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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
# Copyright 2020 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.
"""Types which provide many builds and composite them into a single binary."""
import logging
import shutil
import subprocess
import zmake.build_config as build_config
import zmake.multiproc
import zmake.util as util
class BasePacker:
"""Abstract base for all packers."""
def __init__(self, project):
self.project = project
def configs(self):
"""Get all of the build configurations necessary.
Yields:
2-tuples of config name and a BuildConfig.
"""
yield 'singleimage', build_config.BuildConfig()
def pack_firmware(self, work_dir, jobclient, version_string=""):
"""Pack a firmware image.
Config names from the configs generator are passed as keyword
arguments, with each argument being set to the path of the
build directory.
Args:
work_dir: A directory to write outputs and temporary files
into.
jobclient: A JobClient object to use.
version_string: The version string, which may end up in
certain parts of the outputs.
Yields:
2-tuples of the path of each file in the work_dir (or any
other directory) which should be copied into the output
directory, and the output filename.
"""
raise NotImplementedError('Abstract method not implemented')
class ElfPacker(BasePacker):
"""Raw proxy for ELF output of a single build."""
def pack_firmware(self, work_dir, jobclient, singleimage,
version_string=""):
yield singleimage / 'zephyr' / 'zephyr.elf', 'zephyr.elf'
class RawBinPacker(BasePacker):
"""Raw proxy for zephyr.bin output of a single build."""
def pack_firmware(self, work_dir, jobclient, singleimage,
version_string=""):
yield singleimage / 'zephyr' / 'zephyr.bin', 'zephyr.bin'
class NpcxPacker(BasePacker):
"""Packer for RO/RW image to generate a .bin build using FMAP.
This expects that the build is setup to generate a
zephyr.packed.bin for the RO image, which should be packed using
Nuvoton's loader format.
"""
def __init__(self, project):
self.logger = logging.getLogger(self.__class__.__name__)
super().__init__(project)
def configs(self):
yield 'ro', build_config.BuildConfig(kconfig_defs={'CONFIG_CROS_EC_RO': 'y'})
yield 'rw', build_config.BuildConfig(kconfig_defs={'CONFIG_CROS_EC_RW': 'y'})
def pack_firmware(self, work_dir, jobclient, ro, rw, version_string=""):
"""Pack RO and RW sections using Binman.
Binman configuration is expected to be found in the RO build
device-tree configuration.
Args:
work_dir: The directory used for packing.
jobclient: The client used to run subprocesses.
ro: Directory containing the RO image build.
rw: Directory containing the RW image build.
version_string: The version string to use in FRID/FWID.
Yields:
2-tuples of the path of each file in the work_dir that
should be copied into the output directory, and the output
filename.
"""
dts_file_path = ro / 'zephyr' / 'zephyr.dts'
# Copy the inputs into the work directory so that Binman can
# find them under a hard-coded name.
shutil.copy2(ro / 'zephyr' / 'zephyr.packed.bin',
work_dir / 'zephyr_ro.bin')
shutil.copy2(rw / 'zephyr' / 'zephyr.bin', work_dir / 'zephyr_rw.bin')
# Version in FRID/FWID can be at most 31 bytes long (32, minus
# one for null character).
if len(version_string) > 31:
version_string = version_string[:31]
proc = jobclient.popen(
['binman', '-v', '5', 'build',
'-a', 'version={}'.format(version_string),
'-d', dts_file_path, '-m', '-O', work_dir],
cwd=work_dir,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
encoding='utf-8')
zmake.multiproc.log_output(self.logger, logging.DEBUG, proc.stdout)
zmake.multiproc.log_output(self.logger, logging.ERROR, proc.stderr)
if proc.wait(timeout=60):
raise OSError('Failed to run binman')
yield work_dir / 'zephyr.bin', 'zephyr.bin'
yield ro / 'zephyr' / 'zephyr.elf', 'zephyr.ro.elf'
yield rw / 'zephyr' / 'zephyr.elf', 'zephyr.rw.elf'
# A dictionary mapping packer config names to classes.
packer_registry = {
'elf': ElfPacker,
'npcx': NpcxPacker,
'raw': RawBinPacker,
}
|
