vsf_bitmap.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __VSF_BITMAP_H__
#define __VSF_BITMAP_H__
 
/* example:
 
    // 0. Include vsf header file
    #include "vsf.h"
 
    // 1. Declare the bitmap with bit_size
    // IMPORTANT: DANGER: RED: can not access bits larger than bit_size
    dcl_vsf_bitmap(xxx_bitmap, 32);
 
    // 2. Defining bitmap variable
    static vsf_bitmap(xxxx_bitmap) usr_xxxx_bitmap;
 
    void user_example_task(void)
    {
        ......
 
        ......
 
        // 3. Set bit in bitmap
        vsf_bitmap_set(&usr_xxxx_bitmap, 10);
        // 4. Clear bit in bitmap
        vsf_bitmap_clear(&usr_xxxx_bitmap, 12);
        // 5. TODO: Find First Set/Zero bit in bitmap
        vsf_bitmap_ffs(&usr_xxxx_bitmap, 32);
        vsf_bitmap_ffz(&usr_xxxx_bitmap, 32);
 
        ......
    }
 */
 
/*============================ INCLUDES ======================================*/
 
#include "../compiler/compiler.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
#define __vsf_bitmap(__name)        __name##_bitmap_t
 
#define __vsf_declare_bitmap_ex(__name, __bit_size)                             \
    typedef uintalu_t                                                           \
                __name[((__bit_size) + __optimal_bit_sz - 1) / __optimal_bit_sz];
 
#define __vsf_declare_bitmap(__name, __bit_size)                                \
    __vsf_declare_bitmap_ex(__vsf_bitmap(__name), __bit_size)
 
 
 
#define __vsf_bitmap_get0(__bitmap_ptr, __bit)                                  \
    (((uintalu_t *)__bitmap_ptr)[(__bit) / __optimal_bit_sz] & ((uintalu_t)1 << ((__bit) & __optimal_bit_msk)))
#define __vsf_bitmap_get1(__bitmap_ptr, __bit, __pbit_val)                      \
    do {                                                                        \
        *(&(__bit_val)) = __vsf_bitmap_get0(__bitmap_ptr, __bit);               \
    } while (0)
 
#define __vsf_bitmap_set(__bitmap_ptr, __bit)                                   \
    do {                                                                        \
        (__bitmap_ptr)[(__bit) / __optimal_bit_sz] |=                           \
            ((uintalu_t)1 << ((__bit) & __optimal_bit_msk));                    \
    } while (0)
 
#define __vsf_bitmap_clear(__bitmap_ptr, __bit)                                 \
    do {                                                                        \
        (__bitmap_ptr)[(__bit) / __optimal_bit_sz] &=                           \
            ~((uintalu_t)1 << ((__bit) & __optimal_bit_msk));                   \
    } while (0)
 
#define vsf_bitmap(__name)          __vsf_bitmap(__name)
 
#define vsf_declare_bitmap(__name, __bit_size)                                  \
            __vsf_declare_bitmap(__name, __bit_size)
 
#define dcl_vsf_bitmap(__name, __bit_size)                                      \
            vsf_declare_bitmap(__name, __bit_size)
 
#define declare_vsf_bitmap(__name, __bit_size)                                  \
            vsf_declare_bitmap(__name, __bit_size)
 
#define vsf_bitmap_get(__bitmap_ptr, __bit, ...)                                \
            __PLOOC_EVAL(__vsf_bitmap_get, __VA_ARGS__)((__bitmap_ptr), (__bit), ##__VA_ARGS__)
 
#define vsf_bitmap_set(__bitmap_ptr, __bit)                                     \
            __vsf_bitmap_set((uintalu_t *)(__bitmap_ptr), (__bit))
 
#define vsf_bitmap_clear(__bitmap_ptr, __bit)                                   \
            __vsf_bitmap_clear((uintalu_t *)(__bitmap_ptr), (__bit))
 
#define vsf_bitmap_set_range(__bitmap_ptr, __begin_bit, __end_bit)              \
            __vsf_bitmap_range_assign((uintalu_t *)(__bitmap_ptr), (__begin_bit), (__end_bit), 1)
 
#define vsf_bitmap_clear_range(__bitmap_ptr, __begin_bit, __end_bit)            \
            __vsf_bitmap_range_assign((uintalu_t *)(__bitmap_ptr), (__begin_bit), (__end_bit), 0)
 
#define vsf_bitmap_reset(__bitmap_ptr, __bit_size)                              \
            memset(__bitmap_ptr, 0, ((uint_fast32_t)__bit_size + 7) >> 3)
 
#define vsf_bitmap_ffz(__bitmap_ptr, __bit_size)                                \
            __vsf_bitmap_ffz((uintalu_t *)(__bitmap_ptr), (__bit_size))
 
#define vsf_bitmap_ffs(__bitmap_ptr, __bit_size)                                \
            __vsf_bitmap_ffs((uintalu_t *)(__bitmap_ptr), (__bit_size))
 
/*============================ TYPES =========================================*/
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ PROTOTYPES ====================================*/
 
extern void __vsf_bitmap_range_assign(uintalu_t *bitmap_ptr, int_fast32_t begin_bit, int_fast32_t end_bit, int_fast32_t value);
extern int_fast32_t __vsf_bitmap_ffz(uintalu_t *bitmap_ptr, int_fast32_t bit_size);
extern int_fast32_t __vsf_bitmap_ffs(uintalu_t *bitmap_ptr, int_fast32_t bit_size);
 
#ifdef __cplusplus
}
#endif
 
#endif