#!/usr/bin/env perl # # SlugImage : Manipulate NSLU2 firmware images # Dwayne Fontenot (jacques) # Rod Whitby (rwhitby) # www.nslu2-linux.org # # Copyright (c) 2004, 2006, Dwayne Fontenot & Rod Whitby # All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions # are met: # # Redistributions of source code must retain the above copyright # notice, this list of conditions and the following disclaimer. # Redistributions in binary form must reproduce the above copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. # Neither the name of the NSLU2-Linux Development Team nor the names # of its contributors may be used to endorse or promote products # derived from this software without specific prior written # permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # use strict; use warnings; use Getopt::Long qw(:config no_ignore_case); use POSIX qw(tmpnam); my($debug) = 0; my($quiet) = 0; my($flash_start) = 0x50000000; my($flash_len) = 0x00800000; my($block_size) = 0x00020000; my($kernel_offset) = 0x00060000; my($kernel_size) = 0x00100000; my($ramdisk_offset) = 0x00160000; my(@cleanup); # The last 70 bytes of the SercommRedBootTrailer (i.e. excluding MAC # address). Needed to create an image with an empty RedBoot partition # since the Sercomm upgrade tool checks for this trailer. # http://www.nslu2-linux.org/wiki/Info/SercommRedBootTrailer my @sercomm_redboot_trailer = (0x4573, 0x4372, 0x4d6f, 0x006d, 0x0001, 0x0400, 0x3170, 0x5895, 0x0010, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0001, 0x0000, 0x0000, 0x0000, 0x0003, 0x2300, 0x0063, 0x0000, 0x7320, 0x7245, 0x6f43, 0x6d4d); # There's a 16 byte Sercomm trailer at the end of the flash. It is used # by RedBoot to detect a Sercomm flash layout and to configure the # Sercomm upgrade system. # http://www.nslu2-linux.org/wiki/Info/SercommFlashTrailer my @sercomm_flash_trailer = (0x0100, 0x0000, 0x6323, 0xf790, 0x5265, 0x4f63, 0x4d6d, 0xb400); # Take $data, and pad it out to $total_len bytes, appending 0xff's. sub padBytes { my($data,$total_len) = @_; # 0xFF is used to pad, as it's the erase value of the flash. my($pad_char) = pack("C",0xff); my($pad_len) = $total_len - length($data); # A request for negative padding is indicative of a logic error ... if (length($data) > $total_len) { die sprintf("padBytes error: data (%d) is longer than total_len (%d)", length($data), $total_len); } return $data . ($pad_char x $pad_len); } # Return the next multiple of block_size larger than or equal to $data_len. sub paddedSize { my($data_len) = @_; use integer; return (($data_len - 1) / $block_size) * $block_size + $block_size; } # Return the number of block_size blocks required to hold $data_len. sub numBlocks { my($data_len) = @_; use integer; return (($data_len - 1) / $block_size) + 1; } # Pack the name, address, size and optional skip regions of a partition entry into binary form. sub createPartitionEntry { my($name, $flash_base, $size, $skips) = @_; my $entry; my($zero_long) = 0x0000; # Pack the partition entry according to the format that RedBoot (and the MTD partition parsing code) requires. $entry = pack("a16N5x212N2",$name,$flash_base,$zero_long,$size,$zero_long,$zero_long,$zero_long,$zero_long); # Optionally put a skip header into the padding area. if (defined $skips) { my $i = scalar(@$skips); foreach my $region (@$skips) { substr($entry, -8 - 12*$i, 12) = pack("a4N2", "skip", $region->{'offset'}, $region->{'size'}); $i--; } } return $entry; } # Parse partition entry and return anon array ref [$name, $offset, $size, $skip] or return 0 on partition terminator. sub parsePartitionEntry { my($partition_entry) = @_; my($entry_len) = 0x100; length($partition_entry) eq $entry_len or die "parsePartitionEntry: partition entry length is not $entry_len!\n"; # Unpack the partition table entry, saving those values in which we are interested. my($name, $flash_base, $size, $dummy_long, $padding, $skips); ($name, $flash_base, $dummy_long, $size, $dummy_long, $dummy_long, $padding, $dummy_long, $dummy_long) = unpack("a16N5a212N2",$partition_entry); # A partition entry starting with 0xFF terminates the table. if (unpack("C", $name) eq 0xff) { # %%% FIXME: This should only skip, not terminate. %%% $debug and print "Found terminator for \n"; return 0; } # Remove trailing nulls from the partition name. $name =~ s/\000+//; # Extract the skip regions out of the padding area. $padding =~ s/^\000+//; $padding =~ s/\000*skip(........)\000*/$1/g; $padding =~ s/\000+$//; # Store the skip regions in an array for later use. while (length($padding)) { my $region = {}; ($region->{'offset'}, $region->{'size'}) = unpack("N2", $padding); $debug and printf("Found skip region at 0x%05X, size 0x%05X\n", $region->{'offset'}, $region->{'size'}); push(@$skips, $region); $padding = substr($padding,8); } return [$name, $flash_base - $flash_start, $size, $skips]; } # Return partition table from data is one exists, otherwise return 0. sub findPartitionTable { my($data_buf) = @_; unpack("a7", $data_buf) eq 'RedBoot' or return 0; return substr($data_buf, 0, 0x1000) } # Parse partition table and return array of anonymous array references ([$name, $offset, $size, $skips], ...). sub parsePartitionTable { my($partition_table) = @_; my(@partitions, $fields_ref); my($entry_len) = 0x100; my($partition_count) = 0; # Loop through the fixed size partition table entries, and store the entries in @partitions. # %%% FIXME: This doesn't handle the case of a completely full partition table. %%% while ($fields_ref = parsePartitionEntry(substr($partition_table, $partition_count * $entry_len, $entry_len))) { $debug and printf("Found <%s> at 0x%08X (%s)%s\n", $fields_ref->[0], $fields_ref->[1], ($fields_ref->[2] >= $block_size ? sprintf("%d blocks", numBlocks($fields_ref->[2])) : sprintf("0x%05X bytes", $fields_ref->[2])), (defined $fields_ref->[3] ? sprintf(" [%s]", join(", ", map { sprintf("0x%05X/0x%05X", $_->{'offset'},$_->{'size'}) } @{$fields_ref->[3]})) : "")); $partitions[$partition_count++] = $fields_ref; } return(@partitions); } # Create an empty jffs2 block. sub jffs2Block { return padBytes(pack("N3", 0x19852003, 0x0000000c, 0xf060dc98), $block_size); } # Write out $data to $filename, sub writeOut { my($data, $filename) = @_; open FILE,">$filename" or die "Can't open file \"$filename\": $!\n"; if (defined($data)) { print FILE $data;} close FILE or die "Can't close file \"$filename\": $!\n"; } # Not used at the moment. sub trailerData { my($product_id) = 0x0001; my($protocol_id) = 0x0000; my($firmware_version) = 0x2325; my($unknown1) = 0x90f7; my($magic_number) = 'eRcOmM'; my($unknown2) = 0x00b9; 
#
# Copyright (C) 2006-2008 OpenWrt.org
#
# This is free software, licensed under the GNU General Public License v2.
# See /LICENSE for more information.
#

WIRELESS_MENU:=Wireless Drivers

define KernelPackage/net-airo
  SUBMENU:=$(WIRELESS_MENU)
  TITLE:=Cisco Aironet driver
  DEPENDS:=@PCI_SUPPORT +@DRIVER_WEXT_SUPPORT
  KCONFIG:=CONFIG_AIRO
  FILES:=$(LINUX_DIR)/drivers/net/wireless/airo.ko
  AUTOLOAD:=$(call AutoProbe,airo)
endef

define KernelPackage/net-airo/description
 Kernel support for Cisco Aironet cards
endef

$(eval $(call KernelPackage,net-airo))


define KernelPackage/net-zd1201
  SUBMENU:=$(WIRELESS_MENU)
  TITLE:=Zydas ZD1201 support
  DEPENDS:=@USB_SUPPORT +@DRIVER_WEXT_SUPPORT +kmod-usb-core
  KCONFIG:=CONFIG_USB_ZD1201
  FILES:=$(LINUX_DIR)/drivers/net/wireless/zd1201.ko
  AUTOLOAD:=$(call AutoProbe,zd1201)
endef

define KernelPackage/net-zd1201/description
 Kernel modules for Zydas ZD1201 support
 Devices using this chip:
   * Sweex LC100020
   * Zyxel ZyAir B-220
   * Peabird USB
   * Gigafast WF741-UIC
   * E-Tech Wireless USB Adapter
   * DSE 802.11b USB wireless LAN adapter
   * CC and C WLAN USB Adapter (WL 1202)
   * Edimax EW-7117U
   * X-Micro WLAN 11b USB Adapter
   * Belkin F5D6051
   * Topcom SKYR@CER WIRELESS USB STICK 11
   * Surecom EP-9001
   * JAHT WN-1011U
   * BeWAN Wi-Fi USB 11
   * NorthQ NQ9000
   * MSI UB11B
   * Origo WLL-1610
   * Longshine LCS-8131R
   * Gigabyte GN-WLBZ201
