Skip to contentSkip to conversation

doc: board: xilinx: Update Xilinx documentation

PATCH Superseded Michal Simek 2 participants 8 messages Sep 16, 2020 Arm/Zynq architecture

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover doc: board: xilinx: Update Xilinx documentation

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
Signature · 1 line
2.28.0
#1 lore raw

PATCH 1/5 MAINTAINERS: Record documentation for Xilinx platforms

Add fragment to cover documenation for Xilinx platforms.

---

 MAINTAINERS | 1 +
 1 file changed, 1 insertion(+)
MAINTAINERS +1 -0
index 101f4e185df3..c6c100e87cab 100644
@@ -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
Signature · 1 line
2.28.0
#4 lore raw

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

In reply to Michal Simek

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

---

 doc/board/xilinx/zynq.rst | 7 +------
 1 file changed, 1 insertion(+), 6 deletions(-)
doc/board/xilinx/zynq.rst +1 -6
index f564434b69c4..438912fe42c2 100644
@@ -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
Signature · 1 line
2.28.0
#5 lore raw

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

In reply to Michal Simek

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

---

 doc/board/xilinx/xilinx.rst | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)
doc/board/xilinx/xilinx.rst +13 -3
index f6ea5dbe2158..8c9afb482d65 100644
@@ -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
Signature · 1 line
2.28.0
#6 lore raw

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

In reply to Michal Simek

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

---

 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
doc/board/xilinx/index.rst +1 -0
index 47f09290af03..e9560f208fb4 100644
@@ -8,3 +8,4 @@ Xilinx
 
    xilinx
    zynq
+   zynqmp
doc/board/xilinx/zynqmp.rst new file +97 -0

97 lines not on this page · raw message

Signature · 1 line
2.28.0
#7 lore raw

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

In reply to Michal Simek

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

---

 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
doc/board/xilinx/index.rst +1 -0
index e9560f208fb4..2e31fe3f3a4f 100644
@@ -9,3 +9,4 @@ Xilinx
    xilinx
    zynq
    zynqmp
+   zynqmp-r5
doc/board/xilinx/zynqmp-r5.rst new file +137 -0

137 lines not on this page · raw message

Signature · 1 line
2.28.0
#2 lore raw

PATCH 1/5 MAINTAINERS: Record documentation for Xilinx platforms

In reply to Michal Simek
Quoted 14 lines · Michal Simek

Add fragment to cover documenation for Xilinx platforms.

---

 MAINTAINERS | 1 +
 1 file changed, 1 insertion(+)
MAINTAINERS +0 -0
index 101f4e185df3..c6c100e87cab 100644

MAINTAINERS F: drivers/usb/host/ehci-zynq.c · line 554

Quoted 7 lines
MAINTAINERS +1 -0
@@ -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

#3 lore raw

PATCH 1/5 MAINTAINERS: Record documentation for Xilinx platforms

Quoted 25 lines · Heinrich Schuchardt
Quoted 14 lines · Michal Simek

Add fragment to cover documenation for Xilinx platforms.

---

 MAINTAINERS | 1 +
 1 file changed, 1 insertion(+)
MAINTAINERS +0 -0
index 101f4e185df3..c6c100e87cab 100644

MAINTAINERS F: drivers/usb/host/ehci-zynq.c · line 554

Quoted 7 lines
MAINTAINERS +1 -0
@@ -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.

Quoted 5 lines

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

Otherwise

Will fix it in v2.

Thanks,
Michal