generic_i2c.c File Reference

#include "no_os_error.h"
#include "no_os_i2c.h"
#include "no_os_util.h"

Include dependency graph for generic_i2c.c:

Functions
int32_t	generic_i2c_init (struct no_os_i2c_desc **desc, const struct no_os_i2c_init_param *param)
	Initialize the I2C communication peripheral.
int32_t	generic_i2c_remove (struct no_os_i2c_desc *desc)
	Free the resources allocated by no_os_i2c_init().
int32_t	generic_i2c_write (struct no_os_i2c_desc *desc, uint8_t *data, uint8_t bytes_number, uint8_t stop_bit)
	Write data to a slave device.
int32_t	generic_i2c_read (struct no_os_i2c_desc *desc, uint8_t *data, uint8_t bytes_number, uint8_t stop_bit)
	Read data from a slave device.

Variables
const struct no_os_i2c_platform_ops	generic_i2c_ops
	Generic platform I2C ops.

Detailed Description

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.

SPDX-License-Identifier: BSD-3-Clause

Function Documentation

generic_i2c_init()

int32_t generic_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.

generic_i2c_read()

int32_t generic_i2c_read	(	struct no_os_i2c_desc *	desc,
		uint8_t *	data,
		uint8_t	bytes_number,
		uint8_t	stop_bit )

Read data from a 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

0 in case of success, -1 otherwise.

generic_i2c_remove()

int32_t generic_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.

generic_i2c_write()

int32_t generic_i2c_write	(	struct no_os_i2c_desc *	desc,
		uint8_t *	data,
		uint8_t	bytes_number,
		uint8_t	stop_bit )

Write data to a 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

0 in case of success, -1 otherwise.

Variable Documentation

generic_i2c_ops

const struct no_os_i2c_platform_ops generic_i2c_ops

Initial value:

= {
    .i2c_ops_init = &generic_i2c_init,
    .i2c_ops_write = &generic_i2c_write,
    .i2c_ops_read = &generic_i2c_read,
    .i2c_ops_remove = &generic_i2c_remove
}

Generic platform I2C ops.