ftest.py 75.7 KB
Newer Older
1
# SPDX-License-Identifier: GPL-2.0+
2 3 4 5 6 7 8
# Copyright (c) 2016 Google, Inc
# Written by Simon Glass <sjg@chromium.org>
#
# To run a single test, change to this directory, and:
#
#    python -m unittest func_test.TestFunctional.testHelp

9 10
from __future__ import print_function

S
Simon Glass 已提交
11
import hashlib
12 13 14 15 16 17 18 19 20 21 22 23
from optparse import OptionParser
import os
import shutil
import struct
import sys
import tempfile
import unittest

import binman
import cmdline
import command
import control
24
import elf
S
Simon Glass 已提交
25
import fdt
26
import fdt_util
27
import fmap_util
28
import test_util
29
import state
30 31 32 33
import tools
import tout

# Contents of test files, corresponding to different entry types
S
Simon Glass 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
U_BOOT_DATA           = b'1234'
U_BOOT_IMG_DATA       = b'img'
U_BOOT_SPL_DATA       = b'56780123456789abcde'
U_BOOT_TPL_DATA       = b'tpl'
BLOB_DATA             = b'89'
ME_DATA               = b'0abcd'
VGA_DATA              = b'vga'
U_BOOT_DTB_DATA       = b'udtb'
U_BOOT_SPL_DTB_DATA   = b'spldtb'
U_BOOT_TPL_DTB_DATA   = b'tpldtb'
X86_START16_DATA      = b'start16'
X86_START16_SPL_DATA  = b'start16spl'
X86_START16_TPL_DATA  = b'start16tpl'
PPC_MPC85XX_BR_DATA   = b'ppcmpc85xxbr'
U_BOOT_NODTB_DATA     = b'nodtb with microcode pointer somewhere in here'
U_BOOT_SPL_NODTB_DATA = b'splnodtb with microcode pointer somewhere in here'
U_BOOT_TPL_NODTB_DATA = b'tplnodtb with microcode pointer somewhere in here'
FSP_DATA              = b'fsp'
CMC_DATA              = b'cmc'
VBT_DATA              = b'vbt'
MRC_DATA              = b'mrc'
55 56 57
TEXT_DATA             = 'text'
TEXT_DATA2            = 'text2'
TEXT_DATA3            = 'text3'
S
Simon Glass 已提交
58 59 60 61 62 63
CROS_EC_RW_DATA       = b'ecrw'
GBB_DATA              = b'gbbd'
BMPBLK_DATA           = b'bmp'
VBLOCK_DATA           = b'vblk'
FILES_DATA            = (b"sorry I'm late\nOh, don't bother apologising, I'm " +
                         b"sorry you're alive\n")
64
COMPRESS_DATA         = b'compress xxxxxxxxxxxxxxxxxxxxxx data'
S
Simon Glass 已提交
65
REFCODE_DATA          = b'refcode'
66

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83

class TestFunctional(unittest.TestCase):
    """Functional tests for binman

    Most of these use a sample .dts file to build an image and then check
    that it looks correct. The sample files are in the test/ subdirectory
    and are numbered.

    For each entry type a very small test file is created using fixed
    string contents. This makes it easy to test that things look right, and
    debug problems.

    In some cases a 'real' file must be used - these are also supplied in
    the test/ diurectory.
    """
    @classmethod
    def setUpClass(self):
84 85 86
        global entry
        import entry

87 88 89 90 91 92 93 94 95 96 97
        # Handle the case where argv[0] is 'python'
        self._binman_dir = os.path.dirname(os.path.realpath(sys.argv[0]))
        self._binman_pathname = os.path.join(self._binman_dir, 'binman')

        # Create a temporary directory for input files
        self._indir = tempfile.mkdtemp(prefix='binmant.')

        # Create some test files
        TestFunctional._MakeInputFile('u-boot.bin', U_BOOT_DATA)
        TestFunctional._MakeInputFile('u-boot.img', U_BOOT_IMG_DATA)
        TestFunctional._MakeInputFile('spl/u-boot-spl.bin', U_BOOT_SPL_DATA)
98
        TestFunctional._MakeInputFile('tpl/u-boot-tpl.bin', U_BOOT_TPL_DATA)
99
        TestFunctional._MakeInputFile('blobfile', BLOB_DATA)
100 101
        TestFunctional._MakeInputFile('me.bin', ME_DATA)
        TestFunctional._MakeInputFile('vga.bin', VGA_DATA)
102
        self._ResetDtbs()
103
        TestFunctional._MakeInputFile('u-boot-x86-16bit.bin', X86_START16_DATA)
104
        TestFunctional._MakeInputFile('u-boot-br.bin', PPC_MPC85XX_BR_DATA)
105 106
        TestFunctional._MakeInputFile('spl/u-boot-x86-16bit-spl.bin',
                                      X86_START16_SPL_DATA)
107 108
        TestFunctional._MakeInputFile('tpl/u-boot-x86-16bit-tpl.bin',
                                      X86_START16_TPL_DATA)
109
        TestFunctional._MakeInputFile('u-boot-nodtb.bin', U_BOOT_NODTB_DATA)
110 111
        TestFunctional._MakeInputFile('spl/u-boot-spl-nodtb.bin',
                                      U_BOOT_SPL_NODTB_DATA)
112 113
        TestFunctional._MakeInputFile('tpl/u-boot-tpl-nodtb.bin',
                                      U_BOOT_TPL_NODTB_DATA)
114 115
        TestFunctional._MakeInputFile('fsp.bin', FSP_DATA)
        TestFunctional._MakeInputFile('cmc.bin', CMC_DATA)
116
        TestFunctional._MakeInputFile('vbt.bin', VBT_DATA)
117
        TestFunctional._MakeInputFile('mrc.bin', MRC_DATA)
118
        TestFunctional._MakeInputFile('ecrw.bin', CROS_EC_RW_DATA)
119 120
        TestFunctional._MakeInputDir('devkeys')
        TestFunctional._MakeInputFile('bmpblk.bin', BMPBLK_DATA)
121
        TestFunctional._MakeInputFile('refcode.bin', REFCODE_DATA)
122

123
        # ELF file with a '_dt_ucode_base_size' symbol
124
        with open(self.TestFile('u_boot_ucode_ptr'), 'rb') as fd:
125 126 127
            TestFunctional._MakeInputFile('u-boot', fd.read())

        # Intel flash descriptor file
128
        with open(self.TestFile('descriptor.bin'), 'rb') as fd:
129 130
            TestFunctional._MakeInputFile('descriptor.bin', fd.read())

S
Simon Glass 已提交
131 132 133
        shutil.copytree(self.TestFile('files'),
                        os.path.join(self._indir, 'files'))

S
Simon Glass 已提交
134 135
        TestFunctional._MakeInputFile('compress', COMPRESS_DATA)

136 137 138
    @classmethod
    def tearDownClass(self):
        """Remove the temporary input directory and its contents"""
139 140 141 142 143
        if self.preserve_indir:
            print('Preserving input dir: %s' % self._indir)
        else:
            if self._indir:
                shutil.rmtree(self._indir)
144 145
        self._indir = None

146
    @classmethod
S
Simon Glass 已提交
147 148
    def setup_test_args(cls, preserve_indir=False, preserve_outdirs=False,
                        toolpath=None):
149 150 151 152 153 154 155 156
        """Accept arguments controlling test execution

        Args:
            preserve_indir: Preserve the shared input directory used by all
                tests in this class.
            preserve_outdir: Preserve the output directories used by tests. Each
                test has its own, so this is normally only useful when running a
                single test.
S
Simon Glass 已提交
157
            toolpath: ist of paths to use for tools
158 159 160
        """
        cls.preserve_indir = preserve_indir
        cls.preserve_outdirs = preserve_outdirs
S
Simon Glass 已提交
161
        cls.toolpath = toolpath
162

163 164 165 166 167 168 169
    def setUp(self):
        # Enable this to turn on debugging output
        # tout.Init(tout.DEBUG)
        command.test_result = None

    def tearDown(self):
        """Remove the temporary output directory"""
170 171 172 173
        if self.preserve_outdirs:
            print('Preserving output dir: %s' % tools.outdir)
        else:
            tools._FinaliseForTest()
174

175 176 177 178 179 180
    @classmethod
    def _ResetDtbs(self):
        TestFunctional._MakeInputFile('u-boot.dtb', U_BOOT_DTB_DATA)
        TestFunctional._MakeInputFile('spl/u-boot-spl.dtb', U_BOOT_SPL_DTB_DATA)
        TestFunctional._MakeInputFile('tpl/u-boot-tpl.dtb', U_BOOT_TPL_DTB_DATA)

181 182 183 184 185 186 187 188 189 190 191 192 193
    def _GetVerbosity(self):
        """Check if verbosity should be enabled

        Returns:
            list containing either:
                - Verbosity flag (e.g. '-v2') if it is present on the cmd line
                - nothing if the flag is not present
        """
        for arg in sys.argv[1:]:
            if arg.startswith('-v'):
                return [arg]
        return []

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
    def _RunBinman(self, *args, **kwargs):
        """Run binman using the command line

        Args:
            Arguments to pass, as a list of strings
            kwargs: Arguments to pass to Command.RunPipe()
        """
        result = command.RunPipe([[self._binman_pathname] + list(args)],
                capture=True, capture_stderr=True, raise_on_error=False)
        if result.return_code and kwargs.get('raise_on_error', True):
            raise Exception("Error running '%s': %s" % (' '.join(args),
                            result.stdout + result.stderr))
        return result

    def _DoBinman(self, *args):
        """Run binman using directly (in the same process)

        Args:
            Arguments to pass, as a list of strings
        Returns:
            Return value (0 for success)
        """
216 217 218 219
        args = list(args)
        if '-D' in sys.argv:
            args = args + ['-D']
        (options, args) = cmdline.ParseArgs(args)
220 221 222 223 224 225 226
        options.pager = 'binman-invalid-pager'
        options.build_dir = self._indir

        # For testing, you can force an increase in verbosity here
        # options.verbosity = tout.DEBUG
        return control.Binman(options, args)

227
    def _DoTestFile(self, fname, debug=False, map=False, update_dtb=False,
228 229
                    entry_args=None, images=None, use_real_dtb=False,
                    verbosity=None):
230 231 232
        """Run binman with a given test file

        Args:
233
            fname: Device-tree source filename to use (e.g. 005_simple.dts)
234
            debug: True to enable debugging output
235
            map: True to output map files for the images
236
            update_dtb: Update the offset and size of each entry in the device
237
                tree before packing it into the image
238 239 240 241
            entry_args: Dict of entry args to supply to binman
                key: arg name
                value: value of that arg
            images: List of image names to build
242
        """
243 244 245
        args = ['-p', '-I', self._indir, '-d', self.TestFile(fname)]
        if debug:
            args.append('-D')
246 247
        if map:
            args.append('-m')
248
        if update_dtb:
249
            args.append('-u')
250 251
        if not use_real_dtb:
            args.append('--fake-dtb')
