Donatien Garnier / VodafoneK3770LibBeta

The beta version of the Vodafone K3770 dongle driver

This library is deprecated. Please use the newest production branch of the library from https://mbed.org/users/mbed_official/code/VodafoneUSBModem/

NetworkingCoreLib/main/core/MtxCircBuffer.h@1:4b33ffe61bfa, 2012-11-01 (annotated)

Committer:
donatien
Date:
Thu Nov 01 10:03:50 2012 +0000
Revision:
1:4b33ffe61bfa
Parent:
0:0ac66acdfdc0 
Deprecating library, pointing out at new one

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:0ac66acdfdc0 1 /* MtxCircBuf.h */
donatien 0:0ac66acdfdc0 2 /*
donatien 0:0ac66acdfdc0 3 Copyright (C) 2012 ARM Limited.
donatien 0:0ac66acdfdc0 4
donatien 0:0ac66acdfdc0 5 Permission is hereby granted, free of charge, to any person obtaining a copy of
donatien 0:0ac66acdfdc0 6 this software and associated documentation files (the "Software"), to deal in
donatien 0:0ac66acdfdc0 7 the Software without restriction, including without limitation the rights to
donatien 0:0ac66acdfdc0 8 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
donatien 0:0ac66acdfdc0 9 of the Software, and to permit persons to whom the Software is furnished to do
donatien 0:0ac66acdfdc0 10 so, subject to the following conditions:
donatien 0:0ac66acdfdc0 11
donatien 0:0ac66acdfdc0 12 The above copyright notice and this permission notice shall be included in all
donatien 0:0ac66acdfdc0 13 copies or substantial portions of the Software.
donatien 0:0ac66acdfdc0 14
donatien 0:0ac66acdfdc0 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
donatien 0:0ac66acdfdc0 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
donatien 0:0ac66acdfdc0 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
donatien 0:0ac66acdfdc0 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
donatien 0:0ac66acdfdc0 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 0:0ac66acdfdc0 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
donatien 0:0ac66acdfdc0 21 SOFTWARE.
donatien 0:0ac66acdfdc0 22 */
donatien 0:0ac66acdfdc0 23
donatien 0:0ac66acdfdc0 24 #ifndef MTXCIRCBUFFER_H
donatien 0:0ac66acdfdc0 25 #define MTXCIRCBUFFER_H
donatien 0:0ac66acdfdc0 26
donatien 0:0ac66acdfdc0 27 #include "fwk.h"
donatien 0:0ac66acdfdc0 28
donatien 0:0ac66acdfdc0 29 #include "rtos.h"
donatien 0:0ac66acdfdc0 30
donatien 0:0ac66acdfdc0 31 //Mutex protected circualr buffer
donatien 0:0ac66acdfdc0 32 template<typename T, int size>
donatien 0:0ac66acdfdc0 33 class MtxCircBuffer
donatien 0:0ac66acdfdc0 34 {
donatien 0:0ac66acdfdc0 35 public:
donatien 0:0ac66acdfdc0 36 MtxCircBuffer() //:
donatien 0:0ac66acdfdc0 37 //mtx()
donatien 0:0ac66acdfdc0 38 {
donatien 0:0ac66acdfdc0 39 write = 0;
donatien 0:0ac66acdfdc0 40 read = 0;
donatien 0:0ac66acdfdc0 41 }
donatien 0:0ac66acdfdc0 42
donatien 0:0ac66acdfdc0 43 bool isFull()
donatien 0:0ac66acdfdc0 44 {
donatien 0:0ac66acdfdc0 45 mtx.lock();
donatien 0:0ac66acdfdc0 46 bool r = (((write + 1) % size) == read);
donatien 0:0ac66acdfdc0 47 mtx.unlock();
donatien 0:0ac66acdfdc0 48 return r;
donatien 0:0ac66acdfdc0 49 }
donatien 0:0ac66acdfdc0 50
donatien 0:0ac66acdfdc0 51 bool isEmpty()
donatien 0:0ac66acdfdc0 52 {
donatien 0:0ac66acdfdc0 53 mtx.lock();
donatien 0:0ac66acdfdc0 54 bool r = (read == write);
donatien 0:0ac66acdfdc0 55 mtx.unlock();
donatien 0:0ac66acdfdc0 56 return r;
donatien 0:0ac66acdfdc0 57 }
donatien 0:0ac66acdfdc0 58
donatien 0:0ac66acdfdc0 59 void queue(T k)
donatien 0:0ac66acdfdc0 60 {
donatien 0:0ac66acdfdc0 61 mtx.lock();
donatien 0:0ac66acdfdc0 62 while (((write + 1) % size) == read) //if (isFull())
donatien 0:0ac66acdfdc0 63 {
donatien 0:0ac66acdfdc0 64 /*while((((write + 1) % size) == read))
donatien 0:0ac66acdfdc0 65 {*/
donatien 0:0ac66acdfdc0 66 mtx.unlock();
donatien 0:0ac66acdfdc0 67 Thread::wait(10);
donatien 0:0ac66acdfdc0 68 mtx.lock();
donatien 0:0ac66acdfdc0 69 /*}*/
donatien 0:0ac66acdfdc0 70 //read++;
donatien 0:0ac66acdfdc0 71 //read %= size;
donatien 0:0ac66acdfdc0 72 }
donatien 0:0ac66acdfdc0 73 buf[write++] = k;
donatien 0:0ac66acdfdc0 74 write %= size;
donatien 0:0ac66acdfdc0 75 mtx.unlock();
donatien 0:0ac66acdfdc0 76 }
donatien 0:0ac66acdfdc0 77
donatien 0:0ac66acdfdc0 78 uint16_t available()
donatien 0:0ac66acdfdc0 79 {
donatien 0:0ac66acdfdc0 80 mtx.lock();
donatien 0:0ac66acdfdc0 81 uint16_t a = (write >= read) ? (write - read) : (size - read + write);
donatien 0:0ac66acdfdc0 82 mtx.unlock();
donatien 0:0ac66acdfdc0 83 return a;
donatien 0:0ac66acdfdc0 84 }
donatien 0:0ac66acdfdc0 85
donatien 0:0ac66acdfdc0 86 bool dequeue(T * c)
donatien 0:0ac66acdfdc0 87 {
donatien 0:0ac66acdfdc0 88 mtx.lock();
donatien 0:0ac66acdfdc0 89 bool empty = (read == write);
donatien 0:0ac66acdfdc0 90 if (!empty)
donatien 0:0ac66acdfdc0 91 {
donatien 0:0ac66acdfdc0 92 *c = buf[read++];
donatien 0:0ac66acdfdc0 93 read %= size;
donatien 0:0ac66acdfdc0 94 }
donatien 0:0ac66acdfdc0 95 mtx.unlock();
donatien 0:0ac66acdfdc0 96 return (!empty);
donatien 0:0ac66acdfdc0 97 }
donatien 0:0ac66acdfdc0 98
donatien 0:0ac66acdfdc0 99 private:
donatien 0:0ac66acdfdc0 100 volatile uint16_t write;
donatien 0:0ac66acdfdc0 101 volatile uint16_t read;
donatien 0:0ac66acdfdc0 102 volatile T buf[size];
donatien 0:0ac66acdfdc0 103 Mutex mtx;
donatien 0:0ac66acdfdc0 104 };
donatien 0:0ac66acdfdc0 105
donatien 0:0ac66acdfdc0 106 #endif
donatien 0:0ac66acdfdc0 107