Merge lp:~tony-mansson/linaro-image-tools/snowball-support into lp:linaro-image-tools/11.11

[Loïc Minier]

This is initial support for snowball

[Loïc Minier (lool)]

We should move to some file.txt format which lists the "magic" values like filenames to read from, and all the other TOC contents; something like:
foo.txt:
# name, relative file path, address, flag?, flag?
ISSW boot_image_issw.bin -1 0 0
X-LOADER boot_image_x-loader.bin -1 0 0
MEM_INIT mem_init.bin 0 0x160000 0
PWR_MGT power_management.bin 0 0x170000 0
NORMAL u-boot.bin 0 0xBA0000 0
UBOOT_ENV u-boot-env.bin 0 0x00C1F000 0

then we'd add a linaro-media-create --snowball-toc-contents flag which would read that file

[Loïc Minier (lool)]

It would be nice to have more descriptive names for the flags rather than "flag"

[Loïc Minier (lool)]

The dev/BoardConfig names should be tweaked a bit; perhaps "SnowballSdConfig" and "SnowballEmmcConfig"

LOADER_START_S should be renamed to SNOWBALL_LOADER_START_S

[Mattias Backman (mabac)]

In f2f meeting Friday last week Loïc and Tony agreed that the options --mmc and '--dev snowball' cannot be used together. Code to block that should be added.

[Mattias Backman (mabac)]

> It would be nice to have more descriptive names for the flags rather than
> "flag"

Here's the spec. http://igloocommunity.org/support/index.php/ConfigPartitionOverview

create_toc() writes the toc as:
           data = struct.pack('<IIIii12s',
                              address,
                              size,
                              0, flag, flag,
                              section)

Seems like 'flags' in the toc according to the spec is set to 0 while 'flag' is written to the toc fields align and load_address.

[Mattias Backman (mabac)]

I suggest we consider this superseeded by https://code.launchpad.net/~mabac/linaro-image-tools/snowball-support/+merge/61582 so that I can help with this work more efficiently.

=== modified file 'linaro_image_tools/media_create/boards.py'
--- linaro_image_tools/media_create/boards.py	2011-04-26 16:37:19 +0000
+++ linaro_image_tools/media_create/boards.py	2011-05-13 14:11:44 +0000
@@ -495,6 +495,136 @@
         make_boot_script(boot_env, boot_script_path)
 
 
