-
Notifications
You must be signed in to change notification settings - Fork 1
/
buffer.h
61 lines (55 loc) · 1.32 KB
/
buffer.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/** @file
* @brief Header file with cicle buffer functions
*/
#ifndef BUFFER_H
#define BUFFER_H
#include <stdint.h>
#include <stdbool.h>
/**
* @defgroup CicleBuffer
*
* Cicle buffer
* Callback will automaticaly called for each half of buffer,
* when pointer will be out of this half
*
* @{
*/
/** Maximum size of the buffer, should be power of 2 */
#define BUFFER_SIZE 512U
/** Callback when data is required ptr - start pointer, max_size - maximum size, size - actual size */
typedef void(*buffer_OnNeedDataCb)(uint8_t *ptr, uint32_t max_size, uint32_t *size);
/**
* @brief Init function of the buffer
*
* It is required to call this function before any actions with buffer
*
* @param[in] needDataCb pointer on callback which will be called
* inside Run functions when data is required
*
* @return none
* @see buffer_OnNeedDataCb
*/
void buffer_Init(buffer_OnNeedDataCb needDataCb);
/**
* @brief Get next element from buffer
*
* @param[out] next pointer to store next element
*
* @return false - no more data available
*/
bool buffer_GetNext(uint8_t *next);
/**
* @brief Run managment function for buffer
*
* @return none
*/
void buffer_Run(void);
/**
* @brief Stop buffer
* will be automaticaly called in Init if required
*
* @return none
*/
void buffer_Stop(void);
/** @} */
#endif /* BUFFER_H */