cfn_hal_util.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_HAL_CFN_HAL_UTIL_H
#define CAFFEINE_HAL_CFN_HAL_UTIL_H
#include <stdint.h>
#include <stdbool.h>
 
/* --- 1. Multi-Byte Reconstruction (Endianness) --- */
 
static inline int16_t cfn_util_bytes_to_int16_le(uint8_t msb, uint8_t lsb)
{
    /* Use 32-bit unsigned math internally to prevent signed promotion during shifts */
    const uint32_t COMBINED = ((uint32_t) msb << 8U) | (uint32_t) lsb;
    return (int16_t) COMBINED;
}
 
static inline uint32_t cfn_util_bytes_to_uint32_le(uint8_t b3, uint8_t b2, uint8_t b1, uint8_t b0)
{
    return ((uint32_t) b3 << 24U) | ((uint32_t) b2 << 16U) | ((uint32_t) b1 << 8U) | (uint32_t) b0;
}
 
static inline int32_t cfn_util_bytes_to_int32_be(uint8_t b0, uint8_t b1, uint8_t b2, uint8_t b3)
{
    const uint32_t COMBINED = ((uint32_t) b0 << 24U) | ((uint32_t) b1 << 16U) | ((uint32_t) b2 << 8U) | (uint32_t) b3;
    return (int32_t) COMBINED;
}
 
/* --- 2. Bitwise Manipulation (Explicit Logic) --- */
 
static inline uint32_t cfn_util_extract_field(uint32_t val, uint32_t mask, uint32_t shift)
{
    /* Mask first, then shift down so the result fits in the smallest possible type */
    return (uint32_t) ((val & mask) >> shift);
}
 
static inline bool cfn_util_bit_is_set(uint8_t reg_val, uint8_t bit_mask)
{
    return (bool) ((reg_val & bit_mask) != 0U);
}
 
/* --- 3. Saturated & Safe Arithmetic --- */
 
static inline int16_t cfn_util_sat_add_s16(int16_t a, int16_t b)
{
    const int32_t RESULT = (int32_t) a + (int32_t) b;
    int16_t       out;
    if (RESULT > 32767)
    {
        out = 32767;
    }
    else if (RESULT < -32768)
    {
        out = -32768;
    }
    else
    {
        out = (int16_t) RESULT;
    }
    return out;
}
 
static inline float cfn_util_clamp_f32(float val, float min, float max)
{
    float res = val;
    if (val < min)
    {
        res = min;
    }
    else if (val > max)
    {
        res = max;
    }
    return res;
}
 
/* --- 4. Floating Point Utilities --- */
 
static inline bool cfn_util_f32_is_equal(float a, float b, float epsilon)
{
    float diff = a - b;
    if (diff < 0.0F)
    {
        diff = -diff;
    }
    return (bool) (diff <= epsilon);
}
 
/* --- 5. Conversion Utilities --- */
 
static inline int16_t cfn_util_f32_to_q15(float val)
{
    const float SCALED = val * 32767.0F;
    return (int16_t) SCALED;
}
 
static inline uint8_t cfn_util_get_msb16(uint16_t val)
{
    return (uint8_t) (((uint32_t) val >> 8U) & 0xFFU);
}
 
static inline uint8_t cfn_util_get_lsb16(uint16_t val)
{
    return (uint8_t) ((uint32_t) val & 0xFFU);
}
 
#endif // CAFFEINE_HAL_CFN_HAL_UTIL_H