ds1687reg.h revision 1.1
1 /* $NetBSD: ds1687reg.h,v 1.1 2003/01/18 22:07:21 rafal Exp $ */ 2 3 /* 4 * Copyright (c) 2003 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Rafal K. Boni. 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. The name of the author may not be used to endorse or promote products 23 * derived from this software without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 26 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 27 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 28 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 30 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 34 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 35 */ 36 37 /* 38 * Definitions for the Dallas Semiconductor DS1687 Real Time Clock. 39 * 40 * The DS1687 and follow-on RTC chips are Y2k-compliant successors to the 41 * DS1287, which in turn is register-compatible with the MC146818 and/or 42 * MC146818A RTCs. 43 * 44 * Plucked right from the Dallas Semicomductor specs available at: 45 * http://pdfserv.maxim-ic.com/arpdf/DS1685-DS1687.pdf 46 * 47 * The DS1686 contains 14 basic clock-related registers and 50 bytes of 48 * user RAM laid out for compatibility with the register layout of the 49 * DS1287/MC14818 chips. It also includes an extended mode which allows 50 * access to these same basic registers as well an an extended register 51 * set and NVRAM area; this extended register set includes a century 52 * register for Y2k compliant date storage. 53 * 54 * Since the locations of these ports and the method used to access them 55 * can be machine-dependent, the low-level details of reading and writing 56 * writing the RTC's registers are handled by machine-specific functions. 57 * 58 * The Dallas chip can store time-of-day and alarm data in BCD or binary; 59 * this setting applies to *all* values stored in the clock chip and a 60 * change from one mode to the other requires *all* of the clock data to 61 * be re-written. The "hours" time-of-year and alarm registers can be 62 * stored either in an AM/PM or a 24-hour format; the format is set 63 * globally and changing it requires re-writing both the hours time-of- 64 * year and alarm registers. In AM/PM mode, the hour must be in the 65 * range of 1-12 (and stored as either BCD or binary), with the high- 66 * bit cleared to indicate AM and set to indicate PM. In 24-hour mode, 67 * hours must be in the range 0-23. 68 * 69 * In order to support extended features like the century register and 70 * an embedded silicon serial number while keeping backwards compatibility 71 * with the DS1287/MC146818, the DS1687 provides a bank-switching method 72 * which allows the user to switch the RTC between a "compatible" mode in 73 * bank 0 and an extended mode in bank 1. 74 * 75 * Both banks provide access to the 14 timekeeping/alarm registers and 76 * to 50 bytes of user RAM. In addition, bank 0 provides access to an 77 * additional 64 bytes of user RAM in the upper half of the RTC address 78 * space. 79 * 80 * Bank 1, on the other hand, provides access to an extended register set, 81 * including a silicon serial number -- including a model ID byte, century 82 * register for Y2k compatibility and memory address/data registers which 83 * allow indirect access to a larger extended user RAM address space. It 84 * is worth noting that the extended user RAM is distinct from the "basic" 85 * 114 bytes of user RAM which are accesible in bank 0. 86 */ 87 88 /* 89 * The registers, and the bits within each register. 90 */ 91 92 #define DS1687_SEC 0x00 /* Time of year: seconds (0-59) */ 93 #define DS1687_ASEC 0x01 /* Alarm: seconds */ 94 #define DS1687_MIN 0x02 /* Time of year: minutes (0-59) */ 95 #define DS1687_AMIN 0x03 /* Alarm: minutes */ 96 #define DS1687_HOUR 0x04 /* Time of year: hour (see above) */ 97 #define DS1687_AHOUR 0x05 /* Alarm: hour (see above) */ 98 #define DS1687_DOW 0x06 /* Time of year: day of week (1-7, 1 = Sun) */ 99 #define DS1687_DOM 0x07 /* Time of year: day of month (1-31) */ 100 #define DS1687_MONTH 0x08 /* Time of year: month (1-12) */ 101 #define DS1687_YEAR 0x09 /* Time of year: year in century (0-99) */ 102 103 #define DS1687_CONTROLA 0x0a /* Control Register A */ 104 105 #define DS1687_UIP 0x80 /* Update in progress: RO */ 106 #define DS1687_DV2 0x40 /* Countdown chain: 0 = on, 1 = reset if DV1 */ 107 #define DS1687_DV1 0x20 /* Oscillator enable */ 108 #define DS1687_BANK1 0x10 /* Bank select: 0 = bank0, 1 = bank1 */ 109 #define DS1687_RATEMASK 0x0f /* Rate select bits for sq. wave and PIE */ 110 111 #define DS1687_CONTROLB 0x0b /* Control Register B */ 112 113 #define DS1687_SET 0x80 /* Clock update control: 1 = disable update */ 114 #define DS1687_PIE 0x40 /* Periodic interrupt enable */ 115 #define DS1687_AIE 0x20 /* Alarm interrupt enable */ 116 #define DS1687_UIE 0x10 /* Update-ended interrupt enable */ 117 #define DS1687_SQWE 0x08 /* Enable sq. wave output on SQW pin */ 118 #define DS1687_BINARY 0x04 /* Data mode: 0 = BCD, 1 = binary data */ 119 #define DS1687_24HRS 0x02 /* Hour format: 1 = 24hrs, 0 = 12hrs */ 120 #define DS1687_DSE 0x01 /* Daylight savings enable */ 121 122 #define DS1687_CONTROLC 0x0c /* Control register C: Read-only */ 123 /* Note: PF, AF, UF cleared on read */ 124 125 #define DS1687_IRQF 0x80 /* IRQ present: set when any IRQ is active */ 126 #define DS1687_PF 0x40 /* Periodic interrupt: independent of PIE */ 127 #define DS1687_AF 0x20 /* Alarm reached: independent of AIE */ 128 #define DS1687_UF 0x10 /* Update ended: independent of UIE */ 129 130 #define DS1687_CONTROLD 0x0d /* Control register D: Read-only */ 131 132 #define DS1687_VRT 0x80 /* Valid RAM and time: battery bad if 0 */ 133 134 #define DS1687_NVRAM_START 0x0e /* Start of user ram: offset 14 */ 135 #define DS1687_NVRAM_SIZE 0x72 /* 114 bytes of user RAM */ 136 137 #define DS1687_BANK1_START 0x40 /* BANK1: Start of BANK1 registers */ 138 #define DS1687_BANK1_CENTURY 0x48 /* BANK1: Time of yr: Century (0-99) */ 139 #define DS1687_BANK1_ADATE 0x49 /* BANK1: Alarm: Date (1-31) */ 140 141 #define DS1687_NBASEREGS 0x0d /* 14 registers; CMOS follows */ 142 #define D1687_NVRAM_START 0xe /* start of NVRAM: offset 14 */ 143 144 /* Layout of software shadow copy of TOD registers */ 145 #define DS1687_NHDW_TODREGS 0x0a /* 10 basic TOD registers */ 146 #define DS1687_NSOFT_TODREGS 0x0c /* ...plus shadow CENTURY, ADATE */ 147 148 #define DS1687_SOFT_SEC 0x00 149 #define DS1687_SOFT_ASEC 0x01 150 #define DS1687_SOFT_MIN 0x02 151 #define DS1687_SOFT_AMIN 0x03 152 #define DS1687_SOFT_HOUR 0x04 153 #define DS1687_SOFT_AHOUR 0x05 154 #define DS1687_SOFT_DOW 0x06 155 #define DS1687_SOFT_DOM 0x07 156 #define DS1687_SOFT_MONTH 0x08 157 #define DS1687_SOFT_YEAR 0x09 158 #define DS1687_SOFT_CENTURY 0x0a 159 #define DS1687_SOFT_ADATE 0x0b 160 161 /* 162 * RTC register/NVRAM read and write functions -- machine-dependent. 163 * Appropriately manipulate RTC registers to get/put data values. 164 */ 165 u_int ds1687_read __P((void *sc, u_int reg)); 166 void ds1687_write __P((void *sc, u_int reg, u_int datum)); 167 168 /* 169 * A collection of TOD/Alarm registers. 170 */ 171 typedef u_int ds1687_todregs[DS1687_NSOFT_TODREGS]; 172 173 /* 174 * Get all of the TOD/Alarm registers 175 * Must be called at splhigh(), and with the RTC properly set up. 176 */ 177 #define DS1687_GETTOD(sc, regs) \ 178 do { \ 179 int i; \ 180 u_int ctl; \ 181 \ 182 /* turn off update for now */ \ 183 ctl = ds1687_read(sc, DS1687_CONTROLB); \ 184 ds1687_write(sc, DS1687_CONTROLB, ctl | DS1687_SET); \ 185 \ 186 /* read all of the tod/alarm regs */ \ 187 for (i = 0; i < DS1687_NHDW_TODREGS; i++) \ 188 (*regs)[i] = ds1687_read(sc, i); \ 189 \ 190 (*regs)[DS1687_SOFT_CENTURY] = \ 191 ds1687_read(sc, DS1687_BANK1_CENTURY); \ 192 (*regs)[DS1687_SOFT_ADATE] = \ 193 ds1687_read(sc, DS1687_BANK1_ADATE); \ 194 \ 195 /* turn update back on */ \ 196 ds1687_write(sc, DS1687_CONTROLB, ctl); \ 197 } while (0); 198 199 /* 200 * Set all of the TOD/Alarm registers 201 * Must be called at splhigh(), and with the RTC properly set up. 202 */ 203 #define DS1687_PUTTOD(sc, regs) \ 204 do { \ 205 int i; \ 206 u_int ctl; \ 207 \ 208 /* turn off update for now */ \ 209 ctl = ds1687_read(sc, DS1687_CONTROLB); \ 210 ds1687_write(sc, DS1687_CONTROLB, ctl | DS1687_SET); \ 211 \ 212 /* write all of the tod/alarm regs */ \ 213 for (i = 0; i < DS1687_NHDW_TODREGS; i++) \ 214 ds1687_write(sc, i, (*regs)[i]); \ 215 \ 216 ds1687_write(sc, DS1687_BANK1_CENTURY, \ 217 (*regs)[DS1687_SOFT_CENTURY]); \ 218 ds1687_write(sc, DS1687_BANK1_ADATE, \ 219 (*regs)[DS1687_SOFT_ADATE]); \ 220 \ 221 /* turn update back on */ \ 222 ds1687_write(sc, DS1687_CONTROLB, ctl); \ 223 } while (0); 224
Indexes created Mon Sep 29 03:10:08 GMT 2025