xref: /netbsd/sys/dev/ic/mk48txxreg.h (revision bf9ec67e)
1 /*	$NetBSD: mk48txxreg.h,v 1.6 2002/02/23 17:18:56 scw Exp $ */
2 /*-
3  * Copyright (c) 2000 The NetBSD Foundation, Inc.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to The NetBSD Foundation
7  * by Paul Kranenburg.
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 by the NetBSD
20  *        Foundation, Inc. and its contributors.
21  * 4. Neither the name of The NetBSD Foundation nor the names of its
22  *    contributors may be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26  * ``AS IS'' AND 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 THE FOUNDATION OR CONTRIBUTORS
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 /*
39  * Mostek MK48Txx clocks.
40  *
41  * The MK48T02 has 2KB of non-volatile memory. The time-of-day clock
42  * registers start at offset 0x7f8.
43  *
44  * The MK48T08 and MK48T18 have 8KB of non-volatile memory
45  *
46  * The MK48T59 also has 8KB of non-volatile memory but in addition it
47  * has a battery low detection bit and a power supply wakeup alarm for
48  * power management.  It's at offset 0x1ff0 in the NVRAM.
49  */
50 
51 /*
52  * Mostek MK48TXX register definitions
53  */
54 
55 /*
56  * The first bank of eight registers at offset (nvramsz - 16) is
57  * available only on recenter (which??) MK48Txx models.
58  */
59 #define MK48TXX_X0	0	/* find out later */
60 				/* ... */
61 #define MK48TXX_X7	7	/* find out later */
62 #define MK48TXX_ICSR	8	/* control register */
63 #define MK48TXX_ISEC	9	/* seconds (0..59; BCD) */
64 #define MK48TXX_IMIN	10	/* minutes (0..59; BCD) */
65 #define MK48TXX_IHOUR	11	/* hour (0..23; BCD) */
66 #define MK48TXX_IWDAY	12	/* weekday (1..7) */
67 #define MK48TXX_IDAY	13	/* day in month (1..31; BCD) */
68 #define MK48TXX_IMON	14	/* month (1..12; BCD) */
69 #define MK48TXX_IYEAR	15	/* year (0..99; BCD) */
70 
71 /* Bits in the control register */
72 #define MK48TXX_CSR_WRITE	0x80	/* want to write */
73 #define MK48TXX_CSR_READ	0x40	/* want to read (freeze clock) */
74 
75 #define MK48T02_CLKSZ		2048
76 #define MK48T02_CLKOFF		0x7f0
77 
78 #define MK48T08_CLKSZ		8192
79 #define MK48T08_CLKOFF		0x1ff0
80 
81 #define MK48T18_CLKSZ		8192
82 #define MK48T18_CLKOFF		0x1ff0
83 
84 #define MK48T59_CLKSZ		8192
85 #define MK48T59_CLKOFF		0x1ff0
86 
87 typedef u_int8_t (*mk48txx_nvrd_t)(bus_space_tag_t, bus_space_handle_t, int);
88 typedef void (*mk48txx_nvwr_t)(bus_space_tag_t, bus_space_handle_t, int,
89 	    u_int8_t);
90 
91 /* Chip attach function */
92 todr_chip_handle_t mk48txx_attach(bus_space_tag_t, bus_space_handle_t,
93 	    const char *, int, mk48txx_nvrd_t, mk48txx_nvwr_t);
94 
95 /* Retrieve size of the on-chip NVRAM area */
96 int	mk48txx_get_nvram_size(todr_chip_handle_t, bus_size_t *);
97