cmdline.py 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. # SPDX-License-Identifier: GPL-2.0+
  2. # Copyright (c) 2016 Google, Inc
  3. # Written by Simon Glass <sjg@chromium.org>
  4. #
  5. # Command-line parser for binman
  6. #
  7. from argparse import ArgumentParser
  8. def ParseArgs(argv):
  9. """Parse the binman command-line arguments
  10. Args:
  11. argv: List of string arguments
  12. Returns:
  13. Tuple (options, args) with the command-line options and arugments.
  14. options provides access to the options (e.g. option.debug)
  15. args is a list of string arguments
  16. """
  17. if '-H' in argv:
  18. argv.append('build')
  19. epilog = '''Binman creates and manipulate images for a board from a set of binaries. Binman is
  20. controlled by a description in the board device tree.'''
  21. parser = ArgumentParser(epilog=epilog)
  22. parser.add_argument('-B', '--build-dir', type=str, default='b',
  23. help='Directory containing the build output')
  24. parser.add_argument('-D', '--debug', action='store_true',
  25. help='Enabling debugging (provides a full traceback on error)')
  26. parser.add_argument('-H', '--full-help', action='store_true',
  27. default=False, help='Display the README file')
  28. parser.add_argument('--toolpath', type=str, action='append',
  29. help='Add a path to the directories containing tools')
  30. parser.add_argument('-v', '--verbosity', default=1,
  31. type=int, help='Control verbosity: 0=silent, 1=warnings, 2=notices, '
  32. '3=info, 4=detail, 5=debug')
  33. subparsers = parser.add_subparsers(dest='cmd')
  34. build_parser = subparsers.add_parser('build', help='Build firmware image')
  35. build_parser.add_argument('-a', '--entry-arg', type=str, action='append',
  36. help='Set argument value arg=value')
  37. build_parser.add_argument('-b', '--board', type=str,
  38. help='Board name to build')
  39. build_parser.add_argument('-d', '--dt', type=str,
  40. help='Configuration file (.dtb) to use')
  41. build_parser.add_argument('--fake-dtb', action='store_true',
  42. help='Use fake device tree contents (for testing only)')
  43. build_parser.add_argument('-i', '--image', type=str, action='append',
  44. help='Image filename to build (if not specified, build all)')
  45. build_parser.add_argument('-I', '--indir', action='append',
  46. help='Add a path to the list of directories to use for input files')
  47. build_parser.add_argument('-m', '--map', action='store_true',
  48. default=False, help='Output a map file for each image')
  49. build_parser.add_argument('-O', '--outdir', type=str,
  50. action='store', help='Path to directory to use for intermediate and '
  51. 'output files')
  52. build_parser.add_argument('-p', '--preserve', action='store_true',\
  53. help='Preserve temporary output directory even if option -O is not '
  54. 'given')
  55. build_parser.add_argument('-u', '--update-fdt', action='store_true',
  56. default=False, help='Update the binman node with offset/size info')
  57. entry_parser = subparsers.add_parser('entry-docs',
  58. help='Write out entry documentation (see README.entries)')
  59. list_parser = subparsers.add_parser('ls', help='List files in an image')
  60. list_parser.add_argument('-i', '--image', type=str, required=True,
  61. help='Image filename to list')
  62. list_parser.add_argument('paths', type=str, nargs='*',
  63. help='Paths within file to list (wildcard)')
  64. extract_parser = subparsers.add_parser('extract',
  65. help='Extract files from an image')
  66. extract_parser.add_argument('-i', '--image', type=str, required=True,
  67. help='Image filename to extract')
  68. extract_parser.add_argument('-f', '--filename', type=str,
  69. help='Output filename to write to')
  70. extract_parser.add_argument('-O', '--outdir', type=str, default='',
  71. help='Path to directory to use for output files')
  72. extract_parser.add_argument('paths', type=str, nargs='*',
  73. help='Paths within file to extract (wildcard)')
  74. extract_parser.add_argument('-U', '--uncompressed', action='store_true',
  75. help='Output raw uncompressed data for compressed entries')
  76. replace_parser = subparsers.add_parser('replace',
  77. help='Replace entries in an image')
  78. replace_parser.add_argument('-C', '--compressed', action='store_true',
  79. help='Input data is already compressed if needed for the entry')
  80. replace_parser.add_argument('-i', '--image', type=str, required=True,
  81. help='Image filename to extract')
  82. replace_parser.add_argument('-f', '--filename', type=str,
  83. help='Input filename to read from')
  84. replace_parser.add_argument('-F', '--fix-size', action='store_true',
  85. help="Don't allow entries to be resized")
  86. replace_parser.add_argument('-I', '--indir', type=str, default='',
  87. help='Path to directory to use for input files')
  88. replace_parser.add_argument('-m', '--map', action='store_true',
  89. default=False, help='Output a map file for the updated image')
  90. replace_parser.add_argument('paths', type=str, nargs='*',
  91. help='Paths within file to extract (wildcard)')
  92. test_parser = subparsers.add_parser('test', help='Run tests')
  93. test_parser.add_argument('-P', '--processes', type=int,
  94. help='set number of processes to use for running tests')
  95. test_parser.add_argument('-T', '--test-coverage', action='store_true',
  96. default=False, help='run tests and check for 100%% coverage')
  97. test_parser.add_argument('-X', '--test-preserve-dirs', action='store_true',
  98. help='Preserve and display test-created input directories; also '
  99. 'preserve the output directory if a single test is run (pass test '
  100. 'name at the end of the command line')
  101. test_parser.add_argument('tests', nargs='*',
  102. help='Test names to run (omit for all)')
  103. return parser.parse_args(argv)