-# Building for Supported Renesas Boards
+---
+title: Building for Supported Renesas Boards
+---
AGL supports building for several automotive
[Renesas](https://www.renesas.com/us/en/solutions/automotive.html) board kits.
or the Reference Hardware System Architecture Expert Group
[wiki page](https://wiki.automotivelinux.org/eg-rhsa).
-## 1. Downloading Proprietary Drivers
+## 1. Prepare your build
+
+### 1.1 Downloading Proprietary Drivers
Before setting up the build environment, you need to download proprietary drivers from the
[R-Car H3/M3 Software library and Technical document](https://www.renesas.com/us/en/application/automotive/r-car-h3-m3-documents-software)
1. **Determine the Files You Need:**
- Run the ``setup_mm_packages.sh`` script as follows to
- display the list of ZIP files containing the drivers you need.
- Following is an example:
+ Run the ``setup_mm_packages.sh`` script as follows to
+ display the list of ZIP files containing the drivers you need.
+ Following is an example:
- ```sh
- grep -rn ZIP_.= $AGL_TOP/meta-agl/meta-agl-bsp/meta-rcar-gen3/scripts/setup_mm_packages.sh
- ```
+ ```sh
+ grep -rn ZIP_.= $AGL_TOP/meta-agl/meta-agl-bsp/meta-rcar-gen3/scripts/setup_mm_packages.sh
+ ```
- The script's output identifies the files you need to download from the page.
+ The script's output identifies the files you need to download from the page.
2. **Get Your Board Support Package (BSP) Version:**
Here is an example:
```sh
- $ export XDG_DOWNLOAD_DIR=$HOME/Downloads
+ export XDG_DOWNLOAD_DIR=$HOME/Downloads
```
5. **Be Sure the Files Have Rights:**
-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
```
-## 2. Getting More Software
+### 1.2. Getting More Software
1. **Get the `bmaptool`:**
The site has pre-built packages (DEB or RPM) for the supported host
operating systems.
-## 3. Getting Your Hardware Together
+### 1.3. Getting Your Hardware Together
Gather together this list of hardware items, which is not exhaustive.
Having these items ahead of time saves you from having to try and
collect hardware during development:
- * Supported Starter Kit Gen3 board with its 5V power supply.
- * Micro USB-A cable for serial console.
- This cable is optional if you are using Ethernet and an SSH connection.
- * USB 2.0 Hub. The hub is optional but makes it easy to connect multiple USB devices.
- * Ethernet cable. The cable is optional if you are using a serial console.
- * HDMI type D (Micro connector) cable and an associated display.
- * 4 Gbyte minimum MicroSD Card. It is recommended that you use a class 10 type.
- * USB touch screen device such as the GeChic 1502i/1503i. A touch screen device is optional.
+* Supported Starter Kit Gen3 board with its 5V power supply.
+* Micro USB-A cable for serial console.
+ This cable is optional if you are using Ethernet and an SSH connection.
+* USB 2.0 Hub. The hub is optional but makes it easy to connect multiple USB devices.
+* Ethernet cable. The cable is optional if you are using a serial console.
+* HDMI type D (Micro connector) cable and an associated display.
+* 4 Gbyte minimum MicroSD Card. It is recommended that you use a class 10 type.
+* USB touch screen device such as the GeChic 1502i/1503i. A touch screen device is optional.
- **NOTE:** The Salvator-X Board has NDA restrictions.
- Consequently, less documentation is available for this board both here and across the
- Internet.
+**NOTE:** The Salvator-X Board has NDA restrictions.
+Consequently, less documentation is available for this board both here and across the
+Internet.
-
-## 4. Making Sure Your Build Environment is Correct
+### 1.4. Making Sure Your Build Environment is Correct
The
"[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)"
for the Starter Kit Premier/H3 Board:
```sh
- $ export MACHINE=h3ulcb
- ```
-
-2. **Run the `aglsetup.sh` Script:**
-
- Use the following commands to run the AGL Setup script:
-
- ```sh
- $ cd $AGL_TOP
- $ source meta-agl/scripts/aglsetup.sh -m $MACHINE -b build agl-devel agl-demo
+ export MACHINE=h3ulcb
```
- If building for the AGL Reference Hardware (with `MACHINE` set to "h3ulcb" or
- "h3ulcb-nogfx"), add `agl-refhw-h3`, for example:
-
- ```sh
- $ cd $AGL_TOP
- $ source meta-agl/scripts/aglsetup.sh -m $MACHINE -b build agl-devel agl-demo agl-refhw-h3
- ```
-
- **NOTE:**
- Running the `aglsetup.sh` script automatically places you in the
- working directory (i.e. `$AGL_TOP/build`).
- You can change this default behavior by adding the "-f" option to the
- script's command line.
-
- In the previous command, the "-m" option sets your machine to the previously
- defined `MACHINE` variable.
- The "-b" option defines your Build Directory, which is the
- default `$AGL_TOP/build`.
- Finally, the AGL features are provided to support building the AGL Demo image
- for the Renesas board.
-
- You can learn more about the AGL Features in the
- "[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)"
- section.
-
-3. **Examine the Script's Log:**
-
- Running the `aglsetup.sh` script creates the `setup.log` file, which is in
- the `build/conf` folder.
- You can examine this log to see the results of the script.
- For example, suppose the graphics drivers were missing or could not be extracted
- when you ran the script.
- In case of missing graphics drivers, you could notice an error message
- similar to the following:
- ```text
- [snip]
- --- fragment /home/working/workspace_agl_master/meta-agl/templates/machine/h3ulcb/50_setup.sh
- /home/working/workspace_agl_master /home/working/workspace_agl_master/build_gen3
- The graphics and multimedia acceleration packages for
- the R-Car Gen3 board can be downloaded from:
- https://www.renesas.com/en-us/solutions/automotive/rcar-demoboard-2.html
-
- These 2 files from there should be store in your'/home/devel/Downloads' directory.
- R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip
- R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip
- /home/working/workspace_agl_master/build_gen3
- --- fragment /home/working/workspace_agl_master/meta-agl/templates/base/99_setup_EULAconf.sh
- --- end of setup script
- OK
- Generating setup file: /home/working/workspace_agl_master/build_gen3/agl-init-build-env ... OK
- ------------ aglsetup.sh: Done
- [snip]
- ```
-
- If you encounter this issue, or any other unwanted behavior, you can fix the error
- mentioned, remove the `$AGL_TOP/build` directory, and then re-launch the
- `aglsetup.sh` again.
-
- Here is another example that indicates the driver files could not be extracted from the downloads directory:
- ```
- ~/workspace_agl/build/conf $ cat setup.log
- --- beginning of setup script
- --- fragment /home/working/workspace_agl/meta-agl/templates/base/01_setup_EULAfunc.sh
- --- fragment /home/working/workspace_agl/meta-agl/templates/machine/h3ulcb/50_setup.sh
- ~/workspace_agl ~/workspace_agl/build
- ERROR: FILES "+/home/working/Downloads/R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip+" NOT EXTRACTING CORRECTLY
- ERROR: FILES "+/home/working/Downloads/R-car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip+" NOT EXTRACTING CORRECTLY
- The graphics and multimedia acceleration packages for
- the R-Car Gen3 board BSP can be downloaded from:
- <https://www.renesas.com/us/en/application/automotive/r-car-h3-m3-documents-software>
-
- These 2 files from there should be stored in your
- '/home/working/Downloads' directory.
- R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip
- R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip
- ERROR: Script /home/working/workspace_agl/build/conf/setup.sh failed
- [snip]
- ```
+### 1.5. **Run the `aglsetup.sh` Script:**
-## 5. Checking Your Configuration
-
-Aside from environment variables and parameters you establish through
-running the `aglsetup.sh` script, you can ensure your build's configuration
-is just how you want it by examining the `local.conf` configuration file.
-
-You can find this configuration file in the Build Directory (e.g.
-`$TOP_DIR/build/conf/local.conf`).
-
-In general, the defaults along with the configuration fragments the
-`aglsetup.sh` script applies in the `local.conf` file are good enough.
-However, you can customize aspects by editing the `local.conf` file.
-See the
-"[Customizing Your Build](4_Customizing_Your_Build.md)"
-section for common configurations you might want to consider.
-
-**NOTE:** For detailed explanations of the configurations you can make
-in the ``local.conf`` file, consult the
-[Yocto Project Documentation](https://www.yoctoproject.org/docs/).
-
-A quick way to see if you have the `$MACHINE` variable set correctly
-is to use the following command:
+Use the following commands to run the AGL Setup script:
```sh
-grep -w -e "^MACHINE =" $AGL_TOP/build/conf/local.conf
+cd $AGL_TOP
+source meta-agl/scripts/aglsetup.sh -m $MACHINE -b build agl-devel agl-demo
```
-Depending on the Renesas board you are using, you should see output
-as follows:
+If building for the AGL Reference Hardware (with `MACHINE` set to "h3ulcb" or
+"h3ulcb-nogfx"), add `agl-refhw-h3`, for example:
```sh
-MACHINE = "h3ulcb"
-```
-or
-```sh
-MACHINE = "m3ulcb"
-```
-or
-```sh
-MACHINE = "h3-salvator-x"
+cd $AGL_TOP
+source meta-agl/scripts/aglsetup.sh -m $MACHINE -b build agl-devel agl-demo agl-refhw-h3
```
-If you ran the `aglsetup.sh` script as described in the
-"[Making Sure Your Build Environment is Correct](./5_3_RCar_Gen_3.md#4-making-sure-your-build-environment-is-correct)"
-section earlier, the "agl-devel", "agl-demo", "agl-netboot", "agl-appfw-smack", and
-"agl-localdev" AGL features will be in effect.
-These features provide the following:
+**NOTE:**
+You can check if your logs match what is expected in the [troubleshooting section](#4-troubleshooting).
-* A debugger (gdb)
-* Some tweaks, including a disabled root password
-* A SFTP server
-* The TCF Agent for easier application deployment and remote debugging
-* Some extra system tools such as USB and bluetooth
-* Support for the AGL demo platform
-* Network boot support through TFTP and NBD protocols
-* [IoT.bzh](https://iot.bzh/en/) Application Framework plus
- [SMACK](https://en.wikipedia.org/wiki/Smack_(software)) and
- [Cynara](https://wiki.tizen.org/Security:Cynara)
-* Support for local development including `localdev.inc` when present
+Running the `aglsetup.sh` script automatically places you in the
+working directory (i.e. `$AGL_TOP/build`).
+You can change this default behavior by adding the "-f" option to the
+script's command line.
+
+In the previous command, the "-m" option sets your machine to the previously
+defined `MACHINE` variable.
+The "-b" option defines your Build Directory, which is the
+default `$AGL_TOP/build`.
+Finally, the AGL features are provided to support building the AGL Demo image
+for the Renesas board.
+
+You can learn more about the AGL Features in the
+"[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)"
+section.
-## 6. Using BitBake
+## 2. Using BitBake
This section shows the `bitbake` command used to build the AGL image.
Before running BitBake to start your build, it is good to be reminded that AGL
The build process puts the resulting image in the Build Directory:
-```
+```sh
<build_directory>/tmp/deploy/images/$MACHINE
```
-## 7. Booting the Image Using a MicroSD Card
+## 3. Deploying the AGL Demo Image
To boot your image on the Renesas board, you need to do three things:
-1. Update all firmware on the board.
+1. [Update all firmware on the board.](#4-troubleshooting)
2. Prepare the MicroSD card to you can boot from it.
3. Boot the board.
**NOTE:** For subsequent builds, you only have to re-write the MicroSD
card with a new image.
-### Updating the Board's Firmware
-
-Follow these steps to update the firmware:
-
-1. **Update the Sample Loader and MiniMonitor:**
+### 3.1. Booting the Image Using a MicroSD Card
- You only need to make these updates one time per device.
-
- Follow the procedure found on the
- eLinux.org wiki to update to at least version 3.02,
- which is mandatory to run the AGL image
- ([R-car loader update](https://elinux.org/R-Car/Boards/Kingfisher#How_to_update_of_Sample_Loader_and_MiniMonitor)).
+1. Preparing the MicroSD Card
-2. **Update the Firmware Stack:**
-
- You only need to update the firmware stack if you are
- using the Eel or later (5.0) version of AGL software.
-
- M3 and H3 Renesas board are AArch64 platforms.
- As such, they have a firmware stack that is divided across: **ARM Trusted Firmware**, **OP-Tee** and **U-Boot**.
-
- If you are using the Eel (5.0) version or later of the AGL software, you must update
- the firmware using the **[h3ulcb] [R-car h3ulcb firmware update](http://elinux.org/R-Car/Boards/H3SK#Flashing_firmware)**
- or **[m3ulcb] [R-car m3ulcb firmware update](https://elinux.org/R-Car/Boards/M3SK#Flashing_firmware)** links from the
- [Embedded Linux Wiki](https://www.elinux.org/Main_Page) (i.e. `elinux.org`).
-
- The table in the wiki lists the files you need to flash the firmware.
- You can find these files in the following directory:
+ Plug the MicroSD card into your Build Host.
+ After plugging in the device, use the `dmesg` command as follows to
+ discover the device name:
```sh
- $AGL_TOP/build/tmp/deploy/images/$MACHINE
+ $ dmesg | tail -4
+ [ 1971.462160] sd 6:0:0:0: [sdc] Mode Sense: 03 00 00 00
+ [ 1971.462277] sd 6:0:0:0: [sdc] No Caching mode page found
+ [ 1971.462278] sd 6:0:0:0: [sdc] Assuming drive cache: write through
+ [ 1971.463870] sdc: sdc1 sdc2
```
- **NOTE:** The Salvator-X firmware update process is not documented on eLinux.
- **NOTE:** The AGL Reference Hardware board generally should not require a
- firmware update to be usable, and has a slightly different update procedure.
- If you do need to update the firmware, the procedure is documented
- [here](https://git.automotivelinux.org/AGL/meta-agl-refhw/tree/meta-agl-refhw-gen3/docs/ReferenceHW_Rcar_gen3.md).
+ In the previous example, the MicroSD card is attached to the device `/dev/sdc`.
+ You can also use the `lsblk` command to show all your devices.
+ Here is an example that shows the MicroSD card as `/dev/sdc`:
-### Preparing the MicroSD Card
+ ```sh
+ $ lsblk
+ NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
+ sda 8:0 0 167,7G 0 disk
+ ├─sda1 8:1 0 512M 0 part /boot/efi
+ ├─sda2 8:2 0 159,3G 0 part /
+ └─sda3 8:3 0 7,9G 0 part [SWAP]
+ sdb 8:16 0 931,5G 0 disk
+ └─sdb1 8:17 0 931,5G 0 part /media/storage
+ sdc 8:32 1 14,9G 0 disk
+ ├─sdc1 8:33 1 40M 0 part
+ └─sdc2 8:34 1 788M 0 part
+ ```
-Plug the MicroSD card into your Build Host.
-After plugging in the device, use the `dmesg` command as follows to
-discover the device name:
-```sh
-$ dmesg | tail -4
-[ 1971.462160] sd 6:0:0:0: [sdc] Mode Sense: 03 00 00 00
-[ 1971.462277] sd 6:0:0:0: [sdc] No Caching mode page found
-[ 1971.462278] sd 6:0:0:0: [sdc] Assuming drive cache: write through
-[ 1971.463870] sdc: sdc1 sdc2
-```
-In the previous example, the MicroSD card is attached to the device `/dev/sdc`.
-You can also use the `lsblk` command to show all your devices.
-Here is an example that shows the MicroSD card as `/dev/sdc`:
-```sh
-$ lsblk
- NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
- sda 8:0 0 167,7G 0 disk
- ├─sda1 8:1 0 512M 0 part /boot/efi
- ├─sda2 8:2 0 159,3G 0 part /
- └─sda3 8:3 0 7,9G 0 part [SWAP]
- sdb 8:16 0 931,5G 0 disk
- └─sdb1 8:17 0 931,5G 0 part /media/storage
- sdc 8:32 1 14,9G 0 disk
- ├─sdc1 8:33 1 40M 0 part
- └─sdc2 8:34 1 788M 0 part
-```
-**IMPORTANT NOTE:** Before re-writing any device on your Build Host, you need to
-be sure you are actually writing to the removable MicroSD card and not some other
-device.
-Each computer is different and removable devices can change from time to time.
-Consequently, you should repeat the previous operation with the MicroSD card to
-confirm the device name every time you write to the card.
+ **IMPORTANT NOTE:** Before re-writing any device on your Build Host, you need to
+ be sure you are actually writing to the removable MicroSD card and not some other
+ device.
+ Each computer is different and removable devices can change from time to time.
+ Consequently, you should repeat the previous operation with the MicroSD card to
+ confirm the device name every time you write to the card.
-To summarize this example so far, we have the following:
+ To summarize this example so far, we have the following:
-* The first SATA drive is `/dev/sda`.
+ * The first SATA drive is `/dev/sda`.
-* `/dev/sdc` corresponds to the MicroSD card, and is also marked as a removable device.
- You can see this in the output of the `lsblk` command where "1" appears in the "RM" column
- for that device.
+ * `/dev/sdc` corresponds to the MicroSD card, and is also marked as a removable device.
+ You can see this in the output of the `lsblk` command where "1" appears in the "RM" column
+ for that device.
-Now that you have identified the device you are going to be writing the image on,
-you can use the `bmaptool` to copy the image to the MicroSD card.
+ Now that you have identified the device you are going to be writing the image on,
+ you can use the `bmaptool` to copy the image to the MicroSD card.
-Your desktop system might offer a choice to mount the MicroSD automatically
-in some directory.
-For this example, assume that the MicroSD card mount directory is stored in the
-`$SDCARD` variable.
+ Your desktop system might offer a choice to mount the MicroSD automatically
+ in some directory.
+ For this example, assume that the MicroSD card mount directory is stored in the
+ `$SDCARD` variable.
-Following are example commands that write the image to the MicroSD card:
+ Following are example commands that write the image to the MicroSD card:
-```sh
-cd $AGL_TOP/build/tmp/deploy/images/$MACHINE
-bmaptool copy ./agl-demo-platform-$MACHINE.wic.xz <boot_device_name>
-```
+ ```sh
+ cd $AGL_TOP/build/tmp/deploy/images/$MACHINE
+ bmaptool copy ./agl-demo-platform-$MACHINE.wic.xz <boot_device_name>
+ ```
-Alternatively, you can leave the image in an uncompressed state and write it
-to the MicroSD card:
+ Alternatively, you can leave the image in an uncompressed state and write it
+ to the MicroSD card:
-```sh
-sudo umount <boot_device_name>
-xzcat ./agl-demo-platform-$MACHINE.wic.xz | sudo dd of=<boot_device_name> bs=4M
-sync
-```
+ ```sh
+ sudo umount <boot_device_name>
+ xzcat ./agl-demo-platform-$MACHINE.wic.xz | sudo dd of=<boot_device_name> bs=4M
+ sync
+ ```
-### Booting the Board
+2. Booting the Board
-Follow these steps to boot the board:
+ Follow these steps to boot the board:
-1. Use the board's power switch to turn off the board.
+ 1. Use the board's power switch to turn off the board.
-2. Insert the MicroSD card into the board.
+ 2. Insert the MicroSD card into the board.
-3. Verify that you have plugged in the following:
+ 3. Verify that you have plugged in the following:
- * An external monitor into the board's HDMI port
+ * An external monitor into the board's HDMI port
- * An input device (e.g. keyboard, mouse, touchscreen, and so forth) into the board's USB ports.
+ * An input device (e.g. keyboard, mouse, touchscreen, and so forth) into the board's USB ports.
-4. Use the board's power switch to turn on the board.
+ 4. Use the board's power switch to turn on the board.
-After a few seconds, you will see the AGL splash screen on the display and you
-will be able to log in at the console's terminal or using the graphic screen.
+ After a few seconds, you will see the AGL splash screen on the display and you
+ will be able to log in at the console's terminal or using the graphic screen.
-## 8. Setting Up the Serial Console
+### 3.2. Setting Up the Serial Console
Setting up the Serial Console involves the following:
* Logging into the console
* Determining the board's IP address
-### Installing a Serial Client on Your Build Host
+1. Installing a Serial Client on Your Build Host
-You need to install a serial client on your build host.
-Some examples are:
+ You need to install a serial client on your build host.
+ Some examples are:
-* [GNU Screen](https://en.wikipedia.org/wiki/GNU_Screen)
-* [picocom](https://linux.die.net/man/8/picocom)
-* [Minicom](https://en.wikipedia.org/wiki/Minicom)
+ * [GNU Screen](https://en.wikipedia.org/wiki/GNU_Screen)
+ * [picocom](https://linux.die.net/man/8/picocom)
+ * [Minicom](https://en.wikipedia.org/wiki/Minicom)
-Of these three, "picocom" has the least dependencies and is therefore
-considered the "lightest" solution.
+ Of these three, "picocom" has the least dependencies and is therefore
+ considered the "lightest" solution.
-### Connecting Your Build Host to Your Renesas Board's Serial Port
+2. Connecting Your Build Host to Your Renesas Board's Serial Port
-You need to physically connect your build host to the Renesas board using
-a USB cable from the host to the serial CP2102 USP port (i.e. Micro USB-A port)
-on the Renesas board.
+ You need to physically connect your build host to the Renesas board using
+ a USB cable from the host to the serial CP2102 USP port (i.e. Micro USB-A port)
+ on the Renesas board.
-Once you connect the board, determine the device created for the serial link.
-Use the ``dmesg`` command on your build host.
-Here is an example:
-```sh
-dmesg | tail 9
-[2097783.287091] usb 2-1.5.3: new full-speed USB device number 24 using ehci-pci
-[2097783.385857] usb 2-1.5.3: New USB device found, idVendor=0403, idProduct=6001
-[2097783.385862] usb 2-1.5.3: New USB device strings: Mfr=1, Product=2, SerialNumber=3
-[2097783.385864] usb 2-1.5.3: Product: FT232R USB UART
-[2097783.385866] usb 2-1.5.3: Manufacturer: FTDI
-[2097783.385867] usb 2-1.5.3: SerialNumber: AK04WWCE
-[2097783.388288] ftdi_sio 2-1.5.3:1.0: FTDI USB Serial Device converter detected
-[2097783.388330] usb 2-1.5.3: Detected FT232RL
-[2097783.388658] usb 2-1.5.3: FTDI USB Serial Device converter now attached to ttyUSB0
-```
-The device created is usually "/dev/ttyUSB0".
-However, the number might vary depending on other USB serial ports connected to the host.
+ Once you connect the board, determine the device created for the serial link.
+ Use the ``dmesg`` command on your build host.
+ Here is an example:
-To use the link, you need to launch the client.
-Here are three commands, which vary based on the serial client, that show
-how to launch the client:
+ ```sh
+ dmesg | tail 9
+ [2097783.287091] usb 2-1.5.3: new full-speed USB device number 24 using ehci-pci
+ [2097783.385857] usb 2-1.5.3: New USB device found, idVendor=0403, idProduct=6001
+ [2097783.385862] usb 2-1.5.3: New USB device strings: Mfr=1, Product=2, SerialNumber=3
+ [2097783.385864] usb 2-1.5.3: Product: FT232R USB UART
+ [2097783.385866] usb 2-1.5.3: Manufacturer: FTDI
+ [2097783.385867] usb 2-1.5.3: SerialNumber: AK04WWCE
+ [2097783.388288] ftdi_sio 2-1.5.3:1.0: FTDI USB Serial Device converter detected
+ [2097783.388330] usb 2-1.5.3: Detected FT232RL
+ [2097783.388658] usb 2-1.5.3: FTDI USB Serial Device converter now attached to ttyUSB0
+ ```
-```sh
-$ picocom -b 115200 /dev/ttyUSB0
-```
+ The device created is usually "/dev/ttyUSB0".
+ However, the number might vary depending on other USB serial ports connected to the host.
-or
+ To use the link, you need to launch the client.
+ Here are three commands, which vary based on the serial client, that show
+ how to launch the client:
-```sh
-$ minicom -b 115200 -D /dev/ttyUSB0
-```
+ ```sh
+ picocom -b 115200 /dev/ttyUSB0
+ ```
-or
+ or
-```sh
-$ screen /dev/ttyUSB0 115200
-```
+ ```sh
+ minicom -b 115200 -D /dev/ttyUSB0
+ ```
-### Powering on the Board to Get a Shell at the Console
+ or
-Both the Pro and Premier kits (e.g.
-[m3ulcb](https://elinux.org/R-Car/Boards/M3SK) and
-[h3ulcb](https://elinux.org/R-Car/Boards/H3SK#Hardware)) have nine
-switches (SW1 through SW9).
-To power on the board, "short-press" SW8, which is the power switch.
+ ```sh
+ screen /dev/ttyUSB0 115200
+ ```
-Following, is console output for the power on process for each kit:
+3. Powering on the Board to Get a Shell at the Console
-**h3ulcb**:
-```text
-NOTICE: BL2: R-Car Gen3 Initial Program Loader(CA57) Rev.1.0.7
-NOTICE: BL2: PRR is R-Car H3 ES1.1
-NOTICE: BL2: LCM state is CM
-NOTICE: BL2: DDR1600(rev.0.15)
-NOTICE: BL2: DRAM Split is 4ch
-NOTICE: BL2: QoS is Gfx Oriented(rev.0.30)
-NOTICE: BL2: AVS setting succeeded. DVFS_SetVID=0x52
-NOTICE: BL2: Lossy Decomp areas
-NOTICE: Entry 0: DCMPAREACRAx:0x80000540 DCMPAREACRBx:0x570
-NOTICE: Entry 1: DCMPAREACRAx:0x40000000 DCMPAREACRBx:0x0
-NOTICE: Entry 2: DCMPAREACRAx:0x20000000 DCMPAREACRBx:0x0
-NOTICE: BL2: v1.1(release):41099f4
-NOTICE: BL2: Built : 19:20:52, Jun 9 2016
-NOTICE: BL2: Normal boot
-NOTICE: BL2: dst=0xe63150c8 src=0x8180000 len=36(0x24)
-NOTICE: BL2: dst=0x43f00000 src=0x8180400 len=3072(0xc00)
-NOTICE: BL2: dst=0x44000000 src=0x81c0000 len=65536(0x10000)
-NOTICE: BL2: dst=0x44100000 src=0x8200000 len=524288(0x80000)
-NOTICE: BL2: dst=0x49000000 src=0x8640000 len=1048576(0x100000)
-
-
-U-Boot 2015.04 (Jun 09 2016 - 19:21:52)
-
-CPU: Renesas Electronics R8A7795 rev 1.1
-Board: H3ULCB
-I2C: ready
-DRAM: 3.9 GiB
-MMC: sh-sdhi: 0, sh-sdhi: 1
-In: serial
-Out: serial
-Err: serial
-Net: Board Net Initialization Failed
-No ethernet found.
-Hit any key to stop autoboot: 0
-=>
-```
+ Both the Pro and Premier kits (e.g.
+ [m3ulcb](https://elinux.org/R-Car/Boards/M3SK) and
+ [h3ulcb](https://elinux.org/R-Car/Boards/H3SK#Hardware)) have nine
+ switches (SW1 through SW9).
+ To power on the board, "short-press" SW8, which is the power switch.
-**m3ulcb**:
-```text
-NOTICE: BL2: R-Car Gen3 Initial Program Loader(CA57) Rev.1.0.14
-NOTICE: BL2: PRR is R-Car M3 Ver1.0
-NOTICE: BL2: Board is Starter Kit Rev1.0
-NOTICE: BL2: Boot device is HyperFlash(80MHz)
-NOTICE: BL2: LCM state is CM
-NOTICE: BL2: AVS setting succeeded. DVFS_SetVID=0x52
-NOTICE: BL2: DDR1600(rev.0.22)NOTICE: [COLD_BOOT]NOTICE: ..0
-NOTICE: BL2: DRAM Split is 2ch
-NOTICE: BL2: QoS is default setting(rev.0.17)
-NOTICE: BL2: Lossy Decomp areas
-NOTICE: Entry 0: DCMPAREACRAx:0x80000540 DCMPAREACRBx:0x570
-NOTICE: Entry 1: DCMPAREACRAx:0x40000000 DCMPAREACRBx:0x0
-NOTICE: Entry 2: DCMPAREACRAx:0x20000000 DCMPAREACRBx:0x0
-NOTICE: BL2: v1.3(release):4eef9a2
-NOTICE: BL2: Built : 00:25:19, Aug 25 2017
-NOTICE: BL2: Normal boot
-NOTICE: BL2: dst=0xe631e188 src=0x8180000 len=512(0x200)
-NOTICE: BL2: dst=0x43f00000 src=0x8180400 len=6144(0x1800)
-NOTICE: BL2: dst=0x44000000 src=0x81c0000 len=65536(0x10000)
-NOTICE: BL2: dst=0x44100000 src=0x8200000 len=524288(0x80000)
-NOTICE: BL2: dst=0x50000000 src=0x8640000 len=1048576(0x100000)
-
-
-U-Boot 2015.04-dirty (Aug 25 2017 - 10:55:49)
-
-CPU: Renesas Electronics R8A7796 rev 1.0
-Board: M3ULCB
-I2C: ready
-DRAM: 1.9 GiB
-MMC: sh-sdhi: 0, sh-sdhi: 1
-In: serial
-Out: serial
-Err: serial
-Net: ravb
-Hit any key to stop autoboot: 0
-=>
-```
+ Following, is console output for the power on process for each kit:
+
+ **h3ulcb**:
-## 9. Setting-up U-boot
-### Configuring U-Boot Parameters
+ ```text
+ NOTICE: BL2: R-Car Gen3 Initial Program Loader(CA57) Rev.1.0.7
+ NOTICE: BL2: PRR is R-Car H3 ES1.1
+ NOTICE: BL2: LCM state is CM
+ NOTICE: BL2: DDR1600(rev.0.15)
+ NOTICE: BL2: DRAM Split is 4ch
+ NOTICE: BL2: QoS is Gfx Oriented(rev.0.30)
+ NOTICE: BL2: AVS setting succeeded. DVFS_SetVID=0x52
+ NOTICE: BL2: Lossy Decomp areas
+ NOTICE: Entry 0: DCMPAREACRAx:0x80000540 DCMPAREACRBx:0x570
+ NOTICE: Entry 1: DCMPAREACRAx:0x40000000 DCMPAREACRBx:0x0
+ NOTICE: Entry 2: DCMPAREACRAx:0x20000000 DCMPAREACRBx:0x0
+ NOTICE: BL2: v1.1(release):41099f4
+ NOTICE: BL2: Built : 19:20:52, Jun 9 2016
+ NOTICE: BL2: Normal boot
+ NOTICE: BL2: dst=0xe63150c8 src=0x8180000 len=36(0x24)
+ NOTICE: BL2: dst=0x43f00000 src=0x8180400 len=3072(0xc00)
+ NOTICE: BL2: dst=0x44000000 src=0x81c0000 len=65536(0x10000)
+ NOTICE: BL2: dst=0x44100000 src=0x8200000 len=524288(0x80000)
+ NOTICE: BL2: dst=0x49000000 src=0x8640000 len=1048576(0x100000)
+
+
+ U-Boot 2015.04 (Jun 09 2016 - 19:21:52)
+
+ CPU: Renesas Electronics R8A7795 rev 1.1
+ Board: H3ULCB
+ I2C: ready
+ DRAM: 3.9 GiB
+ MMC: sh-sdhi: 0, sh-sdhi: 1
+ In: serial
+ Out: serial
+ Err: serial
+ Net: Board Net Initialization Failed
+ No ethernet found.
+ Hit any key to stop autoboot: 0
+ =>
+ ```
+
+### 3.3. Setting-up U-boot
+
+Configuring U-Boot Parameters
Follow these steps to configure the board to use the MicroSD card as the
boot device and also to set the screen resolution:
1. As the board is powering up, press any key to stop the autoboot process.
- You need to press a key quickly as you have just a few seconds in which to
- press a key.
+You need to press a key quickly as you have just a few seconds in which to
+press a key.
2. Once the autoboot process is interrupted, use the board's serial console to
- enter `printenv` to check if you have correct parameters for booting your board:
+enter `printenv` to check if you have correct parameters for booting your board:
Here is an example using the **h3ulcb** board:
+
```sh
=> printenv
baudrate=115200
Environment size: 648/131068 bytes
```
- Here is a second example using the **m3ulcb** board:
- ```sh
- baudrate=115200
- bootargs=console=ttySC0,115200 root=/dev/mmcblk1p1 rootwait ro rootfstype=ext4
- bootcmd=run load_ker; run load_dtb; booti 0x48080000 - 0x48000000
- bootdelay=3
- fdt_high=0xffffffffffffffff
- filesize=cdeb
- initrd_high=0xffffffffffffffff
- load_dtb=ext4load mmc 0:1 0x48000000 /boot/r8a7796-m3ulcb.dtb
- load_ker=ext4load mmc 0:1 0x48080000 /boot/Image
- stderr=serial
- stdin=serial
- stdout=serial
- ver=U-Boot 2015.04 (Nov 30 2016 - 18:25:18)
-
- Environment size: 557/131068 bytes
- ```
-
3. To boot your board using the MicroSD card, be sure your environment is set up
- as follows:
+as follows:
+
```sh
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
setenv bootcmd run load_ker\; run load_dtb\; booti 0x48080000 - 0x48000000
Make sure your ``load_dtb`` is set as follows :
- * **H3SK v2.0(DDR 4GB)** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7795-h3ulcb.dtb`
+ | Renesas Boards | DTB Name |
+ |:-:|:-:|
+ | **H3SK v2.0(DDR 4GB)** | r8a7795-h3ulcb.dtb |
+ | **H3SK v2.0(DDR 8GB)/v3.0(DDR 8GB)** | r8a7795-h3ulcb-4x2g.dtb |
+ | **M3SK v1.0** | r8a7796-m3ulcb.dtb |
+ | **M3SK v3.0** | r8a7796-m3ulcb-2x4g.dtb |
+ | **H3SK with a Kingfisher board** | r8a7795-h3ulcb-kf.dtb |
+ | **M3SK with a Kingfisher board** | r8a7796-m3ulcb-kf.dtb |
+ | **AGL Reference Hardware board** | r8a7795-agl-refhw.dtb |
- * **H3SK v2.0(DDR 8GB)/v3.0(DDR 8GB)** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7795-h3ulcb-4x2g.dtb`
+ ```sh
+ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7795-h3ulcb-kf.dtb
+ ```
- * **M3SK v1.0** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7796-m3ulcb.dtb`
+5. Save the boot environment:
- * **M3SK v3.0** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7796-m3ulcb-2x4g.dtb`
+ ```sh
+ saveenv
+ ```
- * **H3SK with a Kingfisher board** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7795-h3ulcb-kf.dtb`
+6. Boot the board:
- * **M3SK with a Kingfisher board** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7796-m3ulcb-kf.dtb`
+ ```sh
+ run bootcmd
+ ```
- * **AGL Reference Hardware board** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7795-agl-refhw.dtb`
+## 4. Troubleshooting
+
+### 4.1. Checking Your Configuration
+
+Aside from environment variables and parameters you establish through
+running the `aglsetup.sh` script, you can ensure your build's configuration
+is just how you want it by examining the `local.conf` configuration file.
+
+You can find this configuration file in the Build Directory (e.g.
+`$TOP_DIR/build/conf/local.conf`).
+
+In general, the defaults along with the configuration fragments the
+`aglsetup.sh` script applies in the `local.conf` file are good enough.
+However, you can customize aspects by editing the `local.conf` file.
+See the
+"[Customizing Your Build](4_Customizing_Your_Build.md)"
+section for common configurations you might want to consider.
+
+**NOTE:** For detailed explanations of the configurations you can make
+in the ``local.conf`` file, consult the
+[Yocto Project Documentation](https://www.yoctoproject.org/docs/).
+
+A quick way to see if you have the `$MACHINE` variable set correctly
+is to use the following command:
+
+```sh
+grep -w -e "^MACHINE =" $AGL_TOP/build/conf/local.conf
+```
+
+Depending on the Renesas board you are using, you should see output
+as follows:
+
+```sh
+MACHINE = "h3ulcb"
+```
+
+or
+
+```sh
+MACHINE = "m3ulcb"
+```
+
+or
+
+```sh
+MACHINE = "h3-salvator-x"
+```
+
+If you ran the `aglsetup.sh` script as described in the
+"[Making Sure Your Build Environment is Correct](./5_3_RCar_Gen_3.md#4-making-sure-your-build-environment-is-correct)"
+section earlier, the "agl-devel", "agl-demo", "agl-netboot", "agl-appfw-smack", and
+"agl-localdev" AGL features will be in effect.
+These features provide the following:
+
+* A debugger (gdb)
+* Some tweaks, including a disabled root password
+* A SFTP server
+* The TCF Agent for easier application deployment and remote debugging
+* Some extra system tools such as USB and bluetooth
+* Support for the AGL demo platform
+* Network boot support through TFTP and NBD protocols
+* [IoT.bzh](https://iot.bzh/en/) Application Framework plus
+[SMACK](https://en.wikipedia.org/wiki/Smack_(software)) and
+[Cynara](https://wiki.tizen.org/Security:Cynara)
+* Support for local development including `localdev.inc` when present
+
+### 4.2. Check the Script's Log:
+
+Running the `aglsetup.sh` script creates the `setup.log` file, which is in
+the `build/conf` folder.
+You can examine this log to see the results of the script.
+For example, suppose the graphics drivers were missing or could not be extracted
+when you ran the script.
+In case of missing graphics drivers, you could notice an error message
+similar to the following:
+
+```text
+[snip]
+--- fragment /home/working/workspace_agl_master/meta-agl/templates/machine/h3ulcb/50_setup.sh
+/home/working/workspace_agl_master /home/working/workspace_agl_master/build_gen3
+The graphics and multimedia acceleration packages for
+the R-Car Gen3 board can be downloaded from:
+https://www.renesas.com/en-us/solutions/automotive/rcar-demoboard-2.html
+
+These 2 files from there should be store in your'/home/devel/Downloads' directory.
+ R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip
+ R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip
+/home/working/workspace_agl_master/build_gen3
+--- fragment /home/working/workspace_agl_master/meta-agl/templates/base/99_setup_EULAconf.sh
+--- end of setup script
+OK
+Generating setup file: /home/working/workspace_agl_master/build_gen3/agl-init-build-env ... OK
+------------ aglsetup.sh: Done
+[snip]
+```
+
+If you encounter this issue, or any other unwanted behavior, you can fix the error
+mentioned, remove the `$AGL_TOP/build` directory, and then re-launch the
+`aglsetup.sh` again.
+
+Here is another example that indicates the driver files could not be extracted from the downloads directory:
+
+```text
+~/workspace_agl/build/conf $ cat setup.log
+--- beginning of setup script
+--- fragment /home/working/workspace_agl/meta-agl/templates/base/01_setup_EULAfunc.sh
+--- fragment /home/working/workspace_agl/meta-agl/templates/machine/h3ulcb/50_setup.sh
+~/workspace_agl ~/workspace_agl/build
+ERROR: FILES "+/home/working/Downloads/R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip+" NOT EXTRACTING CORRECTLY
+ERROR: FILES "+/home/working/Downloads/R-car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip+" NOT EXTRACTING CORRECTLY
+The graphics and multimedia acceleration packages for
+the R-Car Gen3 board BSP can be downloaded from:
+<https://www.renesas.com/us/en/application/automotive/r-car-h3-m3-documents-software>
+
+These 2 files from there should be stored in your
+'/home/working/Downloads' directory.
+ R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip
+ R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip
+ERROR: Script /home/working/workspace_agl/build/conf/setup.sh failed
+[snip]
+```
+
+### 4.3. Updating the Board's Firmware
+
+Follow these steps to update the firmware:
+
+1. **Update the Sample Loader and MiniMonitor:**
+
+ You only need to make these updates one time per device.
+
+ Follow the procedure found on the
+ eLinux.org wiki to update to at least version 3.02,
+ which is mandatory to run the AGL image
+ ([R-car loader update](https://elinux.org/R-Car/Boards/Kingfisher#How_to_update_of_Sample_Loader_and_MiniMonitor)).
+
+2. **Update the Firmware Stack:**
+
+ You only need to update the firmware stack if you are
+ using the Eel or later (5.0) version of AGL software.
+
+ M3 and H3 Renesas board are AArch64 platforms.
+ As such, they have a firmware stack that is divided across: **ARM Trusted Firmware**, **OP-Tee** and **U-Boot**.
+
+ If you are using the Eel (5.0) version or later of the AGL software, you must update
+ the firmware using the **[h3ulcb] [R-car h3ulcb firmware update](http://elinux.org/R-Car/Boards/H3SK#Flashing_firmware)**
+ or **[m3ulcb] [R-car m3ulcb firmware update](https://elinux.org/R-Car/Boards/M3SK#Flashing_firmware)** links from the
+ [Embedded Linux Wiki](https://www.elinux.org/Main_Page) (i.e. `elinux.org`).
+
+ The table in the wiki lists the files you need to flash the firmware.
+ You can find these files in the following directory:
-5. Save the boot environment:
```sh
- saveenv
+ $AGL_TOP/build/tmp/deploy/images/$MACHINE
```
-6. Boot the board:
- ```sh
- run bootcmd
- ```
+ **NOTE:** The Salvator-X firmware update process is not documented on eLinux.
+ **NOTE:** The AGL Reference Hardware board generally should not require a
+ firmware update to be usable, and has a slightly different update procedure.
+ If you do need to update the firmware, the procedure is documented
+ [here](https://git.automotivelinux.org/AGL/meta-agl-refhw/tree/meta-agl-refhw-gen3/docs/ReferenceHW_Rcar_gen3.md).
-## 10. Troubleshooting
-### Logging Into the Console
+### 4.4. Logging Into the Console
Once the board boots, you should see the
[Wayland display](https://en.wikipedia.org/wiki/Wayland_(display_server_protocol))
h3ulcb login: root
```
-**m3ulcb**:
-
-```text
-Automotive Grade Linux ${AGL_VERSION} m3ulcb ttySC0
-
-m3ulcb login: root
-```
-
At the prompt, login by using `root` as the login.
The password is "empty" so you should not be prompted for the password.
-### Determining the Board's IP Address
+### 4.5. Determining the Board's IP Address
If your board is connected to a local network using Ethernet and
if a DHCP server is able to distribute IP addresses,
you can determine the board's IP address and log in using `ssh`.
-Here is an example for the **m3ulcb** board:
+Here is an example for the **h3ulcb** board:
+
```sh
-m3ulcb login: root
+h3ulcb login: root
Last login: Tue Dec 6 09:55:15 UTC 2016 on tty2
-root@m3ulcb:~# ip -4 a
+root@h3ulcb:~# ip -4 a
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default
inet 127.0.0.1/8 scope host lo
- valid_lft forever preferred_lft forever
+ valid_lft forever preferred_lft forever
3: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
inet 10.0.0.27/24 brd 10.0.0.255 scope global eth0
- valid_lft forever preferred_lft forever
-root@m3ulcb:~#
+ valid_lft forever preferred_lft forever
+root@h3ulcb:~#
```
In the previous example, IP address is 10.0.0.27.
Once you know the address, you can use `ssh` to login.
Following is an example that shows logging into SSH and then
displaying the contents of the `/etc/os-release` file:
+
```sh
$ ssh root@10.0.0.27
Last login: Tue Dec 6 10:01:11 2016 from 10.0.0.13
-root@m3ulcb:~# cat /etc/os-release
+root@h3ulcb:~# cat /etc/os-release
ID="poky-agl"
NAME="Automotive Grade Linux"
VERSION="11.0.0+snapshot-20210128 (koi)"
PRETTY_NAME="Automotive Grade Linux 11.0.0+snapshot-20210128 (koi)"
```
-## 11. Supplementary Information
+## 5. Supplementary Information
-### R-Car Generation 3 Information
+### 5.1. R-Car Generation 3 Information
Refer to the [R-Car](https://elinux.org/R-Car) page on the
[elinux.org](https://elinux.org) website for more information.
-### Proprietary libraries for meta-rcar-gen3
+### 5.2. Proprietary libraries for meta-rcar-gen3
The meta-rcar-gen3 layer of meta-renesas supports Graphic GLES(GSX)
libraries, proprietary multimedia libraries, and ICCOM software.
-#### Build with Renesas multimedia libraries
+### 5.3. Build with Renesas multimedia libraries
Multimedia portions depend on GLES portions.
**Enable multimedia features. This provides package group of plug-ins of the GStreamer, multimedia libraries and kernel drivers.**
```sh
- MACHINE_FEATURES_append = " multimedia"
+ 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
+ * Add features to `DISTRO_FEATURES:append` to local.conf
**Additional configuration in OMX module**:
" adsp" - for ADSP driver, ADSP interface and ADSP framework for Linux
" avb" - for AVB Software Package for Linux
```
+
Example:
+
```sh
- 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
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.
**Configuration for multimedia test package**
+
```sh
- DISTRO_FEATURES_append = " mm-test"
+ DISTRO_FEATURES:append = " mm-test"
```
-#### Enable Linux ICCOM driver and Linux ICCOM library
+### 5.4. 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 the following in local.conf:
+
```sh
- DISTRO_FEATURES_append = "iccom"
+ DISTRO_FEATURES:append = "iccom"
```
Code Review / AGL / documentation.git / commitdiff