xstefen
/
calyxos-scripts
mirror of https://github.com/CalyxOS/scripts
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fbpacktool: Update to current version 

Source:
https://source.android.com/static/docs/core/architecture/bootloader/tools/pixel/fw_unpack/*.py

Modified to comment out
'from google3.third_party.devsite.androidsource.en.docs.core.architecture.bootloader.tools.pixel.fw_unpack'
from imports.

Change-Id: Ie81b52969633435ff303a89309868509436392ab
This commit is contained in:
Michael Bestas 2023-06-12 02:22:51 +03:00 committed by Chirayu Desai
parent 14a2e0462a
commit d0dd0055cb
4 changed files with 303 additions and 264 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
fbpacktool/fbpack.py
View File

@ -12,9 +12,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
import struct
from packedstruct import PackedStruct
from collections import OrderedDict
import collections
#from google3.third_party.devsite.androidsource.en.docs.core.architecture.bootloader.tools.pixel.fw_unpack import packedstruct
FBPACK_MAGIC = 0x4b504246 # "FBPK" FastBook PacK
FBPACK_VERSION = 2
@ -25,61 +25,80 @@ FBPACK_PARTITION_DATA = 1
FBPACK_SIDELOAD_DATA = 2
class PackEntry(PackedStruct):
"""Pack entry info."""
class PackEntry(packedstruct.PackedStruct):
"""Pack entry info."""
_FIELDS = OrderedDict([
('type', 'I'),
('name', '36s'),
('product', '40s'),
('offset', 'Q'),
('size', 'Q'),
('slotted', 'I'),
('crc32', 'I'),
])
type: int
name: bytes
product: bytes
offset: int
size: int
slotted: int
crc32: int
_FIELDS = collections.OrderedDict([
('type', 'I'),
('name', '36s'),
('product', '40s'),
('offset', 'Q'),
('size', 'Q'),
('slotted', 'I'),
('crc32', 'I'),
])
def __init__(self, type_=0, name=b'', prod=b'', offset=0, size=0, slotted=0, crc32=0):
super(PackEntry, self).__init__(type_, name, prod, offset, size, slotted, crc32)
# Provide defaults.
# pylint: disable=useless-super-delegation
def __init__(self,
type_=0,
name=b'',
prod=b'',
offset=0,
size=0,
slotted=0,
crc32=0):
super(PackEntry, self).__init__(type_, name, prod, offset, size, slotted,
crc32)
class PackHeader(PackedStruct):
""" A packed image representation """
class PackHeader(packedstruct.PackedStruct):
""" A packed image representation"""
_FIELDS = OrderedDict([
('magic', 'I'),
('version', 'I'),
('header_size', 'I'),
('entry_header_size', 'I'),
('platform', '16s'),
('pack_version', '64s'),
('slot_type', 'I'),
('data_align', 'I'),
('total_entries', 'I'),
('total_size', 'I'),
])
magic: int
version: int
header_size: int
entry_header_size: int
platform: bytes
pack_version: bytes
slot_type: int
data_align: int
total_entries: int
total_size: int
_FIELDS = collections.OrderedDict([
('magic', 'I'),
('version', 'I'),
('header_size', 'I'),
('entry_header_size', 'I'),
('platform', '16s'),
('pack_version', '64s'),
('slot_type', 'I'),
('data_align', 'I'),
('total_entries', 'I'),
('total_size', 'I'),
])
def __init__(
self,
magic=FBPACK_MAGIC,
version=FBPACK_VERSION,
header_size=0,
entry_header_size=len(PackEntry()),
platform=b'',
pack_version=b'',
slot_type=0,
data_align=FBPACK_DEFAULT_DATA_ALIGN,
total_entries=0,
total_size=0):
super(PackHeader, self).__init__(
magic,
version,
header_size,
entry_header_size,
platform,
pack_version,
slot_type,
data_align,
total_entries,
total_size)
# update header size once we know all fields
self.header_size = len(self)
def __init__(self,
magic=FBPACK_MAGIC,
version=FBPACK_VERSION,
header_size=0,
entry_header_size=len(PackEntry()),
platform=b'',
pack_version=b'',
slot_type=0,
data_align=FBPACK_DEFAULT_DATA_ALIGN,
total_entries=0,
total_size=0):
super(PackHeader,
self).__init__(magic, version, header_size, entry_header_size,
platform, pack_version, slot_type, data_align,
total_entries, total_size)
# update header size once we know all fields
self.header_size = len(self)

1
fbpacktool/fbpacktool
View File

@ -1 +0,0 @@
fbpacktool.py

369
fbpacktool/fbpacktool.py Executable file → Normal file
View File

@ -13,244 +13,263 @@
# 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 sys
import os
import argparse
import logging
from fbpack import *
import os
import sys
from lxml.etree import XMLParser
import yaml
#from google3.third_party.devsite.androidsource.en.docs.core.architecture.bootloader.tools.pixel.fw_unpack import fbpack
def bytes_to_str(bstr):
return bstr.decode().rstrip('\x00')
return bstr.decode().rstrip('\x00')
def print_pack_header(pack):
print('magic: {:#x}'.format(pack.magic))
print('version: {}'.format(pack.version))
print('header size: {}'.format(pack.header_size))
print('entry header size: {}'.format(pack.entry_header_size))
platform = bytes_to_str(pack.platform)
print('platform: {}'.format(platform))
pack_version = bytes_to_str(pack.pack_version)
print('pack version: {}'.format(pack_version))
print('slock type: {}'.format(pack.slot_type))
print('data align: {}'.format(pack.data_align))
print('total entries: {}'.format(pack.total_entries))
print('total size: {}'.format(pack.total_size))
print('magic: {:#x}'.format(pack.magic))
print('version: {}'.format(pack.version))
print('header size: {}'.format(pack.header_size))
print('entry header size: {}'.format(pack.entry_header_size))
platform = bytes_to_str(pack.platform)
print('platform: {}'.format(platform))
pack_version = bytes_to_str(pack.pack_version)
print('pack version: {}'.format(pack_version))
print('slock type: {}'.format(pack.slot_type))
print('data align: {}'.format(pack.data_align))
print('total entries: {}'.format(pack.total_entries))
print('total size: {}'.format(pack.total_size))
def print_pack_entry(entry, prefix):
name = bytes_to_str(entry.name)
print('{}name: {}'.format(prefix, name))
etype = 'unknown'
if entry.type == FBPACK_PARTITION_TABLE:
etype = 'partiton table'
elif entry.type == FBPACK_PARTITION_DATA:
etype = 'partition'
elif entry.type == FBPACK_SIDELOAD_DATA:
etype = 'sideload'
else:
print("entry else")
print('{}type: {}'.format(prefix, etype))
product = bytes_to_str(entry.product)
print('{}product: {}'.format(prefix, product))
print('{}offset: {:#x} ({})'.format(prefix, entry.offset, entry.offset))
print('{}size: {:#x} ({})'.format(prefix, entry.size, entry.size))
print('{}slotted: {}'.format(entry.size, bool(entry.slotted)))
print('{}crc32: {:#08x}'.format(prefix, entry.crc32))
name = bytes_to_str(entry.name)
print('{}name: {}'.format(prefix, name))
etype = 'unknown'
if entry.type == fbpack.FBPACK_PARTITION_TABLE:
etype = 'partiton table'
elif entry.type == fbpack.FBPACK_PARTITION_DATA:
etype = 'partition'
elif entry.type == fbpack.FBPACK_SIDELOAD_DATA:
etype = 'sideload'
else:
print('entry else')
print('{}type: {}'.format(prefix, etype))
product = bytes_to_str(entry.product)
print('{}product: {}'.format(prefix, product))
print('{}offset: {:#x} ({})'.format(prefix, entry.offset, entry.offset))
print('{}size: {:#x} ({})'.format(prefix, entry.size, entry.size))
print('{}slotted: {}'.format(entry.size, bool(entry.slotted)))
print('{}crc32: {:#08x}'.format(prefix, entry.crc32))
def cmd_info(args):
with open(args.file, 'rb') as f:
pack = PackHeader.from_bytes(f.read(len(PackHeader())))
with open(args.file, 'rb') as f:
pack = fbpack.PackHeader.from_bytes(f.read(len(fbpack.PackHeader())))
if pack.version != FBPACK_VERSION:
raise NotImplementedError('unsupported version {}'.format(pack.version))
if pack.version != fbpack.FBPACK_VERSION:
raise NotImplementedError('unsupported version {}'.format(pack.version))
print("Header:")
print_pack_header(pack)
print('Header:')
print_pack_header(pack)
print('\nEntries:')
for i in range(1, pack.total_entries + 1):
entry = PackEntry.from_bytes(f.read(len(PackEntry())))
print('Entry {}: {{'.format(i))
print_pack_entry(entry, ' ')
print('}')
print('\nEntries:')
for i in range(1, pack.total_entries + 1):
entry = fbpack.PackEntry.from_bytes(f.read(len(fbpack.PackEntry())))
print('Entry {}: {{'.format(i))
print_pack_entry(entry, ' ')
print('}')
def align_up(val, align):
return (val + align - 1) & ~(align - 1)
return (val + align - 1) & ~(align - 1)
def create_pack_file(file_name, in_dir_name, pack):
pack.total_entries = len(pack.entries)
offset = pack.header_size + pack.total_entries * pack.entry_header_size
with open(file_name, 'wb') as f:
# write entries data
for entry in pack.entries:
# align data
offset = align_up(offset, pack.data_align)
entry.offset = offset
f.seek(offset)
fin_name = os.path.join(in_dir_name, entry.filepath)
with open(fin_name, 'rb') as fin:
data = fin.read()
entry.size = len(data)
f.write(data)
offset += len(data)
pack.total_entries = len(pack.entries)
offset = pack.header_size + pack.total_entries * pack.entry_header_size
with open(file_name, 'wb') as f:
# write entries data
for entry in pack.entries:
# align data
offset = align_up(offset, pack.data_align)
entry.offset = offset
f.seek(offset)
fin_name = os.path.join(in_dir_name, entry.filepath)
with open(fin_name, 'rb') as fin:
data = fin.read()
entry.size = len(data)
f.write(data)
offset += len(data)
pack.total_size = offset
f.seek(0)
# write pack header
f.write(bytes(pack))
# iterate over entries again to write entry header
for entry in pack.entries:
f.write(bytes(entry))
pack.total_size = offset
f.seek(0)
# write pack header
f.write(bytes(pack))
# iterate over entries again to write entry header
for entry in pack.entries:
f.write(bytes(entry))
def cmd_create(args):
if args.file.lower().endswith('.xml'):
import xmlparser as parser
elif args.file.lower().endswith('.yaml'):
import yamlparser as parser
else:
raise NotImplementedError('{} type not supported'.format(args.file))
if not (args.file.lower().endswith('.xml') or
args.file.lower().endswith('.yaml')):
raise NotImplementedError('{} type not supported'.format(args.file))
pack = parser.parse(args.file)
pack.pack_version = bytes(str(args.pack_version).encode('ascii'))
pack.header_size = len(pack)
pack = None
if args.file.lower().endswith('.yaml'):
pack = yaml.parse(args.file)
else:
pack = XMLParser.parse(args.file)
pack.pack_version = bytes(str(args.pack_version).encode('ascii'))
pack.header_size = len(pack)
# create output directory if missing
if not os.path.isdir(args.out_dir):
os.makedirs(args.out_dir, 0o755)
# create output directory if missing
if not os.path.isdir(args.out_dir):
os.makedirs(args.out_dir, 0o755)
file_name = os.path.join(args.out_dir, pack.name + '.img')
file_name = os.path.join(args.out_dir, pack.name + '.img')
create_pack_file(file_name, args.in_dir, pack)
create_pack_file(file_name, args.in_dir, pack)
def product_match(products, product):
return product in products.split('|')
return product in products.split(b'|')
def copyfileobj(src, dst, file_size):
while file_size > 0:
buf = src.read(min(128 * 1024, file_size))
dst.write(buf)
file_size -= len(buf)
while file_size > 0:
buf = src.read(min(128 * 1024, file_size))
dst.write(buf)
file_size -= len(buf)
def cmd_unpack(args):
with open(args.file, 'rb') as f:
pack = PackHeader.from_bytes(f.read(len(PackHeader())))
with open(args.file, 'rb') as f:
pack = fbpack.PackHeader.from_bytes(f.read(len(fbpack.PackHeader())))
if pack.version != FBPACK_VERSION:
raise NotImplementedError('unsupported version {}'.format(pack.version))
if pack.version != fbpack.FBPACK_VERSION:
raise NotImplementedError('unsupported version {}'.format(pack.version))
entries = []
# create list of entries we want to extact
for _ in range(pack.total_entries):
entry = PackEntry.from_bytes(f.read(len(PackEntry())))
name = bytes_to_str(entry.name)
if not args.partitions or name in args.partitions:
# if both product are valid then match product name too
if not args.product or not entry.product or product_match(
entry.product, args.product):
entries.append(entry)
entries = []
# create list of entries we want to extact
for _ in range(pack.total_entries):
entry = fbpack.PackEntry.from_bytes(f.read(len(fbpack.PackEntry())))
name = bytes_to_str(entry.name)
if not args.partitions or name in args.partitions:
# if both product are valid then match product name too
if not args.product or not entry.product or product_match(
entry.product, args.product):
entries.append(entry)
if not entries and not args.unpack_ver:
raise RuntimeError('no images to unpack')
if not entries and not args.unpack_ver:
raise RuntimeError('no images to unpack')
# create output directory if it does not exists
if not os.path.isdir(args.out_dir):
os.makedirs(args.out_dir, 0o755)
# create output directory if it does not exist
if not os.path.isdir(args.out_dir):
os.makedirs(args.out_dir, 0o755)
out_files = {}
# write file per entry
for entry in entries:
name = bytes_to_str(entry.name)
logging.info(
'Unpacking {} (size: {}, offset: {})'.format(
name, entry.size, entry.offset))
f.seek(entry.offset)
entry_filename = os.path.join(args.out_dir, name + '.img')
instance = out_files.get(entry_filename, 0) + 1
out_files[entry_filename] = instance
if instance > 1:
entry_filename = os.path.join(args.out_dir, name + '({}).img'.format(instance - 1))
with open(entry_filename, 'wb') as entry_file:
copyfileobj(f, entry_file, entry.size)
out_files = {}
# write file per entry
for entry in entries:
name = bytes_to_str(entry.name)
logging.info('Unpacking {} (size: {}, offset: {})'.format(
name, entry.size, entry.offset))
f.seek(entry.offset)
entry_filename = os.path.join(args.out_dir, name + '.img')
instance = out_files.get(entry_filename, 0) + 1
out_files[entry_filename] = instance
if instance > 1:
entry_filename = os.path.join(args.out_dir,
name + '({}).img'.format(instance - 1))
with open(entry_filename, 'wb') as entry_file:
copyfileobj(f, entry_file, entry.size)
if args.unpack_ver:
ver_file_path = os.path.join(args.out_dir, 'version.txt')
with open(ver_file_path, 'w') as ver_file:
ver_file.write(bytes_to_str(pack.pack_version))
if args.unpack_ver:
ver_file_path = os.path.join(args.out_dir, 'version.txt')
with open(ver_file_path, 'w') as ver_file:
ver_file.write(bytes_to_str(pack.pack_version))
logging.info('Done')
logging.info('Done')
def parse_args():
parser = argparse.ArgumentParser(
description="Tool to create/modify/inspect fastboot packed images")
parser.add_argument("-v", "--verbosity", action="count", default=0,
help="increase output verbosity")
parser = argparse.ArgumentParser(
description='Tool to create/modify/inspect fastboot packed images')
parser.add_argument(
'-v',
'--verbosity',
action='count',
default=0,
help='increase output verbosity')
subparsers = parser.add_subparsers()
subparsers = parser.add_subparsers()
# info command
info = subparsers.add_parser('info')
info.add_argument('file', help="packed image file")
info.set_defaults(func=cmd_info)
# info command
info = subparsers.add_parser('info')
info.add_argument('file', help='packed image file')
info.set_defaults(func=cmd_info)
# create command
create = subparsers.add_parser('create')
create.add_argument('-d', '--in_dir', help='directory to search for data files', default='.')
create.add_argument(
'-o',
'--out_dir',
help='output directory for the packed image',
default='.')
create.add_argument('-v', '--pack_version', help='Packed image version ', default='')
create.add_argument('file', help="config file describing packed image (yaml/xml)")
create.set_defaults(func=cmd_create)
# create command
create = subparsers.add_parser('create')
create.add_argument(
'-d', '--in_dir', help='directory to search for data files', default='.')
create.add_argument(
'-o',
'--out_dir',
help='output directory for the packed image',
default='.')
create.add_argument(
'-v', '--pack_version', help='Packed image version ', default='')
create.add_argument(
'file', help='config file describing packed image (yaml/xml)')
create.set_defaults(func=cmd_create)
# unpack command
unpack = subparsers.add_parser('unpack')
unpack.add_argument('-o', '--out_dir', help='directory to store unpacked images', default='.')
unpack.add_argument('-p', '--product', help='filter images by product', default='')
unpack.add_argument('-v', '--unpack_ver', help='Unpack version to a file', action='store_true')
unpack.add_argument('file', help="packed image file")
unpack.add_argument('partitions', metavar='PART', type=str, nargs='*',
help='Partition names to extract (default all).')
unpack.set_defaults(func=cmd_unpack)
# unpack command
unpack = subparsers.add_parser('unpack')
unpack.add_argument(
'-o', '--out_dir', help='directory to store unpacked images', default='.')
unpack.add_argument(
'-p', '--product', help='filter images by product', default='')
unpack.add_argument(
'-v',
'--unpack_ver',
help='Unpack version to a file',
action='store_true')
unpack.add_argument('file', help='packed image file')
unpack.add_argument(
'partitions',
metavar='PART',
type=str,
nargs='*',
help='Partition names to extract (default all).')
unpack.set_defaults(func=cmd_unpack)
args = parser.parse_args()
# make sure a command was passed
if not hasattr(args, 'func'):
parser.print_usage()
print("fbpacktool.py: error: no command was passed")
sys.exit(2)
args = parser.parse_args()
# make sure a command was passed
if not hasattr(args, 'func'):
parser.print_usage()
print('fbpacktool.py: error: no command was passed')
sys.exit(2)
return args
return args
def main():
args = parse_args()
args = parse_args()
if args.verbosity >= 2:
log_level = logging.DEBUG
if args.verbosity >= 2:
log_level = logging.DEBUG
elif args.verbosity == 1:
log_level = logging.INFO
else:
log_level = logging.WARNING
elif args.verbosity == 1:
log_level = logging.INFO
else:
log_level = logging.WARNING
logging.basicConfig(level=log_level)
logging.basicConfig(level=log_level)
# execute command
args.func(args)
# execute command
args.func(args)
if __name__ == '__main__':
main()
main()

