summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/README.booting.microblaze.md121
-rw-r--r--docs/README.booting.storage.md22
-rw-r--r--docs/README.booting.versal.md117
-rw-r--r--docs/README.booting.zynq.md124
-rw-r--r--docs/README.booting.zynqmp.md141
-rw-r--r--docs/README.dfx.user.dts.md326
-rw-r--r--docs/README.fpgamanager.custom.md478
-rw-r--r--docs/README.fw.package.md61
8 files changed, 629 insertions, 761 deletions
diff --git a/docs/README.booting.microblaze.md b/docs/README.booting.microblaze.md
index 1ffcc3c8..91c0eda9 100644
--- a/docs/README.booting.microblaze.md
+++ b/docs/README.booting.microblaze.md
@@ -4,11 +4,16 @@ Booting OS images on MicroBlaze target boards can be done using JTAG and QSPI bo
4 4
5* [Setting Up the Target](#setting-up-the-target) 5* [Setting Up the Target](#setting-up-the-target)
6* [Booting from JTAG](#booting-from-jtag) 6* [Booting from JTAG](#booting-from-jtag)
7 * [Loading Bitstream using XSCT](#loading-bitstream-using-xsct) 7 * [Sourcing the XSDB tools](#sourcing-the-xsdb-tools)
8 * [Loading U-boot using XSCT](#loading-u-boot-using-xsct) 8 * [Deploying the images to target](#deploying-the-images-to-target)
9 * [Loading Kernel, Device tree, Root Filesystem and U-boot boot script](#loading-kernel-device-tree-root-filesystem-and-u-boot-boot-script) 9 * [Using devtool boot-jtag script](#using-devtool-boot-jtag-script)
10 * [Using XSCT](#using-xsct) 10 * [Manually executing xsdb commands](#manually-executing-xsdb-commands)
11 * [Using TFTP](#using-tftp) 11 * [Loading Bitstream using XSDB](#loading-bitstream-using-xsdb)
12 * [Loading U-boot using XSDB](#loading-u-boot-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)
14 * [Using XSDB](#using-xsdb)
15 * [Using TFTP](#using-tftp)
16 * [Booting Linux](#booting-linux)
12 17
13## Setting Up the Target 18## Setting Up the Target
14 19
@@ -34,59 +39,79 @@ Booting OS images on MicroBlaze target boards can be done using JTAG and QSPI bo
34 39
35## Booting from JTAG 40## Booting from JTAG
36 41
37This boot flow requires the use of the AMD Xilinx tools, specifically XSCT and 42This boot flow requires the use of the AMD Xilinx tools, specifically XSDB and
38the associated JTAG device drivers. This also requires access to the JTAG interface 43the associated JTAG device drivers. This also requires access to the JTAG interface
39on the board, a number of AMD Xilinx and third-party boards come with on-board JTAG 44on the board, a number of AMD Xilinx and third-party boards come with on-board JTAG
40modules. 45modules.
41 46
421. Source the Vivado or Vitis tools `settings.sh` scripts. 47### Sourcing the XSDB tools
432. Power on the board, Open the XSCT console in the Vitis IDE by clicking the 48
44 XSCT button. Alternatively, you can also open the XSCT console by selecting 49Source the Vivado or Vitis tools `settings.sh` scripts.
45 Xilinx -> XSCT Console. 50
51### Deploying the images to target
52
53Deploying the images can be done in two methods.
54
55#### Using devtool boot-jtag script
56
571. Run devtool command to generate the boot-jtag.tcl script.
58```
59$ devtool boot-jtag --help
60$ devtool boot-jtag --image core-image-minimal --hw_server TCP:<hostname/ip-addr>:3121
61```
622. Script will be generated under ${DEPLOY_DIR_IMAGE}/boot-jtag.tcl
633. Execute this script using xsdb tool as shown below.
64```
65$ xsdb <absolute-path-to-deploy-dir-image>/boot-jtag.tcl
66```
67
68#### Manually executing xsdb commands
69
701. Power on the board, Launch the XSDB shell from command line as shown below.
46``` 71```
47$ xsct 72$ xsdb
48``` 73```
493. In the XSCT console, connect to the target over JTAG using the connect command. 742. In the XSDB console, connect to the target over JTAG using the connect command.
50 Optionally user can use `-url` to specify the local/remote hw_server. The 75 Optionally user can use `-url` to specify the local/remote hw_server. The
51 connect command returns the channel ID of the connection. 76 connect command returns the channel ID of the connection.
52``` 77```
53xsct% connect 78xsdb% connect
54``` 79```
554. The targets command lists the available targets and allows you to select a 803. The targets command lists the available targets and allows you to select a
56 target using its ID. The targets are assigned IDs as they are discovered on 81 target using its ID. The targets are assigned IDs as they are discovered on
57 the JTAG chain, so the IDs can change from session to session. 82 the JTAG chain, so the IDs can change from session to session.
58``` 83```
59xsct% targets 84xsdb% targets
60``` 85```
61 86
62> **Note:** For non-interactive usage such as scripting, you can use the `-filter` 87> **Note:** For non-interactive usage such as scripting, you can use the `-filter`
63 option to select a target instead of selecting the target using its ID. 88 option to select a target instead of selecting the target using its ID.
64 89
65### Loading Bitstream using XSCT 90##### Loading Bitstream using XSDB
66 91
67* Download the bitstream for the target using XSCT with the `fpga` command. Microblaze 92* Download the bitstream for the target using XSDB with the `fpga` command. Microblaze
68bitstream will be located in the `${DEPLOY_DIR_IMAGE}` directory. Optionally user 93bitstream will be located in the `${DEPLOY_DIR_IMAGE}` directory. Optionally user
69can use `fpga -no-revision-check` to skip FPGA silicon revision. 94can use `fpga -no-revision-check` to skip FPGA silicon revision.
70 95
71``` 96```
72xsct% fpga -no-revision-check ${DEPLOY_DIR_IMAGE}/system-${MACHINE}.bit 97xsdb% fpga -no-revision-check ${DEPLOY_DIR_IMAGE}/system-${MACHINE}.bit
73xsct% after 2000 98xsdb% after 2000
74xsct% targets -set -nocase -filter {name =~ "microblaze*#0"} 99xsdb% targets -set -nocase -filter {name =~ "microblaze*#0"}
75xsct% catch {stop} 100xsdb% catch {stop}
76xsct% after 1000 101xsdb% after 1000
77``` 102```
78### Loading U-boot using XSCT 103##### Loading U-boot using XSDB
79 104
801. Download `u-boot.elf` to the target CPU using XSCT. Microblaze u-boot.elf will be 1051. Download `u-boot.elf` to the target CPU using XSDB. Microblaze u-boot.elf will be
81located in the `${DEPLOY_DIR_IMAGE}` directory. Before u-boot.elf is loaded suspend 106located in the `${DEPLOY_DIR_IMAGE}` directory. Before u-boot.elf is loaded suspend
82the execution of active target using `stop` command. 107the execution of active target using `stop` command.
83``` 108```
84xsct% dow ${DEPLOY_DIR_IMAGE}/u-boot.elf 109xsdb% dow ${DEPLOY_DIR_IMAGE}/u-boot.elf
85``` 110```
862. After loading u-boot.elf resume the execution of active target using the `con` 1112. After loading u-boot.elf resume the execution of active target using the `con`
87command in XSCT shell. 112command in XSDB shell.
88``` 113```
89xsct% con 114xsdb% con
90``` 115```
913. In the target Serial Terminal, press any key to stop the U-Boot auto-boot. 1163. In the target Serial Terminal, press any key to stop the U-Boot auto-boot.
92``` 117```
@@ -95,7 +120,7 @@ Hit any key to stop autoboot: 0
95U-Boot> 120U-Boot>
96``` 121```
97 122
98### Loading Kernel, Device tree, Root Filesystem and U-boot boot script 123##### Loading Kernel, Device tree, Root Filesystem and U-boot boot script
99 124
100Load the images into the target DDR/MIG load address i.e., 125Load the images into the target DDR/MIG load address i.e.,
101`DDR base address + <image_offset>`. MicroBlaze U-boot boot script(boot.scr) 126`DDR base address + <image_offset>`. MicroBlaze U-boot boot script(boot.scr)
@@ -121,48 +146,50 @@ this process can take a long time to execute (more than 10 minutes). If your
121system has ethernet it is recommended that you use TFTP to load these images 146system has ethernet it is recommended that you use TFTP to load these images
122using U-Boot. 147using U-Boot.
123 148
124#### Using XSCT 149###### Using XSDB
125 150
1261. Suspend the execution of active target using `stop` command in XSCT. 1511. Suspend the execution of active target using `stop` command in XSDB.
127``` 152```
128xsct% stop 153xsdb% stop
129``` 154```
1302. Using the `dow` command to load the images into the target DDR/MIG 1552. Using the `dow` command to load the images into the target DDR/MIG
131load address. 156load address.
132``` 157```
133xsct% dow -data ${DEPLOY_DIR_IMAGE}/linux.bin.ub 0x80000000 158xsdb% dow -data ${DEPLOY_DIR_IMAGE}/linux.bin.ub 0x80000000
134xsct% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x81e00000 159xsdb% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x81e00000
135xsct% dow -data ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 0x82e00000 160xsdb% dow -data ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 0x82e00000
136xsct% dow -data ${DEPLOY_DIR_IMAGE}/boot.scr 0xff200000 161xsdb% dow -data ${DEPLOY_DIR_IMAGE}/boot.scr 0xff200000
137``` 162```
138 163
139#### Using TFTP 164###### Using TFTP
140 165
1411. Configure the `ipaddr` and `serverip` of the U-Boot environment. 1661. Setup TFTP directory on host machine and copy the images to your TFTP directory
167 so that you can load them from U-Boot.
1682. Configure the `ipaddr` and `serverip` of the U-Boot environment.
142``` 169```
143U-Boot> set serverip <server ip> 170U-Boot> set serverip <server ip>
144U-Boot> set ipaddr <board ip> 171U-Boot> set ipaddr <board ip>
145``` 172```
1462. Load the images to DDR address. Make sure images are copied to tftp directory. 1733. Load the images to DDR address.
147``` 174```
148U-Boot> tftpboot 0x80000000 ${TFTPDIR}/linux.bin.ub 175U-Boot> tftpboot 0x80000000 linux.bin.ub
149U-Boot> tftpboot 0x81e00000 ${TFTPDIR}/system.dtb 176U-Boot> tftpboot 0x81e00000 system.dtb
150U-Boot> tftpboot 0x82e00000 ${TFTPDIR}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 177U-Boot> tftpboot 0x82e00000 core-image-minimal-${MACHINE}.cpio.gz.u-boot
151U-Boot> tftpboot 0xff200000 ${TFTPDIR}/boot.scr 178U-Boot> tftpboot 0xff200000 boot.scr
152``` 179```
153 180
154### Booting Linux 181##### Booting Linux
155 182
156Once the images are loaded continue the execution. 183Once the images are loaded continue the execution.
157 184
1581. After loading images resume the execution of active target using the `con` 1851. After loading images resume the execution of active target using the `con`
159command in XSCT shell, Skip step 1 for if you have used TFTP to load images. 186command in XSDB shell, Skip step 1 for if you have used TFTP to load images.
160``` 187```
161xsct% con 188xsdb% con
162``` 189```
1632. Terminate xsct shell. 1902. Terminate xsdb shell.
164``` 191```
165xsct% exit 192xsdb% exit
166``` 193```
1673. In the target Serial Terminal, from U-Boot prompt run `boot` command. 1943. In the target Serial Terminal, from U-Boot prompt run `boot` command.
168``` 195```
diff --git a/docs/README.booting.storage.md b/docs/README.booting.storage.md
index 4d33600d..2a1f66a7 100644
--- a/docs/README.booting.storage.md
+++ b/docs/README.booting.storage.md
@@ -22,7 +22,7 @@ This section describes how to manually prepare and populate an SD card image.
22There are automation tools in OpenEmbedded that can generate disk images already 22There are automation tools in OpenEmbedded that can generate disk images already
23formatted and prepared such that they can be written directly to a disk. Refer 23formatted and prepared such that they can be written directly to a disk. Refer
24to the Yocto Project Manual for more details: 24to the Yocto Project Manual for more details:
25https://docs.yoctoproject.org/4.1.2/singleindex.html#creating-partitioned-images-using-wic 25https://docs.yoctoproject.org/4.1.4/singleindex.html#creating-partitioned-images-using-wic
26 26
27## Writing image to SD or eMMC device 27## Writing image to SD or eMMC device
28 28
@@ -33,11 +33,17 @@ There are two ways to write the images to SD card or eMMC device.
332. To write image to eMMC device make sure you need to boot Linux from JTAG or 332. To write image to eMMC device make sure you need to boot Linux from JTAG or
34 SD or QSPI first, then copy the wic image to `<target_rootfs>/tmp` directory. 34 SD or QSPI first, then copy the wic image to `<target_rootfs>/tmp` directory.
35 35
36> **Note:** `<target-image>` refers to core-image-minimal or petalinux-image-minimal
37
36### Using Wic file 38### Using Wic file
37 39
38Write wic image file to the SD card or eMMC device. 40Write wic image file to the SD card or eMMC device. Use dd command or balena
41etcher to flash the wic image file to SD card. WIC image will be
42build/tmp/deploy/${MACHINE}/<target-image>-${MACHINE}-${DATETIME}.rootfs.wic, See
43[Flashing Images Using bmaptool](https://docs.yoctoproject.org/singleindex.html#flashing-images-using-bmaptool)
44for fast and easy way to flash the image
39``` 45```
40$ sudo dd if=xilinx-default-sd-${DATETIME}-sda.direct of=/dev/mmcblk<devnum> bs=4M 46$ sudo dd if=<target-image>-${MACHINE}-${DATETIME}.rootfs.wic of=/dev/mmcblk<devnum> bs=4M
41``` 47```
42 48
43### Using Yocto images 49### Using Yocto images
@@ -65,12 +71,12 @@ $ cp ${DEPLOY_DIR_IMAGE}/boot.bin /mnt/boot/boot.bin
65$ cp ${DEPLOY_DIR_IMAGE}/boot.scr /mnt/boot/boot.scr 71$ cp ${DEPLOY_DIR_IMAGE}/boot.scr /mnt/boot/boot.scr
66$ cp ${DEPLOY_DIR_IMAGE}/Image /mnt/boot/Image 72$ cp ${DEPLOY_DIR_IMAGE}/Image /mnt/boot/Image
67$ cp ${DEPLOY_DIR_IMAGE}/system.dtb /mnt/boot/system.dtb 73$ cp ${DEPLOY_DIR_IMAGE}/system.dtb /mnt/boot/system.dtb
68$ cp ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}.cpio.gz.u-boot /mnt/boot/rootfs.cpio.gz.u-boot 74$ cp ${DEPLOY_DIR_IMAGE}/<target-image>-${MACHINE}-${DATETIME}.cpio.gz.u-boot /mnt/boot/rootfs.cpio.gz.u-boot
69``` 75```
704. Extract `core-image-minimal-${MACHINE}-${DATETIME}.rootfs.tar.gz` file content to the SD 764. Extract `<target-image>-${MACHINE}-${DATETIME}.rootfs.tar.gz` file content to the SD
71 card or eMMC device EXT4 partition. 77 card or eMMC device EXT4 partition.
72``` 78```
73$ sudo tar -xf ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}-${DATETIME}.rootfs.tar.gz -C /mnt/rootfs 79$ sudo tar -xf ${DEPLOY_DIR_IMAGE}/<target-image>-${MACHINE}-${DATETIME}.rootfs.tar.gz -C /mnt/rootfs
74$ sync 80$ sync
75``` 81```
765. Unmount the SD Card or eMMC device and boot from SD or eMMC boot modes. 825. Unmount the SD Card or eMMC device and boot from SD or eMMC boot modes.
@@ -97,10 +103,10 @@ $ sudo lsblk /dev/sd<X> -o NAME,FSTYPE,LABEL,PARTLABEL
97``` 103```
98$ sudo mount -L root /mnt/rootfs` 104$ sudo mount -L root /mnt/rootfs`
99``` 105```
1003. Extract `core-image-minimal-${MACHINE}-${DATETIME}.rootfs.tar.gz` file content 1063. Extract `<target-image>-${MACHINE}-${DATETIME}.rootfs.tar.gz` file content
101 to the USB or SATA device EXT4 partition. 107 to the USB or SATA device EXT4 partition.
102``` 108```
103$ sudo tar -xf ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}-${DATETIME}.rootfs.tar.gz -C /mnt/rootfs 109$ sudo tar -xf ${DEPLOY_DIR_IMAGE}/<target-image>-${MACHINE}-${DATETIME}.rootfs.tar.gz -C /mnt/rootfs
104$ sync 110$ sync
105``` 111```
1064. Unmount the USB or SATA device. 1124. Unmount the USB or SATA device.
diff --git a/docs/README.booting.versal.md b/docs/README.booting.versal.md
index afdeba2b..ef817bf3 100644
--- a/docs/README.booting.versal.md
+++ b/docs/README.booting.versal.md
@@ -5,10 +5,15 @@ modes.
5 5
6* [Setting Up the Target](#setting-up-the-target) 6* [Setting Up the Target](#setting-up-the-target)
7* [Booting from JTAG](#booting-from-jtag) 7* [Booting from JTAG](#booting-from-jtag)
8 * [Loading boot.bin using XSCT](#loading-bootbin-using-xsct) 8 * [Sourcing the XSDB tools](#sourcing-the-xsdb-tools)
9 * [Loading Kernel, Root Filesystem and U-boot boot script](#loading-kernel-root-filesystem-and-u-boot-boot-script) 9 * [Deploying the images to target](#deploying-the-images-to-target)
10 * [Using XSCT](#using-xsct) 10 * [Using devtool boot-jtag script](#using-devtool-boot-jtag-script)
11 * [Using TFTP](#using-tftp) 11 * [Manually executing xsdb commands](#manually-executing-xsdb-commands)
12 * [Loading boot.bin using XSDB](#loading-bootbin-using-xsdb)
13 * [Loading Kernel, Root Filesystem and U-boot boot script](#loading-kernel-root-filesystem-and-u-boot-boot-script)
14 * [Using XSDB](#using-xsdb)
15 * [Using TFTP](#using-tftp)
16 * [Booting Linux](#booting-linux)
12* [Booting from SD](#booting-from-sd) 17* [Booting from SD](#booting-from-sd)
13* [Booting from QSPI](#booting-from-qspi) 18* [Booting from QSPI](#booting-from-qspi)
14 19
@@ -37,37 +42,57 @@ modes.
37 42
38## Booting from JTAG 43## Booting from JTAG
39 44
40This boot flow requires the use of the AMD Xilinx tools, specifically XSCT and 45This boot flow requires the use of the AMD Xilinx tools, specifically XSDB and
41the associated JTAG device drivers. This also requires access to the JTAG interface 46the associated JTAG device drivers. This also requires access to the JTAG interface
42on the board, a number of AMD Xilinx and third-party boards come with on-board JTAG 47on the board, a number of AMD Xilinx and third-party boards come with on-board JTAG
43modules. 48modules.
44 49
451. Source the Vivado or Vitis tools `settings.sh` scripts. 50### Sourcing the XSDB tools
462. Power on the board, Open the XSCT console in the Vitis IDE by clicking the 51
47 XSCT button. Alternatively, you can also open the XSCT console by selecting 52Source the Vivado or Vitis tools `settings.sh` scripts.
48 Xilinx -> XSCT Console. 53
54### Deploying the images to target
55
56Deploying the images can be done in two methods.
57
58#### Using devtool boot-jtag script
59
601. Run devtool command to generate the boot-jtag.tcl script.
61```
62$ devtool boot-jtag --help
63$ devtool boot-jtag --image core-image-minimal --hw_server TCP:<hostname/ip-addr>:3121
64```
652. Script will be generated under ${DEPLOY_DIR_IMAGE}/boot-jtag.tcl
663. Execute this script using xsdb tool as shown below.
67```
68$ xsdb <absolute-path-to-deploy-dir-image>/boot-jtag.tcl
69```
70
71#### Manually executing xsdb commands
72
731. Power on the board, Launch the XSDB shell from command line as shown below.
49``` 74```
50$ xsct 75$ xsdb
51``` 76```
523. In the XSCT console, connect to the target over JTAG using the connect command. 772. In the XSDB console, connect to the target over JTAG using the connect command.
53 Optionally user can use `-url` to specify the local/remote hw_server. The 78 Optionally user can use `-url` to specify the local/remote hw_server. The
54 connect command returns the channel ID of the connection. 79 connect command returns the channel ID of the connection.
55``` 80```
56xsct% connect 81xsdb% connect
57``` 82```
584. The targets command lists the available targets and allows you to select a 833. The targets command lists the available targets and allows you to select a
59 target using its ID. The targets are assigned IDs as they are discovered on 84 target using its ID. The targets are assigned IDs as they are discovered on
60 the JTAG chain, so the IDs can change from session to session. 85 the JTAG chain, so the IDs can change from session to session.
61``` 86```
62xsct% targets 87xsdb% targets
63``` 88```
64 89
65> **Note:** For non-interactive usage such as scripting, you can use the `-filter` 90> **Note:** For non-interactive usage such as scripting, you can use the `-filter`
66 option to select a target instead of selecting the target using its ID. 91 option to select a target instead of selecting the target using its ID.
67 92
68### Loading boot.bin using XSCT 93##### Loading boot.bin using XSDB
69 94
701. Download the boot.bin for the target using XSCT with the `device program` command. 951. Download the boot.bin for the target using XSDB with the `device program` command.
71Versal boot.bin will be located in the `${DEPLOY_DIR_IMAGE}` directory. Default 96Versal boot.bin will be located in the `${DEPLOY_DIR_IMAGE}` directory. Default
72boot.bin consists of boot pdi, plm.elf, psm.elf, bl31.elf, u-boot.elf and 97boot.bin consists of boot pdi, plm.elf, psm.elf, bl31.elf, u-boot.elf and
73system.dtb. This boot.bin is generated using bootgen tool by passing a .bif file. 98system.dtb. This boot.bin is generated using bootgen tool by passing a .bif file.
@@ -76,15 +101,15 @@ system.dtb. This boot.bin is generated using bootgen tool by passing a .bif file
76> u-boot and kernel. 101> u-boot and kernel.
77 102
78``` 103```
79xsct% targets -set -nocase -filter {name =~ "*PMC*"} 104xsdb% targets -set -nocase -filter {name =~ "*PMC*"}
80xsct% device program ${DEPLOY_DIR_IMAGE}/boot.bin 105xsdb% device program ${DEPLOY_DIR_IMAGE}/boot.bin
81xsct% targets -set -nocase -filter {name =~ "*A72*#0"} 106xsdb% targets -set -nocase -filter {name =~ "*A72*#0"}
82xsct% stop 107xsdb% stop
83``` 108```
842. After loading boot.bin resume the execution of active target using the `con` 1092. After loading boot.bin resume the execution of active target using the `con`
85command in XSCT shell. 110command in XSDB shell.
86``` 111```
87xsct% con 112xsdb% con
88``` 113```
893. In the target Serial Terminal, press any key to stop the U-Boot auto-boot. 1143. In the target Serial Terminal, press any key to stop the U-Boot auto-boot.
90``` 115```
@@ -93,7 +118,7 @@ Hit any key to stop autoboot: 0
93U-Boot> 118U-Boot>
94``` 119```
95 120
96### Loading Kernel, Root Filesystem and U-boot boot script 121##### Loading Kernel, Root Filesystem and U-boot boot script
97 122
98Load the images into the target DDR/PL DRR load address i.e., 123Load the images into the target DDR/PL DRR load address i.e.,
99`DDR base address + <image_offset>`. 124`DDR base address + <image_offset>`.
@@ -119,49 +144,51 @@ using U-Boot.
119> 4. If common ${DEPLOY_DIR_IMAGE}/system.dtb is used by u-boot and kernel, this 144> 4. If common ${DEPLOY_DIR_IMAGE}/system.dtb is used by u-boot and kernel, this
120> is already part of boot.bin we can skip loading dtb, else load kernel dtb. 145> is already part of boot.bin we can skip loading dtb, else load kernel dtb.
121 146
122#### Using XSCT 147###### Using XSDB
123 148
1241. Suspend the execution of active target using `stop` command in XSCT. 1491. Suspend the execution of active target using `stop` command in XSDB.
125``` 150```
126xsct% stop 151xsdb% stop
127``` 152```
1282. Using the `dow` command to load the images into the target DDR/PL DDR load 1532. Using the `dow` command to load the images into the target DDR/PL DDR load
129 address. 154 address.
130``` 155```
131xsct% dow -data ${DEPLOY_DIR_IMAGE}/Image 0x200000 156xsdb% dow -data ${DEPLOY_DIR_IMAGE}/Image 0x200000
132xsct% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x1000 157xsdb% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x1000
133xsct% dow -data ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 0x4000000 158xsdb% dow -data ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 0x4000000
134xsct% dow -data ${DEPLOY_DIR_IMAGE}/boot.scr 0x20000000 159xsdb% dow -data ${DEPLOY_DIR_IMAGE}/boot.scr 0x20000000
135xsct% targets -set -nocase -filter {name =~ "*A72*#0"} 160xsdb% targets -set -nocase -filter {name =~ "*A72*#0"}
136``` 161```
137 162
138#### Using TFTP 163###### Using TFTP
139 164
1401. Configure the `ipaddr` and `serverip` of the U-Boot environment. 1651. Setup TFTP directory on host machine and copy the images to your TFTP directory
166 so that you can load them from U-Boot.
1672. Configure the `ipaddr` and `serverip` of the U-Boot environment.
141``` 168```
142Versal> set serverip <server ip> 169Versal> set serverip <server ip>
143Versal> set ipaddr <board ip> 170Versal> set ipaddr <board ip>
144``` 171```
1452. Load the images to DDR address. Make sure images are copied to tftp directory. 1723. Load the images to DDR address.
146``` 173```
147U-Boot> tftpboot 0x200000 ${TFTPDIR}/Image 174U-Boot> tftpboot 0x200000 Image
148U-Boot> tftpboot 0x1000 ${TFTPDIR}/system.dtb 175U-Boot> tftpboot 0x1000 system.dtb
149U-Boot> tftpboot 0x4000000 ${TFTPDIR}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 176U-Boot> tftpboot 0x4000000 core-image-minimal-${MACHINE}.cpio.gz.u-boot
150U-Boot> tftpboot 0x20000000 ${TFTPDIR}/boot.scr 177U-Boot> tftpboot 0x20000000 boot.scr
151 178
152``` 179```
153### Booting Linux 180##### Booting Linux
154 181
155Once the images are loaded continue the execution. 182Once the images are loaded continue the execution.
156 183
1571. After loading images resume the execution of active target using the `con` 1841. After loading images resume the execution of active target using the `con`
158command in XSCT shell, Skip step 1 for if you have used TFTP to load images. 185command in XSDB shell, Skip step 1 for if you have used TFTP to load images.
159``` 186```
160xsct% con 187xsdb% con
161``` 188```
1622. Terminate xsct shell. 1892. Terminate xsdb shell.
163``` 190```
164xsct% exit 191xsdb% exit
165``` 192```
1663. In the target Serial Terminal, from U-Boot prompt run `boot` command. 1933. In the target Serial Terminal, from U-Boot prompt run `boot` command.
167``` 194```
@@ -181,9 +208,9 @@ U-Boot> boot
181 card (part number: X_EBM-01, REV_A01). 208 card (part number: X_EBM-01, REV_A01).
1822. With the card powered off, install the QSPI daughter card. 2092. With the card powered off, install the QSPI daughter card.
1833. Power on the VCK190 board and boot using JTAG or SD boot mode, to ensure that 2103. Power on the VCK190 board and boot using JTAG or SD boot mode, to ensure that
184 U-Boot is running and also have boot.bin copied to DDR location using XSCT 211 U-Boot is running and also have boot.bin copied to DDR location using XSDB
185 `dow` or `tftpboot` or `fatload` command. 212 `dow` or `tftpboot` or `fatload` command.
1864. Follow Flash boot instructions [README](README.booting.flash.md) for more details. 2134. Follow Flash boot instructions [README](README.booting.flash.md) for more details.
1875. After flashing the images, turn off the power switch on the board, and change 2145. After flashing the images, turn off the power switch on the board, and change
188 the SW1 boot mode pin settings to QSPI boot mode (1-ON, 2-OFF, 3-ON, 4-ON) by 215 the SW1 boot mode pin settings to QSPI boot mode (1-ON, 2-OFF, 3-ON, 4-ON) by
189 setting the SW1. Refer [Setting Up the Target](#setting-up-the-target). \ No newline at end of file 216 setting the SW1. Refer [Setting Up the Target](#setting-up-the-target).
diff --git a/docs/README.booting.zynq.md b/docs/README.booting.zynq.md
index a9b6e8f3..28aad78f 100644
--- a/docs/README.booting.zynq.md
+++ b/docs/README.booting.zynq.md
@@ -5,10 +5,15 @@ boot modes.
5 5
6* [Setting Up the Target](#setting-up-the-target) 6* [Setting Up the Target](#setting-up-the-target)
7* [Booting from JTAG](#booting-from-jtag) 7* [Booting from JTAG](#booting-from-jtag)
8 * [Loading boot components using XSCT](#loading-boot-components-using-xsct) 8 * [Sourcing the XSDB tools](#sourcing-the-xsdb-tools)
9 * [Loading Kernel, Root Filesystem and U-boot boot script](#loading-kernel-root-filesystem-and-u-boot-boot-script) 9 * [Deploying the images to target](#deploying-the-images-to-target)
10 * [Using XSCT](#using-xsct) 10 * [Using devtool boot-jtag script](#using-devtool-boot-jtag-script)
11 * [Using TFTP](#using-tftp) 11 * [Manually executing xsdb commands](#manually-executing-xsdb-commands)
12 * [Loading boot components using XSDB](#loading-boot-components-using-xsdb)
13 * [Loading Kernel, Root Filesystem and U-boot boot script](#loading-kernel-root-filesystem-and-u-boot-boot-script)
14 * [Using XSDB](#using-xsdb)
15 * [Using TFTP](#using-tftp)
16 * [Booting Linux](#booting-linux)
12* [Booting from SD](#booting-from-sd) 17* [Booting from SD](#booting-from-sd)
13* [Booting from QSPI](#booting-from-qspi) 18* [Booting from QSPI](#booting-from-qspi)
14 19
@@ -35,37 +40,58 @@ boot modes.
35--- 40---
36## Booting from JTAG 41## Booting from JTAG
37 42
38This boot flow requires the use of the AMD Xilinx tools, specifically XSCT and 43This boot flow requires the use of the AMD Xilinx tools, specifically XSDB and
39the associated JTAG device drivers. This also requires access to the JTAG interface 44the associated JTAG device drivers. This also requires access to the JTAG interface
40on the board, a number of AMD Xilinx and third-party boards come with on-board JTAG 45on the board, a number of AMD Xilinx and third-party boards come with on-board JTAG
41modules. 46modules.
42 47
431. Source the Vivado or Vitis tools `settings.sh` scripts. 48### Sourcing the XSDB tools
442. Power on the board, Open the XSCT console in the Vitis IDE by clicking the 49
45 XSCT button. Alternatively, you can also open the XSCT console by selecting 50Source the Vivado or Vitis tools `settings.sh` scripts.
46 Xilinx -> XSCT Console. 51
52### Deploying the images to target
53
54Deploying the images can be done in two methods.
55
56#### Using devtool boot-jtag script
57
581. Run devtool command to generate the boot-jtag.tcl script.
59```
60$ devtool boot-jtag --help
61$ devtool boot-jtag --image core-image-minimal --hw_server TCP:<hostname/ip-addr>:3121
62```
632. Script will be generated under ${DEPLOY_DIR_IMAGE}/boot-jtag.tcl
643. Execute this script using xsdb tool as shown below.
47``` 65```
48$ xsct 66$ xsdb <absolute-path-to-deploy-dir-image>/boot-jtag.tcl
49``` 67```
503. In the XSCT console, connect to the target over JTAG using the connect command. 68
69#### Manually executing xsdb commands
70
711. Power on the board, Launch the XSDB shell from command line as shown below.
72```
73$ xsdb
74```
752. In the XSDB console, connect to the target over JTAG using the connect command.
51 Optionally user can use `-url` to specify the local/remote hw_server. The 76 Optionally user can use `-url` to specify the local/remote hw_server. The
52 connect command returns the channel ID of the connection. 77 connect command returns the channel ID of the connection.
53``` 78```
54xsct% connect 79xsdb% connect
55``` 80```
564. The targets command lists the available targets and allows you to select a 813. The targets command lists the available targets and allows you to select a
57 target using its ID. The targets are assigned IDs as they are discovered on 82 target using its ID. The targets are assigned IDs as they are discovered on
58 the JTAG chain, so the IDs can change from session to session. 83 the JTAG chain, so the IDs can change from session to session.
59``` 84```
60xsct% targets 85xsdb% targets
61``` 86```
62 87
63> **Note:** For non-interactive usage such as scripting, you can use the `-filter` 88> **Note:** For non-interactive usage such as scripting, you can use the `-filter`
64 option to select a target instead of selecting the target using its ID. 89 option to select a target instead of selecting the target using its ID.
90
65--- 91---
66### Loading boot components using XSCT 92##### Loading boot components using XSDB
67 93
681. Download the boot images for the target using XSCT with the `fpga` and `dow` 941. Download the boot images for the target using XSDB with the `fpga` and `dow`
69 command. Zynq boot images will be located in the `${DEPLOY_DIR_IMAGE}` 95 command. Zynq boot images will be located in the `${DEPLOY_DIR_IMAGE}`
70 directory. 96 directory.
71 97
@@ -74,24 +100,24 @@ xsct% targets
74 100
752. Program the bitstream or skip this step if you are loading from u-boot or linux. 1012. Program the bitstream or skip this step if you are loading from u-boot or linux.
76``` 102```
77xsct% fpga -no-revision-check ${DEPLOY_DIR_IMAGE}/download.bit 103xsdb% fpga -no-revision-check ${DEPLOY_DIR_IMAGE}/download.bit
78``` 104```
793. Select APU Cortex-A9 Core 0 to load and execute FSBL. 1053. Select APU Cortex-A9 Core 0 to load and execute FSBL.
80``` 106```
81xsct% targets -set -nocase -filter {name =~ "arm*#0"} 107xsdb% targets -set -nocase -filter {name =~ "arm*#0"}
82xsct% catch {stop} 108xsdb% catch {stop}
83``` 109```
845. Download and run FSBL from APU Cortex-A9 Core 0 1105. Download and run FSBL from APU Cortex-A9 Core 0
85``` 111```
86xsct% dow ${DEPLOY_DIR_IMAGE}/zynq_fsbl.elf 112xsdb% dow ${DEPLOY_DIR_IMAGE}/zynq_fsbl.elf
87xsct% con 113xsdb% con
88``` 114```
897. Now download U-boot.elf and Device tree to APU and execute. 1157. Now download U-boot.elf and Device tree to APU and execute.
90``` 116```
91xsct% stop 117xsdb% stop
92xsct% dow ${DEPLOY_DIR_IMAGE}/u-boot.elf 118xsdb% dow ${DEPLOY_DIR_IMAGE}/u-boot.elf
93xsct% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x100000 119xsdb% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x100000
94xsct% con 120xsdb% con
95``` 121```
96 122
978. In the target Serial Terminal, press any key to stop the U-Boot auto-boot. 1238. In the target Serial Terminal, press any key to stop the U-Boot auto-boot.
@@ -101,7 +127,7 @@ Hit any key to stop autoboot: 0
101U-Boot> 127U-Boot>
102``` 128```
103--- 129---
104### Loading Kernel, Root Filesystem and U-boot boot script 130##### Loading Kernel, Root Filesystem and U-boot boot script
105 131
106Load the images into the target DDR load address i.e., 132Load the images into the target DDR load address i.e.,
107`DDR base address + <image_offset>`. 133`DDR base address + <image_offset>`.
@@ -127,53 +153,56 @@ using U-Boot.
127> 4. If common ${DEPLOY_DIR_IMAGE}/system.dtb is used by u-boot and kernel, this 153> 4. If common ${DEPLOY_DIR_IMAGE}/system.dtb is used by u-boot and kernel, this
128> is already part of boot.bin we can skip loading dtb, else load kernel dtb. 154> is already part of boot.bin we can skip loading dtb, else load kernel dtb.
129--- 155---
130#### Using XSCT 156###### Using XSDB
131 157
1321. Suspend the execution of active target using `stop` command in XSCT. 1581. Suspend the execution of active target using `stop` command in XSDB.
133``` 159```
134xsct% stop 160xsdb% stop
135``` 161```
1362. Using the `dow` command to load the images into the target DDR/PL DDR load 1622. Using the `dow` command to load the images into the target DDR/PL DDR load
137 address. 163 address.
138``` 164```
139xsct% dow -data ${DEPLOY_DIR_IMAGE}/uImage 0x200000 165xsdb% dow -data ${DEPLOY_DIR_IMAGE}/uImage 0x200000
140xsct% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x100000 166xsdb% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x100000
141xsct% dow -data ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 0x4000000 167xsdb% dow -data ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 0x4000000
142xsct% dow -data ${DEPLOY_DIR_IMAGE}/boot.scr 0x3000000 168xsdb% dow -data ${DEPLOY_DIR_IMAGE}/boot.scr 0x3000000
143``` 169```
144--- 170---
145#### Using TFTP 171###### Using TFTP
146 172
1471. Configure the `ipaddr` and `serverip` of the U-Boot environment. 1731. Setup TFTP directory on host machine and copy the images to your TFTP directory
174 so that you can load them from U-Boot.
1752. Configure the `ipaddr` and `serverip` of the U-Boot environment.
148``` 176```
149Versal> set serverip <server ip> 177Versal> set serverip <server ip>
150Versal> set ipaddr <board ip> 178Versal> set ipaddr <board ip>
151``` 179```
1522. Load the images to DDR address. Make sure images are copied to tftp directory. 1803. Load the images to DDR address.
153``` 181```
154U-Boot> tftpboot 0x200000 ${TFTPDIR}/uImage 182U-Boot> tftpboot 0x200000 uImage
155U-Boot> tftpboot 0x100000 ${TFTPDIR}/system.dtb 183U-Boot> tftpboot 0x100000 system.dtb
156U-Boot> tftpboot 0x4000000 ${TFTPDIR}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 184U-Boot> tftpboot 0x4000000 core-image-minimal-${MACHINE}.cpio.gz.u-boot
157U-Boot> tftpboot 0x3000000 ${TFTPDIR}/boot.scr 185U-Boot> tftpboot 0x3000000 boot.scr
158``` 186```
159--- 187---
160### Booting Linux 188##### Booting Linux
161 189
162Once the images are loaded continue the execution. 190Once the images are loaded continue the execution.
163 191
1641. After loading images resume the execution of active target using the `con` 1921. After loading images resume the execution of active target using the `con`
165command in XSCT shell, Skip step 1 for if you have used TFTP to load images. 193command in XSDB shell, Skip step 1 for if you have used TFTP to load images.
166``` 194```
167xsct% con 195xsdb% con
168``` 196```
1692. Terminate xsct shell. 1972. Terminate xsdb shell.
170``` 198```
171xsct% exit 199xsdb% exit
172``` 200```
1733. In the target Serial Terminal, from U-Boot prompt run `boot` command. 2013. In the target Serial Terminal, from U-Boot prompt run `boot` command.
174``` 202```
175U-Boot> boot 203U-Boot> boot
176``` 204```
205
177--- 206---
178## Booting from SD 207## Booting from SD
179 208
@@ -181,14 +210,15 @@ U-Boot> boot
1812. Configure the ZC702 board to boot in SD-Boot mode (1-OFF, 2-OFF, 3-ON, 4-ON, 5-OFF) 2102. Configure the ZC702 board to boot in SD-Boot mode (1-OFF, 2-OFF, 3-ON, 4-ON, 5-OFF)
182 by setting the SW6. Refer [Setting Up the Target](#setting-up-the-target). 211 by setting the SW6. Refer [Setting Up the Target](#setting-up-the-target).
1833. Follow SD boot instructions [README](README.booting.storage.md) for more details. 2123. Follow SD boot instructions [README](README.booting.storage.md) for more details.
213
184--- 214---
185## Booting from QSPI 215## Booting from QSPI
186 216
1871. To boot ZC702 board in QSPI boot mode, Power on the ZCU102 board and boot 2171. To boot ZC702 board in QSPI boot mode, Power on the ZCU102 board and boot
188 using JTAG or SD boot mode, to ensure that U-Boot is running and also have 218 using JTAG or SD boot mode, to ensure that U-Boot is running and also have
189 boot.bin copied to DDR location using XSCT `dow` or `tftpboot` or `fatload` 219 boot.bin copied to DDR location using XSDB `dow` or `tftpboot` or `fatload`
190 command. 220 command.
1912. Follow Flash boot instructions [README](README.booting.flash.md) for more details. 2212. Follow Flash boot instructions [README](README.booting.flash.md) for more details.
1923. After flashing the images, turn off the power switch on the board, and change 2223. After flashing the images, turn off the power switch on the board, and change
193 the SW16 boot mode pin settings to QSPI boot mode (1-OFF, 2-ON, 3-OFF, 4-OFF, 5-OFF) 223 the SW16 boot mode pin settings to QSPI boot mode (1-OFF, 2-ON, 3-OFF, 4-OFF, 5-OFF)
194 by setting the SW16. Refer [Setting Up the Target](#setting-up-the-target). \ No newline at end of file 224 by setting the SW16. Refer [Setting Up the Target](#setting-up-the-target).
diff --git a/docs/README.booting.zynqmp.md b/docs/README.booting.zynqmp.md
index c8f8aa21..80e6d5ae 100644
--- a/docs/README.booting.zynqmp.md
+++ b/docs/README.booting.zynqmp.md
@@ -5,10 +5,15 @@ NAND boot modes.
5 5
6* [Setting Up the Target](#setting-up-the-target) 6* [Setting Up the Target](#setting-up-the-target)
7* [Booting from JTAG](#booting-from-jtag) 7* [Booting from JTAG](#booting-from-jtag)
8 * [Loading boot components using XSCT](#loading-boot-components-using-xsct) 8 * [Sourcing the XSDB tools](#sourcing-the-xsdb-tools)
9 * [Loading Kernel, Root Filesystem and U-boot boot script](#loading-kernel-root-filesystem-and-u-boot-boot-script) 9 * [Deploying the images to target](#deploying-the-images-to-target)
10 * [Using XSCT](#using-xsct) 10 * [Using devtool boot-jtag script](#using-devtool-boot-jtag-script)
11 * [Using TFTP](#using-tftp) 11 * [Manually executing xsdb commands](#manually-executing-xsdb-commands)
12 * [Loading boot components using XSDB](#loading-boot-components-using-xsdb)
13 * [Loading Kernel, Root Filesystem and U-boot boot script](#loading-kernel-root-filesystem-and-u-boot-boot-script)
14 * [Using XSDB](#using-xsdb)
15 * [Using TFTP](#using-tftp)
16 * [Booting Linux](#booting-linux)
12* [Booting from SD](#booting-from-sd) 17* [Booting from SD](#booting-from-sd)
13* [Booting from QSPI](#booting-from-qspi) 18* [Booting from QSPI](#booting-from-qspi)
14 19
@@ -34,37 +39,57 @@ NAND boot modes.
34 39
35## Booting from JTAG 40## Booting from JTAG
36 41
37This boot flow requires the use of the AMD Xilinx tools, specifically XSCT and 42This boot flow requires the use of the AMD Xilinx tools, specifically XSDB and
38the associated JTAG device drivers. This also requires access to the JTAG interface 43the associated JTAG device drivers. This also requires access to the JTAG interface
39on the board, a number of AMD Xilinx and third-party boards come with on-board JTAG 44on the board, a number of AMD Xilinx and third-party boards come with on-board JTAG
40modules. 45modules.
41 46
421. Source the Vivado or Vitis tools `settings.sh` scripts. 47### Sourcing the XSDB tools
432. Power on the board, Open the XSCT console in the Vitis IDE by clicking the 48
44 XSCT button. Alternatively, you can also open the XSCT console by selecting 49Source the Vivado or Vitis tools `settings.sh` scripts.
45 Xilinx -> XSCT Console. 50
51### Deploying the images to target
52
53Deploying the images can be done in two methods.
54
55#### Using devtool boot-jtag script
56
571. Run devtool command to generate the boot-jtag.tcl script.
58```
59$ devtool boot-jtag --help
60$ devtool boot-jtag --image core-image-minimal --hw_server TCP:<hostname/ip-addr>:3121
61```
622. Script will be generated under ${DEPLOY_DIR_IMAGE}/boot-jtag.tcl
633. Execute this script using xsdb tool as shown below.
64```
65$ xsdb <absolute-path-to-deploy-dir-image>/boot-jtag.tcl
66```
67
68#### Manually executing xsdb commands
69
701. Power on the board, Launch the XSDB shell from command line as shown below.
46``` 71```
47$ xsct 72$ xsdb
48``` 73```
493. In the XSCT console, connect to the target over JTAG using the connect command. 742. In the XSDB console, connect to the target over JTAG using the connect command.
50 Optionally user can use `-url` to specify the local/remote hw_server. The 75 Optionally user can use `-url` to specify the local/remote hw_server. The
51 connect command returns the channel ID of the connection. 76 connect command returns the channel ID of the connection.
52``` 77```
53xsct% connect 78xsdb% connect
54``` 79```
554. The targets command lists the available targets and allows you to select a 803. The targets command lists the available targets and allows you to select a
56 target using its ID. The targets are assigned IDs as they are discovered on 81 target using its ID. The targets are assigned IDs as they are discovered on
57 the JTAG chain, so the IDs can change from session to session. 82 the JTAG chain, so the IDs can change from session to session.
58``` 83```
59xsct% targets 84xsdb% targets
60``` 85```
61 86
62> **Note:** For non-interactive usage such as scripting, you can use the `-filter` 87> **Note:** For non-interactive usage such as scripting, you can use the `-filter`
63 option to select a target instead of selecting the target using its ID. 88 option to select a target instead of selecting the target using its ID.
64 89
65### Loading boot components using XSCT 90##### Loading boot components using XSDB
66 91
671. Download the boot images for the target using XSCT with the `fpga` and `dow` 921. Download the boot images for the target using XSDB with the `fpga` and `dow`
68 command. ZyqnMP boot images will be located in the `${DEPLOY_DIR_IMAGE}` 93 command. ZyqnMP boot images will be located in the `${DEPLOY_DIR_IMAGE}`
69 directory. 94 directory.
70 95
@@ -73,43 +98,43 @@ xsct% targets
73 98
742. Program the bitstream or skip this step if you are loading from u-boot or linux. 992. Program the bitstream or skip this step if you are loading from u-boot or linux.
75``` 100```
76xsct% fpga -no-revision-check ${DEPLOY_DIR_IMAGE}/download.bit 101xsdb% fpga -no-revision-check ${DEPLOY_DIR_IMAGE}/download.bit
77``` 102```
783. By default, JTAG security gates are enabled. Disable the security gates for 1033. By default, JTAG security gates are enabled. Disable the security gates for
79 DAP, PL TAP, and PMU (this makes the PMU MB target visible to the debugger). 104 DAP, PL TAP, and PMU (this makes the PMU MB target visible to the debugger).
80``` 105```
81xsct% targets -set -nocase -filter {name =~ "*PSU*"} 106xsdb% targets -set -nocase -filter {name =~ "*PSU*"}
82xsct% mask_write 0xFFCA0038 0x1C0 0x1C0 107xsdb% mask_write 0xFFCA0038 0x1C0 0x1C0
83``` 108```
843. Verify if the PMU MB target is listed under the PMU device. Now, load the PMU 1093. Verify if the PMU MB target is listed under the PMU device. Now, load the PMU
85 firmware. 110 firmware.
86``` 111```
87xsct% targets -set -nocase -filter {name =~ "*MicroBlaze PMU*"} 112xsdb% targets -set -nocase -filter {name =~ "*MicroBlaze PMU*"}
88xsct% catch {stop} 113xsdb% catch {stop}
89xsct% dow ${DEPLOY_DIR_IMAGE}/pmufw.elf 114xsdb% dow ${DEPLOY_DIR_IMAGE}/pmufw.elf
90xsct% con 115xsdb% con
91``` 116```
925. Reset APU Cortex-A53 Core 0 to load and execute FSBL, This step is important, 1175. Reset APU Cortex-A53 Core 0 to load and execute FSBL, This step is important,
93 because when the ZynqMP boots up in JTAG boot mode, all the APU and RPU cores 118 because when the ZynqMP boots up in JTAG boot mode, all the APU and RPU cores
94 are held in reset. You must clear the resets on each core before performing 119 are held in reset. You must clear the resets on each core before performing
95 debugging on these cores. You can use the `rst` command in XSCT to clear the 120 debugging on these cores. You can use the `rst` command in XSDB to clear the
96 resets. 121 resets.
97``` 122```
98xsct% targets -set -nocase -filter {name =~ "*A53*#0"} 123xsdb% targets -set -nocase -filter {name =~ "*A53*#0"}
99xsct% rst -processor -clear-registers 124xsdb% rst -processor -clear-registers
100``` 125```
1016. Download and run FSBL from APU Cortex-A53 Core 0 1266. Download and run FSBL from APU Cortex-A53 Core 0
102``` 127```
103xsct% dow ${DEPLOY_DIR_IMAGE}/zynqmp_fsbl.elf 128xsdb% dow ${DEPLOY_DIR_IMAGE}/zynqmp_fsbl.elf
104xsct% con 129xsdb% con
105``` 130```
1067. Now download TF-A, U-boot.elf and Device tree to APU and execute. 1317. Now download TF-A, U-boot.elf and Device tree to APU and execute.
107``` 132```
108xsct% stop 133xsdb% stop
109xsct% dow ${DEPLOY_DIR_IMAGE}/bl31.elf 134xsdb% dow ${DEPLOY_DIR_IMAGE}/bl31.elf
110xsct% dow ${DEPLOY_DIR_IMAGE}/u-boot.elf 135xsdb% dow ${DEPLOY_DIR_IMAGE}/u-boot.elf
111xsct% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x100000 136xsdb% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x100000
112xsct% con 137xsdb% con
113``` 138```
114 139
1158. In the target Serial Terminal, press any key to stop the U-Boot auto-boot. 1408. In the target Serial Terminal, press any key to stop the U-Boot auto-boot.
@@ -119,7 +144,7 @@ Hit any key to stop autoboot: 0
119U-Boot> 144U-Boot>
120``` 145```
121 146
122### Loading Kernel, Root Filesystem and U-boot boot script 147##### Loading Kernel, Root Filesystem and U-boot boot script
123 148
124Load the images into the target DDR/PL DRR load address i.e., 149Load the images into the target DDR/PL DRR load address i.e.,
125`DDR base address + <image_offset>`. 150`DDR base address + <image_offset>`.
@@ -145,48 +170,50 @@ using U-Boot.
145> 4. If common ${DEPLOY_DIR_IMAGE}/system.dtb is used by u-boot and kernel, this 170> 4. If common ${DEPLOY_DIR_IMAGE}/system.dtb is used by u-boot and kernel, this
146> is already part of boot.bin we can skip loading dtb, else load kernel dtb. 171> is already part of boot.bin we can skip loading dtb, else load kernel dtb.
147 172
148#### Using XSCT 173###### Using XSDB
149 174
1501. Suspend the execution of active target using `stop` command in XSCT. 1751. Suspend the execution of active target using `stop` command in XSDB.
151``` 176```
152xsct% stop 177xsdb% stop
153``` 178```
1542. Using the `dow` command to load the images into the target DDR/PL DDR load 1792. Using the `dow` command to load the images into the target DDR/PL DDR load
155 address. 180 address.
156``` 181```
157xsct% dow -data ${DEPLOY_DIR_IMAGE}/Image 0x200000 182xsdb% dow -data ${DEPLOY_DIR_IMAGE}/Image 0x200000
158xsct% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x100000 183xsdb% dow -data ${DEPLOY_DIR_IMAGE}/system.dtb 0x100000
159xsct% dow -data ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 0x4000000 184xsdb% dow -data ${DEPLOY_DIR_IMAGE}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 0x4000000
160xsct% dow -data ${DEPLOY_DIR_IMAGE}/boot.scr 0x20000000 185xsdb% dow -data ${DEPLOY_DIR_IMAGE}/boot.scr 0x20000000
161``` 186```
162 187
163#### Using TFTP 188###### Using TFTP
164 189
1651. Configure the `ipaddr` and `serverip` of the U-Boot environment. 1901. Setup TFTP directory on host machine and copy the images to your TFTP directory
191 so that you can load them from U-Boot.
1922. Configure the `ipaddr` and `serverip` of the U-Boot environment.
166``` 193```
167Versal> set serverip <server ip> 194ZynqMP> set serverip <host-server-ip-address>
168Versal> set ipaddr <board ip> 195ZynqMP> set ipaddr <board-ip-address>
169``` 196```
1702. Load the images to DDR address. Make sure images are copied to tftp directory. 1973. Load the images to DDR address.
171``` 198```
172U-Boot> tftpboot 0x200000 ${TFTPDIR}/Image 199U-Boot> tftpboot 0x200000 Image
173U-Boot> tftpboot 0x100000 ${TFTPDIR}/system.dtb 200U-Boot> tftpboot 0x100000 system.dtb
174U-Boot> tftpboot 0x4000000 ${TFTPDIR}/core-image-minimal-${MACHINE}.cpio.gz.u-boot 201U-Boot> tftpboot 0x4000000 core-image-minimal-${MACHINE}.cpio.gz.u-boot
175U-Boot> tftpboot 0x20000000 ${TFTPDIR}/boot.scr 202U-Boot> tftpboot 0x20000000 boot.scr
176 203
177``` 204```
178### Booting Linux 205##### Booting Linux
179 206
180Once the images are loaded continue the execution. 207Once the images are loaded continue the execution.
181 208
1821. After loading images resume the execution of active target using the `con` 2091. After loading images resume the execution of active target using the `con`
183command in XSCT shell, Skip step 1 for if you have used TFTP to load images. 210command in XSDB shell, Skip step 1 for if you have used TFTP to load images.
184``` 211```
185xsct% con 212xsdb% con
186``` 213```
1872. Terminate xsct shell. 2142. Terminate xsdb shell.
188``` 215```
189xsct% exit 216xsdb% exit
190``` 217```
1913. In the target Serial Terminal, from U-Boot prompt run `boot` command. 2183. In the target Serial Terminal, from U-Boot prompt run `boot` command.
192``` 219```
@@ -204,9 +231,9 @@ U-Boot> boot
204 231
2051. To boot ZCU012 board in QSPI boot mode, Power on the ZCU102 board and boot 2321. To boot ZCU012 board in QSPI boot mode, Power on the ZCU102 board and boot
206 using JTAG or SD boot mode, to ensure that U-Boot is running and also have 233 using JTAG or SD boot mode, to ensure that U-Boot is running and also have
207 boot.bin copied to DDR location using XSCT `dow` or `tftpboot` or `fatload` 234 boot.bin copied to DDR location using XSDB `dow` or `tftpboot` or `fatload`
208 command. 235 command.
2092. Follow Flash boot instructions [README](README.booting.flash.md) for more details. 2362. Follow Flash boot instructions [README](README.booting.flash.md) for more details.
2103. After flashing the images, turn off the power switch on the board, and change 2373. After flashing the images, turn off the power switch on the board, and change
211 the SW6 boot mode pin settings to QSPI boot mode (1-ON, 2-ON, 3-OFF, 4-ON) by 238 the SW6 boot mode pin settings to QSPI boot mode (1-ON, 2-ON, 3-OFF, 4-ON) by
212 setting the SW6. Refer [Setting Up the Target](#setting-up-the-target). \ No newline at end of file 239 setting the SW6. Refer [Setting Up the Target](#setting-up-the-target).
diff --git a/docs/README.dfx.user.dts.md b/docs/README.dfx.user.dts.md
index 69e1e52b..724c1692 100644
--- a/docs/README.dfx.user.dts.md
+++ b/docs/README.dfx.user.dts.md
@@ -16,11 +16,12 @@ following use cases.
16> **Note:** Refer https://github.com/Xilinx/dfx-mgr/blob/master/README.md for 16> **Note:** Refer https://github.com/Xilinx/dfx-mgr/blob/master/README.md for
17> shell.json and accel.json file content. 17> shell.json and accel.json file content.
18 18
19* **Zynq-7000 and ZynqMP**: 19* **Zynq 7000, ZynqMP and Versal**:
20 * Design: Vivado flat design. 20 * Design: Vivado flat or Segmented Configuration design.
21 * Input files to firmware recipes: .bit, .dtsi or dtbo and shell.json (optional) 21 * Input files to firmware recipes: .bit or .bin or _pld.pdi, .dtsi or dtbo and shell.json (optional)
22 * Usage Examples: 22 * Usage Examples:
23``` 23```
24# Zynq 7000 or ZynqMP flat design
24SRC_URI = " \ 25SRC_URI = " \
25 file://<flat_design_pl>.bit \ 26 file://<flat_design_pl>.bit \
26 file://<flat_design_pl>.dtsi \ 27 file://<flat_design_pl>.dtsi \
@@ -29,6 +30,7 @@ SRC_URI = " \
29``` 30```
30 31
31``` 32```
33# Zynq 7000 or ZynqMP flat design
32SRC_URI = " \ 34SRC_URI = " \
33 file://<flat_design_pl>.bit \ 35 file://<flat_design_pl>.bit \
34 file://<flat_design_pl>.dtbo \ 36 file://<flat_design_pl>.dtbo \
@@ -36,9 +38,69 @@ SRC_URI = " \
36 " 38 "
37``` 39```
38 40
41```
42# Zynq 7000 or ZynqMP flat design
43SRC_URI = " \
44 file://<flat_design_pl>.bin \
45 file://<flat_design_pl>.dtsi \
46 file://shell.json \
47 "
48```
49
50```
51# Zynq 7000 or ZynqMP flat design
52SRC_URI = " \
53 file://<flat_design_pl>.bin \
54 file://<flat_design_pl>.dtbo \
55 file://shell.json \
56 "
57```
58
59```
60# Zynq 7000 or ZynqMP flat design
61SRC_URI = " \
62 file://<flat_design_pl>.bit \
63 file://shell.json \
64 "
65```
66
67```
68# Zynq 7000 or ZynqMP flat design
69SRC_URI = " \
70 file://<flat_design_pl>.bin \
71 file://shell.json \
72 "
73```
74
75```
76# Versal Segmented Configuration design
77SRC_URI = " \
78 file://<flat_design>_pld.pdi \
79 file://<flat_design>_pld.dtsi \
80 file://shell.json \
81 "
82```
83
84```
85# Versal Segmented Configuration design
86SRC_URI = " \
87 file://<flat_design>_pld.pdi \
88 file://<flat_design>_pld.dtbo \
89 file://shell.json \
90 "
91```
92
93```
94# Versal Segmented Configuration design
95SRC_URI = " \
96 file://<flat_design>_pld.pdi \
97 file://shell.json \
98 "
99```
100
39* **ZynqMP and Versal**: 101* **ZynqMP and Versal**:
40 * Design: Vivado DFx design. 102 * Design: Vivado DFx design.
41 * Input files to firmware recipes: .bit(ZynqMP) or .pdi(Versal), .dtsi or dtbo 103 * Input files to firmware recipes: .bit/bin(ZynqMP) or .pdi(Versal), .dtsi or dtbo
42 shell.json or accel.json (optional) and .xclbin (optional). 104 shell.json or accel.json (optional) and .xclbin (optional).
43 * Usage Examples: 105 * Usage Examples:
44 106
@@ -63,6 +125,44 @@ SRC_URI = " \
63``` 125```
64 126
65``` 127```
128# ZynqMP DFx Static
129SRC_URI = " \
130 file://<dfx_design_static_pl>.bin \
131 file://<dfx_design_static_pl>.dtsi \
132 file://shell.json \
133 file://<dfx_design_static_pl>.xclbin \
134 "
135```
136
137```
138# ZynqMP DFx Static
139SRC_URI = " \
140 file://<dfx_design_static_pl>.bin \
141 file://<dfx_design_static_pl>.dtbo \
142 file://shell.json \
143 file://<dfx_design_static_pl>.xclbin \
144 "
145```
146
147```
148# ZynqMP DFx Static
149SRC_URI = " \
150 file://<dfx_design_static_pl>.bit \
151 file://shell.json \
152 file://<dfx_design_static_pl>.xclbin \
153 "
154```
155
156```
157# ZynqMP DFx Static
158SRC_URI = " \
159 file://<dfx_design_static_pl>.bin \
160 file://shell.json \
161 file://<dfx_design_static_pl>.xclbin \
162 "
163```
164
165```
66# ZynqMP DFx RP 166# ZynqMP DFx RP
67SRC_URI = " \ 167SRC_URI = " \
68 file://<dfx_design_rp_rm_pl>.bit \ 168 file://<dfx_design_rp_rm_pl>.bit \
@@ -81,6 +181,45 @@ SRC_URI = " \
81 file://<dfx_design_rp_rm_pl>.xclbin \ 181 file://<dfx_design_rp_rm_pl>.xclbin \
82 " 182 "
83``` 183```
184
185```
186# ZynqMP DFx RP
187SRC_URI = " \
188 file://<dfx_design_rp_rm_pl>.bin \
189 file://<dfx_design_rp_rm_pl>.dtsi \
190 file://accel.json \
191 file://<dfx_design_rp_rm_pl>.xclbin \
192 "
193```
194
195```
196# ZynqMP DFx RP
197SRC_URI = " \
198 file://<dfx_design_rp_rm_pl>.bin \
199 file://<dfx_design_rp_rm_pl>.dtbo \
200 file://accel.json \
201 file://<dfx_design_rp_rm_pl>.xclbin \
202 "
203```
204
205```
206# ZynqMP DFx RP
207SRC_URI = " \
208 file://<dfx_design_rp_rm_pl>.bit \
209 file://accel.json \
210 file://<dfx_design_rp_rm_pl>.xclbin \
211 "
212```
213
214```
215# ZynqMP DFx RP
216SRC_URI = " \
217 file://<dfx_design_rp_rm_pl>.bin \
218 file://accel.json \
219 file://<dfx_design_rp_rm_pl>.xclbin \
220 "
221```
222
84``` 223```
85# Versal DFx Static 224# Versal DFx Static
86SRC_URI = " \ 225SRC_URI = " \
@@ -102,6 +241,15 @@ SRC_URI = " \
102``` 241```
103 242
104``` 243```
244# Versal DFx Static
245SRC_URI = " \
246 file://<dfx_design_static_pl>.pdi \
247 file://shell.json \
248 file://<dfx_design_static_pl>.xclbin \
249 "
250```
251
252```
105# Versal DFx RP 253# Versal DFx RP
106SRC_URI = " \ 254SRC_URI = " \
107 file://<dfx_design_rp_rm_pl>.pdi \ 255 file://<dfx_design_rp_rm_pl>.pdi \
@@ -120,16 +268,29 @@ SRC_URI = " \
120 file://<dfx_design_rp_rm_pl>.xclbin \ 268 file://<dfx_design_rp_rm_pl>.xclbin \
121 " 269 "
122``` 270```
271
272```
273# Versal DFx RP
274SRC_URI = " \
275 file://<dfx_design_rp_rm_pl>.pdi \
276 file://accel.json \
277 file://<dfx_design_rp_rm_pl>.xclbin \
278 "
279```
123--- 280---
124 281
125## How to create a firmware recipe app 282## How to create a firmware recipe app
126 283
1271. Follow [Building Instructions](../README.building.md) upto step 4. 2841. Follow SDT or XSCT Build instructions whichever build method is used but not
1282. Create recipes-firmware directory in meta layer and copy the .bit/pdi, 285 both.
286 a. [SDT Building Instructions](../meta-xilinx-standalone-experimental/README.md) upto step 4.
287 b. [XSCT Building Instructions](../README.building.md)
288 upto step 4.b (With SDT overlay).
2892. Create recipes-firmware directory in meta layer and copy the .bit/bin/pdi,
129 .dtsi/dtbo, .json and .xclbin file to these directories. 290 .dtsi/dtbo, .json and .xclbin file to these directories.
130``` 291```
131$ mkdir -p <meta-layer>/recipes-firmware/<recipes-firmware-app>/files 292$ mkdir -p <meta-layer>/recipes-firmware/<recipes-firmware-app>/files
132$ cp -r <path-to-files>/*.{bit or pdi, dtsi or dtbo, shell.json or accel.json and .xclbin} <meta-layer>/recipes-firmware/<firmware-app-name>/files 293$ cp -r <path-to-files>/*.{bit or bin or pdi, dtsi or dtbo, shell.json or accel.json and .xclbin} <meta-layer>/recipes-firmware/<firmware-app-name>/files
133``` 294```
1343. Now create the recipes for flat or static or partial firmware using recipetool. 2953. Now create the recipes for flat or static or partial firmware using recipetool.
135``` 296```
@@ -144,8 +305,9 @@ LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda
144inherit dfx_user_dts 305inherit dfx_user_dts
145 306
146SRC_URI = "\ 307SRC_URI = "\
147 file://zcu111-pl-demo.bit \ 308 file://shell.json \
148 file://zcu111-pl-demo.dtsi \ 309 file://zcu111-pl-demo-user-dts.bit \
310 file://zcu111-pl-demo-user-dts.dtsi \
149 " 311 "
150 312
151COMPATIBLE_MACHINE ?= "^$" 313COMPATIBLE_MACHINE ?= "^$"
@@ -153,7 +315,7 @@ COMPATIBLE_MACHINE:zynqmp = "zynqmp"
153``` 315```
1545. Add firmware-recipe app to image and enable fpga-overlay machine features to 3165. Add firmware-recipe app to image and enable fpga-overlay machine features to
155 local.conf as shown below. 317 local.conf as shown below.
156> **Note:** fpga-manager-script provides fpgautil tool to load .bit/pdi and dtbo 318> **Note:** fpga-manager-script provides fpgautil tool to load .bin/pdi and dtbo
157> at runtime linux. 319> at runtime linux.
158``` 320```
159MACHINE_FEATURES += "fpga-overlay" 321MACHINE_FEATURES += "fpga-overlay"
@@ -162,7 +324,11 @@ IMAGE_INSTALL:append = " \
162 fpga-manager-script \ 324 fpga-manager-script \
163 " 325 "
164``` 326```
1656. Follow [Building Instructions](../README.building.md) and continue from step 5. 3276. Follow SDT or XSCT Build instructions whichever build method is used but not
328 both.
329 a. [SDT Building Instructions](../meta-xilinx-standalone-experimental/README.md ) and continue from step 5.
330 b. [XSCT Building Instructions](../README.building.md)
331 and continue from step 5.
1667. Once images are built firmware app files will be installed on target_rootfs. 3327. Once images are built firmware app files will be installed on target_rootfs.
167``` 333```
168# <target_rootfs>/lib/firmware/xilinx/firmware-app-name 334# <target_rootfs>/lib/firmware/xilinx/firmware-app-name
@@ -170,7 +336,7 @@ IMAGE_INSTALL:append = " \
170--- 336---
171 337
172## Test Procedure on Target 338## Test Procedure on Target
173* Once Linux boots on target, use fpgautil command to load .bit or .pdi and 339* Once Linux boots on target, use fpgautil command to load .bin or .pdi and
174 corresponding dt overlay as shown below. 340 corresponding dt overlay as shown below.
175> **Note:** firmware can be loaded only with sudo or root permissions. 341> **Note:** firmware can be loaded only with sudo or root permissions.
176--- 342---
@@ -179,11 +345,11 @@ IMAGE_INSTALL:append = " \
179 345
180* ZynqMP 346* ZynqMP
181``` 347```
182yocto-zynqmp-generic-20231:~$ sudo su 348yocto-zynqmp-generic:~$ sudo su
183yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts 349yocto-zynqmp-generic:/home/petalinux# cat /proc/interrupts
184 CPU0 CPU1 CPU2 CPU3 350 CPU0 CPU1 CPU2 CPU3
185 11: 13309 13021 13673 14170 GICv2 30 Level arch_timer 351 11: 5820 5482 14979 6981 GICv2 30 Level arch_timer
186 14: 0 0 0 0 GICv2 67 Level zynqmp_ipi 352 14: 0 0 0 0 GICv2 67 Level zynqmp-ipi
187 15: 0 0 0 0 GICv2 175 Level arm-pmu 353 15: 0 0 0 0 GICv2 175 Level arm-pmu
188 16: 0 0 0 0 GICv2 176 Level arm-pmu 354 16: 0 0 0 0 GICv2 176 Level arm-pmu
189 17: 0 0 0 0 GICv2 177 Level arm-pmu 355 17: 0 0 0 0 GICv2 177 Level arm-pmu
@@ -193,7 +359,7 @@ yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts
193 21: 0 0 0 0 GICv2 42 Level ff960000.memory-controller 359 21: 0 0 0 0 GICv2 42 Level ff960000.memory-controller
194 22: 0 0 0 0 GICv2 88 Level ams-irq 360 22: 0 0 0 0 GICv2 88 Level ams-irq
195 23: 0 0 0 0 GICv2 155 Level axi-pmon, axi-pmon 361 23: 0 0 0 0 GICv2 155 Level axi-pmon, axi-pmon
196 24: 327 0 0 0 GICv2 53 Level xuartps 362 24: 366 0 0 0 GICv2 53 Level xuartps
197 27: 0 0 0 0 GICv2 156 Level zynqmp-dma 363 27: 0 0 0 0 GICv2 156 Level zynqmp-dma
198 28: 0 0 0 0 GICv2 157 Level zynqmp-dma 364 28: 0 0 0 0 GICv2 157 Level zynqmp-dma
199 29: 0 0 0 0 GICv2 158 Level zynqmp-dma 365 29: 0 0 0 0 GICv2 158 Level zynqmp-dma
@@ -212,54 +378,55 @@ yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts
212 42: 0 0 0 0 GICv2 116 Level zynqmp-dma 378 42: 0 0 0 0 GICv2 116 Level zynqmp-dma
213 43: 0 0 0 0 GICv2 154 Level fd4c0000.dma-controller 379 43: 0 0 0 0 GICv2 154 Level fd4c0000.dma-controller
214 44: 5938 0 0 0 GICv2 47 Level ff0f0000.spi 380 44: 5938 0 0 0 GICv2 47 Level ff0f0000.spi
215 45: 76 0 0 0 GICv2 95 Level eth0, eth0 381 45: 325 0 0 0 GICv2 95 Level eth0, eth0
216 46: 0 0 0 0 GICv2 57 Level axi-pmon, axi-pmon 382 46: 0 0 0 0 GICv2 57 Level axi-pmon, axi-pmon
217 47: 4802 0 0 0 GICv2 49 Level cdns-i2c 383 47: 2798 0 0 0 GICv2 49 Level cdns-i2c
218 48: 501 0 0 0 GICv2 50 Level cdns-i2c 384 48: 326 0 0 0 GICv2 50 Level cdns-i2c
219 50: 0 0 0 0 GICv2 84 Edge ff150000.watchdog 385 50: 0 0 0 0 GICv2 84 Edge ff150000.watchdog
220 51: 0 0 0 0 GICv2 151 Level fd4a0000.display 386 51: 0 0 0 0 GICv2 151 Level fd4a0000.display
221 52: 548 0 0 0 GICv2 81 Level mmc0 387 52: 551 0 0 0 GICv2 81 Level mmc0
222 53: 0 0 0 0 GICv2 165 Level ahci-ceva[fd0c0000.ahci] 388 53: 0 0 0 0 GICv2 165 Level ahci-ceva[fd0c0000.ahci]
223 54: 0 0 0 0 GICv2 97 Level xhci-hcd:usb1 389 54: 0 0 0 0 GICv2 97 Level xhci-hcd:usb1
224 55: 0 0 0 0 zynq-gpio 22 Edge sw19 390 55: 0 0 0 0 zynq-gpio 22 Edge sw19
225IPI0: 64 25 87 38 Rescheduling interrupts 391IPI0: 51 94 136 48 Rescheduling interrupts
226IPI1: 1933 6579 1096 5686 Function call interrupts 392IPI1: 2295 6271 2952 873 Function call interrupts
227IPI2: 0 0 0 0 CPU stop interrupts 393IPI2: 0 0 0 0 CPU stop interrupts
228IPI3: 0 0 0 0 CPU stop (for crash dump) interrupts 394IPI3: 0 0 0 0 CPU stop (for crash dump) interrupts
229IPI4: 0 0 0 0 Timer broadcast interrupts 395IPI4: 0 0 0 0 Timer broadcast interrupts
230IPI5: 0 0 0 0 IRQ work interrupts 396IPI5: 0 0 0 0 IRQ work interrupts
231IPI6: 0 0 0 0 CPU wake-up interrupts 397IPI6: 0 0 0 0 CPU wake-up interrupts
232Err: 0 398Err: 0
233yocto-zynqmp-generic-20231:/home/petalinux# tree /lib/firmware/ 399yocto-zynqmp-generic:/home/petalinux# tree /lib/firmware/
234/lib/firmware/ 400/lib/firmware/
235`-- xilinx 401`-- xilinx
236 `-- zcu111-pl-demo 402 `-- zcu111-pl-demo-user-dts
237 |-- zcu111-pl-demo.bit.bin 403 |-- shell.json
238 `-- zcu111-pl-demo.dtbo 404 |-- zcu111-pl-demo-user-dts.bin
239 405 `-- zcu111-pl-demo-user-dts.dtbo
2402 directories, 2 files 406
241yocto-zynqmp-generic-20231:/home/petalinux# fpgautil -b /lib/firmware/xilinx/zcu111-pl-demo/zcu111-pl-demo.bit -o /lib/firmware/xilinx/zcu111-pl-demo/zcu111-pl-demo.dtbo 4072 directories, 3 files
242[ 91.039773] fpga_manager fpga0: writing zcu111-pl-demo.bit to Xilinx ZynqMP FPGA Manager 408yocto-zynqmp-generic:/home/petalinux# fpgautil -b /lib/firmware/xilinx/zcu111-pl-demo-user-dts/zcu111-pl-demo-user-dts.bin -o /lib/firmware/xilinx/zcu111-pl-demo-user-dts/zcu111-pl-demo-user-dts.dtbo
243[ 91.528214] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/firmware-name 409[ 370.737539] fpga_manager fpga0: writing zcu111-pl-demo-user-dts.bin to Xilinx ZynqMP FPGA Manager
244[ 91.538354] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/pid 410[ 370.960368] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/firmware-name
245[ 91.547598] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/resets 411[ 370.970508] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/pid
246[ 91.557087] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/uid 412[ 370.979755] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/resets
247[ 91.566804] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/afi0 413[ 370.989244] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/uid
248[ 91.576312] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/clocking0 414[ 370.998947] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/afi0
249[ 91.586255] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_gpio_0 415[ 371.008449] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/clocking0
250[ 91.596280] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/misc_clk_0 416[ 371.018398] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_gpio_0
251[ 91.606300] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_gpio_1 417[ 371.028420] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/misc_clk_0
252[ 91.616325] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_gpio_2 418[ 371.038442] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_gpio_1
253[ 91.626342] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_uartlite_0 419[ 371.048467] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_gpio_2
254[ 91.636705] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ddr4_0 420[ 371.058487] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_uartlite_0
255[ 91.661849] gpio gpiochip3: (a0000000.gpio): not an immutable chip, please consider fixing it! 421[ 371.068852] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ddr4_0
256[ 91.662020] gpio gpiochip4: (a0010000.gpio): not an immutable chip, please consider fixing it! 422[ 371.096047] gpio gpiochip3: (a0000000.gpio): not an immutable chip, please consider fixing it!
257[ 91.863492] a0030000.serial: ttyUL0 at MMIO 0xa0030000 (irq = 58, base_baud = 0) is a uartlite 423[ 371.096223] gpio gpiochip4: (a0010000.gpio): not an immutable chip, please consider fixing it!
258[ 91.876674] uartlite a0030000.serial: Runtime PM usage count underflow! 424[ 371.115206] a0030000.serial: ttyUL0 at MMIO 0xa0030000 (irq = 58, base_baud = 0) is a uartlite
259[ 91.906539] input: pl-gpio-keys as /devices/platform/pl-gpio-keys/input/input1 425[ 371.124178] uartlite a0030000.serial: Runtime PM usage count underflow!
260Time taken to load BIN is 901.000000 Milli Seconds 426[ 371.133186] input: axi:pl-gpio-keys as /devices/platform/axi/axi:pl-gpio-keys/input/input1
427Time taken to load BIN is 409.000000 Milli Seconds
261BIN FILE loaded through FPGA manager successfully 428BIN FILE loaded through FPGA manager successfully
262yocto-zynqmp-generic-20231:/home/petalinux# 429yocto-zynqmp-generic:/home/petalinux#
263``` 430```
264* Versal (DFx Static) 431* Versal (DFx Static)
265``` 432```
@@ -324,10 +491,10 @@ root@yocto-vck190-dfx-2023:~#
324* Verify PL GPIO DIP switches and Push buttons are registered. 491* Verify PL GPIO DIP switches and Push buttons are registered.
325* Move the DIP Switches ON/OFF and verify the interrupt counts. 492* Move the DIP Switches ON/OFF and verify the interrupt counts.
326``` 493```
327yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts 494yocto-zynqmp-generic:/home/petalinux# cat /proc/interrupts
328 CPU0 CPU1 CPU2 CPU3 495 CPU0 CPU1 CPU2 CPU3
329 11: 23303 22971 24203 24990 GICv2 30 Level arch_timer 496 11: 7674 7136 20210 8226 GICv2 30 Level arch_timer
330 14: 0 0 0 0 GICv2 67 Level zynqmp_ipi 497 14: 0 0 0 0 GICv2 67 Level zynqmp-ipi
331 15: 0 0 0 0 GICv2 175 Level arm-pmu 498 15: 0 0 0 0 GICv2 175 Level arm-pmu
332 16: 0 0 0 0 GICv2 176 Level arm-pmu 499 16: 0 0 0 0 GICv2 176 Level arm-pmu
333 17: 0 0 0 0 GICv2 177 Level arm-pmu 500 17: 0 0 0 0 GICv2 177 Level arm-pmu
@@ -337,7 +504,7 @@ yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts
337 21: 0 0 0 0 GICv2 42 Level ff960000.memory-controller 504 21: 0 0 0 0 GICv2 42 Level ff960000.memory-controller
338 22: 0 0 0 0 GICv2 88 Level ams-irq 505 22: 0 0 0 0 GICv2 88 Level ams-irq
339 23: 0 0 0 0 GICv2 155 Level axi-pmon, axi-pmon 506 23: 0 0 0 0 GICv2 155 Level axi-pmon, axi-pmon
340 24: 515 0 0 0 GICv2 53 Level xuartps 507 24: 1143 0 0 0 GICv2 53 Level xuartps
341 27: 0 0 0 0 GICv2 156 Level zynqmp-dma 508 27: 0 0 0 0 GICv2 156 Level zynqmp-dma
342 28: 0 0 0 0 GICv2 157 Level zynqmp-dma 509 28: 0 0 0 0 GICv2 157 Level zynqmp-dma
343 29: 0 0 0 0 GICv2 158 Level zynqmp-dma 510 29: 0 0 0 0 GICv2 158 Level zynqmp-dma
@@ -356,13 +523,13 @@ yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts
356 42: 0 0 0 0 GICv2 116 Level zynqmp-dma 523 42: 0 0 0 0 GICv2 116 Level zynqmp-dma
357 43: 0 0 0 0 GICv2 154 Level fd4c0000.dma-controller 524 43: 0 0 0 0 GICv2 154 Level fd4c0000.dma-controller
358 44: 5938 0 0 0 GICv2 47 Level ff0f0000.spi 525 44: 5938 0 0 0 GICv2 47 Level ff0f0000.spi
359 45: 110 0 0 0 GICv2 95 Level eth0, eth0 526 45: 485 0 0 0 GICv2 95 Level eth0, eth0
360 46: 0 0 0 0 GICv2 57 Level axi-pmon, axi-pmon 527 46: 0 0 0 0 GICv2 57 Level axi-pmon, axi-pmon
361 47: 4802 0 0 0 GICv2 49 Level cdns-i2c 528 47: 2798 0 0 0 GICv2 49 Level cdns-i2c
362 48: 501 0 0 0 GICv2 50 Level cdns-i2c 529 48: 326 0 0 0 GICv2 50 Level cdns-i2c
363 50: 0 0 0 0 GICv2 84 Edge ff150000.watchdog 530 50: 0 0 0 0 GICv2 84 Edge ff150000.watchdog
364 51: 0 0 0 0 GICv2 151 Level fd4a0000.display 531 51: 0 0 0 0 GICv2 151 Level fd4a0000.display
365 52: 548 0 0 0 GICv2 81 Level mmc0 532 52: 551 0 0 0 GICv2 81 Level mmc0
366 53: 0 0 0 0 GICv2 165 Level ahci-ceva[fd0c0000.ahci] 533 53: 0 0 0 0 GICv2 165 Level ahci-ceva[fd0c0000.ahci]
367 54: 0 0 0 0 GICv2 97 Level xhci-hcd:usb1 534 54: 0 0 0 0 GICv2 97 Level xhci-hcd:usb1
368 55: 0 0 0 0 zynq-gpio 22 Edge sw19 535 55: 0 0 0 0 zynq-gpio 22 Edge sw19
@@ -379,18 +546,19 @@ yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts
379 69: 0 0 0 0 gpio-xilinx 2 Edge PL_GPIO_DIP_SW2 546 69: 0 0 0 0 gpio-xilinx 2 Edge PL_GPIO_DIP_SW2
380 70: 0 0 0 0 gpio-xilinx 1 Edge PL_GPIO_DIP_SW1 547 70: 0 0 0 0 gpio-xilinx 1 Edge PL_GPIO_DIP_SW1
381 71: 0 0 0 0 gpio-xilinx 0 Edge PL_GPIO_DIP_SW0 548 71: 0 0 0 0 gpio-xilinx 0 Edge PL_GPIO_DIP_SW0
382IPI0: 64 25 87 38 Rescheduling interrupts 549IPI0: 64 106 160 56 Rescheduling interrupts
383IPI1: 2066 6747 1212 5791 Function call interrupts 550IPI1: 2712 6721 3259 998 Function call interrupts
384IPI2: 0 0 0 0 CPU stop interrupts 551IPI2: 0 0 0 0 CPU stop interrupts
385IPI3: 0 0 0 0 CPU stop (for crash dump) interrupts 552IPI3: 0 0 0 0 CPU stop (for crash dump) interrupts
386IPI4: 0 0 0 0 Timer broadcast interrupts 553IPI4: 0 0 0 0 Timer broadcast interrupts
387IPI5: 0 0 0 0 IRQ work interrupts 554IPI5: 0 0 0 0 IRQ work interrupts
388IPI6: 0 0 0 0 CPU wake-up interrupts 555IPI6: 0 0 0 0 CPU wake-up interrupts
389Err: 0 556Err: 0
390yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts 557yocto-zcu111-zynqmp:/home/petalinux#
558yocto-zcu111-zynqmp:/home/petalinux# cat /proc/interrupts
391 CPU0 CPU1 CPU2 CPU3 559 CPU0 CPU1 CPU2 CPU3
392 11: 28169 27725 29250 30190 GICv2 30 Level arch_timer 560 11: 8530 7717 22106 8626 GICv2 30 Level arch_timer
393 14: 0 0 0 0 GICv2 67 Level zynqmp_ipi 561 14: 0 0 0 0 GICv2 67 Level zynqmp-ipi
394 15: 0 0 0 0 GICv2 175 Level arm-pmu 562 15: 0 0 0 0 GICv2 175 Level arm-pmu
395 16: 0 0 0 0 GICv2 176 Level arm-pmu 563 16: 0 0 0 0 GICv2 176 Level arm-pmu
396 17: 0 0 0 0 GICv2 177 Level arm-pmu 564 17: 0 0 0 0 GICv2 177 Level arm-pmu
@@ -400,7 +568,7 @@ yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts
400 21: 0 0 0 0 GICv2 42 Level ff960000.memory-controller 568 21: 0 0 0 0 GICv2 42 Level ff960000.memory-controller
401 22: 0 0 0 0 GICv2 88 Level ams-irq 569 22: 0 0 0 0 GICv2 88 Level ams-irq
402 23: 0 0 0 0 GICv2 155 Level axi-pmon, axi-pmon 570 23: 0 0 0 0 GICv2 155 Level axi-pmon, axi-pmon
403 24: 603 0 0 0 GICv2 53 Level xuartps 571 24: 1234 0 0 0 GICv2 53 Level xuartps
404 27: 0 0 0 0 GICv2 156 Level zynqmp-dma 572 27: 0 0 0 0 GICv2 156 Level zynqmp-dma
405 28: 0 0 0 0 GICv2 157 Level zynqmp-dma 573 28: 0 0 0 0 GICv2 157 Level zynqmp-dma
406 29: 0 0 0 0 GICv2 158 Level zynqmp-dma 574 29: 0 0 0 0 GICv2 158 Level zynqmp-dma
@@ -419,45 +587,45 @@ yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts
419 42: 0 0 0 0 GICv2 116 Level zynqmp-dma 587 42: 0 0 0 0 GICv2 116 Level zynqmp-dma
420 43: 0 0 0 0 GICv2 154 Level fd4c0000.dma-controller 588 43: 0 0 0 0 GICv2 154 Level fd4c0000.dma-controller
421 44: 5938 0 0 0 GICv2 47 Level ff0f0000.spi 589 44: 5938 0 0 0 GICv2 47 Level ff0f0000.spi
422 45: 134 0 0 0 GICv2 95 Level eth0, eth0 590 45: 527 0 0 0 GICv2 95 Level eth0, eth0
423 46: 0 0 0 0 GICv2 57 Level axi-pmon, axi-pmon 591 46: 0 0 0 0 GICv2 57 Level axi-pmon, axi-pmon
424 47: 4802 0 0 0 GICv2 49 Level cdns-i2c 592 47: 2798 0 0 0 GICv2 49 Level cdns-i2c
425 48: 501 0 0 0 GICv2 50 Level cdns-i2c 593 48: 326 0 0 0 GICv2 50 Level cdns-i2c
426 50: 0 0 0 0 GICv2 84 Edge ff150000.watchdog 594 50: 0 0 0 0 GICv2 84 Edge ff150000.watchdog
427 51: 0 0 0 0 GICv2 151 Level fd4a0000.display 595 51: 0 0 0 0 GICv2 151 Level fd4a0000.display
428 52: 548 0 0 0 GICv2 81 Level mmc0 596 52: 551 0 0 0 GICv2 81 Level mmc0
429 53: 0 0 0 0 GICv2 165 Level ahci-ceva[fd0c0000.ahci] 597 53: 0 0 0 0 GICv2 165 Level ahci-ceva[fd0c0000.ahci]
430 54: 0 0 0 0 GICv2 97 Level xhci-hcd:usb1 598 54: 0 0 0 0 GICv2 97 Level xhci-hcd:usb1
431 55: 0 0 0 0 zynq-gpio 22 Edge sw19 599 55: 0 0 0 0 zynq-gpio 22 Edge sw19
432 59: 2 0 0 0 gpio-xilinx 4 Edge PL_GPIO_PB_SW9_N 600 59: 2 0 0 0 gpio-xilinx 4 Edge PL_GPIO_PB_SW9_N
433 60: 4 0 0 0 gpio-xilinx 3 Edge PL_GPIO_PB_SW12_E 601 60: 4 0 0 0 gpio-xilinx 3 Edge PL_GPIO_PB_SW12_E
434 61: 2 0 0 0 gpio-xilinx 2 Edge PL_GPIO_PB_SW13_S 602 61: 6 0 0 0 gpio-xilinx 2 Edge PL_GPIO_PB_SW13_S
435 62: 2 0 0 0 gpio-xilinx 1 Edge PL_GPIO_PB_SW10_W 603 62: 4 0 0 0 gpio-xilinx 1 Edge PL_GPIO_PB_SW10_W
436 63: 2 0 0 0 gpio-xilinx 0 Edge PL_GPIO_PB_SW11_C 604 63: 2 0 0 0 gpio-xilinx 0 Edge PL_GPIO_PB_SW11_C
437 64: 2 0 0 0 gpio-xilinx 7 Edge PL_GPIO_DIP_SW7 605 64: 20 0 0 0 gpio-xilinx 7 Edge PL_GPIO_DIP_SW7
438 65: 2 0 0 0 gpio-xilinx 6 Edge PL_GPIO_DIP_SW6 606 65: 20 0 0 0 gpio-xilinx 6 Edge PL_GPIO_DIP_SW6
439 66: 4 0 0 0 gpio-xilinx 5 Edge PL_GPIO_DIP_SW5 607 66: 2 0 0 0 gpio-xilinx 5 Edge PL_GPIO_DIP_SW5
440 67: 2 0 0 0 gpio-xilinx 4 Edge PL_GPIO_DIP_SW4 608 67: 8 0 0 0 gpio-xilinx 4 Edge PL_GPIO_DIP_SW4
441 68: 2 0 0 0 gpio-xilinx 3 Edge PL_GPIO_DIP_SW3 609 68: 4 0 0 0 gpio-xilinx 3 Edge PL_GPIO_DIP_SW3
442 69: 2 0 0 0 gpio-xilinx 2 Edge PL_GPIO_DIP_SW2 610 69: 2 0 0 0 gpio-xilinx 2 Edge PL_GPIO_DIP_SW2
443 70: 2 0 0 0 gpio-xilinx 1 Edge PL_GPIO_DIP_SW1 611 70: 2 0 0 0 gpio-xilinx 1 Edge PL_GPIO_DIP_SW1
444 71: 2 0 0 0 gpio-xilinx 0 Edge PL_GPIO_DIP_SW0 612 71: 2 0 0 0 gpio-xilinx 0 Edge PL_GPIO_DIP_SW0
445IPI0: 64 26 87 38 Rescheduling interrupts 613IPI0: 64 107 160 56 Rescheduling interrupts
446IPI1: 2163 6791 1243 5866 Function call interrupts 614IPI1: 2720 6763 3430 998 Function call interrupts
447IPI2: 0 0 0 0 CPU stop interrupts 615IPI2: 0 0 0 0 CPU stop interrupts
448IPI3: 0 0 0 0 CPU stop (for crash dump) interrupts 616IPI3: 0 0 0 0 CPU stop (for crash dump) interrupts
449IPI4: 0 0 0 0 Timer broadcast interrupts 617IPI4: 0 0 0 0 Timer broadcast interrupts
450IPI5: 0 0 0 0 IRQ work interrupts 618IPI5: 0 0 0 0 IRQ work interrupts
451IPI6: 0 0 0 0 CPU wake-up interrupts 619IPI6: 0 0 0 0 CPU wake-up interrupts
452Err: 0 620Err: 0
453yocto-zynqmp-generic-20231:/home/petalinux# 621yocto-zynqmp-generic:/home/petalinux#
454``` 622```
455--- 623---
456 624
457### Unloading PL bitstream or pdi and dt overlay 625### Unloading PL bitstream or pdi and dt overlay
458* Zynq or ZynqMP 626* Zynq or ZynqMP
459``` 627```
460yocto-zynqmp-generic-20231:/home/petalinux# fpgautil -R 628yocto-zynqmp-generic:/home/petalinux# fpgautil -R
461``` 629```
462* Versal (DFx RP) 630* Versal (DFx RP)
463``` 631```
diff --git a/docs/README.fpgamanager.custom.md b/docs/README.fpgamanager.custom.md
deleted file mode 100644
index dbdf5907..00000000
--- a/docs/README.fpgamanager.custom.md
+++ /dev/null
@@ -1,478 +0,0 @@
1# Build Instructions to create firmware recipes using fpgamanager_custom bbclass
2
3* [Introduction](#introduction)
4* [How to create a firmware recipe app](#how-to-create-a-firmware-recipe-app)
5* [Test Procedure on Target](#test-procedure-on-target)
6 * [Loading PL bitstream or pdi and dt overlay](#loading-pl-bitstream-or-pdi-and-dt-overlay)
7 * [Testing PL functionality](#testing-pl-functionality)
8 * [Unloading PL bitstream or pdi and dt overlay](#unloading-pl-bitstream-or-pdi-and-dt-overlay)
9* [References](#references)
10
11> **Note:** This README will be deprecated in 2024.1 release. User sthould start
12> using [DFx User DTS README](README.dfx.user.dts.md)
13
14## Introduction
15This readme describes the build instructions to create firmware recipes using
16fpgamanager_custom.bbclass for dynamic configuration. This bitbake class supports
17following use cases.
18
19> **Note:** Refer https://github.com/Xilinx/dfx-mgr/blob/master/README.md for
20> shell.json and accel.json file content.
21
22* **Zynq-7000 and ZynqMP**:
23 * Design: Vivado flat design.
24 * Input files to firmware recipes: .bit, .dtsi or dtbo and shell.json (optional)
25 * Usage Examples:
26```
27SRC_URI = " \
28 file://<flat_design_pl>.bit \
29 file://<flat_design_pl>.dtsi \
30 file://shell.json \
31 "
32```
33
34```
35SRC_URI = " \
36 file://<flat_design_pl>.bit \
37 file://<flat_design_pl>.dtbo \
38 file://shell.json \
39 "
40```
41
42* **ZynqMP and Versal**:
43 * Design: Vivado DFx design.
44 * Input files to firmware recipes: .bit(ZynqMP) or .pdi(Versal), .dtsi or dtbo
45 shell.json or accel.json (optional) and .xclbin (optional).
46 * Usage Examples:
47
48```
49# ZynqMP DFx Static
50SRC_URI = " \
51 file://<dfx_design_static_pl>.bit \
52 file://<dfx_design_static_pl>.dtsi \
53 file://shell.json \
54 file://<dfx_design_static_pl>.xclbin \
55 "
56```
57
58```
59# ZynqMP DFx Static
60SRC_URI = " \
61 file://<dfx_design_static_pl>.bit \
62 file://<dfx_design_static_pl>.dtbo \
63 file://shell.json \
64 file://<dfx_design_static_pl>.xclbin \
65 "
66```
67
68```
69# ZynqMP DFx RP
70SRC_URI = " \
71 file://<dfx_design_rp_rm_pl>.bit \
72 file://<dfx_design_rp_rm_pl>.dtsi \
73 file://accel.json \
74 file://<dfx_design_rp_rm_pl>.xclbin \
75 "
76```
77
78```
79# ZynqMP DFx RP
80SRC_URI = " \
81 file://<dfx_design_rp_rm_pl>.bit \
82 file://<dfx_design_rp_rm_pl>.dtbo \
83 file://accel.json \
84 file://<dfx_design_rp_rm_pl>.xclbin \
85 "
86```
87```
88# Versal DFx Static
89SRC_URI = " \
90 file://<dfx_design_static_pl>.pdi \
91 file://<dfx_design_static_pl>.dtsi \
92 file://shell.json \
93 file://<dfx_design_static_pl>.xclbin \
94 "
95```
96
97```
98# Versal DFx Static
99SRC_URI = " \
100 file://<dfx_design_static_pl>.pdi \
101 file://<dfx_design_static_pl>.dtbo \
102 file://shell.json \
103 file://<dfx_design_static_pl>.xclbin \
104 "
105```
106
107```
108# Versal DFx RP
109SRC_URI = " \
110 file://<dfx_design_rp_rm_pl>.pdi \
111 file://<dfx_design_rp_rm_pl>.dtsi \
112 file://accel.json \
113 file://<dfx_design_rp_rm_pl>.xclbin \
114 "
115```
116
117```
118# Versal DFx RP
119SRC_URI = " \
120 file://<dfx_design_rp_rm_pl>.pdi \
121 file://<dfx_design_rp_rm_pl>.dtbo \
122 file://accel.json \
123 file://<dfx_design_rp_rm_pl>.xclbin \
124 "
125```
126---
127
128## How to create a firmware recipe app
129
1301. Follow [Building Instructions](../README.building.md) upto step 4.
1312. Create recipes-firmware directory in meta layer and copy the .bit/pdi,
132 .dtsi/dtbo, .json and .xclbin file to these directories.
133```
134$ mkdir -p <meta-layer>/recipes-firmware/<recipes-firmware-app>/files
135$ cp -r <path-to-files>/*.{bit or pdi, dtsi or dtbo, shell.json or accel.json and .xclbin} <meta-layer>/recipes-firmware/<firmware-app-name>/files
136```
1373. Now create the recipes for flat or static or partial firmware using recipetool.
138```
139$ recipetool create -o <meta-layer>/recipes-firmware/<firmware-app-name>/firmware-app-name.bb file:///<meta-layer>/recipes-firmware/<firmware-app-name>/files
140```
1414. Modify the recipe and inherit fpgamanager_custom bbclass as shown below.
142```
143SUMMARY = "Full Bitstream loading zcu111-pl-demo firmware using fpgamanager_custom bbclass"
144LICENSE = "MIT"
145LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
146
147inherit fpgamanager_custom
148
149SRC_URI = "\
150 file://zcu111-pl-demo.bit \
151 file://zcu111-pl-demo.dtsi \
152 "
153
154COMPATIBLE_MACHINE ?= "^$"
155COMPATIBLE_MACHINE:zynqmp = "zynqmp"
156```
1575. Add firmware-recipe app to image and enable fpga-overlay machine features to
158 local.conf as shown below.
159> **Note:** fpga-manager-script provides fpgautil tool to load .bit/pdi and dtbo
160> at runtime linux.
161```
162MACHINE_FEATURES += "fpga-overlay"
163IMAGE_INSTALL:append = " \
164 firmware-app-name \
165 fpga-manager-script \
166 "
167```
1686. Follow [Building Instructions](../README.building.md) and continue from step 5.
1697. Once images are built firmware app files will be installed on target_rootfs.
170```
171# <target_rootfs>/lib/firmware/xilinx/firmware-app-name
172```
173---
174
175## Test Procedure on Target
176* Once Linux boots on target, use fpgautil command to load .bit or .pdi and
177 corresponding dt overlay as shown below.
178> **Note:** firmware can be loaded only with sudo or root permissions.
179---
180
181### Loading PL bitstream or pdi and dt overlay
182
183* ZynqMP
184```
185yocto-zynqmp-generic-20231:~$ sudo su
186yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts
187 CPU0 CPU1 CPU2 CPU3
188 11: 13309 13021 13673 14170 GICv2 30 Level arch_timer
189 14: 0 0 0 0 GICv2 67 Level zynqmp_ipi
190 15: 0 0 0 0 GICv2 175 Level arm-pmu
191 16: 0 0 0 0 GICv2 176 Level arm-pmu
192 17: 0 0 0 0 GICv2 177 Level arm-pmu
193 18: 0 0 0 0 GICv2 178 Level arm-pmu
194 19: 0 0 0 0 GICv2 58 Level ffa60000.rtc
195 20: 0 0 0 0 GICv2 59 Level ffa60000.rtc
196 21: 0 0 0 0 GICv2 42 Level ff960000.memory-controller
197 22: 0 0 0 0 GICv2 88 Level ams-irq
198 23: 0 0 0 0 GICv2 155 Level axi-pmon, axi-pmon
199 24: 327 0 0 0 GICv2 53 Level xuartps
200 27: 0 0 0 0 GICv2 156 Level zynqmp-dma
201 28: 0 0 0 0 GICv2 157 Level zynqmp-dma
202 29: 0 0 0 0 GICv2 158 Level zynqmp-dma
203 30: 0 0 0 0 GICv2 159 Level zynqmp-dma
204 31: 0 0 0 0 GICv2 160 Level zynqmp-dma
205 32: 0 0 0 0 GICv2 161 Level zynqmp-dma
206 33: 0 0 0 0 GICv2 162 Level zynqmp-dma
207 34: 0 0 0 0 GICv2 163 Level zynqmp-dma
208 35: 0 0 0 0 GICv2 109 Level zynqmp-dma
209 36: 0 0 0 0 GICv2 110 Level zynqmp-dma
210 37: 0 0 0 0 GICv2 111 Level zynqmp-dma
211 38: 0 0 0 0 GICv2 112 Level zynqmp-dma
212 39: 0 0 0 0 GICv2 113 Level zynqmp-dma
213 40: 0 0 0 0 GICv2 114 Level zynqmp-dma
214 41: 0 0 0 0 GICv2 115 Level zynqmp-dma
215 42: 0 0 0 0 GICv2 116 Level zynqmp-dma
216 43: 0 0 0 0 GICv2 154 Level fd4c0000.dma-controller
217 44: 5938 0 0 0 GICv2 47 Level ff0f0000.spi
218 45: 76 0 0 0 GICv2 95 Level eth0, eth0
219 46: 0 0 0 0 GICv2 57 Level axi-pmon, axi-pmon
220 47: 4802 0 0 0 GICv2 49 Level cdns-i2c
221 48: 501 0 0 0 GICv2 50 Level cdns-i2c
222 50: 0 0 0 0 GICv2 84 Edge ff150000.watchdog
223 51: 0 0 0 0 GICv2 151 Level fd4a0000.display
224 52: 548 0 0 0 GICv2 81 Level mmc0
225 53: 0 0 0 0 GICv2 165 Level ahci-ceva[fd0c0000.ahci]
226 54: 0 0 0 0 GICv2 97 Level xhci-hcd:usb1
227 55: 0 0 0 0 zynq-gpio 22 Edge sw19
228IPI0: 64 25 87 38 Rescheduling interrupts
229IPI1: 1933 6579 1096 5686 Function call interrupts
230IPI2: 0 0 0 0 CPU stop interrupts
231IPI3: 0 0 0 0 CPU stop (for crash dump) interrupts
232IPI4: 0 0 0 0 Timer broadcast interrupts
233IPI5: 0 0 0 0 IRQ work interrupts
234IPI6: 0 0 0 0 CPU wake-up interrupts
235Err: 0
236yocto-zynqmp-generic-20231:/home/petalinux# tree /lib/firmware/
237/lib/firmware/
238`-- xilinx
239 `-- zcu111-pl-demo
240 |-- zcu111-pl-demo.bit.bin
241 `-- zcu111-pl-demo.dtbo
242
2432 directories, 2 files
244yocto-zynqmp-generic-20231:/home/petalinux# fpgautil -b /lib/firmware/xilinx/zcu111-pl-demo/zcu111-pl-demo.bit -o /lib/firmware/xilinx/zcu111-pl-demo/zcu111-pl-demo.dtbo
245[ 91.039773] fpga_manager fpga0: writing zcu111-pl-demo.bit to Xilinx ZynqMP FPGA Manager
246[ 91.528214] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/firmware-name
247[ 91.538354] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/pid
248[ 91.547598] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/resets
249[ 91.557087] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga-full/uid
250[ 91.566804] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/afi0
251[ 91.576312] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/clocking0
252[ 91.586255] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_gpio_0
253[ 91.596280] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/misc_clk_0
254[ 91.606300] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_gpio_1
255[ 91.616325] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_gpio_2
256[ 91.626342] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/axi_uartlite_0
257[ 91.636705] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ddr4_0
258[ 91.661849] gpio gpiochip3: (a0000000.gpio): not an immutable chip, please consider fixing it!
259[ 91.662020] gpio gpiochip4: (a0010000.gpio): not an immutable chip, please consider fixing it!
260[ 91.863492] a0030000.serial: ttyUL0 at MMIO 0xa0030000 (irq = 58, base_baud = 0) is a uartlite
261[ 91.876674] uartlite a0030000.serial: Runtime PM usage count underflow!
262[ 91.906539] input: pl-gpio-keys as /devices/platform/pl-gpio-keys/input/input1
263Time taken to load BIN is 901.000000 Milli Seconds
264BIN FILE loaded through FPGA manager successfully
265yocto-zynqmp-generic-20231:/home/petalinux#
266```
267* Versal (DFx Static)
268```
269yocto-vck190-dfx-2023:~$ sudo su
270root@yocto-vck190-dfx-2023:~#
271root@yocto-vck190-dfx-2023:~# fpgautil -o /lib/firmware/xilinx/vck190-dfx-static/vck190-dfx-static.dtbo
272[ 257.555571] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga/external-fpga-config
273[ 257.565879] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga/pid
274[ 257.574670] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga/uid
275[ 257.583599] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/fpga_PR0
276[ 257.593434] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/fpga_PR1
277[ 257.603268] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/fpga_PR2
278[ 257.613100] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/static_region_axi_bram_ctrl_0
279[ 257.624762] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/static_region_dfx_decoupler_rp1
280[ 257.636589] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/static_region_dfx_decoupler_rp2
281[ 257.648415] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/static_region_dfx_decoupler_rp3
282[ 257.663234] of-fpga-region fpga:fpga-PR0: FPGA Region probed
283[ 257.669135] of-fpga-region fpga:fpga-PR1: FPGA Region probed
284[ 257.675022] of-fpga-region fpga:fpga-PR2: FPGA Region probed
285root@yocto-vck190-dfx-2023:~#
286```
287* Versal (DFx RP)
288```
289root@yocto-vck190-dfx-2023:~# fpgautil -b /lib/firmware/xilinx/vck190-dfx-static/rp1/vck190-dfx-rp1rm1-dipsw/vck190-dfx-rp1rm1-dipsw.pdi -o /lib/firmware/xilinx/vck190-dfx-static/rp1/vck190-dfx-rp1rm1-dipsw/vck190-dfx-rp1rm1-dipsw.dtbo -f Partial -n PR0
290[ 273.511455] fpga_manager fpga0: writing vck190-dfx-rp1rm1-dipsw.pdi to Xilinx Versal FPGA Manager
291[284052.461]Loading PDI from DDR
292[284052.566]Monolithic/Master Device
293[284055.847]3.365 ms: PDI initialization time
294[284059.809]+++Loading Image#: 0x0, Name: pl_cfi, Id: 0x18700002
295[284065.432]---Loading Partition#: 0x0, Id: 0x103
296[284069.829] 0.033 ms for Partition#: 0x0, Size: 1312 Bytes
297[284074.973]---Loading Partition#: 0x1, Id: 0x105
298[284079.344] 0.007 ms for Partition#: 0x1, Size: 160 Bytes
299[284084.430]---Loading Partition#: 0x2, Id: 0x205
300[284088.844] 0.049 ms for Partition#: 0x2, Size: 960 Bytes
301[284093.887]---Loading Partition#: 0x3, Id: 0x203
302[284098.280] 0.030 ms for Partition#: 0x3, Size: 688 Bytes
303[284103.342]---Loading Partition#: 0x4, Id: 0x303
304[284108.863] 1.156 ms for Partition#: 0x4, Size: 209440 Bytes
305[284113.052]---Loading Partition#: 0x5, Id: 0x305
306[284117.712] 0.296 ms for Partition#: 0x5, Size: 3536 Bytes
307[284122.594]---Loading Partition#: 0x6, Id: 0x403
308[284126.991] 0.034 ms for Partition#: 0x6, Size: 8096 Bytes
309[284132.136]---Loading Partition#: 0x7, Id: 0x405
310[284136.507] 0.007 ms for Partition#: 0x7, Size: 160 Bytes
311[284141.636]Subsystem PDI Load: Done
312[ 273.615503] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga/firmware-name
313[ 273.627382] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga/fpga-bridges
314[ 273.636953] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /fpga/partial-fpga-config
315[ 273.647241] OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/rp1_axi_gpio_0
316[ 273.660826] gpio gpiochip1: (a4010000.gpio): not an immutable chip, please consider fixing it!
317[ 273.670490] input: pl-gpio-keys as /devices/platform/pl-gpio-keys/input/input0
318Time taken to load BIN is 171.000000 Milli Seconds
319BIN FILE loaded through FPGA manager successfully
320root@yocto-vck190-dfx-2023:~#
321```
322---
323
324### Testing PL functionality
325
326* This examples uses PL GPIO DIP switches and Push buttons to capture interrupts.
327* Verify PL GPIO DIP switches and Push buttons are registered.
328* Move the DIP Switches ON/OFF and verify the interrupt counts.
329```
330yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts
331 CPU0 CPU1 CPU2 CPU3
332 11: 23303 22971 24203 24990 GICv2 30 Level arch_timer
333 14: 0 0 0 0 GICv2 67 Level zynqmp_ipi
334 15: 0 0 0 0 GICv2 175 Level arm-pmu
335 16: 0 0 0 0 GICv2 176 Level arm-pmu
336 17: 0 0 0 0 GICv2 177 Level arm-pmu
337 18: 0 0 0 0 GICv2 178 Level arm-pmu
338 19: 0 0 0 0 GICv2 58 Level ffa60000.rtc
339 20: 0 0 0 0 GICv2 59 Level ffa60000.rtc
340 21: 0 0 0 0 GICv2 42 Level ff960000.memory-controller
341 22: 0 0 0 0 GICv2 88 Level ams-irq
342 23: 0 0 0 0 GICv2 155 Level axi-pmon, axi-pmon
343 24: 515 0 0 0 GICv2 53 Level xuartps
344 27: 0 0 0 0 GICv2 156 Level zynqmp-dma
345 28: 0 0 0 0 GICv2 157 Level zynqmp-dma
346 29: 0 0 0 0 GICv2 158 Level zynqmp-dma
347 30: 0 0 0 0 GICv2 159 Level zynqmp-dma
348 31: 0 0 0 0 GICv2 160 Level zynqmp-dma
349 32: 0 0 0 0 GICv2 161 Level zynqmp-dma
350 33: 0 0 0 0 GICv2 162 Level zynqmp-dma
351 34: 0 0 0 0 GICv2 163 Level zynqmp-dma
352 35: 0 0 0 0 GICv2 109 Level zynqmp-dma
353 36: 0 0 0 0 GICv2 110 Level zynqmp-dma
354 37: 0 0 0 0 GICv2 111 Level zynqmp-dma
355 38: 0 0 0 0 GICv2 112 Level zynqmp-dma
356 39: 0 0 0 0 GICv2 113 Level zynqmp-dma
357 40: 0 0 0 0 GICv2 114 Level zynqmp-dma
358 41: 0 0 0 0 GICv2 115 Level zynqmp-dma
359 42: 0 0 0 0 GICv2 116 Level zynqmp-dma
360 43: 0 0 0 0 GICv2 154 Level fd4c0000.dma-controller
361 44: 5938 0 0 0 GICv2 47 Level ff0f0000.spi
362 45: 110 0 0 0 GICv2 95 Level eth0, eth0
363 46: 0 0 0 0 GICv2 57 Level axi-pmon, axi-pmon
364 47: 4802 0 0 0 GICv2 49 Level cdns-i2c
365 48: 501 0 0 0 GICv2 50 Level cdns-i2c
366 50: 0 0 0 0 GICv2 84 Edge ff150000.watchdog
367 51: 0 0 0 0 GICv2 151 Level fd4a0000.display
368 52: 548 0 0 0 GICv2 81 Level mmc0
369 53: 0 0 0 0 GICv2 165 Level ahci-ceva[fd0c0000.ahci]
370 54: 0 0 0 0 GICv2 97 Level xhci-hcd:usb1
371 55: 0 0 0 0 zynq-gpio 22 Edge sw19
372 59: 0 0 0 0 gpio-xilinx 4 Edge PL_GPIO_PB_SW9_N
373 60: 0 0 0 0 gpio-xilinx 3 Edge PL_GPIO_PB_SW12_E
374 61: 0 0 0 0 gpio-xilinx 2 Edge PL_GPIO_PB_SW13_S
375 62: 0 0 0 0 gpio-xilinx 1 Edge PL_GPIO_PB_SW10_W
376 63: 0 0 0 0 gpio-xilinx 0 Edge PL_GPIO_PB_SW11_C
377 64: 0 0 0 0 gpio-xilinx 7 Edge PL_GPIO_DIP_SW7
378 65: 0 0 0 0 gpio-xilinx 6 Edge PL_GPIO_DIP_SW6
379 66: 0 0 0 0 gpio-xilinx 5 Edge PL_GPIO_DIP_SW5
380 67: 0 0 0 0 gpio-xilinx 4 Edge PL_GPIO_DIP_SW4
381 68: 0 0 0 0 gpio-xilinx 3 Edge PL_GPIO_DIP_SW3
382 69: 0 0 0 0 gpio-xilinx 2 Edge PL_GPIO_DIP_SW2
383 70: 0 0 0 0 gpio-xilinx 1 Edge PL_GPIO_DIP_SW1
384 71: 0 0 0 0 gpio-xilinx 0 Edge PL_GPIO_DIP_SW0
385IPI0: 64 25 87 38 Rescheduling interrupts
386IPI1: 2066 6747 1212 5791 Function call interrupts
387IPI2: 0 0 0 0 CPU stop interrupts
388IPI3: 0 0 0 0 CPU stop (for crash dump) interrupts
389IPI4: 0 0 0 0 Timer broadcast interrupts
390IPI5: 0 0 0 0 IRQ work interrupts
391IPI6: 0 0 0 0 CPU wake-up interrupts
392Err: 0
393yocto-zynqmp-generic-20231:/home/petalinux# cat /proc/interrupts
394 CPU0 CPU1 CPU2 CPU3
395 11: 28169 27725 29250 30190 GICv2 30 Level arch_timer
396 14: 0 0 0 0 GICv2 67 Level zynqmp_ipi
397 15: 0 0 0 0 GICv2 175 Level arm-pmu
398 16: 0 0 0 0 GICv2 176 Level arm-pmu
399 17: 0 0 0 0 GICv2 177 Level arm-pmu
400 18: 0 0 0 0 GICv2 178 Level arm-pmu
401 19: 0 0 0 0 GICv2 58 Level ffa60000.rtc
402 20: 0 0 0 0 GICv2 59 Level ffa60000.rtc
403 21: 0 0 0 0 GICv2 42 Level ff960000.memory-controller
404 22: 0 0 0 0 GICv2 88 Level ams-irq
405 23: 0 0 0 0 GICv2 155 Level axi-pmon, axi-pmon
406 24: 603 0 0 0 GICv2 53 Level xuartps
407 27: 0 0 0 0 GICv2 156 Level zynqmp-dma
408 28: 0 0 0 0 GICv2 157 Level zynqmp-dma
409 29: 0 0 0 0 GICv2 158 Level zynqmp-dma
410 30: 0 0 0 0 GICv2 159 Level zynqmp-dma
411 31: 0 0 0 0 GICv2 160 Level zynqmp-dma
412 32: 0 0 0 0 GICv2 161 Level zynqmp-dma
413 33: 0 0 0 0 GICv2 162 Level zynqmp-dma
414 34: 0 0 0 0 GICv2 163 Level zynqmp-dma
415 35: 0 0 0 0 GICv2 109 Level zynqmp-dma
416 36: 0 0 0 0 GICv2 110 Level zynqmp-dma
417 37: 0 0 0 0 GICv2 111 Level zynqmp-dma
418 38: 0 0 0 0 GICv2 112 Level zynqmp-dma
419 39: 0 0 0 0 GICv2 113 Level zynqmp-dma
420 40: 0 0 0 0 GICv2 114 Level zynqmp-dma
421 41: 0 0 0 0 GICv2 115 Level zynqmp-dma
422 42: 0 0 0 0 GICv2 116 Level zynqmp-dma
423 43: 0 0 0 0 GICv2 154 Level fd4c0000.dma-controller
424 44: 5938 0 0 0 GICv2 47 Level ff0f0000.spi
425 45: 134 0 0 0 GICv2 95 Level eth0, eth0
426 46: 0 0 0 0 GICv2 57 Level axi-pmon, axi-pmon
427 47: 4802 0 0 0 GICv2 49 Level cdns-i2c
428 48: 501 0 0 0 GICv2 50 Level cdns-i2c
429 50: 0 0 0 0 GICv2 84 Edge ff150000.watchdog
430 51: 0 0 0 0 GICv2 151 Level fd4a0000.display
431 52: 548 0 0 0 GICv2 81 Level mmc0
432 53: 0 0 0 0 GICv2 165 Level ahci-ceva[fd0c0000.ahci]
433 54: 0 0 0 0 GICv2 97 Level xhci-hcd:usb1
434 55: 0 0 0 0 zynq-gpio 22 Edge sw19
435 59: 2 0 0 0 gpio-xilinx 4 Edge PL_GPIO_PB_SW9_N
436 60: 4 0 0 0 gpio-xilinx 3 Edge PL_GPIO_PB_SW12_E
437 61: 2 0 0 0 gpio-xilinx 2 Edge PL_GPIO_PB_SW13_S
438 62: 2 0 0 0 gpio-xilinx 1 Edge PL_GPIO_PB_SW10_W
439 63: 2 0 0 0 gpio-xilinx 0 Edge PL_GPIO_PB_SW11_C
440 64: 2 0 0 0 gpio-xilinx 7 Edge PL_GPIO_DIP_SW7
441 65: 2 0 0 0 gpio-xilinx 6 Edge PL_GPIO_DIP_SW6
442 66: 4 0 0 0 gpio-xilinx 5 Edge PL_GPIO_DIP_SW5
443 67: 2 0 0 0 gpio-xilinx 4 Edge PL_GPIO_DIP_SW4
444 68: 2 0 0 0 gpio-xilinx 3 Edge PL_GPIO_DIP_SW3
445 69: 2 0 0 0 gpio-xilinx 2 Edge PL_GPIO_DIP_SW2
446 70: 2 0 0 0 gpio-xilinx 1 Edge PL_GPIO_DIP_SW1
447 71: 2 0 0 0 gpio-xilinx 0 Edge PL_GPIO_DIP_SW0
448IPI0: 64 26 87 38 Rescheduling interrupts
449IPI1: 2163 6791 1243 5866 Function call interrupts
450IPI2: 0 0 0 0 CPU stop interrupts
451IPI3: 0 0 0 0 CPU stop (for crash dump) interrupts
452IPI4: 0 0 0 0 Timer broadcast interrupts
453IPI5: 0 0 0 0 IRQ work interrupts
454IPI6: 0 0 0 0 CPU wake-up interrupts
455Err: 0
456yocto-zynqmp-generic-20231:/home/petalinux#
457```
458---
459
460### Unloading PL bitstream or pdi and dt overlay
461* Zynq or ZynqMP
462```
463yocto-zynqmp-generic-20231:/home/petalinux# fpgautil -R
464```
465* Versal (DFx RP)
466```
467root@yocto-vck190-dfx-2023:~# fpgautil -R -n PR0
468```
469* Versal (DFx Static)
470```
471root@yocto-vck190-dfx-2023:~# fpgautil -R -n Full
472```
473---
474
475## References
476* https://xilinx-wiki.atlassian.net/wiki/spaces/A/pages/18841645/Solution+Zynq+PL+Programming+With+FPGA+Manager
477* https://xilinx-wiki.atlassian.net/wiki/spaces/A/pages/18841847/Solution+ZynqMP+PL+Programming
478* https://xilinx-wiki.atlassian.net/wiki/spaces/A/pages/1188397412/Solution+Versal+PL+Programming
diff --git a/docs/README.fw.package.md b/docs/README.fw.package.md
new file mode 100644
index 00000000..a7e54402
--- /dev/null
+++ b/docs/README.fw.package.md
@@ -0,0 +1,61 @@
1# How to package and depoly firmware elf or bin to linux root filesystem
2
3* [Introduction](#introduction)
4* [How to create and install firmware package recipe](#how-to-create-and-install-firmware-package-recipe)
5
6## Introduction
7This readme describes how to package and deploy firmware baremetal or freertos
8application elf or bin files to linux root filesystem under /lib/firmware directory.
9Packaging an firmware baremetal or freertos application elf or bin files to linux
10root filesystem is not automated from multiconfig baremetal or freertos recipes.
11Hence user has to create a linux recipe and inherit fw-package which provides
12infrastructure to package and deploy firmware elf or bin files to linux root
13filesystem.
14
15## How to create and install firmware package recipe
16
171. Follow [SDT Building Instructions](../meta-xilinx-standalone-experimental/README.md ) upto step 4.
18
192. Create recipes-firmware directory in distribution meta layer.
20```
21$ mkdir -p <meta-layer>/recipes-firmware/<firmware-package-name>/
22```
233. Now create the recipes firmware package using recipetool.
24```
25$ recipetool create -o <meta-layer>/recipes-firmware/<firmware-package-name>/firmware-package-name.bb
26```
274. Modify the recipe and inherit fw-package bbclass as shown below.
28
29> **Note:**
30> * **DESTDIR:** Variable to specify elf or bin directory path. Default is set to
31> /lib/firmware directory from fw-package,bbclass and user can
32> change this value to /boot directory depending on requirement.
33> * **FW_NAME:** Variable to define firmware baremetal or freertos application
34> recipe name.
35> * **TARGET_MC:** Variable to define one of the multiconfig target name
36> (ex: cortexr5-0-zynqmp-baremetal) from the BBMULTICONFIG list
37> generated at [SDT Building Instructions](../meta-xilinx-standalone-experimental/README.md )
38> step 4.
39
40```
41SUMMARY = "Recipe to package and deploy baremetal or freertos elf or bin to linux rootfs"
42LICENSE = "CLOSED"
43
44inherit fw-package
45
46FW_NAME = "hello-world"
47
48TARGET_MC = "cortexr5-0-zynqmp-baremetal"
49
50FW_MCDEPENDS := "mc::${TARGET_MC}:${FW_NAME}:do_deploy"
51FW_DEPLOY_DIR := "${TOPDIR}/tmp-${TARGET_MC}/deploy/images/${MACHINE}"
52```
535. Add firmware-package recipe to image to local.conf as shown below.
54
55```
56IMAGE_INSTALL:append = " \
57 firmware-package-name \
58 "
59```
606. Follow [SDT Building Instructions](../meta-xilinx-standalone-experimental/README.md ) and continue from
61 step 5.
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-05-31 01:41:35 +0000