C

CMake manual for Renesas RA boards

The CMake build tool simplifies the build process for development projects. It automatically generates build systems, such as Makefiles and Visual Studio project files.

CMake is a third-party tool with its own documentation. This topic describes how to use CMake with Qt Quick Ultralite when developing applications for Renesas RA boards.

QUL_ROOT and QUL_TOOLS are used in the command line examples below as if they were set as environment variables. For example:

export QUL_ROOT=$HOME/Qt/QtMCUs/2.12.0
export QUL_TOOLS=$HOME/Qt/Tools/QtMCUs
set QUL_ROOT=C:\Qt\QtMCUs\2.12.0
set QUL_TOOLS=C:\Qt\Tools\QtMCUs

Build configuration

Configure the following CMake variables when developing applications for Renesas RA boards.

Setting up a development environment for EK-RA8D1

Configure the following CMake variables for EK-RA8D1.

VariableProcedure
Qul_ROOTSet the Qul_ROOT to the Qt for MCUs SDK install path.
-DQul_ROOT=$QUL_ROOT
-DQul_ROOT=%QUL_ROOT%

Note: This CMake variable is intentionally mixed-case because it needs to match the package name.

QUL_PLATFORMThe platform name must indicate the board and the OS you want to target. It's a combination of the chosen board's name and the OS you are targeting. The platform name in the following example indicates that your target is EK-RA8D1 on baremetal.
-DQUL_PLATFORM=ek-ra8d1-baremetal

Similarly, EK-RA8D1 on FreeRTOS OS,

-DQUL_PLATFORM=ek-ra8d1-freertos

Note: If you want to target another board or OS, refer to Supported platforms for more information.

CMAKE_TOOLCHAIN_FILESet the CMAKE_TOOLCHAIN_FILE to the Arm GCC or IAR toolchain.
-DCMAKE_TOOLCHAIN_FILE=$QUL_ROOT/lib/cmake/Qul/toolchain/armgcc.cmake
-DCMAKE_TOOLCHAIN_FILE=%QUL_ROOT%\lib\cmake\Qul\toolchain\armgcc.cmake
QUL_TARGET_TOOLCHAIN_DIRUse QUL_TARGET_TOOLCHAIN_DIR to set the location for the toolchain.
-DQUL_TARGET_TOOLCHAIN_DIR=/path/to/the/toolchain
-DQUL_TARGET_TOOLCHAIN_DIR=C:\path\to\the\toolchain
QUL_COLOR_DEPTHUse QUL_COLOR_DEPTH to set the color depth supported by the platform. The reference port for EK-RA8D1 supports 16bpp color depth.
-DQUL_COLOR_DEPTH=16

Note: If this variable is not set, default color depth is used while configuring for the platform.

QUL_BOARD_SDK_DIRSet this variable to the Renesas Flexible Software Package (FSP) install path.

For example:

-DQUL_BOARD_SDK_DIR=$QUL_TOOLS/Renesas/fsp-<version>
-DQUL_BOARD_SDK_DIR=%QUL_TOOLS%\Renesas\fsp-<version>
FREERTOS_DIRAbsolute path to the FreeRTOS sources, which is required for FreeRTOS targets only. Refer to FreeRTOS platforms for more information about boards on FreeRTOS.
-DFREERTOS_DIR=$QUL_TOOLS/Renesas/FreeRTOS-Kernel<version>
-DFREERTOS_DIR=%QUL_ROOT%/Renesas/FreeRTOS-Kernel<version>
JLINK_PATHSet the JLINK_PATH CMake cache entry to the SEGGER J-Link installation path if it is not installed in the default location.

For example:

-DJLINK_PATH=/opt/SEGGER/JLink
-DJLINK_PATH=C:\tools\SEGGER\JLink

Notes

  • Make sure that the entry value does not contain spaces.
  • Creates flash targets if the J-Link software kit is found.

Note: In a Qt Quick Ultralite project, CMAKE_BUILD_TYPE is set to MinSizeRel by default. MinSizeRel is the build type used for the prebuilt platform libraries shipped with Qt Quick Ultralite. To change the build type (to Release for example), invoke CMake with the -DCMAKE_BUILD_TYPE=Release option. For more information, see CMAKE_BUILD_TYPE.

Available under certain Qt licenses.
Find out more.