DECLARE_CRIT_SECTION_LOCK_IN_STRUCT macro

This macro declares a critical section lock as a member of a struct. The critical section lock member is only declared if built for multi-core systems, otherwise it is omitted. Example usage:

{c}
 ...
 #include "os/critical_section.h"
 ...
 typedef struct protected_struct_t {
     int member1;
     DECLARE_CRIT_SECTION_LOCK_IN_STRUCT(my_lock) // no semicolon!
     int another_member;
 };
 

Syntax

Show:

Summary

Declaration

from critical_section.h:160

#define DECLARE_CRIT_SECTION_LOCK_IN_STRUCT(lock_name) esp_os_spinlock_t lock_name;

Arguments

Argument

lock_name

Notes

When using this macro, the critical section macros esp_os_enter_critical* and esp_os_exit_critical* MUST be used, otherwise normal functions would be passed an undefined variable when build for single-core systems. Do NOT add any semicolon after declaring the member with this macro. The trailing semicolon is included in the macro, otherwise -Wpedantic would complain about superfluous ";" if OS_SPINLOCK == 0.

References

Code

Location

#define DECLARE_CRIT_SECTION_LOCK_IN_STRUCT(lock_name) esp_os_spinlock_t lock_name;

critical_section.h:160

DECLARE_CRIT_SECTION_LOCK_IN_STRUCT(spinlock)

uart.c:171

DECLARE_CRIT_SECTION_LOCK_IN_STRUCT macro

Syntax

Arguments

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle