API Documentation  3.02.02.00
Data Fields
SPICC26XXDMA_Object Struct Reference

SPICC26XXDMA Object. More...

Data Fields

size_t amtDataXferred
 
unsigned int bitRate
 SPI bit rate in Hz. More...
 
PIN_Id csnPin
 
SPI_TransactioncurrentTransaction
 
size_t currentXferAmt
 
unsigned int dataSize
 
SPI_FrameFormat frameFormat
 
SPICC26XXDMA_FrameSize frameSize
 
HwiP_Struct hwi
 
bool isOpen
 
SPI_Mode mode
 
PIN_Handle pinHandle
 
PIN_State pinState
 
bool returnPartial
 
uint16_t scratchBuf
 
void * spiPostFxn
 
Power_NotifyObj spiPostObj
 
volatile bool spiPowerConstraint
 
void * spiPreFxn
 
Power_NotifyObj spiPreObj
 
SwiP_Struct swi
 
SPI_CallbackFxn transferCallbackFxn
 
SemaphoreP_Struct transferComplete
 
SPI_TransferMode transferMode
 
unsigned int transferTimeout
 
UDMACC26XX_Handle udmaHandle
 

Detailed Description

SPICC26XXDMA Object.

The application must not access any member variables of this structure!

Field Documentation

§ amtDataXferred

size_t SPICC26XXDMA_Object::amtDataXferred

Number of frames transferred

§ bitRate

unsigned int SPICC26XXDMA_Object::bitRate

SPI bit rate in Hz.

When the SPI is configured as SPI slave, the maximum bitrate is 4MHz.

When the SPI is configured as SPI master, the maximum bitrate is 12MHz.

§ csnPin

PIN_Id SPICC26XXDMA_Object::csnPin

SPI CSN pin

§ currentTransaction

SPI_Transaction* SPICC26XXDMA_Object::currentTransaction

Ptr to the current transaction

§ currentXferAmt

size_t SPICC26XXDMA_Object::currentXferAmt

Size of current DMA transfer

§ dataSize

unsigned int SPICC26XXDMA_Object::dataSize

SPI data frame size in bits

§ frameFormat

SPI_FrameFormat SPICC26XXDMA_Object::frameFormat

SPI frame format

§ frameSize

SPICC26XXDMA_FrameSize SPICC26XXDMA_Object::frameSize

Data frame size variable

§ hwi

HwiP_Struct SPICC26XXDMA_Object::hwi

Hwi object handle

§ isOpen

bool SPICC26XXDMA_Object::isOpen

Has the object been opened

§ mode

SPI_Mode SPICC26XXDMA_Object::mode

Master or Slave mode

§ returnPartial

bool SPICC26XXDMA_Object::returnPartial

Optional slave mode return partial on CSN deassert

§ spiPostFxn

void* SPICC26XXDMA_Object::spiPostFxn

SPI post-notification function pointer

§ spiPostObj

Power_NotifyObj SPICC26XXDMA_Object::spiPostObj

SPI post-notification object

§ spiPowerConstraint

volatile bool SPICC26XXDMA_Object::spiPowerConstraint

SPI power constraint flag, guard to avoid power constraints getting out of sync

§ spiPreFxn

void* SPICC26XXDMA_Object::spiPreFxn

SPI pre-notification function pointer

§ spiPreObj

Power_NotifyObj SPICC26XXDMA_Object::spiPreObj

SPI pre-notification object

§ swi

SwiP_Struct SPICC26XXDMA_Object::swi

Swi object

§ transferCallbackFxn

SPI_CallbackFxn SPICC26XXDMA_Object::transferCallbackFxn

Callback function pointer

§ transferComplete

SemaphoreP_Struct SPICC26XXDMA_Object::transferComplete

Notify finished SPICC26XXDMA transfer

§ transferMode

SPI_TransferMode SPICC26XXDMA_Object::transferMode

Blocking or Callback mode

§ transferTimeout

unsigned int SPICC26XXDMA_Object::transferTimeout

Timeout for the transfer when in blocking mode


The documentation for this struct was generated from the following file: