2. Creating and Building a Project

Please navigate to the section related to target use:

For RH850, RL78, RX, RZ, R-Car projects which are previously generated by e 2 studio, please follow the instructions in section Using CMake Toolchain Scripts to create and configure the CMake Build Scripts.

Please also refer to Introductory Videos for C++ in Visual Studio Code documents for handling projects and working with CMake.

2.1. Using Smart Configurator for RA Projects (RA SC)

For RA device family projects, it is recommended to use RA Smart Configurator to create a project for VS Code. Please follow the following instructions to create and build a project for RA device family.

2.1.1. Creating an RA Project with Smart Configurator

For RA device family projects, it is recommended to use RA Smart Configurator to create a project for VS Code. Smart Configurator could be directly used from VS Code command palette for creating a project for RA device family. Please follow the following instructions to create and build a project for RA device family.

  1. Open [Command Palette] and select [Renesas: Create RA Project with Smart Configurator] from the commands.

    _images/rasc_cp_create_project.png

  2. VSCode will show installed [RA Smart Configurator] list, select a [Smart Configurator] from the list.

    _images/rasc_cp_create_select_rasc.png

    Note

    If an RA Smart Configurator is not detected automatically, the message “No RA Smart Configurator installation found!” will be displayed in VSCode:

    _images/rasc_cp_no_rasc_found.png

    • For Linux and Windows operating systems, please click to the “Browse RA SC”, then select the location of the RA Smart Configurator binary (“rasc.exe” for Windows; “rasc” for Linux), when a select file dialog window appears. Extension will automatically register the location of the RA Smart Configurator for the next use.

    • For macOS operating systems, please follow the instructions in installation chapter here.

  3. Select a [Folder] to create the project.

    _images/rasc_cp_create_select_folder.png

  4. Enter [Project name] and click [Next].

    _images/rasc_create_project1.png

  5. Configure your board, device type and preferred toolchain from the toolchains list, then click [Next].

    _images/rasc_create_project2.png

  6. Choose “No RTOS” for the sample project and click [Next].

    _images/rasc_create_project3.png

  7. Choose one of the project templates then click [Finish] to complete the project creation steps.

    _images/rasc_create_project4.png

  8. Close [RA Smart Configurator] after generation of the project files completed.

    _images/rasc_create_project5.png

2.1.2. Building an RA Project created in Smart Configurator

For building a project, which has been created with RA Smart Configurator, please follow the steps below:

  1. When the project is opened for the first time, CMake configure and the CMake Kit selection operations must be performed. In order to do these operations, open the [Command Palette] in VSCode and select [CMake: Configure] from the commands.

    _images/rasc_build_project1.png

  2. Then, a kit selection menu will be shown. Select “ARM GCC - Ninja” from the menu.

    _images/rasc_build_project2.png

    Note

    Missing the selection of the CMake Kit or wrong selection can cause build problems. If you missed the CMake Kit selection or selected a wrong kit, you can re-select the CMake Kit by running “CMake: Select a kit” command from the VSCode Command Palette.

    _images/rasc_build_project2_sak.png

  3. Now, go to and click “Terminal” => “Run Build Task” from the menu.

    _images/rasc_build_project3.png

  4. Build options will be shown, select the “Build Project” option.

    _images/rasc_build_project4.png

After the build operation, by default, build output (<project name>.elf) can be found in “build/<Build Type>/CMakeFiles/<project name>.elf.dir/” folder.

TIP: For more information about RA Smart Configurator, click here to visit RA Smart Configurator page.

2.2. Using Smart Configurator for RH850 Projects (RH850 SC)

For RH850 device family projects, it is recommended to use RH850 Smart Configurator to create a project for VS Code. Please follow these instructions to create and build a project for RH850 device family.

Note

Before creating a project for the RH850 device family, please install the RH850 support files from the [Renesas Support Files Manager] by following the instructions in chapter “Managing Support Files”.

2.2.1. Creating an RH850 Project with Smart Configurator

