LS2088ARDB - How to update MC firmware, DPC, and DPL images in NOR flash

[#1]

Follow these steps to update the DPAA2 MC firmware, DPC, and DPL images in NOR flash.

qixis_reset boots the board from NOR bank 0 and qixis_reset altbank boots the board from NOR bank 4.

Obtaining MC firmware

Clone the qoriq-mc-binary repository.

1. $ git clone https://github.com/NXP/qoriq-mc-binary.git
2. $ cd qoriq-mc-binary/ls2088a/
3. $ git checkout -b <new branch name> <LSDK tag>. For example, $ git checkout -b LSDK-19.09 LSDK-19.09

The prebuilt MC firmware image, mc_10.18.0_ls2088a.itb, is available at /qoriq-mc-binary/ls2088a/.

Note that the name of the MC firmware image may vary depending on the release version used. 

Obtaining DPC and DPL images

Clone the mc-utils repository and compile the DPC and DPL images.

1. $ git clone https://source.codeaurora.org/external/qoriq/qoriq-components/mc-utils
2. $ cd mc-utils
3. $ git checkout -b <new branch name> <LSDK tag>. For example, $ git checkout -b LSDK-19.09 LSDK-19.09
4. If required, make changes to the DPC and DPL files.
5. $ make -C config/

The compiled dpc.0x2A_0x41.dtb and  dpl-eth.0x2A_0x41.dtb images are available at /mc-utils/config/ls2088a/RDB/.

Note that the name of the DPC and DPL images may vary depending on the release version used. 

Flashing MC firmware, DPC, and DPL images to NOR flash

1. Boot LS2088ARDB from NOR flash. Ensure that the switches are set to boot the board from NOR bank 0. For booting from NOR bank 0, switch settings are as follows:   
       
   • SW5[1:8] = 1111 1111
       
   • SW3[1:8] = 0001 0010
       
   • SW4[1:8] = 1111 1111
       
   • SW6[1:8] = 1111 1111
       
   • SW7[1:8] = 0100 0010
       
   • SW9[1:8] = 0100 0000
       
   • SW8[1:8] = 0111 1111
      
2. In addition to the above switch settings, make sure the following jumper settings are correct (for RDB Rev E and later)
   • J14 = 1-2, for NOR boot
3. Boot from NOR bank 0: => qixis_reset

   For LS2088ARDB, in boot log, you'll see:

   Board: LS2088AE Rev1.1-RDB, Board Arch: V1, Board version: F, boot from vBank: 0

The images can be loaded to the LS2088ARDB from a TFTP server or from a mass storage device (SD, USB, or SATA).

Option 1: Load image from the TFTP server

Set up Ethernet connection

When board boots up, U-Boot prints a list of enabled Ethernet interfaces.

DPMAC1@xgmii, DPMAC2@xgmii, DPMAC3@xgmii, DPMAC4@xgmii, DPMAC5@xgmii, DPMAC6@xgmii, DPMAC7@xgmii, DPMAC8@xgmii

  
1. Set server IP address to the IP address of the host machine on which you have configured the TFTP server. 

   => setenv serverip <ipaddress1>

  

2. Set ethact and ethprime as the Ethernet interface connected to the TFTP server.

   See LS2088ARDB Ethernet port mapping for the mapping of Ethernet port names appearing on the chassis front panel with the port names in U-Boot and Linux.

                                                                        

   => setenv ethprime <name of interface connected to TFTP server>

   For example:

   => setenv ethprime DPMAC1@xgmii

   => setenv ethact <name of interface connected to TFTP server>

   For example:

   => setenv ethact DPMAC1@xgmii

  
3. Set IP address of the board. You can set a static IP address or, if the board can connect to a dhcp server, you can use the dhcp command. 

   Static IP address assignment:
   => setenv ipaddr <ipaddress2>
   => setenv netmask <subnet mask>

   Dynamic IP address assignment:
   => dhcp

  
4. Save the settings. => saveenv
  
5. Check the connection between the board and the TFTP server.

=> ping $serverip

Using DPMAC1@xgmii device

host 192.168.1.1 is alive

Load images from a TFTP server

1. Flash MC firmware to NOR bank 4 (after booting from NOR bank 0):
   
   1. => tftp 0x80000000 mc_10.18.0_ls2088a.itb
   2. => print filesize
   3. => erase 0x584A00000 +$filesize;cp.b 80000000 0x584A00000 $filesize

      Address 0x584A0000 is the location of MC firmware in alternate NOR bank. Refer Flash layout for new boot flow with TF-A for the complete flash memory layout.

2. Flash DPL image to NOR bank 4 (after booting from NOR bank 0):
   1. => tftp 0x80000000 dpl-eth.0x2A_0x41.dtb
   2. => print filesize 
   3. => erase 0x584D00000 +$filesize;cp.b 80000000 0x584D00000 $filesize

      Address 0x584D00000 is the location of DPL image in alternate NOR bank. Refer Flash layout for new boot flow with TF-A for the complete flash memory layout.

3. Flash DPC image to NOR bank 4 (after booting from NOR bank 0):
   1. => tftp 0x80000000 dpc.0x2A_0x41.dtb
   2. => print filesize 
   3. => erase 0x584E00000 +$filesize;cp.b 80000000 0x584E00000 $filesize

      Address 0x584E00000 is the location of DPC image in alternate NOR bank. Refer Flash layout for new boot flow with TF-A for the complete flash memory layout.

4. Boot from NOR bank 4: => qixis_reset altbank

Ensure that SD card, USB flash drive, or SCSI hard disk installed with LSDK Ubuntu distribution is plugged into the board to boot the board to Ubuntu. If U-Boot does not find LSDK on a mass storage device, it will boot TinyDistro from lsdk_linux_arm64_tiny.itb stored in NOR flash.

Option 2: Load images from partition on mass storage device (SD, USB, or SATA)

1. Select mass storage device to use.

   => mmc rescan

   => mmc info

   Or

   => usb start
   => usb info

   Or

   => scsi scan

   => scsi info

2. Optional – List files on the storage device

   => ls mmc <device:partition>

   For example:

   => ls mmc 0:2

   Or

   => ls usb <device:partition>

   For example:

   => ls usb 0:1

   Or

   => ls scsi <device:partition>

   For example:

   => ls scsi 0:2

   If the ls command fails to run, check that U-Boot in NOR bank 0 supports the command by typing ls at the U-Boot prompt:
   => ls
   ls - Lists files in a directory (default)
   Usage:
   ls <interface> [<dev[:part]> [directory]]
   - Lists files in directory [directory] of partition [part] on device type [interface] and instance [dev].
   If U-Boot does not support this command, then update the composite firmware image in NOR bank 0.
   For steps to update composite firmware image in NOR bank, see Layerscape Software Development Kit User Guide .

   Use the following command if the SD card is formatted/created using LSDK flex-installer command:
   => load <interface> [<dev[:part]> [<addr> [<filename> [bytes [pos]]]]]
   For example:
   => load mmc 0:2 $load_addr mc_10.18.0_ls2088a.itb
   Use the following command if the SD card is formatted/created on a Windows PC:
   => fatload <interface> [<dev[:part]> [<addr> [<filename> [bytes [pos]]]]]
   For example:
   => fatload mmc 0:2 $load_addr mc_10.18.0_ls2088a.itb
   Use the following command if the SD card is formatted/created on a Linux PC:
   => ext2load <interface> [<dev[:part]> [<addr> [<filename> [bytes [pos]]]]]
   For example:
   =>ext2load mmc 0:2 $load_addr mc_10.18.0_ls2088a.itb
   Also note that LSDK flex-installer command puts the images on the IInd partition, so 0:2 is used in the load command. If the SD card is formatted on Windows PC or Linux PC for single partition only, then 0 should be used instead of 0:2 in the fatload/ext2load command.

3. Flash MC firmware:
   
   1. Load MC firmware image from the storage device
      

      => load mmc 0:2 80000000 <mc firmware>

      For example:

      => load mmc 0:2 80000000 mc_10.18.0_ls2088a.itb

      => print filesize

      Or

      => load usb 0:2 80000000 <image name>

      => print filesize

      Or

      => load scsi 0:2 80000000 <image name>

      => print filesize

   2. Program MC firmware image to NOR bank 4 (after booting from NOR bank 0): => erase 0x584A00000 +$filesize;cp.b 80000000 0x584A00000 $filesize 

      Address 0x584A00000 is the location of MC firmware in alternate NOR bank.  Refer Flash layout for new boot flow with TF-A for the complete flash memory layout.

4. Flash DPL image:

   1. Load DPL image from the storage device
      

      => load mmc 0:2 80000000 <dpl image>

      For example:

      => load mmc 0:2 80000000 dpl-eth.0x2A_0x41.dtb

      => print filesize

      Or

      => load usb 0:2 80000000 <image name>

      => print filesize

      Or

      => load scsi 0:2 80000000 <image name>

      => print filesize

   2. Program DPL image to NOR bank 4 (after booting from NOR bank 0): => erase 0x584D00000 +$filesize;cp.b 80000000 0x584D00000 $filesize

      Address 0x584D00000 is the location of DPL image in alternate NOR flash.  Refer Flash layout for new boot flow with TF-A for the complete flash memory layout.

5. Flash DPC image:

   1. Load DPC image from the storage device
      

      => load mmc 0:2 80000000 <dpc image>

      For example:

      => load mmc 0:2 80000000 dpc.0x2A_0x41.dtb

      => print filesize

      Or

      => load usb 0:2 80000000 <image name>

      => print filesize

      Or

      => load scsi 0:2 80000000 <image name>

      => print filesize

   2. Program DPC image to NOR bank 4 (after booting from NOR bank 0): => erase 0x584E00000 +$filesize;cp.b 80000000 0x584E00000 $filesize

      Address 0x584E00000 is the location of DPC image in alternate NOR flash.  Refer Flash layout for new boot flow with TF-A for the complete flash memory layout.

6. Boot from NOR bank 4: => qixis_reset altbank

   Ensure that SD card, USB flash drive, or SCSI hard disk installed with LSDK Ubuntu distribution is plugged into the board to boot the board to Ubuntu. If U-Boot does not find LSDK on a mass storage device, it will boot TinyDistro from lsdk_linux_arm64_tiny.itb stored in NOR flash.