1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Synopsys DesignWare I2C adapter driver.
4 *
5 * Based on the TI DAVINCI I2C adapter driver.
6 *
7 * Copyright (C) 2006 Texas Instruments.
8 * Copyright (C) 2007 MontaVista Software Inc.
9 * Copyright (C) 2009 Provigent Ltd.
10 */
11 #include <linux/acpi.h>
12 #include <linux/clk-provider.h>
13 #include <linux/clk.h>
14 #include <linux/delay.h>
15 #include <linux/dmi.h>
16 #include <linux/err.h>
17 #include <linux/errno.h>
18 #include <linux/i2c.h>
19 #include <linux/interrupt.h>
20 #include <linux/io.h>
21 #include <linux/kernel.h>
22 #include <linux/mfd/syscon.h>
23 #include <linux/module.h>
24 #include <linux/of.h>
25 #include <linux/platform_device.h>
26 #include <linux/pm.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/property.h>
29 #include <linux/regmap.h>
30 #include <linux/reset.h>
31 #include <linux/sched.h>
32 #include <linux/slab.h>
33 #include <linux/suspend.h>
34 #include <linux/units.h>
35
36 #include "i2c-designware-core.h"
37
i2c_dw_get_clk_rate_khz(struct dw_i2c_dev * dev)38 static u32 i2c_dw_get_clk_rate_khz(struct dw_i2c_dev *dev)
39 {
40 return clk_get_rate(dev->clk) / KILO;
41 }
42
43 #ifdef CONFIG_ACPI
44 static const struct acpi_device_id dw_i2c_acpi_match[] = {
45 { "INT33C2", 0 },
46 { "INT33C3", 0 },
47 { "INT3432", 0 },
48 { "INT3433", 0 },
49 { "80860F41", ACCESS_NO_IRQ_SUSPEND },
50 { "808622C1", ACCESS_NO_IRQ_SUSPEND },
51 { "AMD0010", ACCESS_INTR_MASK },
52 { "AMDI0010", ACCESS_INTR_MASK },
53 { "AMDI0019", ACCESS_INTR_MASK | ARBITRATION_SEMAPHORE },
54 { "AMDI0510", 0 },
55 { "APMC0D0F", 0 },
56 { "HISI02A1", 0 },
57 { "HISI02A2", 0 },
58 { "HISI02A3", 0 },
59 { "HYGO0010", ACCESS_INTR_MASK },
60 { }
61 };
62 MODULE_DEVICE_TABLE(acpi, dw_i2c_acpi_match);
63 #endif
64
65 #ifdef CONFIG_OF
66 #define BT1_I2C_CTL 0x100
67 #define BT1_I2C_CTL_ADDR_MASK GENMASK(7, 0)
68 #define BT1_I2C_CTL_WR BIT(8)
69 #define BT1_I2C_CTL_GO BIT(31)
70 #define BT1_I2C_DI 0x104
71 #define BT1_I2C_DO 0x108
72
bt1_i2c_read(void * context,unsigned int reg,unsigned int * val)73 static int bt1_i2c_read(void *context, unsigned int reg, unsigned int *val)
74 {
75 struct dw_i2c_dev *dev = context;
76 int ret;
77
78 /*
79 * Note these methods shouldn't ever fail because the system controller
80 * registers are memory mapped. We check the return value just in case.
81 */
82 ret = regmap_write(dev->sysmap, BT1_I2C_CTL,
83 BT1_I2C_CTL_GO | (reg & BT1_I2C_CTL_ADDR_MASK));
84 if (ret)
85 return ret;
86
87 return regmap_read(dev->sysmap, BT1_I2C_DO, val);
88 }
89
bt1_i2c_write(void * context,unsigned int reg,unsigned int val)90 static int bt1_i2c_write(void *context, unsigned int reg, unsigned int val)
91 {
92 struct dw_i2c_dev *dev = context;
93 int ret;
94
95 ret = regmap_write(dev->sysmap, BT1_I2C_DI, val);
96 if (ret)
97 return ret;
98
99 return regmap_write(dev->sysmap, BT1_I2C_CTL,
100 BT1_I2C_CTL_GO | BT1_I2C_CTL_WR | (reg & BT1_I2C_CTL_ADDR_MASK));
101 }
102
103 static struct regmap_config bt1_i2c_cfg = {
104 .reg_bits = 32,
105 .val_bits = 32,
106 .reg_stride = 4,
107 .fast_io = true,
108 .reg_read = bt1_i2c_read,
109 .reg_write = bt1_i2c_write,
110 .max_register = DW_IC_COMP_TYPE,
111 };
112
bt1_i2c_request_regs(struct dw_i2c_dev * dev)113 static int bt1_i2c_request_regs(struct dw_i2c_dev *dev)
114 {
115 dev->sysmap = syscon_node_to_regmap(dev->dev->of_node->parent);
116 if (IS_ERR(dev->sysmap))
117 return PTR_ERR(dev->sysmap);
118
119 dev->map = devm_regmap_init(dev->dev, NULL, dev, &bt1_i2c_cfg);
120 return PTR_ERR_OR_ZERO(dev->map);
121 }
122
123 #define MSCC_ICPU_CFG_TWI_DELAY 0x0
124 #define MSCC_ICPU_CFG_TWI_DELAY_ENABLE BIT(0)
125 #define MSCC_ICPU_CFG_TWI_SPIKE_FILTER 0x4
126
mscc_twi_set_sda_hold_time(struct dw_i2c_dev * dev)127 static int mscc_twi_set_sda_hold_time(struct dw_i2c_dev *dev)
128 {
129 writel((dev->sda_hold_time << 1) | MSCC_ICPU_CFG_TWI_DELAY_ENABLE,
130 dev->ext + MSCC_ICPU_CFG_TWI_DELAY);
131
132 return 0;
133 }
134
dw_i2c_of_configure(struct platform_device * pdev)135 static int dw_i2c_of_configure(struct platform_device *pdev)
136 {
137 struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
138
139 switch (dev->flags & MODEL_MASK) {
140 case MODEL_MSCC_OCELOT:
141 dev->ext = devm_platform_ioremap_resource(pdev, 1);
142 if (!IS_ERR(dev->ext))
143 dev->set_sda_hold_time = mscc_twi_set_sda_hold_time;
144 break;
145 default:
146 break;
147 }
148
149 return 0;
150 }
151
152 static const struct of_device_id dw_i2c_of_match[] = {
153 { .compatible = "snps,designware-i2c", },
154 { .compatible = "mscc,ocelot-i2c", .data = (void *)MODEL_MSCC_OCELOT },
155 { .compatible = "baikal,bt1-sys-i2c", .data = (void *)MODEL_BAIKAL_BT1 },
156 {},
157 };
158 MODULE_DEVICE_TABLE(of, dw_i2c_of_match);
159 #else
bt1_i2c_request_regs(struct dw_i2c_dev * dev)160 static int bt1_i2c_request_regs(struct dw_i2c_dev *dev)
161 {
162 return -ENODEV;
163 }
164
dw_i2c_of_configure(struct platform_device * pdev)165 static inline int dw_i2c_of_configure(struct platform_device *pdev)
166 {
167 return -ENODEV;
168 }
169 #endif
170
txgbe_i2c_request_regs(struct dw_i2c_dev * dev)171 static int txgbe_i2c_request_regs(struct dw_i2c_dev *dev)
172 {
173 dev->map = dev_get_regmap(dev->dev->parent, NULL);
174 if (!dev->map)
175 return -ENODEV;
176
177 return 0;
178 }
179
dw_i2c_plat_pm_cleanup(struct dw_i2c_dev * dev)180 static void dw_i2c_plat_pm_cleanup(struct dw_i2c_dev *dev)
181 {
182 pm_runtime_disable(dev->dev);
183
184 if (dev->shared_with_punit)
185 pm_runtime_put_noidle(dev->dev);
186 }
187
dw_i2c_plat_request_regs(struct dw_i2c_dev * dev)188 static int dw_i2c_plat_request_regs(struct dw_i2c_dev *dev)
189 {
190 struct platform_device *pdev = to_platform_device(dev->dev);
191 int ret;
192
193 switch (dev->flags & MODEL_MASK) {
194 case MODEL_BAIKAL_BT1:
195 ret = bt1_i2c_request_regs(dev);
196 break;
197 case MODEL_WANGXUN_SP:
198 ret = txgbe_i2c_request_regs(dev);
199 break;
200 default:
201 dev->base = devm_platform_ioremap_resource(pdev, 0);
202 ret = PTR_ERR_OR_ZERO(dev->base);
203 break;
204 }
205
206 return ret;
207 }
208
209 static const struct dmi_system_id dw_i2c_hwmon_class_dmi[] = {
210 {
211 .ident = "Qtechnology QT5222",
212 .matches = {
213 DMI_MATCH(DMI_SYS_VENDOR, "Qtechnology"),
214 DMI_MATCH(DMI_PRODUCT_NAME, "QT5222"),
215 },
216 },
217 { } /* terminate list */
218 };
219
220 static const struct i2c_dw_semaphore_callbacks i2c_dw_semaphore_cb_table[] = {
221 #ifdef CONFIG_I2C_DESIGNWARE_BAYTRAIL
222 {
223 .probe = i2c_dw_baytrail_probe_lock_support,
224 },
225 #endif
226 #ifdef CONFIG_I2C_DESIGNWARE_AMDPSP
227 {
228 .probe = i2c_dw_amdpsp_probe_lock_support,
229 },
230 #endif
231 {}
232 };
233
i2c_dw_probe_lock_support(struct dw_i2c_dev * dev)234 static int i2c_dw_probe_lock_support(struct dw_i2c_dev *dev)
235 {
236 const struct i2c_dw_semaphore_callbacks *ptr;
237 int i = 0;
238 int ret;
239
240 ptr = i2c_dw_semaphore_cb_table;
241
242 dev->semaphore_idx = -1;
243
244 while (ptr->probe) {
245 ret = ptr->probe(dev);
246 if (ret) {
247 /*
248 * If there is no semaphore device attached to this
249 * controller, we shouldn't abort general i2c_controller
250 * probe.
251 */
252 if (ret != -ENODEV)
253 return ret;
254
255 i++;
256 ptr++;
257 continue;
258 }
259
260 dev->semaphore_idx = i;
261 break;
262 }
263
264 return 0;
265 }
266
i2c_dw_remove_lock_support(struct dw_i2c_dev * dev)267 static void i2c_dw_remove_lock_support(struct dw_i2c_dev *dev)
268 {
269 if (dev->semaphore_idx < 0)
270 return;
271
272 if (i2c_dw_semaphore_cb_table[dev->semaphore_idx].remove)
273 i2c_dw_semaphore_cb_table[dev->semaphore_idx].remove(dev);
274 }
275
dw_i2c_plat_probe(struct platform_device * pdev)276 static int dw_i2c_plat_probe(struct platform_device *pdev)
277 {
278 struct device *device = &pdev->dev;
279 struct i2c_adapter *adap;
280 struct dw_i2c_dev *dev;
281 struct i2c_timings *t;
282 int irq, ret;
283
284 irq = platform_get_irq(pdev, 0);
285 if (irq < 0)
286 return irq;
287
288 dev = devm_kzalloc(device, sizeof(*dev), GFP_KERNEL);
289 if (!dev)
290 return -ENOMEM;
291
292 dev->flags = (uintptr_t)device_get_match_data(device);
293 if (device_property_present(device, "wx,i2c-snps-model"))
294 dev->flags = MODEL_WANGXUN_SP | ACCESS_POLLING;
295
296 dev->dev = device;
297 dev->irq = irq;
298 platform_set_drvdata(pdev, dev);
299
300 ret = dw_i2c_plat_request_regs(dev);
301 if (ret)
302 return ret;
303
304 dev->rst = devm_reset_control_get_optional_exclusive(device, NULL);
305 if (IS_ERR(dev->rst))
306 return PTR_ERR(dev->rst);
307
308 reset_control_deassert(dev->rst);
309
310 t = &dev->timings;
311 i2c_parse_fw_timings(&pdev->dev, t, false);
312
313 i2c_dw_adjust_bus_speed(dev);
314
315 if (pdev->dev.of_node)
316 dw_i2c_of_configure(pdev);
317
318 if (has_acpi_companion(&pdev->dev))
319 i2c_dw_acpi_configure(&pdev->dev);
320
321 ret = i2c_dw_validate_speed(dev);
322 if (ret)
323 goto exit_reset;
324
325 ret = i2c_dw_probe_lock_support(dev);
326 if (ret)
327 goto exit_reset;
328
329 i2c_dw_configure(dev);
330
331 /* Optional interface clock */
332 dev->pclk = devm_clk_get_optional(device, "pclk");
333 if (IS_ERR(dev->pclk)) {
334 ret = PTR_ERR(dev->pclk);
335 goto exit_reset;
336 }
337
338 dev->clk = devm_clk_get_optional(device, NULL);
339 if (IS_ERR(dev->clk)) {
340 ret = PTR_ERR(dev->clk);
341 goto exit_reset;
342 }
343
344 ret = i2c_dw_prepare_clk(dev, true);
345 if (ret)
346 goto exit_reset;
347
348 if (dev->clk) {
349 u64 clk_khz;
350
351 dev->get_clk_rate_khz = i2c_dw_get_clk_rate_khz;
352 clk_khz = dev->get_clk_rate_khz(dev);
353
354 if (!dev->sda_hold_time && t->sda_hold_ns)
355 dev->sda_hold_time =
356 DIV_S64_ROUND_CLOSEST(clk_khz * t->sda_hold_ns, MICRO);
357 }
358
359 adap = &dev->adapter;
360 adap->owner = THIS_MODULE;
361 adap->class = dmi_check_system(dw_i2c_hwmon_class_dmi) ?
362 I2C_CLASS_HWMON : I2C_CLASS_DEPRECATED;
363 ACPI_COMPANION_SET(&adap->dev, ACPI_COMPANION(&pdev->dev));
364 adap->dev.of_node = pdev->dev.of_node;
365 adap->nr = -1;
366
367 if (dev->flags & ACCESS_NO_IRQ_SUSPEND)
368 dev_pm_set_driver_flags(device, DPM_FLAG_SMART_PREPARE);
369 else
370 dev_pm_set_driver_flags(device, DPM_FLAG_SMART_PREPARE | DPM_FLAG_SMART_SUSPEND);
371
372 device_enable_async_suspend(device);
373
374 /* The code below assumes runtime PM to be disabled. */
375 WARN_ON(pm_runtime_enabled(device));
376
377 pm_runtime_set_autosuspend_delay(device, 1000);
378 pm_runtime_use_autosuspend(device);
379 pm_runtime_set_active(device);
380
381 if (dev->shared_with_punit)
382 pm_runtime_get_noresume(device);
383
384 pm_runtime_enable(device);
385
386 ret = i2c_dw_probe(dev);
387 if (ret)
388 goto exit_probe;
389
390 return ret;
391
392 exit_probe:
393 dw_i2c_plat_pm_cleanup(dev);
394 exit_reset:
395 reset_control_assert(dev->rst);
396 return ret;
397 }
398
dw_i2c_plat_remove(struct platform_device * pdev)399 static void dw_i2c_plat_remove(struct platform_device *pdev)
400 {
401 struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
402 struct device *device = &pdev->dev;
403
404 pm_runtime_get_sync(device);
405
406 i2c_del_adapter(&dev->adapter);
407
408 i2c_dw_disable(dev);
409
410 pm_runtime_dont_use_autosuspend(device);
411 pm_runtime_put_sync(device);
412 dw_i2c_plat_pm_cleanup(dev);
413
414 i2c_dw_remove_lock_support(dev);
415
416 reset_control_assert(dev->rst);
417 }
418
dw_i2c_plat_prepare(struct device * dev)419 static int dw_i2c_plat_prepare(struct device *dev)
420 {
421 /*
422 * If the ACPI companion device object is present for this device, it
423 * may be accessed during suspend and resume of other devices via I2C
424 * operation regions, so tell the PM core and middle layers to avoid
425 * skipping system suspend/resume callbacks for it in that case.
426 */
427 return !has_acpi_companion(dev);
428 }
429
dw_i2c_plat_runtime_suspend(struct device * dev)430 static int dw_i2c_plat_runtime_suspend(struct device *dev)
431 {
432 struct dw_i2c_dev *i_dev = dev_get_drvdata(dev);
433
434 if (i_dev->shared_with_punit)
435 return 0;
436
437 i2c_dw_disable(i_dev);
438 i2c_dw_prepare_clk(i_dev, false);
439
440 return 0;
441 }
442
dw_i2c_plat_suspend(struct device * dev)443 static int dw_i2c_plat_suspend(struct device *dev)
444 {
445 struct dw_i2c_dev *i_dev = dev_get_drvdata(dev);
446
447 i2c_mark_adapter_suspended(&i_dev->adapter);
448
449 return dw_i2c_plat_runtime_suspend(dev);
450 }
451
dw_i2c_plat_runtime_resume(struct device * dev)452 static int dw_i2c_plat_runtime_resume(struct device *dev)
453 {
454 struct dw_i2c_dev *i_dev = dev_get_drvdata(dev);
455
456 if (!i_dev->shared_with_punit)
457 i2c_dw_prepare_clk(i_dev, true);
458
459 i_dev->init(i_dev);
460
461 return 0;
462 }
463
dw_i2c_plat_resume(struct device * dev)464 static int dw_i2c_plat_resume(struct device *dev)
465 {
466 struct dw_i2c_dev *i_dev = dev_get_drvdata(dev);
467
468 dw_i2c_plat_runtime_resume(dev);
469 i2c_mark_adapter_resumed(&i_dev->adapter);
470
471 return 0;
472 }
473
474 static const struct dev_pm_ops dw_i2c_dev_pm_ops = {
475 .prepare = pm_sleep_ptr(dw_i2c_plat_prepare),
476 LATE_SYSTEM_SLEEP_PM_OPS(dw_i2c_plat_suspend, dw_i2c_plat_resume)
477 RUNTIME_PM_OPS(dw_i2c_plat_runtime_suspend, dw_i2c_plat_runtime_resume, NULL)
478 };
479
480 /* Work with hotplug and coldplug */
481 MODULE_ALIAS("platform:i2c_designware");
482
483 static struct platform_driver dw_i2c_driver = {
484 .probe = dw_i2c_plat_probe,
485 .remove_new = dw_i2c_plat_remove,
486 .driver = {
487 .name = "i2c_designware",
488 .of_match_table = of_match_ptr(dw_i2c_of_match),
489 .acpi_match_table = ACPI_PTR(dw_i2c_acpi_match),
490 .pm = pm_ptr(&dw_i2c_dev_pm_ops),
491 },
492 };
493
dw_i2c_init_driver(void)494 static int __init dw_i2c_init_driver(void)
495 {
496 return platform_driver_register(&dw_i2c_driver);
497 }
498 subsys_initcall(dw_i2c_init_driver);
499
dw_i2c_exit_driver(void)500 static void __exit dw_i2c_exit_driver(void)
501 {
502 platform_driver_unregister(&dw_i2c_driver);
503 }
504 module_exit(dw_i2c_exit_driver);
505
506 MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>");
507 MODULE_DESCRIPTION("Synopsys DesignWare I2C bus adapter");
508 MODULE_LICENSE("GPL");
509