openembedded: db410c: first release notes for 17.06

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>

4 files changed, 195 insertions, 0 deletions

diff --git a/Makefile b/Makefile
index f253790..9959ace 100644
--- a/Makefile
+++ b/Makefile
@@ -2,6 +2,7 @@
 TEXTILE:=
 include debian/boards/snapdragon/Makefile
 include debian/boards/dragonboard410c/Makefile
+include openembedded/boards/dragonboard410c/Makefile
 
 HTML=$(subst .textile,.html,$(TEXTILE))
 
diff --git a/openembedded/boards/dragonboard410c/Makefile b/openembedded/boards/dragonboard410c/Makefile
new file mode 100644
index 0000000..28f3264
--- /dev/null
+++ b/openembedded/boards/dragonboard410c/Makefile
@@ -0,0 +1,2 @@
+DIR:=$(dir $(lastword $(MAKEFILE_LIST)))
+TEXTILE+= $(DIR)README.textile
diff --git a/openembedded/boards/dragonboard410c/README.textile.in b/openembedded/boards/dragonboard410c/README.textile.in
new file mode 100644
index 0000000..02873b7
--- /dev/null
+++ b/openembedded/boards/dragonboard410c/README.textile.in
@@ -0,0 +1,182 @@
+The Linaro Qualcomm Landing Team is pleased to announce the new release of the _Linaro OpenEmbedded RPB release for Qualcomm(tm) Snapdragon(R) 410E processor_. 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 OpenEmbedded based release for Dragonboard 410c and the Qualcomm Snapdragon 410E processor.
+
+h4. Important note(s) about this release
+
+You need to install the most recent bootloader package before using this release. Unlike the Debian based release, there is no GUI SD card installer for OpenEmbedded releases, and you need to use the SD rescue image using the "latest bootloader release":http://builds.96boards.org/releases/dragonboard410c/linaro/rescue/17.04/. 
+
+h4. Known issues
+
+For a list of all known issues, please check our "Bugzilla":https://bugs.96boards.org/buglist.cgi?bug_status=__open__&list_id=3368&order=Importance&product=Dragonboard%20410c&query_format=specific
+
+h4. Features
+
+The Linaro OpenEmbedde RPB version ##RELEASE## for the Snapdragon 410E 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 available on "Qualcomm Developer Network or 96boards.org":##QDN_FIRMWARE_LINK##.
+* The following 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)
+** @rpb-desktop-image@ image that includes a minimal desktop environment with Xorg and @openbox@
+** @rpb-weston-image@ image that includes a minimal desktop environment with Wayland and @weston@
+* All images have a pre-configured user called @linaro@, and the password for this user is set to @linaro@
+* All images are configured with a password less root account.
+* All images exist in two variants. The regular image, and a @-lava@ image , which includes addition packages typically useful for test and validation.
+* The root file system should be flashed in the onboard eMMC.
+* The following features are supported on the DragonBoard 410c:
+** Quad Core ARMv8 A53 CPU (==@==1.2GHz)
+** PSCI with support for cpuidle, SMP, hotplug and restart.
+** Adreno 306 GPU, powered by @freedreno@ Mesa/Gallium GPU driver, version ##MESA_VERSION##
+*** OpenGL 3.1, OpenGLES 3.0, GLX, EGL
+*** X11 -modesetting video driver
+** Cpufreq, using ondemand governor by default
+** CPU thermal sensors, and thermal management using the step wise governor
+** HDMI display and audio using the onboard ADV7533 MIPI/DSI Receiver with HDMI Transmitter from Analog Devices
+** UART, SD, eMMC
+** USB2.0 (Mouse, Keyboard, Storage, Ethernet)
+** Wifi and Bluetooth using integrated WCN3620, using proprietary firmware and "wcn36xx driver":http://wireless.kernel.org/en/users/Drivers/wcn36xx
+** Hardware accelerated video codecs using dedicated Snapdragon coprocessor
+** Onboard GPS using Qualcomm GNSS subsystem
+** CSI interface with external ISP only, sample driver included for OV5645, with support for the following features:
+*** CSI0 and/or CSI1 on the high speed expansion connector
+*** streaming from the camera sensor or CSID test generator
+*** raw dump to memory: 8bit packed UYVY format from OV5645 and resolutions of 2592x1944, 1920x1080 or 1280x960
+*** format conversion from 8bit packed UYVY to NV12
+*** input image downscaling (up to 16x)
+*** input image cropping
+
+h4. Information about the DragonBoard 410c
+
+For more information about the DragonBoard 410c, please check the following website and wiki:
+* "http://www.96boards.org/dragonboard410c":http://www.96boards.org/dragonboard410c
+* "http://www.96boards.org/dragonboard410c/documentation":http://www.96boards.org/dragonboard410c/documentation
+* "http://www.96boards.org/dragonboard410c/gettingstarted":http://www.96boards.org/dragonboard410c/gettingstarted
+* "https://github.com/96boards/documentation/wiki":https://github.com/96boards/documentation/wiki
+* "https://developer.qualcomm.com/hardware/dragonboard-410c":https://developer.qualcomm.com/hardware/dragonboard-410c
+
+h4. How to install and use this release
+
+To install this release please follow the instructions from the "DragonBoard 410c Linux user guide":https://github.com/96boards/documentation/wiki/Dragonboard-410c-Installation-Guide-for-Linux-and-Android. You need to use the SD recue method to install the most recent bootloader release and ensure that the board can boot in @fastboot@ mode.
+
+h4. Proprietary firmware
+
+This release contains proprietary firmware. You can download the proprietary firmware separately, from "here":##QDN_FIRMWARE_LINK##. All the required firmware files are pre-installed, and our images are bound to the Qualcomm Linux BSP license agreement. A copy of the LICENSE can be found in the image as @/etc/QCOM-LINUX-BOARD-SUPPORT-LICENSE@.
+
+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 Dragonboard 410c can support. The current release is based on the OpenEmbedded Core ##OS_REL_NICK## release branch.
+
+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
+
+The default partition scheme, flashed by the Linaro bootloader release, has created the following partitions:
+* @boot@ for the boot image (which includes the kernel Image)
+* @rootfs@ for the main root file system image
+
+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 rootfs <rpb-xxx--image.rootfs.img>
+
+h5. Running @rpb-desktop-image@
+
+The desktop image is a minimal graphical image based on the Xorg server. When booting it will automatically start an instance of Xorg server, and launch the @openbox@ window manager. It is recommended to use an HDMI monitor, as well as USB keyboard and mouse. A console login will also be started on the serial console.
+
+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.
+
+h5. Running the @rpb-weston-image@
+
+The Weston image is a sample image that will start the Weston compositor using Wayland automatically on boot. It is recommended to use an HDMI monitor, as well as USB keyboard and mouse. A console login will also be started on the serial console.
+
+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 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/dragonboard-410c/boot-dragonboard410c.img@.You can run the following @fastboot@ command to boot it on the board:
+
+bc. sudo fastboot boot boot-dragonboard410c.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. sudo fastboot flash boot boot-dragonboard410c.img
+
+h4. How to get and customize the bootloader
+
+While the first stage bootloader is proprietary and released as firmware blob available on "Qualcomm Developer Network or 96boards.org":##QDN_FIRMWARE_LINK##, the second stage bootloader is @LK@ and is open source. However the second stage bootloader is not built as part of the OpenEmbedded RPB build, but it can be built separately.
+
+The original LK source code is available on "CodeAurora.org":https://www.codeaurora.org/cgit/quic/la/kernel/lk/, and the source code which is used in this release can be found in the "Linaro Qualcomm Landing Team git repository":https://git.linaro.org/landing-teams/working/qualcomm/lk.git:
+
+bc. git: http://git.linaro.org/landing-teams/working/qualcomm/lk.git
+tag: dragonboard410c-##LK_RELEASE##
+
+The first stage bootloader expects the second stage bootloader to include a signature. The signature is typically used for secure boot. On Dragonboard 410c, since no private keys are available, the signature is not checked for integrity however the signature section, even if empty, must exist. To build the LK bootloader and add the signature section, you can use the following instructions:
+
+bc. git clone git://codeaurora.org/platform/prebuilts/gcc/linux-x86/arm/arm-eabi-4.8.git -b ##LK_GCC_REL##
+git clone http://git.linaro.org/landing-teams/working/qualcomm/lk.git -b dragonboard410c-##LK_RELEASE##
+git clone https://git.linaro.org/landing-teams/working/qualcomm/signlk.git
+cd lk
+make -j4 msm8916 EMMC_BOOT=1 TOOLCHAIN_PREFIX=<path to arm-eabi-4.8 tree>/bin/arm-eabi-
+mv ./build-msm8916/emmc_appsboot.mbn ./build-msm8916/emmc_appsboot_unsigned.mbn
+../signlk/signlk.sh -i=./build-msm8916/emmc_appsboot_unsigned.mbn -o=./build-msm8916/emmc_appsboot.mbn -d
+
+The second stage bootloader is flashed on the @aboot@ partition, you can now flash your board with:
+
+bc. sudo fastboot flash aboot ./build-msm8916/emmc_appsboot.mbn
+
+h4. Using the onboard GPS
+
+The GPS software stack mostly runs on the DSP subsystem. The communication between the main CPU and the DSP is done with a specific IPC driver called QRTR (see ./net/qrtr/ in the kernel source tree). The DSP is not started automatically at boot. To start the GPS, the DSP needs to be started first. Once the DSP is started any gpsd client can be started and will be able to retrieve GPS data.
+
+Please note that the sensitivity of the onboard antenna is quite low, so getting a FIX will take several minutes. Please refer to the dedicated application note to install an external antenna for better GPS performance.
+
+To get started with GPS, you need to start the DSP:
+
+bc. sudo systemctl start qdsp-start.service
+
+From now on, you can use any gpsd client, such as gpsmon or xgps.
+
+h4. Using CSI camera
+
+For detailed information about using CSI camera, please refer to this "document":https://github.com/96boards/documentation/blob/master/ConsumerEdition/DragonBoard-410c/Guides/CameraModule.md.
+
+h4. Optimized video pipeline
+
+In order to exercise a fully optimized video pipeline some specific settings need to be applied throughout the pipeline elements. With the fully optimized video use case there is no extra buffer copy, and the various drivers involved are sharing all video buffers using dmabuf.
+
+To exercise the opimized video pipeline, you can use for example the following gstreamer command:
+
+bc. GST_GL_PLATFORM=egl gst-launch-1.0 filesrc location=<path to file> ! qtdemux name=m m.video_0 ! h264parse ! v4l2video0dec capture-io-mode=dmabuf ! glimagesink
+
+h4. Feedback and Support
+
+For general question or support request, please go to "96boards.org Community forum":https://www.96boards.org/forums/forum/products/dragonboard410c/.
+
+For any bug related to this release, please submit issues to the "96Board.org Bug tracking system":https://bugs.96boards.org/. To submit a bug, follow this "link":https://bugs.96boards.org/enter_bug.cgi?product=Dragonboard%20410c.
+
+Bugs will be reviewed and prioritized by the team. For any bug report it is recommended to provide as much information as possible, and at the very list please include the name of the release you are using, the output of @dpkg -l@ to list all packages installed, as well, as the boot log (output of @dmesg@).
+
+h4. How to contribute
+
+We very much encourage developers to use and contribute to our releases, using the "following instructions":https://github.com/96boards/documentation/blob/master/ConsumerEdition/DragonBoard-410c/Downloads/Contribute.md.
+
+<hr>
+
+__Qualcomm Snapdragon is product of Qualcomm Technologies, Inc.__
diff --git a/openembedded/boards/dragonboard410c/README.textile.vars b/openembedded/boards/dragonboard410c/README.textile.vars
new file mode 100644
index 0000000..f07a318
--- /dev/null
+++ b/openembedded/boards/dragonboard410c/README.textile.vars
@@ -0,0 +1,10 @@
+export RELEASE="17.06"
+export OS_REL="2.2.1"
+export KERNEL_VER="4.9.34"
+export KERNEL_RECIPE_VER="4.9"
+export OS_REL_NICK="morty"
+export LINARO_GCC="http://releases.linaro.org/components/toolchain/binaries/6.3-2017.02/aarch64-linux-gnu/gcc-linaro-6.3.1-2017.02-x86_64_aarch64-linux-gnu.tar.xz"
+export QDN_FIRMWARE_LINK="http://builds.96boards.org/releases/dragonboard410c/qualcomm/firmware/linux-board-support-package-r1032.1.zip"
+export MESA_VERSION="17.1.1"
+export LK_RELEASE="LA.BR.1.2.7-03810-8x16.0-linaro1"
+export LK_GCC_REL="LA.BR.1.1.3.c4-01000-8x16.0"