[mirror_edk2.git] / IntelFsp2Pkg / Tools / SplitFspBin.py

## @ SplitFspBin.py\r
#\r
# Copyright (c) 2015 - 2022, Intel Corporation. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
##\r
\r
import os\r
import sys\r
import uuid\r
import copy\r
import struct\r
import argparse\r
from   ctypes import *\r
from functools import reduce\r
\r
"""\r
This utility supports some operations for Intel FSP 1.x/2.x image.\r
It supports:\r
    - Display FSP 1.x/2.x information header\r
    - Split FSP 2.x image into individual FSP-T/M/S/O component\r
    - Rebase FSP 1.x/2.x components to a different base address\r
    - Generate FSP 1.x/2.x mapping C header file\r
"""\r
\r
CopyRightHeaderFile = """/*\r
 *\r
 * Automatically generated file; DO NOT EDIT.\r
 * FSP mapping file\r
 *\r
 */\r
"""\r
\r
class c_uint24(Structure):\r
    """Little-Endian 24-bit Unsigned Integer"""\r
    _pack_   = 1\r
    _fields_ = [('Data', (c_uint8 * 3))]\r
\r
    def __init__(self, val=0):\r
        self.set_value(val)\r
\r
    def __str__(self, indent=0):\r
        return '0x%.6x' % self.value\r
\r
    def __int__(self):\r
        return self.get_value()\r
\r
    def set_value(self, val):\r
        self.Data[0:3] = Val2Bytes(val, 3)\r
\r
    def get_value(self):\r
        return Bytes2Val(self.Data[0:3])\r
\r
    value = property(get_value, set_value)\r
\r
class EFI_FIRMWARE_VOLUME_HEADER(Structure):\r
    _fields_ = [\r
        ('ZeroVector',           ARRAY(c_uint8, 16)),\r
        ('FileSystemGuid',       ARRAY(c_uint8, 16)),\r
        ('FvLength',             c_uint64),\r
        ('Signature',            ARRAY(c_char, 4)),\r
        ('Attributes',           c_uint32),\r
        ('HeaderLength',         c_uint16),\r
        ('Checksum',             c_uint16),\r
        ('ExtHeaderOffset',      c_uint16),\r
        ('Reserved',             c_uint8),\r
        ('Revision',             c_uint8)\r
        ]\r
\r
class EFI_FIRMWARE_VOLUME_EXT_HEADER(Structure):\r
    _fields_ = [\r
        ('FvName',               ARRAY(c_uint8, 16)),\r
        ('ExtHeaderSize',        c_uint32)\r
        ]\r
\r
class EFI_FFS_INTEGRITY_CHECK(Structure):\r
    _fields_ = [\r
        ('Header',               c_uint8),\r
        ('File',                 c_uint8)\r
        ]\r
\r
class EFI_FFS_FILE_HEADER(Structure):\r
    _fields_ = [\r
        ('Name',                 ARRAY(c_uint8, 16)),\r
        ('IntegrityCheck',       EFI_FFS_INTEGRITY_CHECK),\r
        ('Type',                 c_uint8),\r
        ('Attributes',           c_uint8),\r
        ('Size',                 c_uint24),\r
        ('State',                c_uint8)\r
        ]\r
\r
class EFI_COMMON_SECTION_HEADER(Structure):\r
    _fields_ = [\r
        ('Size',                 c_uint24),\r
        ('Type',                 c_uint8)\r
        ]\r
\r
class FSP_COMMON_HEADER(Structure):\r
     _fields_ = [\r
        ('Signature',            ARRAY(c_char, 4)),\r
        ('HeaderLength',         c_uint32)\r
        ]\r
\r
class FSP_INFORMATION_HEADER(Structure):\r
     _fields_ = [\r
        ('Signature',                       ARRAY(c_char, 4)),\r
        ('HeaderLength',                    c_uint32),\r
        ('Reserved1',                       c_uint16),\r
        ('SpecVersion',                     c_uint8),\r
        ('HeaderRevision',                  c_uint8),\r
        ('ImageRevision',                   c_uint32),\r
        ('ImageId',                         ARRAY(c_char, 8)),\r
        ('ImageSize',                       c_uint32),\r
        ('ImageBase',                       c_uint32),\r
        ('ImageAttribute',                  c_uint16),\r
        ('ComponentAttribute',              c_uint16),\r
        ('CfgRegionOffset',                 c_uint32),\r
        ('CfgRegionSize',                   c_uint32),\r
        ('Reserved2',                       c_uint32),\r
        ('TempRamInitEntryOffset',          c_uint32),\r
        ('Reserved3',                       c_uint32),\r
        ('NotifyPhaseEntryOffset',          c_uint32),\r
        ('FspMemoryInitEntryOffset',        c_uint32),\r
        ('TempRamExitEntryOffset',          c_uint32),\r
        ('FspSiliconInitEntryOffset',       c_uint32),\r
        ('FspMultiPhaseSiInitEntryOffset',  c_uint32),\r
        ('ExtendedImageRevision',           c_uint16),\r
        ('Reserved4',                       c_uint16),\r
        ('FspMultiPhaseMemInitEntryOffset', c_uint32),\r
        ('FspSmmInitEntryOffset',           c_uint32)\r
    ]\r
\r
class FSP_PATCH_TABLE(Structure):\r
    _fields_ = [\r
        ('Signature',            ARRAY(c_char, 4)),\r
        ('HeaderLength',         c_uint16),\r
        ('HeaderRevision',       c_uint8),\r
        ('Reserved',             c_uint8),\r
        ('PatchEntryNum',        c_uint32)\r
        ]\r
