BaseTools/Source/Python/FirmwareStorageFormat/Common.py

   1 ## @file
   2 # This file is used to define the common C struct and functions.
   3 #
   4 # Copyright (c) 2021-, Intel Corporation. All rights reserved.<BR>
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6 ##
   7 from ctypes import *
   8 import uuid
   9
  10 # ZeroGuid = uuid.UUID('{00000000-0000-0000-0000-000000000000}')
  11 # EFI_FIRMWARE_FILE_SYSTEM2_GUID = uuid.UUID('{8C8CE578-8A3D-4f1c-9935-896185C32DD3}')
  12 # EFI_FIRMWARE_FILE_SYSTEM3_GUID = uuid.UUID('{5473C07A-3DCB-4dca-BD6F-1E9689E7349A}')
  13 # EFI_FFS_VOLUME_TOP_FILE_GUID = uuid.UUID('{1BA0062E-C779-4582-8566-336AE8F78F09}')
  14
  15 EFI_FIRMWARE_FILE_SYSTEM2_GUID = uuid.UUID("8c8ce578-8a3d-4f1c-9935-896185c32dd3")
  16 EFI_FIRMWARE_FILE_SYSTEM2_GUID_BYTE = b'x\xe5\x8c\x8c=\x8a\x1cO\x995\x89a\x85\xc3-\xd3'
  17 # EFI_FIRMWARE_FILE_SYSTEM2_GUID_BYTE = EFI_FIRMWARE_FILE_SYSTEM2_GUID.bytes
  18 EFI_FIRMWARE_FILE_SYSTEM3_GUID = uuid.UUID("5473C07A-3DCB-4dca-BD6F-1E9689E7349A")
  19 # EFI_FIRMWARE_FILE_SYSTEM3_GUID_BYTE = b'x\xe5\x8c\x8c=\x8a\x1cO\x995\x89a\x85\xc3-\xd3'
  20 EFI_FIRMWARE_FILE_SYSTEM3_GUID_BYTE = b'z\xc0sT\xcb=\xcaM\xbdo\x1e\x96\x89\xe74\x9a'
  21 EFI_SYSTEM_NVDATA_FV_GUID = uuid.UUID("fff12b8d-7696-4c8b-a985-2747075b4f50")
  22 EFI_SYSTEM_NVDATA_FV_GUID_BYTE = b"\x8d+\xf1\xff\x96v\x8bL\xa9\x85'G\x07[OP"
  23 EFI_FFS_VOLUME_TOP_FILE_GUID = uuid.UUID("1ba0062e-c779-4582-8566-336ae8f78f09")
  24 EFI_FFS_VOLUME_TOP_FILE_GUID_BYTE = b'.\x06\xa0\x1by\xc7\x82E\x85f3j\xe8\xf7\x8f\t'
  25 ZEROVECTOR_BYTE = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
  26 PADVECTOR = uuid.UUID("ffffffff-ffff-ffff-ffff-ffffffffffff")
  27 FVH_SIGNATURE = b'_FVH'
  28
  29 #Alignment
  30 SECTION_COMMON_ALIGNMENT = 4
  31 FFS_COMMON_ALIGNMENT = 8
  32
  33 class GUID(Structure):
  34     _pack_ = 1
  35     _fields_ = [
  36         ('Guid1',            c_uint32),
  37         ('Guid2',            c_uint16),
  38         ('Guid3',            c_uint16),
  39         ('Guid4',            ARRAY(c_uint8, 8)),
  40     ]
  41
  42     def from_list(self, listformat: list) -> None:
  43         self.Guid1 = listformat[0]
  44         self.Guid2 = listformat[1]
  45         self.Guid3 = listformat[2]
  46         for i in range(8):
  47             self.Guid4[i] = listformat[i+3]
  48
  49     def __cmp__(self, otherguid) -> bool:
  50         if not isinstance(otherguid, GUID):
  51             return 'Input is not the GUID instance!'
  52         rt = False
  53         if self.Guid1 == otherguid.Guid1 and self.Guid2 == otherguid.Guid2 and self.Guid3 == otherguid.Guid3:
  54             rt = True
  55             for i in range(8):
  56                 rt = rt & (self.Guid4[i] == otherguid.Guid4[i])
  57         return rt
  58
  59 def ModifyGuidFormat(target_guid: str) -> GUID:
  60     target_guid = target_guid.replace('-', '')
  61     target_list = []
  62     start = [0,8,12,16,18,20,22,24,26,28,30]
  63     end = [8,12,16,18,20,22,24,26,28,30,32]
  64     num = len(start)
  65     for pos in range(num):
  66         new_value = int(target_guid[start[pos]:end[pos]], 16)
  67         target_list.append(new_value)
  68     new_format = GUID()
  69     new_format.from_list(target_list)
  70     return new_format
  71
  72
  73 # Get data from ctypes to bytes.
  74 def struct2stream(s) -> bytes:
  75     length = sizeof(s)
  76     p = cast(pointer(s), POINTER(c_char * length))
  77     return p.contents.raw
  78
  79
  80
  81 def GetPadSize(Size: int, alignment: int) -> int:
  82     if Size % alignment == 0:
  83         return 0
  84     Pad_Size = alignment - Size % alignment
  85     return Pad_Size