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@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- 170:e95d10626187
- Child:
- 172:65be27845400
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 156:ff21514d8981 | 1 | /* mbed Microcontroller Library |
AnnaBridge | 156:ff21514d8981 | 2 | * Copyright (c) 2015 ARM Limited |
AnnaBridge | 156:ff21514d8981 | 3 | * |
AnnaBridge | 156:ff21514d8981 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
AnnaBridge | 156:ff21514d8981 | 5 | * you may not use this file except in compliance with the License. |
AnnaBridge | 156:ff21514d8981 | 6 | * You may obtain a copy of the License at |
AnnaBridge | 156:ff21514d8981 | 7 | * |
AnnaBridge | 156:ff21514d8981 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
AnnaBridge | 156:ff21514d8981 | 9 | * |
AnnaBridge | 156:ff21514d8981 | 10 | * Unless required by applicable law or agreed to in writing, software |
AnnaBridge | 156:ff21514d8981 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
AnnaBridge | 156:ff21514d8981 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
AnnaBridge | 156:ff21514d8981 | 13 | * See the License for the specific language governing permissions and |
AnnaBridge | 156:ff21514d8981 | 14 | * limitations under the License. |
AnnaBridge | 156:ff21514d8981 | 15 | */ |
AnnaBridge | 156:ff21514d8981 | 16 | #ifndef MBED_CIRCULARBUFFER_H |
AnnaBridge | 156:ff21514d8981 | 17 | #define MBED_CIRCULARBUFFER_H |
AnnaBridge | 156:ff21514d8981 | 18 | |
AnnaBridge | 156:ff21514d8981 | 19 | #include "platform/mbed_critical.h" |
AnnaBridge | 165:d1b4690b3f8b | 20 | #include "platform/mbed_assert.h" |
AnnaBridge | 156:ff21514d8981 | 21 | |
AnnaBridge | 156:ff21514d8981 | 22 | namespace mbed { |
AnnaBridge | 165:d1b4690b3f8b | 23 | |
AnnaBridge | 165:d1b4690b3f8b | 24 | namespace internal { |
AnnaBridge | 165:d1b4690b3f8b | 25 | /* Detect if CounterType of the Circular buffer is of unsigned type. */ |
AnnaBridge | 165:d1b4690b3f8b | 26 | template<typename T> |
AnnaBridge | 170:e95d10626187 | 27 | struct is_unsigned { |
AnnaBridge | 170:e95d10626187 | 28 | static const bool value = false; |
AnnaBridge | 170:e95d10626187 | 29 | }; |
AnnaBridge | 165:d1b4690b3f8b | 30 | template<> |
AnnaBridge | 170:e95d10626187 | 31 | struct is_unsigned<unsigned char> { |
AnnaBridge | 170:e95d10626187 | 32 | static const bool value = true; |
AnnaBridge | 170:e95d10626187 | 33 | }; |
AnnaBridge | 165:d1b4690b3f8b | 34 | template<> |
AnnaBridge | 170:e95d10626187 | 35 | struct is_unsigned<unsigned short> { |
AnnaBridge | 170:e95d10626187 | 36 | static const bool value = true; |
AnnaBridge | 170:e95d10626187 | 37 | }; |
AnnaBridge | 165:d1b4690b3f8b | 38 | template<> |
AnnaBridge | 170:e95d10626187 | 39 | struct is_unsigned<unsigned int> { |
AnnaBridge | 170:e95d10626187 | 40 | static const bool value = true; |
AnnaBridge | 170:e95d10626187 | 41 | }; |
AnnaBridge | 165:d1b4690b3f8b | 42 | template<> |
AnnaBridge | 170:e95d10626187 | 43 | struct is_unsigned<unsigned long> { |
AnnaBridge | 170:e95d10626187 | 44 | static const bool value = true; |
AnnaBridge | 170:e95d10626187 | 45 | }; |
AnnaBridge | 165:d1b4690b3f8b | 46 | template<> |
AnnaBridge | 170:e95d10626187 | 47 | struct is_unsigned<unsigned long long> { |
AnnaBridge | 170:e95d10626187 | 48 | static const bool value = true; |
AnnaBridge | 170:e95d10626187 | 49 | }; |
AnnaBridge | 165:d1b4690b3f8b | 50 | }; |
AnnaBridge | 165:d1b4690b3f8b | 51 | |
AnnaBridge | 156:ff21514d8981 | 52 | /** \addtogroup platform */ |
AnnaBridge | 158:1c57384330a6 | 53 | /** @{*/ |
AnnaBridge | 158:1c57384330a6 | 54 | /** |
AnnaBridge | 158:1c57384330a6 | 55 | * \defgroup platform_CircularBuffer CircularBuffer functions |
AnnaBridge | 158:1c57384330a6 | 56 | * @{ |
AnnaBridge | 158:1c57384330a6 | 57 | */ |
AnnaBridge | 156:ff21514d8981 | 58 | |
AnnaBridge | 156:ff21514d8981 | 59 | /** Templated Circular buffer class |
AnnaBridge | 156:ff21514d8981 | 60 | * |
AnnaBridge | 156:ff21514d8981 | 61 | * @note Synchronization level: Interrupt safe |
AnnaBridge | 165:d1b4690b3f8b | 62 | * @note CounterType must be unsigned and consistent with BufferSize |
AnnaBridge | 156:ff21514d8981 | 63 | */ |
AnnaBridge | 156:ff21514d8981 | 64 | template<typename T, uint32_t BufferSize, typename CounterType = uint32_t> |
AnnaBridge | 156:ff21514d8981 | 65 | class CircularBuffer { |
AnnaBridge | 156:ff21514d8981 | 66 | public: |
AnnaBridge | 170:e95d10626187 | 67 | CircularBuffer() : _head(0), _tail(0), _full(false) |
AnnaBridge | 170:e95d10626187 | 68 | { |
AnnaBridge | 165:d1b4690b3f8b | 69 | MBED_STATIC_ASSERT( |
AnnaBridge | 165:d1b4690b3f8b | 70 | internal::is_unsigned<CounterType>::value, |
AnnaBridge | 165:d1b4690b3f8b | 71 | "CounterType must be unsigned" |
AnnaBridge | 165:d1b4690b3f8b | 72 | ); |
AnnaBridge | 165:d1b4690b3f8b | 73 | |
AnnaBridge | 165:d1b4690b3f8b | 74 | MBED_STATIC_ASSERT( |
AnnaBridge | 165:d1b4690b3f8b | 75 | (sizeof(CounterType) >= sizeof(uint32_t)) || |
AnnaBridge | 165:d1b4690b3f8b | 76 | (BufferSize < (((uint64_t) 1) << (sizeof(CounterType) * 8))), |
AnnaBridge | 165:d1b4690b3f8b | 77 | "Invalid BufferSize for the CounterType" |
AnnaBridge | 165:d1b4690b3f8b | 78 | ); |
AnnaBridge | 156:ff21514d8981 | 79 | } |
AnnaBridge | 156:ff21514d8981 | 80 | |
AnnaBridge | 170:e95d10626187 | 81 | ~CircularBuffer() |
AnnaBridge | 170:e95d10626187 | 82 | { |
AnnaBridge | 156:ff21514d8981 | 83 | } |
AnnaBridge | 156:ff21514d8981 | 84 | |
AnnaBridge | 156:ff21514d8981 | 85 | /** Push the transaction to the buffer. This overwrites the buffer if it's |
AnnaBridge | 156:ff21514d8981 | 86 | * full |
AnnaBridge | 156:ff21514d8981 | 87 | * |
AnnaBridge | 156:ff21514d8981 | 88 | * @param data Data to be pushed to the buffer |
AnnaBridge | 156:ff21514d8981 | 89 | */ |
AnnaBridge | 170:e95d10626187 | 90 | void push(const T &data) |
AnnaBridge | 170:e95d10626187 | 91 | { |
AnnaBridge | 156:ff21514d8981 | 92 | core_util_critical_section_enter(); |
AnnaBridge | 156:ff21514d8981 | 93 | if (full()) { |
AnnaBridge | 156:ff21514d8981 | 94 | _tail++; |
AnnaBridge | 171:3a7713b1edbc | 95 | if (_tail == BufferSize) { |
AnnaBridge | 171:3a7713b1edbc | 96 | _tail = 0; |
AnnaBridge | 171:3a7713b1edbc | 97 | } |
AnnaBridge | 156:ff21514d8981 | 98 | } |
AnnaBridge | 156:ff21514d8981 | 99 | _pool[_head++] = data; |
AnnaBridge | 171:3a7713b1edbc | 100 | if (_head == BufferSize) { |
AnnaBridge | 171:3a7713b1edbc | 101 | _head = 0; |
AnnaBridge | 171:3a7713b1edbc | 102 | } |
AnnaBridge | 156:ff21514d8981 | 103 | if (_head == _tail) { |
AnnaBridge | 156:ff21514d8981 | 104 | _full = true; |
AnnaBridge | 156:ff21514d8981 | 105 | } |
AnnaBridge | 156:ff21514d8981 | 106 | core_util_critical_section_exit(); |
AnnaBridge | 156:ff21514d8981 | 107 | } |
AnnaBridge | 156:ff21514d8981 | 108 | |
AnnaBridge | 156:ff21514d8981 | 109 | /** Pop the transaction from the buffer |
AnnaBridge | 156:ff21514d8981 | 110 | * |
Anna Bridge |
169:a7c7b631e539 | 111 | * @param data Data to be popped from the buffer |
AnnaBridge | 156:ff21514d8981 | 112 | * @return True if the buffer is not empty and data contains a transaction, false otherwise |
AnnaBridge | 156:ff21514d8981 | 113 | */ |
AnnaBridge | 170:e95d10626187 | 114 | bool pop(T &data) |
AnnaBridge | 170:e95d10626187 | 115 | { |
AnnaBridge | 156:ff21514d8981 | 116 | bool data_popped = false; |
AnnaBridge | 156:ff21514d8981 | 117 | core_util_critical_section_enter(); |
AnnaBridge | 156:ff21514d8981 | 118 | if (!empty()) { |
AnnaBridge | 156:ff21514d8981 | 119 | data = _pool[_tail++]; |
AnnaBridge | 171:3a7713b1edbc | 120 | if (_tail == BufferSize) { |
AnnaBridge | 171:3a7713b1edbc | 121 | _tail = 0; |
AnnaBridge | 171:3a7713b1edbc | 122 | } |
AnnaBridge | 156:ff21514d8981 | 123 | _full = false; |
AnnaBridge | 156:ff21514d8981 | 124 | data_popped = true; |
AnnaBridge | 156:ff21514d8981 | 125 | } |
AnnaBridge | 156:ff21514d8981 | 126 | core_util_critical_section_exit(); |
AnnaBridge | 156:ff21514d8981 | 127 | return data_popped; |
AnnaBridge | 156:ff21514d8981 | 128 | } |
AnnaBridge | 156:ff21514d8981 | 129 | |
AnnaBridge | 156:ff21514d8981 | 130 | /** Check if the buffer is empty |
AnnaBridge | 156:ff21514d8981 | 131 | * |
AnnaBridge | 156:ff21514d8981 | 132 | * @return True if the buffer is empty, false if not |
AnnaBridge | 156:ff21514d8981 | 133 | */ |
AnnaBridge | 170:e95d10626187 | 134 | bool empty() const |
AnnaBridge | 170:e95d10626187 | 135 | { |
AnnaBridge | 156:ff21514d8981 | 136 | core_util_critical_section_enter(); |
AnnaBridge | 156:ff21514d8981 | 137 | bool is_empty = (_head == _tail) && !_full; |
AnnaBridge | 156:ff21514d8981 | 138 | core_util_critical_section_exit(); |
AnnaBridge | 156:ff21514d8981 | 139 | return is_empty; |
AnnaBridge | 156:ff21514d8981 | 140 | } |
AnnaBridge | 156:ff21514d8981 | 141 | |
AnnaBridge | 156:ff21514d8981 | 142 | /** Check if the buffer is full |
AnnaBridge | 156:ff21514d8981 | 143 | * |
AnnaBridge | 156:ff21514d8981 | 144 | * @return True if the buffer is full, false if not |
AnnaBridge | 156:ff21514d8981 | 145 | */ |
AnnaBridge | 170:e95d10626187 | 146 | bool full() const |
AnnaBridge | 170:e95d10626187 | 147 | { |
AnnaBridge | 156:ff21514d8981 | 148 | core_util_critical_section_enter(); |
AnnaBridge | 156:ff21514d8981 | 149 | bool full = _full; |
AnnaBridge | 156:ff21514d8981 | 150 | core_util_critical_section_exit(); |
AnnaBridge | 156:ff21514d8981 | 151 | return full; |
AnnaBridge | 156:ff21514d8981 | 152 | } |
AnnaBridge | 156:ff21514d8981 | 153 | |
AnnaBridge | 156:ff21514d8981 | 154 | /** Reset the buffer |
AnnaBridge | 156:ff21514d8981 | 155 | * |
AnnaBridge | 156:ff21514d8981 | 156 | */ |
AnnaBridge | 170:e95d10626187 | 157 | void reset() |
AnnaBridge | 170:e95d10626187 | 158 | { |
AnnaBridge | 156:ff21514d8981 | 159 | core_util_critical_section_enter(); |
AnnaBridge | 156:ff21514d8981 | 160 | _head = 0; |
AnnaBridge | 156:ff21514d8981 | 161 | _tail = 0; |
AnnaBridge | 156:ff21514d8981 | 162 | _full = false; |
AnnaBridge | 156:ff21514d8981 | 163 | core_util_critical_section_exit(); |
AnnaBridge | 156:ff21514d8981 | 164 | } |
AnnaBridge | 156:ff21514d8981 | 165 | |
Anna Bridge |
160:5571c4ff569f | 166 | /** Get the number of elements currently stored in the circular_buffer */ |
AnnaBridge | 170:e95d10626187 | 167 | CounterType size() const |
AnnaBridge | 170:e95d10626187 | 168 | { |
Anna Bridge |
160:5571c4ff569f | 169 | core_util_critical_section_enter(); |
Anna Bridge |
160:5571c4ff569f | 170 | CounterType elements; |
Anna Bridge |
160:5571c4ff569f | 171 | if (!_full) { |
Anna Bridge |
160:5571c4ff569f | 172 | if (_head < _tail) { |
Anna Bridge |
160:5571c4ff569f | 173 | elements = BufferSize + _head - _tail; |
Anna Bridge |
160:5571c4ff569f | 174 | } else { |
Anna Bridge |
160:5571c4ff569f | 175 | elements = _head - _tail; |
Anna Bridge |
160:5571c4ff569f | 176 | } |
Anna Bridge |
160:5571c4ff569f | 177 | } else { |
Anna Bridge |
160:5571c4ff569f | 178 | elements = BufferSize; |
Anna Bridge |
160:5571c4ff569f | 179 | } |
Anna Bridge |
160:5571c4ff569f | 180 | core_util_critical_section_exit(); |
Anna Bridge |
160:5571c4ff569f | 181 | return elements; |
Anna Bridge |
160:5571c4ff569f | 182 | } |
Anna Bridge |
169:a7c7b631e539 | 183 | |
Anna Bridge |
169:a7c7b631e539 | 184 | /** Peek into circular buffer without popping |
Anna Bridge |
169:a7c7b631e539 | 185 | * |
Anna Bridge |
169:a7c7b631e539 | 186 | * @param data Data to be peeked from the buffer |
Anna Bridge |
169:a7c7b631e539 | 187 | * @return True if the buffer is not empty and data contains a transaction, false otherwise |
Anna Bridge |
169:a7c7b631e539 | 188 | */ |
AnnaBridge | 170:e95d10626187 | 189 | bool peek(T &data) const |
AnnaBridge | 170:e95d10626187 | 190 | { |
Anna Bridge |
169:a7c7b631e539 | 191 | bool data_updated = false; |
Anna Bridge |
169:a7c7b631e539 | 192 | core_util_critical_section_enter(); |
Anna Bridge |
169:a7c7b631e539 | 193 | if (!empty()) { |
Anna Bridge |
169:a7c7b631e539 | 194 | data = _pool[_tail]; |
Anna Bridge |
169:a7c7b631e539 | 195 | data_updated = true; |
Anna Bridge |
169:a7c7b631e539 | 196 | } |
Anna Bridge |
169:a7c7b631e539 | 197 | core_util_critical_section_exit(); |
Anna Bridge |
169:a7c7b631e539 | 198 | return data_updated; |
Anna Bridge |
169:a7c7b631e539 | 199 | } |
AnnaBridge | 170:e95d10626187 | 200 | |
AnnaBridge | 156:ff21514d8981 | 201 | private: |
AnnaBridge | 156:ff21514d8981 | 202 | T _pool[BufferSize]; |
AnnaBridge | 171:3a7713b1edbc | 203 | CounterType _head; |
AnnaBridge | 171:3a7713b1edbc | 204 | CounterType _tail; |
AnnaBridge | 171:3a7713b1edbc | 205 | bool _full; |
AnnaBridge | 156:ff21514d8981 | 206 | }; |
AnnaBridge | 156:ff21514d8981 | 207 | |
AnnaBridge | 158:1c57384330a6 | 208 | /**@}*/ |
AnnaBridge | 158:1c57384330a6 | 209 | |
AnnaBridge | 158:1c57384330a6 | 210 | /**@}*/ |
AnnaBridge | 158:1c57384330a6 | 211 | |
AnnaBridge | 156:ff21514d8981 | 212 | } |
AnnaBridge | 156:ff21514d8981 | 213 | |
AnnaBridge | 156:ff21514d8981 | 214 | #endif |