\r
class EFI_IMAGE_DATA_DIRECTORY(Structure):\r
    _fields_ = [\r
        ('VirtualAddress',       c_uint32),\r
        ('Size',                 c_uint32)\r
        ]\r
\r
class EFI_TE_IMAGE_HEADER(Structure):\r
    _fields_ = [\r
        ('Signature',            ARRAY(c_char, 2)),\r
        ('Machine',              c_uint16),\r
        ('NumberOfSections',     c_uint8),\r
        ('Subsystem',            c_uint8),\r
        ('StrippedSize',         c_uint16),\r
        ('AddressOfEntryPoint',  c_uint32),\r
        ('BaseOfCode',           c_uint32),\r
        ('ImageBase',            c_uint64),\r
        ('DataDirectoryBaseReloc',  EFI_IMAGE_DATA_DIRECTORY),\r
        ('DataDirectoryDebug',      EFI_IMAGE_DATA_DIRECTORY)\r
        ]\r
\r
class EFI_IMAGE_DOS_HEADER(Structure):\r
    _fields_ = [\r
        ('e_magic',              c_uint16),\r
        ('e_cblp',               c_uint16),\r
        ('e_cp',                 c_uint16),\r
        ('e_crlc',               c_uint16),\r
        ('e_cparhdr',            c_uint16),\r
        ('e_minalloc',           c_uint16),\r
        ('e_maxalloc',           c_uint16),\r
        ('e_ss',                 c_uint16),\r
        ('e_sp',                 c_uint16),\r
        ('e_csum',               c_uint16),\r
        ('e_ip',                 c_uint16),\r
        ('e_cs',                 c_uint16),\r
        ('e_lfarlc',             c_uint16),\r
        ('e_ovno',               c_uint16),\r
        ('e_res',                ARRAY(c_uint16, 4)),\r
        ('e_oemid',              c_uint16),\r
        ('e_oeminfo',            c_uint16),\r
        ('e_res2',               ARRAY(c_uint16, 10)),\r
        ('e_lfanew',             c_uint16)\r
        ]\r
\r
class EFI_IMAGE_FILE_HEADER(Structure):\r
    _fields_ = [\r
        ('Machine',               c_uint16),\r
        ('NumberOfSections',      c_uint16),\r
        ('TimeDateStamp',         c_uint32),\r
        ('PointerToSymbolTable',  c_uint32),\r
        ('NumberOfSymbols',       c_uint32),\r
        ('SizeOfOptionalHeader',  c_uint16),\r
        ('Characteristics',       c_uint16)\r
        ]\r
\r
class PE_RELOC_BLOCK_HEADER(Structure):\r
    _fields_ = [\r
        ('PageRVA',              c_uint32),\r
        ('BlockSize',            c_uint32)\r
        ]\r
\r
class EFI_IMAGE_OPTIONAL_HEADER32(Structure):\r
    _fields_ = [\r
        ('Magic',                         c_uint16),\r
        ('MajorLinkerVersion',            c_uint8),\r
        ('MinorLinkerVersion',            c_uint8),\r
        ('SizeOfCode',                    c_uint32),\r
        ('SizeOfInitializedData',         c_uint32),\r
        ('SizeOfUninitializedData',       c_uint32),\r
        ('AddressOfEntryPoint',           c_uint32),\r
        ('BaseOfCode',                    c_uint32),\r
        ('BaseOfData',                    c_uint32),\r
        ('ImageBase',                     c_uint32),\r
        ('SectionAlignment',              c_uint32),\r
        ('FileAlignment',                 c_uint32),\r
        ('MajorOperatingSystemVersion',   c_uint16),\r
        ('MinorOperatingSystemVersion',   c_uint16),\r
        ('MajorImageVersion',             c_uint16),\r
        ('MinorImageVersion',             c_uint16),\r
        ('MajorSubsystemVersion',         c_uint16),\r
        ('MinorSubsystemVersion',         c_uint16),\r
        ('Win32VersionValue',             c_uint32),\r
        ('SizeOfImage',                   c_uint32),\r
        ('SizeOfHeaders',                 c_uint32),\r
        ('CheckSum'     ,                 c_uint32),\r
        ('Subsystem',                     c_uint16),\r
        ('DllCharacteristics',            c_uint16),\r
        ('SizeOfStackReserve',            c_uint32),\r
        ('SizeOfStackCommit' ,            c_uint32),\r
        ('SizeOfHeapReserve',             c_uint32),\r
        ('SizeOfHeapCommit' ,             c_uint32),\r
        ('LoaderFlags'     ,              c_uint32),\r
        ('NumberOfRvaAndSizes',           c_uint32),\r
        ('DataDirectory',                 ARRAY(EFI_IMAGE_DATA_DIRECTORY, 16))\r
        ]\r
\r
class EFI_IMAGE_OPTIONAL_HEADER32_PLUS(Structure):\r
    _fields_ = [\r
        ('Magic',                         c_uint16),\r
        ('MajorLinkerVersion',            c_uint8),\r
        ('MinorLinkerVersion',            c_uint8),\r
        ('SizeOfCode',                    c_uint32),\r
        ('SizeOfInitializedData',         c_uint32),\r
        ('SizeOfUninitializedData',       c_uint32),\r
        ('AddressOfEntryPoint',           c_uint32),\r
        ('BaseOfCode',                    c_uint32),\r
        ('ImageBase',                     c_uint64),\r
        ('SectionAlignment',              c_uint32),\r
        ('FileAlignment',                 c_uint32),\r
        ('MajorOperatingSystemVersion',   c_uint16),\r
        ('MinorOperatingSystemVersion',   c_uint16),\r
        ('MajorImageVersion',             c_uint16),\r
        ('MinorImageVersion',             c_uint16),\r
        ('MajorSubsystemVersion',         c_uint16),\r
        ('MinorSubsystemVersion',         c_uint16),\r
        ('Win32VersionValue',             c_uint32),\r
        ('SizeOfImage',                   c_uint32),\r
        ('SizeOfHeaders',                 c_uint32),\r
        ('CheckSum'     ,                 c_uint32),\r
        ('Subsystem',                     c_uint16),\r
        ('DllCharacteristics',            c_uint16),\r
        ('SizeOfStackReserve',            c_uint64),\r
        ('SizeOfStackCommit' ,            c_uint64),\r
        ('SizeOfHeapReserve',             c_uint64),\r
        ('SizeOfHeapCommit' ,             c_uint64),\r
        ('LoaderFlags'     ,              c_uint32),\r
        ('NumberOfRvaAndSizes',           c_uint32),\r
        ('DataDirectory',                 ARRAY(EFI_IMAGE_DATA_DIRECTORY, 16))\r
        ]\r
