1UPSLUG2(8) System Manager's Manual UPSLUG2(8)
3
7 upslug2 - utility to upgrade the firmware of a NSLU2 via the network
8
12 upslug2 [options]
13
17 upslug2 is a command line program intended to allow the upgrade the
18 firmware of a LinkSys NSLU2 (Network Storage Link for USB 2.0 Disk
19 Drives) to new or different versions. When a NSLU2 in the local net‐
20 work is put in upgrade mode, upslug2 can connect to it and upload a new
21 firmware.
22 upslug2 will accept a full firmware image but it can also upgrade the
24 flash from individual files holding the kernel, ramdisk and root
25 filesystem. upslug2 provides status information during the upgrade
26 process and verifies the written image after the upgrade.
27
31 -C, --Complete-reprogram
32 Reprogram the complete flash, including the RedBoot boot loader
33 and the SysConf partition holding configuration information.
34 Using this option may result in the NSLU2 becoming permanently
35 unusable! By default, upslug2 will not touch these two parti‐
36 tions since this allows flashing a new firmware if an uploaded
37 firmware does not work. This is not possible if RedBoot itself
38 is damaged. Use with caution.
39 -d, --device
42 The network device on the host machine connected to the network
43 on which the NSLU2 is located. (Default: eth0).
44 -e, --endian
47 The endianness of the files to be uploaded. upslug2 will usu‐
48 ally detected the endianness automatically but this option can
49 be used to force byte swapping to occur. This option accepts
50 three values, separated by comma: endianness of kernel, data and
51 RedBoot FIS directory. Valid values are l (little endian), p
52 (pdp endian) and b (big endian). (Default: ,b,b)
53 -f, --from
56 The MAC address of the host system.
57 -h, --help
60 Show summary of options.
61 -i, --image
64 The flash image to use.
65 -j, --rootfs
68 A root filesystem, usually of type jffs.
69 -k, --kernel
72 A compressed kernel zImage image.
73 -n, --no-reboot
76 Do not reboot after upgrade
77 -p, --payload
80 FIS directory payload. There are about 140 Kb in the last block
81 (between the FIS dir and the trailer at the end) which can be
82 used for data.
83 -r, --ramdisk
86 A compressed ramdisk image.
87 -R, --ram-payload
90 A ram paylod (replaced ramdisk). (FIXME: if it replaced the
91 ramdisk, why cannot you just use the -r option? What's the dif‐
92 ference)
93 -t, --target
96 The MAC address of the NSLU2 to upgrade. Without this option,
97 upslug2 will only perform an upgrade if there is just one NSLU2
98 in upgrade mode.
99 -U, --no-verify
102 Do not verify the image, only upgrade.
103 -v, --verify
106 Do not write to flash, only verify the image.
107 Options to specify firmware information
111 The following options should be used when individual kernel, ramdisk
112 and root filesystem files are specified rather than a firmware image.
113 -E, --extra-version
116 Extra version information, a 2 byte value. (Default: 0x90f7)
117 -F, --firmware-version
120 The firmware version, a 2 byte value. (Default: 0x2329)
121 -P, --product-id
124 The product ID, a 2 byte value. (Default: 1)
125 -T, --protocol-id
128 The protocol ID, a 2 byte value. (Default: 0)
129
133 In order to use upslug2 the NSLU2 which is to be upgraded has to be put
134 in upgrade mode:
135 1. Disconnect any disks and/or devices from the USB ports.
137 2. Power off the NSLU2
139 3. Press and hold the reset button (accessible through the small hole
141 on the back just above the power input).
142 4. Press and release the power button to power on the NSLU2.
144 5. Wait for 10 seconds watching the ready/status LED. After 10 seconds
146 it will change from amber to red. Immediately release the reset button.
147 6. The NSLU2 ready/status LED will flash alternately red/green (there
149 is a 1 second delay before the first green). The NSLU2 is now in
150 upgrade mode.
151 If you decide not to flash the image the NSLU2 can be rebooted by dis‐
153 connecting the power. If the ready/status LED does not turn green
154 after step four it will remain red for several seconds then flash
155 amber. This happens if you do not release the reset button in time -
156 pull the power, reconnect it and repeat from the second step.
157 Once the NSLU2 is in upgrade mode it will remain in this state until
159 either the power is connected or a new image has been flashed. If the
160 flash fails the NSLU2 will (eventually) return to upgrade mode
161
164 The most common use of upslug2 is the following:
165 upslug2 --image NSLU2_V23R63.bin
166 This specifies a firmware image which will be written to flash (with
167 the exception of the RedBoot and SysConf partitions).
168 Alternatively, kernel, ramdisk and root filesystem can be specified
170 individually:
171 upslug2 -k nslu2-zImage -r ramdisk -j root.jffs
172 In this case, the options -E, -F, -P and -T should typically be speci‐
173 fied as well.
174 By default, upslug2 will search for the NSLU2 on the network on your
176 eth0 network interface. If the network is on a different interface,
177 you can easily specify it:
178 upslug2 -d eth1 --image NSLU2_V23R63.bin
179 If there are potentially more than one NSLU2 in your network which may
181 be in upgrade mode, you can specify its MAC address:
182 upslug2 -t 00:11:85:12:34:56 --image NSLU2_V23R63.bin
183
186 slugimage(1)
187
190 John Bowler <jbowler@acm.org>
191 January 2006 UPSLUG2(8)