1.\" $NetBSD: intersil7170.4,v 1.11 2006/10/04 17:55:54 wiz Exp $ 2.\" 3.\" Copyright (c) 2000 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Paul Kranenburg. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd October 1, 2006 38.Dt INTERSIL7170 4 39.Os 40.Sh NAME 41.Nm intersil7170 42.Nd 43.Tn Intersil ICM7170 time-of-day clock driver 44.Sh SYNOPSIS 45.In dev/ic/intersil7170reg.h 46.In dev/ic/intersil7170var.h 47.Cd "define intersil7170" 48.Cd "file dev/ic/intersil7170.c intersil7170" 49.Sh DESCRIPTION 50The 51.Nm 52driver provides access to the 53.Tn Intersil ICM7170 54time-of-day clock chip. 55Access methods to retrieve and set date and time 56are provided through the 57.Em TODR 58interface defined in 59.Xr todr 9 . 60.Pp 61To tie an instance of this device to the system, use the 62.Fn intersil7170_attach 63function and the 64.Fa intersil7170_softc 65structure defined as follows: 66.Pp 67.Ft "void" 68.Fn intersil7170_attach "struct intersil7170_softc *" 69.Pp 70.Bd -literal 71struct intersil7170_softc { 72 struct device sc_dev; 73 bus_space_tag_t sc_bst; 74 bus_space_handle_t sc_bsh; 75 struct todr_chip_handle sc_handle; 76 u_int sc_year0; 77 u_int sc_flag; 78}; 79.Ed 80.Pp 81.Bl -tag -width Dv -offset indent 82.It Fa bus_tag 83.It Fa bus_handle 84Specify bus space access to the chip's non-volatile memory 85.Pq including the clock registers . 86.It Fa sc_handle 87TODR handle passed to the 88.Fn todr_attach 89function to register 90.Xr todr 9 91interface. 92.It Fa sc_year0 93The actual year represented by the clock's 94.Sq year 95counter. 96This is generally dependent on the system configuration in which 97the clock device is mounted. 98For instance, on Sun Microsystems machines 99the convention is to have clock's two-digit year represent the year 1968. 100.It Fa sc_flag 101This flag is used to specify machine-dependent features. 102.El 103.Pp 104Note that if the resulting date retrieved with the todr_gettime() method 105is earlier that January 1, 1970, the driver will assume that the chip's 106year counter actually represents a year in the 21st century. 107This behaviour can be overridden by setting the 108.Va INTERSIL7170_NO_CENT_ADJUST 109flag in 110.Fa sc_flag . 111.Sh SEE ALSO 112.Xr intro 4 , 113.Xr todr 9 114.Sh HISTORY 115The 116.Nm 117driver first appeared in 118.Nx 1.5 . 119.Sh AUTHORS 120The 121.Nm 122driver was written by 123.An Paul Kranenburg 124.Aq pk@NetBSD.org . 125