Sarah Marsh / emw3162-driver

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.

Fork of emw3162-driver by Maggie Mei

emw3162/ATParser/BufferedSerial/BufferedSerial.cpp@0:2d5090e1ceb4, 2016-11-01 (annotated)

Committer:
Maggie17
Date:
Tue Nov 01 02:18:18 2016 +0000
Revision:
0:2d5090e1ceb4
Initial commit

Who changed what in which revision?

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