68
fbpacktool/packedstruct.py
View File

@ -12,50 +12,52 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
import collections
import struct
class PackedStruct(object):
"""Class representing a C style packed structure
"""Class representing a C style packed structure.
Derived classes need to provide a dictionary with key will be the attributes and the values are
the format characters for each field. e.g.
Derived classes need to provide a dictionary where the keys are the attributes
and the values are the format characters for each field. e.g.
class Foo(PackedStruct):
_FIELDS = {
x: 'I',
name: '64s',
}
class Foo(PackedStruct):
_FIELDS = {
x: 'I',
name: '64s',
}
In this case Foo.x will represent an "unsigned int" C value, while Foo.name will be a "char[64]"
C value
In this case Foo.x will represent an "unsigned int" C value, while Foo.name
will be a "char[64]" C value.
"""
_FIELDS: collections.OrderedDict
"""
def __init__(self, *args, **kwargs):
self._fmt = '<' + ''.join(fmt for fmt in self._FIELDS.values())
for name in self._FIELDS:
setattr(self, name, None)
def __init__(self, *args, **kwargs):
self._fmt = '<' + ''.join(fmt for fmt in self._FIELDS.values())
for name in self._FIELDS:
setattr(self, name, None)
for name, val in zip(self._FIELDS.keys(), args):
setattr(self, name, val)
for name, val in kwargs.items():
setattr(self, name, val)
for name, val in zip(self._FIELDS.keys(), args):
setattr(self, name, val)
for name, val in kwargs.items():
setattr(self, name, val)
def __repr__(self):
return '{} {{\n'.format(self.__class__.__name__) + ',\n'.join(
' {!r}: {!r}'.format(k, getattr(self, k))
for k in self._FIELDS) + '\n}'
def __repr__(self):
return '{} {{\n'.format(self.__class__.__name__) + ',\n'.join(
' {!r}: {!r}'.format(k, getattr(self, k)) for k in self._FIELDS) + '\n}'
def __str__(self):
return struct.pack(self._fmt, *(getattr(self, x) for x in self._FIELDS))
def __str__(self):
return struct.pack(self._fmt, *(getattr(self, x) for x in self._FIELDS))
def __bytes__(self):
return struct.pack(self._fmt, *(getattr(self, x) for x in self._FIELDS))
def __bytes__(self):
return struct.pack(self._fmt, *(getattr(self, x) for x in self._FIELDS))
def __len__(self):
return struct.calcsize(self._fmt)
def __len__(self):
return struct.calcsize(self._fmt)
@classmethod
def from_bytes(cls, data):
fmt_str = '<' + ''.join(fmt for fmt in cls._FIELDS.values())
return cls(*struct.unpack(fmt_str, data))
@classmethod
def from_bytes(cls, data):
fmt_str = '<' + ''.join(fmt for fmt in cls._FIELDS.values())
return cls(*struct.unpack(fmt_str, data))