252 253
        if verbosity is not None:
            args.append('-v%d' % verbosity)
254 255
        else:
            args += self._GetVerbosity()
256
        if entry_args:
257
            for arg, value in entry_args.items():
258
                args.append('-a%s=%s' % (arg, value))
259 260 261
        if images:
            for image in images:
                args += ['-i', image]
S
Simon Glass 已提交
262 263 264
        if self.toolpath:
            for path in self.toolpath:
                args += ['--toolpath', path]
265
        return self._DoBinman(*args)
266 267

    def _SetupDtb(self, fname, outfile='u-boot.dtb'):
268 269 270 271 272 273 274
        """Set up a new test device-tree file

        The given file is compiled and set up as the device tree to be used
        for ths test.

        Args:
            fname: Filename of .dts file to read
275
            outfile: Output filename for compiled device-tree binary
276 277

        Returns:
278
            Contents of device-tree binary
279
        """
280
        tools.PrepareOutputDir(None)
281
        dtb = fdt_util.EnsureCompiled(self.TestFile(fname))
282
        with open(dtb, 'rb') as fd:
283 284
            data = fd.read()
            TestFunctional._MakeInputFile(outfile, data)
285 286
        tools.FinaliseOutputDir()
        return data
287

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
    def _GetDtbContentsForSplTpl(self, dtb_data, name):
        """Create a version of the main DTB for SPL or SPL

        For testing we don't actually have different versions of the DTB. With
        U-Boot we normally run fdtgrep to remove unwanted nodes, but for tests
        we don't normally have any unwanted nodes.

        We still want the DTBs for SPL and TPL to be different though, since
        otherwise it is confusing to know which one we are looking at. So add
        an 'spl' or 'tpl' property to the top-level node.
        """
        dtb = fdt.Fdt.FromData(dtb_data)
        dtb.Scan()
        dtb.GetNode('/binman').AddZeroProp(name)
        dtb.Sync(auto_resize=True)
        dtb.Pack()
        return dtb.GetContents()

306
    def _DoReadFileDtb(self, fname, use_real_dtb=False, map=False,
307
                       update_dtb=False, entry_args=None, reset_dtbs=True):
308 309 310 311 312 313 314 315 316
        """Run binman and return the resulting image

        This runs binman with a given test file and then reads the resulting
        output file. It is a shortcut function since most tests need to do
        these steps.

        Raises an assertion failure if binman returns a non-zero exit code.

        Args:
317
            fname: Device-tree source filename to use (e.g. 005_simple.dts)
318 319 320 321
            use_real_dtb: True to use the test file as the contents of
                the u-boot-dtb entry. Normally this is not needed and the
                test contents (the U_BOOT_DTB_DATA string) can be used.
                But in some test we need the real contents.
322
            map: True to output map files for the images
323
            update_dtb: Update the offset and size of each entry in the device
324
                tree before packing it into the image
325 326 327 328 329

        Returns:
            Tuple:
                Resulting image contents
                Device tree contents
330
                Map data showing contents of image (or None if none)
331
                Output device tree binary filename ('u-boot.dtb' path)
332
        """
333
        dtb_data = None
334 335
        # Use the compiled test file as the u-boot-dtb input
        if use_real_dtb:
336
            dtb_data = self._SetupDtb(fname)
337 338 339 340 341 342 343 344

            # For testing purposes, make a copy of the DT for SPL and TPL. Add
            # a node indicating which it is, so aid verification.
            for name in ['spl', 'tpl']:
                dtb_fname = '%s/u-boot-%s.dtb' % (name, name)
                outfile = os.path.join(self._indir, dtb_fname)
                TestFunctional._MakeInputFile(dtb_fname,
                        self._GetDtbContentsForSplTpl(dtb_data, name))
345 346

        try:
347
            retcode = self._DoTestFile(fname, map=map, update_dtb=update_dtb,
348
                    entry_args=entry_args, use_real_dtb=use_real_dtb)
349
            self.assertEqual(0, retcode)
350
            out_dtb_fname = tools.GetOutputFilename('u-boot.dtb.out')
351 352 353

            # Find the (only) image, read it and return its contents
            image = control.images['image']
354 355
            image_fname = tools.GetOutputFilename('image.bin')
            self.assertTrue(os.path.exists(image_fname))
356 357 358 359 360 361
            if map:
                map_fname = tools.GetOutputFilename('image.map')
                with open(map_fname) as fd:
                    map_data = fd.read()
            else:
                map_data = None
362
            with open(image_fname, 'rb') as fd:
363
                return fd.read(), dtb_data, map_data, out_dtb_fname
364 365
        finally:
            # Put the test file back
366
            if reset_dtbs and use_real_dtb:
367
                self._ResetDtbs()
368

369
    def _DoReadFile(self, fname, use_real_dtb=False):
370 371 372
        """Helper function which discards the device-tree binary

        Args:
373
            fname: Device-tree source filename to use (e.g. 005_simple.dts)
374 375 376 377
            use_real_dtb: True to use the test file as the contents of
                the u-boot-dtb entry. Normally this is not needed and the
                test contents (the U_BOOT_DTB_DATA string) can be used.
                But in some test we need the real contents.
378 379 380

        Returns:
            Resulting image contents
381
        """
382 383
        return self._DoReadFileDtb(fname, use_real_dtb)[0]

384 385 386 387 388
    @classmethod
    def _MakeInputFile(self, fname, contents):
        """Create a new test input file, creating directories as needed

        Args:
389
            fname: Filename to create
390 391 392 393 394 395 396 397 398 399 400 401
            contents: File contents to write in to the file
        Returns:
            Full pathname of file created
        """
        pathname = os.path.join(self._indir, fname)
        dirname = os.path.dirname(pathname)
        if dirname and not os.path.exists(dirname):
            os.makedirs(dirname)
        with open(pathname, 'wb') as fd:
            fd.write(contents)
        return pathname

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
    @classmethod
    def _MakeInputDir(self, dirname):
        """Create a new test input directory, creating directories as needed

        Args:
            dirname: Directory name to create

        Returns:
            Full pathname of directory created
        """
        pathname = os.path.join(self._indir, dirname)
        if not os.path.exists(pathname):
            os.makedirs(pathname)
        return pathname

S
Simon Glass 已提交
417 418 419 420 421 422 423
    @classmethod
    def _SetupSplElf(self, src_fname='bss_data'):
        """Set up an ELF file with a '_dt_ucode_base_size' symbol

        Args:
            Filename of ELF file to use as SPL
        """
424
        with open(self.TestFile(src_fname), 'rb') as fd:
S
Simon Glass 已提交
425 426
            TestFunctional._MakeInputFile('spl/u-boot-spl', fd.read())

427 428 429 430 431 432 433 434 435 436 437 438 439 440
    @classmethod
    def TestFile(self, fname):
        return os.path.join(self._binman_dir, 'test', fname)

    def AssertInList(self, grep_list, target):
        """Assert that at least one of a list of things is in a target

        Args:
            grep_list: List of strings to check
            target: Target string
        """
        for grep in grep_list:
            if grep in target:
                return
441
        self.fail("Error: '%s' not found in '%s'" % (grep_list, target))
442 443 444 445 446 447 448

    def CheckNoGaps(self, entries):
        """Check that all entries fit together without gaps

        Args:
            entries: List of entries to check
        """
449
        offset = 0
450
        for entry in entries.values():
451 452
            self.assertEqual(offset, entry.offset)
            offset += entry.size
453

454
    def GetFdtLen(self, dtb):
455
        """Get the totalsize field from a device-tree binary
456 457

        Args:
458
            dtb: Device-tree binary contents
459 460

        Returns:
461
            Total size of device-tree binary, from the header
462 463 464
        """
        return struct.unpack('>L', dtb[4:8])[0]

465
    def _GetPropTree(self, dtb, prop_names):
466 467 468 469 470
        def AddNode(node, path):
            if node.name != '/':
                path += '/' + node.name
            for subnode in node.subnodes:
                for prop in subnode.props.values():
471
                    if prop.name in prop_names:
472 473 474 475 476 477 478 479 480
                        prop_path = path + '/' + subnode.name + ':' + prop.name
                        tree[prop_path[len('/binman/'):]] = fdt_util.fdt32_to_cpu(
                            prop.value)
                AddNode(subnode, path)

        tree = {}
        AddNode(dtb.GetRoot(), '')
        return tree

481 482 483 484 485 486 487 488
    def testRun(self):
        """Test a basic run with valid args"""
        result = self._RunBinman('-h')

    def testFullHelp(self):
        """Test that the full help is displayed with -H"""
        result = self._RunBinman('-H')
        help_file = os.path.join(self._binman_dir, 'README')
489 490 491 492
        # Remove possible extraneous strings
        extra = '::::::::::::::\n' + help_file + '\n::::::::::::::\n'
        gothelp = result.stdout.replace(extra, '')
        self.assertEqual(len(gothelp), os.path.getsize(help_file))
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
        self.assertEqual(0, len(result.stderr))
        self.assertEqual(0, result.return_code)

    def testFullHelpInternal(self):
        """Test that the full help is displayed with -H"""
        try:
            command.test_result = command.CommandResult()
            result = self._DoBinman('-H')
            help_file = os.path.join(self._binman_dir, 'README')
        finally:
            command.test_result = None

    def testHelp(self):
        """Test that the basic help is displayed with -h"""
        result = self._RunBinman('-h')
        self.assertTrue(len(result.stdout) > 200)
        self.assertEqual(0, len(result.stderr))
        self.assertEqual(0, result.return_code)

    def testBoard(self):
        """Test that we can run it with a specific board"""
514
        self._SetupDtb('005_simple.dts', 'sandbox/u-boot.dtb')
515 516 517 518 519 520 521 522 523 524 525 526
        TestFunctional._MakeInputFile('sandbox/u-boot.bin', U_BOOT_DATA)
        result = self._DoBinman('-b', 'sandbox')
        self.assertEqual(0, result)

    def testNeedBoard(self):
        """Test that we get an error when no board ius supplied"""
        with self.assertRaises(ValueError) as e:
            result = self._DoBinman()
        self.assertIn("Must provide a board to process (use -b <board>)",
                str(e.exception))

    def testMissingDt(self):
527
        """Test that an invalid device-tree file generates an error"""
528 529 530 531 532 533 534
        with self.assertRaises(Exception) as e:
            self._RunBinman('-d', 'missing_file')
        # We get one error from libfdt, and a different one from fdtget.
        self.AssertInList(["Couldn't open blob from 'missing_file'",
                           'No such file or directory'], str(e.exception))

    def testBrokenDt(self):
535
        """Test that an invalid device-tree source file generates an error
536 537 538 539 540

        Since this is a source file it should be compiled and the error
        will come from the device-tree compiler (dtc).
        """
        with self.assertRaises(Exception) as e:
541
            self._RunBinman('-d', self.TestFile('001_invalid.dts'))
542 543 544 545 546 547
        self.assertIn("FATAL ERROR: Unable to parse input tree",
                str(e.exception))

    def testMissingNode(self):
        """Test that a device tree without a 'binman' node generates an error"""
        with self.assertRaises(Exception) as e:
