BaseTools: Add FMMT Python Tool

[mirror_edk2.git] / BaseTools / Source / Python / FirmwareStorageFormat / Common.py

diff --git a/BaseTools/Source/Python/FirmwareStorageFormat/Common.py b/BaseTools/Source/Python/FirmwareStorageFormat/Common.py
new file mode 100644 (file)
index 0000000..5082268
--- /dev/null
+++ b/BaseTools/Source/Python/FirmwareStorageFormat/Common.py
@@ -0,0 +1,85 @@
+## @file\r
+# This file is used to define the common C struct and functions.\r
+#\r
+# Copyright (c) 2021-, Intel Corporation. All rights reserved.<BR>\r
+# SPDX-License-Identifier: BSD-2-Clause-Patent\r
+##\r
+from ctypes import *\r
+import uuid\r
+\r
+# ZeroGuid = uuid.UUID('{00000000-0000-0000-0000-000000000000}')\r
+# EFI_FIRMWARE_FILE_SYSTEM2_GUID = uuid.UUID('{8C8CE578-8A3D-4f1c-9935-896185C32DD3}')\r
+# EFI_FIRMWARE_FILE_SYSTEM3_GUID = uuid.UUID('{5473C07A-3DCB-4dca-BD6F-1E9689E7349A}')\r
+# EFI_FFS_VOLUME_TOP_FILE_GUID = uuid.UUID('{1BA0062E-C779-4582-8566-336AE8F78F09}')\r
+\r
+EFI_FIRMWARE_FILE_SYSTEM2_GUID = uuid.UUID("8c8ce578-8a3d-4f1c-9935-896185c32dd3")\r
+EFI_FIRMWARE_FILE_SYSTEM2_GUID_BYTE = b'x\xe5\x8c\x8c=\x8a\x1cO\x995\x89a\x85\xc3-\xd3'\r
+# EFI_FIRMWARE_FILE_SYSTEM2_GUID_BYTE = EFI_FIRMWARE_FILE_SYSTEM2_GUID.bytes\r
+EFI_FIRMWARE_FILE_SYSTEM3_GUID = uuid.UUID("5473C07A-3DCB-4dca-BD6F-1E9689E7349A")\r
+# EFI_FIRMWARE_FILE_SYSTEM3_GUID_BYTE = b'x\xe5\x8c\x8c=\x8a\x1cO\x995\x89a\x85\xc3-\xd3'\r
+EFI_FIRMWARE_FILE_SYSTEM3_GUID_BYTE = b'z\xc0sT\xcb=\xcaM\xbdo\x1e\x96\x89\xe74\x9a'\r
+EFI_SYSTEM_NVDATA_FV_GUID = uuid.UUID("fff12b8d-7696-4c8b-a985-2747075b4f50")\r
+EFI_SYSTEM_NVDATA_FV_GUID_BYTE = b"\x8d+\xf1\xff\x96v\x8bL\xa9\x85'G\x07[OP"\r
+EFI_FFS_VOLUME_TOP_FILE_GUID = uuid.UUID("1ba0062e-c779-4582-8566-336ae8f78f09")\r
+EFI_FFS_VOLUME_TOP_FILE_GUID_BYTE = b'.\x06\xa0\x1by\xc7\x82E\x85f3j\xe8\xf7\x8f\t'\r
+ZEROVECTOR_BYTE = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'\r
+PADVECTOR = uuid.UUID("ffffffff-ffff-ffff-ffff-ffffffffffff")\r
+FVH_SIGNATURE = b'_FVH'\r
+\r
+#Alignment\r
+SECTION_COMMON_ALIGNMENT = 4\r
+FFS_COMMON_ALIGNMENT = 8\r
+\r
+class GUID(Structure):\r
+    _pack_ = 1\r
+    _fields_ = [\r
+        ('Guid1',            c_uint32),\r
+        ('Guid2',            c_uint16),\r
+        ('Guid3',            c_uint16),\r
+        ('Guid4',            ARRAY(c_uint8, 8)),\r
+    ]\r
+\r
+    def from_list(self, listformat: list) -> None:\r
+        self.Guid1 = listformat[0]\r
+        self.Guid2 = listformat[1]\r
+        self.Guid3 = listformat[2]\r
+        for i in range(8):\r
+            self.Guid4[i] = listformat[i+3]\r
+\r
+    def __cmp__(self, otherguid) -> bool:\r
+        if not isinstance(otherguid, GUID):\r
+            return 'Input is not the GUID instance!'\r
+        rt = False\r
+        if self.Guid1 == otherguid.Guid1 and self.Guid2 == otherguid.Guid2 and self.Guid3 == otherguid.Guid3:\r
+            rt = True\r
+            for i in range(8):\r
+                rt = rt & (self.Guid4[i] == otherguid.Guid4[i])\r
+        return rt\r
+\r
+def ModifyGuidFormat(target_guid: str) -> GUID:\r
+    target_guid = target_guid.replace('-', '')\r
+    target_list = []\r
+    start = [0,8,12,16,18,20,22,24,26,28,30]\r
+    end = [8,12,16,18,20,22,24,26,28,30,32]\r
+    num = len(start)\r
+    for pos in range(num):\r
+        new_value = int(target_guid[start[pos]:end[pos]], 16)\r
+        target_list.append(new_value)\r
+    new_format = GUID()\r
+    new_format.from_list(target_list)\r
+    return new_format\r
+\r
+\r
+# Get data from ctypes to bytes.\r
+def struct2stream(s) -> bytes:\r
+    length = sizeof(s)\r
+    p = cast(pointer(s), POINTER(c_char * length))\r
+    return p.contents.raw\r
+\r
+\r
+\r
+def GetPadSize(Size: int, alignment: int) -> int:\r
+    if Size % alignment == 0:\r
+        return 0\r
+    Pad_Size = alignment - Size % alignment\r
+    return Pad_Size\r