XDK API  3.6.0
Documentation
Files
I2C

Unified I2C Master Interface. More...

+ Collaboration diagram for I2C:

Files

file  BCDS_MCU_I2C.h
 

Detailed Description

Usually the I2C hardware gets initialized by the HAL-BSP (Board support package). The application should then be able to get a handle on a fully initialized I2C device that can be used by this driver to send and receive data.

A typical use of this API would start with initializing the driver instance with a correct handle, and a callback function for the application layer in case the call mode is not blocking. This will initialize the driver and bind it to the handle of the BSP. After that it is ready to use according to settings made in the BSP.

Retcode_T retcode = MCU_I2C_Initialize(I2c2, MyI2CCallBack);
if(RETCODE_OK == retcode)
{
// use the I2C driver
}

Now, the I2C is configured and active such that the communication can start.

Note
It is possible to disable the entire I2C feature in the HAL-BSP configuration file. I.e. the I2C code will only be compiled and linked if the feature BCDS_FEATURE_I2C is set to 1 in the configuration file.
This interface only supports the I2C master mode.
Attention
This I2C interface only supports 7 bit addresses for slave addressing.

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:53 by doxygen 1.8.8