board/csky: fixup gdb instructions in readme.txt
[buildroot-gz.git] / board / zynq / readme.txt
blobc5506fe9668cd81cb234bf3f38d69cc60974a87e
1 This is the Buildroot support for Zynq boards.  Zynq boards are available from
2 Xilinx and some third party vendors, but the build procedure is very similar.
4 Currently, three boards are natively supported by Buildroot:
5  - Xilinx ZC706 board (zynq_zc706_defconfig)
6  - Avnet ZedBoard (zynq_zed_defconfig)
7  - Avnet MicroZed (zynq_microzed_defconfig)
9 Steps to create a working system for a Zynq board:
11 1) Configuration (do one of the following)
12     make zynq_zc706_defconfig     (ZC706)
13     make zynq_zed_defconfig       (Zedboard)
14     make zynq_microzed_defconfig  (MicroZed)
15 2) make
16 3) All needed files will be available in the output/images directory.
17    Create a FAT32 partition at the beginning of your SD Card and copy files:
18      - boot.bin
19      - u-boot.img
20      - uImage
21      - uramdisk.image.gz (should be renamed from rootfs.cpio.uboot)
22      - devicetree.dtb (should be renamed from zynq-***.dtb)
23    into your SD card
24 4) boot your board
26 You can alter the booting procedure by creating a file uEnv.txt
27 in the root of the SD card. It is a plain text file in format
28 <key>=<value> one per line:
30 kernel_image=myimage
31 modeboot=myboot
32 myboot=...
34 Note:
35 The DTB for MicroZed is the same as the one for the Zedboard (zynq-zed.dtb),
36 and this is the recommended solution, see
37 https://forums.xilinx.com/t5/Embedded-Linux/Microzed-default-device-tree-dts/td-p/432856.
39 References:
40  - ZC706 information including schematics, reference designs, and manuals are
41    available from
42    http://www.xilinx.com/products/boards-and-kits/ek-z7-zc706-g.html.
44  - Zedboard/Microzed information including schematics, reference designs, and
45    manuals are available from http://www.zedboard.org .
47 Support for other boards:
49 If you want to build a system for other boards based on the same SoC
50 (for ex. Digilent Zybo board), and the board is already supported by
51 the upstream kernel and U-Boot, you simply need to change the
52 following Buildroot options:
54  - Kernel Device Tree file name (BR2_LINUX_KERNEL_INTREE_DTS_NAME)
55  - U-Boot board defconfig (BR2_TARGET_UBOOT_BOARD_DEFCONFIG)
57 Custom ps7_init_gpl.c/h support:
59 To generate a working boot.bin image, ps7_init_gpl.c/h are required in
60 the U-Boot source tree. Without those files, boot.bin will be built
61 successfully but it will not be functional at all. Those files are
62 output from the Xilinx tools, but for convenience, U-Boot includes the
63 default ps7_init_gpl.c/h of popular boards. Those files may need to be
64 updated for any programmable logic customizations which impact
65 ps7_init (clock/pin setup & mapping/AXI bridge setup/etc). See
66 board/xilinx/zynq/ directory of U-Boot for natively supported ps7_init
67 files. If the ps7_init files for your board are not found in U-Boot,
68 you need to add them by yourself.
70 1) Start with a defconfig supported by Buildroot (e.g. Zedboard)
71     make zynq_zed_defconfig
73 2) make uboot-menuconfig
74     Visit the following menu and enable CONFIG_ZYNQ_CUSTOM_INIT.
76     ARM architecture  --->
77        [*] Use custom ps7_init provided by Xilinx tool
79 3) Copy ps7_init_gpl.c/h generated by the Xilinx tools into
80    output/build/uboot-xilinx-<pkg version>/board/xilinx/zynq/custom_hw_platform/
82 4) make
84 Note: The files in step 3 will need to be re-copied after cleaning the
85 output directory and at this time, there is no way to save them as
86 part of the buildroot configuration, except as a U-Boot patch.