buffer.h

Go to the documentation of this file.

#ifndef _BUFFER_H_
#define _BUFFER_H_

// Standard Includes
#include <stdint.h>
#include <stdbool.h>

#include "library.h"

typedef struct {
    uint16_t size; 
    uint16_t max_size; 
    uint8_t *front; 
    uint8_t *rear; 
    uint8_t *buffer_start; 
    uint8_t *buffer_end; 
    void (*Callback)(void * buf); 
    //x the input to the Callback should be a buffer_t pointer; however, buffer_t
    //x has not been defined thus the pointer is cast as a void pointer.
    void (*OverwriteCallback)(void);
} buffer_t;

void Buffer_Enqueue(buffer_t *buffer, uint8_t data);

uint8_t Buffer_Dequeue(buffer_t *buffer);

uint16_t Buffer_GetSize(buffer_t *buffer);

#define BUFFER_ALLOCATE(buffer_name,  max_size)\
    char CAT2(buffer_name, _array)[max_size];\
    buffer_t buffer_name

#define BUFFER_INIT(buffer_name, max_size)\
    Buffer_Init(&buffer_name, &CAT2(buffer_name, _array)[0], max_size)

void Buffer_Init(buffer_t *buffer, uint8_t *data_array, uint16_t max_size);

void Buffer_SetCallback(buffer_t * buffer, void (*Callback)(buffer_t * buffer));

void Buffer_ClearCallback(buffer_t * buffer);

uint8_t Buffer_EnqueueData(buffer_t * buffer, uint8_t * data, uint16_t length);

#define BUFFER_ENQUEUE_FAILED 1 
#define BUFFER_ENQUEUE_SUCCEEDED 0 


#endif // _BUFFER_H_