Smart Configurator can be accessed from the VS Code command palette to create a project for the RH850 device family.

  1. Open [Command Palette] and select [Renesas: Create RH850 Project with Smart Configurator] from the commands.

    _images/rh850sc_rh850_cp_create_project.png

  2. VSCode will show installed [RH850 Smart Configurator] list, select a [Smart Configurator] from the list.

    _images/rh850sc_rh850_cp_create_select_rh850sc.png

    Note

    If an RH850 Smart Configurator is not detected automatically, the message “No RH850 Smart Configurator installation found!” will be displayed in VSCode:

    _images/rh850sc_rh850_cp_no_rxsc_found.png

    Please click “Browse RH850 SC”, then select the location of the RH850 Smart Configurator binary (“SmartConfigurator.exe” for Windows). When a select file dialog window appears, the extension will automatically store the location of the RH850 Smart Configurator for the next use.

  3. Select a [Folder] to create the project.

    _images/rh850sc_rh850_cp_create_select_folder.png

  4. Enter [File name], configure your board and device type, select [Renesas CCRH850 Toolchain], and then click [Next].

    _images/rh850sc_rh850_create_project1.png

  5. Configure [RTOS] then click [Finish] to complete the project creation steps.

    _images/rh850sc_rh850_create_project2.png

  6. Click [Generate Code] and close [RH850 Smart Configurator] after generation of the project files completes.

    _images/rh850sc_rh850_create_project3.png

2.2.2. Building an RH850 Project created in Smart Configurator

For building a project, which has been created with RH850 Smart Configurator, please follow the steps below:

  1. In the VS Code Command Palette, run the “CMake: Delete Cache and Reconfigure” command.

    _images/delete_cache_and_reconfigure.png

  2. In the first time of running, a kit selection is shown. Select “[Unspecified]”.

    _images/select_unspecified_kit.png

  3. In VS Code, click [Terminal] ⇒ [Run Build Task] from the menu. Alternatively, press ctrl+shift+B to quickly open the Build task.

    _images/sc_run_build_task.png

  4. Select [Build Project] from the commands.

    _images/rasc_build_project4.png

TIP: For more information about RH850 Smart Configurator, click here to visit the RH850 Smart Configurator page.

2.3. Using Smart Configurator for RL78 Projects (RL78 SC)

For RL78 device family projects, it is recommended to use RL78 Smart Configurator to create a project for VS Code. Please follow these instructions to create and build a project for RL78 device family.

Note

Before creating a project for the RL78 device family, please install the RL78 support files from the [Renesas Support Files Manager] by following the instructions in chapter “Managing Support Files”.

2.3.1. Creating an RL78 Project with Smart Configurator

Smart Configurator can be accessed from the VS Code command palette to create a project for the RL78 device family.

  1. Open [Command Palette] and select [Renesas: Create RL78 Project with Smart Configurator] from the commands.

    _images/rl78sc_rl78_cp_create_project.png

  2. VSCode will show installed [RL78 Smart Configurator] list, select a [Smart Configurator] from the list.

    _images/rl78sc_rl78_cp_create_select_rl78sc.png

    Note

    If an RL78 Smart Configurator is not detected automatically, the message “No RL78 Smart Configurator installation found!” will be displayed in VSCode:

    _images/rl78sc_rl78_cp_no_rxsc_found.png

    Please click “Browse RL78 SC”, then select the location of the RL78 Smart Configurator binary (“SmartConfigurator.exe” for Windows). When a select file dialog window appears, the extension will automatically store the location of the RL78 Smart Configurator for the next use.

  3. Select a [Folder] to create the project.

    _images/rl78sc_rl78_cp_create_select_folder.png

  4. Enter [File name], configure your board and device type, select either [Renesas CCRL78 Toolchain] or [LLVM for Renesas RL78] (only applicable for some devices), and then click [Finish] to complete the project creation steps.

    _images/rl78sc_rl78_create_project1.png

  5. Click [System], select [Use emulator] or [COM Port] for [On-chip debug operation setting].

    _images/rl78sc_rl78_create_project2.png

  6. Click [Generate Code] and close [RL78 Smart Configurator] after generation of the project files completes.

    _images/rl78sc_rl78_create_project3.png

2.3.2. Building an RL78 Project created in Smart Configurator

