no-OS
Classes | Typedefs | Functions
i2c.h File Reference

Header file of I2C Interface. More...

#include <stdint.h>
Include dependency graph for i2c.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  i2c_init_param
 Structure holding the parameters for I2C initialization. More...
 
struct  i2c_desc
 Structure holding I2C descriptor. More...
 
struct  i2c_platform_ops
 Structure holding I2C function pointers that point to the platform specific function. More...
 

Typedefs

typedef struct i2c_init_param i2c_init_param
 
typedef struct i2c_desc i2c_desc
 

Functions

int32_t i2c_init (struct i2c_desc **desc, const struct i2c_init_param *param)
 Initialize the I2C communication peripheral. More...
 
int32_t i2c_remove (struct i2c_desc *desc)
 Free the resources allocated by i2c_init(). More...
 
int32_t i2c_write (struct i2c_desc *desc, uint8_t *data, uint8_t bytes_number, uint8_t stop_bit)
 I2C Write data to slave device. More...
 
int32_t i2c_read (struct i2c_desc *desc, uint8_t *data, uint8_t bytes_number, uint8_t stop_bit)
 I2C Read data from slave device. More...
 

Detailed Description

Header file of I2C Interface.

Author
DBogdan (drago.nosp@m.s.bo.nosp@m.gdan@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2019(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Typedef Documentation

◆ i2c_desc

typedef struct i2c_desc i2c_desc

◆ i2c_init_param

Function Documentation

◆ i2c_init()

int32_t i2c_init ( struct i2c_desc **  desc,
const struct i2c_init_param param 
)

Initialize the I2C communication peripheral.

Parameters
desc- The I2C descriptor.
param- The structure that contains the I2C parameters.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ i2c_read()

int32_t i2c_read ( struct i2c_desc desc,
uint8_t *  data,
uint8_t  bytes_number,
uint8_t  stop_bit 
)

I2C Read data from slave device.

Parameters
desc- The i2c descriptor.
data- The buffer with the transmitted/received data.
bytes_number- Number of bytes to read.
stop_bit- Stop conditional control. Example: 0 - A stop condition will not be generated. 1 - A stop condition will be generated.
Returns
SUCCESS in case of success, FAILURE otherwise.

I2C Read data from slave device.

Parameters
desc- The I2C descriptor.
data- Buffer that will store the received data.
bytes_number- Number of bytes to read.
stop_bit- Stop condition control. Example: 0 - A stop condition will not be generated; 1 - A stop condition will be generated.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ i2c_remove()

int32_t i2c_remove ( struct i2c_desc desc)

Free the resources allocated by i2c_init().

Parameters
desc- The I2C descriptor.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ i2c_write()

int32_t i2c_write ( struct i2c_desc desc,
uint8_t *  data,
uint8_t  bytes_number,
uint8_t  stop_bit 
)

I2C Write data to slave device.

Parameters
desc- The I2C descriptor.
data- The buffer with the transmitted/received data.
bytes_number- Number of bytes to write.
stop_bit- Stop conditional control. Example: 0 - A stop condition will not be generated. 1 - A stop condition will be generated.
Returns
SUCCESS in case of success, FAILURE otherwise.

I2C Write data to slave device.

Parameters
desc- The I2C descriptor.
data- Buffer that stores the transmission data.
bytes_number- Number of bytes to write.
stop_bit- Stop condition control. Example: 0 - A stop condition will not be generated; 1 - A stop condition will be generated.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function: