summaryrefslogtreecommitdiffstats
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
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 @@
1This file contains a list of BSP maintainers for the BSPs contained in
2the meta-xilinx repository.
3
4Patches for this layer should be sent to meta-xilinx@lists.yoctoproject.org.
5See meta-xilinx/README for more details.
6
7Maintainers List
8
9Nathan Rossi<nathan.rossi@xilinx.com>
10Sipke 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
11information): 11information):
12 * Xilinx KC705 Embedded TRD (MicroBlaze) 12 * Xilinx KC705 Embedded TRD (MicroBlaze)
13 * Xilinx ZC702 (Zynq) 13 * Xilinx ZC702 (Zynq)
14 * Xilinx ZC706 (Zynq)
14 * Avnet/Digilent ZedBoard (Zynq) 15 * Avnet/Digilent ZedBoard (Zynq)
15 16
16Additional information on the MicroBlaze or Zynq architectures can be found at: 17Additional information on the MicroBlaze or Zynq architectures can be found at:
17 http://www.xilinx.com/support/index.htm 18 http://www.xilinx.com/support/index.htm
18 19
19Patches 20Maintainers, Patches/Submissions, Community
20======= 21===========================================
21 22
22Please submit any patches for this layer to: meta-xilinx@lists.yoctoproject.org. 23Please send any patches, pull requests, comments or questions for this layer to:
23 24
24Please see the MAINTAINERS file for more details. 25 meta-xilinx@lists.yoctoproject.org
26
27Maintainers:
28
29 Nathan Rossi <nathan.rossi@xilinx.com>
30 Sipke Vriend <sipke.vriend@xilinx.com>
25 31
26Dependencies 32Dependencies
27============ 33============
@@ -54,41 +60,11 @@ Build the target file system image using bitbake:
54 60
55 $ bitbake core-image-minimal 61 $ bitbake core-image-minimal
56 62
57Build additional targets, including U-Boot:
58
59 $ bitbake u-boot-xlnx
60
61Once complete the images for the target machine will be available in the output 63Once complete the images for the target machine will be available in the output
62directory 'tmp/deploy/images'. 64directory 'tmp/deploy/images'.
63 65
64Images generated: 66Additional Documentation
65 * core-image-minimal-<machine name>.tar.gz (rootfs tar+GZIP) 67========================
66 * core-image-minimal-<machine name>.cpio (rootfs in CPIO format) 68
67 * core-image-minimal-<machine name>.ext2.gz.u-boot (rootfs in EXT2+GZIP, u-boot wrapped format) 69Additional documentation can be found in the 'docs/*' directory of this layer.
68 * u-boot.elf (U-Boot ELF) 70
69 * For Zynq:
70 * uImage (Linux Kernel binary, in u-boot wrapped format)
71 * uImage-<machine name>.dtb (DTB for target machine)
72 * For MicroBlaze:
73 * linux.bin.ub (Linux Kernel binary, in u-boot wrapped format)
74 * linux.bin.ub-<machine name>.dtb (DTB for target machine)
75
76Booting
77=======
78
79Please see the associated README file for each avaliable boot method in the
80'docs/BOOT.*' files of this layer.
81
82Configuring External Toolchain
83==============================
84
85In order to build with an external toolchain some additional configuration must
86be set in the build environments local.conf. First configure the use of an
87external toolchain, including the location to the toolchain:
88
89 TCMODE = "external-xilinx"
90 EXTERNAL_TOOLCHAIN = "<path to toolchain>"
91
92WARNING: There is a known issue with the MicroBlaze Linux toolchain provided by
93XSDK 2013.3 where certain shift instructions are not generated correctly, avoid
94using this toolchain. Use the newer XSDK 2013.4 or PetaLinux 2013.10 toolchains.
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.
28 28
29Copy the following to the SD card partition one: 29Copy the following to the SD card partition one:
30 * Kernel: uImage 30 * Kernel: uImage
31 * Root FS: core-image-minimal-<machine name>.ext2.gz.u-boot 31 * Root FS: core-image-minimal-<machine name>.cpio.gz.u-boot
32 * Devicetree: uImage-<machine name>.dtb 32 * Devicetree: uImage-<machine name>.dtb
33 33
34Also create the file "uEnv.txt" on the SD card parition one, with the following 34Also create the file "uEnv.txt" on the SD card parition one, with the following
@@ -38,7 +38,7 @@ correct name for you machine/system.
38 38
39 kernel_image=uImage 39 kernel_image=uImage
40 devicetree_image=uImage-<machine name>.dtb 40 devicetree_image=uImage-<machine name>.dtb
41 ramdisk_image=core-image-minimal-<machine name>.ext2.gz.u-boot 41 ramdisk_image=core-image-minimal-<machine name>.cpio.gz.u-boot
42 42
43Alternatively you can use the default names for the images, rename them 43Alternatively you can use the default names for the images, rename them
44according to below and copy them onto partition one. Doing this removes the need 44according 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).
54Booting the Kernel (with mmcblk/SD card rootfs) 54Booting the Kernel (with mmcblk/SD card rootfs)
55----------------------------------------------- 55-----------------------------------------------
56Use an SD card with partition one in FAT16 format, and an additional partition 56Use an SD card with partition one in FAT16 format, and an additional partition
57for the root filesystem (formatted as EXT2). 57for the root filesystem (formatted as EXT2/3/4).
58 58
59Copy the following to the SD card partition one: 59Copy the following to the SD card partition one:
60 * Kernel: uImage 60 * 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.
7Boot your system into U-Boot, using an alternative boot method (e.g. JTAG, SD). 7Boot your system into U-Boot, using an alternative boot method (e.g. JTAG, SD).
8 8
9Place the following images into the root of the TFTP server directory: 9Place the following images into the root of the TFTP server directory:
10 * core-image-minimal-<machine name>.ext2.gz.u-boot (RootFS) 10 * core-image-minimal-<machine name>.cpio.gz.u-boot (RootFS)
11 * linux.bin.ub or uImage (Linux Kernel) 11 * linux.bin.ub or uImage (Linux Kernel)
12 * <kernel binary>-<machine name>.dtb (DTB) 12 * <kernel binary>-<machine name>.dtb (DTB)
13 13
diff --git a/docs/Rootfs b/docs/Rootfs
new file mode 100644
index 00000000..656b4b36
--- /dev/null
+++ b/docs/Rootfs
@@ -0,0 +1,11 @@
1
2Configuring Additional RootFS Output Images
3===========================================
4
5To configure the build or the machine to output additional rootfs image types
6the IMAGE_FSTYPES variable can be overridden or appended to.
7
8e.g. Add ext2 and ext2.gz.u-boot image types to the local.conf
9
10 IMAGE_FSTYPES += "ext2 ext2.gz.u-boot"
11
diff --git a/docs/Toolchain b/docs/Toolchain
new file mode 100644
index 00000000..7e8d313b
--- /dev/null
+++ b/docs/Toolchain
@@ -0,0 +1,15 @@
1
2Configuring External Toolchain
3==============================
4
5In order to build with an external toolchain some additional configuration must
6be set in the build environments local.conf. First configure the use of an
7external toolchain, including the location to the toolchain:
8
9 TCMODE = "external-xilinx"
10 EXTERNAL_TOOLCHAIN = "<path to toolchain>"
11
12WARNING: There is a known issue with the MicroBlaze Linux toolchain provided by
13XSDK 2013.3 where certain shift instructions are not generated correctly, avoid
14using this toolchain. Use the newer XSDK 2013.4 or PetaLinux 2013.10 toolchains.
15