8000 py/ringbuf: Implement put_bytes/get_bytes functions. · micropython/micropython@0cfb346 · GitHub
[go: up one dir, main page]
Skip to content

Commit 0cfb346

Browse files
glenn20glenn20
committed
py/ringbuf: Implement put_bytes/get_bytes functions.
1 parent 116d2b7 commit 0cfb346

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

‎py/ringbuf.c

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2424
* THE SOFTWARE.
2525
*/
26+
#include <string.h>
27+
2628
#include "ringbuf.h"
2729

2830
int ringbuf_get16(ringbuf_t *r) {
@@ -71,3 +73,47 @@ int ringbuf_put16(ringbuf_t *r, uint16_t v) {
7173
r->iput = iput_b;
7274
return 0;
7375
}
76+
77+
// Returns:
78+
// 0: Success
79+
// -1: Not enough data available to complete read (try again later)
80+
// -2: Requested read is larger than buffer - will never succeed
81+
int ringbuf_get_bytes(ringbuf_t *r, uint8_t *data, size_t data_len) {
82+
if (ringbuf_avail(r) < data_len) {
83+
return (r->size <= data_len) ? -2 : -1;
84+
}
85+
uint32_t iget = r->iget;
86+
uint32_t iget_a = (iget + data_len) % r->size;
87+
uint8_t *datap = data;
88+
if (iget_a < iget) {
89+
// Copy part of the data from the space left at the end of the buffer
90+
memcpy(datap, r->buf + iget, r->size - iget);
91+
datap += (r->size - iget);
92+
iget = 0;
93+
}
94+
memcpy(datap, r->buf + iget, iget_a - iget);
95+
r->iget = iget_a;
96+
return 0;
97+
}
98+
99+
// Returns:
100+
// 0: Success
101+
// -1: Not enough free space available to complete write (try again later)
102+
// -2: Requested write is larger than buffer - will never succeed
103+
int ringbuf_put_bytes(ringbuf_t *r, const uint8_t *data, size_t data_len) {
104+
if (ringbuf_free(r) < data_len) {
105+
return (r->size <= data_len) ? -2 : -1;
106+
}
107+
uint32_t iput = r->iput;
108+
uint32_t iput_a = (iput + data_len) % r->size;
109+
const uint8_t *datap = data;
110+
if (iput_a < iput) {
111+
// Copy part of the data to the end of the buffer
112+
memcpy(r->buf + iput, datap, r->size - iput);
113+
datap += (r->size - iput);
114+
iput = 0;
115+
}
116+
memcpy(r->buf + iput, datap, iput_a - iput);
117+
r->iput = iput_a;
118+
return 0;
119+
}

‎py/ringbuf.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,7 @@ int ringbuf_get16(ringbuf_t *r);
9696
int ringbuf_peek16(ringbuf_t *r);
9797
int ringbuf_put16(ringbuf_t *r, uint16_t v);
9898

99+
int ringbuf_get_bytes(ringbuf_t *r, uint8_t *data, size_t data_len);
100+
int ringbuf_put_bytes(ringbuf_t *r, const uint8_t *data, size_t data_len);
101+
99102
#endif // MICROPY_INCLUDED_PY_RINGBUF_H

0 commit comments

Comments
 (0)
0