synchronise with lx2160a_build and restructure - tested on one board

Author: Josua-SR

README.md

@@ -14,17 +14,11 @@ Start in a **new empty directory** with plenty of free disk space - at least 30G
 
 2. apply downstream patches to dependent layers:
 
-   - `poky`: add support for wic images without partition table (for xspi image)
-
-      ```
-      pushd sources/poky
-      git am ../meta-solidrun-arm-lx2xxx/patches/poky/0001-wic-add-supppport-for-generating-images-without-part.patch
-      popd
-      ```
+TBD.
 
 3. Initialise a build directory with example configuration files based on lx2160ardb, and appropriate shell environment variables:
 
-       source ./setup-env -m lx2160ardb-rev2 -b build_lx2160a-rev2-honeycomb
+       source ./setup-env -m lx2160ardb-rev2 -b build
 
 4. Adapt example configuration files for SolidRun LX2160A Honeycomb:
 
@@ -43,47 +37,30 @@ Start in a **new empty directory** with plenty of free disk space - at least 30G
      +MACHINE ??= 'lx2160a-rev2-honeycomb'
      ```
 
+     Enable generating sd bootable image (wic). append:
+
+     ```
+     IMAGE_FSTYPES:append = " wic.gz wic.bmap "
+     # break dependency cycle with core-image-minimal used as initramfs
+     IMAGE_FSTYPES:remove:pn-core-image-minimal = "wic.gz wic.bmap"
+     ```
+
    - See below for additional configuration options.
 
 5. Build nxp image `fsl-image-networking`:
 
        bitbake fsl-image-networking
 
-6. Generate bootable disk image:
-
-   NXP QorIQ Layers by default do not assemble full bootable disk images,
-   users are expected to install all components to various offsets manually.
-
-   SolidRun provides [wic](https://docs.yoctoproject.org/dev/dev-manual/wic.html) configuration files for generating bootable disk images from the build artifacts.
-   This process can be launched after a successful build:
-
-   - SD-Card / eMMC (includes rootfs):
-
-         wic create lx2160a-bootimg-mmc -e fsl-image-networking
+6. Find resulting image ready for programming:
 
-     This generates a bootable disk image named `lx2160a-bootimg-mmc.wks-<timestamp>-mmcblk.direct` that is suitable
-     for writing to SD-Card or eMMC data partition, from the previously built `fsl-image-networking` target.
-
-   - SPI Flash (without rootfs):
-
-         wic create lx2160a-bootimg-xspi -e fsl-image-networking
-
-     This generates a bootable spi flash image named `lx2160a-bootimg-xspi.wks-<timestamp>-mmcblk.direct` that is suitable
-     for writing to SPI flash, from the previously built `fsl-image-networking` target's bootloader parts.
-
-   - SD-Card / eMMC / USB / SATA / NVMe (rootfs only):
-
-         wic create lx2160a-rootimg -e fsl-image-networking
-
-     This generates a bootable disk image named `lx2160a-rootimg.wks-<timestamp>-mmcblk.direct` that is suitable
-     for writing to any block storage, from the previously built `fsl-image-networking`.
-     It comes with kernel + rootfs only, use on separate media, together with an SD or SPI boot image.
+       ls -lh tmp/deploy/images/
+       ls -lh tmp/deploy/images/lx2160a-clearfog-cx/
 
 Note: The build environment and ability to run `bitbake` is lost when closing the terminal or rebooting.
 It can be restored at any time by entering the build directory and sourcing the aut-generated `SOURCE_THIS` file:
 
 ```
