Gan likun / The prosthetic control

The prosthetic control（MIT）

platform/CircularBuffer.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

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