\r
class EFI_IMAGE_OPTIONAL_HEADER(Union):\r
    _fields_ = [\r
        ('PeOptHdr',             EFI_IMAGE_OPTIONAL_HEADER32),\r
        ('PePlusOptHdr',         EFI_IMAGE_OPTIONAL_HEADER32_PLUS)\r
        ]\r
\r
class EFI_IMAGE_NT_HEADERS32(Structure):\r
    _fields_ = [\r
        ('Signature',            c_uint32),\r
        ('FileHeader',           EFI_IMAGE_FILE_HEADER),\r
        ('OptionalHeader',       EFI_IMAGE_OPTIONAL_HEADER)\r
        ]\r
\r
\r
class EFI_IMAGE_DIRECTORY_ENTRY:\r
    EXPORT                     = 0\r
    IMPORT                     = 1\r
    RESOURCE                   = 2\r
    EXCEPTION                  = 3\r
    SECURITY                   = 4\r
    BASERELOC                  = 5\r
    DEBUG                      = 6\r
    COPYRIGHT                  = 7\r
    GLOBALPTR                  = 8\r
    TLS                        = 9\r
    LOAD_CONFIG                = 10\r
\r
class EFI_FV_FILETYPE:\r
    ALL                        = 0x00\r
    RAW                        = 0x01\r
    FREEFORM                   = 0x02\r
    SECURITY_CORE              = 0x03\r
    PEI_CORE                   = 0x04\r
    DXE_CORE                   = 0x05\r
    PEIM                       = 0x06\r
    DRIVER                     = 0x07\r
    COMBINED_PEIM_DRIVER       = 0x08\r
    APPLICATION                = 0x09\r
    SMM                        = 0x0a\r
    FIRMWARE_VOLUME_IMAGE      = 0x0b\r
    COMBINED_SMM_DXE           = 0x0c\r
    SMM_CORE                   = 0x0d\r
    OEM_MIN                    = 0xc0\r
    OEM_MAX                    = 0xdf\r
    DEBUG_MIN                  = 0xe0\r
    DEBUG_MAX                  = 0xef\r
    FFS_MIN                    = 0xf0\r
    FFS_MAX                    = 0xff\r
    FFS_PAD                    = 0xf0\r
\r
class EFI_SECTION_TYPE:\r
    """Enumeration of all valid firmware file section types."""\r
    ALL                        = 0x00\r
    COMPRESSION                = 0x01\r
    GUID_DEFINED               = 0x02\r
    DISPOSABLE                 = 0x03\r
    PE32                       = 0x10\r
    PIC                        = 0x11\r
    TE                         = 0x12\r
    DXE_DEPEX                  = 0x13\r
    VERSION                    = 0x14\r
    USER_INTERFACE             = 0x15\r
    COMPATIBILITY16            = 0x16\r
    FIRMWARE_VOLUME_IMAGE      = 0x17\r
    FREEFORM_SUBTYPE_GUID      = 0x18\r
    RAW                        = 0x19\r
    PEI_DEPEX                  = 0x1b\r
    SMM_DEPEX                  = 0x1c\r
\r
def AlignPtr (offset, alignment = 8):\r
    return (offset + alignment - 1) & ~(alignment - 1)\r
\r
def Bytes2Val (bytes):\r
    return reduce(lambda x,y: (x<<8)|y,  bytes[::-1] )\r
\r
def Val2Bytes (value, blen):\r
    return [(value>>(i*8) & 0xff) for i in range(blen)]\r
\r
def IsIntegerType (val):\r
    if sys.version_info[0] < 3:\r
        if type(val) in (int, long):\r
            return True\r
    else:\r
        if type(val) is int:\r
            return True\r
    return False\r
\r
def IsStrType (val):\r
    if sys.version_info[0] < 3:\r
        if type(val) is str:\r
            return True\r
    else:\r
        if type(val) is bytes:\r
            return True\r
    return False\r
\r
def HandleNameStr (val):\r
    if sys.version_info[0] < 3:\r
        rep = "0x%X ('%s')" % (Bytes2Val (bytearray (val)), val)\r
    else:\r
        rep = "0x%X ('%s')" % (Bytes2Val (bytearray (val)), str (val, 'utf-8'))\r
    return rep\r
\r
def OutputStruct (obj, indent = 0, plen = 0):\r
    if indent:\r
        body = ''\r
    else:\r
        body = ('  ' * indent + '<%s>:\n') % obj.__class__.__name__\r
\r
    if plen == 0:\r
        plen = sizeof(obj)\r
\r
    max_key_len = 26\r
    pstr = ('  ' * (indent + 1) + '{0:<%d} = {1}\n') % max_key_len\r