-cd <insert-your-workdir>/build_lx2160acex7-rev2
+cd <insert-your-workdir>/build
 source SOURCE_THIS
 ```
 
@@ -100,7 +77,9 @@ This Layer supports the following machines:
 | lx2160a-rev2-cex6-evb    | SolidRun-internal Evaluation Board, LX2160A Silicon 2.0 (production version)   |
 | lx2160a-rev2-clearfog-cx | LX2160A COM-Express 7 on Clearfog-CX, LX2160A Silicon 2.0 (production version) |
 | lx2160a-rev2-honeycomb   | LX2160A COM-Express 7 on Honeycomb, LX2160A Silicon 2.0 (production version)   |
+| lx2160a-rev2-half-twins  | LX2160A COM-Express 7 on Twins, LX2160A Silicon 2.0 (production version)       |
 | lx2162a-rev2-clearfog    | LX2162A SoM on Clearfog                                                        |
+| lx216xa-solidrun         | Generic LX2160A & LX2162A without Bootloader                                   |
 
 ### Supported Images
 
@@ -111,6 +90,14 @@ This Layer supports the following images:
 | fsl-image-networking      | Typical networking features and basic cli utilities                            |
 | fsl-image-networking-full | Demo of all packages tested by NXP including dpdk, dpdk examples and vpp       |
 
+### Image Types (wic)
+
+This layer can generate a range of image types by `WKS_FILE` in local.conf:
+
+- `lx2160a-bootimg-mmc.wks.in` (default): Bootloader & Kernel & RootFS, for SD or eMMC.
+- `lx2160a-bootimg-xspi.wks.in`: Bootloader only, for SPI Flash.
+- `lx2160a-rootimg.wks.in`: Kernel & RootFS only, for any block storage.
+
 ### DDR Clock
 
 DDR Clock can be configured in local.conf using `LX2160A_DDR_SPEED`, supported values are:
@@ -152,6 +139,57 @@ Additional configurations are added by patching `mc-utils` package and adding fi
 
 ## Known Issues
 
+### `setup-env` script requires bash
+
+On shells other than bash the nxp `setup-env` script fails unintuitively, e.g. below with zsh:
+
+```
+source ./setup-env -m lx2160ardb-rev2 -b build
+./setup-env:159: no matches found: /opt/workspace/YOCTO/lx2k-scarthgap/sources/meta-fsl*/*/*/conf/machine
+lx2160ardb-rev2 is not supported by this build setup.
+Usage: . setup-env -m <machine>
+usage:3: no matches found: /opt/workspace/YOCTO/lx2k-scarthgap/sources/meta-fsl*/*/*/conf/machine
+
+    Supported machines:
+
+
+    Optional parameters:
+    * [-m machine]: the target machine to be built.
+    * [-j jobs]:    number of jobs for make to spawn during the compilation stage.
+    * [-t tasks]:   number of BitBake tasks that can be issued in parallel.
+    * [-b path]:    non-default path of project build folder.
+    * [-d path]:    non-default path of DL_DIR (downloaded source)
+    * [-c path]:    non-default path of SSTATE_DIR (shared state Cache)
+    * [-h]:         help
+```
+
+Ensure using a `bash` shell.
+
+### permission error in disable_network
+
+Bitbake can fail with a confusing permission error while trying to disable it's child processes network access:
+
+```
+ERROR: PermissionError: [Errno 1] Operation not permitted
+
+During handling of the above exception, another exception occurred:
+
+Traceback (most recent call last):
+  File "/opt/workspace/YOCTO/imx8-scarthgap/sources/poky/bitbake/bin/bitbake-worker", line 278, in child
+    bb.utils.disable_network(uid, gid)
+  File "/opt/workspace/YOCTO/imx8-scarthgap/sources/poky/bitbake/lib/bb/utils.py", line 1696, in disable_network
+    with open("/proc/self/uid_map", "w") as f:
+PermissionError: [Errno 1] Operation not permitted
+
+ERROR: Task (virtual:native:/opt/workspace/YOCTO/imx8-scarthgap/sources/poky/meta/recipes-devtools/autoconf/autoconf_2.72e.bb:do_unpack) failed with exit code '1'
+```
+
+See [Ubuntu Bug 2056555](https://bugs.launchpad.net/ubuntu/+source/apparmor/+bug/2056555) for more details.
+
+As a workaround apparmor "unprivileged_userns" profile can be temporarily disabled:
+
+    sudo apparmor_parser -R /etc/apparmor.d/unprivileged_userns
+
 ## Maintainer Notes
 
 ### Patching Linux / U-Boot / ATF / RCW / DPL / DPC / etc.:

conf/machine/include/lx2160a-clearfog-cx.inc

@@ -3,12 +3,14 @@ KERNEL_DEVICETREE ?= " \
 	freescale/fsl-lx2160a-clearfog-cx.dtb \
 	freescale/fsl-lx2160a-honeycomb.dtb \
 "
-# HACK: place copy of kernel dtb in vendor subfolder as expected by u-boot
+
+# install DTBs with freescale/ prefix
 IMAGE_BOOT_FILES:append = " \
     fsl-lx2160a-clearfog-cx.dtb;freescale/fsl-lx2160a-clearfog-cx.dtb \
     fsl-lx2160a-honeycomb.dtb;freescale/fsl-lx2160a-honeycomb.dtb \
 "
-IMAGE_BOOT_FILES:remove = "${KERNEL_DEVICETREE}"
+# HACK: place one sentinel dtb without freescale/ prefix to fix wic image generated extlinux.conf fdtdir path
+IMAGE_BOOT_FILES:prepend = " fsl-lx2160a-clearfog-cx.dtb;sentinel.dtb "
 
 # select DPL/DPC (config/lx2160a/LX2160A-<MC_FLAVOUR>/<DPL/DPC>)
 # variable consumed in wks files

conf/machine/include/lx2160acex6-rev2.inc

@@ -3,45 +3,31 @@
 #@SOC: LSCH3
 #@DESCRIPTION: Machine configuration for SolidRun Internal LX2160A Rev 2.0 COM-Express Type 6 Module
 
-require conf/machine/include/qoriq-arm64.inc
-DEFAULTTUNE ?= "cortexa72-crypto"
-require conf/machine/include/arm/armv8a/tune-cortexa72.inc
-
-MACHINEOVERRIDES =. "lx2160a-cex6:fsl-lsch3:lx2160a:"
-
-MACHINE_FEATURES:append = " optee "
-
-KERNEL_CLASSES  = " kernel-fitimage "
-KERNEL_IMAGETYPES = "fitImage"
+MACHINEOVERRIDES =. "lx2160a-cex6:"
 
 DTB_LOAD = "0x90000000"
 UBOOT_ENTRYPOINT = "0x80080000"
 
-UBOOT_CONFIG ?= "tfa-secure-boot tfa"
+UBOOT_CONFIG ??= "tfa-secure-boot tfa"
 UBOOT_CONFIG[tfa] = "lx2160acex7_tfa_defconfig,,u-boot-dtb.bin"
 UBOOT_CONFIG[tfa-secure-boot] = "lx2160ardb_tfa_SECURE_BOOT_defconfig,,u-boot-dtb.bin"
 
-KERNEL_DEFCONFIG ?= "defconfig"
-
-SERIAL_CONSOLES ?= "115200;ttyS0 115200;ttyS1 115200;ttyAMA0"
-SERIAL_CONSOLES_CHECK ?= "${SERIAL_CONSOLES}"
+ATF_PLATFORM ?= "lx2160acex6"
 
 LX2160A_BUS_SPEED ?= "700"
 LX2160A_CPU_SPEED ?= "2000"
 LX2160A_DDR_SPEED ?= "2900"
 
 UEFI_XSPIBOOT ?= "LX2160ARDB_EFI_NORBOOT.fd"
 
-EXTRA_IMAGEDEPENDS += "management-complex mc-utils rcw ls2-phy ddr-phy uefi qoriq-atf inphi"
-USE_VT = "0"
-
-# install the vendor-prefixed dtbs
-# Note: must keep the non-prefixed versions in place,
-# to ensure bootimg-partition.py does not mess with extlinux.conf fdtdir
-IMAGE_BOOT_FILES:append = "${KERNEL_DEVICETREE}"
+EXTRA_IMAGEDEPENDS += "management-complex mc-utils rcw ls2-phy ddr-phy qoriq-atf"
 
 # select DPL/DPC source (config/lx2160a/LX2160A-<MC_FLAVOUR>)
 MC_FLAVOUR ?= "CEX6"
 
 # select rev2 rcw
 RCW_FOLDER ?= "lx2160acex6_rev2"
+RCW_BOARDS ?= "lx2160acex6_rev2"
+
+# generate sd-bootable wic image
+WKS_FILE ?= "lx2160a-bootimg-mmc.wks.in"

conf/machine/include/lx2160acex7.inc

@@ -3,44 +3,30 @@
 #@SOC: LSCH3
 #@DESCRIPTION: Machine configuration for SolidRun LX2160A Rev 1.0 COM-Express Type 7 Module
 
-require conf/machine/include/qoriq-arm64.inc
-DEFAULTTUNE ?= "cortexa72-crypto"
-require conf/machine/include/arm/armv8a/tune-cortexa72.inc
-
-MACHINEOVERRIDES =. "lx2160a-cex7:fsl-lsch3:lx2160a:"
-
-MACHINE_FEATURES:append = " optee "
-
-KERNEL_CLASSES  = " kernel-fitimage "
-KERNEL_IMAGETYPES = "fitImage"
+MACHINEOVERRIDES =. "lx2160a-cex7:"
 
 DTB_LOAD = "0x90000000"
 UBOOT_ENTRYPOINT = "0x80080000"
 
-UBOOT_CONFIG ?= "tfa-secure-boot tfa"
+UBOOT_CONFIG ??= "tfa-secure-boot tfa"
 UBOOT_CONFIG[tfa] = "lx2160acex7_tfa_defconfig,,u-boot-dtb.bin"
 UBOOT_CONFIG[tfa-secure-boot] = "lx2160ardb_tfa_SECURE_BOOT_defconfig,,u-boot-dtb.bin"
 
-KERNEL_DEFCONFIG ?= "defconfig"
-
-SERIAL_CONSOLES ?= "115200;ttyS0 115200;ttyS1 115200;ttyAMA0"
-SERIAL_CONSOLES_CHECK ?= "${SERIAL_CONSOLES}"
+ATF_PLATFORM ?= "lx2160acex7"
 
 LX2160A_BUS_SPEED ?= "700"
 LX2160A_CPU_SPEED ?= "2000"
 LX2160A_DDR_SPEED ?= "2900"
 
 UEFI_XSPIBOOT ?= "LX2160ARDB_EFI_NORBOOT.fd"
 
-EXTRA_IMAGEDEPENDS += "management-complex mc-utils rcw ls2-phy ddr-phy uefi qoriq-atf inphi"
-USE_VT = "0"
-
-# install the vendor-prefixed dtbs
-# Note: must keep the non-prefixed versions in place,
-# to ensure bootimg-partition.py does not mess with extlinux.conf fdtdir
-IMAGE_BOOT_FILES:append = "${KERNEL_DEVICETREE}"
+EXTRA_IMAGEDEPENDS += "management-complex mc-utils rcw ls2-phy ddr-phy qoriq-atf"
 
 # select DPL/DPC source (config/lx2160a/LX2160A-<MC_FLAVOUR>)
 MC_FLAVOUR ?= "CEX7"
 
 RCW_FOLDER ?= "lx2160acex7"
+RCW_BOARDS ?= "lx2160acex7 lx2160acex7_rev2"
+
+# generate sd-bootable wic image
+WKS_FILE ?= "lx2160a-bootimg-mmc.wks.in"

conf/machine/include/lx2162asom-rev2.inc

@@ -3,45 +3,31 @@
 #@SOC: LSCH3
 #@DESCRIPTION: Machine configuration for SolidRun LX2162A Rev 2.0 System on Module
 
-require conf/machine/include/qoriq-arm64.inc
-DEFAULTTUNE ?= "cortexa72-crypto"
-require conf/machine/include/arm/armv8a/tune-cortexa72.inc
-
-MACHINEOVERRIDES =. "lx2162a-som:fsl-lsch3:lx2162a:"
-
-MACHINE_FEATURES:append = " optee "
-
-KERNEL_CLASSES  = " kernel-fitimage "
-KERNEL_IMAGETYPES = "fitImage"
+MACHINEOVERRIDES =. "lx2162a-som:"
 
 DTB_LOAD = "0x90000000"
 UBOOT_ENTRYPOINT = "0x80080000"
 
-UBOOT_CONFIG ?= "tfa-secure-boot tfa"
+UBOOT_CONFIG ??= "tfa-secure-boot tfa"
 UBOOT_CONFIG[tfa] = "lx2160acex7_tfa_defconfig,,u-boot-dtb.bin"
 UBOOT_CONFIG[tfa-secure-boot] = "lx2160ardb_tfa_SECURE_BOOT_defconfig,,u-boot-dtb.bin"
 
-KERNEL_DEFCONFIG ?= "defconfig"
-
-SERIAL_CONSOLES ?= "115200;ttyS0 115200;ttyS1 115200;ttyAMA0"
-SERIAL_CONSOLES_CHECK ?= "${SERIAL_CONSOLES}"
+ATF_PLATFORM ?= "lx2162asom"
 
 LX2160A_BUS_SPEED ?= "650"
 LX2160A_CPU_SPEED ?= "2000"
 LX2160A_DDR_SPEED ?= "2900"
 
 UEFI_XSPIBOOT ?= "LX2160ARDB_EFI_NORBOOT.fd"
 
-EXTRA_IMAGEDEPENDS += "management-complex mc-utils rcw ls2-phy ddr-phy uefi qoriq-atf inphi"
-USE_VT = "0"
-
-# install the vendor-prefixed dtbs
-# Note: must keep the non-prefixed versions in place,
-# to ensure bootimg-partition.py does not mess with extlinux.conf fdtdir
-IMAGE_BOOT_FILES:append = "${KERNEL_DEVICETREE}"
+EXTRA_IMAGEDEPENDS += "management-complex mc-utils rcw ls2-phy ddr-phy qoriq-atf"
 
 # select DPL/DPC source (config/lx2162a/LX2162A-<MC_FLAVOUR>)
 MC_FLAVOUR ?= "SOM"
 
 # select rev2 rcw
 RCW_FOLDER ?= "lx2162asom_rev2"
+RCW_BOARDS ?= "lx2162asom_rev2"
+
+# generate sd-bootable wic image
+WKS_FILE ?= "lx2160a-bootimg-mmc.wks.in"

conf/machine/include/lx216xa-solidrun.inc

@@ -0,0 +1,17 @@
+require conf/machine/include/qoriq-arm64.inc
+DEFAULTTUNE ?= "cortexa72-crypto"
+require conf/machine/include/arm/armv8a/tune-cortexa72.inc
+
+MACHINEOVERRIDES =. "fsl-lsch3:lx2160a:"
+
+MACHINE_FEATURES:append = " optee "
+
+KERNEL_CLASSES  = " kernel-fitimage "
+KERNEL_IMAGETYPES = "fitImage"
+
+KERNEL_DEFCONFIG ?= "defconfig"
+
+SERIAL_CONSOLES ?= "115200;ttyAMA0"
+SERIAL_CONSOLES_CHECK ?= "${SERIAL_CONSOLES}"
+
+USE_VT = "0"

conf/machine/lx2160a-clearfog-cx.conf

@@ -3,5 +3,9 @@
 #@SOC: LSCH3
 #@DESCRIPTION: Machine configuration for SolidRun LX2160A 1.0 Clearfog CX Board
 
+require conf/machine/include/lx216xa-solidrun.inc
 require conf/machine/include/lx2160acex7.inc
 require conf/machine/include/lx2160a-clearfog-cx.inc
+
+UBOOT_FDT ?= "fsl-lx2160a-clearfog-cx"
+UBOOT_FDT_FILE ?= "freescale/fsl-lx2160a-clearfog-cx.dtb"

conf/machine/lx2160a-honeycomb.conf

@@ -3,5 +3,9 @@
 #@SOC: LSCH3
 #@DESCRIPTION: Machine configuration for SolidRun LX2160A 1.0 Honeycomb Board
 
+require conf/machine/include/lx216xa-solidrun.inc
 require conf/machine/include/lx2160acex7.inc
 require conf/machine/include/lx2160a-clearfog-cx.inc
+
+UBOOT_FDT ?= "fsl-lx2160a-honeycomb"
+UBOOT_FDT_FILE ?= "freescale/fsl-lx2160a-honeycomb.dtb"