doc: Add a readme guide for SiFive FU540
[platform/kernel/u-boot.git] / doc / README.zynq
1 # SPDX-License-Identifier: GPL-2.0+
2 #
3 # Xilinx ZYNQ U-Boot
4 #
5 # (C) Copyright 2013 Xilinx, Inc.
6
7 1. About this
8
9 This document describes the information about Xilinx Zynq U-Boot -
10 like supported boards, ML status and TODO list.
11
12 2. Zynq boards
13
14 Xilinx Zynq-7000 All Programmable SoCs enable extensive system level
15 differentiation, integration, and flexibility through hardware, software,
16 and I/O programmability.
17
18 * zc702 (single qspi, gem0, mmc) [1]
19 * zc706 (dual parallel qspi, gem0, mmc) [2]
20 * zed (single qspi, gem0, mmc) [3]
21 * microzed (single qspi, gem0, mmc) [4]
22 * zc770
23   - zc770-xm010 (single qspi, gem0, mmc)
24   - zc770-xm011 (8 or 16 bit nand)
25   - zc770-xm012 (nor)
26   - zc770-xm013 (dual parallel qspi, gem1)
27
28 3. Building
29
30  ex. configure and build for zc702 board
31    $ make zynq_zc702_config
32    $ make
33
34 4. Bootmode
35
36 Zynq has a facility to read the bootmode from the slcr bootmode register
37 once user is setting through jumpers on the board - see page no:1546 on [5]
38
39 All possible bootmode values are defined in Table 6-2:Boot_Mode MIO Pins
40 on [5].
41
42 board_late_init() will read the bootmode values using slcr bootmode register
43 at runtime and assign the modeboot variable to specific bootmode string which
44 is intern used in autoboot.
45
46 SLCR bootmode register Bit[3:0] values
47 #define ZYNQ_BM_NOR             0x02
48 #define ZYNQ_BM_SD              0x05
49 #define ZYNQ_BM_JTAG            0x0
50
51 "modeboot" variable can assign any of "norboot", "sdboot" or "jtagboot"
52 bootmode strings at runtime.
53
54 5. Mainline status
55
56 - Added basic board configurations support.
57 - Added zynq u-boot bsp code - arch/arm/cpu/armv7/zynq
58 - Added zynq boards named - zc70x, zed, microzed, zc770_xm010/xm011/xm012/xm013
59 - Added zynq drivers:
60   serial - drivers/serial/serial_zynq.c
61   net - drivers/net/zynq_gem.c
62   mmc - drivers/mmc/zynq_sdhci.c
63   spi - drivers/spi/zynq_spi.c
64   qspi - drivers/spi/zynq_qspi.c
65   i2c - drivers/i2c/zynq_i2c.c
66   nand - drivers/mtd/nand/raw/zynq_nand.c
67 - Done proper cleanups on board configurations
68 - Added basic FDT support for zynq boards
69 - d-cache support for zynq_gem.c
70
71 6. TODO
72
73 - Add FDT support on individual drivers
74
75 [1] http://www.xilinx.com/products/boards-and-kits/EK-Z7-ZC702-G.htm
76 [2] http://www.xilinx.com/products/boards-and-kits/EK-Z7-ZC706-G.htm
77 [3] http://zedboard.org/product/zedboard
78 [4] http://zedboard.org/product/microzed
79 [5] http://www.xilinx.com/support/documentation/user_guides/ug585-Zynq-7000-TRM.pdf
80
81 --
82 Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
83 Sun Dec 15 14:52:41 IST 2013