Common Configuration#

You can configure the Common module to define how the module will behave, what resources it requires, and so on. The configuration options take effect at compile-time.

You can also change run-time configurations that will tailor the Common module to the needs of the application, while using a minimum of resources when it not needed. The following pages describe both types of configurations.

• RTOS Compile-Time Description

• RTOS Compile-Time Configuration

• Common Compile-Time Configuration

• RTOS ERR Type Configuration

• Common Run-Time Configuration

RTOS Compile-Time Description#

• RTOS Description

• CPU & Toolchain - Mandatory Constant Description

• Modules Present Description

RTOS Description#

The following configuration constants can be added to the rtos_description.h file.

CPU & Toolchain - Mandatory Constant Description#

Modules Present Description#

The following is a list of #define to be added to rtos_description.h to activate the modules and its sub-modules.

RTOS Compile-Time Configuration#

• RTOS Configuration

  • Asserts configurations

  • RTOS_CFG_RTOS_ASSERT_DBG_FAILED_END_CALL_SEL

  • RTOS_CFG_RTOS_ASSERT_CRITICAL_FAILED_END_CALL_SEL

  • RTOS_CFG_EXTERNALIZE_OPTIONAL_CFG_EN

• RTOS Logging Configuration

  • Logging Channel Configuration

  • Major Logging Channels

RTOS Configuration#

The following configuration constants are located in the rtos_cfg.h file.

Asserts configurations#

RTOSCFG_ASSERT_DBG_ARG_CHK_EXT<module>_EN configurations define if asserts that are used in argument checking are enabled or not. These asserts check the validity of the arguments passed to any stack function. This can include checking whether a pointer is non-NULL, or if a given value is within a certain range, or if a configuration is valid, etc.

These configurations ca be set to 1 (enable asserts) or 0 (disable asserts).

There is one configuration per module. The following table lists the different configurations.

Recommendation: disable this feature as much as possible in 'release' code. This will improve performance and reduce the amount of code space required.

RTOS_CFG_RTOS_ASSERT_DBG_FAILED_END_CALL_SEL#

RTOS_CFG_RTOS_ASSERT_CRITICAL_FAILED_END_CALL_SEL#

Table - Assert failed end call configuration value description#

RTOS_CFG_EXTERNALIZE_OPTIONAL_CFG_EN#

RTOS Logging Configuration#

Table - RTOS Logging Configuration Constants#

Logging Channel Configuration#

The logging mechanism allows every logging channel to inherit from the parent channel, with the root ancestor being the RTOS_CFG_LOG_ALL channel. This allows any channel option to have the DFLT setting, which means it uses the inherited channel option.

The "parent-child" relationship is defined by finding the channel to where a particular module is logging. For example, the kernel logs in the KERNEL channel and the USB-Device Audio class would log to the USBD, CLASS, AUDIO channel. This would mean that the kernel channel inherits only from the root parent ALL and that the USB-Device Audio class would inherit from (in order):

• The USBD_CLASS channel if defined

• The USBD channel if defined and the root parent ALL

For the USB-Device Audio class channel, this means that if a #define named RTOS_CFG_LOG_USBD_CLASS does exist, it will take the options set via that configuration as default. If not, it could take its options from a RTOS_CFG_LOG_USBD #define. If it is also not present, it will set the options in the RTOS_CFG_LOG_ALL #define.

This allows a very fine granularity while allowing to configure several channels in a single step.

The available options for each channel #define must respect the order and be separated by commas. The order should be as follows: <lowest_level>, <timing>, <function_name_en>, <time_stamp_en>, <log_output_funct>. The possible values for each option are as follows:

Table - RTOS Logging Channel Options#

Major Logging Channels#

The table below presents the major logging channels that can be referenced when configuring the logging module. Several other channels exist, for example for each FS or USB driver (FS, DRV, SD; USBD, DRV, SYNOPSYS_OTG_HS or USBH, HCD, EHCI).

Common Compile-Time Configuration#

• Lib Module

  • Lib Memory Configuration

  • Lib String Configuration

The following configuration constants are located in the common_cfg.h configuration file.

Lib Module#

Lib Memory Configuration#

Table - Lib Mem Optimization Configuration Constants#

Table - Lib Mem Allocation Configuration Constants#

Lib String Configuration#

Table - Lib Str Configuration Constants#

RTOS_ERR Type Configuration#

The following configuration constants are located in the rtos_err_cfg.h file.

