How to use the product - renesas/FreeRTOS-Kernel GitHub Wiki

Renesas/FreeRTOS-Kernel wiki

Introduction

  • This section shows how to develop FreeRTOS (Kernel only) projects for RX family devices in e² studio.
  • e² studio is an Eclipse-based integrated development environment (IDE) for Renesas MCUs.
    FreeRTOS (Kernel only) projects can be created using e² studio's “Create New Project” (referred as ProjectGeneration (PG) henceforth) feature.

Please visit the Renesas website to download the latest e² studio.

Confirmed Operation Environment

Item Contents
Integrated development environment e2 studio 2024-07
C compiler CC-RX V3.06.00
GCC-RX 8.3.0.202311

Create FreeRTOS (Kernel only) project in e² studio

  1. Launch e² studio from the start menu and specify the workspace location
    image
    (Note1: If you checked "Use this as the default and do not ask again" previously, this window will not appear.)
    (Note2: Due to the limitation of e² studio, the full pathname of your workspace location must not exceed 35 characters.
                If the pathname exceeds 35 characters, build error will occur when building the project.)

  2. From e² studio menu, select File > New > Renesas C/C++ Project > Renesas RX.
    image

  3. Select the preferred compiler and click Next.

    • GCC: Select "GCC for Renesas RX C/C++ Executable Project"
    • CC-RX: Select "Renesas CC-RX C/C++ Executable Project"
      image
  4. Enter your preferred project name and click Next.
    image

  5. Select FreeRTOS(Kernel only) in "RTOS" drop-down list.
    (Note1: FreeRTOS (with IoT libraries) and FreeRTOS (with IoT libraries)(deprecated structure) are projects which communicates with AWS IoT Core using FreeRTOS AWS IoT libraries.)
    image

If you have downloaded a FreeRTOS(Kernel-only) software package previously, please skip to Step8.
  1. Click "Manage RTOS Versions"
    image

  2. Modify the FreeRTOS package download path. A long path will result in build error, so click "Browse" and specify a short path (e.g: C:\rtos).
    image

  1. Download and select v10.4.3-rx-1.0.10 (or later).

  2. In "Device Settings", select your preferred device in Target Board/Target Device drop-down list.
    Then, configure "Bank Mode", and "Hardware Debug Configuration" to match with your device configuration.
    (Note1: If you selected a "custom" target device, please configure pin setting, clock setting, and Hardware Debug configuration accordingly.)
    (Note2: If you do not see your preferred device in the "Target Board" drop-down list, please click "Download additional boards...")
    image

  3. Click Next > Finish.

The FreeRTOS (Kernel-only) project is created successfully.
(If the "Editors available on the Marketplace" dialog box appears, click Cancel to dismiss it.)

Project description

The FreeRTOS (Kernel-only) project created with PG process is a skeleton project, consisting only the FreeRTOS Kernel and corresponding portable code.
This project can be further configured and customized to fit your use case using SmartConfigurator (SC) tool.
You can find detailed explanations on various API functions by accessing the FreeRTOS documentation.

How to configure the generated project

  • This section explains how to configure FreeRTOS (Kernel only) PG project using SC.
  • In this example, we will show:
    • How to configure configMAX_SYSCALL_INTERRUPT_PRIORITY config.
    • How to create a new task.
To configure FreeRTOS Kernel configuration.
  1. In the PG project workspace, open the scfg file to start SC.
    image

  2. In the Components tab, select "FreeRTOS_Kernel" component.
    image

  3. In the "Configure" panel, locate "Maximum syscall interrupt priority".
    Then, change its value from 45.
    image

  4. Click "Generate Code".
    image

  5. Check that the related configuration file (FreeRTOSConfig.h) is updated.
    image

To create a new task.
  1. In the PG project workspace, open the scfg file to start SC.
    image

  2. In the Components tab, select "FreeRTOS_Object" component.
    image

  3. In the "Configure" panel > "Tasks" tab, click the "+" icon to add a new task.
    image

  4. Click "Generate Code".
    image

  5. Check that the source code of the newly created task is generated.
    image


For more information, visit FAQ

⚠️ **GitHub.com Fallback** ⚠️