xref: /freebsd/sys/dev/powermac_nvram/powermac_nvramvar.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 
29 #ifndef	_POWERPC_POWERMAC_POWERMAC_NVRAMVAR_H_
30 #define	_POWERPC_POWERMAC_POWERMAC_NVRAMVAR_H_
31 
32 #define	NVRAM_SIZE		0x2000
33 
34 #define	CORE99_SIGNATURE	0x5a
35 
36 #define SM_FLASH_CMD_ERASE_CONFIRM	0xd0
37 #define SM_FLASH_CMD_ERASE_SETUP	0x20
38 #define SM_FLASH_CMD_RESET		0xff
39 #define SM_FLASH_CMD_WRITE_SETUP	0x40
40 #define SM_FLASH_CMD_CLEAR_STATUS	0x50
41 #define SM_FLASH_CMD_READ_STATUS	0x70
42 
43 #define SM_FLASH_STATUS_DONE	0x80
44 #define SM_FLASH_STATUS_ERR	0x38
45 
46 #ifdef _KERNEL
47 
48 struct powermac_nvram_softc {
49 	device_t		sc_dev;
50 	struct sx		sc_lock;
51 	phandle_t		sc_node;
52 	void *			sc_bank;
53 	void *			sc_bank0;
54 	void *			sc_bank1;
55 	uint8_t			sc_data[NVRAM_SIZE];
56 
57 	struct cdev *		sc_cdev;
58 	int			sc_type;
59 #define FLASH_TYPE_SM	0
60 #define FLASH_TYPE_AMD	1
61 	int			sc_isopen;
62 	int			sc_rpos;
63 	int			sc_wpos;
64 };
65 
66 #endif /* _KERNEL */
67 
68 struct chrp_header {
69 	uint8_t			signature;
70 	uint8_t			chrp_checksum;
71 	uint16_t		length;
72 	char			name[12];
73 };
74 
75 struct core99_header {
76 	struct chrp_header	chrp_header;
77 	uint32_t		adler_checksum;
78 	uint32_t		generation;
79 	uint32_t		reserved[2];
80 };
81 
82 #endif  /* _POWERPC_POWERMAC_POWERMAC_NVRAMVAR_H_ */
83