Table - RTOS_ERR Type Configuration Constants#

Common Run-Time Configuration#

• General Configuration

  • Memory Segment

  • Logging Configuration Structure

  • Logging Memory Segment

• Authentication

  • Root User Configuration Structure

  • Resource Usage Configuration Structure

  • Memory Segment

• Shell

  • Command Usage

  • Memory Segment

• Configuration Summary

  • Common

  • Authentication

This section describes the application-specific configurations of the common module. These are specified at run-time.

• For more information on how default run-time configuration values can be changed or used, see Initialization of the Common Module .

• For more information on how to initialize any Micrium product, see Stacks Initialization Methods .

The following sections describe the configurations that are optional. If you do not set them in your application, the default configurations will apply.

General Configuration#

Default values can be retrieved via the Common_InitCfgDflt structure.

The following tables describe the configuration structure's fields, their default values and the functions used to change them. For the advanced method, it is assumed that a COMMON_INIT_CFG structure global variable called Common_InitCfg is defined by the application.

Memory Segment#

Pointer to the memory segment from which the Common module's data will be allocated.

Logging Configuration Structure#

Only present if the Logging module is enabled, by setting RTOS_CFG_LOG_EN to DEF_ENABLED, in rtos_cfg.h. For more details about logging configuration, see Logging Usage .

Configuration structure for the Logging module.

Logging Memory Segment#

Only present if the Logging module is enabled, by setting RTOS_CFG_LOG_EN to DEF_ENABLED in rtos_cfg.h . For more details about logging configuration, see Logging Usage .

Pointer to memory segment from which the Logging module's data will be allocated, including the ring buffer, if the size is not 0.

Authentication#

The default values can be retrieved via the structure Auth_InitCfgDflt.

The following tables describe the configuration structure's fields, their default values and the functions used to change them. When using the advanced method, the application defines the AUTH_INIT_CFG structure global variable called Auth_InitCfg.

Root User Configuration Structure#

Configuration structure for the Root User.

Resource Usage Configuration Structure#

Configuration structure for the Resource usage.

Memory Segment#

Pointer to memory segment from which Authentication module's data will be allocated.

Shell#

The following configurations will only be present if the Shell module is available.

The default values can be retrieved via the structure Shell_InitCfgDflt.

The following tables describe the configuration structure's fields, their default values, and the functions that modify them. If the advanced method is used and Shell_Init() is called by the application, the application defines a SHELL_INIT_CFG structure global variable called Shell_InitCfg.

Command Usage#

Configuration structure for the commands that will be registered in the Shell sub-module

Memory Segment#

Pointer to the memory segment from which the Shell module's data will be allocated.

Configuration Summary#

The table below provides a summary of the configurations functions for the core and every sub-module.

Common#

Authentication#

Shell#

Authentication Run-Time Application-Specific Configurations#

• AUTH_CFG_ROOT_USER

• AUTH_CFG_RESOURCE

The following structures contain values that configure the authentication sub-module, which is part of the Common module. This module is optional.

AUTH_CFG_ROOT_USER#

AUTH_CFG_ROOT_USER is a structure that can be used to configure the root user's properties.

Table - AUTH_CFG_ROOT_USER configuration structure in the Authentication Run-Time Application-Specific Configurations page describes each configuration field available for this configuration structure.

Table - AUTH_CFG_ROOT_USER configuration structure#

AUTH_CFG_RESOURCE#

AUTH_CFG_RESOURCE is a structure that can be used to configure the various resources used by the authentication sub-module.

Table - AUTH_CFG_RESOURCE configuration structure in the Authentication Run-Time Application-Specific Configurations page describes each configuration field available for this configuration structure.

Table - AUTH_CFG_RESOURCE configuration structure#

Logging Run-Time Application-Specific Configuration#

COMMON_CFG_LOGGING is a structure that can be used to configure the buffer sizes for the logging sub-module.

Table - COMMON_CFG_LOGGING structure in the Logging Run-Time Application-Specific Configuration page describes each field available in this configuration structure.

Table - COMMON_CFG_LOGGING structure#

Shell Run-Time Application-Specific Configurations#

SHELL_CFG_CMD_USAGE is a structure that can be used to configure the various quantity and buffer sizes used by the Shell sub-module.

Table - SHELL_CFG_CMD_USAGE configuration structure in the Shell Run-Time Application-Specific Configurations page describes each field available for this configuration structure.

Table - SHELL_CFG_CMD_USAGE configuration structure#