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 */ 30 31 #ifndef _BHND_NVRAM_BHND_NVRAM_H_ 32 #define _BHND_NVRAM_BHND_NVRAM_H_ 33 34 #ifdef _KERNEL 35 #include <sys/types.h> 36 #else /* !_KERNEL */ 37 #include <stdbool.h> 38 #include <stdint.h> 39 #endif /* _KERNEL */ 40 41 /** 42 * BHND NVRAM boolean type; guaranteed to be exactly 8-bits, representing 43 * true as integer constant 1, and false as integer constant 0. 44 * 45 * Compatible with stdbool constants (true, false). 46 */ 47 typedef uint8_t bhnd_nvram_bool_t; 48 49 /** 50 * NVRAM data sources supported by bhnd(4) devices. 51 */ 52 typedef enum { 53 BHND_NVRAM_SRC_OTP, /**< On-chip one-time-programmable 54 * memory. */ 55 56 BHND_NVRAM_SRC_FLASH, /**< External flash */ 57 BHND_NVRAM_SRC_SPROM, /**< External serial EEPROM. */ 58 59 BHND_NVRAM_SRC_UNKNOWN /**< No NVRAM source is directly 60 * attached. 61 * 62 * This will be returned by ChipCommon 63 * revisions (rev <= 31) used in early 64 * chipsets that vend SPROM/OTP via the 65 * native host bridge interface. 66 * 67 * For example, PCMCIA cards may vend 68 * Broadcom NVRAM data via their standard CIS 69 * table, and earlier PCI(e) devices map 70 * SPROM statically into PCI BARs, and the 71 * control registers into PCI config space. 72 73 * This will also be returned on later 74 * devices that are attached via PCI(e) to 75 * BHND SoCs, but do not include an attached 76 * SPROM, or programmed OTP. On such SoCs, 77 * NVRAM configuration for individual devices 78 * is provided by a common platform NVRAM 79 * device. 80 */ 81 } bhnd_nvram_src; 82 83 /** 84 * NVRAM data types. 85 * 86 * @internal 87 * 88 * All primitive (non-array) constants should be representable as a 4-bit 89 * integer (e.g. 0-15) to support SPROM_OPCODE_TYPE_IMM encoding as used by 90 * nvram_map_gen.awk. 91 */ 92 typedef enum { 93 BHND_NVRAM_TYPE_UINT8 = 0, /**< unsigned 8-bit integer */ 94 BHND_NVRAM_TYPE_UINT16 = 1, /**< unsigned 16-bit integer */ 95 BHND_NVRAM_TYPE_UINT32 = 2, /**< unsigned 32-bit integer */ 96 BHND_NVRAM_TYPE_UINT64 = 3, /**< signed 64-bit integer */ 97 BHND_NVRAM_TYPE_INT8 = 4, /**< signed 8-bit integer */ 98 BHND_NVRAM_TYPE_INT16 = 5, /**< signed 16-bit integer */ 99 BHND_NVRAM_TYPE_INT32 = 6, /**< signed 32-bit integer */ 100 BHND_NVRAM_TYPE_INT64 = 7, /**< signed 64-bit integer */ 101 BHND_NVRAM_TYPE_CHAR = 8, /**< ASCII/UTF-8 character */ 102 BHND_NVRAM_TYPE_STRING = 9, /**< ASCII/UTF-8 NUL-terminated 103 string */ 104 BHND_NVRAM_TYPE_BOOL = 10, /**< uint8 boolean value. see 105 bhnd_nvram_bool_t. */ 106 BHND_NVRAM_TYPE_NULL = 11, /**< NULL (empty) value */ 107 BHND_NVRAM_TYPE_DATA = 12, /**< opaque octet string */ 108 109 /* 10-15 reserved for primitive (non-array) types */ 110 111 BHND_NVRAM_TYPE_UINT8_ARRAY = 16, /**< array of uint8 integers */ 112 BHND_NVRAM_TYPE_UINT16_ARRAY = 17, /**< array of uint16 integers */ 113 BHND_NVRAM_TYPE_UINT32_ARRAY = 18, /**< array of uint32 integers */ 114 BHND_NVRAM_TYPE_UINT64_ARRAY = 19, /**< array of uint64 integers */ 115 BHND_NVRAM_TYPE_INT8_ARRAY = 20, /**< array of int8 integers */ 116 BHND_NVRAM_TYPE_INT16_ARRAY = 21, /**< array of int16 integers */ 117 BHND_NVRAM_TYPE_INT32_ARRAY = 22, /**< array of int32 integers */ 118 BHND_NVRAM_TYPE_INT64_ARRAY = 23, /**< array of int64 integers */ 119 BHND_NVRAM_TYPE_CHAR_ARRAY = 24, /**< array of ASCII/UTF-8 120 characters */ 121 BHND_NVRAM_TYPE_STRING_ARRAY = 25, /**< array of ASCII/UTF-8 122 NUL-terminated strings */ 123 BHND_NVRAM_TYPE_BOOL_ARRAY = 26, /**< array of uint8 boolean 124 values */ 125 } bhnd_nvram_type; 126 127 bool bhnd_nvram_is_signed_type(bhnd_nvram_type type); 128 bool bhnd_nvram_is_unsigned_type(bhnd_nvram_type type); 129 bool bhnd_nvram_is_int_type(bhnd_nvram_type type); 130 bool bhnd_nvram_is_array_type(bhnd_nvram_type type); 131 bhnd_nvram_type bhnd_nvram_base_type(bhnd_nvram_type type); 132 bhnd_nvram_type bhnd_nvram_raw_type(bhnd_nvram_type type); 133 const char *bhnd_nvram_type_name(bhnd_nvram_type type); 134 size_t bhnd_nvram_type_width(bhnd_nvram_type type); 135 size_t bhnd_nvram_type_host_align(bhnd_nvram_type type); 136 137 const char *bhnd_nvram_string_array_next(const char *inp, size_t ilen, 138 const char *prev, size_t *olen); 139 140 #endif /* _BHND_NVRAM_BHND_NVRAM_H_ */ 141