tools/binman/cmdline.py

   1 # SPDX-License-Identifier: GPL-2.0+
   2 # Copyright (c) 2016 Google, Inc
   3 # Written by Simon Glass <sjg@chromium.org>
   4 #
   5
   6 """Command-line parser for binman"""
   7
   8 import argparse
   9 from argparse import ArgumentParser
  10 import state
  11
  12 def 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')
  20     extract_parser.add_argument('-F', '--format', type=str,
  21         help='Select an alternative format for extracted data')
  22     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
  33
  34 #pylint: disable=R0903
  35 class 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
  58
  59 def ParseArgs(argv):
  60     """Parse the binman command-line arguments
  61
  62     Args:
  63         argv (list of str): List of string arguments
  64
  65     Returns:
  66         tuple: (options, args) with the command-line options and arugments.
  67             options provides access to the options (e.g. option.debug)
  68             args is a list of string arguments
  69     """
  70     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
  74 controlled 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',
  82         default=False, help='Display the README file')
  83     parser.add_argument('--toolpath', type=str, action='append',
  84         help='Add a path to the directories containing tools')
  85     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)')
  89     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')
  92     parser.add_argument('-V', '--version', nargs=0, action=BinmanVersion)
  93
  94     subparsers = parser.add_subparsers(dest='cmd')
  95     subparsers.required = True
  96
  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)')
 106     build_parser.add_argument('--fake-ext-blobs', action='store_true',
 107             help='Create fake ext blobs with dummy content (for testing only)')
 108     build_parser.add_argument('--force-missing-bintools', type=str,
 109             help='Comma-separated list of bintools to consider missing (for testing)')
 110     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',
 115         default=False, help='Output a map file for each image')
 116     build_parser.add_argument('-M', '--allow-missing', action='store_true',
 117         default=False, help='Allow external blobs to be missing')
 118     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")
 121     build_parser.add_argument('-O', '--outdir', type=str,
 122         action='store', help='Path to directory to use for intermediate and '
 123         'output files')
 124     build_parser.add_argument('-p', '--preserve', action='store_true',\
 125         help='Preserve temporary output directory even if option -O is not '
 126              'given')
 127     build_parser.add_argument('-u', '--update-fdt', action='store_true',
 128         default=False, help='Update the binman node with offset/size info')
 129     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')
 131
 132     subparsers.add_parser(
 133         'bintool-docs', help='Write out bintool documentation (see bintool.rst)')
 134
 135     subparsers.add_parser(
 136         'entry-docs', help='Write out entry documentation (see entries.rst)')
 137
 138     list_parser = subparsers.add_parser('ls', help='List files in an image')
 139     list_parser.add_argument('-i', '--image', type=str, required=True,
 140                              help='Image filename to list')
 141     list_parser.add_argument('paths', type=str, nargs='*',
 142                              help='Paths within file to list (wildcard)')
 143
 144     make_extract_parser(subparsers)
 145
 146     replace_parser = subparsers.add_parser('replace',
 147                                            help='Replace entries in an image')
 148     replace_parser.add_argument('-C', '--compressed', action='store_true',
 149         help='Input data is already compressed if needed for the entry')
 150     replace_parser.add_argument('-i', '--image', type=str, required=True,
 151                                 help='Image filename to update')
 152     replace_parser.add_argument('-f', '--filename', type=str,
 153                                 help='Input filename to read from')
 154     replace_parser.add_argument('-F', '--fix-size', action='store_true',
 155         help="Don't allow entries to be resized")
 156     replace_parser.add_argument('-I', '--indir', type=str, default='',
 157         help='Path to directory to use for input files')
 158     replace_parser.add_argument('-m', '--map', action='store_true',
 159         default=False, help='Output a map file for the updated image')
 160     replace_parser.add_argument('paths', type=str, nargs='*',
 161                                 help='Paths within file to replace (wildcard)')
 162
 163     test_parser = subparsers.add_parser('test', help='Run tests')
 164     test_parser.add_argument('-P', '--processes', type=int,
 165         help='set number of processes to use for running tests')
 166     test_parser.add_argument('-T', '--test-coverage', action='store_true',
 167         default=False, help='run tests and check for 100%% coverage')
 168     test_parser.add_argument('-X', '--test-preserve-dirs', action='store_true',
 169         help='Preserve and display test-created input directories; also '
 170              'preserve the output directory if a single test is run (pass test '
 171              'name at the end of the command line')
 172     test_parser.add_argument('tests', nargs='*',
 173                              help='Test names to run (omit for all)')
 174
 175     tool_parser = subparsers.add_parser('tool', help='Check bintools')
 176     tool_parser.add_argument('-l', '--list', action='store_true',
 177                              help='List all known bintools')
 178     tool_parser.add_argument('-f', '--fetch', action='store_true',
 179                              help='fetch a bintool from a known location (or: all/missing)')
 180     tool_parser.add_argument('bintools', type=str, nargs='*')
 181
 182     return parser.parse_args(argv)