Point Labs / USBDevice

adds a USB serial port to your design

Dependents:   Example_WatchDog_Timer

USBSerial/CircBuffer.h@51:deafa44182d9, 2015-04-23 (annotated)

Committer:
mbed_official
Date:
Thu Apr 23 08:45:28 2015 +0100
Revision:
51:deafa44182d9
Parent:
14:d495202c90f4
Child:
56:151ba33713ff
Synchronized with git revision 7c4831f300daf357b21e4301785771d48f00e3a6



Full URL: https://github.com/mbedmicro/mbed/commit/7c4831f300daf357b21e4301785771d48f00e3a6/



Changed CircBuffer to take its size as a template parameters for efficientcy.

Who changed what in which revision?

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