Donatien Garnier / NetServicesSource

NetServices Stack source

Dependents:   HelloWorld ServoInterfaceBoardExample1 4180_Lab4

drv/serial/buf/SerialBuf.cpp@4:fd826cad83c0, 2010-07-09 (annotated)

Committer:
donatien
Date:
Fri Jul 09 14:46:47 2010 +0000
Revision:
4:fd826cad83c0
Parent:
0:632c9925f013
Child:
9:c79fa4034f5b

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


donatien

0:632c9925f013


     1







donatien

0:632c9925f013


     2

/*





donatien

0:632c9925f013


     3

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





donatien

0:632c9925f013


     4

 





donatien

0:632c9925f013


     5

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





donatien

0:632c9925f013


     6

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





donatien

0:632c9925f013


     7

in the Software without restriction, including without limitation the rights





donatien

0:632c9925f013


     8

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





donatien

0:632c9925f013


     9

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





donatien

0:632c9925f013


    10

furnished to do so, subject to the following conditions:





donatien

0:632c9925f013


    11

 





donatien

0:632c9925f013


    12

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





donatien

0:632c9925f013


    13

all copies or substantial portions of the Software.





donatien

0:632c9925f013


    14

 





donatien

0:632c9925f013


    15

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





donatien

0:632c9925f013


    16

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





donatien

0:632c9925f013


    17

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





donatien

0:632c9925f013


    18

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





donatien

0:632c9925f013


    19

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





donatien

0:632c9925f013


    20

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





donatien

0:632c9925f013


    21

THE SOFTWARE.





donatien

0:632c9925f013


    22

*/





donatien

0:632c9925f013


    23







donatien

0:632c9925f013


    24

#include "SerialBuf.h"





donatien

0:632c9925f013


    25

#include "mbed.h"





donatien

0:632c9925f013


    26







donatien

0:632c9925f013


    27

//#define __DEBUG





donatien

0:632c9925f013


    28

#include "dbg/dbg.h"





donatien

0:632c9925f013


    29







donatien

0:632c9925f013


    30

#include "netCfg.h"





donatien

0:632c9925f013


    31

#if NET_GPRS





donatien

0:632c9925f013


    32







donatien

0:632c9925f013


    33

#if NET_USB_SERIAL





donatien

0:632c9925f013


    34

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





donatien

0:632c9925f013


    35

#else





donatien

0:632c9925f013


    36

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





donatien

0:632c9925f013


    37

#endif





donatien

0:632c9925f013


    38







donatien

4:fd826cad83c0


    39

//Circular buf





donatien

4:fd826cad83c0


    40







donatien

4:fd826cad83c0


    41

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





donatien

4:fd826cad83c0


    42

{





donatien

4:fd826cad83c0


    43

  m_buf = new char[len];





donatien

4:fd826cad83c0


    44

  m_len = len;





donatien

4:fd826cad83c0


    45

  m_pReadStart = m_pRead = m_buf;





donatien

4:fd826cad83c0


    46

  m_pWrite = m_buf;





donatien

4:fd826cad83c0


    47

} 





donatien

4:fd826cad83c0


    48







donatien

4:fd826cad83c0


    49

SerialCircularBuf::~SerialCircularBuf()





donatien

4:fd826cad83c0


    50

{





donatien

4:fd826cad83c0


    51

  if(m_buf)





donatien

4:fd826cad83c0


    52

    delete[] m_buf;





donatien

4:fd826cad83c0


    53

}





donatien

4:fd826cad83c0


    54







donatien

4:fd826cad83c0


    55

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





donatien

4:fd826cad83c0


    56

{





donatien

4:fd826cad83c0


    57

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





donatien

4:fd826cad83c0


    58

  if ( m_pReadStart > m_pWrite )





donatien

4:fd826cad83c0


    59

    return ( m_pReadStart - m_pWrite - 1 );





donatien

4:fd826cad83c0


    60

  else





donatien

4:fd826cad83c0


    61

    return m_len - ( m_pWrite - m_pReadStart ) - 1;





donatien

4:fd826cad83c0


    62

}





donatien

4:fd826cad83c0


    63







donatien

4:fd826cad83c0


    64

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





donatien

4:fd826cad83c0


    65

{





donatien

4:fd826cad83c0


    66

  if ( m_pWrite >= m_pRead )





donatien

4:fd826cad83c0


    67

    return ( m_pWrite - m_pRead );





donatien

4:fd826cad83c0


    68

  else





donatien

4:fd826cad83c0


    69

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





donatien

4:fd826cad83c0


    70

}





donatien

4:fd826cad83c0


    71







donatien

4:fd826cad83c0


    72

void SerialCircularBuf::write(char c)





donatien

4:fd826cad83c0


    73

