summaryrefslogtreecommitdiff
path: root/py/ringbuf.h
diff options
context:
space:
mode:
authorDaniel Pollard <daniel@learnweaver.com>2020-05-12 14:41:28 +1000
committerDaniel Pollard <daniel@learnweaver.com>2020-05-12 14:41:28 +1000
commitee2cb703c83ff1c27675e98ce28f4cc49a33ebb9 (patch)
tree989b08a0d3016ac63e254ae44fcb7385bf9fc020 /py/ringbuf.h
parente947e4eb580e080d37445240ec88610fc1787975 (diff)
parent62b835ad7637c5336f210ab688289dc607bec661 (diff)
merged master
Diffstat (limited to 'py/ringbuf.h')
-rw-r--r--py/ringbuf.h83
1 files changed, 16 insertions, 67 deletions
diff --git a/py/ringbuf.h b/py/ringbuf.h
index 7fc35d266..476bd428f 100644
--- a/py/ringbuf.h
+++ b/py/ringbuf.h
@@ -32,78 +32,27 @@
typedef struct _ringbuf_t {
uint8_t *buf;
- uint16_t size;
- uint16_t iget;
- uint16_t iput;
+ // Allocated size; capacity is one less. Don't reference this directly.
+ uint32_t size;
+ uint32_t iget;
+ uint32_t iput;
} ringbuf_t;
+// Note that the capacity of the buffer is N-1!
+
// Static initialization:
// byte buf_array[N];
// ringbuf_t buf = {buf_array, sizeof(buf_array)};
-// Dynamic initialization. This creates root pointer!
-#define ringbuf_alloc(r, sz, long_lived) \
-{ \
- (r)->buf = gc_alloc(sz, false, long_lived); \
- (r)->size = sz; \
- (r)->iget = (r)->iput = 0; \
-}
-
-static inline int ringbuf_get(ringbuf_t *r) {
- if (r->iget == r->iput) {
- return -1;
- }
- uint8_t v = r->buf[r->iget++];
- if (r->iget >= r->size) {
- r->iget = 0;
- }
- return v;
-}
-
-static inline int ringbuf_put(ringbuf_t *r, uint8_t v) {
- uint32_t iput_new = r->iput + 1;
- if (iput_new >= r->size) {
- iput_new = 0;
- }
- if (iput_new == r->iget) {
- return -1;
- }
- r->buf[r->iput] = v;
- r->iput = iput_new;
- return 0;
-}
-
-static inline uint16_t ringbuf_count(ringbuf_t *r)
-{
- volatile int count = r->iput - r->iget;
- if ( count < 0 ) {
- count += r->size;
- }
-
- return (uint16_t) count;
-}
-
-static inline void ringbuf_clear(ringbuf_t *r)
-{
- r->iput = r->iget = 0;
-}
-
-// will overwrite old data
-static inline void ringbuf_put_n(ringbuf_t* r, uint8_t* buf, uint8_t bufsize)
-{
- for(uint8_t i=0; i < bufsize; i++) {
- if ( ringbuf_put(r, buf[i]) < 0 ) {
- // if full overwrite old data
- (void) ringbuf_get(r);
- ringbuf_put(r, buf[i]);
- }
- }
-}
+bool ringbuf_alloc(ringbuf_t *r, size_t capacity, bool long_lived);
+void ringbuf_free(ringbuf_t *r);
+size_t ringbuf_capacity(ringbuf_t *r);
+int ringbuf_get(ringbuf_t *r);
+int ringbuf_put(ringbuf_t *r, uint8_t v);
+void ringbuf_clear(ringbuf_t *r);
+size_t ringbuf_num_empty(ringbuf_t *r);
+size_t ringbuf_num_filled(ringbuf_t *r);
+size_t ringbuf_put_n(ringbuf_t* r, uint8_t* buf, size_t bufsize);
+size_t ringbuf_get_n(ringbuf_t* r, uint8_t* buf, size_t bufsize);
-static inline void ringbuf_get_n(ringbuf_t* r, uint8_t* buf, uint8_t bufsize)
-{
- for(uint8_t i=0; i < bufsize; i++) {
- buf[i] = ringbuf_get(r);
- }
-}
#endif // MICROPY_INCLUDED_PY_RINGBUF_H