1. Installation
1.1. Supported Environments
Operating System |
Windows: Windows 10 / Windows 11 Linux: Ubuntu 22.04 / Ubuntu 24.04 macOS: macOS 14 Sonoma (Apple silicon) |
VS Code version |
1.96.0 (minimum) |
Note
Supported Operating Systems may vary on device families.
For R-Car development, the supported operating systems are Windows 10 and Ubuntu 20.04.
VS Code can be downloaded and installed from this page https://code.visualstudio.com/.
1.2. Installing the Renesas Extensions
Renesas provides 2 extensions to help building and debugging Renesas C/C++ project in VS Code, these are:
Latest versions of these extensions can be installed from extension marketplace directly. Developers can follow the steps below to install the latest versions of the extensions from extension marketplace.
Open “VS Code” and navigate to “Extensions” section.
Search for “Renesas”
Click to “Install” button for both extensions “Renesas Build Utilities” and Renesas Debug”.
Renesas extensions have dependent packages to perform the build and debug operations. After installing the extensions, please follow the user guide to setup the development environment:
1.3. Dependencies for Windows
Renesas Extensions support a variety of device and tools combinations for embedded development. It is essential to set-up your development environment properly before starting your development. For Windows operating systems, please follow this guide to set-up your environment. It is suggested to:
Firstly, follow the instructions at section “Prerequisites for Windows”,
Then, depending on the target device family please follow the “Additionals for …” sections to install device family specific requirements.
1.3.1. Prerequisites for Windows
To utilise the Renesas VS Code extensions on Windows, it’s necessary to install “CMake” and “Ninja Build” for project build operations.
You can install “CMake” and “Ninja Build” by downloading their latest installers.
Step 1: Install the latest “CMake” for Windows.
Download the latest version of CMake for Windows.
Install CMake for Windows.
Important
You must add the CMake folders to the “Path” environment variable. The Windows Installer of CMake has an option to modify the system’s environment variables and add the CMake folders to the “Path” variable. Please select this option during installation. If you are not using the installer or this option is not selected during installation, please use the following notes to manually add CMake’s bin folder to the Path variable.
Step 2: Install the latest “Ninja Build” for Windows.
Download the latest version of Ninja for Windows.
Extract the downloaded zip file (ninja-win.zip) and place the ninja.exe into a folder.
(e.g.: C:\Tools\ninja-build\ninja.exe).
Step 3: Configure the “Path” environment variable.
Open the System Environment Variables configuration, and add the following variables:
Add the path of CMake’s bin folder if it is not defined during the CMake installation.
(e.g. C:\Program Files\CMake\bin).
Add the path of the ninja.exe folder. (e.g. C:\Tools\ninja-build).
Guide for managing System Environment Variables
Use Windows Search to find and open “Edit the system environment variables”
In the “Advanced” tab, click on the “Environment Variables…” button to open the “Environment Variables” dialog.
Select to edit the “Path”.
Add CMake’s bin folder to the “Path” environment variable, then perform the following steps:
Add the path of CMake’s bin folder if it is not defined during the CMake installation. (e.g. C:\Program Files\CMake\bin).
Add the path of the ninja.exe folder. (e.g. C:\Tools\ninja-build).
Alternatively, Windows Prerequisites can be installed with Windows Package Manager Command Line Tool winget (*). Please run the following commands in Windows Command Prompt:
winget install Kitware.CMake
winget install Ninja-build.Ninja
(*) The winget is a command line tool enables users to discover, install, upgrade, remove and configure applications on Windows 10 and Windows 11 computers. This tool is the client interface to the Windows Package Manager service. It is a straightforward process if you want to use winget package manager for CMake and Ninja Build installation. For more information about winget, please visit: https://learn.microsoft.com/en-us/windows/package-manager/winget/
1.3.2. Additionals for Dialog
Installing Python 3.10:
Install the 64-bit version of the Python 3.10 into your system.
Add the path of the folder the Python 3.10 into the “Path” environment variable.
Guide to add Python 3.10 folder into the “Path” environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Select to edit “Path”
Add the path of Python 3.10 folder
Click OK to close the dialog
Installing the “GNU Arm Embedded Toolchain 9 (2019-Q4)”:
For Dialog projects, it is recommended to use the “GNU Arm Embedded Toolchain 9 (2019-Q4)”.
Download and install the “GNU Arm Embedded Toolchain 9 (2019-Q4)” toolchain:
Configure the Path environment variable, and add the bin folder of the toolchain to the Path environment variables.
Guide for configuring the “Path” environment variable
Use Windows Search to find and open “Edit the system environment variables”
In the “Advanced” tab, click on the “Environment Variables…” button to open the “Environment Variables” dialog.
Select “Path”, and then click to the “Edit” to edit the definition.
Add the bin folder of the toolchain to the “Path” environment variable, then save the changes.
Getting the Dialog Audio Development Platform:
For Dialog projects, it is recommended to use the “Dialog Audio Development Platform” during project development. Customers can have access the Audio Development Platform (ADP) software upon request.
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices. Please install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.3.3. Additionals for RA
Installing Python 3.10:
Install the 64-bit version of the Python 3.10 into your system.
Add the path of the folder the Python 3.10 into the “Path” environment variable.
Guide to add Python 3.10 folder into the “Path” environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Select to edit “Path”
Add the path of Python 3.10 folder
Click OK to close the dialog
Installing and Configuring RA Smart Configurator:
For RA projects, it is recommended to install and configure the RA Smart Configurator before starting the development. First, download and install the latest version of RA Smart Configurator:
Then, open the [Command Palette] (use [View] => [Command Palette] menu, or use [CTRL+SHIFT+P] keyboard combination), then click to the [Renesas: Open Renesas Support Files Manager].
Navigate to the [RA] device family.
Click the [Install] button to install the device family support files.
After the support files installation, Renesas Support Files Manager will show the installed Smart Configurators. Click the [Import Files] on your RA Smart Configurator.
If you can not see installed Smart Configurators
Click the [Select RA SC] button.
VS Code will ask for the path of the Smart Configurator binary. Navigate to the installation folder and select the [rasc.exe]. Please make sure you select the correct family of the Smart Configurator, you will be unable to register the family of the Smart Configurator not matched to the operation. Register RA Smart Configurator in RA device family.
Renesas Debug extension will register the Smart Configurator for use and automatically import the necessary definition files.
This process will register the Smart Configurator for use, and import the necessary device files for debugging.
Installing Toolchains for RA Development:
Install one of the preferred toolchains for RA Project Build. It is recommended to use either “Arm GNU Toolchain” or “LLVM Embedded Toolchain for Arm”.
Installing and Configuring “Arm GNU Toolchain” for Renesas RA
Download and install the latest toolchain:
https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads
Add the bin folder of the toolchain as “ARM_GCC_TOOLCHAIN_PATH” to the environment variables.
Guide for Configuring ARM_GCC_TOOLCHAIN_PATH environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Click to “New…”.
Enter the “ARM_GCC_TOOLCHAIN_PATH” to the Variable name field, and click to “Browse Directory…” to select the bin folder of the toolchain. Then click “OK”.
Installing and Configuring “LLVM Embedded Toolchain for Arm” for Renesas RA
Download and install the latest toolchain:
https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases
Add the bin folder of the toolchain as “ARM_LLVM_TOOLCHAIN_PATH” to the environment variables.
Guide for Configuring ARM_LLVM_TOOLCHAIN_PATH environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Click to “New…”.
Enter the “ARM_LLVM_TOOLCHAIN_PATH” to the Variable name field, and click to “Browse Directory…” to select the bin folder of the toolchain. Then click “OK”.
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices.
Using Renesas E2/E2Lite Emulators:
If you are using Renesas Emulators, please install the latest drivers before starting your debug session. Use the following link to download the drivers suitable for your operating system and device:
Using SEGGER J-Link Connection:
Install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.3.4. Additionals for R-Car
Installing Python 2.7 (32-bit):
Install the 32-bit version of the Python 2.7.18 (Important!: 32-bit Python is needed even in 64-bit OS environment).
Add the path of the Python 2.7.18 installation into the “Path” environment variable.
Guide to add Python 2.7 folder into the “Path” environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Select to edit “Path”
Add the path of Python folder
Click OK to close the dialog
Setting up a build environment with MinGW over MSYS2 for Windows
R-Car and RZ/N families require MinGW Makefiles in the development environment on Windows. Please, install CMake and MSYS2 packages.
Step 1: Install the latest CMake version for Windows.
Download the latest version of CMake for Windows.
Install CMake for Windows.
Important!: You must add the CMake folders to the Path environment variable. The Windows Installer of CMake has an option to modify the system’s environment variables and add the CMake folders to the Path variable. Please select this option during installation. If you are not using the installer or this option is not selected during installation, please use the notes at step 3 to manually add CMake’s bin folder to the Path variable.
Step 2: Install and configure the latest MSYS2 package.
Download the latest version of the MSYS2 package.
Install the MSYS2 package. The MSYS2 package will automatically install the MinGW environment.
Use Windows Search to find and open [MSYS2 MINGW64] terminal.
Install the make package for MinGW64 using pacman package manager.
pacman -S mingw-w64-x86_64-make
Check if make package is installed correctly.
mingw32-make --version
See also
make package is a 32-bit package. You can install it by using “MSYS2 MINGW32” terminal instead of “MSYS2 MINGW64” terminal. If you are using “MSYS2 MINGW32” then run the following command for the installation:
pacman -S mingw-w64-i686-make
Also, please make sure you include the correct folder for the Path environment variable in the next step (e.g. C:\msys64\mingw32\bin).
Step 3: Configure the Path environment variable.
Use Windows Search to find and open [Edit the system environment variables]
In the [Advanced] tab, click on the [Environment Variables…] button to open the [Environment Variables] dialog.
Select to edit the Path.
Add the path of CMake’s bin folder if it is not defined during the CMake installation.
(e.g. C:\Program Files\CMake\bin)
Add the path of the MSYS2 and MinGW bin folders.
(e.g. C:\msys64\usr\bin, C:\msys64\mingw64\bin)
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices.
Using Renesas E2/E2Lite Emulators:
If you are using Renesas Emulators, please install the latest drivers before starting your debug session. Use the following link to download the drivers suitable for your operating system and device:
Using SEGGER J-Link Connection:
Install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.3.5. Additionals for RH850
Installing Python 2.7 (32-bit):
Install the 32-bit version of the Python 2.7.18 (Important!: 32-bit Python is needed even in 64-bit OS environment).
Add the path of the Python 2.7.18 installation into the “Path” environment variable.
Guide to add Python 2.7 folder into the “Path” environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Select to edit “Path”
Add the path of Python folder
Click OK to close the dialog
Installing the latest RH850 Smart Configurator (RH850 SC):
For RH850 projects, it is recommended to download and install the latest RH850 Smart Configurator.
Installing “CC-RH” toolchains for RH850 Project Build:
For RH850 projects, it is recommended to install “CC-RH” toolchain. For installing “CC-RH”:
Download and install the latest toolchain:
https://www.renesas.com/us/en/software-tool/c-compiler-package-rh850-family
Add the bin folder of the toolchain as “RENESAS_CCRH_TOOLCHAIN_PATH” to the environment variables.
Configuring RENESAS_CCRH_TOOLCHAIN_PATH environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Click to “New…”.
Enter the “RENESAS_CCRH_TOOLCHAIN_PATH” to the Variable name field, and click to “Browse Directory…” to select the bin folder of the toolchain. Then click “OK”.
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices. Please install the latest drivers before starting your debug session. Use the following link to download the drivers suitable for your operating system and device:
1.3.6. Additionals for RL78
Installing Python 3.10:
Install the 64-bit version of the Python 3.10 into your system.
Add the path of the folder the Python 3.10 into the “Path” environment variable.
Guide to add Python 3.10 folder into the “Path” environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Select to edit “Path”
Add the path of Python 3.10 folder
Click OK to close the dialog
Installing the latest RL78 Smart Configurator (RL78 SC):
Download and install the latest version of RL78 Smart Configurator:
Installing Toolchains for RL78 Development:
Install one of the preferred toolchains for RL78 Project Build. It is recommended to use either “CC-RL” or “LLVM for Renesas RL78”.
Installing and Configuring “CC-RL” toolchain
For installing “CC-RL”:
Download and install the latest toolchain:
https://www.renesas.com/us/en/software-tool/c-compiler-package-rl78-family
Add the bin folder of the toolchain as “RENESAS_CCRL_TOOLCHAIN_PATH” to the environment variables.
Note
Configuring RENESAS_CCRL_TOOLCHAIN_PATH environment variable:
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Click to “New…”.
Enter the “RENESAS_CCRL_TOOLCHAIN_PATH” to the Variable name field, and click to “Browse Directory…” to select the bin folder of the toolchain. Then click “OK”.
Installing and Configuring “LLVM for Renesas RL78” toolchain
For installing “LLVM for Renesas RL78”:
Download and install the latest toolchain:
Add the bin folder of the toolchain as “RENESAS_LLVM_TOOLCHAIN_PATH” to the environment variables.
Note
Configuring RENESAS_LLVM_TOOLCHAIN_PATH environment variable:
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Click to “New…”.
Enter the “RENESAS_LLVM_TOOLCHAIN_PATH” to the Variable name field, and click to “Browse Directory…” to select the bin folder of the toolchain. Then click “OK”.
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices. Please install the latest drivers before starting your debug session. Use the following link to download the drivers suitable for your operating system and device:
For other Renesas emulators, please check for any recommended drivers:
1.3.7. Additionals for RX
Installing Python 3.10:
Install the 64-bit version of the Python 3.10 into your system.
Add the path of the folder the Python 3.10 into the “Path” environment variable.
Guide to add Python 3.10 folder into the “Path” environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Select to edit “Path”
Add the path of Python 3.10 folder
Click OK to close the dialog
Installing the latest RX Smart Configurator (RX SC):
Download and install the latest version of RX Smart Configurator
Installing Toolchains for RX Development:
Install one of the preferred toolchains for RX Project Build. It is recommended to use either “CC-RX” or “GCC for Renesas GNURX”.
Installing and Configuring “CC-RX” toolchain
For installing “CC-RX”:
Download and install the latest toolchain:
https://www.renesas.com/us/en/software-tool/cc-compiler-package-rx-family
Add the bin folder of the toolchain as “RENESAS_RXC_TOOLCHAIN_PATH” to the environment variables.
Configuring RENESAS_RXC_TOOLCHAIN_PATH environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Click to “New…”.
Enter the “RENESAS_RXC_TOOLCHAIN_PATH” to the Variable name field, and click to “Browse Directory…” to select the bin folder of the toolchain. Then click “OK”.
Note
For building CC-RX projects without using RX Smart Configurator, add “BIN_RX”, “INC_RX” and “TMP_RX” variables to the environment variables with the following values:
BIN_RX: bin folder of the CC-RX toolchain (e.g.: C:\Toolchains\CCRX\3_6_0\bin).
INC_RX: include folder of the CC-RX toolchain (e.g.: C:\Toolchains\CCRX\3_6_0\include).
TMP_RX: root folder of the CC-RX toolchain (e.g.: C:\Toolchains\CCRX\3_6_0).
Installing and Configuring “GCC for Renesas GNURX” toolchain
For installing “GCC for Renesas GNURX”:
Download and install the latest toolchain:
Add the bin folder of the toolchain as “RENESAS_GCCRX_TOOLCHAIN_PATH” to the environment variables.
Note
Configuring RENESAS_GCCRX_TOOLCHAIN_PATH environment variable:
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Click to “New…”.
Enter the “RENESAS_GCCRX_TOOLCHAIN_PATH” to the Variable name field, and click to “Browse Directory…” to select the bin folder of the toolchain. Then click “OK”.
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices. Please install the latest drivers before starting your debug session. Use the following link to download the drivers suitable for your operating system and device:
Using Renesas Emulators:
If you are using Renesas Emulators, please install the latest drivers before starting your debug session. Use the following link to download the drivers suitable for your operating system and device:
For other Renesas emulators, please check for any recommended drivers:
Using SEGGER J-Link Connection:
Install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.3.8. Additionals for RZ family
Installing Python 3.10:
Install the 64-bit version of the Python 3.10 into your system.
Add the path of the folder the Python 3.10 into the “Path” environment variable.
Guide to add Python 3.10 folder into the “Path” environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Select to edit “Path”
Add the path of Python 3.10 folder
Click OK to close the dialog
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices. Please install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.3.9. Additionals for RZ/N family
Installing Python 3.10:
Install the 64-bit version of the Python 3.10 into your system.
Add the path of the folder the Python 3.10 into the “Path” environment variable.
Guide to add Python 3.10 folder into the “Path” environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Select to edit “Path”
Add the path of Python 3.10 folder
Click OK to close the dialog
Setting up a build environment with MinGW over MSYS2 for Windows
R-Car and RZ/N families require MinGW Makefiles in the development environment on Windows. Please, install CMake and MSYS2 packages.
Step 1: Install the latest CMake version for Windows.
Download the latest version of CMake for Windows.
Install CMake for Windows.
Important!: You must add the CMake folders to the Path environment variable. The Windows Installer of CMake has an option to modify the system’s environment variables and add the CMake folders to the Path variable. Please select this option during installation. If you are not using the installer or this option is not selected during installation, please use the notes at step 3 to manually add CMake’s bin folder to the Path variable.
Step 2: Install and configure the latest MSYS2 package.
Download the latest version of the MSYS2 package.
Install the MSYS2 package. The MSYS2 package will automatically install the MinGW environment.
Use Windows Search to find and open [MSYS2 MINGW64] terminal.
Install the make package for MinGW64 using pacman package manager.
pacman -S mingw-w64-x86_64-make
Check if make package is installed correctly.
mingw32-make --version
See also
make package is a 32-bit package. You can install it by using “MSYS2 MINGW32” terminal instead of “MSYS2 MINGW64” terminal. If you are using “MSYS2 MINGW32” then run the following command for the installation:
pacman -S mingw-w64-i686-make
Also, please make sure you include the correct folder for the Path environment variable in the next step (e.g. C:\msys64\mingw32\bin).
Step 3: Configure the Path environment variable.
Use Windows Search to find and open [Edit the system environment variables]
In the [Advanced] tab, click on the [Environment Variables…] button to open the [Environment Variables] dialog.
Select to edit the Path.
Add the path of CMake’s bin folder if it is not defined during the CMake installation.
(e.g. C:\Program Files\CMake\bin)
Add the path of the MSYS2 and MinGW bin folders.
(e.g. C:\msys64\usr\bin, C:\msys64\mingw64\bin)
Installing the latest RZ/N Smart Configurator:
Download and install the latest version of RZ/N Smart Configurator:
Installing the “Arm GNU Toolchain” toolchains for RZ/N Development
For installing “Arm GNU Toolchain”:
Download and install the latest toolchain:
https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads
Add the bin folder of the toolchain as “ARM_GCC_TOOLCHAIN_PATH” to the environment variables.
Guide for Configuring ARM_GCC_TOOLCHAIN_PATH environment variable
Use Window search to find and open “Edit the system environment variables”
In “Advanced” tab, click on “Environment Variables…” button to open “Environment Variables” dialog
Click to “New…”.
Enter the “ARM_GCC_TOOLCHAIN_PATH” to the Variable name field, and click to “Browse Directory…” to select the bin folder of the toolchain. Then click “OK”.
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices. Please install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.4. Dependencies for Ubuntu 20.04
Important
Ubuntu 20.04 version is only suggested to be used as an R-Car development environment. Please consider using a newer version of the Ubuntu operating system for other device families
1.4.1. Prerequisites for Ubuntu 20.04
Installing the Dependent Packages:
Run the following commands to refresh the package lists, and install the dependent packages:
sudo apt update sudo apt install cmake libusb-1.0-0-dev
1.4.2. Additionals for R-Car
For debugging in device family R-Car:
Install Python 2.7 libraries for debugging in R-Car device family. Use the following command to install the required libraries:
sudo apt install python2.7-dev
1.5. Dependencies for Ubuntu 22.04
Important
Debugging in the RH850 device family is not available in Ubuntu 22.04.
Renesas Extensions support a variety of device and tools combinations for embedded development. It is essential to set-up your development environment properly before starting your development. For Ubuntu 22.04 operating systems, please follow this guide to set-up your environment. It is suggested to:
Firstly, follow the instructions at section “Prerequisites for Ubuntu 22.04”,
Then, depending on the target device family please follow the “Additionals for …” sections to install device family specific requirements.
1.5.1. Prerequisites for Ubuntu 22.04
Installing the Dependent Packages:
Run the following commands to refresh the package lists, and install the dependent packages:
sudo apt update sudo apt install cmake ninja-build libusb-1.0-0-dev python3.10-dev
1.5.2. Additionals for Dialog
Installing the “GNU Arm Embedded Toolchain 9 (2019-Q4)”:
For Dialog projects, it is recommended to use the “GNU Arm Embedded Toolchain 9 (2019-Q4)”.
Download and install the “GNU Arm Embedded Toolchain 9 (2019-Q4)” toolchain:
Configure the PATH environment variable, and add the bin folder of the toolchain to the PATH environment variables.
Guide for configuring the “PATH” environment variable
For configuring PATH environment variable, open .bashrc file in the home folder of the current user, then add the following line:
export PATH="<bin folder of the Arm GNU Toolchain>:$PATH"
For instance:
export PATH="/home/renesas/gcc-arm-none-eabi-9-2019-q4-major/bin:$PATH"
Getting the Dialog Audio Development Platform:
For Dialog projects, it is recommended to use the “Dialog Audio Development Platform” during project development. Customers can have access the Audio Development Platform (ADP) software upon request.
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices. Please install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.5.3. Additionals for RA
Installing and Configuring RA Smart Configurator:
For RA projects, it is recommended to install and configure the RA Smart Configurator before starting the development. First, download and install the latest version of RA Smart Configurator:
Then, open the [Command Palette] (use [View] => [Command Palette] menu, or use [CTRL+SHIFT+P] keyboard combination), then click to the [Renesas: Open Renesas Support Files Manager].
Navigate to the [RA] device family.
Click the [Install] button to install the device family support files.
After the support files installation, click the [Select RA SC] button.
VS Code will ask for the path of the RA Smart Configurator binary. Navigate to the installation folder and select the [rasc] binary.
Renesas Debug extension will register the RA Smart Configurator for use and automatically import the necessary definition files.
Installing Toolchains for RA Development:
Install one of the preferred toolchains for RA Project Build. It is recommended to use either “Arm GNU Toolchain” or “LLVM Embedded Toolchain for Arm”.
Installing and Configuring “Arm GNU Toolchain” for Renesas RA
Download and install the latest toolchain:
https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads
Add the bin folder of the toolchain as “ARM_GCC_TOOLCHAIN_PATH” to the environment variables.
Guide for Configuring ARM_GCC_TOOLCHAIN_PATH environment variable
For adding ARM_GCC_TOOLCHAIN_PATH variable to environment variables, open .bashrc file in the home folder of the current user, then add the following line:
export ARM_GCC_TOOLCHAIN_PATH="<bin folder of the Arm GNU Toolchain>"
For instance:
export ARM_GCC_TOOLCHAIN_PATH="/home/renesas/arm-gnu-toolchain-13.2.Rel1-darwin-arm64-arm-none-eabi/bin"
Installing and Configuring “LLVM Embedded Toolchain for Arm” for Renesas RA
Download and install the latest toolchain:
https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases
Add the bin folder of the toolchain as “ARM_LLVM_TOOLCHAIN_PATH” to the environment variables.
Guide for Configuring ARM_LLVM_TOOLCHAIN_PATH environment variable
For adding ARM_LLVM_TOOLCHAIN_PATH variable to environment variables, open .bashrc file in the home folder of the current user, then add the following line:
export ARM_LLVM_TOOLCHAIN_PATH="<bin folder of the LLVM Embedded Toolchain for Arm>"
For instance:
export ARM_LLVM_TOOLCHAIN_PATH="/home/renesas/LLVMEmbeddedToolchainForArm-17.0.1-Darwin/bin"
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices.
Using Renesas E2/E2Lite Emulators:
If you are using Renesas Emulators, please install the latest drivers before starting your debug session. Use the following link to download the drivers suitable for your operating system and device:
Using SEGGER J-Link Connection:
Install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.6. Dependencies for Ubuntu 24.04
Important
Debugging in the RH850 device family is not available in Ubuntu 24.04.
Renesas Extensions support a variety of device and tools combinations for embedded development. It is essential to set-up your development environment properly before starting your development. For Ubuntu 24.04 operating systems, please follow this guide to set-up your environment. It is suggested to:
Firstly, follow the instructions at section “Prerequisites for Ubuntu 24.04”,
Then, depending on the target device family please follow the “Additionals for …” sections to install device family specific requirements.
1.6.1. Prerequisites for Ubuntu 24.04
Installing the Dependent Packages:
Run the following commands to refresh the package lists, and install the dependent packages:
sudo apt update sudo apt install cmake ninja-build libusb-1.0-0-dev
Installing Python 3.10:
Install Python 3.10 libraries for debugging in device families Dialog, RA, RL78, RX and RZ. Python 3.10 is not directly accessible at the default APT repository of Ubuntu 24.04, you can use the 3rd party repository (ppa:deadsnakes/ppa) to install Python 3.10 by following the instructions below:
sudo add-apt-repository ppa:deadsnakes/ppa sudo apt update sudo apt install python3.10-dev
1.6.2. Additionals for Dialog
Installing the “GNU Arm Embedded Toolchain 9 (2019-Q4)”:
For Dialog projects, it is recommended to use the “GNU Arm Embedded Toolchain 9 (2019-Q4)”.
Download and install the “GNU Arm Embedded Toolchain 9 (2019-Q4)” toolchain:
Configure the PATH environment variable, and add the bin folder of the toolchain to the PATH environment variables.
Guide for configuring the “PATH” environment variable
For configuring PATH environment variable, open .bashrc file in the home folder of the current user, then add the following line:
export PATH="<bin folder of the Arm GNU Toolchain>:$PATH"
For instance:
export PATH="/home/renesas/gcc-arm-none-eabi-9-2019-q4-major/bin:$PATH"
Getting the Dialog Audio Development Platform:
For Dialog projects, it is recommended to use the “Dialog Audio Development Platform” during project development. Customers can have access the Audio Development Platform (ADP) software upon request.
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices. Please install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.6.3. Additionals for RA
Installing and Configuring RA Smart Configurator:
For RA projects, it is recommended to install and configure the RA Smart Configurator before starting the development. First, download and install the latest version of RA Smart Configurator:
Then, open the [Command Palette] (use [View] => [Command Palette] menu, or use [CTRL+SHIFT+P] keyboard combination), then click to the [Renesas: Open Renesas Support Files Manager].
Navigate to the [RA] device family.
Click the [Install] button to install the device family support files.
After the support files installation, click the [Select RA SC] button.
VS Code will ask for the path of the RA Smart Configurator binary. Navigate to the installation folder and select the [rasc] binary.
Renesas Debug extension will register the RA Smart Configurator for use and automatically import the necessary definition files.
Installing Toolchains for RA Development:
Install one of the preferred toolchains for RA Project Build. It is recommended to use either “Arm GNU Toolchain” or “LLVM Embedded Toolchain for Arm”.
Installing and Configuring “Arm GNU Toolchain” for Renesas RA
Download and install the latest toolchain:
https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads
Add the bin folder of the toolchain as “ARM_GCC_TOOLCHAIN_PATH” to the environment variables.
Guide for Configuring ARM_GCC_TOOLCHAIN_PATH environment variable
For adding ARM_GCC_TOOLCHAIN_PATH variable to environment variables, open .bashrc file in the home folder of the current user, then add the following line:
export ARM_GCC_TOOLCHAIN_PATH="<bin folder of the Arm GNU Toolchain>"
For instance:
export ARM_GCC_TOOLCHAIN_PATH="/home/renesas/arm-gnu-toolchain-13.2.Rel1-darwin-arm64-arm-none-eabi/bin"
Installing and Configuring “LLVM Embedded Toolchain for Arm” for Renesas RA
Download and install the latest toolchain:
https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases
Add the bin folder of the toolchain as “ARM_LLVM_TOOLCHAIN_PATH” to the environment variables.
Guide for Configuring ARM_LLVM_TOOLCHAIN_PATH environment variable
For adding ARM_LLVM_TOOLCHAIN_PATH variable to environment variables, open .bashrc file in the home folder of the current user, then add the following line:
export ARM_LLVM_TOOLCHAIN_PATH="<bin folder of the LLVM Embedded Toolchain for Arm>"
For instance:
export ARM_LLVM_TOOLCHAIN_PATH="/home/renesas/LLVMEmbeddedToolchainForArm-17.0.1-Darwin/bin"
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices.
Using Renesas E2/E2Lite Emulators:
If you are using Renesas Emulators, please install the latest drivers before starting your debug session. Use the following link to download the drivers suitable for your operating system and device:
Using SEGGER J-Link Connection:
Install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.7. Dependencies for macOS
Renesas Extensions support a variety of device and tools combinations for embedded development. It is essential to set-up your development environment properly before starting your development. For macOS operating systems, please follow this guide to set-up your environment. It is suggested to:
Firstly, follow the instructions at section “Prerequisites for macOS”,
Then, depending on the target device family please follow the “Additionals for …” sections to install device family specific requirements.
1.7.1. Prerequisites for macOS
Note
Installation steps for macOS are using Homebrew (brew), which is an open-source software package management system that simplifies the installation of software for macOS. For installation and more information about Homebrew, please refer to https://brew.sh/.
To utilise the build and debug with Renesas extensions on macOS, it’s necessary to install:
CMake
Ninja Build
XZ Archive Utilities
Python 3.10: Specific version of the Python is required for debugging Dialog, RA, RL78 and RX device families on macOS
You can install these dependencies by performing the following steps:
Install the required packages by using brew install cmake ninja xz python@3.10 command.
$ brew install cmake ninja xz python@3.10
Check CMake version: You can verify the current installed version of CMake by running cmake –version command as shown below:
$ cmake --version
Check Ninja Build version: You can also verify the current installed version of Ninja Build by running ninja –version command as shown below:
$ ninja --version
1.7.2. Additionals for Dialog
Installing the “GNU Arm Embedded Toolchain 9 (2019-Q4)”:
For Dialog projects, it is recommended to use the “GNU Arm Embedded Toolchain 9 (2019-Q4)”.
Download and install the “GNU Arm Embedded Toolchain 9 (2019-Q4)” toolchain:
Configure the PATH environment variable, and add the bin folder of the toolchain to the PATH environment variables.
Guide for configuring the “PATH” environment variable
For configuring PATH environment variable, open .zprofile file in the home folder of the current user, then add the following line:
export PATH="<bin folder of the Arm GNU Toolchain>:${PATH}"
For instance:
export PATH="/Users/renesas/gcc-arm-none-eabi-9-2019-q4-major/bin:${PATH}"
Getting the Dialog Audio Development Platform:
For Dialog projects, it is recommended to use the “Dialog Audio Development Platform” during project development. Customers can have access the Audio Development Platform (ADP) software upon request.
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices. Please install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.7.3. Additionals for RA
Installing and Configuring RA Smart Configurator:
For RA projects, it is recommended to install and configure the RA Smart Configurator before starting the development. First, download and install the latest version of RA Smart Configurator:
Then, open the [Command Palette] (use [View] => [Command Palette] menu, or use [CMD+SHIFT+P] keyboard combination), then click to the [Renesas: Open Renesas Support Files Manager].
Navigate to the [RA] device family.
Click the [Install] button to install the device family support files.
After the installation, click to the [Select RA SC]. It is now asking for the path of the RA Smart Configurator binary. Leave the file dialog open (we will drag&drop the binary to this window later), and open a separate [Finder] window.
Navigate to the [Renesas RA FSP] application under the [Applications] folder.
Right click to the [Renesas RA FSP X.Y.Z] application and click to the [Show Package Contents],
Navigate to the [Contents] => [MacOS] folder inside the package, then, drag&drop the [rasc] binary back to the file dialog window.
Click to the [Select] button.
Now, VS Code is starting to import the additional device files. At the end of the import, RA Smart Configurator will be registered for use.
Installing Toolchains for RA Development:
Install one of the preferred toolchains for RA Project Build. It is recommended to use either “Arm GNU Toolchain” or “LLVM Embedded Toolchain for Arm”.
Installing and Configuring “Arm GNU Toolchain” for Renesas RA
Download and install the latest toolchain:
https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads
Add the bin folder of the toolchain as “ARM_GCC_TOOLCHAIN_PATH” to the environment variables.
Guide for Configuring ARM_GCC_TOOLCHAIN_PATH environment variable
For adding ARM_GCC_TOOLCHAIN_PATH variable to environment variables, open .zprofile file in the home folder of the current user, then add the following line:
export ARM_GCC_TOOLCHAIN_PATH="<bin folder of the Arm GNU Toolchain>"
For instance:
export ARM_GCC_TOOLCHAIN_PATH="/Users/renesas/arm-gnu-toolchain-13.2.Rel1-darwin-arm64-arm-none-eabi/bin"
Installing and Configuring “LLVM Embedded Toolchain for Arm” for Renesas RA
Download and install the latest toolchain:
https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases
Add the bin folder of the toolchain as “ARM_LLVM_TOOLCHAIN_PATH” to the environment variables.
Guide for Configuring ARM_LLVM_TOOLCHAIN_PATH environment variable
For adding ARM_LLVM_TOOLCHAIN_PATH variable to environment variables, open .zprofile file in the home folder of the current user, then add the following line:
export ARM_LLVM_TOOLCHAIN_PATH="<bin folder of the LLVM Embedded Toolchain for Arm>"
For instance:
export ARM_LLVM_TOOLCHAIN_PATH="/Users/renesas/LLVMEmbeddedToolchainForArm-17.0.1-Darwin/bin"
Installing Emulator Drivers
You may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices.
Using Renesas E2/E2Lite Emulators:
If you are using Renesas Emulators, please install the latest drivers before starting your debug session. Use the following link to download the drivers suitable for your operating system and device:
Using SEGGER J-Link Connection:
Install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system:
1.8. Supported Toolchains
Install the latest (or suggested) toolchains for a target device family and add the path of the desired toolchain’s bin folder to the “PATH” environment variable.
Device Family |
Toolchain |
---|---|
Dialog |
|
RA |
|
RH850 |
|
RL78 |
|
RX |
|
RZ |
1.9. Drivers for Debugging Connection
Both for Windows, Linux and macOS operating systems, you may need to download and install additional USB drivers for establishing a proper connection with the emulators and devices.
1.9.1. Using Renesas Emulators:
If you are using Renesas Emulators, please install the latest drivers before starting your debug session. Use the following link to download the drivers suitable for your operating system and device:
For other Renesas emulators, please check for any recommended drivers:
1.9.2. Using SEGGER J-Link Connection:
Install the latest SEGGER J-Link drivers before starting your debug session. Use the following link to download the J-Link drivers suitable for your operating system: