svn commit: r212779 - in head/share/man: man4 man7

[Alexander Motin]

Author: mav
Date: Fri Sep 17 04:55:01 2010
New Revision: 212779
URL: http://svn.freebsd.org/changeset/base/212779

Log:
  Add attimer(4) manual page.

Added:
  head/share/man/man4/attimer.4   (contents, props changed)
Modified:
  head/share/man/man4/Makefile
  head/share/man/man4/hpet.4
  head/share/man/man7/eventtimers.7

Modified: head/share/man/man4/Makefile
==============================================================================
--- head/share/man/man4/Makefile	Fri Sep 17 04:48:50 2010	(r212778)
+++ head/share/man/man4/Makefile	Fri Sep 17 04:55:01 2010	(r212779)
@@ -50,6 +50,7 @@ MAN=	aac.4 \
 	atkbd.4 \
 	atkbdc.4 \
 	${_atp.4} \
+	${attimer.4} \
 	audit.4 \
 	auditpipe.4 \
 	aue.4 \
@@ -547,6 +548,7 @@ MLINKS+=hatm.4 if_hatm.4
 MLINKS+=hme.4 if_hme.4
 MLINKS+=hpet.4 acpi_hpet.4
 MLINKS+=${_hptrr.4} ${_rr232x.4}
+MLINKS+=${_attimer.4} ${_i8254.4}
 MLINKS+=idt.4 if_idt.4
 MLINKS+=igb.4 if_igb.4
 MLINKS+=ip.4 rawip.4
@@ -643,6 +645,7 @@ _acpi_sony.4=	acpi_sony.4
 _acpi_toshiba.4=acpi_toshiba.4
 _acpi_wmi.4=	acpi_wmi.4
 _aesni.4=	aesni.4
+_attimer.4=	attimer.4
 _aibs.4=	aibs.4
 _amdsbwd.4=	amdsbwd.4
 _amdsmb.4=	amdsmb.4
@@ -655,6 +658,7 @@ _dpms.4=	dpms.4
 _hptiop.4=	hptiop.4
 _hptmv.4=	hptmv.4
 _hptrr.4=	hptrr.4
+_i8254.4=	i8254.4
 _ichwd.4=	ichwd.4
 _if_ndis.4=	if_ndis.4
 _if_nfe.4=	if_nfe.4

Added: head/share/man/man4/attimer.4
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/share/man/man4/attimer.4	Fri Sep 17 04:55:01 2010	(r212779)
@@ -0,0 +1,69 @@
+.\" Copyright (c) 2010 Alexander Motin <mav at 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$
+.\"
+.Dd September 14, 2010
+.Dt attimer 4
+.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
+controls event timers functionality support. Setting to 0, disables it.
+Default value is 1.
+.It Va hint.attimer. Ns Ar X Ns Va .timecounter
+controls time counter functionality support. Setting to 0, disables it.
+Default value is 1.
+.El
+.Sh DESCRIPTION
+This driver uses i8254 Programmable Interval Timer (AT Timer) hardware
+to supply kernel with one time counter and one event timer, and generate
+sound tones for system speaker.
+This hardware includes three channels.
+Each channel includes 16bit counter, counting down with known,
+platform-dependent frequency.
+Counters can operate in several different modes, including periodic and
+one-shot.
+Output of each channel has platform-defined wiring: one channel is wired
+to the interrupt controller and may be used as event timer, one channel is
+wired to speaker and used to generate sound tones, and one timer is reserved
+for platform purposes.
+.Pp
+Driver uses single hardware channel to provide both time counter and event
+timer functionality.
+To make it possible, respective counter must be running in periodic more.
+As result, one-shot event timer mode supported only when time counter
+functionality is disabled.
+.Pp
+Event timer provided by the driver is irrelevant to CPU power states.
+.Sh SEE ALSO
+.Xr hpet 4 ,
+.Xr eventtimers 7

Modified: head/share/man/man4/hpet.4
==============================================================================
--- head/share/man/man4/hpet.4	Fri Sep 17 04:48:50 2010	(r212778)
+++ head/share/man/man4/hpet.4	Fri Sep 17 04:55:01 2010	(r212779)
@@ -94,6 +94,7 @@ group is bound to specific CPU core. Thi
 of these comparators has own unsharable IRQ.
 .Sh SEE ALSO
 .Xr acpi 4 ,
+.Xr attimer 4 ,
 .Xr eventtimers 7
 .Sh HISTORY
 The

Modified: head/share/man/man7/eventtimers.7
==============================================================================
--- head/share/man/man7/eventtimers.7	Fri Sep 17 04:48:50 2010	(r212778)
+++ head/share/man/man7/eventtimers.7	Fri Sep 17 04:55:01 2010	(r212779)
@@ -128,4 +128,5 @@ and runs in periodic mode, this option h
 always generating.
 .El
 .Sh SEE ALSO
+.Xr attimer 4 ,
 .Xr hpet 4