[PATCH 0/5] doc: board: xilinx: Update Xilinx documentation

[PATCH 0/5] doc: board: xilinx: Update Xilinx documentation

[Michal Simek]

Hi,

this series is trying to update documentation for Xilinx SoCs.
Based on this documentation developers should be able to configure and run
u-boot on their platforms.

Thanks,
Michal


Michal Simek (5):
  MAINTAINERS: Record documentation for Xilinx platforms
  doc: board: xilinx: zynq.rst: Update zynq documentation
  doc: board: xilinx: Update links to DT binding docs
  doc: board: xilinx: Add documentation for ZynqMP
  doc: board: xilinx: Add documentation for ZynqMP R5

 MAINTAINERS                    |   1 +
 doc/board/xilinx/index.rst     |   2 +
 doc/board/xilinx/xilinx.rst    |  16 +++-
 doc/board/xilinx/zynq.rst      |   7 +-
 doc/board/xilinx/zynqmp-r5.rst | 137 +++++++++++++++++++++++++++++++++
 doc/board/xilinx/zynqmp.rst    |  97 +++++++++++++++++++++++
 6 files changed, 251 insertions(+), 9 deletions(-)
 create mode 100644 doc/board/xilinx/zynqmp-r5.rst
 create mode 100644 doc/board/xilinx/zynqmp.rst

-- 
2.28.0

[PATCH 1/5] MAINTAINERS: Record documentation for Xilinx platforms

[Michal Simek]

Add fragment to cover documenation for Xilinx platforms.

Signed-off-by: Michal Simek <michal.simek@xilinx.com>
---

 MAINTAINERS | 1 +
 1 file changed, 1 insertion(+)

diff --git a/MAINTAINERS b/MAINTAINERS
index 101f4e185df3..c6c100e87cab 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -548,6 +548,7 @@ F:	drivers/usb/host/ehci-zynq.c
 F:	drivers/watchdog/cdns_wdt.c
 F:	include/zynqpl.h
 F:	tools/zynqimage.c
+F:	doc/board/xilinx/
 N:	zynq
 
 ARM ZYNQMP
-- 
2.28.0

[PATCH 2/5] doc: board: xilinx: zynq.rst: Update zynq documentation

[Michal Simek]

- Correct location of BSP code
- Remove TODO which is done already

Signed-off-by: Michal Simek <michal.simek@xilinx.com>
---

 doc/board/xilinx/zynq.rst | 7 +------
 1 file changed, 1 insertion(+), 6 deletions(-)

diff --git a/doc/board/xilinx/zynq.rst b/doc/board/xilinx/zynq.rst
index f564434b69c4..438912fe42c2 100644
--- a/doc/board/xilinx/zynq.rst
+++ b/doc/board/xilinx/zynq.rst
@@ -83,7 +83,7 @@ Mainline status
 ---------------
 
 - Added basic board configurations support.
-- Added zynq u-boot bsp code - arch/arm/cpu/armv7/zynq
+- Added zynq u-boot bsp code - arch/arm/mach-zynq
 - Added zynq boards named - zc70x, zed, microzed, zc770_xm010/xm011/xm012/xm013
 - Added zynq drivers:
 
@@ -99,11 +99,6 @@ Mainline status
 - Added basic FDT support for zynq boards
 - d-cache support for zynq_gem.c
 
-TODO
-----
-
-Add FDT support on individual drivers
-
 * [1] http://www.xilinx.com/products/boards-and-kits/EK-Z7-ZC702-G.htm
 * [2] http://www.xilinx.com/products/boards-and-kits/EK-Z7-ZC706-G.htm
 * [3] http://zedboard.org/product/zedboard
-- 
2.28.0

[PATCH 3/5] doc: board: xilinx: Update links to DT binding docs

[Michal Simek]

Several drivers have been added without updating documentation.
And also some dt bindings have been moved to yaml.

Signed-off-by: Michal Simek <michal.simek@xilinx.com>
---

 doc/board/xilinx/xilinx.rst | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/doc/board/xilinx/xilinx.rst b/doc/board/xilinx/xilinx.rst
index f6ea5dbe2158..8c9afb482d65 100644
--- a/doc/board/xilinx/xilinx.rst
+++ b/doc/board/xilinx/xilinx.rst
@@ -10,18 +10,28 @@ kernel.
 
 * ata
 	- Documentation/devicetree/bindings/ata/ahci-ceva.txt
+* clock
+	- Documentation/devicetree/bindings/clock/xlnx,zynqmp-clk.txt
+* firmware
+	- Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.txt
+* fpga
+	- Documentation/devicetree/bindings/fpga/xlnx,zynqmp-pcap-fpga.txt
 * gpio
 	- Documentation/devicetree/bindings/gpio/gpio-xilinx.txt
 	- Documentation/devicetree/bindings/gpio/gpio-zynq.txt
 * i2c
