SPDX: Convert all of our single license tags to Linux Kernel style
[oweals/u-boot.git] / arch / arm / include / asm / mach-imx / mxc_i2c.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright (C) 2011 Freescale Semiconductor, Inc. All Rights Reserved.
4  */
5 #ifndef __ASM_ARCH_MXC_MXC_I2C_H__
6 #define __ASM_ARCH_MXC_MXC_I2C_H__
7 #include <asm-generic/gpio.h>
8 #include <asm/mach-imx/iomux-v3.h>
9
10 struct i2c_pin_ctrl {
11         iomux_v3_cfg_t i2c_mode;
12         iomux_v3_cfg_t gpio_mode;
13         unsigned char gp;
14         unsigned char spare;
15 };
16
17 struct i2c_pads_info {
18         struct i2c_pin_ctrl scl;
19         struct i2c_pin_ctrl sda;
20 };
21
22 /*
23  * Information about i2c controller
24  * struct mxc_i2c_bus - information about the i2c[x] bus
25  * @index: i2c bus index
26  * @base: Address of I2C bus controller
27  * @driver_data: Flags for different platforms, such as I2C_QUIRK_FLAG.
28  * @speed: Speed of I2C bus
29  * @pads_info: pinctrl info for this i2c bus, will be used when pinctrl is ok.
30  * The following two is only to be compatible with non-DM part.
31  * @idle_bus_fn: function to force bus idle
32  * @idle_bus_data: parameter for idle_bus_fun
33  * For DM:
34  * bus: The device structure for i2c bus controller
35  * scl-gpio: specify the gpio related to SCL pin
36  * sda-gpio: specify the gpio related to SDA pin
37  */
38 struct mxc_i2c_bus {
39         /*
40          * board file can use this index to locate which i2c_pads_info is for
41          * i2c_idle_bus. When pinmux is implement, this entry can be
42          * discarded. Here we do not use dev->seq, because we do not want to
43          * export device to board file.
44          */
45         int index;
46         ulong base;
47         ulong driver_data;
48         int speed;
49         struct i2c_pads_info *pads_info;
50 #ifndef CONFIG_DM_I2C
51         int (*idle_bus_fn)(void *p);
52         void *idle_bus_data;
53 #else
54         struct udevice *bus;
55         /* Use gpio to force bus idle when bus state is abnormal */
56         struct gpio_desc scl_gpio;
57         struct gpio_desc sda_gpio;
58 #endif
59 };
60
61 #if defined(CONFIG_MX6QDL)
62 #define I2C_PADS(name, scl_i2c, scl_gpio, scl_gp, sda_i2c, sda_gpio, sda_gp) \
63         struct i2c_pads_info mx6q_##name = {            \
64                 .scl = {                                \
65                         .i2c_mode = MX6Q_##scl_i2c,     \
66                         .gpio_mode = MX6Q_##scl_gpio,   \
67                         .gp = scl_gp,                   \
68                 },                                      \
69                 .sda = {                                \
70                         .i2c_mode = MX6Q_##sda_i2c,     \
71                         .gpio_mode = MX6Q_##sda_gpio,   \
72                         .gp = sda_gp,                   \
73                 }                                       \
74         };                                              \
75         struct i2c_pads_info mx6s_##name = {            \
76                 .scl = {                                \
77                         .i2c_mode = MX6DL_##scl_i2c,    \
78                         .gpio_mode = MX6DL_##scl_gpio,  \
79                         .gp = scl_gp,                   \
80                 },                                      \
81                 .sda = {                                \
82                         .i2c_mode = MX6DL_##sda_i2c,    \
83                         .gpio_mode = MX6DL_##sda_gpio,  \
84                         .gp = sda_gp,                   \
85                 }                                       \
86         };
87
88
89 #define I2C_PADS_INFO(name)     \
90         (is_mx6dq() || is_mx6dqp()) ? &mx6q_##name : &mx6s_##name
91 #endif
92
93 int setup_i2c(unsigned i2c_index, int speed, int slave_addr,
94               struct i2c_pads_info *p);
95 void bus_i2c_init(int index, int speed, int slave_addr,
96                 int (*idle_bus_fn)(void *p), void *p);
97 int force_idle_bus(void *priv);
98 int i2c_idle_bus(struct mxc_i2c_bus *i2c_bus);
99 #endif