blob: 508232eabb5afde5a5c25abbe682689c5e6e0015 [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# Command-line parser for binman
6#
7
Simon Glass53cd5d92019-07-08 14:25:29 -06008from argparse import ArgumentParser
Simon Glassbf7fd502016-11-25 20:15:51 -07009
10def ParseArgs(argv):
11 """Parse the binman command-line arguments
12
13 Args:
14 argv: List of string arguments
15 Returns:
16 Tuple (options, args) with the command-line options and arugments.
17 options provides access to the options (e.g. option.debug)
18 args is a list of string arguments
19 """
Simon Glass53cd5d92019-07-08 14:25:29 -060020 if '-H' in argv:
21 argv.append('build')
22
23 epilog = '''Binman creates and manipulate images for a board from a set of binaries. Binman is
24controlled by a description in the board device tree.'''
25
26 parser = ArgumentParser(epilog=epilog)
27 parser.add_argument('-B', '--build-dir', type=str, default='b',
28 help='Directory containing the build output')
29 parser.add_argument('-D', '--debug', action='store_true',
30 help='Enabling debugging (provides a full traceback on error)')
31 parser.add_argument('-H', '--full-help', action='store_true',
Simon Glassbf7fd502016-11-25 20:15:51 -070032 default=False, help='Display the README file')
Simon Glass53cd5d92019-07-08 14:25:29 -060033 parser.add_argument('--toolpath', type=str, action='append',
34 help='Add a path to the directories containing tools')
35 parser.add_argument('-v', '--verbosity', default=1,
36 type=int, help='Control verbosity: 0=silent, 1=warnings, 2=notices, '
37 '3=info, 4=detail, 5=debug')
38
39 subparsers = parser.add_subparsers(dest='cmd')
40
41 build_parser = subparsers.add_parser('build', help='Build firmware image')
42 build_parser.add_argument('-a', '--entry-arg', type=str, action='append',
43 help='Set argument value arg=value')
44 build_parser.add_argument('-b', '--board', type=str,
45 help='Board name to build')
46 build_parser.add_argument('-d', '--dt', type=str,
47 help='Configuration file (.dtb) to use')
48 build_parser.add_argument('--fake-dtb', action='store_true',
49 help='Use fake device tree contents (for testing only)')
50 build_parser.add_argument('-i', '--image', type=str, action='append',
51 help='Image filename to build (if not specified, build all)')
52 build_parser.add_argument('-I', '--indir', action='append',
53 help='Add a path to the list of directories to use for input files')
54 build_parser.add_argument('-m', '--map', action='store_true',
Simon Glass3b0c3822018-06-01 09:38:20 -060055 default=False, help='Output a map file for each image')
Simon Glass53cd5d92019-07-08 14:25:29 -060056 build_parser.add_argument('-O', '--outdir', type=str,
Simon Glassbf7fd502016-11-25 20:15:51 -070057 action='store', help='Path to directory to use for intermediate and '
58 'output files')
Simon Glass53cd5d92019-07-08 14:25:29 -060059 build_parser.add_argument('-p', '--preserve', action='store_true',\
Simon Glassbf7fd502016-11-25 20:15:51 -070060 help='Preserve temporary output directory even if option -O is not '
61 'given')
Simon Glass53cd5d92019-07-08 14:25:29 -060062 build_parser.add_argument('-u', '--update-fdt', action='store_true',
Simon Glass3ab95982018-08-01 15:22:37 -060063 default=False, help='Update the binman node with offset/size info')
Simon Glass53cd5d92019-07-08 14:25:29 -060064
65 entry_parser = subparsers.add_parser('entry-docs',
66 help='Write out entry documentation (see README.entries)')
67
Simon Glass61f564d2019-07-08 14:25:48 -060068 list_parser = subparsers.add_parser('ls', help='List files in an image')
69 list_parser.add_argument('-i', '--image', type=str, required=True,
70 help='Image filename to list')
71 list_parser.add_argument('paths', type=str, nargs='*',
72 help='Paths within file to list (wildcard)')
73
Simon Glass53cd5d92019-07-08 14:25:29 -060074 test_parser = subparsers.add_parser('test', help='Run tests')
75 test_parser.add_argument('-P', '--processes', type=int,
76 help='set number of processes to use for running tests')
77 test_parser.add_argument('-T', '--test-coverage', action='store_true',
78 default=False, help='run tests and check for 100%% coverage')
79 test_parser.add_argument('-X', '--test-preserve-dirs', action='store_true',
Simon Glassd5164a72019-07-08 13:18:49 -060080 help='Preserve and display test-created input directories; also '
81 'preserve the output directory if a single test is run (pass test '
82 'name at the end of the command line')
Simon Glass53cd5d92019-07-08 14:25:29 -060083 test_parser.add_argument('tests', nargs='*',
84 help='Test names to run (omit for all)')
Simon Glassbf7fd502016-11-25 20:15:51 -070085
86 return parser.parse_args(argv)