Home | History | Annotate | Line # | Download | only in ic
intersil7170reg.h revision 1.1 
      1 /*	$NetBSD: intersil7170reg.h,v 1.1 2006/10/04 15:04:43 tsutsui Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1996 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Adam Glass.
      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	_INTERSIL7170REG_H_
     40 #define	_INTERSIL7170REG_H_
     41 
     42 /*
     43  * Driver support for the intersil7170 used in sun[34]s to provide
     44  * real time clock and time-of-day support.
     45  *
     46  * Derived from: datasheet "ICM7170 a uP-Compatible Real-Time Clock"
     47  *                          document #301680-005, Dec 85
     48  *
     49  * Note that this device provides both time-of-day and interval timer
     50  * functionality. Both functions use the same control registers. On top
     51  * of that, the command control register is write-only. Currently, this
     52  * driver assumes that the interval timer is to be enabled, and hence
     53  * always sets/restores the INTERSIL_CMD_IENABLE control bit when
     54  * manipulating the TOD.
     55  */
     56 
     57 struct intersil_dt {		/* from p. 7 of 10 */
     58 	uint8_t dt_csec;
     59 	uint8_t dt_hour;
     60 	uint8_t dt_min;
     61 	uint8_t dt_sec;
     62 	uint8_t dt_month;
     63 	uint8_t dt_day;
     64 	uint8_t dt_year;
     65 	uint8_t dt_dow;
     66 };
     67 
     68 struct intersil7170 {
     69 	struct intersil_dt counters;
     70 	struct intersil_dt clk_ram; /* should be ok as both are word aligned */
     71 	uint8_t clk_intr_reg;
     72 	uint8_t clk_cmd_reg;
     73 };
     74 
     75 /* Indices to time-of-day clock registers */
     76 #define INTERSIL_ICSEC	0
     77 #define INTERSIL_IHOUR	1
     78 #define INTERSIL_IMIN	2
     79 #define INTERSIL_ISEC	3
     80 #define INTERSIL_IMON	4
     81 #define INTERSIL_IDAY	5
     82 #define INTERSIL_IYEAR	6
     83 #define INTERSIL_IDOW	7
     84 
     85 #define INTERSIL_IINTR	16
     86 #define INTERSIL_ICMD	17
     87 
     88 /*  bit assignments for command register, p. 6 of 10, write-only */
     89 #define INTERSIL_CMD_FREQ_32K    0x0
     90 #define INTERSIL_CMD_FREQ_1M     0x1
     91 #define INTERSIL_CMD_FREQ_2M     0x2
     92 #define INTERSIL_CMD_FREQ_4M     0x3
     93 
     94 #define INTERSIL_CMD_12HR_MODE   0x0
     95 #define INTERSIL_CMD_24HR_MODE   0x4
     96 
     97 #define INTERSIL_CMD_STOP        0x0
     98 #define INTERSIL_CMD_RUN         0x8
     99 
    100 #define INTERSIL_CMD_IDISABLE   0x0
    101 #define INTERSIL_CMD_IENABLE   0x10
    102 
    103 #define INTERSIL_CMD_TEST_MODE      0x20
    104 #define INTERSIL_CMD_NORMAL_MODE    0x0
    105 
    106 #define INTERSIL_COMMAND(run, interrupt)				\
    107         ((run) | (interrupt) | INTERSIL_CMD_FREQ_32K |			\
    108 	INTERSIL_CMD_24HR_MODE | INTERSIL_CMD_NORMAL_MODE)
    109 
    110 /* bit assignments for interrupt register r/w, p 7 of 10 */
    111 
    112 #define INTERSIL_INTER_ALARM       0x1 /* r/w */
    113 #define INTERSIL_INTER_CSECONDS    0x2 /* r/w */
    114 #define INTERSIL_INTER_DSECONDS    0x4 /* r/w */
    115 #define INTERSIL_INTER_SECONDS     0x8 /* r/w */
    116 #define INTERSIL_INTER_MINUTES    0x10 /* r/w */
    117 #define INTERSIL_INTER_HOURS      0x20 /* r/w */
    118 #define INTERSIL_INTER_DAYS       0x40 /* r/w */
    119 #define INTERSIL_INTER_PENDING    0x80 /* read-only */
    120 
    121 #define INTERSIL_INTER_BITS	\
    122 	"\20\10PENDING\7DAYS\6HRS\5MIN\4SCDS\3DSEC\2CSEC\1ALARM"
    123 
    124 #endif	/* _INTERSIL7170REG_H_ */
    125