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@5:ee58295c58e1, 2015-02-10 (annotated)

Committer:
miguelcordero191
Date:
Tue Feb 10 14:29:32 2015 +0000
Revision:
5:ee58295c58e1
Parent:
4:3956012cd0c4 
This library just was modified when a K64F is used

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 3:ea9719695b6a 38 // reset drop counters
BlazeX 3:ea9719695b6a 39 numTxDrops= 0;
BlazeX 3:ea9719695b6a 40 numRxDrops= 0;
BlazeX 3:ea9719695b6a 41
BlazeX 0:cd0d79be0c1a 42 // attach interrupt routines
BlazeX 0:cd0d79be0c1a 43 attach(this, &SerialDriver::onRxIrq, RxIrq);
miguelcordero191 5:ee58295c58e1 44 #if !defined(TARGET_K64F)
miguelcordero191 5:ee58295c58e1 45 attach(this, &SerialDriver::onTxIrq, TxIrq);
miguelcordero191 5:ee58295c58e1 46 #endif
BlazeX 0:cd0d79be0c1a 47 }
BlazeX 0:cd0d79be0c1a 48
miguelcordero191 5:ee58295c58e1 49 #if !defined(TARGET_K64F)
miguelcordero191 4:3956012cd0c4 50 int SerialDriver::putc(int c, unsigned int timeoutMs)
miguelcordero191 4:3956012cd0c4 51 {
BlazeX 0:cd0d79be0c1a 52 // critical section, isr could modify cursors
BlazeX 0:cd0d79be0c1a 53 disableTxInterrupt();
BlazeX 0:cd0d79be0c1a 54
BlazeX 0:cd0d79be0c1a 55 if(isTxBufferFull())
BlazeX 0:cd0d79be0c1a 56 {
BlazeX 0:cd0d79be0c1a 57 // wait for free space
BlazeX 0:cd0d79be0c1a 58 while(semTxBufferFull.wait(0) > 0); // clear semaphore
BlazeX 0:cd0d79be0c1a 59 enableTxInterrupt();
BlazeX 0:cd0d79be0c1a 60
BlazeX 0:cd0d79be0c1a 61 // let isr work
BlazeX 0:cd0d79be0c1a 62 semTxBufferFull.wait(timeoutMs);
BlazeX 0:cd0d79be0c1a 63
BlazeX 0:cd0d79be0c1a 64 disableTxInterrupt();
BlazeX 0:cd0d79be0c1a 65 if(isTxBufferFull()) // still full? drop byte!
BlazeX 0:cd0d79be0c1a 66 {
BlazeX 3:ea9719695b6a 67 numTxDrops++;
BlazeX 0:cd0d79be0c1a 68 enableTxInterrupt();
BlazeX 0:cd0d79be0c1a 69 return 0;
BlazeX 0:cd0d79be0c1a 70 }
BlazeX 0:cd0d79be0c1a 71 }
BlazeX 0:cd0d79be0c1a 72
BlazeX 0:cd0d79be0c1a 73 // write this byte to tx buffer
BlazeX 0:cd0d79be0c1a 74 txBuffer[txIn]= (unsigned char)c;
BlazeX 0:cd0d79be0c1a 75 txIn= (txIn+1) % txBufferLength;
BlazeX 0:cd0d79be0c1a 76 txCount++;
BlazeX 0:cd0d79be0c1a 77
BlazeX 0:cd0d79be0c1a 78 // its over, isr can come
BlazeX 0:cd0d79be0c1a 79 enableTxInterrupt();
BlazeX 0:cd0d79be0c1a 80
BlazeX 0:cd0d79be0c1a 81 // Let's write (isr will check writeability itself)
BlazeX 0:cd0d79be0c1a 82 onTxIrq();
BlazeX 0:cd0d79be0c1a 83
BlazeX 0:cd0d79be0c1a 84 return 1;
BlazeX 0:cd0d79be0c1a 85 }
miguelcordero191 5:ee58295c58e1 86 #else
miguelcordero191 5:ee58295c58e1 87 int SerialDriver::putc(int c, unsigned int timeoutMs)
miguelcordero191 5:ee58295c58e1 88 {
miguelcordero191 5:ee58295c58e1 89
miguelcordero191 5:ee58295c58e1 90 while(!SerialBase::writeable())
miguelcordero191 5:ee58295c58e1 91 {//wait until character had been sent
miguelcordero191 5:ee58295c58e1 92 Thread::wait(1);
miguelcordero191 5:ee58295c58e1 93 }
miguelcordero191 5:ee58295c58e1 94
miguelcordero191 5:ee58295c58e1 95 if(SerialBase::writeable())
miguelcordero191 5:ee58295c58e1 96 {
miguelcordero191 5:ee58295c58e1 97 // take byte from tx buffer and put it out
miguelcordero191 5:ee58295c58e1 98 SerialBase::_base_putc(c);
miguelcordero191 5:ee58295c58e1 99 }
miguelcordero191 5:ee58295c58e1 100
miguelcordero191 5:ee58295c58e1 101 return 1;
miguelcordero191 5:ee58295c58e1 102 }
miguelcordero191 5:ee58295c58e1 103 #endif
miguelcordero191 5:ee58295c58e1 104
BlazeX 0:cd0d79be0c1a 105 void SerialDriver::onTxIrq()
BlazeX 0:cd0d79be0c1a 106 {
BlazeX 0:cd0d79be0c1a 107 // prevent fire another TxIrq now
BlazeX 0:cd0d79be0c1a 108 disableTxInterrupt();
BlazeX 0:cd0d79be0c1a 109
BlazeX 0:cd0d79be0c1a 110 // write as long as you can
BlazeX 0:cd0d79be0c1a 111 bool wasFull= isTxBufferFull();
BlazeX 0:cd0d79be0c1a 112 while(SerialBase::writeable() && !isTxBufferEmtpy())
BlazeX 0:cd0d79be0c1a 113 {
BlazeX 0:cd0d79be0c1a 114 // take byte from tx buffer and put it out
BlazeX 0:cd0d79be0c1a 115 SerialBase::_base_putc(txBuffer[txOut]);
BlazeX 0:cd0d79be0c1a 116 txOut= (txOut+1) % txBufferLength;
BlazeX 0:cd0d79be0c1a 117 txCount--;
BlazeX 0:cd0d79be0c1a 118 }
BlazeX 0:cd0d79be0c1a 119
BlazeX 0:cd0d79be0c1a 120 if(wasFull && !isTxBufferFull()) // more bytes can come
BlazeX 0:cd0d79be0c1a 121 semTxBufferFull.release();
BlazeX 0:cd0d79be0c1a 122
BlazeX 0:cd0d79be0c1a 123 // ok, let's wait for next writability
BlazeX 0:cd0d79be0c1a 124 enableTxInterrupt();
BlazeX 0:cd0d79be0c1a 125 }
BlazeX 0:cd0d79be0c1a 126
BlazeX 0:cd0d79be0c1a 127
BlazeX 0:cd0d79be0c1a 128 int SerialDriver::getc(unsigned int timeoutMs)
BlazeX 0:cd0d79be0c1a 129 {
BlazeX 0:cd0d79be0c1a 130 // Let's read (isr will check readability itself)
BlazeX 0:cd0d79be0c1a 131 onRxIrq();
BlazeX 0:cd0d79be0c1a 132
BlazeX 0:cd0d79be0c1a 133 // critical section, isr could modify cursors
BlazeX 0:cd0d79be0c1a 134 disableRxInterrupt();
BlazeX 0:cd0d79be0c1a 135
BlazeX 0:cd0d79be0c1a 136 if(isRxBufferEmpty())
BlazeX 0:cd0d79be0c1a 137 {
BlazeX 0:cd0d79be0c1a 138 // wait for new byte
BlazeX 0:cd0d79be0c1a 139 while(semRxBufferEmpty.wait(0) > 0); // clear semaphore
BlazeX 0:cd0d79be0c1a 140 enableRxInterrupt();
BlazeX 0:cd0d79be0c1a 141
BlazeX 0:cd0d79be0c1a 142 // let isr work
BlazeX 0:cd0d79be0c1a 143 semRxBufferEmpty.wait(timeoutMs);
BlazeX 0:cd0d79be0c1a 144
BlazeX 0:cd0d79be0c1a 145 disableRxInterrupt();
BlazeX 0:cd0d79be0c1a 146 if(isRxBufferEmpty()) // still empty? nothing received!
BlazeX 0:cd0d79be0c1a 147 {
BlazeX 0:cd0d79be0c1a 148 enableRxInterrupt();
BlazeX 0:cd0d79be0c1a 149 return -1;
BlazeX 0:cd0d79be0c1a 150 }
BlazeX 0:cd0d79be0c1a 151 }
BlazeX 0:cd0d79be0c1a 152
BlazeX 0:cd0d79be0c1a 153 // get byte from rx buffer
BlazeX 0:cd0d79be0c1a 154 int c= (int)rxBuffer[rxOut];
BlazeX 0:cd0d79be0c1a 155 rxOut= (rxOut+1) % rxBufferLength;
BlazeX 0:cd0d79be0c1a 156 rxCount--;
BlazeX 0:cd0d79be0c1a 157
BlazeX 0:cd0d79be0c1a 158 // its over, isr can come
BlazeX 0:cd0d79be0c1a 159 enableRxInterrupt();
BlazeX 0:cd0d79be0c1a 160
BlazeX 0:cd0d79be0c1a 161 return c;
BlazeX 0:cd0d79be0c1a 162 }
BlazeX 0:cd0d79be0c1a 163
BlazeX 0:cd0d79be0c1a 164 void SerialDriver::onRxIrq()
BlazeX 0:cd0d79be0c1a 165 {
BlazeX 0:cd0d79be0c1a 166 // prevent fire another RxIrq now
BlazeX 0:cd0d79be0c1a 167 disableRxInterrupt();
BlazeX 0:cd0d79be0c1a 168
BlazeX 0:cd0d79be0c1a 169 // read as long as you can
BlazeX 0:cd0d79be0c1a 170 bool wasEmpty= isRxBufferEmpty();
BlazeX 0:cd0d79be0c1a 171 while(SerialBase::readable())
BlazeX 0:cd0d79be0c1a 172 {
BlazeX 0:cd0d79be0c1a 173 // get byte and store it to the RX buffer
BlazeX 0:cd0d79be0c1a 174 int c= SerialBase::_base_getc();
BlazeX 0:cd0d79be0c1a 175 if(!isRxBufferFull())
BlazeX 0:cd0d79be0c1a 176 {
BlazeX 0:cd0d79be0c1a 177 rxBuffer[rxIn]= (unsigned char)c;
BlazeX 0:cd0d79be0c1a 178 rxIn= (rxIn+1) % rxBufferLength;
BlazeX 0:cd0d79be0c1a 179 rxCount++;
BlazeX 3:ea9719695b6a 180 }
BlazeX 3:ea9719695b6a 181 else // drop byte :(
BlazeX 3:ea9719695b6a 182 numRxDrops++;
BlazeX 0:cd0d79be0c1a 183 }
BlazeX 0:cd0d79be0c1a 184
BlazeX 0:cd0d79be0c1a 185 if(wasEmpty && !isRxBufferEmpty()) // more bytes can go
BlazeX 0:cd0d79be0c1a 186 semRxBufferEmpty.release();
BlazeX 0:cd0d79be0c1a 187
BlazeX 0:cd0d79be0c1a 188 // ok, let's wait for next readability
BlazeX 0:cd0d79be0c1a 189 enableRxInterrupt();
BlazeX 0:cd0d79be0c1a 190 }
BlazeX 0:cd0d79be0c1a 191
BlazeX 0:cd0d79be0c1a 192
BlazeX 0:cd0d79be0c1a 193 int SerialDriver::write(const unsigned char * buffer, const unsigned int length, bool block)
BlazeX 0:cd0d79be0c1a 194 {
BlazeX 0:cd0d79be0c1a 195 // try to put all bytes
BlazeX 0:cd0d79be0c1a 196 for(int i= 0; i < length; i++)
BlazeX 0:cd0d79be0c1a 197 if(!putc(buffer[i], block ? osWaitForever : 0))
BlazeX 0:cd0d79be0c1a 198 return i; // putc failed, but already put i bytes
BlazeX 0:cd0d79be0c1a 199
BlazeX 0:cd0d79be0c1a 200 return length; // put all bytes
BlazeX 0:cd0d79be0c1a 201 }
BlazeX 0:cd0d79be0c1a 202
miguelcordero191 4:3956012cd0c4 203 int SerialDriver::read( char * buffer, const unsigned int length, bool block)
BlazeX 0:cd0d79be0c1a 204 {
BlazeX 0:cd0d79be0c1a 205 // try to get all bytes
BlazeX 0:cd0d79be0c1a 206 int c;
BlazeX 0:cd0d79be0c1a 207 for(int i= 0; i < length; i++)
BlazeX 0:cd0d79be0c1a 208 {
BlazeX 0:cd0d79be0c1a 209 c= getc(block ? osWaitForever : 0);
BlazeX 0:cd0d79be0c1a 210 if(c < 0)
BlazeX 0:cd0d79be0c1a 211 return i; // getc failed, but already got i bytes
miguelcordero191 4:3956012cd0c4 212 buffer[i]= ( char)c;
BlazeX 0:cd0d79be0c1a 213 }
BlazeX 0:cd0d79be0c1a 214
BlazeX 0:cd0d79be0c1a 215 return length; // got all bytes
BlazeX 0:cd0d79be0c1a 216 }
BlazeX 0:cd0d79be0c1a 217
BlazeX 0:cd0d79be0c1a 218
BlazeX 0:cd0d79be0c1a 219 int SerialDriver::puts(const char * str, bool block)
BlazeX 0:cd0d79be0c1a 220 {
BlazeX 0:cd0d79be0c1a 221 // the same as write, but get length from strlen
BlazeX 0:cd0d79be0c1a 222 const int len= strlen(str);
BlazeX 0:cd0d79be0c1a 223 return write((const unsigned char *)str, len, block);
BlazeX 0:cd0d79be0c1a 224 }
BlazeX 0:cd0d79be0c1a 225
BlazeX 0:cd0d79be0c1a 226 int SerialDriver::printf(const char * format, ...)
BlazeX 0:cd0d79be0c1a 227 {
BlazeX 0:cd0d79be0c1a 228 // Parts of this are copied from mbed RawSerial ;)
BlazeX 0:cd0d79be0c1a 229 std::va_list arg;
BlazeX 0:cd0d79be0c1a 230 va_start(arg, format);
BlazeX 0:cd0d79be0c1a 231
BlazeX 0:cd0d79be0c1a 232 int length= vsnprintf(NULL, 0, format, arg);
BlazeX 0:cd0d79be0c1a 233 char *temp = new char[length + 1];
BlazeX 0:cd0d79be0c1a 234 vsprintf(temp, format, arg);
BlazeX 0:cd0d79be0c1a 235 puts(temp, true);
BlazeX 0:cd0d79be0c1a 236 delete[] temp;
BlazeX 0:cd0d79be0c1a 237
BlazeX 0:cd0d79be0c1a 238 va_end(arg);
BlazeX 0:cd0d79be0c1a 239 return length;
BlazeX 0:cd0d79be0c1a 240 }
BlazeX 0:cd0d79be0c1a 241
BlazeX 3:ea9719695b6a 242 // still thinking of XTN