Ram Gandikota / Mbed OS metronome

FRDM K64F Metronome

easy-connect/esp8266-driver/ESP8266/ATParser/BufferedSerial/Buffer/MyBuffer.h@0:a2cb7295a1f7, 2017-05-14 (annotated)

Committer:
ram54288
Date:
Sun May 14 18:35:07 2017 +0000
Revision:
0:a2cb7295a1f7
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ram54288 0:a2cb7295a1f7 1
ram54288 0:a2cb7295a1f7 2 /**
ram54288 0:a2cb7295a1f7 3 * @file Buffer.h
ram54288 0:a2cb7295a1f7 4 * @brief Software Buffer - Templated Ring Buffer for most data types
ram54288 0:a2cb7295a1f7 5 * @author sam grove
ram54288 0:a2cb7295a1f7 6 * @version 1.0
ram54288 0:a2cb7295a1f7 7 * @see
ram54288 0:a2cb7295a1f7 8 *
ram54288 0:a2cb7295a1f7 9 * Copyright (c) 2013
ram54288 0:a2cb7295a1f7 10 *
ram54288 0:a2cb7295a1f7 11 * Licensed under the Apache License, Version 2.0 (the "License");
ram54288 0:a2cb7295a1f7 12 * you may not use this file except in compliance with the License.
ram54288 0:a2cb7295a1f7 13 * You may obtain a copy of the License at
ram54288 0:a2cb7295a1f7 14 *
ram54288 0:a2cb7295a1f7 15 * http://www.apache.org/licenses/LICENSE-2.0
ram54288 0:a2cb7295a1f7 16 *
ram54288 0:a2cb7295a1f7 17 * Unless required by applicable law or agreed to in writing, software
ram54288 0:a2cb7295a1f7 18 * distributed under the License is distributed on an "AS IS" BASIS,
ram54288 0:a2cb7295a1f7 19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ram54288 0:a2cb7295a1f7 20 * See the License for the specific language governing permissions and
ram54288 0:a2cb7295a1f7 21 * limitations under the License.
ram54288 0:a2cb7295a1f7 22 */
ram54288 0:a2cb7295a1f7 23
ram54288 0:a2cb7295a1f7 24 #ifndef MYBUFFER_H
ram54288 0:a2cb7295a1f7 25 #define MYBUFFER_H
ram54288 0:a2cb7295a1f7 26
ram54288 0:a2cb7295a1f7 27 #include <stdint.h>
ram54288 0:a2cb7295a1f7 28 #include <string.h>
ram54288 0:a2cb7295a1f7 29
ram54288 0:a2cb7295a1f7 30 /** A templated software ring buffer
ram54288 0:a2cb7295a1f7 31 *
ram54288 0:a2cb7295a1f7 32 * Example:
ram54288 0:a2cb7295a1f7 33 * @code
ram54288 0:a2cb7295a1f7 34 * #include "mbed.h"
ram54288 0:a2cb7295a1f7 35 * #include "MyBuffer.h"
ram54288 0:a2cb7295a1f7 36 *
ram54288 0:a2cb7295a1f7 37 * MyBuffer <char> buf;
ram54288 0:a2cb7295a1f7 38 *
ram54288 0:a2cb7295a1f7 39 * int main()
ram54288 0:a2cb7295a1f7 40 * {
ram54288 0:a2cb7295a1f7 41 * buf = 'a';
ram54288 0:a2cb7295a1f7 42 * buf.put('b');
ram54288 0:a2cb7295a1f7 43 * char *head = buf.head();
ram54288 0:a2cb7295a1f7 44 * puts(head);
ram54288 0:a2cb7295a1f7 45 *
ram54288 0:a2cb7295a1f7 46 * char whats_in_there[2] = {0};
ram54288 0:a2cb7295a1f7 47 * int pos = 0;
ram54288 0:a2cb7295a1f7 48 *
ram54288 0:a2cb7295a1f7 49 * while(buf.available())
ram54288 0:a2cb7295a1f7 50 * {
ram54288 0:a2cb7295a1f7 51 * whats_in_there[pos++] = buf;
ram54288 0:a2cb7295a1f7 52 * }
ram54288 0:a2cb7295a1f7 53 * printf("%c %c\n", whats_in_there[0], whats_in_there[1]);
ram54288 0:a2cb7295a1f7 54 * buf.clear();
ram54288 0:a2cb7295a1f7 55 * error("done\n\n\n");
ram54288 0:a2cb7295a1f7 56 * }
ram54288 0:a2cb7295a1f7 57 * @endcode
ram54288 0:a2cb7295a1f7 58 */
ram54288 0:a2cb7295a1f7 59
ram54288 0:a2cb7295a1f7 60 template <typename T>
ram54288 0:a2cb7295a1f7 61 class MyBuffer
ram54288 0:a2cb7295a1f7 62 {
ram54288 0:a2cb7295a1f7 63 private:
ram54288 0:a2cb7295a1f7 64 T *_buf;
ram54288 0:a2cb7295a1f7 65 volatile uint32_t _wloc;
ram54288 0:a2cb7295a1f7 66 volatile uint32_t _rloc;
ram54288 0:a2cb7295a1f7 67 uint32_t _size;
ram54288 0:a2cb7295a1f7 68
ram54288 0:a2cb7295a1f7 69 public:
ram54288 0:a2cb7295a1f7 70 /** Create a Buffer and allocate memory for it
ram54288 0:a2cb7295a1f7 71 * @param size The size of the buffer
ram54288 0:a2cb7295a1f7 72 */
ram54288 0:a2cb7295a1f7 73 MyBuffer(uint32_t size = 0x100);
ram54288 0:a2cb7295a1f7 74
ram54288 0:a2cb7295a1f7 75 /** Get the size of the ring buffer
ram54288 0:a2cb7295a1f7 76 * @return the size of the ring buffer
ram54288 0:a2cb7295a1f7 77 */
ram54288 0:a2cb7295a1f7 78 uint32_t getSize();
ram54288 0:a2cb7295a1f7 79
ram54288 0:a2cb7295a1f7 80 /** Destry a Buffer and release it's allocated memory
ram54288 0:a2cb7295a1f7 81 */
ram54288 0:a2cb7295a1f7 82 ~MyBuffer();
ram54288 0:a2cb7295a1f7 83
ram54288 0:a2cb7295a1f7 84 /** Add a data element into the buffer
ram54288 0:a2cb7295a1f7 85 * @param data Something to add to the buffer
ram54288 0:a2cb7295a1f7 86 */
ram54288 0:a2cb7295a1f7 87 void put(T data);
ram54288 0:a2cb7295a1f7 88
ram54288 0:a2cb7295a1f7 89 /** Remove a data element from the buffer
ram54288 0:a2cb7295a1f7 90 * @return Pull the oldest element from the buffer
ram54288 0:a2cb7295a1f7 91 */
ram54288 0:a2cb7295a1f7 92 T get(void);
ram54288 0:a2cb7295a1f7 93
ram54288 0:a2cb7295a1f7 94 /** Get the address to the head of the buffer
ram54288 0:a2cb7295a1f7 95 * @return The address of element 0 in the buffer
ram54288 0:a2cb7295a1f7 96 */
ram54288 0:a2cb7295a1f7 97 T *head(void);
ram54288 0:a2cb7295a1f7 98
ram54288 0:a2cb7295a1f7 99 /** Reset the buffer to 0. Useful if using head() to parse packeted data
ram54288 0:a2cb7295a1f7 100 */
ram54288 0:a2cb7295a1f7 101 void clear(void);
ram54288 0:a2cb7295a1f7 102
ram54288 0:a2cb7295a1f7 103 /** Determine if anything is readable in the buffer
ram54288 0:a2cb7295a1f7 104 * @return 1 if something can be read, 0 otherwise
ram54288 0:a2cb7295a1f7 105 */
ram54288 0:a2cb7295a1f7 106 uint32_t available(void);
ram54288 0:a2cb7295a1f7 107
ram54288 0:a2cb7295a1f7 108 /** Overloaded operator for writing to the buffer
ram54288 0:a2cb7295a1f7 109 * @param data Something to put in the buffer
ram54288 0:a2cb7295a1f7 110 * @return
ram54288 0:a2cb7295a1f7 111 */
ram54288 0:a2cb7295a1f7 112 MyBuffer &operator= (T data)
ram54288 0:a2cb7295a1f7 113 {
ram54288 0:a2cb7295a1f7 114 put(data);
ram54288 0:a2cb7295a1f7 115 return *this;
ram54288 0:a2cb7295a1f7 116 }
ram54288 0:a2cb7295a1f7 117
ram54288 0:a2cb7295a1f7 118 /** Overloaded operator for reading from the buffer
ram54288 0:a2cb7295a1f7 119 * @return Pull the oldest element from the buffer
ram54288 0:a2cb7295a1f7 120 */
ram54288 0:a2cb7295a1f7 121 operator int(void)
ram54288 0:a2cb7295a1f7 122 {
ram54288 0:a2cb7295a1f7 123 return get();
ram54288 0:a2cb7295a1f7 124 }
ram54288 0:a2cb7295a1f7 125
ram54288 0:a2cb7295a1f7 126 uint32_t peek(char c);
ram54288 0:a2cb7295a1f7 127
ram54288 0:a2cb7295a1f7 128 };
ram54288 0:a2cb7295a1f7 129
ram54288 0:a2cb7295a1f7 130 template <class T>
ram54288 0:a2cb7295a1f7 131 inline void MyBuffer<T>::put(T data)
ram54288 0:a2cb7295a1f7 132 {
ram54288 0:a2cb7295a1f7 133 _buf[_wloc++] = data;
ram54288 0:a2cb7295a1f7 134 _wloc %= (_size-1);
ram54288 0:a2cb7295a1f7 135
ram54288 0:a2cb7295a1f7 136 return;
ram54288 0:a2cb7295a1f7 137 }
ram54288 0:a2cb7295a1f7 138
ram54288 0:a2cb7295a1f7 139 template <class T>
ram54288 0:a2cb7295a1f7 140 inline T MyBuffer<T>::get(void)
ram54288 0:a2cb7295a1f7 141 {
ram54288 0:a2cb7295a1f7 142 T data_pos = _buf[_rloc++];
ram54288 0:a2cb7295a1f7 143 _rloc %= (_size-1);
ram54288 0:a2cb7295a1f7 144
ram54288 0:a2cb7295a1f7 145 return data_pos;
ram54288 0:a2cb7295a1f7 146 }
ram54288 0:a2cb7295a1f7 147
ram54288 0:a2cb7295a1f7 148 template <class T>
ram54288 0:a2cb7295a1f7 149 inline T *MyBuffer<T>::head(void)
ram54288 0:a2cb7295a1f7 150 {
ram54288 0:a2cb7295a1f7 151 T *data_pos = &_buf[0];
ram54288 0:a2cb7295a1f7 152
ram54288 0:a2cb7295a1f7 153 return data_pos;
ram54288 0:a2cb7295a1f7 154 }
ram54288 0:a2cb7295a1f7 155
ram54288 0:a2cb7295a1f7 156 template <class T>
ram54288 0:a2cb7295a1f7 157 inline uint32_t MyBuffer<T>::available(void)
ram54288 0:a2cb7295a1f7 158 {
ram54288 0:a2cb7295a1f7 159 return (_wloc == _rloc) ? 0 : 1;
ram54288 0:a2cb7295a1f7 160 }
ram54288 0:a2cb7295a1f7 161
ram54288 0:a2cb7295a1f7 162 #endif
ram54288 0:a2cb7295a1f7 163