no-OS
Classes | Macros | Functions
i2c.c File Reference

Implementation of I2C driver for ADuCM302x. More...

#include "i2c.h"
#include "error.h"
#include <stdlib.h>
#include <drivers/i2c/adi_i2c.h>
#include <drivers/gpio/adi_gpio.h>
#include <string.h>
Include dependency graph for i2c.c:

Classes

struct  aducm_i2c_extra
 

Macros

#define UNINITIALIZED_BITRATE   0
 
#define UNINITIALIZED_ADDRESS   0xFF
 

Functions

int32_t i2c_init (struct i2c_desc **desc, const struct i2c_init_param *param)
 Initialize the I2C communication peripheral. Supported bitrates are between 100kHz and 400 kHz. Is slave address is 0, then this instance will be used for general call. 10 bits addressing is not supported. More...
 
int32_t i2c_remove (struct i2c_desc *desc)
 Free the resources allocated by i2c_init. More...
 
int32_t i2c_write (struct i2c_desc *desc, uint8_t *data, uint8_t bytes_number, uint8_t stop_bit)
 Write data to a slave device. More...
 
int32_t i2c_read (struct i2c_desc *desc, uint8_t *data, uint8_t bytes_number, uint8_t stop_bit)
 Read data from a slave device. More...
 

Detailed Description

Implementation of I2C driver for ADuCM302x.

Author
Mihail Chindris (mihai.nosp@m.l.ch.nosp@m.indri.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:

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.

Macro Definition Documentation

◆ UNINITIALIZED_ADDRESS

#define UNINITIALIZED_ADDRESS   0xFF

◆ UNINITIALIZED_BITRATE

#define UNINITIALIZED_BITRATE   0

Function Documentation

◆ i2c_init()

int32_t i2c_init ( struct i2c_desc **  desc,
const struct i2c_init_param param 
)

Initialize the I2C communication peripheral. Supported bitrates are between 100kHz and 400 kHz. Is slave address is 0, then this instance will be used for general call. 10 bits addressing is not supported.

Initialize the I2C communication peripheral.

Parameters
desc- Descriptor of the I2C device used in the call of the driver functions.
param- Parameter used to configure the I2C device. The extra field it is not used and must be set to NULL.
Returns
SUCCESS in case of success, FAILURE otherwise.

◆ i2c_read()

int32_t i2c_read ( struct i2c_desc desc,
uint8_t *  data,
uint8_t  bytes_number,
uint8_t  stop_bit 
)

Read data from a slave device.

I2C Read data from slave device.

Parameters
desc- Descriptor of the I2C device
data- Buffer that stores the transmission data.
bytes_number- Number of bytes to write.
stop_bit- Stop condition control. NOTE: not applicable in this case Example: 0 - A stop condition will not be generated. 1 - A stop condition will be generated
Returns
SUCCESS in case of success, FAILURE otherwise.

◆ i2c_remove()

int32_t i2c_remove ( struct i2c_desc desc)

Free the resources allocated by i2c_init.

Free the resources allocated by i2c_init().

Parameters
desc- Descriptor of the I2C device
Returns
SUCCESS in case of success, FAILURE otherwise.

◆ i2c_write()

int32_t i2c_write ( struct i2c_desc desc,
uint8_t *  data,
uint8_t  bytes_number,
uint8_t  stop_bit 
)

Write data to a slave device.

I2C Write data to slave device.

Parameters
desc- Descriptor of the I2C device
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
SUCCESS in case of success, FAILURE otherwise.