Debian Build U-Boot: Difference between revisions

From Variscite Wiki
(Initial (based on Yocto_Build_U-Boot)
 
(Update/Align to the Debian script)
Line 1: Line 1:
<!-- Set release according to "release" parameter in URL and use mx8m-yocto-kirkstone-5.15-2.0.x-v1.1 as default
<!-- Set release according to "release" parameter in URL and use RELEASE_BUSTER_V2.0_DART-MX8M as default
--> {{INIT_RELEASE_PARAM|mx8m-yocto-kirkstone-5.15-2.0.x-v1.1}}<!--
 
--> {{#lst:Yocto_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
This guide was derivat from the Yocto one and aligned to the Debian script.
--> {{#lst:B2QT_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
 
--> {{INIT_RELEASE_PARAM|RELEASE_BUSTER_V2.0_DART-MX8M}}<!--
--> {{#lst:Debian_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
--> {{#lst:Debian_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
--> {{#vardefine:PLATFORM_OS|{{#varexists:DEBIAN_NAME|Debian|Yocto}}}} <!--
--> {{PageHeader|{{#var:PLATFORM_OS}} Build U-Boot from source code}} {{DocImage|category1=Debian|category2={{#var:HARDWARE_NAME}}}} <!--
--> {{PageHeader|{{#var:PLATFORM_OS}} Build U-Boot from source code}} {{DocImage|category1=Yocto|category2=Debian}} <!--
--> __toc__
--> [[category:{{#var:HARDWARE_NAME}}]] __toc__


= Toolchain installation for out of {{#var:PLATFORM_OS}} builds =
= Toolchain installation for out of {{#var:PLATFORM_OS}} builds =


To install the toolchain, follow the {{Varlink2|{{#var:PLATFORM_OS}} Toolchain installation|{{#var:RELEASE_LINK}}}} guide.
To install the toolchain, follow the {{Varlink2|Debian Toolchain installation|{{#var:RELEASE_LINK}}}} guide.


= Build U-Boot out of {{#var:PLATFORM_OS}} tree =
= Build U-Boot out of {{#var:PLATFORM_OS}} tree =
Line 19: Line 19:


Configure compilation environment:
Configure compilation environment:
{{#switch:{{#var:PLATFORM_OS}}
|Yocto=
<br>
$ source {{#var:TOOLCHAIN_LOCATION}}
|Debian=
<br>
  $ export ARCH={{#var:ARCH}}
  $ export ARCH={{#var:ARCH}}
  $ export CROSS_COMPILE={{#var:BUILD_FOLDER}}/toolchain/{{#var:TOOLCHAIN}}/{{#var:CROSS_COMPILE}}
  $ export CROSS_COMPILE={{#var:BUILD_FOLDER}}/toolchain/{{#var:TOOLCHAIN}}/{{#var:CROSS_COMPILE}}
}}


Cleanup everything:
Cleanup everything:
Line 33: Line 26:


{{#switch: {{#var:SOC_SERIES}} | imx8 | imx9=
{{#switch: {{#var:SOC_SERIES}} | imx8 | imx9=
<br>
Select configuration:
Select configuration:
  $ make {{#var:U-BOOT_SD_DEFCONFIG}}
  $ make {{#var:U-BOOT_SD_DEFCONFIG}}
Line 63: Line 55:
  $ cd imx-boot-tools
  $ cd imx-boot-tools


<!-- SCFW/SECO firmware -->
{{#switch: {{#var:SOC_FAMILY}}
{{#switch: {{#var:SOC_FAMILY}}
| imx8=
| imx8=
Obtain SC firmware:<br>
Obtain SC firmware:<br>
{{#ifexpr: {{#var:YOCTO_VERSION}} < 3.1 |Either build|Build}} SCFW by following the {{Varlink|Yocto_Build_SCFW|{{#var:RELEASE_LINK}}|Build SCFW from source code}} page and copy the SCFW image to the imx-boot-tools directory{{#ifexpr: {{#var:YOCTO_VERSION}} < 3.1 |, or download the pre-built binary by running:<br>
{{#ifexpr: {{#var:DEBIAN_VERSION}} < 11 |Either build|Build}} SCFW by following the {{Varlink|Yocto_Build_SCFW|{{#var:RELEASE_LINK}}|Build SCFW from source code}} page and copy the SCFW image to the imx-boot-tools directory{{#ifexpr: {{#var:DEBIAN_VERSION}} < 11 |, or download the pre-built binary by running:<br>
  $ wget {{#var:META_VARISCITE_GIT}}/raw/{{#var:META_VARISCITE_BRANCH}}/recipes-bsp/imx-sc-firmware/imx-sc-firmware/{{#var:SC_FIRMWARE}} -O scfw_tcm.bin|
<!-- For Buster (Debian 10) obtain from the debian-var repo -->
  $ wget {{#var:DEBIAN_GIT}}/raw/{{#var:DEBIAN_BRANCH}}/variscite/{{#var:MACHINE_NAME}}/imx-boot-tools/{{#switch:{{#var:SOC}}|mx8m=scfw_tcm.bin|mx8qxp=mx8qx-scfw-tcm.bin}} -O scfw_tcm.bin|
.<br><br>}}
.<br><br>}}


{{#ifexpr: {{#rpos: {{#var:NXP_FIRMWARE}} | firmware-imx-8.1.1}} >= 0
Download SECO firmware:<br>
| <!-- SECO is in NXP_FIRMWARE for original Sumo release -->&nbsp;
<!-- For Buster (Debian 10) download from the debian-var repo -->
Download SECO firmware:
{{#ifexpr: {{#var:DEBIAN_VERSION}} < 11 |
  $ wget {{#var:NXP_FIRMWARE_URL}}/{{#var:NXP_FIRMWARE}}.bin
{{#switch:{{#var:SOC}}
  $ chmod +x {{#var:NXP_FIRMWARE}}.bin
| mx8qxp=
$ ./{{#var:NXP_FIRMWARE}}.bin
For i.MXQXP SOC revB:<br>
  $ cp {{#var:NXP_FIRMWARE}}/firmware/seco/{{#var:SECO_FIRMWARE}} .
  $ wget {{#var:DEBIAN_GIT}}/raw/{{#var:DEBIAN_BRANCH}}/variscite/{{#var:MACHINE_NAME}}/imx-boot-tools/mx8qxc0-ahab-container.img -O mx8qxb0-ahab-container.img
| <!-- SECO is in SECO_FIRMWARE for other releases --> &nbsp;
For i.MXQXP SOC revC:<br>
Download SECO firmware:
  $ wget {{#var:DEBIAN_GIT}}/raw/{{#var:DEBIAN_BRANCH}}/variscite/{{#var:MACHINE_NAME}}/imx-boot-tools/mx8qxc0-ahab-container.img -O mx8qxc0-ahab-container.img
| mx8qm=
  $ wget {{#var:DEBIAN_GIT}}/raw/{{#var:DEBIAN_BRANCH}}/variscite/{{#var:MACHINE_NAME}}/imx-boot-tools/mx8qxc0-ahab-container.img -O mx8qm-ahab-container.img
}}
|
<!-- For Bullseye (Debian 11) and above download from NXP -->
  $ wget {{#var:SECO_FIRMWARE_URL}}/{{#var:SECO_FIRMWARE}}.bin
  $ wget {{#var:SECO_FIRMWARE_URL}}/{{#var:SECO_FIRMWARE}}.bin
  $ chmod +x {{#var:SECO_FIRMWARE}}.bin
  $ chmod +x {{#var:SECO_FIRMWARE}}.bin
Line 96: Line 95:
  $ cp {{#var:NXP_FIRMWARE}}/firmware/ddr/synopsys/* .
  $ cp {{#var:NXP_FIRMWARE}}/firmware/ddr/synopsys/* .
| #default=
| #default=
Download DDR {{#switch: {{#var:SOC}}|mx8mq|mx8m= and HDMI|#default=}} firmware:
<!-- Download the DDR/HDMI firmware from the debian-var repository (Debian Buster and above) -->
  $ wget {{#var:NXP_FIRMWARE_URL}}/{{#var:NXP_FIRMWARE}}.bin
Download DDR {{#switch: {{#var:SOC}}|mx8mq|mx8m= and HDMI/DP|#default=}} firmware:
  $ chmod +x {{#var:NXP_FIRMWARE}}.bin
  $ git clone {{#var:DEBIAN_GIT}} -b {{#var:DEBIAN_BRANCH}}
$ ./{{#var:NXP_FIRMWARE}}.bin
  $ cp debian-var/variscite/{{#var:MACHINE_NAME}}/imx-boot-tools/*ddr4* .
$ cp {{#var:NXP_FIRMWARE}}/firmware/ddr/synopsys/* .
  {{#switch: {{#var:SOC}}|mx8m= $ cp debian-var/variscite/{{#var:MACHINE_NAME}}/imx-boot-tools/signed_* .|#default=}}
  {{#switch: {{#var:SOC}}|mx8mq|mx8m= $ cp {{#var:NXP_FIRMWARE}}/firmware/hdmi/cadence/signed_* .|#default=}}
}}
}}


<!-- imx-mkimage tool -->
{{#switch: {{#var:SOC_FAMILY}}
{{#switch: {{#var:SOC_FAMILY}}
| imx8=
| imx8=
Download and build imx_mkimage:
Download and build imx-mkimage:
  $ git clone {{#var:NXP_IMX_GIT}}/imx-mkimage -b {{#var:NXP_IMX_BRANCH}}
  $ git clone {{#var:NXP_IMX_GIT}}/imx-mkimage -b {{#var:NXP_IMX_BRANCH}}
  $ cd imx-mkimage
  $ cd imx-mkimage
Line 113: Line 112:
  $ cd ..
  $ cd ..
| imx9=
| imx9=
Download and build imx_mkimage:
Download and build imx-mkimage:
  $ git clone {{#var:NXP_IMX_GIT}}/imx-mkimage -b {{#var:NXP_IMX_BRANCH}}
  $ git clone {{#var:NXP_IMX_GIT}}/imx-mkimage -b {{#var:NXP_IMX_BRANCH}}
  $ cd imx-mkimage
  $ cd imx-mkimage
Line 120: Line 119:
  $ cd ..
  $ cd ..
| #default=
| #default=
Download imx_mkimage:
Download imx-mkimage:
  $ git clone {{#var:NXP_IMX_GIT}}/imx-mkimage -b {{#var:NXP_IMX_BRANCH}}
  $ git clone {{#var:NXP_IMX_GIT}}/imx-mkimage -b {{#var:NXP_IMX_BRANCH}} <!--
  $ cp imx-mkimage/iMX8M/*.c imx-mkimage/iMX8M/*.sh {{#ifeq: {{#var:FSL_BSP_VERSION}}|L4.14.78-1.0.0_ga|imx-mkimage/iMX8M/soc.mak|}} {{#ifeq: {{#var:YOCTO_NAME}}|Morty||imx-mkimage/scripts/*.sh}} .
  Patch imx-mkimage for mx8mn, mx8mm, mx8mp, mx8mq
{{#ifexpr: {{#var:YOCTO_VERSION}} >= 3.3 |$ cp dtb_check.sh ../scripts/|}}
-->{{#ifexpr: {{#var:DEBIAN_VERSION}} >= 11
}}
| <!-- For Bullseye (Debian 11) and above, use patches located at debian-var -->
 
  $ git clone {{#var:DEBIAN_GIT}} -b {{#var:DEBIAN_BRANCH}}
Download and build ATF:<!--  
Use VARISCITE_ATF_GIT from yocto platform customization if exists for Variscite hosted repo, else default to NXP:
-->
$ git clone {{#var:VARISCITE_ATF_GIT | {{#var:NXP_IMX_GIT}}/imx-atf}} -b {{#var:VARISCITE_ATF_BRANCH | {{#var:NXP_IMX_BRANCH}}}}
{{#ifeq: {{#var:SOC_FAMILY}}|imx8m|
  $ git clone {{#var:META_VARISCITE_GIT}} -b {{#var:META_VARISCITE_BRANCH}}
{{#ifeq: {{#var:FSL_BSP_VERSION}}|L4.14.78-1.0.0_ga||
{{#if: {{#var:IMX_MKIMAGE_SOC_PATCH}}|
  $ cd imx-mkimage
  $ cd imx-mkimage
{{#if: {{#var:IMX_MKIMAGE_SOC_FREESCALE_PATCH}}|
  $ git apply ../{{#var:DEBIAN_GIT}}/{{#var:IMX_MKIMAGE_SOC_PATCH}}<!--
$ wget {{#var:IMX_MKIMAGE_SOC_FREESCALE_PATCH_URL}}
$ git apply {{#var:IMX_MKIMAGE_SOC_FREESCALE_PATCH}}
$ rm {{#var:IMX_MKIMAGE_SOC_FREESCALE_PATCH}}
}}
  $ git apply ../{{#var:META_VARISCITE_REPO}}/{{#var:IMX_MKIMAGE_SOC_PATCH}}<!--
   -->{{#varexists:IMX_MKIMAGE_SOC_PATCH_1 |
   -->{{#varexists:IMX_MKIMAGE_SOC_PATCH_1 |
  <br>$ git apply ../{{#var:META_VARISCITE_REPO}}/{{#var:IMX_MKIMAGE_SOC_PATCH_1}}
  <br>$ git apply ../{{#var:DEBIAN_GIT}}/variscite/{{#var:MACHINE_NAME}}/imx-boot-tools/{{#var:IMX_MKIMAGE_SOC_PATCH_1}}
  }}<!--
  }}<!--
   -->{{#varexists:IMX_MKIMAGE_SOC_PATCH_2 |
   -->{{#varexists:IMX_MKIMAGE_SOC_PATCH_2 |
  <br>$ git apply ../{{#var:META_VARISCITE_REPO}}/{{#var:IMX_MKIMAGE_SOC_PATCH_2}}
  <br>$ git apply ../{{#var:DEBIAN_GIT}}/variscite/{{#var:MACHINE_NAME}}/imx-boot-tools/{{#var:IMX_MKIMAGE_SOC_PATCH_2}}
  }}
  }}
$ cp iMX8M/soc.mak ..
  $ cd ..
  $ cd ..
  |
  | <!-- For Buster (Debian 10), overwrite soc.mak (only for mx8mn) -->
  $ cp {{#var:META_VARISCITE_REPO}}/recipes-bsp/imx-mkimage/files/soc.mak .}}
{{#switch:{{#var:SOC}}
  $ git clone {{#var:DEBIAN_GIT}} -b {{#var:DEBIAN_BRANCH}}
|mx8mn= $ cp {{#var:DEBIAN_GIT}}/variscite/{{#var:MACHINE_NAME}}/imx-boot-tools/{{#var:MACHINE_NAME}}/soc.mak imx-mkimage/iMX8M/soc.mak
  }}
  }}
|
  }} <!-- end of DEBIAN_VERSION -->
  }}
  $ cp imx-mkimage/iMX8M/*.c imx-mkimage/iMX8M/*.sh imx-mkimage/iMX8M/soc.mak . <!-- dtb-check.sh -->
  $ cd imx-atf {{#if: {{#var:VARISCITE_ATF_GIT}}||&nbsp;
}}
{{#ifeq: {{#var:SOC_FAMILY}}| imx8m |
 
{{#ifeq: {{#var:FSL_BSP_VERSION}}| L4.14.78-1.0.0_ga | $ git apply ../{{#var:META_VARISCITE_REPO}}/recipes-bsp/imx-atf/imx-atf/* |
<!-- ATF firmware -->
{{#switch: {{#var:SOC}}|mx8mn= $ git apply ../{{#var:META_VARISCITE_REPO}}/recipes-bsp/imx-atf/imx-atf/*
Download {{#ifexpr: {{#var:DEBIAN_VERSION}} >= 11 |and build}} ATF:<!--  
| mx8mp= $ git apply ../{{#var:META_VARISCITE_REPO}}/recipes-bsp/imx-atf/imx-atf/*
Use VARISCITE_ATF_GIT from yocto platform customization if exists for Variscite hosted repo, else default to NXP:
| mx8mm= $ git apply ../{{#var:META_VARISCITE_REPO}}/recipes-bsp/imx-atf/imx-atf/imx8mm* ../{{#var:META_VARISCITE_REPO}}/recipes-bsp/imx-atf/imx-atf/imx8m-* |
-->
| mx8mq | mx8m= $ git apply ../{{#var:META_VARISCITE_REPO}}/recipes-bsp/imx-atf/imx-atf/imx8m-*}} }} }} }}
{{#ifexpr: {{#var:DEBIAN_VERSION}} > 10
$ source {{#var:TOOLCHAIN_LOCATION}}
| <!-- For Bullyese (Debian 11) and above -->
$ git clone {{#var:VARISCITE_ATF_GIT}} -b {{#var:VARISCITE_ATF_BRANCH}}  
$ cd imx-atf
  $ unset LDFLAGS
  $ unset LDFLAGS
  $ make PLAT={{#var:IMX_ATF_PLAT}} bl31
  $ make PLAT={{#var:IMX_ATF_PLAT}} bl31
  $ cp build/{{#var:IMX_ATF_PLAT}}/release/bl31.bin ..
  $ cp build/{{#var:IMX_ATF_PLAT}}/release/bl31.bin ..
  $ cd ..
  $ cd ..
| <!-- For Buster (Debian 10) -->
$ wget {{#var:DEBIAN_GIT}}/raw/{{#var:DEBIAN_BRANCH}}/variscite/{{#var:MACHINE_NAME}}/imx-boot-tools/bl31-{{#var:SOC}}.bin -O bl31.bin
}}


<!-- Build imx-boot -->
Copy U-Boot binaries:
Copy U-Boot binaries:
  $ cp ../tools/mkimage mkimage_uboot
  $ cp ../tools/mkimage mkimage_uboot
Line 259: Line 252:
}}
}}
}}
}}
  (Replace /dev/sdX with the correct device)
  (Replace /dev/sdX with the correct device)
If you want to use our recovery SD card to flash the built U-Boot to NAND flash/eMMC, then copy it to the appropriate location in the SD card:
If you want to use our recovery SD card to flash the built U-Boot to NAND flash/eMMC, then copy it to the appropriate location in the SD card:
{{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A  
{{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A  
|<br>
|<br>
  $ sudo cp {{#var:U-BOOT_IMAGE_NAME}} /media/rootfs/opt/images/
  $ sudo cp {{#var:U-BOOT_IMAGE_NAME}} /media/rootfs/opt/images/Debian
|<br>
|<br>
  $ sudo cp SPL /media/rootfs/opt/images/
  $ sudo cp SPL /media/rootfs/opt/images/Debian
  $ sudo cp u-boot.img /media/rootfs/opt/images/
  $ sudo cp u-boot.img /media/rootfs/opt/images/Debian
}}
}}
And eject the SD card gracefully from host machine.
And eject the SD card gracefully from host machine.
Line 273: Line 266:
{{Note|Note: If you manually upgrade an existing U-Boot, and you have an old environment saved, it is a good idea to reset your environment to the new default (see [[U-Boot 4.1.15 features#Environment handling commands|Environment handling commands]])}}
{{Note|Note: If you manually upgrade an existing U-Boot, and you have an old environment saved, it is a good idea to reset your environment to the new default (see [[U-Boot 4.1.15 features#Environment handling commands|Environment handling commands]])}}


= Update your U-Boot out of {{#var:PLATFORM_OS}} tree =
= Update your U-Boot out of Debian tree =
<pre>
<pre>
$ cd uboot-imx
$ git pull
$ git pull
</pre>
</pre>

Revision as of 19:54, 2 May 2023

Warning: This page is designed to be used with a 'release' URL parameter.

This page is using the default release RELEASE_BUSTER_V2.0_DART-MX8M.
To view this page for a specific Variscite SoM and software release, please follow these steps:

  1. Visit variwiki.com
  2. Select your SoM
  3. Select the software release
Build U-Boot from source code

Toolchain installation for out of builds

To install the toolchain, follow the Debian Toolchain installation guide.

Build U-Boot out of tree

Obtain sources:

$ git clone https://github.com/varigit/uboot-imx.git -b imx_v2018.03_4.14.78_1.0.0_ga_var01
$ cd uboot-imx

Configure compilation environment:

$ export ARCH=arm64
$ export CROSS_COMPILE=~/var_mx8m_dart_debian/toolchain/gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu/aarch64-linux-gnu-

Cleanup everything:

$ make mrproper

Select configuration:

$ make imx8m_var_dart_defconfig

Build U-Boot:

$ make -j$(nproc)

Build boot image

The final boot image contains multiple firmware files, as explained by NXP in IMX_LINUX_USERS_GUIDE.pdf (Search for "How to build imx-boot image by using imx-mkimage").

The following procedure builds the final image:

Create imx-boot-tools directory:

$ mkdir imx-boot-tools
$ cd imx-boot-tools

Download DDR and HDMI/DP firmware:

$ git clone https://github.com/varigit/debian-var.git -b debian_buster_var01
$ cp debian-var/variscite/imx8m-var-dart/imx-boot-tools/*ddr4* .
$ cp debian-var/variscite/imx8m-var-dart/imx-boot-tools/signed_* .

Download imx-mkimage:

$ git clone /imx-mkimage -b   
$ cp imx-mkimage/iMX8M/*.c imx-mkimage/iMX8M/*.sh imx-mkimage/iMX8M/soc.mak .

Download ATF:

$ wget https://github.com/varigit/debian-var.git/raw/debian_buster_var01/variscite/imx8m-var-dart/imx-boot-tools/bl31-mx8m.bin -O bl31.bin

Copy U-Boot binaries:

$ cp ../tools/mkimage mkimage_uboot
$ cp ../u-boot.bin .
$ cp ../u-boot-nodtb.bin ../spl/u-boot-spl.bin ../arch/arm/dts/ .

Build boot image:

$ make -f soc.mak clean
$ make -f soc.mak SOC= dtbs= MKIMG=./mkimage_imx8 PAD_IMAGE=./pad_image.sh CC=gcc OUTIMG=imx-boot-sd.bin flash_evk 

Install the built U-Boot on an SD card


$ sudo dd if=imx-boot-sd.bin of=/dev/sdX bs=1K seek= conv=fsync
(Replace /dev/sdX with the correct device)

If you want to use our recovery SD card to flash the built U-Boot to NAND flash/eMMC, then copy it to the appropriate location in the SD card:

$ sudo cp SPL /media/rootfs/opt/images/Debian
$ sudo cp u-boot.img /media/rootfs/opt/images/Debian

And eject the SD card gracefully from host machine.


Note: If you manually upgrade an existing U-Boot, and you have an old environment saved, it is a good idea to reset your environment to the new default (see Environment handling commands)

Update your U-Boot out of Debian tree

$ cd uboot-imx
$ git pull