aiden
/
xmir-patcher
mirror of https://github.com/openwrt-xiaomi/xmir-patcher
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[xmir_base] Add module "fdt" v0.3.3

Browse Source 
Sources: https://github.com/molejar/pyFDT
pull/24/head
remittor 2 years ago
parent d36f194a34
commit fdfb91e92b
5 changed files with 1926 additions and 0 deletions
Show Stats Download Patch File Download Diff File

680
xmir_base/fdt/__init__.py
Unescape Escape View File

@ -0,0 +1,680 @@
# Copyright 2017 Martin Olejar
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import os
from .header import Header, DTB_BEGIN_NODE, DTB_END_NODE, DTB_PROP, DTB_END, DTB_NOP
from .items import new_property, Property, PropBytes, PropWords, PropStrings, PropIncBin, Node
from .misc import strip_comments, split_to_lines, get_version_info, extract_string
__author__ = "Martin Olejar"
__contact__ = "martin.olejar@gmail.com"
__version__ = "0.3.3"
__license__ = "Apache 2.0"
__status__ = "Development"
__all__ = [
# FDT Classes
'FDT',
'Node',
'Header',
# properties
'Property',
'PropBytes',
'PropWords',
'PropStrings',
'PropIncBin',
# core methods
'parse_dts',
'parse_dtb',
'diff'
]
class ItemType:
NODE = 0
PROP = 1
# Specific property type
PROP_BASE = 5
PROP_WORDS = 6
PROP_BYTES = 7
PROP_STRINGS = 8
# All types
ALL = 100
class FDT:
""" Flattened Device Tree Class """
@property
def empty(self):
return self.root.empty
def __init__(self, header=None, entries=[]):
"""
FDT class constructor
:param header:
"""
self.entries = entries
self.header = Header() if header is None else header
self.root = Node('/')
self.last_handle = 0
self.label_to_handle = {}
self.handle_to_label = {}
def __str__(self):
""" String representation """
return self.info()
def info(self):
""" Return object info in human readable format """
msg = "FDT Content:\n"
for path, nodes, props in self.walk():
msg += "{} [{}N, {}P]\n".format(path, len(nodes), len(props))
return msg
def get_node(self, path: str, create: bool = False) -> Node:
"""
Get node object from specified path
:param path: Path as string
:param create: If True, not existing nodes will be created
"""
assert isinstance(path, str), "Node path must be a string type !"
node = self.root
path = path.lstrip('/')
if path:
names = path.split('/')
for name in names:
item = node.get_subnode(name)
if item is None:
if create:
item = Node(name)
node.append(item)
else:
raise ValueError("Path \"{}\" doesn't exists".format(path))
node = item
return node
def get_property(self, name: str, path: str = '') -> Property:
"""
Get property object by name from specified path
:param name: Property name
:param path: Path to sub-node
"""
return self.get_node(path).get_property(name)
def set_property(self, name: str, value, path: str = '', create: bool = True):
"""
Set property object by name
:param name: Property name
:param value: Property value
:param path: Path to subnode
:param create: If True, not existing nodes will be created
"""
self.get_node(path, create).set_property(name, value)
def exist_node(self, path: str) -> bool:
"""
Check if <path>/node exist and return True
:param path: path/node name
:return True if <path>/node exist else False
"""
try:
self.get_node(path)
except ValueError:
return False
else:
return True
def exist_property(self, name: str, path: str = '') -> bool:
"""
Check if property exist
:param name: Property name
:param path: The path
"""
return self.get_node(path).exist_property(name) if self.exist_node(path) else False
def remove_node(self, name: str, path: str = ''):
"""
Remove node obj by path/name. Raises ValueError if path/name doesn't exist
:param name: Node name
:param path: Path to sub-node
"""
self.get_node(path).remove_subnode(name)
def remove_property(self, name: str, path: str = ''):
"""
Remove property obj by name. Raises ValueError if path/name doesn't exist
:param name: Property name
:param path: Path to subnode
"""
self.get_node(path).remove_property(name)
def add_item(self, obj, path: str = '', create: bool = True):
"""
Add sub-node or property at specified path. Raises ValueError if path doesn't exist
:param obj: The node or property object
:param path: The path to subnode
:param create: If True, not existing nodes will be created
"""
self.get_node(path, create).append(obj)
def add_label(self, label):
''' track labels/references to convert to phandles
adds label with incrmenting handle to dictionary if not alread present
returns handle for which can be used to replace the reference'''
if label in self.label_to_handle:
return self.label_to_handle[label]
self.last_handle += 1
self.label_to_handle[label] = self.last_handle
self.handle_to_label[self.last_handle] = label
return self.last_handle
def search(self, name: str, itype: int = ItemType.ALL, path: str = '', recursive: bool = True) -> list:
"""
Search properties and/or nodes with specified name. Return list of founded items
:param name: The Property or Node name. If empty "", all nodes or properties will selected
:param itype: Item type - NODE, PROP, PROP_BASE, PROP_WORDS, PROP_BYTES, PROP_STRINGS or ALL
:param path: Path to root node
:param recursive: Search in all sub-nodes (default: True)
"""
assert isinstance(name, str), "Property name must be a string type !"
node = self.get_node(path)
nodes = []
items = []
pclss = {
ItemType.PROP_BASE: Property,
ItemType.PROP_BYTES: PropBytes,
ItemType.PROP_WORDS: PropWords,
ItemType.PROP_STRINGS: PropStrings
}
while True:
nodes += node.nodes
if itype == ItemType.NODE or itype == ItemType.ALL:
if not name or node.name == name:
items.append(node)
if itype != ItemType.NODE or itype == ItemType.ALL:
for p in node.props:
if name and p.name != name:
continue
if itype in pclss and type(p) is not pclss[itype]:
continue
items.append(p)
if not recursive or not nodes:
break
node = nodes.pop()
return items
def walk(self, path: str = '', relative: bool = False) -> list:
"""
Walk trough nodes and return relative/absolute path with list of sub-nodes and properties
:param path: The path to root node
:param relative: True for relative or False for absolute return path
"""
all_nodes = []
node = self.get_node(path)
while True:
all_nodes += node.nodes
current_path = "{}/{}".format(node.path, node.name)
current_path = current_path.replace('///', '/')
current_path = current_path.replace('//', '/')
if path and relative:
current_path = current_path.replace(path, '').lstrip('/')
yield current_path, node.nodes, node.props
if not all_nodes:
break
node = all_nodes.pop()
def merge(self, fdt_obj, replace: bool = True):
"""
Merge external FDT object into this object.
:param fdt_obj: The FDT object which will be merged into this
:param replace: True for replace existing items or False for keep old items
"""
assert isinstance(fdt_obj, FDT)
if self.header.version is None:
self.header = fdt_obj.header
else:
if fdt_obj.header.version is not None and \
fdt_obj.header.version > self.header.version:
self.header.version = fdt_obj.header.version
if fdt_obj.entries:
for in_entry in fdt_obj.entries:
exist = False
for index in range(len(self.entries)):
if self.entries[index]['address'] == in_entry['address']:
self.entries[index]['size'] = in_entry['size']
exist = True
break
if not exist:
self.entries.append(in_entry)
self.root.merge(fdt_obj.get_node('/'), replace)
def update_phandles(self):
all_nodes = []
no_phandle_nodes = []
node = self.root
all_nodes += self.root.nodes
while all_nodes:
props = (node.get_property('phandle'), node.get_property('linux,phandle'))
value = None
for i, p in enumerate(props):
if isinstance(p, PropWords) and isinstance(p.value, int):
value = None if i == 1 and p.value != value else p.value
if value is None:
no_phandle_nodes.append(node)
# ...
node = all_nodes.pop()
all_nodes += node.nodes
for node in no_phandle_nodes:
if node.name != '/':
if node.path == '/':
phandle_value = self.add_label(node.name)
else:
phandle_value = self.add_label(node.path+'/'+node.name)
node.set_property('linux,phandle', phandle_value)
node.set_property('phandle', phandle_value)
def to_dts(self, tabsize: int = 4) -> str:
"""
Store FDT Object into string format (DTS)
:param tabsize:
"""
result = "/dts-v1/;\n"
if self.header.version is not None:
result += "// version: {}\n".format(self.header.version)
result += "// last_comp_version: {}\n".format(self.header.last_comp_version)
if self.header.version >= 2:
result += "// boot_cpuid_phys: 0x{:X}\n".format(self.header.boot_cpuid_phys)
result += '\n'
if self.entries:
for entry in self.entries:
result += "/memreserve/ "
result += "{:#x} ".format(entry['address']) if entry['address'] else "0 "
result += "{:#x}".format(entry['size']) if entry['size'] else "0"
result += ";\n"
if self.root is not None:
result += self.root.to_dts(tabsize)
return result
def to_dtb(self, version: int = None, last_comp_version: int = None, boot_cpuid_phys: int = None, strings: str = None) -> bytes:
"""
Export FDT Object into Binary Blob format (DTB)
:param version:
:param last_comp_version:
:param boot_cpuid_phys:
:param strings:
The strings param is useful (only) when manipulating a signed itb or dtb. The signature includes
the strings buffer in the dtb _in order_. C executables write the strings out in a surprising order.
The argument is used as an initial version of the strings buffer, so that all strings in the input
file are included (and in the same order) in the output file. Usage:
# Read and parse dtb
with open(input, 'rb') as file:
data = file.read()
dtree = fdt.parse_dtb(data)
# Read strings buffer (Assumes version >= 3)
strings_start = dtree.header.off_dt_strings
strings_end = strings_start + dtree.header.size_dt_strings
strings = data[strings_start:strings_end].decode("ascii")
# Serialize dtb and write to output
data = dtree.to_dtb(strings=strings)
with open(output, 'wb') as file:
file.write(data)
"""
if self.root is None:
return b''
from struct import pack
if version is not None:
self.header.version = version
if last_comp_version is not None:
self.header.last_comp_version = last_comp_version
if boot_cpuid_phys is not None:
self.header.boot_cpuid_phys = boot_cpuid_phys
if self.header.version is None:
raise Exception("DTB Version must be specified !")
if strings is None:
strings = ''
blob_entries = bytes()
if self.entries:
for entry in self.entries:
blob_entries += pack('>QQ', entry['address'], entry['size'])
blob_entries += pack('>QQ', 0, 0)
blob_data_start = self.header.size + len(blob_entries)
(blob_data, blob_strings, data_pos) = self.root.to_dtb(strings, blob_data_start, self.header.version)
blob_data += pack('>I', DTB_END)
self.header.size_dt_strings = len(blob_strings)
self.header.size_dt_struct = len(blob_data)
self.header.off_mem_rsvmap = self.header.size
self.header.off_dt_struct = blob_data_start
self.header.off_dt_strings = blob_data_start + len(blob_data)
self.header.total_size = blob_data_start + len(blob_data) + len(blob_strings)
blob_header = self.header.export()
return blob_header + blob_entries + blob_data + blob_strings.encode('ascii')
def parse_dts(text: str, root_dir: str = '') -> FDT:
"""
Parse DTS text file and create FDT Object
:param text:
:param root_dir:
"""
ver = get_version_info(text)
text = strip_comments(text)
dts_lines = split_to_lines(text)
fdt_obj = FDT()
if 'version' in ver:
fdt_obj.header.version = ver['version']
if 'last_comp_version' in ver:
fdt_obj.header.last_comp_version = ver['last_comp_version']
if 'boot_cpuid_phys' in ver:
fdt_obj.header.boot_cpuid_phys = ver['boot_cpuid_phys']
# parse entries
fdt_obj.entries = []
for line in dts_lines:
if line.endswith('{'):
break
if line.startswith('/memreserve/'):
line = line.strip(';')
line = line.split()
if len(line) != 3 :
raise Exception()
fdt_obj.entries.append({'address': int(line[1], 0), 'size': int(line[2], 0)})
# parse nodes
curnode = None
fdt_obj.root = None
for line in dts_lines:
if line.endswith('{'):
# start node
if ':' in line: #indicates the present of a label
label, rest = line.split(':')
node_name = rest.split()[0]
new_node = Node(node_name)
new_node.set_label(label)
else:
node_name = line.split()[0]
new_node = Node(node_name)
if fdt_obj.root is None:
fdt_obj.root = new_node
if curnode is not None:
curnode.append(new_node)
curnode = new_node
elif line.endswith('}'):
# end node
if curnode is not None:
if curnode.get_property('phandle') is None:
if curnode.label is not None:
handle = fdt_obj.add_label(curnode.label)
curnode.set_property('phandle', handle)
curnode = curnode.parent
else:
# properties
if line.find('=') == -1:
prop_name = line
prop_obj = Property(prop_name)
else:
line = line.split('=', maxsplit=1)
prop_name = line[0].rstrip(' ')
prop_value = line[1].lstrip(' ')
if prop_value.startswith('<'):
prop_obj = PropWords(prop_name)
prop_value = prop_value.replace('<', '').replace('>', '')
# ['interrupts ' = ' <0 5 4>, <0 6 4>']
# just change ',' to ' ' -- to concatenate the values into single array
if ',' in prop_value:
prop_value = prop_value.replace(',', ' ')
# keep the orginal references for phandles as a phantom
# property
if "&" in prop_value:
phantom_obj = PropStrings(prop_name+'_with_references')
phantom_obj.append(line[1].lstrip(' '))
if curnode is not None:
curnode.append(phantom_obj)
for prop in prop_value.split():
if prop.startswith('0x'):
prop_obj.append(int(prop, 16))
elif prop.startswith('0b'):
prop_obj.append(int(prop, 2))
elif prop.startswith('0'):
prop_obj.append(int(prop, 8))
elif prop.startswith('&'):
prop_obj.append(fdt_obj.add_label(prop[1:]))
else:
prop_obj.append(int(prop))
elif prop_value.startswith('['):
prop_obj = PropBytes(prop_name)
prop_value = prop_value.replace('[', '').replace(']', '')
for prop in prop_value.split():
prop_obj.append(int(prop, 16))
elif prop_value.startswith('/incbin/'):
prop_value = prop_value.replace('/incbin/("', '').replace('")', '')
prop_value = prop_value.split(',')
file_path = os.path.join(root_dir, prop_value[0].strip())
file_offset = int(prop_value.strip(), 0) if len(prop_value) > 1 else 0
file_size = int(prop_value.strip(), 0) if len(prop_value) > 2 else 0
if file_path is None or not os.path.exists(file_path):
raise Exception("File path doesn't exist: {}".format(file_path))
with open(file_path, "rb") as f:
f.seek(file_offset)
prop_data = f.read(file_size) if file_size > 0 else f.read()
prop_obj = PropIncBin(prop_name, prop_data, os.path.split(file_path)[1])
elif prop_value.startswith('/plugin/'):
raise NotImplementedError("Not implemented property value: /plugin/")
elif prop_value.startswith('/bits/'):
raise NotImplementedError("Not implemented property value: /bits/")
else:
prop_obj = PropStrings(prop_name)
expect_open = True
in_prop = False
prop = ''
for c in prop_value:
if c == '"' and not in_prop and expect_open:
prop = ''
in_prop = True
elif c == '"' and in_prop:
if not len(prop) > 0:
raise ValueError('Empty string')
prop_obj.append(prop)
in_prop = False
expect_open = False
elif in_prop:
prop += c
elif c == ',' and not expect_open:
expect_open = True
elif c == ' ':
continue
else:
raise ValueError(f'Invalid char: {c}')
if expect_open:
raise ValueError('Expected string after ,')
if curnode is not None:
curnode.append(prop_obj)
return fdt_obj
def parse_dtb(data: bytes, offset: int = 0) -> FDT:
"""
Parse FDT Binary Blob and create FDT Object
:param data: FDT Binary Blob in bytes
:param offset: The offset of input data
"""
assert isinstance(data, (bytes, bytearray)), "Invalid argument type"
from struct import unpack_from
fdt_obj = FDT()
# parse header
fdt_obj.header = Header.parse(data)
# parse entries
index = fdt_obj.header.off_mem_rsvmap
while True:
entrie = dict(zip(('address', 'size'), unpack_from(">QQ", data, offset + index)))
index += 16
if entrie['address'] == 0 and entrie['size'] == 0:
break
fdt_obj.entries.append(entrie)
# parse nodes
current_node = None
fdt_obj.root = None
index = fdt_obj.header.off_dt_struct
while True:
if len(data) < (offset + index + 4):
raise Exception("Index out of range !")
tag = unpack_from(">I", data, offset + index)[0]
index += 4
if tag == DTB_BEGIN_NODE:
node_name = extract_string(data, offset + index)
index = ((index + len(node_name) + 4) & ~3)
if not node_name: node_name = '/'
new_node = Node(node_name)
if fdt_obj.root is None:
fdt_obj.root = new_node
if current_node is not None:
current_node.append(new_node)
current_node = new_node
elif tag == DTB_END_NODE:
if current_node is not None:
current_node = current_node.parent
elif tag == DTB_PROP:
prop_size, prop_string_pos, = unpack_from(">II", data, offset + index)
prop_start = index + 8
if fdt_obj.header.version < 16 and prop_size >= 8:
prop_start = ((prop_start + 7) & ~0x7)
prop_name = extract_string(data, fdt_obj.header.off_dt_strings + prop_string_pos)
prop_raw_value = data[offset + prop_start : offset + prop_start + prop_size]
index = prop_start + prop_size
index = ((index + 3) & ~0x3)
if current_node is not None:
current_node.append(new_property(prop_name, prop_raw_value))
elif tag == DTB_END:
break
else:
raise Exception("Unknown Tag: {}".format(tag))
return fdt_obj
def diff(fdt1: FDT, fdt2: FDT) -> tuple:
"""
Compare two flattened device tree objects and return list of 3 objects (same in 1 and 2, specific for 1, specific for 2)
:param fdt1: The object 1 of FDT
:param fdt2: The object 2 of FDT
"""
assert isinstance(fdt1, FDT), "Invalid argument type"
assert isinstance(fdt2, FDT), "Invalid argument type"
fdt_a = FDT(fdt1.header)
fdt_b = FDT(fdt2.header)
if fdt1.header.version is not None and fdt2.header.version is not None:
fdt_same = FDT(fdt1.header if fdt1.header.version > fdt2.header.version else fdt2.header)
else:
fdt_same = FDT(fdt1.header)
if fdt1.entries and fdt2.entries:
for entry_a in fdt1.entries:
for entry_b in fdt2.entries:
if entry_a['address'] == entry_b['address'] and entry_a['size'] == entry_b['size']:
fdt_same.entries.append(entry_a)
break
for entry_a in fdt1.entries:
found = False
for entry_s in fdt_same.entries:
if entry_a['address'] == entry_s['address'] and entry_a['size'] == entry_s['size']:
found = True
break
if not found:
fdt_a.entries.append(entry_a)
for entry_b in fdt2.entries:
found = False
for entry_s in fdt_same.entries:
if entry_b['address'] == entry_s['address'] and entry_b['size'] == entry_s['size']:
found = True
break
if not found:
fdt_b.entries.append(entry_b)
for path, nodes, props in fdt1.walk():
try:
rnode = fdt2.get_node(path)
except:
rnode = None
for node_b in nodes:
if rnode is None or rnode.get_subnode(node_b.name) is None:
fdt_a.add_item(Node(node_b.name), path)
else:
fdt_same.add_item(Node(node_b.name), path)
for prop_a in props:
if rnode is not None and prop_a == rnode.get_property(prop_a.name):
fdt_same.add_item(prop_a.copy(), path)
else:
fdt_a.add_item(prop_a.copy(), path)
for path, nodes, props in fdt2.walk():
try:
rnode = fdt_same.get_node(path)
except:
rnode = None
for node_b in nodes:
if rnode is None or rnode.get_subnode(node_b.name) is None:
fdt_b.add_item(Node(node_b.name), path)
for prop_b in props:
if rnode is None or prop_b != rnode.get_property(prop_b.name):
fdt_b.add_item(prop_b.copy(), path)
return fdt_same, fdt_a, fdt_b