\r
    for field in obj._fields_:\r
        key = field[0]\r
        val = getattr(obj, key)\r
        rep = ''\r
        if not isinstance(val, c_uint24) and isinstance(val, Structure):\r
            body += pstr.format(key, val.__class__.__name__)\r
            body += OutputStruct (val, indent + 1)\r
            plen -= sizeof(val)\r
        else:\r
            if IsStrType (val):\r
                rep = HandleNameStr (val)\r
            elif IsIntegerType (val):\r
                if (key == 'ImageRevision'):\r
                    FspImageRevisionMajor       = ((val >> 24) & 0xFF)\r
                    FspImageRevisionMinor       = ((val >> 16) & 0xFF)\r
                    FspImageRevisionRevision    = ((val >> 8) & 0xFF)\r
                    FspImageRevisionBuildNumber = (val & 0xFF)\r
                    rep = '0x%08X' % val\r
                elif (key == 'ExtendedImageRevision'):\r
                    FspImageRevisionRevision    |= (val & 0xFF00)\r
                    FspImageRevisionBuildNumber |= ((val << 8) & 0xFF00)\r
                    rep = "0x%04X ('%02X.%02X.%04X.%04X')" % (val, FspImageRevisionMajor, FspImageRevisionMinor, FspImageRevisionRevision, FspImageRevisionBuildNumber)\r
                elif field[1] == c_uint64:\r
                    rep = '0x%016X' % val\r
                elif field[1] == c_uint32:\r
                    rep = '0x%08X' % val\r
                elif field[1] == c_uint16:\r
                    rep = '0x%04X' % val\r
                elif field[1] == c_uint8:\r
                    rep = '0x%02X' % val\r
                else:\r
                    rep = '0x%X' % val\r
            elif isinstance(val, c_uint24):\r
                rep = '0x%X' % val.get_value()\r
            elif 'c_ubyte_Array' in str(type(val)):\r
                if sizeof(val) == 16:\r
                    if sys.version_info[0] < 3:\r
                        rep = str(bytearray(val))\r
                    else:\r
                        rep = bytes(val)\r
                    rep = str(uuid.UUID(bytes_le = rep)).upper()\r
                else:\r
                    res = ['0x%02X'%i for i in bytearray(val)]\r
                    rep = '[%s]' % (','.join(res))\r
            else:\r
                rep = str(val)\r
            plen -= sizeof(field[1])\r
            body += pstr.format(key, rep)\r
        if plen <= 0:\r
            break\r
    return body\r
\r
class Section:\r
    def __init__(self, offset, secdata):\r
        self.SecHdr   = EFI_COMMON_SECTION_HEADER.from_buffer (secdata, 0)\r
        self.SecData  = secdata[0:int(self.SecHdr.Size)]\r
        self.Offset   = offset\r
\r
class FirmwareFile:\r
    def __init__(self, offset, filedata):\r
        self.FfsHdr   = EFI_FFS_FILE_HEADER.from_buffer (filedata, 0)\r
        self.FfsData  = filedata[0:int(self.FfsHdr.Size)]\r
        self.Offset   = offset\r
        self.SecList  = []\r
\r
    def ParseFfs(self):\r
        ffssize = len(self.FfsData)\r
        offset  = sizeof(self.FfsHdr)\r
        if self.FfsHdr.Name != '\xff' * 16:\r
            while offset < (ffssize - sizeof (EFI_COMMON_SECTION_HEADER)):\r
                sechdr = EFI_COMMON_SECTION_HEADER.from_buffer (self.FfsData, offset)\r
                sec = Section (offset, self.FfsData[offset:offset + int(sechdr.Size)])\r
                self.SecList.append(sec)\r
                offset += int(sechdr.Size)\r
                offset  = AlignPtr(offset, 4)\r
\r
class FirmwareVolume:\r
    def __init__(self, offset, fvdata):\r
        self.FvHdr    = EFI_FIRMWARE_VOLUME_HEADER.from_buffer (fvdata, 0)\r
        self.FvData   = fvdata[0 : self.FvHdr.FvLength]\r
        self.Offset   = offset\r
        if self.FvHdr.ExtHeaderOffset > 0:\r
            self.FvExtHdr = EFI_FIRMWARE_VOLUME_EXT_HEADER.from_buffer (self.FvData, self.FvHdr.ExtHeaderOffset)\r
        else:\r
            self.FvExtHdr = None\r
        self.FfsList  = []\r
\r
    def ParseFv(self):\r
        fvsize = len(self.FvData)\r
        if self.FvExtHdr:\r
            offset = self.FvHdr.ExtHeaderOffset + self.FvExtHdr.ExtHeaderSize\r
        else:\r
            offset = self.FvHdr.HeaderLength\r
        offset = AlignPtr(offset)\r
        while offset < (fvsize - sizeof (EFI_FFS_FILE_HEADER)):\r
            ffshdr = EFI_FFS_FILE_HEADER.from_buffer (self.FvData, offset)\r
            if (ffshdr.Name == '\xff' * 16) and (int(ffshdr.Size) == 0xFFFFFF):\r
                offset = fvsize\r
            else:\r
                ffs = FirmwareFile (offset, self.FvData[offset:offset + int(ffshdr.Size)])\r
                ffs.ParseFfs()\r
                self.FfsList.append(ffs)\r
                offset += int(ffshdr.Size)\r
                offset = AlignPtr(offset)\r
\r
class FspImage:\r
    def __init__(self, offset, fih, fihoff, patch):\r
        self.Fih       = fih\r
        self.FihOffset = fihoff\r
        self.Offset    = offset\r
        self.FvIdxList = []\r
        self.Type      = "XTMSIXXXOXXXXXXX"[(fih.ComponentAttribute >> 12) & 0x0F]\r
        self.PatchList = patch\r
        self.PatchList.append(fihoff + 0x1C)\r
