share/man/man4/hpet.4

   1 .\" Copyright (c) 2010 Alexander Motin <mav@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd September 14, 2010
  28 .Dt HPET 4
  29 .Os
  30 .Sh NAME
  31 .Nm hpet
  32 .Nd High Precision Event Timer driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device acpi"
  39 .Ed
  40 .Pp
  41 The following tunables are settable from the
  42 .Xr loader 8 :
  43 .Bl -ohang
  44 .It Va hint.hpet. Ns Ar X Ns Va .allowed_irqs
  45 is a 32bit mask. Each set bit allows driver to use respective IRQ,
  46 if BIOS also set respective capability bit in comparator's configuration
  47 register.
  48 Default value is 0xffff0000, except some known broken hardware.
  49 .It Va hint.hpet. Ns Ar X Ns Va .clock
  50 controls event timers functionality support. Setting to 0, disables it.
  51 Default value is 1.
  52 .It Va hint.hpet. Ns Ar X Ns Va .legacy_route
  53 controls "LegacyReplacement Route" mode. If enabled, HPET will steal IRQ0 of
  54 i8254 timer and IRQ8 of RTC. Before using it, make sure that respective
  55 drivers are not using interrupts, by setting also:
  56 .Bd -literal
  57 hint.attimer.0.clock=0
  58 hint.atrtc.0.clock=0
  59 .Ed
  60 Default value is 0.
  61 .It Va hint.hpet. Ns Ar X Ns Va .per_cpu
  62 controls how much per-CPU event timers should driver attempt to register.
  63 This functionality requires every comparator in a group to have own unshared
  64 IRQ, so it depends on hardware capabilities and interrupts configuration.
  65 Default value is 1.
  66 .El
  67 .Sh DESCRIPTION
  68 This driver uses High Precision Event Timer hardware (part of the chipset,
  69 usually enumerated via ACPI) to supply kernel with one time counter and
  70 several (usually from 3 to 8) event timers.
  71 This hardware includes single main counter with known increment frequency
  72 (10MHz or more), and several programmable comparators (optionally with
  73 automatic reload feature).
  74 When value of the main counter matches current value of any comparator,
  75 interrupt can be generated.
  76 Depending on hardware capabilities and configuration, interrupt can be
  77 delivered as regular I/O APIC interrupt (ISA or PCI) in range from 0 to 31,
  78 or as Front Side Bus interrupt, alike to PCI MSI interrupts, or in so called
  79 "LegacyReplacement Route" HPET can steal IRQ0 of i8254 and IRQ8 of the RTC.
  80 Interrupt can be either edge- or level-triggered. In last case they could be
  81 safely shared with PCI IRQs.
  82 Driver prefers to use FSB interrupts, if supported, to avoid sharing.
  83 If it is not possible, it uses single sharable IRQ from PCI range.
  84 Other modes (LegacyReplacement and ISA IRQs) require special care to setup,
  85 but could be configured manually via device hints.
  86 .Pp
  87 Event timers provided by the driver support both one-shot an periodic modes
  88 and irrelevant to CPU power states.
  89 .Pp
  90 Depending on hardware capabilities and configuration, driver can expose each
  91 comparator as separate event timer or group them into one or several per-CPU
  92 event timers. In last case interrupt of every of those comparators within
  93 group is bound to specific CPU core. This is possible only when each
  94 of these comparators has own unsharable IRQ.
  95 .Sh SEE ALSO
  96 .Xr acpi 4 ,
  97 .Xr apic 4 ,
  98 .Xr atrtc 4 ,
  99 .Xr attimer 4 ,
 100 .Xr eventtimers 4 ,
 101 .Xr timecounters 4
 102 .Sh HISTORY
 103 The
 104 .Nm
 105 driver first appeared in
 106 .Fx 6.3 .
 107 Support for event timers was added in
 108 .Fx 9.0 .