endef

ZD1201FW_NAME:=zd1201
ZD1201FW_VERSION:=0.14
ZD1201FW_DIR:=$(ZD1201FW_NAME)-$(ZD1201FW_VERSION)-fw
ZD1201FW_FILE:=$(ZD1201FW_DIR).tar.gz

define Download/net-zd1201
  FILE:=$(ZD1201FW_FILE)
  #http://downloads.sourceforge.net/project/linux-lc100020/%28NEW%29%20zd1201%20driver/zd1201.%20Version%200.14/zd1201-0.14-fw.tar.gz
  URL:=@SF/linux-lc100020/%28NEW%29%20$(ZD1201FW_NAME)%20driver/$(ZD1201FW_NAME).%20Version%20$(ZD1201FW_VERSION)/
  MD5SUM:=07a4febc365121f975e2c5e59791d55d
endef

define KernelPackage/net-zd1201/install
	$(INSTALL_DIR) $(1)/lib/firmware
	$(TAR) -C $(1)/lib/firmware -zxf $(DL_DIR)/$(ZD1201FW_FILE) --strip-components=1 $(ZD1201FW_DIR)/$(ZD1201FW_NAME).fw $(ZD1201FW_DIR)/$(ZD1201FW_NAME)-ap.fw
endef

$(eval $(call Download,net-zd1201))
$(eval $(call KernelPackage,net-zd1201))


define KernelPackage/net-prism54
  SUBMENU:=$(WIRELESS_MENU)
  TITLE:=Intersil Prism54 support
  DEPENDS:=@PCI_SUPPORT +@DRIVER_WEXT_SUPPORT
  KCONFIG:=CONFIG_PRISM54
  FILES:=$(LINUX_DIR)/drivers/net/wireless/prism54/prism54.ko
  AUTOLOAD:=$(call AutoProbe,prism54)
endef

define KernelPackage/net-prism54/description
 Kernel modules for Intersil Prism54 support
endef

# Prism54 FullMAC firmware (jbnore.free.fr seems to be rather slow, so we use daemonizer.de)
PRISM54_FW:=1.0.4.3.arm

define Download/net-prism54
  FILE:=$(PRISM54_FW)
  URL:=http://daemonizer.de/prism54/prism54-fw/fw-fullmac/
  MD5SUM:=8bd4310971772a486b9784c77f8a6df9
endef

define KernelPackage/net-prism54/install
	$(INSTALL_DIR) $(1)/lib/firmware
	$(INSTALL_DATA) $(DL_DIR)/$(PRISM54_FW) $(1)/lib/firmware/isl3890
endef

$(eval $(call Download,net-prism54))
$(eval $(call KernelPackage,net-prism54))

define KernelPackage/net-rtl8188eu
  SUBMENU:=$(WIRELESS_MENU)
  TITLE:=RTL8188EU support (staging)
  DEPENDS:=@LINUX_3_13 @USB_SUPPORT +@DRIVER_WEXT_SUPPORT +r8188eu-firmware +kmod-usb-core
  KCONFIG:=\
	CONFIG_STAGING=y \
	CONFIG_R8188EU \
	CONFIG_88EU_AP_MODE=n \
	CONFIG_88EU_P2P=n
  FILES:=$(LINUX_DIR)/drivers/staging/rtl8188eu/r8188eu.ko
  AUTOLOAD:=$(call AutoProbe,r8188eu)
