1/* $NetBSD: mc146818reg.h,v 1.8 2005/12/11 12:21:27 christos Exp $ */ 2 3/* 4 * Copyright (c) 1995 Carnegie-Mellon University. 5 * All rights reserved. 6 * 7 * Permission to use, copy, modify and distribute this software and 8 * its documentation is hereby granted, provided that both the copyright 9 * notice and this permission notice appear in all copies of the 10 * software, derivative works or modified versions, and any portions 11 * thereof, and that both notices appear in supporting documentation. 12 * 13 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 14 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 15 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 16 * 17 * Carnegie Mellon requests users of this software to return to 18 * 19 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 20 * School of Computer Science 21 * Carnegie Mellon University 22 * Pittsburgh PA 15213-3890 23 * 24 * any improvements or extensions that they make and grant Carnegie the 25 * rights to redistribute these changes. 26 */ 27 28/* 29 * Definitions for the Motorola MC146818A Real Time Clock. 30 * They also apply for the (compatible) Dallas Semiconductor DS1287A RTC. 31 * 32 * Though there are undoubtedly other (better) sources, this material was 33 * culled from the DEC "KN121 System Module Programmer's Reference 34 * Information." 35 * 36 * The MC146818A has 16 registers. The first 10 contain time-of-year 37 * and alarm data. The rest contain various control and status bits. 38 * 39 * To read or write the registers, one writes the register number to 40 * the RTC's control port, then either reads from or writes the new 41 * data to the RTC's data port. Since the locations of these ports 42 * and the method used to access them can be machine-dependent, the 43 * low-level details of reading and writing the RTC's registers are 44 * handled by machine-specific functions. 45 * 46 * The time-of-year and alarm data can be expressed in either binary 47 * or BCD, and they are selected by a bit in register B. 48 * 49 * The "hour" time-of-year and alarm fields can either be expressed in 50 * AM/PM format, or in 24-hour format. If AM/PM format is chosen, the 51 * hour fields can have the values: 1-12 and 81-92 (the latter being 52 * PM). If the 24-hour format is chosen, they can have the values 53 * 0-24. The hour format is selectable by a bit in register B. 54 * (XXX IS AM/PM MODE DESCRIPTION CORRECT?) 55 * 56 * It is assumed the if systems are going to use BCD (rather than 57 * binary) mode, or AM/PM hour format, they'll do the appropriate 58 * conversions in machine-dependent code. Also, if the clock is 59 * switched between BCD and binary mode, or between AM/PM mode and 60 * 24-hour mode, the time-of-day and alarm registers are NOT 61 * automatically reset; they must be reprogrammed with correct values. 62 */ 63 64/* XXX not yet all port switch to MI mc146818(4) with todr(9) support */ 65#if defined(arc) 66#define USE_TODR_MCCLOCK 67#endif 68 69/* 70 * The registers, and the bits within each register. 71 */ 72 73#define MC_SEC 0x0 /* Time of year: seconds (0-59) */ 74#define MC_ASEC 0x1 /* Alarm: seconds */ 75#define MC_MIN 0x2 /* Time of year: minutes (0-59) */ 76#define MC_AMIN 0x3 /* Alarm: minutes */ 77#define MC_HOUR 0x4 /* Time of year: hour (see above) */ 78#define MC_AHOUR 0x5 /* Alarm: hour */ 79#define MC_DOW 0x6 /* Time of year: day of week (1-7) */ 80#define MC_DOM 0x7 /* Time of year: day of month (1-31) */ 81#define MC_MONTH 0x8 /* Time of year: month (1-12) */ 82#define MC_YEAR 0x9 /* Time of year: year in century (0-99) */ 83 84#define MC_REGA 0xa /* Control register A */ 85 86#define MC_REGA_RSMASK 0x0f /* Interrupt rate select mask (see below) */ 87#define MC_REGA_DVMASK 0x70 /* Divisor select mask (see below) */ 88#define MC_REGA_UIP 0x80 /* Update in progress; read only. */ 89 90#define MC_REGB 0xb /* Control register B */ 91 92#define MC_REGB_DSE 0x01 /* Daylight Savings Enable */ 93#define MC_REGB_24HR 0x02 /* 24-hour mode (AM/PM mode when clear) */ 94#define MC_REGB_BINARY 0x04 /* Binary mode (BCD mode when clear) */ 95#define MC_REGB_SQWE 0x08 /* Square Wave Enable */ 96#define MC_REGB_UIE 0x10 /* Update End interrupt enable */ 97#define MC_REGB_AIE 0x20 /* Alarm interrupt enable */ 98#define MC_REGB_PIE 0x40 /* Periodic interrupt enable */ 99#define MC_REGB_SET 0x80 /* Allow time to be set; stops updates */ 100 101#define MC_REGC 0xc /* Control register C */ 102 103/* MC_REGC_UNUSED 0x0f UNUSED */ 104#define MC_REGC_UF 0x10 /* Update End interrupt flag */ 105#define MC_REGC_AF 0x20 /* Alarm interrupt flag */ 106#define MC_REGC_PF 0x40 /* Periodic interrupt flag */ 107#define MC_REGC_IRQF 0x80 /* Interrupt request pending flag */ 108 109#define MC_REGD 0xd /* Control register D */ 110 111/* MC_REGD_UNUSED 0x7f UNUSED */ 112#define MC_REGD_VRT 0x80 /* Valid RAM and Time bit */ 113 114 115#define MC_NREGS 0xe /* 14 registers; CMOS follows */ 116#define MC_NTODREGS 0xa /* 10 of those regs are for TOD and alarm */ 117 118#define MC_NVRAM_START 0xe /* start of NVRAM: offset 14 */ 119#define MC_NVRAM_SIZE 50 /* 50 bytes of NVRAM */ 120 121/* 122 * Periodic Interrupt Rate Select constants (Control register A) 123 */ 124#define MC_RATE_NONE 0x0 /* No periodic interrupt */ 125#define MC_RATE_1 0x1 /* 256 Hz if MC_BASE_32_KHz, else 32768 Hz */ 126#define MC_RATE_2 0x2 /* 128 Hz if MC_BASE_32_KHz, else 16384 Hz */ 127#define MC_RATE_8192_Hz 0x3 /* 122.070 us period */ 128#define MC_RATE_4096_Hz 0x4 /* 244.141 us period */ 129#define MC_RATE_2048_Hz 0x5 /* 488.281 us period */ 130#define MC_RATE_1024_Hz 0x6 /* 976.562 us period */ 131#define MC_RATE_512_Hz 0x7 /* 1.953125 ms period */ 132#define MC_RATE_256_Hz 0x8 /* 3.90625 ms period */ 133#define MC_RATE_128_Hz 0x9 /* 7.8125 ms period */ 134#define MC_RATE_64_Hz 0xa /* 15.625 ms period */ 135#define MC_RATE_32_Hz 0xb /* 31.25 ms period */ 136#define MC_RATE_16_Hz 0xc /* 62.5 ms period */ 137#define MC_RATE_8_Hz 0xd /* 125 ms period */ 138#define MC_RATE_4_Hz 0xe /* 250 ms period */ 139#define MC_RATE_2_Hz 0xf /* 500 ms period */ 140 141/* 142 * Time base (divisor select) constants (Control register A) 143 */ 144#define MC_BASE_4_MHz 0x00 /* 4 MHz crystal */ 145#define MC_BASE_1_MHz 0x10 /* 1 MHz crystal */ 146#define MC_BASE_32_KHz 0x20 /* 32 kHz crystal */ 147#define MC_BASE_NONE 0x60 /* actually, both of these reset */ 148#define MC_BASE_RESET 0x70 149 150#ifndef USE_TODR_MCCLOCK 151/* 152 * RTC register/NVRAM read and write functions -- machine-dependent. 153 * Appropriately manipulate RTC registers to get/put data values. 154 */ 155u_int mc146818_read(void *, u_int); 156void mc146818_write(void *, u_int, u_int); 157 158/* 159 * A collection of TOD/Alarm registers. 160 */ 161typedef u_int mc_todregs[MC_NTODREGS]; 162 163/* 164 * Get all of the TOD/Alarm registers 165 * Must be called at splhigh(), and with the RTC properly set up. 166 */ 167#define MC146818_GETTOD(sc, regs) \ 168 do { \ 169 int i; \ 170 \ 171 /* update in progress; spin loop */ \ 172 while (mc146818_read(sc, MC_REGA) & MC_REGA_UIP) \ 173 ; \ 174 \ 175 /* read all of the tod/alarm regs */ \ 176 for (i = 0; i < MC_NTODREGS; i++) \ 177 (*regs)[i] = mc146818_read(sc, i); \ 178 } while (0); 179 180/* 181 * Set all of the TOD/Alarm registers 182 * Must be called at splhigh(), and with the RTC properly set up. 183 */ 184#define MC146818_PUTTOD(sc, regs) \ 185 do { \ 186 int i; \ 187 \ 188 /* stop updates while setting */ \ 189 mc146818_write(sc, MC_REGB, \ 190 mc146818_read(sc, MC_REGB) | MC_REGB_SET); \ 191 \ 192 /* write all of the tod/alarm regs */ \ 193 for (i = 0; i < MC_NTODREGS; i++) \ 194 mc146818_write(sc, i, (*regs)[i]); \ 195 \ 196 /* reenable updates */ \ 197 mc146818_write(sc, MC_REGB, \ 198 mc146818_read(sc, MC_REGB) & ~MC_REGB_SET); \ 199 } while (0); 200#endif /* USE_TODR_MCCLOCK */ 201