Zephyr API Documentation 4.5.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
atomic_c.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 1997-2015, Wind River Systems, Inc.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
13
14/* IWYU pragma: private, include "zephyr/sys/atomic.h" */
15
16#ifndef ZEPHYR_INCLUDE_SYS_ATOMIC_C_H_
17#define ZEPHYR_INCLUDE_SYS_ATOMIC_C_H_
18
19/* Included from <atomic.h> */
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
26
27/* Simple and correct (but very slow) implementation of atomic
28 * primitives that require nothing more than kernel interrupt locking.
29 */
30
31__syscall bool atomic_cas(atomic_t *target, atomic_val_t old_value,
32 atomic_val_t new_value);
33
34__syscall bool atomic_ptr_cas(atomic_ptr_t *target, atomic_ptr_val_t old_value,
35 atomic_ptr_val_t new_value);
36
37__syscall atomic_val_t atomic_add(atomic_t *target, atomic_val_t value);
38
39__syscall atomic_val_t atomic_sub(atomic_t *target, atomic_val_t value);
40
41static inline atomic_val_t atomic_inc(atomic_t *target)
42{
43 return atomic_add(target, 1);
44
45}
46
47static inline atomic_val_t atomic_dec(atomic_t *target)
48{
49 return atomic_sub(target, 1);
50
51}
52
53atomic_val_t atomic_get(const atomic_t *target);
54
56
57__syscall atomic_val_t atomic_set(atomic_t *target, atomic_val_t value);
58
60
61static inline atomic_val_t atomic_clear(atomic_t *target)
62{
63 return atomic_set(target, 0);
64
65}
66
68{
69 return atomic_ptr_set(target, NULL);
70
71}
72
73__syscall atomic_val_t atomic_or(atomic_t *target, atomic_val_t value);
74
75__syscall atomic_val_t atomic_xor(atomic_t *target, atomic_val_t value);
76
77__syscall atomic_val_t atomic_and(atomic_t *target, atomic_val_t value);
78
79__syscall atomic_val_t atomic_nand(atomic_t *target, atomic_val_t value);
80
82
83#ifdef __cplusplus
84}
85#endif
86
87#ifdef CONFIG_ATOMIC_OPERATIONS_C
88
89#ifndef DISABLE_SYSCALL_TRACING
90/* Skip defining macros of atomic_*() for syscall tracing.
91 * Compiler does not like "({ ... tracing code ... })" and complains
92 *
93 * error: expected identifier or '(' before '{' token
94 *
95 * ... even though there is a '(' before '{'.
96 */
97#define DISABLE_SYSCALL_TRACING
98#define _REMOVE_DISABLE_SYSCALL_TRACING
99#endif
100
101#include <zephyr/syscalls/atomic_c.h>
102
103#ifdef _REMOVE_DISABLE_SYSCALL_TRACING
104#undef DISABLE_SYSCALL_TRACING
105#undef _REMOVE_DISABLE_SYSCALL_TRACING
106#endif
107
108#endif
109
110#endif /* ZEPHYR_INCLUDE_SYS_ATOMIC_C_H_ */
long atomic_t
Atomic integer variable.
Definition atomic_types.h:34
atomic_val_t atomic_or(atomic_t *target, atomic_val_t value)
Atomic bitwise inclusive OR.
atomic_val_t atomic_xor(atomic_t *target, atomic_val_t value)
Atomic bitwise exclusive OR (XOR).
atomic_ptr_val_t atomic_ptr_get(const atomic_ptr_t *target)
Atomic get a pointer value.
atomic_t atomic_val_t
Value type for atomic integer variables.
Definition atomic_types.h:41
atomic_val_t atomic_get(const atomic_t *target)
Atomic get.
atomic_ptr_t atomic_ptr_val_t
Value type for atomic pointer variables.
Definition atomic_types.h:56
atomic_ptr_val_t atomic_ptr_set(atomic_ptr_t *target, atomic_ptr_val_t value)
Atomic get-and-set for pointer values.
atomic_val_t atomic_nand(atomic_t *target, atomic_val_t value)
Atomic bitwise NAND.
atomic_val_t atomic_and(atomic_t *target, atomic_val_t value)
Atomic bitwise AND.
atomic_val_t atomic_add(atomic_t *target, atomic_val_t value)
Atomic addition.
atomic_ptr_val_t atomic_ptr_clear(atomic_ptr_t *target)
Atomic clear of a pointer value.
atomic_val_t atomic_set(atomic_t *target, atomic_val_t value)
Atomic get-and-set.
atomic_val_t atomic_sub(atomic_t *target, atomic_val_t value)
Atomic subtraction.
atomic_val_t atomic_clear(atomic_t *target)
Atomic clear.
bool atomic_ptr_cas(atomic_ptr_t *target, atomic_ptr_val_t old_value, atomic_ptr_val_t new_value)
Atomic compare-and-set with pointer values.
atomic_val_t atomic_inc(atomic_t *target)
Atomic increment.
bool atomic_cas(atomic_t *target, atomic_val_t old_value, atomic_val_t new_value)
Atomic compare-and-set.
atomic_val_t atomic_dec(atomic_t *target)
Atomic decrement.
void * atomic_ptr_t
Atomic pointer variable.
Definition atomic_types.h:49