+class SnowballSdcardConfig(Ux500Config):
+    '''Use only with --mmc option. Creates the standard vfat and ext2
+       partitions for kernel and rootfs on an SD card.
+       Note that the Snowball board needs a loader partition on the
+       internal eMMC flash to boot. That partition is created with
+       the SnowballConfigImage configuration.'''
+
+    @classmethod
+    def _make_boot_files(cls, boot_env, chroot_dir, boot_dir,
+                         boot_device_or_file, k_img_data, i_img_data,
+                         d_img_data):
+        make_uImage(cls.load_addr, k_img_data, boot_dir)
+        boot_script_path = os.path.join(boot_dir, cls.boot_script)
+        make_boot_script(boot_env, boot_script_path)
+
+
+class SnowballImageConfig(SnowballSdcardConfig):
+    '''Use only with --image option. Creates a raw image which contains an
+       additional (raw) loader partition, containing some boot stages
+       and u-boot.'''
+    # Boot ROM looks for a boot table of contents (TOC) at 0x20000
+    # Actually, it first looks at address 0, but that's where l-m-c
+    # puts the MBR, so the boot loader skips that address. 
+    LOADER_START_S = (128 * 1024) / SECTOR_SIZE
+
+    @classmethod
+    def get_sfdisk_cmd(cls, should_align_boot_part=None):
+        """Return the sfdisk command to partition the media.
+
+        :param should_align_boot_part: Ignored.
+
+        The Snowball partitioning scheme depends on whether the target is
+        a raw image or an SD card. Both targets have the normal
+        FAT 32 boot partition and EXT? root partition.
+        The raw image prepends these two partitions with a raw loader partition,
+        containing HW-dependent boot stages up to and including u-boot.
+        This is done since the boot rom always boots off the internal memory;
+        there simply is no point to having a loader partition on SD card.
+        """
+        # boot ROM expects bootloader at 0x20000, which is sector 0x100 
+        # with the usual SECTOR_SIZE of 0x200.
+        # (sector 0 is MBR / partition table)
+        loader_start, loader_end, loader_len = align_partition(
+            SnowballImageConfig.LOADER_START_S, 
+            LOADER_MIN_SIZE_S, 1, PART_ALIGN_S)
+
+        boot_start, boot_end, boot_len = align_partition(
+            loader_end + 1, BOOT_MIN_SIZE_S, PART_ALIGN_S, PART_ALIGN_S)
+        # we ignore _root_end / _root_len and return an sfdisk command to
+        # instruct the use of all remaining space; XXX if we had some root size
+        # config, we could do something more sensible
+        root_start, _root_end, _root_len = align_partition(
+            boot_end + 1, ROOT_MIN_SIZE_S, PART_ALIGN_S, PART_ALIGN_S)
+
+        return '%s,%s,0xDA\n%s,%s,0x0C,*\n%s,,,-' % (
+        loader_start, loader_len, boot_start, boot_len, root_start)
+
+
+    @classmethod
+    def _make_boot_files(cls, boot_env, chroot_dir, boot_dir,
+                         boot_device_or_file, k_img_data, i_img_data,
+                         d_img_data):
+        make_uImage(cls.load_addr, k_img_data, boot_dir)
+        boot_script_path = os.path.join(boot_dir, cls.boot_script)
+        make_boot_script(boot_env, boot_script_path)
+        toc_filename = 'toc.bin'
+        # Adresses are relative the toc at 0x20000
+        files = [('ISSW', 'boot_image_issw.bin', -1, 0, 0),
+                 ('X-LOADER', 'boot_image_x-loader.bin', -1, 0, 0),
+                 ('MEM_INIT', 'mem_init.bin', 0, 0x160000, 0),
+                 ('PWR_MGT', 'power_management.bin', 0, 0x170000, 0),
+                 ('NORMAL', 'u-boot.bin', 0, 0xBA0000, 0),
+                 ('UBOOT_ENV', 'u-boot-env.bin', 0, 0x00C1F000, 0)]
+        config_files_path = os.path.join(chroot_dir, 'boot')
+        new_files = get_file_info(config_files_path, files)
+        with open(toc_filename, 'wb') as toc:
+            create_toc(toc, new_files)
+        install_snowball_boot_loader(toc_filename, new_files, 
+                                     boot_device_or_file, cls.LOADER_START_S)
+        os.remove(toc_filename)
+
+
+
+def install_snowball_boot_loader(toc_file_name, files, 
+                                 boot_device_or_file, start_sector):
+    ''' Copies TOC and boot files into the boot partition.
+        A sector size of 1 is used for some files, as they do not
+        necessarily start on an even address. '''
+    _dd(toc_file_name, boot_device_or_file, seek=start_sector)
+    for item in files:
+        section, filename, dummy_flag, offset, size = item
+        if (offset % SECTOR_SIZE) != 0:
+            seek_bytes = start_sector * SECTOR_SIZE + offset
+            _dd(filename, boot_device_or_file, block_size=1, seek=seek_bytes)
+        else:
+            seek_sectors = start_sector + offset/SECTOR_SIZE
+            _dd(filename, boot_device_or_file, seek=seek_sectors)
+
+
+def create_toc(f, files):
+    ''' Writes a table of contents of the boot binaries.
+        Boot rom searches this table to find the binaries.'''
+    for item in files:
+        section, filename, flag, address, size = item
+        data = struct.pack('<IIIii12s', 
+                           address,
+                           size, 
+                           0, flag, flag, 
+                           section)
+        f.write(data)
+
+
+def get_file_info(bin_dir, files):
+    ''' Fills in the offsets of files that are located in
+        non-absolute memory locations depending on their sizes.'
+        Also fills in file sizes'''
+    toc_size = 512
+    ofs = toc_size
+    for i in range(len(files)):
+        section, filename, flag, address, sz = files[i]
+        filename = os.path.join(bin_dir, filename)
+        if address != 0:
+            ofs = address
+        size = os.path.getsize(filename)
+        files[i] = section, filename, flag, ofs, size
+        ofs += size
+    return files
+
+
+
 class Mx5Config(BoardConfig):
     serial_tty = 'ttymxc0'
     extra_serial_opts = 'console=tty0 console=%s,115200n8' % serial_tty
