diff mbox

[v2] Rewriting instructions to generate a zedboard image to be really verbose

Message ID 1403303331-14450-1-git-send-email-javierdo1@gmail.com
State Accepted
Headers show

Commit Message

Javier Domingo Cansino June 20, 2014, 10:28 p.m. UTC
---
Changes v1 -> v2:
  - Rewrote messages as suggested by spenser
---
 board/avnet/zedboard/readme.txt |   62 ++++++++++++++++++++++++++++++++-------
 1 file changed, 52 insertions(+), 10 deletions(-)

Comments

Spenser Gilliland June 21, 2014, 7:58 a.m. UTC | #1
Javier,

On Fri, Jun 20, 2014 at 3:28 PM, Javier Domingo Cansino
<javierdo1@gmail.com> wrote:
> ---
> Changes v1 -> v2:
>   - Rewrote messages as suggested by spenser
> ---
>  board/avnet/zedboard/readme.txt |   62 ++++++++++++++++++++++++++++++++-------
>  1 file changed, 52 insertions(+), 10 deletions(-)
>
> diff --git a/board/avnet/zedboard/readme.txt b/board/avnet/zedboard/readme.txt
> index efd076f..28f4846 100644
> --- a/board/avnet/zedboard/readme.txt
> +++ b/board/avnet/zedboard/readme.txt
> @@ -5,26 +5,68 @@ System-On-Chip.
>  Zedboard information including schematics, reference designs, and manuals are
>  available from http://www.zedboard.org .
>
> -To boot the Zedboard using a buildroot generated image copy the following files
> -to the sdcard:
> -       zynq-zed.dtb -> devicetree.dtb
> -       rootfs.cpio.gz.uboot -> uramdisk.image.gz
> -       uImage -> uImage
> -       boot.bin -> boot.bin
> +The U-Boot firmware for the Xilinx Zynq All Programmable SoC depends
> +on some propietary code. This dependency consists of a pair of
> +files are available from the Xilinx SDK installation.
>
> -U-Boot SPL Support
> --------------
> +You will need this files from Xilinx SDK installation to generate

This -> these

> +the U-Boot firmware:
> +       ps7_init.c
> +       ps7_init.h
> +
> +Buildroot will create the following files and place them in the
> +<output>/images directory.
> +       zynq-zed.dtb
> +       rootfs.cpio.uboot
> +       uImage
> +       u-boot.img
> +       boot.bin
> +
> +
> +uboot.bin  -- U-Boot SPL w/ Xilinx boot.bin wrapper
> +---------------------------------------------------
>
>  Due to licensing issues, the files ps7_init.c/h are not able to be
>  distributed with the U-Boot source code.  These files are required to make a
>  boot.bin file.
>
> -If you already have the Xilinx tools installed, the follwing sequence will
> +If you already have the Xilinx tools installed, the following sequence will
>  unpack, patch and build the rfs, kernel, uboot, and uboot-spl.
>
>  make zedboard_defconfig
>  make uboot-patch
>  cp ${XILINX}/ISE_DS/EDK/sw/lib/hwplatform_templates/zed_hw_platform/ps7_init.{c,h} \
> -output/build/uboot-xilinx-v2014.1/boards/xilinx/zynq/
> +output/build/uboot-xilinx-v2014.1/board/xilinx/zynq/
> +
> +After copying these files into the U-Boot source tree, you can
> +continue the build with:
> +
>  make
>
> +*Notice*
> +While the build will successfully complete without the ps7_init.*
> +files,  the uboot.bin file generated by this configuration will not
> +function properly on the Zedboard.  Therefore, it is imperative that
> +the ps7_init.* files be copied into the U-Boot source tree any time
> +the clean, or uboot-dirclean targets are made.
> +
> +
> +Resulting system
> +----------------
> +A FAT32 partition should be created at the beggining of the SD Card
> +and the following files should be installed:
> +       /boot.bin
> +       /devicetree.dtb
> +       /uImage
> +       /uramdisk.image.gz
> +       /u-boot.img
> +
> +
> +All needed files can be taken from output/images/
> +
> +boot.bin, uImage and u-boot.img are direct copies of the same files
> +available on output/images/
> +
> +devicetree.dtb is just zynq-zed.dtb renamed.
> +
> +uramdisk.image.gz is rootfs.cpio.uboot renamed
> --
> 1.7.10.4
>
> _______________________________________________
> buildroot mailing list
> buildroot@busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot

Otherwise, looks good to me.  Peter if you could apply this with the
small grammar fix above; it would help the documentation for users of
the Zedboard.

Thanks,
Spenser
Thomas Petazzoni June 22, 2014, 8:08 p.m. UTC | #2
Dear Javier Domingo Cansino,

