payloads/libpayload/include/coreboot_tables.h

   1 /*
   2  * This file is part of the libpayload project.
   3  *
   4  * Copyright (C) 2008 Advanced Micro Devices, Inc.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #ifndef _COREBOOT_TABLES_H
  31 #define _COREBOOT_TABLES_H
  32
  33 #include <arch/types.h>
  34 #include <ipchksum.h>
  35
  36 struct cbuint64 {
  37         u32 lo;
  38         u32 hi;
  39 };
  40
  41 struct cb_header {
  42         u8 signature[4];
  43         u32 header_bytes;
  44         u32 header_checksum;
  45         u32 table_bytes;
  46         u32 table_checksum;
  47         u32 table_entries;
  48 };
  49
  50 struct cb_record {
  51         u32 tag;
  52         u32 size;
  53 };
  54
  55 #define CB_TAG_UNUSED     0x0000
  56 #define CB_TAG_MEMORY     0x0001
  57
  58 struct cb_memory_range {
  59         struct cbuint64 start;
  60         struct cbuint64 size;
  61         u32 type;
  62 };
  63
  64 #define CB_MEM_RAM          1
  65 #define CB_MEM_RESERVED     2
  66 #define CB_MEM_ACPI         3
  67 #define CB_MEM_NVS          4
  68 #define CB_MEM_UNUSABLE     5
  69 #define CB_MEM_VENDOR_RSVD  6
  70 #define CB_MEM_TABLE       16
  71
  72 struct cb_memory {
  73         u32 tag;
  74         u32 size;
  75         struct cb_memory_range map[0];
  76 };
  77
  78 #define CB_TAG_HWRPB      0x0002
  79
  80 struct cb_hwrpb {
  81         u32 tag;
  82         u32 size;
  83         u64 hwrpb;
  84 };
  85
  86 #define CB_TAG_MAINBOARD  0x0003
  87
  88 struct cb_mainboard {
  89         u32 tag;
  90         u32 size;
  91         u8 vendor_idx;
  92         u8 part_number_idx;
  93         u8 strings[0];
  94 };
  95
  96 #define CB_TAG_VERSION        0x0004
  97 #define CB_TAG_EXTRA_VERSION  0x0005
  98 #define CB_TAG_BUILD          0x0006
  99 #define CB_TAG_COMPILE_TIME   0x0007
 100 #define CB_TAG_COMPILE_BY     0x0008
 101 #define CB_TAG_COMPILE_HOST   0x0009
 102 #define CB_TAG_COMPILE_DOMAIN 0x000a
 103 #define CB_TAG_COMPILER       0x000b
 104 #define CB_TAG_LINKER         0x000c
 105 #define CB_TAG_ASSEMBLER      0x000d
 106
 107 struct cb_string {
 108         u32 tag;
 109         u32 size;
 110         u8 string[0];
 111 };
 112
 113 #define CB_TAG_SERIAL         0x000f
 114
 115 struct cb_serial {
 116         u32 tag;
 117         u32 size;
 118 #define CB_SERIAL_TYPE_IO_MAPPED     1
 119 #define CB_SERIAL_TYPE_MEMORY_MAPPED 2
 120         u32 type;
 121         u32 baseaddr;
 122         u32 baud;
 123 };
 124
 125 #define CB_TAG_CONSOLE       0x00010
 126
 127 struct cb_console {
 128         u32 tag;
 129         u32 size;
 130         u16 type;
 131 };
 132
 133 #define CB_TAG_CONSOLE_SERIAL8250 0
 134 #define CB_TAG_CONSOLE_VGA        1 // OBSOLETE
 135 #define CB_TAG_CONSOLE_BTEXT      2 // OBSOLETE
 136 #define CB_TAG_CONSOLE_LOGBUF     3
 137 #define CB_TAG_CONSOLE_SROM       4 // OBSOLETE
 138 #define CB_TAG_CONSOLE_EHCI       5
 139
 140 #define CB_TAG_FORWARD       0x00011
 141
 142 struct cb_forward {
 143         u32 tag;
 144         u32 size;
 145         u64 forward;
 146 };
 147
 148 #define CB_TAG_FRAMEBUFFER      0x0012
 149 struct cb_framebuffer {
 150         u32 tag;
 151         u32 size;
 152
 153         u64 physical_address;
 154         u32 x_resolution;
 155         u32 y_resolution;
 156         u32 bytes_per_line;
 157         u8 bits_per_pixel;
 158         u8 red_mask_pos;
 159         u8 red_mask_size;
 160         u8 green_mask_pos;
 161         u8 green_mask_size;
 162         u8 blue_mask_pos;
 163         u8 blue_mask_size;
 164         u8 reserved_mask_pos;
 165         u8 reserved_mask_size;
 166 };
 167
 168 #define CB_TAG_CMOS_OPTION_TABLE 0x00c8
 169 struct cb_cmos_option_table {
 170         u32 tag;
 171         u32 size;
 172         u32 header_length;
 173 };
 174
 175 #define CB_TAG_OPTION         0x00c9
 176 #define CMOS_MAX_NAME_LENGTH    32
 177 struct cb_cmos_entries {
 178         u32 tag;
 179         u32 size;
 180         u32 bit;
 181         u32 length;
 182         u32 config;
 183         u32 config_id;
 184         u8 name[CMOS_MAX_NAME_LENGTH];
 185 };
 186
 187
 188 #define CB_TAG_OPTION_ENUM    0x00ca
 189 #define CMOS_MAX_TEXT_LENGTH 32
 190 struct cb_cmos_enums {
 191         u32 tag;
 192         u32 size;
 193         u32 config_id;
 194         u32 value;
 195         u8 text[CMOS_MAX_TEXT_LENGTH];
 196 };
 197
 198 #define CB_TAG_OPTION_DEFAULTS 0x00cb
 199 #define CMOS_IMAGE_BUFFER_SIZE 128
 200 struct cb_cmos_defaults {
 201         u32 tag;
 202         u32 size;
 203         u32 name_length;
 204         u8 name[CMOS_MAX_NAME_LENGTH];
 205         u8 default_set[CMOS_IMAGE_BUFFER_SIZE];
 206 };
 207
 208 #define CB_TAG_OPTION_CHECKSUM 0x00cc
 209 #define CHECKSUM_NONE   0
 210 #define CHECKSUM_PCBIOS 1
 211 struct  cb_cmos_checksum {
 212         u32 tag;
 213         u32 size;
 214         u32 range_start;
 215         u32 range_end;
 216         u32 location;
 217         u32 type;
 218 };
 219
 220 /* Helpful inlines */
 221
 222 static inline u64 cb_unpack64(struct cbuint64 val)
 223 {
 224         return (((u64) val.hi) << 32) | val.lo;
 225 }
 226
 227 static inline u16 cb_checksum(const void *ptr, unsigned len)
 228 {
 229         return ipchksum(ptr, len);
 230 }
 231
 232 static inline const char *cb_mb_vendor_string(const struct cb_mainboard *cbm)
 233 {
 234         return (char *)(cbm->strings + cbm->vendor_idx);
 235 }
 236
 237 static inline const char *cb_mb_part_string(const struct cb_mainboard *cbm)
 238 {
 239         return (char *)(cbm->strings + cbm->part_number_idx);
 240 }
 241
 242 /* Helpful macros */
 243
 244 #define MEM_RANGE_COUNT(_rec) \
 245         (((_rec)->size - sizeof(*(_rec))) / sizeof((_rec)->map[0]))
 246
 247 #define MEM_RANGE_PTR(_rec, _idx) \
 248         (void *)(((u8 *) (_rec)) + sizeof(*(_rec)) \
 249                 + (sizeof((_rec)->map[0]) * (_idx)))
 250
 251 #endif