nvram.h revision 1.1.4.3 1 1.1.4.3 yamt /* $NetBSD: nvram.h,v 1.1.4.3 2006/06/26 12:45:14 yamt Exp $ */
2 1.1.4.2 yamt
3 1.1.4.2 yamt /*-
4 1.1.4.2 yamt * Copyright (c) 2006 The NetBSD Foundation, Inc.
5 1.1.4.2 yamt * All rights reserved.
6 1.1.4.2 yamt *
7 1.1.4.2 yamt * This code is derived from software contributed to The NetBSD Foundation
8 1.1.4.2 yamt * by Tim Rightnour
9 1.1.4.2 yamt *
10 1.1.4.2 yamt * Redistribution and use in source and binary forms, with or without
11 1.1.4.2 yamt * modification, are permitted provided that the following conditions
12 1.1.4.2 yamt * are met:
13 1.1.4.2 yamt * 1. Redistributions of source code must retain the above copyright
14 1.1.4.2 yamt * notice, this list of conditions and the following disclaimer.
15 1.1.4.2 yamt * 2. Redistributions in binary form must reproduce the above copyright
16 1.1.4.2 yamt * notice, this list of conditions and the following disclaimer in the
17 1.1.4.2 yamt * documentation and/or other materials provided with the distribution.
18 1.1.4.2 yamt * 3. All advertising materials mentioning features or use of this software
19 1.1.4.2 yamt * must display the following acknowledgement:
20 1.1.4.2 yamt * This product includes software developed by the NetBSD
21 1.1.4.2 yamt * Foundation, Inc. and its contributors.
22 1.1.4.2 yamt * 4. Neither the name of The NetBSD Foundation nor the names of its
23 1.1.4.2 yamt * contributors may be used to endorse or promote products derived
24 1.1.4.2 yamt * from this software without specific prior written permission.
25 1.1.4.2 yamt *
26 1.1.4.2 yamt * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 1.1.4.2 yamt * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 1.1.4.2 yamt * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 1.1.4.2 yamt * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 1.1.4.2 yamt * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 1.1.4.2 yamt * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 1.1.4.2 yamt * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 1.1.4.2 yamt * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 1.1.4.2 yamt * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 1.1.4.2 yamt * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 1.1.4.2 yamt * POSSIBILITY OF SUCH DAMAGE.
37 1.1.4.2 yamt */
38 1.1.4.2 yamt
39 1.1.4.2 yamt /*
40 1.1.4.2 yamt * Based on the PowerPC Reference Platform NVRAM Specification.
41 1.1.4.2 yamt * Document Number: PPS-AR-FW0002
42 1.1.4.2 yamt * Jan 22, 1996
43 1.1.4.2 yamt * Version 0.3
44 1.1.4.2 yamt */
45 1.1.4.2 yamt
46 1.1.4.2 yamt #ifndef _MACHINE_NVRAM_H
47 1.1.4.2 yamt #define _MACHINE_NVRAM_H
48 1.1.4.2 yamt
49 1.1.4.3 yamt /* for the motorola machines */
50 1.1.4.3 yamt #include <dev/ic/mk48txxvar.h>
51 1.1.4.3 yamt
52 1.1.4.2 yamt #define MAX_PREP_NVRAM 0x8000 /* maxmum size of the nvram */
53 1.1.4.2 yamt
54 1.1.4.2 yamt #define NVSIZE 4096 /* standard nvram size */
55 1.1.4.2 yamt #define OSAREASIZE 512 /* size of OSArea space */
56 1.1.4.2 yamt #define CONFSIZE 1024 /* guess at size of configuration area */
57 1.1.4.2 yamt
58 1.1.4.2 yamt /*
59 1.1.4.2 yamt * The security fields are maintained by the firmware, and should be
60 1.1.4.2 yamt * considered read-only.
61 1.1.4.2 yamt */
62 1.1.4.2 yamt typedef struct _SECURITY {
63 1.1.4.2 yamt uint32_t BootErrCnt; /* count of boot password errors */
64 1.1.4.2 yamt uint32_t ConfigErrCnt; /* count of config password errors */
65 1.1.4.2 yamt uint32_t BootErrorDT[2];/* Date&Time from RTC of last error in pw */
66 1.1.4.2 yamt uint32_t ConfigErrorDT[2]; /* last config pw error */
67 1.1.4.2 yamt uint32_t BootCorrectDT[2]; /* last correct boot pw */
68 1.1.4.2 yamt uint32_t ConfigCorrectDT[2]; /* last correct config pw */
69 1.1.4.2 yamt uint32_t BootSetDT[2]; /* last set of boot pw */
70 1.1.4.2 yamt uint32_t ConfigSetDT[2]; /* last set of config pw */
71 1.1.4.2 yamt uint8_t Serial[16]; /* Box serial number */
72 1.1.4.2 yamt } SECURITY;
73 1.1.4.2 yamt
74 1.1.4.2 yamt typedef enum _ERROR_STATUS {
75 1.1.4.2 yamt Clear = 0, /* empty entry */
76 1.1.4.2 yamt Pending = 1,
77 1.1.4.2 yamt DiagnosedOK = 2,
78 1.1.4.2 yamt DiagnosedFail = 3,
79 1.1.4.2 yamt Overrun = 4,
80 1.1.4.2 yamt Logged = 5,
81 1.1.4.2 yamt } ERROR_STATUS;
82 1.1.4.2 yamt
83 1.1.4.2 yamt typedef enum _OS_ID {
84 1.1.4.2 yamt Unknown = 0,
85 1.1.4.2 yamt Firmware = 1,
86 1.1.4.2 yamt AIX = 2,
87 1.1.4.2 yamt NT = 3,
88 1.1.4.2 yamt WPOS2 = 4,
89 1.1.4.2 yamt WPX = 5,
90 1.1.4.2 yamt Taligent = 6,
91 1.1.4.2 yamt Solaris = 7,
92 1.1.4.2 yamt Netware = 8,
93 1.1.4.2 yamt USL = 9,
94 1.1.4.2 yamt Low_End_Client = 10,
95 1.1.4.2 yamt SCO = 11,
96 1.1.4.2 yamt MK = 12, /* from linux ?? */
97 1.1.4.2 yamt } OS_ID;
98 1.1.4.2 yamt
99 1.1.4.2 yamt /*
100 1.1.4.2 yamt * According to IBM, if severity is severe, the OS should not boot. It should
101 1.1.4.2 yamt * instead run diags. Umm.. whatever.
102 1.1.4.2 yamt */
103 1.1.4.2 yamt
104 1.1.4.2 yamt typedef struct _ERROR_LOG {
105 1.1.4.2 yamt uint8_t Status; /* ERROR_STATUS */
106 1.1.4.2 yamt uint8_t Os; /* OS_ID */
107 1.1.4.2 yamt uint8_t Type; /* H=hardware S=software */
108 1.1.4.2 yamt uint8_t Severity; /* S=servere E=Error */
109 1.1.4.2 yamt uint32_t ErrDT[2]; /* date and time from RTC */
110 1.1.4.2 yamt uint8_t code[8]; /* error code */
111 1.1.4.2 yamt union {
112 1.1.4.2 yamt uint8_t detail[20]; /* detail of error */
113 1.1.4.2 yamt } data;
114 1.1.4.2 yamt } ERROR_LOG;
115 1.1.4.2 yamt
116 1.1.4.2 yamt typedef enum _BOOT_STATUS {
117 1.1.4.2 yamt BootStarted = 0x01,
118 1.1.4.2 yamt BootFinished = 0x02,
119 1.1.4.2 yamt RestartStarted = 0x04,
120 1.1.4.2 yamt RestartFinished = 0x08,
121 1.1.4.2 yamt PowerFailStarted = 0x10,
122 1.1.4.2 yamt PowerFailFinished = 0x20,
123 1.1.4.2 yamt ProcessorReady = 0x40,
124 1.1.4.2 yamt ProcessorRunning = 0x80,
125 1.1.4.2 yamt ProcessorStart = 0x0100
126 1.1.4.2 yamt } BOOT_STATUS;
127 1.1.4.2 yamt
128 1.1.4.2 yamt /*
129 1.1.4.2 yamt * If the OS decided to store data in the os area of NVRAM, this tells us
130 1.1.4.2 yamt * the last user, so we can decide if we want to re-use it or nuke it.
131 1.1.4.2 yamt * I'm not sure what all of these do yet.
132 1.1.4.2 yamt */
133 1.1.4.2 yamt typedef struct _RESTART_BLOCK {
134 1.1.4.2 yamt uint16_t Version;
135 1.1.4.2 yamt uint16_t Revision;
136 1.1.4.2 yamt uint32_t BootMasterId;
137 1.1.4.2 yamt uint32_t ProcessorId;
138 1.1.4.2 yamt volatile uint32_t BootStatus;
139 1.1.4.2 yamt uint32_t CheckSum; /* Checksum of RESTART_BLOCK */
140 1.1.4.2 yamt void *RestartAddress;
141 1.1.4.2 yamt void *SaveAreaAddr;
142 1.1.4.2 yamt uint32_t SaveAreaLength;
143 1.1.4.2 yamt } RESTART_BLOCK;
144 1.1.4.2 yamt
145 1.1.4.2 yamt typedef enum _OSAREA_USAGE {
146 1.1.4.2 yamt Empty = 0,
147 1.1.4.2 yamt Used = 1,
148 1.1.4.2 yamt } OSAREA_USAGE;
149 1.1.4.2 yamt
150 1.1.4.2 yamt typedef enum _PM_MODE {
151 1.1.4.2 yamt Suspend = 0x80, /* part of state is in memory */
152 1.1.4.2 yamt DirtyBit = 0x01, /* used to decide if pushbutton needs to be checked */
153 1.1.4.2 yamt Hibernate = 0, /* nothing is in memory */
154 1.1.4.2 yamt } PMMODE;
155 1.1.4.2 yamt
156 1.1.4.2 yamt typedef struct _HEADER {
157 1.1.4.2 yamt uint16_t Size; /* NVRAM size in K(1024) */
158 1.1.4.2 yamt uint8_t Version; /* Structure map different */
159 1.1.4.2 yamt uint8_t Revision; /* Structure map same */
160 1.1.4.2 yamt uint16_t Crc1; /* checksum from beginning of nvram to OSArea*/
161 1.1.4.2 yamt uint16_t Crc2; /* cksum of config */
162 1.1.4.2 yamt uint8_t LastOS; /* OS_ID */
163 1.1.4.2 yamt uint8_t Endian; /* B if BE L if LE */
164 1.1.4.2 yamt uint8_t OSAreaUSage; /* OSAREA_USAGE */
165 1.1.4.2 yamt uint8_t PMMode; /* Shutdown mode */
166 1.1.4.2 yamt RESTART_BLOCK RestartBlock;
167 1.1.4.2 yamt SECURITY Security;
168 1.1.4.2 yamt ERROR_LOG ErrorLog[2];
169 1.1.4.2 yamt
170 1.1.4.2 yamt /* Global Environment info */
171 1.1.4.2 yamt void *GEAddress;
172 1.1.4.2 yamt uint32_t GELength;
173 1.1.4.2 yamt uint32_t GELastWRiteDT[2]; /* last change to GE area */
174 1.1.4.2 yamt
175 1.1.4.2 yamt /* Configuration info */
176 1.1.4.2 yamt void *ConfigAddress;
177 1.1.4.2 yamt uint32_t ConfigLength;
178 1.1.4.2 yamt uint32_t ConfigLastWriteDT[2]; /* last change to config area */
179 1.1.4.2 yamt uint32_t ConfigCount; /* count of entries in configuration */
180 1.1.4.2 yamt
181 1.1.4.2 yamt /* OS Dependant temp area */
182 1.1.4.2 yamt void *OSAreaAddress;
183 1.1.4.2 yamt uint32_t OSAreaLength;
184 1.1.4.2 yamt uint32_t OSAreaLastWriteDT[2]; /* last change to OSArea */
185 1.1.4.2 yamt } HEADER;
186 1.1.4.2 yamt
187 1.1.4.2 yamt typedef struct _NVRAM_MAP {
188 1.1.4.2 yamt HEADER Header;
189 1.1.4.2 yamt uint8_t GEArea[NVSIZE - CONFSIZE - OSAREASIZE - sizeof(HEADER)];
190 1.1.4.2 yamt uint8_t OSArea[OSAREASIZE];
191 1.1.4.2 yamt uint8_t ConfigArea[CONFSIZE];
192 1.1.4.2 yamt } NVRAM_MAP;
193 1.1.4.2 yamt
194 1.1.4.2 yamt struct pnviocdesc {
195 1.1.4.2 yamt int pnv_namelen; /* len of pnv_name */
196 1.1.4.2 yamt char *pnv_name; /* node name */
197 1.1.4.2 yamt int pnv_buflen; /* len of pnv_bus */
198 1.1.4.2 yamt char *pnv_buf; /* option value result */
199 1.1.4.2 yamt int pnv_num; /* number of something */
200 1.1.4.2 yamt };
201 1.1.4.2 yamt
202 1.1.4.3 yamt struct prep_mk48txx_softc {
203 1.1.4.3 yamt struct device sc_dev;
204 1.1.4.3 yamt bus_space_tag_t sc_bst; /* bus tag & handle */
205 1.1.4.3 yamt bus_space_handle_t sc_bsh; /* */
206 1.1.4.3 yamt
207 1.1.4.3 yamt struct todr_chip_handle sc_handle; /* TODR handle */
208 1.1.4.3 yamt const char *sc_model; /* chip model name */
209 1.1.4.3 yamt bus_size_t sc_nvramsz; /* Size of NVRAM on the chip */
210 1.1.4.3 yamt bus_size_t sc_clkoffset; /* Offset in NVRAM to clock bits */
211 1.1.4.3 yamt u_int sc_year0; /* What year is represented on
212 1.1.4.3 yamt the system by the chip's year
213 1.1.4.3 yamt counter at 0 */
214 1.1.4.3 yamt u_int sc_flag;
215 1.1.4.3 yamt #define MK48TXX_NO_CENT_ADJUST 0x0001
216 1.1.4.3 yamt
217 1.1.4.3 yamt mk48txx_nvrd_t sc_nvrd; /* NVRAM/RTC read function */
218 1.1.4.3 yamt mk48txx_nvwr_t sc_nvwr; /* NVRAM/RTC write function */
219 1.1.4.3 yamt bus_space_tag_t sc_data;
220 1.1.4.3 yamt bus_space_handle_t sc_datah;
221 1.1.4.3 yamt };
222 1.1.4.3 yamt
223 1.1.4.2 yamt struct nvram_pnpbus_softc {
224 1.1.4.2 yamt struct device sc_dev; /* base device */
225 1.1.4.2 yamt
226 1.1.4.2 yamt bus_space_tag_t sc_iot; /* io space tag */
227 1.1.4.2 yamt bus_space_tag_t sc_as; /* addr line */
228 1.1.4.2 yamt bus_space_handle_t sc_ash;
229 1.1.4.2 yamt bus_space_handle_t sc_ashs[2];
230 1.1.4.2 yamt
231 1.1.4.2 yamt bus_space_tag_t sc_data; /* data line */
232 1.1.4.2 yamt bus_space_handle_t sc_datah;
233 1.1.4.3 yamt
234 1.1.4.3 yamt /* clock bits for mk48txx */
235 1.1.4.3 yamt struct prep_mk48txx_softc sc_mksc; /* mk48txx softc */
236 1.1.4.3 yamt
237 1.1.4.2 yamt u_char sc_open; /* single use device */
238 1.1.4.2 yamt };
239 1.1.4.2 yamt
240 1.1.4.2 yamt #define PNVIOCGET _IOWR('O', 1, struct pnviocdesc) /* get var contents */
241 1.1.4.2 yamt #define PNVIOCGETNEXTNAME _IOWR('O', 2, struct pnviocdesc) /* get next var */
242 1.1.4.2 yamt
243 1.1.4.2 yamt #endif /* _MACHINE_NVRAM_H */
244