LinuxUartDriver.hpp

Go to the documentation of this file.

// ======================================================================
// \title  LinuxUartDriverImpl.hpp
// \author tcanham
// \brief  hpp file for LinuxUartDriver component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef LinuxUartDriver_HPP
#define LinuxUartDriver_HPP

#include <Drv/LinuxUartDriver/LinuxUartDriverComponentAc.hpp>
#include <Os/Mutex.hpp>
#include <Os/Task.hpp>

#include <termios.h>
#include <atomic>

namespace Drv {

class LinuxUartDriver final : public LinuxUartDriverComponentBase {
  public:
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

    LinuxUartDriver(const char* const compName 
    );

    enum UartBaudRate {
        BAUD_9600 = 9600,
        BAUD_19200 = 19200,
        BAUD_38400 = 38400,
        BAUD_57600 = 57600,
        BAUD_115K = 115200,
        BAUD_230K = 230400,
#ifdef B460800
        BAUD_460K = 460800,
#endif
#ifdef B921600
        BAUD_921K = 921600,
#endif
#ifdef B1000000
        BAUD_1000K = 1000000,
#endif
#ifdef B1152000
        BAUD_1152K = 1152000,
#endif
#ifdef B1500000
        BAUD_1500K = 1500000,
#endif
#ifdef B2000000
        BAUD_2000K = 2000000,
#endif
#ifdef B2500000
        BAUD_2500K = 2500000,
#endif
#ifdef B3000000
        BAUD_3000K = 3000000,
#endif
#ifdef B3500000
        BAUD_3500K = 3500000,
#endif
#ifdef B4000000
        BAUD_4000K = 4000000
#endif
    };

    enum UartFlowControl { NO_FLOW, HW_FLOW };

    enum UartParity { PARITY_NONE, PARITY_ODD, PARITY_EVEN };

    // Open device with specified baud and flow control.
    bool open(const char* const device,
              UartBaudRate baud,
              UartFlowControl fc,
              UartParity parity,
              FwSizeType allocationSize);

    void start(FwTaskPriorityType priority = Os::Task::TASK_PRIORITY_DEFAULT,
               Os::Task::ParamType stackSize = Os::Task::TASK_DEFAULT,
               Os::Task::ParamType cpuAffinity = Os::Task::TASK_DEFAULT);

    void quitReadThread();

    Os::Task::Status join();

    ~LinuxUartDriver();

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------

    void run_handler(FwIndexType portNum,  
                     U32 context           
                     ) override;

    Drv::ByteStreamStatus send_handler(FwIndexType portNum, 
                                       Fw::Buffer& serBuffer) override;

    void recvReturnIn_handler(FwIndexType portNum,  
                              Fw::Buffer& fwBuffer  
                              ) override;

    int m_fd;                     
    FwSizeType m_allocationSize;  
    const char* m_device;         

    static void serialReadTaskEntry(void* ptr);

    Os::Task m_readTask;  

    std::atomic<FwSizeType> m_bytesSent;      
    std::atomic<FwSizeType> m_bytesReceived;  
    bool m_quitReadThread;                    
};

}  // end namespace Drv

#endif