237
xmir_base/fdt/__main__.py
Unescape Escape View File

@ -0,0 +1,237 @@
#!/usr/bin/env python
# Copyright 2017 Martin Olejar
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import os
import sys
import fdt
import argparse
########################################################################################################################
# Helper Functions
########################################################################################################################
def parse_fdt(file_path: str, file_type: str):
"""
Parse *.dtb ot *.dts input file and return FDT object
:param file_path: The path to input file
:param file_type: File type 'dtb', 'dts' or 'auto'
"""
if not os.path.exists(file_path):
raise Exception('File doesnt exist: {}'.format(file_path))
if file_type == 'auto':
if file_path.endswith(".dtb"):
file_type = 'dtb'
elif file_path.endswith(".dts"):
file_type = 'dts'
else:
raise Exception('Not supported file extension: {}'.format(file_path))
if file_type == 'dtb':
with open(file_path, 'rb') as f:
obj = fdt.parse_dtb(f.read())
else:
with open(file_path, 'r') as f:
obj = fdt.parse_dts(f.read(), os.path.dirname(file_path))
return obj
########################################################################################################################
# Commands Functions
########################################################################################################################
def pack(in_file: str, out_file: str, version: int, lc_version: int, cpu_id: int, update_phandles: bool):
"""
The implementation of pack command.
:param in_file: Input File Path
:param out_file: Output File Path
:param version: DTB version
:param lc_version: DTB Last Compatible Version
:param cpu_id: Boot CPU ID
:param update_phandles: If True phandles will be updated
"""
if version is not None and version > fdt.Header.MAX_VERSION:
raise Exception("DTB Version must be lover or equal {} !".format(fdt.Header.MAX_VERSION))
fdt_obj = parse_fdt(in_file, 'dts')
if update_phandles:
fdt_obj.update_phandles()
raw_data = fdt_obj.to_dtb(version, lc_version, cpu_id)
with open(out_file, 'wb') as f:
f.write(raw_data)
print(" DTB saved as: {}".format(out_file))
def unpack(in_file: str, out_file: str, tab_size):
"""
The implementation of unpack command.
:param in_file: Input File Path
:param out_file: Output File Path
:param tab_size: Tabulator size in count of spaces
"""
fdt_obj = parse_fdt(in_file, 'dtb')
with open(out_file, 'w') as f:
f.write(fdt_obj.to_dts(tab_size))
print(" DTS saved as: {}".format(out_file))
def merge(out_file: str, in_files: list, file_type: str, tab_size: int):
"""
The implementation of merge command.
:param out_file: Output File Path
:param in_files: Input Files Path
:param file_type: The type of input files
:param tab_size: Tabulator size in count of spaces
"""
fdt_obj = None
for file in in_files:
obj = parse_fdt(file, file_type)
if fdt_obj is None:
fdt_obj = obj
else:
fdt_obj.merge(obj)
with open(out_file, 'w') as f:
f.write(fdt_obj.to_dts(tab_size))
print(" Output saved as: {}".format(out_file))
def diff(in_file1: str, in_file2: str, file_type: str, out_dir: str):
"""
The implementation of diff command.
:param in_file1: Input File1 Path
:param in_file2: Input File2 Path
:param file_type: The type of input files
:param out_dir: Path to output directory
"""
# load input files
fdt1 = parse_fdt(in_file1, file_type)
fdt2 = parse_fdt(in_file2, file_type)
# compare it
diff = fdt.diff(fdt1, fdt2)
if diff[0].empty:
print(" Input files are completely different !")
sys.exit()
# create output directory
os.makedirs(out_dir, exist_ok=True)
# get names for output files
file_name = (
"same.dts",
os.path.splitext(os.path.basename(in_file1))[0] + ".dts",
os.path.splitext(os.path.basename(in_file2))[0] + ".dts")
# save output files
for index, obj in enumerate(diff):
if not obj.empty:
with open(os.path.join(out_dir, file_name[index]), 'w') as f:
f.write(obj.to_dts())
print(" Diff output saved into: {}".format(out_dir))
########################################################################################################################
# Main
########################################################################################################################
def main():
# cli interface
parser = argparse.ArgumentParser(
prog="pydtc",
description="Flat Device Tree (FDT) tool for manipulation with *.dtb and *.dts files")
parser.add_argument('-v', '--version', action='version', version=fdt.__version__)
subparsers = parser.add_subparsers(dest='command')
# pack command
pack_parser = subparsers.add_parser('pack', help='Pack *.dts into binary blob (*.dtb)')
pack_parser.add_argument('dts_file', nargs=1, help='Path to *.dts file')
pack_parser.add_argument('-v', dest='version', type=int, help='DTB Version')
pack_parser.add_argument('-l', dest='lc_version', type=int, help='DTB Last Compatible Version')
pack_parser.add_argument('-c', dest='cpu_id', type=int, help='Boot CPU ID')
pack_parser.add_argument('-p', dest='phandles', action='store_true', help='Update phandles')
pack_parser.add_argument('-o', dest='dtb_file', type=str, help='Output path with file name (*.dtb)')
# unpack command
unpack_parser = subparsers.add_parser('unpack', help='Unpack *.dtb into readable format (*.dts)')
unpack_parser.add_argument('dtb_file', nargs=1, help='Path to *.dtb file')
unpack_parser.add_argument('-s', dest='tab_size', type=int, default=4, help='Tabulator Size')
unpack_parser.add_argument('-o', dest='dts_file', type=str, help='Output path with file name (*.dts)')
# merge command
merge_parser = subparsers.add_parser('merge', help='Merge more files in *.dtb or *.dts format')
merge_parser.add_argument('out_file', nargs=1, help='Output path with file name (*.dts or *.dtb)')
merge_parser.add_argument('in_files', nargs='+', help='Path to input files')
merge_parser.add_argument('-t', dest='type', type=str, choices=['auto', 'dts', 'dtb'], help='Input file type')
merge_parser.add_argument('-s', dest='tab_size', type=int, default=4, help='Tabulator Size for dts')
# diff command
diff_parser = subparsers.add_parser('diff', help='Compare two files in *.dtb or *.dts format')
diff_parser.add_argument('in_file1', nargs=1, help='Path to dts or dtb file')
diff_parser.add_argument('in_file2', nargs=1, help='Path to dts or dtb file')
diff_parser.add_argument('-t', dest='type', type=str, choices=['auto', 'dts', 'dtb'], help='Input file type')
diff_parser.add_argument('-o', dest='out_dir', type=str, help='Output directory')
args = parser.parse_args()
try:
if args.command == 'pack':
in_file = args.dts_file[0]
if args.dtb_file is None:
out_file = os.path.splitext(os.path.basename(in_file))[0] + ".dtb"
else:
out_file = args.dtb_file.lstrip()
pack(in_file, out_file, args.version, args.lc_version, args.cpu_id, args.phandles)
elif args.command == 'unpack':
in_file = args.dtb_file[0]
if args.dts_file is None:
out_file = os.path.splitext(os.path.basename(in_file))[0] + ".dts"
else:
out_file = args.dts_file.lstrip()
unpack(in_file, out_file, args.tab_size)
elif args.command == 'merge':
merge(args.out_file[0], args.in_files, args.type, args.tab_size)
elif args.command == 'diff':
out_dir = args.out_dir if args.out_dir else os.path.join(os.getcwd(), 'diff_out')
diff(args.in_file1[0], args.in_file2[0], args.type, out_dir.lstrip())
else:
parser.print_help()
except Exception as e:
print("[pydtc] Execution Error !")
print(str(e) if str(e) else "Unknown Error", file=sys.stderr)
sys.exit(1)
if __name__ == '__main__':
main()

