/* circularbytebuffer.h */
/*
This file is part of the AVR-circularbytebuffer.
- Copyright (C) 2009 Daniel Otte (daniel.otte@rub.de)
+ Copyright (C) 2006-2015 Daniel Otte (bg@nerilex.org)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
*/
/**
* \file circularbytebuffer.h
- * \email daniel.otte@rub.de
+ * \email bg@nerilex.org
* \author Daniel Otte
* \date 2009-07-24
* \license GPLv3 or later
typedef struct {
uint8_t buffer_size; /**< holds the amount of bytes which may be stored in the buffer */
uint8_t fillcount; /**< holds the amount of bytes actually stored in the buffer */
- uint8_t* buffer; /**< pointer to the actual buffer */
- uint8_t* head; /**< pointer to the head of the buffer */
- uint8_t* tail; /**< pointer to the tail of the buffer */
- uint8_t* top; /**< pointer to the last free address in the buffer */
+ uint8_t *buffer; /**< pointer to the actual buffer */
+ uint8_t *head; /**< pointer to the head of the buffer */
+ uint8_t *tail; /**< pointer to the tail of the buffer */
+ uint8_t *top; /**< pointer to the last free address in the buffer */
} circularbytebuffer_t;
* \param buffersize size of the buffer to allocate
* \param cb buffer context to be initialized
*/
-uint8_t circularbytebuffer_init(uint8_t buffersize, circularbytebuffer_t* cb);
+uint8_t circularbytebuffer_init(uint8_t buffersize, circularbytebuffer_t *cb);
#endif
#if CIRCULARBYTEBUFFER_NO_INIT2==0
/** \brief buffer initialisation without automatic allocation
* \param cb buffer context to be initialized
* \param buffer buffer for the storage of data (you are responisble for allocation and freeing)
*/
-void circularbytebuffer_init2(uint8_t buffersize, circularbytebuffer_t* cb, void* buffer);
+void circularbytebuffer_init2(uint8_t buffersize, circularbytebuffer_t *cb, void *buffer);
#endif
/** \brief
*
*
*/
-uint16_t circularbytebuffer_get_lifo(circularbytebuffer_t* cb);
-uint16_t circularbytebuffer_get_fifo(circularbytebuffer_t* cb);
-uint8_t circularbytebuffer_append(uint8_t, circularbytebuffer_t* cb);
-uint8_t circularbytebuffer_push(uint8_t, circularbytebuffer_t* cb);
-uint8_t circularbytebuffer_cnt(circularbytebuffer_t* cb);
-void circularbytebuffer_free(circularbytebuffer_t* cb);
+uint16_t circularbytebuffer_get_lifo(circularbytebuffer_t *cb);
+uint16_t circularbytebuffer_get_fifo(circularbytebuffer_t *cb);
+uint8_t circularbytebuffer_append(uint8_t, circularbytebuffer_t *cb);
+uint8_t circularbytebuffer_push(uint8_t, circularbytebuffer_t *cb);
+uint8_t circularbytebuffer_cnt(circularbytebuffer_t *cb);
+void circularbytebuffer_free(circularbytebuffer_t *cb);
/*@}*/
#endif /* CIRCULARBYTEBUFFER_H_ */