@@ -687,6 +817,8 @@
     'panda': PandaConfig,
     'vexpress': VexpressConfig,
     'ux500': Ux500Config,
+    'snowball_sdcard': SnowballSdcardConfig,
+    'snowball_image': SnowballImageConfig,
     'efikamx': EfikamxConfig,
     'efikasb': EfikasbConfig,
     'mx51evk': Mx51evkConfig,

=== modified file 'linaro_image_tools/media_create/tests/test_media_create.py'
--- linaro_image_tools/media_create/tests/test_media_create.py	2011-05-10 15:05:57 +0000
+++ linaro_image_tools/media_create/tests/test_media_create.py	2011-05-13 14:11:44 +0000
@@ -213,6 +213,18 @@
         expected = ['make_uImage', 'make_uInitrd', 'make_boot_script']
         self.assertEqual(expected, self.funcs_calls)
 
+    def test_snowball_sdcard_steps(self):
+        self.make_boot_files(boards.SnowballSdcardConfig)
+        expected = ['make_uImage', 'make_boot_script']
+        self.assertEqual(expected, self.funcs_calls)
+
+    def test_snowball_image_steps(self):
+        self.make_boot_files(boards.SnowballImageConfig)
+        expected = ['make_uImage', 'make_boot_script',
+                    'get_file_info', 'create_toc', 
+                    'install_snowball_boot_loader']
+        self.assertEqual(expected, self.funcs_calls)
+
     def test_panda_steps(self):
         self.mock_set_appropriate_serial_tty(boards.PandaConfig)
         self.make_boot_files(boards.PandaConfig)
@@ -330,6 +342,16 @@
             '1,8191,0xDA\n8192,106496,0x0C,*\n114688,,,-',
             boards.Mx5Config.get_sfdisk_cmd())
 
+    def test_snowball_sdcard(self):
+        self.assertEqual(
+            '63,106432,0x0C,*\n106496,,,-',
+            boards.SnowballSdcardConfig.get_sfdisk_cmd())
+
+    def test_snowball_image(self):
+        self.assertEqual(
+            '256,7936,0xDA\n8192,106496,0x0C,*\n114688,,,-',
+            boards.SnowballImageConfig.get_sfdisk_cmd())
+
     def test_smdkv310(self):
         self.assertEquals(
             '1,8191,0xDA\n8192,106496,0x0C,*\n114688,,,-',
@@ -393,6 +415,23 @@
                        'bootm 0x00100000 0x08000000'}
         self.assertEqual(expected, boot_commands)
 
+    def test_snowball_image(self):
+        boot_commands = board_configs['snowball_image']._get_boot_env(
+            is_live=False, is_lowmem=False, consoles=[],
+            rootfs_uuid="deadbeef", d_img_data=None)
+        expected = {
+            'bootargs': 'console=tty0 console=ttyAMA2,115200n8  '
+                        'root=UUID=deadbeef rootwait ro earlyprintk '
+                        'rootdelay=1 fixrtc nocompcache mem=96M@0 '
+                        'mem_modem=32M@96M mem=44M@128M pmem=22M@172M '
+                        'mem=30M@194M mem_mali=32M@224M pmem_hwb=54M@256M '
+                        'hwmem=48M@302M mem=152M@360M',
+            'bootcmd': 'fatload mmc 1:1 0x00100000 uImage; '
+                       'fatload mmc 1:1 0x08000000 uInitrd; '
+                       'bootm 0x00100000 0x08000000'}
+        self.assertEqual(expected, boot_commands)
+
+
     def test_panda(self):
         # XXX: To fix bug 697824 we have to change class attributes of our
         # OMAP board configs, and some tests do that so to make sure they