548
            self._DoBinman('-d', self.TestFile('002_missing_node.dts'))
549 550 551 552
        self.assertIn("does not have a 'binman' node", str(e.exception))

    def testEmpty(self):
        """Test that an empty binman node works OK (i.e. does nothing)"""
553
        result = self._RunBinman('-d', self.TestFile('003_empty.dts'))
554 555 556 557 558 559 560
        self.assertEqual(0, len(result.stderr))
        self.assertEqual(0, result.return_code)

    def testInvalidEntry(self):
        """Test that an invalid entry is flagged"""
        with self.assertRaises(Exception) as e:
            result = self._RunBinman('-d',
561
                                     self.TestFile('004_invalid_entry.dts'))
562 563 564 565 566
        self.assertIn("Unknown entry type 'not-a-valid-type' in node "
                "'/binman/not-a-valid-type'", str(e.exception))

    def testSimple(self):
        """Test a simple binman with a single file"""
567
        data = self._DoReadFile('005_simple.dts')
568 569
        self.assertEqual(U_BOOT_DATA, data)

570 571
    def testSimpleDebug(self):
        """Test a simple binman run with debugging enabled"""
572
        data = self._DoTestFile('005_simple.dts', debug=True)
573

574 575 576 577 578
    def testDual(self):
        """Test that we can handle creating two images

        This also tests image padding.
        """
579
        retcode = self._DoTestFile('006_dual_image.dts')
580 581 582 583 584 585
        self.assertEqual(0, retcode)

        image = control.images['image1']
        self.assertEqual(len(U_BOOT_DATA), image._size)
        fname = tools.GetOutputFilename('image1.bin')
        self.assertTrue(os.path.exists(fname))
586
        with open(fname, 'rb') as fd:
587 588 589 590 591 592 593
            data = fd.read()
            self.assertEqual(U_BOOT_DATA, data)

        image = control.images['image2']
        self.assertEqual(3 + len(U_BOOT_DATA) + 5, image._size)
        fname = tools.GetOutputFilename('image2.bin')
        self.assertTrue(os.path.exists(fname))
594
        with open(fname, 'rb') as fd:
595 596
            data = fd.read()
            self.assertEqual(U_BOOT_DATA, data[3:7])
597 598
            self.assertEqual(tools.GetBytes(0, 3), data[:3])
            self.assertEqual(tools.GetBytes(0, 5), data[7:])
599 600 601 602

    def testBadAlign(self):
        """Test that an invalid alignment value is detected"""
        with self.assertRaises(ValueError) as e:
603
            self._DoTestFile('007_bad_align.dts')
604 605 606 607 608
        self.assertIn("Node '/binman/u-boot': Alignment 23 must be a power "
                      "of two", str(e.exception))

    def testPackSimple(self):
        """Test that packing works as expected"""
609
        retcode = self._DoTestFile('008_pack.dts')
610 611 612
        self.assertEqual(0, retcode)
        self.assertIn('image', control.images)
        image = control.images['image']
613
        entries = image.GetEntries()
614 615 616 617 618
        self.assertEqual(5, len(entries))

        # First u-boot
        self.assertIn('u-boot', entries)
        entry = entries['u-boot']
619
        self.assertEqual(0, entry.offset)
620 621 622 623 624
        self.assertEqual(len(U_BOOT_DATA), entry.size)

        # Second u-boot, aligned to 16-byte boundary
        self.assertIn('u-boot-align', entries)
        entry = entries['u-boot-align']
625
        self.assertEqual(16, entry.offset)
626 627 628 629 630
        self.assertEqual(len(U_BOOT_DATA), entry.size)

        # Third u-boot, size 23 bytes
        self.assertIn('u-boot-size', entries)
        entry = entries['u-boot-size']
631
        self.assertEqual(20, entry.offset)
632 633 634 635 636 637
        self.assertEqual(len(U_BOOT_DATA), entry.contents_size)
        self.assertEqual(23, entry.size)

        # Fourth u-boot, placed immediate after the above
        self.assertIn('u-boot-next', entries)
        entry = entries['u-boot-next']
638
        self.assertEqual(43, entry.offset)
639 640
        self.assertEqual(len(U_BOOT_DATA), entry.size)

641
        # Fifth u-boot, placed at a fixed offset
642 643
        self.assertIn('u-boot-fixed', entries)
        entry = entries['u-boot-fixed']
644
        self.assertEqual(61, entry.offset)
645 646 647 648 649 650
        self.assertEqual(len(U_BOOT_DATA), entry.size)

        self.assertEqual(65, image._size)

    def testPackExtra(self):
        """Test that extra packing feature works as expected"""
651
        retcode = self._DoTestFile('009_pack_extra.dts')
652 653 654 655

        self.assertEqual(0, retcode)
        self.assertIn('image', control.images)
        image = control.images['image']
656
        entries = image.GetEntries()
657 658 659 660 661
        self.assertEqual(5, len(entries))

        # First u-boot with padding before and after
        self.assertIn('u-boot', entries)
        entry = entries['u-boot']
662
        self.assertEqual(0, entry.offset)
663 664 665 666 667 668
        self.assertEqual(3, entry.pad_before)
        self.assertEqual(3 + 5 + len(U_BOOT_DATA), entry.size)

        # Second u-boot has an aligned size, but it has no effect
        self.assertIn('u-boot-align-size-nop', entries)
        entry = entries['u-boot-align-size-nop']
669
        self.assertEqual(12, entry.offset)
670 671 672 673 674
        self.assertEqual(4, entry.size)

        # Third u-boot has an aligned size too
        self.assertIn('u-boot-align-size', entries)
        entry = entries['u-boot-align-size']
675
        self.assertEqual(16, entry.offset)
676 677 678 679 680
        self.assertEqual(32, entry.size)

        # Fourth u-boot has an aligned end
        self.assertIn('u-boot-align-end', entries)
        entry = entries['u-boot-align-end']
681
        self.assertEqual(48, entry.offset)
682 683 684 685 686
        self.assertEqual(16, entry.size)

        # Fifth u-boot immediately afterwards
        self.assertIn('u-boot-align-both', entries)
        entry = entries['u-boot-align-both']
687
        self.assertEqual(64, entry.offset)
688 689 690 691 692 693 694 695
        self.assertEqual(64, entry.size)

        self.CheckNoGaps(entries)
        self.assertEqual(128, image._size)

    def testPackAlignPowerOf2(self):
        """Test that invalid entry alignment is detected"""
        with self.assertRaises(ValueError) as e:
696
            self._DoTestFile('010_pack_align_power2.dts')
697 698 699 700 701 702
        self.assertIn("Node '/binman/u-boot': Alignment 5 must be a power "
                      "of two", str(e.exception))

    def testPackAlignSizePowerOf2(self):
        """Test that invalid entry size alignment is detected"""
        with self.assertRaises(ValueError) as e:
703
            self._DoTestFile('011_pack_align_size_power2.dts')
704 705 706 707
        self.assertIn("Node '/binman/u-boot': Alignment size 55 must be a "
                      "power of two", str(e.exception))

    def testPackInvalidAlign(self):
708
        """Test detection of an offset that does not match its alignment"""
709
        with self.assertRaises(ValueError) as e:
710
            self._DoTestFile('012_pack_inv_align.dts')
711
        self.assertIn("Node '/binman/u-boot': Offset 0x5 (5) does not match "
712 713 714 715 716
                      "align 0x4 (4)", str(e.exception))

    def testPackInvalidSizeAlign(self):
        """Test that invalid entry size alignment is detected"""
        with self.assertRaises(ValueError) as e:
717
            self._DoTestFile('013_pack_inv_size_align.dts')
718 719 720 721 722 723
        self.assertIn("Node '/binman/u-boot': Size 0x5 (5) does not match "
                      "align-size 0x4 (4)", str(e.exception))

    def testPackOverlap(self):
        """Test that overlapping regions are detected"""
        with self.assertRaises(ValueError) as e:
724
            self._DoTestFile('014_pack_overlap.dts')
725
        self.assertIn("Node '/binman/u-boot-align': Offset 0x3 (3) overlaps "
726 727 728 729 730 731
                      "with previous entry '/binman/u-boot' ending at 0x4 (4)",
                      str(e.exception))

    def testPackEntryOverflow(self):
        """Test that entries that overflow their size are detected"""
        with self.assertRaises(ValueError) as e:
732
            self._DoTestFile('015_pack_overflow.dts')
733 734 735 736 737 738
        self.assertIn("Node '/binman/u-boot': Entry contents size is 0x4 (4) "
                      "but entry size is 0x3 (3)", str(e.exception))

    def testPackImageOverflow(self):
        """Test that entries which overflow the image size are detected"""
        with self.assertRaises(ValueError) as e:
739
            self._DoTestFile('016_pack_image_overflow.dts')
740
        self.assertIn("Section '/binman': contents size 0x4 (4) exceeds section "
741 742 743 744
                      "size 0x3 (3)", str(e.exception))

    def testPackImageSize(self):
        """Test that the image size can be set"""
745
        retcode = self._DoTestFile('017_pack_image_size.dts')
746 747 748 749 750 751 752
        self.assertEqual(0, retcode)
        self.assertIn('image', control.images)
        image = control.images['image']
        self.assertEqual(7, image._size)

    def testPackImageSizeAlign(self):
        """Test that image size alignemnt works as expected"""
753
        retcode = self._DoTestFile('018_pack_image_align.dts')
754 755 756 757 758 759 760 761
        self.assertEqual(0, retcode)
        self.assertIn('image', control.images)
        image = control.images['image']
        self.assertEqual(16, image._size)

    def testPackInvalidImageAlign(self):
        """Test that invalid image alignment is detected"""
        with self.assertRaises(ValueError) as e:
762
            self._DoTestFile('019_pack_inv_image_align.dts')
763
        self.assertIn("Section '/binman': Size 0x7 (7) does not match "
764 765 766 767 768
                      "align-size 0x8 (8)", str(e.exception))

    def testPackAlignPowerOf2(self):
        """Test that invalid image alignment is detected"""
        with self.assertRaises(ValueError) as e:
769
            self._DoTestFile('020_pack_inv_image_align_power2.dts')
770
        self.assertIn("Section '/binman': Alignment size 131 must be a power of "
771 772 773 774
                      "two", str(e.exception))

    def testImagePadByte(self):
        """Test that the image pad byte can be specified"""
S
Simon Glass 已提交
775
        self._SetupSplElf()
776
        data = self._DoReadFile('021_image_pad.dts')
777 778
        self.assertEqual(U_BOOT_SPL_DATA + tools.GetBytes(0xff, 1) +
                         U_BOOT_DATA, data)
779 780 781

    def testImageName(self):
        """Test that image files can be named"""
782
        retcode = self._DoTestFile('022_image_name.dts')
