MacroRat / MouseCode

Mouse code for the MacroRat

Dependencies:   ITG3200 QEI

mbed-dev/platform/CircularBuffer.h@46:b156ef445742, 2017-06-03 (annotated)

Committer:
sahilmgandhi
Date:
Sat Jun 03 00:22:44 2017 +0000
Revision:
46:b156ef445742
Parent:
18:6a4db94011d3 
Final code for internal battlebot competition.

Who changed what in which revision?

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