| CMSIS-Core (Cortex-M) CMSIS-Core support for Cortex-M processor-based devices |

Loading...
Searching...
No Matches
Macros
Compiler Control

Compiler agnostic #define symbols for generic C/C++ source code. More...

## Macros
#define | __ALIAS
| Creates a symbol as alias to another symbol.
#define | __ALIGNED
| Minimum alignment for a variable.
#define | __ARM_ARCH_6M__
| Set to 1 when generating code for Armv6-M architecture.
#define | __ARM_ARCH_7EM__
| Set to 1 when generating code for Armv7-M architecture with FPU.
#define | __ARM_ARCH_7M__
| Set to 1 when generating code for Armv7-M architecture.
#define | __ARM_ARCH_8_1M_MAIN__
| Set to 1 when generating code for Armv8.1-M architecture.
#define | __ARM_ARCH_8M_BASE__
| Set to 1 when generating code for Armv8-M Baseline architecture.
#define | __ARM_ARCH_8M_MAIN__
| Set to 1 when generating code for Armv8-M Mainline architecture.
#define | __ASM
| Pass information from the compiler to the assembler.
#define | __COMPILER_BARRIER
| Barrier to prevent compiler from reordering instructions.
#define | __INITIAL_SP
| Compiler/linker symbol specifying the location of the main stack (MSP).
#define | __INLINE
| Recommend that function should be inlined by the compiler.
#define | __NO_INIT
| Specifies a section name for a variable to simplify variable placement into a non-initialized memory.
#define | __NO_RETURN
| Inform the compiler that a function does not return.
#define | __PACKED
| Request smallest possible alignment.
#define | __PACKED_STRUCT
| Request smallest possible alignment for a structure.
#define | __PROGRAM_START
| Entry function into the user application or library startup.
#define | __RESTRICT
| restrict pointer qualifier to enable additional optimizations.
#define | __STACK_LIMIT
| Compiler/linker symbol specifying the limit of the main stack (MSP).
#define | __STATIC_FORCEINLINE
| Define a static function that should be always inlined by the compiler.
#define | __STATIC_INLINE
| Define a static function that may be inlined by the compiler.
#define | __UNALIGNED_UINT16_READ
| Pointer for unaligned read of a uint16_t variable.
#define | __UNALIGNED_UINT16_WRITE
| Pointer for unaligned write of a uint16_t variable.
#define | __UNALIGNED_UINT32_READ
| Pointer for unaligned read of a uint32_t variable.
#define | __UNALIGNED_UINT32_WRITE
| Pointer for unaligned write of a uint32_t variable.
#define | __USED
| Inform that a variable shall be retained in executable image.
#define | __VECTOR_TABLE
| Symbol name used for the (static) interrupt vector table.
#define | __VECTOR_TABLE_ATTRIBUTE
| Additional decl specs to be used when defining the (static) interrupt vector table.
#define | __WEAK
| Export a function or variable weakly to allow overwrites.

## Description

Compiler agnostic #define symbols for generic C/C++ source code.

The CMSIS-Core provides the header file cmsis_compiler.h with consistent #define symbols for generate C or C++ source files that should be compiler agnostic. Each CMSIS compliant compiler should support the functionality described in this section.

The header file cmsis_compiler.h is also included by each Device Header File <Device.h> so that these definitions are available.

## Macro Definition Documentation

## ◆ __ALIAS

#define __ALIAS

Creates a symbol as alias to another symbol.

Code Example: The example declares the function Interrupt0_Handler. By default it is just an alias pointing to Default_Handler. In combination with __WEAK modifier this allows giving the function definition at a later point if required.

void Interrupt0_Handler (void) __WEAK __ALIAS("Default_Handler");
__WEAK
#define __WEAK
Export a function or variable weakly to allow overwrites.
Definition: ref_compiler_ctrl.txt:253
__ALIAS
#define __ALIAS
Creates a symbol as alias to another symbol.
Definition: ref_compiler_ctrl.txt:450

## ◆ __ALIGNED

#define __ALIGNED

Minimum alignment for a variable.

Specifies a minimum alignment for a variable or structure field, measured in bytes.

