Michael Spencer / Mbed 2 deprecated LaOS

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.

Dependencies:   mbed

NetServices/drv/serial/buf/SerialBuf.cpp@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Michael J. Spencer 1:f5ac63519541 1
Michael J. Spencer 1:f5ac63519541 2 /*
Michael J. Spencer 1:f5ac63519541 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
Michael J. Spencer 1:f5ac63519541 4
Michael J. Spencer 1:f5ac63519541 5 Permission is hereby granted, free of charge, to any person obtaining a copy
Michael J. Spencer 1:f5ac63519541 6 of this software and associated documentation files (the "Software"), to deal
Michael J. Spencer 1:f5ac63519541 7 in the Software without restriction, including without limitation the rights
Michael J. Spencer 1:f5ac63519541 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Michael J. Spencer 1:f5ac63519541 9 copies of the Software, and to permit persons to whom the Software is
Michael J. Spencer 1:f5ac63519541 10 furnished to do so, subject to the following conditions:
Michael J. Spencer 1:f5ac63519541 11
Michael J. Spencer 1:f5ac63519541 12 The above copyright notice and this permission notice shall be included in
Michael J. Spencer 1:f5ac63519541 13 all copies or substantial portions of the Software.
Michael J. Spencer 1:f5ac63519541 14
Michael J. Spencer 1:f5ac63519541 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Michael J. Spencer 1:f5ac63519541 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Michael J. Spencer 1:f5ac63519541 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Michael J. Spencer 1:f5ac63519541 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Michael J. Spencer 1:f5ac63519541 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Michael J. Spencer 1:f5ac63519541 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Michael J. Spencer 1:f5ac63519541 21 THE SOFTWARE.
Michael J. Spencer 1:f5ac63519541 22 */
Michael J. Spencer 1:f5ac63519541 23
Michael J. Spencer 1:f5ac63519541 24 #include "SerialBuf.h"
Michael J. Spencer 1:f5ac63519541 25 #include "mbed.h"
Michael J. Spencer 1:f5ac63519541 26
Michael J. Spencer 1:f5ac63519541 27 //#define __DEBUG
Michael J. Spencer 1:f5ac63519541 28 #include "dbg/dbg.h"
Michael J. Spencer 1:f5ac63519541 29
Michael J. Spencer 1:f5ac63519541 30 #include "netCfg.h"
Michael J. Spencer 1:f5ac63519541 31 #if NET_GPRS
Michael J. Spencer 1:f5ac63519541 32
Michael J. Spencer 1:f5ac63519541 33 #if NET_USB_SERIAL
Michael J. Spencer 1:f5ac63519541 34 #define m_pStream( a ) (m_pSerial?m_pSerial->a:m_pUsbSerial->a)
Michael J. Spencer 1:f5ac63519541 35 #else
Michael J. Spencer 1:f5ac63519541 36 #define m_pStream( a ) (m_pSerial->a)
Michael J. Spencer 1:f5ac63519541 37 #endif
Michael J. Spencer 1:f5ac63519541 38
Michael J. Spencer 1:f5ac63519541 39 //Circular buf
Michael J. Spencer 1:f5ac63519541 40
Michael J. Spencer 1:f5ac63519541 41 SerialCircularBuf::SerialCircularBuf(int len) : m_readMode(false)
Michael J. Spencer 1:f5ac63519541 42 {
Michael J. Spencer 1:f5ac63519541 43 m_buf = new char[len];
Michael J. Spencer 1:f5ac63519541 44 m_len = len;
Michael J. Spencer 1:f5ac63519541 45 m_pReadStart = m_pRead = m_buf;
Michael J. Spencer 1:f5ac63519541 46 m_pWrite = m_buf;
Michael J. Spencer 1:f5ac63519541 47 }
Michael J. Spencer 1:f5ac63519541 48
Michael J. Spencer 1:f5ac63519541 49 SerialCircularBuf::~SerialCircularBuf()
Michael J. Spencer 1:f5ac63519541 50 {
Michael J. Spencer 1:f5ac63519541 51 if(m_buf)
Michael J. Spencer 1:f5ac63519541 52 delete[] m_buf;
Michael J. Spencer 1:f5ac63519541 53 }
Michael J. Spencer 1:f5ac63519541 54
Michael J. Spencer 1:f5ac63519541 55 int SerialCircularBuf::room() //Return room available in buf
Michael J. Spencer 1:f5ac63519541 56 {
Michael J. Spencer 1:f5ac63519541 57 //return m_len - len() - 1; //-1 is to avoid loop
Michael J. Spencer 1:f5ac63519541 58 if ( m_pReadStart > m_pWrite )
Michael J. Spencer 1:f5ac63519541 59 return ( m_pReadStart - m_pWrite - 1 );
Michael J. Spencer 1:f5ac63519541 60 else
Michael J. Spencer 1:f5ac63519541 61 return m_len - ( m_pWrite - m_pReadStart ) - 1;
Michael J. Spencer 1:f5ac63519541 62 }
Michael J. Spencer 1:f5ac63519541 63
Michael J. Spencer 1:f5ac63519541 64 int SerialCircularBuf::len() //Return chars length in buf
Michael J. Spencer 1:f5ac63519541 65 {
Michael J. Spencer 1:f5ac63519541 66 if ( m_pWrite >= m_pRead )
Michael J. Spencer 1:f5ac63519541 67 return ( m_pWrite - m_pRead );
Michael J. Spencer 1:f5ac63519541 68 else
Michael J. Spencer 1:f5ac63519541 69 return m_len - ( m_pRead - m_pWrite ); // = ( ( m_buf + m_len) - m_pRead ) + ( m_pWrite - m_buf )
Michael J. Spencer 1:f5ac63519541 70 }
Michael J. Spencer 1:f5ac63519541 71
Michael J. Spencer 1:f5ac63519541 72 void SerialCircularBuf::write(char c)
Michael J. Spencer 1:f5ac63519541 73 {
Michael J. Spencer 1:f5ac63519541 74 #if 0
Michael J. Spencer 1:f5ac63519541 75 if(!room())
Michael J. Spencer 1:f5ac63519541 76 return;
Michael J. Spencer 1:f5ac63519541 77 #endif
Michael J. Spencer 1:f5ac63519541 78 //WARN: Must call room() before
Michael J. Spencer 1:f5ac63519541 79 *m_pWrite = c;
Michael J. Spencer 1:f5ac63519541 80 m_pWrite++;
Michael J. Spencer 1:f5ac63519541 81 if(m_pWrite>=m_buf+m_len)
Michael J. Spencer 1:f5ac63519541 82 m_pWrite=m_buf;
Michael J. Spencer 1:f5ac63519541 83 }
Michael J. Spencer 1:f5ac63519541 84 char SerialCircularBuf::read()
Michael J. Spencer 1:f5ac63519541 85 {
Michael J. Spencer 1:f5ac63519541 86 #if 0
Michael J. Spencer 1:f5ac63519541 87 if(!len())
Michael J. Spencer 1:f5ac63519541 88 return 0;
Michael J. Spencer 1:f5ac63519541 89 #endif
Michael J. Spencer 1:f5ac63519541 90 //WARN: Must call len() before
Michael J. Spencer 1:f5ac63519541 91 char c = *m_pRead;
Michael J. Spencer 1:f5ac63519541 92 m_pRead++;
Michael J. Spencer 1:f5ac63519541 93
Michael J. Spencer 1:f5ac63519541 94 if(m_pRead>=m_buf+m_len)
Michael J. Spencer 1:f5ac63519541 95 m_pRead=m_buf;
Michael J. Spencer 1:f5ac63519541 96
Michael J. Spencer 1:f5ac63519541 97 if(!m_readMode) //If readmode=false, trash this char
Michael J. Spencer 1:f5ac63519541 98 m_pReadStart=m_pRead;
Michael J. Spencer 1:f5ac63519541 99
Michael J. Spencer 1:f5ac63519541 100 return c;
Michael J. Spencer 1:f5ac63519541 101 }
Michael J. Spencer 1:f5ac63519541 102
Michael J. Spencer 1:f5ac63519541 103 void SerialCircularBuf::setReadMode(bool readMode) //If true, keeps chars in buf when read, false by default
Michael J. Spencer 1:f5ac63519541 104 {
Michael J. Spencer 1:f5ac63519541 105 if(m_readMode == true && readMode == false)
Michael J. Spencer 1:f5ac63519541 106 {
Michael J. Spencer 1:f5ac63519541 107 //Trash bytes that have been read
Michael J. Spencer 1:f5ac63519541 108 flushRead();
Michael J. Spencer 1:f5ac63519541 109 }
Michael J. Spencer 1:f5ac63519541 110 m_readMode = readMode;
Michael J. Spencer 1:f5ac63519541 111 }
Michael J. Spencer 1:f5ac63519541 112
Michael J. Spencer 1:f5ac63519541 113 void SerialCircularBuf::flushRead() //Delete chars that have been read & return chars len (only useful with readMode = true)
Michael J. Spencer 1:f5ac63519541 114 {
Michael J. Spencer 1:f5ac63519541 115 m_pReadStart = m_pRead;
Michael J. Spencer 1:f5ac63519541 116 }
Michael J. Spencer 1:f5ac63519541 117
Michael J. Spencer 1:f5ac63519541 118 void SerialCircularBuf::resetRead() //Go back to initial read position & return chars len (only useful with readMode = true)
Michael J. Spencer 1:f5ac63519541 119 {
Michael J. Spencer 1:f5ac63519541 120 m_pRead = m_pReadStart;
Michael J. Spencer 1:f5ac63519541 121 }
Michael J. Spencer 1:f5ac63519541 122
Michael J. Spencer 1:f5ac63519541 123 //SerialBuf
Michael J. Spencer 1:f5ac63519541 124
Michael J. Spencer 1:f5ac63519541 125 SerialBuf::SerialBuf(int len) : m_rxBuf(len), m_txBuf(len), m_pSerial(NULL) //Buffer length
Michael J. Spencer 1:f5ac63519541 126 #if NET_USB_SERIAL
Michael J. Spencer 1:f5ac63519541 127 , m_pUsbSerial(NULL)
Michael J. Spencer 1:f5ac63519541 128 #endif
Michael J. Spencer 1:f5ac63519541 129 {
Michael J. Spencer 1:f5ac63519541 130 DBG("New Serial buf@%p\n", this);
Michael J. Spencer 1:f5ac63519541 131 }
Michael J. Spencer 1:f5ac63519541 132
Michael J. Spencer 1:f5ac63519541 133 SerialBuf::~SerialBuf()
Michael J. Spencer 1:f5ac63519541 134 {
Michael J. Spencer 1:f5ac63519541 135
Michael J. Spencer 1:f5ac63519541 136 }
Michael J. Spencer 1:f5ac63519541 137
Michael J. Spencer 1:f5ac63519541 138 void SerialBuf::attach(Serial* pSerial)
Michael J. Spencer 1:f5ac63519541 139 {
Michael J. Spencer 1:f5ac63519541 140 DBG("Serial buf@%p in attach\n", this);
Michael J. Spencer 1:f5ac63519541 141 m_pSerial = pSerial;
Michael J. Spencer 1:f5ac63519541 142 m_pSerial->attach<SerialBuf>(this, &SerialBuf::onRxInterrupt, Serial::RxIrq);
Michael J. Spencer 1:f5ac63519541 143 m_pSerial->attach<SerialBuf>(this, &SerialBuf::onTxInterrupt, Serial::TxIrq);
Michael J. Spencer 1:f5ac63519541 144 onRxInterrupt(); //Read data
Michael J. Spencer 1:f5ac63519541 145 }
Michael J. Spencer 1:f5ac63519541 146
Michael J. Spencer 1:f5ac63519541 147 void SerialBuf::detach()
Michael J. Spencer 1:f5ac63519541 148 {
Michael J. Spencer 1:f5ac63519541 149 if(m_pSerial)
Michael J. Spencer 1:f5ac63519541 150 {
Michael J. Spencer 1:f5ac63519541 151 m_pSerial->attach<SerialBuf>(NULL, NULL, Serial::RxIrq);
Michael J. Spencer 1:f5ac63519541 152 m_pSerial->attach<SerialBuf>(NULL, NULL, Serial::TxIrq);
Michael J. Spencer 1:f5ac63519541 153 m_pSerial = NULL;
Michael J. Spencer 1:f5ac63519541 154 }
Michael J. Spencer 1:f5ac63519541 155 #if NET_USB_SERIAL
Michael J. Spencer 1:f5ac63519541 156 else if(m_pUsbSerial)
Michael J. Spencer 1:f5ac63519541 157 {
Michael J. Spencer 1:f5ac63519541 158 m_pUsbSerial->attach<SerialBuf>(NULL, NULL, UsbSerial::RxIrq);
Michael J. Spencer 1:f5ac63519541 159 m_pUsbSerial->attach<SerialBuf>(NULL, NULL, UsbSerial::TxIrq);
Michael J. Spencer 1:f5ac63519541 160 m_pUsbSerial = NULL;
Michael J. Spencer 1:f5ac63519541 161 }
Michael J. Spencer 1:f5ac63519541 162 #endif
Michael J. Spencer 1:f5ac63519541 163 }
Michael J. Spencer 1:f5ac63519541 164
Michael J. Spencer 1:f5ac63519541 165 #if NET_USB_SERIAL
Michael J. Spencer 1:f5ac63519541 166 void SerialBuf::attach(UsbSerial* pUsbSerial)
Michael J. Spencer 1:f5ac63519541 167 {
Michael J. Spencer 1:f5ac63519541 168 m_pUsbSerial = pUsbSerial;
Michael J. Spencer 1:f5ac63519541 169 m_pUsbSerial->attach<SerialBuf>(this, &SerialBuf::onRxInterrupt, UsbSerial::RxIrq);
Michael J. Spencer 1:f5ac63519541 170 m_pUsbSerial->attach<SerialBuf>(this, &SerialBuf::onTxInterrupt, UsbSerial::TxIrq);
Michael J. Spencer 1:f5ac63519541 171 onRxInterrupt(); //Read data
Michael J. Spencer 1:f5ac63519541 172 }
Michael J. Spencer 1:f5ac63519541 173 #endif
Michael J. Spencer 1:f5ac63519541 174
Michael J. Spencer 1:f5ac63519541 175 char SerialBuf::getc()
Michael J. Spencer 1:f5ac63519541 176 {
Michael J. Spencer 1:f5ac63519541 177 while(!readable());
Michael J. Spencer 1:f5ac63519541 178 char c = m_rxBuf.read();
Michael J. Spencer 1:f5ac63519541 179 return c;
Michael J. Spencer 1:f5ac63519541 180 }
Michael J. Spencer 1:f5ac63519541 181
Michael J. Spencer 1:f5ac63519541 182 void SerialBuf::putc(char c)
Michael J. Spencer 1:f5ac63519541 183 {
Michael J. Spencer 1:f5ac63519541 184 while(!writeable());
Michael J. Spencer 1:f5ac63519541 185 m_txBuf.write(c);
Michael J. Spencer 1:f5ac63519541 186 onTxInterrupt();
Michael J. Spencer 1:f5ac63519541 187 }
Michael J. Spencer 1:f5ac63519541 188
Michael J. Spencer 1:f5ac63519541 189 bool SerialBuf::readable()
Michael J. Spencer 1:f5ac63519541 190 {
Michael J. Spencer 1:f5ac63519541 191 if( !m_rxBuf.len() ) //Fill buf if possible
Michael J. Spencer 1:f5ac63519541 192 onRxInterrupt();
Michael J. Spencer 1:f5ac63519541 193 return (m_rxBuf.len() > 0);
Michael J. Spencer 1:f5ac63519541 194 }
Michael J. Spencer 1:f5ac63519541 195
Michael J. Spencer 1:f5ac63519541 196 bool SerialBuf::writeable()
Michael J. Spencer 1:f5ac63519541 197 {
Michael J. Spencer 1:f5ac63519541 198 if( !m_txBuf.room() ) //Free buf is possible
Michael J. Spencer 1:f5ac63519541 199 onTxInterrupt();
Michael J. Spencer 1:f5ac63519541 200 return (m_txBuf.room() > 0);
Michael J. Spencer 1:f5ac63519541 201 }
Michael J. Spencer 1:f5ac63519541 202
Michael J. Spencer 1:f5ac63519541 203 void SerialBuf::setReadMode(bool readMode) //If true, keeps chars in buf when read, false by default
Michael J. Spencer 1:f5ac63519541 204 {
Michael J. Spencer 1:f5ac63519541 205 m_rxBuf.setReadMode(readMode);
Michael J. Spencer 1:f5ac63519541 206 }
Michael J. Spencer 1:f5ac63519541 207
Michael J. Spencer 1:f5ac63519541 208 void SerialBuf::flushRead() //Delete chars that have been read & return chars len (only useful with readMode = true)
Michael J. Spencer 1:f5ac63519541 209 {
Michael J. Spencer 1:f5ac63519541 210 m_rxBuf.flushRead();
Michael J. Spencer 1:f5ac63519541 211 }
Michael J. Spencer 1:f5ac63519541 212
Michael J. Spencer 1:f5ac63519541 213 void SerialBuf::resetRead() //Go back to initial read position & return chars len (only useful with readMode = true)
Michael J. Spencer 1:f5ac63519541 214 {
Michael J. Spencer 1:f5ac63519541 215 m_rxBuf.resetRead();
Michael J. Spencer 1:f5ac63519541 216 }
Michael J. Spencer 1:f5ac63519541 217
Michael J. Spencer 1:f5ac63519541 218 void SerialBuf::onRxInterrupt() //Callback from m_pSerial
Michael J. Spencer 1:f5ac63519541 219 {
Michael J. Spencer 1:f5ac63519541 220 while( m_rxBuf.room() && m_pStream(readable()) )
Michael J. Spencer 1:f5ac63519541 221 {
Michael J. Spencer 1:f5ac63519541 222 m_rxBuf.write(m_pStream(getc()));
Michael J. Spencer 1:f5ac63519541 223 }
Michael J. Spencer 1:f5ac63519541 224 }
Michael J. Spencer 1:f5ac63519541 225
Michael J. Spencer 1:f5ac63519541 226 void SerialBuf::onTxInterrupt() //Callback from m_pSerial
Michael J. Spencer 1:f5ac63519541 227 {
Michael J. Spencer 1:f5ac63519541 228 while( m_txBuf.len() && m_pStream(writeable()) )
Michael J. Spencer 1:f5ac63519541 229 {
Michael J. Spencer 1:f5ac63519541 230 m_pStream(putc(m_txBuf.read()));
Michael J. Spencer 1:f5ac63519541 231 }
Michael J. Spencer 1:f5ac63519541 232 }
Michael J. Spencer 1:f5ac63519541 233
Michael J. Spencer 1:f5ac63519541 234
Michael J. Spencer 1:f5ac63519541 235 #endif