mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/CircularBuffer.h@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
145:64910690c574 
Release 147 of the mbed library.

Who changed what in which revision?

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