{





donatien

4:fd826cad83c0


    74

#if 0





donatien

4:fd826cad83c0


    75

  if(!room())





donatien

4:fd826cad83c0


    76

    return;





donatien

4:fd826cad83c0


    77

#endif





donatien

4:fd826cad83c0


    78

  //WARN: Must call room() before





donatien

4:fd826cad83c0


    79

  *m_pWrite = c;





donatien

4:fd826cad83c0


    80

  m_pWrite++;





donatien

4:fd826cad83c0


    81

  if(m_pWrite>=m_buf+m_len)





donatien

4:fd826cad83c0


    82

    m_pWrite=m_buf;





donatien

4:fd826cad83c0


    83

}





donatien

4:fd826cad83c0


    84

char SerialCircularBuf::read()





donatien

4:fd826cad83c0


    85

{





donatien

4:fd826cad83c0


    86

#if 0





donatien

4:fd826cad83c0


    87

  if(!len())





donatien

4:fd826cad83c0


    88

    return 0;





donatien

4:fd826cad83c0


    89

#endif





donatien

4:fd826cad83c0


    90

  //WARN: Must call len() before





donatien

4:fd826cad83c0


    91

  char c = *m_pRead;





donatien

4:fd826cad83c0


    92

  m_pRead++;





donatien

4:fd826cad83c0


    93

  





donatien

4:fd826cad83c0


    94

  if(m_pRead>=m_buf+m_len)





donatien

4:fd826cad83c0


    95

    m_pRead=m_buf;





donatien

4:fd826cad83c0


    96

    





donatien

4:fd826cad83c0


    97

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





donatien

4:fd826cad83c0


    98

    m_pReadStart=m_pRead;





donatien

4:fd826cad83c0


    99

    





donatien

4:fd826cad83c0


   100

  return c;





donatien

4:fd826cad83c0


   101

}





donatien

4:fd826cad83c0


   102







donatien

4:fd826cad83c0


   103

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





donatien

4:fd826cad83c0


   104

{





donatien

4:fd826cad83c0


   105

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





donatien

4:fd826cad83c0


   106

  {





donatien

4:fd826cad83c0


   107

    //Trash bytes that have been read





donatien

4:fd826cad83c0


   108

    flushRead();





donatien

4:fd826cad83c0


   109

  }





donatien

4:fd826cad83c0


   110

  m_readMode = readMode;





donatien

4:fd826cad83c0


   111

}





donatien

4:fd826cad83c0


   112







donatien

4:fd826cad83c0


   113

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





donatien

4:fd826cad83c0


   114

{





donatien

4:fd826cad83c0


   115

  m_pReadStart = m_pRead;





donatien

4:fd826cad83c0


   116

}





donatien

4:fd826cad83c0


   117







donatien

4:fd826cad83c0


   118

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





donatien

4:fd826cad83c0


   119

{





donatien

4:fd826cad83c0


   120

  m_pRead = m_pReadStart;





donatien

4:fd826cad83c0


   121

}





donatien

4:fd826cad83c0


   122







donatien

4:fd826cad83c0


   123

//SerialBuf





donatien

4:fd826cad83c0


   124







donatien

4:fd826cad83c0


   125

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





donatien

0:632c9925f013


   126

#if NET_USB_SERIAL





donatien

0:632c9925f013


   127

, m_pUsbSerial(NULL) 





donatien

0:632c9925f013


   128

#endif





donatien

0:632c9925f013


   129

{





donatien

4:fd826cad83c0


   130

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





donatien

0:632c9925f013


   131

}





donatien

0:632c9925f013


   132







donatien

0:632c9925f013


   133

SerialBuf::~SerialBuf()





donatien

0:632c9925f013


   134

{





donatien

4:fd826cad83c0


   135







donatien

0:632c9925f013


   136

}





donatien

0:632c9925f013


   137







donatien

0:632c9925f013


   138

void SerialBuf::attach(Serial* pSerial)





donatien

0:632c9925f013


   139

{





donatien

4:fd826cad83c0


   140

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





donatien

0:632c9925f013


   141

  m_pSerial = pSerial;





donatien

4:fd826cad83c0


   142

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





donatien

4:fd826cad83c0


   143

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





donatien

4:fd826cad83c0


   144

  onRxInterrupt(); //Read data





donatien

4:fd826cad83c0


   145

}





donatien

4:fd826cad83c0


   146







donatien

4:fd826cad83c0


   147

void SerialBuf::detach()





donatien

4:fd826cad83c0


   148

