no-OS
i2c_extra.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * @file xilinx/i2c_extra.h
3  * @brief Header containing types used in the i2c driver.
4  * @author scuciurean (sergiu.cuciurean@analog.com)
5 ********************************************************************************
6  * Copyright 2019(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 
40 #ifndef I2C_EXTRA_H_
41 #define I2C_EXTRA_H_
42 
43 /******************************************************************************/
44 /***************************** Include Files **********************************/
45 /******************************************************************************/
46 
47 #include <stdint.h>
48 
49 /******************************************************************************/
50 /*************************** Types Declarations *******************************/
51 /******************************************************************************/
52 
62 } xil_i2c_type;
63 
69 typedef struct xil_i2c_init_param {
73  uint32_t device_id;
75 
80 typedef struct xil_i2c_desc {
84  uint32_t device_id;
86  void *config;
88  void *instance;
89 } xil_i2c_desc;
90 
94 extern const struct no_os_i2c_platform_ops xil_i2c_ops;
95 
96 /******************************************************************************/
97 /************************ Functions Declarations ******************************/
98 /******************************************************************************/
99 
100 /* Initialize the I2C communication peripheral. */
101 int32_t xil_i2c_init(struct no_os_i2c_desc **desc,
102  const struct no_os_i2c_init_param *param);
103 
104 /* Free the resources allocated by no_os_i2c_init(). */
105 int32_t xil_i2c_remove(struct no_os_i2c_desc *desc);
106 
107 /* I2C Write data */
108 int32_t xil_i2c_write(struct no_os_i2c_desc *desc, uint8_t *data,
109  uint8_t bytes_number, uint8_t stop_bit);
110 
111 /* I2C Read data. */
112 int32_t xil_i2c_read(struct no_os_i2c_desc *desc, uint8_t *data,
113  uint8_t bytes_number, uint8_t stop_bit);
114 
115 #endif // I2C_EXTRA_H_
IIC_PS
@ IIC_PS
Definition: i2c_extra.h:61
xil_i2c_desc
Xilinx platform specific I2C descriptor.
Definition: i2c_extra.h:80
xil_i2c_desc::device_id
uint32_t device_id
Definition: i2c_extra.h:84
xil_i2c_desc::instance
void * instance
Definition: i2c_extra.h:88
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.
Definition: xilinx_i2c.c:457
xil_i2c_init_param
Definition: i2c_extra.h:69
xil_i2c_desc::type
enum xil_i2c_type type
Definition: i2c_extra.h:82
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.
Definition: xilinx_i2c.c:160
xil_i2c_type
xil_i2c_type
Xilinx platform architecture sections.
Definition: i2c_extra.h:57
no_os_i2c_platform_ops
Structure holding I2C function pointers that point to the platform specific function.
Definition: no_os_i2c.h:99
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.
Definition: xilinx_i2c.c:392
no_os_i2c_desc
Structure holding I2C descriptor.
Definition: no_os_i2c.h:81
xil_i2c_desc
struct xil_i2c_desc xil_i2c_desc
IIC_PL
@ IIC_PL
Definition: i2c_extra.h:59
xil_i2c_ops
const struct no_os_i2c_platform_ops xil_i2c_ops
Xilinx platform specific i2c platform ops structure.
Definition: xilinx_i2c.c:92
xil_i2c_remove
int32_t xil_i2c_remove(struct no_os_i2c_desc *desc)
Free the resources allocated by no_os_i2c_init().
Definition: xilinx_i2c.c:317
no_os_i2c_init_param
Structure holding the parameters for I2C initialization.
Definition: no_os_i2c.h:64
xil_i2c_init_param
struct xil_i2c_init_param xil_i2c_init_param
xil_i2c_init_param::type
enum xil_i2c_type type
Definition: i2c_extra.h:71
xil_i2c_init_param::device_id
uint32_t device_id
Definition: i2c_extra.h:73
xil_i2c_desc::config
void * config
Definition: i2c_extra.h:86