[[PageOutline]]

= Updating Venice Firmware / Software

This page is all about updating / flashing firmware / software onto a Venice SBC. 

The various components of the 'firmware' on a Venice board which you may want to update from time to time are (lowest level components listed first):
- GSC firmware
- SPL
- Linux device-tree
- U-Boot bootloader
- Linux kernel
- root filesystem

Some components above you can update individually in Linux using {{{dd}}} or in U-Boot using {{{mmc write}}} taking care to place them at the right offset.

[=#images]
= Pre-Built Images

Various Pre-built images can be found on http://dev.gateworks.com/venice including:
 * '''Compressed Disk Images''': (*.img.gz files) OS Images (everything but boot firmware)
  - [http://dev.gateworks.com/venice/images/jammy-venice.img.gz jammy-venice.img.gz] - Gateworks Ubuntu based OS details are available [wiki:venice/ubuntu here]
  - [http://dev.gateworks.com/venice/images/openwrt-23.03-venice.img.gz openwrt-23.03-venice.img.gz] - Gateworks OpenWrt OS details are available [wiki:OpenWrt here]
  * '''[#disk-images Install compressed disk images via U-Boot or Linux using instructions here]'''
 * '''Gateworks System Controller Firmware''': (board specific gsc*.txt files)
  - [http://dev.gateworks.com/venice/images/gsc_7000.txt gsc_7000.txt] - for boards with a GW700x IMX8MM SOM module
  - [http://dev.gateworks.com/venice/images/gsc_7000.txt gsc_7020.txt] - for boards with a GW702x IMX8MP SOM module
  - [http://dev.gateworks.com/venice/images/gsc_7400.txt gsc_7400.txt] - for GW74xx IMX8MP boards
  * '''[wiki:gsc#firmware Install GSC firmware via JTAG or Linux via instructions here]'''
 * '''Boot Firmware''': (SOC specific) Everything up to the OS (SPL, ATF, U-Boot, U-Boot env)
  - For updating via U-Boot or Linux or booting via SDP (does not contain U-Boot env)
   * [http://dev.gateworks.com/venice/boot_firmware/venice-imx8mm-flash.bin venice-imx8mm-flash.bin] - for IMX8MM SOC
   * [http://dev.gateworks.com/venice/boot_firmware/venice-imx8mp-flash.bin venice-imx8mp-flash.bin] - for IMX8MP SOC
   - '''[#boot-firmware For updating via U-Boot or Linux see here]'''
   - '''[wiki:venice/SDP For booting over USB via the SDP protocol (helpful during bootloader development or customization) see here]'''
  - For updating via JTAG:
   * [http://dev.gateworks.com/venice/images/firmware-venice-imx8mm.bin firmware-venice-imx8mm.bin] - for IMX8MM SOC
   * [http://dev.gateworks.com/venice/images/firmware-venice-imx8mp.bin firmware-venice-imx8mp.bin] - for IMX8MP SOC
   - '''[wiki:jtag_instructions for details For JTAG programming instructions see here]'''
 * '''Venice Kernel Tarball''' useful for installing on top of root filesystem manually
  * [http://dev.gateworks.com/venice/kernel/linux-venice.tar.xz linux-venice.tar.xz] - Compressed TAR archive of pre-built Linux kernel

Gateworks System Controller files are 'board specific' meaning the file used depends on the baseboard or SOM model. Boot firmware images are 'SOC specific' meaning there is a specific one to match the SOC on your board - IMX8M Mini (imx8mm) vs IMX8M Nano (imx8mn) vs IMX8M Plus (imx8mp). Compressed Disk Images are written to the eMMC user partition which contains a disk partition table and the various OS partitions (assuming the boot firmware is booting from emmc boot0 or boot1 hardware partition).


[=#firmware-version]
= Firmware Versioning

You can determine the firmware version of various portions of the firmware by looking for banners on the serial console. For example:
{{{#!bash
U-Boot SPL 2020.04-g0a0109fcfb (Oct 07 2020 - 19:30:09 +0000)
GSC     : v57 0x4d20 RST:VIN Thermal Protection Enabled
Model   : GW7301-00-B1B
...
U-Boot 2020.04-g0a0109fcfb (Oct 07 2020 - 19:30:09 +0000), Build: jenkins-venice-bsp-24
...
[    0.000000] Linux version 5.4.45-g43e409dc8906 (jenkins@bionic_builder) (gcc version 8.4.0 (Buildroot 2020.05.2-109-g32cec2af36)) #1 SMP Wed Oct 7 18:43:20 UTC 2020
...
Ubuntu 20.04.1 LTS focal-venice ttymxc1

Gateworks-Ubuntu-gateworks-g65dac90 Tue Oct  6 23:54:49 UTC 2020
...
}}}


The above output shows you:
 * Secondary Program Loader (SPL) GIT revision and build date
 * GSC firmware version
 * U-Boot GIT revision and build date
 * Linux kernel version, GIT revision, build date and build source
 * Ubuntu root filesystem version and GIT revision of the Gateworks [https://github.com/gateworks/ubuntu-rootfs ubuntu-rootfs.sh] that created it (use {{{dpkg -l | grep "^ii"}}} to see what packages and versions are installed


[=#firmware-update]
= Updating Firmware
This section provides instructions for updating both GSC firmware as well as boot device firmware.

There are two methods for updating firmware:
 * on a live board using Serial Console and Ethernet
 * using a GW16099 JTAG dongle (see [#jtag below])

The various items that can be easily updated:
 * GSC Firmware - Can be updated via JTAG or at runtime - see [#gsc below])
 * Boot Firmware (Everything up to and including the Bootloader)
 * Root Filesystem (Operating System)

[=#jtag]
== JTAG Programming
The Gateworks JTAG adapter (GW16099) is available in the Venice Dev Kit as well as on the Gateworks web store [http://shop.gateworks.com/index.php?route=product/category&path=70_80 here]

All Venice boards have a 10-pin JTAG header which provides:
 * JTAG Programming for embedded emmc flash - see [wiki:jtag_instructions here] for instructions
 * Serial Console access via UART2 (/dev/ttymxc1)

Please Note:
 * Only flash .bin files via the JTAG programmer and jtag_usbv4
 * Linux software is supported for programming Venice (jtag_usbv4 required). Windows is not supported. (Serial console through Windows does work).
 * JTAG Programming of eMMC is supported by [http://dev.gateworks.com/jtag/jtag_usbv4 jtag_usbv4] - see [wiki:jtag_instructions here]. Due to this being a slow process for large eMMC devices it is recommended to program boot firmware via JTAG if you brick your board and use the bootloader to install firmware when possible for speed (see [#serial-ethernet] below).
 * JTAG Programming of the GSC firmware is supported by [http://dev.gateworks.com/jtag/jtag_usbv4 jtag_usbv4] - see [#jtag-gsc below]

To flash the Venice boot firmware (no operating system), use the following command:
{{{
sudo ./jtag_usbv4 –p firmware-venice-imx8mm.bin
}}}
 * You must use firmware appropriate for the SoC on your board:
  - GW730x-0x/GW720x-0x/GW710x-0x with an IMX8MM: [http://dev.gateworks.com/venice/images/firmware-venice-imx8mm.bin firmware-venice-imx8mm.bin]
  - GW740x with an IMX8MP: [http://dev.gateworks.com/venice/images/firmware-venice-imx8mp.bin firmware-venice-imx8mm.bin]


[=#serial-ethernet]
== Update Firmware via Serial Console and Ethernet from Bootloader
The quickest and easiest way to update your firmware is via Serial Console and Ethernet. You can do this either in the U-Boot bootloader (recommended) or within a Linux OS.

If updating firmware via !Bootloader/Serial/Ethernet (recommended for speed) you need to setup a TFTP server to host the files for transfer. Alternatively you could load firmware files from removable storage (microSD, or USB Mass Storage for example) however you will need to deviate from the examples below. For details on setting up a TFTP server see [wiki:tftpserver here].

The following instructions assume your board target IP address is 192.168.1.1 and you have a TFTP server at 192.168.1.146. Adjust environment according to your network via 'setenv ipaddr <ipaddr>' and 'setenv serverip <serverip>'.

The methods you use to update the firmware depends on what specifically you are trying to update.

Be care to use firmware images built for the specific SOC on the board you are using. Venice boards use a variety of IMX8M SoC's which have different boot firmware:
||= Board =||= SoC =||= Notes =||
|| GW710x-0x-* || i.MX8M Mini (aka IMX8MM) || use firmware with 'imx8mm' in the name ||
|| GW720x-0x-* || i.MX8M Mini (aka IMX8MM) || use firmware with 'imx8mm' in the name ||
|| GW730x-0x-* || i.MX8M Mini (aka IMX8MM) || use firmware with 'imx8mm' in the name ||
|| GW740x-*    || i.MX8M Plus (aka IMX8MP) || use firmware with 'imx8mp' in the name ||

You can tell what you are using by watching the board boot:
{{{#!bash
U-Boot 2022.07-g1050480603 (Aug 19 2022 - 17:02:47 +0000), Build: jenkins-venice-bsp-122

CPU:   Freescale i.MX8MP[8] rev1.1 1600 MHz (running at 1200 MHz)
CPU:   Industrial temperature grade (-40C to 105C) at 28C
...
Hit any key to stop autoboot:  0 
u-boot=> print soc
soc=imx8mp
}}}
 - The above CPU banner shows 'i.MX8MP' which requires firmware with a 'imx8mp' in its name
 - The latest firmware images set the 'soc' U-Boot env variable to match the SoC you are using


[=#disk-images]
==== Update OS via Compressed Disk Images
A compressed disk image is relatively easy to create and is easy to install on a running board via U-Boot or Linux running from a ramdisk. Assuming boot firmware is booting from another device or hardware partition (ie eMMC boot0 hardware partition) the compressed disk image contains only the disk partition table and OS filesystem partitions.

Procedure:
 * Via U-Boot:
{{{#!bash
#First, setup the IP and server IP as described above (example IPs below)
setenv ipaddr 192.168.1.1
setenv serverip 192.168.1.2 
# setup network environment (use bootp or static by setting ipaddr/serverip and optional netmask/gatewayip)
setenv autoload 0; bootp  # use dhcp for network config but do not fetch a file
# choose the device to update
setenv dev 2 # sets MMC device to be flashed - see mmc list
# set your image
setenv image <distro>-venice.img.gz
# update
run update_all
}}}
  - This is what the update_all script does if your curious:
{{{#!bash
update_all=tftpboot ${loadaddr} ${image} && gzwrite mmc ${dev} ${loadaddr} ${filesize}
}}}
 * Via Linux (when the volume is unmounted):
{{{#!bash
# fetch your file
cd /tmp
wget http://dev.gateworks.com/venice/images/<distro>-venice.img.gz
# uncompress and write to the emmc device
zcat <disro>-venice.img.gz | dd of=/dev/mmcblk0 bs=4M
}}}

Note that Gateworks used to place boot firmware in the eMMC user partition meaning the compressed disk image would also include the boot firmware. This is now considered 'legacy' but to keep users from bricking boards that still have boot firmware on the eMMC user hardware partition the Gateworks Venice BSP still places imx8mm boot firmware in the compressed disk image.


[=#boot-firmware]
==== Updating just the boot firmware
Updating the [wiki:venice/boot 'Boot firmware'] via this method includes the SPL, U-Boot, the device-tree, and the ATF. The method here specifically does not update the disk partition table at the beginning of the boot device as that really has nothing to do with the boot firmware. This method also does not destroy any current U-Boot environment.

Note that the IMX8 BOOT ROM fetches code starting at a 33K offset (in order to reserve everything below that for things like disk partition tables).

The latest pre-built Bootloader images for Venice are available for download here: 
[http://dev.gateworks.com/venice/boot_firmware/]
 * Be sure to use one that is compatible with the SoC on your board

Procedure:
 * Via U-Boot:
  - for IMX8M Mini board variants:
{{{#!bash
# setup network environment (use bootp or static by setting ipaddr/serverip and optional netmask/gatewayip)
bootp  # optional: use dhcp for network config
# choose the device to update
setenv dev 2 # sets MMC device to be flashed - see mmc list
# set your image
setenv image venice-$soc-flash.bin # with any tftp server directories in front of the filename
# update
run update_firmware
}}}
   - This is what the update_firmware script does if your curious:
{{{#!bash
update_firmware=tftpboot $loadaddr $image && setexpr blkcnt $filesize + 0x1ff && setexpr blkcnt $blkcnt / 0x200 && mmc dev $dev && mmc write $loadaddr 0x42 $blkcnt
}}}
  - for IMX8M Nano board variants:
{{{#!bash
# setup network environment (use bootp or static by setting ipaddr/serverip and optional netmask/gatewayip)
setenv autoload 0; bootp  # use dhcp for network config but do not fetch a file
# choose the device to update
setenv dev 2 # sets MMC device to be flashed - see mmc list
# set your image
setenv image venice-$soc-flash.bin # with any tftp server directories in front of the filename
# update
run update_firmware
}}}
   - This is what the update_firmware script does if your curious:
{{{#!bash
update_firmware=tftpboot $loadaddr $image && setexpr blkcnt $filesize + 0x1ff && setexpr blkcnt $blkcnt / 0x200 && mmc dev $dev && mmc write $loadaddr $splblk $blkcnt
}}}
 * Via Linux:
  - Updating via Linux requires you to download the 'venice-<soc>-flash.bin' file (pre-built images can be found [http://dev.gateworks.com/venice/boot_firmware/ here] and to use the correct offset in the boot device which varies per SoC:
  - for IMX8M Mini board variants:
{{{#!bash
# fetch your file
cd /tmp
wget http://dev.gateworks.com/venice/boot_firmware/venice-imx8mm-flash.bin
# uncompress and write to the emmc device to 33K offset
dd if=venice-imx8mm-flash.bin of=/dev/mmcblk2 bs=1K seek=33
}}}
  - for IMX8M Nano board variants:
{{{#!bash
# fetch your file
cd /tmp
wget http://dev.gateworks.com/venice/boot_firmware/venice-imx8mn-flash.bin
# uncompress and write to the emmc device to 32K offset
dd if=venice-imx8mn-flash.bin of=/dev/mmcblk2 bs=1K seek=32
}}}
  - for IMX8M Plus board variants:
{{{#!bash
# fetch your file
cd /tmp
wget http://dev.gateworks.com/venice/boot_firmware/venice-imx8mp-flash.bin
# uncompress and write to the emmc device to 32K offset
dd if=venice-imx8mp-flash.bin of=/dev/mmcblk2 bs=1K seek=32
}}}


==== Updating just the root filesystem
Updating the root filesystem from a 'compressed filesystem image' is easily done in U-Boot or Linux.

Note that Gateworks does not host any pre-built filesystem images on our servers but the Venice BSP builds one for you from a downloaded rootfs tarball when you build the {{{ubuntu-image}}} target. The file is in the bsp directory as {{{focal-venice.ext4}}} and can be compressed with {{{gzip focal-venice.ext4}}}


Procedure:
 * Via U-Boot:
{{{#!bash
# setup network environment (use bootp or static by setting ipaddr/serverip and optional netmask/gatewayip)
setenv autoload 0; bootp  # use dhcp for network config but do not fetch a file
# choose the device to update
setenv dev 2 # sets MMC device to be flashed - see mmc list
# set your image
setenv image rootfs.ext4.gz # with any tftp server directories in front of the filename
# update
run update_rootfs
}}}
  - This is what the update_rootfs script does if your curious:
{{{#!bash
update_rootfs=tftpboot $loadaddr $image && gzwrite mmc $dev $loadaddr $filesize 100000 1000000
}}}
  - Note gzwrite is used so the filesystem image must be compressed with 'gzip' (otherwise you could use mmc write manually). The data (ie type of filesystem or content ) does not matter here
  - Note the flash offset is 0x1000000 blocks which is 16MiB
  - Note the {{{dev}}} and {{{image}}} env variables are used by this script
 * Via Linux:
{{{#!bash
# fetch your file
cd /tmp
wget http://sever/rootfs.ext4.gz
# uncompress and write to the emmc device to 16M offset
dd if=venice-imx8mm-flash.bin of=/dev/mmcblk0 bs=1M seek=16
}}}


=== TFTP Error Troubleshooting
There are many reasons why TFTP may fail including:
 * firewall issue keeping your TFTP server for being accessible (make sure you can ping it!)
 * invalid network configuration (netmask, gatewayip, ipaddr, serverip) - again make sure you can ping it!
 * 'TFTP error: trying to overwrite reserved memory...' - indicates you are trying to transfer a file that is larger than system memory. You will need to split the file into chunks and flash them individually at the right offsets


= Updating GSC firmware
The GSC firmware is updated via the {{{gsc_update}}} application running under Linux as described at on the [wiki:gsc#firmware gsc wiki]. While it takes only a few seconds to update there is no recovery for a failed update. Gateworks has ensured that this update is robust but can not survive a power-cut or kernel crash in the middle of the update. Updates to the GSC firmware are expected to be rare.


[=#jtag-gsc]
=== Update GSC Firmware via JTAG ===
To update the GSC firmware via JTAG download the {{{jtag_usbv4}}} application on a Linux x86 host from [http://dev.gateworks.com/jtag/jtag_usbv4 here] and execute as follows:
{{{#!bash
./jtag_usbv4 -m gsc_7000_v57.txt
}}}

Note that the {{{ftdi_sio}}} kernel module must not be loaded (sudo rmmod ftdi_sio) and you may need to run this command as root by pre-pending a sudo depending on the configuration of your linux host.

For more details please see:
 * [wiki:jtag Gateworks JTAG wiki page]