12373f6b9SDirk Brandewie /* 22373f6b9SDirk Brandewie * Synopsys DesignWare I2C adapter driver (master only). 32373f6b9SDirk Brandewie * 42373f6b9SDirk Brandewie * Based on the TI DAVINCI I2C adapter driver. 52373f6b9SDirk Brandewie * 62373f6b9SDirk Brandewie * Copyright (C) 2006 Texas Instruments. 72373f6b9SDirk Brandewie * Copyright (C) 2007 MontaVista Software Inc. 82373f6b9SDirk Brandewie * Copyright (C) 2009 Provigent Ltd. 92373f6b9SDirk Brandewie * 102373f6b9SDirk Brandewie * ---------------------------------------------------------------------------- 112373f6b9SDirk Brandewie * 122373f6b9SDirk Brandewie * This program is free software; you can redistribute it and/or modify 132373f6b9SDirk Brandewie * it under the terms of the GNU General Public License as published by 142373f6b9SDirk Brandewie * the Free Software Foundation; either version 2 of the License, or 152373f6b9SDirk Brandewie * (at your option) any later version. 162373f6b9SDirk Brandewie * 172373f6b9SDirk Brandewie * This program is distributed in the hope that it will be useful, 182373f6b9SDirk Brandewie * but WITHOUT ANY WARRANTY; without even the implied warranty of 192373f6b9SDirk Brandewie * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 202373f6b9SDirk Brandewie * GNU General Public License for more details. 212373f6b9SDirk Brandewie * ---------------------------------------------------------------------------- 222373f6b9SDirk Brandewie * 232373f6b9SDirk Brandewie */ 242373f6b9SDirk Brandewie #include <linux/kernel.h> 252373f6b9SDirk Brandewie #include <linux/module.h> 262373f6b9SDirk Brandewie #include <linux/delay.h> 272373f6b9SDirk Brandewie #include <linux/i2c.h> 282373f6b9SDirk Brandewie #include <linux/clk.h> 29a445900cSCarl Peng #include <linux/clk-provider.h> 302373f6b9SDirk Brandewie #include <linux/errno.h> 312373f6b9SDirk Brandewie #include <linux/sched.h> 322373f6b9SDirk Brandewie #include <linux/err.h> 332373f6b9SDirk Brandewie #include <linux/interrupt.h> 349803f868SChristian Ruppert #include <linux/of.h> 352373f6b9SDirk Brandewie #include <linux/platform_device.h> 363bf3b289SDeepak Sikri #include <linux/pm.h> 377272194eSMika Westerberg #include <linux/pm_runtime.h> 382373f6b9SDirk Brandewie #include <linux/io.h> 392373f6b9SDirk Brandewie #include <linux/slab.h> 40b61b1415SMika Westerberg #include <linux/acpi.h> 414bcfda09STan, Raymond #include <linux/platform_data/i2c-designware.h> 422373f6b9SDirk Brandewie #include "i2c-designware-core.h" 432373f6b9SDirk Brandewie 441d31b58fSDirk Brandewie static u32 i2c_dw_get_clk_rate_khz(struct dw_i2c_dev *dev) 451d31b58fSDirk Brandewie { 461d31b58fSDirk Brandewie return clk_get_rate(dev->clk)/1000; 471d31b58fSDirk Brandewie } 482373f6b9SDirk Brandewie 49b61b1415SMika Westerberg #ifdef CONFIG_ACPI 5057cd1e30SMika Westerberg static void dw_i2c_acpi_params(struct platform_device *pdev, char method[], 5157cd1e30SMika Westerberg u16 *hcnt, u16 *lcnt, u32 *sda_hold) 5257cd1e30SMika Westerberg { 5357cd1e30SMika Westerberg struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER }; 5457cd1e30SMika Westerberg acpi_handle handle = ACPI_HANDLE(&pdev->dev); 5557cd1e30SMika Westerberg union acpi_object *obj; 5657cd1e30SMika Westerberg 5757cd1e30SMika Westerberg if (ACPI_FAILURE(acpi_evaluate_object(handle, method, NULL, &buf))) 5857cd1e30SMika Westerberg return; 5957cd1e30SMika Westerberg 6057cd1e30SMika Westerberg obj = (union acpi_object *)buf.pointer; 6157cd1e30SMika Westerberg if (obj->type == ACPI_TYPE_PACKAGE && obj->package.count == 3) { 6257cd1e30SMika Westerberg const union acpi_object *objs = obj->package.elements; 6357cd1e30SMika Westerberg 6457cd1e30SMika Westerberg *hcnt = (u16)objs[0].integer.value; 6557cd1e30SMika Westerberg *lcnt = (u16)objs[1].integer.value; 6657cd1e30SMika Westerberg if (sda_hold) 6757cd1e30SMika Westerberg *sda_hold = (u32)objs[2].integer.value; 6857cd1e30SMika Westerberg } 6957cd1e30SMika Westerberg 7057cd1e30SMika Westerberg kfree(buf.pointer); 7157cd1e30SMika Westerberg } 7257cd1e30SMika Westerberg 73b61b1415SMika Westerberg static int dw_i2c_acpi_configure(struct platform_device *pdev) 74b61b1415SMika Westerberg { 75b61b1415SMika Westerberg struct dw_i2c_dev *dev = platform_get_drvdata(pdev); 76b61b1415SMika Westerberg 77b61b1415SMika Westerberg dev->adapter.nr = -1; 78b61b1415SMika Westerberg dev->tx_fifo_depth = 32; 79b61b1415SMika Westerberg dev->rx_fifo_depth = 32; 8057cd1e30SMika Westerberg 8157cd1e30SMika Westerberg /* 8257cd1e30SMika Westerberg * Try to get SDA hold time and *CNT values from an ACPI method if 8357cd1e30SMika Westerberg * it exists for both supported speed modes. 8457cd1e30SMika Westerberg */ 850b26c845SMika Westerberg dw_i2c_acpi_params(pdev, "SSCN", &dev->ss_hcnt, &dev->ss_lcnt, NULL); 8657cd1e30SMika Westerberg dw_i2c_acpi_params(pdev, "FMCN", &dev->fs_hcnt, &dev->fs_lcnt, 870b26c845SMika Westerberg &dev->sda_hold_time); 8857cd1e30SMika Westerberg 89b61b1415SMika Westerberg return 0; 90b61b1415SMika Westerberg } 91b61b1415SMika Westerberg 92b61b1415SMika Westerberg static const struct acpi_device_id dw_i2c_acpi_match[] = { 93b61b1415SMika Westerberg { "INT33C2", 0 }, 94b61b1415SMika Westerberg { "INT33C3", 0 }, 9525b3dfc8SMika Westerberg { "INT3432", 0 }, 9625b3dfc8SMika Westerberg { "INT3433", 0 }, 975a7e6bd8SMika Westerberg { "80860F41", 0 }, 980409516aSAlan Cox { "808622C1", 0 }, 993eddad96SKen Xue { "AMD0010", 0 }, 100b61b1415SMika Westerberg { } 101b61b1415SMika Westerberg }; 102b61b1415SMika Westerberg MODULE_DEVICE_TABLE(acpi, dw_i2c_acpi_match); 103b61b1415SMika Westerberg #else 104b61b1415SMika Westerberg static inline int dw_i2c_acpi_configure(struct platform_device *pdev) 105b61b1415SMika Westerberg { 106b61b1415SMika Westerberg return -ENODEV; 107b61b1415SMika Westerberg } 108b61b1415SMika Westerberg #endif 109b61b1415SMika Westerberg 1106ad6fde3SJarkko Nikula static int dw_i2c_plat_probe(struct platform_device *pdev) 1112373f6b9SDirk Brandewie { 1122373f6b9SDirk Brandewie struct dw_i2c_dev *dev; 1132373f6b9SDirk Brandewie struct i2c_adapter *adap; 1141cb715caSAndy Shevchenko struct resource *mem; 1154bcfda09STan, Raymond struct dw_i2c_platform_data *pdata; 1162373f6b9SDirk Brandewie int irq, r; 117925ddb24SMika Westerberg u32 clk_freq, ht = 0; 1182373f6b9SDirk Brandewie 1192373f6b9SDirk Brandewie irq = platform_get_irq(pdev, 0); 120b20d3864SAlexey Brodkin if (irq < 0) 121b20d3864SAlexey Brodkin return irq; 1222373f6b9SDirk Brandewie 1231cb715caSAndy Shevchenko dev = devm_kzalloc(&pdev->dev, sizeof(struct dw_i2c_dev), GFP_KERNEL); 1241cb715caSAndy Shevchenko if (!dev) 1251cb715caSAndy Shevchenko return -ENOMEM; 1262373f6b9SDirk Brandewie 1273cc2d009SWolfram Sang mem = platform_get_resource(pdev, IORESOURCE_MEM, 0); 1281cb715caSAndy Shevchenko dev->base = devm_ioremap_resource(&pdev->dev, mem); 1291cb715caSAndy Shevchenko if (IS_ERR(dev->base)) 1301cb715caSAndy Shevchenko return PTR_ERR(dev->base); 1312373f6b9SDirk Brandewie 1321cb715caSAndy Shevchenko dev->dev = &pdev->dev; 1332373f6b9SDirk Brandewie dev->irq = irq; 1342373f6b9SDirk Brandewie platform_set_drvdata(pdev, dev); 1352373f6b9SDirk Brandewie 1368e5f6b2aSRomain Baeriswyl /* fast mode by default because of legacy reasons */ 1378e5f6b2aSRomain Baeriswyl clk_freq = 400000; 1388e5f6b2aSRomain Baeriswyl 139ca5b74d2SRafael J. Wysocki if (has_acpi_companion(&pdev->dev)) { 140925ddb24SMika Westerberg dw_i2c_acpi_configure(pdev); 141925ddb24SMika Westerberg } else if (pdev->dev.of_node) { 1429803f868SChristian Ruppert of_property_read_u32(pdev->dev.of_node, 1439803f868SChristian Ruppert "i2c-sda-hold-time-ns", &ht); 1446468276bSRomain Baeriswyl 1456468276bSRomain Baeriswyl of_property_read_u32(pdev->dev.of_node, 1466468276bSRomain Baeriswyl "i2c-sda-falling-time-ns", 1476468276bSRomain Baeriswyl &dev->sda_falling_time); 1486468276bSRomain Baeriswyl of_property_read_u32(pdev->dev.of_node, 1496468276bSRomain Baeriswyl "i2c-scl-falling-time-ns", 1506468276bSRomain Baeriswyl &dev->scl_falling_time); 1518e5f6b2aSRomain Baeriswyl 1528e5f6b2aSRomain Baeriswyl of_property_read_u32(pdev->dev.of_node, "clock-frequency", 1538e5f6b2aSRomain Baeriswyl &clk_freq); 1548e5f6b2aSRomain Baeriswyl 1558e5f6b2aSRomain Baeriswyl /* Only standard mode at 100kHz and fast mode at 400kHz 1568e5f6b2aSRomain Baeriswyl * are supported. 1578e5f6b2aSRomain Baeriswyl */ 1588e5f6b2aSRomain Baeriswyl if (clk_freq != 100000 && clk_freq != 400000) { 1598e5f6b2aSRomain Baeriswyl dev_err(&pdev->dev, "Only 100kHz and 400kHz supported"); 1608e5f6b2aSRomain Baeriswyl return -EINVAL; 1618e5f6b2aSRomain Baeriswyl } 1624bcfda09STan, Raymond } else { 1634bcfda09STan, Raymond pdata = dev_get_platdata(&pdev->dev); 1644bcfda09STan, Raymond if (pdata) 1654bcfda09STan, Raymond clk_freq = pdata->i2c_scl_freq; 1669803f868SChristian Ruppert } 1679803f868SChristian Ruppert 168894acb2fSDavid Box r = i2c_dw_eval_lock_support(dev); 169894acb2fSDavid Box if (r) 170894acb2fSDavid Box return r; 171894acb2fSDavid Box 1722fa8326bSDirk Brandewie dev->functionality = 1732fa8326bSDirk Brandewie I2C_FUNC_I2C | 1742fa8326bSDirk Brandewie I2C_FUNC_10BIT_ADDR | 1752fa8326bSDirk Brandewie I2C_FUNC_SMBUS_BYTE | 1762fa8326bSDirk Brandewie I2C_FUNC_SMBUS_BYTE_DATA | 1772fa8326bSDirk Brandewie I2C_FUNC_SMBUS_WORD_DATA | 1782fa8326bSDirk Brandewie I2C_FUNC_SMBUS_I2C_BLOCK; 1798e5f6b2aSRomain Baeriswyl if (clk_freq == 100000) 1808e5f6b2aSRomain Baeriswyl dev->master_cfg = DW_IC_CON_MASTER | DW_IC_CON_SLAVE_DISABLE | 1818e5f6b2aSRomain Baeriswyl DW_IC_CON_RESTART_EN | DW_IC_CON_SPEED_STD; 1828e5f6b2aSRomain Baeriswyl else 183e18563fcSDirk Brandewie dev->master_cfg = DW_IC_CON_MASTER | DW_IC_CON_SLAVE_DISABLE | 184e18563fcSDirk Brandewie DW_IC_CON_RESTART_EN | DW_IC_CON_SPEED_FAST; 1852fa8326bSDirk Brandewie 186925ddb24SMika Westerberg dev->clk = devm_clk_get(&pdev->dev, NULL); 187925ddb24SMika Westerberg dev->get_clk_rate_khz = i2c_dw_get_clk_rate_khz; 188925ddb24SMika Westerberg if (IS_ERR(dev->clk)) 189925ddb24SMika Westerberg return PTR_ERR(dev->clk); 190925ddb24SMika Westerberg clk_prepare_enable(dev->clk); 191925ddb24SMika Westerberg 192925ddb24SMika Westerberg if (!dev->sda_hold_time && ht) { 193925ddb24SMika Westerberg u32 ic_clk = dev->get_clk_rate_khz(dev); 194925ddb24SMika Westerberg 195925ddb24SMika Westerberg dev->sda_hold_time = div_u64((u64)ic_clk * ht + 500000, 196925ddb24SMika Westerberg 1000000); 197925ddb24SMika Westerberg } 198925ddb24SMika Westerberg 199925ddb24SMika Westerberg if (!dev->tx_fifo_depth) { 200f3fa9f3dSDirk Brandewie u32 param1 = i2c_dw_read_comp_param(dev); 2012373f6b9SDirk Brandewie 2022373f6b9SDirk Brandewie dev->tx_fifo_depth = ((param1 >> 16) & 0xff) + 1; 2032373f6b9SDirk Brandewie dev->rx_fifo_depth = ((param1 >> 8) & 0xff) + 1; 204b61b1415SMika Westerberg dev->adapter.nr = pdev->id; 2052373f6b9SDirk Brandewie } 2062373f6b9SDirk Brandewie 2072373f6b9SDirk Brandewie adap = &dev->adapter; 2082373f6b9SDirk Brandewie adap->owner = THIS_MODULE; 20970fba830SWolfram Sang adap->class = I2C_CLASS_DEPRECATED; 210af71100cSRob Herring adap->dev.of_node = pdev->dev.of_node; 2112373f6b9SDirk Brandewie 212d80d1341SJarkko Nikula r = i2c_dw_probe(dev); 213d80d1341SJarkko Nikula if (r) 2141cb715caSAndy Shevchenko return r; 2152373f6b9SDirk Brandewie 216894acb2fSDavid Box if (dev->pm_runtime_disabled) { 217894acb2fSDavid Box pm_runtime_forbid(&pdev->dev); 218894acb2fSDavid Box } else { 21943452335SMika Westerberg pm_runtime_set_autosuspend_delay(&pdev->dev, 1000); 22043452335SMika Westerberg pm_runtime_use_autosuspend(&pdev->dev); 2217272194eSMika Westerberg pm_runtime_set_active(&pdev->dev); 2227272194eSMika Westerberg pm_runtime_enable(&pdev->dev); 223894acb2fSDavid Box } 2247272194eSMika Westerberg 2252373f6b9SDirk Brandewie return 0; 2262373f6b9SDirk Brandewie } 2272373f6b9SDirk Brandewie 2286ad6fde3SJarkko Nikula static int dw_i2c_plat_remove(struct platform_device *pdev) 2292373f6b9SDirk Brandewie { 2302373f6b9SDirk Brandewie struct dw_i2c_dev *dev = platform_get_drvdata(pdev); 2312373f6b9SDirk Brandewie 2327272194eSMika Westerberg pm_runtime_get_sync(&pdev->dev); 2337272194eSMika Westerberg 2342373f6b9SDirk Brandewie i2c_del_adapter(&dev->adapter); 2352373f6b9SDirk Brandewie 236f3fa9f3dSDirk Brandewie i2c_dw_disable(dev); 2372373f6b9SDirk Brandewie 238edfc3901SMika Westerberg pm_runtime_dont_use_autosuspend(&pdev->dev); 239edfc3901SMika Westerberg pm_runtime_put_sync(&pdev->dev); 2407272194eSMika Westerberg pm_runtime_disable(&pdev->dev); 2417272194eSMika Westerberg 2422373f6b9SDirk Brandewie return 0; 2432373f6b9SDirk Brandewie } 2442373f6b9SDirk Brandewie 245af71100cSRob Herring #ifdef CONFIG_OF 246af71100cSRob Herring static const struct of_device_id dw_i2c_of_match[] = { 247af71100cSRob Herring { .compatible = "snps,designware-i2c", }, 248af71100cSRob Herring {}, 249af71100cSRob Herring }; 250af71100cSRob Herring MODULE_DEVICE_TABLE(of, dw_i2c_of_match); 251af71100cSRob Herring #endif 252af71100cSRob Herring 2538503ff16SJisheng Zhang #ifdef CONFIG_PM_SLEEP 2546ad6fde3SJarkko Nikula static int dw_i2c_plat_prepare(struct device *dev) 2558503ff16SJisheng Zhang { 2568503ff16SJisheng Zhang return pm_runtime_suspended(dev); 2578503ff16SJisheng Zhang } 2588503ff16SJisheng Zhang 2596ad6fde3SJarkko Nikula static void dw_i2c_plat_complete(struct device *dev) 2608503ff16SJisheng Zhang { 2618503ff16SJisheng Zhang if (dev->power.direct_complete) 2628503ff16SJisheng Zhang pm_request_resume(dev); 2638503ff16SJisheng Zhang } 2648503ff16SJisheng Zhang #else 265319d7f05SJarkko Nikula #define dw_i2c_plat_prepare NULL 266319d7f05SJarkko Nikula #define dw_i2c_plat_complete NULL 2678503ff16SJisheng Zhang #endif 2688503ff16SJisheng Zhang 2691fc2fe20SMika Westerberg #ifdef CONFIG_PM 2706ad6fde3SJarkko Nikula static int dw_i2c_plat_suspend(struct device *dev) 2713bf3b289SDeepak Sikri { 2723bf3b289SDeepak Sikri struct platform_device *pdev = to_platform_device(dev); 2733bf3b289SDeepak Sikri struct dw_i2c_dev *i_dev = platform_get_drvdata(pdev); 2743bf3b289SDeepak Sikri 275f537295aSMika Westerberg i2c_dw_disable(i_dev); 276e1fac69fSViresh Kumar clk_disable_unprepare(i_dev->clk); 2773bf3b289SDeepak Sikri 2783bf3b289SDeepak Sikri return 0; 2793bf3b289SDeepak Sikri } 2803bf3b289SDeepak Sikri 2816ad6fde3SJarkko Nikula static int dw_i2c_plat_resume(struct device *dev) 2823bf3b289SDeepak Sikri { 2833bf3b289SDeepak Sikri struct platform_device *pdev = to_platform_device(dev); 2843bf3b289SDeepak Sikri struct dw_i2c_dev *i_dev = platform_get_drvdata(pdev); 2853bf3b289SDeepak Sikri 286e1fac69fSViresh Kumar clk_prepare_enable(i_dev->clk); 287894acb2fSDavid Box 288894acb2fSDavid Box if (!i_dev->pm_runtime_disabled) 2893bf3b289SDeepak Sikri i2c_dw_init(i_dev); 2903bf3b289SDeepak Sikri 2913bf3b289SDeepak Sikri return 0; 2923bf3b289SDeepak Sikri } 2933bf3b289SDeepak Sikri 2948503ff16SJisheng Zhang static const struct dev_pm_ops dw_i2c_dev_pm_ops = { 2956ad6fde3SJarkko Nikula .prepare = dw_i2c_plat_prepare, 2966ad6fde3SJarkko Nikula .complete = dw_i2c_plat_complete, 2976ad6fde3SJarkko Nikula SET_SYSTEM_SLEEP_PM_OPS(dw_i2c_plat_suspend, dw_i2c_plat_resume) 2986ad6fde3SJarkko Nikula SET_RUNTIME_PM_OPS(dw_i2c_plat_suspend, dw_i2c_plat_resume, NULL) 2998503ff16SJisheng Zhang }; 3008503ff16SJisheng Zhang 3018503ff16SJisheng Zhang #define DW_I2C_DEV_PMOPS (&dw_i2c_dev_pm_ops) 3028503ff16SJisheng Zhang #else 3038503ff16SJisheng Zhang #define DW_I2C_DEV_PMOPS NULL 3048503ff16SJisheng Zhang #endif 3051fc2fe20SMika Westerberg 3062373f6b9SDirk Brandewie /* work with hotplug and coldplug */ 3072373f6b9SDirk Brandewie MODULE_ALIAS("platform:i2c_designware"); 3082373f6b9SDirk Brandewie 3092373f6b9SDirk Brandewie static struct platform_driver dw_i2c_driver = { 3106ad6fde3SJarkko Nikula .probe = dw_i2c_plat_probe, 3116ad6fde3SJarkko Nikula .remove = dw_i2c_plat_remove, 3122373f6b9SDirk Brandewie .driver = { 3132373f6b9SDirk Brandewie .name = "i2c_designware", 314af71100cSRob Herring .of_match_table = of_match_ptr(dw_i2c_of_match), 315b61b1415SMika Westerberg .acpi_match_table = ACPI_PTR(dw_i2c_acpi_match), 3168503ff16SJisheng Zhang .pm = DW_I2C_DEV_PMOPS, 3172373f6b9SDirk Brandewie }, 3182373f6b9SDirk Brandewie }; 3192373f6b9SDirk Brandewie 3202373f6b9SDirk Brandewie static int __init dw_i2c_init_driver(void) 3212373f6b9SDirk Brandewie { 322cccdcea1SWolfram Sang return platform_driver_register(&dw_i2c_driver); 3232373f6b9SDirk Brandewie } 32410452280SPratyush Anand subsys_initcall(dw_i2c_init_driver); 3252373f6b9SDirk Brandewie 3262373f6b9SDirk Brandewie static void __exit dw_i2c_exit_driver(void) 3272373f6b9SDirk Brandewie { 3282373f6b9SDirk Brandewie platform_driver_unregister(&dw_i2c_driver); 3292373f6b9SDirk Brandewie } 3302373f6b9SDirk Brandewie module_exit(dw_i2c_exit_driver); 3312373f6b9SDirk Brandewie 3322373f6b9SDirk Brandewie MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>"); 3332373f6b9SDirk Brandewie MODULE_DESCRIPTION("Synopsys DesignWare I2C bus adapter"); 3342373f6b9SDirk Brandewie MODULE_LICENSE("GPL"); 335