tools/binman/control.py

   1 # Copyright (c) 2016 Google, Inc
   2 # Written by Simon Glass <sjg@chromium.org>
   3 #
   4 # SPDX-License-Identifier:      GPL-2.0+
   5 #
   6 # Creates binary images from input files controlled by a description
   7 #
   8
   9 from collections import OrderedDict
  10 import os
  11 import sys
  12 import tools
  13
  14 import command
  15 import fdt_select
  16 import fdt_util
  17 from image import Image
  18 import tout
  19
  20 # List of images we plan to create
  21 # Make this global so that it can be referenced from tests
  22 images = OrderedDict()
  23
  24 def _ReadImageDesc(binman_node):
  25     """Read the image descriptions from the /binman node
  26
  27     This normally produces a single Image object called 'image'. But if
  28     multiple images are present, they will all be returned.
  29
  30     Args:
  31         binman_node: Node object of the /binman node
  32     Returns:
  33         OrderedDict of Image objects, each of which describes an image
  34     """
  35     images = OrderedDict()
  36     if 'multiple-images' in binman_node.props:
  37         for node in binman_node.subnodes:
  38             images[node.name] = Image(node.name, node)
  39     else:
  40         images['image'] = Image('image', binman_node)
  41     return images
  42
  43 def _FindBinmanNode(dtb):
  44     """Find the 'binman' node in the device tree
  45
  46     Args:
  47         dtb: Fdt object to scan
  48     Returns:
  49         Node object of /binman node, or None if not found
  50     """
  51     for node in dtb.GetRoot().subnodes:
  52         if node.name == 'binman':
  53             return node
  54     return None
  55
  56 def Binman(options, args):
  57     """The main control code for binman
  58
  59     This assumes that help and test options have already been dealt with. It
  60     deals with the core task of building images.
  61
  62     Args:
  63         options: Command line options object
  64         args: Command line arguments (list of strings)
  65     """
  66     global images
  67
  68     if options.full_help:
  69         pager = os.getenv('PAGER')
  70         if not pager:
  71             pager = 'more'
  72         fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
  73                             'README')
  74         command.Run(pager, fname)
  75         return 0
  76
  77     # Try to figure out which device tree contains our image description
  78     if options.dt:
  79         dtb_fname = options.dt
  80     else:
  81         board = options.board
  82         if not board:
  83             raise ValueError('Must provide a board to process (use -b <board>)')
  84         board_pathname = os.path.join(options.build_dir, board)
  85         dtb_fname = os.path.join(board_pathname, 'u-boot.dtb')
  86         if not options.indir:
  87             options.indir = ['.']
  88         options.indir.append(board_pathname)
  89
  90     try:
  91         tout.Init(options.verbosity)
  92         try:
  93             tools.SetInputDirs(options.indir)
  94             tools.PrepareOutputDir(options.outdir, options.preserve)
  95             dtb = fdt.FdtScan(dtb_fname)
  96             node = _FindBinmanNode(dtb)
  97             if not node:
  98                 raise ValueError("Device tree '%s' does not have a 'binman' "
  99                                  "node" % dtb_fname)
 100             images = _ReadImageDesc(node)
 101             for image in images.values():
 102                 # Perform all steps for this image, including checking and
 103                 # writing it. This means that errors found with a later
 104                 # image will be reported after earlier images are already
 105                 # completed and written, but that does not seem important.
 106                 image.GetEntryContents()
 107                 image.GetEntryPositions()
 108                 image.PackEntries()
 109                 image.CheckSize()
 110                 image.CheckEntries()
 111                 image.ProcessEntryContents()
 112                 image.BuildImage()
 113         finally:
 114             tools.FinaliseOutputDir()
 115     finally:
 116         tout.Uninit()
 117
 118     return 0