1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/*-
* Copyright (c) 2015-2016 Landon Fuller <landon@landonf.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer,
* without modification.
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
* similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
* redistribution must be conditioned upon including a substantially
* similar Disclaimer requirement for further binary redistribution.
*
* NO WARRANTY
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
* IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGES.
*
* $FreeBSD$
*/
#ifndef _BHND_NVRAM_BHND_NVRAM_H_
#define _BHND_NVRAM_BHND_NVRAM_H_
/**
* NVRAM data sources supported by bhnd(4) devices.
*/
typedef enum {
BHND_NVRAM_SRC_OTP, /**< On-chip one-time-programmable
* memory. */
BHND_NVRAM_SRC_FLASH, /**< External flash */
BHND_NVRAM_SRC_SPROM, /**< External serial EEPROM. */
BHND_NVRAM_SRC_UNKNOWN /**< No NVRAM source is directly
* attached.
*
* This will be returned by ChipCommon
* revisions (rev <= 31) used in early
* chipsets that vend SPROM/OTP via the
* native host bridge interface.
*
* For example, PCMCIA cards may vend
* Broadcom NVRAM data via their standard CIS
* table, and earlier PCI(e) devices map
* SPROM statically into PCI BARs, and the
* control registers into PCI config space.
* This will also be returned on later
* devices that are attached via PCI(e) to
* BHND SoCs, but do not include an attached
* SPROM, or programmed OTP. On such SoCs,
* NVRAM configuration for individual devices
* is provided by a common platform NVRAM
* device.
*/
} bhnd_nvram_src;
/** Supported NVRAM formats. */
typedef enum {
BHND_NVRAM_FMT_BCM = 0, /**< Broadcom NUL-delimited key=value pairs */
BHND_NVRAM_FMT_TLV = 1, /**< CFE TLV encoding, as used on WGT634U */
BHND_NVRAM_FMT_BTXT = 2, /**< Broadcom board text file. This is used
to provide external NVRAM data for some
fullmac WiFi devices. */
BHND_NVRAM_FMT_SPROM = 3, /**< SPROM/OTP-specific encoding used by
Broadcom network adapters */
BHND_NVRAM_FMT_CIS = 4, /**< A mostly CIS-compatible encoding used
on some Broadcom network adapters */
BHND_NVRAM_FMT_UNKNOWN = 5 /**< Unknown or unrecognized format */
} bhnd_nvram_format;
/** bhnd_nvram_type bit flags */
enum {
BHND_NVRAM_TF_SIGNED = (1<<7),
};
#define BHND_NVRAM_TYPE_ID_MASK 0xF
#define BHND_NVRAM_TYPE_FLAGS_MASK 0x70
#define BHND_NVRAM_TYPE_ID(_id, _flags) \
(((_id) & BHND_NVRAM_TYPE_ID_MASK) | \
((_flags) & BHND_NVRAM_TYPE_FLAGS_MASK))
/** Supported NVRAM data types */
typedef enum {
BHND_NVRAM_TYPE_UINT8 = BHND_NVRAM_TYPE_ID(0, 0), /**< unsigned 8-bit integer */
BHND_NVRAM_TYPE_UINT16 = BHND_NVRAM_TYPE_ID(1, 0), /**< unsigned 16-bit integer */
BHND_NVRAM_TYPE_UINT32 = BHND_NVRAM_TYPE_ID(2, 0), /**< unsigned 32-bit integer */
BHND_NVRAM_TYPE_INT8 = BHND_NVRAM_TYPE_ID(4, BHND_NVRAM_TF_SIGNED), /**< signed 8-bit integer */
BHND_NVRAM_TYPE_INT16 = BHND_NVRAM_TYPE_ID(5, BHND_NVRAM_TF_SIGNED), /**< signed 16-bit integer */
BHND_NVRAM_TYPE_INT32 = BHND_NVRAM_TYPE_ID(6, BHND_NVRAM_TF_SIGNED), /**< signed 32-bit integer */
BHND_NVRAM_TYPE_CHAR = BHND_NVRAM_TYPE_ID(7, BHND_NVRAM_TF_SIGNED), /**< ASCII character */
BHND_NVRAM_TYPE_CSTR = BHND_NVRAM_TYPE_ID(8, 0), /**< NUL-terminated C string */
} bhnd_nvram_type;
#undef BHND_NVRAM_TYPE_ID_MASK
#undef BHND_NVRAM_TYPE_FLAGS_MASK
#undef BHND_NVRAM_TYPE_ID
#define BHND_NVRAM_SIGNED_TYPE(_type) \
(((_type) & BHND_NVRAM_TF_SIGNED) == BHND_NVRAM_TF_SIGNED)
#endif /* _BHND_NVRAM_BHND_NVRAM_H_ */
|