783 784 785 786 787 788 789 790 791 792 793
        self.assertEqual(0, retcode)
        image = control.images['image1']
        fname = tools.GetOutputFilename('test-name')
        self.assertTrue(os.path.exists(fname))

        image = control.images['image2']
        fname = tools.GetOutputFilename('test-name.xx')
        self.assertTrue(os.path.exists(fname))

    def testBlobFilename(self):
        """Test that generic blobs can be provided by filename"""
794
        data = self._DoReadFile('023_blob.dts')
795 796 797 798
        self.assertEqual(BLOB_DATA, data)

    def testPackSorted(self):
        """Test that entries can be sorted"""
S
Simon Glass 已提交
799
        self._SetupSplElf()
800
        data = self._DoReadFile('024_sorted.dts')
801 802
        self.assertEqual(tools.GetBytes(0, 1) + U_BOOT_SPL_DATA +
                         tools.GetBytes(0, 2) + U_BOOT_DATA, data)
803

804 805
    def testPackZeroOffset(self):
        """Test that an entry at offset 0 is not given a new offset"""
806
        with self.assertRaises(ValueError) as e:
807
            self._DoTestFile('025_pack_zero_size.dts')
808
        self.assertIn("Node '/binman/u-boot-spl': Offset 0x0 (0) overlaps "
809 810 811 812 813
                      "with previous entry '/binman/u-boot' ending at 0x4 (4)",
                      str(e.exception))

    def testPackUbootDtb(self):
        """Test that a device tree can be added to U-Boot"""
814
        data = self._DoReadFile('026_pack_u_boot_dtb.dts')
815
        self.assertEqual(U_BOOT_NODTB_DATA + U_BOOT_DTB_DATA, data)
816 817 818 819

    def testPackX86RomNoSize(self):
        """Test that the end-at-4gb property requires a size property"""
        with self.assertRaises(ValueError) as e:
820
            self._DoTestFile('027_pack_4gb_no_size.dts')
821
        self.assertIn("Section '/binman': Section size must be provided when "
822 823
                      "using end-at-4gb", str(e.exception))

824 825 826 827 828 829 830 831
    def test4gbAndSkipAtStartTogether(self):
        """Test that the end-at-4gb and skip-at-size property can't be used
        together"""
        with self.assertRaises(ValueError) as e:
            self._DoTestFile('80_4gb_and_skip_at_start_together.dts')
        self.assertIn("Section '/binman': Provide either 'end-at-4gb' or "
                      "'skip-at-start'", str(e.exception))

832
    def testPackX86RomOutside(self):
833
        """Test that the end-at-4gb property checks for offset boundaries"""
834
        with self.assertRaises(ValueError) as e:
835
            self._DoTestFile('028_pack_4gb_outside.dts')
836
        self.assertIn("Node '/binman/u-boot': Offset 0x0 (0) is outside "
837
                      "the section starting at 0xffffffe0 (4294967264)",
838 839 840 841
                      str(e.exception))

    def testPackX86Rom(self):
        """Test that a basic x86 ROM can be created"""
S
Simon Glass 已提交
842
        self._SetupSplElf()
843
        data = self._DoReadFile('029_x86-rom.dts')
844 845
        self.assertEqual(U_BOOT_DATA + tools.GetBytes(0, 7) + U_BOOT_SPL_DATA +
                         tools.GetBytes(0, 2), data)
846 847 848

    def testPackX86RomMeNoDesc(self):
        """Test that an invalid Intel descriptor entry is detected"""
S
Simon Glass 已提交
849
        TestFunctional._MakeInputFile('descriptor.bin', b'')
850
        with self.assertRaises(ValueError) as e:
851
            self._DoTestFile('031_x86-rom-me.dts')
852 853
        self.assertIn("Node '/binman/intel-descriptor': Cannot find Intel Flash Descriptor (FD) signature",
                      str(e.exception))
854 855 856 857

    def testPackX86RomBadDesc(self):
        """Test that the Intel requires a descriptor entry"""
        with self.assertRaises(ValueError) as e:
858
            self._DoTestFile('030_x86-rom-me-no-desc.dts')
859 860 861
        self.assertIn("Node '/binman/intel-me': No offset set with "
                      "offset-unset: should another entry provide this correct "
                      "offset?", str(e.exception))
862 863 864

    def testPackX86RomMe(self):
        """Test that an x86 ROM with an ME region can be created"""
865
        data = self._DoReadFile('031_x86-rom-me.dts')
866 867 868 869
        self.assertEqual(ME_DATA, data[0x1000:0x1000 + len(ME_DATA)])

    def testPackVga(self):
        """Test that an image with a VGA binary can be created"""
870
        data = self._DoReadFile('032_intel-vga.dts')
871 872 873 874
        self.assertEqual(VGA_DATA, data[:len(VGA_DATA)])

    def testPackStart16(self):
        """Test that an image with an x86 start16 region can be created"""
875
        data = self._DoReadFile('033_x86-start16.dts')
876 877
        self.assertEqual(X86_START16_DATA, data[:len(X86_START16_DATA)])

878 879 880 881 882 883
    def testPackPowerpcMpc85xxBootpgResetvec(self):
        """Test that an image with powerpc-mpc85xx-bootpg-resetvec can be
        created"""
        data = self._DoReadFile('81_powerpc_mpc85xx_bootpg_resetvec.dts')
        self.assertEqual(PPC_MPC85XX_BR_DATA, data[:len(PPC_MPC85XX_BR_DATA)])

884
    def _RunMicrocodeTest(self, dts_fname, nodtb_data, ucode_second=False):
885 886 887 888 889
        """Handle running a test for insertion of microcode

        Args:
            dts_fname: Name of test .dts file
            nodtb_data: Data that we expect in the first section
890 891
            ucode_second: True if the microsecond entry is second instead of
                third
892 893 894 895

        Returns:
            Tuple:
                Contents of first region (U-Boot or SPL)
896
                Offset and size components of microcode pointer, as inserted
897 898
                    in the above (two 4-byte words)
        """
899
        data = self._DoReadFile(dts_fname, True)
900 901

        # Now check the device tree has no microcode
902 903 904 905 906 907 908 909 910 911
        if ucode_second:
            ucode_content = data[len(nodtb_data):]
            ucode_pos = len(nodtb_data)
            dtb_with_ucode = ucode_content[16:]
            fdt_len = self.GetFdtLen(dtb_with_ucode)
        else:
            dtb_with_ucode = data[len(nodtb_data):]
            fdt_len = self.GetFdtLen(dtb_with_ucode)
            ucode_content = dtb_with_ucode[fdt_len:]
            ucode_pos = len(nodtb_data) + fdt_len
912 913
        fname = tools.GetOutputFilename('test.dtb')
        with open(fname, 'wb') as fd:
914
            fd.write(dtb_with_ucode)
S
Simon Glass 已提交
915 916
        dtb = fdt.FdtScan(fname)
        ucode = dtb.GetNode('/microcode')
917 918 919 920 921 922
        self.assertTrue(ucode)
        for node in ucode.subnodes:
            self.assertFalse(node.props.get('data'))

        # Check that the microcode appears immediately after the Fdt
        # This matches the concatenation of the data properties in
923
        # the /microcode/update@xxx nodes in 34_x86_ucode.dts.
924 925
        ucode_data = struct.pack('>4L', 0x12345678, 0x12345679, 0xabcd0000,
                                 0x78235609)
926
        self.assertEqual(ucode_data, ucode_content[:len(ucode_data)])
927 928

        # Check that the microcode pointer was inserted. It should match the
929
        # expected offset and size
930 931
        pos_and_size = struct.pack('<2L', 0xfffffe00 + ucode_pos,
                                   len(ucode_data))
932 933
        u_boot = data[:len(nodtb_data)]
        return u_boot, pos_and_size
934 935 936 937 938 939 940 941 942 943

    def testPackUbootMicrocode(self):
        """Test that x86 microcode can be handled correctly

        We expect to see the following in the image, in order:
            u-boot-nodtb.bin with a microcode pointer inserted at the correct
                place
            u-boot.dtb with the microcode removed
            the microcode
        """
944
        first, pos_and_size = self._RunMicrocodeTest('034_x86_ucode.dts',
945
                                                     U_BOOT_NODTB_DATA)
S
Simon Glass 已提交
946 947
        self.assertEqual(b'nodtb with microcode' + pos_and_size +
                         b' somewhere in here', first)
948

S
Simon Glass 已提交
949
    def _RunPackUbootSingleMicrocode(self):
950 951 952 953 954 955 956 957 958 959 960
        """Test that x86 microcode can be handled correctly

        We expect to see the following in the image, in order:
            u-boot-nodtb.bin with a microcode pointer inserted at the correct
                place
            u-boot.dtb with the microcode
            an empty microcode region
        """
        # We need the libfdt library to run this test since only that allows
        # finding the offset of a property. This is required by
        # Entry_u_boot_dtb_with_ucode.ObtainContents().
961
        data = self._DoReadFile('035_x86_single_ucode.dts', True)
962 963 964 965 966 967 968

        second = data[len(U_BOOT_NODTB_DATA):]

        fdt_len = self.GetFdtLen(second)
        third = second[fdt_len:]
        second = second[:fdt_len]

S
Simon Glass 已提交
969 970 971
        ucode_data = struct.pack('>2L', 0x12345678, 0x12345679)
        self.assertIn(ucode_data, second)
        ucode_pos = second.find(ucode_data) + len(U_BOOT_NODTB_DATA)
972

S
Simon Glass 已提交
973
        # Check that the microcode pointer was inserted. It should match the
974
        # expected offset and size
S
Simon Glass 已提交
975 976 977
        pos_and_size = struct.pack('<2L', 0xfffffe00 + ucode_pos,
                                   len(ucode_data))
        first = data[:len(U_BOOT_NODTB_DATA)]
S
Simon Glass 已提交
978 979
        self.assertEqual(b'nodtb with microcode' + pos_and_size +
                         b' somewhere in here', first)
980

981 982 983
    def testPackUbootSingleMicrocode(self):
        """Test that x86 microcode can be handled correctly with fdt_normal.
        """
S
Simon Glass 已提交
984
        self._RunPackUbootSingleMicrocode()
985

986 987
    def testUBootImg(self):
        """Test that u-boot.img can be put in a file"""
988
        data = self._DoReadFile('036_u_boot_img.dts')
989
        self.assertEqual(U_BOOT_IMG_DATA, data)
990 991 992 993

    def testNoMicrocode(self):
        """Test that a missing microcode region is detected"""
        with self.assertRaises(ValueError) as e:
994
            self._DoReadFile('037_x86_no_ucode.dts', True)
995 996 997 998 999 1000
        self.assertIn("Node '/binman/u-boot-dtb-with-ucode': No /microcode "
                      "node found in ", str(e.exception))

    def testMicrocodeWithoutNode(self):
        """Test that a missing u-boot-dtb-with-ucode node is detected"""
        with self.assertRaises(ValueError) as e:
1001
            self._DoReadFile('038_x86_ucode_missing_node.dts', True)
1002 1003 1004 1005 1006 1007
        self.assertIn("Node '/binman/u-boot-with-ucode-ptr': Cannot find "
                "microcode region u-boot-dtb-with-ucode", str(e.exception))

    def testMicrocodeWithoutNode2(self):
        """Test that a missing u-boot-ucode node is detected"""
        with self.assertRaises(ValueError) as e:
