openembedded: provide release notes for RB5 platform

Change-Id: Ifcf7cf37792ce59ce99c07dd08ae94508158a248
Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>

4 files changed, 144 insertions, 0 deletions

diff --git a/Makefile b/Makefile
index 1ae2921..b78a6cd 100644
--- a/Makefile
+++ b/Makefile
@@ -5,6 +5,7 @@ include debian/boards/dragonboard410c/Makefile
 include debian/boards/dragonboard845c/Makefile
 include openembedded/boards/dragonboard410c/Makefile
 include openembedded/boards/dragonboard845c/Makefile
+include openembedded/boards/rb5/Makefile
 
 HTML=$(subst .textile,.html,$(TEXTILE))
 
diff --git a/openembedded/boards/rb5/Makefile b/openembedded/boards/rb5/Makefile
new file mode 100644
index 0000000..28f3264
--- /dev/null
+++ b/openembedded/boards/rb5/Makefile
@@ -0,0 +1,2 @@
+DIR:=$(dir $(lastword $(MAKEFILE_LIST)))
+TEXTILE+= $(DIR)README.textile
diff --git a/openembedded/boards/rb5/README.textile.in b/openembedded/boards/rb5/README.textile.in
new file mode 100644
index 0000000..576b9b3
--- /dev/null
+++ b/openembedded/boards/rb5/README.textile.in
@@ -0,0 +1,134 @@
+The Linaro Qualcomm Landing Team is pleased to announce the new release of the _Linaro OpenEmbedded RPB release for Qualcomm(tm) Robotics RB5 platform_. The Linaro OpenEmbedded RPB release ##RELEASE## is based on OpenEmbedded and provides developers with a reference set of images including Xorg, Wayland/Weston as well as console only configurations.
+
+h4. What's new in this release
+
+This is the first release for RB5 platform.
+
+###. * MESA upgrade to ##MESA_VERSION##.
+
+h4. Important note(s) about this release
+
+None
+
+h4. Features
+
+The Linaro OpenEmbedde RPB version ##RELEASE## for the Robotics RB5 platform supports the following features:
+
+* It is based on the OpenEmbedded / Yocto Project release ##OS_REL## (aka ##OS_REL_NICK##).
+* It is based on Linux kernel ##KERNEL_VER##.
+* It is based on proprietary firmware pre-flashed by the board manufacturer, Thundercomm. Updated firmware is not yet released.
+* The following reference images are released:
+** @boot@ image that includes prebuilt kernel and initrd
+** @rpb-console-image@ image that includes core packages as well as typical development packages (headless)
+* All images are configured with a password less root account.
+* All images exist in two variants. The regular image, and a @-test@ image , which includes additional packages typically useful for test and validation.
+* The root file system should be flashed in the onboard UFS.
+* The following features are supported on the Robotics RB5 platform:
+** QRB5165 8x Kryo 585 CPU, up to 2.84 GHz
+** PSCI with support for cpuidle, SMP, hotplug and restart.
+** HDMI display
+** UART, SD, UFS
+** USB 3.0 (Mouse, Keyboard, Storage, Ethernet)
+
+h4. Information about the Robotics RB5
+
+For more information about the DragonBoard 845c, please check the following website and wiki:
+* "https://www.qualcomm.com/products/qualcomm-robotics-rb5-platform":https://www.qualcomm.com/products/qualcomm-robotics-rb5-platform
+* "https://www.96boards.org/documentation/consumer":https://www.96boards.org/documentation/consumer
+* "https://developer.qualcomm.com/qualcomm-robotics-rb5-kit":https://developer.qualcomm.com/qualcomm-robotics-rb5-kit
+* "https://www.thundercomm.com/app_en/product/1590131656070623":https://www.thundercomm.com/app_en/product/1590131656070623
+
+h4. How to install and use this release
+
+h5. Download and preparation
+
+Before starting download necessary files. This should include:
+* boot image: boot-qrb5165-rb5.img
+* One of rootfs images:
+** rpb-console-image-qrb5165-rb5.rootfs.ext4.gz
+** rpb-console-image-test-qrb5165-rb5.rootfs.ext4.gz
+
+Gunzip downloaded files.
+
+Make sure that you have fastboot tool installed. It can be either a part of "android-tools" package (Fedora, old Debian/Ubuntu) or a separate package ("android-tools-fastboot" or just "fastboot", contemporary Debian/Ubuntu).
+
+Connect host computer to RB5. It must be powered off (unplugged from power)
+BOOT_CONFIG DIP switch on RB5 must be set to ‘0-0-0-0’. All switches should be in “off” position
+
+h5. Boot RB5 into fastboot mode.
+
+* Hold down the "VOL-" button when connecting power supply.
+* Tap the "ON/OFF" button  while continuing to hold the “VOL-“ button for ~5 seconds after the blue LED lights up.
+* Release “VOL-“ button
+* Connect the USB3 Type C (5) between the Linux PC and the board
+
+Board should boot into fastboot mode.
+
+Check to make sure device is connected and in fastboot mode
+
+bc. $ sudo fastboot devices
+
+Typically it will show as below
+
+bc. de82318	fastboot
+
+h4. Proprietary firmware
+
+This release does not contain proprietary firmware. It uses firmware provided by the board manufacturer. Updating firmare is not yet supported. Please be sure to use latest firmware provided by Thundercomm.
+
+h4. Linaro OpenEmbedded RPB
+
+Linaro OpenEmbedded Reference Platform Build (RPB) is a reference implementation of an OpenEmbedded based distribution developed by Linaro. It provides examples and guidelines for users to create their own distribution based on OpenEmbedded. The reference images included in this release can be used to demonstrate and validate any of the use case that the Robotics RB5 can support. The current release is based on the OpenEmbedded Core ##OS_REL_NICK## release branch.
+
+The following reference distributions are provided by the Linaro OpenEmbedded RPB project:
+* @rpb@ is a reference OE distro that is based on Xorg graphics stack
+
+For more information about Linaro OpenEmbedded RPB, please check this "document":https://github.com/96boards/oe-rpb-manifest/blob/qcom/##OS_REL_NICK##/README.md.
+
+h4. Flashing the prebuilt images
+
+To flash the boot image, from the host PC, run the following command:
+
+bc. fastboot flash boot <boot image file>
+
+To flash the root file system image, download the image file with the extension @.img.gz@ and run:
+
+bc. $ gunzip rpb-XXX-image.rootfs.img.gz
+$ fastboot flash userdata rpb-XXX-image.rootfs.img
+
+substituting XXX with the type of the image you have selected.
+
+h5. Running the @rpb-console-image@
+
+If you have flashed the console image, when booting the board you will end up in a login prompt on the serial console. If you have an HDMI monitor connected, you will also have login terminals on the display.
+
+h4. Building from sources
+
+The boot image and the root file system are completely built from sources, using OpenEmbedded build system. It is recommended to setup the build environment using the "following instructions":https://github.com/96boards/oe-rpb-manifest/blob/qcom/##OS_REL_NICK##/README.md. For Qualcomm Robotics RB5 platform @qrb5165-rb5@ is to be used as @MACHINE@. For example you can use following commands:
+
+bc. $ MACHINE=qrb5165-rb5 DISTRO=rpb . setup-environment
+$ bitbake rpb-console-image
+
+For more information about OpenEmbedded and the Yocto project please refer to the "Yocto Project Documentation":http://www.yoctoproject.org/docs/##OS_REL##/mega-manual/mega-manual.html.
+
+h4. How to get and customize the kernel source code
+
+To rebuild the kernel you can use the OpenEmbedded workflow and update the kernel recipe, located in the build environment in @./layers/meta-qcom/recipes-kernel/linux/linux-linaro-qcomlt_##KERNEL_RECIPE_VER##.bb@. To rebuild a boot image that includes your kernel changes, you can run the following @bitbake@ command:
+
+bc. $ bitbake virtual/kernel
+
+Assuming the build went fine, the new boot image will be located in the build folder, as @tmp-rpb-glibc/deploy/images/qrb5165-rb5/boot-qrb5165-rb5.img@. You can run the following @fastboot@ command to boot it on the board:
+
+bc. $ fastboot boot boot-qrb5165-rb5.img
+
+If you want to permanently use a custom kernel image, you can update the boot image and reflash it into the @boot@ partition:
+
+bc. $ fastboot flash boot boot-qrb5165-rb5.img
+
+h4. How to contribute
+
+We very much encourage developers to use and contribute to our releases, using the "following instructions":https://www.96boards.org/documentation/consumer/dragonboard/guides/contribute/.
+
+<hr>
+
+__Qualcomm Snapdragon and Qualcomm Robotics RB5 are products of Qualcomm Technologies, Inc.__
diff --git a/openembedded/boards/rb5/README.textile.vars b/openembedded/boards/rb5/README.textile.vars
new file mode 100644
index 0000000..0b0c2e5
--- /dev/null
+++ b/openembedded/boards/rb5/README.textile.vars
@@ -0,0 +1,7 @@
+export RELEASE="20.012"
+export RESCUE_RELEASE="20.07"
+export OS_REL="3.1.2"
+export KERNEL_VER="5.9-rc8"
+export KERNEL_RECIPE_VER="5.9"
+export OS_REL_NICK="dunfell"
+export MESA_VERSION="20.0.2"