Open FFBoard
Open source force feedback firmware
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SPIDevice Class Reference

#include <SPI.h>

Inheritance diagram for SPIDevice:
EncoderBissC EncoderSSI MtEncoderSPI SPI_Buttons ShifterAnalog::G27ShifterButtonClient TMC4671 SPI_Buttons_1 SPI_Buttons_2 TMC_1 TMC_2

Public Member Functions

 SPIDevice (SPIPort &port, OutputPin csPin)
 
 SPIDevice (SPIPort &port, SPIConfig &spiConfig)
 
virtual ~SPIDevice ()
 
void assertChipSelect ()
 
void clearChipSelect ()
 
virtual bool updateCSPin (OutputPin &csPin)
 
virtual void spiTxCompleted (SPIPort *port)
 
virtual void spiRxCompleted (SPIPort *port)
 
virtual void spiTxRxCompleted (SPIPort *port)
 
virtual void spiRequestError (SPIPort *port)
 
virtual void beginSpiTransfer (SPIPort *port)
 
virtual void endSpiTransfer (SPIPort *port)
 
virtual SPIConfig * getSpiConfig ()
 

Protected Member Functions

virtual void setSpiConfig (SPIConfig config)
 

Protected Attributes

SPIPort & spiPort
 
SPIConfig spiConfig
 

Detailed Description

Definition at line 100 of file SPI.h.

Constructor & Destructor Documentation

◆ SPIDevice() [1/2]

SPIDevice::SPIDevice ( SPIPort &  port,
OutputPin  csPin 
)

Definition at line 332 of file SPI.cpp.

◆ SPIDevice() [2/2]

SPIDevice::SPIDevice ( SPIPort &  port,
SPIConfig &  spiConfig 
)

Definition at line 329 of file SPI.cpp.

◆ ~SPIDevice()

SPIDevice::~SPIDevice ( )
virtual

Definition at line 336 of file SPI.cpp.

Member Function Documentation

◆ assertChipSelect()

void SPIDevice::assertChipSelect ( )

Definition at line 373 of file SPI.cpp.

◆ beginSpiTransfer()

void SPIDevice::beginSpiTransfer ( SPIPort *  port)
virtual

Reimplemented in EncoderBissC, EncoderSSI, and TMC4671.

Definition at line 359 of file SPI.cpp.

◆ clearChipSelect()

void SPIDevice::clearChipSelect ( )

Definition at line 377 of file SPI.cpp.

◆ endSpiTransfer()

void SPIDevice::endSpiTransfer ( SPIPort *  port)
virtual

Reimplemented in EncoderBissC, EncoderSSI, and TMC4671.

Definition at line 368 of file SPI.cpp.

◆ getSpiConfig()

virtual SPIConfig * SPIDevice::getSpiConfig ( )
inlinevirtual

Definition at line 120 of file SPI.h.

◆ setSpiConfig()

virtual void SPIDevice::setSpiConfig ( SPIConfig  config)
inlineprotectedvirtual

Definition at line 123 of file SPI.h.

◆ spiRequestError()

virtual void SPIDevice::spiRequestError ( SPIPort *  port)
inlinevirtual

Definition at line 115 of file SPI.h.

◆ spiRxCompleted()

virtual void SPIDevice::spiRxCompleted ( SPIPort *  port)
inlinevirtual

Reimplemented in EncoderBissC, and EncoderSSI.

Definition at line 113 of file SPI.h.

◆ spiTxCompleted()

virtual void SPIDevice::spiTxCompleted ( SPIPort *  port)
inlinevirtual

Definition at line 112 of file SPI.h.

◆ spiTxRxCompleted()

virtual void SPIDevice::spiTxRxCompleted ( SPIPort *  port)
inlinevirtual

Reimplemented in MtEncoderSPI.

Definition at line 114 of file SPI.h.

◆ updateCSPin()

bool SPIDevice::updateCSPin ( OutputPin &  csPin)
virtual

Definition at line 340 of file SPI.cpp.

Member Data Documentation

◆ spiConfig

SPIConfig SPIDevice::spiConfig
protected

Definition at line 125 of file SPI.h.

◆ spiPort

SPIPort& SPIDevice::spiPort
protected

Definition at line 124 of file SPI.h.

The documentation for this class was generated from the following files: