I2CMSP432.h File Reference

Detailed Description

I2C driver implementation for the EUSCI controller on MSP432.

============================================================================

This I2C driver implementation is designed to operate on a EUCSI controller in I2C mode. The I2CMSP432 header file should be included in an application as follows:

#include <ti/drivers/I2C.h>
#include <ti/drivers/I2CMSP432.h>

---

#include <stdint.h>
#include <stdbool.h>
#include <ti/drivers/I2C.h>
#include <ti/drivers/ports/HwiP.h>
#include <ti/drivers/ports/SemaphoreP.h>
#include <ti/drivers/Power.h>

Include dependency graph for I2CMSP432.h:

Go to the source code of this file.

Data Structures
struct	I2CMSP432_HWAttrs
	I2CMSP432 Hardware attributes These fields, with the exception of intPriority, are used by driverlib APIs and therefore must be populated by driverlib macro definitions. For MSP430Ware these definitions are found in: More...
struct	I2CMSP432_Object
	I2CMSP432 Object. More...

Typedefs
typedef enum I2CMSP432_Mode	I2CMSP432_Mode
	I2CMSP432 mode. More...
typedef struct I2CMSP432_HWAttrs	I2CMSP432_HWAttrs
	I2CMSP432 Hardware attributes These fields, with the exception of intPriority, are used by driverlib APIs and therefore must be populated by driverlib macro definitions. For MSP430Ware these definitions are found in: More...
typedef struct I2CMSP432_Object	I2CMSP432_Object
	I2CMSP432 Object. More...

Enumerations
enum	I2CMSP432_Mode {   I2CMSP432_IDLE_MODE = 0,   I2CMSP432_WRITE_MODE,   I2CMSP432_READ_MODE,   I2CMSP432_ERROR = 0xFF }
	I2CMSP432 mode. More...

Variables
const I2C_FxnTable	I2CMSP432_fxnTable

Typedef Documentation

typedef enum I2CMSP432_Mode I2CMSP432_Mode

I2CMSP432 mode.

This enum defines the state of the I2C driver's state-machine. Do not modify.

typedef struct I2CMSP432_HWAttrs I2CMSP432_HWAttrs

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

• i2c.h

intPriority is the I2C 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:

const I2CMSP432_HWAttrs i2cMSP432HWAttrs[] = {
    {
        .baseAddr = EUSCI_B0_BASE,
        .intNum = INT_EUSCIB0,
        .intPriority = (~0),
        .clockSource = EUSCI_B_I2C_CLOCKSOURCE_SMCLK
    }
};

typedef struct I2CMSP432_Object I2CMSP432_Object

I2CMSP432 Object.

The application must not access any member variables of this structure!

Enumeration Type Documentation

enum I2CMSP432_Mode

I2CMSP432 mode.

This enum defines the state of the I2C driver's state-machine. Do not modify.

Enumerator
I2CMSP432_IDLE_MODE
I2CMSP432_WRITE_MODE
I2CMSP432_READ_MODE
I2CMSP432_ERROR

Variable Documentation

const I2C_FxnTable I2CMSP432_fxnTable