uart_dev.hpp

Go to the documentation of this file.

/*
 *     SocialLedge.com - Copyright (C) 2013
 *
 *     This file is part of free software framework for embedded processors.
 *     You can use it and/or distribute it as long as this copyright header
 *     remains unmodified.  The code is free for personal use and requires
 *     permission to use in a commercial product.
 *
 *      THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 *      OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 *      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 *      I SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
 *      CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *     You can reach the author of this software at :
 *          p r e e t . w i k i @ g m a i l . c o m
 */

#ifndef UART_DEV_HPP_
#define UART_DEV_HPP_

#include "FreeRTOS.h"
#include "queue.h"
#include "semphr.h"
#include "task.h"

#include "char_dev.hpp"
#include "LPC17xx.h"



class UartDev : public CharDev
{
    public:

        void setBaudRate(unsigned int baudRate);

        bool getChar(char* pInputChar, unsigned int timeout=portMAX_DELAY);

        bool putChar(char out, unsigned int timeout=portMAX_DELAY);

        bool flush(void);

        inline unsigned int getRxQueueSize() const { return uxQueueMessagesWaiting(mRxQueue); }
        inline unsigned int getTxQueueSize() const { return uxQueueMessagesWaiting(mTxQueue); }
        inline unsigned int getRxQueueWatermark() const { return mRxQWatermark; }
        inline unsigned int getTxQueueWatermark() const { return mTxQWatermark; }
        bool recentlyActive(unsigned int ms=3000) const;
        inline TickType_t getLastActivityTime(void) const { return mLastActivityTime; }
        inline void resetActivity(void) { mLastActivityTime = xTaskGetMsCount(); }
        void handleInterrupt();

    protected:
        bool init(unsigned int pclk, unsigned int baudRate, int rxQSize=32, int txQSize=32);

        UartDev(unsigned int* pUARTBaseAddr);
        ~UartDev() { } 
    private:
        UartDev(); 
        LPC_UART_TypeDef* mpUARTRegBase;
        QueueHandle_t mRxQueue;         
        QueueHandle_t mTxQueue;         
        uint32_t mPeripheralClock;      
        uint16_t mRxQWatermark;         
        uint16_t mTxQWatermark;         
        TickType_t mLastActivityTime;   
};



#endif /* UART_DEV_HPP_ */