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 struct lb_header
  68 {
  69         uint8_t  signature[4]; /* LBIO */
  70         uint32_t header_bytes;
  71         uint32_t header_checksum;
  72         uint32_t table_bytes;
  73         uint32_t table_checksum;
  74         uint32_t table_entries;
  75 };
  76
  77 /* Every entry in the boot environment list will correspond to a boot
  78  * info record.  Encoding both type and size.  The type is obviously
  79  * so you can tell what it is.  The size allows you to skip that
  80  * boot environment record if you don't know what it easy.  This allows
  81  * forward compatibility with records not yet defined.
  82  */
  83 struct lb_record {
  84         uint32_t tag;           /* tag ID */
  85         uint32_t size;          /* size of record (in bytes) */
  86 };
  87
  88 #define LB_TAG_UNUSED           0x0000
  89
  90 #define LB_TAG_MEMORY           0x0001
  91
  92 struct lb_memory_range {
  93         struct lb_uint64 start;
  94         struct lb_uint64 size;
  95         uint32_t type;
  96 #define LB_MEM_RAM               1      /* Memory anyone can use */
  97 #define LB_MEM_RESERVED          2      /* Don't use this memory region */
  98 #define LB_MEM_ACPI              3      /* ACPI Tables */
  99 #define LB_MEM_NVS               4      /* ACPI NVS Memory */
 100 #define LB_MEM_UNUSABLE          5      /* Unusable address space */
 101 #define LB_MEM_VENDOR_RSVD       6      /* Vendor Reserved */
 102 #define LB_MEM_TABLE            16      /* Ram configuration tables are kept in */
 103 };
 104
 105 struct lb_memory {
 106         uint32_t tag;
 107         uint32_t size;
 108         struct lb_memory_range map[0];
 109 };
 110
 111 #define LB_TAG_HWRPB            0x0002
 112 struct lb_hwrpb {
 113         uint32_t tag;
 114         uint32_t size;
 115         uint64_t hwrpb;
 116 };
 117
 118 #define LB_TAG_MAINBOARD        0x0003
 119 struct lb_mainboard {
 120         uint32_t tag;
 121         uint32_t size;
 122         uint8_t  vendor_idx;
 123         uint8_t  part_number_idx;
 124         uint8_t  strings[0];
 125 };
 126
 127 #define LB_TAG_VERSION          0x0004
 128 #define LB_TAG_EXTRA_VERSION    0x0005
 129 #define LB_TAG_BUILD            0x0006
 130 #define LB_TAG_COMPILE_TIME     0x0007
 131 #define LB_TAG_COMPILE_BY       0x0008
 132 #define LB_TAG_COMPILE_HOST     0x0009
 133 #define LB_TAG_COMPILE_DOMAIN   0x000a
 134 #define LB_TAG_COMPILER         0x000b
 135 #define LB_TAG_LINKER           0x000c
 136 #define LB_TAG_ASSEMBLER        0x000d
 137 struct lb_string {
 138         uint32_t tag;
 139         uint32_t size;
 140         uint8_t  string[0];
 141 };
 142
 143 /* 0xe is taken by v3 */
 144
 145 #define LB_TAG_SERIAL           0x000f
 146 struct lb_serial {
 147         uint32_t tag;
 148         uint32_t size;
 149         uint16_t ioport;
 150         uint32_t baud;
 151 };
 152
 153 #define LB_TAG_CONSOLE          0x0010
 154 struct lb_console {
 155         uint32_t tag;
 156         uint32_t size;
 157         uint16_t type;
 158 };
 159
 160 #define LB_TAG_CONSOLE_SERIAL8250       0
 161 #define LB_TAG_CONSOLE_VGA              1 // OBSOLETE
 162 #define LB_TAG_CONSOLE_BTEXT            2 // OBSOLETE
 163 #define LB_TAG_CONSOLE_LOGBUF           3
 164 #define LB_TAG_CONSOLE_SROM             4 // OBSOLETE
 165 #define LB_TAG_CONSOLE_EHCI             5
 166 #define LB_TAG_CONSOLE_SERIAL8250MEM    6
 167
 168 #define LB_TAG_FORWARD          0x0011
 169 struct lb_forward {
 170         uint32_t tag;
 171         uint32_t size;
 172         uint64_t forward;
 173 };
 174
 175 #define LB_TAG_FRAMEBUFFER      0x0012
 176 struct lb_framebuffer {
 177         uint32_t tag;
 178         uint32_t size;
 179
 180         uint64_t physical_address;
 181         uint32_t x_resolution;
 182         uint32_t y_resolution;
 183         uint32_t bytes_per_line;
 184         uint8_t bits_per_pixel;
 185         uint8_t red_mask_pos;
 186         uint8_t red_mask_size;
 187         uint8_t green_mask_pos;
 188         uint8_t green_mask_size;
 189         uint8_t blue_mask_pos;
 190         uint8_t blue_mask_size;
 191         uint8_t reserved_mask_pos;
 192         uint8_t reserved_mask_size;
 193 };
 194
 195 /* The following structures are for the cmos definitions table */
 196 #define LB_TAG_CMOS_OPTION_TABLE 200
 197 /* cmos header record */
 198 struct cmos_option_table {
 199         uint32_t tag;               /* CMOS definitions table type */
 200         uint32_t size;               /* size of the entire table */
 201         uint32_t header_length;      /* length of header */
 202 };
 203
 204 /* cmos entry record
 205         This record is variable length.  The name field may be
 206         shorter than CMOS_MAX_NAME_LENGTH. The entry may start
 207         anywhere in the byte, but can not span bytes unless it
 208         starts at the beginning of the byte and the length is
 209         fills complete bytes.
 210 */
 211 #define LB_TAG_OPTION 201
 212 struct cmos_entries {
 213         uint32_t tag;                /* entry type */
 214         uint32_t size;               /* length of this record */
 215         uint32_t bit;                /* starting bit from start of image */
 216         uint32_t length;             /* length of field in bits */
 217         uint32_t config;             /* e=enumeration, h=hex, r=reserved */
 218         uint32_t config_id;          /* a number linking to an enumeration record */
 219 #define CMOS_MAX_NAME_LENGTH 32
 220         uint8_t name[CMOS_MAX_NAME_LENGTH]; /* name of entry in ascii,
 221                                                variable length int aligned */
 222 };
 223
 224
 225 /* cmos enumerations record
 226         This record is variable length.  The text field may be
 227         shorter than CMOS_MAX_TEXT_LENGTH.
 228 */
 229 #define LB_TAG_OPTION_ENUM 202
 230 struct cmos_enums {
 231         uint32_t tag;                /* enumeration type */
 232         uint32_t size;               /* length of this record */
 233         uint32_t config_id;          /* a number identifying the config id */
 234         uint32_t value;              /* the value associated with the text */
 235 #define CMOS_MAX_TEXT_LENGTH 32
 236         uint8_t text[CMOS_MAX_TEXT_LENGTH]; /* enum description in ascii,
 237                                                 variable length int aligned */
 238 };
 239
 240 /* cmos defaults record
 241         This record contains default settings for the cmos ram.
 242 */
 243 #define LB_TAG_OPTION_DEFAULTS 203
 244 struct cmos_defaults {
 245         uint32_t tag;                /* default type */
 246         uint32_t size;               /* length of this record */
 247         uint32_t name_length;        /* length of the following name field */
 248         uint8_t name[CMOS_MAX_NAME_LENGTH]; /* name identifying the default */
 249 #define CMOS_IMAGE_BUFFER_SIZE 256
 250         uint8_t default_set[CMOS_IMAGE_BUFFER_SIZE]; /* default settings */
 251 };
 252
 253 #define LB_TAG_OPTION_CHECKSUM 204
 254 struct  cmos_checksum {
 255         uint32_t tag;
 256         uint32_t size;
 257         /* In practice everything is byte aligned, but things are measured
 258          * in bits to be consistent.
 259          */
 260         uint32_t range_start;   /* First bit that is checksummed (byte aligned) */
 261         uint32_t range_end;     /* Last bit that is checksummed (byte aligned) */
 262         uint32_t location;      /* First bit of the checksum (byte aligned) */
 263         uint32_t type;          /* Checksum algorithm that is used */
 264 #define CHECKSUM_NONE   0
 265 #define CHECKSUM_PCBIOS 1
 266 };
 267
 268 #endif /* COREBOOT_TABLES_H */