Code Example:

uint32_t stack_space[0x100] __ALIGNED(8); // 8-byte alignment required
__ALIGNED
#define __ALIGNED
Minimum alignment for a variable.
Definition: ref_compiler_ctrl.txt:389

## ◆ __ARM_ARCH_6M__

#define __ARM_ARCH_6M__

Set to 1 when generating code for Armv6-M architecture.

The #define ARM_ARCH_6M is set to 1 when generating code for the Armv6-M architecture. This architecture is for example used by the Cortex-M0, Cortex-M0+, and Cortex-M1 processor.

## ◆ __ARM_ARCH_7EM__

#define __ARM_ARCH_7EM__

Set to 1 when generating code for Armv7-M architecture with FPU.

The #define ARM_ARCH_7EM is set to 1 when generating code for the Armv7-M architecture with floating point extension. This architecture is for example implemented by the Cortex-M4 processor with FPU.

## ◆ __ARM_ARCH_7M__

#define __ARM_ARCH_7M__

Set to 1 when generating code for Armv7-M architecture.

The #define ARM_ARCH_7M is set to 1 when generating code for the Armv7-M architecture. This architecture is for example used by the Cortex-M3 processor.

## ◆ __ARM_ARCH_8_1M_MAIN__

#define __ARM_ARCH_8_1M_MAIN__

Set to 1 when generating code for Armv8.1-M architecture.

The #define ARM_ARCH_8_1M_MAIN is set to 1 when generating code for the Armv8.1-M architecture. This architecture is for example implemented by the Cortex-M55 processor.

## ◆ __ARM_ARCH_8M_BASE__

#define __ARM_ARCH_8M_BASE__

Set to 1 when generating code for Armv8-M Baseline architecture.

The #define ARM_ARCH_8M_BASE is set to 1 when generating code for the Armv8-M architecture baseline variant. This architecture is for example implemented by the Cortex-M23 processor.

## ◆ __ARM_ARCH_8M_MAIN__

#define __ARM_ARCH_8M_MAIN__

Set to 1 when generating code for Armv8-M Mainline architecture.

The #define ARM_ARCH_8M_MAIN is set to 1 when generating code for the Armv8-M architecture mainline variant. This architecture is for example implemented by the Cortex-M33 processor.

## ◆ __ASM

#define __ASM

Pass information from the compiler to the assembler.

The __ASM keyword can declare or define an embedded assembly function or incorporate inline assembly into a function (shown in the code example below).

Code Example:

// Reverse bit order of value
__attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __RBIT(uint32_t value)
{
uint32_t result;
__ASM volatile ("rbit %0, %1" : "=r" (result) : "r" (value) );
return(result);
}
__ASM
#define __ASM
Pass information from the compiler to the assembler.
Definition: ref_compiler_ctrl.txt:95
__STATIC_INLINE
#define __STATIC_INLINE
Define a static function that may be inlined by the compiler.
Definition: ref_compiler_ctrl.txt:141
__RBIT
uint32_t __RBIT(uint32_t value)
Reverse bit order of value.

## ◆ __COMPILER_BARRIER

#define __COMPILER_BARRIER

Barrier to prevent compiler from reordering instructions.

This barrier limits the compilers reordering optimizations. It prevents the compiler from swapping instructions resulting from code before and after the barrier.

Code Example: The assignments in the example are independent. Hence the compiler could choose a different order of execution, e.g. for a better pipeline utilization. Using the barrier in between prevents this type of reordering.

void test (uint8_t *ptr) {
var1 = 1;
__COMPILE_BARRIER();
var2 = var3 + 1;
}

## ◆ __INITIAL_SP

#define __INITIAL_SP

Compiler/linker symbol specifying the location of the main stack (MSP).

The address of the specified symbol is used to initialize the main stack pointer (MSP) during low level init. This is compiler/linker specific. CMSIS specifies common default for supported compilers.

Note
  This define is only intended to be used by the Startup File startup_<Device>.c.

## ◆ __INLINE

#define __INLINE

Recommend that function should be inlined by the compiler.

