nrf_802154_bsmap.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */
 
#ifndef NRF_802154_BSMAP_H_
#define NRF_802154_BSMAP_H_
 
#include <nrfx.h>
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
struct nrf_802154_bsmap_s;
 
typedef struct nrf_802154_bsmap_s nrf_802154_bsmap_t;
 
typedef struct
{
    int32_t index;
    bool forward;
    bool deleted;
    nrf_802154_bsmap_t * p_bsmap;
} nrf_802154_bsmap_iterator_t;
 
struct nrf_802154_bsmap_s
{
    uint16_t key_size;
 
    uint16_t value_size;
 
    uint16_t entry_size;
 
    uint16_t capacity;
 
    uint16_t keys_count;
 
    void * p_memory;
 
    nrfx_atomic_t entry_idx_in_aux;
 
    void * p_aux_memory;
 
    nrf_802154_bsmap_iterator_t * p_iter;
};
 
#define NRF_802154_BSMAP_ENTRY_SIZE(key_size, value_size) ((key_size) + (value_size))
 
#define NRF_802154_BSMAP_MEMORY_SIZE(key_size, value_size, capacity) \
    (NRF_802154_BSMAP_ENTRY_SIZE((key_size), (value_size)) * (capacity))
 
#define NRF_802154_BSMAP_AUX_MEMORY_SIZE(key_size, value_size) \
    NRF_802154_BSMAP_ENTRY_SIZE((key_size), (value_size))
 
void nrf_802154_bsmap_init(nrf_802154_bsmap_t * p_bsmap,
                           size_t               key_size,
                           size_t               value_size,
                           size_t               capacity,
                           void               * p_memory);
 
bool nrf_802154_bsmap_rec_get(const nrf_802154_bsmap_t * p_bsmap,
                              const void               * p_key,
                              void                     * p_value);
 
bool nrf_802154_bsmap_rec_write(nrf_802154_bsmap_t * p_bsmap,
                                const void         * p_key,
                                const void         * p_value,
                                void               * p_aux_memory);
 
bool nrf_802154_bsmap_rec_delete(nrf_802154_bsmap_t * p_bsmap,
                                 const void         * p_key,
                                 void               * p_aux_memory);
 
void nrf_802154_bsmap_clear(nrf_802154_bsmap_t * p_bsmap);
 
void nrf_802154_bsmap_iterator_begin(nrf_802154_bsmap_t          * p_bsmap,
                                     nrf_802154_bsmap_iterator_t * p_iter,
                                     bool                          forward);
 
bool nrf_802154_bsmap_iterator_is_valid(const nrf_802154_bsmap_iterator_t * p_iter);
 
void nrf_802154_bsmap_iterator_rec_key_get(const nrf_802154_bsmap_iterator_t * p_iter,
                                           void                              * p_key);
 
void nrf_802154_bsmap_iterator_rec_value_get(const nrf_802154_bsmap_iterator_t * p_iter,
                                             void                              * p_value);
 
void nrf_802154_bsmap_iterator_rec_value_write(
    const nrf_802154_bsmap_iterator_t * p_iter,
    const void                        * p_value,
    void                              * p_aux_memory);
 
void nrf_802154_bsmap_iterator_rec_delete(
    nrf_802154_bsmap_iterator_t * p_iter,
    void                        * p_aux_memory);
 
void nrf_802154_bsmap_iterator_next(nrf_802154_bsmap_iterator_t * p_iter);
 
void nrf_802154_bsmap_iterator_finish(nrf_802154_bsmap_iterator_t * p_iter);
 
#endif /* NRF_802154_BSMAP_H_ */