xref: /freebsd/sys/dev/powermac_nvram/powermac_nvramvar.h (revision 058ac3e8063366dafa634d9107642e12b038bf09)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2006 Maxim Sobolev <sobomax@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef	_POWERPC_POWERMAC_POWERMAC_NVRAMVAR_H_
32 #define	_POWERPC_POWERMAC_POWERMAC_NVRAMVAR_H_
33 
34 #define	NVRAM_SIZE		0x2000
35 
36 #define	CORE99_SIGNATURE	0x5a
37 
38 #define SM_FLASH_CMD_ERASE_CONFIRM	0xd0
39 #define SM_FLASH_CMD_ERASE_SETUP	0x20
40 #define SM_FLASH_CMD_RESET		0xff
41 #define SM_FLASH_CMD_WRITE_SETUP	0x40
42 #define SM_FLASH_CMD_CLEAR_STATUS	0x50
43 #define SM_FLASH_CMD_READ_STATUS	0x70
44 
45 #define SM_FLASH_STATUS_DONE	0x80
46 #define SM_FLASH_STATUS_ERR	0x38
47 
48 #ifdef _KERNEL
49 
50 struct powermac_nvram_softc {
51 	device_t		sc_dev;
52 	struct sx		sc_lock;
53 	phandle_t		sc_node;
54 	void *			sc_bank;
55 	void *			sc_bank0;
56 	void *			sc_bank1;
57 	uint8_t			sc_data[NVRAM_SIZE];
58 
59 	struct cdev *		sc_cdev;
60 	int			sc_type;
61 #define FLASH_TYPE_SM	0
62 #define FLASH_TYPE_AMD	1
63 	int			sc_isopen;
64 	int			sc_rpos;
65 	int			sc_wpos;
66 };
67 
68 #endif /* _KERNEL */
69 
70 struct chrp_header {
71 	uint8_t			signature;
72 	uint8_t			chrp_checksum;
73 	uint16_t		length;
74 	char			name[12];
75 };
76 
77 struct core99_header {
78 	struct chrp_header	chrp_header;
79 	uint32_t		adler_checksum;
80 	uint32_t		generation;
81 	uint32_t		reserved[2];
82 };
83 
84 #endif  /* _POWERPC_POWERMAC_POWERMAC_NVRAMVAR_H_ */
85