Руслан Бредун / Mbed 2 deprecated Santec

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed Watchdog

BufferedSerial/Buffer/MyBuffer.h@0:858059db6068, 2021-11-02 (annotated)

Committer:
ruslanbredun
Date:
Tue Nov 02 11:28:01 2021 +0000
Revision:
0:858059db6068
New FirmWare for MC_node;

Who changed what in which revision?

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