xilinx_i2c.c File Reference

Implementation of Xilinx I2C Generic Driver. More...

#include <stdlib.h>
#include <xparameters.h>
#include "no_os_error.h"
#include "no_os_i2c.h"
#include "xilinx_i2c.h"
#include "no_os_list.h"
#include "no_os_alloc.h"

Include dependency graph for xilinx_i2c.c:

Classes
struct	inst_table_item
	Table item for I2C cores already started. More...

Functions
int32_t	xil_i2c_init (struct no_os_i2c_desc **desc, const struct no_os_i2c_init_param *param)
	Initialize the I2C communication peripheral. More...
int32_t	xil_i2c_remove (struct no_os_i2c_desc *desc)
	Free the resources allocated by no_os_i2c_init(). More...
int32_t	xil_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. More...
int32_t	xil_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. More...

Variables
const struct no_os_i2c_platform_ops	xil_i2c_ops
	Xilinx platform specific I2C platform ops structure. More...

Detailed Description

Implementation of Xilinx I2C Generic Driver.

Author

Antoniu Miclaus (anton.nosp@m.iu.m.nosp@m.iclau.nosp@m.s@an.nosp@m.alog..nosp@m.com)

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.

Function Documentation

xil_i2c_init()

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

xil_i2c_read()

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

xil_i2c_remove()

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

xil_i2c_write()

int32_t xil_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

xil_i2c_ops

const struct no_os_i2c_platform_ops xil_i2c_ops

Initial value:

= {
    .i2c_ops_init = &xil_i2c_init,
    .i2c_ops_write = &xil_i2c_write,
    .i2c_ops_read = &xil_i2c_read,
    .i2c_ops_remove = &xil_i2c_remove
}

Xilinx platform specific I2C platform ops structure.

Xilinx platform specific i2c platform ops structure.