For building a project, which has been created with RL78 Smart Configurator, please follow the steps below:

  1. In the VS Code Command Palette, run the “CMake: Delete Cache and Reconfigure” command.

    _images/delete_cache_and_reconfigure.png

  2. In the first time of running, a kit selection is shown. Select “[Unspecified]”.

    _images/select_unspecified_kit.png

  3. In VS Code, click [Terminal] ⇒ [Run Build Task] from the menu. Alternatively, press ctrl+shift+B to quickly open the Build task.

    _images/sc_run_build_task.png

  4. Select [Build Project] from the commands.

    _images/rasc_build_project4.png

TIP: For more information about RL78 Smart Configurator, click here to visit the RL78 Smart Configurator page.

2.4. Using Smart Configurator for RX Projects (RX SC)

For RX device family projects, it is recommended to use RX Smart Configurator to create a project for VS Code. Please follow these instructions to create and build a project for RX device family.

Note

Before creating a project for the RX device family, please install the RX support files from the [Renesas Support Files Manager] by following the instructions in chapter “Managing Support Files”.

2.4.1. Creating an RX Project with Smart Configurator

Smart Configurator can be accessed from the VS Code command palette to create a project for the RX device family.

  1. Open [Command Palette] and select [Renesas: Create RX Project with Smart Configurator] from the commands.

    _images/rxsc_rx_cp_create_project.png

  2. VSCode will show installed [RX Smart Configurator] list, select a [Smart Configurator] from the list.

    _images/rxsc_rx_cp_create_select_rxsc.png

    Note

    If an RX Smart Configurator is not detected automatically, the message “No RX Smart Configurator installation found!” will be displayed in VSCode:

    _images/rxsc_rx_cp_no_rxsc_found.png

    Please click “Browse RX SC”, then select the location of the RX Smart Configurator binary (“SmartConfigurator.exe” for Windows). When a select file dialog window appears, the extension will automatically store the location of the RX Smart Configurator for the next use.

  3. Select a [Folder] to create the project.

    _images/rxsc_rx_cp_create_select_folder.png

  4. Enter [File name], configure your board and device type, select either [Renesas RXC Toolchain] or [GCC RX Toolchain], and then click [Next].

    _images/rxsc_rx_create_project1.png

  5. Choose one of the [Bank mode setting] (applicable for some devices) then click [Finish] to complete the project creation steps.

    _images/rxsc_rx_create_project2.png

  6. Click [Generate Code] and close [RX Smart Configurator] after generation of the project files completes.

    _images/rxsc_rx_create_project3.png

2.4.2. Building an RX Project created in Smart Configurator

For building a project, which has been created with RX Smart Configurator, please follow the steps below:

  1. In the VS Code Command Palette, run the “CMake: Delete Cache and Reconfigure” command.

    _images/delete_cache_and_reconfigure.png

  2. In the first time of running, a kit selection is shown. Select “[Unspecified]”.

    _images/select_unspecified_kit.png

  3. In VS Code, click [Terminal] ⇒ [Run Build Task] from the menu. Alternatively, press ctrl+shift+B to quickly open the Build task.

    _images/sc_run_build_task.png

  4. Select [Build Project] from the commands.

    _images/rasc_build_project4.png

TIP: For more information about RX Smart Configurator, click here to visit the RX Smart Configurator page.

2.5. Using Smart Configurator for RZ/N Projects (RZ/N SC)

Note

Projects that are generated with RZ/N Smart Configurator require “MinGW Makefiles” as the CMake Generator for Windows. If you are planning to use RZ/N Smart Configurator during project generation, please follow the additional installation instructions in chapter Additionals for RZ/N family for installing the build prerequisites.

For RZ/N device family projects, it is recommended to use RZ/N Smart Configurator to create a project for VS Code. Please follow the following instructions to create and build a project for RZ/N device family.

2.5.1. Creating an RZ/N Project with Smart Configurator

