Miguel Urco / SerialDriver

Buffered Serial Port Driver for RTOS tested with a K64F

Dependents:   JRO_CR2 frdm_test JRO_DDSv2 JRO_DDSv2_rev2019

Fork of SerialDriver by BlazeX .

SerialDriver.cpp@0:cd0d79be0c1a, 2015-01-14 (annotated)

Committer:
BlazeX
Date:
Wed Jan 14 16:30:14 2015 +0000
Revision:
0:cd0d79be0c1a
Child:
3:ea9719695b6a
Release :)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
BlazeX 0:cd0d79be0c1a 1 #include "SerialDriver.h"
BlazeX 0:cd0d79be0c1a 2
BlazeX 0:cd0d79be0c1a 3 SerialDriver::SerialDriver(PinName txPin, PinName rxPin, int txBufferLength_, int rxBufferLength_, unsigned char * txBuffer_, unsigned char * rxBuffer_)
BlazeX 0:cd0d79be0c1a 4 : SerialBase(txPin, rxPin), semTxBufferFull(0), semRxBufferEmpty(0)
BlazeX 0:cd0d79be0c1a 5 {
BlazeX 0:cd0d79be0c1a 6 // check buffer length
BlazeX 0:cd0d79be0c1a 7 txBufferLength= txBufferLength_;
BlazeX 0:cd0d79be0c1a 8 if(txBufferLength <= 1)
BlazeX 0:cd0d79be0c1a 9 error("TX buffer length must be > 1 !");
BlazeX 0:cd0d79be0c1a 10
BlazeX 0:cd0d79be0c1a 11 rxBufferLength= rxBufferLength_;
BlazeX 0:cd0d79be0c1a 12 if(rxBufferLength <= 1)
BlazeX 0:cd0d79be0c1a 13 error("RX buffer length must be > 1 !");
BlazeX 0:cd0d79be0c1a 14
BlazeX 0:cd0d79be0c1a 15 // take or allocate buffer
BlazeX 0:cd0d79be0c1a 16 txBuffer= txBuffer_;
BlazeX 0:cd0d79be0c1a 17 if(txBuffer == NULL)
BlazeX 0:cd0d79be0c1a 18 {
BlazeX 0:cd0d79be0c1a 19 txBuffer= new unsigned char[txBufferLength];
BlazeX 0:cd0d79be0c1a 20 if(txBuffer == NULL)
BlazeX 0:cd0d79be0c1a 21 error("Cannot allocate TX buffer!");
BlazeX 0:cd0d79be0c1a 22 }
BlazeX 0:cd0d79be0c1a 23
BlazeX 0:cd0d79be0c1a 24 rxBuffer= rxBuffer_;
BlazeX 0:cd0d79be0c1a 25 if(rxBuffer == NULL)
BlazeX 0:cd0d79be0c1a 26 {
BlazeX 0:cd0d79be0c1a 27 rxBuffer= new unsigned char[rxBufferLength];
BlazeX 0:cd0d79be0c1a 28 if(rxBuffer == NULL)
BlazeX 0:cd0d79be0c1a 29 error("Cannot allocate RX buffer!");
BlazeX 0:cd0d79be0c1a 30 }
BlazeX 0:cd0d79be0c1a 31
BlazeX 0:cd0d79be0c1a 32
BlazeX 0:cd0d79be0c1a 33 // reset cursors
BlazeX 0:cd0d79be0c1a 34 txIn= txOut= 0;
BlazeX 0:cd0d79be0c1a 35 rxIn= rxOut= 0;
BlazeX 0:cd0d79be0c1a 36 txCount= rxCount= 0;
BlazeX 0:cd0d79be0c1a 37
BlazeX 0:cd0d79be0c1a 38 // attach interrupt routines
BlazeX 0:cd0d79be0c1a 39 attach(this, &SerialDriver::onTxIrq, TxIrq);
BlazeX 0:cd0d79be0c1a 40 attach(this, &SerialDriver::onRxIrq, RxIrq);
BlazeX 0:cd0d79be0c1a 41
BlazeX 0:cd0d79be0c1a 42 }
BlazeX 0:cd0d79be0c1a 43
BlazeX 0:cd0d79be0c1a 44 int SerialDriver::putc(int c, unsigned int timeoutMs)
BlazeX 0:cd0d79be0c1a 45 {
BlazeX 0:cd0d79be0c1a 46 // critical section, isr could modify cursors
BlazeX 0:cd0d79be0c1a 47 disableTxInterrupt();
BlazeX 0:cd0d79be0c1a 48
BlazeX 0:cd0d79be0c1a 49 if(isTxBufferFull())
BlazeX 0:cd0d79be0c1a 50 {
BlazeX 0:cd0d79be0c1a 51 // wait for free space
BlazeX 0:cd0d79be0c1a 52 while(semTxBufferFull.wait(0) > 0); // clear semaphore
BlazeX 0:cd0d79be0c1a 53 enableTxInterrupt();
BlazeX 0:cd0d79be0c1a 54
BlazeX 0:cd0d79be0c1a 55 // let isr work
BlazeX 0:cd0d79be0c1a 56 semTxBufferFull.wait(timeoutMs);
BlazeX 0:cd0d79be0c1a 57
BlazeX 0:cd0d79be0c1a 58 disableTxInterrupt();
BlazeX 0:cd0d79be0c1a 59 if(isTxBufferFull()) // still full? drop byte!
BlazeX 0:cd0d79be0c1a 60 {
BlazeX 0:cd0d79be0c1a 61 enableTxInterrupt();
BlazeX 0:cd0d79be0c1a 62 return 0;
BlazeX 0:cd0d79be0c1a 63 }
BlazeX 0:cd0d79be0c1a 64 }
BlazeX 0:cd0d79be0c1a 65
BlazeX 0:cd0d79be0c1a 66 // write this byte to tx buffer
BlazeX 0:cd0d79be0c1a 67 txBuffer[txIn]= (unsigned char)c;
BlazeX 0:cd0d79be0c1a 68 txIn= (txIn+1) % txBufferLength;
BlazeX 0:cd0d79be0c1a 69 txCount++;
BlazeX 0:cd0d79be0c1a 70
BlazeX 0:cd0d79be0c1a 71 // its over, isr can come
BlazeX 0:cd0d79be0c1a 72 enableTxInterrupt();
BlazeX 0:cd0d79be0c1a 73
BlazeX 0:cd0d79be0c1a 74 // Let's write (isr will check writeability itself)
BlazeX 0:cd0d79be0c1a 75 onTxIrq();
BlazeX 0:cd0d79be0c1a 76
BlazeX 0:cd0d79be0c1a 77 return 1;
BlazeX 0:cd0d79be0c1a 78 }
BlazeX 0:cd0d79be0c1a 79
BlazeX 0:cd0d79be0c1a 80 void SerialDriver::onTxIrq()
BlazeX 0:cd0d79be0c1a 81 {
BlazeX 0:cd0d79be0c1a 82 // prevent fire another TxIrq now
BlazeX 0:cd0d79be0c1a 83 disableTxInterrupt();
BlazeX 0:cd0d79be0c1a 84
BlazeX 0:cd0d79be0c1a 85 // write as long as you can
BlazeX 0:cd0d79be0c1a 86 bool wasFull= isTxBufferFull();
BlazeX 0:cd0d79be0c1a 87 while(SerialBase::writeable() && !isTxBufferEmtpy())
BlazeX 0:cd0d79be0c1a 88 {
BlazeX 0:cd0d79be0c1a 89 // take byte from tx buffer and put it out
BlazeX 0:cd0d79be0c1a 90 SerialBase::_base_putc(txBuffer[txOut]);
BlazeX 0:cd0d79be0c1a 91 txOut= (txOut+1) % txBufferLength;
BlazeX 0:cd0d79be0c1a 92 txCount--;
BlazeX 0:cd0d79be0c1a 93 }
BlazeX 0:cd0d79be0c1a 94
BlazeX 0:cd0d79be0c1a 95 if(wasFull && !isTxBufferFull()) // more bytes can come
BlazeX 0:cd0d79be0c1a 96 semTxBufferFull.release();
BlazeX 0:cd0d79be0c1a 97
BlazeX 0:cd0d79be0c1a 98 // ok, let's wait for next writability
BlazeX 0:cd0d79be0c1a 99 enableTxInterrupt();
BlazeX 0:cd0d79be0c1a 100 }
BlazeX 0:cd0d79be0c1a 101
BlazeX 0:cd0d79be0c1a 102
BlazeX 0:cd0d79be0c1a 103 int SerialDriver::getc(unsigned int timeoutMs)
BlazeX 0:cd0d79be0c1a 104 {
BlazeX 0:cd0d79be0c1a 105 // Let's read (isr will check readability itself)
BlazeX 0:cd0d79be0c1a 106 onRxIrq();
BlazeX 0:cd0d79be0c1a 107
BlazeX 0:cd0d79be0c1a 108 // critical section, isr could modify cursors
BlazeX 0:cd0d79be0c1a 109 disableRxInterrupt();
BlazeX 0:cd0d79be0c1a 110
BlazeX 0:cd0d79be0c1a 111 if(isRxBufferEmpty())
BlazeX 0:cd0d79be0c1a 112 {
BlazeX 0:cd0d79be0c1a 113 // wait for new byte
BlazeX 0:cd0d79be0c1a 114 while(semRxBufferEmpty.wait(0) > 0); // clear semaphore
BlazeX 0:cd0d79be0c1a 115 enableRxInterrupt();
BlazeX 0:cd0d79be0c1a 116
BlazeX 0:cd0d79be0c1a 117 // let isr work
BlazeX 0:cd0d79be0c1a 118 semRxBufferEmpty.wait(timeoutMs);
BlazeX 0:cd0d79be0c1a 119
BlazeX 0:cd0d79be0c1a 120 disableRxInterrupt();
BlazeX 0:cd0d79be0c1a 121 if(isRxBufferEmpty()) // still empty? nothing received!
BlazeX 0:cd0d79be0c1a 122 {
BlazeX 0:cd0d79be0c1a 123 enableRxInterrupt();
BlazeX 0:cd0d79be0c1a 124 return -1;
BlazeX 0:cd0d79be0c1a 125 }
BlazeX 0:cd0d79be0c1a 126 }
BlazeX 0:cd0d79be0c1a 127
BlazeX 0:cd0d79be0c1a 128 // get byte from rx buffer
BlazeX 0:cd0d79be0c1a 129 int c= (int)rxBuffer[rxOut];
BlazeX 0:cd0d79be0c1a 130 rxOut= (rxOut+1) % rxBufferLength;
BlazeX 0:cd0d79be0c1a 131 rxCount--;
BlazeX 0:cd0d79be0c1a 132
BlazeX 0:cd0d79be0c1a 133 // its over, isr can come
BlazeX 0:cd0d79be0c1a 134 enableRxInterrupt();
BlazeX 0:cd0d79be0c1a 135
BlazeX 0:cd0d79be0c1a 136 return c;
BlazeX 0:cd0d79be0c1a 137 }
BlazeX 0:cd0d79be0c1a 138
BlazeX 0:cd0d79be0c1a 139 void SerialDriver::onRxIrq()
BlazeX 0:cd0d79be0c1a 140 {
BlazeX 0:cd0d79be0c1a 141 // prevent fire another RxIrq now
BlazeX 0:cd0d79be0c1a 142 disableRxInterrupt();
BlazeX 0:cd0d79be0c1a 143
BlazeX 0:cd0d79be0c1a 144 // read as long as you can
BlazeX 0:cd0d79be0c1a 145 bool wasEmpty= isRxBufferEmpty();
BlazeX 0:cd0d79be0c1a 146 while(SerialBase::readable())
BlazeX 0:cd0d79be0c1a 147 {
BlazeX 0:cd0d79be0c1a 148 // get byte and store it to the RX buffer
BlazeX 0:cd0d79be0c1a 149 int c= SerialBase::_base_getc();
BlazeX 0:cd0d79be0c1a 150 if(!isRxBufferFull())
BlazeX 0:cd0d79be0c1a 151 {
BlazeX 0:cd0d79be0c1a 152 rxBuffer[rxIn]= (unsigned char)c;
BlazeX 0:cd0d79be0c1a 153 rxIn= (rxIn+1) % rxBufferLength;
BlazeX 0:cd0d79be0c1a 154 rxCount++;
BlazeX 0:cd0d79be0c1a 155 } // else drop byte :(
BlazeX 0:cd0d79be0c1a 156 }
BlazeX 0:cd0d79be0c1a 157
BlazeX 0:cd0d79be0c1a 158 if(wasEmpty && !isRxBufferEmpty()) // more bytes can go
BlazeX 0:cd0d79be0c1a 159 semRxBufferEmpty.release();
BlazeX 0:cd0d79be0c1a 160
BlazeX 0:cd0d79be0c1a 161 // ok, let's wait for next readability
BlazeX 0:cd0d79be0c1a 162 enableRxInterrupt();
BlazeX 0:cd0d79be0c1a 163 }
BlazeX 0:cd0d79be0c1a 164
BlazeX 0:cd0d79be0c1a 165
BlazeX 0:cd0d79be0c1a 166 int SerialDriver::write(const unsigned char * buffer, const unsigned int length, bool block)
BlazeX 0:cd0d79be0c1a 167 {
BlazeX 0:cd0d79be0c1a 168 // try to put all bytes
BlazeX 0:cd0d79be0c1a 169 for(int i= 0; i < length; i++)
BlazeX 0:cd0d79be0c1a 170 if(!putc(buffer[i], block ? osWaitForever : 0))
BlazeX 0:cd0d79be0c1a 171 return i; // putc failed, but already put i bytes
BlazeX 0:cd0d79be0c1a 172
BlazeX 0:cd0d79be0c1a 173 return length; // put all bytes
BlazeX 0:cd0d79be0c1a 174 }
BlazeX 0:cd0d79be0c1a 175
BlazeX 0:cd0d79be0c1a 176 int SerialDriver::read(unsigned char * buffer, const unsigned int length, bool block)
BlazeX 0:cd0d79be0c1a 177 {
BlazeX 0:cd0d79be0c1a 178 // try to get all bytes
BlazeX 0:cd0d79be0c1a 179 int c;
BlazeX 0:cd0d79be0c1a 180 for(int i= 0; i < length; i++)
BlazeX 0:cd0d79be0c1a 181 {
BlazeX 0:cd0d79be0c1a 182 c= getc(block ? osWaitForever : 0);
BlazeX 0:cd0d79be0c1a 183 if(c < 0)
BlazeX 0:cd0d79be0c1a 184 return i; // getc failed, but already got i bytes
BlazeX 0:cd0d79be0c1a 185 buffer[i]= (unsigned char)c;
BlazeX 0:cd0d79be0c1a 186 }
BlazeX 0:cd0d79be0c1a 187
BlazeX 0:cd0d79be0c1a 188 return length; // got all bytes
BlazeX 0:cd0d79be0c1a 189 }
BlazeX 0:cd0d79be0c1a 190
BlazeX 0:cd0d79be0c1a 191
BlazeX 0:cd0d79be0c1a 192 int SerialDriver::puts(const char * str, bool block)
BlazeX 0:cd0d79be0c1a 193 {
BlazeX 0:cd0d79be0c1a 194 // the same as write, but get length from strlen
BlazeX 0:cd0d79be0c1a 195 const int len= strlen(str);
BlazeX 0:cd0d79be0c1a 196 return write((const unsigned char *)str, len, block);
BlazeX 0:cd0d79be0c1a 197 }
BlazeX 0:cd0d79be0c1a 198
BlazeX 0:cd0d79be0c1a 199 int SerialDriver::printf(const char * format, ...)
BlazeX 0:cd0d79be0c1a 200 {
BlazeX 0:cd0d79be0c1a 201 // Parts of this are copied from mbed RawSerial ;)
BlazeX 0:cd0d79be0c1a 202 std::va_list arg;
BlazeX 0:cd0d79be0c1a 203 va_start(arg, format);
BlazeX 0:cd0d79be0c1a 204
BlazeX 0:cd0d79be0c1a 205 int length= vsnprintf(NULL, 0, format, arg);
BlazeX 0:cd0d79be0c1a 206 char *temp = new char[length + 1];
BlazeX 0:cd0d79be0c1a 207 vsprintf(temp, format, arg);
BlazeX 0:cd0d79be0c1a 208 puts(temp, true);
BlazeX 0:cd0d79be0c1a 209 delete[] temp;
BlazeX 0:cd0d79be0c1a 210
BlazeX 0:cd0d79be0c1a 211 va_end(arg);
BlazeX 0:cd0d79be0c1a 212 return length;
BlazeX 0:cd0d79be0c1a 213 }
BlazeX 0:cd0d79be0c1a 214
BlazeX 0:cd0d79be0c1a 215 // for XTN