EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

tools/flash_algo/flash_algo.py@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

UserRevisionLine numberNew contents of line
be_bryan 0:b74591d5ab33 1 #!/usr/bin/env python
be_bryan 0:b74591d5ab33 2 """
be_bryan 0:b74591d5ab33 3 mbed
be_bryan 0:b74591d5ab33 4 Copyright (c) 2017-2017 ARM Limited
be_bryan 0:b74591d5ab33 5
be_bryan 0:b74591d5ab33 6 Licensed under the Apache License, Version 2.0 (the "License");
be_bryan 0:b74591d5ab33 7 you may not use this file except in compliance with the License.
be_bryan 0:b74591d5ab33 8 You may obtain a copy of the License at
be_bryan 0:b74591d5ab33 9
be_bryan 0:b74591d5ab33 10 http://www.apache.org/licenses/LICENSE-2.0
be_bryan 0:b74591d5ab33 11
be_bryan 0:b74591d5ab33 12 Unless required by applicable law or agreed to in writing, software
be_bryan 0:b74591d5ab33 13 distributed under the License is distributed on an "AS IS" BASIS,
be_bryan 0:b74591d5ab33 14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
be_bryan 0:b74591d5ab33 15 See the License for the specific language governing permissions and
be_bryan 0:b74591d5ab33 16 limitations under the License.
be_bryan 0:b74591d5ab33 17 """
be_bryan 0:b74591d5ab33 18
be_bryan 0:b74591d5ab33 19 from __future__ import print_function
be_bryan 0:b74591d5ab33 20 import os
be_bryan 0:b74591d5ab33 21 import struct
be_bryan 0:b74591d5ab33 22 import binascii
be_bryan 0:b74591d5ab33 23 import argparse
be_bryan 0:b74591d5ab33 24 import logging
be_bryan 0:b74591d5ab33 25 import StringIO
be_bryan 0:b74591d5ab33 26 import jinja2
be_bryan 0:b74591d5ab33 27 from collections import namedtuple
be_bryan 0:b74591d5ab33 28 from itertools import count
be_bryan 0:b74591d5ab33 29
be_bryan 0:b74591d5ab33 30 from elftools.common.py3compat import bytes2str
be_bryan 0:b74591d5ab33 31 from elftools.elf.elffile import ELFFile
be_bryan 0:b74591d5ab33 32 from elftools.elf.sections import SymbolTableSection
be_bryan 0:b74591d5ab33 33
be_bryan 0:b74591d5ab33 34 logger = logging.getLogger(__name__)
be_bryan 0:b74591d5ab33 35 logger.addHandler(logging.NullHandler())
be_bryan 0:b74591d5ab33 36
be_bryan 0:b74591d5ab33 37
be_bryan 0:b74591d5ab33 38 def main():
be_bryan 0:b74591d5ab33 39 parser = argparse.ArgumentParser(description="Algo Extracter")
be_bryan 0:b74591d5ab33 40 parser.add_argument("input", help="File to extract flash algo from")
be_bryan 0:b74591d5ab33 41 parser.add_argument("template", default="py_blob.tmpl",
be_bryan 0:b74591d5ab33 42 help="Template to use")
be_bryan 0:b74591d5ab33 43 parser.add_argument("output", help="Output file")
be_bryan 0:b74591d5ab33 44 args = parser.parse_args()
be_bryan 0:b74591d5ab33 45
be_bryan 0:b74591d5ab33 46 with open(args.input, "rb") as file_handle:
be_bryan 0:b74591d5ab33 47 data = file_handle.read()
be_bryan 0:b74591d5ab33 48 algo = PackFlashAlgo(data)
be_bryan 0:b74591d5ab33 49 algo.process_template(args.template, args.output)
be_bryan 0:b74591d5ab33 50
be_bryan 0:b74591d5ab33 51
be_bryan 0:b74591d5ab33 52 class PackFlashAlgo(object):
be_bryan 0:b74591d5ab33 53 """
be_bryan 0:b74591d5ab33 54 Class to wrap a flash algo
be_bryan 0:b74591d5ab33 55
be_bryan 0:b74591d5ab33 56 This class is intended to provide easy access to the information
be_bryan 0:b74591d5ab33 57 provided by a flash algorithm, such as symbols and the flash
be_bryan 0:b74591d5ab33 58 algorithm itself.
be_bryan 0:b74591d5ab33 59 """
be_bryan 0:b74591d5ab33 60
be_bryan 0:b74591d5ab33 61 REQUIRED_SYMBOLS = set([
be_bryan 0:b74591d5ab33 62 "Init",
be_bryan 0:b74591d5ab33 63 "UnInit",
be_bryan 0:b74591d5ab33 64 "EraseSector",
be_bryan 0:b74591d5ab33 65 "ProgramPage",
be_bryan 0:b74591d5ab33 66 ])
be_bryan 0:b74591d5ab33 67
be_bryan 0:b74591d5ab33 68 EXTRA_SYMBOLS = set([
be_bryan 0:b74591d5ab33 69 "BlankCheck",
be_bryan 0:b74591d5ab33 70 "EraseChip",
be_bryan 0:b74591d5ab33 71 "Verify",
be_bryan 0:b74591d5ab33 72 ])
be_bryan 0:b74591d5ab33 73
be_bryan 0:b74591d5ab33 74 def __init__(self, data):
be_bryan 0:b74591d5ab33 75 """Construct a PackFlashAlgorithm from an ElfFileSimple"""
be_bryan 0:b74591d5ab33 76 self.elf = ElfFileSimple(data)
be_bryan 0:b74591d5ab33 77 self.flash_info = PackFlashInfo(self.elf)
be_bryan 0:b74591d5ab33 78
be_bryan 0:b74591d5ab33 79 self.flash_start = self.flash_info.start
be_bryan 0:b74591d5ab33 80 self.flash_size = self.flash_info.size
be_bryan 0:b74591d5ab33 81 self.page_size = self.flash_info.page_size
be_bryan 0:b74591d5ab33 82 self.sector_sizes = self.flash_info.sector_info_list
be_bryan 0:b74591d5ab33 83
be_bryan 0:b74591d5ab33 84 symbols = {}
be_bryan 0:b74591d5ab33 85 symbols.update(_extract_symbols(self.elf, self.REQUIRED_SYMBOLS))
be_bryan 0:b74591d5ab33 86 symbols.update(_extract_symbols(self.elf, self.EXTRA_SYMBOLS,
be_bryan 0:b74591d5ab33 87 default=0xFFFFFFFF))
be_bryan 0:b74591d5ab33 88 self.symbols = symbols
be_bryan 0:b74591d5ab33 89
be_bryan 0:b74591d5ab33 90 sections_to_find = (
be_bryan 0:b74591d5ab33 91 ("PrgCode", "SHT_PROGBITS"),
be_bryan 0:b74591d5ab33 92 ("PrgData", "SHT_PROGBITS"),
be_bryan 0:b74591d5ab33 93 ("PrgData", "SHT_NOBITS"),
be_bryan 0:b74591d5ab33 94 )
be_bryan 0:b74591d5ab33 95
be_bryan 0:b74591d5ab33 96 ro_rw_zi = _find_sections(self.elf, sections_to_find)
be_bryan 0:b74591d5ab33 97 ro_rw_zi = _algo_fill_zi_if_missing(ro_rw_zi)
be_bryan 0:b74591d5ab33 98 error_msg = _algo_check_for_section_problems(ro_rw_zi)
be_bryan 0:b74591d5ab33 99 if error_msg is not None:
be_bryan 0:b74591d5ab33 100 raise Exception(error_msg)
be_bryan 0:b74591d5ab33 101
be_bryan 0:b74591d5ab33 102 sect_ro, sect_rw, sect_zi = ro_rw_zi
be_bryan 0:b74591d5ab33 103 self.ro_start = sect_ro["sh_addr"]
be_bryan 0:b74591d5ab33 104 self.ro_size = sect_ro["sh_size"]
be_bryan 0:b74591d5ab33 105 self.rw_start = sect_rw["sh_addr"]
be_bryan 0:b74591d5ab33 106 self.rw_size = sect_rw["sh_size"]
be_bryan 0:b74591d5ab33 107 self.zi_start = sect_zi["sh_addr"]
be_bryan 0:b74591d5ab33 108 self.zi_size = sect_zi["sh_size"]
be_bryan 0:b74591d5ab33 109
be_bryan 0:b74591d5ab33 110 self.algo_data = _create_algo_bin(ro_rw_zi)
be_bryan 0:b74591d5ab33 111
be_bryan 0:b74591d5ab33 112 def format_algo_data(self, spaces, group_size, fmt):
be_bryan 0:b74591d5ab33 113 """"
be_bryan 0:b74591d5ab33 114 Return a string representing algo_data suitable for use in a template
be_bryan 0:b74591d5ab33 115
be_bryan 0:b74591d5ab33 116 The string is intended for use in a template.
be_bryan 0:b74591d5ab33 117
be_bryan 0:b74591d5ab33 118 :param spaces: The number of leading spaces for each line
be_bryan 0:b74591d5ab33 119 :param group_size: number of elements per line (element type
be_bryan 0:b74591d5ab33 120 depends of format)
be_bryan 0:b74591d5ab33 121 :param fmt: - format to create - can be either "hex" or "c"
be_bryan 0:b74591d5ab33 122 """
be_bryan 0:b74591d5ab33 123 padding = " " * spaces
be_bryan 0:b74591d5ab33 124 if fmt == "hex":
be_bryan 0:b74591d5ab33 125 blob = binascii.b2a_hex(self.algo_data)
be_bryan 0:b74591d5ab33 126 line_list = []
be_bryan 0:b74591d5ab33 127 for i in xrange(0, len(blob), group_size):
be_bryan 0:b74591d5ab33 128 line_list.append('"' + blob[i:i + group_size] + '"')
be_bryan 0:b74591d5ab33 129 return ("\n" + padding).join(line_list)
be_bryan 0:b74591d5ab33 130 elif fmt == "c":
be_bryan 0:b74591d5ab33 131 blob = self.algo_data[:]
be_bryan 0:b74591d5ab33 132 pad_size = 0 if len(blob) % 4 == 0 else 4 - len(blob) % 4
be_bryan 0:b74591d5ab33 133 blob = blob + "\x00" * pad_size
be_bryan 0:b74591d5ab33 134 integer_list = struct.unpack("<" + "L" * (len(blob) / 4), blob)
be_bryan 0:b74591d5ab33 135 line_list = []
be_bryan 0:b74591d5ab33 136 for pos in range(0, len(integer_list), group_size):
be_bryan 0:b74591d5ab33 137 group = ["0x%08x" % value for value in
be_bryan 0:b74591d5ab33 138 integer_list[pos:pos + group_size]]
be_bryan 0:b74591d5ab33 139 line_list.append(", ".join(group))
be_bryan 0:b74591d5ab33 140 return (",\n" + padding).join(line_list)
be_bryan 0:b74591d5ab33 141 else:
be_bryan 0:b74591d5ab33 142 raise Exception("Unsupported format %s" % fmt)
be_bryan 0:b74591d5ab33 143
be_bryan 0:b74591d5ab33 144 def process_template(self, template_path, output_path, data_dict=None):
be_bryan 0:b74591d5ab33 145 """
be_bryan 0:b74591d5ab33 146 Generate output from the supplied template
be_bryan 0:b74591d5ab33 147
be_bryan 0:b74591d5ab33 148 All the public methods and fields of this class can be accessed from
be_bryan 0:b74591d5ab33 149 the template via "algo".
be_bryan 0:b74591d5ab33 150
be_bryan 0:b74591d5ab33 151 :param template_path: Relative or absolute file path to the template
be_bryan 0:b74591d5ab33 152 :param output_path: Relative or absolute file path to create
be_bryan 0:b74591d5ab33 153 :param data_dict: Additional data to use when generating
be_bryan 0:b74591d5ab33 154 """
be_bryan 0:b74591d5ab33 155 if data_dict is None:
be_bryan 0:b74591d5ab33 156 data_dict = {}
be_bryan 0:b74591d5ab33 157 else:
be_bryan 0:b74591d5ab33 158 assert isinstance(data_dict, dict)
be_bryan 0:b74591d5ab33 159 data_dict = dict(data_dict)
be_bryan 0:b74591d5ab33 160 assert "algo" not in data_dict, "algo already set by user data"
be_bryan 0:b74591d5ab33 161 data_dict["algo"] = self
be_bryan 0:b74591d5ab33 162
be_bryan 0:b74591d5ab33 163 with open(template_path) as file_handle:
be_bryan 0:b74591d5ab33 164 template_text = file_handle.read()
be_bryan 0:b74591d5ab33 165
be_bryan 0:b74591d5ab33 166 template = jinja2.Template(template_text)
be_bryan 0:b74591d5ab33 167 target_text = template.render(data_dict)
be_bryan 0:b74591d5ab33 168
be_bryan 0:b74591d5ab33 169 with open(output_path, "wb") as file_handle:
be_bryan 0:b74591d5ab33 170 file_handle.write(target_text)
be_bryan 0:b74591d5ab33 171
be_bryan 0:b74591d5ab33 172
be_bryan 0:b74591d5ab33 173 def _extract_symbols(simple_elf, symbols, default=None):
be_bryan 0:b74591d5ab33 174 """Fill 'symbols' field with required flash algo symbols"""
be_bryan 0:b74591d5ab33 175 to_ret = {}
be_bryan 0:b74591d5ab33 176 for symbol in symbols:
be_bryan 0:b74591d5ab33 177 if symbol not in simple_elf.symbols:
be_bryan 0:b74591d5ab33 178 if default is not None:
be_bryan 0:b74591d5ab33 179 to_ret[symbol] = default
be_bryan 0:b74591d5ab33 180 continue
be_bryan 0:b74591d5ab33 181 raise Exception("Missing symbol %s" % symbol)
be_bryan 0:b74591d5ab33 182 to_ret[symbol] = simple_elf.symbols[symbol].value
be_bryan 0:b74591d5ab33 183 return to_ret
be_bryan 0:b74591d5ab33 184
be_bryan 0:b74591d5ab33 185
be_bryan 0:b74591d5ab33 186 def _find_sections(elf, name_type_pairs):
be_bryan 0:b74591d5ab33 187 """Return a list of sections the same length and order of the input list"""
be_bryan 0:b74591d5ab33 188 sections = [None] * len(name_type_pairs)
be_bryan 0:b74591d5ab33 189 for section in elf.iter_sections():
be_bryan 0:b74591d5ab33 190 section_name = bytes2str(section.name)
be_bryan 0:b74591d5ab33 191 section_type = section["sh_type"]
be_bryan 0:b74591d5ab33 192 for i, name_and_type in enumerate(name_type_pairs):
be_bryan 0:b74591d5ab33 193 if name_and_type != (section_name, section_type):
be_bryan 0:b74591d5ab33 194 continue
be_bryan 0:b74591d5ab33 195 if sections[i] is not None:
be_bryan 0:b74591d5ab33 196 raise Exception("Elf contains duplicate section %s attr %s" %
be_bryan 0:b74591d5ab33 197 (section_name, section_type))
be_bryan 0:b74591d5ab33 198 sections[i] = section
be_bryan 0:b74591d5ab33 199 return sections
be_bryan 0:b74591d5ab33 200
be_bryan 0:b74591d5ab33 201
be_bryan 0:b74591d5ab33 202 def _algo_fill_zi_if_missing(ro_rw_zi):
be_bryan 0:b74591d5ab33 203 """Create an empty zi section if it is missing"""
be_bryan 0:b74591d5ab33 204 s_ro, s_rw, s_zi = ro_rw_zi
be_bryan 0:b74591d5ab33 205 if s_rw is None:
be_bryan 0:b74591d5ab33 206 return ro_rw_zi
be_bryan 0:b74591d5ab33 207 if s_zi is not None:
be_bryan 0:b74591d5ab33 208 return ro_rw_zi
be_bryan 0:b74591d5ab33 209 s_zi = {
be_bryan 0:b74591d5ab33 210 "sh_addr": s_rw["sh_addr"] + s_rw["sh_size"],
be_bryan 0:b74591d5ab33 211 "sh_size": 0
be_bryan 0:b74591d5ab33 212 }
be_bryan 0:b74591d5ab33 213 return s_ro, s_rw, s_zi
be_bryan 0:b74591d5ab33 214
be_bryan 0:b74591d5ab33 215
be_bryan 0:b74591d5ab33 216 def _algo_check_for_section_problems(ro_rw_zi):
be_bryan 0:b74591d5ab33 217 """Return a string describing any errors with the layout or None if good"""
be_bryan 0:b74591d5ab33 218 s_ro, s_rw, s_zi = ro_rw_zi
be_bryan 0:b74591d5ab33 219 if s_ro is None:
be_bryan 0:b74591d5ab33 220 return "RO section is missing"
be_bryan 0:b74591d5ab33 221 if s_rw is None:
be_bryan 0:b74591d5ab33 222 return "RW section is missing"
be_bryan 0:b74591d5ab33 223 if s_zi is None:
be_bryan 0:b74591d5ab33 224 return "ZI section is missing"
be_bryan 0:b74591d5ab33 225 if s_ro["sh_addr"] != 0:
be_bryan 0:b74591d5ab33 226 return "RO section does not start at address 0"
be_bryan 0:b74591d5ab33 227 if s_ro["sh_addr"] + s_ro["sh_size"] != s_rw["sh_addr"]:
be_bryan 0:b74591d5ab33 228 return "RW section does not follow RO section"
be_bryan 0:b74591d5ab33 229 if s_rw["sh_addr"] + s_rw["sh_size"] != s_zi["sh_addr"]:
be_bryan 0:b74591d5ab33 230 return "ZI section does not follow RW section"
be_bryan 0:b74591d5ab33 231 return None
be_bryan 0:b74591d5ab33 232
be_bryan 0:b74591d5ab33 233
be_bryan 0:b74591d5ab33 234 def _create_algo_bin(ro_rw_zi):
be_bryan 0:b74591d5ab33 235 """Create a binary blob of the flash algo which can execute from ram"""
be_bryan 0:b74591d5ab33 236 sect_ro, sect_rw, sect_zi = ro_rw_zi
be_bryan 0:b74591d5ab33 237 algo_size = sect_ro["sh_size"] + sect_rw["sh_size"] + sect_zi["sh_size"]
be_bryan 0:b74591d5ab33 238 algo_data = bytearray(algo_size)
be_bryan 0:b74591d5ab33 239 for section in (sect_ro, sect_rw):
be_bryan 0:b74591d5ab33 240 start = section["sh_addr"]
be_bryan 0:b74591d5ab33 241 size = section["sh_size"]
be_bryan 0:b74591d5ab33 242 data = section.data()
be_bryan 0:b74591d5ab33 243 assert len(data) == size
be_bryan 0:b74591d5ab33 244 algo_data[start:start + size] = data
be_bryan 0:b74591d5ab33 245 return algo_data
be_bryan 0:b74591d5ab33 246
be_bryan 0:b74591d5ab33 247
be_bryan 0:b74591d5ab33 248 class PackFlashInfo(object):
be_bryan 0:b74591d5ab33 249 """Wrapper class for the non-executable information in an FLM file"""
be_bryan 0:b74591d5ab33 250
be_bryan 0:b74591d5ab33 251 FLASH_DEVICE_STRUCT = "<H128sHLLLLBxxxLL"
be_bryan 0:b74591d5ab33 252 FLASH_SECTORS_STRUCT = "<LL"
be_bryan 0:b74591d5ab33 253 FLASH_SECTORS_STRUCT_SIZE = struct.calcsize(FLASH_SECTORS_STRUCT)
be_bryan 0:b74591d5ab33 254 SECTOR_END = 0xFFFFFFFF
be_bryan 0:b74591d5ab33 255
be_bryan 0:b74591d5ab33 256 def __init__(self, elf_simple):
be_bryan 0:b74591d5ab33 257 dev_info = elf_simple.symbols["FlashDevice"]
be_bryan 0:b74591d5ab33 258 info_start = dev_info.value
be_bryan 0:b74591d5ab33 259 info_size = struct.calcsize(self.FLASH_DEVICE_STRUCT)
be_bryan 0:b74591d5ab33 260 data = elf_simple.read(info_start, info_size)
be_bryan 0:b74591d5ab33 261 values = struct.unpack(self.FLASH_DEVICE_STRUCT, data)
be_bryan 0:b74591d5ab33 262
be_bryan 0:b74591d5ab33 263 self.version = values[0]
be_bryan 0:b74591d5ab33 264 self.name = values[1].strip("\x00")
be_bryan 0:b74591d5ab33 265 self.type = values[2]
be_bryan 0:b74591d5ab33 266 self.start = values[3]
be_bryan 0:b74591d5ab33 267 self.size = values[4]
be_bryan 0:b74591d5ab33 268 self.page_size = values[5]
be_bryan 0:b74591d5ab33 269 self.value_empty = values[7]
be_bryan 0:b74591d5ab33 270 self.prog_timeout_ms = values[8]
be_bryan 0:b74591d5ab33 271 self.erase_timeout_ms = values[9]
be_bryan 0:b74591d5ab33 272
be_bryan 0:b74591d5ab33 273 sector_gen = self._sector_and_sz_itr(elf_simple,
be_bryan 0:b74591d5ab33 274 info_start + info_size)
be_bryan 0:b74591d5ab33 275 self.sector_info_list = list(sector_gen)
be_bryan 0:b74591d5ab33 276
be_bryan 0:b74591d5ab33 277 def __str__(self):
be_bryan 0:b74591d5ab33 278 desc = ""
be_bryan 0:b74591d5ab33 279 desc += "Flash Device:" + os.linesep
be_bryan 0:b74591d5ab33 280 desc += " name=%s" % self.name + os.linesep
be_bryan 0:b74591d5ab33 281 desc += " version=0x%x" % self.version + os.linesep
be_bryan 0:b74591d5ab33 282 desc += " type=%i" % self.type + os.linesep
be_bryan 0:b74591d5ab33 283 desc += " start=0x%x" % self.start + os.linesep
be_bryan 0:b74591d5ab33 284 desc += " size=0x%x" % self.size + os.linesep
be_bryan 0:b74591d5ab33 285 desc += " page_size=0x%x" % self.page_size + os.linesep
be_bryan 0:b74591d5ab33 286 desc += " value_empty=0x%x" % self.value_empty + os.linesep
be_bryan 0:b74591d5ab33 287 desc += " prog_timeout_ms=%i" % self.prog_timeout_ms + os.linesep
be_bryan 0:b74591d5ab33 288 desc += " erase_timeout_ms=%i" % self.erase_timeout_ms + os.linesep
be_bryan 0:b74591d5ab33 289 desc += " sectors:" + os.linesep
be_bryan 0:b74591d5ab33 290 for sector_start, sector_size in self.sector_info_list:
be_bryan 0:b74591d5ab33 291 desc += (" start=0x%x, size=0x%x" %
be_bryan 0:b74591d5ab33 292 (sector_start, sector_size) + os.linesep)
be_bryan 0:b74591d5ab33 293 return desc
be_bryan 0:b74591d5ab33 294
be_bryan 0:b74591d5ab33 295 def _sector_and_sz_itr(self, elf_simple, data_start):
be_bryan 0:b74591d5ab33 296 """Iterator which returns starting address and sector size"""
be_bryan 0:b74591d5ab33 297 for entry_start in count(data_start, self.FLASH_SECTORS_STRUCT_SIZE):
be_bryan 0:b74591d5ab33 298 data = elf_simple.read(entry_start, self.FLASH_SECTORS_STRUCT_SIZE)
be_bryan 0:b74591d5ab33 299 size, start = struct.unpack(self.FLASH_SECTORS_STRUCT, data)
be_bryan 0:b74591d5ab33 300 start_and_size = start, size
be_bryan 0:b74591d5ab33 301 if start_and_size == (self.SECTOR_END, self.SECTOR_END):
be_bryan 0:b74591d5ab33 302 return
be_bryan 0:b74591d5ab33 303 yield start_and_size
be_bryan 0:b74591d5ab33 304
be_bryan 0:b74591d5ab33 305
be_bryan 0:b74591d5ab33 306 SymbolSimple = namedtuple("SymbolSimple", "name, value, size")
be_bryan 0:b74591d5ab33 307
be_bryan 0:b74591d5ab33 308
be_bryan 0:b74591d5ab33 309 class ElfFileSimple(ELFFile):
be_bryan 0:b74591d5ab33 310 """Wrapper for elf object which allows easy access to symbols and rom"""
be_bryan 0:b74591d5ab33 311
be_bryan 0:b74591d5ab33 312 def __init__(self, data):
be_bryan 0:b74591d5ab33 313 """Construct a ElfFileSimple from bytes or a bytearray"""
be_bryan 0:b74591d5ab33 314 super(ElfFileSimple, self).__init__(StringIO.StringIO(data))
be_bryan 0:b74591d5ab33 315 self.symbols = self._read_symbol_table()
be_bryan 0:b74591d5ab33 316
be_bryan 0:b74591d5ab33 317 def _read_symbol_table(self):
be_bryan 0:b74591d5ab33 318 """Read the symbol table into the field "symbols" for easy use"""
be_bryan 0:b74591d5ab33 319 section = self.get_section_by_name(b".symtab")
be_bryan 0:b74591d5ab33 320 if not section:
be_bryan 0:b74591d5ab33 321 raise Exception("Missing symbol table")
be_bryan 0:b74591d5ab33 322
be_bryan 0:b74591d5ab33 323 if not isinstance(section, SymbolTableSection):
be_bryan 0:b74591d5ab33 324 raise Exception("Invalid symbol table section")
be_bryan 0:b74591d5ab33 325
be_bryan 0:b74591d5ab33 326 symbols = {}
be_bryan 0:b74591d5ab33 327 for symbol in section.iter_symbols():
be_bryan 0:b74591d5ab33 328 name_str = bytes2str(symbol.name)
be_bryan 0:b74591d5ab33 329 if name_str in symbols:
be_bryan 0:b74591d5ab33 330 logging.debug("Duplicate symbol %s", name_str)
be_bryan 0:b74591d5ab33 331 symbols[name_str] = SymbolSimple(name_str, symbol["st_value"],
be_bryan 0:b74591d5ab33 332 symbol["st_size"])
be_bryan 0:b74591d5ab33 333 return symbols
be_bryan 0:b74591d5ab33 334
be_bryan 0:b74591d5ab33 335 def read(self, addr, size):
be_bryan 0:b74591d5ab33 336 """Read program data from the elf file
be_bryan 0:b74591d5ab33 337
be_bryan 0:b74591d5ab33 338 :param addr: physical address (load address) to read from
be_bryan 0:b74591d5ab33 339 :param size: number of bytes to read
be_bryan 0:b74591d5ab33 340 :return: Requested data or None if address is unmapped
be_bryan 0:b74591d5ab33 341 """
be_bryan 0:b74591d5ab33 342 for segment in self.iter_segments():
be_bryan 0:b74591d5ab33 343 seg_addr = segment["p_paddr"]
be_bryan 0:b74591d5ab33 344 seg_size = min(segment["p_memsz"], segment["p_filesz"])
be_bryan 0:b74591d5ab33 345 if addr >= seg_addr + seg_size:
be_bryan 0:b74591d5ab33 346 continue
be_bryan 0:b74591d5ab33 347 if addr + size <= seg_addr:
be_bryan 0:b74591d5ab33 348 continue
be_bryan 0:b74591d5ab33 349 # There is at least some overlap
be_bryan 0:b74591d5ab33 350
be_bryan 0:b74591d5ab33 351 if addr >= seg_addr and addr + size <= seg_addr + seg_size:
be_bryan 0:b74591d5ab33 352 # Region is fully contained
be_bryan 0:b74591d5ab33 353 data = segment.data()
be_bryan 0:b74591d5ab33 354 start = addr - seg_addr
be_bryan 0:b74591d5ab33 355 return data[start:start + size]
be_bryan 0:b74591d5ab33 356
be_bryan 0:b74591d5ab33 357
be_bryan 0:b74591d5ab33 358 if __name__ == '__main__':
be_bryan 0:b74591d5ab33 359 main()