Taylor Gy / ESP8266

ESP8266 driver from ARM

Dependents:   8-0_OneNet_IoT_demo STM32F103C8T6_OneNet_IoT

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