Brandon Fictorie / Mbed 2 deprecated BF_Websocket

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@0:8cdad1c73e8e, 2012-03-25 (annotated)

Committer:
bfictorie
Date:
Sun Mar 25 17:26:30 2012 +0000
Revision:
0:8cdad1c73e8e

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


bfictorie

0:8cdad1c73e8e


     1







bfictorie

0:8cdad1c73e8e


     2

/*





bfictorie

0:8cdad1c73e8e


     3

Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)





bfictorie

0:8cdad1c73e8e


     4

 





bfictorie

0:8cdad1c73e8e


     5

Permission is hereby granted, free of charge, to any person obtaining a copy





bfictorie

0:8cdad1c73e8e


     6

of this software and associated documentation files (the "Software"), to deal





bfictorie

0:8cdad1c73e8e


     7

in the Software without restriction, including without limitation the rights





bfictorie

0:8cdad1c73e8e


     8

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell





bfictorie

0:8cdad1c73e8e


     9

copies of the Software, and to permit persons to whom the Software is





bfictorie

0:8cdad1c73e8e


    10

furnished to do so, subject to the following conditions:





bfictorie

0:8cdad1c73e8e


    11

 





bfictorie

0:8cdad1c73e8e


    12

The above copyright notice and this permission notice shall be included in





bfictorie

0:8cdad1c73e8e


    13

all copies or substantial portions of the Software.





bfictorie

0:8cdad1c73e8e


    14

 





bfictorie

0:8cdad1c73e8e


    15

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR





bfictorie

0:8cdad1c73e8e


    16

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,





bfictorie

0:8cdad1c73e8e


    17

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE





bfictorie

0:8cdad1c73e8e


    18

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER





bfictorie

0:8cdad1c73e8e


    19

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,





bfictorie

0:8cdad1c73e8e


    20

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN





bfictorie

0:8cdad1c73e8e


    21

THE SOFTWARE.





bfictorie

0:8cdad1c73e8e


    22

*/





bfictorie

0:8cdad1c73e8e


    23







bfictorie

0:8cdad1c73e8e


    24

#include "SerialBuf.h"





bfictorie

0:8cdad1c73e8e


    25

#include "mbed.h"





bfictorie

0:8cdad1c73e8e


    26







bfictorie

0:8cdad1c73e8e


    27

//#define __DEBUG





bfictorie

0:8cdad1c73e8e


    28

#include "dbg/dbg.h"





bfictorie

0:8cdad1c73e8e


    29







bfictorie

0:8cdad1c73e8e


    30

#include "netCfg.h"





bfictorie

0:8cdad1c73e8e


    31

#if NET_GPRS





bfictorie

0:8cdad1c73e8e


    32







bfictorie

0:8cdad1c73e8e


    33

#if NET_USB_SERIAL





bfictorie

0:8cdad1c73e8e


    34

#define m_pStream( a ) (m_pSerial?m_pSerial->a:m_pUsbSerial->a)





bfictorie

0:8cdad1c73e8e


    35

#else





bfictorie

0:8cdad1c73e8e


    36

#define m_pStream( a ) (m_pSerial->a)





bfictorie

0:8cdad1c73e8e


    37

#endif





bfictorie

0:8cdad1c73e8e


    38







bfictorie

0:8cdad1c73e8e


    39

//Circular buf





bfictorie

0:8cdad1c73e8e


    40







bfictorie

0:8cdad1c73e8e


    41

SerialCircularBuf::SerialCircularBuf(int len) : m_readMode(false)





bfictorie

0:8cdad1c73e8e


    42

{





bfictorie

0:8cdad1c73e8e


    43

  m_buf = new char[len];





bfictorie

0:8cdad1c73e8e


    44

  m_len = len;





bfictorie

0:8cdad1c73e8e


    45

  m_pReadStart = m_pRead = m_buf;





bfictorie

0:8cdad1c73e8e


    46

  m_pWrite = m_buf;





bfictorie

0:8cdad1c73e8e


    47

} 





