I2CWFF3_HWAttrs Struct Reference

I2CWFF3 Hardware attributes. More...

#include <I2CWFF3.h>

Data Fields
I2C_BASE_HWATTRS unsigned long	powerMngrId
uint32_t	swiPriority
uint8_t	sdaPin
uint8_t	sdaPinMux
uint8_t	sclPin
uint8_t	sclPinMux

Detailed Description

I2CWFF3 Hardware attributes.

The baseAddr and intNum fields define the base address and the interrupt number of the I2C peripheral. These values are passed to driverlib APIs and therefore must be populated by driverlib macro definitions. These macros are found in the header files:

• inc/hw_memmap.h
• inc/hw_ints.h

The powerMngrId is the Power driver resource ID for the I2C peripheral. These macros are defined in the device specific Power include file.

intPriority is the I2C peripheral's interrupt priority. This value is passed unmodified to HwiP_construct().

swiPriority is the priority of a SwiP that the I2C driver constructs to finalize I2C transfers. See the documentation for the SwiP module for a description of Swi priorities.

sdaPin and sclPin define the SDA and SCL pin mapping, respectively. These are typically defined with a macro in a header file, which maps to a GPIO number. For example, when using sysconfig, ti_drivers_config.h defines CONFIG_GPIO_I2C_0_SDA to be 18 (for GPIO18).

sdaPinMux and sclPinMux are values drawn from the GPIO driver. They indicate the function for that specific DIO pin that select I2C mode.

A sample structure is shown below:

const I2CWFF3_HWAttrs I2CWFF3_hwAttrs[CONFIG_I2C_COUNT] = {
    {
        .baseAddr    = I2C0_BASE,
        .powerMngrId = PowerWFF3_PERIPH_I2C0,
        .intNum      = INT_SP_I2C_0_INTREQ, // TODO: Update this when OSPREY_SILICON-1671 is fixed
        .intPriority = (~0),
        .swiPriority = 0,
        .sclPin      = 17,
        .sclPinMux   = 6,
        .sdaPin      = 18,
        .sdaPinMux   = 6
    },
};

Field Documentation

powerMngrId

I2C_BASE_HWATTRS unsigned long I2CWFF3_HWAttrs::powerMngrId

swiPriority

uint32_t I2CWFF3_HWAttrs::swiPriority

sdaPin

uint8_t I2CWFF3_HWAttrs::sdaPin

sdaPinMux

uint8_t I2CWFF3_HWAttrs::sdaPinMux

sclPin

uint8_t I2CWFF3_HWAttrs::sclPin

sclPinMux

uint8_t I2CWFF3_HWAttrs::sclPinMux

---

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

• I2CWFF3.h