Collaboration diagram for I2C driver APIs:

Data Structures
struct	I2CTargetMSPM0_HWAttrs
	I2CTargetMSPM0 Hardware attributes. More...

struct	I2CTargetMSPM0_Object
	I2CTargetMSPM0 Object. More...

Functions
static bool	I2CBaseValid (I2C_Regs *i2c)
	Checks an I2C base address. This function determines if a I2C port base address is valid. More...

Detailed Description

Note: All calls should go through the generic I2CTarget API.

Driver Include

The I2CTarget header file should be included in an application as follows:

#include <ti/drivers/I2CTarget.h>

#include <ti/drivers/i2c/I2CTargetMSPM0.h>

Refer to I2CTarget.h for a complete description of APIs.

Overview

The generic I2CTarget API is normally used in application code, for example, I2CTarget_open(). Do not use APIs in this header file directly. The board file will define the device specific config, and casting in the general API will ensure that the correct device specific functions are called.

General Behavior

Before using the I2C in MSPM0:

The I2CTarget driver is initialized by calling I2CTarget_init().
The I2C HW is configured and system dependencies are declared (e.g. IOs, power, etc.) by calling I2CTarget_open().
The I2CTarget driver starts acting on I2C bus activities after calling I2CTarget_start().

Power Management

The Power drivers are yet to implement but the behavior should follow like the information given here. The I2CTargetMSPM0 driver sets a power constraint when I2CTarget_start() is called to keep the device out of standby; so when all tasks are blocked, the device will enter idle mode instead of standby. When the application calls I2CTarget_stop(), the the power constraint to prohibit standby is released. The following statements are valid:

After I2CTarget_open() call: I2C peripheral is enabled in target mode, but the device can enter standby. The device will need to be woken up (for example on GPIO or timer events) before I2C bus activity can be processed.
After I2CTarget_start() call: I2C events will trigger the user callback function. The device might enter idle, but not standby.
After I2C_stop() call: Same as after I2CTarget_open() call.
After I2C_close() call: I2C peripheral is disabled.

Supported Functions

Note: All calls should go through the generic API.

Use Cases

See generic API for examples.

Function Documentation

§ I2CBaseValid()

static bool I2CBaseValid ( I2C_Regs * i2c )

static

Checks an I2C base address. This function determines if a I2C port base address is valid.

Parameters

i2c	is the base address of the I2C port.

Returns: Returns true if the base address is valid and false otherwise

Data Structures

Functions