1 /*        $NetBSD: ds1307reg.h,v 1.8 2016/10/18 18:54:54 aymeric 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 #define   MCP7940_ADDR                  0x6f
47 
48 #define DSXXXX_SECONDS                  0x00
49 #define DSXXXX_MINUTES                  0x01
50 #define DSXXXX_HOURS                    0x02
51 #define DSXXXX_DAY            0x03
52 #define DSXXXX_DATE           0x04
53 #define DSXXXX_MONTH                    0x05
54 #define DSXXXX_YEAR           0x06
55 #define   DSXXXX_RTC_SIZE               7
56 
57 #define DS1307_CONTROL                  0x07
58 #define   DS1307_RTC_START    0
59 #define   DS1307_RTC_SIZE               DSXXXX_RTC_SIZE
60 #define   DS1307_NVRAM_START  0x08
61 #define   DS1307_NVRAM_SIZE   0x38
62 
63 #define DS1339_CONTROL                  0x0e
64 #define   DS1339_RTC_START    0
65 #define   DS1339_RTC_SIZE               DSXXXX_RTC_SIZE
66 #define   DS1339_NVRAM_START  0
67 #define   DS1339_NVRAM_SIZE   0
68 
69 #define   DS1340_RTC_START    0
70 #define   DS1340_RTC_SIZE               DSXXXX_RTC_SIZE
71 #define   DS1340_SECONDS_EOSC           (1 << 7) /* Clock Hold */
72 
73 #define DS1672_CNTR1                    0x00
74 #define DS1672_CNTR2                    0x01
75 #define DS1672_CNTR3                    0x02
76 #define DS1672_CNTR4                    0x03
77 #define DS1672_CONTROL                  0x04
78 #define DS1672_CONTROL_CH               (1 << 7) /* clock hold */
79 #define DS1672_TRICKLE                  0x05
80 
81 #define DS1672_RTC_START      0
82 #define DS1672_RTC_SIZE                 4
83 #define   DS1672_NVRAM_START  0
84 #define   DS1672_NVRAM_SIZE   0
85 
86 #define DS3232_CONTROL                  0x0e
87 #define DS3232_CSR            0x0f
88 #define   DS3232_RTC_START    0
89 #define   DS3232_RTC_SIZE               DSXXXX_RTC_SIZE
90 #define DS3232_TEMP_MSB                 0x11
91 #define DS3232_TEMP_LSB                 0x12
92 #define   DS3232_NVRAM_START  0x14
93 #define   DS3232_NVRAM_SIZE   0xec
94 
95 #define   MCP7940_NVRAM_START 0x20
96 #define   MCP7940_NVRAM_SIZE  0x40
97 
98 /*
99  * Bit definitions.
100  */
101 #define   DSXXXX_SECONDS_MASK 0x7f
102 #define   DSXXXX_MINUTES_MASK 0x7f
103 #define   DSXXXX_HOURS_12HRS_MODE       (1u << 6) /* Set for 12 hour mode */
104 #define   DSXXXX_HOURS_12HRS_PM         (1u << 5) /* If 12 hr mode, set = PM */
105 #define   DSXXXX_HOURS_12MASK 0x1f
106 #define   DSXXXX_HOURS_24MASK 0x3f
107 #define   DSXXXX_DAY_MASK               0x07
108 #define   DSXXXX_DATE_MASK    0x3f
109 #define   DSXXXX_MONTH_MASK   0x1f
110 #define   DSXXXX_MONTH_CENTURY          0x80
111 
112 #define   DS1307_SECONDS_CH   (1u << 7) /* Clock Hold */
113 #define   DS1307_CONTROL_OUT  (1u << 7) /* OSC/OUT pin value */
114 #define   DS1307_CONTROL_SQWE (1u << 4) /* Enable square wave output */
115 #define   DS1307_CONTROL_1HZ  0
116 #define   DS1307_CONTROL_4096HZ         1
117 #define   DS1307_CONTROL_8192HZ         2
118 #define   DS1307_CONTROL_32768HZ        3
119 
120 #define   DSXXXX_CONTROL_DOSC (1u << 7) /* Disable Oscillator */
121 
122 #define   MCP7940_TOD_DAY_VBATEN        (1u << 3) /* Enable battery backup */
123 
124 #endif /* _DEV_I2C_DS1307REG_H_ */
125