xref: /openbsd/sys/dev/ic/mk48txxreg.h (revision 73471bf0)
1 /*	$OpenBSD: mk48txxreg.h,v 1.5 2009/05/15 23:02:25 miod Exp $	*/
2 /*	$NetBSD: mk48txxreg.h,v 1.4 2000/11/11 11:59:42 pk Exp $ */
3 /*-
4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Paul Kranenburg.
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  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Mostek MK48Txx clocks.
34  *
35  * The MK48T02 has 2KB of non-volatile memory. The time-of-day clock
36  * registers start at offset 0x7f8.
37  *
38  * The MK48T08 and MK48T18 have 8KB of non-volatile memory
39  *
40  * The MK48T59 also has 8KB of non-volatile memory but in addition it
41  * has a battery low detection bit and a power supply wakeup alarm for
42  * power management.  It's at offset 0x1ff0 in the NVRAM.
43  */
44 
45 /*
46  * Mostek MK48TXX register definitions
47  */
48 
49 /*
50  * The first bank of eight registers at offset (nvramsz - 16) is
51  * available only on recenter (which??) MK48Txx models.
52  */
53 #define MK48TXX_X0	0	/* find out later */
54 				/* ... */
55 #define MK48TXX_X7	7	/* find out later */
56 #define MK48TXX_ICSR	8	/* control register */
57 #define MK48TXX_ISEC	9	/* seconds (0..59; BCD) */
58 #define MK48TXX_IMIN	10	/* minutes (0..59; BCD) */
59 #define MK48TXX_IHOUR	11	/* hour (0..23; BCD) */
60 #define MK48TXX_IWDAY	12	/* weekday (1..7) */
61 #define MK48TXX_IDAY	13	/* day in month (1..31; BCD) */
62 #define MK48TXX_IMON	14	/* month (1..12; BCD) */
63 #define MK48TXX_IYEAR	15	/* year (0..99; BCD) */
64 
65 /* Bits in the control register */
66 #define MK48TXX_CSR_WRITE	0x80	/* want to write */
67 #define MK48TXX_CSR_READ	0x40	/* want to read (freeze clock) */
68 
69 #define MK48T02_CLKSZ		2048
70 #define MK48T02_CLKOFF		0x7f0
71 
72 #define MK48T08_CLKSZ		8192
73 #define MK48T08_CLKOFF		0x1ff0
74 
75 #define MK48T18_CLKSZ		8192
76 #define MK48T18_CLKOFF		0x1ff0
77 
78 #define MK48T59_CLKSZ		8192
79 #define MK48T59_CLKOFF		0x1ff0
80 
81 #define	MK48T35_CLKSZ		0x8000
82 #define	MK48T35_CLKOFF		0x7ff0
83 
84 /* Chip attach function */
85 todr_chip_handle_t mk48txx_attach(bus_space_tag_t, bus_space_handle_t,
86 				  const char *, int);
87 
88 /* Retrieve size of the on-chip NVRAM area */
89 int	mk48txx_get_nvram_size(todr_chip_handle_t, bus_size_t *);
90