xref: /freebsd/sys/dev/bhnd/nvram/bhnd_nvram.h (revision ec65e4f8d0654361df5e97d4de3518edebf76b46)
1 /*-
2  * Copyright (c) 2015-2016 Landon Fuller <landon@landonf.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  * $FreeBSD$
30  */
31 
32 #ifndef _BHND_NVRAM_BHND_NVRAM_H_
33 #define _BHND_NVRAM_BHND_NVRAM_H_
34 
35 /**
36  * NVRAM data sources supported by bhnd(4) devices.
37  */
38 typedef enum {
39 	BHND_NVRAM_SRC_CIS,	/**< Default CIS source; this may
40 				  *  apply, for example, to PCMCIA cards
41 				  *  vending Broadcom NVRAM data via
42 				  *  their standard CIS table. */
43 
44 	BHND_NVRAM_SRC_OTP,	/**< On-chip one-time-programmable
45 				  *  memory. */
46 
47 	BHND_NVRAM_SRC_NFLASH,	/**< External flash device accessible
48 				  *  via on-chip flash core, such
49 				  *  as the NAND/QSPI controller cores
50 				  *  used on Northstar devices to access
51 				  *  NVRAM. */
52 	BHND_NVRAM_SRC_SPROM,	/**< External serial EEPROM. */
53 
54 	BHND_NVRAM_SRC_NONE	/**< No NVRAM source is directly
55 				  *  attached. This is used on devices
56 				  *  attached via PCI(e) to BHND SoCs,
57 				  *  where to avoid unnecessary flash
58 				  *  hardware, NVRAM configuration for
59 				  *  individual devices is provided by
60 				  *  hardware attached to the SoC
61 				  *  itself.
62 				  */
63 } bhnd_nvram_src_t;
64 
65 #endif /* _BHND_NVRAM_BHND_NVRAM_H_ */