DEFINE_CRIT_SECTION_LOCK_STATIC macro

Define and initialize a static (internal linking) lock for entering critical sections. Use this when all the critical sections are local inside a file. The lock will only be defined if built for a multi-core system, otherwise it is unnecessary. Example usage:

{c}
 ...
 #include "os/critical_section.h"
 ...
 DEFINE_CRIT_SECTION_LOCK_STATIC(my_lock); // will have internal linking (static)
 ...
 esp_os_enter_critical(&my_lock);
 ...
 esp_os_exit_critical(&my_lock);
 

Syntax

Show:

Summary

Declaration

from critical_section.h:63

#define DEFINE_CRIT_SECTION_LOCK_STATIC(lock_name, optional_qualifiers...) static optional_qualifiers esp_os_spinlock_t lock_name = SPINLOCK_INITIALIZER

Arguments

Argument

Description

lock_name

Variable name of the lock. This will later be used to reference the declared lock.

optional_qualifiers

Qualifiers such as DRAM_ATTR and other attributes. Can be omitted if no qualifiers are required.

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.

References

Code

Location

#define DEFINE_CRIT_SECTION_LOCK_STATIC(lock_name, optional_qualifiers...) static optional_qualifiers esp_os_spinlock_t lock_name = SPINLOCK_INITIALIZER

critical_section.h:63

DEFINE_CRIT_SECTION_LOCK_STATIC( critical_section_lock );

FreeRTOS_POSIX_mqueue.c:163

DEFINE_CRIT_SECTION_LOCK_STATIC(s_spinlock);

esp_cache.c:30

DEFINE_CRIT_SECTION_LOCK_STATIC macro

Syntax

Arguments

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle