Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
USBSerialLib/USBSerial/CircBuffer.h@1:6e512faaa17c, 2020-02-21 (annotated)
- Committer:
- mjoun
- Date:
- Fri Feb 21 20:40:56 2020 +0000
- Revision:
- 1:6e512faaa17c
works
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| mjoun | 1:6e512faaa17c | 1 | /* Copyright (c) 2010-2011 mbed.org, MIT License |
| mjoun | 1:6e512faaa17c | 2 | * |
| mjoun | 1:6e512faaa17c | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
| mjoun | 1:6e512faaa17c | 4 | * and associated documentation files (the "Software"), to deal in the Software without |
| mjoun | 1:6e512faaa17c | 5 | * restriction, including without limitation the rights to use, copy, modify, merge, publish, |
| mjoun | 1:6e512faaa17c | 6 | * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the |
| mjoun | 1:6e512faaa17c | 7 | * Software is furnished to do so, subject to the following conditions: |
| mjoun | 1:6e512faaa17c | 8 | * |
| mjoun | 1:6e512faaa17c | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
| mjoun | 1:6e512faaa17c | 10 | * substantial portions of the Software. |
| mjoun | 1:6e512faaa17c | 11 | * |
| mjoun | 1:6e512faaa17c | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
| mjoun | 1:6e512faaa17c | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
| mjoun | 1:6e512faaa17c | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
| mjoun | 1:6e512faaa17c | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| mjoun | 1:6e512faaa17c | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| mjoun | 1:6e512faaa17c | 17 | */ |
| mjoun | 1:6e512faaa17c | 18 | |
| mjoun | 1:6e512faaa17c | 19 | #ifndef CIRCBUFFER_H |
| mjoun | 1:6e512faaa17c | 20 | #define CIRCBUFFER_H |
| mjoun | 1:6e512faaa17c | 21 | |
| mjoun | 1:6e512faaa17c | 22 | template <class T, int Size> |
| mjoun | 1:6e512faaa17c | 23 | class CircBuffer { |
| mjoun | 1:6e512faaa17c | 24 | public: |
| mjoun | 1:6e512faaa17c | 25 | CircBuffer():write(0), read(0){} |
| mjoun | 1:6e512faaa17c | 26 | bool isFull() { |
| mjoun | 1:6e512faaa17c | 27 | return ((write + 1) % size == read); |
| mjoun | 1:6e512faaa17c | 28 | }; |
| mjoun | 1:6e512faaa17c | 29 | |
| mjoun | 1:6e512faaa17c | 30 | bool isEmpty() { |
| mjoun | 1:6e512faaa17c | 31 | return (read == write); |
| mjoun | 1:6e512faaa17c | 32 | }; |
| mjoun | 1:6e512faaa17c | 33 | |
| mjoun | 1:6e512faaa17c | 34 | void queue(T k) { |
| mjoun | 1:6e512faaa17c | 35 | if (isFull()) { |
| mjoun | 1:6e512faaa17c | 36 | read++; |
| mjoun | 1:6e512faaa17c | 37 | read %= size; |
| mjoun | 1:6e512faaa17c | 38 | } |
| mjoun | 1:6e512faaa17c | 39 | buf[write++] = k; |
| mjoun | 1:6e512faaa17c | 40 | write %= size; |
| mjoun | 1:6e512faaa17c | 41 | } |
| mjoun | 1:6e512faaa17c | 42 | |
| mjoun | 1:6e512faaa17c | 43 | uint16_t available() { |
| mjoun | 1:6e512faaa17c | 44 | return (write >= read) ? write - read : size - read + write; |
| mjoun | 1:6e512faaa17c | 45 | }; |
| mjoun | 1:6e512faaa17c | 46 | |
| mjoun | 1:6e512faaa17c | 47 | bool dequeue(T * c) { |
| mjoun | 1:6e512faaa17c | 48 | bool empty = isEmpty(); |
| mjoun | 1:6e512faaa17c | 49 | if (!empty) { |
| mjoun | 1:6e512faaa17c | 50 | *c = buf[read++]; |
| mjoun | 1:6e512faaa17c | 51 | read %= size; |
| mjoun | 1:6e512faaa17c | 52 | } |
| mjoun | 1:6e512faaa17c | 53 | return(!empty); |
| mjoun | 1:6e512faaa17c | 54 | }; |
| mjoun | 1:6e512faaa17c | 55 | |
| mjoun | 1:6e512faaa17c | 56 | private: |
| mjoun | 1:6e512faaa17c | 57 | volatile uint16_t write; |
| mjoun | 1:6e512faaa17c | 58 | volatile uint16_t read; |
| mjoun | 1:6e512faaa17c | 59 | static const int size = Size+1; //a modern optimizer should be able to remove this so it uses no ram. |
| mjoun | 1:6e512faaa17c | 60 | T buf[Size+1]; |
| mjoun | 1:6e512faaa17c | 61 | }; |
| mjoun | 1:6e512faaa17c | 62 | |
| mjoun | 1:6e512faaa17c | 63 | #endif |
