1/*-
2 * Copyright (c) 2015-2016 Landon Fuller <landonf@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer,
10 *    without modification.
11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13 *    redistribution must be conditioned upon including a substantially
14 *    similar Disclaimer requirement for further binary redistribution.
15 *
16 * NO WARRANTY
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27 * THE POSSIBILITY OF SUCH DAMAGES.
28 */
29
30#ifndef _BHND_NVRAM_BHND_NVRAM_BCMVAR_H_
31#define _BHND_NVRAM_BHND_NVRAM_BCMVAR_H_
32
33#define	BCM_NVRAM_ENCODE_OPT_VERSION	"bcm_version"
34
35/**
36 * BCM NVRAM header value data.
37 */
38union bhnd_nvram_bcm_hvar_value {
39	uint16_t	u16;
40	uint32_t	u32;
41};
42
43/**
44 * Internal representation of BCM NVRAM values that mirror (and must be
45 * vended as) NVRAM variables.
46 */
47struct bhnd_nvram_bcm_hvar {
48	const char	*name;	/**< variable name */
49	bhnd_nvram_type	 type;	/**< value type */
50	size_t		 nelem;	/**< value element count */
51	size_t		 len;	/**< value length */
52	const char	*envp;	/**< Pointer to the NVRAM variable mirroring
53				     this header value, or NULL. */
54	bool		 stale;	/**< header value does not match
55				     mirrored NVRAM value */
56
57	/** variable data */
58	union bhnd_nvram_bcm_hvar_value value;
59};
60
61/** BCM NVRAM header */
62struct bhnd_nvram_bcmhdr {
63	uint32_t magic;
64	uint32_t size;
65	uint32_t cfg0;		/**< crc:8, version:8, sdram_init:16 */
66	uint32_t cfg1;		/**< sdram_config:16, sdram_refresh:16 */
67	uint32_t sdram_ncdl;	/**< sdram_ncdl */
68} __packed;
69
70int	bhnd_nvram_bcm_getvar_direct_common(struct bhnd_nvram_io *io,
71	    const char *name, void *outp, size_t *olen, bhnd_nvram_type otype,
72	    bool have_header);
73
74#endif /* _BHND_NVRAM_BHND_NVRAM_BCMVAR_H_ */
75