ArmPlatformPkg/Scripts: Added ARM DS-5 scripts to debug UEFI

These scripts allow to automatically load the symbols using either the
report file created by the BaseTools or using the memory regions
defined in the arguments.

This is the scripts for DS-5 prior to DS5 v5.12.

Signed-off-by: Olivier Martin <olivier.martin@arm.com>



git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13874 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 127 insertions, 0 deletions

diff --git a/ArmPlatformPkg/Scripts/Ds5/system_table.py b/ArmPlatformPkg/Scripts/Ds5/system_table.py
new file mode 100644
index 0000000000..f74554fa65
--- /dev/null
+++ b/ArmPlatformPkg/Scripts/Ds5/system_table.py
@@ -0,0 +1,127 @@
+#
+#  Copyright (c) 2011-2012, ARM Limited. All rights reserved.
+#  
+#  This program and the accompanying materials                          
+#  are licensed and made available under the terms and conditions of the BSD License         
+#  which accompanies this distribution.  The full text of the license may be found at        
+#  http://opensource.org/licenses/bsd-license.php                                            
+#
+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
+#
+
+from arm_ds.debugger_v1 import DebugException
+
+import firmware_volume
+import struct
+
+class DebugInfoTable:
+    CONST_DEBUG_INFO_TABLE_GUID = ( 0x49152E77L, 0x47641ADAL, 0xFE7AA2B7L, 0x8B5ED9FEL)
+    
+    DebugInfos = []
+    
+    def __init__(self, ec, debug_info_table_header_offset):
+        self.ec = ec
+        self.base = debug_info_table_header_offset
+        
+    def get_debug_info(self):
+        count = self.ec.getMemoryService().readMemory32(self.base + 0x4)
+        debug_info_table_base = self.ec.getMemoryService().readMemory32(self.base + 0x8)
+        
+        self.DebugInfos = []
+        
+        for i in range(0, count):
+            # Get the address of the structure EFI_DEBUG_IMAGE_INFO
+            debug_info = self.ec.getMemoryService().readMemory32(debug_info_table_base + (i * 4))
+            if debug_info:
+                debug_info_type = self.ec.getMemoryService().readMemory32(debug_info)
+                # Normal Debug Info Type
+                if debug_info_type == 1:
+                    # Get the base address of the structure EFI_LOADED_IMAGE_PROTOCOL
+                    loaded_image_protocol = self.ec.getMemoryService().readMemory32(debug_info + 0x4)
+                    
+                    image_base = self.ec.getMemoryService().readMemory32(loaded_image_protocol + 0x20)
+                    image_size = self.ec.getMemoryService().readMemory32(loaded_image_protocol + 0x28)
+                    
+                    self.DebugInfos.append((image_base,image_size))
+    
+    # Return (base, size)
+    def load_symbols_at(self, addr):
+        if self.DebugInfos == []:
+            self.get_debug_info()
+        
+        found = False
+        for debug_info in self.DebugInfos:
+            if (addr >= debug_info[0]) and (addr < debug_info[0] + debug_info[1]):
+                section = firmware_volume.EfiSectionPE32(self.ec, debug_info[0])
+                
+                edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase())
+
+                found = True
+                return debug_info
+
+        if found == False:
+            raise Exception('DebugInfoTable','No symbol found at 0x%x' % addr)
+
+    def load_all_symbols(self):
+        if self.DebugInfos == []:
+            self.get_debug_info()
+        
+        for debug_info in self.DebugInfos:
+            section = firmware_volume.EfiSectionPE32(self.ec, debug_info[0])
+           
+            edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase())
+
+    def dump(self):
+        self.get_debug_info()
+        for debug_info in self.DebugInfos:
+            base_pe32 = debug_info[0]
+            section = firmware_volume.EfiSectionPE32(self.ec, base_pe32)
+            print section.get_debug_filepath()
+        
+class SystemTable:
+    CONST_ST_SIGNATURE = ('I','B','I',' ','S','Y','S','T')
+    
+    def __init__(self, ec, membase, memsize):
+        self.membase = membase
+        self.memsize = memsize
+        self.ec = ec
+        
+        found = False
+        
+        # Start from the top of the memory
+        offset = self.membase + self.memsize
+        # Align to highest 4MB boundary
+        offset = offset & ~0x3FFFFF
+        # We should not have a System Table at the top of the System Memory
+        offset = offset - 0x400000
+        
+        # Start at top and look on 4MB boundaries for system table ptr structure
+        while offset > self.membase:
+            try:
+                signature = struct.unpack("cccccccc", self.ec.getMemoryService().read(str(offset), 8, 32))
+            except DebugException:
+                raise Exception('SystemTable','Fail to access System Memory. Ensure all the memory in the region [0x%x;0x%X] is accessible.' % (membase,membase+memsize))
+            if signature == SystemTable.CONST_ST_SIGNATURE:
+                found = True
+                self.system_table_base = self.ec.getMemoryService().readMemory32(offset + 0x8)
+                break
+            offset = offset - 0x400000
+            
+        if not found:
+            raise Exception('SystemTable','System Table not found in System Memory [0x%x;0x%X]' % (membase,membase+memsize))
+        
+    def get_configuration_table(self, conf_table_guid):
+        # Number of configuration Table entry
+        conf_table_entry_count = self.ec.getMemoryService().readMemory32(self.system_table_base + 0x40)
+        
+        # Get location of the Configuration Table entries
+        conf_table_offset = self.ec.getMemoryService().readMemory32(self.system_table_base + 0x44)
+        
+        for i in range(0, conf_table_entry_count):
+            offset = conf_table_offset + (i * 0x14)
+            guid = struct.unpack("<IIII", self.ec.getMemoryService().read(str(offset), 16, 32))
+            if guid == conf_table_guid:
+                return self.ec.getMemoryService().readMemory32(offset + 0x10)
+            
+        raise Exception('SystemTable','Configuration Table not found')