LinuxSpiDriverComponentImpl.hpp

Go to the documentation of this file.

// ======================================================================
// \title  LinuxSpiDriverImpl.hpp
// \author tcanham
// \brief  hpp file for LinuxSpiDriver component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef LinuxSpiDriver_HPP
#define LinuxSpiDriver_HPP
 
#include "Drv/LinuxSpiDriver/LinuxSpiDriverComponentAc.hpp"
 
namespace Drv {
 
    enum SpiFrequency
    {
       SPI_FREQUENCY_1MHZ = 1000000UL,
       SPI_FREQUENCY_5MHZ = 5000000UL,
       SPI_FREQUENCY_10MHZ = 10000000UL,
       SPI_FREQUENCY_15MHZ = 15000000UL,
       SPI_FREQUENCY_20MHZ = 20000000UL,
    };
 
    enum SpiMode
    {
        SPI_MODE_CPOL_LOW_CPHA_LOW, 
        SPI_MODE_CPOL_LOW_CPHA_HIGH,
        SPI_MODE_CPOL_HIGH_CPHA_LOW,
        SPI_MODE_CPOL_HIGH_CPHA_HIGH,
    };
 
    class LinuxSpiDriverComponentImpl: public LinuxSpiDriverComponentBase {
 
        public:
 
            // ----------------------------------------------------------------------
            // Construction, initialization, and destruction
            // ----------------------------------------------------------------------
 
            LinuxSpiDriverComponentImpl(
                    const char * const compName 
            );
 
            void init(const NATIVE_INT_TYPE instance = 0 
            );
 
            ~LinuxSpiDriverComponentImpl();
 
            bool open(NATIVE_INT_TYPE device,
                      NATIVE_INT_TYPE select,
                      SpiFrequency clock,
                      SpiMode spiMode = SpiMode::SPI_MODE_CPOL_LOW_CPHA_LOW);
 
        PRIVATE:
 
            // ----------------------------------------------------------------------
            // Handler implementations for user-defined typed input ports
            // ----------------------------------------------------------------------
 
            void SpiReadWrite_handler(const NATIVE_INT_TYPE portNum, 
            Fw::Buffer &WriteBuffer, Fw::Buffer &readBuffer);
 
            NATIVE_INT_TYPE m_fd;
            NATIVE_INT_TYPE m_device;
            NATIVE_INT_TYPE m_select;
            U32 m_bytes;
 
    };
 
} // end namespace Drv
 
#endif