1/*-
2 * Copyright (c) 2010 Aleksandr Rybalko.
3 * Copyright (c) 2016 Michael Zhilin.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 *
27 * $FreeBSD$
28 */
29
30
31#ifndef NVRAM2ENV_NVRAM2ENV_H_
32#define	NVRAM2ENV_NVRAM2ENV_H_
33
34#define	nvram2env_read_1(sc, reg)				\
35	bus_space_read_1((sc)->sc_bt, (sc)->sc_bh,(reg))
36
37#define	nvram2env_read_2(sc, reg)				\
38	bus_space_read_2((sc)->sc_bt, (sc)->sc_bh,(reg))
39
40#define	nvram2env_read_4(sc, reg)				\
41	bus_space_read_4((sc)->sc_bt, (sc)->sc_bh,(reg))
42
43#define	nvram2env_write_1(sc, reg, val)			\
44	bus_space_write_1((sc)->sc_bt, (sc)->sc_bh,	\
45			 (reg), (val))
46
47#define	nvram2env_write_2(sc, reg, val)			\
48	bus_space_write_2((sc)->sc_bt, (sc)->sc_bh,	\
49			 (reg), (val))
50
51#define	nvram2env_write_4(sc, reg, val)			\
52	bus_space_write_4((sc)->sc_bt, (sc)->sc_bh,	\
53			 (reg), (val))
54
55struct nvram2env_softc {
56	bus_space_tag_t bst;
57	bus_space_handle_t bsh;
58	bus_addr_t addr;
59	int need_swap;
60	uint32_t sig;
61	uint32_t flags;
62#define	NVRAM_FLAGS_NOCHECK	0x0001	/* Do not check(CRC or somthing else)*/
63#define	NVRAM_FLAGS_GENERIC	0x0002	/* Format Generic, skip 4b and read */
64#define	NVRAM_FLAGS_BROADCOM	0x0004	/* Format Broadcom, use struct nvram */
65#define	NVRAM_FLAGS_UBOOT	0x0008	/* Format Generic, skip 4b of CRC and read */
66	uint32_t maxsize;
67	uint32_t crc;
68};
69
70#define	NVRAM_MAX_SIZE	0x10000
71#define	CFE_NVRAM_SIGNATURE 0x48534c46
72
73struct nvram {
74	u_int32_t sig;
75	u_int32_t size;
76	u_int32_t unknown1;
77	u_int32_t unknown2;
78	u_int32_t unknown3;
79	char data[];
80};
81
82int		nvram2env_attach(device_t);
83int		nvram2env_probe(device_t);
84
85extern devclass_t	nvram2env_devclass;
86extern driver_t		nvram2env_driver;
87
88#endif /* SYS_DEV_NVRAM2ENV_NVRAM2ENV_H_ */
89