GPS Device
Loading...
Searching...
No Matches
cbuf.h
Go to the documentation of this file.
1
28
34
35#ifndef CBUF_H__
36#define CBUF_H__
37
38#include "err.h"
39#include <stdint.h>
40
47
60typedef struct {
62 uint8_t *ptr;
63
65 uint8_t size;
66
69
73
75
82
98ERR_te cbuf_read(CBUF_HANDLE_ts *cbuf_handle, uint8_t *output_buf_o);
99
118ERR_te cbuf_write(CBUF_HANDLE_ts *cbuf_handle, uint8_t *input_buf, uint32_t input_len);
119
132ERR_te cbuf_len(CBUF_HANDLE_ts const *cbuf_handle, uint8_t *len_o);
133
135
136#endif
137
System-wide error code definitions.
ERR_te cbuf_read(CBUF_HANDLE_ts *cbuf_handle, uint8_t *output_buf_o)
Reads all available data from the circular buffer into an output buffer.
Definition cbuf.c:22
ERR_te cbuf_len(CBUF_HANDLE_ts const *cbuf_handle, uint8_t *len_o)
Returns the number of bytes currently stored in the circular buffer.
Definition cbuf.c:61
ERR_te cbuf_write(CBUF_HANDLE_ts *cbuf_handle, uint8_t *input_buf, uint32_t input_len)
Writes data from an input buffer into the circular buffer.
Definition cbuf.c:41
ERR_te
Standard return type used by all public API functions.
Definition err.h:35
Handle representing a circular buffer instance.
Definition cbuf.h:60
uint8_t size
Definition cbuf.h:65
uint8_t * ptr
Definition cbuf.h:62
uint8_t write_position
Definition cbuf.h:71
uint8_t read_position
Definition cbuf.h:68