bfictorie

0:8cdad1c73e8e


    48







bfictorie

0:8cdad1c73e8e


    49

SerialCircularBuf::~SerialCircularBuf()





bfictorie

0:8cdad1c73e8e


    50

{





bfictorie

0:8cdad1c73e8e


    51

  if(m_buf)





bfictorie

0:8cdad1c73e8e


    52

    delete[] m_buf;





bfictorie

0:8cdad1c73e8e


    53

}





bfictorie

0:8cdad1c73e8e


    54







bfictorie

0:8cdad1c73e8e


    55

int SerialCircularBuf::room() //Return room available in buf





bfictorie

0:8cdad1c73e8e


    56

{





bfictorie

0:8cdad1c73e8e


    57

  //return m_len - len() - 1; //-1 is to avoid loop





bfictorie

0:8cdad1c73e8e


    58

  if ( m_pReadStart > m_pWrite )





bfictorie

0:8cdad1c73e8e


    59

    return ( m_pReadStart - m_pWrite - 1 );





bfictorie

0:8cdad1c73e8e


    60

  else





bfictorie

0:8cdad1c73e8e


    61

    return m_len - ( m_pWrite - m_pReadStart ) - 1;





bfictorie

0:8cdad1c73e8e


    62

}





bfictorie

0:8cdad1c73e8e


    63







bfictorie

0:8cdad1c73e8e


    64

int SerialCircularBuf::len() //Return chars length in buf





bfictorie

0:8cdad1c73e8e


    65

{





bfictorie

0:8cdad1c73e8e


    66

  if ( m_pWrite >= m_pRead )





bfictorie

0:8cdad1c73e8e


    67

    return ( m_pWrite - m_pRead );





bfictorie

0:8cdad1c73e8e


    68

  else





bfictorie

0:8cdad1c73e8e


    69

    return m_len - ( m_pRead - m_pWrite ); // = ( ( m_buf + m_len) - m_pRead ) + ( m_pWrite - m_buf )





bfictorie

0:8cdad1c73e8e


    70

}





bfictorie

0:8cdad1c73e8e


    71







bfictorie

0:8cdad1c73e8e


    72

void SerialCircularBuf::write(char c)





bfictorie

0:8cdad1c73e8e


    73

{





bfictorie

0:8cdad1c73e8e


    74

#if 0





bfictorie

0:8cdad1c73e8e


    75

  if(!room())





bfictorie

0:8cdad1c73e8e


    76

    return;





bfictorie

0:8cdad1c73e8e


    77

#endif





bfictorie

0:8cdad1c73e8e


    78

  //WARN: Must call room() before





bfictorie

0:8cdad1c73e8e


    79

  *m_pWrite = c;





bfictorie

0:8cdad1c73e8e


    80

  m_pWrite++;





bfictorie

0:8cdad1c73e8e


    81

  if(m_pWrite>=m_buf+m_len)





bfictorie

0:8cdad1c73e8e


    82

    m_pWrite=m_buf;





bfictorie

0:8cdad1c73e8e


    83

}





bfictorie

0:8cdad1c73e8e


    84

char SerialCircularBuf::read()





bfictorie

0:8cdad1c73e8e


    85

{





bfictorie

0:8cdad1c73e8e


    86

#if 0





bfictorie

0:8cdad1c73e8e


    87

  if(!len())





bfictorie

0:8cdad1c73e8e


    88

    return 0;





bfictorie

0:8cdad1c73e8e


    89

#endif





bfictorie

0:8cdad1c73e8e


    90

  //WARN: Must call len() before





bfictorie

0:8cdad1c73e8e


    91

  char c = *m_pRead;





bfictorie

0:8cdad1c73e8e


    92

  m_pRead++;





bfictorie

0:8cdad1c73e8e


    93

  





bfictorie

0:8cdad1c73e8e


    94

  if(m_pRead>=m_buf+m_len)





bfictorie

0:8cdad1c73e8e


    95

    m_pRead=m_buf;





bfictorie

0:8cdad1c73e8e


    96

    





bfictorie

0:8cdad1c73e8e


    97

  if(!m_readMode) //If readmode=false, trash this char





bfictorie

0:8cdad1c73e8e


    98

    m_pReadStart=m_pRead;





bfictorie

0:8cdad1c73e8e


    99

    





bfictorie

0:8cdad1c73e8e


   100

  return c;





bfictorie

0:8cdad1c73e8e


   101

}





