aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArsalan H. Awan <Arsalan_Awan@mentor.com>2019-09-17 18:10:44 +0500
committerArsalan H. Awan <Arsalan_Awan@mentor.com>2019-09-30 18:21:07 +0500
commit011cdaef104a1f150a44ed9f42731a9f831a3224 (patch)
tree38a83e0e2bdc3a15fe0bff1de64352877743d542
parentc7d07d81f47f7038e843e57a478ebc62aa77501c (diff)
downloadmeta-amd-011cdaef104a1f150a44ed9f42731a9f831a3224.tar.gz
meta-amd-011cdaef104a1f150a44ed9f42731a9f831a3224.tar.bz2
meta-amd-011cdaef104a1f150a44ed9f42731a9f831a3224.zip
docs: fix SETUP.md & add FEATURES.md, DOCUMENTATION.md & RELEASE.md
This makes the SETUP.md more understandable for the users by splitting the commands into sub steps and explaining what each step does. This also adds the following files: * FEATURES.md - enlists all the supported features by each BSP * DOCUMENTATION.md - enlists links to official docs of various features * RELEASE.md - enlists release notes for BSPs containing layer commit hashes, software vers, fixed/known issues Signed-off-by: Arsalan H. Awan <Arsalan_Awan@mentor.com>
-rw-r--r--BUILD.md2
-rw-r--r--DOCUMENTATION.md14
-rw-r--r--FEATURES.md105
-rw-r--r--README.md13
-rw-r--r--RELEASE.md47
-rw-r--r--SETUP.md54
6 files changed, 217 insertions, 18 deletions
diff --git a/BUILD.md b/BUILD.md
index 0c9ce2e0..a2254ea7 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -50,7 +50,7 @@ Build one of the supported image recipes:
bitbake <image-name> -k
```
-###### where `<image-name>` is to be replaced with one of the supported images for the selected AMD BSP.
+###### where `<image-name>` is to be replaced with one of the [supported images](FEATURES.md) for the selected AMD BSP.
###### (e.g. `core-image-sato` or `core-image-base`)
---
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
new file mode 100644
index 00000000..37752746
--- /dev/null
+++ b/DOCUMENTATION.md
@@ -0,0 +1,14 @@
+# Documentation
+
+This document lists the links to official documentation of various
+features and a general guide to Yocto Project and it's build system.
+
+| Feature | Documentation | Comments |
+|:-------------------------------------------|:------------------------------------------------------------------------------------|:-----------------------------------------------------------------|
+| Yocto Project Overview and Concepts Manual | https://www.yoctoproject.org/docs/2.7/overview-manual/overview-manual | |
+| Yocto Project Quick Build | https://www.yoctoproject.org/docs/2.7/brief-yoctoprojectqs/brief-yoctoprojectqs.htm | |
+| KGDB | https://www.kernel.org/doc/html/v4.19/dev-tools/kgdb.html | |
+| LTTng | https://lttng.org/docs/v2.10 | |
+| Toaster | https://www.yoctoproject.org/docs/2.7/toaster-manual/toaster-manual.html | |
+| SDK | https://www.yoctoproject.org/docs/2.7/sdk-manual/sdk-manual.html | |
+| RGP | https://github.com/GPUOpen-Tools/Radeon-GPUProfiler/releases/tag/v1.5.1 | Follow the docs contained in the .tgz file attached on this link |
diff --git a/FEATURES.md b/FEATURES.md
new file mode 100644
index 00000000..6800c74e
--- /dev/null
+++ b/FEATURES.md
@@ -0,0 +1,105 @@
+# Features
+
+This document lists the features supported for the AMD BSPs. In each
+BSP column, a "Y" represents that the feature in this row is supported
+for this BSP.
+
+| Category | Feature | R1000 |
+|:--------------------------------|:----------------------------------------|:-----:|
+| Images | | |
+| | core-image-sato | Y |
+| | core-image-base | |
+| Images Types | | |
+| | WIC | Y |
+| | ISO | Y |
+| Board Devices | | |
+| | Ethernet | Y |
+| | USB 2.0 Host | Y |
+| | USB 3.0 Host (MSC) | Y |
+| | USB 3.1 Host | Y |
+| | M.2 SATA | Y |
+| | I2C | Y |
+| | UART | Y |
+| | eMMC | Y |
+| | SMP | Y |
+| | SPI | Y |
+| I/O | | |
+| | USB Host | Y |
+| | USB Mass Storage | Y |
+| | Audio | Y |
+| | Ethernet | Y |
+| | UART | Y |
+| | Bluetooth | Y |
+| | Wi-Fi | Y |
+| | HDD/SATA | Y |
+| | SGMII | Y |
+| | RGMII | Y |
+| | SD/MMC | Y |
+| General Purpose Kernel Features | | |
+| | Control Groups | Y |
+| | CPU Hot Plugging | Y |
+| | High Resolution Timers (HRT) | Y |
+| | POSIX Message Quese & Semaphores | Y |
+| | Prioritized OOM Killer | Y |
+| | Symmetric Multi-Processing (SMP) | Y |
+| | Native POSIX Thread Library | Y |
+| Kernel Preemption | | |
+| | Preemptive Kernel (Low-Latency Desktop) | Y |
+| | Fully Preemptible Kernel (RT) | |
+| Filesystems | | |
+| | Devtmpfs | Y |
+| | EXT2 | Y |
+| | EXT3 | Y |
+| | EXT4 | Y |
+| | FAT | Y |
+| | NFSv3 | Y |
+| | ProcFS | Y |
+| | RamFS | Y |
+| | SysFS | Y |
+| | tmpfs | Y |
+| HID (Input Devices) | | |
+| | Input Core (CONFIG_INPUT) | Y |
+| | Mouse Interface | Y |
+| | Keyboards | Y |
+| | Touchscreen | Y |
+| Display Device Support | | |
+| | DP | Y |
+| | HDMI | Y |
+| Network Protocols | | |
+| | IPv4 | Y |
+| | IPv6 | Y |
+| Kernel Debug/Trace | | |
+| | KGDB | Y |
+| | LTTng - Kernel Tracing | Y |
+| | LTTng - Userspace Tracing | Y |
+| USB Protocols | | |
+| | USB 2.0 | Y |
+| | USB 3.0 | Y |
+| | USB 3.1 | Y |
+| | USB HS | Y |
+| Sound Support | | |
+| | ALSA | Y |
+| Multimedia Support | | |
+| | Accelerated gstreamer | Y |
+| | Unaccelerated gstreamer | Y |
+| | OMX | Y |
+| | VDPAU | Y |
+| | VAAPI | Y |
+| | mesa (accelerated graphics) | Y |
+| | unaccelerated graphics | Y |
+| | Vulkan | Y |
+| | multi-display | Y |
+| | CodeXL | |
+| | RGP | Y |
+| | MP4 | Y |
+| | MPEG2 | Y |
+| | MPEG4 | Y |
+| | VC-1 | Y |
+| | H.264 | Y |
+| | H.265 | Y |
+| | ROCm-OpenCL | |
+| Network Security | | |
+| | IPSEC (strongswan) | |
+| | DPDK | |
+| Kernel Virtualization | | |
+| | KVM | |
diff --git a/README.md b/README.md
index 5ae0a8a7..f10a78de 100644
--- a/README.md
+++ b/README.md
@@ -29,12 +29,19 @@ a built image onto a USB/CD/DVD and boot the target machine with it.
#### What's next
-You can also customize the images according to your requirement.
-
-Please see [CUSTOMIZE.md](CUSTOMIZE.md) for instructions on how to
+* Please see [CUSTOMIZE.md](CUSTOMIZE.md) for instructions on how to
customize the build and to enable/disable any of the supported features
and software components to be included into the build.
+* Please see [FEATURES.md](FEATURES.md) for a list of currently
+supported features against each BSP.
+
+* Please see [DOCUMENTATION.md](DOCUMENTATION.md) for links to official
+documentation of various supported features and a general guide of the
+Yocto Project.
+
+* Please see [RELEASE.md](RELEASE.md) for release notes.
+
## Troubleshoot
If you have problems with or questions about a particular BSP, please
diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 00000000..78c66ada
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,47 @@
+# Release notes
+
+This is the release notes document for the AMD BSP. This document
+contains information about the yocto layers' git repos, their branches
+and commit hashes, software versions, and known/fixed issues.
+
+## Layers
+| Layer | Git Repo | Branch | Commit Hash |
+|:------------------|:---------------------------------------------|:--------|:-----------------------------------------|
+| poky | git://git.yoctoproject.org/poky | warrior | 6d2e12e79211b31cdf5ea824fb9a8be54ba9a9eb |
+| meta-openembedded | git://git.openembedded.org/meta-openembedded | warrior | 3bdbf72e3a4bf18a4a2c7afbde4f7ab773aeded9 |
+| meta-dpdk | git://git.yoctoproject.org/meta-dpdk | warrior | c8c30c2c4e2f36b4a55a69a475fe774015423705 |
+
+## Softwares
+| Software | Version |
+|:---------------|:-------------|
+| BIOS | RBB1201B |
+| linux-yocto | 4.19.8 |
+| gcc | 8.3.0 |
+| util-linux | 2.32.1 |
+| grub | 2.02 |
+| pulseaudio | 12.2 |
+| xf86-video-amd | 19.0.1 |
+| xserver | 1.20.4 |
+| mesa | 19.2.0-devel |
+| libdrm | 2.4.99 |
+| llvm | 9.0.0 |
+| vulkan | 1.1.92.1 |
+| libomxil | 0.9.3 |
+| libva | 2.4.0 |
+| libvdpau | 1.1.1 |
+| gstreamer | 1.14.4 |
+| mpv | 0.28.2 |
+| ffmpeg | 4.0.2 |
+| lttng | 2.10 |
+| babeltrace | 1.5.6 |
+| connman | 1.36 |
+| gdb | 8.2.1 |
+| rgp | 1.5.1 |
+
+## Fixed Issues
+| None |
+|:-----|
+
+## Known Issues
+| None |
+|:-----|
diff --git a/SETUP.md b/SETUP.md
index 17b14b01..1ad7201c 100644
--- a/SETUP.md
+++ b/SETUP.md
@@ -1,25 +1,51 @@
# 1. Setting up the build system
+Building images for AMD BSPs requires setting up the Yocto Project
+Build System. Please follow the guidelines on
+[Yocto Project Overview and Concepts Manual](https://www.yoctoproject.org/docs/2.7/overview-manual/overview-manual.html)
+and [Yocto Project Quick Build](https://www.yoctoproject.org/docs/2.7/brief-yoctoprojectqs/brief-yoctoprojectqs.html)
+if you are not familiar with the Yocto Project and it's Build System.
+
Running the following commands will setup the build system and will
-enable us to build recipes & images for any of the supported AMD BSPs:
+enable us to build recipes & images for any of the
+[supported AMD BSPs](meta-amd-bsp/README.md).
-```sh
-gitclonecheckout() {
- REPO="$1"; NAME="$2"; HASH="$3"
+### 1.1 Prerequisites
+
+Install the build system's dependencies
+```
+sudo apt install -y gawk wget git-core diffstat unzip texinfo \
+ gcc-multilib build-essential chrpath socat cpio python python3 \
+ python3-pip python3-pexpect xz-utils debianutils iputils-ping \
+ python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev xterm
+```
- git clone --single-branch --branch "${YOCTO_BRANCH}" "${REPO}" "${NAME}"
- cd "${NAME}"
- git checkout --quiet "${HASH}"
- cd ..
-}
+### 1.2 Download the build system and the meta-data layers
+Select the Yocto Project branch:
+```sh
YOCTO_BRANCH="warrior"
+```
-gitclonecheckout "git://git.yoctoproject.org/poky" "poky-amd" "6d2e12e79211b31cdf5ea824fb9a8be54ba9a9eb"
-cd "poky-amd"
-gitclonecheckout "git://git.openembedded.org/meta-openembedded" "meta-openembedded" "3bdbf72e3a4bf18a4a2c7afbde4f7ab773aeded9"
-gitclonecheckout "git://git.yoctoproject.org/meta-amd" "meta-amd" "HEAD"
-gitclonecheckout "git://git.yoctoproject.org/meta-dpdk" "meta-dpdk" "c8c30c2c4e2f36b4a55a69a475fe774015423705"
+Clone the git repositories:
+```sh
+git clone --single-branch --branch "${YOCTO_BRANCH}" "git://git.yoctoproject.org/poky" "poky-amd"
+cd poky-amd
+git clone --single-branch --branch "${YOCTO_BRANCH}" "git://git.openembedded.org/meta-openembedded"
+git clone --single-branch --branch "${YOCTO_BRANCH}" "git://git.yoctoproject.org/meta-dpdk"
+git clone --single-branch --branch "${YOCTO_BRANCH}" "git://git.yoctoproject.org/meta-amd"
+```
+
+Checkout commit hashes:
+```sh
+git checkout --quiet 6d2e12e79211b31cdf5ea824fb9a8be54ba9a9eb
+cd meta-openembedded
+git checkout --quiet 3bdbf72e3a4bf18a4a2c7afbde4f7ab773aeded9
+cd ../meta-dpdk
+git checkout --quiet c8c30c2c4e2f36b4a55a69a475fe774015423705
+cd ../meta-amd
+git checkout --quiet HEAD
+cd ..
```
---