takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/platform/CircularBuffer.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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