Skip to content

Getting Started

This page explains how to start-up the HMI SDK.

Note

Hereafter, we use following terminology.

  • EVK: Refers "Evaluation Board Kit".

Introduction

Getting Started explains the instruction to run HMI Applications.

Common instructions are explained in this document.

Step 1: Obtain an evaluation board

Click the button below to get the board.

Board and Software
Get the board and software for RZ/G series.

The RZ/G2L Evaluation Board Kit (EVK) is the ideal board kit for RZ/G2L evaluation.

Following items are included in the RZ/G2L Evaluation Board Kit.

Equipment Details
RZ/G2L Evaluation Board Evaluation board itself.
Micro USB to Serial Cable For serial communication between PC and the board.

Step 2: Obtain necessary environment

1. Necessary Equipment

Please prepare the following equipment for your EVK.

Equipment

Purpose

Remarks

RZ/G2L Module Board (SMARC2.1) + Common Carrier Board

(P/N: RTK9744L23S01000BE)

It is used to evaluate not only Linux but also demo programs or applications that run on Linux in the Linux operating environment provided by HMI SDK.

  • 4GB or more ROM (SPI or eMMC or SD)
  • 2GB or more RAM (DDR4/DDR3L 16bit x 1.6/1.3Gbps)

Included with RZ/G2L Evaluation Board Kit (EVK).

USB serial cable

It is used to connect the PC and the EVK and get the console output of Linux running on the EVK.

  • Connect to micro USB type-B (2.0) port of EVK

Included with RZ/G2L Evaluation Board Kit (EVK).

USB Power Delivery (PD) AC adapter + USB C PD cable for power supply

Use for power supply.

  • Connect to USB type-C port of EVK

PC

It can be used to operate the demo environment from a terminal on a PC, rebuild HMI SDK Linux, or use it as a development device for applications.

  • At least 100GB or more free space of HDD/SDD
  • 8GB or more RAM
  • 4-core or more CPU

The OS of the PC is as follows. However, Windows PCs are for debugging using a serial connection and cannot be used for development such as building software.

  • Ubuntu 20.04 LTS, 64-bit version
  • Windows 10 or 11

HDMI display monitor + HDMI cable

Used to display demo programs or applications provided by HMI SDK.

  • Connect to micro HDMI port of EVK

If you need a touch panel function, you need a panel that supports USB connection.

The HMI SDK supports the display of resolutions supported by the Extended Display Identification Data (EDID) information obtained from this HDMI display monitor.

USB mouse

Used to operate demo programs and applications provided by HMI SDK.

  • USB HID Compliant

USB hub

Used when multiple USB devices are required for the demo program or applications provided by HMI SDK.

USB keyboard

Used to operate demo programs and applications provided by HMI SDK.

  • USB HID Compliant

USB touch screen

Used to operate demo programs and applications provided by HMI SDK.

  • USB HID Compliant

Audio speaker

Used to evaluate the audio output demo programs or applications provided by HMI SDK.

  • 3.5mm mini plug connector required

micro SD card

Linux and demo images provided by the HMI SDK are written and used as a Linux boot device.

  • Type: SDHC
  • Speed class: UHI-Class 10
  • Capacity: Minimum 4GB, recommended 8GB

Linux on the RZ/G2L EVK is booted from a micro SD card by eSD boot.

2. Necessary Software

Please install following software on Linux PC.

  • git

Step 3: Obtain RZ/G HMI SDK

Please download from Renesas.com website.

Get HMI SDK

Get HMI SDK source code

Once downloaded, please check the Release Note included inside package.

Step 4: Prepare HMI SDK SD card image for demo

Prebuilt binary prepared as wic image

wic image is available inside image-file_rzg2l_hmi-sdk_v1.0.zip.

1. In case of Windows PC

  1. Download or copy the release package into your PC
  2. Unzip the release package and extract an image file
  3. Write the image file to your micro SD card by using one of the following tool

    Image file is:

    • core-image-weston-smarc-rzg2l.wic.gz

    Caution

    Even if you see a message such as you need to format the disk before/after writing the image, do not format the SD card.

