Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/platform/CircularBuffer.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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