Gan likun / mbed-dev

00

platform/CircularBuffer.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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