Merge tag 'u-boot-imx-20191105' of https://gitlab.denx.de/u-boot/custodians/u-boot-imx
[platform/kernel/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 #if CONFIG_IS_ENABLED(CLK)
10 #include <clk.h>
11 #endif
12
13 struct i2c_pin_ctrl {
14         iomux_v3_cfg_t i2c_mode;
15         iomux_v3_cfg_t gpio_mode;
16         unsigned char gp;
17         unsigned char spare;
18 };
19
20 struct i2c_pads_info {
21         struct i2c_pin_ctrl scl;
22         struct i2c_pin_ctrl sda;
23 };
24
25 /*
26  * Information about i2c controller
27  * struct mxc_i2c_bus - information about the i2c[x] bus
28  * @index: i2c bus index
29  * @base: Address of I2C bus controller
30  * @driver_data: Flags for different platforms, such as I2C_QUIRK_FLAG.
31  * @speed: Speed of I2C bus
32  * @pads_info: pinctrl info for this i2c bus, will be used when pinctrl is ok.
33  * The following two is only to be compatible with non-DM part.
34  * @idle_bus_fn: function to force bus idle
35  * @idle_bus_data: parameter for idle_bus_fun
36  * For DM:
37  * bus: The device structure for i2c bus controller
38  * scl-gpio: specify the gpio related to SCL pin
39  * sda-gpio: specify the gpio related to SDA pin
40  */
41 struct mxc_i2c_bus {
42         /*
43          * board file can use this index to locate which i2c_pads_info is for
44          * i2c_idle_bus. When pinmux is implement, this entry can be
45          * discarded. Here we do not use dev->seq, because we do not want to
46          * export device to board file.
47          */
48         int index;
49         ulong base;
50         ulong driver_data;
51         int speed;
52         struct i2c_pads_info *pads_info;
53 #if CONFIG_IS_ENABLED(CLK)
54         struct clk per_clk;
55 #endif
56 #ifndef CONFIG_DM_I2C
57         int (*idle_bus_fn)(void *p);
58         void *idle_bus_data;
59 #else
60         struct udevice *bus;
61         /* Use gpio to force bus idle when bus state is abnormal */
62         struct gpio_desc scl_gpio;
63         struct gpio_desc sda_gpio;
64 #endif
65 };
66
67 #if defined(CONFIG_MX6QDL)
68 #define I2C_PADS(name, scl_i2c, scl_gpio, scl_gp, sda_i2c, sda_gpio, sda_gp) \
69         struct i2c_pads_info mx6q_##name = {            \
70                 .scl = {                                \
71                         .i2c_mode = MX6Q_##scl_i2c,     \
72                         .gpio_mode = MX6Q_##scl_gpio,   \
73                         .gp = scl_gp,                   \
74                 },                                      \
75                 .sda = {                                \
76                         .i2c_mode = MX6Q_##sda_i2c,     \
77                         .gpio_mode = MX6Q_##sda_gpio,   \
78                         .gp = sda_gp,                   \
79                 }                                       \
80         };                                              \
81         struct i2c_pads_info mx6s_##name = {            \
82                 .scl = {                                \
83                         .i2c_mode = MX6DL_##scl_i2c,    \
84                         .gpio_mode = MX6DL_##scl_gpio,  \
85                         .gp = scl_gp,                   \
86                 },                                      \
87                 .sda = {                                \
88                         .i2c_mode = MX6DL_##sda_i2c,    \
89                         .gpio_mode = MX6DL_##sda_gpio,  \
90                         .gp = sda_gp,                   \
91                 }                                       \
92         };
93
94
95 #define I2C_PADS_INFO(name)     \
96         (is_mx6dq() || is_mx6dqp()) ? &mx6q_##name : &mx6s_##name
97 #endif
98
99 int setup_i2c(unsigned i2c_index, int speed, int slave_addr,
100               struct i2c_pads_info *p);
101 void bus_i2c_init(int index, int speed, int slave_addr,
102                 int (*idle_bus_fn)(void *p), void *p);
103 int force_idle_bus(void *priv);
104 int i2c_idle_bus(struct mxc_i2c_bus *i2c_bus);
105 #endif