{





donatien

4:fd826cad83c0


   149

  if(m_pSerial)





donatien

4:fd826cad83c0


   150

  {





donatien

4:fd826cad83c0


   151

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





donatien

4:fd826cad83c0


   152

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





donatien

4:fd826cad83c0


   153

    m_pSerial = NULL;





donatien

4:fd826cad83c0


   154

  }





donatien

4:fd826cad83c0


   155

  #if NET_USB_SERIAL





donatien

4:fd826cad83c0


   156

  else if(m_pUsbSerial)





donatien

4:fd826cad83c0


   157

  {





donatien

4:fd826cad83c0


   158

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





donatien

4:fd826cad83c0


   159

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





donatien

4:fd826cad83c0


   160

    m_pUsbSerial = NULL;





donatien

4:fd826cad83c0


   161

  }





donatien

4:fd826cad83c0


   162

  #endif





donatien

0:632c9925f013


   163

}





donatien

0:632c9925f013


   164







donatien

0:632c9925f013


   165

#if NET_USB_SERIAL





donatien

0:632c9925f013


   166

void SerialBuf::attach(UsbSerial* pUsbSerial)





donatien

0:632c9925f013


   167

{





donatien

0:632c9925f013


   168

  m_pUsbSerial = pUsbSerial;





donatien

4:fd826cad83c0


   169

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





donatien

4:fd826cad83c0


   170

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





donatien

4:fd826cad83c0


   171

  onRxInterrupt(); //Read data





donatien

0:632c9925f013


   172

}





donatien

0:632c9925f013


   173

#endif





donatien

0:632c9925f013


   174







donatien

0:632c9925f013


   175

char SerialBuf::getc()





donatien

0:632c9925f013


   176

{





donatien

4:fd826cad83c0


   177

  while(!readable());





donatien

4:fd826cad83c0


   178

  char c = m_rxBuf.read();





donatien

0:632c9925f013


   179

  return c;





donatien

0:632c9925f013


   180

}





donatien

0:632c9925f013


   181







donatien

0:632c9925f013


   182

void SerialBuf::putc(char c)





donatien

0:632c9925f013


   183

{





donatien

4:fd826cad83c0


   184

  while(!writeable());





donatien

4:fd826cad83c0


   185

  m_txBuf.write(c);





donatien

4:fd826cad83c0


   186

  onTxInterrupt();





donatien

0:632c9925f013


   187

}





donatien

0:632c9925f013


   188







donatien

0:632c9925f013


   189

bool SerialBuf::readable()





donatien

0:632c9925f013


   190

{





donatien

4:fd826cad83c0


   191

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





donatien

4:fd826cad83c0


   192

    onRxInterrupt();





donatien

4:fd826cad83c0


   193

  return (bool)m_rxBuf.len();





donatien

0:632c9925f013


   194

}





donatien

0:632c9925f013


   195







donatien

0:632c9925f013


   196

bool SerialBuf::writeable()





donatien

0:632c9925f013


   197

{





donatien

4:fd826cad83c0


   198

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





donatien

4:fd826cad83c0


   199

    onTxInterrupt();





donatien

4:fd826cad83c0


   200

  return (bool)m_txBuf.room();





donatien

0:632c9925f013


   201

}





donatien

0:632c9925f013


   202







donatien

0:632c9925f013


   203

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





donatien

0:632c9925f013


   204

{





donatien

4:fd826cad83c0


   205

  m_rxBuf.setReadMode(readMode);





donatien

0:632c9925f013


   206

}





donatien

0:632c9925f013


   207







donatien

4:fd826cad83c0


   208

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





donatien

0:632c9925f013


   209

{





donatien

4:fd826cad83c0


   210

  m_rxBuf.flushRead();





donatien

0:632c9925f013


   211

}





donatien

0:632c9925f013


   212







donatien

4:fd826cad83c0


   213

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





donatien

0:632c9925f013


   214

{





donatien

4:fd826cad83c0


   215

  m_rxBuf.resetRead();





donatien

0:632c9925f013


   216

}





donatien

0:632c9925f013


   217







donatien

4:fd826cad83c0


   218

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





donatien

0:632c9925f013


   219

{





donatien

4:fd826cad83c0


   220

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





donatien

4:fd826cad83c0


   221

  {





donatien

4:fd826cad83c0


   222

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





donatien

4:fd826cad83c0


   223

  }





donatien

0:632c9925f013


   224

}





donatien

0:632c9925f013


   225







donatien

4:fd826cad83c0


   226

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





donatien

0:632c9925f013


   227

{





donatien

4:fd826cad83c0


   228

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





donatien

4:fd826cad83c0


   229

  {





donatien

4:fd826cad83c0


   230

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





donatien

4:fd826cad83c0


   231

  }





donatien

0:632c9925f013


   232

}





donatien

0:632c9925f013


   233







donatien

0:632c9925f013


   234







donatien

0:632c9925f013


   235

#endif