Taylor Gy / ESP8266

ESP8266 driver from ARM

Dependents:   8-0_OneNet_IoT_demo STM32F103C8T6_OneNet_IoT

ATParser/BufferedSerial/Buffer/MyBuffer.h@0:dfb22bd0e039, 2017-03-29 (annotated)

Committer:
TaylorGy
Date:
Wed Mar 29 03:09:15 2017 +0000
Revision:
0:dfb22bd0e039
ESP8266 driver from ARM

Who changed what in which revision?

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