Inline functions offer a trade-off between code size and performance. By default, the compiler decides during optimization whether to inline code or not. The __INLINE attribute gives the compiler an hint to inline this function. Still, the compiler may decide not to inline the function. As the function is global an callable function is also generated.

Code Example:

const uint32_t led_mask[] = {1U << 4, 1U << 5, 1U << 6, 1U << 7};
/*------------------------------------------------------------------------------
Switch on LEDs
*------------------------------------------------------------------------------*/
__INLINE static void LED_On (uint32_t led) {
PTD->PCOR = led_mask[led];
}
__INLINE
#define __INLINE
Recommend that function should be inlined by the compiler.
Definition: ref_compiler_ctrl.txt:120

## ◆ __NO_INIT

#define __NO_INIT

Specifies a section name for a variable to simplify variable placement into a non-initialized memory.

Specifies a section name (e.g, .bss.noinit or .noinit) for a variable that can be used by a linker-script to position that variable into a non-initialized memory.

Code Example: The EventBuffer in the example must not be copy- or zero-initialized. By adding __NO_INIT at variable declaration/definition, and with appropriate linker-script, this variable is positioned into a non-initialized memory.

static EventRecord_t EventBuffer[EVENT_RECORD_COUNT] __NO_INIT __ALIGNED(16);
__NO_INIT
#define __NO_INIT
Specifies a section name for a variable to simplify variable placement into a non-initialized memory.
Definition: ref_compiler_ctrl.txt:433

## ◆ __NO_RETURN

#define __NO_RETURN

Inform the compiler that a function does not return.

Informs the compiler that the function does not return. The compiler can then perform optimizations by removing code that is never reached.

Code Example:

// OS idle demon (running when no other thread is ready to run).
__NO_RETURN void os_idle_demon (void);
__NO_RETURN
#define __NO_RETURN
Inform the compiler that a function does not return.
Definition: ref_compiler_ctrl.txt:182

## ◆ __PACKED

#define __PACKED

Request smallest possible alignment.

Specifies that a type must have the smallest possible alignment.

Code Example:

struct foo {
uint8_t u8;
uint32_t u32[2] __PACKED;
};
__PACKED
#define __PACKED
Request smallest possible alignment.
Definition: ref_compiler_ctrl.txt:271

## ◆ __PACKED_STRUCT

#define __PACKED_STRUCT

Request smallest possible alignment for a structure.

Specifies that a structure must have the smallest possible alignment.

Code Example:

__PACKED_STRUCT foo {
uint8_t u8;
uint32_t u32;
uint16_t u16;
};
__PACKED_STRUCT
#define __PACKED_STRUCT
Request smallest possible alignment for a structure.
Definition: ref_compiler_ctrl.txt:290

## ◆ __PROGRAM_START

#define __PROGRAM_START

Entry function into the user application or library startup.

Gives the function to be jumped into right after low level initialization, i.e. SystemInit. This is compiler and library specific. CMSIS specifies common default for supported compilers.

Note
  This define is only intended to be used by the Startup File startup_<Device>.c.

Code Example:

void Reset_Handler(void)
{
SystemInit(); /* CMSIS System Initialization */
__PROGRAM_START(); /* Enter PreMain (C library entry point) */
}
__PROGRAM_START
#define __PROGRAM_START
Entry function into the user application or library startup.
Definition: ref_compiler_ctrl.txt:472
SystemInit
void SystemInit(void)
Function to Initialize the system.

## ◆ __RESTRICT

#define __RESTRICT

restrict pointer qualifier to enable additional optimizations.

The __RESTRICT keyword corresponds to the restrict pointer qualifier that has been introduced in C99. __RESTRICT is a hint to the compiler that enables additional optimizations. It specifies that for the lifetime of the pointer, only the pointer itself or a value directly derived from it (such as pointer + 1) is used to access the object. The compiler may therefore ignore potential pointer aliasing effects and perform additional optimizations.

Note
  For compilers that do not support the restrict keyword, __RESTRICT is defined as an empty macro and a warning is issued.

Code Example:

__STATIC_INLINE void ARM_MPU_OrderedMemcpy (volatile uint32_t* dst, const uint32_t* __RESTRICT src, uint32_t len)
{
uint32_t i;
for (i = 0U; i < len; ++i)
{
dst[i] = src[i]; // Since src is restrict, the compiler can assume that dst and src are not overlapping may load multiple values at a time
}
}
__RESTRICT
#define __RESTRICT
restrict pointer qualifier to enable additional optimizations.
Definition: ref_compiler_ctrl.txt:210
ARM_MPU_OrderedMemcpy
__STATIC_INLINE void ARM_MPU_OrderedMemcpy(volatile uint32_t *dst, const uint32_t *__RESTRICT src, uint32_t len)

## ◆ __STACK_LIMIT

#define __STACK_LIMIT

Compiler/linker symbol specifying the limit of the main stack (MSP).

The address of the specified symbol is used to initialize the main stack pointer limit (MSPLIM on Armv8-M) during low level init. This is compiler/linker specific. CMSIS specifies common default for supported compilers.

Note
  This define is only intended to be used by the Startup File startup_<Device>.c.

Code Example:

void Reset_Handler(void)
{
__set_MSPLIM((uint32_t)(&__STACK_LIMIT));
// :
// :
}
__set_MSPLIM
__set_MSPLIM(uint32_t MainStackPtrLimit)
Set Main Stack Pointer Limit Devices without Armv8-M Main Extensions (i.e. Cortex-M23) lack the non-s...
__STACK_LIMIT
#define __STACK_LIMIT
Compiler/linker symbol specifying the limit of the main stack (MSP).
Definition: ref_compiler_ctrl.txt:507

## ◆ __STATIC_FORCEINLINE

#define __STATIC_FORCEINLINE

Define a static function that should be always inlined by the compiler.

Defines a static function that should be always inlined by the compiler.

Note
  For compilers that do not allow to force function inlining, the macro maps to __STATIC_INLINE.

Code Example:

\\ Get Interrupt Vector
__STATIC_FORCEINLINE uint32_t NVIC_GetVector(IRQn_Type IRQn)
{
uint32_t *vectors = (uint32_t *) ((uintptr_t) SCB->VTOR);
return vectors[(int32_t)IRQn + NVIC_USER_IRQ_OFFSET];
}
IRQn_Type
IRQn_Type
Definition of IRQn numbers.
Definition: ref_nvic.txt:385
NVIC_GetVector
uint32_t NVIC_GetVector(IRQn_Type IRQn)
Read Interrupt Vector [not for Cortex-M0, SC000].
__STATIC_FORCEINLINE
#define __STATIC_FORCEINLINE
Define a static function that should be always inlined by the compiler.
Definition: ref_compiler_ctrl.txt:164

## ◆ __STATIC_INLINE

#define __STATIC_INLINE

Define a static function that may be inlined by the compiler.

Defines a static function that may be inlined by the compiler. If the compiler generates inline code for all calls to this functions, no additional function implementation is generated which may further optimize space.

Code Example:

\\ Get Interrupt Vector
__STATIC_INLINE uint32_t NVIC_GetVector(IRQn_Type IRQn)
{
uint32_t *vectors = (uint32_t *) ((uintptr_t) SCB->VTOR);
return vectors[(int32_t)IRQn + NVIC_USER_IRQ_OFFSET];
}

## ◆ __UNALIGNED_UINT16_READ

#define __UNALIGNED_UINT16_READ

Pointer for unaligned read of a uint16_t variable.

Defines a pointer to a uint16_t from an address that does not need to be aligned. This can then be used in read operations. The compiler will generate the appropriate access (aligned or non-aligned) depending on the underlying Arm processor core and compiler settings.

Code Example:

uint16_t val16;
void test (uint8_t *ptr) {
val16 = __UNALIGNED_UINT16_READ(ptr);
}
__UNALIGNED_UINT16_READ
#define __UNALIGNED_UINT16_READ
Pointer for unaligned read of a uint16_t variable.
Definition: ref_compiler_ctrl.txt:311

## ◆ __UNALIGNED_UINT16_WRITE

#define __UNALIGNED_UINT16_WRITE

