AM261x MCU+ SDK: i2c.h File Reference

| AM261x MCU+ SDK 26.00.00 |

Data Structures | Typedefs | Functions
i2c.h File Reference

Go to the source code of this file.

## Data Structures
struct | I2C_HwAttrs
| I2C Hardware attributes. More...
struct | I2C_Mem_Transaction
| I2C Memory Transaction. More...
struct | I2C_Transaction
| I2C Transaction. More...
struct | I2C_Params
| I2C Parameters. More...
struct | I2C_Object
| I2C Object. More...
struct | I2C_Config
| I2C Global configuration. More...

## Macros
MACROS used to select the transfer mode
I2C_MODE_BLOCKING block task execution while a I2C transfer is in progress I2C_MODE_CALLBACK does not block task execution; but calls a callback function when the I2C transfer has completed
#define | I2C_MODE_BLOCKING ((uint8_t) 0U)
#define | I2C_MODE_CALLBACK ((uint8_t) 1U)
MACROS for the possible values of I2C_Mem_Transaction member
memDataDir. Deafults to I2C_TXN_DIR_INVALID
#define | I2C_MEM_TXN_DIR_INVALID ((uint8_t) 0U)
| I2C LLD invalid dataDir. More...
#define | I2C_MEM_TXN_DIR_TX ((uint8_t) 1U)
| I2C LLD Write. More...
#define | I2C_MEM_TXN_DIR_RX ((uint8_t) 2U)
| I2C LLD Read. More...

## Typedefs
typedef struct I2C_Config_s * | I2C_Handle
| A handle that is returned from a I2C_open() call. More...
typedef void(* | I2C_CallbackFxn) (I2C_Handle handle, I2C_Transaction *msg, int32_t transferStatus)
| I2C Callback Function. More...

## Functions
void | I2C_init (void)
| Initialize the I2C module. More...
void | I2C_deinit (void)
| De-nitialize the I2C module. More...
void | I2C_Params_init (I2C_Params *params)
| API to set default values of I2C_Params in params. More...
I2C_Handle | I2C_open (uint32_t idx, const I2C_Params *params)
| API to Open I2C at index idx with parameters params. More...
void | I2C_close (I2C_Handle handle)
| API to close the I2C instance specified by the handle passed. More...
void | I2C_Memory_Transaction_init (I2C_Mem_Transaction *memTransaction)
| API to set default values of I2C_Mem_Transaction in memTransaction. More...
void | I2C_Transaction_init (I2C_Transaction *transaction)
| API to set default values of I2C_Transaction in transaction. More...
int32_t | I2C_transfer (I2C_Handle handle, I2C_Transaction *transaction)
| API to initiate a transfer from I2C Instance. More...
int32_t | I2C_memory_transfer (I2C_Handle handle, I2C_Mem_Transaction *transaction)
| API to initiate a memory transfer from I2C Instance. More...
int32_t | I2C_probe (I2C_Handle handle, uint32_t targetAddr)
| API to probe I2C Device. More...
int32_t | I2C_setBusFrequency (I2C_Handle handle, uint32_t busFrequency)
| API to set the bus frequency of I2C Instance. More...
I2C_Handle | I2C_getHandle (uint32_t index)
| API to get the handle of an open I2C instance from the instance index. More...