blob: 895345ec513b5cfe90ac3a2d7c95d355ecce121a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001 High Precision Event Timer Driver for Linux
2
David Brownell64a76f62008-07-29 12:47:38 -07003The High Precision Event Timer (HPET) hardware follows a specification
Michael S. Tsirkin4e7f9df2016-02-11 01:05:01 +02004by Intel and Microsoft, revision 1.
David Brownell64a76f62008-07-29 12:47:38 -07005
6Each HPET has one fixed-rate counter (at 10+ MHz, hence "High Precision")
7and up to 32 comparators. Normally three or more comparators are provided,
Matt LaPlante19f59462009-04-27 15:06:31 +02008each of which can generate oneshot interrupts and at least one of which has
David Brownell64a76f62008-07-29 12:47:38 -07009additional hardware to support periodic interrupts. The comparators are
10also called "timers", which can be misleading since usually timers are
11independent of each other ... these share a counter, complicating resets.
12
13HPET devices can support two interrupt routing modes. In one mode, the
14comparators are additional interrupt sources with no particular system
15role. Many x86 BIOS writers don't route HPET interrupts at all, which
16prevents use of that mode. They support the other "legacy replacement"
17mode where the first two comparators block interrupts from 8254 timers
18and from the RTC.
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
Randy Dunlap8a0d4902005-11-07 01:01:06 -080020The driver supports detection of HPET driver allocation and initialization
21of the HPET before the driver module_init routine is called. This enables
22platform code which uses timer 0 or 1 as the main timer to intercept HPET
23initialization. An example of this initialization can be found in
David Brownell64a76f62008-07-29 12:47:38 -070024arch/x86/kernel/hpet.c.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
David Brownell64a76f62008-07-29 12:47:38 -070026The driver provides a userspace API which resembles the API found in the
Randy Dunlape61863092010-03-10 15:21:56 -080027RTC driver framework. An example user space program is provided in
Shuah Khan155fe002016-09-16 17:20:42 -060028file:samples/timers/hpet_example.c