From 864de3b0859dfb61b815f2d54de73e61acfea3d4 Mon Sep 17 00:00:00 2001 From: Khang Nguyen Date: Wed, 7 Aug 2019 16:56:32 +0700 Subject: rcar-gen3: README: Update release information This commit updates information for Community Yocto BSP v3.21.0 on Yocto Project 2.8 (Zeus). Signed-off-by: Khang Nguyen Signed-off-by: Takamitsu Honda Change-Id: I47a17c40a89cca82c8356e82a9f4a3f7f88323b3 --- meta-rcar-gen3/README.evaproprietary.md | 121 +++++++++++++++++++ meta-rcar-gen3/README.md | 200 +++++++++++++++++++++++--------- meta-rcar-gen3/README.proprietary.md | 196 ++++++++++++++++++------------- 3 files changed, 379 insertions(+), 138 deletions(-) create mode 100644 meta-rcar-gen3/README.evaproprietary.md (limited to 'meta-rcar-gen3') diff --git a/meta-rcar-gen3/README.evaproprietary.md b/meta-rcar-gen3/README.evaproprietary.md new file mode 100644 index 0000000..69a33d8 --- /dev/null +++ b/meta-rcar-gen3/README.evaproprietary.md @@ -0,0 +1,121 @@ +# R-Car Gen3 Evaluation Software Package for Linux + + +The meta-rcar-gen3 layer of meta-renesas supports the Click-through licensed +Linux Drivers and Gfx/MMP packages. + +This README describes how to use these features and setting local.conf. + +```bash + I/ Build configuration + II/ Obtain and Install Renesas Graphics Drivers +``` + +**NOTE:** + +* However, to have a completed local.conf, please also refer to Build +Instruction in [meta-renesas/meta-rcar-gen3/README.md](README.md). + +* In addition, these libraries are not provided with recipes. If you would like +to use, you will need to get them from Renesas. + +## I/ Build configuration + + +* Add the target board 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 R-Car Starter Kit Pro(M3NULCB) board + + ```bash + MACHINE = "m3nulcb" + ``` + + * 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" + ``` + +* When using the click-through version of the gfx/mmp packages, you need to add +the following to your local.conf + +```bash + DISTRO_FEATURES_append = " use_eva_pkg" +``` + +## II/ Obtain and Install Renesas Graphics Drivers + + +Before setting up the build environment, you need to download the proprietary +drivers. + +* Download Renesas graphic drivers with a "click through" license from +[Renesas website][rcar Linux Drivers] and unzip them into a folder. + +**NOTE:** + +* You have to register with a free account on MyRenesas and accept the license +conditions before downloading the drivers. +The operation is fast and simple nevertheless mandatory to access evaluation of +non open-source drivers for free. +Once you registered, you can download two zip files. + +```bash +$ cd +$ unzip -o R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-*.zip +$ unzip -o R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-*.zip +``` + +To install them into the correct place in the Yocto BSP, a copy script is used. + +```bash +$ cd ./meta-renesas +$ sh meta-rcar-gen3/docs/sample/copyscript/copy_evaproprietary_softwares.sh +``` + +[rcar Linux Drivers]: https://www.renesas.com/us/en/solutions/automotive/rcar-download/rcar-demoboard-2.html diff --git a/meta-rcar-gen3/README.md b/meta-rcar-gen3/README.md index 555e644..1c7b186 100644 --- a/meta-rcar-gen3/README.md +++ b/meta-rcar-gen3/README.md @@ -1,51 +1,98 @@ # 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: R-Car Starter Kit pro(M3NULCB) / SoC: R8A77965 (R-Car M3N) -- Board: Ebisu / SoC: R8A77990 (R-Car E3) -## Patches +This layer provides the support for the evaluation board mounted ARM SoCs of +Renesas Electronics, called the R-Car Generation 3. -Please submit any patches for this layer to: takamitsu.honda.pv@renesas.com -Please see the MAINTAINERS file for more details. +Currently, this supports boards and the SoCs of the following: + +```bash + - 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: R-Car Starter Kit pro(M3NULCB) / SoC: R8A77965 (R-Car M3N) + - Board: Ebisu / SoC: R8A77990 (R-Car E3) +``` + +## Branch Policy + + +* This is Community Yocto BSP to follow Yocto/Poky releases. + +* It is not supported to the level of the Customer Yocto BSP. + +## Tag Policy + + +* Releases are created from the respective working branch. + +* After a Customer Yocto BSP version releases, the Community Yocto BSP will be +rebased and released accordingly. + +* zeus-X: + + * The versions used on zeus (Yocto Project 2.8) will start on + zeus-Yocto-v3.21.0 to keep the major version numbers in sync. + +## Contribution + + +* Please submit any patches for this layer to: takamitsu.honda.pv@renesas.com + +* Please see the MAINTAINERS file for more details. + +## Layer Dependencies -## Dependencies This layer depends on: +* poky + +```bash URI: git://git.yoctoproject.org/poky layers: meta, meta-yocto, meta-yocto-bsp - branch: rocko + branch: master + revision: 835f7eac0610325e906591cd81890bebe8627580 +``` +* meta-linaro +```bash URI: git://git.linaro.org/openembedded/meta-linaro.git layers: meta-optee - branch: rocko + branch: warrior + revision: c38fb78fd1eb3883f2a8199c2d21358f4a412fb4 +``` + +* meta-openembedded +```bash URI: git://git.openembedded.org/meta-openembedded layers: meta-oe - branch: rocko + branch: master + revision: 80e0113f7a31447191204e1a1bda9c12e4ac693b +``` ## Build Instructions + The following instructions require a Poky installation (or equivalent). -This also needs git user name and email defined: +* This also needs git user name and email defined: + ```bash $ git config --global user.email "you@example.com" $ git config --global user.name "Your Name" ``` -Initialize a build using the 'oe-init-build-env' script in Poky. e.g.: +* 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.: +* After that, initialized configure bblayers.conf by adding meta-rcar-gen3 layer. +e.g.: + ```bash BBLAYERS ?= " \ /poky/meta \ @@ -56,7 +103,9 @@ After that, initialized configure bblayers.conf by adding meta-rcar-gen3 layer. /meta-openembedded/meta-oe \ " ``` -To build a specific target BSP, configure the associated machine in local.conf: + +* To build a specific target BSP, configure the associated machine in local.conf: + ```bash MACHINE ??= "" ``` @@ -69,89 +118,126 @@ Starter Kit Pro (M3ULCB)|MACHINE="m3ulcb" Starter Kit Pro (M3NULCB)|MACHINE="m3nulcb" Starter Kit Premier (H3ULCB)|MACHINE="h3ulcb" -Select the SOC: -```bash - For H3: r8a7795 - SOC_FAMILY = "r8a7795" +* Select the SOC - For M3: r8a7796 - SOC_FAMILY = "r8a7796" + * For H3: r8a7795 - For M3N: r8a77965 - SOC_FAMILY = "r8a77965" + ```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" + ``` + +* Configure for systemd init in local.conf: - 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 + +* Configure for ivi-shell and ivi-extension + ```bash DISTRO_FEATURES_append = " ivi-shell" ``` -Configure for USB 3.0 + +* Configure for USB 3.0 + ```bash MACHINE_FEATURES_append = " usb3" ``` -Enable tuning support for Capacity Aware migration Strategy (CAS) + +* Enable tuning support for Capacity Aware migration Strategy (CAS) + ```bash MACHINE_FEATURES_append = " cas" ``` -For a list of sample local.conf file, please refer to: [docs/sample/conf/](docs/sample/conf/) +* For a list of sample local.conf file, please refer to: [docs/sample/conf/](docs/sample/conf/) + +* Build the target file system image using bitbake: -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/'_. + +After completing the images for the target machine will be available in the +output directory 'tmp/deploy/images/'. Images generated: + * Image (generic Linux Kernel binary image file) -* Image-.dtb (DTB for target machine) -* core-image-minimal-.tar.bz2 (rootfs tar+bzip2) -* core-image-minimal-.ext4 (rootfs ext4 format) + +* \-\.dtb (DTB for target machine) + +* core-image-minimal-\.tar.bz2 (rootfs tar+bzip2) + +* core-image-minimal-\.ext4 (rootfs ext4 format) ## Build Instructions for SDK -This may be changed in the near feature. These instructions are tentative. + +NOTE: + +**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): + +### For 64-bit target SDK (aarch64) + + +Use `bitbake -c populate_sdk` for generating the toolchain SDK + ```bash $ bitbake core-image-minimal -c populate_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 +The SDK can be found in the output directory `tmp/deploy/sdk` + +* `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` + +* For 64-bit target SDK -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, using environment script in `/opt/poky/x.x` + ```bash $ source /opt/poky/x.x/environment-setup-aarch64-poky-linux ``` -## ULCB Information - -Refer to the following for more information of ULCB: - http://elinux.org/R-Car +## R-Car Generation 3 Information -## The information on building and running Yocto on R-Car Generation 3 -Refer to the following for more information: +Refer to the following for more information from eLinux website - https://elinux.org/R-Car/Boards/Yocto-Gen3 +https://elinux.org/R-Car diff --git a/meta-rcar-gen3/README.proprietary.md b/meta-rcar-gen3/README.proprietary.md index 1ba64d0..22da393 100644 --- a/meta-rcar-gen3/README.proprietary.md +++ b/meta-rcar-gen3/README.proprietary.md @@ -1,15 +1,16 @@ # 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. + +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 +```bash + 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: @@ -17,55 +18,74 @@ 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. +If you would like to use Linux ICCOM driver and Linux ICCOM library, please +check section IV. -**Note:** +**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. +* However, to have a completed local.conf, please also refer to Build +Instruction in [meta-renesas/meta-rcar-gen3/README.md](README.md). + +* 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" + MACHINE = "salvator-x" ``` + * For R-Car Starter Kit Premier(H3ULCB) board + ```bash - MACHINE = "h3ulcb" + MACHINE = "h3ulcb" ``` + * For R-Car Starter Kit Pro(M3ULCB) board + ```bash - MACHINE = "m3ulcb" + MACHINE = "m3ulcb" ``` + * For R-Car Starter Kit Pro(M3NULCB) board + ```bash MACHINE = "m3nulcb" ``` + * For Ebisu board + ```bash - MACHINE = "ebisu" + MACHINE = "ebisu" ``` -* Set SOC family name: + +* Set SOC family name * For H3: r8a7795 + ```bash - SOC_FAMILY = "r8a7795" + SOC_FAMILY = "r8a7795" ``` + * For M3: r8a7796 + ```bash - SOC_FAMILY = "r8a7796" + SOC_FAMILY = "r8a7796" ``` + * For M3N: r8a77965 + ```bash - SOC_FAMILY = "r8a77965" + SOC_FAMILY = "r8a77965" ``` + * For E3: r8a77990 + ```bash # Already added in machine config: ebisu.conf SOC_FAMILY = "r8a77990" @@ -73,10 +93,12 @@ you will need to get them from Renesas. ## II/ Build with GLES + For wayland with GSX -1. Please copy proprietary libraries to the directory of recipes. -2. Set local.conf the following. +* Please copy proprietary libraries to the directory of recipes. + +* Set local.conf the following. ```bash # Enable Gfx Pkgs @@ -96,78 +118,85 @@ For wayland with GSX BBMASK = "mesa-gl" ``` -3. Run - -```bash - $ bitbake core-image-weston -``` +* Run `bitbake core-image-weston` ## III/ Build with Renesas multimedia libraries + Multimedia portions depend on GLES portions. -**A/ Configuration for Multimedia features** +### A/ Configuration for Multimedia features + + +* Please copy proprietary libraries to the directory of recipes. + +* Please set local.conf the following. -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. + # Enable multimedia features. + # This provides package group of plug-ins of the GStreamer, multimedia + # libraries and kernel drivers. - MACHINE_FEATURES_append = " multimedia" + MACHINE_FEATURES_append = " multimedia" ``` -**B/ Configuration for optional codecs and middleware** +### B/ Configuration for optional codecs and middleware + + +* Please copy proprietary libraries to the directory of recipes. + +* Add features to DISTRO_FEATURES_append to local.conf -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 + # 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" ``` + DISTRO_FEATURES_append = " h264dec_lib h265dec_lib mpeg2dec_lib aaclcdec_lib aaclcdec_mdw" +``` + +### C/ Configuration for test packages -**C/ Configuration for test packages** -Must ensure that Multimedia features have been enabled. (Please refer to III/A to enable Multimedia.) +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. -Please add feature to DISTRO_FEATURES_append to local.conf: ```bash # Configuration for multimedia test package @@ -176,10 +205,15 @@ Please add feature to DISTRO_FEATURES_append to local.conf: ## 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. +* Please copy proprietary libraries to the directory of recipes. + +* Please set local.conf the following. + ```bash - DISTRO_FEATURES_append = " iccom" + DISTRO_FEATURES_append = " iccom" ``` +END. + -- cgit 1.2.3-korg