esp_os_enter_critical macro

Enter a critical section, i.e., a section that will not be interrupted by any other task or interrupt. 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:230

#define esp_os_enter_critical(lock) portENTER_CRITICAL(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(lock) portENTER_CRITICAL(lock)

critical_section.h:230

esp_os_enter_critical( &critical_section_lock );

FreeRTOS_POSIX_mqueue.c:350

#define UART_ENTER_CRITICAL(spinlock) esp_os_enter_critical(spinlock)

uart.c:101

esp_os_enter_critical macro

Syntax

Arguments

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle