eRPC API Reference  Rev. 1.12.0
NXP Semiconductors
Configuration

Configuration settings. More...

Overview

Configuration settings.

Files

file  erpc_config.h
 

Macros

#define ERPC_PRE_POST_ACTION
 
#define ERPC_PRE_POST_ACTION_DEFAULT
 

Threading model options

#define ERPC_ALLOCATION_POLICY_DYNAMIC
 Dynamic allocation policy.
 
#define ERPC_ALLOCATION_POLICY_STATIC
 Static allocation policy.
 
#define ERPC_THREADS_NONE
 No threads.
 
#define ERPC_THREADS_PTHREADS
 POSIX pthreads.
 
#define ERPC_THREADS_FREERTOS
 FreeRTOS.
 
#define ERPC_THREADS_ZEPHYR
 ZEPHYR.
 
#define ERPC_THREADS_MBED
 Mbed OS.
 
#define ERPC_THREADS_WIN32
 WIN32.
 
#define ERPC_THREADS_THREADX
 THREADX.
 
#define ERPC_NOEXCEPT_DISABLED
 Disabling noexcept feature.
 
#define ERPC_NOEXCEPT_ENABLED
 Enabling noexcept feature.
 
#define ERPC_NESTED_CALLS_DISABLED
 No nested calls support.
 
#define ERPC_NESTED_CALLS_ENABLED
 Nested calls support.
 
#define ERPC_NESTED_CALLS_DETECTION_DISABLED
 Nested calls detection disabled.
 
#define ERPC_NESTED_CALLS_DETECTION_ENABLED
 Nested calls detection enabled.
 
#define ERPC_MESSAGE_LOGGING_DISABLED
 Trace functions disabled.
 
#define ERPC_MESSAGE_LOGGING_ENABLED
 Trace functions enabled.
 
#define ERPC_TRANSPORT_MU_USE_MCMGR_DISABLED
 Do not use MCMGR for MU ISR management.
 
#define ERPC_TRANSPORT_MU_USE_MCMGR_ENABLED
 Use MCMGR for MU ISR management.
 
#define ERPC_PRE_POST_ACTION_DISABLED
 Pre post shim callbacks functions disabled.
 
#define ERPC_PRE_POST_ACTION_ENABLED
 Pre post shim callback functions enabled.
 
#define ERPC_PRE_POST_ACTION_DEFAULT_DISABLED
 Pre post shim default callbacks functions disabled.
 
#define ERPC_PRE_POST_ACTION_DEFAULT_ENABLED
 Pre post shim default callback functions enabled.
 

Configuration options

#define ERPC_ALLOCATION_POLICY
 Choose which allocation policy should be used. More...
 
#define ERPC_CODEC_COUNT
 Set amount of codecs objects used simultaneously in case of ERPC_ALLOCATION_POLICY is set to ERPC_ALLOCATION_POLICY_STATIC. For example if client or server is used in one thread then 1. If both are used in one thread per each then 2, ... Default value 2.
 
#define ERPC_MESSAGE_LOGGERS_COUNT
 Set amount of message loggers objects used simultaneously in case of ERPC_ALLOCATION_POLICY is set to ERPC_ALLOCATION_POLICY_STATIC. For example if client or server is used in one thread then 1. If both are used in one thread per each then 2, ... For arbitrated client 1 is enough. Default value 0 (May not be used).
 
#define ERPC_CLIENTS_THREADS_AMOUNT
 Set amount of client threads objects used in case of ERPC_ALLOCATION_POLICY is set to ERPC_ALLOCATION_POLICY_STATIC. Default value 1 (Most of current cases).
 
#define ERPC_DEFAULT_BUFFER_SIZE
 Size of buffers allocated by BasicMessageBufferFactory in setup functions. More...
 
#define ERPC_DEFAULT_BUFFERS_COUNT
 Count of buffers allocated by StaticMessageBufferFactory. More...
 
#define ERPC_NOEXCEPT
 Disable/enable noexcept support. More...
 
#define ERPC_NESTED_CALLS
 
#define ERPC_NESTED_CALLS_DETECTION
 
#define ERPC_MESSAGE_LOGGING
 

Macro Definition Documentation

#define ERPC_ALLOCATION_POLICY

Choose which allocation policy should be used.

Set ERPC_ALLOCATION_POLICY_DYNAMIC if dynamic allocations should be used. Set ERPC_ALLOCATION_POLICY_STATIC if static allocations should be used.

Default value is ERPC_ALLOCATION_POLICY_DYNAMIC or in case of FreeRTOS it can be auto-detected if __has_include() is supported by compiler. Uncomment comment bellow to use static allocation policy. In case of static implementation user need consider another values to set (ERPC_CODEC_COUNT, ERPC_MESSAGE_LOGGERS_COUNT, ERPC_CLIENTS_THREADS_AMOUNT).

#define ERPC_DEFAULT_BUFFER_SIZE

Size of buffers allocated by BasicMessageBufferFactory in setup functions.

Uncomment to change the size of buffers allocated by one of MessageBufferFactory. (Client Setup and Server Setup). The default size is set to 256. For RPMsg transport layer, ERPC_DEFAULT_BUFFER_SIZE must be 2^n - 16.

#define ERPC_DEFAULT_BUFFERS_COUNT

Count of buffers allocated by StaticMessageBufferFactory.

Uncomment to change the count of buffers allocated by one of statically allocated messages. Default value is set to 2.

#define ERPC_NOEXCEPT

Disable/enable noexcept support.

Uncomment for using noexcept feature.

#define ERPC_NESTED_CALLS

Default set to ERPC_NESTED_CALLS_DISABLED. Uncomment when callbacks, or other eRPC functions are called from server implementation of another eRPC call. Nested functions need to be marked as in IDL.

#define ERPC_NESTED_CALLS_DETECTION

Default set to ERPC_NESTED_CALLS_DETECTION_ENABLED when NDEBUG macro is presented. This serve for locating nested calls in code. Nested calls are calls where inside eRPC function on server side is called another eRPC function (like callbacks). Code need be a bit changed to support nested calls. See ERPC_NESTED_CALLS macro.

#define ERPC_MESSAGE_LOGGING

Enable eRPC message logging code through the eRPC. Take look into "erpc_message_loggers.h". Can be used for base printing messages, or sending data to another system for data analysis. Default set to ERPC_MESSAGE_LOGGING_DISABLED.

Uncomment for using logging feature.

#define ERPC_PRE_POST_ACTION

Enable eRPC pre and post callback functions shim code. Take look into "erpc_pre_post_action.h". Can be used for detection of eRPC call freeze, ... Default set to ERPC_PRE_POST_ACTION_DISABLED.

Uncomment for using pre post callback feature.

#define ERPC_PRE_POST_ACTION_DEFAULT

Enable eRPC pre and post default callback functions. Take look into "erpc_setup_extensions.h". Can be used for detection of eRPC call freeze, ... Default set to ERPC_PRE_POST_ACTION_DEFAULT_DISABLED.

Uncomment for using pre post default callback feature.