-	- Documentation/devicetree/bindings/i2c/i2c-xiic.txt
-	- Documentation/devicetree/bindings/i2c/i2c-cadence.txt
+	- Documentation/devicetree/bindings/i2c/xlnx,xps-iic-2.00.a.yaml
+	- Documentation/devicetree/bindings/i2c/cdns,i2c-r1p10.yaml
 * mmc
-	- Documentation/devicetree/bindings/mmc/arasan,sdhci.txt
+	- Documentation/devicetree/bindings/mmc/arasan,sdhci.yaml
 * net
 	- Documentation/devicetree/bindings/net/macb.txt
 	- Documentation/devicetree/bindings/net/xilinx_axienet.txt
 	- Documentation/devicetree/bindings/net/xilinx_emaclite.txt
+* nvmem
+	- Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt
+* power
+	- Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.txt
 * serial
 	- Documentation/devicetree/bindings/serial/cdns,uart.txt
 	- Documentation/devicetree/bindings/serial/xlnx,opb-uartlite.txt
-- 
2.28.0

[PATCH 4/5] doc: board: xilinx: Add documentation for ZynqMP

[Michal Simek]

Add missing documentation for Xilinx ZynqMP configuration with steps how
to configure it and run it.

Signed-off-by: Michal Simek <michal.simek@xilinx.com>
---

 doc/board/xilinx/index.rst  |  1 +
 doc/board/xilinx/zynqmp.rst | 97 +++++++++++++++++++++++++++++++++++++
 2 files changed, 98 insertions(+)
 create mode 100644 doc/board/xilinx/zynqmp.rst

diff --git a/doc/board/xilinx/index.rst b/doc/board/xilinx/index.rst
index 47f09290af03..e9560f208fb4 100644
--- a/doc/board/xilinx/index.rst
+++ b/doc/board/xilinx/index.rst
@@ -8,3 +8,4 @@ Xilinx
 
    xilinx
    zynq
+   zynqmp
diff --git a/doc/board/xilinx/zynqmp.rst b/doc/board/xilinx/zynqmp.rst
new file mode 100644
index 000000000000..326b495dcca7
--- /dev/null
+++ b/doc/board/xilinx/zynqmp.rst
@@ -0,0 +1,97 @@
+.. SPDX-License-Identifier: GPL-2.0
+..  (C) Copyright 2020 Xilinx, Inc.
+
+ZYNQMP
+======
+
+About this
+----------
+
+This document describes the information about Xilinx Zynq UltraScale+ MPSOC
+U-Boot support. Core support is available in arch/arm/mach-zynqmp folder.
+
+ZynqMP boards
+-------------
+
+* zcu100 (ultra96 v1), zcu102, zcu104, zcu106 - Evaluation boards
+* zc1232 - Characterization boards
+* zcu111, zcu208, zcu216 - RFSOC evaluation boards
+* zcu1254, zcu1275, zcu1285 - RFSOC characterization boards
+* a2197 - System Controller on Versal boards
+* mini - Mini U-Boot running out of OCM
+* zc1751 - Characterization Processor boards
+     - zc1751-xm015-dc1
+     - zc1751-xm016-dc2
+     - zc1751-xm017-dc3
+     - zc1751-xm018-dc4
+     - zc1751-xm019-dc5
+
+Building
+--------
+
+Configure and build for zcu102 board::
+
+   $ source arm64 toolchain
+   $ export DEVICE_TREE=zynqmp-zcu102-revA
+   $ make xilinx_zynqmp_virt_defconfig
+   $ make
+
+U-Boot SPL flow
+---------------
+
+For getting U-Boot SPL flow up and running it is necessary to do some additional
+steps because booting device requires external images which are not the part of
+U-Boot repository.
+
+PMU firmware
+^^^^^^^^^^^^
+The Platform Management Unit (PMU) RAM can be loaded with a firmware (PMU
+Firmware) at run-time and can be used to extend or customize the functionality
+of PMU. The PMU firmware is the part of boot image (boot.bin) and it is
+automatically loaded by BootROM. boot.bin can be directly generated by mkimage
+tool as the part of make. If you want to create boot.bin with PMU Firmware
+include please point CONFIG_PMUFW_INIT_FILE to PMU firmware binary. For example:::
+
+  CONFIG_PMUFW_INIT_FILE="<path>/pmu.bin"
+
+If you see below message you need to load PMU Firmware::
+
+  PMUFW is not found - Please load it!
+
+The second external blob is PMU Configuration object which is object which is
+passed from U-Boot SPL to PMU Firmware for initial system configuration. PMU
+Configuration object is the part of U-Boot SPL image. For pointing to this
+object please use CONFIG_ZYNQMP_SPL_PM_CFG_OBJ_FILE symbol. For example:::
+
+  CONFIG_ZYNQMP_SPL_PM_CFG_OBJ_FILE="<path>/pmu_obj.bin"
+
+
+Arm Trusted Firmware (ATF)
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+U-Boot itself can run from EL3 to EL1. Without ATF U-Boot runs in EL3. Boot flow
+is U-Boot SPL->U-Boot in EL3. When ATF is used U-Boot normally runs in EL2. Boot
+flow is U-Boot SPL->ATF->U-Boot in EL2. As the part of build process u-boot.itb
+is generated. When BL31 shell variable is present u-boot.itb is generated with
+ATF included. You can point to it by:::
+
+  $ export BL31=<path>/bl31.bin
+
+Flashing
+--------
+
+SD Card
+^^^^^^^
+
+To write an image that boots from a SD card first create a FAT32 partition
+and a FAT32 filesystem on the SD card::
+
+        sudo fdisk /dev/sdx
+        sudo mkfs.vfat -F 32 /dev/sdx1
+
+Mount the SD card and copy the SPL and U-Boot to the root directory of the
+SD card::
+
+        sudo mount -t vfat /dev/sdx1 /mnt
+        sudo cp spl/boot.bin /mnt
+        sudo cp u-boot.itb /mnt
-- 
2.28.0

