Gan likun / mbed-dev11

platform/CircularBuffer.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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