esp_os_enter_critical_safe macro

Enter a critical section from normal task or ISR. This macro will check if the current CPU is processing an ISR or not and enter the critical section accordingly. On multi-core systems, this will disable interrupts and take the spinlock \c lock. On single core systems, a spinlock is unncessary, hence \c lock is ignored and interrupts are disabled only. Example usage with static locks:

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

Syntax

Show:

Summary

Declaration

from critical_section.h:347

#define esp_os_enter_critical_safe(lock) portENTER_CRITICAL_SAFE(lock)

Arguments

Argument

Description

lock

Pointer to the critical section lock. Ignored if build for single core system.

Notes

This macro MUST be used together with any of the initialization macros, e.g. DEFINE_CRIT_SECTION_LOCK_STATIC. If not, there may be unused variables.

References

Code

Location

#define esp_os_enter_critical_safe(lock) portENTER_CRITICAL_SAFE(lock)

critical_section.h:347

esp_os_enter_critical_safe(&s_spinlock);

esp_cache.c:123

#define UART_ENTER_CRITICAL_SAFE(spinlock) esp_os_enter_critical_safe(spinlock)

uart.c:97

esp_os_enter_critical_safe macro

Syntax

Arguments

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle