1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-"
# Copyright 2019 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
#
# Ignore indention messages, since legacy scripts use 2 spaces instead of 4.
# pylint: disable=bad-indentation,docstring-section-indent
# pylint: disable=docstring-trailing-quotes
# A script to pack EC binary with manifest header according to
# Based on 607297_Host_ISH_Firmware_Load_Chrome_OS_SAS_Rev0p5.pdf,
# https://chrome-internal.googlesource.com/chromeos/intel-ish/+/refs/heads/upstream/master/modules/api/ish_api/include/loader_common.h#211,
# and b/124788278#comment10
"""Script to pack EC binary with manifest header.
Package ecos main FW binary (kernel) and AON task binary into final EC binary
image with a manifest header, ISH shim loader will parse this header and load
each binaries into right memory location.
"""
import argparse
import struct
MANIFEST_ENTRY_SIZE = 0x80
HEADER_SIZE = 0x1000
PAGE_SIZE = 0x1000
def parseargs():
parser = argparse.ArgumentParser()
parser.add_argument("-k", "--kernel",
help="EC kernel binary to pack, \
usually ec.RW.bin or ec.RW.flat.",
required=True)
parser.add_argument("--kernel-size", type=int,
help="Size of EC kernel image",
required=True)
parser.add_argument("-a", "--aon",
help="EC aontask binary to pack, \
usually ish_aontask.bin.",
required=False)
parser.add_argument("--aon-size", type=int,
help="Size of EC aontask image",
required=False)
parser.add_argument("-o", "--output",
help="Output flash binary file")
return parser.parse_args()
def gen_manifest(ext_id, comp_app_name, code_offset, module_size):
"""Returns a binary blob that represents a manifest entry"""
m = bytearray(MANIFEST_ENTRY_SIZE)
# 4 bytes of ASCII encode ID (little endian)
struct.pack_into('<4s', m, 0, ext_id)
# 8 bytes of ASCII encode ID (little endian)
struct.pack_into('<8s', m, 32, comp_app_name)
# 4 bytes of code offset (little endian)
struct.pack_into('<I', m, 96, code_offset)
# 2 bytes of module in page size increments (little endian)
struct.pack_into('<H', m, 100, module_size)
return m
def roundup_page(size):
"""Returns roundup-ed page size from size of bytes"""
return int(size / PAGE_SIZE) + (size % PAGE_SIZE > 0)
def main():
args = parseargs()
print(" Packing EC image file for ISH")
with open(args.output, 'wb') as f:
print(" kernel binary size:", args.kernel_size)
kern_rdup_pg_size = roundup_page(args.kernel_size)
# Add manifest for main ISH binary
f.write(gen_manifest(b'ISHM', b'ISH_KERN', HEADER_SIZE, kern_rdup_pg_size))
if args.aon is not None:
print(" AON binary size: ", args.aon_size)
aon_rdup_pg_size = roundup_page(args.aon_size)
# Add manifest for aontask binary
f.write(gen_manifest(b'ISHM', b'AON_TASK',
(HEADER_SIZE + kern_rdup_pg_size * PAGE_SIZE -
MANIFEST_ENTRY_SIZE), aon_rdup_pg_size))
# Add manifest that signals end of manifests
f.write(gen_manifest(b'ISHE', b'', 0, 0))
# Pad the remaining HEADER with 0s
if args.aon is not None:
f.write(b'\x00' * (HEADER_SIZE - (MANIFEST_ENTRY_SIZE * 3)))
else:
f.write(b'\x00' * (HEADER_SIZE - (MANIFEST_ENTRY_SIZE * 2)))
# Append original kernel image
with open(args.kernel, 'rb') as in_file:
f.write(in_file.read())
# Filling padings due to size round up as pages
f.write(b'\x00' * (kern_rdup_pg_size * PAGE_SIZE - args.kernel_size))
if args.aon is not None:
# Append original aon image
with open(args.aon, 'rb') as in_file:
f.write(in_file.read())
# Filling padings due to size round up as pages
f.write(b'\x00' * (aon_rdup_pg_size * PAGE_SIZE - args.aon_size))
if __name__ == '__main__':
main()
|
