IntelSiliconPkg/Include/IndustryStandard/FirmwareInterfaceTable.h

   1 /** @file
   2   FirmwareInterfaceTable (FIT) related definitions.
   3
   4   @todo update document/spec reference
   5
   6   Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
   7   This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef __FIRMWARE_INTERFACE_TABLE_H__
  18 #define __FIRMWARE_INTERFACE_TABLE_H__
  19
  20 //
  21 // FIT Entry type definitions
  22 //
  23 #define FIT_TYPE_00_HEADER                  0x00
  24 #define FIT_TYPE_01_MICROCODE               0x01
  25 #define FIT_TYPE_02_STARTUP_ACM             0x02
  26 #define FIT_TYPE_07_BIOS_STARTUP_MODULE     0x07
  27 #define FIT_TYPE_08_TPM_POLICY              0x08
  28 #define FIT_TYPE_09_BIOS_POLICY             0x09
  29 #define FIT_TYPE_0A_TXT_POLICY              0x0A
  30 #define FIT_TYPE_0B_KEY_MANIFEST            0x0B
  31 #define FIT_TYPE_0C_BOOT_POLICY_MANIFEST    0x0C
  32 #define FIT_TYPE_10_CSE_SECURE_BOOT         0x10
  33 #define FIT_TYPE_2D_TXTSX_POLICY            0x2D
  34 #define FIT_TYPE_2F_JMP_DEBUG_POLICY        0x2F
  35 #define FIT_TYPE_7F_SKIP                    0x7F
  36
  37 #define FIT_POINTER_ADDRESS                 0xFFFFFFC0 ///< Fixed address at 4G - 40h
  38
  39 #define FIT_TYPE_VERSION                    0x0100
  40
  41 #define FIT_TYPE_00_SIGNATURE  SIGNATURE_64 ('_', 'F', 'I', 'T', '_', ' ', ' ', ' ')
  42
  43 #pragma pack(1)
  44
  45 typedef struct {
  46   /**
  47     Address is the base address of the firmware component
  48     must be aligned on 16 byte boundary
  49   **/
  50   UINT64 Address;
  51   UINT8  Size[3];   ///< Size is the span of the component in multiple of 16 bytes
  52   UINT8  Reserved;  ///< Reserved must be set to 0
  53   /**
  54     Component's version number in binary coded decimal (BCD) format.
  55     For the FIT header entry, the value in this field will indicate the revision
  56     number of the FIT data structure. The upper byte of the revision field
  57     indicates the major revision and the lower byte indicates the minor revision.
  58   **/
  59   UINT16 Version;
  60   UINT8  Type : 7;  ///< FIT types 0x00 to 0x7F
  61   ///
  62   /// Checksum Valid indicates whether component has valid checksum.
  63   ///
  64   UINT8  C_V  : 1;
  65   /**
  66     Component's checksum. The modulo sum of all the bytes in the component and
  67     the value in this field (Chksum) must add up to zero. This field is only
  68     valid if the C_V flag is non-zero.
  69   **/
  70   UINT8  Chksum;
  71 } FIRMWARE_INTERFACE_TABLE_ENTRY;
  72
  73 #pragma pack()
  74
  75 #endif