/**
 * 日期: 2025-04-13
 * 作者: coffee
 * 描述: 环转缓冲区
 */

#ifndef _H_RING_BUFFER_H_
#define _H_RING_BUFFER_H_


#include <stdint.h>


enum eRingBufferFlag {
    kHRingBufferFlag8       = 0x01, // 数据8位
    kHRingBufferFlag16      = 0x02, // 数据16位
    kHRingBufferFlag32      = 0x04, // 数据32位

    kHRingBufferFlagAllMask = 0x07, // 数据掩码

    kHRingBufferFull        = 0x40, // 环转缓冲区满
    kHRingBufferNeedInit    = 0x80, // 需要初始化
};


typedef uint8_t HRingBufferType;        // 环转缓冲区类型
typedef uint32_t HRingBufferDataType;   // 环转缓冲区统一数据类型

// 使用2字节长度
#ifndef _HRING_BUFFER_LEN_USE16
#define _HRING_BUFFER_LEN_USE16
#endif


#ifdef _HRING_BUFFER_LEN_USE32
#define HRING_BUFFER_ERROR (0xffffffff)
typedef uint32_t HRingBufferLenType;
#elif defined(_HRING_BUFFER_LEN_USE16)
#define HRING_BUFFER_ERROR (0xffff)
typedef uint16_t HRingBufferLenType;
#else
#define HRING_BUFFER_ERROR (0xff)
typedef uint8_t HRingBufferLenType;
#endif

typedef struct __attribute__ ((__packed__)) _HRingBufferBase {
    volatile uint8_t flag;
    HRingBufferLenType len;
    volatile HRingBufferLenType start;
    volatile HRingBufferLenType end;
} _HRingBufferBase;


typedef struct __attribute__ ((__packed__)) _HRingBuffer8 {
    _HRingBufferBase base;
    uint8_t data[0];
} _HRingBuffer8;

typedef struct __attribute__ ((__packed__)) _HRingBuffer16 {
    _HRingBufferBase base;
    uint16_t data[0];
} _HRingBuffer16;

typedef struct __attribute__ ((__packed__)) _HRingBuffer32 {
    _HRingBufferBase base;
    uint32_t data[0];
} _HRingBuffer32;

// 用于辅助多类型数值计算
#ifdef _HRING_BUFFER_LEN_USE32
#define _HRING_BUFFER_INIT_SIZE(size)        ((size >> 24) & 0xff), ((size >> 16) & 0xff), ((size >> 8) & 0xff), (size & 0xff)
#define _HRING_BUFFER_INIT_SIZE_INIT(size)   ((size[0] << 24) | (size[1] << 16) | (size[2] << 8) | (size[3] & 0xff))
#elif defined(_HRING_BUFFER_LEN_USE16)
#define _HRING_BUFFER_INIT_SIZE(size)        ((size >> 8) & 0xff), (size & 0xff)
#define _HRING_BUFFER_INIT_SIZE_INIT(size)   ((size[0] << 8) | (size[1] & 0xff))
#else
#define _HRING_BUFFER_INIT_SIZE(size)        (size & 0xff)
#define _HRING_BUFFER_INIT_SIZE_INIT(size)   (size[0] & 0xff)
#endif

// 计算环形缓冲区的内存大小
#define _HRING_BUFFER_CALC_LEN8(len) (sizeof(_HRingBuffer8) + (len) * sizeof(uint8_t))
#define _HRING_BUFFER_CALC_LEN16(len) (sizeof(_HRingBuffer16) + (len) * sizeof(uint16_t))
#define _HRING_BUFFER_CALC_LEN32(len) (sizeof(_HRingBuffer32) + (len) * sizeof(uint32_t))
#define _HRING_BUFFER_CALC_LEN(len, type) _HRING_BUFFER_CALC_LEN##type(len)

// 初始化宏，处理不同的长度类型
#define _HRING_BUFFER_INIT8(size) { kHRingBufferNeedInit | kHRingBufferFlag8, _HRING_BUFFER_INIT_SIZE(size), _HRING_BUFFER_INIT_SIZE(0), _HRING_BUFFER_INIT_SIZE(0) }
#define _HRING_BUFFER_INIT16(size) { kHRingBufferNeedInit | kHRingBufferFlag16, _HRING_BUFFER_INIT_SIZE(size), _HRING_BUFFER_INIT_SIZE(0), _HRING_BUFFER_INIT_SIZE(0) }
#define _HRING_BUFFER_INIT32(size) { kHRingBufferNeedInit | kHRingBufferFlag32, _HRING_BUFFER_INIT_SIZE(size), _HRING_BUFFER_INIT_SIZE(0), _HRING_BUFFER_INIT_SIZE(0) }
#define _HRING_BUFFER_INIT(size, type) _HRING_BUFFER_INIT##type(size)

// 定义环形缓冲区变量
#define HRING_BUFFER_DEFINE(name, size) HRingBufferType name[_HRING_BUFFER_CALC_LEN(size, 8)] = _HRING_BUFFER_INIT(size, 8)
#define HRING_BUFFER_DEFINE16(name, size) HRingBufferType name[_HRING_BUFFER_CALC_LEN(size, 16)] = _HRING_BUFFER_INIT(size, 16)
#define HRING_BUFFER_DEFINE32(name, size) HRingBufferType name[_HRING_BUFFER_CALC_LEN(size, 32)] = _HRING_BUFFER_INIT(size, 32)

// 添加数据到环形缓冲区, 成功返回1, 失败返回0
uint8_t HRingBufferAddData(HRingBufferType* buffer, HRingBufferDataType data);

// 添加数据到环形缓冲区, 当环形缓冲区满时, 会覆盖旧数据, 成功返回1, 失败返回0
uint8_t HRingBufferAddDataOver(HRingBufferType* buffer, HRingBufferDataType data);

// 获取指定位置的环形缓冲区数据, 失败返回 HRING_BUFFER_ERROR
HRingBufferDataType HRingBufferGetData(HRingBufferType* buffer, HRingBufferLenType index);

// 获取环形缓冲区数据, 失败返回 HRING_BUFFER_ERROR
HRingBufferDataType HRingBufferPopData(HRingBufferType* buffer);

// 获取环形缓冲区数据长度
HRingBufferLenType HRingBufferGetLen(HRingBufferType* buffer);

// 获取环形缓冲区数据字节长度
HRingBufferLenType HRingBufferGetByteLen(HRingBufferType* buffer);

// 清空环形缓冲区
void HRingBufferClear(HRingBufferType* buffer);

// 判断环形缓冲区是否为空
uint8_t HRingBufferEmpty(HRingBufferType* buffer);

#endif // _H_RING_BUFFER_H_