On Sat, 21 Jun 2014 00:28:51 +0200, Javier Domingo Cansino wrote:
> ---
> Changes v1 -> v2:
>   - Rewrote messages as suggested by spenser
> ---
>  board/avnet/zedboard/readme.txt |   62 ++++++++++++++++++++++++++++++++-------
>  1 file changed, 52 insertions(+), 10 deletions(-)

Thanks, applied, after fixing the grammar issue noticed by Spenser,
adding your SoB line (I assumed you SoB'ed your patch since it was the
case in its v1), and adjusting the commit title.

Thomas
Javier Domingo Cansino June 22, 2014, 8:14 p.m. UTC | #3
Nice! I indeed forgot to put the -s option.
El 22/06/2014 14:08, "Thomas Petazzoni" <thomas.petazzoni@free-electrons.com>
escribió:

> Dear Javier Domingo Cansino,
>
> On Sat, 21 Jun 2014 00:28:51 +0200, Javier Domingo Cansino wrote:
> > ---
> > Changes v1 -> v2:
> >   - Rewrote messages as suggested by spenser
> > ---
> >  board/avnet/zedboard/readme.txt |   62
> ++++++++++++++++++++++++++++++++-------
> >  1 file changed, 52 insertions(+), 10 deletions(-)
>
> Thanks, applied, after fixing the grammar issue noticed by Spenser,
> adding your SoB line (I assumed you SoB'ed your patch since it was the
> case in its v1), and adjusting the commit title.
>
> Thomas
> --
> Thomas Petazzoni, CTO, Free Electrons
> Embedded Linux, Kernel and Android engineering
> http://free-electrons.com
>
diff mbox

Patch

diff --git a/board/avnet/zedboard/readme.txt b/board/avnet/zedboard/readme.txt
index efd076f..28f4846 100644
--- a/board/avnet/zedboard/readme.txt
+++ b/board/avnet/zedboard/readme.txt
@@ -5,26 +5,68 @@  System-On-Chip.
 Zedboard information including schematics, reference designs, and manuals are
 available from http://www.zedboard.org .
 
-To boot the Zedboard using a buildroot generated image copy the following files
-to the sdcard:
-	zynq-zed.dtb -> devicetree.dtb
-	rootfs.cpio.gz.uboot -> uramdisk.image.gz
-	uImage -> uImage
-	boot.bin -> boot.bin
+The U-Boot firmware for the Xilinx Zynq All Programmable SoC depends
+on some propietary code. This dependency consists of a pair of
+files are available from the Xilinx SDK installation.
 
-U-Boot SPL Support
--------------
+You will need this files from Xilinx SDK installation to generate
+the U-Boot firmware:
+	ps7_init.c
+	ps7_init.h
+
+Buildroot will create the following files and place them in the
+<output>/images directory.
+	zynq-zed.dtb
+	rootfs.cpio.uboot
+	uImage
+	u-boot.img
+	boot.bin
+
+
+uboot.bin  -- U-Boot SPL w/ Xilinx boot.bin wrapper
+---------------------------------------------------
 
 Due to licensing issues, the files ps7_init.c/h are not able to be
 distributed with the U-Boot source code.  These files are required to make a
 boot.bin file.
 
-If you already have the Xilinx tools installed, the follwing sequence will
+If you already have the Xilinx tools installed, the following sequence will
 unpack, patch and build the rfs, kernel, uboot, and uboot-spl.
 
 make zedboard_defconfig
 make uboot-patch
 cp ${XILINX}/ISE_DS/EDK/sw/lib/hwplatform_templates/zed_hw_platform/ps7_init.{c,h} \
-output/build/uboot-xilinx-v2014.1/boards/xilinx/zynq/
+output/build/uboot-xilinx-v2014.1/board/xilinx/zynq/
+
+After copying these files into the U-Boot source tree, you can
+continue the build with:
+
 make
 
+*Notice*
+While the build will successfully complete without the ps7_init.*
+files,  the uboot.bin file generated by this configuration will not
+function properly on the Zedboard.  Therefore, it is imperative that
+the ps7_init.* files be copied into the U-Boot source tree any time
+the clean, or uboot-dirclean targets are made.
+
+
+Resulting system
+----------------
+A FAT32 partition should be created at the beggining of the SD Card
+and the following files should be installed:
+	/boot.bin
+	/devicetree.dtb
+	/uImage
+	/uramdisk.image.gz
+	/u-boot.img
+
+
+All needed files can be taken from output/images/
+
+boot.bin, uImage and u-boot.img are direct copies of the same files
+available on output/images/
+
+devicetree.dtb is just zynq-zed.dtb renamed.
+
+uramdisk.image.gz is rootfs.cpio.uboot renamed