Nuvoton / Mbed OS NuMaker-mbed-Serial-to-Ethernet

NuMaker Transfer data UART to Ethernet

Fork of Serial-to-Ethernet by Morgan Du

BufferSerial/BufferSerial.cpp@6:014b1a469aed, 2021-03-02 (annotated)

Committer:
SHLIU1@OANBE02333.nuvoton.com
Date:
Tue Mar 02 10:09:10 2021 +0800
Revision:
6:014b1a469aed
Support the both V5.X and V6.X for mbed-os

Who changed what in which revision?

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