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  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice,
12  * this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of Analog Devices, Inc. nor the names of its
19  * contributors may be used to endorse or promote products derived from this
20  * software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
25  * EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
28  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
31  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 *******************************************************************************/
33 #ifndef LINUX_I2C_H_
34 #define LINUX_I2C_H_
35 
43  uint32_t device_id;
44 };
45 
49 extern const struct no_os_i2c_platform_ops linux_i2c_ops;
50 
51 #endif // LINUX_I2C_H_
no_os_alloc.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:60
linux_i2c_init_param
Structure holding the initialization parameters for Linux platform specific I2C parameters.
Definition: linux_i2c.h:41
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:109
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:149
linux_i2c_ops
const struct no_os_i2c_platform_ops linux_i2c_ops
Linux platform specific I2C platform ops structure.
Definition: linux_i2c.c:220
linux_i2c_init_param::device_id
uint32_t device_id
Definition: linux_i2c.h:43
no_os_i2c_platform_ops
Structure holding I2C function pointers that point to the platform specific function.
Definition: no_os_i2c.h:121
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:123
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:73
no_os_i2c_desc
Structure holding I2C address descriptor.
Definition: no_os_i2c.h:101
no_os_malloc
void * no_os_malloc(size_t size)
Allocate memory and return a pointer to it.
Definition: chibios_alloc.c:43
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:120
no_os_free
void no_os_free(void *ptr)
Deallocate memory previously allocated by a call to no_os_calloc or no_os_malloc.
Definition: chibios_alloc.c:69
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:188
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:113
linux_i2c_ops
const struct no_os_i2c_platform_ops linux_i2c_ops
Linux specific I2C platform ops structure.
Definition: linux_i2c.c:220
linux_i2c_desc
Linux platform specific I2C descriptor.
Definition: linux_i2c.c:58