mayuresh bharmoria / Mbed OS mbed-os-example-wifi

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.

esp32-driver/ESP32/ATParser_os/BufferedSerial/BufferedSerial.cpp@0:8f8e8f3cbd1c, 2018-06-21 (annotated)

Committer:
mayur098
Date:
Thu Jun 21 17:50:21 2018 +0000
Revision:
0:8f8e8f3cbd1c
first commit;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mayur098 0:8f8e8f3cbd1c 1 /**
mayur098 0:8f8e8f3cbd1c 2 * @file BufferedSerial.cpp
mayur098 0:8f8e8f3cbd1c 3 * @brief Software Buffer - Extends mbed Serial functionallity adding irq driven TX and RX
mayur098 0:8f8e8f3cbd1c 4 * @author sam grove
mayur098 0:8f8e8f3cbd1c 5 * @version 1.0
mayur098 0:8f8e8f3cbd1c 6 * @see
mayur098 0:8f8e8f3cbd1c 7 *
mayur098 0:8f8e8f3cbd1c 8 * Copyright (c) 2013
mayur098 0:8f8e8f3cbd1c 9 *
mayur098 0:8f8e8f3cbd1c 10 * Licensed under the Apache License, Version 2.0 (the "License");
mayur098 0:8f8e8f3cbd1c 11 * you may not use this file except in compliance with the License.
mayur098 0:8f8e8f3cbd1c 12 * You may obtain a copy of the License at
mayur098 0:8f8e8f3cbd1c 13 *
mayur098 0:8f8e8f3cbd1c 14 * http://www.apache.org/licenses/LICENSE-2.0
mayur098 0:8f8e8f3cbd1c 15 *
mayur098 0:8f8e8f3cbd1c 16 * Unless required by applicable law or agreed to in writing, software
mayur098 0:8f8e8f3cbd1c 17 * distributed under the License is distributed on an "AS IS" BASIS,
mayur098 0:8f8e8f3cbd1c 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mayur098 0:8f8e8f3cbd1c 19 * See the License for the specific language governing permissions and
mayur098 0:8f8e8f3cbd1c 20 * limitations under the License.
mayur098 0:8f8e8f3cbd1c 21 */
mayur098 0:8f8e8f3cbd1c 22
mayur098 0:8f8e8f3cbd1c 23 #include "BufferedSerial.h"
mayur098 0:8f8e8f3cbd1c 24 #include <stdarg.h>
mayur098 0:8f8e8f3cbd1c 25
mayur098 0:8f8e8f3cbd1c 26 extern "C" int BufferedPrintfC(void *stream, int size, const char* format, va_list arg);
mayur098 0:8f8e8f3cbd1c 27
mayur098 0:8f8e8f3cbd1c 28 BufferedSerial::BufferedSerial(PinName tx, PinName rx, uint32_t buf_size, uint32_t tx_multiple, const char* name)
mayur098 0:8f8e8f3cbd1c 29 : RawSerial(tx, rx) , _rxbuf(buf_size), _txbuf((uint32_t)(tx_multiple*buf_size))
mayur098 0:8f8e8f3cbd1c 30 {
mayur098 0:8f8e8f3cbd1c 31 RawSerial::attach(this, &BufferedSerial::rxIrq, Serial::RxIrq);
mayur098 0:8f8e8f3cbd1c 32 this->_buf_size = buf_size;
mayur098 0:8f8e8f3cbd1c 33 this->_tx_multiple = tx_multiple;
mayur098 0:8f8e8f3cbd1c 34 return;
mayur098 0:8f8e8f3cbd1c 35 }
mayur098 0:8f8e8f3cbd1c 36
mayur098 0:8f8e8f3cbd1c 37 BufferedSerial::~BufferedSerial(void)
mayur098 0:8f8e8f3cbd1c 38 {
mayur098 0:8f8e8f3cbd1c 39 RawSerial::attach(NULL, RawSerial::RxIrq);
mayur098 0:8f8e8f3cbd1c 40 RawSerial::attach(NULL, RawSerial::TxIrq);
mayur098 0:8f8e8f3cbd1c 41
mayur098 0:8f8e8f3cbd1c 42 return;
mayur098 0:8f8e8f3cbd1c 43 }
mayur098 0:8f8e8f3cbd1c 44
mayur098 0:8f8e8f3cbd1c 45 int BufferedSerial::readable(void)
mayur098 0:8f8e8f3cbd1c 46 {
mayur098 0:8f8e8f3cbd1c 47 return _rxbuf.available(); // note: look if things are in the buffer
mayur098 0:8f8e8f3cbd1c 48 }
mayur098 0:8f8e8f3cbd1c 49
mayur098 0:8f8e8f3cbd1c 50 int BufferedSerial::writeable(void)
mayur098 0:8f8e8f3cbd1c 51 {
mayur098 0:8f8e8f3cbd1c 52 return 1; // buffer allows overwriting by design, always true
mayur098 0:8f8e8f3cbd1c 53 }
mayur098 0:8f8e8f3cbd1c 54
mayur098 0:8f8e8f3cbd1c 55 int BufferedSerial::getc(void)
mayur098 0:8f8e8f3cbd1c 56 {
mayur098 0:8f8e8f3cbd1c 57 return _rxbuf;
mayur098 0:8f8e8f3cbd1c 58 }
mayur098 0:8f8e8f3cbd1c 59
mayur098 0:8f8e8f3cbd1c 60 int BufferedSerial::putc(int c)
mayur098 0:8f8e8f3cbd1c 61 {
mayur098 0:8f8e8f3cbd1c 62 _txbuf = (char)c;
mayur098 0:8f8e8f3cbd1c 63 BufferedSerial::prime();
mayur098 0:8f8e8f3cbd1c 64
mayur098 0:8f8e8f3cbd1c 65 return c;
mayur098 0:8f8e8f3cbd1c 66 }
mayur098 0:8f8e8f3cbd1c 67
mayur098 0:8f8e8f3cbd1c 68 int BufferedSerial::puts(const char *s)
mayur098 0:8f8e8f3cbd1c 69 {
mayur098 0:8f8e8f3cbd1c 70 if (s != NULL) {
mayur098 0:8f8e8f3cbd1c 71 const char* ptr = s;
mayur098 0:8f8e8f3cbd1c 72
mayur098 0:8f8e8f3cbd1c 73 while(*(ptr) != 0) {
mayur098 0:8f8e8f3cbd1c 74 _txbuf = *(ptr++);
mayur098 0:8f8e8f3cbd1c 75 }
mayur098 0:8f8e8f3cbd1c 76 _txbuf = '\n'; // done per puts definition
mayur098 0:8f8e8f3cbd1c 77 BufferedSerial::prime();
mayur098 0:8f8e8f3cbd1c 78
mayur098 0:8f8e8f3cbd1c 79 return (ptr - s) + 1;
mayur098 0:8f8e8f3cbd1c 80 }
mayur098 0:8f8e8f3cbd1c 81 return 0;
mayur098 0:8f8e8f3cbd1c 82 }
mayur098 0:8f8e8f3cbd1c 83
mayur098 0:8f8e8f3cbd1c 84 extern "C" size_t BufferedSerialThunk(void *buf_serial, const void *s, size_t length)
mayur098 0:8f8e8f3cbd1c 85 {
mayur098 0:8f8e8f3cbd1c 86 BufferedSerial *buffered_serial = (BufferedSerial *)buf_serial;
mayur098 0:8f8e8f3cbd1c 87 return buffered_serial->write(s, length);
mayur098 0:8f8e8f3cbd1c 88 }
mayur098 0:8f8e8f3cbd1c 89
mayur098 0:8f8e8f3cbd1c 90 int BufferedSerial::printf(const char* format, ...)
mayur098 0:8f8e8f3cbd1c 91 {
mayur098 0:8f8e8f3cbd1c 92 va_list arg;
mayur098 0:8f8e8f3cbd1c 93 va_start(arg, format);
mayur098 0:8f8e8f3cbd1c 94 int r = BufferedPrintfC((void*)this, this->_buf_size, format, arg);
mayur098 0:8f8e8f3cbd1c 95 va_end(arg);
mayur098 0:8f8e8f3cbd1c 96 return r;
mayur098 0:8f8e8f3cbd1c 97 }
mayur098 0:8f8e8f3cbd1c 98
mayur098 0:8f8e8f3cbd1c 99 ssize_t BufferedSerial::write(const void *s, size_t length)
mayur098 0:8f8e8f3cbd1c 100 {
mayur098 0:8f8e8f3cbd1c 101 if (s != NULL && length > 0) {
mayur098 0:8f8e8f3cbd1c 102 const char* ptr = (const char*)s;
mayur098 0:8f8e8f3cbd1c 103 const char* end = ptr + length;
mayur098 0:8f8e8f3cbd1c 104
mayur098 0:8f8e8f3cbd1c 105 while (ptr != end) {
mayur098 0:8f8e8f3cbd1c 106 _txbuf = *(ptr++);
mayur098 0:8f8e8f3cbd1c 107 }
mayur098 0:8f8e8f3cbd1c 108 BufferedSerial::prime();
mayur098 0:8f8e8f3cbd1c 109
mayur098 0:8f8e8f3cbd1c 110 return ptr - (const char*)s;
mayur098 0:8f8e8f3cbd1c 111 }
mayur098 0:8f8e8f3cbd1c 112 return 0;
mayur098 0:8f8e8f3cbd1c 113 }
mayur098 0:8f8e8f3cbd1c 114
mayur098 0:8f8e8f3cbd1c 115
mayur098 0:8f8e8f3cbd1c 116 void BufferedSerial::rxIrq(void)
mayur098 0:8f8e8f3cbd1c 117 {
mayur098 0:8f8e8f3cbd1c 118 // read from the peripheral and make sure something is available
mayur098 0:8f8e8f3cbd1c 119 if(serial_readable(&_serial)) {
mayur098 0:8f8e8f3cbd1c 120 _rxbuf = serial_getc(&_serial); // if so load them into a buffer
mayur098 0:8f8e8f3cbd1c 121 // trigger callback if necessary
mayur098 0:8f8e8f3cbd1c 122 if (_cbs[RxIrq]) {
mayur098 0:8f8e8f3cbd1c 123 _cbs[RxIrq]();
mayur098 0:8f8e8f3cbd1c 124 }
mayur098 0:8f8e8f3cbd1c 125 }
mayur098 0:8f8e8f3cbd1c 126
mayur098 0:8f8e8f3cbd1c 127 return;
mayur098 0:8f8e8f3cbd1c 128 }
mayur098 0:8f8e8f3cbd1c 129
mayur098 0:8f8e8f3cbd1c 130 void BufferedSerial::txIrq(void)
mayur098 0:8f8e8f3cbd1c 131 {
mayur098 0:8f8e8f3cbd1c 132 // see if there is room in the hardware fifo and if something is in the software fifo
mayur098 0:8f8e8f3cbd1c 133 while(serial_writable(&_serial)) {
mayur098 0:8f8e8f3cbd1c 134 if(_txbuf.available()) {
mayur098 0:8f8e8f3cbd1c 135 serial_putc(&_serial, (int)_txbuf.get());
mayur098 0:8f8e8f3cbd1c 136 } else {
mayur098 0:8f8e8f3cbd1c 137 // disable the TX interrupt when there is nothing left to send
mayur098 0:8f8e8f3cbd1c 138 RawSerial::attach(NULL, RawSerial::TxIrq);
mayur098 0:8f8e8f3cbd1c 139 // trigger callback if necessary
mayur098 0:8f8e8f3cbd1c 140 if (_cbs[TxIrq]) {
mayur098 0:8f8e8f3cbd1c 141 _cbs[TxIrq]();
mayur098 0:8f8e8f3cbd1c 142 }
mayur098 0:8f8e8f3cbd1c 143 break;
mayur098 0:8f8e8f3cbd1c 144 }
mayur098 0:8f8e8f3cbd1c 145 }
mayur098 0:8f8e8f3cbd1c 146
mayur098 0:8f8e8f3cbd1c 147 return;
mayur098 0:8f8e8f3cbd1c 148 }
mayur098 0:8f8e8f3cbd1c 149
mayur098 0:8f8e8f3cbd1c 150 void BufferedSerial::prime(void)
mayur098 0:8f8e8f3cbd1c 151 {
mayur098 0:8f8e8f3cbd1c 152 // if already busy then the irq will pick this up
mayur098 0:8f8e8f3cbd1c 153 if(serial_writable(&_serial)) {
mayur098 0:8f8e8f3cbd1c 154 RawSerial::attach(NULL, RawSerial::TxIrq); // make sure not to cause contention in the irq
mayur098 0:8f8e8f3cbd1c 155 BufferedSerial::txIrq(); // only write to hardware in one place
mayur098 0:8f8e8f3cbd1c 156 RawSerial::attach(this, &BufferedSerial::txIrq, RawSerial::TxIrq);
mayur098 0:8f8e8f3cbd1c 157 }
mayur098 0:8f8e8f3cbd1c 158
mayur098 0:8f8e8f3cbd1c 159 return;
mayur098 0:8f8e8f3cbd1c 160 }
mayur098 0:8f8e8f3cbd1c 161
mayur098 0:8f8e8f3cbd1c 162 void BufferedSerial::attach(Callback<void()> func, IrqType type)
mayur098 0:8f8e8f3cbd1c 163 {
mayur098 0:8f8e8f3cbd1c 164 _cbs[type] = func;
mayur098 0:8f8e8f3cbd1c 165 }
mayur098 0:8f8e8f3cbd1c 166