altera_i2c.h File Reference

Classes
struct	altera_i2c_init_param
	Structure holding the initialization parameters for Altera platform specific I2C parameters. More...
struct	altera_i2c_desc
	Altera platform specific I2C descriptor. More...

Enumerations
enum	i2c_type { NIOS_II_I2C }
	Altera platform architecture types. More...

Functions
int32_t	altera_i2c_init (struct no_os_i2c_desc **desc, const struct no_os_i2c_init_param *param)
	Initialize the I2C communication peripheral.
int32_t	altera_i2c_remove (struct no_os_i2c_desc *desc)
	Free the resources allocated by no_os_i2c_init().
int32_t	altera_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	altera_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
enum i2c_type	i2c_type
struct altera_i2c_init_param	altera_i2c_init_param
struct altera_i2c_desc	altera_i2c_desc
const struct no_os_i2c_platform_ops	altera_i2c_ops
	Altera platform specific i2c platform ops structure.

Detailed Description

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.

SPDX-License-Identifier: BSD-3-Clause

Enumeration Type Documentation

i2c_type

enum i2c_type

Altera platform architecture types.

Enumerator
NIOS_II_I2C	Nios II architecture

Function Documentation

altera_i2c_init()

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

altera_i2c_read()

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

altera_i2c_remove()

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

altera_i2c_write()

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

altera_i2c_desc

struct altera_i2c_desc altera_i2c_desc

altera_i2c_init_param

struct altera_i2c_init_param altera_i2c_init_param

altera_i2c_ops

const struct no_os_i2c_platform_ops altera_i2c_ops

extern

Altera platform specific i2c platform ops structure.

Altera platform specific i2c platform ops structure.

i2c_type

enum i2c_type i2c_type