1 /** @file 2 Intel FSP Header File definition from Intel Firmware Support Package External 3 Architecture Specification v2.0 and above. 4 5 Copyright (c) 2014 - 2020, Intel Corporation. All rights reserved.<BR> 6 SPDX-License-Identifier: BSD-2-Clause-Patent 7 8 **/ 9 10 #ifndef __FSP_HEADER_FILE_H__ 11 #define __FSP_HEADER_FILE_H__ 12 13 #define FSP_HEADER_REVISION_3 3 14 15 #define FSPE_HEADER_REVISION_1 1 16 #define FSPP_HEADER_REVISION_1 1 17 18 /// 19 /// Fixed FSP header offset in the FSP image 20 /// 21 #define FSP_INFO_HEADER_OFF 0x94 22 23 #define OFFSET_IN_FSP_INFO_HEADER(x) (UINT32)&((FSP_INFO_HEADER *)(UINTN)0)->x 24 25 #define FSP_INFO_HEADER_SIGNATURE SIGNATURE_32 ('F', 'S', 'P', 'H') 26 27 #define FSP_SIG 0x48505346 /* 'FSPH' */ 28 29 #pragma pack(1) 30 31 /// 32 /// FSP Information Header as described in FSP v2.0 Spec section 5.1.1. 33 /// 34 typedef struct { 35 /// 36 /// Byte 0x00: Signature ('FSPH') for the FSP Information Header. 37 /// 38 UINT32 Signature; 39 /// 40 /// Byte 0x04: Length of the FSP Information Header. 41 /// 42 UINT32 HeaderLength; 43 /// 44 /// Byte 0x08: Reserved. 45 /// 46 UINT8 Reserved1[2]; 47 /// 48 /// Byte 0x0A: Indicates compliance with a revision of this specification in the BCD format. 49 /// 50 UINT8 SpecVersion; 51 /// 52 /// Byte 0x0B: Revision of the FSP Information Header. 53 /// 54 UINT8 HeaderRevision; 55 /// 56 /// Byte 0x0C: Revision of the FSP binary. 57 /// 58 UINT32 ImageRevision; 59 /// 60 /// Byte 0x10: Signature string that will help match the FSP Binary to a supported HW configuration. 61 /// 62 CHAR8 ImageId[8]; 63 /// 64 /// Byte 0x18: Size of the entire FSP binary. 65 /// 66 UINT32 ImageSize; 67 /// 68 /// Byte 0x1C: FSP binary preferred base address. 69 /// 70 UINT32 ImageBase; 71 /// 72 /// Byte 0x20: Attribute for the FSP binary. 73 /// 74 UINT16 ImageAttribute; 75 /// 76 /// Byte 0x22: Attributes of the FSP Component. 77 /// 78 UINT16 ComponentAttribute; 79 /// 80 /// Byte 0x24: Offset of the FSP configuration region. 81 /// 82 UINT32 CfgRegionOffset; 83 /// 84 /// Byte 0x28: Size of the FSP configuration region. 85 /// 86 UINT32 CfgRegionSize; 87 /// 88 /// Byte 0x2C: Reserved2. 89 /// 90 UINT32 Reserved2; 91 /// 92 /// Byte 0x30: The offset for the API to setup a temporary stack till the memory is initialized. 93 /// 94 UINT32 TempRamInitEntryOffset; 95 /// 96 /// Byte 0x34: Reserved3. 97 /// 98 UINT32 Reserved3; 99 /// 100 /// Byte 0x38: The offset for the API to inform the FSP about the different stages in the boot process. 101 /// 102 UINT32 NotifyPhaseEntryOffset; 103 /// 104 /// Byte 0x3C: The offset for the API to initialize the memory. 105 /// 106 UINT32 FspMemoryInitEntryOffset; 107 /// 108 /// Byte 0x40: The offset for the API to tear down temporary RAM. 109 /// 110 UINT32 TempRamExitEntryOffset; 111 /// 112 /// Byte 0x44: The offset for the API to initialize the CPU and chipset. 113 /// 114 UINT32 FspSiliconInitEntryOffset; 115 /// 116 /// Byte 0x48: Offset for the API for the optional Multi-Phase processor and chipset initialization. 117 /// This value is only valid if FSP HeaderRevision is >= 5. 118 /// If the value is set to 0x00000000, then this API is not available in this component. 119 /// 120 UINT32 FspMultiPhaseSiInitEntryOffset; 121 } FSP_INFO_HEADER; 122 123 /// 124 /// Signature of the FSP Extended Header 125 /// 126 #define FSP_INFO_EXTENDED_HEADER_SIGNATURE SIGNATURE_32 ('F', 'S', 'P', 'E') 127 128 /// 129 /// FSP Information Extended Header as described in FSP v2.0 Spec section 5.1.2. 130 /// 131 typedef struct { 132 /// 133 /// Byte 0x00: Signature ('FSPE') for the FSP Extended Information Header. 134 /// 135 UINT32 Signature; 136 /// 137 /// Byte 0x04: Length of the table in bytes, including all additional FSP producer defined data. 138 /// 139 UINT32 Length; 140 /// 141 /// Byte 0x08: FSP producer defined revision of the table. 142 /// 143 UINT8 Revision; 144 /// 145 /// Byte 0x09: Reserved for future use. 146 /// 147 UINT8 Reserved; 148 /// 149 /// Byte 0x0A: FSP producer identification string 150 /// 151 CHAR8 FspProducerId[6]; 152 /// 153 /// Byte 0x10: FSP producer implementation revision number. Larger numbers are assumed to be newer revisions. 154 /// 155 UINT32 FspProducerRevision; 156 /// 157 /// Byte 0x14: Size of the FSP producer defined data (n) in bytes. 158 /// 159 UINT32 FspProducerDataSize; 160 /// 161 /// Byte 0x18: FSP producer defined data of size (n) defined by FspProducerDataSize. 162 /// 163 } FSP_INFO_EXTENDED_HEADER; 164 165 // 166 // A generic table search algorithm for additional tables can be implemented with a 167 // signature search algorithm until a terminator signature 'FSPP' is found. 168 // 169 #define FSP_FSPP_SIGNATURE SIGNATURE_32 ('F', 'S', 'P', 'P') 170 #define FSP_PATCH_TABLE_SIGNATURE FSP_FSPP_SIGNATURE 171 172 /// 173 /// FSP Patch Table as described in FSP v2.0 Spec section 5.1.5. 174 /// 175 typedef struct { 176 /// 177 /// Byte 0x00: FSP Patch Table Signature "FSPP". 178 /// 179 UINT32 Signature; 180 /// 181 /// Byte 0x04: Size including the PatchData. 182 /// 183 UINT16 HeaderLength; 184 /// 185 /// Byte 0x06: Revision is set to 0x01. 186 /// 187 UINT8 HeaderRevision; 188 /// 189 /// Byte 0x07: Reserved for future use. 190 /// 191 UINT8 Reserved; 192 /// 193 /// Byte 0x08: Number of entries to Patch. 194 /// 195 UINT32 PatchEntryNum; 196 /// 197 /// Byte 0x0C: Patch Data. 198 /// 199 //UINT32 PatchData[]; 200 } FSP_PATCH_TABLE; 201 202 #pragma pack() 203 204 extern EFI_GUID gFspHeaderFileGuid; 205 206 #endif 207