no_os_i2c.h File Reference

Header file of I2C Interface. More...

#include <stdint.h>

Include dependency graph for no_os_i2c.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	no_os_i2c_init_param
	Structure holding the parameters for I2C initialization. More...
struct	no_os_i2cbus_desc
	Structure holding I2C bus descriptor. More...
struct	no_os_i2c_desc
	Structure holding I2C address descriptor. More...
struct	no_os_i2c_platform_ops
	Structure holding I2C function pointers that point to the platform specific function. More...

Macros
#define	I2C_MAX_BUS_NUMBER   4

Functions
int32_t	no_os_i2c_init (struct no_os_i2c_desc **desc, const struct no_os_i2c_init_param *param)
	Initialize the I2C communication peripheral. More...
int32_t	no_os_i2c_remove (struct no_os_i2c_desc *desc)
	Free the resources allocated by no_os_i2c_init(). More...
int32_t	no_os_i2c_write (struct no_os_i2c_desc *desc, uint8_t *data, uint8_t bytes_number, uint8_t stop_bit)
	I2C Write data to slave device. More...
int32_t	no_os_i2c_read (struct no_os_i2c_desc *desc, uint8_t *data, uint8_t bytes_number, uint8_t stop_bit)
	I2C Read data from slave device. More...
int32_t	no_os_i2cbus_init (const struct no_os_i2c_init_param *param)
	Initialize the i2c bus communication peripheral. More...
void	no_os_i2cbus_remove (uint32_t bus_number)
	Removes i2c bus instance. 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:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
• The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
• Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

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.

Macro Definition Documentation

I2C_MAX_BUS_NUMBER

#define I2C_MAX_BUS_NUMBER   4

Function Documentation

no_os_i2c_init()

int32_t no_os_i2c_init	(	struct no_os_i2c_desc **	desc,
		const struct no_os_i2c_init_param *	param
	)

Initialize the I2C communication peripheral.

Parameters

desc	- The I2C descriptor.
param	- The structure that contains the I2C parameters.

Returns

0 in case of success, -1 otherwise.

Here is the caller graph for this function:

no_os_i2c_read()

int32_t no_os_i2c_read	(	struct no_os_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

0 in case of success, -1 otherwise.

Here is the caller graph for this function:

no_os_i2c_remove()

int32_t no_os_i2c_remove

(

struct no_os_i2c_desc *

desc

)

Free the resources allocated by no_os_i2c_init().

Parameters

desc	- The I2C descriptor.

Returns

0 in case of success, -1 otherwise.

Here is the caller graph for this function:

no_os_i2c_write()

int32_t no_os_i2c_write	(	struct no_os_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

0 in case of success, -1 otherwise.

Here is the caller graph for this function:

no_os_i2cbus_init()

int32_t no_os_i2cbus_init

(

const struct no_os_i2c_init_param *

param

)

Initialize the i2c bus communication peripheral.

Parameters

param

- The structure that containes the i2c bus parameters

Returns

0 in case of success, error code otherwise

no_os_i2cbus_remove()

void no_os_i2cbus_remove

(

uint32_t

bus_number

)

Removes i2c bus instance.

Parameters

bus_number

- i2c bus number

Here is the caller graph for this function: