BaseTools/Source/C/GenFv/GenFvInternalLib.h

   1 /** @file
   2
   3 Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>
   4 This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   GenFvInternalLib.h
  15
  16 Abstract:
  17
  18   This file contains describes the public interfaces to the GenFvImage Library.
  19   The basic purpose of the library is to create Firmware Volume images.
  20
  21 **/
  22
  23 #ifndef _EFI_GEN_FV_INTERNAL_LIB_H
  24 #define _EFI_GEN_FV_INTERNAL_LIB_H
  25
  26 //
  27 // Include files
  28 //
  29 #include <stdlib.h>
  30
  31 #include <Common/UefiBaseTypes.h>
  32 #include <Common/UefiCapsule.h>
  33
  34 #include <Common/PiFirmwareFile.h>
  35 #include <Common/PiFirmwareVolume.h>
  36 #include <Guid/PiFirmwareFileSystem.h>
  37 #include <IndustryStandard/PeImage.h>
  38
  39 #include "CommonLib.h"
  40 #include "ParseInf.h"
  41 #include "EfiUtilityMsgs.h"
  42
  43 //
  44 // Different file separater for Linux and Windows
  45 //
  46 #define FILE_SEP_CHAR '/'
  47
  48 //
  49 // The maximum number of Pad file guid entries.
  50 //
  51 #define MAX_NUMBER_OF_PAD_FILE_GUIDS    1024
  52
  53 //
  54 // The maximum number of block map entries supported by the library
  55 //
  56 #define MAX_NUMBER_OF_FV_BLOCKS         100
  57
  58 //
  59 // The maximum number of files in the FV supported by the library
  60 //
  61 #define MAX_NUMBER_OF_FILES_IN_FV       1000
  62 #define MAX_NUMBER_OF_FILES_IN_CAP      1000
  63 #define EFI_FFS_FILE_HEADER_ALIGNMENT   8
  64 //
  65 // INF file strings
  66 //
  67 #define OPTIONS_SECTION_STRING                "[options]"
  68 #define ATTRIBUTES_SECTION_STRING             "[attributes]"
  69 #define FILES_SECTION_STRING                  "[files]"
  70 #define FV_BASE_ADDRESS_STRING                "[FV_BASE_ADDRESS]"
  71
  72 //
  73 // Options section
  74 //
  75 #define EFI_FV_BASE_ADDRESS_STRING        "EFI_BASE_ADDRESS"
  76 #define EFI_FV_FILE_NAME_STRING           "EFI_FILE_NAME"
  77 #define EFI_NUM_BLOCKS_STRING             "EFI_NUM_BLOCKS"
  78 #define EFI_BLOCK_SIZE_STRING             "EFI_BLOCK_SIZE"
  79 #define EFI_GUID_STRING                   "EFI_GUID"
  80 #define EFI_FV_FILESYSTEMGUID_STRING      "EFI_FV_GUID"
  81 #define EFI_FV_NAMEGUID_STRING            "EFI_FVNAME_GUID"
  82 #define EFI_CAPSULE_GUID_STRING           "EFI_CAPSULE_GUID"
  83 #define EFI_CAPSULE_HEADER_SIZE_STRING    "EFI_CAPSULE_HEADER_SIZE"
  84 #define EFI_CAPSULE_FLAGS_STRING          "EFI_CAPSULE_FLAGS"
  85 #define EFI_CAPSULE_VERSION_STRING        "EFI_CAPSULE_VERSION"
  86
  87 #define EFI_FV_TOTAL_SIZE_STRING    "EFI_FV_TOTAL_SIZE"
  88 #define EFI_FV_TAKEN_SIZE_STRING    "EFI_FV_TAKEN_SIZE"
  89 #define EFI_FV_SPACE_SIZE_STRING    "EFI_FV_SPACE_SIZE"
  90
  91 //
  92 // Attributes section
  93 //
  94 #define EFI_FVB2_READ_DISABLED_CAP_STRING  "EFI_READ_DISABLED_CAP"
  95 #define EFI_FVB2_READ_ENABLED_CAP_STRING   "EFI_READ_ENABLED_CAP"
  96 #define EFI_FVB2_READ_STATUS_STRING        "EFI_READ_STATUS"
  97
  98 #define EFI_FVB2_WRITE_DISABLED_CAP_STRING "EFI_WRITE_DISABLED_CAP"
  99 #define EFI_FVB2_WRITE_ENABLED_CAP_STRING  "EFI_WRITE_ENABLED_CAP"
 100 #define EFI_FVB2_WRITE_STATUS_STRING       "EFI_WRITE_STATUS"
 101
 102 #define EFI_FVB2_LOCK_CAP_STRING           "EFI_LOCK_CAP"
 103 #define EFI_FVB2_LOCK_STATUS_STRING        "EFI_LOCK_STATUS"
 104
 105 #define EFI_FVB2_STICKY_WRITE_STRING       "EFI_STICKY_WRITE"
 106 #define EFI_FVB2_MEMORY_MAPPED_STRING      "EFI_MEMORY_MAPPED"
 107 #define EFI_FVB2_ERASE_POLARITY_STRING     "EFI_ERASE_POLARITY"
 108
 109 #define EFI_FVB2_READ_LOCK_CAP_STRING      "EFI_READ_LOCK_CAP"
 110 #define EFI_FVB2_READ_LOCK_STATUS_STRING   "EFI_READ_LOCK_STATUS"
 111 #define EFI_FVB2_WRITE_LOCK_CAP_STRING     "EFI_WRITE_LOCK_CAP"
 112 #define EFI_FVB2_WRITE_LOCK_STATUS_STRING  "EFI_WRITE_LOCK_STATUS"
 113
 114 #define EFI_FVB2_ALIGNMENT_1_STRING       "EFI_FVB2_ALIGNMENT_1"
 115 #define EFI_FVB2_ALIGNMENT_2_STRING       "EFI_FVB2_ALIGNMENT_2"
 116 #define EFI_FVB2_ALIGNMENT_4_STRING       "EFI_FVB2_ALIGNMENT_4"
 117 #define EFI_FVB2_ALIGNMENT_8_STRING       "EFI_FVB2_ALIGNMENT_8"
 118 #define EFI_FVB2_ALIGNMENT_16_STRING      "EFI_FVB2_ALIGNMENT_16"
 119 #define EFI_FVB2_ALIGNMENT_32_STRING      "EFI_FVB2_ALIGNMENT_32"
 120 #define EFI_FVB2_ALIGNMENT_64_STRING      "EFI_FVB2_ALIGNMENT_64"
 121 #define EFI_FVB2_ALIGNMENT_128_STRING     "EFI_FVB2_ALIGNMENT_128"
 122 #define EFI_FVB2_ALIGNMENT_256_STRING     "EFI_FVB2_ALIGNMENT_256"
 123 #define EFI_FVB2_ALIGNMENT_512_STRING     "EFI_FVB2_ALIGNMENT_512"
 124 #define EFI_FVB2_ALIGNMENT_1K_STRING      "EFI_FVB2_ALIGNMENT_1K"
 125 #define EFI_FVB2_ALIGNMENT_2K_STRING      "EFI_FVB2_ALIGNMENT_2K"
 126 #define EFI_FVB2_ALIGNMENT_4K_STRING      "EFI_FVB2_ALIGNMENT_4K"
 127 #define EFI_FVB2_ALIGNMENT_8K_STRING      "EFI_FVB2_ALIGNMENT_8K"
 128 #define EFI_FVB2_ALIGNMENT_16K_STRING     "EFI_FVB2_ALIGNMENT_16K"
 129 #define EFI_FVB2_ALIGNMENT_32K_STRING     "EFI_FVB2_ALIGNMENT_32K"
 130 #define EFI_FVB2_ALIGNMENT_64K_STRING     "EFI_FVB2_ALIGNMENT_64K"
 131 #define EFI_FVB2_ALIGNMENT_128K_STRING    "EFI_FVB2_ALIGNMENT_128K"
 132 #define EFI_FVB2_ALIGNMENT_256K_STRING    "EFI_FVB2_ALIGNMENT_256K"
 133 #define EFI_FVB2_ALIGNMNET_512K_STRING    "EFI_FVB2_ALIGNMENT_512K"
 134 #define EFI_FVB2_ALIGNMENT_1M_STRING      "EFI_FVB2_ALIGNMENT_1M"
 135 #define EFI_FVB2_ALIGNMENT_2M_STRING      "EFI_FVB2_ALIGNMENT_2M"
 136 #define EFI_FVB2_ALIGNMENT_4M_STRING      "EFI_FVB2_ALIGNMENT_4M"
 137 #define EFI_FVB2_ALIGNMENT_8M_STRING      "EFI_FVB2_ALIGNMENT_8M"
 138 #define EFI_FVB2_ALIGNMENT_16M_STRING     "EFI_FVB2_ALIGNMENT_16M"
 139 #define EFI_FVB2_ALIGNMENT_32M_STRING     "EFI_FVB2_ALIGNMENT_32M"
 140 #define EFI_FVB2_ALIGNMENT_64M_STRING     "EFI_FVB2_ALIGNMENT_64M"
 141 #define EFI_FVB2_ALIGNMENT_128M_STRING    "EFI_FVB2_ALIGNMENT_128M"
 142 #define EFI_FVB2_ALIGNMENT_256M_STRING    "EFI_FVB2_ALIGNMENT_256M"
 143 #define EFI_FVB2_ALIGNMENT_512M_STRING    "EFI_FVB2_ALIGNMENT_512M"
 144 #define EFI_FVB2_ALIGNMENT_1G_STRING      "EFI_FVB2_ALIGNMENT_1G"
 145 #define EFI_FVB2_ALIGNMENT_2G_STRING      "EFI_FVB2_ALIGNMENT_2G"
 146
 147 //
 148 // File sections
 149 //
 150 #define EFI_FILE_NAME_STRING      "EFI_FILE_NAME"
 151
 152 #define ONE_STRING                "1"
 153 #define ZERO_STRING               "0"
 154 #define TRUE_STRING               "TRUE"
 155 #define FALSE_STRING              "FALSE"
 156 #define NULL_STRING               "NULL"
 157
 158 //
 159 //
 160 //
 161 #define EFI_FV_EXT_HEADER_FILE_NAME     "EFI_FV_EXT_HEADER_FILE_NAME"
 162
 163
 164 //
 165 // VTF (Firmware Volume Top File) signatures
 166 //
 167 #define IA32_X64_VTF_SIGNATURE_OFFSET    0x14
 168 #define IA32_X64_VTF0_SIGNATURE EFI_SIGNATURE_32('V','T','F',0)
 169
 170 //
 171 // Defines to calculate the offset for PEI CORE entry points
 172 //
 173 #define IA32_PEI_CORE_ENTRY_OFFSET    0x20
 174
 175 //
 176 // Defines to calculate the offset for IA32 SEC CORE entry point
 177 //
 178 #define IA32_SEC_CORE_ENTRY_OFFSET     0xD
 179
 180 //
 181 // Defines to calculate the FIT table
 182 //
 183 #define IPF_FIT_ADDRESS_OFFSET        0x20
 184
 185 //
 186 // Defines to calculate the offset for SALE_ENTRY
 187 //
 188 #define IPF_SALE_ENTRY_ADDRESS_OFFSET 0x18
 189
 190 //
 191 // Symbol file definitions, current max size if 512K
 192 //
 193 #define SYMBOL_FILE_SIZE              0x80000
 194
 195 #define FV_IMAGES_TOP_ADDRESS         0x100000000ULL
 196
 197 //
 198 // Following definition is used for FIT in IPF
 199 //
 200 #define COMP_TYPE_FIT_PEICORE 0x10
 201 #define COMP_TYPE_FIT_UNUSED  0x7F
 202
 203 #define FIT_TYPE_MASK         0x7F
 204 #define CHECKSUM_BIT_MASK     0x80
 205
 206 //
 207 // Private data types
 208 //
 209 //
 210 // Component information
 211 //
 212 typedef struct {
 213   UINTN Size;
 214   CHAR8 ComponentName[_MAX_PATH];
 215 } COMPONENT_INFO;
 216
 217 //
 218 // FV and capsule information holder
 219 //
 220 typedef struct {
 221   BOOLEAN                 BaseAddressSet;
 222   EFI_PHYSICAL_ADDRESS    BaseAddress;
 223   EFI_GUID                FvFileSystemGuid;
 224   BOOLEAN                 FvFileSystemGuidSet;
 225   EFI_GUID                FvNameGuid;
 226   BOOLEAN                 FvNameGuidSet;
 227   CHAR8                   FvExtHeaderFile[_MAX_PATH];
 228   UINTN                   Size;
 229   EFI_FVB_ATTRIBUTES      FvAttributes;
 230   CHAR8                   FvName[_MAX_PATH];
 231   EFI_FV_BLOCK_MAP_ENTRY  FvBlocks[MAX_NUMBER_OF_FV_BLOCKS];
 232   CHAR8                   FvFiles[MAX_NUMBER_OF_FILES_IN_FV][_MAX_PATH];
 233   UINT32                  SizeofFvFiles[MAX_NUMBER_OF_FILES_IN_FV];
 234   BOOLEAN                 IsPiFvImage;
 235 } FV_INFO;
 236
 237 typedef struct {
 238   EFI_GUID                CapGuid;
 239   UINT32                  HeaderSize;
 240   UINT32                  Flags;
 241   CHAR8                   CapName[_MAX_PATH];
 242   CHAR8                   CapFiles[MAX_NUMBER_OF_FILES_IN_CAP][_MAX_PATH];
 243 } CAP_INFO;
 244
 245 #pragma pack(1)
 246
 247 typedef struct {
 248   UINT64  CompAddress;
 249   UINT32  CompSize;
 250   UINT16  CompVersion;
 251   UINT8   CvAndType;
 252   UINT8   CheckSum;
 253 } FIT_TABLE;
 254
 255 #pragma pack()
 256
 257 #define FV_DEFAULT_ATTRIBUTE  0x0004FEFF
 258 extern FV_INFO    mFvDataInfo;
 259 extern CAP_INFO   mCapDataInfo;
 260 extern EFI_GUID   mEfiFirmwareFileSystem2Guid;
 261 extern UINT32     mFvTotalSize;
 262 extern UINT32     mFvTakenSize;
 263
 264 extern EFI_PHYSICAL_ADDRESS mFvBaseAddress[];
 265 extern UINT32               mFvBaseAddressNumber;
 266 //
 267 // Local function prototypes
 268 //
 269 EFI_STATUS
 270 ParseFvInf (
 271   IN  MEMORY_FILE  *InfFile,
 272   OUT FV_INFO      *FvInfo
 273   )
 274 ;
 275
 276 EFI_STATUS
 277 UpdatePeiCoreEntryInFit (
 278   IN FIT_TABLE     *FitTablePtr,
 279   IN UINT64        PeiCorePhysicalAddress
 280   )
 281 /*++
 282
 283 Routine Description:
 284
 285   This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from
 286   Sec to Pei Core
 287
 288 Arguments:
 289
 290   FitTablePtr             - The pointer of FIT_TABLE.
 291   PeiCorePhysicalAddress  - The address of Pei Core entry.
 292
 293 Returns:
 294
 295   EFI_SUCCESS             - The PEI_CORE FIT entry was updated successfully.
 296   EFI_NOT_FOUND           - Not found the PEI_CORE FIT entry.
 297
 298 --*/
 299 ;
 300
 301 VOID
 302 UpdateFitCheckSum (
 303   IN FIT_TABLE   *FitTablePtr
 304   )
 305 /*++
 306
 307 Routine Description:
 308
 309   This function is used to update the checksum for FIT.
 310
 311
 312 Arguments:
 313
 314   FitTablePtr             - The pointer of FIT_TABLE.
 315
 316 Returns:
 317
 318   None.
 319
 320 --*/
 321 ;
 322
 323 EFI_STATUS
 324 GetPe32Info (
 325   IN UINT8                  *Pe32,
 326   OUT UINT32                *EntryPoint,
 327   OUT UINT32                *BaseOfCode,
 328   OUT UINT16                *MachineType
 329   );
 330
 331 EFI_STATUS
 332 ParseCapInf (
 333   IN  MEMORY_FILE  *InfFile,
 334   OUT CAP_INFO     *CapInfo
 335   );
 336
 337 EFI_STATUS
 338 FindApResetVectorPosition (
 339   IN  MEMORY_FILE  *FvImage,
 340   OUT UINT8        **Pointer
 341   );
 342
 343 EFI_STATUS
 344 CalculateFvSize (
 345   FV_INFO *FvInfoPtr
 346   );
 347
 348 EFI_STATUS
 349 FfsRebase (
 350   IN OUT  FV_INFO               *FvInfo,
 351   IN      CHAR8                 *FileName,
 352   IN OUT  EFI_FFS_FILE_HEADER   *FfsFile,
 353   IN      UINTN                 XipOffset,
 354   IN      FILE                  *FvMapFile
 355   );
 356
 357 //
 358 // Exported function prototypes
 359 //
 360 EFI_STATUS
 361 GenerateCapImage (
 362   IN CHAR8                *InfFileImage,
 363   IN UINTN                InfFileSize,
 364   IN CHAR8                *CapFileName
 365   )
 366 /*++
 367
 368 Routine Description:
 369
 370   This is the main function which will be called from application to
 371   generate UEFI Capsule image.
 372
 373 Arguments:
 374
 375   InfFileImage   Buffer containing the INF file contents.
 376   InfFileSize    Size of the contents of the InfFileImage buffer.
 377   CapFileName    Requested name for the Cap file.
 378
 379 Returns:
 380
 381   EFI_SUCCESS             Function completed successfully.
 382   EFI_OUT_OF_RESOURCES    Could not allocate required resources.
 383   EFI_ABORTED             Error encountered.
 384   EFI_INVALID_PARAMETER   A required parameter was NULL.
 385
 386 --*/
 387 ;
 388
 389 EFI_STATUS
 390 GenerateFvImage (
 391   IN CHAR8                *InfFileImage,
 392   IN UINTN                InfFileSize,
 393   IN CHAR8                *FvFileName,
 394   IN CHAR8                *MapFileName
 395   )
 396 /*++
 397
 398 Routine Description:
 399
 400   This is the main function which will be called from application to
 401   generate Firmware Image conforms to PI spec.
 402
 403 Arguments:
 404
 405   InfFileImage   Buffer containing the INF file contents.
 406   InfFileSize    Size of the contents of the InfFileImage buffer.
 407   FvFileName     Requested name for the FV file.
 408   MapFileName    Fv map file to log fv driver information.
 409
 410 Returns:
 411
 412   EFI_SUCCESS             Function completed successfully.
 413   EFI_OUT_OF_RESOURCES    Could not allocate required resources.
 414   EFI_ABORTED             Error encountered.
 415   EFI_INVALID_PARAMETER   A required parameter was NULL.
 416
 417 --*/
 418 ;
 419
 420 #endif