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