Patrick Pollet / USBDevice

usb device

USBSerial/CircBuffer.h@0:c1e89c49eae5, 2022-05-14 (annotated)

Committer:
ppo
Date:
Sat May 14 17:24:10 2022 +0000
Revision:
0:c1e89c49eae5
commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ppo 0:c1e89c49eae5 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
ppo 0:c1e89c49eae5 2 *
ppo 0:c1e89c49eae5 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
ppo 0:c1e89c49eae5 4 * and associated documentation files (the "Software"), to deal in the Software without
ppo 0:c1e89c49eae5 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
ppo 0:c1e89c49eae5 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
ppo 0:c1e89c49eae5 7 * Software is furnished to do so, subject to the following conditions:
ppo 0:c1e89c49eae5 8 *
ppo 0:c1e89c49eae5 9 * The above copyright notice and this permission notice shall be included in all copies or
ppo 0:c1e89c49eae5 10 * substantial portions of the Software.
ppo 0:c1e89c49eae5 11 *
ppo 0:c1e89c49eae5 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
ppo 0:c1e89c49eae5 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
ppo 0:c1e89c49eae5 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
ppo 0:c1e89c49eae5 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ppo 0:c1e89c49eae5 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
ppo 0:c1e89c49eae5 17 */
ppo 0:c1e89c49eae5 18
ppo 0:c1e89c49eae5 19 #ifndef CIRCBUFFER_H
ppo 0:c1e89c49eae5 20 #define CIRCBUFFER_H
ppo 0:c1e89c49eae5 21
ppo 0:c1e89c49eae5 22 template <class T>
ppo 0:c1e89c49eae5 23 class CircBuffer {
ppo 0:c1e89c49eae5 24 public:
ppo 0:c1e89c49eae5 25 CircBuffer(int length) {
ppo 0:c1e89c49eae5 26 write = 0;
ppo 0:c1e89c49eae5 27 read = 0;
ppo 0:c1e89c49eae5 28 size = length + 1;
ppo 0:c1e89c49eae5 29 buf = (T *)malloc(size * sizeof(T));
ppo 0:c1e89c49eae5 30 };
ppo 0:c1e89c49eae5 31
ppo 0:c1e89c49eae5 32 bool isFull() {
ppo 0:c1e89c49eae5 33 return ((write + 1) % size == read);
ppo 0:c1e89c49eae5 34 };
ppo 0:c1e89c49eae5 35
ppo 0:c1e89c49eae5 36 bool isEmpty() {
ppo 0:c1e89c49eae5 37 return (read == write);
ppo 0:c1e89c49eae5 38 };
ppo 0:c1e89c49eae5 39
ppo 0:c1e89c49eae5 40 void queue(T k) {
ppo 0:c1e89c49eae5 41 if (isFull()) {
ppo 0:c1e89c49eae5 42 read++;
ppo 0:c1e89c49eae5 43 read %= size;
ppo 0:c1e89c49eae5 44 }
ppo 0:c1e89c49eae5 45 buf[write++] = k;
ppo 0:c1e89c49eae5 46 write %= size;
ppo 0:c1e89c49eae5 47 }
ppo 0:c1e89c49eae5 48
ppo 0:c1e89c49eae5 49 uint16_t available() {
ppo 0:c1e89c49eae5 50 return (write >= read) ? write - read : size - read + write;
ppo 0:c1e89c49eae5 51 };
ppo 0:c1e89c49eae5 52
ppo 0:c1e89c49eae5 53 bool dequeue(T * c) {
ppo 0:c1e89c49eae5 54 bool empty = isEmpty();
ppo 0:c1e89c49eae5 55 if (!empty) {
ppo 0:c1e89c49eae5 56 *c = buf[read++];
ppo 0:c1e89c49eae5 57 read %= size;
ppo 0:c1e89c49eae5 58 }
ppo 0:c1e89c49eae5 59 return(!empty);
ppo 0:c1e89c49eae5 60 };
ppo 0:c1e89c49eae5 61
ppo 0:c1e89c49eae5 62 private:
ppo 0:c1e89c49eae5 63 volatile uint16_t write;
ppo 0:c1e89c49eae5 64 volatile uint16_t read;
ppo 0:c1e89c49eae5 65 uint16_t size;
ppo 0:c1e89c49eae5 66 T * buf;
ppo 0:c1e89c49eae5 67 };
ppo 0:c1e89c49eae5 68
ppo 0:c1e89c49eae5 69 #endif