aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNathan Rossi <nathan.rossi@xilinx.com>2014-11-28 13:57:23 +1000
committerNathan Rossi <nathan.rossi@xilinx.com>2014-12-03 17:45:43 +1000
commitff7609762e100824abcb2faf518c346d07e1a815 (patch)
treed633c4da03e501447e535f92566fc761b7342bac
parent4d6683a504e3aefba33774567aa633620d440736 (diff)
downloadmeta-xilinx-ff7609762e100824abcb2faf518c346d07e1a815.tar.gz
meta-xilinx-ff7609762e100824abcb2faf518c346d07e1a815.tar.bz2
meta-xilinx-ff7609762e100824abcb2faf518c346d07e1a815.zip
Documentation Updates
* Clean up documentation around ext2/cpio * Split out some of the documentation in the README file into some docs/* files * Moved MAINTAINERS information into the README Signed-off-by: Nathan Rossi <nathan.rossi@xilinx.com>
-rw-r--r--MAINTAINERS10
-rw-r--r--README54
-rw-r--r--docs/BOOT.sdcard6
-rw-r--r--docs/BOOT.tftp2
-rw-r--r--docs/Rootfs11
-rw-r--r--docs/Toolchain15
6 files changed, 45 insertions, 53 deletions
diff --git a/MAINTAINERS b/MAINTAINERS
deleted file mode 100644
index 13ebee06..00000000
--- a/MAINTAINERS
+++ /dev/null
@@ -1,10 +0,0 @@
-This file contains a list of BSP maintainers for the BSPs contained in
-the meta-xilinx repository.
-
-Patches for this layer should be sent to meta-xilinx@lists.yoctoproject.org.
-See meta-xilinx/README for more details.
-
-Maintainers List
-
-Nathan Rossi<nathan.rossi@xilinx.com>
-Sipke Vriend<sipke.vriend@xilinx.com>
diff --git a/README b/README
index c5c548e6..6e56caf4 100644
--- a/README
+++ b/README
@@ -11,17 +11,23 @@ Boards Supported by this layer (Please refer to the associate .conf for more
information):
* Xilinx KC705 Embedded TRD (MicroBlaze)
* Xilinx ZC702 (Zynq)
+ * Xilinx ZC706 (Zynq)
* Avnet/Digilent ZedBoard (Zynq)
Additional information on the MicroBlaze or Zynq architectures can be found at:
http://www.xilinx.com/support/index.htm
-Patches
-=======
+Maintainers, Patches/Submissions, Community
+===========================================
-Please submit any patches for this layer to: meta-xilinx@lists.yoctoproject.org.
+Please send any patches, pull requests, comments or questions for this layer to:
-Please see the MAINTAINERS file for more details.
+ meta-xilinx@lists.yoctoproject.org
+
+Maintainers:
+
+ Nathan Rossi <nathan.rossi@xilinx.com>
+ Sipke Vriend <sipke.vriend@xilinx.com>
Dependencies
============
@@ -54,41 +60,11 @@ Build the target file system image using bitbake:
$ bitbake core-image-minimal
-Build additional targets, including U-Boot:
-
- $ bitbake u-boot-xlnx
-
Once complete the images for the target machine will be available in the output
directory 'tmp/deploy/images'.
-Images generated:
- * core-image-minimal-<machine name>.tar.gz (rootfs tar+GZIP)
- * core-image-minimal-<machine name>.cpio (rootfs in CPIO format)
- * core-image-minimal-<machine name>.ext2.gz.u-boot (rootfs in EXT2+GZIP, u-boot wrapped format)
- * u-boot.elf (U-Boot ELF)
- * For Zynq:
- * uImage (Linux Kernel binary, in u-boot wrapped format)
- * uImage-<machine name>.dtb (DTB for target machine)
- * For MicroBlaze:
- * linux.bin.ub (Linux Kernel binary, in u-boot wrapped format)
- * linux.bin.ub-<machine name>.dtb (DTB for target machine)
-
-Booting
-=======
-
-Please see the associated README file for each avaliable boot method in the
-'docs/BOOT.*' files of this layer.
-
-Configuring External Toolchain
-==============================
-
-In order to build with an external toolchain some additional configuration must
-be set in the build environments local.conf. First configure the use of an
-external toolchain, including the location to the toolchain:
-
- TCMODE = "external-xilinx"
- EXTERNAL_TOOLCHAIN = "<path to toolchain>"
-
-WARNING: There is a known issue with the MicroBlaze Linux toolchain provided by
-XSDK 2013.3 where certain shift instructions are not generated correctly, avoid
-using this toolchain. Use the newer XSDK 2013.4 or PetaLinux 2013.10 toolchains.
+Additional Documentation
+========================
+
+Additional documentation can be found in the 'docs/*' directory of this layer.
+
diff --git a/docs/BOOT.sdcard b/docs/BOOT.sdcard
index 488638c9..62897f3c 100644
--- a/docs/BOOT.sdcard
+++ b/docs/BOOT.sdcard
@@ -28,7 +28,7 @@ Use an SD card with partition one in FAT16 format.
Copy the following to the SD card partition one:
* Kernel: uImage
- * Root FS: core-image-minimal-<machine name>.ext2.gz.u-boot
+ * Root FS: core-image-minimal-<machine name>.cpio.gz.u-boot
* Devicetree: uImage-<machine name>.dtb
Also create the file "uEnv.txt" on the SD card parition one, with the following
@@ -38,7 +38,7 @@ correct name for you machine/system.
kernel_image=uImage
devicetree_image=uImage-<machine name>.dtb
- ramdisk_image=core-image-minimal-<machine name>.ext2.gz.u-boot
+ ramdisk_image=core-image-minimal-<machine name>.cpio.gz.u-boot
Alternatively you can use the default names for the images, rename them
according to below and copy them onto partition one. Doing this removes the need
@@ -54,7 +54,7 @@ board. (Ensure the board is configured via the MIO's for SD Boot).
Booting the Kernel (with mmcblk/SD card rootfs)
-----------------------------------------------
Use an SD card with partition one in FAT16 format, and an additional partition
-for the root filesystem (formatted as EXT2).
+for the root filesystem (formatted as EXT2/3/4).
Copy the following to the SD card partition one:
* Kernel: uImage
diff --git a/docs/BOOT.tftp b/docs/BOOT.tftp
index 17d7e3a4..de3a70ad 100644
--- a/docs/BOOT.tftp
+++ b/docs/BOOT.tftp
@@ -7,7 +7,7 @@ Note: This boot flow requires a TFTP server.
Boot your system into U-Boot, using an alternative boot method (e.g. JTAG, SD).
Place the following images into the root of the TFTP server directory:
- * core-image-minimal-<machine name>.ext2.gz.u-boot (RootFS)
+ * core-image-minimal-<machine name>.cpio.gz.u-boot (RootFS)
* linux.bin.ub or uImage (Linux Kernel)
* <kernel binary>-<machine name>.dtb (DTB)
diff --git a/docs/Rootfs b/docs/Rootfs
new file mode 100644
index 00000000..656b4b36
--- /dev/null
+++ b/docs/Rootfs
@@ -0,0 +1,11 @@
+
+Configuring Additional RootFS Output Images
+===========================================
+
+To configure the build or the machine to output additional rootfs image types
+the IMAGE_FSTYPES variable can be overridden or appended to.
+
+e.g. Add ext2 and ext2.gz.u-boot image types to the local.conf
+
+ IMAGE_FSTYPES += "ext2 ext2.gz.u-boot"
+
diff --git a/docs/Toolchain b/docs/Toolchain
new file mode 100644
index 00000000..7e8d313b
--- /dev/null
+++ b/docs/Toolchain
@@ -0,0 +1,15 @@
+
+Configuring External Toolchain
+==============================
+
+In order to build with an external toolchain some additional configuration must
+be set in the build environments local.conf. First configure the use of an
+external toolchain, including the location to the toolchain:
+
+ TCMODE = "external-xilinx"
+ EXTERNAL_TOOLCHAIN = "<path to toolchain>"
+
+WARNING: There is a known issue with the MicroBlaze Linux toolchain provided by
+XSDK 2013.3 where certain shift instructions are not generated correctly, avoid
+using this toolchain. Use the newer XSDK 2013.4 or PetaLinux 2013.10 toolchains.
+