blob: 42ee7d523e37e349d905f9aa7c81d95f90d4b4ac [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
Stefan Roeseabb3e132016-04-27 09:02:12 +020021#ifdef CONFIG_SYS_I2C_DW_ENABLE_STATUS_UNSUPPORTED
Simon Glassbd9ca8d2019-02-16 20:24:39 -070022static int dw_i2c_enable(struct i2c_regs *i2c_base, bool enable)
Stefan Roese3bc33ba2016-04-21 08:19:38 +020023{
24 u32 ena = enable ? IC_ENABLE_0B : 0;
Stefan Roeseabb3e132016-04-27 09:02:12 +020025
26 writel(ena, &i2c_base->ic_enable);
Simon Glassbd9ca8d2019-02-16 20:24:39 -070027
28 return 0;
Stefan Roeseabb3e132016-04-27 09:02:12 +020029}
30#else
Simon Glassbd9ca8d2019-02-16 20:24:39 -070031static int dw_i2c_enable(struct i2c_regs *i2c_base, bool enable)
Stefan Roeseabb3e132016-04-27 09:02:12 +020032{
33 u32 ena = enable ? IC_ENABLE_0B : 0;
Stefan Roese3bc33ba2016-04-21 08:19:38 +020034 int timeout = 100;
35
36 do {
37 writel(ena, &i2c_base->ic_enable);
38 if ((readl(&i2c_base->ic_enable_status) & IC_ENABLE_0B) == ena)
Simon Glassbd9ca8d2019-02-16 20:24:39 -070039 return 0;
Stefan Roese3bc33ba2016-04-21 08:19:38 +020040
41 /*
42 * Wait 10 times the signaling period of the highest I2C
43 * transfer supported by the driver (for 400KHz this is
44 * 25us) as described in the DesignWare I2C databook.
45 */
46 udelay(25);
47 } while (timeout--);
Stefan Roese3bc33ba2016-04-21 08:19:38 +020048 printf("timeout in %sabling I2C adapter\n", enable ? "en" : "dis");
Simon Glassbd9ca8d2019-02-16 20:24:39 -070049
50 return -ETIMEDOUT;
Stefan Roese3bc33ba2016-04-21 08:19:38 +020051}
Stefan Roeseabb3e132016-04-27 09:02:12 +020052#endif
Stefan Roese3bc33ba2016-04-21 08:19:38 +020053
Simon Glassc7181102020-01-23 11:48:14 -070054/* High and low times in different speed modes (in ns) */
55enum {
56 /* SDA Hold Time */
57 DEFAULT_SDA_HOLD_TIME = 300,
58};
59
60/**
61 * calc_counts() - Convert a period to a number of IC clk cycles
62 *
63 * @ic_clk: Input clock in Hz
64 * @period_ns: Period to represent, in ns
65 * @return calculated count
66 */
67static uint calc_counts(uint ic_clk, uint period_ns)
68{
69 return DIV_ROUND_UP(ic_clk / 1000 * period_ns, NANO_TO_KILO);
70}
71
72/**
73 * struct i2c_mode_info - Information about an I2C speed mode
74 *
75 * Each speed mode has its own characteristics. This struct holds these to aid
76 * calculations in dw_i2c_calc_timing().
77 *
78 * @speed: Speed in Hz
79 * @min_scl_lowtime_ns: Minimum value for SCL low period in ns
80 * @min_scl_hightime_ns: Minimum value for SCL high period in ns
81 * @def_rise_time_ns: Default rise time in ns
82 * @def_fall_time_ns: Default fall time in ns
83 */
84struct i2c_mode_info {
85 int speed;
86 int min_scl_hightime_ns;
87 int min_scl_lowtime_ns;
88 int def_rise_time_ns;
89 int def_fall_time_ns;
90};
91
92static const struct i2c_mode_info info_for_mode[] = {
93 [IC_SPEED_MODE_STANDARD] = {
Simon Glassac77bae2020-01-23 11:48:18 -070094 I2C_SPEED_STANDARD_RATE,
Simon Glassc7181102020-01-23 11:48:14 -070095 MIN_SS_SCL_HIGHTIME,
96 MIN_SS_SCL_LOWTIME,
97 1000,
98 300,
99 },
100 [IC_SPEED_MODE_FAST] = {
Simon Glassac77bae2020-01-23 11:48:18 -0700101 I2C_SPEED_FAST_RATE,
Simon Glassc7181102020-01-23 11:48:14 -0700102 MIN_FS_SCL_HIGHTIME,
103 MIN_FS_SCL_LOWTIME,
104 300,
105 300,
106 },
Simon Glass45649222020-01-23 11:48:23 -0700107 [IC_SPEED_MODE_FAST_PLUS] = {
108 I2C_SPEED_FAST_PLUS_RATE,
109 MIN_FP_SCL_HIGHTIME,
110 MIN_FP_SCL_LOWTIME,
111 260,
112 500,
113 },
Simon Glassc7181102020-01-23 11:48:14 -0700114 [IC_SPEED_MODE_HIGH] = {
Simon Glassac77bae2020-01-23 11:48:18 -0700115 I2C_SPEED_HIGH_RATE,
Simon Glassc7181102020-01-23 11:48:14 -0700116 MIN_HS_SCL_HIGHTIME,
117 MIN_HS_SCL_LOWTIME,
118 120,
119 120,
120 },
121};
122
123/**
124 * dw_i2c_calc_timing() - Calculate the timings to use for a bus
125 *
126 * @priv: Bus private information (NULL if not using driver model)
127 * @mode: Speed mode to use
128 * @ic_clk: IC clock speed in Hz
129 * @spk_cnt: Spike-suppression count
130 * @config: Returns value to use
131 * @return 0 if OK, -EINVAL if the calculation failed due to invalid data
132 */
133static int dw_i2c_calc_timing(struct dw_i2c *priv, enum i2c_speed_mode mode,
134 int ic_clk, int spk_cnt,
135 struct dw_i2c_speed_config *config)
136{
137 int fall_cnt, rise_cnt, min_tlow_cnt, min_thigh_cnt;
138 int hcnt, lcnt, period_cnt, diff, tot;
139 int sda_hold_time_ns, scl_rise_time_ns, scl_fall_time_ns;
140 const struct i2c_mode_info *info;
141
142 /*
143 * Find the period, rise, fall, min tlow, and min thigh in terms of
144 * counts of the IC clock
145 */
146 info = &info_for_mode[mode];
147 period_cnt = ic_clk / info->speed;
148 scl_rise_time_ns = priv && priv->scl_rise_time_ns ?
149 priv->scl_rise_time_ns : info->def_rise_time_ns;
150 scl_fall_time_ns = priv && priv->scl_fall_time_ns ?
151 priv->scl_fall_time_ns : info->def_fall_time_ns;
152 rise_cnt = calc_counts(ic_clk, scl_rise_time_ns);
153 fall_cnt = calc_counts(ic_clk, scl_fall_time_ns);
154 min_tlow_cnt = calc_counts(ic_clk, info->min_scl_lowtime_ns);
155 min_thigh_cnt = calc_counts(ic_clk, info->min_scl_hightime_ns);
156
157 debug("dw_i2c: period %d rise %d fall %d tlow %d thigh %d spk %d\n",
158 period_cnt, rise_cnt, fall_cnt, min_tlow_cnt, min_thigh_cnt,
159 spk_cnt);
160
161 /*
162 * Back-solve for hcnt and lcnt according to the following equations:
163 * SCL_High_time = [(HCNT + IC_*_SPKLEN + 7) * ic_clk] + SCL_Fall_time
164 * SCL_Low_time = [(LCNT + 1) * ic_clk] - SCL_Fall_time + SCL_Rise_time
165 */
166 hcnt = min_thigh_cnt - fall_cnt - 7 - spk_cnt;
167 lcnt = min_tlow_cnt - rise_cnt + fall_cnt - 1;
168
169 if (hcnt < 0 || lcnt < 0) {
170 debug("dw_i2c: bad counts. hcnt = %d lcnt = %d\n", hcnt, lcnt);
171 return -EINVAL;
172 }
173
174 /*
175 * Now add things back up to ensure the period is hit. If it is off,
176 * split the difference and bias to lcnt for remainder
177 */
178 tot = hcnt + lcnt + 7 + spk_cnt + rise_cnt + 1;
179
180 if (tot < period_cnt) {
181 diff = (period_cnt - tot) / 2;
182 hcnt += diff;
183 lcnt += diff;
184 tot = hcnt + lcnt + 7 + spk_cnt + rise_cnt + 1;
185 lcnt += period_cnt - tot;
186 }
187
188 config->scl_lcnt = lcnt;
189 config->scl_hcnt = hcnt;
190
191 /* Use internal default unless other value is specified */
192 sda_hold_time_ns = priv && priv->sda_hold_time_ns ?
193 priv->sda_hold_time_ns : DEFAULT_SDA_HOLD_TIME;
194 config->sda_hold = calc_counts(ic_clk, sda_hold_time_ns);
195
196 debug("dw_i2c: hcnt = %d lcnt = %d sda hold = %d\n", hcnt, lcnt,
197 config->sda_hold);
198
199 return 0;
200}
201
Simon Glassc5294192020-01-23 11:48:25 -0700202static int calc_bus_speed(struct dw_i2c *priv, int speed, ulong bus_clk,
203 struct dw_i2c_speed_config *config)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530204{
Simon Glass60e0c3a2020-01-23 11:48:12 -0700205 const struct dw_scl_sda_cfg *scl_sda_cfg = NULL;
Simon Glassc5294192020-01-23 11:48:25 -0700206 struct i2c_regs *regs = priv->regs;
Simon Glass6ed44ae2020-01-23 11:48:08 -0700207 enum i2c_speed_mode i2c_spd;
Jun Chenef6677e2020-03-02 16:58:55 +0800208 u32 comp_param1;
Simon Glassc38e2b32020-01-23 11:48:15 -0700209 int spk_cnt;
Simon Glassc7181102020-01-23 11:48:14 -0700210 int ret;
Stefan Roese88893c92016-04-21 08:19:39 +0200211
Jun Chenef6677e2020-03-02 16:58:55 +0800212 comp_param1 = readl(&regs->comp_param1);
213
Simon Glass60e0c3a2020-01-23 11:48:12 -0700214 if (priv)
215 scl_sda_cfg = priv->scl_sda_cfg;
Simon Glassf5ef1012020-01-23 11:48:07 -0700216 /* Allow high speed if there is no config, or the config allows it */
Jun Chen3ce27d42020-03-02 16:58:56 +0800217 if (speed >= I2C_SPEED_HIGH_RATE)
Simon Glassf5ef1012020-01-23 11:48:07 -0700218 i2c_spd = IC_SPEED_MODE_HIGH;
Simon Glass45649222020-01-23 11:48:23 -0700219 else if (speed >= I2C_SPEED_FAST_PLUS_RATE)
Simon Glass55397682020-02-13 13:24:55 -0700220 i2c_spd = IC_SPEED_MODE_FAST_PLUS;
221 else if (speed >= I2C_SPEED_FAST_RATE)
Stefan Roese88893c92016-04-21 08:19:39 +0200222 i2c_spd = IC_SPEED_MODE_FAST;
223 else
224 i2c_spd = IC_SPEED_MODE_STANDARD;
Armando Visconti631e6932012-03-29 20:10:17 +0000225
Jun Chenef6677e2020-03-02 16:58:55 +0800226 /* Check is high speed possible and fall back to fast mode if not */
227 if (i2c_spd == IC_SPEED_MODE_HIGH) {
228 if ((comp_param1 & DW_IC_COMP_PARAM_1_SPEED_MODE_MASK)
229 != DW_IC_COMP_PARAM_1_SPEED_MODE_HIGH)
230 i2c_spd = IC_SPEED_MODE_FAST;
231 }
232
Simon Glassc38e2b32020-01-23 11:48:15 -0700233 /* Get the proper spike-suppression count based on target speed */
234 if (!priv || !priv->has_spk_cnt)
235 spk_cnt = 0;
236 else if (i2c_spd >= IC_SPEED_MODE_HIGH)
Simon Glassc5294192020-01-23 11:48:25 -0700237 spk_cnt = readl(&regs->hs_spklen);
Simon Glassc38e2b32020-01-23 11:48:15 -0700238 else
Simon Glassc5294192020-01-23 11:48:25 -0700239 spk_cnt = readl(&regs->fs_spklen);
Simon Glass245ec0b2020-01-23 11:48:13 -0700240 if (scl_sda_cfg) {
Simon Glassc5294192020-01-23 11:48:25 -0700241 config->sda_hold = scl_sda_cfg->sda_hold;
Simon Glass245ec0b2020-01-23 11:48:13 -0700242 if (i2c_spd == IC_SPEED_MODE_STANDARD) {
Simon Glassc5294192020-01-23 11:48:25 -0700243 config->scl_hcnt = scl_sda_cfg->ss_hcnt;
244 config->scl_lcnt = scl_sda_cfg->ss_lcnt;
Jun Chenc191f542020-03-02 16:58:57 +0800245 } else if (i2c_spd == IC_SPEED_MODE_HIGH) {
246 config->scl_hcnt = scl_sda_cfg->hs_hcnt;
247 config->scl_lcnt = scl_sda_cfg->hs_lcnt;
Simon Glass245ec0b2020-01-23 11:48:13 -0700248 } else {
Simon Glassc5294192020-01-23 11:48:25 -0700249 config->scl_hcnt = scl_sda_cfg->fs_hcnt;
250 config->scl_lcnt = scl_sda_cfg->fs_lcnt;
Simon Glass245ec0b2020-01-23 11:48:13 -0700251 }
Simon Glassc7181102020-01-23 11:48:14 -0700252 } else {
Simon Glassc38e2b32020-01-23 11:48:15 -0700253 ret = dw_i2c_calc_timing(priv, i2c_spd, bus_clk, spk_cnt,
Simon Glassc5294192020-01-23 11:48:25 -0700254 config);
Simon Glassc7181102020-01-23 11:48:14 -0700255 if (ret)
256 return log_msg_ret("gen_confg", ret);
Simon Glass245ec0b2020-01-23 11:48:13 -0700257 }
Simon Glassc5294192020-01-23 11:48:25 -0700258 config->speed_mode = i2c_spd;
259
260 return 0;
261}
262
263/*
264 * _dw_i2c_set_bus_speed - Set the i2c speed
265 * @speed: required i2c speed
266 *
267 * Set the i2c speed.
268 */
269static int _dw_i2c_set_bus_speed(struct dw_i2c *priv, struct i2c_regs *i2c_base,
270 unsigned int speed, unsigned int bus_clk)
271{
272 struct dw_i2c_speed_config config;
273 unsigned int cntl;
274 unsigned int ena;
275 int ret;
276
277 ret = calc_bus_speed(priv, speed, bus_clk, &config);
278 if (ret)
279 return ret;
280
281 /* Get enable setting for restore later */
282 ena = readl(&i2c_base->ic_enable) & IC_ENABLE_0B;
283
284 /* to set speed cltr must be disabled */
285 dw_i2c_enable(i2c_base, false);
286
287 cntl = (readl(&i2c_base->ic_con) & (~IC_CON_SPD_MSK));
Simon Glass245ec0b2020-01-23 11:48:13 -0700288
Simon Glassc5294192020-01-23 11:48:25 -0700289 switch (config.speed_mode) {
Simon Glassf5ef1012020-01-23 11:48:07 -0700290 case IC_SPEED_MODE_HIGH:
Jun Chen635cf512020-03-02 16:58:54 +0800291 cntl |= IC_CON_SPD_HS;
Simon Glass245ec0b2020-01-23 11:48:13 -0700292 writel(config.scl_hcnt, &i2c_base->ic_hs_scl_hcnt);
293 writel(config.scl_lcnt, &i2c_base->ic_hs_scl_lcnt);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530294 break;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530295 case IC_SPEED_MODE_STANDARD:
296 cntl |= IC_CON_SPD_SS;
Simon Glass245ec0b2020-01-23 11:48:13 -0700297 writel(config.scl_hcnt, &i2c_base->ic_ss_scl_hcnt);
298 writel(config.scl_lcnt, &i2c_base->ic_ss_scl_lcnt);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530299 break;
Simon Glass45649222020-01-23 11:48:23 -0700300 case IC_SPEED_MODE_FAST_PLUS:
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530301 case IC_SPEED_MODE_FAST:
302 default:
303 cntl |= IC_CON_SPD_FS;
Simon Glass245ec0b2020-01-23 11:48:13 -0700304 writel(config.scl_hcnt, &i2c_base->ic_fs_scl_hcnt);
305 writel(config.scl_lcnt, &i2c_base->ic_fs_scl_lcnt);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530306 break;
307 }
308
Stefan Roeseef6073e2014-10-28 12:12:00 +0100309 writel(cntl, &i2c_base->ic_con);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530310
Stefan Roese38481202016-04-21 08:19:42 +0200311 /* Configure SDA Hold Time if required */
Simon Glass245ec0b2020-01-23 11:48:13 -0700312 if (config.sda_hold)
313 writel(config.sda_hold, &i2c_base->ic_sda_hold);
Stefan Roese38481202016-04-21 08:19:42 +0200314
Jun Chend003a372019-06-05 15:23:16 +0800315 /* Restore back i2c now speed set */
316 if (ena == IC_ENABLE_0B)
317 dw_i2c_enable(i2c_base, true);
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100318
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530319 return 0;
320}
321
322/*
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530323 * i2c_setaddress - Sets the target slave address
324 * @i2c_addr: target i2c address
325 *
326 * Sets the target slave address.
327 */
Stefan Roese41de7662016-04-21 08:19:40 +0200328static void i2c_setaddress(struct i2c_regs *i2c_base, unsigned int i2c_addr)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530329{
Alexey Brodkin41c56552013-11-07 17:52:18 +0400330 /* Disable i2c */
Stefan Roese3bc33ba2016-04-21 08:19:38 +0200331 dw_i2c_enable(i2c_base, false);
Alexey Brodkin41c56552013-11-07 17:52:18 +0400332
Stefan Roeseef6073e2014-10-28 12:12:00 +0100333 writel(i2c_addr, &i2c_base->ic_tar);
Alexey Brodkin41c56552013-11-07 17:52:18 +0400334
335 /* Enable i2c */
Stefan Roese3bc33ba2016-04-21 08:19:38 +0200336 dw_i2c_enable(i2c_base, true);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530337}
338
339/*
340 * i2c_flush_rxfifo - Flushes the i2c RX FIFO
341 *
342 * Flushes the i2c RX FIFO
343 */
Stefan Roese41de7662016-04-21 08:19:40 +0200344static void i2c_flush_rxfifo(struct i2c_regs *i2c_base)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530345{
Stefan Roeseef6073e2014-10-28 12:12:00 +0100346 while (readl(&i2c_base->ic_status) & IC_STATUS_RFNE)
347 readl(&i2c_base->ic_cmd_data);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530348}
349
350/*
351 * i2c_wait_for_bb - Waits for bus busy
352 *
353 * Waits for bus busy
354 */
Stefan Roese41de7662016-04-21 08:19:40 +0200355static int i2c_wait_for_bb(struct i2c_regs *i2c_base)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530356{
357 unsigned long start_time_bb = get_timer(0);
358
Stefan Roeseef6073e2014-10-28 12:12:00 +0100359 while ((readl(&i2c_base->ic_status) & IC_STATUS_MA) ||
360 !(readl(&i2c_base->ic_status) & IC_STATUS_TFE)) {
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530361
362 /* Evaluate timeout */
363 if (get_timer(start_time_bb) > (unsigned long)(I2C_BYTE_TO_BB))
364 return 1;
365 }
366
367 return 0;
368}
369
Stefan Roese41de7662016-04-21 08:19:40 +0200370static int i2c_xfer_init(struct i2c_regs *i2c_base, uchar chip, uint addr,
Stefan Roeseef6073e2014-10-28 12:12:00 +0100371 int alen)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530372{
Stefan Roese41de7662016-04-21 08:19:40 +0200373 if (i2c_wait_for_bb(i2c_base))
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530374 return 1;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530375
Stefan Roese41de7662016-04-21 08:19:40 +0200376 i2c_setaddress(i2c_base, chip);
Chin Liang Seea0c26262014-02-04 11:56:23 -0600377 while (alen) {
378 alen--;
379 /* high byte address going out first */
380 writel((addr >> (alen * 8)) & 0xff,
Stefan Roeseef6073e2014-10-28 12:12:00 +0100381 &i2c_base->ic_cmd_data);
Chin Liang Seea0c26262014-02-04 11:56:23 -0600382 }
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530383 return 0;
384}
385
Stefan Roese41de7662016-04-21 08:19:40 +0200386static int i2c_xfer_finish(struct i2c_regs *i2c_base)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530387{
388 ulong start_stop_det = get_timer(0);
389
390 while (1) {
Stefan Roeseef6073e2014-10-28 12:12:00 +0100391 if ((readl(&i2c_base->ic_raw_intr_stat) & IC_STOP_DET)) {
392 readl(&i2c_base->ic_clr_stop_det);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530393 break;
394 } else if (get_timer(start_stop_det) > I2C_STOPDET_TO) {
395 break;
396 }
397 }
398
Stefan Roese41de7662016-04-21 08:19:40 +0200399 if (i2c_wait_for_bb(i2c_base)) {
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530400 printf("Timed out waiting for bus\n");
401 return 1;
402 }
403
Stefan Roese41de7662016-04-21 08:19:40 +0200404 i2c_flush_rxfifo(i2c_base);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530405
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530406 return 0;
407}
408
409/*
410 * i2c_read - Read from i2c memory
411 * @chip: target i2c address
412 * @addr: address to read from
413 * @alen:
414 * @buffer: buffer for read data
415 * @len: no of bytes to be read
416 *
417 * Read from i2c memory.
418 */
Stefan Roese41de7662016-04-21 08:19:40 +0200419static int __dw_i2c_read(struct i2c_regs *i2c_base, u8 dev, uint addr,
420 int alen, u8 *buffer, int len)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530421{
422 unsigned long start_time_rx;
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200423 unsigned int active = 0;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530424
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400425#ifdef CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW
426 /*
427 * EEPROM chips that implement "address overflow" are ones
428 * like Catalyst 24WC04/08/16 which has 9/10/11 bits of
429 * address and the extra bits end up in the "chip address"
430 * bit slots. This makes a 24WC08 (1Kbyte) chip look like
431 * four 256 byte chips.
432 *
433 * Note that we consider the length of the address field to
434 * still be one byte because the extra address bits are
435 * hidden in the chip address.
436 */
Stefan Roeseef6073e2014-10-28 12:12:00 +0100437 dev |= ((addr >> (alen * 8)) & CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400438 addr &= ~(CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW << (alen * 8));
439
Stefan Roeseef6073e2014-10-28 12:12:00 +0100440 debug("%s: fix addr_overflow: dev %02x addr %02x\n", __func__, dev,
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400441 addr);
442#endif
443
Stefan Roese41de7662016-04-21 08:19:40 +0200444 if (i2c_xfer_init(i2c_base, dev, addr, alen))
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530445 return 1;
446
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530447 start_time_rx = get_timer(0);
448 while (len) {
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200449 if (!active) {
450 /*
451 * Avoid writing to ic_cmd_data multiple times
452 * in case this loop spins too quickly and the
453 * ic_status RFNE bit isn't set after the first
454 * write. Subsequent writes to ic_cmd_data can
455 * trigger spurious i2c transfer.
456 */
457 if (len == 1)
458 writel(IC_CMD | IC_STOP, &i2c_base->ic_cmd_data);
459 else
460 writel(IC_CMD, &i2c_base->ic_cmd_data);
461 active = 1;
462 }
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530463
Stefan Roeseef6073e2014-10-28 12:12:00 +0100464 if (readl(&i2c_base->ic_status) & IC_STATUS_RFNE) {
465 *buffer++ = (uchar)readl(&i2c_base->ic_cmd_data);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530466 len--;
467 start_time_rx = get_timer(0);
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200468 active = 0;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530469 } else if (get_timer(start_time_rx) > I2C_BYTE_TO) {
Marek Vasutc4bc9a82016-10-20 16:48:28 +0200470 return 1;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530471 }
472 }
473
Stefan Roese41de7662016-04-21 08:19:40 +0200474 return i2c_xfer_finish(i2c_base);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530475}
476
477/*
478 * i2c_write - Write to i2c memory
479 * @chip: target i2c address
480 * @addr: address to read from
481 * @alen:
482 * @buffer: buffer for read data
483 * @len: no of bytes to be read
484 *
485 * Write to i2c memory.
486 */
Stefan Roese41de7662016-04-21 08:19:40 +0200487static int __dw_i2c_write(struct i2c_regs *i2c_base, u8 dev, uint addr,
488 int alen, u8 *buffer, int len)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530489{
490 int nb = len;
491 unsigned long start_time_tx;
492
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400493#ifdef CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW
494 /*
495 * EEPROM chips that implement "address overflow" are ones
496 * like Catalyst 24WC04/08/16 which has 9/10/11 bits of
497 * address and the extra bits end up in the "chip address"
498 * bit slots. This makes a 24WC08 (1Kbyte) chip look like
499 * four 256 byte chips.
500 *
501 * Note that we consider the length of the address field to
502 * still be one byte because the extra address bits are
503 * hidden in the chip address.
504 */
Stefan Roeseef6073e2014-10-28 12:12:00 +0100505 dev |= ((addr >> (alen * 8)) & CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400506 addr &= ~(CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW << (alen * 8));
507
Stefan Roeseef6073e2014-10-28 12:12:00 +0100508 debug("%s: fix addr_overflow: dev %02x addr %02x\n", __func__, dev,
Alexey Brodkin7ef00362013-12-16 15:30:35 +0400509 addr);
510#endif
511
Stefan Roese41de7662016-04-21 08:19:40 +0200512 if (i2c_xfer_init(i2c_base, dev, addr, alen))
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530513 return 1;
514
515 start_time_tx = get_timer(0);
516 while (len) {
Stefan Roeseef6073e2014-10-28 12:12:00 +0100517 if (readl(&i2c_base->ic_status) & IC_STATUS_TFNF) {
518 if (--len == 0) {
519 writel(*buffer | IC_STOP,
520 &i2c_base->ic_cmd_data);
521 } else {
522 writel(*buffer, &i2c_base->ic_cmd_data);
523 }
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530524 buffer++;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530525 start_time_tx = get_timer(0);
526
527 } else if (get_timer(start_time_tx) > (nb * I2C_BYTE_TO)) {
528 printf("Timed out. i2c write Failed\n");
529 return 1;
530 }
531 }
532
Stefan Roese41de7662016-04-21 08:19:40 +0200533 return i2c_xfer_finish(i2c_base);
534}
535
Stefan Roese3cb27962016-04-21 08:19:41 +0200536/*
537 * __dw_i2c_init - Init function
538 * @speed: required i2c speed
539 * @slaveaddr: slave address for the device
540 *
541 * Initialization function.
542 */
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700543static int __dw_i2c_init(struct i2c_regs *i2c_base, int speed, int slaveaddr)
Stefan Roese3cb27962016-04-21 08:19:41 +0200544{
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700545 int ret;
546
Stefan Roese3cb27962016-04-21 08:19:41 +0200547 /* Disable i2c */
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700548 ret = dw_i2c_enable(i2c_base, false);
549 if (ret)
550 return ret;
Stefan Roese3cb27962016-04-21 08:19:41 +0200551
Marek Vasut808aa132017-08-07 20:45:31 +0200552 writel(IC_CON_SD | IC_CON_RE | IC_CON_SPD_FS | IC_CON_MM,
553 &i2c_base->ic_con);
Stefan Roese3cb27962016-04-21 08:19:41 +0200554 writel(IC_RX_TL, &i2c_base->ic_rx_tl);
555 writel(IC_TX_TL, &i2c_base->ic_tx_tl);
556 writel(IC_STOP_DET, &i2c_base->ic_intr_mask);
557#ifndef CONFIG_DM_I2C
Simon Glassc5294192020-01-23 11:48:25 -0700558 _dw_i2c_set_bus_speed(NULL, i2c_base, speed, IC_CLK);
Stefan Roese3cb27962016-04-21 08:19:41 +0200559 writel(slaveaddr, &i2c_base->ic_sar);
560#endif
561
562 /* Enable i2c */
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700563 ret = dw_i2c_enable(i2c_base, true);
564 if (ret)
565 return ret;
566
567 return 0;
Stefan Roese3cb27962016-04-21 08:19:41 +0200568}
569
570#ifndef CONFIG_DM_I2C
571/*
572 * The legacy I2C functions. These need to get removed once
573 * all users of this driver are converted to DM.
574 */
Stefan Roese41de7662016-04-21 08:19:40 +0200575static struct i2c_regs *i2c_get_base(struct i2c_adapter *adap)
576{
577 switch (adap->hwadapnr) {
578#if CONFIG_SYS_I2C_BUS_MAX >= 4
579 case 3:
580 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE3;
581#endif
582#if CONFIG_SYS_I2C_BUS_MAX >= 3
583 case 2:
584 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE2;
585#endif
586#if CONFIG_SYS_I2C_BUS_MAX >= 2
587 case 1:
588 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE1;
589#endif
590 case 0:
591 return (struct i2c_regs *)CONFIG_SYS_I2C_BASE;
592 default:
593 printf("Wrong I2C-adapter number %d\n", adap->hwadapnr);
594 }
595
596 return NULL;
597}
598
599static unsigned int dw_i2c_set_bus_speed(struct i2c_adapter *adap,
600 unsigned int speed)
601{
602 adap->speed = speed;
Simon Glassc5294192020-01-23 11:48:25 -0700603 return _dw_i2c_set_bus_speed(NULL, i2c_get_base(adap), speed, IC_CLK);
Stefan Roese41de7662016-04-21 08:19:40 +0200604}
605
Stefan Roese3cb27962016-04-21 08:19:41 +0200606static void dw_i2c_init(struct i2c_adapter *adap, int speed, int slaveaddr)
Stefan Roese41de7662016-04-21 08:19:40 +0200607{
Stefan Roese3cb27962016-04-21 08:19:41 +0200608 __dw_i2c_init(i2c_get_base(adap), speed, slaveaddr);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530609}
610
Stefan Roese41de7662016-04-21 08:19:40 +0200611static int dw_i2c_read(struct i2c_adapter *adap, u8 dev, uint addr,
612 int alen, u8 *buffer, int len)
613{
614 return __dw_i2c_read(i2c_get_base(adap), dev, addr, alen, buffer, len);
615}
616
617static int dw_i2c_write(struct i2c_adapter *adap, u8 dev, uint addr,
618 int alen, u8 *buffer, int len)
619{
620 return __dw_i2c_write(i2c_get_base(adap), dev, addr, alen, buffer, len);
621}
622
Stefan Roese3cb27962016-04-21 08:19:41 +0200623/* dw_i2c_probe - Probe the i2c chip */
Stefan Roeseef6073e2014-10-28 12:12:00 +0100624static int dw_i2c_probe(struct i2c_adapter *adap, u8 dev)
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530625{
Stefan Roese41de7662016-04-21 08:19:40 +0200626 struct i2c_regs *i2c_base = i2c_get_base(adap);
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530627 u32 tmp;
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100628 int ret;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530629
630 /*
631 * Try to read the first location of the chip.
632 */
Stefan Roese41de7662016-04-21 08:19:40 +0200633 ret = __dw_i2c_read(i2c_base, dev, 0, 1, (uchar *)&tmp, 1);
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100634 if (ret)
Stefan Roeseef6073e2014-10-28 12:12:00 +0100635 dw_i2c_init(adap, adap->speed, adap->slaveaddr);
Stefan Roesef6322ebd2012-01-20 11:52:33 +0100636
637 return ret;
Vipin KUMARfc9589f2010-01-15 19:15:44 +0530638}
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000639
Stefan Roeseef6073e2014-10-28 12:12:00 +0100640U_BOOT_I2C_ADAP_COMPLETE(dw_0, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
641 dw_i2c_write, dw_i2c_set_bus_speed,
642 CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 0)
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000643
Stefan Roeseef6073e2014-10-28 12:12:00 +0100644#if CONFIG_SYS_I2C_BUS_MAX >= 2
645U_BOOT_I2C_ADAP_COMPLETE(dw_1, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
646 dw_i2c_write, dw_i2c_set_bus_speed,
647 CONFIG_SYS_I2C_SPEED1, CONFIG_SYS_I2C_SLAVE1, 1)
648#endif
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000649
Stefan Roeseef6073e2014-10-28 12:12:00 +0100650#if CONFIG_SYS_I2C_BUS_MAX >= 3
651U_BOOT_I2C_ADAP_COMPLETE(dw_2, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
652 dw_i2c_write, dw_i2c_set_bus_speed,
653 CONFIG_SYS_I2C_SPEED2, CONFIG_SYS_I2C_SLAVE2, 2)
654#endif
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000655
Stefan Roeseef6073e2014-10-28 12:12:00 +0100656#if CONFIG_SYS_I2C_BUS_MAX >= 4
657U_BOOT_I2C_ADAP_COMPLETE(dw_3, dw_i2c_init, dw_i2c_probe, dw_i2c_read,
658 dw_i2c_write, dw_i2c_set_bus_speed,
659 CONFIG_SYS_I2C_SPEED3, CONFIG_SYS_I2C_SLAVE3, 3)
Armando Visconti4a7b4ec2012-12-06 00:04:15 +0000660#endif
Stefan Roese3cb27962016-04-21 08:19:41 +0200661
662#else /* CONFIG_DM_I2C */
663/* The DM I2C functions */
664
665static int designware_i2c_xfer(struct udevice *bus, struct i2c_msg *msg,
666 int nmsgs)
667{
668 struct dw_i2c *i2c = dev_get_priv(bus);
669 int ret;
670
671 debug("i2c_xfer: %d messages\n", nmsgs);
672 for (; nmsgs > 0; nmsgs--, msg++) {
673 debug("i2c_xfer: chip=0x%x, len=0x%x\n", msg->addr, msg->len);
674 if (msg->flags & I2C_M_RD) {
675 ret = __dw_i2c_read(i2c->regs, msg->addr, 0, 0,
676 msg->buf, msg->len);
677 } else {
678 ret = __dw_i2c_write(i2c->regs, msg->addr, 0, 0,
679 msg->buf, msg->len);
680 }
681 if (ret) {
682 debug("i2c_write: error sending\n");
683 return -EREMOTEIO;
684 }
685 }
686
687 return 0;
688}
689
690static int designware_i2c_set_bus_speed(struct udevice *bus, unsigned int speed)
691{
692 struct dw_i2c *i2c = dev_get_priv(bus);
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800693 ulong rate;
694
695#if CONFIG_IS_ENABLED(CLK)
696 rate = clk_get_rate(&i2c->clk);
697 if (IS_ERR_VALUE(rate))
698 return -EINVAL;
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800699#else
700 rate = IC_CLK;
701#endif
Simon Glassc5294192020-01-23 11:48:25 -0700702 return _dw_i2c_set_bus_speed(i2c, i2c->regs, speed, rate);
Stefan Roese3cb27962016-04-21 08:19:41 +0200703}
704
705static int designware_i2c_probe_chip(struct udevice *bus, uint chip_addr,
706 uint chip_flags)
707{
708 struct dw_i2c *i2c = dev_get_priv(bus);
709 struct i2c_regs *i2c_base = i2c->regs;
710 u32 tmp;
711 int ret;
712
713 /* Try to read the first location of the chip */
714 ret = __dw_i2c_read(i2c_base, chip_addr, 0, 1, (uchar *)&tmp, 1);
715 if (ret)
716 __dw_i2c_init(i2c_base, 0, 0);
717
718 return ret;
719}
720
Simon Glass9e5d1742020-01-23 11:48:11 -0700721int designware_i2c_ofdata_to_platdata(struct udevice *bus)
Stefan Roese3cb27962016-04-21 08:19:41 +0200722{
723 struct dw_i2c *priv = dev_get_priv(bus);
Simon Glass8de5ae82020-01-23 11:48:26 -0700724 int ret;
Stefan Roese3cb27962016-04-21 08:19:41 +0200725
Simon Glass9e5d1742020-01-23 11:48:11 -0700726 if (!priv->regs)
727 priv->regs = (struct i2c_regs *)devfdt_get_addr_ptr(bus);
728 dev_read_u32(bus, "i2c-scl-rising-time-ns", &priv->scl_rise_time_ns);
729 dev_read_u32(bus, "i2c-scl-falling-time-ns", &priv->scl_fall_time_ns);
730 dev_read_u32(bus, "i2c-sda-hold-time-ns", &priv->sda_hold_time_ns);
Simon Glasse2be5532019-12-06 21:41:40 -0700731
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100732 ret = reset_get_bulk(bus, &priv->resets);
Dinh Nguyen08794aa2018-04-04 17:18:24 -0500733 if (ret)
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100734 dev_warn(bus, "Can't get reset: %d\n", ret);
735 else
736 reset_deassert_bulk(&priv->resets);
Dinh Nguyen08794aa2018-04-04 17:18:24 -0500737
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800738#if CONFIG_IS_ENABLED(CLK)
739 ret = clk_get_by_index(bus, 0, &priv->clk);
740 if (ret)
741 return ret;
742
743 ret = clk_enable(&priv->clk);
744 if (ret && ret != -ENOSYS && ret != -ENOTSUPP) {
745 clk_free(&priv->clk);
746 dev_err(bus, "failed to enable clock\n");
747 return ret;
748 }
749#endif
750
Simon Glass8de5ae82020-01-23 11:48:26 -0700751 return 0;
752}
753
754int designware_i2c_probe(struct udevice *bus)
755{
756 struct dw_i2c *priv = dev_get_priv(bus);
757
Simon Glassbd9ca8d2019-02-16 20:24:39 -0700758 return __dw_i2c_init(priv->regs, 0, 0);
Stefan Roese3cb27962016-04-21 08:19:41 +0200759}
760
Simon Glasse2be5532019-12-06 21:41:40 -0700761int designware_i2c_remove(struct udevice *dev)
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100762{
763 struct dw_i2c *priv = dev_get_priv(dev);
764
Ley Foon Tan6e85c812019-06-12 09:48:04 +0800765#if CONFIG_IS_ENABLED(CLK)
766 clk_disable(&priv->clk);
767 clk_free(&priv->clk);
768#endif
769
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100770 return reset_release_bulk(&priv->resets);
771}
772
Simon Glasse2be5532019-12-06 21:41:40 -0700773const struct dm_i2c_ops designware_i2c_ops = {
Stefan Roese3cb27962016-04-21 08:19:41 +0200774 .xfer = designware_i2c_xfer,
775 .probe_chip = designware_i2c_probe_chip,
776 .set_bus_speed = designware_i2c_set_bus_speed,
777};
778
779static const struct udevice_id designware_i2c_ids[] = {
780 { .compatible = "snps,designware-i2c" },
781 { }
782};
783
784U_BOOT_DRIVER(i2c_designware) = {
785 .name = "i2c_designware",
786 .id = UCLASS_I2C,
787 .of_match = designware_i2c_ids,
Simon Glasse2be5532019-12-06 21:41:40 -0700788 .ofdata_to_platdata = designware_i2c_ofdata_to_platdata,
Stefan Roese3cb27962016-04-21 08:19:41 +0200789 .probe = designware_i2c_probe,
790 .priv_auto_alloc_size = sizeof(struct dw_i2c),
Simon Goldschmidt28608a12019-03-28 21:11:48 +0100791 .remove = designware_i2c_remove,
Simon Glasse2be5532019-12-06 21:41:40 -0700792 .flags = DM_FLAG_OS_PREPARE,
Stefan Roese3cb27962016-04-21 08:19:41 +0200793 .ops = &designware_i2c_ops,
794};
795
796#endif /* CONFIG_DM_I2C */