xref: /onnv-gate/usr/src/uts/sun4u/sys/todds1287.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 1999-2001 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_TODDS1287_H
28*0Sstevel@tonic-gate #define	_TODDS1287_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate extern  char    *v_rtc_addr_reg;
37*0Sstevel@tonic-gate extern  volatile uint8_t *v_rtc_data_reg;
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate #ifdef	DEBUG
40*0Sstevel@tonic-gate #include <sys/promif.h>
41*0Sstevel@tonic-gate #define	DPRINTF if (ds1287_debug_flags) prom_printf
42*0Sstevel@tonic-gate #else
43*0Sstevel@tonic-gate #define	DPRINTF
44*0Sstevel@tonic-gate #endif	/* DEBUG */
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate #define	DS1287_ADDR_REG		*(volatile uint8_t *)v_rtc_addr_reg
47*0Sstevel@tonic-gate #define	DS1287_DATA_REG		*(volatile uint8_t *)v_rtc_data_reg
48*0Sstevel@tonic-gate 
49*0Sstevel@tonic-gate /*
50*0Sstevel@tonic-gate  * Maximum number of clones
51*0Sstevel@tonic-gate  */
52*0Sstevel@tonic-gate #define	DS1287_MAX_CLONE	256
53*0Sstevel@tonic-gate 
54*0Sstevel@tonic-gate /*
55*0Sstevel@tonic-gate  * Minor number is instance << 8 + clone minor from range 1-255; clone 0 is
56*0Sstevel@tonic-gate  * reserved for the "original".
57*0Sstevel@tonic-gate  */
58*0Sstevel@tonic-gate #define	DS1287_MINOR_TO_CLONE(minor) ((minor) & (DS1287_MAX_CLONE - 1))
59*0Sstevel@tonic-gate 
60*0Sstevel@tonic-gate struct ds1287 {
61*0Sstevel@tonic-gate 	dev_info_t	*dip;		/* device info pointer */
62*0Sstevel@tonic-gate 	kmutex_t	ds1287_mutex;	/* mutex lock */
63*0Sstevel@tonic-gate 	uchar_t		clones[DS1287_MAX_CLONE]; /* array of clones */
64*0Sstevel@tonic-gate 	int		monitor_on;	/* clone monitoring the button event */
65*0Sstevel@tonic-gate 					/* clone 0 is used to indicate no one */
66*0Sstevel@tonic-gate 					/* is monitoring the button event */
67*0Sstevel@tonic-gate 	pollhead_t	pollhd;		/* poll head struct */
68*0Sstevel@tonic-gate 	int		events;		/* bit map of occured events */
69*0Sstevel@tonic-gate 	int		shutdown_pending; /* system shutdown in progress */
70*0Sstevel@tonic-gate };
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate /*
74*0Sstevel@tonic-gate  * Definitions for Real Time Clock driver (Dallas DS1287 chip).
75*0Sstevel@tonic-gate  */
76*0Sstevel@tonic-gate 
77*0Sstevel@tonic-gate /*
78*0Sstevel@tonic-gate  * Common registers between Banks 0, 1, and 2.
79*0Sstevel@tonic-gate  */
80*0Sstevel@tonic-gate #define	RTC_SEC		0x0	/* Seconds */
81*0Sstevel@tonic-gate #define	RTC_ASEC	0x1	/* Seconds Alarm */
82*0Sstevel@tonic-gate #define	RTC_MIN		0x2	/* Minutes */
83*0Sstevel@tonic-gate #define	RTC_AMIN	0x3	/* Minutes Alarm */
84*0Sstevel@tonic-gate #define	RTC_HRS		0x4	/* Hours */
85*0Sstevel@tonic-gate #define	RTC_AHRS	0x5	/* Hours Alarm */
86*0Sstevel@tonic-gate #define	RTC_DOW		0x6	/* Day-of-Week */
87*0Sstevel@tonic-gate #define	RTC_DOM		0x7	/* Day-of-Month */
88*0Sstevel@tonic-gate #define	RTC_MON		0x8	/* Month */
89*0Sstevel@tonic-gate #define	RTC_YEAR	0x9	/* Year */
90*0Sstevel@tonic-gate #define	RTC_A		0xa	/* Control Register A */
91*0Sstevel@tonic-gate #define	RTC_B		0xb	/* Control Register B */
92*0Sstevel@tonic-gate #define	RTC_C		0xc	/* Control Register C */
93*0Sstevel@tonic-gate #define	RTC_D		0xd	/* Control Register D */
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate /*
96*0Sstevel@tonic-gate  * Control register A definitions
97*0Sstevel@tonic-gate  */
98*0Sstevel@tonic-gate #define	RTC_DIV0	0x10	/* Bank Select */
99*0Sstevel@tonic-gate #define	RTC_DIV1	0x20	/* Oscillator enable */
100*0Sstevel@tonic-gate #define	RTC_DIV2	0x40	/* Countdown chain */
101*0Sstevel@tonic-gate #define	RTC_UIP		0x80	/* Update in progress bit */
102*0Sstevel@tonic-gate 
103*0Sstevel@tonic-gate /*
104*0Sstevel@tonic-gate  * Control register B definitions
105*0Sstevel@tonic-gate  */
106*0Sstevel@tonic-gate #define	RTC_DSE		0x01	/* Daylight Savings Enable */
107*0Sstevel@tonic-gate #define	RTC_HM		0x02	/* Hour mode, 1 = 24 hour, 0 = 12 hour */
108*0Sstevel@tonic-gate #define	RTC_DM		0x04	/* Date mode, 1 = binary, 0 = BCD */
109*0Sstevel@tonic-gate #define	RTC_UIE		0x10	/* Update-ended Interrupt Enable */
110*0Sstevel@tonic-gate #define	RTC_AIE		0x20	/* Alarm Interrupt Enable */
111*0Sstevel@tonic-gate #define	RTC_PIE		0x40	/* Periodic Interrupt Enable */
112*0Sstevel@tonic-gate #define	RTC_SET		0x80	/* Stop updates for time set */
113*0Sstevel@tonic-gate 
114*0Sstevel@tonic-gate /*
115*0Sstevel@tonic-gate  * Control Register C definitions
116*0Sstevel@tonic-gate  */
117*0Sstevel@tonic-gate #define	RTC_UF		0x10	/* UF flag bit */
118*0Sstevel@tonic-gate #define	RTC_AF		0x20	/* AF flag bit */
119*0Sstevel@tonic-gate #define	RTC_PF		0x40	/* PF flag bit */
120*0Sstevel@tonic-gate #define	RTC_IRQF	0x80	/* IRQ flag */
121*0Sstevel@tonic-gate 
122*0Sstevel@tonic-gate /*
123*0Sstevel@tonic-gate  * Control Register D definitions
124*0Sstevel@tonic-gate  */
125*0Sstevel@tonic-gate #define	RTC_VRT		0x80	/* Valid RAM and time bit */
126*0Sstevel@tonic-gate 
127*0Sstevel@tonic-gate /*
128*0Sstevel@tonic-gate  * Bank 1 Registers
129*0Sstevel@tonic-gate  */
130*0Sstevel@tonic-gate #define	RTC_CENTURY	0x48	/* Century */
131*0Sstevel@tonic-gate #define	RTC_ADOM	0x49	/* Date of Month Alarm */
132*0Sstevel@tonic-gate #define	RTC_AMON	0x4a	/* Month Alarm */
133*0Sstevel@tonic-gate 
134*0Sstevel@tonic-gate /*
135*0Sstevel@tonic-gate  * Bank 2 Registers
136*0Sstevel@tonic-gate  */
137*0Sstevel@tonic-gate #define	APC_APCR1	0x40	/* APC Control Register 1 */
138*0Sstevel@tonic-gate #define	APC_APCR2	0x41	/* APC Control Register 2 */
139*0Sstevel@tonic-gate #define	APC_APSR	0x42	/* APC Status Register */
140*0Sstevel@tonic-gate #define	APC_WDWR	0x43	/* Wake up Day of Week */
141*0Sstevel@tonic-gate #define	APC_WDMR	0x44	/* Wake up Date of Month */
142*0Sstevel@tonic-gate #define	APC_WMR		0x45	/* Wake up Month */
143*0Sstevel@tonic-gate #define	APC_WYR		0x46	/* Wake up Year */
144*0Sstevel@tonic-gate #define	APC_WCR		0x48	/* Wake up Century */
145*0Sstevel@tonic-gate 
146*0Sstevel@tonic-gate #define	RTC_CADDR	0x51	/* Century address register */
147*0Sstevel@tonic-gate 
148*0Sstevel@tonic-gate /*
149*0Sstevel@tonic-gate  * APC Control Register 1 (APCR1) definitions
150*0Sstevel@tonic-gate  */
151*0Sstevel@tonic-gate #define	APC_FSTRC	0x40	/* Fail-safe Timer Reset Command */
152*0Sstevel@tonic-gate 
153*0Sstevel@tonic-gate /*
154*0Sstevel@tonic-gate  * APC Control Register 2 (APCR2) definitions
155*0Sstevel@tonic-gate  */
156*0Sstevel@tonic-gate #define	APC_TME		0x01	/* Timer Match Enable */
157*0Sstevel@tonic-gate 
158*0Sstevel@tonic-gate struct	rtc_t {
159*0Sstevel@tonic-gate 	uint8_t	rtc_sec;	/* seconds */
160*0Sstevel@tonic-gate 	uint8_t	rtc_asec;	/* alarm seconds */
161*0Sstevel@tonic-gate 	uint8_t	rtc_min;	/* mins */
162*0Sstevel@tonic-gate 	uint8_t	rtc_amin;	/* alarm mins */
163*0Sstevel@tonic-gate 	uint8_t	rtc_hrs;	/* hours */
164*0Sstevel@tonic-gate 	uint8_t	rtc_ahrs;	/* alarm hours */
165*0Sstevel@tonic-gate 	uint8_t	rtc_dow;	/* day of the week */
166*0Sstevel@tonic-gate 	uint8_t	rtc_dom;	/* day of the month */
167*0Sstevel@tonic-gate 	uint8_t	rtc_mon;	/* month */
168*0Sstevel@tonic-gate 	uint8_t	rtc_year;	/* year */
169*0Sstevel@tonic-gate 	uint8_t	rtc_rega;	/* REG A */
170*0Sstevel@tonic-gate 	uint8_t	rtc_regb;	/* REG B */
171*0Sstevel@tonic-gate 	uint8_t	rtc_regc;	/* REG C */
172*0Sstevel@tonic-gate 	uint8_t	rtc_regd;	/* REG D */
173*0Sstevel@tonic-gate 	uint8_t	rtc_century;	/* century */
174*0Sstevel@tonic-gate 	uint8_t	rtc_adom;	/* alarm  day */
175*0Sstevel@tonic-gate 	uint8_t	rtc_amon;	/* alarm  mon */
176*0Sstevel@tonic-gate 	uint8_t	apc_apcr1;	/* APC Control register 1 */
177*0Sstevel@tonic-gate 	uint8_t	apc_apcr2;	/* APC Control register 2 */
178*0Sstevel@tonic-gate 	uint8_t	apc_apsr;	/* APC Status register */
179*0Sstevel@tonic-gate 	uint8_t	apc_wdwr;	/* Wakeup date of the month */
180*0Sstevel@tonic-gate 	uint8_t	apc_wdmr;	/* Wakeup day of month */
181*0Sstevel@tonic-gate 	uint8_t	apc_wmr;	/* Wakeup month register */
182*0Sstevel@tonic-gate 	uint8_t	apc_wyr;	/* Wakeup year register */
183*0Sstevel@tonic-gate 	uint8_t	apc_wcr;	/* Wakeup Century reg. */
184*0Sstevel@tonic-gate };
185*0Sstevel@tonic-gate 
186*0Sstevel@tonic-gate #ifdef	__cplusplus
187*0Sstevel@tonic-gate }
188*0Sstevel@tonic-gate #endif
189*0Sstevel@tonic-gate 
190*0Sstevel@tonic-gate #endif	/* _TODDS1287_H */
191