Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

CircularBuffer.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jhon309 0:ac8863619623 1 /* mbed Microcontroller Library
jhon309 0:ac8863619623 2 * Copyright (c) 2015 ARM Limited
jhon309 0:ac8863619623 3 *
jhon309 0:ac8863619623 4 * Licensed under the Apache License, Version 2.0 (the "License");
jhon309 0:ac8863619623 5 * you may not use this file except in compliance with the License.
jhon309 0:ac8863619623 6 * You may obtain a copy of the License at
jhon309 0:ac8863619623 7 *
jhon309 0:ac8863619623 8 * http://www.apache.org/licenses/LICENSE-2.0
jhon309 0:ac8863619623 9 *
jhon309 0:ac8863619623 10 * Unless required by applicable law or agreed to in writing, software
jhon309 0:ac8863619623 11 * distributed under the License is distributed on an "AS IS" BASIS,
jhon309 0:ac8863619623 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jhon309 0:ac8863619623 13 * See the License for the specific language governing permissions and
jhon309 0:ac8863619623 14 * limitations under the License.
jhon309 0:ac8863619623 15 */
jhon309 0:ac8863619623 16 #ifndef MBED_CIRCULARBUFFER_H
jhon309 0:ac8863619623 17 #define MBED_CIRCULARBUFFER_H
jhon309 0:ac8863619623 18
jhon309 0:ac8863619623 19 namespace mbed {
jhon309 0:ac8863619623 20
jhon309 0:ac8863619623 21 /** Templated Circular buffer class
jhon309 0:ac8863619623 22 */
jhon309 0:ac8863619623 23 template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
jhon309 0:ac8863619623 24 class CircularBuffer {
jhon309 0:ac8863619623 25 public:
jhon309 0:ac8863619623 26 CircularBuffer() : _head(0), _tail(0), _full(false) {
jhon309 0:ac8863619623 27 }
jhon309 0:ac8863619623 28
jhon309 0:ac8863619623 29 ~CircularBuffer() {
jhon309 0:ac8863619623 30 }
jhon309 0:ac8863619623 31
jhon309 0:ac8863619623 32 /** Push the transaction to the buffer. This overwrites the buffer if it's
jhon309 0:ac8863619623 33 * full
jhon309 0:ac8863619623 34 *
jhon309 0:ac8863619623 35 * @param data Data to be pushed to the buffer
jhon309 0:ac8863619623 36 */
jhon309 0:ac8863619623 37 void push(const T& data) {
jhon309 0:ac8863619623 38 if (full()) {
jhon309 0:ac8863619623 39 _tail++;
jhon309 0:ac8863619623 40 _tail %= BufferSize;
jhon309 0:ac8863619623 41 }
jhon309 0:ac8863619623 42 _pool[_head++] = data;
jhon309 0:ac8863619623 43 _head %= BufferSize;
jhon309 0:ac8863619623 44 if (_head == _tail) {
jhon309 0:ac8863619623 45 _full = true;
jhon309 0:ac8863619623 46 }
jhon309 0:ac8863619623 47 }
jhon309 0:ac8863619623 48
jhon309 0:ac8863619623 49 /** Pop the transaction from the buffer
jhon309 0:ac8863619623 50 *
jhon309 0:ac8863619623 51 * @param data Data to be pushed to the buffer
jhon309 0:ac8863619623 52 * @return True if the buffer is not empty and data contains a transaction, false otherwise
jhon309 0:ac8863619623 53 */
jhon309 0:ac8863619623 54 bool pop(T& data) {
jhon309 0:ac8863619623 55 if (!empty()) {
jhon309 0:ac8863619623 56 data = _pool[_tail++];
jhon309 0:ac8863619623 57 _tail %= BufferSize;
jhon309 0:ac8863619623 58 _full = false;
jhon309 0:ac8863619623 59 return true;
jhon309 0:ac8863619623 60 }
jhon309 0:ac8863619623 61 return false;
jhon309 0:ac8863619623 62 }
jhon309 0:ac8863619623 63
jhon309 0:ac8863619623 64 /** Check if the buffer is empty
jhon309 0:ac8863619623 65 *
jhon309 0:ac8863619623 66 * @return True if the buffer is empty, false if not
jhon309 0:ac8863619623 67 */
jhon309 0:ac8863619623 68 bool empty() {
jhon309 0:ac8863619623 69 return (_head == _tail) && !_full;
jhon309 0:ac8863619623 70 }
jhon309 0:ac8863619623 71
jhon309 0:ac8863619623 72 /** Check if the buffer is full
jhon309 0:ac8863619623 73 *
jhon309 0:ac8863619623 74 * @return True if the buffer is full, false if not
jhon309 0:ac8863619623 75 */
jhon309 0:ac8863619623 76 bool full() {
jhon309 0:ac8863619623 77 return _full;
jhon309 0:ac8863619623 78 }
jhon309 0:ac8863619623 79
jhon309 0:ac8863619623 80 /** Reset the buffer
jhon309 0:ac8863619623 81 *
jhon309 0:ac8863619623 82 */
jhon309 0:ac8863619623 83 void reset() {
jhon309 0:ac8863619623 84 _head = 0;
jhon309 0:ac8863619623 85 _tail = 0;
jhon309 0:ac8863619623 86 _full = false;
jhon309 0:ac8863619623 87 }
jhon309 0:ac8863619623 88
jhon309 0:ac8863619623 89 private:
jhon309 0:ac8863619623 90 T _pool[BufferSize];
jhon309 0:ac8863619623 91 volatile CounterType _head;
jhon309 0:ac8863619623 92 volatile CounterType _tail;
jhon309 0:ac8863619623 93 volatile bool _full;
jhon309 0:ac8863619623 94 };
jhon309 0:ac8863619623 95
jhon309 0:ac8863619623 96 }
jhon309 0:ac8863619623 97
jhon309 0:ac8863619623 98 #endif