Difference between revisions of "Target Software Installation"

Latest revision as of 08:46, 9 September 2021

On this page you will learn how to update (from U-Boot) the Flash's partitions of your APF module storing the Linux, rootfs and U-Boot software images.

Configure U-Boot

Environment variables

U-Boot can be customized in a flexible way with the use of "environment variables/scripts". The command printenv shows you most of them and their current value:

 BIOS> printenv
 bootcmd=run jffsboot
 bootdelay=20
 baudrate=115200
 ethaddr=
 autoload=no
 ...

The command setenv is used to change these variables. For example, to set the IP address (don't do it yet):

 BIOS> setenv ipaddr 192.168.0.10

The command saveenv is used to save the state of your environment variables in FLASH memory; that way they will be available at next boot:

 BIOS> saveenv
 Saving Environment to Flash...
 . done
 Un-Protected 1 sectors
 Erasing Flash...
 . done
 Erased 1 sectors
 Writing to Flash... done
 . done
 Protected 1 sectors

Network configuration

Note: You have to install tftpboot on your host development computer

In order to use the U-Boot's network features, you have to set the network environment variables:

 BIOS> setenv netmask 255.255.255.0                (this default value should be fine in most situations)
 BIOS> setenv ipaddr 192.168.0.10 
 BIOS> setenv serverip 192.168.0.2                 (the IP address of your tftp server/PC hosting the files to download)
 BIOS> setenv rootpath "/tftpboot/apf9328-root"    (to boot Linux over NFS)
 BIOS> setenv consoledev ttymxc0

You can use the dhcp command to configure these variables from your DHCP server. You probably will have to adjust the serverip variable manually. If you use VirtualBox or VMware make sure you have selected Bridge Mode for the network adaptor, otherwise the U-Boot cannot talk to your host.

 BIOS> dhcp
 dm9000 i/o: 0x15c00000, id: 0x90000a46
 MAC: 00:0e:32:00:00:01
 operating at 100M full duplex mode
 BOOTP broadcast 1
 DHCP client bound to address 192.168.0.10
 BIOS> setenv serverip 192.168.0.2
 BIOS> saveenv

Do not forget to save your changes in FLASH, to have them available at next power up:

 BIOS> saveenv

In case of troubles you can use the following U-Boot script to reset the variables to the "factory"/default settings:

 BIOS> run flash_reset_env

or

 BIOS> env default -f -a; saveenv

Linux kernel installation

Check that your Armadeus kernel image size is smaller than the U-Boot partition (see Flash Memory Partitions for size allowances):

 [armadeus]$ ls -al buildroot/output/images/

If yes, copy it to your TFTP server directory (here /tftpboot/):

 [armadeus]$ cp buildroot/output/images/* /tftpboot/

Linux kernel update script

This is the recommended method and the easiest one. The automatic 'update_kernel' scripts downloads the image and flash it in the same go:

 BIOS> run update_kernel

To know what update_kernel script is doing you can display its content:

 BIOS> printenv update_kernel

Warning: If the loaded kernel image is too large, the following operation can destroy data that are stored after the partition limits (e.g. RootFS) - Check that transferred size value is less than the ones specified here Flash Memory Partitions

Other Linux kernel update method

Load kernel image with U-Boot through network:

 BIOS> run download_kernel

or with the serial line:

 BIOS> loadb ${loadaddr}
     ''Ctrl+Altgr+\+c to access kermit command line then:''
 (/home/.../) C-Kermit>send /tftpboot/XX-linux.bin
     ''After download is completed, you can type the c command to reconnect to the terminal:''
 (/home/.../) C-Kermit>c
 Connecting to /dev/ttyUSB0, speed 115200
  Escape character: Ctrl-\ (ASCII 28, FS): enabled
 Type the escape character followed by C to get back,
 or followed by ? to see other options.
 ----------------------------------------------------
 ## Total Size      = 0x<size of XX-linux.bin> = .... Bytes
 ## Start Addr      = 0x08000000
 BIOS> setenv filesize <size of XX-linux.bin>

Check that transferred size value is less than the ones specified here Flash Memory Partitions

 Bytes transferred = 1313216 (1409c0 hex)

You can test your new kernel image without flashing it with; if so you will have to reload it again after test:
- Please note: The bootm command is not supported by APF51 boards yet; directly flash the kernel with the below commands instead

 BIOS> bootm

a U-Boot script exists to ease kernel image loading through Ethernet:

 BIOS> run download_kernel

After kernel image has been downloaded into RAM memory, you can flash it with:

 BIOS> run flash_kernel

If you only want to try a new kernel without flashing the kernel image you can launch it directly from RAM (U-Boot 2011.12):

 BIOS> setenv bootargs console=${consoledev},${baudrate} ${mtdparts};run addubifsargs addipargs; bootm
(the kernel image you want to try must have been loaded at ${loadaddr})

Please note: The bootm command is not supported by APF51 boards yet; directly flash the kernel with the below commands

rootfs installation

Check that your Armadeus rootfs image size is smaller than the rootfs partition (see Flash Memory Partitions for size allowances):

 $ ls -al buildroot/output/images/
 ...
 $ cp buildroot/output/images/* /tftpboot/

Load rootfs image with U-Boot through network:

 BIOS> run update_rootfs

or serial line:

BIOS> loadb ${loadaddr}
    ''Ctrl+Altgr+\+c to access kermit command line then...''
(/home/.../) C-Kermit>send path_to_your_host_buildroot_dir/XX-rootfs.ubi
    ''After download is completed, you can type the c command to reconnect to the terminal:''
(/home/.../) C-Kermit>c
Connecting to /dev/ttyUSB0, speed 115200
 Escape character: Ctrl-\ (ASCII 28, FS): enabled
Type the escape character followed by C to get back,
or followed by ? to see other options.
----------------------------------------------------
## Total Size      = 0x<size of rootfs>
## Start Addr      = 0x........
BIOS> setenv filesize <size of rootfs>
BIOS> run flash_rootfs

Now you should be ready to test Linux:

 BIOS> boot

For large rootfs (bigger than the available RAM on your system) please use the method which suit your board:
- APF9328: none :-(
- APF27/APF28/APF51:

 BIOS> nand erase.part rootfs
 BIOS> tftpboot ${rootfs_addr} ${board_name}-rootfs.ubi nand

- APF6: U-Boot UMS

FPGA firmware test

The FPGA firmwares are all located in the firmware/ directory of your Armadeus BSP sources:

 $ ls firmware/
 apf_pkg  BRAMTest  bus_led  led  PS2  PS2_Opencore  servo  sram_test  wishbone_example  Xtools

You can make some trials with the firmware/leds/blinking_led/bin/ files.

Warning: for the APF9328, please check that your bitfile size is smaller than the firmware partition size (256KB) before trying the following commands or you may corrupt your Linux kernel FLASH partition !!!

Note: For the APF51 and U-Boot versions earlier than 2013.04, only binary file format (.bin) can be used; do not try .bit file.
For the APF51 and U-Boot versions 2013.04 or later you can also use .bit files with the U-Boot command:

 BIOS> fpga loadb

Load FPGA firmware image file with U-Boot through:

Ethernet:

 BIOS> tftpboot ${loadaddr} fpgafirmware.bin

fpgafirmware.bin is of course the name of your bitfile stored in your TFTP shared directory (/tftpboot/)

then you can type the c command to reconnect to the terminal

Test your new FPGA firmware's downloading:
- for .bin binary files
```
BIOS> fpga load 0 ${loadaddr} ${filesize}
```
- for .bit binary files
```
BIOS> fpga loadb 0 ${loadaddr} ${filesize}
```
For your convenience a set of U-Boot script to facilitate firmware management with the APF boards:
- download_firmware: assuming your firmware is in /tftpboot and name apfXX-firmware.bin (where apfXX is the name of your board apf27, apf51, apf9328..) will download the firmware in RAM with the command: run download_firmware
- flash_firmware: save the previously downloaded firmware from RAM into the flash.
- update_firmware: will execute the previous 2 scripts in sequence.
- load_firmware: read a firmware from the flash (there is dedication partition named firmware for this purpose) and load it into the FPGA.

FPGA firmware installation

APF9328, APF27 and APF51

instal/copy your firmware to /tftpboot

manually:

 $ cp myfirmware.bin /tftpboot/apfXX-firmware.bin (where apfXX is the name of your board: apf27, apf51 or apf9328)

using the armadeus BSP:

 $ make menuconfig

Package Selection for the target  --->   Armadeus specific tools/utilities  --->

you can specify the path to the FPGA firmware:

[*] FPGA Firmware 
      Firmware to install (Install a custom FPGA firmware)  --->
 ($(TOPDIR)/../firmware/leds/blinking_led/bin/blinking_led_apf27_200k.bit) FPGA binary file path
[*]   Export this file to Buildroot images folder

 $ cp buildroot/output/images/* /tftpboot

Download and test your firmware image with:

 BIOS> run download_firmware
 BIOS> run load_firmware

When you are satisfied with your firmware, you can write it in flash make it "autoloaded" at power up:

Warning: Before setting the firmware_autoload variable, be sure that your FPGA binary file is correct. If not, your board will hang up at U-Boot start and you will need to cancel the fpga download to take control of the board. see note below

 BIOS> run update_firmware
 BIOS> setenv firmware_autoload 1
 BIOS> saveenv

Note: (U-Boot 2012.04) you can manually cancel the firmware autoload using the following procedure: keeping <CTRL-C> pressed on the console and power up the board will start the board without downloading the FPGA firmware - This procedure can be helpfull if you have programmed a broken firmware

APF6_SP

Firmware installation was simplified in APF6_SP.

To «autoload» your firmware while U-Boot is starting, simply add your bitstream to your rootfs, for example :

/lib/firmware/fpga/firmware.periph.rbf

Note: By default, directory /lib/firmware/fpga doesn't exists, then simply create it with

# mkdir /lib/firmware/fpga

Then reboot under U-Boot and configure your environment variables firmware_autoload and firmware_path :

BIOS> setenv firmware_path /lib/firmware/fpga/firmware.periph.rbf
BIOS> setenv firmware_autoload 1

Do not forget to save your environment variables:

BIOS> saveenv

That's all, now your bitstream will be loaded with U-Boot at boot:

U-Boot SPL 2014.07 (Apr 23 2015 - 16:16:45)

U-Boot 2014.07 (Apr 23 2015 - 16:16:45)

[...]

39688 bytes read in 260 ms (148.4 KiB/s)
Hit any key to stop autoboot:  0

Update U-Boot

Check that your Armadeus U-Boot image size is smaller than the u-boot partition (see Flash Memory Partitions for size allowances) and copy all the binary images to your TFTP server directory:

 [armadeus]$ ls -al buildroot/output/images/
 ...
 [armadeus]$ cp buildroot/output/images/* /tftpboot/

U-Boot update script

This is the recommended method and the easiest one. The automatic 'update_uboot' scripts downloads the image and flash it in the same go:

 BIOS> run update_uboot

Reset your board and check if you need to update your environment variables:

 BIOS> reset
 U-Boot 2011.12 ..
 ...
 *** Warning - Environment version change suggests: run flash_reset_env; reset
 BIOS> run flash_reset_env; reset

In such a case you may have to update your network environment variables (see Configure U-Boot)

Other U-Boot update method

You can use the following commands to download U-boot in RAM:

With Ethernet and a TFTP server:

 BIOS> run download_uboot

With Ethernet and a NFS server:

 BIOS> nfs ${loadaddr} host_ip_addr:/nfs_path_to_buildroot/apfXX-u-boot{.bin|-nand.bin|.sb}

With kermit and the serial/RS232 line

 BIOS> loadb ${loadaddr}
    <CTRL><ALT GR>\
    c
    send path_to_buildroot/apfXX-u-boot{.bin|-nand.bin|.sb}
    c<ENTER>
 Connecting to /dev/ttyUSB0, speed 115200
  Escape character: Ctrl-\ (ASCII 28, FS): enabled
 Type the escape character followed by C to get back,
 or followed by ? to see other options.
 ----------------------------------------------------
 ## Total Size      = 0x<size of U-Boot> = .... Bytes
 ## Start Addr      = 0x08000000
 BIOS> setenv filesize <size of U-Boot>

Then you can use the U-Boot command/script 'flash_uboot' to tranfert the new U-Boot from RAM to Flash memory:

 BIOS> run flash_uboot

Advanced informations can be found at the BootLoader wiki page.

Note: APF51

When updating your board from a legacy version of Armadeus BSP you should set the `fdt_addr_r` environment var to boot correctly:

BIOS> setenv fdt_addr_r 91000000

See How_to_use_vanilla_kernel_on_APF51 for more informations.

Update U-Boot, kernel and rootfs images all at once

Copy all the binary images to your TFTP server directory:

 [armadeus]$ cp buildroot/output/images/* /tftpboot/

The automatic 'update_all' scripts downloads each image and flash it in the same go:

 BIOS> run update_all

Reset your board to check that wour board is correctly updated.

Note: When updating your board from a legacy version of Armadeus BSP you should update U-Boot first to update the environment variables before any other partition update ( see Update U-Boot)

Flash memory partitions

Old Flash partitionning (pre armadeus-5.0) is kept here.

APF9328 / U-Boot 2011.12 and newer release - Flash memory partitions

Address range (index from FLASH physical @ 0x10000000)	Type
0x000000 - 0x03FFFF ( 256KB )	U-Boot image
0x040000 - 0x5FFFF ( 128KB )	U-Boot environment variables (primary partition: env)
0x060000 - 0x7FFFF ( 128KB )	U-Boot environment variables (redundant partition: env2)
0x080000 - 0xBFFFF ( 256KB )	FPGA bitfile (firmware)
0x0C0000 - 0x2BFFFF ( 2MB )	Linux kernel image (kernel)
0x2C0000 - End of FLASH ( ~5.5 MB or ~13.5 MB )	Root filesystem (rootfs)

APF27 / U-Boot 2011.12 and newer release - Flash memory partitions

It's safer to not touch sectors marked as red ;-)

NAND flash address range	Type
0x00000000 - 0x000FFFFF (1MiB, including NAND SPL and spare memory for bad blocks)	U-Boot image
0x00100000 - 0x0017FFFF (512kB)	U-Boot environment variables (primary partition: env)
0x00180000 - 0x001FFFFF (512kB)	U-Boot environment variables (redundant partition: env2)
0x00200000 - 0x0027FFFF (512KB)	FPGA bitfile (firmware)
0x00280000 - 0x002FFFFF (512kB)	DeviceTree Block partition (dtb)
0x00300000 - 0x007FFFFF (5MB)	Linux kernel image (kernel)
0x00800000 - 0xff7ffff (>~248MB)	Root filesystem (rootfs)
0xff800000 - End of FLASH (512KB)	U-Boot NAND bad blocks table. Sectors mark as bad, don't touch !!

APF28 / U-Boot 2011.12 and newer release - Flash memory partitions

NAND flash address range	Type
0x00000000 - 0x002FFFFF (3MB, including NAND SPL and spare memory for bad blocks)	U-Boot
0x00300000 - 0x0037FFFF (512kB)	U-Boot environment variables (primary partition: env)
0x00380000 - 0x003FFFFF (512kB)	U-Boot environment variables (redundant partition: env2)
0x00400000 - 0x0047FFFF (512kB)	DeviceTree Block partition (dtb)
0x00480000 - 0x004FFFFF (512kB)	Reserved for a futur splash screen (splash)
0x00500000 - 0x00CFFFFF (8MB)	Linux kernel image (kernel)
0x00D00000 - End of FLASH (>~243MB)	Root filesystem (rootfs)

APF51 / U-Boot 2011.12 and newer release - Flash memory partitions

NAND flash address range	Type
0x00000000 - 0x000FFFFF (1MB, including NAND SPL and spare memory for bad blocks)	U-Boot image
0x00100000 - 0x0017FFFF (512kB)	U-Boot environment variables (primary partition: env)
0x00180000 - 0x001FFFFF (512kB)	U-Boot environment variables (redundant partition: env2)
0x00200000 - 0x002FFFFF (1MB)	FPGA bitfile
0x00300000 - 0x0037FFFF (512kB)	DeviceTree Block partition (dtb)
0x00380000 - 0x003FFFFF (512kB)	Reserved for a futur splash screen (splash)
0x00400000 - 0x00BFFFFF (8MB)	Linux kernel image (kernel)
0x00C00000 - End of FLASH (>~500MB)	Root filesystem (rootfs)

APF6

APF6 has an eMMC.

OPOS6UL

OPOS6UL has an eMMC.