Smart Configurator could be directly used from VS Code command palette for creating a project for RZ/N device family.

  1. Open [Command Palette] and select [Renesas: Create RZ/N Project with Smart Configurator] from the commands.

    _images/rasc_rzn_cp_create_project.png

  2. VSCode will show installed [RZ/N Smart Configurator] list, select a [Smart Configurator] from the list.

    _images/rasc_rzn_cp_create_select_rasc.png

    Note

    If an RZ/N Smart Configurator is not detected automatically, the message “No RZ/N Smart Configurator installation found!” will be displayed in VSCode:

    _images/rasc_rzn_cp_no_rasc_found.png

    Please click on “Browse RZ/N SC”, then select the location of the RZ/N Smart Configurator binary (rasc.exe), when the select file dialog window appears. The extension will automatically register the location of the RZ/N Smart Configurator for the next use.

  3. Select a [Folder] to create the project.

    _images/rasc_rzn_cp_create_select_folder.png

  4. In the project name and location selection, Click [Next].

    _images/rasc_rzn_create_project1.png

  5. Configure your board and device type, and configure the project as CMake project, then click [Next].

    _images/rasc_rzn_create_project2.png

  6. Continue without RTOS selection and click [Next].

    _images/rasc_rzn_create_project3.png

  7. Choose one of the project templates then click [Finish] to complete the project creation steps.

    _images/rasc_rzn_create_project4.png

  8. Close [RZ/N Smart Configurator] after generation of the project files completed.

    _images/rasc_rzn_create_project5.png

  9. Open [Config.cmake] file and set [CMAKE_FIND_ROOT_PATH] variable with the path of toolchain’s bin folder. E.g.

    _images/rasc_rzn_create_project6.png

Config.cmake:

# Configuration file for user settings
# This file should include the path for toolchain and other settings that user would like to override.
# Example toolchain path definitions
set(CMAKE_FIND_ROOT_PATH "D:/Toolchains/GCC/gcc-arm-none-eabi-9-2019-q4-major-win32/bin")

2.5.2. Building an RZ/N Project created in Smart Configurator

For building a project, which has been created with RZ/N Smart Configurator, please follow the steps below:

  1. In the VS Code Command Palette, run the “CMake: Delete Cache and Reconfigure” command.

    _images/rasc_rzn_build_project1.png

  2. In the first time of running, a kit selection is shown. Select “[Unspecified]”.

    _images/rasc_rzn_build_project2.png

  3. Then, run “CMake: Build” command.

    _images/rasc_rzn_build_project3.png

  4. By default, executable file (<project name>.elf) can be found in “build/CMakeFiles/<project name>.elf.dir/” folder.

TIP: For more information about RZ/N Smart Configurator, click here to visit RZ/N Smart Configurator page.

2.6. Using Audio Development Platform (ADP) for Dialog DA148xx device family

Renesas VS Code extensions support project development for DA148xx family of integrated audio processors. Customers can have access to the Audio Development Platform software upon request and start their Dialog project development by using Dialog Audio Development Platform (ADP). The ADP comes with ready to start, predefined project samples inside the package. Please follow the instructions below to start developing a Dialog device project:

  1. From the ADP sample projects, open a desired start up project in VSCode.

    Note

    Sample projects in the ADP can be found inside the following directories:

    • <ADP_ROOT>/Software/Source/projects/bare_metal

    • <ADP_ROOT>/Software/Source/projects/freertos

  2. After your project is opened in VSCode, open the settings file of the project in .vscode/settings.json path and check the cmake.configureSettings configuration. Make sure the BOARD, BOOT and DEVICE settings are correct for the targeted development. Configure them if necessary.

    _images/dialog-project-settings.png

  3. Then, open “Command Palette” (by using “View”” => “Command Palette” menu), and run the “CMake: Select a Kit” command.

  4. From the list, select the CMake Kit related to the “GNU Arm Embedded Toolchain 9 (2019-Q4)” toolchain.

    Note

    Please note that:

    • Naming of the CMake Kit related to the “GNU Arm Embedded Toolchain 9 (2019-Q4)” toolchain can vary on local configuration, search and look for “GCC 9”.

    • If no CMake Kit for “GNU Arm Embedded Toolchain 9 (2019-Q4)” toolchain is visible in the list, make sure the toolchain is already installed and the binaries folder of the toolchain is added to the “Path” environment variable. Then, open the VS Code Command Palette and run the “CMake: Scan for Kit” command to refresh the list of the CMake Kits.

    _images/dialog-cmake-select-kit.png

  5. In the VS Code Command Palette, run “CMake: Delete Cache and Reconfigure” command.

    _images/dialog-cmake-reconfigure.png

  6. Then, run the “CMake: Build” command.

    _images/dialog-cmake-build.png

  7. By default, the executable file (<project name>.elf) is generated into the “build/syscpu” folder.

2.7. Using CMake Toolchain Scripts

2.7.1. Opening the Project

For RH850, RL78, RX, RZ, R-Car projects created in e 2 studio, projects can be opened in VS Code by simply opening the project folder and then following the instructions below:

  1. In [Explorer] view, select [Open Folder] button if available. If not, select [File] → [Open Folder…] menu item.

    _images/IDE-54291_11.png _images/IDE-54291_12.png

  2. In [Open Folder] dialog, browse to project folder and click [Select Folder] button.

    _images/IDE-54291_13.png

Besides, there are alternative methods to open a project in VS Code, you can check the alternative methods in “Productivity Tips” section Alternative ways for opening a project in VSCode

2.7.2. Creating CMake Toolchain Scripts and Building the Project

Renesas Build Utilities extension provides predefined scripts to build Renesas C/C++ projects. The predefined build scripts can be accessed by opening the [Command Palette] and typing “Create” to filter the commands. The extension provides the following commands:

  • Create CC-RH project files

  • Create CC-RL project files

  • Create CC-RX project files

  • Create GCC RL78 project files

  • Create GCC RX project files

  • Create GCC RZ project files

  • Create LLVM for RL78 project files

  • Create RCar CMake (Development board / SoC) project files

  • Create RCar CMake (Instruction Set Simulators) project files

_images/vscode-create-project-files-menu.png

The commands will generate the VS Code settings files, as well as the CMake script files cross.cmake and CMakeLists.txt files:

  • .vscode/settings.json - this file contains the settings for CMake.

  • .vscode/tasks.json - this file contains the build definitions for VSCode.

  • Cross.cmake - this file contains the information about the toolchain to use.

  • CMakeLists.txt - this file contains the information about the building project (which files to build, which options to set etc.).

File .vscode/settings.json - this file contains the settings for CMake.

.settings.json file’s general content:

1{
2    "cmake.configureArgs": [
3        "-DCMAKE_TOOLCHAIN_FILE=<absolute/relative path of toolchain information file (<file name>.cmake file)"
4    ],
5    "cmake.sourceDirectory": "<absolute/relative path of the folder containing the root CMakeLists.txt file>"
6}

File .vscode/tasks.json - this file contains the build definitions for VSCode.

.tasks.json file’s general content:

 1{
 2  "version": "2.0.0",
 3  "tasks": [
 4    {
 5      "label": "Build Project",
 6      "group": "build",
 7      "type": "renesas-build",
 8      "command": "build",
 9      "deviceFamily": "<Device family (e.g. RA, RCAR, RH850, RL78, RX or RZ)>",
10      "toolchain": "<Toolchain (e.g. gcc, cc-rl, cc-rx, llvm)>"
11    }
12  ]
13}

Cross.cmake - this file contains the information about the toolchain to use.

Cross.cmake file’s general content:

 1# Specify toolchain path
 2SET(CMAKE_FIND_ROOT_PATH "<absolute path of toolchain's bin folder>")
 3
 4# Specify the C compiler and necessary options
 5SET(CMAKE_C_COMPILER ${CMAKE_FIND_ROOT_PATH}/<C compiler executable file>)
 6
 7# Specify the CPP compiler and necessary options
 8SET(CMAKE_CXX_COMPILER ${CMAKE_FIND_ROOT_PATH}/<CPP compiler executable file>)
 9
10# Specify the assembler and necessary options
11SET(CMAKE_ASM_COMPILER ${CMAKE_FIND_ROOT_PATH}/<assembler executable file>)
12
13# Specify the linker and necessary options
14SET(CMAKE_LINKER ${CMAKE_FIND_ROOT_PATH}/<linker executable file>)
15
16# Specify the library generator and necessary options
17SET(CMAKE_LIBRARY ${CMAKE_FIND_ROOT_PATH}/<library generator executable file>)
18
19# Specify the converter and necessary options
20SET(CMAKE_CONVERTER_EXECUTABLE ${CMAKE_FIND_ROOT_PATH}/<converter executable file>)