153
xmir_base/fdt/header.py
Unescape Escape View File

@ -0,0 +1,153 @@
# Copyright 2017 Martin Olejar
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from struct import unpack_from, pack
########################################################################################################################
# Binary Blob Constants
########################################################################################################################
DTB_BEGIN_NODE = 0x1
DTB_END_NODE = 0x2
DTB_PROP = 0x3
DTB_NOP = 0x4
DTB_END = 0x9
########################################################################################################################
# Header Class
########################################################################################################################
class Header:
MIN_SIZE = 4 * 7
MAX_SIZE = 4 * 10
MAX_VERSION = 17
MAGIC_NUMBER = 0xD00DFEED
@property
def version(self):
return self._version
@version.setter
def version(self, value):
if value > self.MAX_VERSION:
raise ValueError("Invalid Version {}, use: 0 - 17 !".format(value))
# update size and padding
self._size = self.MIN_SIZE
if value >= 2:
self._size += 4
if value >= 3:
self._size += 4
if value >= 17:
self._size += 4
self._padding = 8 - (self._size % 8) if self._size % 8 != 0 else 0
self._version = value
self.last_comp_version = value - 1
@property
def size(self):
return self._size + self._padding
@property
def padding(self):
return self._padding
def __init__(self):
# private variables
self._version = None
self._size = 0
self._padding = 0
# public variables
self.total_size = 0
self.off_dt_struct = 0
self.off_dt_strings = 0
self.off_mem_rsvmap = 0
self.last_comp_version = 0
# version depend variables
self.boot_cpuid_phys = 0
self.size_dt_strings = None
self.size_dt_struct = None
def __str__(self):
return '<FDT-v{}, size: {}>'.format(self.version, self.size)
def info(self):
nfo = 'FDT Header:'
nfo += '- Version: {}'.format(self.version)
nfo += '- Size: {}'.format(self.size)
return nfo
def export(self) -> bytes:
"""
:return:
"""
if self.version is None:
raise Exception("Header version must be specified !")
blob = pack('>7I', self.MAGIC_NUMBER, self.total_size, self.off_dt_struct, self.off_dt_strings,
self.off_mem_rsvmap, self.version, self.last_comp_version)
if self.version >= 2:
blob += pack('>I', self.boot_cpuid_phys)
if self.version >= 3:
blob += pack('>I', self.size_dt_strings)
if self.version >= 17:
blob += pack('>I', self.size_dt_struct)
if self.padding:
blob += bytes([0] * self.padding)
return blob
@classmethod
def parse(cls, data: bytes, offset: int = 0):
"""
:param data:
:param offset:
"""
if len(data) < (offset + cls.MIN_SIZE):
raise ValueError('Data size too small !')
header = cls()
(magic_number,
header.total_size,
header.off_dt_struct,
header.off_dt_strings,
header.off_mem_rsvmap,
header.version,
header.last_comp_version) = unpack_from('>7I', data, offset)
offset += cls.MIN_SIZE
if magic_number != cls.MAGIC_NUMBER:
raise Exception('Invalid Magic Number')
if header.last_comp_version > cls.MAX_VERSION - 1:
raise Exception('Invalid last compatible Version {}'.format(header.last_comp_version))
if header.version >= 2:
header.boot_cpuid_phys = unpack_from('>I', data, offset)[0]
offset += 4
if header.version >= 3:
header.size_dt_strings = unpack_from('>I', data, offset)[0]
offset += 4
if header.version >= 17:
header.size_dt_struct = unpack_from('>I', data, offset)[0]
offset += 4
return header

