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
  35 struct cbuint64 {
  36         uint32_t lo;
  37         uint32_t hi;
  38 };
  39
  40 struct cb_header {
  41         uint8_t signature[4];
  42         uint32_t header_bytes;
  43         uint32_t header_checksum;
  44         uint32_t table_bytes;
  45         uint32_t table_checksum;
  46         uint32_t table_entries;
  47 };
  48
  49 struct cb_record {
  50         uint32_t tag;
  51         uint32_t size;
  52 };
  53
  54 #define CB_TAG_UNUSED     0x0000
  55 #define CB_TAG_MEMORY     0x0001
  56
  57 struct cb_memory_range {
  58         struct cbuint64 start;
  59         struct cbuint64 size;
  60         uint32_t type;
  61 };
  62
  63 #define CB_MEM_RAM      1
  64 #define CB_MEM_RESERVED 2
  65 #define CB_MEM_TABLE    16
  66
  67 struct cb_memory {
  68         uint32_t tag;
  69         uint32_t size;
  70         struct cb_memory_range map[0];
  71 };
  72
  73 #define CB_TAG_HWRPB      0x0002
  74
  75 struct cb_hwrpb {
  76         uint32_t tag;
  77         uint32_t size;
  78         uint64_t hwrpb;
  79 };
  80
  81 #define CB_TAG_MAINBOARD  0x0003
  82
  83 struct cb_mainboard {
  84         uint32_t tag;
  85         uint32_t size;
  86         uint8_t vendor_idx;
  87         uint8_t part_number_idx;
  88         uint8_t strings[0];
  89 };
  90
  91 #define CB_TAG_VERSION        0x0004
  92 #define CB_TAG_EXTRA_VERSION  0x0005
  93 #define CB_TAG_BUILD          0x0006
  94 #define CB_TAG_COMPILE_TIME   0x0007
  95 #define CB_TAG_COMPILE_BY     0x0008
  96 #define CB_TAG_COMPILE_HOST   0x0009
  97 #define CB_TAG_COMPILE_DOMAIN 0x000a
  98 #define CB_TAG_COMPILER       0x000b
  99 #define CB_TAG_LINKER         0x000c
 100 #define CB_TAG_ASSEMBLER      0x000d
 101
 102 struct cb_string {
 103         uint32_t tag;
 104         uint32_t size;
 105         uint8_t string[0];
 106 };
 107
 108 #define CB_TAG_SERIAL         0x000f
 109
 110 struct cb_serial {
 111         uint32_t tag;
 112         uint32_t size;
 113         uint16_t ioport;
 114 };
 115
 116 #define CB_TAG_CONSOLE       0x00010
 117
 118 struct cb_console {
 119         uint32_t tag;
 120         uint32_t size;
 121         uint16_t type;
 122 };
 123
 124 #define CB_TAG_CONSOLE_SERIAL8250 0
 125 #define CB_TAG_CONSOLE_VGA        1
 126 #define CB_TAG_CONSOLE_BTEXT      2
 127 #define CB_TAG_CONSOLE_LOGBUF     3
 128 #define CB_TAG_CONSOLE_SROM       4
 129 #define CB_TAG_CONSOLE_EHCI       5
 130
 131 /* Still to come: CMOS information. */
 132
 133 /* Helpful macros */
 134
 135 #define MEM_RANGE_COUNT(_rec) \
 136         (((_rec)->size - sizeof(*(_rec))) / sizeof((_rec)->map[0]))
 137
 138 #define MEM_RANGE_PTR(_rec, _idx) \
 139         (((uint8_t *) (_rec)) + sizeof(*(_rec)) \
 140         + (sizeof((_rec)->map[0]) * (_idx)))
 141
 142 #define MB_VENDOR_STRING(_mb) \
 143         (((unsigned char *) ((_mb)->strings)) + (_mb)->vendor_idx)
 144
 145 #define MB_PART_STRING(_mb) \
 146         (((unsigned char *) ((_mb)->strings)) + (_mb)->part_number_idx)
 147
 148 #define UNPACK_CB64(_in) \
 149         ( (((uint64_t) _in.hi) << 32) | _in.lo )
 150
 151 #endif