SPITivaDMA Hardware attributes. More...

#include <SPITivaDMA.h>

Data Fields
SPIBaseAddrType	baseAddr

unsigned int	intNum

uint32_t	intPriority

uint32_t *	scratchBufPtr

uint32_t	defaultTxBufValue

uint32_t	rxChannelIndex

uint32_t	txChannelIndex

void(*	channelMappingFxn )(SPIDataType)

uint32_t	rxChannelMappingFxnArg

uint32_t	txChannelMappingFxnArg

Detailed Description

SPITivaDMA Hardware attributes.

These fields, with the exception of intPriority, are used by driverlib APIs and therefore must be populated by driverlib macro definitions. For TivaWare these definitions are found in:

inc/hw_memmap.h
inc/hw_ints.h
driverlib/udma.h

intPriority is the SPI peripheral's interrupt priority, as defined by the underlying OS. It is passed unmodified to the underlying OS's interrupt handler creation code, so you need to refer to the OS documentation for usage. For example, for SYS/BIOS applications, refer to the ti.sysbios.family.arm.m3.Hwi documentation for SYS/BIOS usage of interrupt priorities. If the driver uses the ti.drivers.ports interface instead of making OS calls directly, then the HwiP port handles the interrupt priority in an OS specific way. In the case of the SYS/BIOS port, intPriority is passed unmodified to Hwi_create().

A sample structure is shown below:

uint32_t spiTivaDMAscratchBuf;
const SPITivaDMA_HWAttrs spiTivaDMAobjects[] = {
    {
        .baseAddr = SSI0_BASE,
        .intNum = INT_SSI0,
        .intPriority = (~0),
        .scratchBufPtr = &spiTivaDMAscratchBuf,
        .defaultTxBufValue = 0,
        .rxChannelIndex = UDMA_CHANNEL_SSI0RX,
        .txChannelIndex = UDMA_CHANNEL_SSI0TX,
        .channelMappingFxn = uDMAChannelAssign,
        .rxChannelMappingFxnArg = UDMA_CH10_SSI0RX,
        .txChannelMappingFxnArg = UDMA_CH11_SSI0TX
    },
};

Field Documentation

SPIBaseAddrType SPITivaDMA_HWAttrs::baseAddr

SSI Peripheral's base address

unsigned int SPITivaDMA_HWAttrs::intNum

SSI TivaDMA Peripheral's interrupt vector

uint32_t SPITivaDMA_HWAttrs::intPriority

SPITivaDMA Peripheral's interrupt priority

uint32_t* SPITivaDMA_HWAttrs::scratchBufPtr

Address of a scratch buffer of size uint32_t

uint32_t SPITivaDMA_HWAttrs::defaultTxBufValue

Default TX value if txBuf == NULL

uint32_t SPITivaDMA_HWAttrs::rxChannelIndex

uDMA controlTable channel index

uint32_t SPITivaDMA_HWAttrs::txChannelIndex

uDMA controlTable channel index

void(* SPITivaDMA_HWAttrs::channelMappingFxn) (SPIDataType)

uDMA mapping function that maps the SPI trigger to the DMA channel

uint32_t SPITivaDMA_HWAttrs::rxChannelMappingFxnArg

uDMA MappingFxn arg to map the Tx channel

uint32_t SPITivaDMA_HWAttrs::txChannelMappingFxnArg

uDMA MappingFxn arg to map the Rx channel

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

SPITivaDMA.h

Data Fields

Detailed Description

Field Documentation