SIM card related Projects » SIMtrace 2

{{>toc}}

h1. Flashing

There are several ways to flash firmware images, depending on the image you can to flash.

h2. DFU

SIMtrace 2 comes with a USB DFU bootloader pre-installed which allows to flash the application firmware over USB using the @dfu-util@ utility.

To get @dfu-util@:

<pre>

sudo apt-get install dfu-util

</pre>

To flash the firmware:

<pre>

sudo dfu-util --device 1d50:PID --cfg 1 --alt 1 --reset --download BOARD-APP-dfu.bin

</pre>

*PID* is the USB product ID for the corresponding [[Wiki#Hardware|hardware platform]]:

* @60e3@ for the [[Wiki#SIMtrace 2|SIMtrace 2 board]]

* @4004@ for the [[Wiki#sysmoQMOD|sysmoQMOD board]]

*BOARD* is the name of the target board for which the firmware image has been built:

* @simtrace@ for the [[Wiki#SIMtrace 2|SIMtrace 2 board]]

* @qmod@ for the [[Wiki#sysmoQMOD|sysmoQMOD board]]

*APP* is the firmware application name as listed in the [[Wiki#Firmware|firmware section]].

You can find pre-built images on the [[Wiki#Firmware|firmware section]].

To prevent having to use @sudo@ in order to use @dfu-util@ on SIMtrace 2, grant access permission to the USB device to the current user:

<pre>

# add current user to plugdev group (user needs to re-login for this change to take effect)

sudo adduser $USERNAME plugdev

# grant access permission to SIMtrace 2 for plugdev group

sudo wget --output-file=/etc/udev/rules.d/99-simtrace2.rules https://git.osmocom.org/simtrace2/plain/host/99-simtrace2.rules 

# reload udev rules

sudo udevadm control --reload-rules

sudo udevadm trigger

</pre>

h3. Forcing DFU

@dfu-util@ should reset the board and start the DFU bootloader.

Try the command a second time if it did not work at first.

If this still does not work, you can force the board to boot the DFU bootloader:

* on [[Wiki#SIMtrace 2|SIMtrace 2 boards]] keep the *BOOTLOADER* button pressed while shortly pressing on the *RESET* button

!{width:20%}simtrace-board-buttons.jpg!

* on [[Wiki#sysmoQMOD|sysmoQMOD boards]] short the TX and RX pins next to the micro-controller while powering the board.

!{width:20%}sysmoqmod-dfu.jpg!

If the USB DFU bootloader is missing, defective, or needs to be updated, use the JTAG or SAMBA methods to flash the bootloader firmware.

h2. SAMBA

The SAM3S micro-controller comes with an embedded bootloader called SAMBA, allowing to flash firmwares over USB.

The SAMBA bootloader can be used to flash the DFU bootloader.

To activate the SAMBA bootloader on [[Wiki#SIMtrace 2|SIMtrace 2 boards]]:

# short the *ERASE* pin on the top of the board with the nearby 3V3 pin using a jumper

!{width:20%}simtrace-jumper-mini.jpg!

# connect SIMtrace 2 over USB to power it up (no LED will light up) and wait 1 second

# remove the jumper shorting *ERASE* to 3V3

To activate the SAMBA bootloader on [[Wiki#sysmoQMOD|sysmoQMOD boards]]:

# connect using an USB to UART adapter to the serial port on the SAM3S micro-controller *opposite* of the one you want to reflash

!{width:20%}sysmoqmod-dfu.jpg!

# the serial configuration is 115200 8N1

# enter 'y'

# wait 1 second

# enter 'Y'

To verifry if the SAMBA bootloader has been started:

# using @lsusb@ you should find the following entry:

<pre>

ID 03eb:6124 Atmel Corp. at91sam SAMBA bootloader

</pre>

# using @journalctl -f@ ensure SIMtrace 2 has been recognized as USB ACM device:

<pre>

kernel: usb 2-2: new full-speed USB device number 4 using xhci_hcd

kernel: usb 2-2: New USB device found, idVendor=03eb, idProduct=6124

kernel: usb 2-2: New USB device strings: Mfr=0, Product=0, SerialNumber=0

kernel: cdc_acm 2-2:1.0: ttyACM0: USB ACM device

kernel: usbcore: registered new interface driver cdc_acm

kernel: cdc_acm: USB Abstract Control Model driver for USB modems and ISDN adapters

</pre>

To flash using the SAMBA bootloader:

# install the @bossac@ utility to flash using the SAMBA protocol

<pre>

sudo apt install bossac

</pre>

# download the DFU bootloader firmware image corresponding to your board:

** attachment:simtrace-dfu-flash.bin for [[Wiki#SIMtrace 2|SIMtrace 2 boards]]

** attachment:qmod-dfu-flash.bin for [[Wiki#sysmoQMOD|sysmoQMOD boards]]

# flash the USB DFU firmware using @bossac@ (note: @erase@ ensures no main application remains so to force booting the USB DFU bootloader; @boot=1@ ensures the micro-controller will boot from the internal flash instead of the embedded bootloader next time it is powered up)

<pre>

sudo bossac --port /dev/ttyACM0 --erase --write BOARD-dfu-flash.bin --verify --boot=1

</pre>

## using the following firmware image:

# to prevent using @sudo@, grant to current user the permission to access USB serial devices (e.g. @/dev/ttyACM0@). Note: this change only takes effect after re-logging-in

<pre>

sudo adduser $USERNAME dialout

</pre>

Once the USB DFU bootloader is flashed, when re-pluging the SIMtrace 2 device over USB, you can flash the main application firmware using the [[Flashing#DFU|DFU]] method.

h2. JTAG

It is also possible to flash or debug [[Wiki#SIMtrace 2|SIMtrace 2 boards]] over JTAG using the ARM 20-pin JTAG header on the top of the board.

To flash the USB DFU firmware using JTAG:

# install the JTAG utility @openOCD@

<pre>

sudo apt install openocd

</pre>

# flash the USB DFU bootloader firmware

<pre>

openocd --file interface/jlink.cfg --file target/at91sam3sXX.cfg --command "init" --command "halt" --command "flash write_bank 0 simtrace-dfu-flash.bin 0" --command "at91sam3 gpnvm set 1" --command "reset" --command "shutdown"

</pre>

#* replace @interface/jlink.cfg@ with the configuration file for your JTAG debugging adapter

#* @at91sam3 gpnvm set 1@ ensures the micro-controller will boot from the internal flash (i.e. not from the embedded SAMBA bootloader)

The SAM3S also offers the low pin-count SWD alternative to JTAG, allowing to use an inexpensive ST-Link V2 (clone) to flash (and debug):

<pre>

openocd --file interface/stlink-v2.cfg --command "set CPUTAPID 0x2ba01477" --file target/at91sam3sXX.cfg --command "init" --command "halt" --command "flash write_bank 0 simtrace-dfu-flash.bin 0" --command "at91sam3 gpnvm set 1" --command "reset" --command "shutdown"

</pre>

SWD pinout:

!{width:20%}simtrace_swd.jpg!

Once the USB DFU bootloader is flashed, when re-pluging SIMtrace 2 over USB, you can flash the main application firmware using the DFU method.