CMakeLists.txt - this file contains the information about the building project (which files to build, which options to set etc.).

.CMakeLists.txt file’s general content:

 1cmake_minimum_required(VERSION 3.16)
 2
 3# Set project name
 4project("<project name>")
 5
 6enable_language(C ASM)
 7
 8# Collect source files
 9FILE (GLOB_RECURSE SOURCE ${CMAKE_CURRENT_SOURCE_DIR}
10"*.c" "*.cpp" "*.asm"
11)
12add_executable(${PROJECT_NAME} ${SOURCE})
13
14# Set C compiler command
15SET(CMAKE_C_COMPILE_OBJECT "${CMAKE_C_COMPILER} <specify C compiler options here>")
16
17# Set C++ compiler command
18SET(CMAKE_CXX_COMPILE_OBJECT "${CMAKE_CXX_COMPILER} <specify C++ compiler options here>")
19
20# Set Assembler command
21SET(CMAKE_ASM_COMPILE_OBJECT "${CMAKE_ASM_COMPILER} <specify assembler options here>")
22
23# Set Linker command
24SET(CMAKE_C_LINK_EXECUTABLE "${CMAKE_LINKER} <specify linker options here>")
25
26# Set Library generator command
27add_custom_COMMAND(
28 TARGET ${CMAKE_PROJECT_NAME}
29 PRE_LINK
30 COMMAND ${CMAKE_LIBRARY} <specify library generator options here>
31 COMMENT "Libgen:"
32 VERBATIM
33)
34
35# Set Converter Command
36add_custom_command (
37 TARGET ${CMAKE_PROJECT_NAME}
38 COMMAND ${CMAKE_CONVERTER_EXECUTABLE} <specify converter options here>
39 COMMENT "Converter:"
40 VERBATIM
41)

After generating these files, it is necessary to configure the toolchain information and device specific build settings in these files. The typical approach can be structured into the following steps:

  1. Open the cross.cmake file, and configure the toolchain path.

  2. Get the device specific build settings from e2 Studio by following the instructions below:

    2.1. Open the desired project in e2 studio.

    2.2. Go to [Project] => [Properties] menu.

    2.3. In the project properties windows, navigate to [C/C++ Build] => [Settings] section.

    2.4. In the “Tool Settings” tab, check the “Common”, “Compiler”, “Assembler”, “Linker” sections. Depending on the target device get the values of the device specific parameters. The following parameters are the most common device specific parameters:

    • -isa

    • -cpu

    • -fpu (generally either -fpu or -nofpu)

    • -rom

    • -start

    2.5. Now, open the project in VSCode, navigate to CMakeLists.txt and configure the device specific parameters in the CMake script.

  3. Once all the necessary files are in place, open the [Command Palette] and run the [CMake: Delete Cache and Reconfigure] operation.

  4. To run build task, either press [CTRL+SHIFT+B] ([CMD+SHIFT+B] for macOS) or select [Terminal] → [Run Build Task…] from the menu.

  5. Build options will be shown, select the [Build Project] option.

_images/image-build-from-menu.png

2.7.3. Sample Scenario: Configuring CC/RX project CMake Files

In the following example, we are going to cover step by step instructions for converting the CMakeLists.txt script, and targeting it for the CCRX toolchain and an RX66T device.

  1. First, open your project in e2 Studio, (or create an new one using e2 Studio).

  2. Go to [Project] => [Properties] menu.

    _images/cmake-custom-scripts-e2-project-menu.png

  3. In the project properties windows, navigate to [C/C++ Build] => [Settings] section.

    _images/cmake-custom-scripts-e2-project-properties-01.png

  4. In parallel, open your project in VSCode.

  5. If the CMake build scripts are not generated yet, open the [Command Palette] in VSCode and click [Renesas: Create CC-RX project files].

    _images/cmake-custom-scripts-vscode-create-project-files.png

  6. VSCode will ask for the root folder of the target project, select your project’s root folder.

  7. Now, VSCode will create the necessary files. Open the cross.cmake file and set the path of the toolchain as shown in the screenshot below.

    _images/cmake-custom-scripts-cross-cmake.png

  8. Now, VSCode will create the necessary files. Open the CMakeLists.txt file.

  9. In the e2 Studio Project Settings, navigate to [Common], take the -isa and fpu parameters, then replace them in the CmakeLists.txt in VSCode. Change the -isa=rxv1 parameter to -isa=rxv3, and replace the -nofpu parameters with -fpu.

    _images/cmake-custom-scripts-common-args.png

  10. In the e2 Studio Project Settings, navigate to [Linker], take the -rom and -cpu parameters, then replace the value of the -cpu and add the -rom parameter in the CMAKE_EXE_LINKER_FLAGS at CmakeLists.txt file.

    _images/cmake-custom-scripts-linker-args.png

  11. In the e2 Studio Project Settings, navigate to [Linker] => [Section], take the -start parameter, then replace the value of the -start parameter in the CMAKE_EXE_LINKER_FLAGS at CmakeLists.txt file.

  12. In the e2 Studio Project Settings, navigate to [Assembly], then take the -start parameter, then replace them in the CmakeLists.txt in VSCode.

    _images/cmake-custom-scripts-start-arg.png

    Note

    Please note that you may need to follow the escape character rules while setting the values, for example the -start parameter may include a $ character, which needs to be replaced with a double dollar sign $$ according to the CMake escape character usage:

    SU,SI,B_1,R_1,B_2,R_2,B,R/04,PResetPRG,C_1,C_2,C,C$*,D*,W*,L,PIntPRG,P/0FFF80000,EXCEPTVECT/0FFFFFF80,RESETVECT/0FFFFFFFC

    should be defined as:

    SU,SI,B_1,R_1,B_2,R_2,B,R/04,PResetPRG,C_1,C_2,C,C$$*,D*,W*,L,PIntPRG,P/0FFF80000,EXCEPTVECT/0FFFFFF80,RESETVECT/0FFFFFFFC

  13. Open the [Command Palette] in VSCode and click [CMake: Delete Cache and Reconfigure].

  14. In the first time of running, a kit selection is shown. Select “[Unspecified]”.

    _images/cmake-custom-scripts-build-toolchain.png

    Note

    Missing the selection of the CMake Kit or wrong selection can cause build problems. If you missed the CMake Kit selection or selected a wrong kit, you can re-select the CMake Kit by running “CMake: Select a kit” command from the VSCode Command Palette.

    _images/cmake-custom-scripts-sak.png

  15. Go to and click [Terminal] => [Run Build Task] from the menu.

    _images/cmake-custom-scripts-build-01.png

  16. Build options will be shown, select the [Build Project] option.

    _images/cmake-custom-scripts-build-02.png

For testing the project, you can use the RX Simulator (Simulator is only available for Windows operating systems).

  1. Go to the [Debug] tab in VSCode and generate a launch configuration for [Renesas GDB Simulator Debugging]. This will generate a sample Launch configuration in the .vscode/launch.json file.

  2. Open the Launch configuration and set the correct parameters for your target device. For example:

     1{
 2  // Use IntelliSense to learn about possible attributes.
 3  // Hover to view descriptions of existing attributes.
 4  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 5  "version": "0.2.0",
 6  "configurations": [
 7    {
 8      "type": "renesas-simulator",
 9      "request": "launch",
10      "name": "Renesas GDB Simulator Debugging",
11      "target": {
12        "deviceFamily": "RX",
13        "device": "R5F566TE",
14        "debuggerType": "SIMULATOR"
15      }
16    }
17  ]
18}

  3. Start your debug session.

    _images/cmake-custom-scripts-debug-start.png

2.7.4. Sample Scenario: Using Renesas R-Car SDK

The details of some specific devices will be presented here. Sample projects can be found in the samples folder inside the SDK directory.

The package is typically installed in the default path: “C:/Renesas/rcar-xos”

_images/SDK_default_path.png _images/SDK_samples.png

