@web-font-path: "roboto-debian.css";
Loading...
Searching...
No Matches
critical_section.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef _PICO_CRITICAL_SECTION_H
8#define _PICO_CRITICAL_SECTION_H
9
10#include "pico.h"
11#include "pico/lock_core.h"
12
13#ifdef __cplusplus
14extern "C" {
15#endif
16
29
30typedef struct __packed_aligned critical_section {
31 spin_lock_t *spin_lock;
32 uint32_t save;
33} critical_section_t;
34
45void critical_section_init(critical_section_t *crit_sec);
46
52void critical_section_init_with_lock_num(critical_section_t *crit_sec, uint lock_num);
53
62__force_inline static void critical_section_enter_blocking(critical_section_t *crit_sec) {
63 crit_sec->save = spin_lock_blocking(crit_sec->spin_lock);
64}
65
71__force_inline static void critical_section_exit(critical_section_t *crit_sec) {
72 spin_unlock(crit_sec->spin_lock, crit_sec->save);
73}
74
84void critical_section_deinit(critical_section_t *crit_sec);
85
92static inline bool critical_section_is_initialized(critical_section_t *crit_sec) {
93 return crit_sec->spin_lock != 0;
94}
95
96#ifdef __cplusplus
97}
98#endif
99#endif
void critical_section_deinit(critical_section_t *crit_sec)
De-Initialise a critical_section created by the critical_section_init method.
Definition critical_section.c:22
void critical_section_init(critical_section_t *crit_sec)
Initialise a critical_section structure allowing the system to assign a spin lock number.
Definition critical_section.c:13
static __force_inline void critical_section_enter_blocking(critical_section_t *crit_sec)
Enter a critical_section.
Definition critical_section.h:62
static __force_inline void critical_section_exit(critical_section_t *crit_sec)
Release a critical_section.
Definition critical_section.h:71
void critical_section_init_with_lock_num(critical_section_t *crit_sec, uint lock_num)
Initialise a critical_section structure assigning a specific spin lock number.
Definition critical_section.c:17
static __force_inline uint32_t spin_lock_blocking(spin_lock_t *lock)
Acquire a spin lock safely.
Definition spin_lock.h:301
io_rw_32 spin_lock_t
A spin lock identifier.
Definition spin_lock.h:84
static __force_inline void spin_unlock(spin_lock_t *lock, uint32_t saved_irq)
Release a spin lock safely.
Definition spin_lock.h:332
static bool critical_section_is_initialized(critical_section_t *crit_sec)
Test whether a critical_section has been initialized.
Definition critical_section.h:92
#define __force_inline
Attribute to force inlining of a function regardless of optimization level.
Definition compiler.h:128
Definition critical_section.h:30