[src/trunk]: src/share/man/man4 Add driver man pages for Mostek MK48TXX and I...

To: source-changes-hg%NetBSD.org@localhost
Subject: [src/trunk]: src/share/man/man4 Add driver man pages for Mostek MK48TXX and I...
From: pk <pk%NetBSD.org@localhost>
Date: Fri, 24 Jan 2020 07:50:44 +0000
details:   https://anonhg.NetBSD.org/src/rev/1471ab947f49
branches:  trunk
changeset: 495292:1471ab947f49
user:      pk <pk%NetBSD.org@localhost>
date:      Tue Jul 25 21:02:54 2000 +0000

description:
Add driver man pages for Mostek MK48TXX and Intersil7170 time-of-day clocks.

diffstat:

 share/man/man4/Makefile       |   10 +-
 share/man/man4/intersil7170.4 |   96 ++++++++++++++++++++++++++++++++++++
 share/man/man4/mk48txx.4      |  110 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 211 insertions(+), 5 deletions(-)

diffs (245 lines):

diff -r 51f8df604559 -r 1471ab947f49 share/man/man4/Makefile
--- a/share/man/man4/Makefile   Tue Jul 25 20:56:10 2000 +0000
+++ b/share/man/man4/Makefile   Tue Jul 25 21:02:54 2000 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.162 2000/07/24 11:53:49 ad Exp $
+#      $NetBSD: Makefile,v 1.163 2000/07/25 21:02:56 pk Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   adv.4 adw.4 ahb.4 ahc.4 aria.4 atalk.4 audio.4 auvia.4 \
@@ -6,9 +6,9 @@
        cd.4 ch.4 clcs.4 clnp.4 cltp.4 cmpci.4 cms.4 cnw.4 ddb.4 \
        de.4 dpt.4 drum.4 eap.4 en.4 envsys.4 ep.4 esh.4 \
        esis.4 eso.4 exphy.4 fd.4 fpa.4 fms.4 fxp.4 gre.4 icmp.4 \
-       icsphy.4 idp.4 ifmedia.4 inet.4 inphy.4 ioat.4 iophy.4 ip.4 \
-       ipip.4 ipkdb.4 iso.4 isp.4 lc.4 lkm.4 lo.4 lxtphy.4 \
-       mainbus.4 mbe.4 mca.4 md.4 mhzc.4 midi.4 mii.4 mpu.4 \
+       icsphy.4 idp.4 ifmedia.4 inet.4 inphy.4 intersil7170.4 ioat.4 \
+       iophy.4 ip.4 ipip.4 ipkdb.4 iso.4 isp.4 lc.4 lkm.4 lo.4 lxtphy.4 \
+       mainbus.4 mbe.4 mca.4 md.4 mhzc.4 midi.4 mii.4 mk48txx.4 mpu.4 \
        mtio.4 ncr.4 ne.4 netintro.4 ns.4 nsip.4 \
        nsphy.4 ntwoc.4 null.4 opl.4 options.4 pas.4 pcdisplay.4 \
        pciide.4 pckbc.4 pckbd.4 pcppi.4 pcscp.4 pms.4 ppp.4 \
@@ -26,7 +26,7 @@
        aue.4 cue.4 kue.4 upl.4 \
        uhci.4 ohci.4
 
-# machine-independent buses
+# machine-independent busses
 MAN+=  eisa.4 isa.4 isapnp.4 pci.4 pcmcia.4
 
 # machine-independent PCI devices
diff -r 51f8df604559 -r 1471ab947f49 share/man/man4/intersil7170.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/intersil7170.4     Tue Jul 25 21:02:54 2000 +0000
@@ -0,0 +1,96 @@
+.\"    $NetBSD: intersil7170.4,v 1.1 2000/07/25 21:02:55 pk Exp $
+.\"
+.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Paul Kranenburg.
+.\"
+.\" 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
+.\"
+.Dd July 20, 2000
+.Dt INTERSIL7170 4
+.Os
+.Sh NAME
+.Nm intersil7170
+.Nd
+.Tn Intersil time-of-day clock driver
+.Sh SYNOPSIS
+.Fd #include <dev/ic/intersil7170.h>
+.Cd "define intersil7170"
+.Cd "file   dev/ic/intersil7170.c    intersil7170"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides access to the
+.Tm Intersil 7170
+time-of-day clock chip. Access methods to retrieve and set date and time
+are provided through the
+.Em TODR
+interface defined in
+.Xr todr 9 .
+.Pp
+To tie in instance of this device to the system, use
+.nr nS 1
+.Ft "todr_chip_handle_t"
+.Fn intersil7170_attach "bus_space_tag_t bus_tag" \
+"bus_space_handle_t bus_handle" "int year0"
+.Pp
+.Bl -tag -width -offset xxxxx
+.It Fa bus_tag
+.It Fa bus_handle
+Specify bus space access to the chip's non-volatile memory
+.Pq including the clock registers .
+.It Fa year0
+The actual year represented by the clock's
+.Sq year
+counter. This is generally dependent on the system configuration in which
+the clock device is mounted. For instance, on Sun Microsystems machines
+the convention is to have clock's two-digit year represent the year 1968.
+.El
+.Pp
+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
+year counter actually represents a year in the 21st century. This
+behaviour can be overridden by setting the global variable
+.Va intersil7170_auto_century_adjust
+to zero.
+.Sh SEE ALSO
+.Xr intro 4 ,
+.Xr todr 9 ,
+.Sh AUTHOR
+The
+.Nm
+driver was written by Paul Kranenburg
+.Aq pk%netbsd.org@localhost .
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Nx 1.5 .
diff -r 51f8df604559 -r 1471ab947f49 share/man/man4/mk48txx.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/mk48txx.4  Tue Jul 25 21:02:54 2000 +0000
@@ -0,0 +1,110 @@
+.\"    $NetBSD: mk48txx.4,v 1.1 2000/07/25 21:02:54 pk Exp $
+.\"
+.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Paul Kranenburg.
+.\"
+.\" 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
+.\"
+.Dd July 20, 2000
+.Dt MK48TXX 4
+.Os
+.Sh NAME
+.Nm mk48txx
+.Nd
+.Tn Mostek time-of-day clock driver
+.Sh SYNOPSIS
+.Fd #include <dev/ic/mk48txxreg.h>
+.Cd "define mk48txx"
+.Cd "file   dev/ic/mk48txx.c    mk48txx"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides access to several models of
+.Tm Mostek
+time-of-day clock chips. Access methods to retrieve and set date and time
+are provided through the
+.Em TODR
+interface defined in
+.Xr todr 9 .
+.Pp
+To tie in instance of this device to the system, use
+.nr nS 1
+.Ft "todr_chip_handle_t"
+.Fn mk48txx_attach "bus_space_tag_t bus_tag" "bus_space_handle_t bus_handle" \
+"const char *model" "int year0"
+.Pp
+.Bl -tag -width -offset xxxxx
+.It Fa bus_tag
+.It Fa bus_handle
+Specify bus space access to the chip's non-volatile memory
+.Pq including the clock registers .
+.It Fa model
+The chip model which this instance should serve. Must be one of
+.Dq mk48t02 ,
+.Dq mk48t08
+or
+.Dq mk48t59 .
+.It Fa year0
+The actual year represented by the clock's
+.Sq year
+counter. This is generally dependent on the system configuration in which
+the clock device is mounted. For instance, on Sun Microsystems machines
+the convention is to have clock's two-digit year represent the year 1968.
+.El
+.Pp
+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
+year counter actually represents a year in the 21st century. This
+behaviour can be overridden by setting the global variable
+.Va mk48txx_auto_century_adjust
+to zero.
+.Sh HARDWARE
+The following models are supported:
+.Pp
+.Bl -tag -width -offset indent -compact
+.It Tn Mostek MK48T02
+.It Tn Mostek MK48T08
+.It Tn Mostek MK48T59
+.El
+.Sh SEE ALSO
+.Xr intro 4 ,
+.Xr todr 9 ,
+.Sh AUTHOR
+The
+.Nm
+driver was written by Paul Kranenburg
+.Aq pk%netbsd.org@localhost .
+.Sh HISTORY
+The
+.Nm mk48txx
+driver first appeared in
+.Nx 1.5 .
Prev by Date: [src/trunk]: src/share/man/man9 Add man page for a new time-of-day clock driv...
Next by Date: [src/trunk]: src/sys/arch/sparc/dev Add `dma' to the `early device' list, sin...
Previous by Thread: [src/trunk]: src/share/man/man9 Add man page for a new time-of-day clock driv...
Next by Thread: [src/trunk]: src/sys/arch/sparc/dev Add `dma' to the `early device' list, sin...
Indexes:
Home | Main Index | Thread Index | Old Index