diff options
| author | Mark Hatle <mark.hatle@amd.com> | 2024-11-21 13:54:05 -0600 |
|---|---|---|
| committer | Mark Hatle <mark.hatle@amd.com> | 2024-11-21 13:54:05 -0600 |
| commit | 1241013c7bce4262a6128eb4ccb3db410831746d (patch) | |
| tree | da79ab94a5b4ae9abf6211d8289a4bf5dbdcde9f /docs | |
| parent | 6e3a214d268c7d75a42a9a329b5621fb5a49a89a (diff) | |
| parent | 10531c26195f97f9565e9770c21977805e53c46b (diff) | |
| download | meta-xilinx-1241013c7bce4262a6128eb4ccb3db410831746d.tar.gz | |
Merge remote-tracking branch 'origin/scarthgap' into yocto-master
This moves the system to scarthgap. It is known to NOT work with Styhead and master,
Signed-off-by: Mark Hatle <mark.hatle@amd.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.booting.microblaze.md | 50 | ||||
| -rw-r--r-- | docs/README.booting.zynq.md | 52 | ||||
| -rw-r--r-- | docs/README.dfx.user.dts.md | 4 | ||||
| -rw-r--r-- | docs/README.fw.package.md | 17 |
4 files changed, 88 insertions, 35 deletions
diff --git a/docs/README.booting.microblaze.md b/docs/README.booting.microblaze.md index 91c0eda9..21bd1dad 100644 --- a/docs/README.booting.microblaze.md +++ b/docs/README.booting.microblaze.md | |||
| @@ -2,18 +2,20 @@ | |||
| 2 | 2 | ||
| 3 | Booting OS images on MicroBlaze target boards can be done using JTAG and QSPI boot modes. | 3 | Booting OS images on MicroBlaze target boards can be done using JTAG and QSPI boot modes. |
| 4 | 4 | ||
| 5 | * [Setting Up the Target](#setting-up-the-target) | 5 | - [Booting OS Images on MicroBlaze target boards](#booting-os-images-on-microblaze-target-boards) |
| 6 | * [Booting from JTAG](#booting-from-jtag) | 6 | - [Setting Up the Target](#setting-up-the-target) |
| 7 | * [Sourcing the XSDB tools](#sourcing-the-xsdb-tools) | 7 | - [Booting from JTAG](#booting-from-jtag) |
| 8 | * [Deploying the images to target](#deploying-the-images-to-target) | 8 | - [Sourcing the XSDB tools](#sourcing-the-xsdb-tools) |
| 9 | * [Using devtool boot-jtag script](#using-devtool-boot-jtag-script) | 9 | - [Deploying the images to target](#deploying-the-images-to-target) |
| 10 | * [Manually executing xsdb commands](#manually-executing-xsdb-commands) | 10 | - [Using devtool boot-jtag script](#using-devtool-boot-jtag-script) |
| 11 | * [Loading Bitstream using XSDB](#loading-bitstream-using-xsdb) | 11 | - [Manually executing xsdb commands](#manually-executing-xsdb-commands) |
| 12 | * [Loading U-boot using XSDB](#loading-u-boot-using-xsdb) | 12 | - [Loading Bitstream using XSDB](#loading-bitstream-using-xsdb) |
| 13 | * [Loading Kernel, Device tree, Root Filesystem and U-boot boot script](#loading-kernel-device-tree-root-filesystem-and-u-boot-boot-script) | 13 | - [Loading U-boot using XSDB](#loading-u-boot-using-xsdb) |
| 14 | * [Using XSDB](#using-xsdb) | 14 | - [Loading Kernel, Device tree, Root Filesystem and U-boot boot script](#loading-kernel-device-tree-root-filesystem-and-u-boot-boot-script) |
| 15 | * [Using TFTP](#using-tftp) | 15 | - [Using XSDB](#using-xsdb) |
| 16 | * [Booting Linux](#booting-linux) | 16 | - [Using TFTP](#using-tftp) |
| 17 | - [Booting Linux](#booting-linux) | ||
| 18 | - [Limitation](#limitation) | ||
| 17 | 19 | ||
| 18 | ## Setting Up the Target | 20 | ## Setting Up the Target |
| 19 | 21 | ||
| @@ -195,3 +197,27 @@ xsdb% exit | |||
| 195 | ``` | 197 | ``` |
| 196 | U-Boot> boot | 198 | U-Boot> boot |
| 197 | ``` | 199 | ``` |
| 200 | |||
| 201 | ## Limitation | ||
| 202 | |||
| 203 | 1. Booting core-image-minimal or other image target excluding | ||
| 204 | petalinux-image-minimal you can observe below error message. | ||
| 205 | |||
| 206 | ``` | ||
| 207 | Error: argument "/en*" is wrong: "dev" not a valid ifname | ||
| 208 | Starting syslogd/klogd: done | ||
| 209 | |||
| 210 | Poky (Yocto Project Reference Distro) 5.0.2 kcu105-microblazeel ttyUL0 | ||
| 211 | |||
| 212 | INIT: Id "1" respawning too fast: disabled for 5 minutes | ||
| 213 | |||
| 214 | kcu105-microblazeel login: | ||
| 215 | ``` | ||
| 216 | |||
| 217 | This is due to pni-names distro feature is not enabled by default and eudev uses | ||
| 218 | classic network interface naming scheme. To resolve this issue add pni-names | ||
| 219 | distro feature from <distro>.conf or local.file. | ||
| 220 | |||
| 221 | ``` | ||
| 222 | DISTRO_FEATURES:append:microblaze = " pni-names" | ||
| 223 | ``` \ No newline at end of file | ||
diff --git a/docs/README.booting.zynq.md b/docs/README.booting.zynq.md index 28aad78f..660cc64f 100644 --- a/docs/README.booting.zynq.md +++ b/docs/README.booting.zynq.md | |||
| @@ -3,19 +3,21 @@ | |||
| 3 | Booting OS images on Zynq boards can be done using JTAG, SD, eMMC, QSPI and NAND | 3 | Booting OS images on Zynq boards can be done using JTAG, SD, eMMC, QSPI and NAND |
| 4 | boot modes. | 4 | boot modes. |
| 5 | 5 | ||
| 6 | * [Setting Up the Target](#setting-up-the-target) | 6 | - [Booting OS Images on Zynq target boards](#booting-os-images-on-zynq-target-boards) |
| 7 | * [Booting from JTAG](#booting-from-jtag) | 7 | - [Setting Up the Target](#setting-up-the-target) |
| 8 | * [Sourcing the XSDB tools](#sourcing-the-xsdb-tools) | 8 | - [Booting from JTAG](#booting-from-jtag) |
| 9 | * [Deploying the images to target](#deploying-the-images-to-target) | 9 | - [Sourcing the XSDB tools](#sourcing-the-xsdb-tools) |
| 10 | * [Using devtool boot-jtag script](#using-devtool-boot-jtag-script) | 10 | - [Deploying the images to target](#deploying-the-images-to-target) |
| 11 | * [Manually executing xsdb commands](#manually-executing-xsdb-commands) | 11 | - [Using devtool boot-jtag script](#using-devtool-boot-jtag-script) |
| 12 | * [Loading boot components using XSDB](#loading-boot-components-using-xsdb) | 12 | - [Manually executing xsdb commands](#manually-executing-xsdb-commands) |
| 13 | * [Loading Kernel, Root Filesystem and U-boot boot script](#loading-kernel-root-filesystem-and-u-boot-boot-script) | 13 | - [Loading boot components using XSDB](#loading-boot-components-using-xsdb) |
| 14 | * [Using XSDB](#using-xsdb) | 14 | - [Loading Kernel, Root Filesystem and U-boot boot script](#loading-kernel-root-filesystem-and-u-boot-boot-script) |
| 15 | * [Using TFTP](#using-tftp) | 15 | - [Using XSDB](#using-xsdb) |
| 16 | * [Booting Linux](#booting-linux) | 16 | - [Using TFTP](#using-tftp) |
| 17 | * [Booting from SD](#booting-from-sd) | 17 | - [Booting Linux](#booting-linux) |
| 18 | * [Booting from QSPI](#booting-from-qspi) | 18 | - [Booting from SD](#booting-from-sd) |
| 19 | - [Booting from QSPI](#booting-from-qspi) | ||
| 20 | - [Limitation](#limitation) | ||
| 19 | 21 | ||
| 20 | ## Setting Up the Target | 22 | ## Setting Up the Target |
| 21 | 1. Connect a USB cable between the CP210x USB-to-UART bridge USB Mini-B on | 23 | 1. Connect a USB cable between the CP210x USB-to-UART bridge USB Mini-B on |
| @@ -214,7 +216,7 @@ U-Boot> boot | |||
| 214 | --- | 216 | --- |
| 215 | ## Booting from QSPI | 217 | ## Booting from QSPI |
| 216 | 218 | ||
| 217 | 1. To boot ZC702 board in QSPI boot mode, Power on the ZCU102 board and boot | 219 | 1. To boot ZC702 board in QSPI boot mode, Power on the ZC702 board and boot |
| 218 | using JTAG or SD boot mode, to ensure that U-Boot is running and also have | 220 | using JTAG or SD boot mode, to ensure that U-Boot is running and also have |
| 219 | boot.bin copied to DDR location using XSDB `dow` or `tftpboot` or `fatload` | 221 | boot.bin copied to DDR location using XSDB `dow` or `tftpboot` or `fatload` |
| 220 | command. | 222 | command. |
| @@ -222,3 +224,25 @@ U-Boot> boot | |||
| 222 | 3. After flashing the images, turn off the power switch on the board, and change | 224 | 3. After flashing the images, turn off the power switch on the board, and change |
| 223 | the SW16 boot mode pin settings to QSPI boot mode (1-OFF, 2-ON, 3-OFF, 4-OFF, 5-OFF) | 225 | the SW16 boot mode pin settings to QSPI boot mode (1-OFF, 2-ON, 3-OFF, 4-OFF, 5-OFF) |
| 224 | by setting the SW16. Refer [Setting Up the Target](#setting-up-the-target). | 226 | by setting the SW16. Refer [Setting Up the Target](#setting-up-the-target). |
| 227 | |||
| 228 | ## Limitation | ||
| 229 | |||
| 230 | 1. Booting core-image-minimal or other image target excluding | ||
| 231 | petalinux-image-minimal you can observe below error message. | ||
| 232 | |||
| 233 | ``` | ||
| 234 | Error: argument "/en*" is wrong: "dev" not a valid ifname | ||
| 235 | Starting syslogd/klogd: done | ||
| 236 | |||
| 237 | Poky (Yocto Project Reference Distro) 5.0.2 zc702-zynq7 ttyPS0 | ||
| 238 | |||
| 239 | zc702-zynq7 login: | ||
| 240 | ``` | ||
| 241 | |||
| 242 | This is due to pni-names distro feature is not enabled by default and eudev uses | ||
| 243 | classic network interface naming scheme. To resolve this issue add pni-names | ||
| 244 | distro feature from <distro>.conf or local.file. | ||
| 245 | |||
| 246 | ``` | ||
| 247 | DISTRO_FEATURES:append:zynq = " pni-names" | ||
| 248 | ``` | ||
diff --git a/docs/README.dfx.user.dts.md b/docs/README.dfx.user.dts.md index 9caf866e..09e68be5 100644 --- a/docs/README.dfx.user.dts.md +++ b/docs/README.dfx.user.dts.md | |||
| @@ -283,7 +283,7 @@ SRC_URI = " \ | |||
| 283 | 283 | ||
| 284 | 1. Follow SDT or XSCT Build instructions whichever build method is used but not | 284 | 1. Follow SDT or XSCT Build instructions whichever build method is used but not |
| 285 | both. | 285 | both. |
| 286 | a. [SDT Building Instructions](../meta-xilinx-standalone-experimental/README.md) upto step 4. | 286 | a. [SDT Building Instructions](../meta-xilinx-standalone-sdt/README.md) upto step 4. |
| 287 | b. [XSCT Building Instructions](../README.building.md) | 287 | b. [XSCT Building Instructions](../README.building.md) |
| 288 | upto step 4.b (With SDT overlay). | 288 | upto step 4.b (With SDT overlay). |
| 289 | 2. Create recipes-firmware directory in meta layer and copy the .bit/bin/pdi, | 289 | 2. Create recipes-firmware directory in meta layer and copy the .bit/bin/pdi, |
| @@ -326,7 +326,7 @@ IMAGE_INSTALL:append = " \ | |||
| 326 | ``` | 326 | ``` |
| 327 | 6. Follow SDT or XSCT Build instructions whichever build method is used but not | 327 | 6. Follow SDT or XSCT Build instructions whichever build method is used but not |
| 328 | both. | 328 | both. |
| 329 | a. [SDT Building Instructions](../meta-xilinx-standalone-experimental/README.md ) and continue from step 5. | 329 | a. [SDT Building Instructions](../meta-xilinx-standalone-sdt/README.md ) and continue from step 5. |
| 330 | b. [XSCT Building Instructions](../README.building.md) | 330 | b. [XSCT Building Instructions](../README.building.md) |
| 331 | and continue from step 5. | 331 | and continue from step 5. |
| 332 | 7. Once images are built firmware app files will be installed on target_rootfs. | 332 | 7. Once images are built firmware app files will be installed on target_rootfs. |
diff --git a/docs/README.fw.package.md b/docs/README.fw.package.md index a7e54402..696687d6 100644 --- a/docs/README.fw.package.md +++ b/docs/README.fw.package.md | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | # How to package and depoly firmware elf or bin to linux root filesystem | 1 | # How to package and deploy firmware elf or bin to linux root filesystem |
| 2 | 2 | ||
| 3 | * [Introduction](#introduction) | 3 | * [Introduction](#introduction) |
| 4 | * [How to create and install firmware package recipe](#how-to-create-and-install-firmware-package-recipe) | 4 | * [How to create and install firmware package recipe](#how-to-create-and-install-firmware-package-recipe) |
| @@ -14,16 +14,19 @@ filesystem. | |||
| 14 | 14 | ||
| 15 | ## How to create and install firmware package recipe | 15 | ## How to create and install firmware package recipe |
| 16 | 16 | ||
| 17 | 1. Follow [SDT Building Instructions](../meta-xilinx-standalone-experimental/README.md ) upto step 4. | 17 | 1. Follow [SDT Mulitconfig Building Instructions](../meta-xilinx-standalone-sdt/README.sdt.mc.build.md) |
| 18 | upto step 3. | ||
| 18 | 19 | ||
| 19 | 2. Create recipes-firmware directory in distribution meta layer. | 20 | 2. Create recipes-firmware directory in distribution meta layer. |
| 20 | ``` | 21 | ``` |
| 21 | $ mkdir -p <meta-layer>/recipes-firmware/<firmware-package-name>/ | 22 | $ mkdir -p <meta-layer>/recipes-firmware/<firmware-package-name>/ |
| 22 | ``` | 23 | ``` |
| 24 | |||
| 23 | 3. Now create the recipes firmware package using recipetool. | 25 | 3. Now create the recipes firmware package using recipetool. |
| 24 | ``` | 26 | ``` |
| 25 | $ recipetool create -o <meta-layer>/recipes-firmware/<firmware-package-name>/firmware-package-name.bb | 27 | $ recipetool create -o <meta-layer>/recipes-firmware/<firmware-package-name>/firmware-package-name.bb |
| 26 | ``` | 28 | ``` |
| 29 | |||
| 27 | 4. Modify the recipe and inherit fw-package bbclass as shown below. | 30 | 4. Modify the recipe and inherit fw-package bbclass as shown below. |
| 28 | 31 | ||
| 29 | > **Note:** | 32 | > **Note:** |
| @@ -33,9 +36,9 @@ $ recipetool create -o <meta-layer>/recipes-firmware/<firmware-package-name>/fir | |||
| 33 | > * **FW_NAME:** Variable to define firmware baremetal or freertos application | 36 | > * **FW_NAME:** Variable to define firmware baremetal or freertos application |
| 34 | > recipe name. | 37 | > recipe name. |
| 35 | > * **TARGET_MC:** Variable to define one of the multiconfig target name | 38 | > * **TARGET_MC:** Variable to define one of the multiconfig target name |
| 36 | > (ex: cortexr5-0-zynqmp-baremetal) from the BBMULTICONFIG list | 39 | > (ex: <soc-family>-<board-name>-sdt-<design-name>-cortexr5-0-baremetal) |
| 37 | > generated at [SDT Building Instructions](../meta-xilinx-standalone-experimental/README.md ) | 40 | > from the BBMULTICONFIG list generated at [SDT Mulitconfig Building Instructions](../meta-xilinx-standalone-sdt/README.sdt.mc.build.md) |
| 38 | > step 4. | 41 | > step 2. |
| 39 | 42 | ||
| 40 | ``` | 43 | ``` |
| 41 | SUMMARY = "Recipe to package and deploy baremetal or freertos elf or bin to linux rootfs" | 44 | SUMMARY = "Recipe to package and deploy baremetal or freertos elf or bin to linux rootfs" |
| @@ -45,7 +48,7 @@ inherit fw-package | |||
| 45 | 48 | ||
| 46 | FW_NAME = "hello-world" | 49 | FW_NAME = "hello-world" |
| 47 | 50 | ||
| 48 | TARGET_MC = "cortexr5-0-zynqmp-baremetal" | 51 | TARGET_MC = "<soc-family>-<board-name>-sdt-<design-name>-cortexr5-0-baremetal" |
| 49 | 52 | ||
| 50 | FW_MCDEPENDS := "mc::${TARGET_MC}:${FW_NAME}:do_deploy" | 53 | FW_MCDEPENDS := "mc::${TARGET_MC}:${FW_NAME}:do_deploy" |
| 51 | FW_DEPLOY_DIR := "${TOPDIR}/tmp-${TARGET_MC}/deploy/images/${MACHINE}" | 54 | FW_DEPLOY_DIR := "${TOPDIR}/tmp-${TARGET_MC}/deploy/images/${MACHINE}" |
| @@ -57,5 +60,5 @@ IMAGE_INSTALL:append = " \ | |||
| 57 | firmware-package-name \ | 60 | firmware-package-name \ |
| 58 | " | 61 | " |
| 59 | ``` | 62 | ``` |
| 60 | 6. Follow [SDT Building Instructions](../meta-xilinx-standalone-experimental/README.md ) and continue from | 63 | 6. Follow [SDT Building Instructions](../meta-xilinx-standalone-sdt/README.sdt.bsp.md) and continue from |
| 61 | step 5. | 64 | step 5. |