767
xmir_base/fdt/items.py
Unescape Escape View File

@ -0,0 +1,767 @@
# Copyright 2017 Martin Olejar
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from struct import pack, Struct
from string import printable
from .header import Header, DTB_PROP, DTB_BEGIN_NODE, DTB_END_NODE
from .misc import is_string, line_offset
BIGENDIAN_WORD = Struct(">I")
########################################################################################################################
# Helper methods
########################################################################################################################
def new_property(name: str, raw_value: bytes) -> object:
"""
Instantiate property with raw value type
:param name: Property name
:param raw_value: Property raw data
"""
if is_string(raw_value):
obj = PropStrings(name)
# Extract strings from raw value
for st in raw_value.decode('ascii').split('\0'):
if st:
obj.append(st)
return obj
elif len(raw_value) and len(raw_value) % 4 == 0:
obj = PropWords(name)
# Extract words from raw value
obj.data = [BIGENDIAN_WORD.unpack(raw_value[i:i + 4])[0] for i in range(0, len(raw_value), 4)]
return obj
elif len(raw_value):
return PropBytes(name, data=raw_value)
else:
return Property(name)
########################################################################################################################
# Base Class
########################################################################################################################
class BaseItem:
@property
def name(self):
return self._name
@property
def label(self):
return self._label
@property
def parent(self):
return self._parent
@property
def path(self):
node = self._parent
path = ""
while node:
if node.name == '/': break
path = '/' + node.name + path
node = node.parent
return path if path else '/'
def __init__(self, name: str, label=None):
"""
BaseItem constructor
:param name: Item name
"""
assert isinstance(name, str)
assert all(c in printable for c in name), "The value must contain just printable chars !"
self._name = name
self._label = label
self._parent = None
def __str__(self):
""" String representation """
return "{}".format(self.name)
def set_name(self, value: str):
"""
Set item name
:param value: The name in string format
"""
assert isinstance(value, str)
assert all(c in printable for c in value), "The value must contain just printable chars !"
self._name = value
def set_label(self, value: str):
"""
Set item label
:param value: The label in string format
"""
assert isinstance(value, str)
assert all(c in printable for c in value), "The value must contain just printable chars !"
self._label = value
def set_parent(self, value):
"""
Set item parent
:param value: The parent node
"""
assert isinstance(value, Node)
self._parent = value
def to_dts(self, tabsize: int = 4, depth: int = 0):
raise NotImplementedError()
def to_dtb(self, strings: str, pos: int = 0, version: int = Header.MAX_VERSION):
raise NotImplementedError()
########################################################################################################################
# Property Classes
########################################################################################################################
class Property(BaseItem):
def __getitem__(self, value):
""" Returns No Items """
return None
def __eq__(self, obj):
""" Check Property object equality """
return isinstance(obj, Property) and self.name == obj.name
def copy(self):
""" Get object copy """
return Property(self.name)
def to_dts(self, tabsize: int = 4, depth: int = 0):
"""
Get string representation
:param tabsize: Tabulator size in count of spaces
:param depth: Start depth for line
"""
return line_offset(tabsize, depth, '{};\n'.format(self.name))
def to_dtb(self, strings: str, pos: int = 0, version: int = Header.MAX_VERSION):
"""
Get binary blob representation
:param strings:
:param pos:
:param version:
"""
strpos = strings.find(self.name + '\0')
if strpos < 0:
strpos = len(strings)
strings += self.name + '\0'
pos += 12
return pack('>III', DTB_PROP, 0, strpos), strings, pos
class PropStrings(Property):
"""Property with strings as value"""
@property
def value(self):
return self.data[0] if self.data else None
def __init__(self, name: str, *args):
"""
PropStrings constructor
:param name: Property name
:param args: str1, str2, ...
"""
super().__init__(name)
self.data = []
for arg in args:
self.append(arg)
def __str__(self):
""" String representation """
return "{} = {}".format(self.name, self.data)
def __len__(self):
""" Get strings count """
return len(self.data)
def __getitem__(self, index):
""" Get string by index """
return self.data[index]
def __eq__(self, obj):
""" Check PropStrings object equality """
if not isinstance(obj, PropStrings) or self.name != obj.name or len(self) != len(obj):
return False
for index in range(len(self)):
if self.data[index] != obj[index]:
return False
return True
def copy(self):
""" Get object copy """
return PropStrings(self.name, *self.data)
def append(self, value: str):
assert isinstance(value, str)
assert len(value) > 0, "Invalid strings value"
assert all(c in printable or c in ('\r', '\n') for c in value), "Invalid chars in strings value"
self.data.append(value)
def pop(self, index: int):
assert 0 <= index < len(self.data), "Index out of range"
return self.data.pop(index)
def clear(self):
self.data.clear()
def to_dts(self, tabsize: int = 4, depth: int = 0):
"""
Get string representation
:param tabsize: Tabulator size in count of spaces
:param depth: Start depth for line
"""
result = line_offset(tabsize, depth, self.name)
result += ' = "'
result += '", "'.join([item.replace('"', '\\"') for item in self.data])
result += '";\n'
return result
def to_dtb(self, strings: str, pos: int = 0, version: int = Header.MAX_VERSION):
"""
Get blob representation
:param strings:
:param pos:
:param version:
"""
blob = pack('')
for chars in self.data:
blob += chars.encode('ascii') + pack('b', 0)
blob_len = len(blob)
if version < 16 and (pos + 12) % 8 != 0:
blob = pack('b', 0) * (8 - ((pos + 12) % 8)) + blob
if blob_len % 4:
blob += pack('b', 0) * (4 - (blob_len % 4))
strpos = strings.find(self.name + '\0')
if strpos < 0:
strpos = len(strings)
strings += self.name + '\0'
blob = pack('>III', DTB_PROP, blob_len, strpos) + blob
pos += len(blob)
return blob, strings, pos
class PropWords(Property):
"""Property with words as value"""
@property
def value(self):
return self.data[0] if self.data else None
def __init__(self, name, *args):
"""
PropWords constructor
:param name: Property name
:param args: word1, word2, ...
"""
super().__init__(name)
self.data = []
self.word_size = 32
for val in args:
self.append(val)
def __str__(self):
""" String representation """
return "{} = {}".format(self.name, self.data)
def __getitem__(self, index):
""" Get word by index """
return self.data[index]
def __len__(self):
""" Get words count """
return len(self.data)
def __eq__(self, prop):
""" Check PropWords object equality """
if not isinstance(prop, PropWords):
return False
if self.name != prop.name:
return False
if len(self) != len(prop):
return False
for index in range(len(self)):
if self.data[index] != prop[index]:
return False
return True
def copy(self):
return PropWords(self.name, *self.data)
def append(self, value):
assert isinstance(value, int), "Invalid object type"
assert 0 <= value < 2**self.word_size, "Invalid word value {}, use <0x0 - 0x{:X}>".format(
value, 2**self.word_size - 1)
self.data.append(value)
def pop(self, index):
assert 0 <= index < len(self.data), "Index out of range"
return self.data.pop(index)
def clear(self):
self.data.clear()
def to_dts(self, tabsize: int = 4, depth: int = 0):
"""
Get string representation
:param tabsize: Tabulator size in count of spaces
:param depth: Start depth for line
"""
result = line_offset(tabsize, depth, self.name)
result += ' = <'
result += ' '.join(["0x{:X}".format(word) for word in self.data])
result += ">;\n"
return result
def to_dtb(self, strings: str, pos: int = 0, version: int = Header.MAX_VERSION):
"""
Get blob representation
:param strings:
:param pos:
:param version:
"""
strpos = strings.find(self.name + '\0')
if strpos < 0:
strpos = len(strings)
strings += self.name + '\0'
blob = pack('>III', DTB_PROP, len(self.data) * 4, strpos)
blob += bytes().join([BIGENDIAN_WORD.pack(word) for word in self.data])
pos += len(blob)
return blob, strings, pos
class PropBytes(Property):
"""Property with bytes as value"""
def __init__(self, name, *args, data=None):
"""
PropBytes constructor
:param name: Property name
:param args: byte0, byte1, ...
:param data: Data as list, bytes or bytearray
"""
super().__init__(name)
self.data = bytearray(args)
if data:
assert isinstance(data, (list, bytes, bytearray))
self.data += bytearray(data)
def __str__(self):
""" String representation """
return "{} = {}".format(self.name, self.data)
def __getitem__(self, index):
"""Get byte by index """
return self.data[index]
def __len__(self):
""" Get bytes count """
return len(self.data)
def __eq__(self, prop):
""" Check PropBytes object equality """
if not isinstance(prop, PropBytes):
return False
if self.name != prop.name:
return False
if len(self) != len(prop):
return False
for index in range(len(self)):
if self.data[index] != prop[index]:
return False
return True
def copy(self):
""" Create a copy of object """
return PropBytes(self.name, data=self.data)
def append(self, value):
assert isinstance(value, int), "Invalid object type"
assert 0 <= value <= 0xFF, "Invalid byte value {}, use <0 - 255>".format(value)
self.data.append(value)
def pop(self, index):
assert 0 <= index < len(self.data), "Index out of range"
return self.data.pop(index)
def clear(self):
self.data = bytearray()
def to_dts(self, tabsize: int = 4, depth: int = 0):
"""
Get string representation
:param tabsize: Tabulator size in count of spaces
:param depth: Start depth for line
"""
result = line_offset(tabsize, depth, self.name)
result += ' = ['
result += ' '.join(["{:02X}".format(byte) for byte in self.data])
result += '];\n'
return result
def to_dtb(self, strings: str, pos: int = 0, version: int = Header.MAX_VERSION):
"""
Get blob representation
:param strings:
:param pos:
:param version:
"""
strpos = strings.find(self.name + '\0')
if strpos < 0:
strpos = len(strings)
strings += self.name + '\0'
blob = pack('>III', DTB_PROP, len(self.data), strpos)
blob += bytes(self.data)
if len(blob) % 4:
blob += bytes([0] * (4 - (len(blob) % 4)))
pos += len(blob)
return blob, strings, pos
class PropIncBin(PropBytes):
"""Property with bytes as value"""
def __init__(self, name, data=None, file_name=None, rpath=None):
"""
PropIncBin constructor
:param name: Property name
:param data: Data as list, bytes or bytearray
:param file_name: File name
:param rpath: Relative path
"""
super().__init__(name, data)
self.file_name = file_name
self.relative_path = rpath
def __eq__(self, prop):
""" Check PropIncBin object equality """
if not isinstance(prop, PropIncBin):
return False
if self.name != prop.name:
return False
if self.file_name != prop.file_name:
return False
if self.relative_path != prop.relative_path:
return False
if self.data != prop.data:
return False
return True
def copy(self):
""" Create a copy of object """
return PropIncBin(self.name, self.data, self.file_name, self.relative_path)
def to_dts(self, tabsize: int = 4, depth: int = 0):
"""
Get string representation
:param tabsize: Tabulator size in count of spaces
:param depth: Start depth for line
"""
file_path = self.file_name
if self.relative_path is not None:
file_path = "{}/{}".format(self.relative_path, self.file_name)
result = line_offset(tabsize, depth, self.name)
result += " = /incbin/(\"{}\");\n".format(file_path)
return result
########################################################################################################################
# Node Class
########################################################################################################################
class Node(BaseItem):
"""Node representation"""
@property
def props(self):
return self._props
@property
def nodes(self):
return self._nodes
@property
def empty(self):
return False if self.nodes or self.props else True
def __init__(self, name, *args, label=None):
"""
Node constructor
:param name: Node name
:param args: List of properties and subnodes
"""
super().__init__(name, label=label)
self._props = []
self._nodes = []
for item in args:
self.append(item)
def __str__(self):
""" String representation """
return "< {}: {} props, {} nodes >".format(self.name, len(self.props), len(self.nodes))
def __eq__(self, node):
""" Check node equality """
if not isinstance(node, Node):
return False
if self.name != node.name or \
len(self.props) != len(node.props) or \
len(self.nodes) != len(node.nodes):
return False
for p in self.props:
if p not in node.props:
return False
for n in self.nodes:
if n not in node.nodes:
return False
return True
def copy(self):
""" Create a copy of Node object """
node = Node(self.name, label=self.label)
for p in self.props:
node.append(p.copy())
for n in self.nodes:
node.append(n.copy())
return node
def get_property(self, name):
"""
Get property object by its name
:param name: Property name
"""
for p in self.props:
if p.name == name:
return p
return None
def set_property(self, name, value):
"""
Set property
:param name: Property name
:param value: Property value
"""
if value is None:
new_prop = Property(name)
elif isinstance(value, int):
new_prop = PropWords(name, value)
elif isinstance(value, str):
new_prop = PropStrings(name, value)
elif isinstance(value, list) and isinstance(value[0], int):
new_prop = PropWords(name, *value)
elif isinstance(value, list) and isinstance(value[0], str):
new_prop = PropStrings(name, *value)
elif isinstance(value, (bytes, bytearray)):
new_prop = PropBytes(name, data=value)
else:
raise TypeError('Value type not supported')
new_prop.set_parent(self)
old_prop = self.get_property(name)
if old_prop is None:
self.props.append(new_prop)
else:
index = self.props.index(old_prop)
self.props[index] = new_prop
def get_subnode(self, name: str):
"""
Get subnode object by name
:param name: Subnode name
"""
for n in self.nodes:
if n.name == name:
return n
return None
def exist_property(self, name: str) -> bool:
"""
Check if property exist and return True if exist else False
:param name: Property name
"""
return False if self.get_property(name) is None else True
def exist_subnode(self, name: str) -> bool:
"""
Check if subnode exist and return True if exist else False
:param name: Subnode name
"""
return False if self.get_subnode(name) is None else True
def remove_property(self, name: str):
"""
Remove property object by its name.
:param name: Property name
"""
item = self.get_property(name)
if item is not None:
self.props.remove(item)
def remove_subnode(self, name: str):
"""
Remove subnode object by its name.
:param name: Subnode name
"""
item = self.get_subnode(name)
if item is not None:
self.nodes.remove(item)
def append(self, item):
"""
Append node or property
:param item: The node or property object
"""
assert isinstance(item, (Node, Property)), "Invalid object type, use \"Node\" or \"Property\""
if isinstance(item, Property):
if self.get_property(item.name) is not None:
raise Exception("{}: \"{}\" property already exists".format(self, item.name))
item.set_parent(self)
self.props.append(item)
else:
if self.get_subnode(item.name) is not None:
raise Exception("{}: \"{}\" node already exists".format(self, item.name))
if item is self:
raise Exception("{}: append the same node {}".format(self, item.name))
item.set_parent(self)
self.nodes.append(item)
def merge(self, node_obj, replace: bool = True):
"""
Merge two nodes
:param node_obj: Node object
:param replace: If True, replace current properties with the given properties
"""
assert isinstance(node_obj, Node), "Invalid object type"
def get_property_index(name):
for i, p in enumerate(self.props):
if p.name == name:
return i
return None
def get_subnode_index(name):
for i, n in enumerate(self.nodes):
if n.name == name:
return i
return None
for prop in node_obj.props:
index = get_property_index(prop.name)
if index is None:
self.append(prop.copy())
elif prop in self._props:
continue
elif replace:
new_prop = prop.copy()
new_prop.set_parent(self)
self._props[index] = new_prop
else:
pass
for sub_node in node_obj.nodes:
index = get_subnode_index(sub_node.name)
if index is None:
self.append(sub_node.copy())
elif sub_node in self._nodes:
continue
else:
self._nodes[index].merge(sub_node, replace)
def to_dts(self, tabsize: int = 4, depth: int = 0) -> str:
"""
Get string representation of NODE object
:param tabsize: Tabulator size in count of spaces
:param depth: Start depth for line
"""
if self._label is not None:
dts = line_offset(tabsize, depth, self._label + ': ' + self.name + ' {\n')
else:
dts = line_offset(tabsize, depth, self.name + ' {\n')
# phantom properties which maintain reference state info
# have names ending with _with_references
# don't write those out to dts file
dts += ''.join(
prop.to_dts(tabsize, depth + 1)
for prop in self._props if prop.name.endswith('_with_references') is False)
dts += ''.join(node.to_dts(tabsize, depth + 1) for node in self._nodes)
dts += line_offset(tabsize, depth, "};\n")
return dts
def to_dtb(self, strings: str, pos: int = 0, version: int = Header.MAX_VERSION) -> tuple:
"""
Get NODE in binary blob representation
:param strings:
:param pos:
:param version:
"""
if self.name == '/':
blob = pack('>II', DTB_BEGIN_NODE, 0)
else:
blob = pack('>I', DTB_BEGIN_NODE)
blob += self.name.encode('ascii') + b'\0'
if len(blob) % 4:
blob += pack('b', 0) * (4 - (len(blob) % 4))
pos += len(blob)
for prop in self._props:
# phantom property too maintain reference state should
# not write out to dtb file
if prop.name.endswith('_with_references') is False:
(data, strings, pos) = prop.to_dtb(strings, pos, version)
blob += data
for node in self._nodes:
(data, strings, pos) = node.to_dtb(strings, pos, version)
blob += data
pos += 4
blob += pack('>I', DTB_END_NODE)
return blob, strings, pos

