Changes between Version 18 and Version 19 of provisioning

Timestamp:

10/29/2021 08:29:19 PM (3 years ago)

Author:

Tim Harvey

Comment:

added details about provisioning uboot env

provisioning

@@ -102 +102 @@
 - partition editor (sgdisk and/or parted)
 - filesystem creation tools (ie e2fsprogs if using ext2/3/4)
-- u-boot-tools (fw_printenv/fw_setenv) if setting or altering uboot env
+- u-boot-tools (fw_printenv/fw_setenv/mkenvimage) if setting or altering uboot env
 - networking support to fetch your filesystem tarballs (which could also come from removable storage)
 - optionally your provisioning script (or you can transfer this via network)
@@ -387 +387 @@
 
 Please read more about JTAG upload here: [wiki:jtag_instructions JTAG Instructions]
+
+
+[=#ubootenv]
+== U-Boot environment provisioning
+The U-Boot bootloader uses environment variables and scripts to control the booting of a board. Often it is desirable to override the default environment the Gateworks BSP's create and create your own.
+
+The device, location, size, and redundancy details of how the U-Boot environment is stored vary from board to board based on U-Boot's configuration:
+ * Venice: 32KiB (0x8000) redundant env stored at 16320KiB (0xff0000) offset for MMC
+ * Newport: 32KiB (0x8000) redundant env stored at 16320KiB (0xff0000) offset for MMC
+ * Ventana:
+  - MMC: 128MiB redundant env stored at 709KiB offset
+  - NAND: 128MiB redundant env stored at 16MiB offset
+
+There are some tools from the U-Boot project available in the u-boot-tools package that can be used to alter or create an env that can then be copied directly to flash:
+ * fw_setenv / fw_getenv - requires a config file and can get or alter the env. If there is no valid env where the config file points to a default env hard coded into the bootloader will be returned.
+ * mkenvimage - create an env image from scratch with a specified size and redundancy.
+
+For examples of how the default env is created for the various Gateworks products:
+ - Venice BSP uses fw_setenv to alter the hard-coded default env. For details see:
+  * https://github.com/Gateworks/bsp-venice/blob/master/Makefile
+  * https://github.com/Gateworks/bsp-venice/blob/master/venice.env
+  * https://github.com/Gateworks/bsp-venice/blob/master/fw_env.config
+ - Newport BSP uses fw_setenv to alter the hard-coded default env. For details see:
+  * https://github.com/Gateworks/bsp-newport/blob/sdk-10.1.1.0-newport/Makefile
+  * https://github.com/Gateworks/bsp-newport/blob/sdk-10.1.1.0-newport/newport.env
+  * https://github.com/Gateworks/bsp-newport/blob/sdk-10.1.1.0-newport/fw_env.config
+ - Ventana firmware images have a blank env area therefore use hard-coded default env from U-Boot
+
+To create a specific env from scratch (ie without inheriting any defaults) use the {{{mkenvimage}}} tool from the u-boot-tools package
+ 1. Create an env.txt file with 'name=value' pairs. Be sure to include everything that is necessary as no defaults will be available other than variables that are set at runtime on the fly such as serial#, model, and macaddr:
+{{{#!bash
+cat << EOF >> env.txt
+baudrate=115200
+bootcmd=run distro_boot
+...
+EOF
+}}}
+{{{#!bash
+cat << EOF >> env.txt
+baudrate=115200
+loadaddr=0x48200000
+ipaddr=192.168.1.1
+serverip=192.168.1.146
+update_all=tftpboot $loadaddr venice/venice-focal-imx8mm.img.gz && gzwrite mmc 2 $loadaddr $filesize
+update_env=tftpboot $loadaddr venice/env.bin && mmc dev 2 && mmc write $loadaddr 0x7f80 $filesize
+EOF
+}}}
+ 2. Use {{{mkenvimage}}}  taking care to specify the env size the bootloader is configured to use and specify '-r' for redundancy if the bootloader is configured for that:
+  * Venice / Newport
+{{{#!bash
+mkenvimage -r -s $((32 * 1024)) -o env.bin env.txt
+}}}
+  * Ventana:
+{{{#!bash
+mkenvimage -r -s $((128 * 1024)) -o env.bin env.txt
+}}}
+ 3. Place this image in FLASH:
+  * Venice / Newport:
+   - Example: compressed disk image for Venice / Newport:
+{{{#!bash
+gunzip disk.img.gz
+dd if=env.bin of=disk.img bs=1K seek=16320 oflag=notrunc
+gzip disk.img
+}}}
+   - Example: update from Linux:
+{{{#!bash
+dd if=env.bin of=/dev/mmcblk0 bs=1K seek=16320 oflag=notrunc
+}}} 
+   - Example: update from U-Boot (16320KiB is equivalent to 0x7f80 512byte blocks in hex)
+{{{#!bash
+tftp $loadaddr env.bin && mmc write $loadaddr 0x7f80 $filesize
+}}}
+  * Ventana:
+   - Example: JTAG binary image for a Ventana NAND device:
+{{{#!bash
+mkimage_jtag -e SPL@0 u-boot.img@14M env.bin@16M ubi@17M > image.bin
+}}}
+   - Example: update from Linux:
+{{{#!bash
+dd if=env.bin of=/dev/mmcblk0 bs=1K seek=16384 oflag=notrunc
+}}} 
+   - Example: update from U-Boot (16384MiB is equivalent to 0x8000 512byte blocks in hex)
+{{{#!bash
+tftp $loadaddr env.bin && mmc write $loadaddr 0x8000 $filesize
+}}}