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

The configuration of the driver. More...

#include <netx_drv_i2c.h>

Collaboration diagram for DRV_I2C_CONFIGURATION_T:
Collaboration graph

Data Fields

DRV_I2C_DEVICE_ID_E eDeviceID
 
DRV_OPERATION_MODE_E eOperationMode
 
DRV_I2C_SPEED_MODE_E eSpeedMode
 
uint16_t sAckPollMaximum
 
DRV_I2C_ADDRESS_T tSlaveAddress
 
DRV_I2C_WATERMARK_E eMstTxFifoWatermark
 
DRV_I2C_WATERMARK_E eMstRxFifoWatermark
 
DRV_I2C_WATERMARK_E eSlvTxFifoWatermark
 
DRV_I2C_WATERMARK_E eSlvRxFifoWatermark
 
DRV_CALLBACK_F fnMasterCompleteCallback
 
void * pMasterCompleteCallbackHandle
 
DRV_CALLBACK_F fnSlaveCompleteCallback
 
void * pSlaveCompleteCallbackHandle
 
DRV_CALLBACK_F fnArbitrationLostCallback
 
void * pArbitrationLostCallbackHandle
 
DRV_CALLBACK_F fnErrorCallback
 
void * pErrorCallbackHandle
 
uint32_t ulDriverTimeout
 

Detailed Description

The configuration of the 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 312 of file netx_drv_i2c.h.

Field Documentation

DRV_I2C_DEVICE_ID_E DRV_I2C_CONFIGURATION_T::eDeviceID

The device to be used

Definition at line 314 of file netx_drv_i2c.h.

DRV_I2C_WATERMARK_E DRV_I2C_CONFIGURATION_T::eMstRxFifoWatermark

Fifo size of the master rx.

Definition at line 320 of file netx_drv_i2c.h.

DRV_I2C_WATERMARK_E DRV_I2C_CONFIGURATION_T::eMstTxFifoWatermark

Fifo size of the master tx.

Definition at line 319 of file netx_drv_i2c.h.

DRV_OPERATION_MODE_E DRV_I2C_CONFIGURATION_T::eOperationMode

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

Definition at line 315 of file netx_drv_i2c.h.

DRV_I2C_WATERMARK_E DRV_I2C_CONFIGURATION_T::eSlvRxFifoWatermark

Fifo size of the slave rx.

Definition at line 322 of file netx_drv_i2c.h.

DRV_I2C_WATERMARK_E DRV_I2C_CONFIGURATION_T::eSlvTxFifoWatermark

Fifo size of the slave tx.

Definition at line 321 of file netx_drv_i2c.h.

DRV_I2C_SPEED_MODE_E DRV_I2C_CONFIGURATION_T::eSpeedMode

The speed operation mode.

Definition at line 316 of file netx_drv_i2c.h.

DRV_CALLBACK_F DRV_I2C_CONFIGURATION_T::fnArbitrationLostCallback

The callback used if the arbitration got lost.

Definition at line 327 of file netx_drv_i2c.h.

DRV_CALLBACK_F DRV_I2C_CONFIGURATION_T::fnErrorCallback

The callback used if an error occurred.

Definition at line 329 of file netx_drv_i2c.h.

DRV_CALLBACK_F DRV_I2C_CONFIGURATION_T::fnMasterCompleteCallback

The callback used if master transaction is completed.

Definition at line 323 of file netx_drv_i2c.h.

DRV_CALLBACK_F DRV_I2C_CONFIGURATION_T::fnSlaveCompleteCallback

The callback used if slave transaction is completed.

Definition at line 325 of file netx_drv_i2c.h.

void* DRV_I2C_CONFIGURATION_T::pArbitrationLostCallbackHandle

The handle associated with the arbitration callback.

Definition at line 328 of file netx_drv_i2c.h.

void* DRV_I2C_CONFIGURATION_T::pErrorCallbackHandle

The handle associated with the error callback.

Definition at line 330 of file netx_drv_i2c.h.

void* DRV_I2C_CONFIGURATION_T::pMasterCompleteCallbackHandle

The handle associated with the master complete callback.

Definition at line 324 of file netx_drv_i2c.h.

void* DRV_I2C_CONFIGURATION_T::pSlaveCompleteCallbackHandle

The handle associated with the slave complete callback.

Definition at line 326 of file netx_drv_i2c.h.

uint16_t DRV_I2C_CONFIGURATION_T::sAckPollMaximum

Value that stores the count of how often the device will try to get an acknowledge from the addressed slave(s).

Definition at line 317 of file netx_drv_i2c.h.

DRV_I2C_ADDRESS_T DRV_I2C_CONFIGURATION_T::tSlaveAddress

Slave address format including I2C Addressing Scheme.

Definition at line 318 of file netx_drv_i2c.h.

uint32_t DRV_I2C_CONFIGURATION_T::ulDriverTimeout

Timeout used in the drivers Polling Mode.

Definition at line 331 of file netx_drv_i2c.h.


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