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

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Synopsys DesignWare I2C adapter driver (master only).
   4  *
   5  * Based on the TI DAVINCI I2C adapter driver.
   6  *
   7  * Copyright (C) 2006 Texas Instruments.
   8  * Copyright (C) 2007 MontaVista Software Inc.
   9  * Copyright (C) 2009 Provigent Ltd.
  10  * Copyright (C) 2011, 2015, 2016 Intel Corporation.
  11  */
  12 #include <linux/acpi.h>
  13 #include <linux/delay.h>
  14 #include <linux/err.h>
  15 #include <linux/errno.h>
  16 #include <linux/i2c.h>
  17 #include <linux/interrupt.h>
  18 #include <linux/io.h>
  19 #include <linux/kernel.h>
  20 #include <linux/module.h>
  21 #include <linux/pci.h>
  22 #include <linux/pm_runtime.h>
  23 #include <linux/sched.h>
  24 #include <linux/slab.h>
  25
  26 #include "i2c-designware-core.h"
  27
  28 #define DRIVER_NAME "i2c-designware-pci"
  29
  30 enum dw_pci_ctl_id_t {
  31         medfield,
  32         merrifield,
  33         baytrail,
  34         cherrytrail,
  35         haswell,
  36 };
  37
  38 struct dw_scl_sda_cfg {
  39         u32 ss_hcnt;
  40         u32 fs_hcnt;
  41         u32 ss_lcnt;
  42         u32 fs_lcnt;
  43         u32 sda_hold;
  44 };
  45
  46 struct dw_pci_controller {
  47         u32 bus_num;
  48         u32 bus_cfg;
  49         u32 tx_fifo_depth;
  50         u32 rx_fifo_depth;
  51         u32 clk_khz;
  52         u32 functionality;
  53         u32 flags;
  54         struct dw_scl_sda_cfg *scl_sda_cfg;
  55         int (*setup)(struct pci_dev *pdev, struct dw_pci_controller *c);
  56 };
  57
  58 #define INTEL_MID_STD_CFG  (DW_IC_CON_MASTER |                  \
  59                                 DW_IC_CON_SLAVE_DISABLE |       \
  60                                 DW_IC_CON_RESTART_EN)
  61
  62 /* Merrifield HCNT/LCNT/SDA hold time */
  63 static struct dw_scl_sda_cfg mrfld_config = {
  64         .ss_hcnt = 0x2f8,
  65         .fs_hcnt = 0x87,
  66         .ss_lcnt = 0x37b,
  67         .fs_lcnt = 0x10a,
  68 };
  69
  70 /* BayTrail HCNT/LCNT/SDA hold time */
  71 static struct dw_scl_sda_cfg byt_config = {
  72         .ss_hcnt = 0x200,
  73         .fs_hcnt = 0x55,
  74         .ss_lcnt = 0x200,
  75         .fs_lcnt = 0x99,
  76         .sda_hold = 0x6,
  77 };
  78
  79 /* Haswell HCNT/LCNT/SDA hold time */
  80 static struct dw_scl_sda_cfg hsw_config = {
  81         .ss_hcnt = 0x01b0,
  82         .fs_hcnt = 0x48,
  83         .ss_lcnt = 0x01fb,
  84         .fs_lcnt = 0xa0,
  85         .sda_hold = 0x9,
  86 };
  87
  88 static int mfld_setup(struct pci_dev *pdev, struct dw_pci_controller *c)
  89 {
  90         switch (pdev->device) {
  91         case 0x0817:
  92                 c->bus_cfg &= ~DW_IC_CON_SPEED_MASK;
  93                 c->bus_cfg |= DW_IC_CON_SPEED_STD;
  94                 /* fall through */
  95         case 0x0818:
  96         case 0x0819:
  97                 c->bus_num = pdev->device - 0x817 + 3;
  98                 return 0;
  99         case 0x082C:
 100         case 0x082D:
 101         case 0x082E:
 102                 c->bus_num = pdev->device - 0x82C + 0;
 103                 return 0;
 104         }
 105         return -ENODEV;
 106 }
 107
 108 static int mrfld_setup(struct pci_dev *pdev, struct dw_pci_controller *c)
 109 {
 110         /*
 111          * On Intel Merrifield the user visible i2c busses are enumerated
 112          * [1..7]. So, we add 1 to shift the default range. Besides that the
 113          * first PCI slot provides 4 functions, that's why we have to add 0 to
 114          * the first slot and 4 to the next one.
 115          */
 116         switch (PCI_SLOT(pdev->devfn)) {
 117         case 8:
 118                 c->bus_num = PCI_FUNC(pdev->devfn) + 0 + 1;
 119                 return 0;
 120         case 9:
 121                 c->bus_num = PCI_FUNC(pdev->devfn) + 4 + 1;
 122                 return 0;
 123         }
 124         return -ENODEV;
 125 }
 126
 127 static struct dw_pci_controller dw_pci_controllers[] = {
 128         [medfield] = {
 129                 .bus_num = -1,
 130                 .bus_cfg   = INTEL_MID_STD_CFG | DW_IC_CON_SPEED_FAST,
 131                 .tx_fifo_depth = 32,
 132                 .rx_fifo_depth = 32,
 133                 .functionality = I2C_FUNC_10BIT_ADDR,
 134                 .clk_khz      = 25000,
 135                 .setup = mfld_setup,
 136         },
 137         [merrifield] = {
 138                 .bus_num = -1,
 139                 .bus_cfg = INTEL_MID_STD_CFG | DW_IC_CON_SPEED_FAST,
 140                 .tx_fifo_depth = 64,
 141                 .rx_fifo_depth = 64,
 142                 .functionality = I2C_FUNC_10BIT_ADDR,
 143                 .scl_sda_cfg = &mrfld_config,
 144                 .setup = mrfld_setup,
 145         },
 146         [baytrail] = {
 147                 .bus_num = -1,
 148                 .bus_cfg = INTEL_MID_STD_CFG | DW_IC_CON_SPEED_FAST,
 149                 .tx_fifo_depth = 32,
 150                 .rx_fifo_depth = 32,
 151                 .functionality = I2C_FUNC_10BIT_ADDR,
 152                 .scl_sda_cfg = &byt_config,
 153         },
 154         [haswell] = {
 155                 .bus_num = -1,
 156                 .bus_cfg = INTEL_MID_STD_CFG | DW_IC_CON_SPEED_FAST,
 157                 .tx_fifo_depth = 32,
 158                 .rx_fifo_depth = 32,
 159                 .functionality = I2C_FUNC_10BIT_ADDR,
 160                 .scl_sda_cfg = &hsw_config,
 161         },
 162         [cherrytrail] = {
 163                 .bus_num = -1,
 164                 .bus_cfg = INTEL_MID_STD_CFG | DW_IC_CON_SPEED_FAST,
 165                 .tx_fifo_depth = 32,
 166                 .rx_fifo_depth = 32,
 167                 .functionality = I2C_FUNC_10BIT_ADDR,
 168                 .flags = MODEL_CHERRYTRAIL,
 169                 .scl_sda_cfg = &byt_config,
 170         },
 171 };
 172
 173 #ifdef CONFIG_PM
 174 static int i2c_dw_pci_suspend(struct device *dev)
 175 {
 176         struct dw_i2c_dev *i_dev = dev_get_drvdata(dev);
 177
 178         i_dev->suspended = true;
 179         i_dev->disable(i_dev);
 180
 181         return 0;
 182 }
 183
 184 static int i2c_dw_pci_resume(struct device *dev)
 185 {
 186         struct dw_i2c_dev *i_dev = dev_get_drvdata(dev);
 187         int ret;
 188
 189         ret = i_dev->init(i_dev);
 190         i_dev->suspended = false;
 191
 192         return ret;
 193 }
 194 #endif
 195
 196 static UNIVERSAL_DEV_PM_OPS(i2c_dw_pm_ops, i2c_dw_pci_suspend,
 197                             i2c_dw_pci_resume, NULL);
 198
 199 static u32 i2c_dw_get_clk_rate_khz(struct dw_i2c_dev *dev)
 200 {
 201         return dev->controller->clk_khz;
 202 }
 203
 204 static int i2c_dw_pci_probe(struct pci_dev *pdev,
 205                             const struct pci_device_id *id)
 206 {
 207         struct dw_i2c_dev *dev;
 208         struct i2c_adapter *adap;
 209         int r;
 210         struct dw_pci_controller *controller;
 211         struct dw_scl_sda_cfg *cfg;
 212
 213         if (id->driver_data >= ARRAY_SIZE(dw_pci_controllers)) {
 214                 dev_err(&pdev->dev, "%s: invalid driver data %ld\n", __func__,
 215                         id->driver_data);
 216                 return -EINVAL;
 217         }
 218
 219         controller = &dw_pci_controllers[id->driver_data];
 220
 221         r = pcim_enable_device(pdev);
 222         if (r) {
 223                 dev_err(&pdev->dev, "Failed to enable I2C PCI device (%d)\n",
 224                         r);
 225                 return r;
 226         }
 227
 228         pci_set_master(pdev);
 229
 230         r = pcim_iomap_regions(pdev, 1 << 0, pci_name(pdev));
 231         if (r) {
 232                 dev_err(&pdev->dev, "I/O memory remapping failed\n");
 233                 return r;
 234         }
 235
 236         dev = devm_kzalloc(&pdev->dev, sizeof(struct dw_i2c_dev), GFP_KERNEL);
 237         if (!dev)
 238                 return -ENOMEM;
 239
 240         r = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_ALL_TYPES);
 241         if (r < 0)
 242                 return r;
 243
 244         dev->clk = NULL;
 245         dev->controller = controller;
 246         dev->get_clk_rate_khz = i2c_dw_get_clk_rate_khz;
 247         dev->base = pcim_iomap_table(pdev)[0];
 248         dev->dev = &pdev->dev;
 249         dev->irq = pci_irq_vector(pdev, 0);
 250         dev->flags |= controller->flags;
 251
 252         if (controller->setup) {
 253                 r = controller->setup(pdev, controller);
 254                 if (r) {
 255                         pci_free_irq_vectors(pdev);
 256                         return r;
 257                 }
 258         }
 259
 260         dev->functionality = controller->functionality |
 261                                 DW_IC_DEFAULT_FUNCTIONALITY;
 262
 263         dev->master_cfg = controller->bus_cfg;
 264         if (controller->scl_sda_cfg) {
 265                 cfg = controller->scl_sda_cfg;
 266                 dev->ss_hcnt = cfg->ss_hcnt;
 267                 dev->fs_hcnt = cfg->fs_hcnt;
 268                 dev->ss_lcnt = cfg->ss_lcnt;
 269                 dev->fs_lcnt = cfg->fs_lcnt;
 270                 dev->sda_hold_time = cfg->sda_hold;
 271         }
 272
 273         pci_set_drvdata(pdev, dev);
 274
 275         dev->tx_fifo_depth = controller->tx_fifo_depth;
 276         dev->rx_fifo_depth = controller->rx_fifo_depth;
 277
 278         adap = &dev->adapter;
 279         adap->owner = THIS_MODULE;
 280         adap->class = 0;
 281         ACPI_COMPANION_SET(&adap->dev, ACPI_COMPANION(&pdev->dev));
 282         adap->nr = controller->bus_num;
 283
 284         r = i2c_dw_probe(dev);
 285         if (r) {
 286                 pci_free_irq_vectors(pdev);
 287                 return r;
 288         }
 289
 290         pm_runtime_set_autosuspend_delay(&pdev->dev, 1000);
 291         pm_runtime_use_autosuspend(&pdev->dev);
 292         pm_runtime_put_autosuspend(&pdev->dev);
 293         pm_runtime_allow(&pdev->dev);
 294
 295         return 0;
 296 }
 297
 298 static void i2c_dw_pci_remove(struct pci_dev *pdev)
 299 {
 300         struct dw_i2c_dev *dev = pci_get_drvdata(pdev);
 301
 302         dev->disable(dev);
 303         pm_runtime_forbid(&pdev->dev);
 304         pm_runtime_get_noresume(&pdev->dev);
 305
 306         i2c_del_adapter(&dev->adapter);
 307         pci_free_irq_vectors(pdev);
 308 }
 309
 310 /* work with hotplug and coldplug */
 311 MODULE_ALIAS("i2c_designware-pci");
 312
 313 static const struct pci_device_id i2_designware_pci_ids[] = {
 314         /* Medfield */
 315         { PCI_VDEVICE(INTEL, 0x0817), medfield },
 316         { PCI_VDEVICE(INTEL, 0x0818), medfield },
 317         { PCI_VDEVICE(INTEL, 0x0819), medfield },
 318         { PCI_VDEVICE(INTEL, 0x082C), medfield },
 319         { PCI_VDEVICE(INTEL, 0x082D), medfield },
 320         { PCI_VDEVICE(INTEL, 0x082E), medfield },
 321         /* Merrifield */
 322         { PCI_VDEVICE(INTEL, 0x1195), merrifield },
 323         { PCI_VDEVICE(INTEL, 0x1196), merrifield },
 324         /* Baytrail */
 325         { PCI_VDEVICE(INTEL, 0x0F41), baytrail },
 326         { PCI_VDEVICE(INTEL, 0x0F42), baytrail },
 327         { PCI_VDEVICE(INTEL, 0x0F43), baytrail },
 328         { PCI_VDEVICE(INTEL, 0x0F44), baytrail },
 329         { PCI_VDEVICE(INTEL, 0x0F45), baytrail },
 330         { PCI_VDEVICE(INTEL, 0x0F46), baytrail },
 331         { PCI_VDEVICE(INTEL, 0x0F47), baytrail },
 332         /* Haswell */
 333         { PCI_VDEVICE(INTEL, 0x9c61), haswell },
 334         { PCI_VDEVICE(INTEL, 0x9c62), haswell },
 335         /* Braswell / Cherrytrail */
 336         { PCI_VDEVICE(INTEL, 0x22C1), cherrytrail },
 337         { PCI_VDEVICE(INTEL, 0x22C2), cherrytrail },
 338         { PCI_VDEVICE(INTEL, 0x22C3), cherrytrail },
 339         { PCI_VDEVICE(INTEL, 0x22C4), cherrytrail },
 340         { PCI_VDEVICE(INTEL, 0x22C5), cherrytrail },
 341         { PCI_VDEVICE(INTEL, 0x22C6), cherrytrail },
 342         { PCI_VDEVICE(INTEL, 0x22C7), cherrytrail },
 343         { 0,}
 344 };
 345 MODULE_DEVICE_TABLE(pci, i2_designware_pci_ids);
 346
 347 static struct pci_driver dw_i2c_driver = {
 348         .name           = DRIVER_NAME,
 349         .id_table       = i2_designware_pci_ids,
 350         .probe          = i2c_dw_pci_probe,
 351         .remove         = i2c_dw_pci_remove,
 352         .driver         = {
 353                 .pm     = &i2c_dw_pm_ops,
 354         },
 355 };
 356
 357 module_pci_driver(dw_i2c_driver);
 358
 359 MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>");
 360 MODULE_DESCRIPTION("Synopsys DesignWare PCI I2C bus adapter");
 361 MODULE_LICENSE("GPL");