MHVLib  20111011
An efficiency oriented runtime library for AVR microcontrollers
A:/eclipse/mhvlib/MHV_Device_RX.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2011, Make, Hack, Void Inc
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *  * Redistributions of source code must retain the above copyright
00008  *    notice, this list of conditions and the following disclaimer.
00009  *  * Redistributions in binary form must reproduce the above copyright
00010  *    notice, this list of conditions and the following disclaimer in the
00011  *    documentation and/or other materials provided with the distribution.
00012  *  * Neither the name of the Make, Hack, Void nor the
00013  *    names of its contributors may be used to endorse or promote products
00014  *    derived from this software without specific prior written permission.
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00017  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00018  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00019  * DISCLAIMED. IN NO EVENT SHALL MAKE, HACK, VOID BE LIABLE FOR ANY
00020  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00021  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00022  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00023  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00024  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00025  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026  */
00027 
00028 
00029 #ifndef MHV_RXBUFFER_H
00030 #define MHV_RXBUFFER_H
00031 
00032 #include <inttypes.h>
00033 #include <avr/interrupt.h>
00034 #include <MHV_io.h>
00035 #include <stdio.h>
00036 #include <MHV_RingBuffer.h>
00037 
00038 #define MHV_RX_BUFFER_CREATE(_mhvRxName, _mhvRxCharacterCount) \
00039         char _mhvRxName ## Buf[_mhvRxCharacterCount + 1]; \
00040         MHV_RingBuffer _mhvRxName(_mhvRxName ## Buf, _mhvRxCharacterCount + 1);
00041 
00042 class MHV_Device_RX;
00043 class MHV_RXListener {
00044 public:
00045         virtual void rxReady(MHV_Device_RX *rx) =0;
00046 };
00047 
00048 class MHV_Device_RX {
00049 protected:
00050         MHV_RingBuffer          *_rxBuffer;
00051         MHV_RXListener          *_listener;
00052 
00053         MHV_Device_RX(MHV_RingBuffer *rxBuffer);
00054 
00055 public:
00056         int asyncReadLine(char *buffer, uint8_t bufferLength);
00057         int busyReadLine(char *buffer, uint8_t bufferLength);
00058         int read();
00059         void flush();
00060         bool ready();
00061         void registerListener(MHV_RXListener *listener);
00062         void deregisterListener();
00063 
00064         void handleEvents();
00065 };
00066 
00067 #endif