bfictorie

0:8cdad1c73e8e


   102







bfictorie

0:8cdad1c73e8e


   103

void SerialCircularBuf::setReadMode(bool readMode) //If true, keeps chars in buf when read, false by default





bfictorie

0:8cdad1c73e8e


   104

{





bfictorie

0:8cdad1c73e8e


   105

  if(m_readMode == true && readMode == false)





bfictorie

0:8cdad1c73e8e


   106

  {





bfictorie

0:8cdad1c73e8e


   107

    //Trash bytes that have been read





bfictorie

0:8cdad1c73e8e


   108

    flushRead();





bfictorie

0:8cdad1c73e8e


   109

  }





bfictorie

0:8cdad1c73e8e


   110

  m_readMode = readMode;





bfictorie

0:8cdad1c73e8e


   111

}





bfictorie

0:8cdad1c73e8e


   112







bfictorie

0:8cdad1c73e8e


   113

void SerialCircularBuf::flushRead() //Delete chars that have been read & return chars len (only useful with readMode = true)





bfictorie

0:8cdad1c73e8e


   114

{





bfictorie

0:8cdad1c73e8e


   115

  m_pReadStart = m_pRead;





bfictorie

0:8cdad1c73e8e


   116

}





bfictorie

0:8cdad1c73e8e


   117







bfictorie

0:8cdad1c73e8e


   118

void SerialCircularBuf::resetRead() //Go back to initial read position & return chars len (only useful with readMode = true)





bfictorie

0:8cdad1c73e8e


   119

{





bfictorie

0:8cdad1c73e8e


   120

  m_pRead = m_pReadStart;





bfictorie

0:8cdad1c73e8e


   121

}





bfictorie

0:8cdad1c73e8e


   122







bfictorie

0:8cdad1c73e8e


   123

//SerialBuf





bfictorie

0:8cdad1c73e8e


   124







bfictorie

0:8cdad1c73e8e


   125

SerialBuf::SerialBuf(int len) : m_rxBuf(len), m_txBuf(len), m_pSerial(NULL) //Buffer length





bfictorie

0:8cdad1c73e8e


   126

#if NET_USB_SERIAL





bfictorie

0:8cdad1c73e8e


   127

, m_pUsbSerial(NULL) 





bfictorie

0:8cdad1c73e8e


   128

#endif





bfictorie

0:8cdad1c73e8e


   129

{





bfictorie

0:8cdad1c73e8e


   130

  DBG("New Serial buf@%p\n", this);





bfictorie

0:8cdad1c73e8e


   131

}





bfictorie

0:8cdad1c73e8e


   132







bfictorie

0:8cdad1c73e8e


   133

SerialBuf::~SerialBuf()





bfictorie

0:8cdad1c73e8e


   134

{





bfictorie

0:8cdad1c73e8e


   135







bfictorie

0:8cdad1c73e8e


   136

}





bfictorie

0:8cdad1c73e8e


   137







bfictorie

0:8cdad1c73e8e


   138

void SerialBuf::attach(Serial* pSerial)





bfictorie

0:8cdad1c73e8e


   139

{





bfictorie

0:8cdad1c73e8e


   140

  DBG("Serial buf@%p in attach\n", this);





bfictorie

0:8cdad1c73e8e


   141

  m_pSerial = pSerial;





bfictorie

0:8cdad1c73e8e


   142

  m_pSerial->attach<SerialBuf>(this, &SerialBuf::onRxInterrupt, Serial::RxIrq);





bfictorie

0:8cdad1c73e8e


   143

  m_pSerial->attach<SerialBuf>(this, &SerialBuf::onTxInterrupt, Serial::TxIrq);





bfictorie

0:8cdad1c73e8e


   144

  onRxInterrupt(); //Read data





bfictorie

0:8cdad1c73e8e


   145

}





