Format of bootloader-*.img
files found in factory images of certain Android devices from Huawei:
All image versions can be found in factory images at https://developers.google.com/android/images for the specific device. To avoid having to download an entire ZIP archive when you only need one file from it, install remotezip and use its command line tool to list members in the archive and then to download only the file you want.
This page hosts a formal specification of Huawei Bootloader packed image format using Kaitai Struct. This specification can be automatically translated into a variety of programming languages to get a parsing library.
All parsing code for Python generated by Kaitai Struct depends on the Python runtime library. You have to install it before you can parse data.
The Python runtime library can be installed from PyPI:
python3 -m pip install kaitaistruct
Parse a local file and get structure in memory:
data = AndroidBootldrHuawei.from_file("path/to/local/file.img")
Or parse structure from a bytes:
from kaitaistruct import KaitaiStream, BytesIO
raw = b"\x00\x01\x02..."
data = AndroidBootldrHuawei(KaitaiStream(BytesIO(raw)))
After that, one can get various attributes from the structure by invoking getter methods like:
data.meta_header # => get meta header
# This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild
import kaitaistruct
from kaitaistruct import KaitaiStruct, KaitaiStream, BytesIO
if getattr(kaitaistruct, 'API_VERSION', (0, 9)) < (0, 9):
raise Exception("Incompatible Kaitai Struct Python API: 0.9 or later is required, but you have %s" % (kaitaistruct.__version__))
class AndroidBootldrHuawei(KaitaiStruct):
"""Format of `bootloader-*.img` files found in factory images of certain Android devices from Huawei:
* Nexus 6P "angler": [sample][sample-angler] ([other samples][others-angler]),
[releasetools.py](https://android.googlesource.com/device/huawei/angler/+/cf92cd8/releasetools.py#29)
[sample-angler]: https://androidfilehost.com/?fid=11410963190603870158 "bootloader-angler-angler-03.84.img"
[others-angler]: https://androidfilehost.com/?w=search&s=bootloader-angler&type=files
All image versions can be found in factory images at
<https://developers.google.com/android/images> for the specific device. To
avoid having to download an entire ZIP archive when you only need one file
from it, install [remotezip](https://github.com/gtsystem/python-remotezip) and
use its [command line
tool](https://github.com/gtsystem/python-remotezip#command-line-tool) to list
members in the archive and then to download only the file you want.
.. seealso::
Source - https://android.googlesource.com/device/huawei/angler/+/673cfb9/releasetools.py
.. seealso::
Source - https://source.codeaurora.org/quic/la/device/qcom/common/tree/meta_image/meta_format.h?h=LA.UM.6.1.1&id=a68d284aee85
.. seealso::
Source - https://source.codeaurora.org/quic/la/device/qcom/common/tree/meta_image/meta_image.c?h=LA.UM.6.1.1&id=a68d284aee85
"""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.meta_header = AndroidBootldrHuawei.MetaHdr(self._io, self, self._root)
self.header_ext = self._io.read_bytes((self.meta_header.len_meta_header - 76))
self._raw_image_header = self._io.read_bytes(self.meta_header.len_image_header)
_io__raw_image_header = KaitaiStream(BytesIO(self._raw_image_header))
self.image_header = AndroidBootldrHuawei.ImageHdr(_io__raw_image_header, self, self._root)
class MetaHdr(KaitaiStruct):
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.magic = self._io.read_bytes(4)
if not self.magic == b"\x3C\xD6\x1A\xCE":
raise kaitaistruct.ValidationNotEqualError(b"\x3C\xD6\x1A\xCE", self.magic, self._io, u"/types/meta_hdr/seq/0")
self.version = AndroidBootldrHuawei.Version(self._io, self, self._root)
self.image_version = (KaitaiStream.bytes_terminate(self._io.read_bytes(64), 0, False)).decode(u"ASCII")
self.len_meta_header = self._io.read_u2le()
self.len_image_header = self._io.read_u2le()
class Version(KaitaiStruct):
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.major = self._io.read_u2le()
self.minor = self._io.read_u2le()
class ImageHdr(KaitaiStruct):
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.entries = []
i = 0
while not self._io.is_eof():
self.entries.append(AndroidBootldrHuawei.ImageHdrEntry(self._io, self, self._root))
i += 1
class ImageHdrEntry(KaitaiStruct):
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.name = (KaitaiStream.bytes_terminate(self._io.read_bytes(72), 0, False)).decode(u"ASCII")
self.ofs_body = self._io.read_u4le()
self.len_body = self._io.read_u4le()
@property
def is_used(self):
"""
.. seealso::
Source - https://source.codeaurora.org/quic/la/device/qcom/common/tree/meta_image/meta_image.c?h=LA.UM.6.1.1&id=a68d284aee85#n119
"""
if hasattr(self, '_m_is_used'):
return self._m_is_used
self._m_is_used = ((self.ofs_body != 0) and (self.len_body != 0))
return getattr(self, '_m_is_used', None)
@property
def body(self):
if hasattr(self, '_m_body'):
return self._m_body
if self.is_used:
io = self._root._io
_pos = io.pos()
io.seek(self.ofs_body)
self._m_body = io.read_bytes(self.len_body)
io.seek(_pos)
return getattr(self, '_m_body', None)