Ram Gandikota / Mbed OS IOTMetronome

FRDM K64F Metronome

easy-connect/esp8266-driver/ESP8266/ATParser/BufferedSerial/BufferedSerial.cpp@0:dbad57390bd1, 2017-05-14 (annotated)

Committer:
ram54288
Date:
Sun May 14 18:37:05 2017 +0000
Revision:
0:dbad57390bd1
Initial commit

Who changed what in which revision?

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