89
xmir_base/fdt/misc.py
Unescape Escape View File

@ -0,0 +1,89 @@
# Copyright 2017 Martin Olejar
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import re
from string import printable
def is_string(data):
""" Check property string validity """
if not len(data):
return None
if data[-1] != 0:
return None
pos = 0
while pos < len(data):
posi = pos
while pos < len(data) and \
data[pos] != 0 and \
data[pos] in printable.encode() and \
data[pos] not in (ord('\r'), ord('\n')):
pos += 1
if data[pos] != 0 or pos == posi:
return None
pos += 1
return True
def extract_string(data, offset=0):
""" Extract string """
str_end = offset
while data[str_end] != 0:
str_end += 1
return data[offset:str_end].decode("ascii")
def line_offset(tabsize, offset, string):
offset = " " * (tabsize * offset)
return offset + string
def get_version_info(text):
ret = dict()
for line in text.split('\n'):
line = line.rstrip('\0')
if line and line.startswith('/ {'):
break
if line and line.startswith('//'):
line = line.replace('//', '').replace(':', '')
line = line.split()
if line[0] in ('version', 'last_comp_version', 'boot_cpuid_phys'):
ret[line[0]] = int(line[1], 0)
return ret
def strip_comments(text):
text = re.sub('//.*?(\r\n?|\n)|/\*.*?\*/', '\n', text, flags=re.S)
return text
def split_to_lines(text):
lines = []
mline = str()
for line in text.split('\n'):
line = line.replace('\t', ' ')
line = line.rstrip('\0')
line = line.rstrip(' ')
line = line.lstrip(' ')
if not line or line.startswith('/dts-'):
continue
if line.endswith('{') or line.endswith(';'):
line = line.replace(';', '')
lines.append(mline + line)
mline = str()
else:
mline += line + ' '
return lines
Write Preview
Loading…
Cancel
Save