xref: /netbsd-src/sys/dev/i2c/ds1307reg.h (revision d909946ca08dceb44d7d0f22ec9488679695d976)
1 /*	$NetBSD: ds1307reg.h,v 1.6 2016/04/05 10:53:16 bouyer Exp $	*/
2 
3 /*
4  * Copyright (c) 2003 Wasabi Systems, Inc.
5  * All rights reserved.
6  *
7  * Written by Steve C. Woodford for Wasabi Systems, Inc.
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 for the NetBSD Project by
20  *      Wasabi Systems, Inc.
21  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22  *    or promote products derived from this software without specific prior
23  *    written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26  * 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 WASABI SYSTEMS, INC
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 
38 #ifndef _DEV_I2C_DS1307REG_H_
39 #define _DEV_I2C_DS1307REG_H_
40 
41 /*
42  * DS1307 64x8 Serial Real-Time Clock
43  */
44 
45 #define	DS1307_ADDR		0x68	/* Fixed I2C Slave Address */
46 
47 #define DSXXXX_SECONDS		0x00
48 #define DSXXXX_MINUTES		0x01
49 #define DSXXXX_HOURS		0x02
50 #define DSXXXX_DAY		0x03
51 #define DSXXXX_DATE		0x04
52 #define DSXXXX_MONTH		0x05
53 #define DSXXXX_YEAR		0x06
54 #define	DSXXXX_RTC_SIZE		7
55 
56 #define DS1307_CONTROL		0x07
57 #define	DS1307_RTC_START	0
58 #define	DS1307_RTC_SIZE		DSXXXX_RTC_SIZE
59 #define	DS1307_NVRAM_START	0x08
60 #define	DS1307_NVRAM_SIZE	0x38
61 
62 #define DS1339_CONTROL		0x0e
63 #define	DS1339_RTC_START	0
64 #define	DS1339_RTC_SIZE		DSXXXX_RTC_SIZE
65 #define	DS1339_NVRAM_START	0
66 #define	DS1339_NVRAM_SIZE	0
67 
68 #define DS1672_CNTR1		0x00
69 #define DS1672_CNTR2		0x01
70 #define DS1672_CNTR3		0x02
71 #define DS1672_CNTR4		0x03
72 #define DS1672_CONTROL		0x04
73 #define DS1672_CONTROL_CH		(1 << 7) /* clock hold */
74 #define DS1672_TRICKLE		0x05
75 
76 #define DS1672_RTC_START	0
77 #define DS1672_RTC_SIZE		4
78 #define	DS1672_NVRAM_START	0
79 #define	DS1672_NVRAM_SIZE	0
80 
81 #define DS3232_CONTROL		0x0e
82 #define DS3232_CSR		0x0f
83 #define	DS3232_RTC_START	0
84 #define	DS3232_RTC_SIZE		DSXXXX_RTC_SIZE
85 #define DS3232_TEMP_MSB		0x11
86 #define DS3232_TEMP_LSB		0x12
87 #define	DS3232_NVRAM_START	0x14
88 #define	DS3232_NVRAM_SIZE	0xec
89 
90 
91 /*
92  * Bit definitions.
93  */
94 #define	DSXXXX_SECONDS_MASK	0x7f
95 #define	DSXXXX_MINUTES_MASK	0x7f
96 #define	DSXXXX_HOURS_12HRS_MODE	(1u << 6)	/* Set for 12 hour mode */
97 #define	DSXXXX_HOURS_12HRS_PM	(1u << 5)	/* If 12 hr mode, set = PM */
98 #define	DSXXXX_HOURS_12MASK	0x1f
99 #define	DSXXXX_HOURS_24MASK	0x3f
100 #define	DSXXXX_DAY_MASK		0x07
101 #define	DSXXXX_DATE_MASK	0x3f
102 #define	DSXXXX_MONTH_MASK	0x1f
103 #define	DSXXXX_MONTH_CENTURY	0x80
104 
105 #define	DS1307_SECONDS_CH	(1u << 7)	/* Clock Hold */
106 #define	DS1307_CONTROL_OUT	(1u << 7)	/* OSC/OUT pin value */
107 #define	DS1307_CONTROL_SQWE	(1u << 4)	/* Enable square wave output */
108 #define	DS1307_CONTROL_1HZ	0
109 #define	DS1307_CONTROL_4096HZ	1
110 #define	DS1307_CONTROL_8192HZ	2
111 #define	DS1307_CONTROL_32768HZ	3
112 
113 #define	DSXXXX_CONTROL_DOSC	(1u << 7)	/* Disable Oscillator */
114 
115 #endif /* _DEV_I2C_DS1307REG_H_ */
116