[PATCH 5/5] doc: board: xilinx: Add documentation for ZynqMP R5

[Michal Simek]

Add missing documentation for Xilinx ZynqMP R5 configuration with steps how
to run it.

Signed-off-by: Michal Simek <michal.simek@xilinx.com>
---

 doc/board/xilinx/index.rst     |   1 +
 doc/board/xilinx/zynqmp-r5.rst | 137 +++++++++++++++++++++++++++++++++
 2 files changed, 138 insertions(+)
 create mode 100644 doc/board/xilinx/zynqmp-r5.rst

diff --git a/doc/board/xilinx/index.rst b/doc/board/xilinx/index.rst
index e9560f208fb4..2e31fe3f3a4f 100644
--- a/doc/board/xilinx/index.rst
+++ b/doc/board/xilinx/index.rst
@@ -9,3 +9,4 @@ Xilinx
    xilinx
    zynq
    zynqmp
+   zynqmp-r5
diff --git a/doc/board/xilinx/zynqmp-r5.rst b/doc/board/xilinx/zynqmp-r5.rst
new file mode 100644
index 000000000000..2cd368b0308e
--- /dev/null
+++ b/doc/board/xilinx/zynqmp-r5.rst
@@ -0,0 +1,137 @@
+.. SPDX-License-Identifier: GPL-2.0
+..  (C) Copyright 2020 Xilinx, Inc.
+
+ZYNQMP-R5
+=========
+
+About this
+----------
+
+This document describes the information about Xilinx Zynq UltraScale+ MPSOC
+U-Boot Cortex R5 support.
+
+ZynqMP R5 boards
+----------------
+
+* zynqmp-r5 - U-Boot running on RPU Cortex-R5
+
+Building
+--------
+
+configure and build armv7 toolchain::
+
+   $ make xilinx_zynqmp_r5_defconfig
+   $ make
+
+Notes
+^^^^^
+
+Output fragment is u-boot.
+
+Loading
+-------
+
+ZynqMP R5 U-Boot was created for supporting loading OS on RPU. There are two
+ways how to start U-Boot on R5.
+
+Bootgen
+^^^^^^^
+
+The first way is to use Xilinx FSBL (First stage
+bootloader) to load u-boot and start it. The following bif can be used for boot
+image generation via Xilinx bootgen utility::
+
+
+  the_ROM_image:
+  {
+  	[bootloader,destination_cpu=r5-0] fsbl_rpu.elf
+  	[destination_cpu=r5-0]u-boot.elf
+  }
+
+Bootgen command for building boot.bin::
+
+  bootgen -image <bif>.bif -r -w -o i boot.bin
+
+
+U-Boot cpu command
+^^^^^^^^^^^^^^^^^^
+
+The second way to load U-Boot to Cortex R5 is from U-Boot running on A53 as is
+visible from the following log::
+
+  U-Boot SPL 2020.10-rc4-00090-g801b3d5c5757 (Sep 15 2020 - 14:07:24 +0200)
+  PMUFW:	v1.1
+  Loading new PMUFW cfg obj (2024 bytes)
+  EL Level:	EL3
+  Multiboot:	0
+  Trying to boot from MMC2
+  spl: could not initialize mmc. error: -19
+  Trying to boot from MMC1
+  spl_load_image_fat_os: error reading image u-boot.bin, err - -2
+  NOTICE:  ATF running on XCZU7EG/EV/silicon v4/RTL5.1 at 0xfffea000
+  NOTICE:  BL31: v2.2(release):v2.2-614-ged9dc512fb9c
+  NOTICE:  BL31: Built : 09:32:09, Mar 13 2020
+
+
+  U-Boot 2020.10-rc4-00090-g801b3d5c5757 (Sep 15 2020 - 14:07:24 +0200)
+
+  Model: ZynqMP ZCU104 RevC
+  Board: Xilinx ZynqMP
+  DRAM:  2 GiB
+  PMUFW:	v1.1
+  EL Level:	EL2
+  Chip ID:	zu7e
+  WDT:   Started with servicing (60s timeout)
+  NAND:  0 MiB
+  MMC:   mmc at ff170000: 0
+  Loading Environment from FAT... *** Warning - bad CRC, using default environment
+
+  In:    serial
+  Out:   serial
+  Err:   serial
+  Bootmode: LVL_SHFT_SD_MODE1
+  Reset reason:	SOFT
+  Net:
+  ZYNQ GEM: ff0e0000, mdio bus ff0e0000, phyaddr 12, interface rgmii-id
+  eth0: ethernet at ff0e0000
+  Hit any key to stop autoboot:  0
+  ZynqMP> setenv autoload no
+  ZynqMP> dhcp
+  BOOTP broadcast 1
+  DHCP client bound to address 192.168.0.167 (8 ms)
+  ZynqMP> tftpboot 20000000 192.168.0.105:u-boot-r5-2.elf
+  Using ethernet at ff0e0000 device
+  TFTP from server 192.168.0.105; our IP address is 192.168.0.167
+  Filename 'u-boot-r5-2.elf'.
+  Load address: 0x20000000
+  Loading: #################################################################
+  	 #################################################################
+  	 #################################################################
+  	 #################################################################
+  	 #################################################################
+  	 #################################################################
+  	 ################
+  	 376 KiB/s
+  done
+  Bytes transferred = 2075464 (1fab48 hex)
+  ZynqMP> setenv autostart no
+  ZynqMP> bootelf -p 20000000
+  ZynqMP> cpu 4 release 10000000 lockstep
+  Using TCM jump trampoline for address 0x10000000
+  R5 lockstep mode
+  ZynqMP>
+
+Then on second uart you can see U-Boot up and running on R5::
+
+  U-Boot 2020.10-rc4-00071-g7045622cc9ba (Sep 16 2020 - 13:38:53 +0200)
+
+  Model: Xilinx ZynqMP R5
+  DRAM:  512 MiB
+  MMC:
+  In:    serial at ff010000
+  Out:   serial at ff010000
+  Err:   serial at ff010000
+  Net:   No ethernet found.
+  ZynqMP r5>
+
+Please make sure MIO pins for uart are properly configured to see output.
-- 
2.28.0