\r
    def AppendFv(self, FvIdx):\r
        self.FvIdxList.append(FvIdx)\r
\r
    def Patch(self, delta, fdbin):\r
        count   = 0\r
        applied = 0\r
        for idx, patch in enumerate(self.PatchList):\r
            ptype = (patch>>24) & 0x0F\r
            if ptype not in [0x00, 0x0F]:\r
                raise Exception('ERROR: Invalid patch type %d !' % ptype)\r
            if patch & 0x80000000:\r
                patch = self.Fih.ImageSize - (0x1000000 - (patch & 0xFFFFFF))\r
            else:\r
                patch = patch & 0xFFFFFF\r
            if (patch < self.Fih.ImageSize) and (patch + sizeof(c_uint32) <= self.Fih.ImageSize):\r
                offset = patch + self.Offset\r
                value  = Bytes2Val(fdbin[offset:offset+sizeof(c_uint32)])\r
                value += delta\r
                fdbin[offset:offset+sizeof(c_uint32)] = Val2Bytes(value, sizeof(c_uint32))\r
                applied += 1\r
            count += 1\r
        # Don't count the FSP base address patch entry appended at the end\r
        if count != 0:\r
            count   -= 1\r
            applied -= 1\r
        return (count, applied)\r
\r
class FirmwareDevice:\r
    def __init__(self, offset, fdfile):\r
        self.FvList  = []\r
        self.FspList = []\r
        self.FdFile = fdfile\r
        self.Offset = 0\r
        hfsp = open (self.FdFile, 'rb')\r
        self.FdData = bytearray(hfsp.read())\r
        hfsp.close()\r
\r
    def ParseFd(self):\r
        offset = 0\r
        fdsize = len(self.FdData)\r
        self.FvList  = []\r
        while offset < (fdsize - sizeof (EFI_FIRMWARE_VOLUME_HEADER)):\r
            fvh = EFI_FIRMWARE_VOLUME_HEADER.from_buffer (self.FdData, offset)\r
            if b'_FVH' != fvh.Signature:\r
                raise Exception("ERROR: Invalid FV header !")\r
            fv = FirmwareVolume (offset, self.FdData[offset:offset + fvh.FvLength])\r
            fv.ParseFv ()\r
            self.FvList.append(fv)\r
            offset += fv.FvHdr.FvLength\r
\r
    def CheckFsp (self):\r
        if len(self.FspList) == 0:\r
            return\r
\r
        fih = None\r
        for fsp in self.FspList:\r
            if not fih:\r
                fih = fsp.Fih\r
            else:\r
                newfih = fsp.Fih\r
                if (newfih.ImageId != fih.ImageId) or (newfih.ImageRevision != fih.ImageRevision):\r
                    raise Exception("ERROR: Inconsistent FSP ImageId or ImageRevision detected !")\r
\r
    def ParseFsp(self):\r
        flen = 0\r
        for idx, fv in enumerate(self.FvList):\r
            # Check if this FV contains FSP header\r
            if flen == 0:\r
                if len(fv.FfsList) == 0:\r
                    continue\r
                ffs = fv.FfsList[0]\r
                if len(ffs.SecList) == 0:\r
                    continue\r
                sec = ffs.SecList[0]\r
                if sec.SecHdr.Type != EFI_SECTION_TYPE.RAW:\r
                    continue\r
                fihoffset = ffs.Offset + sec.Offset + sizeof(sec.SecHdr)\r
                fspoffset = fv.Offset\r
                offset    = fspoffset + fihoffset\r
                fih = FSP_INFORMATION_HEADER.from_buffer (self.FdData, offset)\r
                if b'FSPH' != fih.Signature:\r
                    continue\r
\r
                offset += fih.HeaderLength\r
                offset = AlignPtr(offset, 4)\r
                plist  = []\r
                while True:\r
                    fch = FSP_COMMON_HEADER.from_buffer (self.FdData, offset)\r
                    if b'FSPP' != fch.Signature:\r
                        offset += fch.HeaderLength\r
                        offset = AlignPtr(offset, 4)\r
                    else:\r
                        fspp = FSP_PATCH_TABLE.from_buffer (self.FdData, offset)\r
                        offset += sizeof(fspp)\r
                        pdata  = (c_uint32 * fspp.PatchEntryNum).from_buffer(self.FdData, offset)\r
                        plist  = list(pdata)\r
                        break\r
\r
                fsp  = FspImage (fspoffset, fih, fihoffset, plist)\r
                fsp.AppendFv (idx)\r
                self.FspList.append(fsp)\r
                flen = fsp.Fih.ImageSize - fv.FvHdr.FvLength\r
            else:\r
                fsp.AppendFv (idx)\r
                flen -= fv.FvHdr.FvLength\r
                if flen < 0:\r
                    raise Exception("ERROR: Incorrect FV size in image !")\r
        self.CheckFsp ()\r
