blob: 158bd7743b7609e5ea73435044ff581b09dd74a0 [file] [log] [blame]
Simon Glassa3f29ec2011-07-17 09:36:49 -07001# Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
Simon Glass8bd05ec2012-03-22 11:09:04 -07005import binascii
Simon Glass3381a1a2012-03-22 11:13:19 -07006import glob
Simon Glassa3f29ec2011-07-17 09:36:49 -07007import os
8import re
9import time
10import tools
11from tools import CmdError
12
13def RoundUp(value, boundary):
14 """Align a value to the next power of 2 boundary.
15
16 Args:
17 value: The value to align.
18 boundary: The boundary value, e.g. 4096. Must be a power of 2.
19
20 Returns:
21 The rounded-up value.
22 """
23 return (value + boundary - 1) & ~(boundary - 1)
24
25
26class WriteFirmware:
27 """Write firmware to a Tegra 2 board using USB A-A cable.
28
29 This class handles re-reflashing a board with new firmware using the Tegra's
30 built-in boot ROM feature. This works by putting the chip into a special mode
31 where it ignores any available firmware and instead reads it from a connected
32 host machine over USB.
33
34 In our case we use that feature to send U-Boot along with a suitable payload
35 and instructions to flash it to SPI flash. The payload is itself normally a
36 full Chrome OS image consisting of U-Boot, some keys and verification
37 information, images and a map of the flash memory.
Simon Glass6a616c12012-09-24 18:13:46 -070038
39 Private attributes:
40 _servo_port: Port number to use to talk to servo with dut-control.
41 Special values are:
42 None: servo is not available.
43 0: any servo will do.
44
Simon Glassa3f29ec2011-07-17 09:36:49 -070045 """
Simon Glass0191a882012-05-23 13:15:06 -070046 def __init__(self, tools, fdt, output, bundle):
Simon Glassa3f29ec2011-07-17 09:36:49 -070047 """Set up a new WriteFirmware object.
48
49 Args:
50 tools: A tools library for us to use.
51 fdt: An fdt which gives us some info that we need.
52 output: An output object to use for printing progress and messages.
Simon Glass0191a882012-05-23 13:15:06 -070053 bundle: A BundleFirmware object which created the image.
Simon Glassa3f29ec2011-07-17 09:36:49 -070054 """
55 self._tools = tools
56 self._fdt = fdt
57 self._out = output
Simon Glass0191a882012-05-23 13:15:06 -070058 self._bundle = bundle
Simon Glass60a40af2012-06-07 11:54:17 -070059 self.text_base = self._fdt.GetInt('/chromeos-config', 'textbase', -1);
Simon Glassa3f29ec2011-07-17 09:36:49 -070060
Simon Glass5b5fd642011-08-17 12:24:01 -070061 # For speed, use the 'update' algorithm and don't verify
62 self.update = True
63 self.verify = False
64
Simon Glass6a616c12012-09-24 18:13:46 -070065 # Use default servo port
66 self._servo_port = 0
67
68 def SelectServo(self, servo):
69 """Select the servo to use for writing firmware.
70
71 Args:
72 servo: String containing description of servo to use:
73 'none' : Don't use servo, generate an error on any attempt.
74 'any' : Use any available servo.
75 '<port>': Use servo with that port number.
76 """
77 if servo == 'none':
78 self._servo_port = None
79 elif servo == 'any':
80 self._servo_port = 0
81 else:
82 self._servo_port = int(servo)
83 self._out.Notice('Servo port %s' % str(self._servo_port))
84
Simon Glass8bd05ec2012-03-22 11:09:04 -070085 def _GetFlashScript(self, payload_size, update, verify, boot_type, checksum,
86 bus='0'):
Simon Glassa3f29ec2011-07-17 09:36:49 -070087 """Get the U-Boot boot command needed to flash U-Boot.
88
89 We leave a marker in the string for the load address of the image,
90 since this depends on the size of this script. This can be replaced by
91 the caller provided that the marker length is unchanged.
92
93 Args:
94 payload_size: Size of payload in bytes.
Simon Glass5b5fd642011-08-17 12:24:01 -070095 update: Use faster update algorithm rather then full device erase
96 verify: Verify the write by doing a readback and CRC
Simon Glass0dcbecb2012-03-22 21:38:55 -070097 boot_type: The source for bootdevice (nand, sdmmc, or spi)
Simon Glass8bd05ec2012-03-22 11:09:04 -070098 checksum: The checksum of the payload (an integer)
99 bus: The bus number
Simon Glassa3f29ec2011-07-17 09:36:49 -0700100
101 Returns:
102 A tuple containing:
103 The script, as a string ready to use as a U-Boot boot command, with an
104 embedded marker for the load address.
105 The marker string, which the caller should replace with the correct
106 load address as 8 hex digits, without changing its length.
107 """
108 replace_me = 'zsHEXYla'
Rhyland Kleinc5c87282012-03-08 16:40:54 -0800109 page_size = 4096
Simon Glass0dcbecb2012-03-22 21:38:55 -0700110 if boot_type == 'sdmmc':
Rhyland Kleinc5c87282012-03-08 16:40:54 -0800111 page_size = 512
Simon Glass0dcbecb2012-03-22 21:38:55 -0700112 if boot_type != 'spi':
Rhyland Kleinc5c87282012-03-08 16:40:54 -0800113 update = False
114
Simon Glassa3f29ec2011-07-17 09:36:49 -0700115 cmds = [
116 'setenv address 0x%s' % replace_me,
117 'setenv firmware_size %#x' % payload_size,
Rhyland Kleinc5c87282012-03-08 16:40:54 -0800118 'setenv length %#x' % RoundUp(payload_size, page_size),
119 'setenv blocks %#x' % (RoundUp(payload_size, page_size) / page_size),
Simon Glass8bd05ec2012-03-22 11:09:04 -0700120 'setenv _crc "crc32 -v ${address} ${firmware_size} %#08x"' %
121 checksum,
Simon Glass5b5fd642011-08-17 12:24:01 -0700122 'setenv _clear "echo Clearing RAM; mw.b ${address} 0 ${length}"',
Doug Anderson37ae2292011-09-15 17:41:57 -0700123 ]
Simon Glass0dcbecb2012-03-22 21:38:55 -0700124 if boot_type == 'nand':
Doug Anderson37ae2292011-09-15 17:41:57 -0700125 cmds.extend([
126 'setenv _init "echo Init NAND; nand info"',
127 'setenv _erase "echo Erase NAND; nand erase 0 ${length}"',
128 'setenv _write "echo Write NAND; nand write ${address} 0 ${length}"',
129 'setenv _read "echo Read NAND; nand read ${address} 0 ${length}"',
130 ])
Simon Glass0dcbecb2012-03-22 21:38:55 -0700131 elif boot_type == 'sdmmc':
Rhyland Kleinc5c87282012-03-08 16:40:54 -0800132 cmds.extend([
133 'setenv _init "echo Init EMMC; mmc rescan 0"',
134 'setenv _erase "echo Erase EMMC; "',
135 'setenv _write "echo Write EMMC; mmc write 0 ${address} 0 ' \
136 '${blocks} boot1"',
137 'setenv _read "echo Read EMMC; mmc read 0 ${address} 0 ' \
138 '${blocks} boot1"',
139 ])
Doug Anderson37ae2292011-09-15 17:41:57 -0700140 else:
141 cmds.extend([
Simon Glass3d9a6c62012-03-15 20:38:04 -0700142 'setenv _init "echo Init SPI; sf probe %s"' % bus,
Doug Anderson37ae2292011-09-15 17:41:57 -0700143 'setenv _erase "echo Erase SPI; sf erase 0 ${length}"',
144 'setenv _write "echo Write SPI; sf write ${address} 0 ${length}"',
145 'setenv _read "echo Read SPI; sf read ${address} 0 ${length}"',
146 'setenv _update "echo Update SPI; sf update ${address} 0 ${length}"',
147 ])
Simon Glassa3f29ec2011-07-17 09:36:49 -0700148
Doug Anderson37ae2292011-09-15 17:41:57 -0700149 cmds.extend([
Simon Glassa3f29ec2011-07-17 09:36:49 -0700150 'echo Firmware loaded to ${address}, size ${firmware_size}, '
151 'length ${length}',
Simon Glass8bd05ec2012-03-22 11:09:04 -0700152 'if run _crc; then',
Simon Glassa3f29ec2011-07-17 09:36:49 -0700153 'run _init',
Doug Anderson37ae2292011-09-15 17:41:57 -0700154 ])
Simon Glass5b5fd642011-08-17 12:24:01 -0700155 if update:
156 cmds += ['time run _update']
157 else:
158 cmds += ['run _erase', 'run _write']
159 if verify:
160 cmds += [
Simon Glassa3f29ec2011-07-17 09:36:49 -0700161 'run _clear',
162 'run _read',
163 'run _crc',
Simon Glass5b5fd642011-08-17 12:24:01 -0700164 ]
165 else:
166 cmds += ['echo Skipping verify']
Simon Glass8bd05ec2012-03-22 11:09:04 -0700167 cmds.extend([
168 'else',
169 'echo',
170 'echo "** Checksum error on load: please check download tool **"',
171 'fi',
172 ])
Simon Glassa3f29ec2011-07-17 09:36:49 -0700173 script = '; '.join(cmds)
174 return script, replace_me
175
Simon Glass3d9a6c62012-03-15 20:38:04 -0700176 def PrepareFlasher(self, uboot, payload, update, verify, boot_type, bus):
Simon Glassa3f29ec2011-07-17 09:36:49 -0700177 """Get a flasher ready for sending to the board.
178
179 The flasher is an executable image consisting of:
180
181 - U-Boot (u-boot.bin);
182 - a special FDT to tell it what to do in the form of a run command;
183 - (we could add some empty space here, in case U-Boot is not built to
184 be relocatable);
185 - the payload (which is a full flash image, or signed U-Boot + fdt).
186
187 Args:
188 uboot: Full path to u-boot.bin.
189 payload: Full path to payload.
Simon Glass5b5fd642011-08-17 12:24:01 -0700190 update: Use faster update algorithm rather then full device erase
191 verify: Verify the write by doing a readback and CRC
Simon Glass0dcbecb2012-03-22 21:38:55 -0700192 boot_type: the src for bootdevice (nand, sdmmc, or spi)
Simon Glassa3f29ec2011-07-17 09:36:49 -0700193
194 Returns:
Simon Glass290a1802011-07-17 13:54:32 -0700195 Filename of the flasher binary created.
Simon Glassa3f29ec2011-07-17 09:36:49 -0700196 """
Simon Glass951a2db2011-07-17 15:58:58 -0700197 fdt = self._fdt.Copy(os.path.join(self._tools.outdir, 'flasher.dtb'))
Simon Glass8bd05ec2012-03-22 11:09:04 -0700198 payload_data = self._tools.ReadFile(payload)
Simon Glassa3f29ec2011-07-17 09:36:49 -0700199 payload_size = os.stat(payload).st_size
200
Simon Glass8bd05ec2012-03-22 11:09:04 -0700201 # Make sure that the checksum is not negative
202 checksum = binascii.crc32(payload_data) & 0xffffffff
203
204 script, replace_me = self._GetFlashScript(len(payload_data), update,
205 verify, boot_type, checksum, bus)
Simon Glassa3f29ec2011-07-17 09:36:49 -0700206 data = self._tools.ReadFile(uboot)
Simon Glass02d124a2012-03-02 14:47:20 -0800207 fdt.PutString('/config', 'bootcmd', script)
Simon Glassa3f29ec2011-07-17 09:36:49 -0700208 fdt_data = self._tools.ReadFile(fdt.fname)
209
210 # Work out where to place the payload in memory. This is a chicken-and-egg
211 # problem (although in case you haven't heard, it was the chicken that
212 # came first), so we resolve it by replacing the string after
213 # fdt.PutString has done its job.
214 #
215 # Correction: Technically, the egg came first. Whatever genetic mutation
216 # created the new species would have been present in the egg, but not the
217 # parent (since if it was in the parent, it would have been present in the
218 # parent when it was an egg).
219 #
220 # Question: ok so who laid the egg then?
221 payload_offset = len(data) + len(fdt_data)
Doug Anderson37ae2292011-09-15 17:41:57 -0700222
223 # NAND driver expects 4-byte alignment. Just go whole hog and do 4K.
224 alignment = 0x1000
Simon Glass8bd05ec2012-03-22 11:09:04 -0700225 payload_offset = (payload_offset + alignment - 1) & ~(alignment - 1)
Doug Anderson37ae2292011-09-15 17:41:57 -0700226
Simon Glass2c4b3e52011-11-15 14:45:43 -0800227 load_address = self.text_base + payload_offset,
Simon Glassa3f29ec2011-07-17 09:36:49 -0700228 new_str = '%08x' % load_address
229 if len(replace_me) is not len(new_str):
230 raise ValueError("Internal error: replacement string '%s' length does "
231 "not match new string '%s'" % (replace_me, new_str))
232 if len(re.findall(replace_me, fdt_data)) != 1:
233 raise ValueError("Internal error: replacement string '%s' already "
234 "exists in the fdt (%d matches)" % (replace_me, matches))
235 fdt_data = re.sub(replace_me, new_str, fdt_data)
236
237 # Now put it together.
238 data += fdt_data
239 data += "\0" * (payload_offset - len(data))
Simon Glass8bd05ec2012-03-22 11:09:04 -0700240 data += payload_data
Simon Glass951a2db2011-07-17 15:58:58 -0700241 flasher = os.path.join(self._tools.outdir, 'flasher-for-image.bin')
Simon Glassa3f29ec2011-07-17 09:36:49 -0700242 self._tools.WriteFile(flasher, data)
243
244 # Tell the user about a few things.
245 self._tools.OutputSize('U-Boot', uboot)
246 self._tools.OutputSize('Payload', payload)
Simon Glass8bd05ec2012-03-22 11:09:04 -0700247 self._out.Notice('Payload checksum %08x' % checksum)
Simon Glassa3f29ec2011-07-17 09:36:49 -0700248 self._tools.OutputSize('Flasher', flasher)
249 return flasher
250
Simon Glass89ecf712012-06-07 12:20:15 -0700251 def _NvidiaFlashImage(self, flash_dest, uboot, bct, payload, bootstub):
Simon Glassa3f29ec2011-07-17 09:36:49 -0700252 """Flash the image to SPI flash.
253
254 This creates a special Flasher binary, with the image to be flashed as
Allen Martinb3aa2672012-03-23 15:55:25 +0000255 a payload. This is then sent to the board using the tegrarcm utility.
Simon Glassa3f29ec2011-07-17 09:36:49 -0700256
257 Args:
Simon Glass2d1fc8b2012-03-22 21:44:50 -0700258 flash_dest: Destination for flasher, or None to not create a flasher
259 Valid options are spi, sdmmc
Simon Glassa3f29ec2011-07-17 09:36:49 -0700260 uboot: Full path to u-boot.bin.
261 bct: Full path to BCT file (binary chip timings file for Nvidia SOCs).
262 payload: Full path to payload.
Simon Glass89ecf712012-06-07 12:20:15 -0700263 bootstub: Full path to bootstub, which is the payload without the
264 signing information (i.e. bootstub is u-boot.bin + the FDT)
Simon Glassa3f29ec2011-07-17 09:36:49 -0700265
266 Returns:
267 True if ok, False if failed.
268 """
Rhyland Kleinc5c87282012-03-08 16:40:54 -0800269 # Use a Regex to pull Boot type from BCT file.
270 match = re.compile('DevType\[0\] = NvBootDevType_(?P<boot>([a-zA-Z])+);')
271 bct_dumped = self._tools.Run('bct_dump', [bct]).splitlines()
Simon Glass2d1fc8b2012-03-22 21:44:50 -0700272
273 # TODO(sjg): The boot type is currently selected by the bct, rather than
274 # flash_dest selecting which bct to use. This is a bit backwards. For now
275 # we go with the bct's idea.
Rhyland Kleinc5c87282012-03-08 16:40:54 -0800276 boot_type = filter(match.match, bct_dumped)
Simon Glass0dcbecb2012-03-22 21:38:55 -0700277 boot_type = match.match(boot_type[0]).group('boot').lower()
Doug Anderson37ae2292011-09-15 17:41:57 -0700278
Simon Glass89ecf712012-06-07 12:20:15 -0700279 if flash_dest:
280 image = self.PrepareFlasher(uboot, payload, self.update, self.verify,
281 boot_type, 0)
Simon Glasse1824db2012-07-11 17:38:40 +0200282 elif bootstub:
Simon Glass89ecf712012-06-07 12:20:15 -0700283 image = bootstub
Simon Glassa3f29ec2011-07-17 09:36:49 -0700284
Simon Glasse1824db2012-07-11 17:38:40 +0200285 else:
286 image = payload
287 # If we don't know the textbase, extract it from the payload.
288 if self.text_base == -1:
289 data = self._tools.ReadFile(payload)
290 # Skip the BCT which is the first 64KB
291 self.text_base = self._bundle.DecodeTextBase(data[0x10000:])
292
Simon Glass89ecf712012-06-07 12:20:15 -0700293 self._out.Notice('TEXT_BASE is %#x' % self.text_base)
Simon Glassa3f29ec2011-07-17 09:36:49 -0700294 self._out.Progress('Uploading flasher image')
295 args = [
Simon Glassa3f29ec2011-07-17 09:36:49 -0700296 '--bct', bct,
Allen Martinb3aa2672012-03-23 15:55:25 +0000297 '--bootloader', image,
298 '--loadaddr', "%#x" % self.text_base
Simon Glassa3f29ec2011-07-17 09:36:49 -0700299 ]
300
301 # TODO(sjg): Check for existence of board - but chroot has no lsusb!
302 last_err = None
303 for tries in range(10):
304 try:
Simon Glassa3f29ec2011-07-17 09:36:49 -0700305 # TODO(sjg): Use Chromite library so we can monitor output
Allen Martinb3aa2672012-03-23 15:55:25 +0000306 self._tools.Run('tegrarcm', args, sudo=True)
Simon Glassa3f29ec2011-07-17 09:36:49 -0700307 self._out.Notice('Flasher downloaded - please see serial output '
308 'for progress.')
309 return True
310
311 except CmdError as err:
312 if not self._out.stdout_is_tty:
313 return False
314
315 # Only show the error output once unless it changes.
316 err = str(err)
Simon Glass22190ff2012-07-11 14:52:26 +0200317 if not 'could not open USB device' in err:
Allen Martinb3aa2672012-03-23 15:55:25 +0000318 raise CmdError('tegrarcm failed: %s' % err)
Simon Glassa3f29ec2011-07-17 09:36:49 -0700319
320 if err != last_err:
321 self._out.Notice(err)
322 last_err = err
323 self._out.Progress('Please connect USB A-A cable and do a '
324 'recovery-reset', True)
325 time.sleep(1)
326
327 return False
Simon Glass710dedc2011-08-09 14:08:52 -0700328
Simon Glass27a9c142012-03-15 21:08:29 -0700329 def _WaitForUSBDevice(self, name, vendor_id, product_id, timeout=10):
330 """Wait until we see a device on the USB bus.
331
332 Args:
333 name: Board type name
334 vendor_id: USB vendor ID to look for
335 product_id: USB product ID to look for
336 timeout: Timeout to wait in seconds
337
338 Returns
339 True if the device was found, False if we timed out.
340 """
341 self._out.Progress('Waiting for board to appear on USB bus')
Simon Glass4968a472012-05-23 13:52:19 -0700342 start_time = time.time()
343 while time.time() - start_time < timeout:
Simon Glass27a9c142012-03-15 21:08:29 -0700344 try:
345 args = ['-d', '%04x:%04x' % (vendor_id, product_id)]
346 self._tools.Run('lsusb', args, sudo=True)
Simon Glass3381a1a2012-03-22 11:13:19 -0700347 self._out.Progress('Found %s board' % name)
Simon Glass27a9c142012-03-15 21:08:29 -0700348 return True
349
350 except CmdError as err:
351 pass
352
Simon Glass3381a1a2012-03-22 11:13:19 -0700353 return False
Simon Glass27a9c142012-03-15 21:08:29 -0700354
Simon Glass6a616c12012-09-24 18:13:46 -0700355 def _DutControl(self, args):
356 """Run dut-control with supplied arguments.
357
358 The correct servo will be used based on self._servo_port.
359
360 Args:
361 args: List of arguments to dut-control.
362
363 Raises:
364 IOError if no servo access is permitted.
365 """
366 if self._servo_port is None:
367 raise IOError('No servo access available, please use --servo')
368 if self._servo_port:
369 args.extend(['-p', '%s' % self._servo_port])
370 self._tools.Run('dut-control', args)
371
Simon Glass3c5b35b2012-05-23 13:22:23 -0700372 def _ExtractPayloadParts(self, payload):
373 """Extract the BL1, BL2 and U-Boot parts from a payload.
374
375 An exynos image consists of 3 parts: BL1, BL2 and U-Boot/FDT.
376
377 This pulls out the various parts, puts them into files and returns
378 these files.
379
380 Args:
381 payload: Full path to payload.
382
383 Returns:
384 (bl1, bl2, image) where:
385 bl1 is the filename of the extracted BL1
386 bl2 is the filename of the extracted BL2
387 image is the filename of the extracted U-Boot image
388 """
389 # Pull out the parts from the payload
390 bl1 = os.path.join(self._tools.outdir, 'bl1.bin')
391 bl2 = os.path.join(self._tools.outdir, 'bl2.bin')
392 image = os.path.join(self._tools.outdir, 'u-boot-from-image.bin')
393 data = self._tools.ReadFile(payload)
394
395 # The BL1 is always 8KB - extract that part into a new file
396 # TODO(sjg@chromium.org): Perhaps pick these up from the fdt?
397 self._tools.WriteFile(bl1, data[:0x2000])
398
399 # The BL2 (U-Boot SPL) is 14KB and follows BL1. After that there is
400 # a 2KB gap
401 self._tools.WriteFile(bl2, data[0x2000:0x5800])
402
403 # U-Boot itself starts at 24KB, after the gap
404 self._tools.WriteFile(image, data[0x6000:])
405 return bl1, bl2, image
406
Simon Glassde9c8072012-07-02 22:29:02 -0700407 def _ExynosFlashImage(self, flash_dest, flash_uboot, bl1, bl2, payload,
408 kernel):
Simon Glass27a9c142012-03-15 21:08:29 -0700409 """Flash the image to SPI flash.
410
411 This creates a special Flasher binary, with the image to be flashed as
Allen Martinb3aa2672012-03-23 15:55:25 +0000412 a payload. This is then sent to the board using the tegrarcm utility.
Simon Glass27a9c142012-03-15 21:08:29 -0700413
414 Args:
Simon Glass2d1fc8b2012-03-22 21:44:50 -0700415 flash_dest: Destination for flasher, or None to not create a flasher
416 Valid options are spi, sdmmc.
417 flash_uboot: Full path to u-boot.bin to use for flasher.
Simon Glass27a9c142012-03-15 21:08:29 -0700418 bl1: Full path to file containing BL1 (pre-boot).
Simon Glass2d1fc8b2012-03-22 21:44:50 -0700419 bl2: Full path to file containing BL2 (SPL).
Simon Glass27a9c142012-03-15 21:08:29 -0700420 payload: Full path to payload.
Simon Glassde9c8072012-07-02 22:29:02 -0700421 kernel: Kernel to send after the payload, or None.
Simon Glass27a9c142012-03-15 21:08:29 -0700422
423 Returns:
424 True if ok, False if failed.
425 """
Simon Glass2d1fc8b2012-03-22 21:44:50 -0700426 if flash_dest:
427 image = self.PrepareFlasher(flash_uboot, payload, self.update,
428 self.verify, flash_dest, '1:0')
429 else:
Simon Glass3c5b35b2012-05-23 13:22:23 -0700430 bl1, bl2, image = self._ExtractPayloadParts(payload)
Simon Glass27a9c142012-03-15 21:08:29 -0700431
432 vendor_id = 0x04e8
433 product_id = 0x1234
Simon Glass3381a1a2012-03-22 11:13:19 -0700434
435 self._out.Progress('Reseting board via servo')
436 args = ['warm_reset:on', 'fw_up:on', 'pwr_button:press', 'sleep:.1',
437 'warm_reset:off']
438 # TODO(sjg) If the board is bricked a reset does not seem to bring it
439 # back to life.
440 # BUG=chromium-os:28229
441 args = ['cold_reset:on', 'sleep:.2', 'cold_reset:off'] + args
Simon Glass6a616c12012-09-24 18:13:46 -0700442 self._DutControl(args)
Simon Glass27a9c142012-03-15 21:08:29 -0700443
Simon Glassde9c8072012-07-02 22:29:02 -0700444 # If we have a kernel to write, create a new image with that added.
445 if kernel:
446 dl_image = os.path.join(self._tools.outdir, 'image-plus-kernel.bin')
447 data = self._tools.ReadFile(image)
448
449 # Pad the original payload out to the original length
450 data += '\0' * (os.stat(payload).st_size - len(data))
451 data += self._tools.ReadFile(kernel)
452 self._tools.WriteFile(dl_image, data)
453 else:
454 dl_image = image
455
Simon Glass2d1fc8b2012-03-22 21:44:50 -0700456 self._out.Progress('Uploading image')
Simon Glass27a9c142012-03-15 21:08:29 -0700457 download_list = [
Simon Glass3c5b35b2012-05-23 13:22:23 -0700458 # The numbers are the download addresses (in SRAM) for each piece
459 # TODO(sjg@chromium.org): Perhaps pick these up from the fdt?
Simon Glass27a9c142012-03-15 21:08:29 -0700460 ['bl1', 0x02021400, bl1],
461 ['bl2', 0x02023400, bl2],
Simon Glassde9c8072012-07-02 22:29:02 -0700462 ['u-boot', 0x43e00000, dl_image]
Simon Glass27a9c142012-03-15 21:08:29 -0700463 ]
Simon Glass3381a1a2012-03-22 11:13:19 -0700464 try:
Simon Glass4968a472012-05-23 13:52:19 -0700465 for upto in range(len(download_list)):
466 item = download_list[upto]
Simon Glass3381a1a2012-03-22 11:13:19 -0700467 if not self._WaitForUSBDevice('exynos', vendor_id, product_id, 4):
Simon Glass4968a472012-05-23 13:52:19 -0700468 if upto == 0:
Simon Glass3381a1a2012-03-22 11:13:19 -0700469 raise CmdError('Could not find Exynos board on USB port')
470 raise CmdError("Stage '%s' did not complete" % item[0])
Simon Glass3381a1a2012-03-22 11:13:19 -0700471 self._out.Notice(item[2])
Simon Glass27a9c142012-03-15 21:08:29 -0700472 self._out.Progress("Uploading stage '%s'" % item[0])
Simon Glass3381a1a2012-03-22 11:13:19 -0700473
Simon Glass4968a472012-05-23 13:52:19 -0700474 if upto == 0:
475 # The IROM needs roughly 200ms here to be ready for USB download
476 time.sleep(.5)
477
Simon Glass79e3dd02012-08-28 20:08:50 -0700478 args = ['-a', '%#x' % item[1], '-f', item[2]]
479 self._tools.Run('smdk-usbdl', args, sudo=True)
Simon Glass4968a472012-05-23 13:52:19 -0700480 if upto == 1:
481 # Once SPL starts up we can release the power buttom
482 args = ['fw_up:off', 'pwr_button:release']
Simon Glass6a616c12012-09-24 18:13:46 -0700483 self._DutControl(args)
Simon Glass4968a472012-05-23 13:52:19 -0700484
Simon Glass3381a1a2012-03-22 11:13:19 -0700485 finally:
Simon Glass4968a472012-05-23 13:52:19 -0700486 # Make sure that the power button is released, whatever happens
Simon Glass3381a1a2012-03-22 11:13:19 -0700487 args = ['fw_up:off', 'pwr_button:release']
Simon Glass6a616c12012-09-24 18:13:46 -0700488 self._DutControl(args)
Simon Glass27a9c142012-03-15 21:08:29 -0700489
Simon Glass2d1fc8b2012-03-22 21:44:50 -0700490 self._out.Notice('Image downloaded - please see serial output '
Simon Glass3381a1a2012-03-22 11:13:19 -0700491 'for progress.')
Simon Glass27a9c142012-03-15 21:08:29 -0700492 return True
493
Simon Glass0c2ba482012-03-22 21:57:51 -0700494 def _GetDiskInfo(self, disk, item):
495 """Returns information about a SCSI disk device.
496
497 Args:
498 disk: a block device name in sys/block, like '/sys/block/sdf'.
499 item: the item of disk information that is required.
500
501 Returns:
502 The information obtained, as a string, or '[Unknown]' if not found
503 """
504 dev_path = os.path.join(disk, 'device')
505
506 # Search upwards and through symlinks looking for the item.
507 while os.path.isdir(dev_path) and dev_path != '/sys':
508 fname = os.path.join(dev_path, item)
509 if os.path.exists(fname):
510 with open(fname, 'r') as fd:
511 return fd.readline().rstrip()
512
513 # Move up a level and follow any symlink.
514 new_path = os.path.join(dev_path, '..')
515 if os.path.islink(new_path):
516 new_path = os.path.abspath(os.readlink(os.path.dirname(dev_path)))
517 dev_path = new_path
518 return '[Unknown]'
519
520 def _GetDiskCapacity(self, device):
521 """Returns the disk capacity in GB, or 0 if not known.
522
523 Args:
524 device: Device to check, like '/dev/sdf'.
525
526 Returns:
527 Capacity of device in GB, or 0 if not known.
528 """
529 args = ['-l', device]
530 stdout = self._tools.Run('fdisk', args, sudo=True)
531 if stdout:
532 # Seach for the line with capacity information.
533 re_capacity = re.compile('Disk .*: (\d+) \w+,')
534 lines = filter(re_capacity.match, stdout.splitlines())
535 if len(lines):
536 m = re_capacity.match(lines[0])
537
538 # We get something like 7859 MB, so turn into bytes, then GB
539 return int(m.group(1)) * 1024 * 1024 / 1e9
540 return 0
541
542 def _ListUsbDisks(self):
543 """Return a list of available removable USB disks.
544
545 Returns:
546 List of USB devices, each element is itself a list containing:
547 device ('/dev/sdx')
548 manufacturer name
549 product name
550 capacity in GB (an integer)
551 full description (all of the above concatenated).
552 """
553 disk_list = []
554 for disk in glob.glob('/sys/block/sd*'):
555 with open(disk + '/removable', 'r') as fd:
556 if int(fd.readline()) == 1:
557 device = '/dev/%s' % disk.split('/')[-1]
558 manuf = self._GetDiskInfo(disk, 'manufacturer')
559 product = self._GetDiskInfo(disk, 'product')
560 capacity = self._GetDiskCapacity(device)
561 if capacity:
562 desc = '%s: %s %s %d GB' % (device, manuf, product, capacity)
563 disk_list.append([device, manuf, product, capacity, desc])
564 return disk_list
565
566 def WriteToSd(self, flash_dest, disk, uboot, payload):
567 if flash_dest:
Simon Glass559b6612012-05-23 13:28:45 -0700568 raw_image = self.PrepareFlasher(uboot, payload, self.update, self.verify,
Simon Glass0c2ba482012-03-22 21:57:51 -0700569 flash_dest, '1:0')
Simon Glass559b6612012-05-23 13:28:45 -0700570 bl1, bl2, payload_data = self._ExtractPayloadParts(payload)
571 spl_load_size = os.stat(raw_image).st_size
572 bl2 = self._bundle.ConfigureExynosBl2(self._fdt, spl_load_size, bl2,
573 'flasher')
574
575 data = self._tools.ReadFile(bl1) + self._tools.ReadFile(bl2)
576
577 # Pad BL2 out to the required size.
578 # We require that it be 24KB, but data will only contain 8KB + 14KB.
579 # Add the extra padding to bring it to 24KB.
580 data += '\0' * (0x6000 - len(data))
581 data += self._tools.ReadFile(raw_image)
582 image = os.path.join(self._tools.outdir, 'flasher-with-bl.bin')
583 self._tools.WriteFile(image, data)
Simon Glass0c2ba482012-03-22 21:57:51 -0700584 self._out.Progress('Writing flasher to %s' % disk)
585 else:
586 image = payload
587 self._out.Progress('Writing image to %s' % disk)
588
589 args = ['if=%s' % image, 'of=%s' % disk, 'bs=512', 'seek=1']
590 self._tools.Run('dd', args, sudo=True)
591
592 def SendToSdCard(self, dest, flash_dest, uboot, payload):
593 """Write a flasher to an SD card.
594
595 Args:
596 dest: Destination in one of these forms:
597 ':<full description of device>'
598 ':.' selects the only available device, fails if more than one option
599 ':<device>' select deivce
600
601 Examples:
602 ':/dev/sdd: Generic Flash Card Reader/Writer 8 GB'
603 ':.'
604 ':/dev/sdd'
605
606 flash_dest: Destination for flasher, or None to not create a flasher:
607 Valid options are spi, sdmmc.
608 uboot: Full path to u-boot.bin.
609 payload: Full path to payload.
610 """
611 disk = None
612 disks = self._ListUsbDisks()
613 if dest[:1] == ':':
614 name = dest[1:]
615
616 # A '.' just means to use the only available disk.
617 if name == '.' and len(disks) == 1:
618 disk = disks[0][0]
619 for disk_info in disks:
620 # Use the full name or the device name.
621 if disk_info[4] == name or disk_info[1] == name:
622 disk = disk_info[0]
623
624 if disk:
625 self.WriteToSd(flash_dest, disk, uboot, payload)
626 else:
627 self._out.Error("Please specify destination -w 'sd:<disk_description>':")
628 self._out.Error(' - description can be . for the only disk, SCSI '
629 'device letter')
630 self._out.Error(' or the full description listed here')
631 msg = 'Found %d available disks.' % len(disks)
632 if not disks:
633 msg += ' Please insert an SD card and try again.'
634 self._out.UserOutput(msg)
635
636 # List available disks as a convenience.
637 for disk in disks:
638 self._out.UserOutput(' %s' % disk[4])
639
Simon Glass9eb8c722012-06-07 13:34:31 -0700640 def _Em100FlashImage(self, image_fname):
641 """Send an image to an attached EM100 device.
642
643 This is a Dediprog EM100 SPI flash emulation device. We set up servo2
644 to do the SPI emulation, then write the image, then boot the board.
645 All going well, this is enough to get U-Boot running.
646
647 Args:
648 image_fname: Filename of image to send
649 """
650 args = ['spi2_vref:off', 'spi2_buf_en:off', 'spi2_buf_on_flex_en:off']
651 args.append('spi_hold:on')
Simon Glass6a616c12012-09-24 18:13:46 -0700652 self._DutControl(args)
Simon Glass9eb8c722012-06-07 13:34:31 -0700653
654 # TODO(sjg@chromium.org): This is for link. We could make this
655 # configurable from the fdt.
656 args = ['-c', 'W25Q64CV', '-d', self._tools.Filename(image_fname), '-r']
657 self._out.Progress('Writing image to em100')
658 self._tools.Run('em100', args, sudo=True)
659
660 self._out.Progress('Resetting board')
661 args = ['cold_reset:on', 'sleep:.2', 'cold_reset:off', 'sleep:.5']
662 args.extend(['pwr_button:press', 'sleep:.2', 'pwr_button:release'])
Simon Glass6a616c12012-09-24 18:13:46 -0700663 self._DutControl(args)
Simon Glass9eb8c722012-06-07 13:34:31 -0700664
Simon Glass0c2ba482012-03-22 21:57:51 -0700665
Simon Glass27a9c142012-03-15 21:08:29 -0700666def DoWriteFirmware(output, tools, fdt, flasher, file_list, image_fname,
Simon Glass60a40af2012-06-07 11:54:17 -0700667 bundle, update=True, verify=False, dest=None,
Simon Glass6a616c12012-09-24 18:13:46 -0700668 flash_dest=None, kernel=None, props={}, servo='any'):
Simon Glasse0b61442012-03-13 15:29:51 -0700669 """A simple function to write firmware to a device.
Simon Glass710dedc2011-08-09 14:08:52 -0700670
671 This creates a WriteFirmware object and uses it to write the firmware image
Simon Glasse0b61442012-03-13 15:29:51 -0700672 to the given destination device.
Simon Glass710dedc2011-08-09 14:08:52 -0700673
674 Args:
675 output: cros_output object to use.
676 tools: Tools object to use.
677 fdt: Fdt object to use as our device tree.
678 flasher: U-Boot binary to use as the flasher.
Simon Glass75759302012-03-15 20:26:53 -0700679 file_list: Dictionary containing files that we might need.
Simon Glass710dedc2011-08-09 14:08:52 -0700680 image_fname: Filename of image to write.
Simon Glass0191a882012-05-23 13:15:06 -0700681 bundle: The bundle object which created the image.
Simon Glass2c4b3e52011-11-15 14:45:43 -0800682 update: Use faster update algorithm rather then full device erase.
683 verify: Verify the write by doing a readback and CRC.
Simon Glasse0b61442012-03-13 15:29:51 -0700684 dest: Destination device to write firmware to (usb, sd).
Simon Glass2d1fc8b2012-03-22 21:44:50 -0700685 flash_dest: Destination device for flasher to program payload into.
Simon Glassde9c8072012-07-02 22:29:02 -0700686 kernel: Kernel file to write after U-Boot
Simon Glass794217e2012-06-07 11:40:37 -0700687 props: A dictionary containing properties from the PackFirmware object
Simon Glass6a616c12012-09-24 18:13:46 -0700688 servo: Describes the servo unit to use: none=none; any=any; otherwise
689 port number of servo to use.
Simon Glass710dedc2011-08-09 14:08:52 -0700690 """
Simon Glass0191a882012-05-23 13:15:06 -0700691 write = WriteFirmware(tools, fdt, output, bundle)
Simon Glass6a616c12012-09-24 18:13:46 -0700692 write.SelectServo(servo)
Simon Glass5b5fd642011-08-17 12:24:01 -0700693 write.update = update
694 write.verify = verify
Simon Glasse0b61442012-03-13 15:29:51 -0700695 if dest == 'usb':
696 method = fdt.GetString('/chromeos-config', 'flash-method', 'tegra')
697 if method == 'tegra':
Allen Martinb3aa2672012-03-23 15:55:25 +0000698 tools.CheckTool('tegrarcm')
Simon Glasse1824db2012-07-11 17:38:40 +0200699 bootstub = props.get('bootstub')
Simon Glass89ecf712012-06-07 12:20:15 -0700700 if flash_dest:
701 write.text_base = bundle.CalcTextBase('flasher ', fdt, flasher)
Simon Glasse1824db2012-07-11 17:38:40 +0200702 elif bootstub:
Simon Glass89ecf712012-06-07 12:20:15 -0700703 write.text_base = bundle.CalcTextBase('bootstub ', fdt, bootstub)
Simon Glass2d1fc8b2012-03-22 21:44:50 -0700704 ok = write._NvidiaFlashImage(flash_dest, flasher, file_list['bct'],
Simon Glass89ecf712012-06-07 12:20:15 -0700705 image_fname, bootstub)
Simon Glass27a9c142012-03-15 21:08:29 -0700706 elif method == 'exynos':
Simon Glass2c389062012-04-09 13:09:01 -0700707 tools.CheckTool('lsusb', 'usbutils')
708 tools.CheckTool('smdk-usbdl', 'smdk-dltool')
Simon Glass2d1fc8b2012-03-22 21:44:50 -0700709 ok = write._ExynosFlashImage(flash_dest, flasher,
Simon Glassde9c8072012-07-02 22:29:02 -0700710 file_list['exynos-bl1'], file_list['exynos-bl2'], image_fname,
711 kernel)
Simon Glasse0b61442012-03-13 15:29:51 -0700712 else:
713 raise CmdError("Unknown flash method '%s'" % method)
714 if ok:
715 output.Progress('Image uploaded - please wait for flashing to '
716 'complete')
717 else:
718 raise CmdError('Image upload failed - please check board connection')
Simon Glass9eb8c722012-06-07 13:34:31 -0700719 elif dest == 'em100':
720 # crosbug.com/31625
721 tools.CheckTool('em100')
722 write._Em100FlashImage(image_fname)
Simon Glass0c2ba482012-03-22 21:57:51 -0700723 elif dest.startswith('sd'):
724 write.SendToSdCard(dest[2:], flash_dest, flasher, image_fname)
Simon Glass710dedc2011-08-09 14:08:52 -0700725 else:
Simon Glasse0b61442012-03-13 15:29:51 -0700726 raise CmdError("Unknown destination device '%s'" % dest)