diff options
author | Frederic Marec <frederic.marec@iot.bzh> | 2020-10-22 17:55:43 +0200 |
---|---|---|
committer | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2020-10-23 10:26:21 +0000 |
commit | e76766d79c3063b873b75bd2080c654f3f6d71ba (patch) | |
tree | 986bacce946e664caaf9721b59d37d41cca6aab4 | |
parent | de81a8b07f8139fa0f65dddffc839b4a5e83dad7 (diff) |
Renesas: Fix renesas documentation
Difference was done between old and new documentation
Keeping useful information from the old version
Adding new changes from the new one
v2 (jsmoeller): keep in sync with other machines
Bug-AGL: SPEC-3666
Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
Change-Id: Ifa87dfa5ead453b0b994905e80989c6efae726db
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25471
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
-rw-r--r-- | docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md | 1244 |
1 files changed, 774 insertions, 470 deletions
diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md b/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md index dc89aaa..b2126ce 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md @@ -1,6 +1,4 @@ ---- -title: Building for R Car Gen 3 ---- +# Building for Supported Renesas Boards AGL supports building for several automotive [Renesas](https://www.renesas.com/us/en/solutions/automotive.html) board kits. @@ -30,78 +28,109 @@ Follow these steps to download the drivers you need: 1. **Determine the Files You Need:** - Run the `setup_mm_packages.sh` script as follows to + 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 + 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. 2. **Get Your Board Support Package (BSP) Version:** - Be sure to have the correct BSP version of the R-Car Starter Kit based on the version of the AGL software you are using. Find the appropriate download links on the [R-Car H3/M3 Software library and Technical document](https://www.renesas.com/us/en/solutions/automotive/rcar-download/rcar-demoboard-2.html) - site. The file pairs are grouped according to the Yocto Project version you are - using with the AGL software. + Be sure to have the correct BSP version of the R-Car Starter Kit + based on the version of the AGL software you are using. + Find the appropriate download links on the + [R-Car H3/M3 Software library and Technical document](https://www.renesas.com/us/en/solutions/automotive/rcar-download/rcar-demoboard-2.html) + site. + The file pairs are grouped according to the Yocto Project version you are + using with the AGL software. + Use the following table to map the Renesas version to your AGL software: - | AGL Version| Renesas Version | - | AGL master | 3.21.0 | +| AGL Version | Renesas version | +|:-:|:-:| +| AGL master | 4.1.0 | 3. **Download the Files:** - Start the download process by clicking the download link. - If you do not have an account with Renesas, you will be asked to register a free account. - You must register and follow the "Click Through" licensing process - in order to download these proprietary files. + Start the download process by clicking the download link. + If you do not have an account with Renesas, you will be asked to register a free account. + You must register and follow the "Click Through" licensing process + in order to download these proprietary files. - If needed, follow the instructions to create the free account by providing the required - account information. - Once the account is registered and you are logged in, you can download the files. + If needed, follow the instructions to create the free account by providing the required + account information. + Once the account is registered and you are logged in, you can download the files. - **NOTE:** - You might have to re-access the - [original page](https://www.renesas.com/us/en/solutions/automotive/rcar-download/rcar-demoboard-2.html) - that contains the download links you need after creating the account and logging in. + **NOTE:** + You might have to re-access the + [original page](https://www.renesas.com/us/en/solutions/automotive/rcar-download/rcar-demoboard-2.html) + that contains the download links you need after creating the account and logging in. 4. **Create an Environment Variable to Point to Your Download Area:** - Create and export an environment variable named `XDG_DOWNLOAD_DIR` that points to - your download directory. + Create and export an environment variable named `XDG_DOWNLOAD_DIR` that points to + your download directory. + Here is an example: - ```sh - $ export XDG_DOWNLOAD_DIR=$HOME/Downloads - ``` + ```sh + $ export XDG_DOWNLOAD_DIR=$HOME/Downloads + ``` 5. **Be Sure the Files Have Rights:** - Be sure you have the necessary rights for the files you downloaded. + Be sure you have the necessary rights for the files you downloaded. + You can use the following command: - ```sh - $ chmod a+r $XDG_DOWNLOAD_DIR/*.zip - ``` + ```sh + chmod a+x $XDG_DOWNLOAD_DIR/*.zip + ``` + +6. **Check to be Sure the Files are Downloaded and Have the Correct Rights:** + + Do a quick listing of the files to ensure they are in the download directory and + they have the correct access rights. + Here is an example: + + ```sh + $ ls -l $XDG_DOWNLOAD_DIR/*.zip + -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 + -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 Your Hardware Together +## 2. Getting More Software + +1. **Get the `bmaptool`:** + + Download this tool from the + [bmap-tools](https://build.opensuse.org/package/show/isv:LinuxAutomotive:AGL_Master/bmap-tools) + repository. + The site has pre-built packages (DEB or RPM) for the supported host + operating systems. + +## 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. + * 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. + 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. -## 3. Making Sure Your Build Environment is Correct + +## 4. Making Sure Your Build Environment is Correct The "[Initializing Your Build Environment](./3_Initializing_Your_Build_Environment.md)" @@ -110,351 +139,600 @@ Follow these steps to download the drivers you need: If you are building an image for a supported Renesas board, you need to take steps to make sure your build host is set up correctly. - 1. **Define Your Board:** - - Depending on your Renesas board, define and export a `MACHINE` variable as follows: - - - | BOARD | `MACHINE` | - |:-:|:-:| - | Renesas RCar H3 | `MACHINE`= h3ulcb | - | Renesas RCar H3 w Kingfisher Board | `MACHINE`= h3ulcb-kf | - | Renesas RCar H3 w/o gfx blobs | `MACHINE`= h3ulcb-nogfx | - | Renesas RCar Salvator/H3 | `MACHINE`= h3-salvator-x | - | Renesas RCar M3 | `MACHINE`= m3ulcb | - | Renesas RCar M3 w Kingfisher Board | `MACHINE`= m3ulcb-kf | - | Renesas RCar M3 w/o gfx blobs | `MACHINE`= m3ulcb-nogfx | - | Renesas RCar Salvator/M3 | `MACHINE`= m3-salvator-x | - - - For example, the following command defines and exports the `MACHINE` variable - for the Starter Kit Pro/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-$MACHINE agl-devel agl-demo - which expands to : - $ source meta-agl/scripts/aglsetup.sh -m h3ulcb -b build-h3ulcb agl-devel agl-demo - ``` - - 3. **Examine the Script's Log:** - - Running the `aglsetup.sh` script creates the `setup.log` file, which is in - the `build-h3ulcb/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. - -## 4. Using BitBake +1. **Define Your Board:** - Start the build using the `bitbake` command. + Depending on your Renesas board, define and export a `MACHINE` variable as follows: - **NOTE:** An initial build can take many hours depending on your - CPU and and Internet connection speeds. - The build also takes approximately 100G-bytes of free disk space. + | Board| `MACHINE` Setting | + |:-:|:-:| + | Starter Kit Pro/M3 | `MACHINE`=m3ulcb | + | Starter Kit Pro/M3 + kingfisher support | `MACHINE`=m3ulcb-kf | + | Starter Kit Pro/M3 without graphic | `MACHINE`=m3ulcb-nogfx | + | Starter Kit Premier/H3 | `MACHINE`=h3ulcb | + | Starter Kit Premier/H3 + kingfisher support | `MACHINE`=h3ulcb-kf | + | Starter Kit Premier/H3 without graphic | `MACHINE`=h3ulcb-nogfx | + | Salvator-X | `MACHINE`=h3-salvator-x | - For this example, the target is "agl-demo-platform": + For example, the following command defines and exports the `MACHINE` variable + for the Starter Kit Pro/M3 Board: - ``` sh - $ time bitbake agl-demo-platform - ``` + ```sh + $ export MACHINE=m3ulcb + ``` - The build process puts the resulting image in the Build Directory: - ``` sh - build-h3ulcb/tmp/deploy/images/$MACHINE - ``` +2. **Run the `aglsetup.sh` Script:** -## 5. Booting the Image Using a MicroSD Card + Use the following commands to run the AGL Setup script: - To boot your image on the Renesas board, you need to do three things: + ```sh + $ cd $AGL_TOP + $ source meta-agl/scripts/aglsetup.sh -m $MACHINE -b build agl-devel agl-demo + ``` - 1. Update all firmware on the board. - 2. Prepare the MicroSD card to you can boot from it. - 3. Boot the board. + **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. - **NOTE:** For subsequent builds, you only have to re-write the MicroSD - card with a new image. + 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. - * **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. + 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. + +<details> + <summary> In case of missing graphics drivers, you could notice an error message + similar to the following:</summary> + <pre> + <code> +[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-weston5-20190802.zip + R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston5-20190802.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] + </code> + </pre> +</details> + + 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. + +<details> + <summary>Here is another example that indicates the driver files could not be extracted from the downloads directory:</summary> + <pre> + <code> +[snip] + +~/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/m3ulcb/50_setup.sh +~/workspace_agl ~/workspace_agl/build +ERROR: FILES "+/home/working/Downloads/R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston5-20190802.zip+" NOT EXTRACTING CORRECTLY +ERROR: FILES "+/home/working/Downloads/R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston5-20190802.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/solutions/automotive/rcar-download/rcar-demoboard-2.html> + +These 2 files from there should be stored in your +'/home/working/Downloads' directory. + R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston5-20190802.zip + R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston5-20190802.zip +ERROR: Script /home/working/workspace_agl/build/conf/setup.sh failed +[snip] + </code> + </pre> +</details> + +## 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](../image-workflow-cust-build.html)" +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](./renesas.html#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 + +## 6. 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 +does provide pre-built images for developers that work with supported hardware. +You can find these pre-built images on the +[AGL Download web site](https://download.automotivelinux.org/AGL/release). + +Start the build using the `bitbake` command. + +**NOTE:** An initial build can take many hours depending on your +CPU and and Internet connection speeds. +The build also takes approximately 100G-bytes of free disk space. + +For this example, the target is "agl-demo-platform": + +```sh + bitbake agl-demo-platform +``` + +The build process puts the resulting image in the Build Directory: + +``` +<build_directory>/tmp/deploy/images/$MACHINE +``` + +## 7. Booting the Image Using a MicroSD Card + +To boot your image on the Renesas board, you need to do three things: + +1. Update all firmware on the board. +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:** + + 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: + + ```sh + $AGL_TOP/build/tmp/deploy/images/$MACHINE + ``` - 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**. + **NOTE:** The Salvator-X firmware update process is not documented on eLinux. + +### Preparing the MicroSD Card - If you are using the Eel (5.0) version or later of the AGL software, you must update - the firmware using the **[R-car h3ulcb firmware update](http://elinux.org/R-Car/Boards/H3SK#Flashing_firmware)** - or **[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`). +<details> + <summary> + Plug the MicroSD card into your Build Host. + After plugging in the device, use the `dmesg` command as follows to + discover the device name: + </summary> + <pre> + <code> +$ 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 + </code> + </pre> +</details> - The table in the wiki lists the files you need to flash the firmware. - You can find these files in the following directory: +In the previous example, the MicroSD card is attached to the device `/dev/sdc`. - ```sh - $AGL_TOP/build/tmp/deploy/images/$MACHINE - ``` +<details> + <summary> + You can also use the `lsblk` command to show all your devices. + Here is an example that shows the MicroSD card as `/dev/sdc`: + </summary> + <pre> + <code> +$ 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 + </code> + </pre> +</details> - **NOTE:** The Salvator-X firmware update process is not documented on eLinux. +**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. - * **Preparing the MicroSD Card** +To summarize this example so far, we have the following: - ```sh - $ lsblk - $ sudo umount <boot_device_name> - $ xzcat agl-image-ivi-crosssdk-h3ulcb.wic.xz | sudo dd of=<boot_device_name> bs=4M - $ sync - ``` +* The first SATA drive is `/dev/sda`. - * **Booting the Board** +* `/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. - Follow these steps to boot the board: +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. - 1. Use the board's power switch to turn off the board. +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. - 2. Insert the MicroSD card into the board. +Following are example commands that write the image to the MicroSD card: - 3. Verify that you have plugged in the following: +```sh +cd $AGL_TOP/build/tmp/deploy/images/$MACHINE +bmaptool copy ./agl-demo-platform-$MACHINE.wic.xz <boot_device_name> +``` - * An external monitor into the board's HDMI port +Alternatively, you can leave the image in an uncompressed state and write it +to the MicroSD card: - * An input device (e.g. keyboard, mouse, touchscreen, and so forth) into the board's USB ports. +```sh + sudo umount <boot_device_name> + xzcat ./agl-demo-platform-$MACHINE.wic.xz | sudo dd of=<boot_device_name> bs=4M + sync +``` - 4. Use the board's power switch to turn on the board. +### Booting the Board + +Follow these steps to boot 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. +1. Use the board's power switch to turn off the board. + +2. Insert the MicroSD card into the board. -## 6. Setting Up the Serial Console +3. Verify that you have plugged in the following: + + * An external monitor into the board's HDMI port - Setting up the Serial Console involves the following: + * 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. - * Installing a serial client on your build host - * Connecting your build host to your Renesas board's serial port - * Powering on the board to get a shell at the console - * Configuring U-Boot parameters - * Logging into the console - * Determining the board's IP address +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 + +Setting up the Serial Console involves the following: + +* Installing a serial client on your build host +* Connecting your build host to your Renesas board's serial port +* Powering on the board to get a shell at the console +* Configuring U-Boot parameters +* Logging into the console +* Determining the board's IP address - Brief about each process : +### 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 +[GNU Screen](https://en.wikipedia.org/wiki/GNU_Screen), +[picocom](https://linux.die.net/man/8/picocom), +and +[Minicom](https://en.wikipedia.org/wiki/Minicom). - 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), and [Minicom](https://en.wikipedia.org/wiki/Minicom). Of these three, "picocom" has less dependencies and is therefore considered the "lightest" solution. +Of these three, "picocom" has less dependencies and is therefore +considered the "lightest" solution. - 2. Connecting Your Build Host to Your Renesas Board's Serial Port +### 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. +<details> + <summary> Once you connect the board, determine the device created for the serial link. - Use the `dmesg` command on your build host. - - ```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. - - 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 - picocom -b 115200 /dev/ttyUSB0 - ``` - - or - - ```sh - minicom -b 115200 -D /dev/ttyUSB0 - ``` - - or - - ```sh - screen /dev/ttyUSB0 115200 - ``` - - - 3. Powering on the Board to Get a Shell at the Console - - 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. - - Following, is console output for the power on process for each kit: - + Use the ``dmesg`` command on your build host. + Here is an example: + </summary> + <pre> + <code> +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 + </code> + </pre> +</details> + +The device created is usually "/dev/ttyUSB0". +However, the number might vary depending on other USB serial ports connected to the host. + +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 +$ picocom -b 115200 /dev/ttyUSB0 +``` + +or + +```sh +$ minicom -b 115200 -D /dev/ttyUSB0 +``` + +or + +```sh +$ screen /dev/ttyUSB0 115200 +``` + +### Powering on the Board to Get a Shell at the Console + +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. + +Following, is console output for the power on process for each kit: + +<details> + <summary> h3ulcb: - - ```sh - 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 - ``` - - + </summary> + <pre> + <code> + +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 +=> + </code> + </pre> +</details> + +<details> + <summary> m3ulcb: - - ```sh - 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 - ``` - -## 7. 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. - - 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: - - Here is an example using the **h3ulcb** board: - - ```sh - $ printenv - 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 - initrd_high=0xffffffffffffffff - load_dtb=ext4load mmc 0:1 0x48000000 /boot/r8a7795-h3ulcb.dtb - load_ker=ext4load mmc 0:1 0x48080000 /boot/Image - stderr=serial - stdin=serial - stdout=serial - ver=U-Boot 2015.04 (Jun 09 2016 - 19:21:52) - - Environment size: 648/131068 bytes - ``` - - Here is a second example using the **m3ulcb** board: - - ```sh - $ printenv - 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 + </summary> + <pre> + <code> +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 +=> + </code> + </pre> +</details> + +## 9. 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. + +2. Once the autoboot process is interrupted, use the board's serial console to + enter <b>printenv</b> to check if you have correct parameters for booting your board: + <details> + <summary> + Here is an example using the <b>h3ulcb</b> board: + </summary> + <pre> + <code> + + => printenv + 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 + initrd_high=0xffffffffffffffff + load_dtb=ext4load mmc 0:1 0x48000000 /boot/r8a7795-h3ulcb.dtb + load_ker=ext4load mmc 0:1 0x48080000 /boot/Image + stderr=serial + stdin=serial + stdout=serial + ver=U-Boot 2015.04 (Jun 09 2016 - 19:21:52) + + Environment size: 648/131068 bytes + </code> + </pre> + </details> + <details> + <summary> + Here is a second example using the <b>m3ulcb</b> board: + </summary> + <pre> + <code> + => printenv + 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 + </code> + </pre> + </details> + + 3. To boot your board using the MicroSD card, be sure your environment is set up + as follows: + + ```shell + 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 + setenv load_ker ext4load mmc 0:1 0x48080000 /boot/Image ``` - 3. Loading dtb : + 4. Loading dtb : **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. @@ -472,172 +750,198 @@ Follow these steps to download the drivers you need: * **M3SK with a Kingfisher board** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7796-m3ulcb-kf.dtb` - 4. Set Correct Environment : + 5. Save the boot environment: - Be sure your environment is set up 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 - $ setenv load_ker ext4load mmc 0:1 0x48080000 /boot/Image - ``` + ```shell + saveenv + ``` - 5. Save the boot environment: `$ saveenv` + 6. Boot the board: + ```sh + run bootcmd + ``` - 6. Boot the board: `$ run bootcmd` -## 8. Troubleshooting - * **Logging Into the Console** +## 10. Troubleshooting +### Logging Into the Console - Once the board boots, you should see the - [Wayland display](https://en.wikipedia.org/wiki/Wayland_(display_server_protocol)) - on the external monitor. - A login prompt should appear as follows depending on your board: +Once the board boots, you should see the +[Wayland display](https://en.wikipedia.org/wiki/Wayland_(display_server_protocol)) +on the external monitor. +A login prompt should appear as follows depending on your board: - **h3ulcb**: - ```sh - Automotive Grade Linux ${AGL_VERSION} h3ulcb ttySC0 +**h3ulcb**: - h3ulcb login: root - ``` +```sh +Automotive Grade Linux ${AGL_VERSION} h3ulcb ttySC0 - **m3ulcb**: - ```sh - Automotive Grade Linux ${AGL_VERSION} m3ulcb ttySC0 +h3ulcb login: root +``` - m3ulcb login: root - ``` +**m3ulcb**: - At the prompt, login by using `root` as the login. - The password is "empty" so you should not be prompted for the password. +```sh +Automotive Grade Linux ${AGL_VERSION} m3ulcb ttySC0 - * **Determining the Board's IP Address** +m3ulcb login: root +``` - 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`. +At the prompt, login by using `root` as the login. +The password is "empty" so you should not be prompted for the password. - Here is an example for the m3ulcb board: +### Determining the Board's IP Address - ```sh - m3ulcb login: root - root@m3ulcb:~# 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 - 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 - ``` +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`. +<details> + <summary> + Here is an example for the m3ulcb board: + </summary> + <pre> + <code> + m3ulcb login: root + Last login: Tue Dec 6 09:55:15 UTC 2016 on tty2 + root@m3ulcb:~# 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 + 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:~# + </code> + </pre> +</details> + +<details> + <summary> 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: + </summary> + <pre> + <code> + $ 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 + ID="poky-agl" + NAME="Automotive Grade Linux" + VERSION="3.0.0+snapshot-20161202 (chinook)" + VERSION_ID="3.0.0-snapshot-20161202" + PRETTY_NAME="Automotive Grade Linux 3.0.0+snapshot-20161202 (chinook)" + </code> + </pre> +</details> - ```sh - $ ssh root@10.0.0.27 - ``` - -## 9. Supplementary Information - - * R-Car Generation 3 Information - - Refer to the following for more information from [eLinux website](https://elinux.org/R-Car). +**NOTE:** More generics troubleshooting can be found here : [Generic issues](../troubleshooting.html) - * Proprietary libraries for meta-rcar-gen3 +## 11. Supplementary Information - The meta-rcar-gen3 layer of meta-renesas is supported Graphic GLES(GSX) - libraries, proprietary library of multimedia, and ICCOM software. +* R-Car Generation 3 Information - 1. Build with Renesas multimedia libraries +Refer to the following for more information from [eLinux website](https://elinux.org/R-Car). - Multimedia portions depend on GLES portions. +* Proprietary libraries for meta-rcar-gen3 - * A. Configuration for Multimedia features +The meta-rcar-gen3 layer of meta-renesas is supported Graphic GLES(GSX) +libraries, proprietary library of multimedia, and ICCOM software. +1. Build with Renesas multimedia libraries - * Please copy proprietary libraries to the directory of recipes. +Multimedia portions depend on GLES portions. - * Please set local.conf the following. - **Enable multimedia features. This provides package group of plug-ins of the GStreamer, multimedia libraries and kernel drivers.** +* A. Configuration for Multimedia features - ```sh - MACHINE_FEATURES_append = " multimedia" - ``` + * Please copy proprietary libraries to the directory of recipes. - * B. Configuration for optional codecs and middleware + * Please set local.conf the following. + **Enable multimedia features. This provides package group of plug-ins of the GStreamer, multimedia libraries and kernel drivers.** - * Please copy proprietary libraries to the directory of recipes. - - * Add features to DISTRO_FEATURES_append to local.conf - - **Additional configuration in OMX module** - - ```sh - " h263dec_lib" - for OMX Media Component H263 Decoder Library - " h264dec_lib" - for OMX Media Component H264 Decoder Library - " h264enc_lib" - for OMX Media Component H.264 Encoder Library - " h265dec_lib" - for OMX Media Component H265 Decoder Library - " mpeg2dec_lib" - for OMX Media Component MPEG2 Decoder Library - " mpeg4dec_lib" - for OMX Media Component MPEG4 Decoder Library - " vc1dec_lib" - for OMX Media Component VC-1 Decoder Library - " divxdec_lib" - for OMX Media Component DivX Decoder Library - " rvdec_lib" - for OMX Media Component RealVideo Decoder Library - " alacdec_lib" - for OMX Media Component ALAC Decoder Library - " flacdec_lib" - for OMX Media Component FLAC Decoder Library - " aaclcdec_lib" - for OMX Media Component AAC-LC Decoder Library - " aaclcdec_mdw" - for AAC-LC 2ch Decoder Middleware for Linux - " aacpv2dec_lib" - for OMX Media Component aacPlus V2 Decoder Library - " aacpv2dec_mdw" - for aacPlus V2 Decoder Middleware for Linux - " mp3dec_lib" - for OMX Media Component MP3 Decoder Library - " mp3dec_mdw" - for MP3 Decoder Middleware for Linux - " wmadec_lib" - for OMX Media Component WMA Standard Decoder Library - " wmadec_mdw" - for WMA Standard Decoder Middleware for Linux - " dddec_lib" - for OMX Media Component Dolby(R) Digital Decoder Library - " dddec_mdw" - for Dolby(R) Digital Decoder Middleware for Linux - " aaclcenc_lib" - for OMX Media Component AAC-LC Encoder Library - " vp8dec_lib" - for OMX Media Component VP8 Decoder Library for Linux - " vp8enc_lib" - for OMX Media Component VP8 Encoder Library for Linux - " vp9dec_lib" - for OMX Media Component VP9 Decoder Library for Linux - " aaclcenc_mdw" - for AAC-LC Encoder Middleware for Linux - " cmsbcm" - for CMS Basic Color Management Middleware for Linux - " cmsblc" - for CMS CMM3 Backlight Control Middleware for Linux - " cmsdgc" - for CMS VSP2 Dynamic Gamma Correction Middleware for Linux - " dtv" - for ISDB-T DTV Software Package for Linux - " dvd" - for DVD Core-Middleware for Linux - " adsp" - for ADSP driver, ADSP interface and ADSP framework for Linux - " avb" - for AVB Software Package for Linux - ``` - - Ex: - - ```sh - DISTRO_FEATURES_append = " h264dec_lib h265dec_lib mpeg2dec_lib aaclcdec_lib aaclcdec_mdw" - ``` + ```sh + MACHINE_FEATURES_append = " multimedia" + ``` - * C. Configuration for test packages +* 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 + +<details> + <summary> + **Additional configuration in OMX module** + </summary> + <pre> + <code> + " h263dec_lib" - for OMX Media Component H263 Decoder Library + " h264dec_lib" - for OMX Media Component H264 Decoder Library + " h264enc_lib" - for OMX Media Component H.264 Encoder Library + " h265dec_lib" - for OMX Media Component H265 Decoder Library + " mpeg2dec_lib" - for OMX Media Component MPEG2 Decoder Library + " mpeg4dec_lib" - for OMX Media Component MPEG4 Decoder Library + " vc1dec_lib" - for OMX Media Component VC-1 Decoder Library + " divxdec_lib" - for OMX Media Component DivX Decoder Library + " rvdec_lib" - for OMX Media Component RealVideo Decoder Library + " alacdec_lib" - for OMX Media Component ALAC Decoder Library + " flacdec_lib" - for OMX Media Component FLAC Decoder Library + " aaclcdec_lib" - for OMX Media Component AAC-LC Decoder Library + " aaclcdec_mdw" - for AAC-LC 2ch Decoder Middleware for Linux + " aacpv2dec_lib" - for OMX Media Component aacPlus V2 Decoder Library + " aacpv2dec_mdw" - for aacPlus V2 Decoder Middleware for Linux + " mp3dec_lib" - for OMX Media Component MP3 Decoder Library + " mp3dec_mdw" - for MP3 Decoder Middleware for Linux + " wmadec_lib" - for OMX Media Component WMA Standard Decoder Library + " wmadec_mdw" - for WMA Standard Decoder Middleware for Linux + " dddec_lib" - for OMX Media Component Dolby(R) Digital Decoder Library + " dddec_mdw" - for Dolby(R) Digital Decoder Middleware for Linux + " aaclcenc_lib" - for OMX Media Component AAC-LC Encoder Library + " vp8dec_lib" - for OMX Media Component VP8 Decoder Library for Linux + " vp8enc_lib" - for OMX Media Component VP8 Encoder Library for Linux + " vp9dec_lib" - for OMX Media Component VP9 Decoder Library for Linux + " aaclcenc_mdw" - for AAC-LC Encoder Middleware for Linux + " cmsbcm" - for CMS Basic Color Management Middleware for Linux + " cmsblc" - for CMS CMM3 Backlight Control Middleware for Linux + " cmsdgc" - for CMS VSP2 Dynamic Gamma Correction Middleware for Linux + " dtv" - for ISDB-T DTV Software Package for Linux + " dvd" - for DVD Core-Middleware for Linux + " adsp" - for ADSP driver, ADSP interface and ADSP framework for Linux + " avb" - for AVB Software Package for Linux + </code> + </pre> +</details> + + + Ex: - Must ensure that Multimedia features have been enabled. - (Please refer to III/A to enable Multimedia.) + ```sh + DISTRO_FEATURES_append = " h264dec_lib h265dec_lib mpeg2dec_lib aaclcdec_lib aaclcdec_mdw" + ``` - * Please add feature to DISTRO_FEATURES_append to local.conf. +* C. Configuration for test packages - **Configuration for multimedia test package** - ```sh - DISTRO_FEATURES_append = "mm-test" - ``` + Must ensure that Multimedia features have been enabled. + (Please refer to III/A to enable Multimedia.) - 2. Enable Linux ICCOM driver and Linux ICCOM library + * Please add feature to DISTRO_FEATURES_append to local.conf. + **Configuration for multimedia test package** + ```sh + DISTRO_FEATURES_append = "mm-test" + ``` - For Linux ICCOM driver and Linux ICCOM library +2. Enable Linux ICCOM driver and Linux ICCOM library - * Please copy proprietary libraries to the directory of recipes. - * Please set local.conf the following. + For Linux ICCOM driver and Linux ICCOM library - ```sh - DISTRO_FEATURES_append = "iccom" - ``` + * Please copy proprietary libraries to the directory of recipes. + * Please set local.conf the following. + ```sh + DISTRO_FEATURES_append = "iccom" + ``` |