2. In case of Linux PC (Ubuntu)

  1. Download or copy the release package into your PC
  2. Unzip the release package and extract an image file
  3. Insert the micro SD Card into your Linux PC and find the device name of the SD card

    Use lsblk command to check the device name as follows.

    • Before inserting the SD card

      lsblk
      
      NAME        MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
          (snip)
      nvme0n1     259:0    0 465.8G  0 disk
      ├─nvme0n1p1 259:1    0   512M  0 part /boot/efi
      └─nvme0n1p2 259:2    0 465.3G  0 part /
      
    • After inserting the SD card

      lsblk
      
      NAME        MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
          (snip)
      nvme0n1     259:0    0 465.8G  0 disk
      ├─nvme0n1p1 259:1    0   512M  0 part /boot/efi
      └─nvme0n1p2 259:2    0 465.3G  0 part /
      sda           8:0    1  14.5G  0 disk
      ├─sda1        8:1    1   500M  0 part /media/user/boot
      └─sda2        8:2    1   3.4G  0 part /media/user/rootfs
      

    Note

    The device name is assigned to the SD card by Linux on your Host PC. It may be named /dev/sd* (* is a letter representing the physical drive). It is /dev/sda in this sample.

  4. Unmount the SD card if it is mounted

    Use umount command with mount points that are displayed when you executed lsblk command. For example:

    umount /media/user/boot
    umount /media/user/rootfs
    
  5. Write the image to the SD card

    Use bmaptool command with device name of SD card is displayed when you executed lsblk command. For example:

    sudo bmaptool copy <wic image>.wic.gz /dev/sda
    

    Image file is:

    • core-image-weston-smarc-rzg2l.wic.gz

    Note

    Additionally, the files below are also required:

    • core-image-weston-smarc-rzg2l.wic.bmap

Step 5: Run HMI SDK demo

1. Setup EVK's peripheral

Please setup following below diagram.

2. Setup EVK's DIP switch

Set up DIP switch SW1 and SW11 as follows.

  • SW1

    SW1-1 SW1-2
    ON ON
  • SW11

    SW11-1 SW11-2 SW11-3 SW11-4
    ON ON OFF ON

3. Turn on EVK and run demo

  1. Insert the bootable SD card created at Step 4
  2. Connect a USB cable to CN6 for power supply
  3. Press and hold power button (SW9) for 1 second to turn on the EVK

    Note

    Press and hold the button for 2 seconds when you turn off the EVK.

Step 6: Build sample application

This step explains how to build HMI SDK sample application.
To see the overview about HMI Applications, please refer to HMI Applications.

Note

This step requires a Linux PC (Ubuntu).

The prebuilt binary of executable files are also provided, and you can run it directly.

  1. Install cross compiler to you Linux PC (Ubuntu)

    Note

    This step is optional, as prebuilt binaries was prepared.

    sudo sh ./poky-glibc-x86_64-core-image-weston-sdk-aarch64-toolchain-3.1.31.sh
    

    Note

    Please set target directory (default: /opt/poky/3.1.31).

  2. Enable cross compiler

    Note

    This step is optional, as prebuilt binaries was prepared.

    source /opt/poky/3.1.31/environment-setup-aarch64-poky-linux
    

    Note

    Please make sure where cross compiler is installed (default: /opt/poky/3.1.31).

  3. Clone sample application source code

    git clone https://github.com/renesas-rz/rzg_hmi_sdk
    
  4. Go to source code working directory

    cd rzg_hmi_sdk/sample_app/<sample-application-directory>
    

    Note

    Existing <sample-application-directory>(s) are listed on below table.

    <sample-application-directory> Description
    lvgl_sample_img_disp LVGL Sample Program for Image Display
    lvgl_sample_audio_playback LVGL Sample Program for Audio Playback
    lvgl_sample_video_playback LVGL Sample Program for Video Playback
  5. Build sample application

    Note

    This step is optional, as prebuilt binaries was prepared.

    make
    
  6. Executable file of sample application

    Each executable file of sample application built as rzg_hmi_sdk/sample_app/<sample-application-directory>/<sample-application-binary>.

    Note

    Executable file name (<sample-application-binary>) are same with <sample-application-directory> name.

    For example in case lvgl_sample_img_disp, path to executable file is:

    <path-to>/rzg_hmi_sdk/sample_app/lvgl_sample_img_disp/lvgl_sample_img_disp
    

Step 7: Deploy sample application

Note

This step requires a Linux PC (Ubuntu).

