no-OS
Classes | Typedefs | Enumerations | Functions | Variables
i2c_extra.h File Reference
#include <stdint.h>
Include dependency graph for i2c_extra.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  xil_i2c_init_param
 
struct  xil_i2c_desc
 Xilinx platform specific I2C descriptor. More...
 

Typedefs

typedef struct xil_i2c_init_param xil_i2c_init_param
 
typedef struct xil_i2c_desc xil_i2c_desc
 

Enumerations

enum  xil_i2c_type {
  IIC_PL,
  IIC_PS
}
 Xilinx platform architecture sections. 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

enum xil_i2c_type xil_i2c_type
 
const struct no_os_i2c_platform_ops xil_i2c_ops
 Xilinx platform specific i2c platform ops structure. More...
 

Typedef Documentation

◆ xil_i2c_desc

typedef struct xil_i2c_desc xil_i2c_desc

◆ xil_i2c_init_param

Enumeration Type Documentation

◆ xil_i2c_type

Xilinx platform architecture sections.

Enumerator
IIC_PL 

Programmable Logic

IIC_PS 

Processing System

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

Xilinx platform specific i2c platform ops structure.

Xilinx platform specific i2c platform ops structure.

◆ xil_i2c_type