2010-09-17 04:55:01 +00:00
|
|
|
.\" Copyright (c) 2010 Alexander Motin <mav@FreeBSD.org>
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
2014-05-26 19:02:34 +00:00
|
|
|
.Dd May 26, 2014
|
2011-05-25 14:13:53 +00:00
|
|
|
.Dt ATTIMER 4
|
2010-09-17 04:55:01 +00:00
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm attimer
|
|
|
|
|
.Nd i8254 Programmable Interval Timer (AT Timer) driver
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
This driver is a mandatory part of x86 kernels.
|
|
|
|
|
.Pp
|
|
|
|
|
The following tunables are settable from the
|
|
|
|
|
.Xr loader 8 :
|
|
|
|
|
.Bl -ohang
|
|
|
|
|
.It Va hint.attimer. Ns Ar X Ns Va .clock
|
2014-05-26 19:02:34 +00:00
|
|
|
controls support for the event timer functionality.
|
|
|
|
|
Setting this value to
|
|
|
|
|
.Dv 0
|
|
|
|
|
disables it.
|
|
|
|
|
The default value is
|
|
|
|
|
.Dv 1 .
|
2010-09-17 04:55:01 +00:00
|
|
|
.It Va hint.attimer. Ns Ar X Ns Va .timecounter
|
2014-05-26 19:02:34 +00:00
|
|
|
controls support for the time counter functionality.
|
|
|
|
|
Setting this value to
|
|
|
|
|
.Dv 0
|
|
|
|
|
disables it.
|
|
|
|
|
The default value is
|
|
|
|
|
.Dv 1 .
|
2010-09-18 07:45:54 +00:00
|
|
|
.It Va hw.i8254.freq
|
2014-05-26 19:02:34 +00:00
|
|
|
allows overriding the default counter frequency.
|
|
|
|
|
The same value is also available at run-time via the
|
2010-09-18 07:45:54 +00:00
|
|
|
.Va machdep.i8254_freq
|
|
|
|
|
sysctl.
|
2010-09-17 04:55:01 +00:00
|
|
|
.El
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
This driver uses i8254 Programmable Interval Timer (AT Timer) hardware
|
2014-05-26 19:02:34 +00:00
|
|
|
to supply the kernel with one timecounter and one event timer, and to generate
|
|
|
|
|
sound tones for the system speaker.
|
2010-09-17 04:55:01 +00:00
|
|
|
This hardware includes three channels.
|
2014-05-26 19:02:34 +00:00
|
|
|
Each channel includes a 16 bit counter which decreases with a known,
|
2010-09-17 04:55:01 +00:00
|
|
|
platform-dependent frequency.
|
|
|
|
|
Counters can operate in several different modes, including periodic and
|
|
|
|
|
one-shot.
|
2014-05-26 19:02:34 +00:00
|
|
|
The output of each channel has platform-defined wiring: one channel is wired
|
2010-09-17 04:55:01 +00:00
|
|
|
to the interrupt controller and may be used as event timer, one channel is
|
2014-05-26 19:02:34 +00:00
|
|
|
wired to the speaker and used to generate sound tones, and one timer is reserved
|
2010-09-17 04:55:01 +00:00
|
|
|
for platform purposes.
|
|
|
|
|
.Pp
|
2014-05-26 19:02:34 +00:00
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
driver uses a single hardware channel to provide both time counter and event
|
2010-09-17 04:55:01 +00:00
|
|
|
timer functionality.
|
2014-05-26 19:02:34 +00:00
|
|
|
To make this possible, the respective counter must be running in periodic mode.
|
|
|
|
|
As a result, the one-shot event timer mode is supported only when time counter
|
2010-09-17 04:55:01 +00:00
|
|
|
functionality is disabled.
|
|
|
|
|
.Pp
|
2014-05-26 19:02:34 +00:00
|
|
|
The event timer provided by the driver is irrelevant to CPU power states.
|
2010-09-17 04:55:01 +00:00
|
|
|
.Sh SEE ALSO
|
2011-12-20 13:49:52 +00:00
|
|
|
.Xr apic 4 ,
|
2010-09-17 08:44:54 +00:00
|
|
|
.Xr atrtc 4 ,
|
2011-12-20 13:49:52 +00:00
|
|
|
.Xr eventtimers 4 ,
|
2011-12-20 17:10:34 +00:00
|
|
|
.Xr hpet 4 ,
|
|
|
|
|
.Xr timecounters 4
|