1008
            self._DoReadFile('039_x86_ucode_missing_node2.dts', True)
1009 1010 1011 1012 1013 1014 1015
        self.assertIn("Node '/binman/u-boot-with-ucode-ptr': Cannot find "
            "microcode region u-boot-ucode", str(e.exception))

    def testMicrocodeWithoutPtrInElf(self):
        """Test that a U-Boot binary without the microcode symbol is detected"""
        # ELF file without a '_dt_ucode_base_size' symbol
        try:
1016
            with open(self.TestFile('u_boot_no_ucode_ptr'), 'rb') as fd:
1017 1018 1019
                TestFunctional._MakeInputFile('u-boot', fd.read())

            with self.assertRaises(ValueError) as e:
S
Simon Glass 已提交
1020
                self._RunPackUbootSingleMicrocode()
1021 1022 1023 1024 1025
            self.assertIn("Node '/binman/u-boot-with-ucode-ptr': Cannot locate "
                    "_dt_ucode_base_size symbol in u-boot", str(e.exception))

        finally:
            # Put the original file back
1026
            with open(self.TestFile('u_boot_ucode_ptr'), 'rb') as fd:
1027 1028 1029 1030 1031
                TestFunctional._MakeInputFile('u-boot', fd.read())

    def testMicrocodeNotInImage(self):
        """Test that microcode must be placed within the image"""
        with self.assertRaises(ValueError) as e:
1032
            self._DoReadFile('040_x86_ucode_not_in_image.dts', True)
1033 1034
        self.assertIn("Node '/binman/u-boot-with-ucode-ptr': Microcode "
                "pointer _dt_ucode_base_size at fffffe14 is outside the "
1035
                "section ranging from 00000000 to 0000002e", str(e.exception))
1036 1037 1038

    def testWithoutMicrocode(self):
        """Test that we can cope with an image without microcode (e.g. qemu)"""
1039
        with open(self.TestFile('u_boot_no_ucode_ptr'), 'rb') as fd:
1040
            TestFunctional._MakeInputFile('u-boot', fd.read())
1041
        data, dtb, _, _ = self._DoReadFileDtb('044_x86_optional_ucode.dts', True)
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051

        # Now check the device tree has no microcode
        self.assertEqual(U_BOOT_NODTB_DATA, data[:len(U_BOOT_NODTB_DATA)])
        second = data[len(U_BOOT_NODTB_DATA):]

        fdt_len = self.GetFdtLen(second)
        self.assertEqual(dtb, second[:fdt_len])

        used_len = len(U_BOOT_NODTB_DATA) + fdt_len
        third = data[used_len:]
1052
        self.assertEqual(tools.GetBytes(0, 0x200 - used_len), third)
1053 1054 1055 1056

    def testUnknownPosSize(self):
        """Test that microcode must be placed within the image"""
        with self.assertRaises(ValueError) as e:
1057
            self._DoReadFile('041_unknown_pos_size.dts', True)
1058
        self.assertIn("Section '/binman': Unable to set offset/size for unknown "
1059
                "entry 'invalid-entry'", str(e.exception))
1060 1061 1062

    def testPackFsp(self):
        """Test that an image with a FSP binary can be created"""
1063
        data = self._DoReadFile('042_intel-fsp.dts')
1064 1065 1066
        self.assertEqual(FSP_DATA, data[:len(FSP_DATA)])

    def testPackCmc(self):
1067
        """Test that an image with a CMC binary can be created"""
1068
        data = self._DoReadFile('043_intel-cmc.dts')
1069
        self.assertEqual(CMC_DATA, data[:len(CMC_DATA)])
1070 1071 1072

    def testPackVbt(self):
        """Test that an image with a VBT binary can be created"""
1073
        data = self._DoReadFile('046_intel-vbt.dts')
1074
        self.assertEqual(VBT_DATA, data[:len(VBT_DATA)])
1075

1076 1077
    def testSplBssPad(self):
        """Test that we can pad SPL's BSS with zeros"""
1078
        # ELF file with a '__bss_size' symbol
S
Simon Glass 已提交
1079
        self._SetupSplElf()
1080
        data = self._DoReadFile('047_spl_bss_pad.dts')
1081 1082
        self.assertEqual(U_BOOT_SPL_DATA + tools.GetBytes(0, 10) + U_BOOT_DATA,
                         data)
1083

S
Simon Glass 已提交
1084 1085
    def testSplBssPadMissing(self):
        """Test that a missing symbol is detected"""
S
Simon Glass 已提交
1086
        self._SetupSplElf('u_boot_ucode_ptr')
1087
        with self.assertRaises(ValueError) as e:
1088
            self._DoReadFile('047_spl_bss_pad.dts')
1089 1090 1091
        self.assertIn('Expected __bss_size symbol in spl/u-boot-spl',
                      str(e.exception))

1092
    def testPackStart16Spl(self):
1093
        """Test that an image with an x86 start16 SPL region can be created"""
1094
        data = self._DoReadFile('048_x86-start16-spl.dts')
1095 1096
        self.assertEqual(X86_START16_SPL_DATA, data[:len(X86_START16_SPL_DATA)])

1097 1098
    def _PackUbootSplMicrocode(self, dts, ucode_second=False):
        """Helper function for microcode tests
1099 1100 1101 1102 1103 1104

        We expect to see the following in the image, in order:
            u-boot-spl-nodtb.bin with a microcode pointer inserted at the
                correct place
            u-boot.dtb with the microcode removed
            the microcode
1105 1106 1107 1108 1109

        Args:
            dts: Device tree file to use for test
            ucode_second: True if the microsecond entry is second instead of
                third
1110
        """
S
Simon Glass 已提交
1111
        self._SetupSplElf('u_boot_ucode_ptr')
1112 1113
        first, pos_and_size = self._RunMicrocodeTest(dts, U_BOOT_SPL_NODTB_DATA,
                                                     ucode_second=ucode_second)
S
Simon Glass 已提交
1114 1115
        self.assertEqual(b'splnodtb with microc' + pos_and_size +
                         b'ter somewhere in here', first)
1116

1117 1118
    def testPackUbootSplMicrocode(self):
        """Test that x86 microcode can be handled correctly in SPL"""
1119
        self._PackUbootSplMicrocode('049_x86_ucode_spl.dts')
1120 1121 1122 1123 1124 1125 1126 1127

    def testPackUbootSplMicrocodeReorder(self):
        """Test that order doesn't matter for microcode entries

        This is the same as testPackUbootSplMicrocode but when we process the
        u-boot-ucode entry we have not yet seen the u-boot-dtb-with-ucode
        entry, so we reply on binman to try later.
        """
1128
        self._PackUbootSplMicrocode('058_x86_ucode_spl_needs_retry.dts',
1129 1130
                                    ucode_second=True)

1131 1132
    def testPackMrc(self):
        """Test that an image with an MRC binary can be created"""
1133
        data = self._DoReadFile('050_intel_mrc.dts')
1134 1135
        self.assertEqual(MRC_DATA, data[:len(MRC_DATA)])

1136 1137
    def testSplDtb(self):
        """Test that an image with spl/u-boot-spl.dtb can be created"""
1138
        data = self._DoReadFile('051_u_boot_spl_dtb.dts')
1139 1140
        self.assertEqual(U_BOOT_SPL_DTB_DATA, data[:len(U_BOOT_SPL_DTB_DATA)])

1141 1142
    def testSplNoDtb(self):
        """Test that an image with spl/u-boot-spl-nodtb.bin can be created"""
1143
        data = self._DoReadFile('052_u_boot_spl_nodtb.dts')
1144 1145
        self.assertEqual(U_BOOT_SPL_NODTB_DATA, data[:len(U_BOOT_SPL_NODTB_DATA)])

1146 1147 1148 1149 1150
    def testSymbols(self):
        """Test binman can assign symbols embedded in U-Boot"""
        elf_fname = self.TestFile('u_boot_binman_syms')
        syms = elf.GetSymbols(elf_fname, ['binman', 'image'])
        addr = elf.GetSymbolAddress(elf_fname, '__image_copy_start')
1151
        self.assertEqual(syms['_binman_u_boot_spl_prop_offset'].address, addr)
1152

S
Simon Glass 已提交
1153
        self._SetupSplElf('u_boot_binman_syms')
1154
        data = self._DoReadFile('053_symbols.dts')
1155
        sym_values = struct.pack('<LQL', 0x24 + 0, 0x24 + 24, 0x24 + 20)
1156 1157 1158
        expected = (sym_values + U_BOOT_SPL_DATA[16:] +
                    tools.GetBytes(0xff, 1) + U_BOOT_DATA + sym_values +
                    U_BOOT_SPL_DATA[16:])
1159 1160
        self.assertEqual(expected, data)

1161 1162
    def testPackUnitAddress(self):
        """Test that we support multiple binaries with the same name"""
1163
        data = self._DoReadFile('054_unit_address.dts')
1164 1165
        self.assertEqual(U_BOOT_DATA + U_BOOT_DATA, data)

S
Simon Glass 已提交
1166 1167
    def testSections(self):
        """Basic test of sections"""
1168
        data = self._DoReadFile('055_sections.dts')
S
Simon Glass 已提交
1169 1170 1171
        expected = (U_BOOT_DATA + tools.GetBytes(ord('!'), 12) +
                    U_BOOT_DATA + tools.GetBytes(ord('a'), 12) +
                    U_BOOT_DATA + tools.GetBytes(ord('&'), 4))
S
Simon Glass 已提交
1172
        self.assertEqual(expected, data)
1173

1174 1175
    def testMap(self):
        """Tests outputting a map of the images"""
1176
        _, _, map_data, _ = self._DoReadFileDtb('055_sections.dts', map=True)
1177 1178 1179 1180 1181 1182 1183 1184
        self.assertEqual('''ImagePos    Offset      Size  Name
00000000  00000000  00000028  main-section
00000000   00000000  00000010  section@0
00000000    00000000  00000004  u-boot
00000010   00000010  00000010  section@1
00000010    00000000  00000004  u-boot
00000020   00000020  00000004  section@2
00000020    00000000  00000004  u-boot
1185 1186
''', map_data)

1187 1188
    def testNamePrefix(self):
        """Tests that name prefixes are used"""
1189
        _, _, map_data, _ = self._DoReadFileDtb('056_name_prefix.dts', map=True)
1190 1191 1192 1193 1194 1195
        self.assertEqual('''ImagePos    Offset      Size  Name
00000000  00000000  00000028  main-section
00000000   00000000  00000010  section@0
00000000    00000000  00000004  ro-u-boot
00000010   00000010  00000010  section@1
00000010    00000000  00000004  rw-u-boot
1196 1197
''', map_data)

1198 1199 1200
    def testUnknownContents(self):
        """Test that obtaining the contents works as expected"""
        with self.assertRaises(ValueError) as e:
1201
            self._DoReadFile('057_unknown_contents.dts', True)
