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 /docs | |
| 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>
Diffstat (limited to 'docs')
| -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 |
4 files changed, 30 insertions, 4 deletions
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 | |||