bfictorie

0:8cdad1c73e8e


   146







bfictorie

0:8cdad1c73e8e


   147

void SerialBuf::detach()





bfictorie

0:8cdad1c73e8e


   148

{





bfictorie

0:8cdad1c73e8e


   149

  if(m_pSerial)





bfictorie

0:8cdad1c73e8e


   150

  {





bfictorie

0:8cdad1c73e8e


   151

    m_pSerial->attach<SerialBuf>(NULL, NULL, Serial::RxIrq);





bfictorie

0:8cdad1c73e8e


   152

    m_pSerial->attach<SerialBuf>(NULL, NULL, Serial::TxIrq);





bfictorie

0:8cdad1c73e8e


   153

    m_pSerial = NULL;





bfictorie

0:8cdad1c73e8e


   154

  }





bfictorie

0:8cdad1c73e8e


   155

  #if NET_USB_SERIAL





bfictorie

0:8cdad1c73e8e


   156

  else if(m_pUsbSerial)





bfictorie

0:8cdad1c73e8e


   157

  {





bfictorie

0:8cdad1c73e8e


   158

    m_pUsbSerial->attach<SerialBuf>(NULL, NULL, UsbSerial::RxIrq);





bfictorie

0:8cdad1c73e8e


   159

    m_pUsbSerial->attach<SerialBuf>(NULL, NULL, UsbSerial::TxIrq);





bfictorie

0:8cdad1c73e8e


   160

    m_pUsbSerial = NULL;





bfictorie

0:8cdad1c73e8e


   161

  }





bfictorie

0:8cdad1c73e8e


   162

  #endif





bfictorie

0:8cdad1c73e8e


   163

}





bfictorie

0:8cdad1c73e8e


   164







bfictorie

0:8cdad1c73e8e


   165

#if NET_USB_SERIAL





bfictorie

0:8cdad1c73e8e


   166

void SerialBuf::attach(UsbSerial* pUsbSerial)





bfictorie

0:8cdad1c73e8e


   167

{





bfictorie

0:8cdad1c73e8e


   168

  m_pUsbSerial = pUsbSerial;





bfictorie

0:8cdad1c73e8e


   169

  m_pUsbSerial->attach<SerialBuf>(this, &SerialBuf::onRxInterrupt, UsbSerial::RxIrq);





bfictorie

0:8cdad1c73e8e


   170

  m_pUsbSerial->attach<SerialBuf>(this, &SerialBuf::onTxInterrupt, UsbSerial::TxIrq);





bfictorie

0:8cdad1c73e8e


   171

  onRxInterrupt(); //Read data





bfictorie

0:8cdad1c73e8e


   172

}





bfictorie

0:8cdad1c73e8e


   173

#endif





bfictorie

0:8cdad1c73e8e


   174







bfictorie

0:8cdad1c73e8e


   175

char SerialBuf::getc()





bfictorie

0:8cdad1c73e8e


   176

{





bfictorie

0:8cdad1c73e8e


   177

  while(!readable());





bfictorie

0:8cdad1c73e8e


   178

  char c = m_rxBuf.read();





bfictorie

0:8cdad1c73e8e


   179

  return c;





bfictorie

0:8cdad1c73e8e


   180

}





bfictorie

0:8cdad1c73e8e


   181







bfictorie

0:8cdad1c73e8e


   182

void SerialBuf::putc(char c)





bfictorie

0:8cdad1c73e8e


   183

{





bfictorie

0:8cdad1c73e8e


   184

  while(!writeable());





bfictorie

0:8cdad1c73e8e


   185

  m_txBuf.write(c);





bfictorie

0:8cdad1c73e8e


   186

  onTxInterrupt();





bfictorie

0:8cdad1c73e8e


   187

}





bfictorie

0:8cdad1c73e8e


   188







bfictorie

0:8cdad1c73e8e


   189

bool SerialBuf::readable()





bfictorie

0:8cdad1c73e8e


   190

{





bfictorie

0:8cdad1c73e8e


   191

  if( !m_rxBuf.len() ) //Fill buf if possible





bfictorie

0:8cdad1c73e8e


   192

    onRxInterrupt();





bfictorie

0:8cdad1c73e8e


   193

  return (m_rxBuf.len() > 0);





bfictorie

0:8cdad1c73e8e


   194

}





bfictorie

0:8cdad1c73e8e


   195







bfictorie

0:8cdad1c73e8e


   196

bool SerialBuf::writeable()





bfictorie

0:8cdad1c73e8e


   197

{





bfictorie

0:8cdad1c73e8e


   198

  if( !m_txBuf.room() ) //Free buf is possible





bfictorie

0:8cdad1c73e8e


   199

    onTxInterrupt();





bfictorie

0:8cdad1c73e8e


   200

  return (m_txBuf.room() > 0);





bfictorie

0:8cdad1c73e8e


   201

}





bfictorie

0:8cdad1c73e8e


   202







bfictorie

0:8cdad1c73e8e


   203

void SerialBuf::setReadMode(bool readMode) //If true, keeps chars in buf when read, false by default





bfictorie

0:8cdad1c73e8e


   204

{





bfictorie

0:8cdad1c73e8e


   205

  m_rxBuf.setReadMode(readMode);





bfictorie

0:8cdad1c73e8e


   206

}





bfictorie

0:8cdad1c73e8e


   207







bfictorie

0:8cdad1c73e8e


   208

void SerialBuf::flushRead() //Delete chars that have been read & return chars len (only useful with readMode = true)





bfictorie

0:8cdad1c73e8e


   209

{





bfictorie

0:8cdad1c73e8e


   210

  m_rxBuf.flushRead();





bfictorie

0:8cdad1c73e8e


   211

}





bfictorie

0:8cdad1c73e8e


   212







bfictorie

0:8cdad1c73e8e


   213

void SerialBuf::resetRead() //Go back to initial read position & return chars len (only useful with readMode = true)





bfictorie

0:8cdad1c73e8e


   214

{





bfictorie

0:8cdad1c73e8e


   215

  m_rxBuf.resetRead();





bfictorie

0:8cdad1c73e8e


   216

}





bfictorie

0:8cdad1c73e8e


   217







bfictorie

0:8cdad1c73e8e


   218

void SerialBuf::onRxInterrupt() //Callback from m_pSerial





bfictorie

0:8cdad1c73e8e


   219

{





bfictorie

0:8cdad1c73e8e


   220

  while( m_rxBuf.room() && m_pStream(readable()) )





bfictorie

0:8cdad1c73e8e


   221

  {





bfictorie

0:8cdad1c73e8e


   222

    m_rxBuf.write(m_pStream(getc()));





bfictorie

0:8cdad1c73e8e


   223

  }





bfictorie

0:8cdad1c73e8e


   224

}





bfictorie

0:8cdad1c73e8e


   225







bfictorie

0:8cdad1c73e8e


   226

void SerialBuf::onTxInterrupt() //Callback from m_pSerial





bfictorie

0:8cdad1c73e8e


   227

{





bfictorie

0:8cdad1c73e8e


   228

  while( m_txBuf.len() && m_pStream(writeable()) )





bfictorie

0:8cdad1c73e8e


   229

  {





bfictorie

0:8cdad1c73e8e


   230

    m_pStream(putc(m_txBuf.read()));





bfictorie

0:8cdad1c73e8e


   231

  }





bfictorie

0:8cdad1c73e8e


   232

}





bfictorie

0:8cdad1c73e8e


   233







bfictorie

0:8cdad1c73e8e


   234







bfictorie

0:8cdad1c73e8e


   235

#endif