xref: /freebsd/share/man/man4/atrtc.4 (revision bdcbfde31e8e9b343f113a1956384bdf30d1ed62)
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.Dd December 15, 2022
26.Dt ATRTC 4
27.Os
28.Sh NAME
29.Nm atrtc
30.Nd AT Real-Time Clock (RTC) driver
31.Sh SYNOPSIS
32This driver is a mandatory part of i386/amd64 kernels.
33.Pp
34The following tunables are settable from the
35.Xr loader 8 :
36.Bl -ohang
37.It Va hint.atrtc. Ns Ar X Ns Va .clock
38controls event timers functionality support.
39Setting to 0, disables it.
40Default value is 1.
41.It Va hw.atrtc.enabled
42Forces enabling or disabling of the device(s).
43Setting to 0 disables it, setting to 1 enables it, bypassing any platform
44configuration hints.
45Default value is -1 (autodetect).
46.El
47.Sh DESCRIPTION
48This driver uses RTC hardware to supply kernel with time-of-day clock
49with 1 second resolution and one event timer.
50This hardware uses base frequency of 32768Hz for advancing time-of-day clock
51and generating periodic interrupts.
52Interrupts could be generated with fixed number of frequencies, from 2Hz to
538192Hz, obtained by dividing base frequency by one of supported power-of-2
54divisors.
55.Pp
56Event timer provided by the driver is irrelevant to CPU power states.
57.Sh SEE ALSO
58.Xr apic 4 ,
59.Xr attimer 4 ,
60.Xr eventtimers 4 ,
61.Xr hpet 4
62