d0030c4182774f985df85c0d8a54919d2060363f
[AGL/documentation.git] / docs / 0_Getting_Started / 2_Building_AGL_Image / 5_3_RCar_Gen_3.md
1 # Building for Supported Renesas Boards
2
3 AGL supports building for several automotive
4 [Renesas](https://www.renesas.com/us/en/solutions/automotive.html) board kits.
5 Renesas is the number one supplier of vehicle control microcontrollers and
6 System on a Chip (SoC) products for the automotive industry.
7
8 This section provides the build and deploy steps you need to create an
9 image for the following Renesas platforms:
10
11 * [Renesas R-Car Starter Kit Pro Board](https://www.elinux.org/R-Car/Boards/M3SK)
12 * [Renesas R-Car Starter Kit Premier Board](https://www.elinux.org/R-Car/Boards/H3SK)
13 * [Renesas Salvator-X Board](https://www.elinux.org/R-Car/Boards/Salvator-X)
14 * [Renesas Kingfisher Infotainment Board](https://elinux.org/R-Car/Boards/Kingfisher)
15
16 **NOTE:** You can find similar information for the Pro and Premier board kits on the
17 [R-Car/Boards/Yocto-Gen3](https://elinux.org/R-Car/Boards/Yocto-Gen3) page on [elinux.org](https://elinux.org).
18 The information on this page describes setup and build procedures for both of these
19 Renesas development kits.
20
21 ## 1. Downloading Proprietary Drivers
22
23 Before setting up the build environment, you need to download proprietary drivers from the
24 [R-Car H3/M3 Software library and Technical document](https://www.renesas.com/us/en/application/automotive/r-car-h3-m3-documents-software)
25 site.
26
27 Follow these steps to download the drivers you need:
28
29 1. **Determine the Files You Need:**
30
31      Run the ``setup_mm_packages.sh`` script as follows to
32      display the list of ZIP files containing the drivers you need.
33      Following is an example:
34
35      ```sh
36      grep -rn ZIP_.= $AGL_TOP/meta-agl/meta-agl-bsp/meta-rcar-gen3/scripts/setup_mm_packages.sh
37      ```
38
39      The script's output identifies the files you need to download from the page.
40
41 2. **Get Your Board Support Package (BSP) Version:**
42
43     Be sure to have the correct BSP version of the R-Car Starter Kit
44     based on the version of the AGL software you are using.
45     Find the appropriate download links on the
46     [R-Car H3/M3 Software library and Technical document](https://www.renesas.com/us/en/application/automotive/r-car-h3-m3-documents-software)
47     site.
48     The file pairs are grouped according to the Yocto Project version you are
49     using with the AGL software.
50
51     Use the following table to map the Renesas version to your AGL software:
52
53     | AGL Version | Renesas version |
54     |:-:|:-:|
55     | AGL master | 4.1.0 |
56
57 3. **Download the Files:**
58
59     Start the download process by clicking the download link.
60     If you do not have an account with Renesas, you will be asked to register a free account.
61     You must register and follow the "Click Through" licensing process
62     in order to download these proprietary files.
63
64     If needed, follow the instructions to create the free account by providing the required
65     account information.
66     Once the account is registered and you are logged in, you can download the files.
67
68     **NOTE:** You might have to re-access the
69     [original page](https://www.renesas.com/us/en/application/automotive/r-car-h3-m3-documents-software)
70     that contains the download links you need after creating the account and logging in.
71
72 4. **Create an Environment Variable to Point to Your Download Area:**
73
74     Create and export an environment variable named `XDG_DOWNLOAD_DIR` that points to
75     your download directory.
76     Here is an example:
77
78     ```sh
79     $ export XDG_DOWNLOAD_DIR=$HOME/Downloads
80     ```
81
82 5. **Be Sure the Files Have Rights:**
83
84     Be sure you have the necessary rights for the files you downloaded.
85     You can use the following command:
86
87     ```sh
88     chmod a+x $XDG_DOWNLOAD_DIR/*.zip
89     ```
90
91 6. **Check to be Sure the Files are Downloaded and Have the Correct Rights:**
92
93     Do a quick listing of the files to ensure they are in the download directory and
94     they have the correct access rights.
95     Here is an example:
96
97     ```sh
98     $ ls -l $XDG_DOWNLOAD_DIR/*.zip
99     -rw-rw-r-- 1 scottrif scottrif 4662080 Nov 19 14:48 /home/scottrif/Downloads/R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip
100     -rw-rw-r-- 1 scottrif scottrif 3137626 Nov 19 14:49 /home/scottrif/Downloads/R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip
101     ```
102
103 ## 2. Getting More Software
104
105 1. **Get the `bmaptool`:**
106
107     Download this tool from the
108     [bmap-tools](https://build.opensuse.org/package/show/isv:LinuxAutomotive:AGL_Master/bmap-tools)
109     repository.
110     The site has pre-built packages (DEB or RPM) for the supported host
111     operating systems.
112
113 ## 3. Getting Your Hardware Together
114
115 Gather together this list of hardware items, which is not exhaustive.
116 Having these items ahead of time saves you from having to try and
117 collect hardware during development:
118
119    * Supported Starter Kit Gen3 board with its 5V power supply.
120    * Micro USB-A cable for serial console.
121      This cable is optional if you are using Ethernet and an SSH connection.
122    * USB 2.0 Hub.  The hub is optional but makes it easy to connect multiple USB devices.
123    * Ethernet cable.  The cable is optional if you are using a serial console.
124    * HDMI type D (Micro connector) cable and an associated display.
125    * 4 Gbyte minimum MicroSD Card.  It is recommended that you use a class 10 type.
126    * USB touch screen device such as the GeChic 1502i/1503i.  A touch screen device is optional.
127
128    **NOTE:** The Salvator-X Board has NDA restrictions.
129    Consequently, less documentation is available for this board both here and across the
130    Internet.
131
132
133 ## 4. Making Sure Your Build Environment is Correct
134
135 The
136 "[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)"
137 section presented generic information for setting up your build environment
138 using the `aglsetup.sh` script.
139 If you are building an image for a supported Renesas board,
140 you need to take steps to make sure your build host is set up correctly.
141
142 1. **Define Your Board:**
143
144     Depending on your Renesas board, define and export a `MACHINE` variable as follows:
145
146     | Board | `MACHINE` Setting |
147     |:-:|:-:|
148     | Starter Kit Pro/M3  | `MACHINE`=m3ulcb |
149     | Starter Kit Pro/M3 + kingfisher support | `MACHINE`=m3ulcb-kf |
150     | Starter Kit Pro/M3 without graphic  | `MACHINE`=m3ulcb-nogfx |
151     | Starter Kit Premier/H3  | `MACHINE`=h3ulcb |
152     | Starter Kit Premier/H3  + kingfisher support  | `MACHINE`=h3ulcb-kf |
153     | Starter Kit Premier/H3  without graphic   | `MACHINE`=h3ulcb-nogfx |
154     | Salvator-X  | `MACHINE`=h3-salvator-x |
155
156     For example, the following command defines and exports the `MACHINE` variable
157     for the Starter Kit Pro/M3 Board:
158
159     ```sh
160     $ export MACHINE=m3ulcb
161     ```
162
163 2. **Run the `aglsetup.sh` Script:**
164
165     Use the following commands to run the AGL Setup script:
166
167     ```sh
168     $ cd $AGL_TOP
169     $ source meta-agl/scripts/aglsetup.sh -m $MACHINE -b build agl-devel agl-demo
170     ```
171
172     **NOTE:**
173     Running the `aglsetup.sh` script automatically places you in the
174     working directory (i.e. `$AGL_TOP/build`).
175     You can change this default behavior by adding the "-f" option to the
176     script's command line.
177
178     In the previous command, the "-m" option sets your machine to the previously
179     defined `MACHINE` variable.
180     The "-b" option defines your Build Directory, which is the
181     default `$AGL_TOP/build`.
182     Finally, the AGL features are provided to support building the AGL Demo image
183     for the Renesas board.
184
185     You can learn more about the AGL Features in the
186     "[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)"
187     section.
188
189 3. **Examine the Script's Log:**
190
191     Running the `aglsetup.sh` script creates the `setup.log` file, which is in
192     the `build/conf` folder.
193     You can examine this log to see the results of the script.
194     For example, suppose the graphics drivers were missing or could not be extracted
195     when you ran the script.
196     In case of missing graphics drivers, you could notice an error message
197     similar to the following:
198     ```text
199     [snip]
200     --- fragment /home/working/workspace_agl_master/meta-agl/templates/machine/h3ulcb/50_setup.sh
201     /home/working/workspace_agl_master /home/working/workspace_agl_master/build_gen3
202     The graphics and multimedia acceleration packages for
203     the R-Car Gen3 board can be downloaded from:
204     https://www.renesas.com/en-us/solutions/automotive/rcar-demoboard-2.html
205
206     These 2 files from there should be store in your'/home/devel/Downloads' directory.
207       R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston5-20190802.zip
208       R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston5-20190802.zip
209     /home/working/workspace_agl_master/build_gen3
210     --- fragment /home/working/workspace_agl_master/meta-agl/templates/base/99_setup_EULAconf.sh
211     --- end of setup script
212     OK
213     Generating setup file: /home/working/workspace_agl_master/build_gen3/agl-init-build-env ... OK
214     ------------ aglsetup.sh: Done
215     [snip]
216     ```
217
218     If you encounter this issue, or any other unwanted behavior, you can fix the error
219     mentioned, remove the `$AGL_TOP/build` directory, and then re-launch the
220     `aglsetup.sh` again.
221
222     Here is another example that indicates the driver files could not be extracted from the downloads directory:
223     ```
224     ~/workspace_agl/build/conf $ cat setup.log
225     --- beginning of setup script
226     --- fragment /home/working/workspace_agl/meta-agl/templates/base/01_setup_EULAfunc.sh
227     --- fragment /home/working/workspace_agl/meta-agl/templates/machine/m3ulcb/50_setup.sh
228     ~/workspace_agl ~/workspace_agl/build
229     ERROR: FILES "+/home/working/Downloads/R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston5-20190802.zip+" NOT EXTRACTING CORRECTLY
230     ERROR: FILES "+/home/working/Downloads/R-car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston5-20190802.zip+" NOT EXTRACTING CORRECTLY
231     The graphics and multimedia acceleration packages for
232     the R-Car Gen3 board BSP can be downloaded from:
233     <https://www.renesas.com/us/en/application/automotive/r-car-h3-m3-documents-software>
234
235     These 2 files from there should be stored in your
236     '/home/working/Downloads' directory.
237       R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston5-20190802.zip
238       R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston5-20190802.zip
239     ERROR: Script /home/working/workspace_agl/build/conf/setup.sh failed
240     [snip]
241     ```
242
243 ## 5. Checking Your Configuration
244
245 Aside from environment variables and parameters you establish through
246 running the `aglsetup.sh` script, you can ensure your build's configuration
247 is just how you want it by examining the `local.conf` configuration file.
248
249 You can find this configuration file in the Build Directory (e.g.
250 `$TOP_DIR/build/conf/local.conf`).
251
252 In general, the defaults along with the configuration fragments the
253 `aglsetup.sh` script applies in the `local.conf` file are good enough.
254 However, you can customize aspects by editing the `local.conf` file.
255 See the
256 "[Customizing Your Build](4_Customizing_Your_Build.md)"
257 section for common configurations you might want to consider.
258
259 **NOTE:** For detailed explanations of the configurations you can make
260 in the ``local.conf`` file, consult the
261 [Yocto Project Documentation](https://www.yoctoproject.org/docs/).
262
263 A quick way to see if you have the `$MACHINE` variable set correctly
264 is to use the following command:
265
266 ```sh
267 grep -w -e "^MACHINE =" $AGL_TOP/build/conf/local.conf
268 ```
269
270 Depending on the Renesas board you are using, you should see output
271 as follows:
272
273 ```sh
274 MACHINE = "h3ulcb"
275 ```
276 or
277 ```sh
278 MACHINE = "m3ulcb"
279 ```
280 or
281 ```sh
282 MACHINE = "h3-salvator-x"
283 ```
284
285 If you ran the `aglsetup.sh` script as described in the
286 "[Making Sure Your Build Environment is Correct](./5_3_RCar_Gen_3.md#4-making-sure-your-build-environment-is-correct)"
287 section earlier, the "agl-devel", "agl-demo", "agl-netboot", "agl-appfw-smack", and
288 "agl-localdev" AGL features will be in effect.
289 These features provide the following:
290
291 * A debugger (gdb)
292 * Some tweaks, including a disabled root password
293 * A SFTP server
294 * The TCF Agent for easier application deployment and remote debugging
295 * Some extra system tools such as USB and bluetooth
296 * Support for the AGL demo platform
297 * Network boot support through TFTP and NBD protocols
298 * [IoT.bzh](https://iot.bzh/en/) Application Framework plus
299   [SMACK](https://en.wikipedia.org/wiki/Smack_(software)) and
300   [Cynara](https://wiki.tizen.org/Security:Cynara)
301 * Support for local development including `localdev.inc` when present
302
303 ## 6. Using BitBake
304
305 This section shows the `bitbake` command used to build the AGL image.
306 Before running BitBake to start your build, it is good to be reminded that AGL
307 does provide pre-built images for developers that work with supported hardware.
308 You can find these pre-built images on the
309 [AGL Download web site](https://download.automotivelinux.org/AGL/release).
310
311 Start the build using the `bitbake` command.
312
313 **NOTE:** An initial build can take many hours depending on your
314 CPU and and Internet connection speeds.
315 The build also takes approximately 100G-bytes of free disk space.
316
317 For this example, the target is "agl-demo-platform":
318
319 ```sh
320 bitbake agl-demo-platform
321 ```
322
323 The build process puts the resulting image in the Build Directory:
324
325 ```
326 <build_directory>/tmp/deploy/images/$MACHINE
327 ```
328
329 ## 7. Booting the Image Using a MicroSD Card
330
331 To boot your image on the Renesas board, you need to do three things:
332
333 1. Update all firmware on the board.
334 2. Prepare the MicroSD card to you can boot from it.
335 3. Boot the board.
336
337 **NOTE:** For subsequent builds, you only have to re-write the MicroSD
338 card with a new image.
339
340 ### Updating the Board's Firmware
341
342 Follow these steps to update the firmware:
343
344 1. **Update the Sample Loader and MiniMonitor:**
345
346     You only need to make these updates one time per device.
347
348     Follow the procedure found on the
349     eLinux.org wiki to update to at least version 3.02,
350     which is mandatory to run the AGL image
351     ([R-car loader update](https://elinux.org/R-Car/Boards/Kingfisher#How_to_update_of_Sample_Loader_and_MiniMonitor)).
352
353 2. **Update the Firmware Stack:**
354
355     You only need to update the firmware stack if you are
356     using the Eel or later (5.0) version of AGL software.
357
358     M3 and H3 Renesas board are AArch64 platforms.
359     As such, they have a firmware stack that is divided across: **ARM Trusted Firmware**, **OP-Tee** and **U-Boot**.
360
361     If you are using the Eel (5.0) version or later of the AGL software, you must update
362     the firmware using the **[h3ulcb] [R-car h3ulcb firmware update](http://elinux.org/R-Car/Boards/H3SK#Flashing_firmware)**
363     or **[m3ulcb] [R-car m3ulcb firmware update](https://elinux.org/R-Car/Boards/M3SK#Flashing_firmware)** links from the
364     [Embedded Linux Wiki](https://www.elinux.org/Main_Page) (i.e. `elinux.org`).
365
366     The table in the wiki lists the files you need to flash the firmware.
367     You can find these files in the following directory:
368
369     ```sh
370     $AGL_TOP/build/tmp/deploy/images/$MACHINE
371     ```
372
373     **NOTE:** The Salvator-X firmware update process is not documented on eLinux.
374
375 ### Preparing the MicroSD Card
376
377 Plug the MicroSD card into your Build Host.
378 After plugging in the device, use the `dmesg` command as follows to
379 discover the device name:
380 ```sh
381 $ dmesg | tail -4
382 [ 1971.462160] sd 6:0:0:0: [sdc] Mode Sense: 03 00 00 00
383 [ 1971.462277] sd 6:0:0:0: [sdc] No Caching mode page found
384 [ 1971.462278] sd 6:0:0:0: [sdc] Assuming drive cache: write through
385 [ 1971.463870]  sdc: sdc1 sdc2
386 ```
387 In the previous example, the MicroSD card is attached to the device `/dev/sdc`.
388 You can also use the `lsblk` command to show all your devices.
389 Here is an example that shows the MicroSD card as `/dev/sdc`:
390 ```sh
391 $ lsblk
392   NAME   MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
393   sda      8:0    0 167,7G  0 disk
394   ├─sda1   8:1    0   512M  0 part /boot/efi
395   ├─sda2   8:2    0 159,3G  0 part /
396   └─sda3   8:3    0   7,9G  0 part [SWAP]
397   sdb      8:16   0 931,5G  0 disk
398   └─sdb1   8:17   0 931,5G  0 part /media/storage
399   sdc      8:32   1  14,9G  0 disk
400   ├─sdc1   8:33   1    40M  0 part
401   └─sdc2   8:34   1   788M  0 part
402 ```
403 **IMPORTANT NOTE:** Before re-writing any device on your Build Host, you need to
404 be sure you are actually writing to the removable MicroSD card and not some other
405 device.
406 Each computer is different and removable devices can change from time to time.
407 Consequently, you should repeat the previous operation with the MicroSD card to
408 confirm the device name every time you write to the card.
409
410 To summarize this example so far, we have the following:
411
412 * The first SATA drive is `/dev/sda`.
413
414 * `/dev/sdc` corresponds to the MicroSD card, and is also marked as a removable device.
415   You can see this in the output of the `lsblk` command where "1" appears in the "RM" column
416   for that device.
417
418 Now that you have identified the device you are going to be writing the image on,
419 you can use the `bmaptool` to copy the image to the MicroSD card.
420
421 Your desktop system might offer a choice to mount the MicroSD automatically
422 in some directory.
423 For this example, assume that the MicroSD card mount directory is stored in the
424 `$SDCARD` variable.
425
426 Following are example commands that write the image to the MicroSD card:
427
428 ```sh
429 cd $AGL_TOP/build/tmp/deploy/images/$MACHINE
430 bmaptool copy ./agl-demo-platform-$MACHINE.wic.xz <boot_device_name>
431 ```
432
433 Alternatively, you can leave the image in an uncompressed state and write it
434 to the MicroSD card:
435
436 ```sh
437 sudo umount <boot_device_name>
438 xzcat ./agl-demo-platform-$MACHINE.wic.xz | sudo dd of=<boot_device_name> bs=4M
439 sync
440 ```
441
442 ### Booting the Board
443
444 Follow these steps to boot the board:
445
446 1. Use the board's power switch to turn off the board.
447
448 2. Insert the MicroSD card into the board.
449
450 3. Verify that you have plugged in the following:
451
452     * An external monitor into the board's HDMI port
453
454     * An input device (e.g. keyboard, mouse, touchscreen, and so forth) into the board's USB ports.
455
456 4. Use the board's power switch to turn on the board.
457
458 After a few seconds, you will see the AGL splash screen on the display and you
459 will be able to log in at the console's terminal or using the graphic screen.
460
461 ## 8. Setting Up the Serial Console
462
463 Setting up the Serial Console involves the following:
464
465 * Installing a serial client on your build host
466 * Connecting your build host to your Renesas board's serial port
467 * Powering on the board to get a shell at the console
468 * Configuring U-Boot parameters
469 * Logging into the console
470 * Determining the board's IP address
471
472 ### Installing a Serial Client on Your Build Host
473
474 You need to install a serial client on your build host.
475 Some examples are:
476
477 * [GNU Screen](https://en.wikipedia.org/wiki/GNU_Screen)
478 * [picocom](https://linux.die.net/man/8/picocom)
479 * [Minicom](https://en.wikipedia.org/wiki/Minicom)
480
481 Of these three, "picocom" has the least dependencies and is therefore
482 considered the "lightest" solution.
483
484 ### Connecting Your Build Host to Your Renesas Board's Serial Port
485
486 You need to physically connect your build host to the Renesas board using
487 a USB cable from the host to the serial CP2102 USP port (i.e. Micro USB-A port)
488 on the Renesas board.
489
490 Once you connect the board, determine the device created for the serial link.
491 Use the ``dmesg`` command on your build host.
492 Here is an example:
493 ```sh
494 dmesg | tail 9
495 [2097783.287091] usb 2-1.5.3: new full-speed USB device number 24 using ehci-pci
496 [2097783.385857] usb 2-1.5.3: New USB device found, idVendor=0403, idProduct=6001
497 [2097783.385862] usb 2-1.5.3: New USB device strings: Mfr=1, Product=2, SerialNumber=3
498 [2097783.385864] usb 2-1.5.3: Product: FT232R USB UART
499 [2097783.385866] usb 2-1.5.3: Manufacturer: FTDI
500 [2097783.385867] usb 2-1.5.3: SerialNumber: AK04WWCE
501 [2097783.388288] ftdi_sio 2-1.5.3:1.0: FTDI USB Serial Device converter detected
502 [2097783.388330] usb 2-1.5.3: Detected FT232RL
503 [2097783.388658] usb 2-1.5.3: FTDI USB Serial Device converter now attached to ttyUSB0
504 ```
505 The device created is usually "/dev/ttyUSB0".
506 However, the number might vary depending on other USB serial ports connected to the host.
507
508 To use the link, you need to launch the client.
509 Here are three commands, which vary based on the serial client, that show
510 how to launch the client:
511
512 ```sh
513 $ picocom -b 115200 /dev/ttyUSB0
514 ```
515
516 or
517
518 ```sh
519 $ minicom -b 115200 -D /dev/ttyUSB0
520 ```
521
522 or
523
524 ```sh
525 $ screen /dev/ttyUSB0 115200
526 ```
527
528 ### Powering on the Board to Get a Shell at the Console
529
530 Both the Pro and Premier kits (e.g.
531 [m3ulcb](https://elinux.org/R-Car/Boards/M3SK) and
532 [h3ulcb](https://elinux.org/R-Car/Boards/H3SK#Hardware)) have nine
533 switches (SW1 through SW9).
534 To power on the board, "short-press" SW8, which is the power switch.
535
536 Following, is console output for the power on process for each kit:
537
538 **h3ulcb**:
539 ```text
540 NOTICE:  BL2: R-Car Gen3 Initial Program Loader(CA57) Rev.1.0.7
541 NOTICE:  BL2: PRR is R-Car H3 ES1.1
542 NOTICE:  BL2: LCM state is CM
543 NOTICE:  BL2: DDR1600(rev.0.15)
544 NOTICE:  BL2: DRAM Split is 4ch
545 NOTICE:  BL2: QoS is Gfx Oriented(rev.0.30)
546 NOTICE:  BL2: AVS setting succeeded. DVFS_SetVID=0x52
547 NOTICE:  BL2: Lossy Decomp areas
548 NOTICE:       Entry 0: DCMPAREACRAx:0x80000540 DCMPAREACRBx:0x570
549 NOTICE:       Entry 1: DCMPAREACRAx:0x40000000 DCMPAREACRBx:0x0
550 NOTICE:       Entry 2: DCMPAREACRAx:0x20000000 DCMPAREACRBx:0x0
551 NOTICE:  BL2: v1.1(release):41099f4
552 NOTICE:  BL2: Built : 19:20:52, Jun  9 2016
553 NOTICE:  BL2: Normal boot
554 NOTICE:  BL2: dst=0xe63150c8 src=0x8180000 len=36(0x24)
555 NOTICE:  BL2: dst=0x43f00000 src=0x8180400 len=3072(0xc00)
556 NOTICE:  BL2: dst=0x44000000 src=0x81c0000 len=65536(0x10000)
557 NOTICE:  BL2: dst=0x44100000 src=0x8200000 len=524288(0x80000)
558 NOTICE:  BL2: dst=0x49000000 src=0x8640000 len=1048576(0x100000)
559
560
561 U-Boot 2015.04 (Jun 09 2016 - 19:21:52)
562
563 CPU: Renesas Electronics R8A7795 rev 1.1
564 Board: H3ULCB
565 I2C:   ready
566 DRAM:  3.9 GiB
567 MMC:   sh-sdhi: 0, sh-sdhi: 1
568 In:    serial
569 Out:   serial
570 Err:   serial
571 Net:   Board Net Initialization Failed
572 No ethernet found.
573 Hit any key to stop autoboot:  0
574 =>
575 ```
576
577 **m3ulcb**:
578 ```text
579 NOTICE:  BL2: R-Car Gen3 Initial Program Loader(CA57) Rev.1.0.14
580 NOTICE:  BL2: PRR is R-Car M3 Ver1.0
581 NOTICE:  BL2: Board is Starter Kit Rev1.0
582 NOTICE:  BL2: Boot device is HyperFlash(80MHz)
583 NOTICE:  BL2: LCM state is CM
584 NOTICE:  BL2: AVS setting succeeded. DVFS_SetVID=0x52
585 NOTICE:  BL2: DDR1600(rev.0.22)NOTICE:  [COLD_BOOT]NOTICE:  ..0
586 NOTICE:  BL2: DRAM Split is 2ch
587 NOTICE:  BL2: QoS is default setting(rev.0.17)
588 NOTICE:  BL2: Lossy Decomp areas
589 NOTICE:       Entry 0: DCMPAREACRAx:0x80000540 DCMPAREACRBx:0x570
590 NOTICE:       Entry 1: DCMPAREACRAx:0x40000000 DCMPAREACRBx:0x0
591 NOTICE:       Entry 2: DCMPAREACRAx:0x20000000 DCMPAREACRBx:0x0
592 NOTICE:  BL2: v1.3(release):4eef9a2
593 NOTICE:  BL2: Built : 00:25:19, Aug 25 2017
594 NOTICE:  BL2: Normal boot
595 NOTICE:  BL2: dst=0xe631e188 src=0x8180000 len=512(0x200)
596 NOTICE:  BL2: dst=0x43f00000 src=0x8180400 len=6144(0x1800)
597 NOTICE:  BL2: dst=0x44000000 src=0x81c0000 len=65536(0x10000)
598 NOTICE:  BL2: dst=0x44100000 src=0x8200000 len=524288(0x80000)
599 NOTICE:  BL2: dst=0x50000000 src=0x8640000 len=1048576(0x100000)
600
601
602 U-Boot 2015.04-dirty (Aug 25 2017 - 10:55:49)
603
604 CPU: Renesas Electronics R8A7796 rev 1.0
605 Board: M3ULCB
606 I2C:   ready
607 DRAM:  1.9 GiB
608 MMC:   sh-sdhi: 0, sh-sdhi: 1
609 In:    serial
610 Out:   serial
611 Err:   serial
612 Net:   ravb
613 Hit any key to stop autoboot:  0
614 =>
615 ```
616
617 ## 9. Setting-up U-boot
618 ### Configuring U-Boot Parameters
619
620 Follow these steps to configure the board to use the MicroSD card as the
621 boot device and also to set the screen resolution:
622
623 1. As the board is powering up, press any key to stop the autoboot process.
624    You need to press a key quickly as you have just a few seconds in which to
625    press a key.
626
627 2. Once the autoboot process is interrupted, use the board's serial console to
628    enter `printenv` to check if you have correct parameters for booting your board:
629
630     Here is an example using the **h3ulcb** board:
631     ```sh
632     => printenv
633     baudrate=115200
634     bootargs=console=ttySC0,115200 root=/dev/mmcblk1p1 rootwait ro rootfstype=ext4
635     bootcmd=run load_ker; run load_dtb; booti 0x48080000 - 0x48000000
636     bootdelay=3
637     fdt_high=0xffffffffffffffff
638     initrd_high=0xffffffffffffffff
639     load_dtb=ext4load mmc 0:1 0x48000000 /boot/r8a7795-h3ulcb.dtb
640     load_ker=ext4load mmc 0:1 0x48080000 /boot/Image
641     stderr=serial
642     stdin=serial
643     stdout=serial
644     ver=U-Boot 2015.04 (Jun 09 2016 - 19:21:52)
645
646     Environment size: 648/131068 bytes
647     ```
648
649      Here is a second example using the **m3ulcb** board:
650     ```sh
651     baudrate=115200
652     bootargs=console=ttySC0,115200 root=/dev/mmcblk1p1 rootwait ro rootfstype=ext4
653     bootcmd=run load_ker; run load_dtb; booti 0x48080000 - 0x48000000
654     bootdelay=3
655     fdt_high=0xffffffffffffffff
656     filesize=cdeb
657     initrd_high=0xffffffffffffffff
658     load_dtb=ext4load mmc 0:1 0x48000000 /boot/r8a7796-m3ulcb.dtb
659     load_ker=ext4load mmc 0:1 0x48080000 /boot/Image
660     stderr=serial
661     stdin=serial
662     stdout=serial
663     ver=U-Boot 2015.04 (Nov 30 2016 - 18:25:18)
664
665     Environment size: 557/131068 bytes
666     ```
667
668 3. To boot your board using the MicroSD card, be sure your environment is set up
669    as follows:
670     ```sh
671     setenv bootargs console=ttySC0,115200 ignore_loglevel vmalloc=384M video=HDMI-A-1:1920x1080-32@60 root=/dev/mmcblk1p1 rw rootfstype=ext4 rootwait rootdelay=2
672     setenv bootcmd run load_ker\; run load_dtb\; booti 0x48080000 - 0x48000000
673     setenv load_ker ext4load mmc 0:1 0x48080000 /boot/Image
674     ```
675
676 4. Loading dtb :
677
678     **NOTE** : Refer [here](https://elinux.org/R-Car/Boards/Yocto-Gen3-CommonFAQ/Which_dtb_file_is_required_to_boot_linux_on_the_R-Car_Starter_Kit_board_%3F) for more information.
679
680     Make sure your ``load_dtb`` is set as follows :
681
682        * **H3SK v2.0(DDR 4GB)** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7795-h3ulcb.dtb`
683
684        * **H3SK v2.0(DDR 8GB)/v3.0(DDR 8GB)** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7795-h3ulcb-4x2g.dtb`
685
686        * **M3SK v1.0** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7796-m3ulcb.dtb`
687
688        * **M3SK v3.0** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7796-m3ulcb-2x4g.dtb`
689
690        * **H3SK with a Kingfisher board** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7795-h3ulcb-kf.dtb`
691
692        * **M3SK with a Kingfisher board** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7796-m3ulcb-kf.dtb`
693
694 5. Save the boot environment:
695     ```sh
696     saveenv
697     ```
698
699 6. Boot the board:
700    ```sh
701    run bootcmd
702    ```
703
704 ## 10. Troubleshooting
705 ### Logging Into the Console
706
707 Once the board boots, you should see the
708 [Wayland display](https://en.wikipedia.org/wiki/Wayland_(display_server_protocol))
709 on the external monitor.
710 A login prompt should appear as follows depending on your board:
711
712 **h3ulcb**:
713
714 ```text
715 Automotive Grade Linux ${AGL_VERSION} h3ulcb ttySC0
716
717 h3ulcb login: root
718 ```
719
720 **m3ulcb**:
721
722 ```text
723 Automotive Grade Linux ${AGL_VERSION} m3ulcb ttySC0
724
725 m3ulcb login: root
726 ```
727
728 At the prompt, login by using `root` as the login.
729 The password is "empty" so you should not be prompted for the password.
730
731 ### Determining the Board's IP Address
732
733 If your board is connected to a local network using Ethernet and
734 if a DHCP server is able to distribute IP addresses,
735 you can determine the board's IP address and log in using `ssh`.
736
737 Here is an example for the **m3ulcb** board:
738 ```sh
739 m3ulcb login: root
740 Last login: Tue Dec  6 09:55:15 UTC 2016 on tty2
741 root@m3ulcb:~# ip -4 a
742 1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default
743     inet 127.0.0.1/8 scope host lo
744       valid_lft forever preferred_lft forever
745 3: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
746     inet 10.0.0.27/24 brd 10.0.0.255 scope global eth0
747       valid_lft forever preferred_lft forever
748 root@m3ulcb:~#
749 ```
750
751 In the previous example, IP address is 10.0.0.27.
752 Once you know the address, you can use `ssh` to login.
753 Following is an example that shows logging into SSH and then
754 displaying the contents of the `/etc/os-release` file:
755 ```sh
756 $ ssh root@10.0.0.27
757 Last login: Tue Dec  6 10:01:11 2016 from 10.0.0.13
758 root@m3ulcb:~# cat /etc/os-release
759 ID="poky-agl"
760 NAME="Automotive Grade Linux"
761 VERSION="3.0.0+snapshot-20161202 (chinook)"
762 VERSION_ID="3.0.0-snapshot-20161202"
763 PRETTY_NAME="Automotive Grade Linux 3.0.0+snapshot-20161202 (chinook)"
764 ```
765
766 ## 11. Supplementary Information
767
768 ### R-Car Generation 3 Information
769
770 Refer to the [R-Car](https://elinux.org/R-Car) page on the
771 [elinux.org](https://elinux.org) website for more information.
772
773 ### Proprietary libraries for meta-rcar-gen3
774
775 The meta-rcar-gen3 layer of meta-renesas supports Graphic GLES(GSX)
776 libraries, proprietary multimedia libraries, and ICCOM software.
777
778 #### Build with Renesas multimedia libraries
779
780 Multimedia portions depend on GLES portions.
781
782 * A. Configuration for Multimedia features
783
784     * Please copy proprietary libraries to the directory of recipes.
785
786     * Please set local.conf the following.
787
788         **Enable multimedia features. This provides package group of plug-ins of the GStreamer, multimedia libraries and kernel drivers.**
789
790         ```sh
791         MACHINE_FEATURES_append = " multimedia"
792         ```
793
794 * B. Configuration for optional codecs and middleware
795
796     * Please copy proprietary libraries to the directory of recipes.
797
798     * Add features to `DISTRO_FEATURES_append` to local.conf
799
800         **Additional configuration in OMX module**:
801
802         ```text
803         " h263dec_lib"       - for OMX Media Component H263 Decoder Library
804         " h264dec_lib"       - for OMX Media Component H264 Decoder Library
805         " h264enc_lib"       - for OMX Media Component H.264 Encoder Library
806         " h265dec_lib"       - for OMX Media Component H265 Decoder Library
807         " mpeg2dec_lib"      - for OMX Media Component MPEG2 Decoder Library
808         " mpeg4dec_lib"      - for OMX Media Component MPEG4 Decoder Library
809         " vc1dec_lib"        - for OMX Media Component VC-1 Decoder Library
810         " divxdec_lib"       - for OMX Media Component DivX Decoder Library
811         " rvdec_lib"         - for OMX Media Component RealVideo Decoder Library
812         " alacdec_lib"       - for OMX Media Component ALAC Decoder Library
813         " flacdec_lib"       - for OMX Media Component FLAC Decoder Library
814         " aaclcdec_lib"      - for OMX Media Component AAC-LC Decoder Library
815         " aaclcdec_mdw"      - for AAC-LC 2ch Decoder Middleware for Linux
816         " aacpv2dec_lib"     - for OMX Media Component aacPlus V2 Decoder Library
817         " aacpv2dec_mdw"     - for aacPlus V2 Decoder Middleware for Linux
818         " mp3dec_lib"        - for OMX Media Component MP3 Decoder Library
819         " mp3dec_mdw"        - for MP3 Decoder Middleware for Linux
820         " wmadec_lib"        - for OMX Media Component WMA Standard Decoder Library
821         " wmadec_mdw"        - for WMA Standard Decoder Middleware for Linux
822         " dddec_lib"         - for OMX Media Component Dolby(R) Digital Decoder Library
823         " dddec_mdw"         - for Dolby(R) Digital Decoder Middleware for Linux
824         " aaclcenc_lib"      - for OMX Media Component AAC-LC Encoder Library
825         " vp8dec_lib"        - for OMX Media Component VP8 Decoder Library for Linux
826         " vp8enc_lib"        - for OMX Media Component VP8 Encoder Library for Linux
827         " vp9dec_lib"        - for OMX Media Component VP9 Decoder Library for Linux
828         " aaclcenc_mdw"      - for AAC-LC Encoder Middleware for Linux
829         " cmsbcm"            - for CMS Basic Color Management Middleware for Linux
830         " cmsblc"            - for CMS CMM3 Backlight Control Middleware for Linux
831         " cmsdgc"            - for CMS VSP2 Dynamic Gamma Correction Middleware for Linux
832         " dtv"               - for ISDB-T DTV Software Package for Linux
833         " dvd"               - for DVD Core-Middleware for Linux
834         " adsp"              - for ADSP driver, ADSP interface and ADSP framework for Linux
835         " avb"               - for AVB Software Package for Linux
836         ```
837         Example:
838         ```sh
839         DISTRO_FEATURES_append = " h264dec_lib h265dec_lib mpeg2dec_lib aaclcdec_lib aaclcdec_mdw"
840         ```
841
842 * C. Configuration for test packages
843
844     Must ensure that Multimedia features have been enabled.
845     (Please refer to III/A to enable Multimedia.)
846
847     * Please add feature to `DISTRO_FEATURES_append` to local.conf.
848
849         **Configuration for multimedia test package**
850         ```sh
851         DISTRO_FEATURES_append = " mm-test"
852         ```
853
854 #### Enable Linux ICCOM driver and Linux ICCOM library
855
856 For Linux ICCOM driver and Linux ICCOM library
857
858 * Please copy proprietary libraries to the directory of recipes.
859
860 * Please set the following in local.conf:
861     ```sh
862     DISTRO_FEATURES_append = "iccom"
863     ```