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