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 final : public LinuxSpiDriverComponentBase {
  public:
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

    LinuxSpiDriverComponentImpl(const char* const compName 
    );

    ~LinuxSpiDriverComponentImpl();

    bool open(FwIndexType device,
              FwIndexType select,
              SpiFrequency clock,
              SpiMode spiMode = SpiMode::SPI_MODE_CPOL_LOW_CPHA_LOW);

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

    SpiStatus SpiWriteRead_handler(const FwIndexType portNum, 
                                   Fw::Buffer& WriteBuffer,
                                   Fw::Buffer& readBuffer);

    // @ DEPRECATED: Use SpiWriteRead port instead (same operation with a return value)
    void SpiReadWrite_handler(const FwIndexType portNum, 
                              Fw::Buffer& WriteBuffer,
                              Fw::Buffer& readBuffer);

    int m_fd;
    FwIndexType m_device;
    FwIndexType m_select;
    FwSizeType m_bytes;
};

}  // end namespace Drv

#endif