src/include/boot/coreboot_tables.h

   1 #ifndef COREBOOT_TABLES_H
   2 #define COREBOOT_TABLES_H
   3
   4 #include <stdint.h>
   5
   6 /* The coreboot table information is for conveying information
   7  * from the firmware to the loaded OS image.  Primarily this
   8  * is expected to be information that cannot be discovered by
   9  * other means, such as quering the hardware directly.
  10  *
  11  * All of the information should be Position Independent Data.
  12  * That is it should be safe to relocated any of the information
  13  * without it's meaning/correctnes changing.   For table that
  14  * can reasonably be used on multiple architectures the data
  15  * size should be fixed.  This should ease the transition between
  16  * 32 bit and 64 bit architectures etc.
  17  *
  18  * The completeness test for the information in this table is:
  19  * - Can all of the hardware be detected?
  20  * - Are the per motherboard constants available?
  21  * - Is there enough to allow a kernel to run that was written before
  22  *   a particular motherboard is constructed? (Assuming the kernel
  23  *   has drivers for all of the hardware but it does not have
  24  *   assumptions on how the hardware is connected together).
  25  *
  26  * With this test it should be straight forward to determine if a
  27  * table entry is required or not.  This should remove much of the
  28  * long term compatibility burden as table entries which are
  29  * irrelevant or have been replaced by better alternatives may be
  30  * dropped.  Of course it is polite and expidite to include extra
  31  * table entries and be backwards compatible, but it is not required.
  32  */
  33
  34 /* Since coreboot is usually compiled 32bit, gcc will align 64bit
  35  * types to 32bit boundaries. If the coreboot table is dumped on a
  36  * 64bit system, a uint64_t would be aligned to 64bit boundaries,
  37  * breaking the table format.
  38  *
  39  * lb_uint64 will keep 64bit coreboot table values aligned to 32bit
  40  * to ensure compatibility. They can be accessed with the two functions
  41  * below: unpack_lb64() and pack_lb64()
  42  *
  43  * See also: util/lbtdump/lbtdump.c
  44  */
  45
  46 struct lb_uint64 {
  47         uint32_t lo;
  48         uint32_t hi;
  49 };
  50
  51 static inline uint64_t unpack_lb64(struct lb_uint64 value)
  52 {
  53         uint64_t result;
  54         result = value.hi;
  55         result = (result << 32) + value.lo;
  56         return result;
  57 }
  58
  59 static inline struct lb_uint64 pack_lb64(uint64_t value)
  60 {
  61         struct lb_uint64 result;
  62         result.lo = (value >> 0) & 0xffffffff;
  63         result.hi = (value >> 32) & 0xffffffff;
  64         return result;
  65 }
  66
  67
  68
  69 struct lb_header
  70 {
  71         uint8_t  signature[4]; /* LBIO */
  72         uint32_t header_bytes;
  73         uint32_t header_checksum;
  74         uint32_t table_bytes;
  75         uint32_t table_checksum;
  76         uint32_t table_entries;
  77 };
  78
  79 /* Every entry in the boot enviroment list will correspond to a boot
  80  * info record.  Encoding both type and size.  The type is obviously
  81  * so you can tell what it is.  The size allows you to skip that
  82  * boot enviroment record if you don't know what it easy.  This allows
  83  * forward compatibility with records not yet defined.
  84  */
  85 struct lb_record {
  86         uint32_t tag;           /* tag ID */
  87         uint32_t size;          /* size of record (in bytes) */
  88 };
  89
  90 #define LB_TAG_UNUSED   0x0000
  91
  92 #define LB_TAG_MEMORY   0x0001
  93
  94 struct lb_memory_range {
  95         struct lb_uint64 start;
  96         struct lb_uint64 size;
  97         uint32_t type;
  98 #define LB_MEM_RAM               1      /* Memory anyone can use */
  99 #define LB_MEM_RESERVED          2      /* Don't use this memory region */
 100 #define LB_MEM_ACPI              3      /* ACPI Tables */
 101 #define LB_MEM_NVS               4      /* ACPI NVS Memory */
 102 #define LB_MEM_UNUSABLE          5      /* Unusable address space */
 103 #define LB_MEM_VENDOR_RSVD       6      /* Vendor Reserved */
 104 #define LB_MEM_TABLE            16      /* Ram configuration tables are kept in */
 105 };
 106
 107 struct lb_memory {
 108         uint32_t tag;
 109         uint32_t size;
 110         struct lb_memory_range map[0];
 111 };
 112
 113 #define LB_TAG_HWRPB    0x0002
 114 struct lb_hwrpb {
 115         uint32_t tag;
 116         uint32_t size;
 117         uint64_t hwrpb;
 118 };
 119
 120 #define LB_TAG_MAINBOARD        0x0003
 121 struct lb_mainboard {
 122         uint32_t tag;
 123         uint32_t size;
 124         uint8_t  vendor_idx;
 125         uint8_t  part_number_idx;
 126         uint8_t  strings[0];
 127 };
 128
 129 #define LB_TAG_VERSION          0x0004
 130 #define LB_TAG_EXTRA_VERSION    0x0005
 131 #define LB_TAG_BUILD            0x0006
 132 #define LB_TAG_COMPILE_TIME     0x0007
 133 #define LB_TAG_COMPILE_BY       0x0008
 134 #define LB_TAG_COMPILE_HOST     0x0009
 135 #define LB_TAG_COMPILE_DOMAIN   0x000a
 136 #define LB_TAG_COMPILER         0x000b
 137 #define LB_TAG_LINKER           0x000c
 138 #define LB_TAG_ASSEMBLER        0x000d
 139 struct lb_string {
 140         uint32_t tag;
 141         uint32_t size;
 142         uint8_t  string[0];
 143 };
 144
 145 /* 0xe is taken by v3 */
 146
 147 #define LB_TAG_SERIAL           0x000f
 148 struct lb_serial {
 149         uint32_t tag;
 150         uint32_t size;
 151         uint16_t ioport;
 152         uint32_t baud;
 153 };
 154
 155 #define LB_TAG_CONSOLE          0x0010
 156 struct lb_console {
 157         uint32_t tag;
 158         uint32_t size;
 159         uint16_t type;
 160 };
 161
 162 #define LB_TAG_FORWARD          0x0011
 163 struct lb_forward {
 164         uint32_t tag;
 165         uint32_t size;
 166         uint64_t forward;
 167 };
 168
 169 #define LB_TAG_CONSOLE_SERIAL8250       0
 170 #define LB_TAG_CONSOLE_VGA              1
 171 #define LB_TAG_CONSOLE_BTEXT            2
 172 #define LB_TAG_CONSOLE_LOGBUF           3
 173 #define LB_TAG_CONSOLE_SROM             4
 174 #define LB_TAG_CONSOLE_EHCI             5
 175
 176 /* The following structures are for the cmos definitions table */
 177 #define LB_TAG_CMOS_OPTION_TABLE 200
 178 /* cmos header record */
 179 struct cmos_option_table {
 180         uint32_t tag;               /* CMOS definitions table type */
 181         uint32_t size;               /* size of the entire table */
 182         uint32_t header_length;      /* length of header */
 183 };
 184
 185 /* cmos entry record
 186         This record is variable length.  The name field may be
 187         shorter than CMOS_MAX_NAME_LENGTH. The entry may start
 188         anywhere in the byte, but can not span bytes unless it
 189         starts at the beginning of the byte and the length is
 190         fills complete bytes.
 191 */
 192 #define LB_TAG_OPTION 201
 193 struct cmos_entries {
 194         uint32_t tag;                /* entry type */
 195         uint32_t size;               /* length of this record */
 196         uint32_t bit;                /* starting bit from start of image */
 197         uint32_t length;             /* length of field in bits */
 198         uint32_t config;             /* e=enumeration, h=hex, r=reserved */
 199         uint32_t config_id;          /* a number linking to an enumeration record */
 200 #define CMOS_MAX_NAME_LENGTH 32
 201         uint8_t name[CMOS_MAX_NAME_LENGTH]; /* name of entry in ascii,
 202                                                variable length int aligned */
 203 };
 204
 205
 206 /* cmos enumerations record
 207         This record is variable length.  The text field may be
 208         shorter than CMOS_MAX_TEXT_LENGTH.
 209 */
 210 #define LB_TAG_OPTION_ENUM 202
 211 struct cmos_enums {
 212         uint32_t tag;                /* enumeration type */
 213         uint32_t size;               /* length of this record */
 214         uint32_t config_id;          /* a number identifying the config id */
 215         uint32_t value;              /* the value associated with the text */
 216 #define CMOS_MAX_TEXT_LENGTH 32
 217         uint8_t text[CMOS_MAX_TEXT_LENGTH]; /* enum description in ascii,
 218                                                 variable length int aligned */
 219 };
 220
 221 /* cmos defaults record
 222         This record contains default settings for the cmos ram.
 223 */
 224 #define LB_TAG_OPTION_DEFAULTS 203
 225 struct cmos_defaults {
 226         uint32_t tag;                /* default type */
 227         uint32_t size;               /* length of this record */
 228         uint32_t name_length;        /* length of the following name field */
 229         uint8_t name[CMOS_MAX_NAME_LENGTH]; /* name identifying the default */
 230 #define CMOS_IMAGE_BUFFER_SIZE 256
 231         uint8_t default_set[CMOS_IMAGE_BUFFER_SIZE]; /* default settings */
 232 };
 233
 234 #define LB_TAG_OPTION_CHECKSUM 204
 235 struct  cmos_checksum {
 236         uint32_t tag;
 237         uint32_t size;
 238         /* In practice everything is byte aligned, but things are measured
 239          * in bits to be consistent.
 240          */
 241         uint32_t range_start;   /* First bit that is checksummed (byte aligned) */
 242         uint32_t range_end;     /* Last bit that is checksummed (byte aligned) */
 243         uint32_t location;      /* First bit of the checksum (byte aligned) */
 244         uint32_t type;          /* Checksum algorithm that is used */
 245 #define CHECKSUM_NONE   0
 246 #define CHECKSUM_PCBIOS 1
 247 };
 248
 249
 250
 251 #endif /* COREBOOT_TABLES_H */