\r
class PeTeImage:\r
    def __init__(self, offset, data):\r
        self.Offset    = offset\r
        tehdr          = EFI_TE_IMAGE_HEADER.from_buffer (data, 0)\r
        if   tehdr.Signature == b'VZ': # TE image\r
            self.TeHdr   = tehdr\r
        elif tehdr.Signature == b'MZ': # PE image\r
            self.TeHdr   = None\r
            self.DosHdr  = EFI_IMAGE_DOS_HEADER.from_buffer (data, 0)\r
            self.PeHdr   = EFI_IMAGE_NT_HEADERS32.from_buffer (data, self.DosHdr.e_lfanew)\r
            if self.PeHdr.Signature != 0x4550:\r
                raise Exception("ERROR: Invalid PE32 header !")\r
            if self.PeHdr.OptionalHeader.PeOptHdr.Magic == 0x10b: # PE32 image\r
                if self.PeHdr.FileHeader.SizeOfOptionalHeader < EFI_IMAGE_OPTIONAL_HEADER32.DataDirectory.offset:\r
                    raise Exception("ERROR: Unsupported PE32 image !")\r
                if self.PeHdr.OptionalHeader.PeOptHdr.NumberOfRvaAndSizes <= EFI_IMAGE_DIRECTORY_ENTRY.BASERELOC:\r
                    raise Exception("ERROR: No relocation information available !")\r
            elif self.PeHdr.OptionalHeader.PeOptHdr.Magic == 0x20b: # PE32+ image\r
                if self.PeHdr.FileHeader.SizeOfOptionalHeader < EFI_IMAGE_OPTIONAL_HEADER32_PLUS.DataDirectory.offset:\r
                    raise Exception("ERROR: Unsupported PE32+ image !")\r
                if self.PeHdr.OptionalHeader.PePlusOptHdr.NumberOfRvaAndSizes <= EFI_IMAGE_DIRECTORY_ENTRY.BASERELOC:\r
                    raise Exception("ERROR: No relocation information available !")\r
            else:\r
                raise Exception("ERROR: Invalid PE32 optional header !")\r
        self.Offset    = offset\r
        self.Data      = data\r
        self.RelocList = []\r
\r
    def IsTeImage(self):\r
        return  self.TeHdr is not None\r
\r
    def ParseReloc(self):\r
        if self.IsTeImage():\r
            rsize   = self.TeHdr.DataDirectoryBaseReloc.Size\r
            roffset = sizeof(self.TeHdr) - self.TeHdr.StrippedSize + self.TeHdr.DataDirectoryBaseReloc.VirtualAddress\r
        else:\r
            # Assuming PE32 image type (self.PeHdr.OptionalHeader.PeOptHdr.Magic == 0x10b)\r
            rsize   = self.PeHdr.OptionalHeader.PeOptHdr.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY.BASERELOC].Size\r
            roffset = self.PeHdr.OptionalHeader.PeOptHdr.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY.BASERELOC].VirtualAddress\r
            if self.PeHdr.OptionalHeader.PePlusOptHdr.Magic == 0x20b: # PE32+ image\r
                rsize   = self.PeHdr.OptionalHeader.PePlusOptHdr.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY.BASERELOC].Size\r
                roffset = self.PeHdr.OptionalHeader.PePlusOptHdr.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY.BASERELOC].VirtualAddress\r
\r
        alignment = 4\r
        offset = roffset\r
        while offset < roffset + rsize:\r
            offset = AlignPtr(offset, 4)\r
            blkhdr = PE_RELOC_BLOCK_HEADER.from_buffer(self.Data, offset)\r
            offset += sizeof(blkhdr)\r
            # Read relocation type,offset pairs\r
            rlen  = blkhdr.BlockSize - sizeof(PE_RELOC_BLOCK_HEADER)\r
            rnum  = int (rlen/sizeof(c_uint16))\r
            rdata = (c_uint16 * rnum).from_buffer(self.Data, offset)\r
            for each in rdata:\r
                roff  = each & 0xfff\r
                rtype = each >> 12\r
                if rtype == 0: # IMAGE_REL_BASED_ABSOLUTE:\r
                    continue\r
                if ((rtype != 3) and (rtype != 10)): # IMAGE_REL_BASED_HIGHLOW and IMAGE_REL_BASED_DIR64\r
                    raise Exception("ERROR: Unsupported relocation type %d!" % rtype)\r
                # Calculate the offset of the relocation\r
                aoff  = blkhdr.PageRVA + roff\r
                if self.IsTeImage():\r
                    aoff += sizeof(self.TeHdr) - self.TeHdr.StrippedSize\r
                self.RelocList.append((rtype, aoff))\r
            offset += sizeof(rdata)\r
\r
    def Rebase(self, delta, fdbin):\r
        count = 0\r
        if delta == 0:\r
            return count\r
\r
        for (rtype, roff) in self.RelocList:\r
            if rtype == 3: # IMAGE_REL_BASED_HIGHLOW\r
                offset = roff + self.Offset\r
                value  = Bytes2Val(fdbin[offset:offset+sizeof(c_uint32)])\r
                value += delta\r
                fdbin[offset:offset+sizeof(c_uint32)] = Val2Bytes(value, sizeof(c_uint32))\r
                count += 1\r
            elif rtype == 10: # IMAGE_REL_BASED_DIR64\r
                offset = roff + self.Offset\r
                value  = Bytes2Val(fdbin[offset:offset+sizeof(c_uint64)])\r
                value += delta\r
                fdbin[offset:offset+sizeof(c_uint64)] = Val2Bytes(value, sizeof(c_uint64))\r
                count += 1\r
            else:\r
                raise Exception('ERROR: Unknown relocation type %d !' % rtype)\r
\r
        if self.IsTeImage():\r
            offset  = self.Offset + EFI_TE_IMAGE_HEADER.ImageBase.offset\r
            size    = EFI_TE_IMAGE_HEADER.ImageBase.size\r
        else:\r
            offset  = self.Offset + self.DosHdr.e_lfanew\r
            offset += EFI_IMAGE_NT_HEADERS32.OptionalHeader.offset\r
            if self.PeHdr.OptionalHeader.PePlusOptHdr.Magic == 0x20b: # PE32+ image\r
                offset += EFI_IMAGE_OPTIONAL_HEADER32_PLUS.ImageBase.offset\r
                size    = EFI_IMAGE_OPTIONAL_HEADER32_PLUS.ImageBase.size\r
            else:\r
                offset += EFI_IMAGE_OPTIONAL_HEADER32.ImageBase.offset\r
                size    = EFI_IMAGE_OPTIONAL_HEADER32.ImageBase.size\r
