blob: 44a1f3339834e46514a2e2d1083e66fe9265d50c [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Vipin KUMARfc9589f2010-01-15 19:15:44 +05302/*
3 * (C) Copyright 2009
4 * Vipin Kumar, ST Micoelectronics, vipin.kumar@st.com.
Vipin KUMARfc9589f2010-01-15 19:15:44 +05305 */
6
7#include <common.h>
Simon Glass9b7af642020-01-23 11:48:06 -07008#include <clk.h>
Stefan Roese3cb27962016-04-21 08:19:41 +02009#include <dm.h>
Stefan Roeseef6073e2014-10-28 12:12:00 +010010#include <i2c.h>
Simon Glass0f2af882020-05-10 11:40:05 -060011#include <log.h>
Simon Glass9bc15642020-02-03 07:36:16 -070012#include <malloc.h>
Stefan Roese38481202016-04-21 08:19:42 +020013#include <pci.h>
Dinh Nguyen08794aa2018-04-04 17:18:24 -050014#include <reset.h>
Vipin KUMARfc9589f2010-01-15 19:15:44 +053015#include <asm/io.h>
Simon Glassdbd79542020-05-10 11:40:11 -060016#include <linux/delay.h>
Vipin KUMAR3f64acb2012-02-26 23:13:29 +000017#include "designware_i2c.h"
Simon Glass9bc15642020-02-03 07:36:16 -070018#include <dm/device_compat.h>
Simon Glassd66c5f72020-02-03 07:36:15 -070019#include <linux/err.h>
Vipin KUMARfc9589f2010-01-15 19:15:44 +053020
Raul E Rangel057be512020-04-22 10:13:54 -060021/*
22 * This assigned unique hex value is constant and is derived from the two ASCII
23 * letters 'DW' followed by a 16-bit unsigned number
24 */
25#define DW_I2C_COMP_TYPE 0x44570140
26
Stefan Roeseabb3e132016-04-27 09:02:12 +020027#ifdef CONFIG_SYS_I2C_DW_ENABLE_STATUS_UNSUPPORTED
Simon Glassbd9ca8d2019-02-16 20:24:39 -070028static int dw_i2c_enable(struct i2c_regs *i2c_base, bool enable)
Stefan Roese3bc33ba2016-04-21 08:19:38 +020029{
30 u32 ena = enable ? IC_ENABLE_0B : 0;
Stefan Roeseabb3e132016-04-27 09:02:12 +020031
32 writel(ena, &i2c_base->ic_enable);
Simon Glassbd9ca8d2019-02-16 20:24:39 -070033
34 return 0;
Stefan Roeseabb3e132016-04-27 09:02:12 +020035}
36#else
Simon Glassbd9ca8d2019-02-16 20:24:39 -070037static int dw_i2c_enable(struct i2c_regs *i2c_base, bool enable)
Stefan Roeseabb3e132016-04-27 09:02:12 +020038{
39 u32 ena = enable ? IC_ENABLE_0B : 0;
Stefan Roese3bc33ba2016-04-21 08:19:38 +020040 int timeout = 100;
41
42 do {
43 writel(ena, &i2c_base->ic_enable);
44 if ((readl(&i2c_base->ic_enable_status) & IC_ENABLE_0B) == ena)
Simon Glassbd9ca8d2019-02-16 20:24:39 -070045 return 0;
Stefan Roese3bc33ba2016-04-21 08:19:38 +020046
47 /*
48 * Wait 10 times the signaling period of the highest I2C
49 * transfer supported by the driver (for 400KHz this is
50 * 25us) as described in the DesignWare I2C databook.
51 */
52 udelay(25);
53 } while (timeout--);
Stefan Roese3bc33ba2016-04-21 08:19:38 +020054 printf("timeout in %sabling I2C adapter\n", enable ? "en" : "dis");
Simon Glassbd9ca8d2019-02-16 20:24:39 -070055
56 return -ETIMEDOUT;
Stefan Roese3bc33ba2016-04-21 08:19:38 +020057}
Stefan Roeseabb3e132016-04-27 09:02:12 +020058#endif
Stefan Roese3bc33ba2016-04-21 08:19:38 +020059
Simon Glassc7181102020-01-23 11:48:14 -070060/* High and low times in different speed modes (in ns) */
61enum {
62 /* SDA Hold Time */
63 DEFAULT_SDA_HOLD_TIME = 300,
64};
65
66/**
67 * calc_counts() - Convert a period to a number of IC clk cycles
68 *
69 * @ic_clk: Input clock in Hz
70 * @period_ns: Period to represent, in ns
71 * @return calculated count
72 */
73static uint calc_counts(uint ic_clk, uint period_ns)
74{
75 return DIV_ROUND_UP(ic_clk / 1000 * period_ns, NANO_TO_KILO);
76}
77
78/**
79 * struct i2c_mode_info - Information about an I2C speed mode
80 *
81 * Each speed mode has its own characteristics. This struct holds these to aid
82 * calculations in dw_i2c_calc_timing().
83 *
84 * @speed: Speed in Hz
85 * @min_scl_lowtime_ns: Minimum value for SCL low period in ns
86 * @min_scl_hightime_ns: Minimum value for SCL high period in ns
87 * @def_rise_time_ns: Default rise time in ns
88 * @def_fall_time_ns: Default fall time in ns
89 */
90struct i2c_mode_info {
91 int speed;
92 int min_scl_hightime_ns;
93 int min_scl_lowtime_ns;
94 int def_rise_time_ns;
95 int def_fall_time_ns;
96};
97
98static const struct i2c_mode_info info_for_mode[] = {
99 [IC_SPEED_MODE_STANDARD] = {
Simon Glassac77bae2020-01-23 11:48:18 -0700100 I2C_SPEED_STANDARD_RATE,
Simon Glassc7181102020-01-23 11:48:14 -0700101 MIN_SS_SCL_HIGHTIME,
102 MIN_SS_SCL_LOWTIME,
103 1000,
104 300,
105 },
106 [IC_SPEED_MODE_FAST] = {
Simon Glassac77bae2020-01-23 11:48:18 -0700107 I2C_SPEED_FAST_RATE,
Simon Glassc7181102020-01-23 11:48:14 -0700108 MIN_FS_SCL_HIGHTIME,
109 MIN_FS_SCL_LOWTIME,
110 300,
111 300,
112 },
Simon Glass45649222020-01-23 11:48:23 -0700113 [IC_SPEED_MODE_FAST_PLUS] = {
114 I2C_SPEED_FAST_PLUS_RATE,
115 MIN_FP_SCL_HIGHTIME,
116 MIN_FP_SCL_LOWTIME,
117 260,
118 500,
119 },
Simon Glassc7181102020-01-23 11:48:14 -0700120 [IC_SPEED_MODE_HIGH] = {
Simon Glassac77bae2020-01-23 11:48:18 -0700121 I2C_SPEED_HIGH_RATE,
Simon Glassc7181102020-01-23 11:48:14 -0700122 MIN_HS_SCL_HIGHTIME,
123 MIN_HS_SCL_LOWTIME,
124 120,
125 120,
126 },
127};
128
129/**
130 * dw_i2c_calc_timing() - Calculate the timings to use for a bus
131 *
132 * @priv: Bus private information (NULL if not using driver model)
133 * @mode: Speed mode to use
134 * @ic_clk: IC clock speed in Hz
135 * @spk_cnt: Spike-suppression count
136 * @config: Returns value to use
137 * @return 0 if OK, -EINVAL if the calculation failed due to invalid data
138 */
139static int dw_i2c_calc_timing(struct dw_i2c *priv, enum i2c_speed_mode mode,
140 int ic_clk, int spk_cnt,
141 struct dw_i2c_speed_config *config)
142{
143 int fall_cnt, rise_cnt, min_tlow_cnt, min_thigh_cnt;
144 int hcnt, lcnt, period_cnt, diff, tot;
145 int sda_hold_time_ns, scl_rise_time_ns, scl_fall_time_ns;
146 const struct i2c_mode_info *info;
147
148 /*
149 * Find the period, rise, fall, min tlow, and min thigh in terms of
150 * counts of the IC clock
151 */
152 info = &info_for_mode[mode];
153 period_cnt = ic_clk / info->speed;
154 scl_rise_time_ns = priv && priv->scl_rise_time_ns ?
155 priv->scl_rise_time_ns : info->def_rise_time_ns;
156 scl_fall_time_ns = priv && priv->scl_fall_time_ns ?
157 priv->scl_fall_time_ns : info->def_fall_time_ns;
158 rise_cnt = calc_counts(ic_clk, scl_rise_time_ns);
159 fall_cnt = calc_counts(ic_clk, scl_fall_time_ns);
160 min_tlow_cnt = calc_counts(ic_clk, info->min_scl_lowtime_ns);
161 min_thigh_cnt = calc_counts(ic_clk, info->min_scl_hightime_ns);
162
Simon Glass46aadb62020-07-07 21:32:27 -0600163 debug("dw_i2c: mode %d, ic_clk %d, speed %d, period %d rise %d fall %d tlow %d thigh %d spk %d\n",
164 mode, ic_clk, info->speed, period_cnt, rise_cnt, fall_cnt,
165 min_tlow_cnt, min_thigh_cnt, spk_cnt);
Simon Glassc7181102020-01-23 11:48:14 -0700166
167 /*
168 * Back-solve for hcnt and lcnt according to the following equations:
169 * SCL_High_time = [(HCNT + IC_*_SPKLEN + 7) * ic_clk] + SCL_Fall_time
170 * SCL_Low_time = [(LCNT + 1) * ic_clk] - SCL_Fall_time + SCL_Rise_time
171 */
172 hcnt = min_thigh_cnt - fall_cnt - 7 - spk_cnt;
173 lcnt = min_tlow_cnt - rise_cnt + fall_cnt - 1;
174
175 if (hcnt < 0 || lcnt < 0) {
176 debug("dw_i2c: bad counts. hcnt = %d lcnt = %d\n", hcnt, lcnt);
Simon Glass46aadb62020-07-07 21:32:27 -0600177 return log_msg_ret("counts", -EINVAL);
Simon Glassc7181102020-01-23 11:48:14 -0700178 }
179
180 /*
181 * Now add things back up to ensure the period is hit. If it is off,
182 * split the difference and bias to lcnt for remainder
183 */
184 tot = hcnt + lcnt + 7 + spk_cnt + rise_cnt + 1;
185
186 if (tot < period_cnt) {
187 diff = (period_cnt - tot) / 2;
188 hcnt += diff;
189 lcnt += diff;
190 tot = hcnt + lcnt + 7 + spk_cnt + rise_cnt + 1;
191 lcnt += period_cnt - tot;
192 }
193
194 config->scl_lcnt = lcnt;
195 config->scl_hcnt = hcnt;
196
197 /* Use internal default unless other value is specified */
198 sda_hold_time_ns = priv && priv->sda_hold_time_ns ?
199 priv->sda_hold_time_ns : DEFAULT_SDA_HOLD_TIME;
200 config->sda_hold = calc_counts(ic_clk, sda_hold_time_ns);
201
202 debug("dw_i2c: hcnt = %d lcnt = %d sda hold = %d\n", hcnt, lcnt,
203 config->sda_hold);
204
205 return 0;
206}
207
Simon Glass02b880e2020-04-22 10:13:53 -0600208/**
209 * calc_bus_speed() - Calculate the config to use for a particular i2c speed
210 *
211 * @priv: Private information for the driver (NULL if not using driver model)
212 * @i2c_base: Registers for the I2C controller
213 * @speed: Required i2c speed in Hz
214 * @bus_clk: Input clock to the I2C controller in Hz (e.g. IC_CLK)
215 * @config: Returns the config to use for this speed
216 * @return 0 if OK, -ve on error
217 */
218static int calc_bus_speed(struct dw_i2c *priv, struct i2c_regs *regs, int speed,
219 ulong bus_clk, struct dw_i2c_speed_config *config)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530220{
Simon Glass60e0c3a2020-01-23 11:48:12 -0700221 const struct dw_scl_sda_cfg *scl_sda_cfg = NULL;
Simon Glass6ed44ae2020-01-23 11:48:08 -0700222 enum i2c_speed_mode i2c_spd;
Simon Glassc38e2b32020-01-23 11:48:15 -0700223 int spk_cnt;
Simon Glassc7181102020-01-23 11:48:14 -0700224 int ret;
Stefan Roese88893c92016-04-21 08:19:39 +0200225
Simon Glass60e0c3a2020-01-23 11:48:12 -0700226 if (priv)
227 scl_sda_cfg = priv->scl_sda_cfg;
Simon Glassf5ef1012020-01-23 11:48:07 -0700228 /* Allow high speed if there is no config, or the config allows it */
Jun Chen3ce27d42020-03-02 16:58:56 +0800229 if (speed >= I2C_SPEED_HIGH_RATE)
Simon Glassf5ef1012020-01-23 11:48:07 -0700230 i2c_spd = IC_SPEED_MODE_HIGH;
Simon Glass45649222020-01-23 11:48:23 -0700231 else if (speed >= I2C_SPEED_FAST_PLUS_RATE)
Simon Glass55397682020-02-13 13:24:55 -0700232 i2c_spd = IC_SPEED_MODE_FAST_PLUS;
233 else if (speed >= I2C_SPEED_FAST_RATE)
Stefan Roese88893c92016-04-21 08:19:39 +0200234 i2c_spd = IC_SPEED_MODE_FAST;
235 else
236 i2c_spd = IC_SPEED_MODE_STANDARD;
Armando Visconti631e6932012-03-29 20:10:17 +0000237
Jun Chenef6677e2020-03-02 16:58:55 +0800238 /* Check is high speed possible and fall back to fast mode if not */
239 if (i2c_spd == IC_SPEED_MODE_HIGH) {
Simon Glass02b880e2020-04-22 10:13:53 -0600240 u32 comp_param1;
241
242 comp_param1 = readl(&regs->comp_param1);
Jun Chenef6677e2020-03-02 16:58:55 +0800243 if ((comp_param1 & DW_IC_COMP_PARAM_1_SPEED_MODE_MASK)
244 != DW_IC_COMP_PARAM_1_SPEED_MODE_HIGH)
245 i2c_spd = IC_SPEED_MODE_FAST;
246 }
247
Simon Glassc38e2b32020-01-23 11:48:15 -0700248 /* Get the proper spike-suppression count based on target speed */
249 if (!priv || !priv->has_spk_cnt)
250 spk_cnt = 0;
251 else if (i2c_spd >= IC_SPEED_MODE_HIGH)
Simon Glassc5294192020-01-23 11:48:25 -0700252 spk_cnt = readl(&regs->hs_spklen);
Simon Glassc38e2b32020-01-23 11:48:15 -0700253 else
Simon Glassc5294192020-01-23 11:48:25 -0700254 spk_cnt = readl(&regs->fs_spklen);
Simon Glass245ec0b2020-01-23 11:48:13 -0700255 if (scl_sda_cfg) {
Simon Glassc5294192020-01-23 11:48:25 -0700256 config->sda_hold = scl_sda_cfg->sda_hold;
Simon Glass245ec0b2020-01-23 11:48:13 -0700257 if (i2c_spd == IC_SPEED_MODE_STANDARD) {
Simon Glassc5294192020-01-23 11:48:25 -0700258 config->scl_hcnt = scl_sda_cfg->ss_hcnt;
259 config->scl_lcnt = scl_sda_cfg->ss_lcnt;
Jun Chenc191f542020-03-02 16:58:57 +0800260 } else if (i2c_spd == IC_SPEED_MODE_HIGH) {
261 config->scl_hcnt = scl_sda_cfg->hs_hcnt;
262 config->scl_lcnt = scl_sda_cfg->hs_lcnt;
Simon Glass245ec0b2020-01-23 11:48:13 -0700263 } else {
Simon Glassc5294192020-01-23 11:48:25 -0700264 config->scl_hcnt = scl_sda_cfg->fs_hcnt;
265 config->scl_lcnt = scl_sda_cfg->fs_lcnt;
Simon Glass245ec0b2020-01-23 11:48:13 -0700266 }
Simon Glassc7181102020-01-23 11:48:14 -0700267 } else {
Simon Glassc38e2b32020-01-23 11:48:15 -0700268 ret = dw_i2c_calc_timing(priv, i2c_spd, bus_clk, spk_cnt,
Simon Glassc5294192020-01-23 11:48:25 -0700269 config);
Simon Glassc7181102020-01-23 11:48:14 -0700270 if (ret)
271 return log_msg_ret("gen_confg", ret);
Simon Glass245ec0b2020-01-23 11:48:13 -0700272 }
Simon Glassc5294192020-01-23 11:48:25 -0700273 config->speed_mode = i2c_spd;
274
275 return 0;
276}
277
Simon Glass02b880e2020-04-22 10:13:53 -0600278/**
279 * _dw_i2c_set_bus_speed() - Set the i2c speed
Simon Glassc5294192020-01-23 11:48:25 -0700280 *
Simon Glass02b880e2020-04-22 10:13:53 -0600281 * @priv: Private information for the driver (NULL if not using driver model)
282 * @i2c_base: Registers for the I2C controller
283 * @speed: Required i2c speed in Hz
284 * @bus_clk: Input clock to the I2C controller in Hz (e.g. IC_CLK)
285 * @return 0 if OK, -ve on error
Simon Glassc5294192020-01-23 11:48:25 -0700286 */
287static int _dw_i2c_set_bus_speed(struct dw_i2c *priv, struct i2c_regs *i2c_base,
288 unsigned int speed, unsigned int bus_clk)
289{
290 struct dw_i2c_speed_config config;
291 unsigned int cntl;
292 unsigned int ena;
293 int ret;
294
Simon Glass02b880e2020-04-22 10:13:53 -0600295 ret = calc_bus_speed(priv, i2c_base, speed, bus_clk, &config);
Simon Glassc5294192020-01-23 11:48:25 -0700296 if (ret)
297 return ret;
298
299 /* Get enable setting for restore later */
300 ena = readl(&i2c_base->ic_enable) & IC_ENABLE_0B;
301
302 /* to set speed cltr must be disabled */
303 dw_i2c_enable(i2c_base, false);
304
305 cntl = (readl(&i2c_base->ic_con) & (~IC_CON_SPD_MSK));
Simon Glass245ec0b2020-01-23 11:48:13 -0700306
Simon Glassc5294192020-01-23 11:48:25 -0700307 switch (config.speed_mode) {
Simon Glassf5ef1012020-01-23 11:48:07 -0700308 case IC_SPEED_MODE_HIGH:
Jun Chen635cf512020-03-02 16:58:54 +0800309 cntl |= IC_CON_SPD_HS;
Simon Glass245ec0b2020-01-23 11:48:13 -0700310 writel(config.scl_hcnt, &i2c_base->ic_hs_scl_hcnt);
311 writel(config.scl_lcnt, &i2c_base->ic_hs_scl_lcnt);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530312 break;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530313 case IC_SPEED_MODE_STANDARD:
314 cntl |= IC_CON_SPD_SS;
Simon Glass245ec0b2020-01-23 11:48:13 -0700315 writel(config.scl_hcnt, &i2c_base->ic_ss_scl_hcnt);
316 writel(config.scl_lcnt, &i2c_base->ic_ss_scl_lcnt);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530317 break;
Simon Glass45649222020-01-23 11:48:23 -0700318 case IC_SPEED_MODE_FAST_PLUS:
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530319 case IC_SPEED_MODE_FAST:
320 default:
321 cntl |= IC_CON_SPD_FS;
Simon Glass245ec0b2020-01-23 11:48:13 -0700322 writel(config.scl_hcnt, &i2c_base->ic_fs_scl_hcnt);
323 writel(config.scl_lcnt, &i2c_base->ic_fs_scl_lcnt);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530324 break;
325 }
326
Stefan Roeseef6073e2014-10-28 12:12:00 +0100327 writel(cntl, &i2c_base->ic_con);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530328
Stefan Roese38481202016-04-21 08:19:42 +0200329 /* Configure SDA Hold Time if required */
Simon Glass245ec0b2020-01-23 11:48:13 -0700330 if (config.sda_hold)
331 writel(config.sda_hold, &i2c_base->ic_sda_hold);
Stefan Roese38481202016-04-21 08:19:42 +0200332
Jun Chend003a372019-06-05 15:23:16 +0800333 /* Restore back i2c now speed set */
334 if (ena == IC_ENABLE_0B)
335 dw_i2c_enable(i2c_base, true);
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100336
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530337 return 0;
338}
339
340/*
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530341 * i2c_setaddress - Sets the target slave address
342 * @i2c_addr: target i2c address
343 *
344 * Sets the target slave address.
345 */
Stefan Roese41de7662016-04-21 08:19:40 +0200346static void i2c_setaddress(struct i2c_regs *i2c_base, unsigned int i2c_addr)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530347{
Alexey Brodkin41c56552013-11-07 17:52:18 +0400348 /* Disable i2c */
Stefan Roese3bc33ba2016-04-21 08:19:38 +0200349 dw_i2c_enable(i2c_base, false);
Alexey Brodkin41c56552013-11-07 17:52:18 +0400350
Stefan Roeseef6073e2014-10-28 12:12:00 +0100351 writel(i2c_addr, &i2c_base->ic_tar);
Alexey Brodkin41c56552013-11-07 17:52:18 +0400352
353 /* Enable i2c */
Stefan Roese3bc33ba2016-04-21 08:19:38 +0200354 dw_i2c_enable(i2c_base, true);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530355}
356
357/*
358 * i2c_flush_rxfifo - Flushes the i2c RX FIFO
359 *
360 * Flushes the i2c RX FIFO
361 */
Stefan Roese41de7662016-04-21 08:19:40 +0200362static void i2c_flush_rxfifo(struct i2c_regs *i2c_base)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530363{
Stefan Roeseef6073e2014-10-28 12:12:00 +0100364 while (readl(&i2c_base->ic_status) & IC_STATUS_RFNE)
365 readl(&i2c_base->ic_cmd_data);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530366}
367
368/*
369 * i2c_wait_for_bb - Waits for bus busy
370 *
371 * Waits for bus busy
372 */
Stefan Roese41de7662016-04-21 08:19:40 +0200373static int i2c_wait_for_bb(struct i2c_regs *i2c_base)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530374{
375 unsigned long start_time_bb = get_timer(0);
376
Stefan Roeseef6073e2014-10-28 12:12:00 +0100377 while ((readl(&i2c_base->ic_status) & IC_STATUS_MA) ||
378 !(readl(&i2c_base->ic_status) & IC_STATUS_TFE)) {
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530379
380 /* Evaluate timeout */
381 if (get_timer(start_time_bb) > (unsigned long)(I2C_BYTE_TO_BB))
382 return 1;
383 }
384
385 return 0;
386}
387
Stefan Roese41de7662016-04-21 08:19:40 +0200388static int i2c_xfer_init(struct i2c_regs *i2c_base, uchar chip, uint addr,
Stefan Roeseef6073e2014-10-28 12:12:00 +0100389 int alen)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530390{
Stefan Roese41de7662016-04-21 08:19:40 +0200391 if (i2c_wait_for_bb(i2c_base))
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530392 return 1;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530393
Stefan Roese41de7662016-04-21 08:19:40 +0200394 i2c_setaddress(i2c_base, chip);
Chin Liang Seea0c26262014-02-04 11:56:23 -0600395 while (alen) {
396 alen--;
397 /* high byte address going out first */
398 writel((addr >> (alen * 8)) & 0xff,
Stefan Roeseef6073e2014-10-28 12:12:00 +0100399 &i2c_base->ic_cmd_data);
Chin Liang Seea0c26262014-02-04 11:56:23 -0600400 }
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530401 return 0;
402}
403
Stefan Roese41de7662016-04-21 08:19:40 +0200404static int i2c_xfer_finish(struct i2c_regs *i2c_base)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530405{
406 ulong start_stop_det = get_timer(0);
407
408 while (1) {
Stefan Roeseef6073e2014-10-28 12:12:00 +0100409 if ((readl(&i2c_base->ic_raw_intr_stat) & IC_STOP_DET)) {
410 readl(&i2c_base->ic_clr_stop_det);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530411 break;
412 } else if (get_timer(start_stop_det) > I2C_STOPDET_TO) {
413 break;
414 }
415 }
416
Stefan Roese41de7662016-04-21 08:19:40 +0200417 if (i2c_wait_for_bb(i2c_base)) {
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530418 printf("Timed out waiting for bus\n");
419 return 1;
420 }
421
Stefan Roese41de7662016-04-21 08:19:40 +0200422 i2c_flush_rxfifo(i2c_base);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530423
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530424 return 0;
425}
426
427/*
428 * i2c_read - Read from i2c memory
429 * @chip: target i2c address
430 * @addr: address to read from
431 * @alen:
432 * @buffer: buffer for read data
433 * @len: no of bytes to be read
434 *
435 * Read from i2c memory.
436 */
Stefan Roese41de7662016-04-21 08:19:40 +0200437static int __dw_i2c_read(struct i2c_regs *i2c_base, u8 dev, uint addr,
438 int alen, u8 *buffer, int len)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530439{
440 unsigned long start_time_rx;
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200441 unsigned int active = 0;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530442
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400443#ifdef CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW
444 /*
445 * EEPROM chips that implement "address overflow" are ones
446 * like Catalyst 24WC04/08/16 which has 9/10/11 bits of
447 * address and the extra bits end up in the "chip address"
448 * bit slots. This makes a 24WC08 (1Kbyte) chip look like
449 * four 256 byte chips.
450 *
451 * Note that we consider the length of the address field to
452 * still be one byte because the extra address bits are
453 * hidden in the chip address.
454 */
Stefan Roeseef6073e2014-10-28 12:12:00 +0100455 dev |= ((addr >> (alen * 8)) & CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400456 addr &= ~(CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW << (alen * 8));
457
Stefan Roeseef6073e2014-10-28 12:12:00 +0100458 debug("%s: fix addr_overflow: dev %02x addr %02x\n", __func__, dev,
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400459 addr);
460#endif
461
Stefan Roese41de7662016-04-21 08:19:40 +0200462 if (i2c_xfer_init(i2c_base, dev, addr, alen))
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530463 return 1;
464
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530465 start_time_rx = get_timer(0);
466 while (len) {
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200467 if (!active) {
468 /*
469 * Avoid writing to ic_cmd_data multiple times
470 * in case this loop spins too quickly and the
471 * ic_status RFNE bit isn't set after the first
472 * write. Subsequent writes to ic_cmd_data can
473 * trigger spurious i2c transfer.
474 */
475 if (len == 1)
476 writel(IC_CMD | IC_STOP, &i2c_base->ic_cmd_data);
477 else
478 writel(IC_CMD, &i2c_base->ic_cmd_data);
479 active = 1;
480 }
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530481
Stefan Roeseef6073e2014-10-28 12:12:00 +0100482 if (readl(&i2c_base->ic_status) & IC_STATUS_RFNE) {
483 *buffer++ = (uchar)readl(&i2c_base->ic_cmd_data);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530484 len--;
485 start_time_rx = get_timer(0);
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200486 active = 0;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530487 } else if (get_timer(start_time_rx) > I2C_BYTE_TO) {
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200488 return 1;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530489 }
490 }
491
Stefan Roese41de7662016-04-21 08:19:40 +0200492 return i2c_xfer_finish(i2c_base);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530493}
494
495/*
496 * i2c_write - Write to i2c memory
497 * @chip: target i2c address
498 * @addr: address to read from
499 * @alen:
500 * @buffer: buffer for read data
501 * @len: no of bytes to be read
502 *
503 * Write to i2c memory.
504 */
Stefan Roese41de7662016-04-21 08:19:40 +0200505static int __dw_i2c_write(struct i2c_regs *i2c_base, u8 dev, uint addr,
506 int alen, u8 *buffer, int len)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530507{
508 int nb = len;
509 unsigned long start_time_tx;
510
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400511#ifdef CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW
512 /*
513 * EEPROM chips that implement "address overflow" are ones
514 * like Catalyst 24WC04/08/16 which has 9/10/11 bits of
515 * address and the extra bits end up in the "chip address"
516 * bit slots. This makes a 24WC08 (1Kbyte) chip look like
517 * four 256 byte chips.
518 *
519 * Note that we consider the length of the address field to
520 * still be one byte because the extra address bits are
521 * hidden in the chip address.
522 */
Stefan Roeseef6073e2014-10-28 12:12:00 +0100523 dev |= ((addr >> (alen * 8)) & CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400524 addr &= ~(CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW << (alen * 8));
525
Stefan Roeseef6073e2014-10-28 12:12:00 +0100526 debug("%s: fix addr_overflow: dev %02x addr %02x\n", __func__, dev,
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400527 addr);
528#endif
529
Stefan Roese41de7662016-04-21 08:19:40 +0200530 if (i2c_xfer_init(i2c_base, dev, addr, alen))
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530531 return 1;
532
533 start_time_tx = get_timer(0);
534 while (len) {
Stefan Roeseef6073e2014-10-28 12:12:00 +0100535 if (readl(&i2c_base->ic_status) & IC_STATUS_TFNF) {
536 if (--len == 0) {
537 writel(*buffer | IC_STOP,
538 &i2c_base->ic_cmd_data);
539 } else {
540 writel(*buffer, &i2c_base->ic_cmd_data);
541 }
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530542 buffer++;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530543 start_time_tx = get_timer(0);
544
545 } else if (get_timer(start_time_tx) > (nb * I2C_BYTE_TO)) {
546 printf("Timed out. i2c write Failed\n");
547 return 1;
548 }
549 }
550
Stefan Roese41de7662016-04-21 08:19:40 +0200551 return i2c_xfer_finish(i2c_base);
552}
553
Stefan Roese3cb27962016-04-21 08:19:41 +0200554/*
555 * __dw_i2c_init - Init function
556 * @speed: required i2c speed
557 * @slaveaddr: slave address for the device
558 *
559 * Initialization function.
560 */
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700561static int __dw_i2c_init(struct i2c_regs *i2c_base, int speed, int slaveaddr)
Stefan Roese3cb27962016-04-21 08:19:41 +0200562{
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700563 int ret;
564
Stefan Roese3cb27962016-04-21 08:19:41 +0200565 /* Disable i2c */
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700566 ret = dw_i2c_enable(i2c_base, false);
567 if (ret)
568 return ret;
Stefan Roese3cb27962016-04-21 08:19:41 +0200569
Marek Vasut808aa132017-08-07 20:45:31 +0200570 writel(IC_CON_SD | IC_CON_RE | IC_CON_SPD_FS | IC_CON_MM,
571 &i2c_base->ic_con);
Stefan Roese3cb27962016-04-21 08:19:41 +0200572 writel(IC_RX_TL, &i2c_base->ic_rx_tl);
573 writel(IC_TX_TL, &i2c_base->ic_tx_tl);
574 writel(IC_STOP_DET, &i2c_base->ic_intr_mask);
575#ifndef CONFIG_DM_I2C
Simon Glassc5294192020-01-23 11:48:25 -0700576 _dw_i2c_set_bus_speed(NULL, i2c_base, speed, IC_CLK);
Stefan Roese3cb27962016-04-21 08:19:41 +0200577 writel(slaveaddr, &i2c_base->ic_sar);
578#endif
579
580 /* Enable i2c */
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700581 ret = dw_i2c_enable(i2c_base, true);
582 if (ret)
583 return ret;
584
585 return 0;
Stefan Roese3cb27962016-04-21 08:19:41 +0200586}
587
588#ifndef CONFIG_DM_I2C
589/*
590 * The legacy I2C functions. These need to get removed once
591 * all users of this driver are converted to DM.
592 */
Stefan Roese41de7662016-04-21 08:19:40 +0200593static struct i2c_regs *i2c_get_base(struct i2c_adapter *adap)
594{
595 switch (adap->hwadapnr) {
596#if CONFIG_SYS_I2C_BUS_MAX >= 4
597 case 3:
598 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE3;
599#endif
600#if CONFIG_SYS_I2C_BUS_MAX >= 3
601 case 2:
602 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE2;
603#endif
604#if CONFIG_SYS_I2C_BUS_MAX >= 2
605 case 1:
606 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE1;
607#endif
608 case 0:
609 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE;
610 default:
611 printf("Wrong I2C-adapter number %d\n", adap->hwadapnr);
612 }
613
614 return NULL;
615}
616
617static unsigned int dw_i2c_set_bus_speed(struct i2c_adapter *adap,
618 unsigned int speed)
619{
620 adap->speed = speed;
Simon Glassc5294192020-01-23 11:48:25 -0700621 return _dw_i2c_set_bus_speed(NULL, i2c_get_base(adap), speed, IC_CLK);
Stefan Roese41de7662016-04-21 08:19:40 +0200622}
623
Stefan Roese3cb27962016-04-21 08:19:41 +0200624static void dw_i2c_init(struct i2c_adapter *adap, int speed, int slaveaddr)
Stefan Roese41de7662016-04-21 08:19:40 +0200625{
Stefan Roese3cb27962016-04-21 08:19:41 +0200626 __dw_i2c_init(i2c_get_base(adap), speed, slaveaddr);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530627}
628
Stefan Roese41de7662016-04-21 08:19:40 +0200629static int dw_i2c_read(struct i2c_adapter *adap, u8 dev, uint addr,
630 int alen, u8 *buffer, int len)
631{
632 return __dw_i2c_read(i2c_get_base(adap), dev, addr, alen, buffer, len);
633}
634
635static int dw_i2c_write(struct i2c_adapter *adap, u8 dev, uint addr,
636 int alen, u8 *buffer, int len)
637{
638 return __dw_i2c_write(i2c_get_base(adap), dev, addr, alen, buffer, len);
639}
640
Stefan Roese3cb27962016-04-21 08:19:41 +0200641/* dw_i2c_probe - Probe the i2c chip */
Stefan Roeseef6073e2014-10-28 12:12:00 +0100642static int dw_i2c_probe(struct i2c_adapter *adap, u8 dev)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530643{
Stefan Roese41de7662016-04-21 08:19:40 +0200644 struct i2c_regs *i2c_base = i2c_get_base(adap);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530645 u32 tmp;
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100646 int ret;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530647
648 /*
649 * Try to read the first location of the chip.
650 */
Stefan Roese41de7662016-04-21 08:19:40 +0200651 ret = __dw_i2c_read(i2c_base, dev, 0, 1, (uchar *)&tmp, 1);
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100652 if (ret)
Stefan Roeseef6073e2014-10-28 12:12:00 +0100653 dw_i2c_init(adap, adap->speed, adap->slaveaddr);
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100654
655 return ret;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530656}
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000657
Stefan Roeseef6073e2014-10-28 12:12:00 +0100658U_BOOT_I2C_ADAP_COMPLETE(dw_0, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
659 dw_i2c_write, dw_i2c_set_bus_speed,
660 CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 0)
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000661
Stefan Roeseef6073e2014-10-28 12:12:00 +0100662#if CONFIG_SYS_I2C_BUS_MAX >= 2
663U_BOOT_I2C_ADAP_COMPLETE(dw_1, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
664 dw_i2c_write, dw_i2c_set_bus_speed,
665 CONFIG_SYS_I2C_SPEED1, CONFIG_SYS_I2C_SLAVE1, 1)
666#endif
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000667
Stefan Roeseef6073e2014-10-28 12:12:00 +0100668#if CONFIG_SYS_I2C_BUS_MAX >= 3
669U_BOOT_I2C_ADAP_COMPLETE(dw_2, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
670 dw_i2c_write, dw_i2c_set_bus_speed,
671 CONFIG_SYS_I2C_SPEED2, CONFIG_SYS_I2C_SLAVE2, 2)
672#endif
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000673
Stefan Roeseef6073e2014-10-28 12:12:00 +0100674#if CONFIG_SYS_I2C_BUS_MAX >= 4
675U_BOOT_I2C_ADAP_COMPLETE(dw_3, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
676 dw_i2c_write, dw_i2c_set_bus_speed,
677 CONFIG_SYS_I2C_SPEED3, CONFIG_SYS_I2C_SLAVE3, 3)
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000678#endif
Stefan Roese3cb27962016-04-21 08:19:41 +0200679
680#else /* CONFIG_DM_I2C */
681/* The DM I2C functions */
682
683static int designware_i2c_xfer(struct udevice *bus, struct i2c_msg *msg,
684 int nmsgs)
685{
686 struct dw_i2c *i2c = dev_get_priv(bus);
687 int ret;
688
689 debug("i2c_xfer: %d messages\n", nmsgs);
690 for (; nmsgs > 0; nmsgs--, msg++) {
691 debug("i2c_xfer: chip=0x%x, len=0x%x\n", msg->addr, msg->len);
692 if (msg->flags & I2C_M_RD) {
693 ret = __dw_i2c_read(i2c->regs, msg->addr, 0, 0,
694 msg->buf, msg->len);
695 } else {
696 ret = __dw_i2c_write(i2c->regs, msg->addr, 0, 0,
697 msg->buf, msg->len);
698 }
699 if (ret) {
700 debug("i2c_write: error sending\n");
701 return -EREMOTEIO;
702 }
703 }
704
705 return 0;
706}
707
708static int designware_i2c_set_bus_speed(struct udevice *bus, unsigned int speed)
709{
710 struct dw_i2c *i2c = dev_get_priv(bus);
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800711 ulong rate;
712
713#if CONFIG_IS_ENABLED(CLK)
714 rate = clk_get_rate(&i2c->clk);
715 if (IS_ERR_VALUE(rate))
Simon Glass46aadb62020-07-07 21:32:27 -0600716 return log_ret(-EINVAL);
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800717#else
718 rate = IC_CLK;
719#endif
Simon Glassc5294192020-01-23 11:48:25 -0700720 return _dw_i2c_set_bus_speed(i2c, i2c->regs, speed, rate);
Stefan Roese3cb27962016-04-21 08:19:41 +0200721}
722
723static int designware_i2c_probe_chip(struct udevice *bus, uint chip_addr,
724 uint chip_flags)
725{
726 struct dw_i2c *i2c = dev_get_priv(bus);
727 struct i2c_regs *i2c_base = i2c->regs;
728 u32 tmp;
729 int ret;
730
731 /* Try to read the first location of the chip */
732 ret = __dw_i2c_read(i2c_base, chip_addr, 0, 1, (uchar *)&tmp, 1);
733 if (ret)
734 __dw_i2c_init(i2c_base, 0, 0);
735
736 return ret;
737}
738
Simon Glass9e5d1742020-01-23 11:48:11 -0700739int designware_i2c_ofdata_to_platdata(struct udevice *bus)
Stefan Roese3cb27962016-04-21 08:19:41 +0200740{
741 struct dw_i2c *priv = dev_get_priv(bus);
Simon Glass8de5ae82020-01-23 11:48:26 -0700742 int ret;
Stefan Roese3cb27962016-04-21 08:19:41 +0200743
Simon Glass9e5d1742020-01-23 11:48:11 -0700744 if (!priv->regs)
745 priv->regs = (struct i2c_regs *)devfdt_get_addr_ptr(bus);
746 dev_read_u32(bus, "i2c-scl-rising-time-ns", &priv->scl_rise_time_ns);
747 dev_read_u32(bus, "i2c-scl-falling-time-ns", &priv->scl_fall_time_ns);
748 dev_read_u32(bus, "i2c-sda-hold-time-ns", &priv->sda_hold_time_ns);
Simon Glasse2be5532019-12-06 21:41:40 -0700749
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100750 ret = reset_get_bulk(bus, &priv->resets);
Dinh Nguyen08794aa2018-04-04 17:18:24 -0500751 if (ret)
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100752 dev_warn(bus, "Can't get reset: %d\n", ret);
753 else
754 reset_deassert_bulk(&priv->resets);
Dinh Nguyen08794aa2018-04-04 17:18:24 -0500755
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800756#if CONFIG_IS_ENABLED(CLK)
757 ret = clk_get_by_index(bus, 0, &priv->clk);
758 if (ret)
759 return ret;
760
761 ret = clk_enable(&priv->clk);
762 if (ret && ret != -ENOSYS && ret != -ENOTSUPP) {
763 clk_free(&priv->clk);
764 dev_err(bus, "failed to enable clock\n");
765 return ret;
766 }
767#endif
768
Simon Glass8de5ae82020-01-23 11:48:26 -0700769 return 0;
770}
771
772int designware_i2c_probe(struct udevice *bus)
773{
774 struct dw_i2c *priv = dev_get_priv(bus);
Raul E Rangel057be512020-04-22 10:13:54 -0600775 uint comp_type;
776
777 comp_type = readl(&priv->regs->comp_type);
778 if (comp_type != DW_I2C_COMP_TYPE) {
779 log_err("I2C bus %s has unknown type %#x\n", bus->name,
780 comp_type);
781 return -ENXIO;
782 }
783
784 log_info("I2C bus %s version %#x\n", bus->name,
785 readl(&priv->regs->comp_version));
Simon Glass8de5ae82020-01-23 11:48:26 -0700786
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700787 return __dw_i2c_init(priv->regs, 0, 0);
Stefan Roese3cb27962016-04-21 08:19:41 +0200788}
789
Simon Glasse2be5532019-12-06 21:41:40 -0700790int designware_i2c_remove(struct udevice *dev)
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100791{
792 struct dw_i2c *priv = dev_get_priv(dev);
793
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800794#if CONFIG_IS_ENABLED(CLK)
795 clk_disable(&priv->clk);
796 clk_free(&priv->clk);
797#endif
798
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100799 return reset_release_bulk(&priv->resets);
800}
801
Simon Glasse2be5532019-12-06 21:41:40 -0700802const struct dm_i2c_ops designware_i2c_ops = {
Stefan Roese3cb27962016-04-21 08:19:41 +0200803 .xfer = designware_i2c_xfer,
804 .probe_chip = designware_i2c_probe_chip,
805 .set_bus_speed = designware_i2c_set_bus_speed,
806};
807
808static const struct udevice_id designware_i2c_ids[] = {
809 { .compatible = "snps,designware-i2c" },
810 { }
811};
812
813U_BOOT_DRIVER(i2c_designware) = {
814 .name = "i2c_designware",
815 .id = UCLASS_I2C,
816 .of_match = designware_i2c_ids,
Simon Glasse2be5532019-12-06 21:41:40 -0700817 .ofdata_to_platdata = designware_i2c_ofdata_to_platdata,
Stefan Roese3cb27962016-04-21 08:19:41 +0200818 .probe = designware_i2c_probe,
819 .priv_auto_alloc_size = sizeof(struct dw_i2c),
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100820 .remove = designware_i2c_remove,
Simon Glasse2be5532019-12-06 21:41:40 -0700821 .flags = DM_FLAG_OS_PREPARE,
Stefan Roese3cb27962016-04-21 08:19:41 +0200822 .ops = &designware_i2c_ops,
823};
824
825#endif /* CONFIG_DM_I2C */