Using [Create RCar CMake (Development board / SoC) project files] command, necessary files listed below are going to be created.

  • .vscode/settings.json

  • .vscode/tasks.json

  • cross.cmake

  • CMakeLists.txt

  • module.cmake

Contents of the .vscode/settings.json file:

{
    "C_Cpp.updateChannel": "Insiders",
    "workbench.iconTheme": "vs-minimal",
    //For Linux.
    //"cmake.generator": "Unix Makefiles"
    //For Window:
    "cmake.generator": "MinGW Makefiles",
    "cmake.buildDirectory": "${workspaceFolder}/build/rcar.debug.DevBoard",
    "cmake.configureArgs": [
        "-DCMAKE_TOOLCHAIN_FILE=${workspaceFolder}/cross.cmake"
    ],
    "cmake.sourceDirectory": "${workspaceFolder}",
    "cmake.configureOnOpen": true,
    "C_Cpp.intelliSenseEngineFallback": "enabled"
}

Contents of the .vscode/settings.json file

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Build Project",
            "group": "build",
            "type": "renesas-build",
            "command": "build",
            "deviceFamily": "RCAR",
            "toolchain": "gcc"
        }
    ]
}

Contents of the cross.cmake file

# Set the environment root directory
# It can be used to specify the target environment location
# e.g compiler's location. This variable is most useful when crosscompiling.
#(Should avoid spaces in the path or have to escape them)

# Please modify rcar-xos platform location and its version
set (PLATFORM_FIND_ROOT_PATH  "C:/Renesas/rcar-xos")
set (VERSION_SDK "v3.24.0")

# Check rcar-xos platform
if (NOT PLATFORM_FIND_ROOT_PATH)
  message(WARNING "rcar-xos PLATFORM_FIND_ROOT_PATH is not defined\n"
                  "Builds scripts will search rcar-xos platform in environment paths.\n"
                  "Use PLATFORM_FIND_ROOT_PATH variable to set a specific platform folder.")
elseif (NOT PLATFORM_FIND_ROOT_PATH MATCHES "/$")
  set(PLATFORM_FIND_ROOT_PATH "${PLATFORM_FIND_ROOT_PATH}/")
endif()

# Check rcar-xos platform version
if (NOT VERSION_SDK)
  message(WARNING "rcar-xos VERSION_SDK is not defined\n"
                  "Builds scripts will search rcar-xos platform version in environment paths.\n"
                  "Use VERSION_SDK variable to set a specific platform version.")
elseif (NOT VERSION_SDK MATCHES "/$")
  set(VERSION_SDK "${VERSION_SDK}/")
endif()

# Include module.cmake file
include("${CMAKE_CURRENT_LIST_DIR}/module.cmake")

# Set SDKROOT
Set(SDKROOT ${PLATFORM_FIND_ROOT_PATH}/${VERSION_SDK}/tools/toolchains/poky)

# Set CMake folder
set(CMAKE_PREFIX_PATH ${PLATFORM_FIND_ROOT_PATH}/${VERSION_SDK}/cmake)

# Set Device. Example: V3U, V3H1, V3H2, V3M2,..
set(RCAR_SOC V4H2)

# Set IMP Debug level variable
# R_CAR_DEBUG_IMP_LEVEL_CPU:  Only CPU Code
# R_CAR_DEBUG_IMP_LEVEL_CVE_DEBUG: CVe (Shader) debugging
set(R_CAR_DEBUG_IMP_LEVEL_VAR R_CAR_DEBUG_IMP_LEVEL_CVE_DEBUG)

# Build target
set(R_CAR_BUILD_TARGET_VAR aarch64-gnu-linux)

# Include cmake toolchain files as following
include("${CMAKE_PREFIX_PATH}/toolchain_poky_3_1_11_adas.cmake")

Note

Information about the samples corresponding to which device is available in:

C:/Renesas/rcar-xos/<version SDK>/samples/SUPPORTED_ENVIRONMENT.html

Example:

C:/Renesas/rcar-xos/v3.24.0/samples/SUPPORTED_ENVIRONMENT.html

CMakeLists.txt and module.cmake files are overridden with their corresponding files from the project.

_images/SDK_project_path.png _images/SDK_project_sample.png