no-OS
Functions
no_os_i2c.c File Reference

Implementation of the I2C Interface. More...

#include <inttypes.h>
#include "no_os_i2c.h"
#include <stdlib.h>
#include "no_os_error.h"
Include dependency graph for no_os_i2c.c:

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

Detailed Description

Implementation of the I2C Interface.

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

Copyright 2020(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:

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

◆ 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: