Simplified doc-site generationjellyfish_9.99.4jellyfish/9.99.49.99.4

Updated theme to windmill Using Mkdocs static site generator Deployed on readthedocs

Signed-off-by: growupboron <shankhoghosh123@gmail.com>
Change-Id: If62eaaea1855c91b64f687900f54eba6bc1caee8
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25236
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>

2 files changed, 470 insertions, 0 deletions

diff --git a/docs/2_Hardware_Support/Renesas_Gen3_Boards /1_meta-rcar-gen3_Layer.md b/docs/2_Hardware_Support/Renesas_Gen3_Boards /1_meta-rcar-gen3_Layer.md
new file mode 100644
index 0000000..cbbcedf
--- /dev/null
+++ b/docs/2_Hardware_Support/Renesas_Gen3_Boards /1_meta-rcar-gen3_Layer.md
@@ -0,0 +1,242 @@
+---
+edit_link: ''
+title: meta-rcar-gen3 Layer
+origin_url: >-
+  https://git.automotivelinux.org/AGL/meta-renesas-rcar-gen3/plain/meta-rcar-gen3/README.md?h=master
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/hardware/master/renesas-gen3-boards-docs-book.yml -->
+
+# meta-rcar-gen3
+
+
+This layer provides the support for the evaluation board mounted ARM SoCs of
+Renesas Electronics, called the R-Car Generation 3.
+
+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.
+
+*  dunfell-X:
+
+    * The versions used on dunfell (Yocto Project 3.1) will start on
+      dunfell-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
+
+
+This layer depends on:
+
+* poky
+
+```bash
+    URI: git://git.yoctoproject.org/poky
+    layers: meta, meta-poky, meta-yocto-bsp
+    branch: dunfell
+```
+
+* meta-openembedded
+
+```bash
+    URI: git://git.openembedded.org/meta-openembedded
+    layers: meta-oe, meta-python
+    branch: dunfell
+```
+
+## Build Instructions
+
+
+The following instructions require a Poky installation (or equivalent).
+
+* 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.:
+
+```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-poky \
+        <path to layer>/poky/meta-yocto-bsp \
+        <path to layer>/meta-renesas/meta-rcar-gen3 \
+        <path to layer>/meta-openembedded/meta-python \
+        <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>"
+```
+
+Board|MACHINE
+-----|-------
+Salvator-X/XS|MACHINE="salvator-x"
+Ebisu|MACHINE="ebisu"
+Starter Kit Pro (M3ULCB)|MACHINE="m3ulcb"
+Starter Kit Pro (M3NULCB)|MACHINE="m3nulcb"
+Starter Kit Premier (H3ULCB)|MACHINE="h3ulcb"
+
+* Select the SOC
+
+    * 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"
+    ```
+
+* 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"
+```
+
+* 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:
+
+```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>'.
+
+Images generated:
+
+* Image (generic Linux Kernel binary image file)
+
+* \<SoC\>-\<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
+
+
+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"
+```
+
+### 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`
+
+### 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, using environment script in `/opt/poky/x.x`
+
+```bash
+    $ source /opt/poky/x.x/environment-setup-aarch64-poky-linux
+```
+
+## R-Car Generation 3 Information
+
+
+Refer to the following for more information from eLinux website
+
+https://elinux.org/R-Car
diff --git a/docs/2_Hardware_Support/Renesas_Gen3_Boards /2_Proprietary_Drivers.md b/docs/2_Hardware_Support/Renesas_Gen3_Boards /2_Proprietary_Drivers.md
new file mode 100644
index 0000000..a56d667
--- /dev/null
+++ b/docs/2_Hardware_Support/Renesas_Gen3_Boards /2_Proprietary_Drivers.md
@@ -0,0 +1,228 @@
+---
+edit_link: ''
+title: Proprietary Drivers
+origin_url: >-
+  https://git.automotivelinux.org/AGL/meta-renesas-rcar-gen3/plain/meta-rcar-gen3/README.proprietary.md?h=master
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/hardware/master/renesas-gen3-boards-docs-book.yml -->
+
+# 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.
+
+```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:
+
+* 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.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"
+    ```
+
+    * 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"
+    ```
+
+## II/ Build with GLES
+
+
+For wayland with GSX
+
+* Please copy proprietary libraries to the directory of recipes.
+
+* 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"
+```
+
+* Run `bitbake core-image-weston`
+
+## III/ Build with Renesas multimedia libraries
+
+
+Multimedia portions depend on GLES portions.
+
+### A/ Configuration for Multimedia features
+
+
+* Please copy proprietary libraries to the directory of recipes.
+
+* 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
+
+
+* Please copy proprietary libraries to the directory of recipes.
+
+* 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:
+```
+    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
+
+* Please copy proprietary libraries to the directory of recipes.
+
+* Please set local.conf the following.
+
+```bash
+    DISTRO_FEATURES_append = " iccom"
+```
+END.
+