Fix typos, add articles, use more markup.

This commit is contained in:
wiz 2003-11-02 09:08:16 +00:00
parent 8920f41e3e
commit 301fe66e18
1 changed files with 24 additions and 16 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: mk48txx.4,v 1.12 2003/11/02 04:20:04 tsutsui Exp $ .\" $NetBSD: mk48txx.4,v 1.13 2003/11/02 09:08:16 wiz Exp $
.\" .\"
.\" Copyright (c) 2000, 2002 The NetBSD Foundation, Inc. .\" Copyright (c) 2000, 2002 The NetBSD Foundation, Inc.
.\" All rights reserved. .\" All rights reserved.
@ -40,7 +40,8 @@
.Sh NAME .Sh NAME
.Nm mk48txx .Nm mk48txx
.Nd .Nd
.Tn Mostek time-of-day clock driver .Tn Mostek
time-of-day clock driver
.Sh SYNOPSIS .Sh SYNOPSIS
.In dev/ic/mk48txxreg.h .In dev/ic/mk48txxreg.h
.In dev/ic/mk48txxvar.h .In dev/ic/mk48txxvar.h
@ -58,8 +59,9 @@ are provided through the
interface defined in interface defined in
.Xr todr 9 . .Xr todr 9 .
.Pp .Pp
To tie in instance of this device to the system, use mk48txx_attach function To tie an instance of this device to the system, use the
and mk48txx_softc structure defined as follows: .Fn mk48txx_attach
function and the mk48txx_softc structure defined as follows:
.Pp .Pp
.nr nS 1 .nr nS 1
.Ft "void" .Ft "void"
@ -92,7 +94,7 @@ struct mk48txx_softc {
Specify bus space access to the chip's non-volatile memory Specify bus space access to the chip's non-volatile memory
.Pq including the clock registers . .Pq including the clock registers .
.It Fa sc_handle .It Fa sc_handle
TODR handle passed to TODR handle passed to the
.Fn todr_attach .Fn todr_attach
function to register function to register
.Xr todr 9 .Xr todr 9
@ -102,27 +104,33 @@ The chip model which this instance should serve.
Must be one of Must be one of
.Dq mk48t02 , .Dq mk48t02 ,
.Dq mk48t08 , .Dq mk48t08 ,
.Dq mk48t18 .Dq mk48t18 ,
or or
.Dq mk48t59 . .Dq mk48t59 .
.It Fa sc_nvramsz .It Fa sc_nvramsz
Size of non-volatile RAM in the Mostek chip. This value is set by Size of non-volatile RAM in the
.Fn mk48txx_attach .Tn Mostek
function. chip.
This value is set by
.Fn mk48txx_attach .
.It Fa sc_clkoffset .It Fa sc_clkoffset
Offset into the control registers of the Mosteck chip. This value is set by Offset into the control registers of the
.Fn mk48txx_attach .Tn Mostek
function. chip.
This value is set by
.Fn mk48txx_attach .
.It Fa sc_year0 .It Fa sc_year0
The actual year represented by the clock's The actual year represented by the clock's
.Sq year .Sq year
counter. counter.
This is generally dependent on the system configuration in which This is generally dependent on the system configuration in which
the clock device is mounted. the clock device is mounted.
For instance, on Sun Microsystems machines For instance, on
the convention is to have clock's two-digit year represent the year 1968. .Tn Sun Microsystems
machines the convention is to have clock's two-digit year represent
the year 1968.
.It Fa sc_flag .It Fa sc_flag
This flag is used to specify machine dependent features. This flag is used to specify machine-dependent features.
.It Fa sc_nvread .It Fa sc_nvread
.It Fa sc_nvwrite .It Fa sc_nvwrite
Specify alternate access methods for reading resp. writing clock Specify alternate access methods for reading resp. writing clock
@ -144,7 +152,7 @@ location to be read from or written to, respectively.
Note that if the resulting date retrieved with the todr_gettime() method Note that if the resulting date retrieved with the todr_gettime() method
is earlier that January 1, 1970, the driver will assume that the chip's is earlier that January 1, 1970, the driver will assume that the chip's
year counter actually represents a year in the 21st century. year counter actually represents a year in the 21st century.
This behaviour can be overridden by setting This behaviour can be overridden by setting the
.Va MK48TXX_NO_CENT_ADJUST .Va MK48TXX_NO_CENT_ADJUST
flag in flag in
.Fa sc_flag . .Fa sc_flag .