blob: 986d6f1a31542f67bd1bb1c809f7239479ce33c6 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
Simon Glassbf7fd502016-11-25 20:15:51 -07002# Copyright (c) 2016 Google, Inc
3# Written by Simon Glass <sjg@chromium.org>
4#
Simon Glassbf7fd502016-11-25 20:15:51 -07005
Simon Glass650e5de2021-11-23 11:03:41 -07006"""Command-line parser for binman"""
Simon Glassbf7fd502016-11-25 20:15:51 -07007
Simon Glassc475dec2021-11-23 11:03:42 -07008import argparse
Simon Glass53cd5d92019-07-08 14:25:29 -06009from argparse import ArgumentParser
Simon Glass8d2ef3e2022-02-11 13:23:21 -070010from binman import state
Simon Glassbf7fd502016-11-25 20:15:51 -070011
Simon Glass650e5de2021-11-23 11:03:41 -070012def make_extract_parser(subparsers):
13 """make_extract_parser: Make a subparser for the 'extract' command
14
15 Args:
16 subparsers (ArgumentParser): parser to add this one to
17 """
18 extract_parser = subparsers.add_parser('extract',
19 help='Extract files from an image')
Simon Glass943bf782021-11-23 21:09:50 -070020 extract_parser.add_argument('-F', '--format', type=str,
21 help='Select an alternative format for extracted data')
Simon Glass650e5de2021-11-23 11:03:41 -070022 extract_parser.add_argument('-i', '--image', type=str, required=True,
23 help='Image filename to extract')
24 extract_parser.add_argument('-f', '--filename', type=str,
25 help='Output filename to write to')
26 extract_parser.add_argument('-O', '--outdir', type=str, default='',
27 help='Path to directory to use for output files')
28 extract_parser.add_argument('paths', type=str, nargs='*',
29 help='Paths within file to extract (wildcard)')
30 extract_parser.add_argument('-U', '--uncompressed', action='store_true',
31 help='Output raw uncompressed data for compressed entries')
32
Simon Glassc475dec2021-11-23 11:03:42 -070033
34#pylint: disable=R0903
35class BinmanVersion(argparse.Action):
36 """Handles the -V option to binman
37
38 This reads the version information from a file called 'version' in the same
39 directory as this file.
40
41 If not present it assumes this is running from the U-Boot tree and collects
42 the version from the Makefile.
43
44 The format of the version information is three VAR = VALUE lines, for
45 example:
46
47 VERSION = 2022
48 PATCHLEVEL = 01
49 EXTRAVERSION = -rc2
50 """
51 def __init__(self, nargs=0, **kwargs):
52 super().__init__(nargs=nargs, **kwargs)
53
54 def __call__(self, parser, namespace, values, option_string=None):
55 parser._print_message(f'Binman {state.GetVersion()}\n')
56 parser.exit()
57
Simon Glassbf7fd502016-11-25 20:15:51 -070058
59def ParseArgs(argv):
60 """Parse the binman command-line arguments
61
62 Args:
Simon Glass650e5de2021-11-23 11:03:41 -070063 argv (list of str): List of string arguments
64
Simon Glassbf7fd502016-11-25 20:15:51 -070065 Returns:
Simon Glass650e5de2021-11-23 11:03:41 -070066 tuple: (options, args) with the command-line options and arugments.
Simon Glassbf7fd502016-11-25 20:15:51 -070067 options provides access to the options (e.g. option.debug)
68 args is a list of string arguments
69 """
Simon Glass53cd5d92019-07-08 14:25:29 -060070 if '-H' in argv:
71 argv.append('build')
72
73 epilog = '''Binman creates and manipulate images for a board from a set of binaries. Binman is
74controlled by a description in the board device tree.'''
75
76 parser = ArgumentParser(epilog=epilog)
77 parser.add_argument('-B', '--build-dir', type=str, default='b',
78 help='Directory containing the build output')
79 parser.add_argument('-D', '--debug', action='store_true',
80 help='Enabling debugging (provides a full traceback on error)')
81 parser.add_argument('-H', '--full-help', action='store_true',
Simon Glassbf7fd502016-11-25 20:15:51 -070082 default=False, help='Display the README file')
Simon Glass53cd5d92019-07-08 14:25:29 -060083 parser.add_argument('--toolpath', type=str, action='append',
84 help='Add a path to the directories containing tools')
Simon Glassc69d19c2021-07-06 10:36:37 -060085 parser.add_argument('-T', '--threads', type=int,
86 default=None, help='Number of threads to use (0=single-thread)')
87 parser.add_argument('--test-section-timeout', action='store_true',
88 help='Use a zero timeout for section multi-threading (for testing)')
Simon Glass53cd5d92019-07-08 14:25:29 -060089 parser.add_argument('-v', '--verbosity', default=1,
90 type=int, help='Control verbosity: 0=silent, 1=warnings, 2=notices, '
91 '3=info, 4=detail, 5=debug')
Simon Glassc475dec2021-11-23 11:03:42 -070092 parser.add_argument('-V', '--version', nargs=0, action=BinmanVersion)
Simon Glass53cd5d92019-07-08 14:25:29 -060093
94 subparsers = parser.add_subparsers(dest='cmd')
Simon Glass680e3c62020-10-26 17:40:02 -060095 subparsers.required = True
Simon Glass53cd5d92019-07-08 14:25:29 -060096
97 build_parser = subparsers.add_parser('build', help='Build firmware image')
98 build_parser.add_argument('-a', '--entry-arg', type=str, action='append',
99 help='Set argument value arg=value')
100 build_parser.add_argument('-b', '--board', type=str,
101 help='Board name to build')
102 build_parser.add_argument('-d', '--dt', type=str,
103 help='Configuration file (.dtb) to use')
104 build_parser.add_argument('--fake-dtb', action='store_true',
105 help='Use fake device tree contents (for testing only)')
Heiko Thierya89c8f22022-01-06 11:49:41 +0100106 build_parser.add_argument('--fake-ext-blobs', action='store_true',
107 help='Create fake ext blobs with dummy content (for testing only)')
Simon Glass4f9ee832022-01-09 20:14:09 -0700108 build_parser.add_argument('--force-missing-bintools', type=str,
109 help='Comma-separated list of bintools to consider missing (for testing)')
Simon Glass53cd5d92019-07-08 14:25:29 -0600110 build_parser.add_argument('-i', '--image', type=str, action='append',
111 help='Image filename to build (if not specified, build all)')
112 build_parser.add_argument('-I', '--indir', action='append',
113 help='Add a path to the list of directories to use for input files')
114 build_parser.add_argument('-m', '--map', action='store_true',
Simon Glass3b0c3822018-06-01 09:38:20 -0600115 default=False, help='Output a map file for each image')
Simon Glass4f9f1052020-07-09 18:39:38 -0600116 build_parser.add_argument('-M', '--allow-missing', action='store_true',
Simon Glassb38da152022-11-09 19:14:42 -0700117 default=False, help='Allow external blobs and bintools to be missing')
Simon Glass63aeaeb2021-03-18 20:25:05 +1300118 build_parser.add_argument('-n', '--no-expanded', action='store_true',
119 help="Don't use 'expanded' versions of entries where available; "
120 "normally 'u-boot' becomes 'u-boot-expanded', for example")
Simon Glass53cd5d92019-07-08 14:25:29 -0600121 build_parser.add_argument('-O', '--outdir', type=str,
Simon Glassbf7fd502016-11-25 20:15:51 -0700122 action='store', help='Path to directory to use for intermediate and '
123 'output files')
Simon Glass53cd5d92019-07-08 14:25:29 -0600124 build_parser.add_argument('-p', '--preserve', action='store_true',\
Simon Glassbf7fd502016-11-25 20:15:51 -0700125 help='Preserve temporary output directory even if option -O is not '
126 'given')
Simon Glass53cd5d92019-07-08 14:25:29 -0600127 build_parser.add_argument('-u', '--update-fdt', action='store_true',
Simon Glass3ab95982018-08-01 15:22:37 -0600128 default=False, help='Update the binman node with offset/size info')
Simon Glass0427bed2021-11-03 21:09:18 -0600129 build_parser.add_argument('--update-fdt-in-elf', type=str,
130 help='Update an ELF file with the output dtb: infile,outfile,begin_sym,end_sym')
Simon Glassb38da152022-11-09 19:14:42 -0700131 build_parser.add_argument(
132 '-W', '--ignore-missing', action='store_true', default=False,
133 help='Return success even if there are missing blobs/bintools (requires -M)')
Simon Glass53cd5d92019-07-08 14:25:29 -0600134
Simon Glass650e5de2021-11-23 11:03:41 -0700135 subparsers.add_parser(
Simon Glassbc570642022-01-09 20:14:11 -0700136 'bintool-docs', help='Write out bintool documentation (see bintool.rst)')
137
138 subparsers.add_parser(
Simon Glass650e5de2021-11-23 11:03:41 -0700139 'entry-docs', help='Write out entry documentation (see entries.rst)')
Simon Glass53cd5d92019-07-08 14:25:29 -0600140
Simon Glass61f564d2019-07-08 14:25:48 -0600141 list_parser = subparsers.add_parser('ls', help='List files in an image')
142 list_parser.add_argument('-i', '--image', type=str, required=True,
143 help='Image filename to list')
144 list_parser.add_argument('paths', type=str, nargs='*',
145 help='Paths within file to list (wildcard)')
146
Simon Glass650e5de2021-11-23 11:03:41 -0700147 make_extract_parser(subparsers)
Simon Glass71ce0ba2019-07-08 14:25:52 -0600148
Simon Glassa6cb9952019-07-20 12:24:15 -0600149 replace_parser = subparsers.add_parser('replace',
150 help='Replace entries in an image')
151 replace_parser.add_argument('-C', '--compressed', action='store_true',
152 help='Input data is already compressed if needed for the entry')
153 replace_parser.add_argument('-i', '--image', type=str, required=True,
Jan Kiszka89cc0522021-11-11 08:13:30 +0100154 help='Image filename to update')
Simon Glassa6cb9952019-07-20 12:24:15 -0600155 replace_parser.add_argument('-f', '--filename', type=str,
156 help='Input filename to read from')
157 replace_parser.add_argument('-F', '--fix-size', action='store_true',
158 help="Don't allow entries to be resized")
159 replace_parser.add_argument('-I', '--indir', type=str, default='',
160 help='Path to directory to use for input files')
161 replace_parser.add_argument('-m', '--map', action='store_true',
162 default=False, help='Output a map file for the updated image')
163 replace_parser.add_argument('paths', type=str, nargs='*',
Jan Kiszka89cc0522021-11-11 08:13:30 +0100164 help='Paths within file to replace (wildcard)')
Simon Glassa6cb9952019-07-20 12:24:15 -0600165
Simon Glass53cd5d92019-07-08 14:25:29 -0600166 test_parser = subparsers.add_parser('test', help='Run tests')
167 test_parser.add_argument('-P', '--processes', type=int,
168 help='set number of processes to use for running tests')
169 test_parser.add_argument('-T', '--test-coverage', action='store_true',
170 default=False, help='run tests and check for 100%% coverage')
171 test_parser.add_argument('-X', '--test-preserve-dirs', action='store_true',
Simon Glassd5164a72019-07-08 13:18:49 -0600172 help='Preserve and display test-created input directories; also '
173 'preserve the output directory if a single test is run (pass test '
174 'name at the end of the command line')
Simon Glass53cd5d92019-07-08 14:25:29 -0600175 test_parser.add_argument('tests', nargs='*',
176 help='Test names to run (omit for all)')
Simon Glassbf7fd502016-11-25 20:15:51 -0700177
Simon Glass386c63c2022-01-09 20:13:50 -0700178 tool_parser = subparsers.add_parser('tool', help='Check bintools')
179 tool_parser.add_argument('-l', '--list', action='store_true',
180 help='List all known bintools')
181 tool_parser.add_argument('-f', '--fetch', action='store_true',
182 help='fetch a bintool from a known location (or: all/missing)')
183 tool_parser.add_argument('bintools', type=str, nargs='*')
184
Simon Glassbf7fd502016-11-25 20:15:51 -0700185 return parser.parse_args(argv)