Simplified doc-site generation
[AGL/documentation.git] / docs / 2_Hardware_Support / Renesas_Gen3_Boards / 1_meta-rcar-gen3_Layer.md
1 ---
2 edit_link: ''
3 title: meta-rcar-gen3 Layer
4 origin_url: >-
5   https://git.automotivelinux.org/AGL/meta-renesas-rcar-gen3/plain/meta-rcar-gen3/README.md?h=master
6 ---
7
8 <!-- 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 -->
9
10 # meta-rcar-gen3
11
12
13 This layer provides the support for the evaluation board mounted ARM SoCs of
14 Renesas Electronics, called the R-Car Generation 3.
15
16 Currently, this supports boards and the SoCs of the following:
17
18 ```bash
19     - Board: Salvator-X / SoC: R8A7795 (R-Car H3), R8A7796 (R-Car M3), R8A77965 (R-Car M3N)
20     - Board: R-Car Starter Kit premier(H3ULCB) / SoC: R8A7795 (R-Car H3)
21     - Board: R-Car Starter Kit pro(M3ULCB) / SoC: R8A7796 (R-Car M3)
22     - Board: R-Car Starter Kit pro(M3NULCB) / SoC: R8A77965 (R-Car M3N)
23     - Board: Ebisu / SoC: R8A77990 (R-Car E3)
24 ```
25
26 ## Branch Policy
27
28
29 * This is Community Yocto BSP to follow Yocto/Poky releases.
30
31 * It is not supported to the level of the Customer Yocto BSP.
32
33 ## Tag Policy
34
35
36 *  Releases are created from the respective working branch.
37
38 *  After a Customer Yocto BSP version releases, the Community Yocto BSP will be
39 rebased and released accordingly.
40
41 *  dunfell-X:
42
43     * The versions used on dunfell (Yocto Project 3.1) will start on
44       dunfell-Yocto-v3.21.0 to keep the major version numbers in sync.
45
46 ## Contribution
47
48
49 * Please submit any patches for this layer to: takamitsu.honda.pv@renesas.com
50
51 * Please see the MAINTAINERS file for more details.
52
53 ## Layer Dependencies
54
55
56 This layer depends on:
57
58 * poky
59
60 ```bash
61     URI: git://git.yoctoproject.org/poky
62     layers: meta, meta-poky, meta-yocto-bsp
63     branch: dunfell
64 ```
65
66 * meta-openembedded
67
68 ```bash
69     URI: git://git.openembedded.org/meta-openembedded
70     layers: meta-oe, meta-python
71     branch: dunfell
72 ```
73
74 ## Build Instructions
75
76
77 The following instructions require a Poky installation (or equivalent).
78
79 * This also needs git user name and email defined:
80
81 ```bash
82    $ git config --global user.email "you@example.com"
83    $ git config --global user.name "Your Name"
84 ```
85
86 * Initialize a build using the 'oe-init-build-env' script in Poky. e.g.:
87
88 ```bash
89     $ source poky/oe-init-build-env
90 ```
91
92 * After that, initialized configure bblayers.conf by adding meta-rcar-gen3 layer.
93 e.g.:
94
95 ```bash
96     BBLAYERS ?= " \
97         <path to layer>/poky/meta \
98         <path to layer>/poky/meta-poky \
99         <path to layer>/poky/meta-yocto-bsp \
100         <path to layer>/meta-renesas/meta-rcar-gen3 \
101         <path to layer>/meta-openembedded/meta-python \
102         <path to layer>/meta-openembedded/meta-oe \
103     "
104 ```
105
106 * To build a specific target BSP, configure the associated machine in local.conf:
107
108 ```bash
109     MACHINE ??= "<supported board name>"
110 ```
111
112 Board|MACHINE
113 -----|-------
114 Salvator-X/XS|MACHINE="salvator-x"
115 Ebisu|MACHINE="ebisu"
116 Starter Kit Pro (M3ULCB)|MACHINE="m3ulcb"
117 Starter Kit Pro (M3NULCB)|MACHINE="m3nulcb"
118 Starter Kit Premier (H3ULCB)|MACHINE="h3ulcb"
119
120 * Select the SOC
121
122     * For H3: r8a7795
123
124     ```bash
125         SOC_FAMILY = "r8a7795"
126     ```
127
128     * For M3: r8a7796
129
130     ```bash
131         SOC_FAMILY = "r8a7796"
132     ```
133
134     * For M3N: r8a77965
135
136     ```bash
137         SOC_FAMILY = "r8a77965"
138     ```
139
140     * For E3: r8a77990
141
142     ```bash
143         # Already added in machine config: ebisu.conf
144         SOC_FAMILY = "r8a77990"
145     ```
146
147 * Configure for systemd init in local.conf:
148
149 ```bash
150     DISTRO_FEATURES_append = " systemd"
151     VIRTUAL-RUNTIME_init_manager = "systemd"
152 ```
153
154 * Configure for ivi-shell and ivi-extension
155
156 ```bash
157     DISTRO_FEATURES_append = " ivi-shell"
158 ```
159
160 * Configure for USB 3.0
161
162 ```bash
163     MACHINE_FEATURES_append = " usb3"
164 ```
165
166 * Enable tuning support for Capacity Aware migration Strategy (CAS)
167
168 ```bash
169     MACHINE_FEATURES_append = " cas"
170 ```
171
172 * For a list of sample local.conf file, please refer to: [docs/sample/conf/](docs/sample/conf/)
173
174 * Build the target file system image using bitbake:
175
176 ```bash
177     $ bitbake core-image-minimal
178 ```
179
180 After completing the images for the target machine will be available in the
181 output directory 'tmp/deploy/images/<supported board name>'.
182
183 Images generated:
184
185 * Image (generic Linux Kernel binary image file)
186
187 * \<SoC\>-\<machine name\>.dtb (DTB for target machine)
188
189 * core-image-minimal-\<machine name\>.tar.bz2 (rootfs tar+bzip2)
190
191 * core-image-minimal-\<machine name\>.ext4  (rootfs ext4 format)
192
193 ## Build Instructions for SDK
194
195
196 NOTE:
197
198 **This may be changed in the near feature. These instructions are tentative.**
199
200 Should define the staticdev in SDK image feature for installing the static libs
201 to SDK in local.conf.
202
203 ```bash
204     SDKIMAGE_FEATURES_append = " staticdev-pkgs"
205 ```
206
207 ### For 64-bit target SDK (aarch64)
208
209
210 Use `bitbake -c populate_sdk` for generating the toolchain SDK
211
212 ```bash
213     $ bitbake core-image-minimal -c populate_sdk
214 ```
215
216 The SDK can be found in the output directory `tmp/deploy/sdk`
217
218 * `poky-glibc-x86_64-core-image-minimal-aarch64-toolchain-x.x.sh`
219
220 ### Usage of toolchain SDK
221
222
223 Install the SDK to the default: `/opt/poky/x.x`
224
225 * For 64-bit target SDK
226
227 ```bash
228     $ sh poky-glibc-x86_64-core-image-minimal-aarch64-toolchain-x.x.sh
229 ```
230
231 * For 64-bit application, using environment script in `/opt/poky/x.x`
232
233 ```bash
234     $ source /opt/poky/x.x/environment-setup-aarch64-poky-linux
235 ```
236
237 ## R-Car Generation 3 Information
238
239
240 Refer to the following for more information from eLinux website
241
242 https://elinux.org/R-Car