Hilscher netX microcontroller driver  V0.0.5.0
Documentation of the netX driver package
DRV_SPI_CONFIGURATION_T Struct Reference

The configuration structure of the SPI device driver. More...

#include <netx_drv_spi.h>

Collaboration diagram for DRV_SPI_CONFIGURATION_T:
Collaboration graph

Data Fields

DRV_SPI_DEVICE_ID_E eSPIDeviceID
 
DRV_SPI_MISO_E eMISO
 
DRV_OPERATION_MODE_E eOperationMode
 
DRV_SPI_FSS_E eFSS
 
DRV_SPI_FREQUENCY_E eFrequency
 
DRV_SPI_FRAME_FORMAT_E eFrameFormat
 
DRV_SPI_MODE_U uMode
 
DRV_SPI_DUPLEX_E eDuplex
 
DRV_SPI_PARALLELISM_E eParallelism
 
DRV_SPI_BEHAVIOUR_E eBehaviour
 
DRV_SPI_SLV_SIG_EARLY_E eSlaveSigEarly
 
DRV_SPI_FILTER_E eFILTER
 
DRV_SPI_ENDIANESS_E eEndianess
 
DRV_SPI_FSS_STATIC_E eFSSStatic
 
DRV_SPI_FIFO_WM_E eRxFiFoWm
 
DRV_SPI_FIFO_WM_E eTxFiFoWm
 
DRV_SPI_LOOP_BACK_MODE_E eLoopBackMode
 
DRV_SPI_DATA_SIZE_SELECT_E eDataSize
 
DRV_SPI_DUMMYPATTERN_E uDummyPattern
 
DRV_DMAC_DEVICE_ID_E eDMATx
 
DRV_DMAC_DEVICE_ID_E eDMARx
 
DRV_DMAC_HANDLE_TptSequencerTx
 
DRV_DMAC_HANDLE_TptSequencerRx
 
DRV_CALLBACK_F fnCompleteCallback
 
void * pCompleteCallbackHandle
 
uint32_t ulDriverTimeout
 

Detailed Description

The configuration structure of the SPI device driver.

This structure shall be modified to change configuration parameters. It is evaluated during the init routine and used during the handles lifetime. The structure shall not be modified after initialization of the device.

Definition at line 318 of file netx_drv_spi.h.

Field Documentation

DRV_SPI_BEHAVIOUR_E DRV_SPI_CONFIGURATION_T::eBehaviour

Defines if the device is master or slave.

Definition at line 329 of file netx_drv_spi.h.

DRV_SPI_DATA_SIZE_SELECT_E DRV_SPI_CONFIGURATION_T::eDataSize

Size of a word.

Definition at line 337 of file netx_drv_spi.h.

DRV_DMAC_DEVICE_ID_E DRV_SPI_CONFIGURATION_T::eDMARx

The device id of the dmac to be used for rx.

Definition at line 340 of file netx_drv_spi.h.

DRV_DMAC_DEVICE_ID_E DRV_SPI_CONFIGURATION_T::eDMATx

The device id of the dmac to be used for tx.

Definition at line 339 of file netx_drv_spi.h.

DRV_SPI_DUPLEX_E DRV_SPI_CONFIGURATION_T::eDuplex

Half or full duplex.

Definition at line 327 of file netx_drv_spi.h.

DRV_SPI_ENDIANESS_E DRV_SPI_CONFIGURATION_T::eEndianess

Is big endian.

Definition at line 332 of file netx_drv_spi.h.

DRV_SPI_FILTER_E DRV_SPI_CONFIGURATION_T::eFILTER

Is rx data input filter (majority around clk edge).

Definition at line 331 of file netx_drv_spi.h.

DRV_SPI_FRAME_FORMAT_E DRV_SPI_CONFIGURATION_T::eFrameFormat

Motorola SPI frame format only.

Definition at line 325 of file netx_drv_spi.h.

DRV_SPI_FREQUENCY_E DRV_SPI_CONFIGURATION_T::eFrequency

The frequency of the SPI.

Definition at line 324 of file netx_drv_spi.h.

DRV_SPI_FSS_E DRV_SPI_CONFIGURATION_T::eFSS

The frame/chip select to be used.

Definition at line 323 of file netx_drv_spi.h.

DRV_SPI_FSS_STATIC_E DRV_SPI_CONFIGURATION_T::eFSSStatic

Is fss static.

Definition at line 333 of file netx_drv_spi.h.

DRV_SPI_LOOP_BACK_MODE_E DRV_SPI_CONFIGURATION_T::eLoopBackMode

Is loop back mode active.

Definition at line 336 of file netx_drv_spi.h.

DRV_SPI_MISO_E DRV_SPI_CONFIGURATION_T::eMISO

The mosi state.

Definition at line 321 of file netx_drv_spi.h.

DRV_OPERATION_MODE_E DRV_SPI_CONFIGURATION_T::eOperationMode

Which programming method (DMA/IRQ/POLL) is used.

Definition at line 322 of file netx_drv_spi.h.

DRV_SPI_PARALLELISM_E DRV_SPI_CONFIGURATION_T::eParallelism

How many bits are transferred parallel.

Definition at line 328 of file netx_drv_spi.h.

DRV_SPI_FIFO_WM_E DRV_SPI_CONFIGURATION_T::eRxFiFoWm

Receive FiFo watermark. [0..0b1111] (0b1000)

Definition at line 334 of file netx_drv_spi.h.

DRV_SPI_SLV_SIG_EARLY_E DRV_SPI_CONFIGURATION_T::eSlaveSigEarly

Is slave miso generated earlier.

Definition at line 330 of file netx_drv_spi.h.

DRV_SPI_DEVICE_ID_E DRV_SPI_CONFIGURATION_T::eSPIDeviceID

The id of the device used.

Definition at line 320 of file netx_drv_spi.h.

DRV_SPI_FIFO_WM_E DRV_SPI_CONFIGURATION_T::eTxFiFoWm

Tranmit FiFo watermark. [0..0b1111] (0b1000)

Definition at line 335 of file netx_drv_spi.h.

DRV_CALLBACK_F DRV_SPI_CONFIGURATION_T::fnCompleteCallback

The callback used if transaction is completed.

Definition at line 343 of file netx_drv_spi.h.

void* DRV_SPI_CONFIGURATION_T::pCompleteCallbackHandle

The handle associated with the callback.

Definition at line 344 of file netx_drv_spi.h.

DRV_DMAC_HANDLE_T* DRV_SPI_CONFIGURATION_T::ptSequencerRx

The allocated and initialized to 0 handle of the rx dmac.

Definition at line 342 of file netx_drv_spi.h.

DRV_DMAC_HANDLE_T* DRV_SPI_CONFIGURATION_T::ptSequencerTx

The allocated and initialized to 0 handle of the tx dmac.

Definition at line 341 of file netx_drv_spi.h.

DRV_SPI_DUMMYPATTERN_E DRV_SPI_CONFIGURATION_T::uDummyPattern

Pattern used as dummy in empty Tx paths.

Definition at line 338 of file netx_drv_spi.h.

uint32_t DRV_SPI_CONFIGURATION_T::ulDriverTimeout

Timeout used in the driver for polling contexts.

Definition at line 345 of file netx_drv_spi.h.

DRV_SPI_MODE_U DRV_SPI_CONFIGURATION_T::uMode

The spi sampling mode.

Definition at line 326 of file netx_drv_spi.h.


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