Home | History | Annotate | Line # | Download | only in ic
mm58167var.h revision 1.2 
      1 /*	$NetBSD: mm58167var.h,v 1.2 2005/02/04 02:10:36 perry Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Matthew Fredette.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *        This product includes software developed by the NetBSD
     21  *        Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 #ifndef	_MM58167VAR_H
     40 #define	_MM58167VAR_H
     41 
     42 /*
     43  * Driver support for the National Semiconductor MM58167
     44  * time-of-day chip.  See
     45  * http://www.national.com/ds/MM/MM58167B.pdf for data sheets.
     46  */
     47 
     48 struct mm58167_softc {
     49 	struct device	mm58167_dev;
     50 
     51 	/* Pointers to bus_space */
     52 	bus_space_tag_t 	mm58167_regt;
     53 	bus_space_handle_t 	mm58167_regh;
     54 
     55 	/*
     56 	 * Pointers to MM58167 registers.  All of these values are in
     57          * BCD.
     58 	 */
     59 
     60 	/*
     61 	 * The most significant digit of this first value is the
     62 	 * milliseconds unit; least significant digit is undefined:
     63 	 */
     64 	bus_size_t	mm58167_msec_xxx;
     65 	/* both digits of this value make up centiseconds: */
     66 	bus_size_t	mm58167_csec;
     67 	bus_size_t	mm58167_sec;
     68 	bus_size_t	mm58167_min;
     69 	bus_size_t	mm58167_hour;
     70 	bus_size_t	mm58167_wday;
     71 	bus_size_t	mm58167_day;
     72 	bus_size_t	mm58167_mon;
     73 
     74 	/*
     75 	 * The MM58167 has compare latches that line up with the
     76 	 * above, interrupt registers, etc., but we don't use them, so
     77 	 * we don't mention them here.
     78 	 */
     79 	bus_size_t	mm58167_status;		/* bad counter read status */
     80 	bus_size_t	mm58167_go;		/* GO - start at integral seconds */
     81 
     82 	/*
     83 	 * We keep a TODR handle in the softc to save
     84 	 * us from having to allocate it ourselves.
     85 	 * However, only mm58167.c should know this.
     86 	 */
     87 	struct todr_chip_handle _mm58167_todr_handle;
     88 };
     89 
     90 todr_chip_handle_t mm58167_attach(struct mm58167_softc *);
     91 
     92 #endif	/* _MM58167VAR_H */
     93