diff options
author | Nathan Rossi <nathan.rossi@xilinx.com> | 2014-11-28 13:57:23 +1000 |
---|---|---|
committer | Nathan Rossi <nathan.rossi@xilinx.com> | 2014-12-03 17:45:43 +1000 |
commit | ff7609762e100824abcb2faf518c346d07e1a815 (patch) | |
tree | d633c4da03e501447e535f92566fc761b7342bac | |
parent | 4d6683a504e3aefba33774567aa633620d440736 (diff) | |
download | meta-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-- | MAINTAINERS | 10 | ||||
-rw-r--r-- | README | 54 | ||||
-rw-r--r-- | docs/BOOT.sdcard | 6 | ||||
-rw-r--r-- | docs/BOOT.tftp | 2 | ||||
-rw-r--r-- | docs/Rootfs | 11 | ||||
-rw-r--r-- | docs/Toolchain | 15 |
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 @@ | |||
1 | This file contains a list of BSP maintainers for the BSPs contained in | ||
2 | the meta-xilinx repository. | ||
3 | |||
4 | Patches for this layer should be sent to meta-xilinx@lists.yoctoproject.org. | ||
5 | See meta-xilinx/README for more details. | ||
6 | |||
7 | Maintainers List | ||
8 | |||
9 | Nathan Rossi<nathan.rossi@xilinx.com> | ||
10 | Sipke Vriend<sipke.vriend@xilinx.com> | ||
@@ -11,17 +11,23 @@ Boards Supported by this layer (Please refer to the associate .conf for more | |||
11 | information): | 11 | information): |
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 | ||
16 | Additional information on the MicroBlaze or Zynq architectures can be found at: | 17 | Additional 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 | ||
19 | Patches | 20 | Maintainers, Patches/Submissions, Community |
20 | ======= | 21 | =========================================== |
21 | 22 | ||
22 | Please submit any patches for this layer to: meta-xilinx@lists.yoctoproject.org. | 23 | Please send any patches, pull requests, comments or questions for this layer to: |
23 | 24 | ||
24 | Please see the MAINTAINERS file for more details. | 25 | meta-xilinx@lists.yoctoproject.org |
26 | |||
27 | Maintainers: | ||
28 | |||
29 | Nathan Rossi <nathan.rossi@xilinx.com> | ||
30 | Sipke Vriend <sipke.vriend@xilinx.com> | ||
25 | 31 | ||
26 | Dependencies | 32 | Dependencies |
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 | ||
57 | Build additional targets, including U-Boot: | ||
58 | |||
59 | $ bitbake u-boot-xlnx | ||
60 | |||
61 | Once complete the images for the target machine will be available in the output | 63 | Once complete the images for the target machine will be available in the output |
62 | directory 'tmp/deploy/images'. | 64 | directory 'tmp/deploy/images'. |
63 | 65 | ||
64 | Images generated: | 66 | Additional 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) | 69 | Additional 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 | |||
76 | Booting | ||
77 | ======= | ||
78 | |||
79 | Please see the associated README file for each avaliable boot method in the | ||
80 | 'docs/BOOT.*' files of this layer. | ||
81 | |||
82 | Configuring External Toolchain | ||
83 | ============================== | ||
84 | |||
85 | In order to build with an external toolchain some additional configuration must | ||
86 | be set in the build environments local.conf. First configure the use of an | ||
87 | external toolchain, including the location to the toolchain: | ||
88 | |||
89 | TCMODE = "external-xilinx" | ||
90 | EXTERNAL_TOOLCHAIN = "<path to toolchain>" | ||
91 | |||
92 | WARNING: There is a known issue with the MicroBlaze Linux toolchain provided by | ||
93 | XSDK 2013.3 where certain shift instructions are not generated correctly, avoid | ||
94 | using 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 | ||
29 | Copy the following to the SD card partition one: | 29 | Copy 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 | ||
34 | Also create the file "uEnv.txt" on the SD card parition one, with the following | 34 | 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. | |||
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 | ||
43 | Alternatively you can use the default names for the images, rename them | 43 | Alternatively you can use the default names for the images, rename them |
44 | according to below and copy them onto partition one. Doing this removes the need | 44 | 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). | |||
54 | Booting the Kernel (with mmcblk/SD card rootfs) | 54 | Booting the Kernel (with mmcblk/SD card rootfs) |
55 | ----------------------------------------------- | 55 | ----------------------------------------------- |
56 | Use an SD card with partition one in FAT16 format, and an additional partition | 56 | Use an SD card with partition one in FAT16 format, and an additional partition |
57 | for the root filesystem (formatted as EXT2). | 57 | for the root filesystem (formatted as EXT2/3/4). |
58 | 58 | ||
59 | Copy the following to the SD card partition one: | 59 | Copy 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. | |||
7 | Boot your system into U-Boot, using an alternative boot method (e.g. JTAG, SD). | 7 | Boot your system into U-Boot, using an alternative boot method (e.g. JTAG, SD). |
8 | 8 | ||
9 | Place the following images into the root of the TFTP server directory: | 9 | Place 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 | |||
2 | Configuring Additional RootFS Output Images | ||
3 | =========================================== | ||
4 | |||
5 | To configure the build or the machine to output additional rootfs image types | ||
6 | the IMAGE_FSTYPES variable can be overridden or appended to. | ||
7 | |||
8 | e.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 | |||
2 | Configuring External Toolchain | ||
3 | ============================== | ||
4 | |||
5 | In order to build with an external toolchain some additional configuration must | ||
6 | be set in the build environments local.conf. First configure the use of an | ||
7 | external toolchain, including the location to the toolchain: | ||
8 | |||
9 | TCMODE = "external-xilinx" | ||
10 | EXTERNAL_TOOLCHAIN = "<path to toolchain>" | ||
11 | |||
12 | WARNING: There is a known issue with the MicroBlaze Linux toolchain provided by | ||
13 | XSDK 2013.3 where certain shift instructions are not generated correctly, avoid | ||
14 | using this toolchain. Use the newer XSDK 2013.4 or PetaLinux 2013.10 toolchains. | ||
15 | |||