diff options
author | Duy Dang <duy.dang.yw@rvc.renesas.com> | 2018-08-30 10:40:11 +0700 |
---|---|---|
committer | Duy Dang <duy.dang.yw@rvc.renesas.com> | 2018-10-26 09:45:38 +0700 |
commit | 4c216d7d2d29af6cbc231f772e90f23ab619f109 (patch) | |
tree | 04071f8f368b83860ac9db0386811ad39012eae9 | |
parent | bea3b6c35a6592f3e5522af29a36a0e883bb0582 (diff) |
rcar-gen3: README: Use Markdown formatting
This commit edits README files to use Markdown formatting.
There are also some modifications:
- Removed dependency on meta-renesas itself in
meta-rcar-gen3/README.md and meta-rcar-gen3/README.linaro
- Added E3 SoC information to meta-rcar-gen3/README.md
- Replaced core-image-x11 by core-image-minimal in README.md,
this image is not maintained.
Signed-off-by: Duy Dang <duy.dang.yw@rvc.renesas.com>
Signed-off-by: Khang Nguyen <khang.nguyen.xw@renesas.com>
Signed-off-by: Takamitsu Honda <takamitsu.honda.pv@renesas.com>
-rw-r--r-- | README.md (renamed from README) | 27 | ||||
-rw-r--r-- | meta-rcar-gen3/README.md (renamed from meta-rcar-gen3/README) | 103 | ||||
-rw-r--r-- | meta-rcar-gen3/README.proprietary | 139 | ||||
-rw-r--r-- | meta-rcar-gen3/README.proprietary.md | 181 | ||||
-rw-r--r-- | meta-rcar-gen3/docs/sample/patch/patch-for-linaro-gcc/0001-rcar-gen3-add-readme-for-building-with-Linaro-Gcc.patch | 4 |
5 files changed, 243 insertions, 211 deletions
@@ -1,26 +1,27 @@ -OpenEmbedded/Yocto BSP layer for Renesas Electronics's SoCs -========== +# OpenEmbedded/Yocto BSP layer for Renesas Electronics's SoCs + This layer provides support for Renesas Electronics's platforms for use with OpenEmbedded and/or Yocto. Layer maintainer: Takamitsu Honda <takamitsu.honda.pv@renesas.com> -Supported Boards/Machines -========================= +## Supported Boards/Machines + -In addition, this also provides layer that provides support board that is used -SoCs that Renesas build. Layer and board that supports following: +In addition, this also provides layer which supports boards using Renesas SoCs. +Layer and boards that support is the following: - * meta-rcar-gen3 + meta-rcar-gen3 - Renesas Electronics Corporation. Salvator-X (R8A7795/R8A7796/R8A77965) - Renesas Electronics Corporation. R-Car Starter Kit premier(H3ULCB) (R8A7795) - Renesas Electronics Corporation. R-Car Starter Kit pro(M3ULCB) (R8A7796) - Renesas Electronics Corporation. R-Car Ebisu (R8A77990) -Please see README in the layer directory about the description of the board. +Please see README in the layer directory for the description of the board. + +## Original BSP image + +The meta-renesas layer provides original BSP image. The following: -Original BSP image -========================= -The meta-renesas layer provides original BSP image. The following - * core-image-x11 (H3ULCB, M3ULCB) - * core-image-weston +* core-image-minimal +* core-image-weston diff --git a/meta-rcar-gen3/README b/meta-rcar-gen3/README.md index 96b2d3a..1f6d55b 100644 --- a/meta-rcar-gen3/README +++ b/meta-rcar-gen3/README.md @@ -1,22 +1,19 @@ -meta-rcar-gen3 -============== +# meta-rcar-gen3 This layer provides that evaluation board is mounted ARM SoCs of Renesas Electronics, called the R-Car Generation 3. Currently, this supports board and the SoCs of the following: - - Board: Salvator-X / SoC: R8A7795 (R-Car H3), R8A7796 (R-Car M3), R8A77965 (R-Car M3N) - - Board: R-Car Starter Kit premier(H3ULCB) / SoC: R8A7795 (R-Car H3) - - Board: R-Car Starter Kit pro(M3ULCB) / SoC: R8A7796 (R-Car M3) - - Board: Ebisu / SoC: R8A77990 (R-Car E3) +- Board: Salvator-X / SoC: R8A7795 (R-Car H3), R8A7796 (R-Car M3), R8A77965 (R-Car M3N) +- Board: R-Car Starter Kit premier(H3ULCB) / SoC: R8A7795 (R-Car H3) +- Board: R-Car Starter Kit pro(M3ULCB) / SoC: R8A7796 (R-Car M3) +- Board: Ebisu / SoC: R8A77990 (R-Car E3) -Patches -======= +## Patches Please submit any patches for this layer to: takamitsu.honda.pv@renesas.com Please see the MAINTAINERS file for more details. -Dependencies -============ +## Dependencies This layer depends on: @@ -24,10 +21,6 @@ This layer depends on: layers: meta, meta-yocto, meta-yocto-bsp branch: rocko - URI: git://github.com/renesas-rcar/meta-renesas - layers: meta-rcar-gen3 - branch: rocko - URI: git://git.linaro.org/openembedded/meta-linaro.git layers: meta-optee branch: rocko @@ -36,17 +29,17 @@ This layer depends on: layers: meta-oe branch: rocko -Build Instructions -================== +## Build Instructions The following instructions require a Poky installation (or equivalent). Initialize a build using the 'oe-init-build-env' script in Poky. e.g.: - +```bash $ source poky/oe-init-build-env +``` After that, initialized configure bblayers.conf by adding meta-rcar-gen3 layer. e.g.: - +```bash BBLAYERS ?= " \ <path to layer>/poky/meta \ <path to layer>/poky/meta-yocto \ @@ -55,13 +48,13 @@ After that, initialized configure bblayers.conf by adding meta-rcar-gen3 layer. <path to layer>/meta-linaro/meta-optee \ <path to layer>/meta-openembedded/meta-oe \ " - +``` To build a specific target BSP, configure the associated machine in local.conf: - +```bash MACHINE ??= "<supported board name>" - +``` Select the SOC - +```bash For H3: r8a7795 SOC_FAMILY = "r8a7795" @@ -74,72 +67,72 @@ Select the SOC For E3: r8a77990 SOC_FAMILY = "r8a77990" Already added in machine config: ebisu.conf - +``` Configure for systemd init in local.conf: - +```bash DISTRO_FEATURES_append = " systemd" VIRTUAL-RUNTIME_init_manager = "systemd" - +``` Configure for ivi-shell and ivi-extension - +```bash DISTRO_FEATURES_append = " ivi-shell" - +``` Configure for USB 3.0 - +```bash MACHINE_FEATURES_append = " usb3" - +``` Enable tuning support for Capacity Aware migration Strategy (CAS) - +```bash MACHINE_FEATURES_append = " cas" - +``` Build the target file system image using bitbake: - +```bash $ bitbake core-image-minimal - +``` After completing the images for the target machine will be available in the output -directory 'tmp/deploy/images/<supported board name>'. +directory _'tmp/deploy/images/<supported board name>'_. Images generated: - * Image (generic Linux Kernel binary image file) - * Image-<machine name>.dtb (DTB for target machine) - * core-image-minimal-<machine name>.tar.bz2 (rootfs tar+bzip2) - * core-image-minimal-<machine name>.ext4 (rootfs ext4 format) +* Image (generic Linux Kernel binary image file) +* Image-<machine name>.dtb (DTB for target machine) +* core-image-minimal-<machine name>.tar.bz2 (rootfs tar+bzip2) +* core-image-minimal-<machine name>.ext4 (rootfs ext4 format) + +## Build Instructions for SDK -Build Instructions for SDK -========================== This may be changed in the near feature. These instructions are tentative. Should define the staticdev in SDK image feature for installing the static libs to SDK in local.conf. - +```bash SDKIMAGE_FEATURES_append = " staticdev-pkgs" - +``` Use bitbake -c populate_sdk for generating the toolchain SDK: For 64-bit target SDK (aarch64): - +```bash $ bitbake core-image-minimal -c populate_sdk +``` +The SDK can be found in the output directory _'tmp/deploy/sdk'_ -The SDK can be found in the output directory 'tmp/deploy/sdk' - * poky-glibc-x86_64-core-image-minimal-aarch64-toolchain-x.x.sh + poky-glibc-x86_64-core-image-minimal-aarch64-toolchain-x.x.sh -Usage of toolchain SDK: -Install the SDK to the default: /opt/poky/x.x +Usage of toolchain SDK: Install the SDK to the default: _/opt/poky/x.x_ For 64-bit target SDK: - +```bash $ sh poky-glibc-x86_64-core-image-minimal-aarch64-toolchain-x.x.sh - -For 64-bit application use environment script in /opt/poky/x.x - +``` +For 64-bit application use environment script in _/opt/poky/x.x_ +```bash $ source /opt/poky/x.x/environment-setup-aarch64-poky-linux +``` +## ULCB Information -ULCB Information -================ Refer to the following for more information of ULCB: http://elinux.org/R-Car -The information on building and running Yocto on R-Car Generation 3 -========================= +## The information on building and running Yocto on R-Car Generation 3 + Refer to the following for more information: https://elinux.org/R-Car/Boards/Yocto-Gen3 diff --git a/meta-rcar-gen3/README.proprietary b/meta-rcar-gen3/README.proprietary deleted file mode 100644 index 4411c6a..0000000 --- a/meta-rcar-gen3/README.proprietary +++ /dev/null @@ -1,139 +0,0 @@ -Proprietary libraries for meta-rcar-gen3 -======================================== - -The meta-rcar-gen3 layer of meta-renesas is supported Graphic GLES(GSX) libraries, -proprietary library of multimedia, and ICCOM software. -This README describes how to use these features and setting to local.conf. - -There are 2 main paths: - I/ Board configuration - II/ Build with GLES - III/ Build with Renesas multimedia libraries - -Please check section II to config for GLES. -Please check section III to enable Multimedia functions. - -If you would like to use Linux ICCOM driver and Linux ICCOM library, -please check section IV. - -However, to have a completed local.conf, -please also refer to Build Instruction in meta-renesas/meta-rcar-gen3/README. - -In addition, these libraries are not provided with recipes. If you would like to use, -you will need to get them from Renesas. - -I/ Board configuration -================== -* Add this line to local.conf - For Salvator-X board - MACHINE = "salvator-x" - For R-Car Starter Kit Premier(H3ULCB) board - MACHINE = "h3ulcb" - For R-Car Starter Kit Pro(M3ULCB) board - MACHINE = "m3ulcb" - -* Set SOC family name: - For H3: r8a7795 - SOC_FAMILY = "r8a7795" - For M3: r8a7796 - SOC_FAMILY = "r8a7796" - For M3N: r8a77965 - SOC_FAMILY = "r8a77965" - -II/ Build with GLES -================== - * For wayland with GSX - - 1. Please copy proprietary libraries to the directory of recipes. - 2. Set local.conf the following. - - # Enable Gfx Pkgs - MACHINE_FEATURES_append = " gsx" - MULTI_PROVIDER_WHITELIST += "virtual/libgl virtual/egl virtual/libgles1 virtual/libgles2" - - # for Wayland/Weston - DISTRO_FEATURES_NATIVESDK_append = " wayland" - DISTRO_FEATURES_append = " pam" - PREFERRED_PROVIDER_virtual/libgles1 = "" - PREFERRED_PROVIDER_virtual/libgles2 = "gles-user-module" - PREFERRED_PROVIDER_virtual/egl = "libegl" - PREFERRED_PROVIDER_virtual/libgl = "" - PREFERRED_PROVIDER_virtual/mesa = "" - PREFERRED_PROVIDER_libgbm = "libgbm" - PREFERRED_PROVIDER_libgbm-dev = "libgbm" - BBMASK = "mesa-gl" - - 3. Run 'bitbake core-image-weston' - -III/ Build with Renesas multimedia libraries -============================================ - Multimedia portions depend on GLES portions. - - A/ Configuration for Multimedia features - 1. Please copy proprietary libraries to the directory of recipes. - 2. Please set local.conf the following. - - # Enable multimedia features. - # This provides package group of plug-ins of the GStreamer, multimedia - # libraries and kernel drivers. - - MACHINE_FEATURES_append = " multimedia" - - B/ Configuration for optional codecs and middleware - 1. Please copy proprietary libraries to the directory of recipes. - 2. Add features to DISTRO_FEATURES_append to local.conf - # Additional configuration in OMX module - " h263dec_lib" - for OMX Media Component H263 Decoder Library - " h264dec_lib" - for OMX Media Component H264 Decoder Library - " h264enc_lib" - for OMX Media Component H.264 Encoder Library - " h265dec_lib" - for OMX Media Component H265 Decoder Library - " mpeg2dec_lib" - for OMX Media Component MPEG2 Decoder Library - " mpeg4dec_lib" - for OMX Media Component MPEG4 Decoder Library - " vc1dec_lib" - for OMX Media Component VC-1 Decoder Library - " divxdec_lib" - for OMX Media Component DivX Decoder Library - " rvdec_lib" - for OMX Media Component RealVideo Decoder Library - " alacdec_lib" - for OMX Media Component ALAC Decoder Library - " flacdec_lib" - for OMX Media Component FLAC Decoder Library - " aaclcdec_lib" - for OMX Media Component AAC-LC Decoder Library - " aaclcdec_mdw" - for AAC-LC 2ch Decoder Middleware for Linux - " aacpv2dec_lib" - for OMX Media Component aacPlus V2 Decoder Library - " aacpv2dec_mdw" - for aacPlus V2 Decoder Middleware for Linux - " mp3dec_lib" - for OMX Media Component MP3 Decoder Library - " mp3dec_mdw" - for MP3 Decoder Middleware for Linux - " wmadec_lib" - for OMX Media Component WMA Standard Decoder Library - " wmadec_mdw" - for WMA Standard Decoder Middleware for Linux - " dddec_lib" - for OMX Media Component Dolby(R) Digital Decoder Library - " dddec_mdw" - for Dolby(R) Digital Decoder Middleware for Linux - " aaclcenc_lib" - for OMX Media Component AAC-LC Encoder Library - " vp8dec_lib" - for OMX Media Component VP8 Decoder Library for Linux - " vp8enc_lib" - for OMX Media Component VP8 Encoder Library for Linux - " vp9dec_lib" - for OMX Media Component VP9 Decoder Library for Linux - " aaclcenc_mdw" - for AAC-LC Encoder Middleware for Linux - " cmsbcm" - for CMS Basic Color Management Middleware for Linux - " cmsblc" - for CMS CMM3 Backlight Control Middleware for Linux - " cmsdgc" - for CMS VSP2 Dynamic Gamma Correction Middleware for Linux - " dtv" - for ISDB-T DTV Software Package for Linux - " dvd" - for DVD Core-Middleware for Linux - " adsp" - for ADSP driver, ADSP interface and ADSP framework for Linux - " avb" - for AVB Software Package for Linux - - Ex: - DISTRO_FEATURES_append = " h264dec_lib h265dec_lib mpeg2dec_lib aaclcdec_lib aaclcdec_mdw" - - C/ Configuration for test packages - Must ensure that Multimedia features have been enabled. - (Please refer to III/A to enable Multimedia.) - Please add feature to DISTRO_FEATURES_append to local.conf. - # Configuration for multimedia test package - - DISTRO_FEATURES_append = " mm-test" - -IV/ Enable Linux ICCOM driver and Linux ICCOM library -===================================================== - For Linux ICCOM driver and Linux ICCOM library - - 1. Please copy proprietary libraries to the directory of recipes. - 2. Please set local.conf the following. - - DISTRO_FEATURES_append = " iccom" -END. diff --git a/meta-rcar-gen3/README.proprietary.md b/meta-rcar-gen3/README.proprietary.md new file mode 100644 index 0000000..b3f395b --- /dev/null +++ b/meta-rcar-gen3/README.proprietary.md @@ -0,0 +1,181 @@ +# Proprietary libraries for meta-rcar-gen3 + +The meta-rcar-gen3 layer of meta-renesas is supported Graphic GLES(GSX) libraries, +proprietary library of multimedia, and ICCOM software. + +This README describes how to use these features and setting to local.conf. + +``` + I/ Board configuration + II/ Build with GLES + III/ Build with Renesas multimedia libraries + IV/ Enable Linux ICCOM driver and Linux ICCOM library +``` + +There are 2 main paths: + +* Please check section II to config for GLES. +* Please check section III to enable Multimedia functions. + +If you would like to use Linux ICCOM driver and Linux ICCOM library, +please check section IV. + +**Note:** + +* However, to have a completed local.conf, +please also refer to Build Instruction in _meta-renesas/meta-rcar-gen3/README_. +* In addition, these libraries are not provided with recipes. If you would like to use, +you will need to get them from Renesas. + +## I/ Board configuration + +* Add this line to local.conf + + * For Salvator-X board + ```bash + MACHINE = "salvator-x" + ``` + * For R-Car Starter Kit Premier(H3ULCB) board + ```bash + MACHINE = "h3ulcb" + ``` + * For R-Car Starter Kit Pro(M3ULCB) board + ```bash + MACHINE = "m3ulcb" + ``` + * For Ebisu board + ```bash + MACHINE = "ebisu" + ``` +* Set SOC family name: + + * For H3: r8a7795 + ```bash + SOC_FAMILY = "r8a7795" + ``` + * For M3: r8a7796 + ```bash + SOC_FAMILY = "r8a7796" + ``` + * For M3N: r8a77965 + ```bash + SOC_FAMILY = "r8a77965" + ``` + * For E3: r8a77990 + ```bash + # Already added in machine config: ebisu.conf + SOC_FAMILY = "r8a77990" + ``` + +## II/ Build with GLES + +For wayland with GSX + +1. Please copy proprietary libraries to the directory of recipes. +2. Set local.conf the following. + +```bash + # Enable Gfx Pkgs + MACHINE_FEATURES_append = " gsx" + MULTI_PROVIDER_WHITELIST += "virtual/libgl virtual/egl virtual/libgles1 virtual/libgles2" + + # for Wayland/Weston + DISTRO_FEATURES_NATIVESDK_append = " wayland" + DISTRO_FEATURES_append = " pam" + PREFERRED_PROVIDER_virtual/libgles1 = "" + PREFERRED_PROVIDER_virtual/libgles2 = "gles-user-module" + PREFERRED_PROVIDER_virtual/egl = "libegl" + PREFERRED_PROVIDER_virtual/libgl = "" + PREFERRED_PROVIDER_virtual/mesa = "" + PREFERRED_PROVIDER_libgbm = "libgbm" + PREFERRED_PROVIDER_libgbm-dev = "libgbm" + BBMASK = "mesa-gl" +``` + +3. Run + +```bash + $ bitbake core-image-weston +``` + +## III/ Build with Renesas multimedia libraries + +Multimedia portions depend on GLES portions. + +**A/ Configuration for Multimedia features** + +1. Please copy proprietary libraries to the directory of recipes. +2. Please set local.conf the following. +```bash + # Enable multimedia features. + # This provides package group of plug-ins of the GStreamer, multimedia + # libraries and kernel drivers. + + MACHINE_FEATURES_append = " multimedia" +``` + +**B/ Configuration for optional codecs and middleware** + +1. Please copy proprietary libraries to the directory of recipes. +2. Add features to DISTRO_FEATURES_append to local.conf +```bash + # Additional configuration in OMX module + " h263dec_lib" - for OMX Media Component H263 Decoder Library + " h264dec_lib" - for OMX Media Component H264 Decoder Library + " h264enc_lib" - for OMX Media Component H.264 Encoder Library + " h265dec_lib" - for OMX Media Component H265 Decoder Library + " mpeg2dec_lib" - for OMX Media Component MPEG2 Decoder Library + " mpeg4dec_lib" - for OMX Media Component MPEG4 Decoder Library + " vc1dec_lib" - for OMX Media Component VC-1 Decoder Library + " divxdec_lib" - for OMX Media Component DivX Decoder Library + " rvdec_lib" - for OMX Media Component RealVideo Decoder Library + " alacdec_lib" - for OMX Media Component ALAC Decoder Library + " flacdec_lib" - for OMX Media Component FLAC Decoder Library + " aaclcdec_lib" - for OMX Media Component AAC-LC Decoder Library + " aaclcdec_mdw" - for AAC-LC 2ch Decoder Middleware for Linux + " aacpv2dec_lib" - for OMX Media Component aacPlus V2 Decoder Library + " aacpv2dec_mdw" - for aacPlus V2 Decoder Middleware for Linux + " mp3dec_lib" - for OMX Media Component MP3 Decoder Library + " mp3dec_mdw" - for MP3 Decoder Middleware for Linux + " wmadec_lib" - for OMX Media Component WMA Standard Decoder Library + " wmadec_mdw" - for WMA Standard Decoder Middleware for Linux + " dddec_lib" - for OMX Media Component Dolby(R) Digital Decoder Library + " dddec_mdw" - for Dolby(R) Digital Decoder Middleware for Linux + " aaclcenc_lib" - for OMX Media Component AAC-LC Encoder Library + " vp8dec_lib" - for OMX Media Component VP8 Decoder Library for Linux + " vp8enc_lib" - for OMX Media Component VP8 Encoder Library for Linux + " vp9dec_lib" - for OMX Media Component VP9 Decoder Library for Linux + " aaclcenc_mdw" - for AAC-LC Encoder Middleware for Linux + " cmsbcm" - for CMS Basic Color Management Middleware for Linux + " cmsblc" - for CMS CMM3 Backlight Control Middleware for Linux + " cmsdgc" - for CMS VSP2 Dynamic Gamma Correction Middleware for Linux + " dtv" - for ISDB-T DTV Software Package for Linux + " dvd" - for DVD Core-Middleware for Linux + " adsp" - for ADSP driver, ADSP interface and ADSP framework for Linux + " avb" - for AVB Software Package for Linux +``` +Ex: +```bash + DISTRO_FEATURES_append = " h264dec_lib h265dec_lib mpeg2dec_lib aaclcdec_lib aaclcdec_mdw" +``` + +**C/ Configuration for test packages** + +Must ensure that Multimedia features have been enabled. (Please refer to III/A to enable Multimedia.) + +Please add feature to DISTRO_FEATURES_append to local.conf: +```bash + # Configuration for multimedia test package + + DISTRO_FEATURES_append = " mm-test" +``` + +## IV/ Enable Linux ICCOM driver and Linux ICCOM library + +For Linux ICCOM driver and Linux ICCOM library + +1. Please copy proprietary libraries to the directory of recipes. +2. Please set local.conf the following. +```bash + DISTRO_FEATURES_append = " iccom" +``` diff --git a/meta-rcar-gen3/docs/sample/patch/patch-for-linaro-gcc/0001-rcar-gen3-add-readme-for-building-with-Linaro-Gcc.patch b/meta-rcar-gen3/docs/sample/patch/patch-for-linaro-gcc/0001-rcar-gen3-add-readme-for-building-with-Linaro-Gcc.patch index 06ede96..0ca1017 100644 --- a/meta-rcar-gen3/docs/sample/patch/patch-for-linaro-gcc/0001-rcar-gen3-add-readme-for-building-with-Linaro-Gcc.patch +++ b/meta-rcar-gen3/docs/sample/patch/patch-for-linaro-gcc/0001-rcar-gen3-add-readme-for-building-with-Linaro-Gcc.patch @@ -61,10 +61,6 @@ index 0000000..e1fe40a + layers: meta, meta-yocto, meta-yocto-bsp + branch: rocko + -+ URI: git://git.yoctoproject.org/meta-renesas -+ layers: meta-rcar-gen3 -+ branch: rocko -+ + URI: https://git.linaro.org/openembedded/meta-linaro.git + layers: meta-linaro-toolchain, meta-optee + branch: rocko |