Zephyr API Documentation 4.5.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bitmap.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: Copyright (c) 2026 Silicon Laboratories Inc.
3 * SPDX-License-Identifier: Apache-2.0
4 */
5
11
12#ifndef ZEPHYR_INCLUDE_SYS_BITMAP_H_
13#define ZEPHYR_INCLUDE_SYS_BITMAP_H_
14
15#include <stdbool.h>
16#include <stddef.h>
17#include <stdint.h>
18
19#include <zephyr/sys/util.h>
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
41
47#define SYS_BITMAP_SIZE(num_bits) DIV_ROUND_UP(num_bits, BITS_PER_BYTE)
48
59#define SYS_BITMAP_DEFINE(name, num_bits) uint8_t name[SYS_BITMAP_SIZE(num_bits)]
60
70static inline bool sys_bitmap_test_bit(const uint8_t *bitmap, size_t bit)
71{
72 return (bitmap[bit / BITS_PER_BYTE] & BIT(bit % BITS_PER_BYTE)) != 0U;
73}
74
81static inline void sys_bitmap_set_bit(uint8_t *bitmap, size_t bit)
82{
83 bitmap[bit / BITS_PER_BYTE] |= (uint8_t)BIT(bit % BITS_PER_BYTE);
84}
85
92static inline void sys_bitmap_clear_bit(uint8_t *bitmap, size_t bit)
93{
94 bitmap[bit / BITS_PER_BYTE] &= (uint8_t)~BIT(bit % BITS_PER_BYTE);
95}
96
104static inline void sys_bitmap_set_bit_to(uint8_t *bitmap, size_t bit, bool val)
105{
106 if (val) {
107 sys_bitmap_set_bit(bitmap, bit);
108 } else {
109 sys_bitmap_clear_bit(bitmap, bit);
110 }
111}
112
122static inline bool sys_bitmap_test_and_set_bit(uint8_t *bitmap, size_t bit)
123{
124 bool old = sys_bitmap_test_bit(bitmap, bit);
125
126 sys_bitmap_set_bit(bitmap, bit);
127
128 return old;
129}
130
140static inline bool sys_bitmap_test_and_clear_bit(uint8_t *bitmap, size_t bit)
141{
142 bool old = sys_bitmap_test_bit(bitmap, bit);
143
144 sys_bitmap_clear_bit(bitmap, bit);
145
146 return old;
147}
148
159size_t sys_bitmap_find_next_set(const uint8_t *bitmap, size_t num_bits, size_t start);
160
171size_t sys_bitmap_find_next_clear(const uint8_t *bitmap, size_t num_bits, size_t start);
172
181size_t sys_bitmap_count_set(const uint8_t *bitmap, size_t num_bits);
182
190#define SYS_BITMAP_FOR_EACH_SET_BIT(bitmap, num_bits, bit) \
191 for ((bit) = sys_bitmap_find_next_set(bitmap, num_bits, 0); (bit) < (num_bits); \
192 (bit) = sys_bitmap_find_next_set(bitmap, num_bits, (bit) + 1U))
193
197
198#ifdef __cplusplus
199}
200#endif
201
202#endif /* ZEPHYR_INCLUDE_SYS_BITMAP_H_ */
#define BITS_PER_BYTE
Number of bits in a byte.
Definition util.h:62
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
static bool sys_bitmap_test_and_clear_bit(uint8_t *bitmap, size_t bit)
Clear a bit and return its old value.
Definition bitmap.h:140
static bool sys_bitmap_test_and_set_bit(uint8_t *bitmap, size_t bit)
Set a bit and return its old value.
Definition bitmap.h:122
size_t sys_bitmap_find_next_clear(const uint8_t *bitmap, size_t num_bits, size_t start)
Find the next cleared bit.
size_t sys_bitmap_find_next_set(const uint8_t *bitmap, size_t num_bits, size_t start)
Find the next set bit.
size_t sys_bitmap_count_set(const uint8_t *bitmap, size_t num_bits)
Count the set bits.
static void sys_bitmap_set_bit_to(uint8_t *bitmap, size_t bit, bool val)
Set a bit to a given value.
Definition bitmap.h:104
static void sys_bitmap_set_bit(uint8_t *bitmap, size_t bit)
Set a bit.
Definition bitmap.h:81
static void sys_bitmap_clear_bit(uint8_t *bitmap, size_t bit)
Clear a bit.
Definition bitmap.h:92
static bool sys_bitmap_test_bit(const uint8_t *bitmap, size_t bit)
Test a bit.
Definition bitmap.h:70
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
Misc utilities.