no-OS
linux_i2c.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * @file linux/linux_i2c.h
3  * @brief Header containing extra types used by the I2C driver.
4  * @author Dragos Bogdan (dragos.bogdan@analog.com)
5 ********************************************************************************
6  * Copyright 2020(c) Analog Devices, Inc.
7  *
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  * - Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * - Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  * - Neither the name of Analog Devices, Inc. nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  * - The use of this software may or may not infringe the patent rights
22  * of one or more patent holders. This license does not release you
23  * from the requirement that you obtain separate licenses from these
24  * patent holders to use this software.
25  * - Use of the software either in source or binary form, must be run
26  * on or directly connected to an Analog Devices Inc. component.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
29  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
30  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
31  * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
32  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33  * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
34  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
35  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
36  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 *******************************************************************************/
39 #ifndef LINUX_I2C_H_
40 #define LINUX_I2C_H_
41 
49  uint32_t device_id;
50 };
51 
55 extern const struct no_os_i2c_platform_ops linux_i2c_ops;
56 
57 #endif // LINUX_I2C_H_
no_os_i2c_init_param::slave_address
uint8_t slave_address
Definition: no_os_i2c.h:70
linux_i2c.h
linux_i2c_desc::fd
int fd
Definition: linux_i2c.c:65
linux_i2c_init_param
Structure holding the initialization parameters for Linux platform specific I2C parameters.
Definition: linux_i2c.h:47
no_os_i2c_init_param::extra
void * extra
Definition: no_os_i2c.h:74
no_os_i2c_desc::slave_address
uint8_t slave_address
Definition: no_os_i2c.h:87
no_os_error.h
Error codes definition.
linux_i2c_write
int32_t linux_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.
Definition: linux_i2c.c:153
linux_i2c_ops
const struct no_os_i2c_platform_ops linux_i2c_ops
Linux platform specific I2C platform ops structure.
Definition: linux_i2c.c:224
linux_i2c_init_param::device_id
uint32_t device_id
Definition: linux_i2c.h:49
no_os_i2c_platform_ops
Structure holding I2C function pointers that point to the platform specific function.
Definition: no_os_i2c.h:99
no_os_i2c_platform_ops::i2c_ops_init
int32_t(* i2c_ops_init)(struct no_os_i2c_desc **, const struct no_os_i2c_init_param *)
Definition: no_os_i2c.h:101
linux_i2c_init
int32_t linux_i2c_init(struct no_os_i2c_desc **desc, const struct no_os_i2c_init_param *param)
Initialize the I2C communication peripheral.
Definition: linux_i2c.c:78
no_os_i2c_desc
Structure holding I2C descriptor.
Definition: no_os_i2c.h:81
no_os_i2c.h
Header file of I2C Interface.
linux_i2c_remove
int32_t linux_i2c_remove(struct no_os_i2c_desc *desc)
Free the resources allocated by no_os_i2c_init().
Definition: linux_i2c.c:124
linux_i2c_read
int32_t linux_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.
Definition: linux_i2c.c:192
no_os_i2c_init_param
Structure holding the parameters for I2C initialization.
Definition: no_os_i2c.h:64
no_os_i2c_desc::extra
void * extra
Definition: no_os_i2c.h:91
linux_i2c_ops
const struct no_os_i2c_platform_ops linux_i2c_ops
Linux specific I2C platform ops structure.
Definition: linux_i2c.c:224
linux_i2c_desc
Linux platform specific I2C descriptor.
Definition: linux_i2c.c:63