drivers/i2c/busses/i2c-designware-platdrv.c

   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.
  21  * ----------------------------------------------------------------------------
  22  *
  23  */
  24 #include <linux/kernel.h>
  25 #include <linux/module.h>
  26 #include <linux/delay.h>
  27 #include <linux/dmi.h>
  28 #include <linux/i2c.h>
  29 #include <linux/clk.h>
  30 #include <linux/clk-provider.h>
  31 #include <linux/errno.h>
  32 #include <linux/sched.h>
  33 #include <linux/err.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/of.h>
  36 #include <linux/platform_device.h>
  37 #include <linux/pm.h>
  38 #include <linux/pm_runtime.h>
  39 #include <linux/property.h>
  40 #include <linux/io.h>
  41 #include <linux/reset.h>
  42 #include <linux/slab.h>
  43 #include <linux/acpi.h>
  44 #include <linux/platform_data/i2c-designware.h>
  45 #include "i2c-designware-core.h"
  46
  47 static u32 i2c_dw_get_clk_rate_khz(struct dw_i2c_dev *dev)
  48 {
  49         return clk_get_rate(dev->clk)/1000;
  50 }
  51
  52 #ifdef CONFIG_ACPI
  53 /*
  54  * The HCNT/LCNT information coming from ACPI should be the most accurate
  55  * for given platform. However, some systems get it wrong. On such systems
  56  * we get better results by calculating those based on the input clock.
  57  */
  58 static const struct dmi_system_id dw_i2c_no_acpi_params[] = {
  59         {
  60                 .ident = "Dell Inspiron 7348",
  61                 .matches = {
  62                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
  63                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 7348"),
  64                 },
  65         },
  66         { }
  67 };
  68
  69 static void dw_i2c_acpi_params(struct platform_device *pdev, char method[],
  70                                u16 *hcnt, u16 *lcnt, u32 *sda_hold)
  71 {
  72         struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
  73         acpi_handle handle = ACPI_HANDLE(&pdev->dev);
  74         union acpi_object *obj;
  75
  76         if (dmi_check_system(dw_i2c_no_acpi_params))
  77                 return;
  78
  79         if (ACPI_FAILURE(acpi_evaluate_object(handle, method, NULL, &buf)))
  80                 return;
  81
  82         obj = (union acpi_object *)buf.pointer;
  83         if (obj->type == ACPI_TYPE_PACKAGE && obj->package.count == 3) {
  84                 const union acpi_object *objs = obj->package.elements;
  85
  86                 *hcnt = (u16)objs[0].integer.value;
  87                 *lcnt = (u16)objs[1].integer.value;
  88                 if (sda_hold)
  89                         *sda_hold = (u32)objs[2].integer.value;
  90         }
  91
  92         kfree(buf.pointer);
  93 }
  94
  95 static int dw_i2c_acpi_configure(struct platform_device *pdev)
  96 {
  97         struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
  98         const struct acpi_device_id *id;
  99
 100         dev->adapter.nr = -1;
 101         dev->tx_fifo_depth = 32;
 102         dev->rx_fifo_depth = 32;
 103
 104         /*
 105          * Try to get SDA hold time and *CNT values from an ACPI method if
 106          * it exists for both supported speed modes.
 107          */
 108         dw_i2c_acpi_params(pdev, "SSCN", &dev->ss_hcnt, &dev->ss_lcnt, NULL);
 109         dw_i2c_acpi_params(pdev, "FMCN", &dev->fs_hcnt, &dev->fs_lcnt,
 110                            &dev->sda_hold_time);
 111         dw_i2c_acpi_params(pdev, "FPCN", &dev->fp_hcnt, &dev->fp_lcnt, NULL);
 112         dw_i2c_acpi_params(pdev, "HSCN", &dev->hs_hcnt, &dev->hs_lcnt, NULL);
 113
 114         id = acpi_match_device(pdev->dev.driver->acpi_match_table, &pdev->dev);
 115         if (id && id->driver_data)
 116                 dev->accessor_flags |= (u32)id->driver_data;
 117
 118         return 0;
 119 }
 120
 121 static const struct acpi_device_id dw_i2c_acpi_match[] = {
 122         { "INT33C2", 0 },
 123         { "INT33C3", 0 },
 124         { "INT3432", 0 },
 125         { "INT3433", 0 },
 126         { "80860F41", 0 },
 127         { "808622C1", 0 },
 128         { "AMD0010", ACCESS_INTR_MASK },
 129         { "AMDI0010", ACCESS_INTR_MASK },
 130         { "AMDI0510", 0 },
 131         { "APMC0D0F", 0 },
 132         { "HISI02A1", 0 },
 133         { "HISI02A2", 0 },
 134         { }
 135 };
 136 MODULE_DEVICE_TABLE(acpi, dw_i2c_acpi_match);
 137 #else
 138 static inline int dw_i2c_acpi_configure(struct platform_device *pdev)
 139 {
 140         return -ENODEV;
 141 }
 142 #endif
 143
 144 static int i2c_dw_plat_prepare_clk(struct dw_i2c_dev *i_dev, bool prepare)
 145 {
 146         if (IS_ERR(i_dev->clk))
 147                 return PTR_ERR(i_dev->clk);
 148
 149         if (prepare)
 150                 return clk_prepare_enable(i_dev->clk);
 151
 152         clk_disable_unprepare(i_dev->clk);
 153         return 0;
 154 }
 155
 156 static void dw_i2c_set_fifo_size(struct dw_i2c_dev *dev, int id)
 157 {
 158         u32 param, tx_fifo_depth, rx_fifo_depth;
 159
 160         /*
 161          * Try to detect the FIFO depth if not set by interface driver,
 162          * the depth could be from 2 to 256 from HW spec.
 163          */
 164         param = i2c_dw_read_comp_param(dev);
 165         tx_fifo_depth = ((param >> 16) & 0xff) + 1;
 166         rx_fifo_depth = ((param >> 8)  & 0xff) + 1;
 167         if (!dev->tx_fifo_depth) {
 168                 dev->tx_fifo_depth = tx_fifo_depth;
 169                 dev->rx_fifo_depth = rx_fifo_depth;
 170                 dev->adapter.nr = id;
 171         } else if (tx_fifo_depth >= 2) {
 172                 dev->tx_fifo_depth = min_t(u32, dev->tx_fifo_depth,
 173                                 tx_fifo_depth);
 174                 dev->rx_fifo_depth = min_t(u32, dev->rx_fifo_depth,
 175                                 rx_fifo_depth);
 176         }
 177 }
 178
 179 static int dw_i2c_plat_probe(struct platform_device *pdev)
 180 {
 181         struct dw_i2c_platform_data *pdata = dev_get_platdata(&pdev->dev);
 182         struct dw_i2c_dev *dev;
 183         struct i2c_adapter *adap;
 184         struct resource *mem;
 185         int irq, r;
 186         u32 acpi_speed, ht = 0;
 187
 188         irq = platform_get_irq(pdev, 0);
 189         if (irq < 0)
 190                 return irq;
 191
 192         dev = devm_kzalloc(&pdev->dev, sizeof(struct dw_i2c_dev), GFP_KERNEL);
 193         if (!dev)
 194                 return -ENOMEM;
 195
 196         mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 197         dev->base = devm_ioremap_resource(&pdev->dev, mem);
 198         if (IS_ERR(dev->base))
 199                 return PTR_ERR(dev->base);
 200
 201         dev->dev = &pdev->dev;
 202         dev->irq = irq;
 203         platform_set_drvdata(pdev, dev);
 204
 205         dev->rst = devm_reset_control_get_optional_exclusive(&pdev->dev, NULL);
 206         if (IS_ERR(dev->rst)) {
 207                 if (PTR_ERR(dev->rst) == -EPROBE_DEFER)
 208                         return -EPROBE_DEFER;
 209         } else {
 210                 reset_control_deassert(dev->rst);
 211         }
 212
 213         if (pdata) {
 214                 dev->clk_freq = pdata->i2c_scl_freq;
 215         } else {
 216                 device_property_read_u32(&pdev->dev, "i2c-sda-hold-time-ns",
 217                                          &ht);
 218                 device_property_read_u32(&pdev->dev, "i2c-sda-falling-time-ns",
 219                                          &dev->sda_falling_time);
 220                 device_property_read_u32(&pdev->dev, "i2c-scl-falling-time-ns",
 221                                          &dev->scl_falling_time);
 222                 device_property_read_u32(&pdev->dev, "clock-frequency",
 223                                          &dev->clk_freq);
 224         }
 225
 226         acpi_speed = i2c_acpi_find_bus_speed(&pdev->dev);
 227         /*
 228          * Find bus speed from the "clock-frequency" device property, ACPI
 229          * or by using fast mode if neither is set.
 230          */
 231         if (acpi_speed && dev->clk_freq)
 232                 dev->clk_freq = min(dev->clk_freq, acpi_speed);
 233         else if (acpi_speed || dev->clk_freq)
 234                 dev->clk_freq = max(dev->clk_freq, acpi_speed);
 235         else
 236                 dev->clk_freq = 400000;
 237
 238         if (has_acpi_companion(&pdev->dev))
 239                 dw_i2c_acpi_configure(pdev);
 240
 241         /*
 242          * Only standard mode at 100kHz, fast mode at 400kHz,
 243          * fast mode plus at 1MHz and high speed mode at 3.4MHz are supported.
 244          */
 245         if (dev->clk_freq != 100000 && dev->clk_freq != 400000
 246             && dev->clk_freq != 1000000 && dev->clk_freq != 3400000) {
 247                 dev_err(&pdev->dev,
 248                         "Only 100kHz, 400kHz, 1MHz and 3.4MHz supported");
 249                 r = -EINVAL;
 250                 goto exit_reset;
 251         }
 252
 253         r = i2c_dw_eval_lock_support(dev);
 254         if (r)
 255                 goto exit_reset;
 256
 257         dev->functionality = I2C_FUNC_10BIT_ADDR | DW_IC_DEFAULT_FUNCTIONALITY;
 258
 259         dev->master_cfg = DW_IC_CON_MASTER | DW_IC_CON_SLAVE_DISABLE |
 260                           DW_IC_CON_RESTART_EN;
 261
 262         switch (dev->clk_freq) {
 263         case 100000:
 264                 dev->master_cfg |= DW_IC_CON_SPEED_STD;
 265                 break;
 266         case 3400000:
 267                 dev->master_cfg |= DW_IC_CON_SPEED_HIGH;
 268                 break;
 269         default:
 270                 dev->master_cfg |= DW_IC_CON_SPEED_FAST;
 271         }
 272
 273         dev->clk = devm_clk_get(&pdev->dev, NULL);
 274         if (!i2c_dw_plat_prepare_clk(dev, true)) {
 275                 dev->get_clk_rate_khz = i2c_dw_get_clk_rate_khz;
 276
 277                 if (!dev->sda_hold_time && ht)
 278                         dev->sda_hold_time = div_u64(
 279                                 (u64)dev->get_clk_rate_khz(dev) * ht + 500000,
 280                                 1000000);
 281         }
 282
 283         dw_i2c_set_fifo_size(dev, pdev->id);
 284
 285         adap = &dev->adapter;
 286         adap->owner = THIS_MODULE;
 287         adap->class = I2C_CLASS_DEPRECATED;
 288         ACPI_COMPANION_SET(&adap->dev, ACPI_COMPANION(&pdev->dev));
 289         adap->dev.of_node = pdev->dev.of_node;
 290
 291         if (dev->pm_runtime_disabled) {
 292                 pm_runtime_forbid(&pdev->dev);
 293         } else {
 294                 pm_runtime_set_autosuspend_delay(&pdev->dev, 1000);
 295                 pm_runtime_use_autosuspend(&pdev->dev);
 296                 pm_runtime_set_active(&pdev->dev);
 297                 pm_runtime_enable(&pdev->dev);
 298         }
 299
 300         r = i2c_dw_probe(dev);
 301         if (r)
 302                 goto exit_probe;
 303
 304         return r;
 305
 306 exit_probe:
 307         if (!dev->pm_runtime_disabled)
 308                 pm_runtime_disable(&pdev->dev);
 309 exit_reset:
 310         if (!IS_ERR_OR_NULL(dev->rst))
 311                 reset_control_assert(dev->rst);
 312         return r;
 313 }
 314
 315 static int dw_i2c_plat_remove(struct platform_device *pdev)
 316 {
 317         struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
 318
 319         pm_runtime_get_sync(&pdev->dev);
 320
 321         i2c_del_adapter(&dev->adapter);
 322
 323         i2c_dw_disable(dev);
 324
 325         pm_runtime_dont_use_autosuspend(&pdev->dev);
 326         pm_runtime_put_sync(&pdev->dev);
 327         if (!dev->pm_runtime_disabled)
 328                 pm_runtime_disable(&pdev->dev);
 329         if (!IS_ERR_OR_NULL(dev->rst))
 330                 reset_control_assert(dev->rst);
 331
 332         return 0;
 333 }
 334
 335 #ifdef CONFIG_OF
 336 static const struct of_device_id dw_i2c_of_match[] = {
 337         { .compatible = "snps,designware-i2c", },
 338         {},
 339 };
 340 MODULE_DEVICE_TABLE(of, dw_i2c_of_match);
 341 #endif
 342
 343 #ifdef CONFIG_PM_SLEEP
 344 static int dw_i2c_plat_prepare(struct device *dev)
 345 {
 346         return pm_runtime_suspended(dev);
 347 }
 348
 349 static void dw_i2c_plat_complete(struct device *dev)
 350 {
 351         if (dev->power.direct_complete)
 352                 pm_request_resume(dev);
 353 }
 354 #else
 355 #define dw_i2c_plat_prepare     NULL
 356 #define dw_i2c_plat_complete    NULL
 357 #endif
 358
 359 #ifdef CONFIG_PM
 360 static int dw_i2c_plat_suspend(struct device *dev)
 361 {
 362         struct platform_device *pdev = to_platform_device(dev);
 363         struct dw_i2c_dev *i_dev = platform_get_drvdata(pdev);
 364
 365         i2c_dw_disable(i_dev);
 366         i2c_dw_plat_prepare_clk(i_dev, false);
 367
 368         return 0;
 369 }
 370
 371 static int dw_i2c_plat_resume(struct device *dev)
 372 {
 373         struct platform_device *pdev = to_platform_device(dev);
 374         struct dw_i2c_dev *i_dev = platform_get_drvdata(pdev);
 375
 376         i2c_dw_plat_prepare_clk(i_dev, true);
 377
 378         if (!i_dev->pm_runtime_disabled)
 379                 i2c_dw_init(i_dev);
 380
 381         return 0;
 382 }
 383
 384 static const struct dev_pm_ops dw_i2c_dev_pm_ops = {
 385         .prepare = dw_i2c_plat_prepare,
 386         .complete = dw_i2c_plat_complete,
 387         SET_SYSTEM_SLEEP_PM_OPS(dw_i2c_plat_suspend, dw_i2c_plat_resume)
 388         SET_RUNTIME_PM_OPS(dw_i2c_plat_suspend, dw_i2c_plat_resume, NULL)
 389 };
 390
 391 #define DW_I2C_DEV_PMOPS (&dw_i2c_dev_pm_ops)
 392 #else
 393 #define DW_I2C_DEV_PMOPS NULL
 394 #endif
 395
 396 /* work with hotplug and coldplug */
 397 MODULE_ALIAS("platform:i2c_designware");
 398
 399 static struct platform_driver dw_i2c_driver = {
 400         .probe = dw_i2c_plat_probe,
 401         .remove = dw_i2c_plat_remove,
 402         .driver         = {
 403                 .name   = "i2c_designware",
 404                 .of_match_table = of_match_ptr(dw_i2c_of_match),
 405                 .acpi_match_table = ACPI_PTR(dw_i2c_acpi_match),
 406                 .pm     = DW_I2C_DEV_PMOPS,
 407         },
 408 };
 409
 410 static int __init dw_i2c_init_driver(void)
 411 {
 412         return platform_driver_register(&dw_i2c_driver);
 413 }
 414 subsys_initcall(dw_i2c_init_driver);
 415
 416 static void __exit dw_i2c_exit_driver(void)
 417 {
 418         platform_driver_unregister(&dw_i2c_driver);
 419 }
 420 module_exit(dw_i2c_exit_driver);
 421
 422 MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>");
 423 MODULE_DESCRIPTION("Synopsys DesignWare I2C bus adapter");
 424 MODULE_LICENSE("GPL");