115c566fcSAndy Shevchenko // SPDX-License-Identifier: GPL-2.0-or-later 22373f6b9SDirk Brandewie /* 35b6d721bSLuis Oliveira * Synopsys DesignWare I2C adapter driver. 42373f6b9SDirk Brandewie * 52373f6b9SDirk Brandewie * Based on the TI DAVINCI I2C adapter driver. 62373f6b9SDirk Brandewie * 72373f6b9SDirk Brandewie * Copyright (C) 2006 Texas Instruments. 82373f6b9SDirk Brandewie * Copyright (C) 2007 MontaVista Software Inc. 92373f6b9SDirk Brandewie * Copyright (C) 2009 Provigent Ltd. 102373f6b9SDirk Brandewie */ 11e393f674SLuis Oliveira #include <linux/acpi.h> 12e393f674SLuis Oliveira #include <linux/clk-provider.h> 13e393f674SLuis Oliveira #include <linux/clk.h> 142373f6b9SDirk Brandewie #include <linux/delay.h> 152373f6b9SDirk Brandewie #include <linux/err.h> 16e393f674SLuis Oliveira #include <linux/errno.h> 17e393f674SLuis Oliveira #include <linux/i2c.h> 182373f6b9SDirk Brandewie #include <linux/interrupt.h> 19e393f674SLuis Oliveira #include <linux/io.h> 20e393f674SLuis Oliveira #include <linux/kernel.h> 21e393f674SLuis Oliveira #include <linux/module.h> 229803f868SChristian Ruppert #include <linux/of.h> 23e393f674SLuis Oliveira #include <linux/platform_data/i2c-designware.h> 242373f6b9SDirk Brandewie #include <linux/platform_device.h> 253bf3b289SDeepak Sikri #include <linux/pm.h> 267272194eSMika Westerberg #include <linux/pm_runtime.h> 274c5301abSMika Westerberg #include <linux/property.h> 28ab809fd8SZhangfei Gao #include <linux/reset.h> 29e393f674SLuis Oliveira #include <linux/sched.h> 302373f6b9SDirk Brandewie #include <linux/slab.h> 3102e45646SRafael J. Wysocki #include <linux/suspend.h> 32e393f674SLuis Oliveira 332373f6b9SDirk Brandewie #include "i2c-designware-core.h" 342373f6b9SDirk Brandewie 351d31b58fSDirk Brandewie static u32 i2c_dw_get_clk_rate_khz(struct dw_i2c_dev *dev) 361d31b58fSDirk Brandewie { 371d31b58fSDirk Brandewie return clk_get_rate(dev->clk)/1000; 381d31b58fSDirk Brandewie } 392373f6b9SDirk Brandewie 40b61b1415SMika Westerberg #ifdef CONFIG_ACPI 41b61b1415SMika Westerberg static const struct acpi_device_id dw_i2c_acpi_match[] = { 42b61b1415SMika Westerberg { "INT33C2", 0 }, 43b61b1415SMika Westerberg { "INT33C3", 0 }, 4425b3dfc8SMika Westerberg { "INT3432", 0 }, 4525b3dfc8SMika Westerberg { "INT3433", 0 }, 46b30f2f65SHans de Goede { "80860F41", ACCESS_NO_IRQ_SUSPEND }, 47c615f5c6SSerge Semin { "808622C1", ACCESS_NO_IRQ_SUSPEND }, 482d244c81SXiangliang Yu { "AMD0010", ACCESS_INTR_MASK }, 49e4e666baSXiangliang Yu { "AMDI0010", ACCESS_INTR_MASK }, 5090708ce2SSuravee Suthikulpanit { "AMDI0510", 0 }, 5104a407f6SLoc Ho { "APMC0D0F", 0 }, 5258dd8abfSHanjun Guo { "HISI02A1", 0 }, 5358dd8abfSHanjun Guo { "HISI02A2", 0 }, 54dec0a81aSHanjun Guo { "HISI02A3", 0 }, 55b61b1415SMika Westerberg { } 56b61b1415SMika Westerberg }; 57b61b1415SMika Westerberg MODULE_DEVICE_TABLE(acpi, dw_i2c_acpi_match); 58b61b1415SMika Westerberg #endif 59b61b1415SMika Westerberg 6096742775SAlexandre Belloni #ifdef CONFIG_OF 611bb39959SAlexandre Belloni #define MSCC_ICPU_CFG_TWI_DELAY 0x0 621bb39959SAlexandre Belloni #define MSCC_ICPU_CFG_TWI_DELAY_ENABLE BIT(0) 631bb39959SAlexandre Belloni #define MSCC_ICPU_CFG_TWI_SPIKE_FILTER 0x4 641bb39959SAlexandre Belloni 651bb39959SAlexandre Belloni static int mscc_twi_set_sda_hold_time(struct dw_i2c_dev *dev) 661bb39959SAlexandre Belloni { 671bb39959SAlexandre Belloni writel((dev->sda_hold_time << 1) | MSCC_ICPU_CFG_TWI_DELAY_ENABLE, 681bb39959SAlexandre Belloni dev->ext + MSCC_ICPU_CFG_TWI_DELAY); 691bb39959SAlexandre Belloni 701bb39959SAlexandre Belloni return 0; 711bb39959SAlexandre Belloni } 721bb39959SAlexandre Belloni 731bb39959SAlexandre Belloni static int dw_i2c_of_configure(struct platform_device *pdev) 741bb39959SAlexandre Belloni { 751bb39959SAlexandre Belloni struct dw_i2c_dev *dev = platform_get_drvdata(pdev); 761bb39959SAlexandre Belloni 771bb39959SAlexandre Belloni switch (dev->flags & MODEL_MASK) { 781bb39959SAlexandre Belloni case MODEL_MSCC_OCELOT: 79188fe480SAndy Shevchenko dev->ext = devm_platform_ioremap_resource(pdev, 1); 801bb39959SAlexandre Belloni if (!IS_ERR(dev->ext)) 811bb39959SAlexandre Belloni dev->set_sda_hold_time = mscc_twi_set_sda_hold_time; 821bb39959SAlexandre Belloni break; 831bb39959SAlexandre Belloni default: 841bb39959SAlexandre Belloni break; 851bb39959SAlexandre Belloni } 861bb39959SAlexandre Belloni 871bb39959SAlexandre Belloni return 0; 881bb39959SAlexandre Belloni } 891bb39959SAlexandre Belloni 9096742775SAlexandre Belloni static const struct of_device_id dw_i2c_of_match[] = { 9196742775SAlexandre Belloni { .compatible = "snps,designware-i2c", }, 921bb39959SAlexandre Belloni { .compatible = "mscc,ocelot-i2c", .data = (void *)MODEL_MSCC_OCELOT }, 9396742775SAlexandre Belloni {}, 9496742775SAlexandre Belloni }; 9596742775SAlexandre Belloni MODULE_DEVICE_TABLE(of, dw_i2c_of_match); 961bb39959SAlexandre Belloni #else 971bb39959SAlexandre Belloni static inline int dw_i2c_of_configure(struct platform_device *pdev) 981bb39959SAlexandre Belloni { 991bb39959SAlexandre Belloni return -ENODEV; 1001bb39959SAlexandre Belloni } 10196742775SAlexandre Belloni #endif 10296742775SAlexandre Belloni 103126dbc6bSRafael J. Wysocki static void dw_i2c_plat_pm_cleanup(struct dw_i2c_dev *dev) 104126dbc6bSRafael J. Wysocki { 105126dbc6bSRafael J. Wysocki pm_runtime_disable(dev->dev); 106126dbc6bSRafael J. Wysocki 1079cbeeca0SHans de Goede if (dev->shared_with_punit) 108126dbc6bSRafael J. Wysocki pm_runtime_put_noidle(dev->dev); 109126dbc6bSRafael J. Wysocki } 110126dbc6bSRafael J. Wysocki 1116ad6fde3SJarkko Nikula static int dw_i2c_plat_probe(struct platform_device *pdev) 1122373f6b9SDirk Brandewie { 1134c5301abSMika Westerberg struct dw_i2c_platform_data *pdata = dev_get_platdata(&pdev->dev); 1142373f6b9SDirk Brandewie struct i2c_adapter *adap; 115e393f674SLuis Oliveira struct dw_i2c_dev *dev; 116e3ea52b5SAndy Shevchenko struct i2c_timings *t; 117f9288fccSAndy Shevchenko int irq, ret; 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 127188fe480SAndy Shevchenko dev->base = devm_platform_ioremap_resource(pdev, 0); 1281cb715caSAndy Shevchenko if (IS_ERR(dev->base)) 1291cb715caSAndy Shevchenko return PTR_ERR(dev->base); 1302373f6b9SDirk Brandewie 1311cb715caSAndy Shevchenko dev->dev = &pdev->dev; 1322373f6b9SDirk Brandewie dev->irq = irq; 1332373f6b9SDirk Brandewie platform_set_drvdata(pdev, dev); 1342373f6b9SDirk Brandewie 135ab809fd8SZhangfei Gao dev->rst = devm_reset_control_get_optional_exclusive(&pdev->dev, NULL); 136a6af48ecSAndy Shevchenko if (IS_ERR(dev->rst)) 137a6af48ecSAndy Shevchenko return PTR_ERR(dev->rst); 138a6af48ecSAndy Shevchenko 139ab809fd8SZhangfei Gao reset_control_deassert(dev->rst); 140ab809fd8SZhangfei Gao 141e3ea52b5SAndy Shevchenko t = &dev->timings; 142e3ea52b5SAndy Shevchenko if (pdata) 143e3ea52b5SAndy Shevchenko t->bus_freq_hz = pdata->i2c_scl_freq; 144e3ea52b5SAndy Shevchenko else 145e3ea52b5SAndy Shevchenko i2c_parse_fw_timings(&pdev->dev, t, false); 1468e5f6b2aSRomain Baeriswyl 147f9288fccSAndy Shevchenko i2c_dw_acpi_adjust_bus_speed(&pdev->dev); 14810f8e7fbSJarkko Nikula 1491732c22aSAlexandre Belloni dev->flags |= (uintptr_t)device_get_match_data(&pdev->dev); 1501732c22aSAlexandre Belloni 1511bb39959SAlexandre Belloni if (pdev->dev.of_node) 1521bb39959SAlexandre Belloni dw_i2c_of_configure(pdev); 1531bb39959SAlexandre Belloni 1544c5301abSMika Westerberg if (has_acpi_companion(&pdev->dev)) 155f9288fccSAndy Shevchenko i2c_dw_acpi_configure(&pdev->dev); 1564c5301abSMika Westerberg 15720ee1d90SAndy Shevchenko ret = i2c_dw_validate_speed(dev); 15820ee1d90SAndy Shevchenko if (ret) 159ab809fd8SZhangfei Gao goto exit_reset; 1609803f868SChristian Ruppert 161e393f674SLuis Oliveira ret = i2c_dw_probe_lock_support(dev); 162e393f674SLuis Oliveira if (ret) 163ab809fd8SZhangfei Gao goto exit_reset; 164894acb2fSDavid Box 1653ebe40edSAndy Shevchenko i2c_dw_configure(dev); 1662fa8326bSDirk Brandewie 167c62ebb3dSPhil Edworthy /* Optional interface clock */ 168c62ebb3dSPhil Edworthy dev->pclk = devm_clk_get_optional(&pdev->dev, "pclk"); 16971dc297cSAndy Shevchenko if (IS_ERR(dev->pclk)) { 17071dc297cSAndy Shevchenko ret = PTR_ERR(dev->pclk); 17171dc297cSAndy Shevchenko goto exit_reset; 17271dc297cSAndy Shevchenko } 173c62ebb3dSPhil Edworthy 174925ddb24SMika Westerberg dev->clk = devm_clk_get(&pdev->dev, NULL); 1750326f9f8SPhil Reid if (!i2c_dw_prepare_clk(dev, true)) { 176e3ea52b5SAndy Shevchenko u64 clk_khz; 177925ddb24SMika Westerberg 178e3ea52b5SAndy Shevchenko dev->get_clk_rate_khz = i2c_dw_get_clk_rate_khz; 179e3ea52b5SAndy Shevchenko clk_khz = dev->get_clk_rate_khz(dev); 180e3ea52b5SAndy Shevchenko 181e3ea52b5SAndy Shevchenko if (!dev->sda_hold_time && t->sda_hold_ns) 182e3ea52b5SAndy Shevchenko dev->sda_hold_time = 183e3ea52b5SAndy Shevchenko div_u64(clk_khz * t->sda_hold_ns + 500000, 1000000); 184925ddb24SMika Westerberg } 185925ddb24SMika Westerberg 1862373f6b9SDirk Brandewie adap = &dev->adapter; 1872373f6b9SDirk Brandewie adap->owner = THIS_MODULE; 18870fba830SWolfram Sang adap->class = I2C_CLASS_DEPRECATED; 1898eb5c87aSDustin Byford ACPI_COMPANION_SET(&adap->dev, ACPI_COMPANION(&pdev->dev)); 190af71100cSRob Herring adap->dev.of_node = pdev->dev.of_node; 19177f3381aSHans de Goede adap->nr = -1; 1922373f6b9SDirk Brandewie 193d79294d0SHans de Goede if (dev->flags & ACCESS_NO_IRQ_SUSPEND) { 194d79294d0SHans de Goede dev_pm_set_driver_flags(&pdev->dev, 195d79294d0SHans de Goede DPM_FLAG_SMART_PREPARE | 196d79294d0SHans de Goede DPM_FLAG_LEAVE_SUSPENDED); 197d79294d0SHans de Goede } else { 19802e45646SRafael J. Wysocki dev_pm_set_driver_flags(&pdev->dev, 19902e45646SRafael J. Wysocki DPM_FLAG_SMART_PREPARE | 20002e45646SRafael J. Wysocki DPM_FLAG_SMART_SUSPEND | 20102e45646SRafael J. Wysocki DPM_FLAG_LEAVE_SUSPENDED); 202d79294d0SHans de Goede } 203422cb781SRafael J. Wysocki 204126dbc6bSRafael J. Wysocki /* The code below assumes runtime PM to be disabled. */ 205126dbc6bSRafael J. Wysocki WARN_ON(pm_runtime_enabled(&pdev->dev)); 206126dbc6bSRafael J. Wysocki 20743452335SMika Westerberg pm_runtime_set_autosuspend_delay(&pdev->dev, 1000); 20843452335SMika Westerberg pm_runtime_use_autosuspend(&pdev->dev); 2097272194eSMika Westerberg pm_runtime_set_active(&pdev->dev); 210126dbc6bSRafael J. Wysocki 2119cbeeca0SHans de Goede if (dev->shared_with_punit) 212126dbc6bSRafael J. Wysocki pm_runtime_get_noresume(&pdev->dev); 213126dbc6bSRafael J. Wysocki 2147272194eSMika Westerberg pm_runtime_enable(&pdev->dev); 2157272194eSMika Westerberg 216e393f674SLuis Oliveira ret = i2c_dw_probe(dev); 217e393f674SLuis Oliveira if (ret) 218ab809fd8SZhangfei Gao goto exit_probe; 21936d48fb5SWolfram Sang 220e393f674SLuis Oliveira return ret; 221ab809fd8SZhangfei Gao 222ab809fd8SZhangfei Gao exit_probe: 223126dbc6bSRafael J. Wysocki dw_i2c_plat_pm_cleanup(dev); 224ab809fd8SZhangfei Gao exit_reset: 225ab809fd8SZhangfei Gao reset_control_assert(dev->rst); 226e393f674SLuis Oliveira return ret; 2272373f6b9SDirk Brandewie } 2282373f6b9SDirk Brandewie 2296ad6fde3SJarkko Nikula static int dw_i2c_plat_remove(struct platform_device *pdev) 2302373f6b9SDirk Brandewie { 2312373f6b9SDirk Brandewie struct dw_i2c_dev *dev = platform_get_drvdata(pdev); 2322373f6b9SDirk Brandewie 2337272194eSMika Westerberg pm_runtime_get_sync(&pdev->dev); 2347272194eSMika Westerberg 2352373f6b9SDirk Brandewie i2c_del_adapter(&dev->adapter); 2362373f6b9SDirk Brandewie 23790312351SLuis Oliveira dev->disable(dev); 2382373f6b9SDirk Brandewie 239edfc3901SMika Westerberg pm_runtime_dont_use_autosuspend(&pdev->dev); 240edfc3901SMika Westerberg pm_runtime_put_sync(&pdev->dev); 241126dbc6bSRafael J. Wysocki dw_i2c_plat_pm_cleanup(dev); 242126dbc6bSRafael J. Wysocki 243ab809fd8SZhangfei Gao reset_control_assert(dev->rst); 2447272194eSMika Westerberg 2452373f6b9SDirk Brandewie return 0; 2462373f6b9SDirk Brandewie } 2472373f6b9SDirk Brandewie 2488503ff16SJisheng Zhang #ifdef CONFIG_PM_SLEEP 2496ad6fde3SJarkko Nikula static int dw_i2c_plat_prepare(struct device *dev) 2508503ff16SJisheng Zhang { 251422cb781SRafael J. Wysocki /* 252422cb781SRafael J. Wysocki * If the ACPI companion device object is present for this device, it 253422cb781SRafael J. Wysocki * may be accessed during suspend and resume of other devices via I2C 254422cb781SRafael J. Wysocki * operation regions, so tell the PM core and middle layers to avoid 255422cb781SRafael J. Wysocki * skipping system suspend/resume callbacks for it in that case. 256422cb781SRafael J. Wysocki */ 257422cb781SRafael J. Wysocki return !has_acpi_companion(dev); 2588503ff16SJisheng Zhang } 2598503ff16SJisheng Zhang 2606ad6fde3SJarkko Nikula static void dw_i2c_plat_complete(struct device *dev) 2618503ff16SJisheng Zhang { 26202e45646SRafael J. Wysocki /* 26302e45646SRafael J. Wysocki * The device can only be in runtime suspend at this point if it has not 26402e45646SRafael J. Wysocki * been resumed throughout the ending system suspend/resume cycle, so if 26502e45646SRafael J. Wysocki * the platform firmware might mess up with it, request the runtime PM 26602e45646SRafael J. Wysocki * framework to resume it. 26702e45646SRafael J. Wysocki */ 26802e45646SRafael J. Wysocki if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) 2698503ff16SJisheng Zhang pm_request_resume(dev); 2708503ff16SJisheng Zhang } 2718503ff16SJisheng Zhang #else 272319d7f05SJarkko Nikula #define dw_i2c_plat_prepare NULL 273319d7f05SJarkko Nikula #define dw_i2c_plat_complete NULL 2748503ff16SJisheng Zhang #endif 2758503ff16SJisheng Zhang 2761fc2fe20SMika Westerberg #ifdef CONFIG_PM 27754152772SRafael J. Wysocki static int dw_i2c_plat_suspend(struct device *dev) 2783bf3b289SDeepak Sikri { 2799242e72aSMasahiro Yamada struct dw_i2c_dev *i_dev = dev_get_drvdata(dev); 2803bf3b289SDeepak Sikri 28127515415SHans de Goede i_dev->suspended = true; 28227515415SHans de Goede 2839cbeeca0SHans de Goede if (i_dev->shared_with_punit) 2849d9a152eSHans de Goede return 0; 2859d9a152eSHans de Goede 28690312351SLuis Oliveira i_dev->disable(i_dev); 2870326f9f8SPhil Reid i2c_dw_prepare_clk(i_dev, false); 2883bf3b289SDeepak Sikri 2893bf3b289SDeepak Sikri return 0; 2903bf3b289SDeepak Sikri } 2913bf3b289SDeepak Sikri 2926ad6fde3SJarkko Nikula static int dw_i2c_plat_resume(struct device *dev) 2933bf3b289SDeepak Sikri { 2949242e72aSMasahiro Yamada struct dw_i2c_dev *i_dev = dev_get_drvdata(dev); 2953bf3b289SDeepak Sikri 2969cbeeca0SHans de Goede if (!i_dev->shared_with_punit) 2970326f9f8SPhil Reid i2c_dw_prepare_clk(i_dev, true); 2989d9a152eSHans de Goede 29990312351SLuis Oliveira i_dev->init(i_dev); 30027515415SHans de Goede i_dev->suspended = false; 3013bf3b289SDeepak Sikri 3023bf3b289SDeepak Sikri return 0; 3033bf3b289SDeepak Sikri } 3043bf3b289SDeepak Sikri 3058503ff16SJisheng Zhang static const struct dev_pm_ops dw_i2c_dev_pm_ops = { 3066ad6fde3SJarkko Nikula .prepare = dw_i2c_plat_prepare, 3076ad6fde3SJarkko Nikula .complete = dw_i2c_plat_complete, 30854152772SRafael J. Wysocki SET_LATE_SYSTEM_SLEEP_PM_OPS(dw_i2c_plat_suspend, dw_i2c_plat_resume) 30954152772SRafael J. Wysocki SET_RUNTIME_PM_OPS(dw_i2c_plat_suspend, dw_i2c_plat_resume, NULL) 3108503ff16SJisheng Zhang }; 3118503ff16SJisheng Zhang 3128503ff16SJisheng Zhang #define DW_I2C_DEV_PMOPS (&dw_i2c_dev_pm_ops) 3138503ff16SJisheng Zhang #else 3148503ff16SJisheng Zhang #define DW_I2C_DEV_PMOPS NULL 3158503ff16SJisheng Zhang #endif 3161fc2fe20SMika Westerberg 317e393f674SLuis Oliveira /* Work with hotplug and coldplug */ 3182373f6b9SDirk Brandewie MODULE_ALIAS("platform:i2c_designware"); 3192373f6b9SDirk Brandewie 3202373f6b9SDirk Brandewie static struct platform_driver dw_i2c_driver = { 3216ad6fde3SJarkko Nikula .probe = dw_i2c_plat_probe, 3226ad6fde3SJarkko Nikula .remove = dw_i2c_plat_remove, 3232373f6b9SDirk Brandewie .driver = { 3242373f6b9SDirk Brandewie .name = "i2c_designware", 325af71100cSRob Herring .of_match_table = of_match_ptr(dw_i2c_of_match), 326b61b1415SMika Westerberg .acpi_match_table = ACPI_PTR(dw_i2c_acpi_match), 3278503ff16SJisheng Zhang .pm = DW_I2C_DEV_PMOPS, 3282373f6b9SDirk Brandewie }, 3292373f6b9SDirk Brandewie }; 3302373f6b9SDirk Brandewie 3312373f6b9SDirk Brandewie static int __init dw_i2c_init_driver(void) 3322373f6b9SDirk Brandewie { 333cccdcea1SWolfram Sang return platform_driver_register(&dw_i2c_driver); 3342373f6b9SDirk Brandewie } 33510452280SPratyush Anand subsys_initcall(dw_i2c_init_driver); 3362373f6b9SDirk Brandewie 3372373f6b9SDirk Brandewie static void __exit dw_i2c_exit_driver(void) 3382373f6b9SDirk Brandewie { 3392373f6b9SDirk Brandewie platform_driver_unregister(&dw_i2c_driver); 3402373f6b9SDirk Brandewie } 3412373f6b9SDirk Brandewie module_exit(dw_i2c_exit_driver); 3422373f6b9SDirk Brandewie 3432373f6b9SDirk Brandewie MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>"); 3442373f6b9SDirk Brandewie MODULE_DESCRIPTION("Synopsys DesignWare I2C bus adapter"); 3452373f6b9SDirk Brandewie MODULE_LICENSE("GPL"); 346