Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: SDFileSystem_Warning_Fixed F746_GUI
mbed_src_STM32F7/api/CircularBuffer.h@0:f62ffd3644bf, 2018-10-21 (annotated)
- Committer:
- MikamiUitOpen
- Date:
- Sun Oct 21 11:29:47 2018 +0000
- Revision:
- 0:f62ffd3644bf
1
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| MikamiUitOpen | 0:f62ffd3644bf | 1 | /* mbed Microcontroller Library |
| MikamiUitOpen | 0:f62ffd3644bf | 2 | * Copyright (c) 2015 ARM Limited |
| MikamiUitOpen | 0:f62ffd3644bf | 3 | * |
| MikamiUitOpen | 0:f62ffd3644bf | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| MikamiUitOpen | 0:f62ffd3644bf | 5 | * you may not use this file except in compliance with the License. |
| MikamiUitOpen | 0:f62ffd3644bf | 6 | * You may obtain a copy of the License at |
| MikamiUitOpen | 0:f62ffd3644bf | 7 | * |
| MikamiUitOpen | 0:f62ffd3644bf | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| MikamiUitOpen | 0:f62ffd3644bf | 9 | * |
| MikamiUitOpen | 0:f62ffd3644bf | 10 | * Unless required by applicable law or agreed to in writing, software |
| MikamiUitOpen | 0:f62ffd3644bf | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| MikamiUitOpen | 0:f62ffd3644bf | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| MikamiUitOpen | 0:f62ffd3644bf | 13 | * See the License for the specific language governing permissions and |
| MikamiUitOpen | 0:f62ffd3644bf | 14 | * limitations under the License. |
| MikamiUitOpen | 0:f62ffd3644bf | 15 | */ |
| MikamiUitOpen | 0:f62ffd3644bf | 16 | #ifndef MBED_CIRCULARBUFFER_H |
| MikamiUitOpen | 0:f62ffd3644bf | 17 | #define MBED_CIRCULARBUFFER_H |
| MikamiUitOpen | 0:f62ffd3644bf | 18 | |
| MikamiUitOpen | 0:f62ffd3644bf | 19 | namespace mbed { |
| MikamiUitOpen | 0:f62ffd3644bf | 20 | |
| MikamiUitOpen | 0:f62ffd3644bf | 21 | /** Templated Circular buffer class |
| MikamiUitOpen | 0:f62ffd3644bf | 22 | */ |
| MikamiUitOpen | 0:f62ffd3644bf | 23 | template<typename T, uint32_t BufferSize, typename CounterType = uint32_t> |
| MikamiUitOpen | 0:f62ffd3644bf | 24 | class CircularBuffer { |
| MikamiUitOpen | 0:f62ffd3644bf | 25 | public: |
| MikamiUitOpen | 0:f62ffd3644bf | 26 | CircularBuffer() : _head(0), _tail(0), _full(false) { |
| MikamiUitOpen | 0:f62ffd3644bf | 27 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 28 | |
| MikamiUitOpen | 0:f62ffd3644bf | 29 | ~CircularBuffer() { |
| MikamiUitOpen | 0:f62ffd3644bf | 30 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 31 | |
| MikamiUitOpen | 0:f62ffd3644bf | 32 | /** Push the transaction to the buffer. This overwrites the buffer if it's |
| MikamiUitOpen | 0:f62ffd3644bf | 33 | * full |
| MikamiUitOpen | 0:f62ffd3644bf | 34 | * |
| MikamiUitOpen | 0:f62ffd3644bf | 35 | * @param data Data to be pushed to the buffer |
| MikamiUitOpen | 0:f62ffd3644bf | 36 | */ |
| MikamiUitOpen | 0:f62ffd3644bf | 37 | void push(const T& data) { |
| MikamiUitOpen | 0:f62ffd3644bf | 38 | if (full()) { |
| MikamiUitOpen | 0:f62ffd3644bf | 39 | _tail++; |
| MikamiUitOpen | 0:f62ffd3644bf | 40 | _tail %= BufferSize; |
| MikamiUitOpen | 0:f62ffd3644bf | 41 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 42 | _pool[_head++] = data; |
| MikamiUitOpen | 0:f62ffd3644bf | 43 | _head %= BufferSize; |
| MikamiUitOpen | 0:f62ffd3644bf | 44 | if (_head == _tail) { |
| MikamiUitOpen | 0:f62ffd3644bf | 45 | _full = true; |
| MikamiUitOpen | 0:f62ffd3644bf | 46 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 47 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 48 | |
| MikamiUitOpen | 0:f62ffd3644bf | 49 | /** Pop the transaction from the buffer |
| MikamiUitOpen | 0:f62ffd3644bf | 50 | * |
| MikamiUitOpen | 0:f62ffd3644bf | 51 | * @param data Data to be pushed to the buffer |
| MikamiUitOpen | 0:f62ffd3644bf | 52 | * @return True if the buffer is not empty and data contains a transaction, false otherwise |
| MikamiUitOpen | 0:f62ffd3644bf | 53 | */ |
| MikamiUitOpen | 0:f62ffd3644bf | 54 | bool pop(T& data) { |
| MikamiUitOpen | 0:f62ffd3644bf | 55 | if (!empty()) { |
| MikamiUitOpen | 0:f62ffd3644bf | 56 | data = _pool[_tail++]; |
| MikamiUitOpen | 0:f62ffd3644bf | 57 | _tail %= BufferSize; |
| MikamiUitOpen | 0:f62ffd3644bf | 58 | _full = false; |
| MikamiUitOpen | 0:f62ffd3644bf | 59 | return true; |
| MikamiUitOpen | 0:f62ffd3644bf | 60 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 61 | return false; |
| MikamiUitOpen | 0:f62ffd3644bf | 62 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 63 | |
| MikamiUitOpen | 0:f62ffd3644bf | 64 | /** Check if the buffer is empty |
| MikamiUitOpen | 0:f62ffd3644bf | 65 | * |
| MikamiUitOpen | 0:f62ffd3644bf | 66 | * @return True if the buffer is empty, false if not |
| MikamiUitOpen | 0:f62ffd3644bf | 67 | */ |
| MikamiUitOpen | 0:f62ffd3644bf | 68 | bool empty() { |
| MikamiUitOpen | 0:f62ffd3644bf | 69 | return (_head == _tail) && !_full; |
| MikamiUitOpen | 0:f62ffd3644bf | 70 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 71 | |
| MikamiUitOpen | 0:f62ffd3644bf | 72 | /** Check if the buffer is full |
| MikamiUitOpen | 0:f62ffd3644bf | 73 | * |
| MikamiUitOpen | 0:f62ffd3644bf | 74 | * @return True if the buffer is full, false if not |
| MikamiUitOpen | 0:f62ffd3644bf | 75 | */ |
| MikamiUitOpen | 0:f62ffd3644bf | 76 | bool full() { |
| MikamiUitOpen | 0:f62ffd3644bf | 77 | return _full; |
| MikamiUitOpen | 0:f62ffd3644bf | 78 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 79 | |
| MikamiUitOpen | 0:f62ffd3644bf | 80 | /** Reset the buffer |
| MikamiUitOpen | 0:f62ffd3644bf | 81 | * |
| MikamiUitOpen | 0:f62ffd3644bf | 82 | */ |
| MikamiUitOpen | 0:f62ffd3644bf | 83 | void reset() { |
| MikamiUitOpen | 0:f62ffd3644bf | 84 | _head = 0; |
| MikamiUitOpen | 0:f62ffd3644bf | 85 | _tail = 0; |
| MikamiUitOpen | 0:f62ffd3644bf | 86 | _full = false; |
| MikamiUitOpen | 0:f62ffd3644bf | 87 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 88 | |
| MikamiUitOpen | 0:f62ffd3644bf | 89 | private: |
| MikamiUitOpen | 0:f62ffd3644bf | 90 | T _pool[BufferSize]; |
| MikamiUitOpen | 0:f62ffd3644bf | 91 | volatile CounterType _head; |
| MikamiUitOpen | 0:f62ffd3644bf | 92 | volatile CounterType _tail; |
| MikamiUitOpen | 0:f62ffd3644bf | 93 | volatile bool _full; |
| MikamiUitOpen | 0:f62ffd3644bf | 94 | }; |
| MikamiUitOpen | 0:f62ffd3644bf | 95 | |
| MikamiUitOpen | 0:f62ffd3644bf | 96 | } |
| MikamiUitOpen | 0:f62ffd3644bf | 97 | |
| MikamiUitOpen | 0:f62ffd3644bf | 98 | #endif |