2 * PCI glue for ISHTP provider device (ISH) driver
4 * Copyright (c) 2014-2016, Intel Corporation.
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.
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
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/kernel.h>
19 #include <linux/device.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"
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)},
42 MODULE_DEVICE_TABLE(pci, ish_pci_tbl);
45 * ish_event_tracer() - Callback function to dump trace messages
47 * @format: printf style format
49 * Callback to direct log messages to Linux trace buffers
52 void ish_event_tracer(struct ishtp_device *dev, const char *format, ...)
54 if (trace_ishtp_dump_enabled()) {
58 va_start(args, format);
59 vsnprintf(tmp_buf, sizeof(tmp_buf), format, args);
62 trace_ishtp_dump(tmp_buf);
67 * ish_init() - Init function
70 * This function initialize wait queues for suspend/resume and call
71 * calls hadware initialization function. This will initiate
74 * Return: 0 for success or error code for failure
76 static int ish_init(struct ishtp_device *dev)
80 /* Set the state of ISH HW to start */
81 ret = ish_hw_start(dev);
83 dev_err(dev->devc, "ISH: hw start failed.\n");
87 /* Start the inter process communication to ISH processor */
88 ret = ishtp_start(dev);
90 dev_err(dev->devc, "ISHTP: Protocol init failed.\n");
98 * ish_probe() - PCI driver probe callback
100 * @ent: pci device id
102 * Initialize PCI function, setup interrupt and call for ISH initialization
104 * Return: 0 for success or error code for failure
106 static int ish_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
108 struct ishtp_device *dev;
113 ret = pci_enable_device(pdev);
115 dev_err(&pdev->dev, "ISH: Failed to enable PCI device\n");
119 /* set PCI host mastering */
120 pci_set_master(pdev);
122 /* pci request regions for ISH driver */
123 ret = pci_request_regions(pdev, KBUILD_MODNAME);
125 dev_err(&pdev->dev, "ISH: Failed to get PCI regions\n");
129 /* allocates and initializes the ISH dev structure */
130 dev = ish_dev_init(pdev);
133 goto release_regions;
136 dev->print_log = ish_event_tracer;
138 /* mapping IO device memory */
139 hw->mem_addr = pci_iomap(pdev, 0, 0);
141 dev_err(&pdev->dev, "ISH: mapping I/O range failure\n");
148 pdev->dev_flags |= PCI_DEV_FLAGS_NO_D3;
150 /* request and enable interrupt */
151 ret = request_irq(pdev->irq, ish_irq_handler, IRQF_SHARED,
152 KBUILD_MODNAME, dev);
154 dev_err(&pdev->dev, "ISH: request IRQ failure (%d)\n",
159 dev_set_drvdata(dev->devc, dev);
161 init_waitqueue_head(&dev->suspend_wait);
162 init_waitqueue_head(&dev->resume_wait);
171 free_irq(pdev->irq, dev);
173 pci_iounmap(pdev, hw->mem_addr);
176 pci_release_regions(pdev);
178 pci_clear_master(pdev);
179 pci_disable_device(pdev);
180 dev_err(&pdev->dev, "ISH: PCI driver initialization failed.\n");
186 * ish_remove() - PCI driver remove callback
189 * This function does cleanup of ISH on pci remove callback
191 static void ish_remove(struct pci_dev *pdev)
193 struct ishtp_device *ishtp_dev = pci_get_drvdata(pdev);
194 struct ish_hw *hw = to_ish_hw(ishtp_dev);
196 ishtp_bus_remove_all_clients(ishtp_dev, false);
197 ish_device_disable(ishtp_dev);
199 free_irq(pdev->irq, ishtp_dev);
200 pci_iounmap(pdev, hw->mem_addr);
201 pci_release_regions(pdev);
202 pci_clear_master(pdev);
203 pci_disable_device(pdev);
207 static struct device __maybe_unused *ish_resume_device;
209 /* 50ms to get resume response */
210 #define WAIT_FOR_RESUME_ACK_MS 50
213 * ish_resume_handler() - Work function to complete resume
216 * The resume work function to complete resume function asynchronously.
217 * There are two resume paths, one where ISH is not powered off,
218 * in that case a simple resume message is enough, others we need
221 static void __maybe_unused ish_resume_handler(struct work_struct *work)
223 struct pci_dev *pdev = to_pci_dev(ish_resume_device);
224 struct ishtp_device *dev = pci_get_drvdata(pdev);
228 /* Get ISH FW status */
229 fwsts = IPC_GET_ISH_FWSTS(dev->ops->get_fw_status(dev));
232 * If currently, in ISH FW, sensor app is loaded or beyond that,
233 * it means ISH isn't powered off, in this case, send a resume message.
235 if (fwsts >= FWSTS_SENSOR_APP_LOADED) {
236 ishtp_send_resume(dev);
238 /* Waiting to get resume response */
239 if (dev->resume_flag)
240 ret = wait_event_interruptible_timeout(dev->resume_wait,
242 msecs_to_jiffies(WAIT_FOR_RESUME_ACK_MS));
246 * If in ISH FW, sensor app isn't loaded yet, or no resume response.
247 * That means this platform is not S0ix compatible, or something is
248 * wrong with ISH FW. So on resume, full reboot of ISH processor will
249 * happen, so need to go through init sequence again.
251 if (dev->resume_flag)
256 * ish_suspend() - ISH suspend callback
257 * @device: device pointer
259 * ISH suspend callback
261 * Return: 0 to the pm core
263 static int __maybe_unused ish_suspend(struct device *device)
265 struct pci_dev *pdev = to_pci_dev(device);
266 struct ishtp_device *dev = pci_get_drvdata(pdev);
268 enable_irq_wake(pdev->irq);
270 * If previous suspend hasn't been asnwered then ISH is likely dead,
271 * don't attempt nested notification
273 if (dev->suspend_flag)
276 dev->resume_flag = 0;
277 dev->suspend_flag = 1;
278 ishtp_send_suspend(dev);
280 /* 25 ms should be enough for live ISH to flush all IPC buf */
281 if (dev->suspend_flag)
282 wait_event_interruptible_timeout(dev->suspend_wait,
284 msecs_to_jiffies(25));
289 static __maybe_unused DECLARE_WORK(resume_work, ish_resume_handler);
291 * ish_resume() - ISH resume callback
292 * @device: device pointer
294 * ISH resume callback
296 * Return: 0 to the pm core
298 static int __maybe_unused ish_resume(struct device *device)
300 struct pci_dev *pdev = to_pci_dev(device);
301 struct ishtp_device *dev = pci_get_drvdata(pdev);
303 ish_resume_device = device;
304 dev->resume_flag = 1;
306 disable_irq_wake(pdev->irq);
307 schedule_work(&resume_work);
312 static SIMPLE_DEV_PM_OPS(ish_pm_ops, ish_suspend, ish_resume);
314 static struct pci_driver ish_driver = {
315 .name = KBUILD_MODNAME,
316 .id_table = ish_pci_tbl,
318 .remove = ish_remove,
319 .driver.pm = &ish_pm_ops,
322 module_pci_driver(ish_driver);
324 /* Original author */
325 MODULE_AUTHOR("Daniel Drubin <daniel.drubin@intel.com>");
326 /* Adoption to upstream Linux kernel */
327 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>");
329 MODULE_DESCRIPTION("Intel(R) Integrated Sensor Hub PCI Device Driver");
330 MODULE_LICENSE("GPL");