blob: bc8ed8e37ae54742508f5871bbe63ea468b95dd4 [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# Creates binary images from input files controlled by a description
6#
7
8from collections import OrderedDict
9import os
10import sys
11import tools
12
13import command
Simon Glass7fe91732017-11-13 18:55:00 -070014import elf
Simon Glass99ed4a22017-05-27 07:38:30 -060015import fdt
Simon Glassbf7fd502016-11-25 20:15:51 -070016import fdt_util
17from image import Image
18import tout
19
20# List of images we plan to create
21# Make this global so that it can be referenced from tests
22images = OrderedDict()
23
24def _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
Simon Glassec3f3782017-05-27 07:38:29 -060043def _FindBinmanNode(dtb):
Simon Glassbf7fd502016-11-25 20:15:51 -070044 """Find the 'binman' node in the device tree
45
46 Args:
Simon Glassec3f3782017-05-27 07:38:29 -060047 dtb: Fdt object to scan
Simon Glassbf7fd502016-11-25 20:15:51 -070048 Returns:
49 Node object of /binman node, or None if not found
50 """
Simon Glassec3f3782017-05-27 07:38:29 -060051 for node in dtb.GetRoot().subnodes:
Simon Glassbf7fd502016-11-25 20:15:51 -070052 if node.name == 'binman':
53 return node
54 return None
55
56def 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)
Simon Glass19790632017-11-13 18:55:01 -070092 elf.debug = options.debug
Simon Glassbf7fd502016-11-25 20:15:51 -070093 try:
94 tools.SetInputDirs(options.indir)
95 tools.PrepareOutputDir(options.outdir, options.preserve)
Simon Glassec3f3782017-05-27 07:38:29 -060096 dtb = fdt.FdtScan(dtb_fname)
97 node = _FindBinmanNode(dtb)
Simon Glassbf7fd502016-11-25 20:15:51 -070098 if not node:
99 raise ValueError("Device tree '%s' does not have a 'binman' "
100 "node" % dtb_fname)
101 images = _ReadImageDesc(node)
102 for image in images.values():
103 # Perform all steps for this image, including checking and
104 # writing it. This means that errors found with a later
105 # image will be reported after earlier images are already
106 # completed and written, but that does not seem important.
107 image.GetEntryContents()
108 image.GetEntryPositions()
109 image.PackEntries()
110 image.CheckSize()
111 image.CheckEntries()
112 image.ProcessEntryContents()
Simon Glass19790632017-11-13 18:55:01 -0700113 image.WriteSymbols()
Simon Glassbf7fd502016-11-25 20:15:51 -0700114 image.BuildImage()
115 finally:
116 tools.FinaliseOutputDir()
117 finally:
118 tout.Uninit()
119
120 return 0