xt_rb.h

浏览该文件的文档.

 
#ifndef __XT_RB_H__
#define __XT_RB_H__
 
/* ==================== [Includes] ========================================== */
 
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */
 
#define XT_RB_FORCE          1
#define XT_RB_NO_FORCE       0
 
/* ==================== [Typedefs] ========================================== */

struct xt_rb {
    volatile uint32_t head;     
    volatile uint32_t tail;     
    uint32_t buf_size;          
    uint8_t *p_buf;             
};
 
/* ==================== [Global Prototypes] ================================= */

void xt_rb_init(struct xt_rb *rb, uint8_t *buf, uint32_t size);

void xt_rb_reset(struct xt_rb *rb);

bool xt_rb_is_empty(const struct xt_rb *rb);

bool xt_rb_is_full(const struct xt_rb *rb);

uint32_t xt_rb_get_continuous_read_space(const struct xt_rb *rb);

uint32_t xt_rb_get_continuous_write_space(const struct xt_rb *rb, uint8_t b_force);

uint32_t xt_rb_get_size(const struct xt_rb *rb);

uint32_t xt_rb_get_filled(const struct xt_rb *rb);

uint32_t xt_rb_get_empty(const struct xt_rb *rb);

void xt_rb_putc(struct xt_rb *rb, uint8_t ch);

bool xt_rb_getc(struct xt_rb *rb, uint8_t *ch);

uint32_t xt_rb_write(struct xt_rb *rb, const uint8_t *src, uint32_t size, uint8_t b_force);

uint32_t xt_rb_read(struct xt_rb *rb, uint8_t *dst, uint32_t size);
 
/* ==================== [Macros] ============================================ */
 
#define XT_RB_IS_VALID(rb)          ((rb) && ((rb)->p_buf) && ((rb)->buf_size > 0))
#define XT_RB_IS_EMPTY(rb)          xt_rb_is_empty(rb)
#define XT_RB_IS_FULL(rb)           xt_rb_is_full(rb)
  /* xt_rb */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // __XT_RB_H__