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