1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2016 Google, Inc
3 # Written by Simon Glass <sjg@chromium.org>
5 # Entry-type module for Intel Management Engine binary blob
8 from collections import OrderedDict
10 from entry import Entry
11 from blob import Entry_blob
15 class Entry_intel_ifwi(Entry_blob):
16 """Entry containing an Intel Integrated Firmware Image (IFWI) file
18 Properties / Entry arguments:
19 - filename: Filename of file to read into entry. This is either the
20 IFWI file itself, or a file that can be converted into one using a
22 - convert-fit: If present this indicates that the ifwitool should be
23 used to convert the provided file into a IFWI.
25 This file contains code and data used by the SoC that is required to make
26 it work. It includes U-Boot TPL, microcode, things related to the CSE
27 (Converged Security Engine, the microcontroller that loads all the firmware)
28 and other items beyond the wit of man.
30 A typical filename is 'ifwi.bin' for an IFWI file, or 'fitimage.bin' for a
31 file that will be converted to an IFWI.
33 The position of this entry is generally set by the intel-descriptor entry.
35 The contents of the IFWI are specified by the subnodes of the IFWI node.
36 Each subnode describes an entry which is placed into the IFWFI with a given
37 sub-partition (and optional entry name).
39 Properties for subnodes:
40 ifwi-subpart - sub-parition to put this entry into, e.g. "IBBP"
41 ifwi-entry - entry name t use, e.g. "IBBL"
42 ifwi-replace - if present, indicates that the item should be replaced
43 in the IFWI. Otherwise it is added.
45 See README.x86 for information about x86 binary blobs.
47 def __init__(self, section, etype, node):
48 Entry_blob.__init__(self, section, etype, node)
49 self._convert_fit = fdt_util.GetBool(self._node, 'convert-fit')
50 self._ifwi_entries = OrderedDict()
53 def ObtainContents(self):
54 """Get the contects for the IFWI
56 Unfortunately we cannot create anything from scratch here, as Intel has
57 tools which create precursor binaries with lots of data and settings,
58 and these are not incorporated into binman.
60 The first step is to get a file in the IFWI format. This is either
61 supplied directly or is extracted from a fitimage using the 'create'
64 After that we delete the OBBP sub-partition and add each of the files
65 that we want in the IFWI file, one for each sub-entry of the IWFI node.
67 self._pathname = tools.GetInputFilename(self._filename)
69 # Create the IFWI file if needed
71 inname = self._pathname
72 outname = tools.GetOutputFilename('ifwi.bin')
73 tools.RunIfwiTool(inname, tools.CMD_CREATE, outname)
74 self._filename = 'ifwi.bin'
75 self._pathname = outname
77 # Provide a different code path here to ensure we have test coverage
78 outname = self._pathname
80 # Delete OBBP if it is there, then add the required new items.
81 tools.RunIfwiTool(outname, tools.CMD_DELETE, subpart='OBBP')
83 for entry in self._ifwi_entries.values():
84 # First get the input data and put it in a file
85 if not entry.ObtainContents():
87 data = entry.GetData()
88 uniq = self.GetUniqueName()
89 input_fname = tools.GetOutputFilename('input.%s' % uniq)
90 tools.WriteFile(input_fname, data)
92 tools.RunIfwiTool(outname,
93 tools.CMD_REPLACE if entry._ifwi_replace else tools.CMD_ADD,
94 input_fname, entry._ifwi_subpart, entry._ifwi_entry_name)
96 self.ReadBlobContents()
99 def _ReadSubnodes(self):
100 """Read the subnodes to find out what should go in this IFWI"""
101 for node in self._node.subnodes:
102 entry = Entry.Create(self.section, node)
104 entry._ifwi_replace = fdt_util.GetBool(node, 'ifwi-replace')
105 entry._ifwi_subpart = fdt_util.GetString(node, 'ifwi-subpart')
106 entry._ifwi_entry_name = fdt_util.GetString(node, 'ifwi-entry')
107 self._ifwi_entries[entry._ifwi_subpart] = entry