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 #include <linux/miscdevice.h>
28 #define CREATE_TRACE_POINTS
29 #include <trace/events/intel_ish.h>
30 #include "ishtp-dev.h"
33 static const struct pci_device_id ish_pci_tbl[] = {
34 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CHV_DEVICE_ID)},
35 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, BXT_Ax_DEVICE_ID)},
36 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, BXT_Bx_DEVICE_ID)},
37 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, APL_Ax_DEVICE_ID)},
38 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, SPT_Ax_DEVICE_ID)},
41 MODULE_DEVICE_TABLE(pci, ish_pci_tbl);
44 * ish_event_tracer() - Callback function to dump trace messages
46 * @format: printf style format
48 * Callback to direct log messages to Linux trace buffers
51 void ish_event_tracer(struct ishtp_device *dev, const char *format, ...)
53 if (trace_ishtp_dump_enabled()) {
57 va_start(args, format);
58 vsnprintf(tmp_buf, sizeof(tmp_buf), format, args);
61 trace_ishtp_dump(tmp_buf);
66 * ish_init() - Init function
69 * This function initialize wait queues for suspend/resume and call
70 * calls hadware initialization function. This will initiate
73 * Return: 0 for success or error code for failure
75 static int ish_init(struct ishtp_device *dev)
79 /* Set the state of ISH HW to start */
80 ret = ish_hw_start(dev);
82 dev_err(dev->devc, "ISH: hw start failed.\n");
86 /* Start the inter process communication to ISH processor */
87 ret = ishtp_start(dev);
89 dev_err(dev->devc, "ISHTP: Protocol init failed.\n");
97 * ish_probe() - PCI driver probe callback
101 * Initialize PCI function, setup interrupt and call for ISH initialization
103 * Return: 0 for success or error code for failure
105 static int ish_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
107 struct ishtp_device *dev;
112 ret = pci_enable_device(pdev);
114 dev_err(&pdev->dev, "ISH: Failed to enable PCI device\n");
118 /* set PCI host mastering */
119 pci_set_master(pdev);
121 /* pci request regions for ISH driver */
122 ret = pci_request_regions(pdev, KBUILD_MODNAME);
124 dev_err(&pdev->dev, "ISH: Failed to get PCI regions\n");
128 /* allocates and initializes the ISH dev structure */
129 dev = ish_dev_init(pdev);
132 goto release_regions;
135 dev->print_log = ish_event_tracer;
137 /* mapping IO device memory */
138 hw->mem_addr = pci_iomap(pdev, 0, 0);
140 dev_err(&pdev->dev, "ISH: mapping I/O range failure\n");
147 pdev->dev_flags |= PCI_DEV_FLAGS_NO_D3;
149 /* request and enable interrupt */
150 ret = request_irq(pdev->irq, ish_irq_handler, IRQF_SHARED,
151 KBUILD_MODNAME, dev);
153 dev_err(&pdev->dev, "ISH: request IRQ failure (%d)\n",
158 dev_set_drvdata(dev->devc, dev);
160 init_waitqueue_head(&dev->suspend_wait);
161 init_waitqueue_head(&dev->resume_wait);
170 free_irq(pdev->irq, dev);
172 pci_iounmap(pdev, hw->mem_addr);
175 pci_release_regions(pdev);
177 pci_clear_master(pdev);
178 pci_disable_device(pdev);
179 dev_err(&pdev->dev, "ISH: PCI driver initialization failed.\n");
185 * ish_remove() - PCI driver remove callback
188 * This function does cleanup of ISH on pci remove callback
190 static void ish_remove(struct pci_dev *pdev)
192 struct ishtp_device *ishtp_dev = pci_get_drvdata(pdev);
193 struct ish_hw *hw = to_ish_hw(ishtp_dev);
195 ishtp_bus_remove_all_clients(ishtp_dev, false);
196 ish_device_disable(ishtp_dev);
198 free_irq(pdev->irq, ishtp_dev);
199 pci_iounmap(pdev, hw->mem_addr);
200 pci_release_regions(pdev);
201 pci_clear_master(pdev);
202 pci_disable_device(pdev);
207 static struct device *ish_resume_device;
210 * ish_resume_handler() - Work function to complete resume
213 * The resume work function to complete resume function asynchronously.
214 * There are two types of platforms, one where ISH is not powered off,
215 * in that case a simple resume message is enough, others we need
218 static void ish_resume_handler(struct work_struct *work)
220 struct pci_dev *pdev = to_pci_dev(ish_resume_device);
221 struct ishtp_device *dev = pci_get_drvdata(pdev);
224 ishtp_send_resume(dev);
226 /* 50 ms to get resume response */
227 if (dev->resume_flag)
228 ret = wait_event_interruptible_timeout(dev->resume_wait,
230 msecs_to_jiffies(50));
233 * If no resume response. This platform is not S0ix compatible
234 * So on resume full reboot of ISH processor will happen, so
235 * need to go through init sequence again
237 if (dev->resume_flag)
242 * ish_suspend() - ISH suspend callback
243 * @device: device pointer
245 * ISH suspend callback
247 * Return: 0 to the pm core
249 static int ish_suspend(struct device *device)
251 struct pci_dev *pdev = to_pci_dev(device);
252 struct ishtp_device *dev = pci_get_drvdata(pdev);
254 enable_irq_wake(pdev->irq);
256 * If previous suspend hasn't been asnwered then ISH is likely dead,
257 * don't attempt nested notification
259 if (dev->suspend_flag)
262 dev->resume_flag = 0;
263 dev->suspend_flag = 1;
264 ishtp_send_suspend(dev);
266 /* 25 ms should be enough for live ISH to flush all IPC buf */
267 if (dev->suspend_flag)
268 wait_event_interruptible_timeout(dev->suspend_wait,
270 msecs_to_jiffies(25));
275 static DECLARE_WORK(resume_work, ish_resume_handler);
277 * ish_resume() - ISH resume callback
278 * @device: device pointer
280 * ISH resume callback
282 * Return: 0 to the pm core
284 static int ish_resume(struct device *device)
286 struct pci_dev *pdev = to_pci_dev(device);
287 struct ishtp_device *dev = pci_get_drvdata(pdev);
289 ish_resume_device = device;
290 dev->resume_flag = 1;
292 disable_irq_wake(pdev->irq);
293 schedule_work(&resume_work);
298 static const struct dev_pm_ops ish_pm_ops = {
299 .suspend = ish_suspend,
300 .resume = ish_resume,
302 #define ISHTP_ISH_PM_OPS (&ish_pm_ops)
304 #define ISHTP_ISH_PM_OPS NULL
305 #endif /* CONFIG_PM */
307 static struct pci_driver ish_driver = {
308 .name = KBUILD_MODNAME,
309 .id_table = ish_pci_tbl,
311 .remove = ish_remove,
312 .driver.pm = ISHTP_ISH_PM_OPS,
315 module_pci_driver(ish_driver);
317 /* Original author */
318 MODULE_AUTHOR("Daniel Drubin <daniel.drubin@intel.com>");
319 /* Adoption to upstream Linux kernel */
320 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>");
322 MODULE_DESCRIPTION("Intel(R) Integrated Sensor Hub PCI Device Driver");
323 MODULE_LICENSE("GPL");