]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - drivers/i2c/busses/i2c-designware-platdrv.c
Merge branch 'work.xattr' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs
[mirror_ubuntu-hirsute-kernel.git] / drivers / i2c / busses / i2c-designware-platdrv.c
CommitLineData
2373f6b9
DB
1/*
2 * Synopsys DesignWare I2C adapter driver (master only).
3 *
4 * Based on the TI DAVINCI I2C adapter driver.
5 *
6 * Copyright (C) 2006 Texas Instruments.
7 * Copyright (C) 2007 MontaVista Software Inc.
8 * Copyright (C) 2009 Provigent Ltd.
9 *
10 * ----------------------------------------------------------------------------
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
2373f6b9
DB
21 * ----------------------------------------------------------------------------
22 *
23 */
24#include <linux/kernel.h>
25#include <linux/module.h>
26#include <linux/delay.h>
56d4b8a2 27#include <linux/dmi.h>
2373f6b9
DB
28#include <linux/i2c.h>
29#include <linux/clk.h>
a445900c 30#include <linux/clk-provider.h>
2373f6b9
DB
31#include <linux/errno.h>
32#include <linux/sched.h>
33#include <linux/err.h>
34#include <linux/interrupt.h>
9803f868 35#include <linux/of.h>
2373f6b9 36#include <linux/platform_device.h>
3bf3b289 37#include <linux/pm.h>
7272194e 38#include <linux/pm_runtime.h>
2373f6b9
DB
39#include <linux/io.h>
40#include <linux/slab.h>
b61b1415 41#include <linux/acpi.h>
4bcfda09 42#include <linux/platform_data/i2c-designware.h>
2373f6b9
DB
43#include "i2c-designware-core.h"
44
1d31b58f
DB
45static u32 i2c_dw_get_clk_rate_khz(struct dw_i2c_dev *dev)
46{
47 return clk_get_rate(dev->clk)/1000;
48}
2373f6b9 49
b61b1415 50#ifdef CONFIG_ACPI
56d4b8a2
MW
51/*
52 * The HCNT/LCNT information coming from ACPI should be the most accurate
53 * for given platform. However, some systems get it wrong. On such systems
54 * we get better results by calculating those based on the input clock.
55 */
56static const struct dmi_system_id dw_i2c_no_acpi_params[] = {
57 {
58 .ident = "Dell Inspiron 7348",
59 .matches = {
60 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
61 DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 7348"),
62 },
63 },
64 { }
65};
66
57cd1e30
MW
67static void dw_i2c_acpi_params(struct platform_device *pdev, char method[],
68 u16 *hcnt, u16 *lcnt, u32 *sda_hold)
69{
70 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
71 acpi_handle handle = ACPI_HANDLE(&pdev->dev);
72 union acpi_object *obj;
73
56d4b8a2
MW
74 if (dmi_check_system(dw_i2c_no_acpi_params))
75 return;
76
57cd1e30
MW
77 if (ACPI_FAILURE(acpi_evaluate_object(handle, method, NULL, &buf)))
78 return;
79
80 obj = (union acpi_object *)buf.pointer;
81 if (obj->type == ACPI_TYPE_PACKAGE && obj->package.count == 3) {
82 const union acpi_object *objs = obj->package.elements;
83
84 *hcnt = (u16)objs[0].integer.value;
85 *lcnt = (u16)objs[1].integer.value;
86 if (sda_hold)
87 *sda_hold = (u32)objs[2].integer.value;
88 }
89
90 kfree(buf.pointer);
91}
92
b61b1415
MW
93static int dw_i2c_acpi_configure(struct platform_device *pdev)
94{
95 struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
2d244c81 96 const struct acpi_device_id *id;
b61b1415 97
b61b1415 98 dev->adapter.nr = -1;
b61b1415
MW
99 dev->tx_fifo_depth = 32;
100 dev->rx_fifo_depth = 32;
57cd1e30
MW
101
102 /*
103 * Try to get SDA hold time and *CNT values from an ACPI method if
104 * it exists for both supported speed modes.
105 */
0b26c845 106 dw_i2c_acpi_params(pdev, "SSCN", &dev->ss_hcnt, &dev->ss_lcnt, NULL);
57cd1e30 107 dw_i2c_acpi_params(pdev, "FMCN", &dev->fs_hcnt, &dev->fs_lcnt,
0b26c845 108 &dev->sda_hold_time);
57cd1e30 109
2d244c81
XY
110 id = acpi_match_device(pdev->dev.driver->acpi_match_table, &pdev->dev);
111 if (id && id->driver_data)
112 dev->accessor_flags |= (u32)id->driver_data;
113
b61b1415
MW
114 return 0;
115}
116
117static const struct acpi_device_id dw_i2c_acpi_match[] = {
118 { "INT33C2", 0 },
119 { "INT33C3", 0 },
25b3dfc8
MW
120 { "INT3432", 0 },
121 { "INT3433", 0 },
5a7e6bd8 122 { "80860F41", 0 },
0409516a 123 { "808622C1", 0 },
2d244c81 124 { "AMD0010", ACCESS_INTR_MASK },
b61b1415
MW
125 { }
126};
127MODULE_DEVICE_TABLE(acpi, dw_i2c_acpi_match);
128#else
129static inline int dw_i2c_acpi_configure(struct platform_device *pdev)
130{
131 return -ENODEV;
132}
133#endif
134
6ad6fde3 135static int dw_i2c_plat_probe(struct platform_device *pdev)
2373f6b9
DB
136{
137 struct dw_i2c_dev *dev;
138 struct i2c_adapter *adap;
1cb715ca 139 struct resource *mem;
4bcfda09 140 struct dw_i2c_platform_data *pdata;
2373f6b9 141 int irq, r;
925ddb24 142 u32 clk_freq, ht = 0;
2373f6b9 143
2373f6b9 144 irq = platform_get_irq(pdev, 0);
b20d3864
AB
145 if (irq < 0)
146 return irq;
2373f6b9 147
1cb715ca
AS
148 dev = devm_kzalloc(&pdev->dev, sizeof(struct dw_i2c_dev), GFP_KERNEL);
149 if (!dev)
150 return -ENOMEM;
2373f6b9 151
3cc2d009 152 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1cb715ca
AS
153 dev->base = devm_ioremap_resource(&pdev->dev, mem);
154 if (IS_ERR(dev->base))
155 return PTR_ERR(dev->base);
2373f6b9 156
1cb715ca 157 dev->dev = &pdev->dev;
2373f6b9
DB
158 dev->irq = irq;
159 platform_set_drvdata(pdev, dev);
160
8e5f6b2a
RB
161 /* fast mode by default because of legacy reasons */
162 clk_freq = 400000;
163
ca5b74d2 164 if (has_acpi_companion(&pdev->dev)) {
925ddb24
MW
165 dw_i2c_acpi_configure(pdev);
166 } else if (pdev->dev.of_node) {
9803f868
CR
167 of_property_read_u32(pdev->dev.of_node,
168 "i2c-sda-hold-time-ns", &ht);
6468276b
RB
169
170 of_property_read_u32(pdev->dev.of_node,
171 "i2c-sda-falling-time-ns",
172 &dev->sda_falling_time);
173 of_property_read_u32(pdev->dev.of_node,
174 "i2c-scl-falling-time-ns",
175 &dev->scl_falling_time);
8e5f6b2a
RB
176
177 of_property_read_u32(pdev->dev.of_node, "clock-frequency",
178 &clk_freq);
179
180 /* Only standard mode at 100kHz and fast mode at 400kHz
181 * are supported.
182 */
183 if (clk_freq != 100000 && clk_freq != 400000) {
184 dev_err(&pdev->dev, "Only 100kHz and 400kHz supported");
185 return -EINVAL;
186 }
4bcfda09
TR
187 } else {
188 pdata = dev_get_platdata(&pdev->dev);
189 if (pdata)
190 clk_freq = pdata->i2c_scl_freq;
9803f868
CR
191 }
192
894acb2f
DB
193 r = i2c_dw_eval_lock_support(dev);
194 if (r)
195 return r;
196
2fa8326b
DB
197 dev->functionality =
198 I2C_FUNC_I2C |
199 I2C_FUNC_10BIT_ADDR |
200 I2C_FUNC_SMBUS_BYTE |
201 I2C_FUNC_SMBUS_BYTE_DATA |
202 I2C_FUNC_SMBUS_WORD_DATA |
203 I2C_FUNC_SMBUS_I2C_BLOCK;
8e5f6b2a
RB
204 if (clk_freq == 100000)
205 dev->master_cfg = DW_IC_CON_MASTER | DW_IC_CON_SLAVE_DISABLE |
206 DW_IC_CON_RESTART_EN | DW_IC_CON_SPEED_STD;
207 else
208 dev->master_cfg = DW_IC_CON_MASTER | DW_IC_CON_SLAVE_DISABLE |
209 DW_IC_CON_RESTART_EN | DW_IC_CON_SPEED_FAST;
2fa8326b 210
925ddb24
MW
211 dev->clk = devm_clk_get(&pdev->dev, NULL);
212 dev->get_clk_rate_khz = i2c_dw_get_clk_rate_khz;
213 if (IS_ERR(dev->clk))
214 return PTR_ERR(dev->clk);
215 clk_prepare_enable(dev->clk);
216
217 if (!dev->sda_hold_time && ht) {
218 u32 ic_clk = dev->get_clk_rate_khz(dev);
219
220 dev->sda_hold_time = div_u64((u64)ic_clk * ht + 500000,
221 1000000);
222 }
223
224 if (!dev->tx_fifo_depth) {
f3fa9f3d 225 u32 param1 = i2c_dw_read_comp_param(dev);
2373f6b9
DB
226
227 dev->tx_fifo_depth = ((param1 >> 16) & 0xff) + 1;
228 dev->rx_fifo_depth = ((param1 >> 8) & 0xff) + 1;
b61b1415 229 dev->adapter.nr = pdev->id;
2373f6b9 230 }
2373f6b9
DB
231
232 adap = &dev->adapter;
2373f6b9 233 adap->owner = THIS_MODULE;
70fba830 234 adap->class = I2C_CLASS_DEPRECATED;
8eb5c87a 235 ACPI_COMPANION_SET(&adap->dev, ACPI_COMPANION(&pdev->dev));
af71100c 236 adap->dev.of_node = pdev->dev.of_node;
2373f6b9 237
894acb2f
DB
238 if (dev->pm_runtime_disabled) {
239 pm_runtime_forbid(&pdev->dev);
240 } else {
241 pm_runtime_set_autosuspend_delay(&pdev->dev, 1000);
242 pm_runtime_use_autosuspend(&pdev->dev);
243 pm_runtime_set_active(&pdev->dev);
244 pm_runtime_enable(&pdev->dev);
245 }
7272194e 246
d55fc378 247 r = i2c_dw_probe(dev);
e79e72c5 248 if (r && !dev->pm_runtime_disabled)
36d48fb5 249 pm_runtime_disable(&pdev->dev);
36d48fb5 250
e79e72c5 251 return r;
2373f6b9
DB
252}
253
6ad6fde3 254static int dw_i2c_plat_remove(struct platform_device *pdev)
2373f6b9
DB
255{
256 struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
2373f6b9 257
7272194e
MW
258 pm_runtime_get_sync(&pdev->dev);
259
2373f6b9 260 i2c_del_adapter(&dev->adapter);
2373f6b9 261
f3fa9f3d 262 i2c_dw_disable(dev);
2373f6b9 263
edfc3901
MW
264 pm_runtime_dont_use_autosuspend(&pdev->dev);
265 pm_runtime_put_sync(&pdev->dev);
e79e72c5
JN
266 if (!dev->pm_runtime_disabled)
267 pm_runtime_disable(&pdev->dev);
7272194e 268
2373f6b9
DB
269 return 0;
270}
271
af71100c
RH
272#ifdef CONFIG_OF
273static const struct of_device_id dw_i2c_of_match[] = {
274 { .compatible = "snps,designware-i2c", },
275 {},
276};
277MODULE_DEVICE_TABLE(of, dw_i2c_of_match);
278#endif
279
8503ff16 280#ifdef CONFIG_PM_SLEEP
6ad6fde3 281static int dw_i2c_plat_prepare(struct device *dev)
8503ff16
JZ
282{
283 return pm_runtime_suspended(dev);
284}
285
6ad6fde3 286static void dw_i2c_plat_complete(struct device *dev)
8503ff16
JZ
287{
288 if (dev->power.direct_complete)
289 pm_request_resume(dev);
290}
291#else
319d7f05
JN
292#define dw_i2c_plat_prepare NULL
293#define dw_i2c_plat_complete NULL
8503ff16
JZ
294#endif
295
1fc2fe20 296#ifdef CONFIG_PM
6ad6fde3 297static int dw_i2c_plat_suspend(struct device *dev)
3bf3b289
DS
298{
299 struct platform_device *pdev = to_platform_device(dev);
300 struct dw_i2c_dev *i_dev = platform_get_drvdata(pdev);
301
f537295a 302 i2c_dw_disable(i_dev);
e1fac69f 303 clk_disable_unprepare(i_dev->clk);
3bf3b289
DS
304
305 return 0;
306}
307
6ad6fde3 308static int dw_i2c_plat_resume(struct device *dev)
3bf3b289
DS
309{
310 struct platform_device *pdev = to_platform_device(dev);
311 struct dw_i2c_dev *i_dev = platform_get_drvdata(pdev);
312
e1fac69f 313 clk_prepare_enable(i_dev->clk);
894acb2f
DB
314
315 if (!i_dev->pm_runtime_disabled)
316 i2c_dw_init(i_dev);
3bf3b289
DS
317
318 return 0;
319}
3bf3b289 320
8503ff16 321static const struct dev_pm_ops dw_i2c_dev_pm_ops = {
6ad6fde3
JN
322 .prepare = dw_i2c_plat_prepare,
323 .complete = dw_i2c_plat_complete,
324 SET_SYSTEM_SLEEP_PM_OPS(dw_i2c_plat_suspend, dw_i2c_plat_resume)
325 SET_RUNTIME_PM_OPS(dw_i2c_plat_suspend, dw_i2c_plat_resume, NULL)
8503ff16
JZ
326};
327
328#define DW_I2C_DEV_PMOPS (&dw_i2c_dev_pm_ops)
329#else
330#define DW_I2C_DEV_PMOPS NULL
331#endif
1fc2fe20 332
2373f6b9
DB
333/* work with hotplug and coldplug */
334MODULE_ALIAS("platform:i2c_designware");
335
336static struct platform_driver dw_i2c_driver = {
6ad6fde3
JN
337 .probe = dw_i2c_plat_probe,
338 .remove = dw_i2c_plat_remove,
2373f6b9
DB
339 .driver = {
340 .name = "i2c_designware",
af71100c 341 .of_match_table = of_match_ptr(dw_i2c_of_match),
b61b1415 342 .acpi_match_table = ACPI_PTR(dw_i2c_acpi_match),
8503ff16 343 .pm = DW_I2C_DEV_PMOPS,
2373f6b9
DB
344 },
345};
346
347static int __init dw_i2c_init_driver(void)
348{
cccdcea1 349 return platform_driver_register(&dw_i2c_driver);
2373f6b9 350}
10452280 351subsys_initcall(dw_i2c_init_driver);
2373f6b9
DB
352
353static void __exit dw_i2c_exit_driver(void)
354{
355 platform_driver_unregister(&dw_i2c_driver);
356}
357module_exit(dw_i2c_exit_driver);
358
359MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>");
360MODULE_DESCRIPTION("Synopsys DesignWare I2C bus adapter");
361MODULE_LICENSE("GPL");