\r
        value  = Bytes2Val(fdbin[offset:offset+size]) + delta\r
        fdbin[offset:offset+size] = Val2Bytes(value, size)\r
\r
        return count\r
\r
def ShowFspInfo (fspfile):\r
    fd = FirmwareDevice(0, fspfile)\r
    fd.ParseFd  ()\r
    fd.ParseFsp ()\r
\r
    print ("\nFound the following %d Firmware Volumes in FSP binary:" % (len(fd.FvList)))\r
    for idx, fv in enumerate(fd.FvList):\r
        name = fv.FvExtHdr.FvName\r
        if not name:\r
            name = '\xff' * 16\r
        else:\r
            if sys.version_info[0] < 3:\r
                name = str(bytearray(name))\r
            else:\r
                name = bytes(name)\r
        guid = uuid.UUID(bytes_le = name)\r
        print ("FV%d:" % idx)\r
        print ("  GUID   : %s" % str(guid).upper())\r
        print ("  Offset : 0x%08X" %  fv.Offset)\r
        print ("  Length : 0x%08X" % fv.FvHdr.FvLength)\r
    print ("\n")\r
\r
    for fsp in fd.FspList:\r
        fvlist = map(lambda x : 'FV%d' % x, fsp.FvIdxList)\r
        print ("FSP_%s contains %s" % (fsp.Type, ','.join(fvlist)))\r
        print ("%s" % (OutputStruct(fsp.Fih, 0, fsp.Fih.HeaderLength)))\r
\r
def GenFspHdr (fspfile, outdir, hfile):\r
    fd = FirmwareDevice(0, fspfile)\r
    fd.ParseFd  ()\r
    fd.ParseFsp ()\r
\r
    if not hfile:\r
        hfile = os.path.splitext(os.path.basename(fspfile))[0] + '.h'\r
    fspname, ext = os.path.splitext(os.path.basename(hfile))\r
    filename = os.path.join(outdir, fspname + ext)\r
    hfsp   = open(filename, 'w')\r
    hfsp.write ('%s\n\n' % CopyRightHeaderFile)\r
\r
    firstfv = True\r
    for fsp in fd.FspList:\r
        fih = fsp.Fih\r
        if firstfv:\r
            if sys.version_info[0] < 3:\r
                hfsp.write("#define  FSP_IMAGE_ID    0x%016X    /* '%s' */\n" % (Bytes2Val(bytearray(fih.ImageId)), fih.ImageId))\r
            else:\r
                hfsp.write("#define  FSP_IMAGE_ID    0x%016X    /* '%s' */\n" % (Bytes2Val(bytearray(fih.ImageId)), str (fih.ImageId, 'utf-8')))\r
            hfsp.write("#define  FSP_IMAGE_REV   0x%08X \n\n" % fih.ImageRevision)\r
            firstfv = False\r
        fv = fd.FvList[fsp.FvIdxList[0]]\r
        hfsp.write ('#define  FSP%s_BASE       0x%08X\n'   % (fsp.Type, fih.ImageBase))\r
        hfsp.write ('#define  FSP%s_OFFSET     0x%08X\n'   % (fsp.Type, fv.Offset))\r
        hfsp.write ('#define  FSP%s_LENGTH     0x%08X\n\n' % (fsp.Type, fih.ImageSize))\r
\r
    hfsp.close()\r
\r
def SplitFspBin (fspfile, outdir, nametemplate):\r
    fd = FirmwareDevice(0, fspfile)\r
    fd.ParseFd  ()\r
    fd.ParseFsp ()\r
\r
    for fsp in fd.FspList:\r
        if fsp.Fih.HeaderRevision < 3:\r
            raise Exception("ERROR: FSP 1.x is not supported by the split command !")\r
        ftype = fsp.Type\r
        if not nametemplate:\r
            nametemplate = fspfile\r
        fspname, ext = os.path.splitext(os.path.basename(nametemplate))\r
        filename = os.path.join(outdir, fspname + '_' + fsp.Type + ext)\r
        hfsp = open(filename, 'wb')\r
        print ("Create FSP component file '%s'" % filename)\r
        for fvidx in fsp.FvIdxList:\r
            fv = fd.FvList[fvidx]\r
            hfsp.write(fv.FvData)\r
        hfsp.close()\r
\r
def RebaseFspBin (FspBinary, FspComponent, FspBase, OutputDir, OutputFile):\r
    fd = FirmwareDevice(0, FspBinary)\r
    fd.ParseFd  ()\r
    fd.ParseFsp ()\r
\r
    numcomp  = len(FspComponent)\r
    baselist = FspBase\r
    if numcomp != len(baselist):\r
        print ("ERROR: Required number of base does not match number of FSP component !")\r
        return\r
\r
    newfspbin = fd.FdData[:]\r
\r
    for idx, fspcomp in enumerate(FspComponent):\r
\r
        found = False\r
        for fsp in fd.FspList:\r
            # Is this FSP 1.x single binary?\r
            if fsp.Fih.HeaderRevision < 3:\r
                found = True\r
                ftype = 'X'\r
                break\r
            ftype = fsp.Type.lower()\r
            if ftype == fspcomp:\r
                found = True\r
                break\r
\r
        if not found:\r
            print ("ERROR: Could not find FSP_%c component to rebase !" % fspcomp.upper())\r
            return\r