[PATCH 1/5] MAINTAINERS: Record documentation for Xilinx platforms

[Heinrich Schuchardt]

On 16.09.20 15:31, Michal Simek wrote:
> Add fragment to cover documenation for Xilinx platforms.
>
> Signed-off-by: Michal Simek <michal.simek@xilinx.com>
> ---
>
>  MAINTAINERS | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 101f4e185df3..c6c100e87cab 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -548,6 +548,7 @@ F:	drivers/usb/host/ehci-zynq.c
>  F:	drivers/watchdog/cdns_wdt.c
>  F:	include/zynqpl.h
>  F:	tools/zynqimage.c
> +F:	doc/board/xilinx/
>  N:	zynq
>
>  ARM ZYNQMP
>

Thanks for picking that up.

I think we should keep the alphabetic order. doc/ should be before drivers/.

Otherwise
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

[PATCH 1/5] MAINTAINERS: Record documentation for Xilinx platforms

[Michal Simek]

On 16. 09. 20 15:47, Heinrich Schuchardt wrote:
> On 16.09.20 15:31, Michal Simek wrote:
>> Add fragment to cover documenation for Xilinx platforms.
>>
>> Signed-off-by: Michal Simek <michal.simek@xilinx.com>
>> ---
>>
>>  MAINTAINERS | 1 +
>>  1 file changed, 1 insertion(+)
>>
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index 101f4e185df3..c6c100e87cab 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -548,6 +548,7 @@ F:	drivers/usb/host/ehci-zynq.c
>>  F:	drivers/watchdog/cdns_wdt.c
>>  F:	include/zynqpl.h
>>  F:	tools/zynqimage.c
>> +F:	doc/board/xilinx/
>>  N:	zynq
>>
>>  ARM ZYNQMP
>>
> 
> Thanks for picking that up.
> 
> I think we should keep the alphabetic order. doc/ should be before drivers/.
> 
> Otherwise
> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> 

Will fix it in v2.

Thanks,
Michal