Jonne Valola / PokittoLib Featured

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

Dependents:   YATTT sd_map_test cPong SnowDemo ... more

PokittoLib

Library for programming Pokitto hardware

How to Use

  1. Import this library to online compiler (see button "import" on the right hand side
  2. DO NOT import mbed-src anymore, a better version is now included inside PokittoLib
  3. Change My_settings.h according to your project
  4. Start coding!

mbed-pokitto/api/CircularBuffer.h@71:531419862202, 2019-12-25 (annotated)

Committer:
Pokitto
Date:
Wed Dec 25 23:59:52 2019 +0000
Revision:
71:531419862202
Parent:
5:ea7377f3d1af 
Changed Mode2 C++ refresh code (graphical errors)

Who changed what in which revision?

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