\r
        fspbase = baselist[idx]\r
        if fspbase.startswith('0x'):\r
            newbase = int(fspbase, 16)\r
        else:\r
            newbase = int(fspbase)\r
        oldbase = fsp.Fih.ImageBase\r
        delta = newbase - oldbase\r
        print ("Rebase FSP-%c from 0x%08X to 0x%08X:" % (ftype.upper(),oldbase,newbase))\r
\r
        imglist = []\r
        for fvidx in fsp.FvIdxList:\r
            fv = fd.FvList[fvidx]\r
            for ffs in fv.FfsList:\r
                for sec in ffs.SecList:\r
                    if sec.SecHdr.Type in [EFI_SECTION_TYPE.TE, EFI_SECTION_TYPE.PE32]:   # TE or PE32\r
                        offset = fd.Offset + fv.Offset + ffs.Offset + sec.Offset + sizeof(sec.SecHdr)\r
                        imglist.append ((offset, len(sec.SecData) - sizeof(sec.SecHdr)))\r
\r
        fcount  = 0\r
        pcount  = 0\r
        for (offset, length) in imglist:\r
            img = PeTeImage(offset, fd.FdData[offset:offset + length])\r
            img.ParseReloc()\r
            pcount += img.Rebase(delta, newfspbin)\r
            fcount += 1\r
\r
        print ("  Patched %d entries in %d TE/PE32 images." % (pcount, fcount))\r
\r
        (count, applied) = fsp.Patch(delta, newfspbin)\r
        print ("  Patched %d entries using FSP patch table." % applied)\r
        if count != applied:\r
            print ("  %d invalid entries are ignored !" % (count - applied))\r
\r
    if OutputFile == '':\r
        filename = os.path.basename(FspBinary)\r
        base, ext  = os.path.splitext(filename)\r
        OutputFile = base + "_%08X" % newbase + ext\r
\r
    fspname, ext = os.path.splitext(os.path.basename(OutputFile))\r
    filename = os.path.join(OutputDir, fspname + ext)\r
    fd = open(filename, "wb")\r
    fd.write(newfspbin)\r
    fd.close()\r
\r
def main ():\r
    parser     = argparse.ArgumentParser()\r
    subparsers = parser.add_subparsers(title='commands', dest="which")\r
\r
    parser_rebase  = subparsers.add_parser('rebase',  help='rebase a FSP into a new base address')\r
    parser_rebase.set_defaults(which='rebase')\r
    parser_rebase.add_argument('-f',  '--fspbin' , dest='FspBinary',  type=str, help='FSP binary file path', required = True)\r
    parser_rebase.add_argument('-c',  '--fspcomp', choices=['t','m','s','o','i'],  nargs='+', dest='FspComponent', type=str, help='FSP component to rebase', default = "['t']", required = True)\r
    parser_rebase.add_argument('-b',  '--newbase', dest='FspBase', nargs='+', type=str, help='Rebased FSP binary file name', default = '', required = True)\r
    parser_rebase.add_argument('-o',  '--outdir' , dest='OutputDir',  type=str, help='Output directory path', default = '.')\r
    parser_rebase.add_argument('-n',  '--outfile', dest='OutputFile', type=str, help='Rebased FSP binary file name', default = '')\r
\r
    parser_split  = subparsers.add_parser('split',  help='split a FSP into multiple components')\r
    parser_split.set_defaults(which='split')\r
    parser_split.add_argument('-f',  '--fspbin' , dest='FspBinary', type=str, help='FSP binary file path', required = True)\r
    parser_split.add_argument('-o',  '--outdir' , dest='OutputDir', type=str, help='Output directory path',   default = '.')\r
    parser_split.add_argument('-n',  '--nametpl', dest='NameTemplate', type=str, help='Output name template', default = '')\r
\r
    parser_genhdr = subparsers.add_parser('genhdr',  help='generate a header file for FSP binary')\r
    parser_genhdr.set_defaults(which='genhdr')\r
    parser_genhdr.add_argument('-f',  '--fspbin' , dest='FspBinary', type=str, help='FSP binary file path', required = True)\r
    parser_genhdr.add_argument('-o',  '--outdir' , dest='OutputDir', type=str, help='Output directory path',   default = '.')\r
    parser_genhdr.add_argument('-n',  '--hfile',   dest='HFileName', type=str, help='Output header file name', default = '')\r
\r
    parser_info = subparsers.add_parser('info',  help='display FSP information')\r
    parser_info.set_defaults(which='info')\r
    parser_info.add_argument('-f',  '--fspbin' , dest='FspBinary', type=str, help='FSP binary file path', required = True)\r
\r
    args = parser.parse_args()\r
    if args.which in ['rebase', 'split', 'genhdr', 'info']:\r
        if not os.path.exists(args.FspBinary):\r
            raise Exception ("ERROR: Could not locate FSP binary file '%s' !" % args.FspBinary)\r
        if hasattr(args, 'OutputDir') and not os.path.exists(args.OutputDir):\r
            raise Exception ("ERROR: Invalid output directory '%s' !" % args.OutputDir)\r
\r
    if args.which == 'rebase':\r
        RebaseFspBin (args.FspBinary, args.FspComponent, args.FspBase, args.OutputDir, args.OutputFile)\r
    elif args.which == 'split':\r
        SplitFspBin (args.FspBinary, args.OutputDir, args.NameTemplate)\r
    elif args.which == 'genhdr':\r
        GenFspHdr (args.FspBinary, args.OutputDir, args.HFileName)\r
    elif args.which == 'info':\r
        ShowFspInfo (args.FspBinary)\r
    else:\r
        parser.print_help()\r
\r
    return 0\r
\r
if __name__ == '__main__':\r
    sys.exit(main())\r