1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
|
/*
* Copyright © 2017-2022 The Crust Firmware Authors.
* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0-only
*/
#ifndef LIB_BITMAP_H
#define LIB_BITMAP_H
#include <limits.h>
#include <mmio.h>
#include <stdbool.h>
#include <stdint.h>
#include <util.h>
/**
* Calculate a bit index from a word offset (in bytes) and a bit offset
* within that word.
*
* @param word The offset of the word from the beginning of the bitmap.
* @param bit The offset (arithmetic shift) of the bit within the word.
*/
#define BITMAP_INDEX(word, bit) (CHAR_BIT * (word) + (bit))
/**
* Extract the word offset (in bytes) from a bitmap index.
*
* @param index An index into a bitmap, in bits.
*/
#define BITMAP_WORD(index) ((index) / WORD_BIT * (WORD_BIT / CHAR_BIT))
/**
* Extract the bit offset (arithmetic shift) from a bitmap index.
*
* @param index An index into a bitmap, in bits.
*/
#define BITMAP_BIT(index) ((index) % WORD_BIT)
/**
* Clear a bit in a bitmap.
*
* @param base The address of the start of the bitmap.
* @param index The index into the bitmap (in bits) of the bit to clear.
*/
static inline void
bitmap_clear(uintptr_t base, uint32_t index)
{
mmio_clr_32(base + BITMAP_WORD(index), BIT(BITMAP_BIT(index)));
}
/**
* Get a bit in a bitmap.
*
* @param base The address of the start of the bitmap.
* @param index The index into the bitmap (in bits) of the bit to get.
*/
static inline bool
bitmap_get(uintptr_t base, uint32_t index)
{
return mmio_get_32(base + BITMAP_WORD(index), BIT(BITMAP_BIT(index)));
}
/**
* Set a bit in a bitmap.
*
* @param base The address of the start of the bitmap.
* @param index The index into the bitmap (in bits) of the bit to set.
*/
static inline void
bitmap_set(uintptr_t base, uint32_t index)
{
mmio_set_32(base + BITMAP_WORD(index), BIT(BITMAP_BIT(index)));
}
#endif /* LIB_BITMAP_H */
|