1202 1203 1204 1205
        self.assertIn("Section '/binman': Internal error: Could not complete "
                "processing of contents: remaining [<_testing.Entry__testing ",
                str(e.exception))

1206 1207 1208
    def testBadChangeSize(self):
        """Test that trying to change the size of an entry fails"""
        with self.assertRaises(ValueError) as e:
1209
            self._DoReadFile('059_change_size.dts', True)
1210 1211 1212
        self.assertIn("Node '/binman/_testing': Cannot update entry size from "
                      '2 to 1', str(e.exception))

1213
    def testUpdateFdt(self):
1214
        """Test that we can update the device tree with offset/size info"""
1215
        _, _, _, out_dtb_fname = self._DoReadFileDtb('060_fdt_update.dts',
1216
                                                     update_dtb=True)
1217 1218 1219
        dtb = fdt.Fdt(out_dtb_fname)
        dtb.Scan()
        props = self._GetPropTree(dtb, ['offset', 'size', 'image-pos'])
1220
        self.assertEqual({
1221
            'image-pos': 0,
1222
            'offset': 0,
1223
            '_testing:offset': 32,
1224
            '_testing:size': 1,
1225
            '_testing:image-pos': 32,
1226
            'section@0/u-boot:offset': 0,
1227
            'section@0/u-boot:size': len(U_BOOT_DATA),
1228
            'section@0/u-boot:image-pos': 0,
1229
            'section@0:offset': 0,
1230
            'section@0:size': 16,
1231
            'section@0:image-pos': 0,
1232

1233
            'section@1/u-boot:offset': 0,
1234
            'section@1/u-boot:size': len(U_BOOT_DATA),
1235
            'section@1/u-boot:image-pos': 16,
1236
            'section@1:offset': 16,
1237
            'section@1:size': 16,
1238
            'section@1:image-pos': 16,
1239 1240 1241 1242 1243 1244
            'size': 40
        }, props)

    def testUpdateFdtBad(self):
        """Test that we detect when ProcessFdt never completes"""
        with self.assertRaises(ValueError) as e:
1245
            self._DoReadFileDtb('061_fdt_update_bad.dts', update_dtb=True)
1246 1247
        self.assertIn('Could not complete processing of Fdt: remaining '
                      '[<_testing.Entry__testing', str(e.exception))
1248

1249 1250 1251 1252 1253 1254
    def testEntryArgs(self):
        """Test passing arguments to entries from the command line"""
        entry_args = {
            'test-str-arg': 'test1',
            'test-int-arg': '456',
        }
1255
        self._DoReadFileDtb('062_entry_args.dts', entry_args=entry_args)
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
        self.assertIn('image', control.images)
        entry = control.images['image'].GetEntries()['_testing']
        self.assertEqual('test0', entry.test_str_fdt)
        self.assertEqual('test1', entry.test_str_arg)
        self.assertEqual(123, entry.test_int_fdt)
        self.assertEqual(456, entry.test_int_arg)

    def testEntryArgsMissing(self):
        """Test missing arguments and properties"""
        entry_args = {
            'test-int-arg': '456',
        }
1268
        self._DoReadFileDtb('063_entry_args_missing.dts', entry_args=entry_args)
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
        entry = control.images['image'].GetEntries()['_testing']
        self.assertEqual('test0', entry.test_str_fdt)
        self.assertEqual(None, entry.test_str_arg)
        self.assertEqual(None, entry.test_int_fdt)
        self.assertEqual(456, entry.test_int_arg)

    def testEntryArgsRequired(self):
        """Test missing arguments and properties"""
        entry_args = {
            'test-int-arg': '456',
        }
        with self.assertRaises(ValueError) as e:
1281
            self._DoReadFileDtb('064_entry_args_required.dts')
1282 1283 1284 1285 1286 1287
        self.assertIn("Node '/binman/_testing': Missing required "
            'properties/entry args: test-str-arg, test-int-fdt, test-int-arg',
            str(e.exception))

    def testEntryArgsInvalidFormat(self):
        """Test that an invalid entry-argument format is detected"""
1288
        args = ['-d', self.TestFile('064_entry_args_required.dts'), '-ano-value']
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
        with self.assertRaises(ValueError) as e:
            self._DoBinman(*args)
        self.assertIn("Invalid entry arguemnt 'no-value'", str(e.exception))

    def testEntryArgsInvalidInteger(self):
        """Test that an invalid entry-argument integer is detected"""
        entry_args = {
            'test-int-arg': 'abc',
        }
        with self.assertRaises(ValueError) as e:
1299
            self._DoReadFileDtb('062_entry_args.dts', entry_args=entry_args)
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
        self.assertIn("Node '/binman/_testing': Cannot convert entry arg "
                      "'test-int-arg' (value 'abc') to integer",
            str(e.exception))

    def testEntryArgsInvalidDatatype(self):
        """Test that an invalid entry-argument datatype is detected

        This test could be written in entry_test.py except that it needs
        access to control.entry_args, which seems more than that module should
        be able to see.
        """
        entry_args = {
            'test-bad-datatype-arg': '12',
        }
        with self.assertRaises(ValueError) as e:
1315
            self._DoReadFileDtb('065_entry_args_unknown_datatype.dts',
1316 1317 1318 1319
                                entry_args=entry_args)
        self.assertIn('GetArg() internal error: Unknown data type ',
                      str(e.exception))

1320 1321 1322 1323 1324 1325 1326
    def testText(self):
        """Test for a text entry type"""
        entry_args = {
            'test-id': TEXT_DATA,
            'test-id2': TEXT_DATA2,
            'test-id3': TEXT_DATA3,
        }
1327
        data, _, _, _ = self._DoReadFileDtb('066_text.dts',
1328
                                            entry_args=entry_args)
S
Simon Glass 已提交
1329 1330 1331
        expected = (tools.ToBytes(TEXT_DATA) +
                    tools.GetBytes(0, 8 - len(TEXT_DATA)) +
                    tools.ToBytes(TEXT_DATA2) + tools.ToBytes(TEXT_DATA3) +
1332
                    b'some text' + b'more text')
1333 1334
        self.assertEqual(expected, data)

1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
    def testEntryDocs(self):
        """Test for creation of entry documentation"""
        with test_util.capture_sys_output() as (stdout, stderr):
            control.WriteEntryDocs(binman.GetEntryModules())
        self.assertTrue(len(stdout.getvalue()) > 0)

    def testEntryDocsMissing(self):
        """Test handling of missing entry documentation"""
        with self.assertRaises(ValueError) as e:
            with test_util.capture_sys_output() as (stdout, stderr):
                control.WriteEntryDocs(binman.GetEntryModules(), 'u_boot')
        self.assertIn('Documentation is missing for modules: u_boot',
                      str(e.exception))

1349 1350
    def testFmap(self):
        """Basic test of generation of a flashrom fmap"""
1351
        data = self._DoReadFile('067_fmap.dts')
1352
        fhdr, fentries = fmap_util.DecodeFmap(data[32:])
S
Simon Glass 已提交
1353 1354
        expected = (U_BOOT_DATA + tools.GetBytes(ord('!'), 12) +
                    U_BOOT_DATA + tools.GetBytes(ord('a'), 12))
1355
        self.assertEqual(expected, data[:32])
S
Simon Glass 已提交
1356
        self.assertEqual(b'__FMAP__', fhdr.signature)
1357 1358 1359 1360 1361 1362
        self.assertEqual(1, fhdr.ver_major)
        self.assertEqual(0, fhdr.ver_minor)
        self.assertEqual(0, fhdr.base)
        self.assertEqual(16 + 16 +
                         fmap_util.FMAP_HEADER_LEN +
                         fmap_util.FMAP_AREA_LEN * 3, fhdr.image_size)
S
Simon Glass 已提交
1363
        self.assertEqual(b'FMAP', fhdr.name)
1364 1365 1366 1367 1368 1369
        self.assertEqual(3, fhdr.nareas)
        for fentry in fentries:
            self.assertEqual(0, fentry.flags)

        self.assertEqual(0, fentries[0].offset)
        self.assertEqual(4, fentries[0].size)
S
Simon Glass 已提交
1370
        self.assertEqual(b'RO_U_BOOT', fentries[0].name)
1371 1372 1373

        self.assertEqual(16, fentries[1].offset)
        self.assertEqual(4, fentries[1].size)
S
Simon Glass 已提交
1374
        self.assertEqual(b'RW_U_BOOT', fentries[1].name)
1375 1376 1377 1378

        self.assertEqual(32, fentries[2].offset)
        self.assertEqual(fmap_util.FMAP_HEADER_LEN +
                         fmap_util.FMAP_AREA_LEN * 3, fentries[2].size)
S
Simon Glass 已提交
1379
        self.assertEqual(b'FMAP', fentries[2].name)
1380

1381 1382 1383 1384 1385
    def testBlobNamedByArg(self):
        """Test we can add a blob with the filename coming from an entry arg"""
        entry_args = {
            'cros-ec-rw-path': 'ecrw.bin',
        }
1386
        data, _, _, _ = self._DoReadFileDtb('068_blob_named_by_arg.dts',
1387 1388
                                            entry_args=entry_args)

1389 1390
    def testFill(self):
        """Test for an fill entry type"""
1391
        data = self._DoReadFile('069_fill.dts')
1392
        expected = tools.GetBytes(0xff, 8) + tools.GetBytes(0, 8)
1393 1394 1395 1396 1397
        self.assertEqual(expected, data)

    def testFillNoSize(self):
        """Test for an fill entry type with no size"""
        with self.assertRaises(ValueError) as e:
1398
            self._DoReadFile('070_fill_no_size.dts')
1399 1400 1401
        self.assertIn("'fill' entry must have a size property",
                      str(e.exception))

1402 1403 1404 1405 1406 1407
    def _HandleGbbCommand(self, pipe_list):
        """Fake calls to the futility utility"""
        if pipe_list[0][0] == 'futility':
            fname = pipe_list[0][-1]
            # Append our GBB data to the file, which will happen every time the
            # futility command is called.
1408
            with open(fname, 'ab') as fd:
1409 1410 1411 1412 1413 1414 1415 1416 1417 1418
                fd.write(GBB_DATA)
            return command.CommandResult()

    def testGbb(self):
        """Test for the Chromium OS Google Binary Block"""
        command.test_result = self._HandleGbbCommand
        entry_args = {
            'keydir': 'devkeys',
            'bmpblk': 'bmpblk.bin',
        }
1419
        data, _, _, _ = self._DoReadFileDtb('071_gbb.dts', entry_args=entry_args)
1420 1421

        # Since futility
1422 1423
        expected = (GBB_DATA + GBB_DATA + tools.GetBytes(0, 8) +
                    tools.GetBytes(0, 0x2180 - 16))
1424 1425 1426 1427 1428
        self.assertEqual(expected, data)

    def testGbbTooSmall(self):
        """Test for the Chromium OS Google Binary Block being large enough"""
        with self.assertRaises(ValueError) as e:
1429
            self._DoReadFileDtb('072_gbb_too_small.dts')
1430 1431 1432 1433 1434 1435
        self.assertIn("Node '/binman/gbb': GBB is too small",
                      str(e.exception))

    def testGbbNoSize(self):
        """Test for the Chromium OS Google Binary Block having a size"""
        with self.assertRaises(ValueError) as e:
1436
            self._DoReadFileDtb('073_gbb_no_size.dts')
1437 1438 1439
        self.assertIn("Node '/binman/gbb': GBB must have a fixed size",
                      str(e.exception))

1440 1441 1442 1443
    def _HandleVblockCommand(self, pipe_list):
        """Fake calls to the futility utility"""
        if pipe_list[0][0] == 'futility':
            fname = pipe_list[0][3]
S
Simon Glass 已提交
1444
            with open(fname, 'wb') as fd:
1445 1446 1447 1448 1449 1450 1451 1452 1453
                fd.write(VBLOCK_DATA)
            return command.CommandResult()

    def testVblock(self):
        """Test for the Chromium OS Verified Boot Block"""
        command.test_result = self._HandleVblockCommand
        entry_args = {
            'keydir': 'devkeys',
        }
1454
        data, _, _, _ = self._DoReadFileDtb('074_vblock.dts',
1455 1456 1457 1458 1459 1460 1461
                                            entry_args=entry_args)
        expected = U_BOOT_DATA + VBLOCK_DATA + U_BOOT_DTB_DATA
        self.assertEqual(expected, data)

    def testVblockNoContent(self):
        """Test we detect a vblock which has no content to sign"""
        with self.assertRaises(ValueError) as e:
1462
            self._DoReadFile('075_vblock_no_content.dts')
1463 1464 1465 1466 1467 1468
        self.assertIn("Node '/binman/vblock': Vblock must have a 'content' "
                      'property', str(e.exception))

    def testVblockBadPhandle(self):
        """Test that we detect a vblock with an invalid phandle in contents"""
        with self.assertRaises(ValueError) as e:
1469
            self._DoReadFile('076_vblock_bad_phandle.dts')
1470 1471 1472 1473 1474 1475
        self.assertIn("Node '/binman/vblock': Cannot find node for phandle "
                      '1000', str(e.exception))

    def testVblockBadEntry(self):
        """Test that we detect an entry that points to a non-entry"""
        with self.assertRaises(ValueError) as e:
1476
            self._DoReadFile('077_vblock_bad_entry.dts')
1477 1478 1479
        self.assertIn("Node '/binman/vblock': Cannot find entry for node "
                      "'other'", str(e.exception))

1480 1481 1482
    def testTpl(self):
        """Test that an image with TPL and ots device tree can be created"""
        # ELF file with a '__bss_size' symbol
1483
        with open(self.TestFile('bss_data'), 'rb') as fd:
1484
            TestFunctional._MakeInputFile('tpl/u-boot-tpl', fd.read())
1485
        data = self._DoReadFile('078_u_boot_tpl.dts')
1486 1487
        self.assertEqual(U_BOOT_TPL_DATA + U_BOOT_TPL_DTB_DATA, data)

1488 1489 1490
    def testUsesPos(self):
        """Test that the 'pos' property cannot be used anymore"""
        with self.assertRaises(ValueError) as e:
1491
           data = self._DoReadFile('079_uses_pos.dts')
1492 1493 1494
        self.assertIn("Node '/binman/u-boot': Please use 'offset' instead of "
                      "'pos'", str(e.exception))

1495 1496
    def testFillZero(self):
        """Test for an fill entry type with a size of 0"""
1497
        data = self._DoReadFile('080_fill_empty.dts')
1498
        self.assertEqual(tools.GetBytes(0, 16), data)
1499

1500 1501 1502
    def testTextMissing(self):
        """Test for a text entry type where there is no text"""
        with self.assertRaises(ValueError) as e:
1503
            self._DoReadFileDtb('066_text.dts',)
1504 1505 1506
        self.assertIn("Node '/binman/text': No value provided for text label "
                      "'test-id'", str(e.exception))

1507 1508
    def testPackStart16Tpl(self):
        """Test that an image with an x86 start16 TPL region can be created"""
1509
        data = self._DoReadFile('081_x86-start16-tpl.dts')
1510 1511
        self.assertEqual(X86_START16_TPL_DATA, data[:len(X86_START16_TPL_DATA)])

1512 1513
    def testSelectImage(self):
        """Test that we can select which images to build"""
1514 1515 1516
        expected = 'Skipping images: image1'

        # We should only get the expected message in verbose mode
1517
        for verbosity in (0, 2):
1518 1519 1520 1521 1522 1523 1524 1525 1526
            with test_util.capture_sys_output() as (stdout, stderr):
                retcode = self._DoTestFile('006_dual_image.dts',
                                           verbosity=verbosity,
                                           images=['image2'])
            self.assertEqual(0, retcode)
            if verbosity:
                self.assertIn(expected, stdout.getvalue())
            else:
                self.assertNotIn(expected, stdout.getvalue())
1527

1528 1529
            self.assertFalse(os.path.exists(tools.GetOutputFilename('image1.bin')))
            self.assertTrue(os.path.exists(tools.GetOutputFilename('image2.bin')))
1530

1531 1532
    def testUpdateFdtAll(self):
        """Test that all device trees are updated with offset/size info"""
1533
        data, _, _, _ = self._DoReadFileDtb('082_fdt_update_all.dts',
1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
                                            use_real_dtb=True, update_dtb=True)

        base_expected = {
            'section:image-pos': 0,
            'u-boot-tpl-dtb:size': 513,
            'u-boot-spl-dtb:size': 513,
            'u-boot-spl-dtb:offset': 493,
            'image-pos': 0,
            'section/u-boot-dtb:image-pos': 0,
            'u-boot-spl-dtb:image-pos': 493,
            'section/u-boot-dtb:size': 493,
            'u-boot-tpl-dtb:image-pos': 1006,
            'section/u-boot-dtb:offset': 0,
            'section:size': 493,
            'offset': 0,
            'section:offset': 0,
            'u-boot-tpl-dtb:offset': 1006,
            'size': 1519
        }

        # We expect three device-tree files in the output, one after the other.
        # Read them in sequence. We look for an 'spl' property in the SPL tree,
        # and 'tpl' in the TPL tree, to make sure they are distinct from the
        # main U-Boot tree. All three should have the same postions and offset.
        start = 0
        for item in ['', 'spl', 'tpl']:
            dtb = fdt.Fdt.FromData(data[start:])
            dtb.Scan()
            props = self._GetPropTree(dtb, ['offset', 'size', 'image-pos',
                                            'spl', 'tpl'])
            expected = dict(base_expected)
            if item:
                expected[item] = 0
            self.assertEqual(expected, props)
            start += dtb._fdt_obj.totalsize()

    def testUpdateFdtOutput(self):
        """Test that output DTB files are updated"""
        try:
1573
            data, dtb_data, _, _ = self._DoReadFileDtb('082_fdt_update_all.dts',
1574 1575 1576 1577
                    use_real_dtb=True, update_dtb=True, reset_dtbs=False)

            # Unfortunately, compiling a source file always results in a file
            # called source.dtb (see fdt_util.EnsureCompiled()). The test
1578
            # source file (e.g. test/075_fdt_update_all.dts) thus does not enter
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
            # binman as a file called u-boot.dtb. To fix this, copy the file
            # over to the expected place.
            #tools.WriteFile(os.path.join(self._indir, 'u-boot.dtb'),
                    #tools.ReadFile(tools.GetOutputFilename('source.dtb')))
            start = 0
            for fname in ['u-boot.dtb.out', 'spl/u-boot-spl.dtb.out',
                          'tpl/u-boot-tpl.dtb.out']:
                dtb = fdt.Fdt.FromData(data[start:])
                size = dtb._fdt_obj.totalsize()
                pathname = tools.GetOutputFilename(os.path.split(fname)[1])
                outdata = tools.ReadFile(pathname)
                name = os.path.split(fname)[0]

                if name:
                    orig_indata = self._GetDtbContentsForSplTpl(dtb_data, name)
                else:
                    orig_indata = dtb_data
                self.assertNotEqual(outdata, orig_indata,
                        "Expected output file '%s' be updated" % pathname)
                self.assertEqual(outdata, data[start:start + size],
                        "Expected output file '%s' to match output image" %
                        pathname)
                start += size
        finally:
            self._ResetDtbs()

S
Simon Glass 已提交
1605
    def _decompress(self, data):
1606
        return tools.Decompress(data, 'lz4')
S
Simon Glass 已提交
1607 1608 1609

    def testCompress(self):
        """Test compression of blobs"""
1610
        data, _, _, out_dtb_fname = self._DoReadFileDtb('083_compress.dts',
S
Simon Glass 已提交
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623
                                            use_real_dtb=True, update_dtb=True)
        dtb = fdt.Fdt(out_dtb_fname)
        dtb.Scan()
        props = self._GetPropTree(dtb, ['size', 'uncomp-size'])
        orig = self._decompress(data)
        self.assertEquals(COMPRESS_DATA, orig)
        expected = {
            'blob:uncomp-size': len(COMPRESS_DATA),
            'blob:size': len(data),
            'size': len(data),
            }
        self.assertEqual(expected, props)

S
Simon Glass 已提交
1624 1625
    def testFiles(self):
        """Test bringing in multiple files"""
1626
        data = self._DoReadFile('084_files.dts')
S
Simon Glass 已提交
1627 1628 1629 1630
        self.assertEqual(FILES_DATA, data)

    def testFilesCompress(self):
        """Test bringing in multiple files and compressing them"""
1631
        data = self._DoReadFile('085_files_compress.dts')
S
Simon Glass 已提交
1632 1633 1634 1635 1636 1637

        image = control.images['image']
        entries = image.GetEntries()
        files = entries['files']
        entries = files._section._entries

S
Simon Glass 已提交
1638
        orig = b''
S
Simon Glass 已提交
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
        for i in range(1, 3):
            key = '%d.dat' % i
            start = entries[key].image_pos
            len = entries[key].size
            chunk = data[start:start + len]
            orig += self._decompress(chunk)

        self.assertEqual(FILES_DATA, orig)

    def testFilesMissing(self):
        """Test missing files"""
        with self.assertRaises(ValueError) as e:
1651
            data = self._DoReadFile('086_files_none.dts')
S
Simon Glass 已提交
1652 1653 1654 1655 1656 1657
        self.assertIn("Node '/binman/files': Pattern \'files/*.none\' matched "
                      'no files', str(e.exception))

    def testFilesNoPattern(self):
        """Test missing files"""
        with self.assertRaises(ValueError) as e:
1658
            data = self._DoReadFile('087_files_no_pattern.dts')
S
Simon Glass 已提交
1659 1660 1661
        self.assertIn("Node '/binman/files': Missing 'pattern' property",
                      str(e.exception))

S
Simon Glass 已提交
1662 1663
    def testExpandSize(self):
        """Test an expanding entry"""
