ringbuffer.h

浏览该文件的文档.

 
#ifndef __RINGBUFFER_H__
#define __RINGBUFFER_H__
 
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
 
// #define RING_BUFFER_SIZE     256U//512
//
// #if (RING_BUFFER_SIZE & (RING_BUFFER_SIZE - 1)) != 0
// #error "RING_BUFFER_SIZE must be a power of two"
// #endif
 
typedef uint32_t ring_buffer_size_t;
 
// #define RING_BUFFER_MASK (RING_BUFFER_SIZE-1)
 
typedef struct ring_buffer
{
    uint8_t *buffer;
    ring_buffer_size_t size;
    ring_buffer_size_t tail_index;
    ring_buffer_size_t head_index;
    bool rx_lock;
} ring_buffer_t;
// typedef struct ring_buffer {
//  /** Buffer memory. */
//  unsigned char buffer[RING_BUFFER_SIZE];
//  /** Index of tail. */
//  ring_buffer_size_t tail_index;
//  /** Index of head. */
//  ring_buffer_size_t head_index;
//  /** Rx Locker. */
//  bool rx_lock;
//}ring_buffer_t;
 
// typedef struct ring_buffer {
//  /** Buffer memory. */
//  unsigned char buffer[RING_BUFFER_SIZE];
//  /** Index of tail. */
//  ring_buffer_size_t tail_index;
//  /** Index of head. */
//  ring_buffer_size_t head_index;
//  /** Rx Locker. */
//  bool rx_lock;
//}ring_buffer_t;
 
// void ring_buffer_init(ring_buffer_t *buffer);
void ring_buffer_create(ring_buffer_t *rb, uint8_t *buffer, uint32_t size);
 
void ring_buffer_queue(ring_buffer_t *rb, uint8_t data);
 
void ring_buffer_queue_arr(ring_buffer_t *rb, uint8_t *data,
                           ring_buffer_size_t size);
 
ring_buffer_size_t ring_buffer_dequeue(ring_buffer_t *rb, uint8_t *data);
 
ring_buffer_size_t ring_buffer_dequeue_arr(ring_buffer_t *rb, uint8_t *data,
                                           ring_buffer_size_t len);
ring_buffer_size_t ring_buffer_peek(ring_buffer_t *rb, uint8_t *data,
                                    ring_buffer_size_t index);
 
inline ring_buffer_size_t ring_buffer_is_empty(ring_buffer_t *rb)
{
    return (rb->head_index == rb->tail_index);
}
 
inline ring_buffer_size_t ring_buffer_is_full(ring_buffer_t *rb)
{
    return ((rb->head_index - rb->tail_index) & (rb->size - 1)) ==
           (rb->size - 1);
}
 
inline ring_buffer_size_t ring_buffer_num_items(ring_buffer_t *rb)
{
    return ((rb->head_index - rb->tail_index) & (rb->size - 1));
}
 
#endif /* __RINGBUFFER_H__ */