blob: 0b5e70af591cbf031a7eb83a5d416f696f5cfb9d [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 Glass9bc15642020-02-03 07:36:16 -070011#include <malloc.h>
Stefan Roese38481202016-04-21 08:19:42 +020012#include <pci.h>
Dinh Nguyen08794aa2018-04-04 17:18:24 -050013#include <reset.h>
Vipin KUMARfc9589f2010-01-15 19:15:44 +053014#include <asm/io.h>
Vipin KUMAR3f64acb2012-02-26 23:13:29 +000015#include "designware_i2c.h"
Simon Glass9bc15642020-02-03 07:36:16 -070016#include <dm/device_compat.h>
Simon Glassd66c5f72020-02-03 07:36:15 -070017#include <linux/err.h>
Vipin KUMARfc9589f2010-01-15 19:15:44 +053018
Stefan Roeseabb3e132016-04-27 09:02:12 +020019#ifdef CONFIG_SYS_I2C_DW_ENABLE_STATUS_UNSUPPORTED
Simon Glassbd9ca8d2019-02-16 20:24:39 -070020static int dw_i2c_enable(struct i2c_regs *i2c_base, bool enable)
Stefan Roese3bc33ba2016-04-21 08:19:38 +020021{
22 u32 ena = enable ? IC_ENABLE_0B : 0;
Stefan Roeseabb3e132016-04-27 09:02:12 +020023
24 writel(ena, &i2c_base->ic_enable);
Simon Glassbd9ca8d2019-02-16 20:24:39 -070025
26 return 0;
Stefan Roeseabb3e132016-04-27 09:02:12 +020027}
28#else
Simon Glassbd9ca8d2019-02-16 20:24:39 -070029static int dw_i2c_enable(struct i2c_regs *i2c_base, bool enable)
Stefan Roeseabb3e132016-04-27 09:02:12 +020030{
31 u32 ena = enable ? IC_ENABLE_0B : 0;
Stefan Roese3bc33ba2016-04-21 08:19:38 +020032 int timeout = 100;
33
34 do {
35 writel(ena, &i2c_base->ic_enable);
36 if ((readl(&i2c_base->ic_enable_status) & IC_ENABLE_0B) == ena)
Simon Glassbd9ca8d2019-02-16 20:24:39 -070037 return 0;
Stefan Roese3bc33ba2016-04-21 08:19:38 +020038
39 /*
40 * Wait 10 times the signaling period of the highest I2C
41 * transfer supported by the driver (for 400KHz this is
42 * 25us) as described in the DesignWare I2C databook.
43 */
44 udelay(25);
45 } while (timeout--);
Stefan Roese3bc33ba2016-04-21 08:19:38 +020046 printf("timeout in %sabling I2C adapter\n", enable ? "en" : "dis");
Simon Glassbd9ca8d2019-02-16 20:24:39 -070047
48 return -ETIMEDOUT;
Stefan Roese3bc33ba2016-04-21 08:19:38 +020049}
Stefan Roeseabb3e132016-04-27 09:02:12 +020050#endif
Stefan Roese3bc33ba2016-04-21 08:19:38 +020051
Simon Glassc7181102020-01-23 11:48:14 -070052/* High and low times in different speed modes (in ns) */
53enum {
54 /* SDA Hold Time */
55 DEFAULT_SDA_HOLD_TIME = 300,
56};
57
58/**
59 * calc_counts() - Convert a period to a number of IC clk cycles
60 *
61 * @ic_clk: Input clock in Hz
62 * @period_ns: Period to represent, in ns
63 * @return calculated count
64 */
65static uint calc_counts(uint ic_clk, uint period_ns)
66{
67 return DIV_ROUND_UP(ic_clk / 1000 * period_ns, NANO_TO_KILO);
68}
69
70/**
71 * struct i2c_mode_info - Information about an I2C speed mode
72 *
73 * Each speed mode has its own characteristics. This struct holds these to aid
74 * calculations in dw_i2c_calc_timing().
75 *
76 * @speed: Speed in Hz
77 * @min_scl_lowtime_ns: Minimum value for SCL low period in ns
78 * @min_scl_hightime_ns: Minimum value for SCL high period in ns
79 * @def_rise_time_ns: Default rise time in ns
80 * @def_fall_time_ns: Default fall time in ns
81 */
82struct i2c_mode_info {
83 int speed;
84 int min_scl_hightime_ns;
85 int min_scl_lowtime_ns;
86 int def_rise_time_ns;
87 int def_fall_time_ns;
88};
89
90static const struct i2c_mode_info info_for_mode[] = {
91 [IC_SPEED_MODE_STANDARD] = {
Simon Glassac77bae2020-01-23 11:48:18 -070092 I2C_SPEED_STANDARD_RATE,
Simon Glassc7181102020-01-23 11:48:14 -070093 MIN_SS_SCL_HIGHTIME,
94 MIN_SS_SCL_LOWTIME,
95 1000,
96 300,
97 },
98 [IC_SPEED_MODE_FAST] = {
Simon Glassac77bae2020-01-23 11:48:18 -070099 I2C_SPEED_FAST_RATE,
Simon Glassc7181102020-01-23 11:48:14 -0700100 MIN_FS_SCL_HIGHTIME,
101 MIN_FS_SCL_LOWTIME,
102 300,
103 300,
104 },
Simon Glass45649222020-01-23 11:48:23 -0700105 [IC_SPEED_MODE_FAST_PLUS] = {
106 I2C_SPEED_FAST_PLUS_RATE,
107 MIN_FP_SCL_HIGHTIME,
108 MIN_FP_SCL_LOWTIME,
109 260,
110 500,
111 },
Simon Glassc7181102020-01-23 11:48:14 -0700112 [IC_SPEED_MODE_HIGH] = {
Simon Glassac77bae2020-01-23 11:48:18 -0700113 I2C_SPEED_HIGH_RATE,
Simon Glassc7181102020-01-23 11:48:14 -0700114 MIN_HS_SCL_HIGHTIME,
115 MIN_HS_SCL_LOWTIME,
116 120,
117 120,
118 },
119};
120
121/**
122 * dw_i2c_calc_timing() - Calculate the timings to use for a bus
123 *
124 * @priv: Bus private information (NULL if not using driver model)
125 * @mode: Speed mode to use
126 * @ic_clk: IC clock speed in Hz
127 * @spk_cnt: Spike-suppression count
128 * @config: Returns value to use
129 * @return 0 if OK, -EINVAL if the calculation failed due to invalid data
130 */
131static int dw_i2c_calc_timing(struct dw_i2c *priv, enum i2c_speed_mode mode,
132 int ic_clk, int spk_cnt,
133 struct dw_i2c_speed_config *config)
134{
135 int fall_cnt, rise_cnt, min_tlow_cnt, min_thigh_cnt;
136 int hcnt, lcnt, period_cnt, diff, tot;
137 int sda_hold_time_ns, scl_rise_time_ns, scl_fall_time_ns;
138 const struct i2c_mode_info *info;
139
140 /*
141 * Find the period, rise, fall, min tlow, and min thigh in terms of
142 * counts of the IC clock
143 */
144 info = &info_for_mode[mode];
145 period_cnt = ic_clk / info->speed;
146 scl_rise_time_ns = priv && priv->scl_rise_time_ns ?
147 priv->scl_rise_time_ns : info->def_rise_time_ns;
148 scl_fall_time_ns = priv && priv->scl_fall_time_ns ?
149 priv->scl_fall_time_ns : info->def_fall_time_ns;
150 rise_cnt = calc_counts(ic_clk, scl_rise_time_ns);
151 fall_cnt = calc_counts(ic_clk, scl_fall_time_ns);
152 min_tlow_cnt = calc_counts(ic_clk, info->min_scl_lowtime_ns);
153 min_thigh_cnt = calc_counts(ic_clk, info->min_scl_hightime_ns);
154
155 debug("dw_i2c: period %d rise %d fall %d tlow %d thigh %d spk %d\n",
156 period_cnt, rise_cnt, fall_cnt, min_tlow_cnt, min_thigh_cnt,
157 spk_cnt);
158
159 /*
160 * Back-solve for hcnt and lcnt according to the following equations:
161 * SCL_High_time = [(HCNT + IC_*_SPKLEN + 7) * ic_clk] + SCL_Fall_time
162 * SCL_Low_time = [(LCNT + 1) * ic_clk] - SCL_Fall_time + SCL_Rise_time
163 */
164 hcnt = min_thigh_cnt - fall_cnt - 7 - spk_cnt;
165 lcnt = min_tlow_cnt - rise_cnt + fall_cnt - 1;
166
167 if (hcnt < 0 || lcnt < 0) {
168 debug("dw_i2c: bad counts. hcnt = %d lcnt = %d\n", hcnt, lcnt);
169 return -EINVAL;
170 }
171
172 /*
173 * Now add things back up to ensure the period is hit. If it is off,
174 * split the difference and bias to lcnt for remainder
175 */
176 tot = hcnt + lcnt + 7 + spk_cnt + rise_cnt + 1;
177
178 if (tot < period_cnt) {
179 diff = (period_cnt - tot) / 2;
180 hcnt += diff;
181 lcnt += diff;
182 tot = hcnt + lcnt + 7 + spk_cnt + rise_cnt + 1;
183 lcnt += period_cnt - tot;
184 }
185
186 config->scl_lcnt = lcnt;
187 config->scl_hcnt = hcnt;
188
189 /* Use internal default unless other value is specified */
190 sda_hold_time_ns = priv && priv->sda_hold_time_ns ?
191 priv->sda_hold_time_ns : DEFAULT_SDA_HOLD_TIME;
192 config->sda_hold = calc_counts(ic_clk, sda_hold_time_ns);
193
194 debug("dw_i2c: hcnt = %d lcnt = %d sda hold = %d\n", hcnt, lcnt,
195 config->sda_hold);
196
197 return 0;
198}
199
Simon Glassc5294192020-01-23 11:48:25 -0700200static int calc_bus_speed(struct dw_i2c *priv, int speed, ulong bus_clk,
201 struct dw_i2c_speed_config *config)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530202{
Simon Glass60e0c3a2020-01-23 11:48:12 -0700203 const struct dw_scl_sda_cfg *scl_sda_cfg = NULL;
Simon Glassc5294192020-01-23 11:48:25 -0700204 struct i2c_regs *regs = priv->regs;
Simon Glass6ed44ae2020-01-23 11:48:08 -0700205 enum i2c_speed_mode i2c_spd;
Simon Glassc38e2b32020-01-23 11:48:15 -0700206 int spk_cnt;
Simon Glassc7181102020-01-23 11:48:14 -0700207 int ret;
Stefan Roese88893c92016-04-21 08:19:39 +0200208
Simon Glass60e0c3a2020-01-23 11:48:12 -0700209 if (priv)
210 scl_sda_cfg = priv->scl_sda_cfg;
Simon Glassf5ef1012020-01-23 11:48:07 -0700211 /* Allow high speed if there is no config, or the config allows it */
Simon Glassac77bae2020-01-23 11:48:18 -0700212 if (speed >= I2C_SPEED_HIGH_RATE &&
Simon Glassf5ef1012020-01-23 11:48:07 -0700213 (!scl_sda_cfg || scl_sda_cfg->has_high_speed))
214 i2c_spd = IC_SPEED_MODE_HIGH;
Simon Glass45649222020-01-23 11:48:23 -0700215 else if (speed >= I2C_SPEED_FAST_PLUS_RATE)
Simon Glass55397682020-02-13 13:24:55 -0700216 i2c_spd = IC_SPEED_MODE_FAST_PLUS;
217 else if (speed >= I2C_SPEED_FAST_RATE)
Stefan Roese88893c92016-04-21 08:19:39 +0200218 i2c_spd = IC_SPEED_MODE_FAST;
219 else
220 i2c_spd = IC_SPEED_MODE_STANDARD;
Armando Visconti631e6932012-03-29 20:10:17 +0000221
Simon Glassc38e2b32020-01-23 11:48:15 -0700222 /* Get the proper spike-suppression count based on target speed */
223 if (!priv || !priv->has_spk_cnt)
224 spk_cnt = 0;
225 else if (i2c_spd >= IC_SPEED_MODE_HIGH)
Simon Glassc5294192020-01-23 11:48:25 -0700226 spk_cnt = readl(&regs->hs_spklen);
Simon Glassc38e2b32020-01-23 11:48:15 -0700227 else
Simon Glassc5294192020-01-23 11:48:25 -0700228 spk_cnt = readl(&regs->fs_spklen);
Simon Glass245ec0b2020-01-23 11:48:13 -0700229 if (scl_sda_cfg) {
Simon Glassc5294192020-01-23 11:48:25 -0700230 config->sda_hold = scl_sda_cfg->sda_hold;
Simon Glass245ec0b2020-01-23 11:48:13 -0700231 if (i2c_spd == IC_SPEED_MODE_STANDARD) {
Simon Glassc5294192020-01-23 11:48:25 -0700232 config->scl_hcnt = scl_sda_cfg->ss_hcnt;
233 config->scl_lcnt = scl_sda_cfg->ss_lcnt;
Simon Glass245ec0b2020-01-23 11:48:13 -0700234 } else {
Simon Glassc5294192020-01-23 11:48:25 -0700235 config->scl_hcnt = scl_sda_cfg->fs_hcnt;
236 config->scl_lcnt = scl_sda_cfg->fs_lcnt;
Simon Glass245ec0b2020-01-23 11:48:13 -0700237 }
Simon Glassc7181102020-01-23 11:48:14 -0700238 } else {
Simon Glassc38e2b32020-01-23 11:48:15 -0700239 ret = dw_i2c_calc_timing(priv, i2c_spd, bus_clk, spk_cnt,
Simon Glassc5294192020-01-23 11:48:25 -0700240 config);
Simon Glassc7181102020-01-23 11:48:14 -0700241 if (ret)
242 return log_msg_ret("gen_confg", ret);
Simon Glass245ec0b2020-01-23 11:48:13 -0700243 }
Simon Glassc5294192020-01-23 11:48:25 -0700244 config->speed_mode = i2c_spd;
245
246 return 0;
247}
248
249/*
250 * _dw_i2c_set_bus_speed - Set the i2c speed
251 * @speed: required i2c speed
252 *
253 * Set the i2c speed.
254 */
255static int _dw_i2c_set_bus_speed(struct dw_i2c *priv, struct i2c_regs *i2c_base,
256 unsigned int speed, unsigned int bus_clk)
257{
258 struct dw_i2c_speed_config config;
259 unsigned int cntl;
260 unsigned int ena;
261 int ret;
262
263 ret = calc_bus_speed(priv, speed, bus_clk, &config);
264 if (ret)
265 return ret;
266
267 /* Get enable setting for restore later */
268 ena = readl(&i2c_base->ic_enable) & IC_ENABLE_0B;
269
270 /* to set speed cltr must be disabled */
271 dw_i2c_enable(i2c_base, false);
272
273 cntl = (readl(&i2c_base->ic_con) & (~IC_CON_SPD_MSK));
Simon Glass245ec0b2020-01-23 11:48:13 -0700274
Simon Glassc5294192020-01-23 11:48:25 -0700275 switch (config.speed_mode) {
Simon Glassf5ef1012020-01-23 11:48:07 -0700276 case IC_SPEED_MODE_HIGH:
Stefan Roese38481202016-04-21 08:19:42 +0200277 cntl |= IC_CON_SPD_SS;
Simon Glass245ec0b2020-01-23 11:48:13 -0700278 writel(config.scl_hcnt, &i2c_base->ic_hs_scl_hcnt);
279 writel(config.scl_lcnt, &i2c_base->ic_hs_scl_lcnt);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530280 break;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530281 case IC_SPEED_MODE_STANDARD:
282 cntl |= IC_CON_SPD_SS;
Simon Glass245ec0b2020-01-23 11:48:13 -0700283 writel(config.scl_hcnt, &i2c_base->ic_ss_scl_hcnt);
284 writel(config.scl_lcnt, &i2c_base->ic_ss_scl_lcnt);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530285 break;
Simon Glass45649222020-01-23 11:48:23 -0700286 case IC_SPEED_MODE_FAST_PLUS:
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530287 case IC_SPEED_MODE_FAST:
288 default:
289 cntl |= IC_CON_SPD_FS;
Simon Glass245ec0b2020-01-23 11:48:13 -0700290 writel(config.scl_hcnt, &i2c_base->ic_fs_scl_hcnt);
291 writel(config.scl_lcnt, &i2c_base->ic_fs_scl_lcnt);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530292 break;
293 }
294
Stefan Roeseef6073e2014-10-28 12:12:00 +0100295 writel(cntl, &i2c_base->ic_con);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530296
Stefan Roese38481202016-04-21 08:19:42 +0200297 /* Configure SDA Hold Time if required */
Simon Glass245ec0b2020-01-23 11:48:13 -0700298 if (config.sda_hold)
299 writel(config.sda_hold, &i2c_base->ic_sda_hold);
Stefan Roese38481202016-04-21 08:19:42 +0200300
Jun Chend003a372019-06-05 15:23:16 +0800301 /* Restore back i2c now speed set */
302 if (ena == IC_ENABLE_0B)
303 dw_i2c_enable(i2c_base, true);
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100304
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530305 return 0;
306}
307
308/*
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530309 * i2c_setaddress - Sets the target slave address
310 * @i2c_addr: target i2c address
311 *
312 * Sets the target slave address.
313 */
Stefan Roese41de7662016-04-21 08:19:40 +0200314static void i2c_setaddress(struct i2c_regs *i2c_base, unsigned int i2c_addr)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530315{
Alexey Brodkin41c56552013-11-07 17:52:18 +0400316 /* Disable i2c */
Stefan Roese3bc33ba2016-04-21 08:19:38 +0200317 dw_i2c_enable(i2c_base, false);
Alexey Brodkin41c56552013-11-07 17:52:18 +0400318
Stefan Roeseef6073e2014-10-28 12:12:00 +0100319 writel(i2c_addr, &i2c_base->ic_tar);
Alexey Brodkin41c56552013-11-07 17:52:18 +0400320
321 /* Enable i2c */
Stefan Roese3bc33ba2016-04-21 08:19:38 +0200322 dw_i2c_enable(i2c_base, true);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530323}
324
325/*
326 * i2c_flush_rxfifo - Flushes the i2c RX FIFO
327 *
328 * Flushes the i2c RX FIFO
329 */
Stefan Roese41de7662016-04-21 08:19:40 +0200330static void i2c_flush_rxfifo(struct i2c_regs *i2c_base)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530331{
Stefan Roeseef6073e2014-10-28 12:12:00 +0100332 while (readl(&i2c_base->ic_status) & IC_STATUS_RFNE)
333 readl(&i2c_base->ic_cmd_data);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530334}
335
336/*
337 * i2c_wait_for_bb - Waits for bus busy
338 *
339 * Waits for bus busy
340 */
Stefan Roese41de7662016-04-21 08:19:40 +0200341static int i2c_wait_for_bb(struct i2c_regs *i2c_base)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530342{
343 unsigned long start_time_bb = get_timer(0);
344
Stefan Roeseef6073e2014-10-28 12:12:00 +0100345 while ((readl(&i2c_base->ic_status) & IC_STATUS_MA) ||
346 !(readl(&i2c_base->ic_status) & IC_STATUS_TFE)) {
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530347
348 /* Evaluate timeout */
349 if (get_timer(start_time_bb) > (unsigned long)(I2C_BYTE_TO_BB))
350 return 1;
351 }
352
353 return 0;
354}
355
Stefan Roese41de7662016-04-21 08:19:40 +0200356static int i2c_xfer_init(struct i2c_regs *i2c_base, uchar chip, uint addr,
Stefan Roeseef6073e2014-10-28 12:12:00 +0100357 int alen)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530358{
Stefan Roese41de7662016-04-21 08:19:40 +0200359 if (i2c_wait_for_bb(i2c_base))
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530360 return 1;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530361
Stefan Roese41de7662016-04-21 08:19:40 +0200362 i2c_setaddress(i2c_base, chip);
Chin Liang Seea0c26262014-02-04 11:56:23 -0600363 while (alen) {
364 alen--;
365 /* high byte address going out first */
366 writel((addr >> (alen * 8)) & 0xff,
Stefan Roeseef6073e2014-10-28 12:12:00 +0100367 &i2c_base->ic_cmd_data);
Chin Liang Seea0c26262014-02-04 11:56:23 -0600368 }
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530369 return 0;
370}
371
Stefan Roese41de7662016-04-21 08:19:40 +0200372static int i2c_xfer_finish(struct i2c_regs *i2c_base)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530373{
374 ulong start_stop_det = get_timer(0);
375
376 while (1) {
Stefan Roeseef6073e2014-10-28 12:12:00 +0100377 if ((readl(&i2c_base->ic_raw_intr_stat) & IC_STOP_DET)) {
378 readl(&i2c_base->ic_clr_stop_det);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530379 break;
380 } else if (get_timer(start_stop_det) > I2C_STOPDET_TO) {
381 break;
382 }
383 }
384
Stefan Roese41de7662016-04-21 08:19:40 +0200385 if (i2c_wait_for_bb(i2c_base)) {
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530386 printf("Timed out waiting for bus\n");
387 return 1;
388 }
389
Stefan Roese41de7662016-04-21 08:19:40 +0200390 i2c_flush_rxfifo(i2c_base);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530391
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530392 return 0;
393}
394
395/*
396 * i2c_read - Read from i2c memory
397 * @chip: target i2c address
398 * @addr: address to read from
399 * @alen:
400 * @buffer: buffer for read data
401 * @len: no of bytes to be read
402 *
403 * Read from i2c memory.
404 */
Stefan Roese41de7662016-04-21 08:19:40 +0200405static int __dw_i2c_read(struct i2c_regs *i2c_base, u8 dev, uint addr,
406 int alen, u8 *buffer, int len)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530407{
408 unsigned long start_time_rx;
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200409 unsigned int active = 0;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530410
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400411#ifdef CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW
412 /*
413 * EEPROM chips that implement "address overflow" are ones
414 * like Catalyst 24WC04/08/16 which has 9/10/11 bits of
415 * address and the extra bits end up in the "chip address"
416 * bit slots. This makes a 24WC08 (1Kbyte) chip look like
417 * four 256 byte chips.
418 *
419 * Note that we consider the length of the address field to
420 * still be one byte because the extra address bits are
421 * hidden in the chip address.
422 */
Stefan Roeseef6073e2014-10-28 12:12:00 +0100423 dev |= ((addr >> (alen * 8)) & CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400424 addr &= ~(CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW << (alen * 8));
425
Stefan Roeseef6073e2014-10-28 12:12:00 +0100426 debug("%s: fix addr_overflow: dev %02x addr %02x\n", __func__, dev,
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400427 addr);
428#endif
429
Stefan Roese41de7662016-04-21 08:19:40 +0200430 if (i2c_xfer_init(i2c_base, dev, addr, alen))
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530431 return 1;
432
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530433 start_time_rx = get_timer(0);
434 while (len) {
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200435 if (!active) {
436 /*
437 * Avoid writing to ic_cmd_data multiple times
438 * in case this loop spins too quickly and the
439 * ic_status RFNE bit isn't set after the first
440 * write. Subsequent writes to ic_cmd_data can
441 * trigger spurious i2c transfer.
442 */
443 if (len == 1)
444 writel(IC_CMD | IC_STOP, &i2c_base->ic_cmd_data);
445 else
446 writel(IC_CMD, &i2c_base->ic_cmd_data);
447 active = 1;
448 }
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530449
Stefan Roeseef6073e2014-10-28 12:12:00 +0100450 if (readl(&i2c_base->ic_status) & IC_STATUS_RFNE) {
451 *buffer++ = (uchar)readl(&i2c_base->ic_cmd_data);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530452 len--;
453 start_time_rx = get_timer(0);
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200454 active = 0;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530455 } else if (get_timer(start_time_rx) > I2C_BYTE_TO) {
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200456 return 1;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530457 }
458 }
459
Stefan Roese41de7662016-04-21 08:19:40 +0200460 return i2c_xfer_finish(i2c_base);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530461}
462
463/*
464 * i2c_write - Write to i2c memory
465 * @chip: target i2c address
466 * @addr: address to read from
467 * @alen:
468 * @buffer: buffer for read data
469 * @len: no of bytes to be read
470 *
471 * Write to i2c memory.
472 */
Stefan Roese41de7662016-04-21 08:19:40 +0200473static int __dw_i2c_write(struct i2c_regs *i2c_base, u8 dev, uint addr,
474 int alen, u8 *buffer, int len)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530475{
476 int nb = len;
477 unsigned long start_time_tx;
478
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400479#ifdef CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW
480 /*
481 * EEPROM chips that implement "address overflow" are ones
482 * like Catalyst 24WC04/08/16 which has 9/10/11 bits of
483 * address and the extra bits end up in the "chip address"
484 * bit slots. This makes a 24WC08 (1Kbyte) chip look like
485 * four 256 byte chips.
486 *
487 * Note that we consider the length of the address field to
488 * still be one byte because the extra address bits are
489 * hidden in the chip address.
490 */
Stefan Roeseef6073e2014-10-28 12:12:00 +0100491 dev |= ((addr >> (alen * 8)) & CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400492 addr &= ~(CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW << (alen * 8));
493
Stefan Roeseef6073e2014-10-28 12:12:00 +0100494 debug("%s: fix addr_overflow: dev %02x addr %02x\n", __func__, dev,
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400495 addr);
496#endif
497
Stefan Roese41de7662016-04-21 08:19:40 +0200498 if (i2c_xfer_init(i2c_base, dev, addr, alen))
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530499 return 1;
500
501 start_time_tx = get_timer(0);
502 while (len) {
Stefan Roeseef6073e2014-10-28 12:12:00 +0100503 if (readl(&i2c_base->ic_status) & IC_STATUS_TFNF) {
504 if (--len == 0) {
505 writel(*buffer | IC_STOP,
506 &i2c_base->ic_cmd_data);
507 } else {
508 writel(*buffer, &i2c_base->ic_cmd_data);
509 }
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530510 buffer++;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530511 start_time_tx = get_timer(0);
512
513 } else if (get_timer(start_time_tx) > (nb * I2C_BYTE_TO)) {
514 printf("Timed out. i2c write Failed\n");
515 return 1;
516 }
517 }
518
Stefan Roese41de7662016-04-21 08:19:40 +0200519 return i2c_xfer_finish(i2c_base);
520}
521
Stefan Roese3cb27962016-04-21 08:19:41 +0200522/*
523 * __dw_i2c_init - Init function
524 * @speed: required i2c speed
525 * @slaveaddr: slave address for the device
526 *
527 * Initialization function.
528 */
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700529static int __dw_i2c_init(struct i2c_regs *i2c_base, int speed, int slaveaddr)
Stefan Roese3cb27962016-04-21 08:19:41 +0200530{
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700531 int ret;
532
Stefan Roese3cb27962016-04-21 08:19:41 +0200533 /* Disable i2c */
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700534 ret = dw_i2c_enable(i2c_base, false);
535 if (ret)
536 return ret;
Stefan Roese3cb27962016-04-21 08:19:41 +0200537
Marek Vasut808aa132017-08-07 20:45:31 +0200538 writel(IC_CON_SD | IC_CON_RE | IC_CON_SPD_FS | IC_CON_MM,
539 &i2c_base->ic_con);
Stefan Roese3cb27962016-04-21 08:19:41 +0200540 writel(IC_RX_TL, &i2c_base->ic_rx_tl);
541 writel(IC_TX_TL, &i2c_base->ic_tx_tl);
542 writel(IC_STOP_DET, &i2c_base->ic_intr_mask);
543#ifndef CONFIG_DM_I2C
Simon Glassc5294192020-01-23 11:48:25 -0700544 _dw_i2c_set_bus_speed(NULL, i2c_base, speed, IC_CLK);
Stefan Roese3cb27962016-04-21 08:19:41 +0200545 writel(slaveaddr, &i2c_base->ic_sar);
546#endif
547
548 /* Enable i2c */
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700549 ret = dw_i2c_enable(i2c_base, true);
550 if (ret)
551 return ret;
552
553 return 0;
Stefan Roese3cb27962016-04-21 08:19:41 +0200554}
555
556#ifndef CONFIG_DM_I2C
557/*
558 * The legacy I2C functions. These need to get removed once
559 * all users of this driver are converted to DM.
560 */
Stefan Roese41de7662016-04-21 08:19:40 +0200561static struct i2c_regs *i2c_get_base(struct i2c_adapter *adap)
562{
563 switch (adap->hwadapnr) {
564#if CONFIG_SYS_I2C_BUS_MAX >= 4
565 case 3:
566 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE3;
567#endif
568#if CONFIG_SYS_I2C_BUS_MAX >= 3
569 case 2:
570 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE2;
571#endif
572#if CONFIG_SYS_I2C_BUS_MAX >= 2
573 case 1:
574 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE1;
575#endif
576 case 0:
577 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE;
578 default:
579 printf("Wrong I2C-adapter number %d\n", adap->hwadapnr);
580 }
581
582 return NULL;
583}
584
585static unsigned int dw_i2c_set_bus_speed(struct i2c_adapter *adap,
586 unsigned int speed)
587{
588 adap->speed = speed;
Simon Glassc5294192020-01-23 11:48:25 -0700589 return _dw_i2c_set_bus_speed(NULL, i2c_get_base(adap), speed, IC_CLK);
Stefan Roese41de7662016-04-21 08:19:40 +0200590}
591
Stefan Roese3cb27962016-04-21 08:19:41 +0200592static void dw_i2c_init(struct i2c_adapter *adap, int speed, int slaveaddr)
Stefan Roese41de7662016-04-21 08:19:40 +0200593{
Stefan Roese3cb27962016-04-21 08:19:41 +0200594 __dw_i2c_init(i2c_get_base(adap), speed, slaveaddr);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530595}
596
Stefan Roese41de7662016-04-21 08:19:40 +0200597static int dw_i2c_read(struct i2c_adapter *adap, u8 dev, uint addr,
598 int alen, u8 *buffer, int len)
599{
600 return __dw_i2c_read(i2c_get_base(adap), dev, addr, alen, buffer, len);
601}
602
603static int dw_i2c_write(struct i2c_adapter *adap, u8 dev, uint addr,
604 int alen, u8 *buffer, int len)
605{
606 return __dw_i2c_write(i2c_get_base(adap), dev, addr, alen, buffer, len);
607}
608
Stefan Roese3cb27962016-04-21 08:19:41 +0200609/* dw_i2c_probe - Probe the i2c chip */
Stefan Roeseef6073e2014-10-28 12:12:00 +0100610static int dw_i2c_probe(struct i2c_adapter *adap, u8 dev)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530611{
Stefan Roese41de7662016-04-21 08:19:40 +0200612 struct i2c_regs *i2c_base = i2c_get_base(adap);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530613 u32 tmp;
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100614 int ret;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530615
616 /*
617 * Try to read the first location of the chip.
618 */
Stefan Roese41de7662016-04-21 08:19:40 +0200619 ret = __dw_i2c_read(i2c_base, dev, 0, 1, (uchar *)&tmp, 1);
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100620 if (ret)
Stefan Roeseef6073e2014-10-28 12:12:00 +0100621 dw_i2c_init(adap, adap->speed, adap->slaveaddr);
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100622
623 return ret;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530624}
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000625
Stefan Roeseef6073e2014-10-28 12:12:00 +0100626U_BOOT_I2C_ADAP_COMPLETE(dw_0, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
627 dw_i2c_write, dw_i2c_set_bus_speed,
628 CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 0)
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000629
Stefan Roeseef6073e2014-10-28 12:12:00 +0100630#if CONFIG_SYS_I2C_BUS_MAX >= 2
631U_BOOT_I2C_ADAP_COMPLETE(dw_1, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
632 dw_i2c_write, dw_i2c_set_bus_speed,
633 CONFIG_SYS_I2C_SPEED1, CONFIG_SYS_I2C_SLAVE1, 1)
634#endif
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000635
Stefan Roeseef6073e2014-10-28 12:12:00 +0100636#if CONFIG_SYS_I2C_BUS_MAX >= 3
637U_BOOT_I2C_ADAP_COMPLETE(dw_2, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
638 dw_i2c_write, dw_i2c_set_bus_speed,
639 CONFIG_SYS_I2C_SPEED2, CONFIG_SYS_I2C_SLAVE2, 2)
640#endif
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000641
Stefan Roeseef6073e2014-10-28 12:12:00 +0100642#if CONFIG_SYS_I2C_BUS_MAX >= 4
643U_BOOT_I2C_ADAP_COMPLETE(dw_3, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
644 dw_i2c_write, dw_i2c_set_bus_speed,
645 CONFIG_SYS_I2C_SPEED3, CONFIG_SYS_I2C_SLAVE3, 3)
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000646#endif
Stefan Roese3cb27962016-04-21 08:19:41 +0200647
648#else /* CONFIG_DM_I2C */
649/* The DM I2C functions */
650
651static int designware_i2c_xfer(struct udevice *bus, struct i2c_msg *msg,
652 int nmsgs)
653{
654 struct dw_i2c *i2c = dev_get_priv(bus);
655 int ret;
656
657 debug("i2c_xfer: %d messages\n", nmsgs);
658 for (; nmsgs > 0; nmsgs--, msg++) {
659 debug("i2c_xfer: chip=0x%x, len=0x%x\n", msg->addr, msg->len);
660 if (msg->flags & I2C_M_RD) {
661 ret = __dw_i2c_read(i2c->regs, msg->addr, 0, 0,
662 msg->buf, msg->len);
663 } else {
664 ret = __dw_i2c_write(i2c->regs, msg->addr, 0, 0,
665 msg->buf, msg->len);
666 }
667 if (ret) {
668 debug("i2c_write: error sending\n");
669 return -EREMOTEIO;
670 }
671 }
672
673 return 0;
674}
675
676static int designware_i2c_set_bus_speed(struct udevice *bus, unsigned int speed)
677{
678 struct dw_i2c *i2c = dev_get_priv(bus);
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800679 ulong rate;
680
681#if CONFIG_IS_ENABLED(CLK)
682 rate = clk_get_rate(&i2c->clk);
683 if (IS_ERR_VALUE(rate))
684 return -EINVAL;
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800685#else
686 rate = IC_CLK;
687#endif
Simon Glassc5294192020-01-23 11:48:25 -0700688 return _dw_i2c_set_bus_speed(i2c, i2c->regs, speed, rate);
Stefan Roese3cb27962016-04-21 08:19:41 +0200689}
690
691static int designware_i2c_probe_chip(struct udevice *bus, uint chip_addr,
692 uint chip_flags)
693{
694 struct dw_i2c *i2c = dev_get_priv(bus);
695 struct i2c_regs *i2c_base = i2c->regs;
696 u32 tmp;
697 int ret;
698
699 /* Try to read the first location of the chip */
700 ret = __dw_i2c_read(i2c_base, chip_addr, 0, 1, (uchar *)&tmp, 1);
701 if (ret)
702 __dw_i2c_init(i2c_base, 0, 0);
703
704 return ret;
705}
706
Simon Glass9e5d1742020-01-23 11:48:11 -0700707int designware_i2c_ofdata_to_platdata(struct udevice *bus)
Stefan Roese3cb27962016-04-21 08:19:41 +0200708{
709 struct dw_i2c *priv = dev_get_priv(bus);
Simon Glass8de5ae82020-01-23 11:48:26 -0700710 int ret;
Stefan Roese3cb27962016-04-21 08:19:41 +0200711
Simon Glass9e5d1742020-01-23 11:48:11 -0700712 if (!priv->regs)
713 priv->regs = (struct i2c_regs *)devfdt_get_addr_ptr(bus);
714 dev_read_u32(bus, "i2c-scl-rising-time-ns", &priv->scl_rise_time_ns);
715 dev_read_u32(bus, "i2c-scl-falling-time-ns", &priv->scl_fall_time_ns);
716 dev_read_u32(bus, "i2c-sda-hold-time-ns", &priv->sda_hold_time_ns);
Simon Glasse2be5532019-12-06 21:41:40 -0700717
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100718 ret = reset_get_bulk(bus, &priv->resets);
Dinh Nguyen08794aa2018-04-04 17:18:24 -0500719 if (ret)
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100720 dev_warn(bus, "Can't get reset: %d\n", ret);
721 else
722 reset_deassert_bulk(&priv->resets);
Dinh Nguyen08794aa2018-04-04 17:18:24 -0500723
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800724#if CONFIG_IS_ENABLED(CLK)
725 ret = clk_get_by_index(bus, 0, &priv->clk);
726 if (ret)
727 return ret;
728
729 ret = clk_enable(&priv->clk);
730 if (ret && ret != -ENOSYS && ret != -ENOTSUPP) {
731 clk_free(&priv->clk);
732 dev_err(bus, "failed to enable clock\n");
733 return ret;
734 }
735#endif
736
Simon Glass8de5ae82020-01-23 11:48:26 -0700737 return 0;
738}
739
740int designware_i2c_probe(struct udevice *bus)
741{
742 struct dw_i2c *priv = dev_get_priv(bus);
743
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700744 return __dw_i2c_init(priv->regs, 0, 0);
Stefan Roese3cb27962016-04-21 08:19:41 +0200745}
746
Simon Glasse2be5532019-12-06 21:41:40 -0700747int designware_i2c_remove(struct udevice *dev)
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100748{
749 struct dw_i2c *priv = dev_get_priv(dev);
750
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800751#if CONFIG_IS_ENABLED(CLK)
752 clk_disable(&priv->clk);
753 clk_free(&priv->clk);
754#endif
755
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100756 return reset_release_bulk(&priv->resets);
757}
758
Simon Glasse2be5532019-12-06 21:41:40 -0700759const struct dm_i2c_ops designware_i2c_ops = {
Stefan Roese3cb27962016-04-21 08:19:41 +0200760 .xfer = designware_i2c_xfer,
761 .probe_chip = designware_i2c_probe_chip,
762 .set_bus_speed = designware_i2c_set_bus_speed,
763};
764
765static const struct udevice_id designware_i2c_ids[] = {
766 { .compatible = "snps,designware-i2c" },
767 { }
768};
769
770U_BOOT_DRIVER(i2c_designware) = {
771 .name = "i2c_designware",
772 .id = UCLASS_I2C,
773 .of_match = designware_i2c_ids,
Simon Glasse2be5532019-12-06 21:41:40 -0700774 .ofdata_to_platdata = designware_i2c_ofdata_to_platdata,
Stefan Roese3cb27962016-04-21 08:19:41 +0200775 .probe = designware_i2c_probe,
776 .priv_auto_alloc_size = sizeof(struct dw_i2c),
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100777 .remove = designware_i2c_remove,
Simon Glasse2be5532019-12-06 21:41:40 -0700778 .flags = DM_FLAG_OS_PREPARE,
Stefan Roese3cb27962016-04-21 08:19:41 +0200779 .ops = &designware_i2c_ops,
780};
781
782#endif /* CONFIG_DM_I2C */