MODSERIAL.cpp

00001 /*
00002     Copyright (c) 2010 Andy Kirkham
00003  
00004     Permission is hereby granted, free of charge, to any person obtaining a copy
00005     of this software and associated documentation files (the "Software"), to deal
00006     in the Software without restriction, including without limitation the rights
00007     to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008     copies of the Software, and to permit persons to whom the Software is
00009     furnished to do so, subject to the following conditions:
00010  
00011     The above copyright notice and this permission notice shall be included in
00012     all copies or substantial portions of the Software.
00013  
00014     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017     AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00020     THE SOFTWARE.
00021     
00022     @file          MODSERIAL.h 
00023     @purpose       Extends Serial to provide fully buffered IO
00024     @version       1.6
00025     @date          Nov 2010
00026     @author        Andy Kirkham    
00027 */
00028 
00029 #include "MODSERIAL.h"
00030 #include "MACROS.h"
00031 
00032 namespace AjK {
00033 
00034 MODSERIAL::MODSERIAL( PinName tx, PinName rx, const char* name ) : Serial( tx, rx, name )
00035 {
00036     init( MODSERIAL_DEFAULT_TX_BUFFER_SIZE, MODSERIAL_DEFAULT_RX_BUFFER_SIZE, rx );
00037 }
00038 
00039 MODSERIAL::MODSERIAL( PinName tx, PinName rx, int bufferSize, const char* name ) : Serial( tx, rx, name )
00040 {
00041     init( bufferSize, bufferSize, rx );
00042 }
00043 
00044 MODSERIAL::MODSERIAL( PinName tx, PinName rx, int txSize, int rxSize, const char* name ) : Serial( tx, rx, name )
00045 {
00046     init( txSize, rxSize, rx );
00047 }
00048 
00049 MODSERIAL::~MODSERIAL()
00050 {
00051     disableIrq();
00052     if ( buffer[0] != NULL) free((char *)buffer[0] );
00053     if ( buffer[1] != NULL) free((char *)buffer[1] );    
00054 }
00055 
00056 bool 
00057 MODSERIAL::txBufferFull( void ) 
00058 { 
00059     return MODSERIAL_TX_BUFFER_FULL; 
00060 }
00061 
00062 bool 
00063 MODSERIAL::rxBufferFull( void ) 
00064 { 
00065     return MODSERIAL_RX_BUFFER_FULL; 
00066 }
00067 
00068 bool 
00069 MODSERIAL::txBufferEmpty( void ) 
00070 { 
00071     return MODSERIAL_TX_BUFFER_EMPTY; 
00072 }
00073 
00074 bool 
00075 MODSERIAL::rxBufferEmpty( void ) 
00076 { 
00077     return MODSERIAL_RX_BUFFER_EMPTY; 
00078 }
00079 
00080 bool 
00081 MODSERIAL::txIsBusy( void ) 
00082 { 
00083     return ( _LSR & ( 3UL << 5 ) == 0 ) ? true : false; 
00084 } 
00085 
00086 void
00087 MODSERIAL::disableIrq( void )
00088 {
00089 
00090 #ifdef __LPC11UXX_H__
00091     NVIC_DisableIRQ( UART_IRQn );
00092 #elif defined __LPC11xx_H__
00093     NVIC_DisableIRQ( UART_IRQn );
00094 #else
00095     switch( _serial.index ) {
00096         case 0:   NVIC_DisableIRQ( UART0_IRQn ); break;
00097         case 1:   NVIC_DisableIRQ( UART1_IRQn ); break;
00098         case 2:   NVIC_DisableIRQ( UART2_IRQn ); break;
00099         case 3:   NVIC_DisableIRQ( UART3_IRQn ); break;
00100     }
00101 #endif
00102 }
00103 
00104 void
00105 MODSERIAL::enableIrq(void)
00106 {
00107 #ifdef __LPC11UXX_H__
00108     NVIC_EnableIRQ( UART_IRQn );
00109 #elif defined __LPC11xx_H__
00110     NVIC_EnableIRQ( UART_IRQn );
00111 #else
00112     switch( _serial.index ) {
00113         case 0:   NVIC_EnableIRQ( UART0_IRQn ); break;
00114         case 1:   NVIC_EnableIRQ( UART1_IRQn ); break;
00115         case 2:   NVIC_EnableIRQ( UART2_IRQn ); break;
00116         case 3:   NVIC_EnableIRQ( UART3_IRQn ); break;
00117     }
00118 #endif
00119 }
00120 
00121 int 
00122 MODSERIAL::rxDiscardLastChar( void )
00123 {
00124     // This function can only be called indirectly from
00125     // an rxCallback function. Therefore, we know we 
00126     // just placed a char into the buffer.
00127     char c = buffer[RxIrq][buffer_in[RxIrq]];
00128     
00129     if (buffer_count[RxIrq]) {        
00130         buffer_count[RxIrq]--;
00131         buffer_in[RxIrq]--;
00132         if (buffer_in[RxIrq] < 0) {
00133             buffer_in[RxIrq] = buffer_size[RxIrq] - 1;
00134         }
00135     }
00136     
00137     return (int)c;
00138 }
00139 
00140 
00141 }; // namespace AjK ends