Updating Firmware

Updating Firmware#

Received a message about a ChipWhisperer firmware update being available? Accidentally erased the firmware on your ChipWhisperer? If so, this page contains all the information you need to get your device up and running again!

Note

All ChipWhisperer scopes and FPGA targets have a ROM base bootloader, meaning it is effectively impossible to “brick” your ChipWhisperer device by updating or erasing its firmware.

Warning

This page only concerns firmware for ChipWhisperer scopes and FPGA boards like the CW310 or CW305, not for integrated targets or CW308 target boards

Warning

This update method for updating firmware only works for ChipWhisperer 5.6 and newer. For ChipWhisperer versions earlier than 5.6, see Firmware Update.

Checking Firmware Version#

The firmware version can be accessed as follows:

>>> import chipwhisperer as cw
>>> scope = cw.scope()      # or target = cw.target(...) for targets
>>> print(scope.fw_version) # or print(target.fw_version) for targets
{'major': 0, 'minor': 11, 'debug': 0}

The version of the newest firmware can be printed as follows:

>>> import chipwhisperer as cw
>>> scope = cw.scope()     # or target = cw.target(...) for targets
>>> print(scope.latest_fw) # or print(target.fw_version) for targets
{'major': 0, 'minor': 11}

If a firmware update is available, the user will be warned when connecting to the scope (or target):

>>> scope = cw.scope()     # or target = cw.target(...) for targets
WARNING:root:Your firmware is outdated - latest is 0.12. Suggested to update firmware, as you may experience errors
See https://chipwhisperer.readthedocs.io/en/latest/firmware.html

Prerequisites#

Windows Prerequisites#

If you are already running ChipWhisperer natively on Windows, no steps are required before upgrading or flashing new firmware onto your ChipWhisperer.

If you have ChipWhisperer installed and are unable to connect due to not having the correct driver, follow the steps shown at How to Change Drivers.

Linux Prerequisites#

If you are running on Linux, you will need to ensure you have access to the serial ports and USB devices. Instructions on how to install the udev rules can be found in the linux install guide.

Mac Prerequisites#

Coming soon!

VirtualBox Prerequisites#

In addition to the prerequisites for your guest system, you will also need to ensure that the serial bootloader is being passed through from your host, like with your other ChipWhisperer devices. To add a USB passthrough filter for the bootloader, go to the settings for your VM > USB and create a new USB filter with the following settings:

  • Name: ATSAM Bootloader

  • Vendor ID: 03eb

  • Product ID: 6124

This should already be done on the ChipWhisperer VM, but may not be present on older VMs.

Upgrading Firmware#

If you just need to update the firmware on your ChipWhisperer, the easiest way is to connect to your ChipWhisperer as usual, then call the upgrade_firmware() method. For example, upgrading a ChipWhisperer-Lite:

>>> import chipwhisperer as cw
>>> scope = cw.scope()
>>> scope.upgrade_firmware()
Entering bootloader mode...
Detected com port COM13
Loading cwlite firmware...
Opened!
Connecting...
Connected!
Erasing...
Erased!
Programming file SAM3U_CW1173.bin...
Programmed!
Verifying...
Verify OK!
Resetting...
Upgrade successful

If you don’t see the “Resetting…” line, you’ll need to power cycle your ChipWhisperer.

Programming New Firmware#

If you’ve erased the firmware on your ChipWhisperer (either accidentally or on purpose, via the “erase” button or jumper), the best way to flash new firmware is to use ChipWhisperer’s program_sam_firmware() function. You will need to specify the device you are upgrading from the following list:

  • ‘cwlite’

  • ‘cw1200’

  • ‘cwnano’

  • ‘cwhusky’

  • ‘cwhuskyplus’

  • ‘cwbergen’

  • ‘cwluna’

  • ‘cw305’

For example, to flash new firmware to a CW305:

>>> import chipwhisperer as cw
>>> cw.program_sam_firmware(hardware_type='cw305')

Old Firmware Upgrade#

For ChipWhisperer versions earlier than 5.6, see Firmware Update.

Troubleshooting#

Firmware upgrade failed#

If scope.upgrade_firmware()/target.upgrade_firmware() fails for any reason, use cw.program_sam_firmware().

Could not find bootloader serial port#

Ensure the device is plugged in. If you’re using a VM, ensure you have the USB device passed through.

Permission Error#

If running on Linux, ensure you have the new 50-newae.rules file in /etc/udev/rules.d/, then run sudo udevadm control --reload-rules.

Additionally, try unplugging and replugging your ChipWhisperer. If the udev rules have been applied properly, you should see a cw_bootloader%n device in /dev/, where %n is some integer.

If you’re still unable to program new firmware, try adding your user to the dialout group:

sudo usermod -a -G dialout $USER

then logging out and back in again.

Accidentally flashed incorrect firmware#

If the firmware you’ve flashed is for another NewAE device, then, as of ChipWhisperer 5.7.1 or commit 068ec19, you can use quick_firmware_erase() as follows to erase the firmware on your device:

from chipwhisperer.hardware.naeusb.naeusb import quick_firmware_erase
quick_firmware_erase(<product_id>)

replacing <product_id> with the product ID of the firmware that you’ve uploaded. For example, if you’ve uploaded ChipWhisperer-Lite (0xACE2) firmware to your ChipWhisperer-Nano (0xACE0), you should use 0xACE2 as your product ID. You may find it helpful to use cw.list_devices() to list connected NewAE devices.

Otherwise, short the erase pins on your ChipWhisperer to enter bootloader mode, then flash the correct firmware onto your device. Go to your device’s page in the Hardware / Capture section to learn where its erase pins are located.

Instructions for shorting the erase pins can be found on the documentation page for your device.

Linux usbserial module Workaround#

There is an issue in some versions of Linux, where the SAM3U is not assigned a serial port when it enters bootloader mode. Here are some steps to resolve this issue (Note. this is not a permanent fix, you must go through these steps each time you put your ChipWhisperer into bootloader mode.). These steps assume you’ve already put ChipWhisperer into bootloader mode.

  1. Unplug your ChipWhisperer (Leave unplugged until instructed otherwise)

  2. Reboot your computer

  3. Once logged in again, open a terminal session

  4. Run this command: sudo modprobe usbserial vendor=0x3eb product=0x6124

  5. Plug your ChipWhisperer back in

  6. Check that a serial port is now open using: ls -l /dev/ttyUSB*

_images/ttyUSB_example.png

You should now be able to program the bootloader from ChipWhisperer Capture through the port you created

If you run into any issues not covered here, or if none of these steps work for you, let us know over at https://forum.newae.com