drivers/hid/intel-ish-hid/ipc/pci-ish.c

   1 /*
   2  * PCI glue for ISHTP provider device (ISH) driver
   3  *
   4  * Copyright (c) 2014-2016, Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  13  * more details.
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/moduleparam.h>
  18 #include <linux/kernel.h>
  19 #include <linux/device.h>
  20 #include <linux/fs.h>
  21 #include <linux/errno.h>
  22 #include <linux/types.h>
  23 #include <linux/pci.h>
  24 #include <linux/sched.h>
  25 #include <linux/interrupt.h>
  26 #include <linux/workqueue.h>
  27 #define CREATE_TRACE_POINTS
  28 #include <trace/events/intel_ish.h>
  29 #include "ishtp-dev.h"
  30 #include "hw-ish.h"
  31
  32 static const struct pci_device_id ish_pci_tbl[] = {
  33         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CHV_DEVICE_ID)},
  34         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, BXT_Ax_DEVICE_ID)},
  35         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, BXT_Bx_DEVICE_ID)},
  36         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, APL_Ax_DEVICE_ID)},
  37         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, SPT_Ax_DEVICE_ID)},
  38         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CNL_Ax_DEVICE_ID)},
  39         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, GLK_Ax_DEVICE_ID)},
  40         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CNL_H_DEVICE_ID)},
  41         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, ICL_MOBILE_DEVICE_ID)},
  42         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, SPT_H_DEVICE_ID)},
  43         {0, }
  44 };
  45 MODULE_DEVICE_TABLE(pci, ish_pci_tbl);
  46
  47 /**
  48  * ish_event_tracer() - Callback function to dump trace messages
  49  * @dev:        ishtp device
  50  * @format:     printf style format
  51  *
  52  * Callback to direct log messages to Linux trace buffers
  53  */
  54 static __printf(2, 3)
  55 void ish_event_tracer(struct ishtp_device *dev, const char *format, ...)
  56 {
  57         if (trace_ishtp_dump_enabled()) {
  58                 va_list args;
  59                 char tmp_buf[100];
  60
  61                 va_start(args, format);
  62                 vsnprintf(tmp_buf, sizeof(tmp_buf), format, args);
  63                 va_end(args);
  64
  65                 trace_ishtp_dump(tmp_buf);
  66         }
  67 }
  68
  69 /**
  70  * ish_init() - Init function
  71  * @dev:        ishtp device
  72  *
  73  * This function initialize wait queues for suspend/resume and call
  74  * calls hadware initialization function. This will initiate
  75  * startup sequence
  76  *
  77  * Return: 0 for success or error code for failure
  78  */
  79 static int ish_init(struct ishtp_device *dev)
  80 {
  81         int ret;
  82
  83         /* Set the state of ISH HW to start */
  84         ret = ish_hw_start(dev);
  85         if (ret) {
  86                 dev_err(dev->devc, "ISH: hw start failed.\n");
  87                 return ret;
  88         }
  89
  90         /* Start the inter process communication to ISH processor */
  91         ret = ishtp_start(dev);
  92         if (ret) {
  93                 dev_err(dev->devc, "ISHTP: Protocol init failed.\n");
  94                 return ret;
  95         }
  96
  97         return 0;
  98 }
  99
 100 static const struct pci_device_id ish_invalid_pci_ids[] = {
 101         /* Mehlow platform special pci ids */
 102         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0xA309)},
 103         {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0xA30A)},
 104         {}
 105 };
 106
 107 /**
 108  * ish_probe() - PCI driver probe callback
 109  * @pdev:       pci device
 110  * @ent:        pci device id
 111  *
 112  * Initialize PCI function, setup interrupt and call for ISH initialization
 113  *
 114  * Return: 0 for success or error code for failure
 115  */
 116 static int ish_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 117 {
 118         struct ishtp_device *dev;
 119         struct ish_hw *hw;
 120         int     ret;
 121
 122         /* Check for invalid platforms for ISH support */
 123         if (pci_dev_present(ish_invalid_pci_ids))
 124                 return -ENODEV;
 125
 126         /* enable pci dev */
 127         ret = pci_enable_device(pdev);
 128         if (ret) {
 129                 dev_err(&pdev->dev, "ISH: Failed to enable PCI device\n");
 130                 return ret;
 131         }
 132
 133         /* set PCI host mastering */
 134         pci_set_master(pdev);
 135
 136         /* pci request regions for ISH driver */
 137         ret = pci_request_regions(pdev, KBUILD_MODNAME);
 138         if (ret) {
 139                 dev_err(&pdev->dev, "ISH: Failed to get PCI regions\n");
 140                 goto disable_device;
 141         }
 142
 143         /* allocates and initializes the ISH dev structure */
 144         dev = ish_dev_init(pdev);
 145         if (!dev) {
 146                 ret = -ENOMEM;
 147                 goto release_regions;
 148         }
 149         hw = to_ish_hw(dev);
 150         dev->print_log = ish_event_tracer;
 151
 152         /* mapping IO device memory */
 153         hw->mem_addr = pci_iomap(pdev, 0, 0);
 154         if (!hw->mem_addr) {
 155                 dev_err(&pdev->dev, "ISH: mapping I/O range failure\n");
 156                 ret = -ENOMEM;
 157                 goto free_device;
 158         }
 159
 160         dev->pdev = pdev;
 161
 162         pdev->dev_flags |= PCI_DEV_FLAGS_NO_D3;
 163
 164         /* request and enable interrupt */
 165         ret = request_irq(pdev->irq, ish_irq_handler, IRQF_SHARED,
 166                           KBUILD_MODNAME, dev);
 167         if (ret) {
 168                 dev_err(&pdev->dev, "ISH: request IRQ failure (%d)\n",
 169                         pdev->irq);
 170                 goto free_device;
 171         }
 172
 173         dev_set_drvdata(dev->devc, dev);
 174
 175         init_waitqueue_head(&dev->suspend_wait);
 176         init_waitqueue_head(&dev->resume_wait);
 177
 178         ret = ish_init(dev);
 179         if (ret)
 180                 goto free_irq;
 181
 182         return 0;
 183
 184 free_irq:
 185         free_irq(pdev->irq, dev);
 186 free_device:
 187         pci_iounmap(pdev, hw->mem_addr);
 188 release_regions:
 189         pci_release_regions(pdev);
 190 disable_device:
 191         pci_clear_master(pdev);
 192         pci_disable_device(pdev);
 193         dev_err(&pdev->dev, "ISH: PCI driver initialization failed.\n");
 194
 195         return ret;
 196 }
 197
 198 /**
 199  * ish_remove() - PCI driver remove callback
 200  * @pdev:       pci device
 201  *
 202  * This function does cleanup of ISH on pci remove callback
 203  */
 204 static void ish_remove(struct pci_dev *pdev)
 205 {
 206         struct ishtp_device *ishtp_dev = pci_get_drvdata(pdev);
 207         struct ish_hw *hw = to_ish_hw(ishtp_dev);
 208
 209         ishtp_bus_remove_all_clients(ishtp_dev, false);
 210         ish_device_disable(ishtp_dev);
 211
 212         free_irq(pdev->irq, ishtp_dev);
 213         pci_iounmap(pdev, hw->mem_addr);
 214         pci_release_regions(pdev);
 215         pci_clear_master(pdev);
 216         pci_disable_device(pdev);
 217 }
 218
 219 static struct device __maybe_unused *ish_resume_device;
 220
 221 /* 50ms to get resume response */
 222 #define WAIT_FOR_RESUME_ACK_MS          50
 223
 224 /**
 225  * ish_resume_handler() - Work function to complete resume
 226  * @work:       work struct
 227  *
 228  * The resume work function to complete resume function asynchronously.
 229  * There are two resume paths, one where ISH is not powered off,
 230  * in that case a simple resume message is enough, others we need
 231  * a reset sequence.
 232  */
 233 static void __maybe_unused ish_resume_handler(struct work_struct *work)
 234 {
 235         struct pci_dev *pdev = to_pci_dev(ish_resume_device);
 236         struct ishtp_device *dev = pci_get_drvdata(pdev);
 237         uint32_t fwsts;
 238         int ret;
 239
 240         /* Get ISH FW status */
 241         fwsts = IPC_GET_ISH_FWSTS(dev->ops->get_fw_status(dev));
 242
 243         /*
 244          * If currently, in ISH FW, sensor app is loaded or beyond that,
 245          * it means ISH isn't powered off, in this case, send a resume message.
 246          */
 247         if (fwsts >= FWSTS_SENSOR_APP_LOADED) {
 248                 ishtp_send_resume(dev);
 249
 250                 /* Waiting to get resume response */
 251                 if (dev->resume_flag)
 252                         ret = wait_event_interruptible_timeout(dev->resume_wait,
 253                                 !dev->resume_flag,
 254                                 msecs_to_jiffies(WAIT_FOR_RESUME_ACK_MS));
 255         }
 256
 257         /*
 258          * If in ISH FW, sensor app isn't loaded yet, or no resume response.
 259          * That means this platform is not S0ix compatible, or something is
 260          * wrong with ISH FW. So on resume, full reboot of ISH processor will
 261          * happen, so need to go through init sequence again.
 262          */
 263         if (dev->resume_flag)
 264                 ish_init(dev);
 265 }
 266
 267 /**
 268  * ish_suspend() - ISH suspend callback
 269  * @device:     device pointer
 270  *
 271  * ISH suspend callback
 272  *
 273  * Return: 0 to the pm core
 274  */
 275 static int __maybe_unused ish_suspend(struct device *device)
 276 {
 277         struct pci_dev *pdev = to_pci_dev(device);
 278         struct ishtp_device *dev = pci_get_drvdata(pdev);
 279
 280         enable_irq_wake(pdev->irq);
 281         /*
 282          * If previous suspend hasn't been asnwered then ISH is likely dead,
 283          * don't attempt nested notification
 284          */
 285         if (dev->suspend_flag)
 286                 return  0;
 287
 288         dev->resume_flag = 0;
 289         dev->suspend_flag = 1;
 290         ishtp_send_suspend(dev);
 291
 292         /* 25 ms should be enough for live ISH to flush all IPC buf */
 293         if (dev->suspend_flag)
 294                 wait_event_interruptible_timeout(dev->suspend_wait,
 295                                                  !dev->suspend_flag,
 296                                                   msecs_to_jiffies(25));
 297
 298         return 0;
 299 }
 300
 301 static __maybe_unused DECLARE_WORK(resume_work, ish_resume_handler);
 302 /**
 303  * ish_resume() - ISH resume callback
 304  * @device:     device pointer
 305  *
 306  * ISH resume callback
 307  *
 308  * Return: 0 to the pm core
 309  */
 310 static int __maybe_unused ish_resume(struct device *device)
 311 {
 312         struct pci_dev *pdev = to_pci_dev(device);
 313         struct ishtp_device *dev = pci_get_drvdata(pdev);
 314
 315         ish_resume_device = device;
 316         dev->resume_flag = 1;
 317
 318         disable_irq_wake(pdev->irq);
 319         schedule_work(&resume_work);
 320
 321         return 0;
 322 }
 323
 324 static SIMPLE_DEV_PM_OPS(ish_pm_ops, ish_suspend, ish_resume);
 325
 326 static struct pci_driver ish_driver = {
 327         .name = KBUILD_MODNAME,
 328         .id_table = ish_pci_tbl,
 329         .probe = ish_probe,
 330         .remove = ish_remove,
 331         .driver.pm = &ish_pm_ops,
 332 };
 333
 334 module_pci_driver(ish_driver);
 335
 336 /* Original author */
 337 MODULE_AUTHOR("Daniel Drubin <daniel.drubin@intel.com>");
 338 /* Adoption to upstream Linux kernel */
 339 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>");
 340
 341 MODULE_DESCRIPTION("Intel(R) Integrated Sensor Hub PCI Device Driver");
 342 MODULE_LICENSE("GPL");