1. Over ethernet (using SCP)

  1. Boot and connect your EVK into your local network

    Connect an ethernet cable to RJ45 port for networking.

    RJ45 ports are CN8 and CN9.

    Note

    Just connect 1 ethernet cable to CN8 or CN9.

    Note

    Your EVK will run the demo program automatically.

    Please exit the demo by pressing the keyboard keys Ctrl+C, before proceeding to the next step.

  2. Check your EVK's IP

    Open terminal of your EVK, and check using ip command as below.

    ip a
    

    Note

    For example, when RZ/G2L EVK's CN8 ethernet port connected to local network.

    root@smarc-rzg2l:~# ip a | grep eth
    5: eth0: <NO-CARRIER,BROADCAST,MULTICAST,DYNAMIC,UP> mtu 1500 qdisc mq state DOWN group default qlen 1000
        link/ether f2:d6:18:24:f0:6b brd ff:ff:ff:ff:ff:ff
    6: eth1: <BROADCAST,MULTICAST,DYNAMIC,UP,LOWER_UP> mtu 1500 qdisc mq state UP group default qlen 1000
        link/ether 72:26:f0:8b:64:59 brd ff:ff:ff:ff:ff:ff
        inet 192.168.0.32/24 brd 192.168.0.255 scope global dynamic eth1
    

    EVK's IP is 192.168.0.32 (at eth1).

  3. Copy executable into your EVK storage (SD card)

    Send executable file from your Linux PC (Ubuntu) using scp command as below.

    scp <path-to>/rzg_hmi_sdk/sample_app/<sample-application-directory>/<sample-application-binary> root@<your-EVK-IP>:/home/root/
    

    Note

    We recommend you to copy to /home/root directory.

    Don't forget to replace <your-EVK-IP> with your EVK's IP.

  4. Copy resources required by sample application

    scp <path-to>/rzg_hmi_sdk/sample_app/lvgl_sample_img_disp/sample/* root@<your-EVK-IP>:/usr/share/images/
    

    Caution

    Make sure you are copying to /usr/share/images/ directory of EVK.

    scp <path-to>/rzg_hmi_sdk/sample_app/lvgl_sample_audio_playback/sample/* root@<your-EVK-IP>:/usr/share/sounds/sample/
    

    Caution

    Make sure you are copying to /usr/share/sounds/sample/ directory of EVK.

    scp <path-to>/rzg_hmi_sdk/sample_app/lvgl_sample_video_playback/sample/* root@<your-EVK-IP>:/usr/share/movies/
    

    Caution

    Make sure you are copying to /usr/share/movies/ directory of EVK.

2. Directly write into HMI SDK's SD card

  1. Turn off your EVK (if its on)
  2. Insert and mount your SD card into PC
  3. Copy executable into your SD card

    For example, in case mounted on /media/user/rootfs.

    cp <path-to>/rzg_hmi_sdk/sample_app/<sample-application-directory>/<sample-application-binary> /media/user/rootfs/home/root/
    

    Note

    We recommend you to copy to /home/root directory.

    If you not sure where is your SD card mounted, please check it using lsblk command (see Step 4.2.3).

  4. Copy resources required by sample application

    For example, in case mounted on /media/user/rootfs.

    cp <path-to>/rzg_hmi_sdk/sample_app/lvgl_sample_img_disp/sample/* /media/user/rootfs/usr/share/images/
    

    Caution

    Make sure you are copying to /usr/share/images/ directory on SD card.

    cp <path-to>/rzg_hmi_sdk/sample_app/lvgl_sample_audio_playback/sample/* /media/user/rootfs/usr/share/sounds/sample/
    

    Caution

    Make sure you are copying to /usr/share/sounds/sample/ directory on SD card.

    cp <path-to>/rzg_hmi_sdk/sample_app/lvgl_sample_video_playback/sample/* /media/user/rootfs/usr/share/movies/
    

    Caution

    Make sure you are copying to /usr/share/movies/ directory on SD card.

Step 8: Run sample application

  1. Boot your EVK (if not yet)

    Note

    Your EVK will run the demo program automatically.

    Please exit the demo by pressing the keyboard keys Ctrl+C, before proceeding to the next step.

  2. Go to /home/root directory

    Open terminal of your EVK, and go to /home/root using cd command as below.

    cd /home/root
    
  3. Set sample application binary executable

    chmod +x <sample-application-binary>
    
  4. Execute sample application binary

    ./<sample-application-binary>