endef

define KernelPackage/net-rtl8188eu/description
 Kernel modules for RealTek RTL8188EU support
endef

$(eval $(call KernelPackage,net-rtl8188eu))
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-25 06:35:21 +0000
->{'offset'} + $block_size; $kernel->{'data'} = padBytes($kernel->{'data'}, $kernel->{'size'} - $kernel->{'header'} - 16); $_->{'offset'} = $ramdisk_offset + $block_size; $_->{'start'} = $flash_start + $_->{'offset'}; $pointer = $_->{'start'}; $debug and printf("Extending kernel partition past ramdisk offset.\n"); } # If this is the last variable size partition, then fill the rest of the space. if ($_->{'name'} eq $lastdisk->{'name'}) { $_->{'size'} = paddedSize($directory_offset + $flash_start - $pointer); $debug and printf("Padding last variable partition <%s> to 0x%08X bytes\n", $_->{'name'}, $_->{'size'}); } die sprintf("Partition size not defined in <%s>.\n", $_->{'name'}) unless defined $_->{'size'}; # Extend to another block if required. if ($size > $_->{'size'}) { if ($_->{'name'} eq $lastdisk->{'name'}) { die sprintf("Ran out of flash space in <%s> - %s too large.\n", $_->{'name'}, sprintf("0x%05X bytes", ($size - $_->{'size'}))); } $_->{'size'} = $size; printf("Extending partition <%s> to 0x%08X bytes\n", $_->{'name'}, $_->{'size'}); } # Keep the user appraised ... $debug and printf("Allocated <%s> from 0x%08X to 0x%08X (%s / %s)\n", $_->{'name'}, $_->{'start'}, $_->{'start'} + $_->{'size'}, ($size >= $block_size ? sprintf("%d blocks", numBlocks($size)) : sprintf("0x%05X bytes", $size)), ($_->{'size'} >= $block_size ? sprintf("%d blocks", numBlocks($_->{'size'})) : sprintf("0x%05X bytes", $_->{'size'}))); # Check to make sure we have not run out of room. if (($_->{'start'} + $_->{'size'}) > ($flash_start + $flash_len)) { die "Ran out of flash space in <", $_->{'name'}, ">\n"; } $debug and printf("Moving pointer from 0x%08X to 0x%08X (0x%08X + 0x%08X)\n", $pointer, paddedSize($_->{'start'} + $_->{'size'}), $_->{'start'}, $_->{'size'}); # Move the pointer up, in preparation for the next partition. $pointer = paddedSize($_->{'start'} + $_->{'size'}); } @partitions; return; } sub buildPartitionTable { my(@partitions) = @_; my($flash_start) = 0x50000000; my($partition_data) = ''; map { # Collate the partition data for all known partitions. if (not $_->{'pseudo'} and defined $_->{'offset'} and defined $_->{'size'}) { # Pack and append the binary table entry for this partition. $partition_data .= createPartitionEntry($_->{'name'}, $_->{'offset'} + $flash_start, $_->{'size'}, $_->{'skips'}); # If this is the FIS directory, then write the partition table data into it. if ($_->{'name'} eq "FIS directory") { # Explicitly terminate the partition data. $partition_data .= pack("C",0xff) x 0x100; $_->{'data'} = padBytes($partition_data, $_->{'size'}); } my $size = length($_->{'data'}); # Keep the user appraised ... $debug and printf("Table entry <%s> from 0x%08X to 0x%08X (%s / %s)%s\n", $_->{'name'}, $_->{'start'}, $_->{'start'} + $_->{'size'}, ($size >= $block_size ? sprintf("%d blocks", numBlocks($size)) : sprintf("0x%05X bytes", $size)), ($_->{'size'} >= $block_size ? sprintf("%d blocks", numBlocks($_->{'size'})) : sprintf("0x%05X bytes", $_->{'size'})), (defined $_->{'skips'} ? sprintf("\nTable entry <%s> skip %s", $_->{'name'}, join(", ", map { sprintf("0x%08X to 0x%08X", $_->{'offset'}, $_->{'offset'} + $_->{'size'} - 1) } @{$_->{'skips'}})) : "") ); } else { $debug and print "No table entry required for <", $_->{'name'}, ">\n"; } } @partitions; return; } sub writeOutFirmware { my($filename, @partitions) = @_; # Clear the image to start. my $image_buf = ""; map { # We can only write a partition if it has an offset, a size, and some data to write. if (defined $_->{'offset'} and defined $_->{'size'} and defined $_->{'data'}) { # Keep track of the end of the image. my $end_point = length($image_buf); # If the next partition is well past the end of the current image, then pad it. if ($_->{'offset'} > $end_point) { $image_buf .= padBytes("", $_->{'offset'} - $end_point); $quiet or printf("Padded %s before <%s> in \"%s\"\n", ((length($image_buf) - $end_point) >= $block_size ? sprintf("%d blocks", numBlocks(length($image_buf) - $end_point)) : sprintf("0x%05X bytes", length($image_buf) - $end_point)), $_->{'name'}, $filename); } # If the next parition is before the end of the current image, then rewind. elsif ($_->{'offset'} < $end_point) { $debug and printf("Rewound %s before <%s> in \"%s\"\n", (($end_point - $_->{'offset'}) >= $block_size ? sprintf("%d blocks", numBlocks($end_point - $_->{'offset'})) : sprintf("0x%05X bytes", $end_point - $_->{'offset'})), $_->{'name'}, $filename); # if (($end_point - $_->{'offset'}) >= $block_size) { # die "Allocation error: rewound a full block or more ...\n"; # } } # If skip regions are defined, add them to the data. if (defined $_->{'skips'}) { my $added = 0; foreach my $region (@{$_->{'skips'}}) { if (($region->{'offset'} > 0) or not ($_->{'header'} > 0)) { $debug and printf("Inserted 0x%05X bytes (at offset 0x%05X) into <%s>\n", $region->{'size'}, $region->{'offset'}, $_->{'name'}); substr($_->{'data'}, $region->{'offset'} + $added - $_->{'header'}, 0, $region->{'data'}); $added += $region->{'size'}; } } } # Splice the data into the image at the appropriate place, padding as required. substr($image_buf, $_->{'offset'}, $_->{'size'}, $_->{'header'} ? padBytes(pack("N4",length($_->{'data'})).$_->{'data'}, $_->{'size'}) : padBytes($_->{'data'}, $_->{'size'})); # Keep the user appraised ... $quiet or printf("Wrote %s (0x%08X to 0x%08X) from <%s> into \"%s\"\n", ($_->{'size'} >= $block_size ? sprintf("%2d blocks", numBlocks($_->{'size'})) : sprintf("0x%05X bytes", $_->{'size'})), $_->{'offset'}, $_->{'offset'}+$_->{'size'}, $_->{'name'}, $filename); } # If we are not able to write a partition, then give debug information about why. else { $debug and printf("Skipping <%s> (%s)\n", $_->{'name'}, (not defined $_->{'offset'}) ? "no offset defined" : ((not defined $_->{'size'}) ? "no size defined" : "no data available")); } } @partitions; # Write the image to the specified file. writeOut($image_buf, $filename); return; } # checkPartitionTable: sanity check partition table - for testing but might evolve into setting @partitions # so that we can write out jffs2 partitions from a read image # currently not nearly paranoid enough sub checkPartitionTable { my($data) = @_; my($pointer) = 0; my($entry); my($name, $flash_base, $size, $done, $dummy_long, $padding); do { $entry = substr($data, $pointer, 0x100); ($name,$flash_base,$dummy_long,$size,$dummy_long,$dummy_long,$padding,$dummy_long,$dummy_long) = unpack("a16N5x212N2",$entry); $name =~ s/\0//g; $debug and printf("pointer: %d\tname: %s%sflash_base: 0x%08X\tsize: 0x%08X\n", $pointer, $name, (" " x (16 - length($name))), $flash_base, $size); $pointer += 0x100; $debug and printf("terminator: 0x%08X\n", unpack("C", substr($data, $pointer, 1))); if (unpack("C", substr($data, $pointer, 1)) eq 0xff) { $done = 1; } } until $done; } sub printPartitions { my(@partitions) = @_; my($offset, $size, $skips); map { # defined $_->{'size'} ? $size = $_->{'size'} : $size = undef; if (defined $_->{'size'}) { $size = $_->{'size'}; } else { $size = undef; } if (defined $_->{'offset'}) { $offset = $_->{'offset'}; } else { $offset = undef; } if (defined $_->{'skips'}) { $skips = $_->{'skips'}; } else { $skips = undef; } printf("%s%s", $_->{'name'}, (" " x (16 - length($_->{'name'})))); if (defined $offset) { printf("0x%08X\t", $offset); } else { printf("(undefined)\t"); }; if (defined $size) { printf("0x%08X", $size); } else { printf("(undefined)"); }; if (defined $skips) { printf("\t[%s]", join(", ", map { sprintf("0x%05X/0x%05X", $_->{'offset'}, $_->{'size'}); } @$skips)); } printf("\n"); } @partitions; } sub defaultPartitions { return ({'name'=>'RedBoot', 'file'=>'RedBoot', 'offset'=>0x00000000, 'size'=>0x00040000, 'variable'=>0, 'header'=>0, 'pseudo'=>0, 'data'=>undef, 'byteswap'=>0}, {'name'=>'EthAddr', 'file'=>undef, 'offset'=>0x0003ffb0, 'size'=>0x00000006, 'variable'=>0, 'header'=>0, 'pseudo'=>1, 'data'=>undef, 'byteswap'=>0}, {'name'=>'SysConf', 'file'=>'SysConf', 'offset'=>0x00040000, 'size'=>0x00020000, 'variable'=>0, 'header'=>0, 'pseudo'=>0, 'data'=>undef, 'byteswap'=>0}, {'name'=>'Loader', 'file'=>'apex.bin', 'offset'=>undef, 'size'=>undef, 'variable'=>1, 'header'=>16, 'pseudo'=>0, 'data'=>undef, 'byteswap'=>0}, {'name'=>'Kernel', 'file'=>'vmlinuz', 'offset'=>undef, 'size'=>undef, 'variable'=>1, 'header'=>16, 'pseudo'=>0, 'data'=>undef, 'byteswap'=>0}, {'name'=>'Ramdisk', 'file'=>'ramdisk.gz', 'offset'=>undef, 'size'=>undef, 'variable'=>1, 'header'=>16, 'pseudo'=>0, 'data'=>undef, 'byteswap'=>0}, {'name'=>'FIS directory', 'file'=>undef, 'offset'=>0x007e0000, 'size'=>0x00020000, 'variable'=>0, 'header'=>0, 'pseudo'=>0, 'data'=>undef, 'byteswap'=>0}, {'name'=>'Loader config', 'file'=>undef, 'offset'=>0x007f8000, 'size'=>0x00004000, 'variable'=>0, 'header'=>0, 'pseudo'=>1, 'data'=>undef, 'byteswap'=>0}, {'name'=>'Microcode', 'file'=>'NPE-B', 'offset'=>0x007fc000, 'size'=>0x00003fe0, 'variable'=>0, 'header'=>16, 'pseudo'=>1, 'data'=>undef, 'byteswap'=>0}, {'name'=>'Trailer', 'file'=>'Trailer', 'offset'=>0x007ffff0, 'size'=>0x00000010, 'variable'=>0, 'header'=>0, 'pseudo'=>1, 'data'=>undef, 'byteswap'=>0}); } # Main routine starts here ... my($unpack, $pack, $little, $fatflash, $input, $output, $redboot); my($kernel, $sysconf, $ramdisk, $fisdir); my($microcode, $trailer, $ethaddr, $loader); END { # Remove temporary files for my $file (@cleanup) { unlink $file; } } if (!GetOptions("d|debug" => \$debug, "q|quiet" => \$quiet, "u|unpack" => \$unpack, "p|pack" => \$pack, "l|little" => \$little, "F|fatflash" => \$fatflash, "i|input=s" => \$input, "o|output=s" => \$output, "b|redboot=s" => \$redboot, "k|kernel=s" => \$kernel, "s|sysconf=s" => \$sysconf, "r|ramdisk=s" => \$ramdisk, "f|fisdir=s" => \$fisdir, "m|microcode=s" => \$microcode, "t|trailer=s" => \$trailer, "e|ethaddr=s" => \$ethaddr, "L|loader=s" => \$loader, ) or (not defined $pack and not defined $unpack)) { print "Usage: slugimage \n"; print "\n"; print " [-d|--debug] Turn on debugging output\n"; print " [-q|--quiet] Turn off status messages\n"; print " [-u|--unpack] Unpack a firmware image\n"; print " [-p|--pack] Pack a firmware image\n"; print " [-l|--little] Convert Kernel and Ramdisk to little-endian\n"; print " [-F|--fatflash] Generate an image for 16MB flash\n"; print " [-i|--input] Input firmware image filename\n"; print " [-o|--output] Output firmware image filename\n"; print " [-b|--redboot] Input/Output RedBoot filename\n"; print " [-s|--sysconf] Input/Output SysConf filename\n"; print " [-L|--loader] Second stage boot loader filename\n"; print " [-k|--kernel] Input/Ouptut Kernel filename\n"; print " [-r|--ramdisk] Input/Output Ramdisk filename(s)\n"; print " [-f|--fisdir] Input/Output FIS directory filename\n"; print " [-m|--microcode] Input/Output Microcode filename\n"; print " [-t|--trailer] Input/Output Trailer filename\n"; print " [-e|--ethaddr] Set the Ethernet address\n"; # %%% TODO %%% Document --ramdisk syntax exit 1; } my(@partitions) = defaultPartitions(); if ($pack) { die "Output filename must be specified\n" unless defined $output; # If we're creating an image and no RedBoot, SysConf partition is # explicitly specified, simply write an empty one as the upgrade tools # don't touch RedBoot and SysConf anyway. If no Trailer is specified, # put in one. if (not defined $redboot and not -e "RedBoot") { $redboot = tmpnam(); open TMP, ">$redboot" or die "Cannot open file $redboot: $!"; push @cleanup, $redboot; # The RedBoot partition is 256 * 1024 = 262144; the trailer we add # is 70 bytes. print TMP "\0"x(262144-70); # Upgrade tools check for an appropriate Sercomm trailer. for my $i (@sercomm_redboot_trailer) { print TMP pack "S", $i; } close TMP; } if (not defined $sysconf and not -e "SysConf") { $sysconf = tmpnam(); open TMP, ">$sysconf" or die "Cannot open file $sysconf: $!"; push @cleanup, $sysconf; # The SysConf partition is 128 * 1024 = 131072 print TMP "\0"x131072; close TMP; } if (not defined $trailer and not -e "Trailer") { $trailer = tmpnam(); open TMP, ">$trailer" or die "Cannot open file $trailer: $!"; push @cleanup, $trailer; for my $i (@sercomm_flash_trailer) { print TMP pack "S", $i; } close TMP; } # If the microcode was not specified, then don't complain that it's missing. if (not defined $microcode and not -e "NPE-B") { map { ($_->{'name'} eq 'Microcode') && ($_->{'file'} = undef); } @partitions; } } # Go through the partition options, and set the names and files in @partitions if (defined $redboot) { map { ($_->{'name'} eq 'RedBoot') && ($_->{'file'} = $redboot); } @partitions; } if (defined $sysconf) { map { ($_->{'name'} eq 'SysConf') && ($_->{'file'} = $sysconf); } @partitions; } if (defined $loader) { map { ($_->{'name'} eq 'Loader') && ($_->{'file'} = $loader); } @partitions; } if (defined $kernel) { map { ($_->{'name'} eq 'Kernel') && ($_->{'file'} = $kernel); } @partitions; } if (defined $fisdir) { map { ($_->{'name'} eq 'FIS directory') && ($_->{'file'} = $fisdir); } @partitions; } if (defined $microcode) { map { ($_->{'name'} eq 'Microcode') && ($_->{'file'} = $microcode); } @partitions; } if (defined $trailer) { map { ($_->{'name'} eq 'Trailer') && ($_->{'file'} = $trailer); } @partitions; } if (defined $little) { map { if (($_->{'name'} eq 'Loader') or ($_->{'name'} eq 'Kernel') or ($_->{'name'} eq 'Ramdisk')) { $_->{'byteswap'} = 1; } } @partitions; } if (defined $fatflash) { $flash_len = 0x01000000; map { if (($_->{'name'} eq 'FIS directory') or ($_->{'name'} eq 'Loader config') or ($_->{'name'} eq 'Microcode') or ($_->{'name'} eq 'Trailer')) { $_->{'offset'} += 0x00800000; } } @partitions; } if (defined $ethaddr) { map { if ($_->{'name'} eq 'EthAddr') { $ethaddr =~ s/://g; if (($ethaddr !~ m/^[0-9A-Fa-f]+$/) or (length($ethaddr) != 12)) { die "Invalid ethernet address specification: '".$ethaddr."'\n"; } $_->{'data'} = pack("H12", $ethaddr); } } @partitions; } if (defined $ramdisk) { # A single filename is used for the ramdisk filename if ($ramdisk !~ m/[:,]/) { map { ($_->{'name'} eq 'Ramdisk') && ($_->{'file'} = $ramdisk); } @partitions; } # otherwise, it's a list of name:file mappings else { my @mappings = split(',', $ramdisk); # Find the index of the Ramdisk entry my $index; my $count = 0; map { if (not defined $index) { if ($_->{'name'} eq "Ramdisk") { $index = $count; } $count++; } } @partitions; defined $index or die "Cannot find the Ramdisk partition\n"; # Replace the Ramdisk entry with the new mappings splice(@partitions, $index, 1, map { # Preserve the information from the ramdisk entry my %entry = %{$partitions[$index]}; # Parse the mapping ($_ =~ m/^([^:]+):([^:]+)(:([^:]+))?$/) or die "Invalid syntax in --ramdisk\n"; $entry{'name'} = $1; $entry{'file'} = $2; my $size = $4; # If the mapping is not for the ramdisk, then undefine its attributes if ($entry{'name'} ne 'Ramdisk') { $entry{'offset'} = undef; $entry{'size'} = undef; $entry{'variable'} = 1; $entry{'header'} = 0; $entry{'pseudo'} = 0; $entry{'data'} = undef; $entry{'byteswap'} = 0; } # Support specification of the number of blocks for empty jffs2 if ($entry{'file'} =~ m/^[0-9]+$/) { $size = $entry{'file'}; $entry{'file'} = undef; } # If the user has specified a size, then respect their wishes if (defined $size) { $entry{'size'} = $size * $block_size; # Create an empty partition of the requested size. $entry{'data'} = padBytes("", $entry{'size'} - $entry{'header'}); } \%entry; } @mappings); } } # Read in the firmware image if ($input) { if ($debug) { print "Initial partition map:\n"; printPartitions(@partitions); } my $result = readInFirmware($input, \@partitions); if ($debug) { print "After reading firmware:\n"; printPartitions(@partitions); } } # Unpack the firmware if requested if ($unpack) { die "Input filename must be specified\n" unless defined $input; # map { # ($_->{'name'} eq 'FIS directory') and @partitions = checkPartitionTable($_->{'data'}); # } @partitions; writeOutFirmwareParts(@partitions); } # Pack the firmware if requested if ($pack) { if (!defined $loader) { removeOptionalLoader(\@partitions); } if ($debug) { print "Initial partition map:\n"; printPartitions(@partitions); } my $result = readInFirmwareParts(@partitions); if ($debug) { print "after readInFirmwareParts():\n"; printPartitions(@partitions); # map { # ($_->{'name'} eq 'RedBoot') && (printRedbootTrailer($_->{'data'})); # } @partitions; } layoutPartitions(@partitions); if ($debug) { print "after layoutPartitions():\n"; printPartitions(@partitions); } buildPartitionTable(@partitions); if ($debug) { print "after buildPartitionTable():\n"; printPartitions(@partitions); # my($lastblock); # map { # if ($_->{'name'} eq 'FIS directory') { # $lastblock = $_->{'data'}; # } # } @partitions; # print "checkPartitionTable():\n"; # checkPartitionTable($lastblock); } writeOutFirmware($output, @partitions); } exit 0;