Pointer for unaligned write of a uint16_t variable.

Defines a pointer to a uint16_t from an address that does not need to be aligned. This can then be used in write operations. The compiler will generate the appropriate access (aligned or non-aligned) depending on the underlying Arm processor core and compiler settings.

Code Example:

uint16_t val16 = 0U;
void test (uint8_t *ptr) {
__UNALIGNED_UINT16_WRITE(ptr, val16);
}
__UNALIGNED_UINT16_WRITE
#define __UNALIGNED_UINT16_WRITE
Pointer for unaligned write of a uint16_t variable.
Definition: ref_compiler_ctrl.txt:332

## ◆ __UNALIGNED_UINT32_READ

#define __UNALIGNED_UINT32_READ

Pointer for unaligned read of a uint32_t variable.

Defines a pointer to a uint32_t from an address that does not need to be aligned. This can then be used in read operations. The compiler will generate the appropriate access (aligned or non-aligned) depending on the underlying Arm processor core and compiler settings.

Code Example:

uint32_t val32;
void test (uint8_t *ptr) {
val32 = __UNALIGNED_UINT32_READ(ptr);
}
__UNALIGNED_UINT32_READ
#define __UNALIGNED_UINT32_READ
Pointer for unaligned read of a uint32_t variable.
Definition: ref_compiler_ctrl.txt:353

## ◆ __UNALIGNED_UINT32_WRITE

#define __UNALIGNED_UINT32_WRITE

Pointer for unaligned write of a uint32_t variable.

Defines a pointer to a uint32_t from an address that does not need to be aligned. This can then be used in write operations. The compiler will generate the appropriate access (aligned or non-aligned) depending on the underlying Arm processor core and compiler settings.

Code Example:

uint32_t val32 = 0U;
void test (uint8_t *ptr) {
__UNALIGNED_UINT32_WRITE(ptr, val32);
}
__UNALIGNED_UINT32_WRITE
#define __UNALIGNED_UINT32_WRITE
Pointer for unaligned write of a uint32_t variable.
Definition: ref_compiler_ctrl.txt:374

## ◆ __USED

#define __USED

Inform that a variable shall be retained in executable image.

Definitions tagged with __USED in the source code should be not removed by the linker when detected as unused.

Code Example:

/* Export following variables for debugging */
__USED uint32_t const CMSIS_RTOS_API_Version = osCMSIS;
__USED uint32_t const CMSIS_RTOS_RTX_Version = osCMSIS_RTX;
__USED uint32_t const os_clockrate = OS_TICK;
__USED uint32_t const os_timernum = 0;
__USED
#define __USED
Inform that a variable shall be retained in executable image.
Definition: ref_compiler_ctrl.txt:229

## ◆ __VECTOR_TABLE

#define __VECTOR_TABLE

Symbol name used for the (static) interrupt vector table.

The given name is used for defining the static (compiler time) interrupt vector table. The name must comply with any compiler/linker conventions, e.g. if used for vector table relocation or debugger awareness. CMSIS specifies common default for supported compilers.

Note
  This define is only intended to be used by the Startup File startup_<Device>.c.

## ◆ __VECTOR_TABLE_ATTRIBUTE

#define __VECTOR_TABLE_ATTRIBUTE

Additional decl specs to be used when defining the (static) interrupt vector table.

The given decl specs are used for defining the static (compiler time) interrupt vector table, e.g. to mark the table as used and force it into a specific linker section. CMSIS specifies common default for supported compilers.

Note
  This define is only intended to be used by the Startup File startup_<Device>.c.

## ◆ __WEAK

#define __WEAK

Export a function or variable weakly to allow overwrites.

Functions defined with __WEAK export their symbols weakly. A weakly defined function behaves like a normally defined function unless a non-weakly defined function of the same name is linked into the same image. If both a non-weakly defined function and a weakly defined function exist in the same image then all calls to the function resolve to call the non-weak function.

Functions declared with __WEAK and then defined without __WEAK behave as non-weak functions.

Code Example:

__WEAK void SystemInit(void)
{
SystemCoreSetup();
SystemCoreClockSetup();
}