1664
        data, _, map_data, _ = self._DoReadFileDtb('088_expand_size.dts',
S
Simon Glass 已提交
1665
                                                   map=True)
S
Simon Glass 已提交
1666 1667 1668 1669
        expect = (tools.GetBytes(ord('a'), 8) + U_BOOT_DATA +
                  MRC_DATA + tools.GetBytes(ord('b'), 1) + U_BOOT_DATA +
                  tools.GetBytes(ord('c'), 8) + U_BOOT_DATA +
                  tools.GetBytes(ord('d'), 8))
S
Simon Glass 已提交
1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
        self.assertEqual(expect, data)
        self.assertEqual('''ImagePos    Offset      Size  Name
00000000  00000000  00000028  main-section
00000000   00000000  00000008  fill
00000008   00000008  00000004  u-boot
0000000c   0000000c  00000004  section
0000000c    00000000  00000003  intel-mrc
00000010   00000010  00000004  u-boot2
00000014   00000014  0000000c  section2
00000014    00000000  00000008  fill
0000001c    00000008  00000004  u-boot
00000020   00000020  00000008  fill2
''', map_data)

    def testExpandSizeBad(self):
        """Test an expanding entry which fails to provide contents"""
1686 1687
        with test_util.capture_sys_output() as (stdout, stderr):
            with self.assertRaises(ValueError) as e:
1688
                self._DoReadFileDtb('089_expand_size_bad.dts', map=True)
S
Simon Glass 已提交
1689 1690 1691
        self.assertIn("Node '/binman/_testing': Cannot obtain contents when "
                      'expanding entry', str(e.exception))

S
Simon Glass 已提交
1692 1693
    def testHash(self):
        """Test hashing of the contents of an entry"""
1694
        _, _, _, out_dtb_fname = self._DoReadFileDtb('090_hash.dts',
S
Simon Glass 已提交
1695 1696 1697 1698 1699 1700
                use_real_dtb=True, update_dtb=True)
        dtb = fdt.Fdt(out_dtb_fname)
        dtb.Scan()
        hash_node = dtb.GetNode('/binman/u-boot/hash').props['value']
        m = hashlib.sha256()
        m.update(U_BOOT_DATA)
S
Simon Glass 已提交
1701
        self.assertEqual(m.digest(), b''.join(hash_node.value))
S
Simon Glass 已提交
1702 1703 1704

    def testHashNoAlgo(self):
        with self.assertRaises(ValueError) as e:
1705
            self._DoReadFileDtb('091_hash_no_algo.dts', update_dtb=True)
S
Simon Glass 已提交
1706 1707 1708 1709 1710
        self.assertIn("Node \'/binman/u-boot\': Missing \'algo\' property for "
                      'hash node', str(e.exception))

    def testHashBadAlgo(self):
        with self.assertRaises(ValueError) as e:
1711
            self._DoReadFileDtb('092_hash_bad_algo.dts', update_dtb=True)
S
Simon Glass 已提交
1712 1713 1714 1715 1716
        self.assertIn("Node '/binman/u-boot': Unknown hash algorithm",
                      str(e.exception))

    def testHashSection(self):
        """Test hashing of the contents of an entry"""
1717
        _, _, _, out_dtb_fname = self._DoReadFileDtb('099_hash_section.dts',
S
Simon Glass 已提交
1718 1719 1720 1721 1722 1723
                use_real_dtb=True, update_dtb=True)
        dtb = fdt.Fdt(out_dtb_fname)
        dtb.Scan()
        hash_node = dtb.GetNode('/binman/section/hash').props['value']
        m = hashlib.sha256()
        m.update(U_BOOT_DATA)
S
Simon Glass 已提交
1724 1725
        m.update(tools.GetBytes(ord('a'), 16))
        self.assertEqual(m.digest(), b''.join(hash_node.value))
S
Simon Glass 已提交
1726

1727 1728 1729 1730 1731 1732 1733 1734 1735
    def testPackUBootTplMicrocode(self):
        """Test that x86 microcode can be handled correctly in TPL

        We expect to see the following in the image, in order:
            u-boot-tpl-nodtb.bin with a microcode pointer inserted at the correct
                place
            u-boot-tpl.dtb with the microcode removed
            the microcode
        """
1736
        with open(self.TestFile('u_boot_ucode_ptr'), 'rb') as fd:
1737
            TestFunctional._MakeInputFile('tpl/u-boot-tpl', fd.read())
1738
        first, pos_and_size = self._RunMicrocodeTest('093_x86_tpl_ucode.dts',
1739
                                                     U_BOOT_TPL_NODTB_DATA)
S
Simon Glass 已提交
1740 1741
        self.assertEqual(b'tplnodtb with microc' + pos_and_size +
                         b'ter somewhere in here', first)
1742

S
Simon Glass 已提交
1743 1744
    def testFmapX86(self):
        """Basic test of generation of a flashrom fmap"""
1745
        data = self._DoReadFile('094_fmap_x86.dts')
S
Simon Glass 已提交
1746
        fhdr, fentries = fmap_util.DecodeFmap(data[32:])
S
Simon Glass 已提交
1747
        expected = U_BOOT_DATA + MRC_DATA + tools.GetBytes(ord('a'), 32 - 7)
S
Simon Glass 已提交
1748 1749 1750 1751 1752 1753 1754
        self.assertEqual(expected, data[:32])
        fhdr, fentries = fmap_util.DecodeFmap(data[32:])

        self.assertEqual(0x100, fhdr.image_size)

        self.assertEqual(0, fentries[0].offset)
        self.assertEqual(4, fentries[0].size)
S
Simon Glass 已提交
1755
        self.assertEqual(b'U_BOOT', fentries[0].name)
S
Simon Glass 已提交
1756 1757 1758

        self.assertEqual(4, fentries[1].offset)
        self.assertEqual(3, fentries[1].size)
S
Simon Glass 已提交
1759
        self.assertEqual(b'INTEL_MRC', fentries[1].name)
S
Simon Glass 已提交
1760 1761 1762 1763

        self.assertEqual(32, fentries[2].offset)
        self.assertEqual(fmap_util.FMAP_HEADER_LEN +
                         fmap_util.FMAP_AREA_LEN * 3, fentries[2].size)
S
Simon Glass 已提交
1764
        self.assertEqual(b'FMAP', fentries[2].name)
S
Simon Glass 已提交
1765 1766 1767

    def testFmapX86Section(self):
        """Basic test of generation of a flashrom fmap"""
1768
        data = self._DoReadFile('095_fmap_x86_section.dts')
S
Simon Glass 已提交
1769
        expected = U_BOOT_DATA + MRC_DATA + tools.GetBytes(ord('b'), 32 - 7)
S
Simon Glass 已提交
1770 1771 1772 1773 1774 1775 1776
        self.assertEqual(expected, data[:32])
        fhdr, fentries = fmap_util.DecodeFmap(data[36:])

        self.assertEqual(0x100, fhdr.image_size)

        self.assertEqual(0, fentries[0].offset)
        self.assertEqual(4, fentries[0].size)
S
Simon Glass 已提交
1777
        self.assertEqual(b'U_BOOT', fentries[0].name)
S
Simon Glass 已提交
1778 1779 1780

        self.assertEqual(4, fentries[1].offset)
        self.assertEqual(3, fentries[1].size)
S
Simon Glass 已提交
1781
        self.assertEqual(b'INTEL_MRC', fentries[1].name)
S
Simon Glass 已提交
1782 1783 1784 1785

        self.assertEqual(36, fentries[2].offset)
        self.assertEqual(fmap_util.FMAP_HEADER_LEN +
                         fmap_util.FMAP_AREA_LEN * 3, fentries[2].size)
S
Simon Glass 已提交
1786
        self.assertEqual(b'FMAP', fentries[2].name)
S
Simon Glass 已提交
1787

1788 1789
    def testElf(self):
        """Basic test of ELF entries"""
S
Simon Glass 已提交
1790
        self._SetupSplElf()
S
Simon Glass 已提交
1791 1792
        with open(self.TestFile('bss_data'), 'rb') as fd:
            TestFunctional._MakeInputFile('tpl/u-boot-tpl', fd.read())
1793
        with open(self.TestFile('bss_data'), 'rb') as fd:
1794
            TestFunctional._MakeInputFile('-boot', fd.read())
1795
        data = self._DoReadFile('096_elf.dts')
1796

1797
    def testElfStrip(self):
1798
        """Basic test of ELF entries"""
S
Simon Glass 已提交
1799
        self._SetupSplElf()
1800
        with open(self.TestFile('bss_data'), 'rb') as fd:
1801
            TestFunctional._MakeInputFile('-boot', fd.read())
1802
        data = self._DoReadFile('097_elf_strip.dts')
1803

1804 1805 1806 1807
    def testPackOverlapMap(self):
        """Test that overlapping regions are detected"""
        with test_util.capture_sys_output() as (stdout, stderr):
            with self.assertRaises(ValueError) as e:
1808
                self._DoTestFile('014_pack_overlap.dts', map=True)
1809 1810 1811 1812 1813 1814 1815
        map_fname = tools.GetOutputFilename('image.map')
        self.assertEqual("Wrote map file '%s' to show errors\n" % map_fname,
                         stdout.getvalue())

        # We should not get an inmage, but there should be a map file
        self.assertFalse(os.path.exists(tools.GetOutputFilename('image.bin')))
        self.assertTrue(os.path.exists(map_fname))
S
Simon Glass 已提交
1816
        map_data = tools.ReadFile(map_fname, binary=False)
1817 1818 1819 1820 1821 1822
        self.assertEqual('''ImagePos    Offset      Size  Name
<none>    00000000  00000007  main-section
<none>     00000000  00000004  u-boot
<none>     00000003  00000004  u-boot-align
''', map_data)

1823
    def testPackRefCode(self):
1824 1825 1826 1827
        """Test that an image with an Intel Reference code binary works"""
        data = self._DoReadFile('100_intel_refcode.dts')
        self.assertEqual(REFCODE_DATA, data[:len(REFCODE_DATA)])

1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841
    def testSectionOffset(self):
        """Tests use of a section with an offset"""
        data, _, map_data, _ = self._DoReadFileDtb('101_sections_offset.dts',
                                                   map=True)
        self.assertEqual('''ImagePos    Offset      Size  Name
00000000  00000000  00000038  main-section
00000004   00000004  00000010  section@0
00000004    00000000  00000004  u-boot
00000018   00000018  00000010  section@1
00000018    00000000  00000004  u-boot
0000002c   0000002c  00000004  section@2
0000002c    00000000  00000004  u-boot
''', map_data)
        self.assertEqual(data,
1842 1843 1844 1845 1846 1847
                         tools.GetBytes(0x26, 4) + U_BOOT_DATA +
                             tools.GetBytes(0x21, 12) +
                         tools.GetBytes(0x26, 4) + U_BOOT_DATA +
                             tools.GetBytes(0x61, 12) +
                         tools.GetBytes(0x26, 4) + U_BOOT_DATA +
                             tools.GetBytes(0x26, 8))
1848

1849

1850 1851
if __name__ == "__main__":
    unittest.main()