summaryrefslogtreecommitdiffstats
path: root/meta-rcar-gen3/README.md
diff options
context:
space:
mode:
authorKhang Nguyen <khang.nguyen.xw@renesas.com>2019-08-07 16:56:32 +0700
committerKhang Nguyen <khang.nguyen.xw@renesas.com>2019-09-24 08:16:29 +0700
commit864de3b0859dfb61b815f2d54de73e61acfea3d4 (patch)
tree4699547a903839f9b0ba0d7f58c7ddcbdde3e8b5 /meta-rcar-gen3/README.md
parent93980c5448f6b865108ab290b1d551e0bdc84bfb (diff)
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 <khang.nguyen.xw@renesas.com> Signed-off-by: Takamitsu Honda <takamitsu.honda.pv@renesas.com> Change-Id: I47a17c40a89cca82c8356e82a9f4a3f7f88323b3
Diffstat (limited to 'meta-rcar-gen3/README.md')
-rw-r--r--meta-rcar-gen3/README.md200
1 files changed, 143 insertions, 57 deletions
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 ?= " \
<path to layer>/poky/meta \
@@ -56,7 +103,9 @@ After that, initialized configure bblayers.conf by adding meta-rcar-gen3 layer.
<path to 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 ??= "<supported board name>"
```
@@ -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/<supported board name>'_.
+
+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)
-* 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)
+
+* \<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
-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