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)},
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)},
45 MODULE_DEVICE_TABLE(pci, ish_pci_tbl);
48 * ish_event_tracer() - Callback function to dump trace messages
50 * @format: printf style format
52 * Callback to direct log messages to Linux trace buffers
55 void ish_event_tracer(struct ishtp_device *dev, const char *format, ...)
57 if (trace_ishtp_dump_enabled()) {
61 va_start(args, format);
62 vsnprintf(tmp_buf, sizeof(tmp_buf), format, args);
65 trace_ishtp_dump(tmp_buf);
70 * ish_init() - Init function
73 * This function initialize wait queues for suspend/resume and call
74 * calls hadware initialization function. This will initiate
77 * Return: 0 for success or error code for failure
79 static int ish_init(struct ishtp_device *dev)
83 /* Set the state of ISH HW to start */
84 ret = ish_hw_start(dev);
86 dev_err(dev->devc, "ISH: hw start failed.\n");
90 /* Start the inter process communication to ISH processor */
91 ret = ishtp_start(dev);
93 dev_err(dev->devc, "ISHTP: Protocol init failed.\n");
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)},
108 * ish_probe() - PCI driver probe callback
110 * @ent: pci device id
112 * Initialize PCI function, setup interrupt and call for ISH initialization
114 * Return: 0 for success or error code for failure
116 static int ish_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
120 struct ishtp_device *ishtp;
121 struct device *dev = &pdev->dev;
123 /* Check for invalid platforms for ISH support */
124 if (pci_dev_present(ish_invalid_pci_ids))
128 ret = pcim_enable_device(pdev);
130 dev_err(dev, "ISH: Failed to enable PCI device\n");
134 /* set PCI host mastering */
135 pci_set_master(pdev);
137 /* pci request regions for ISH driver */
138 ret = pcim_iomap_regions(pdev, 1 << 0, KBUILD_MODNAME);
140 dev_err(dev, "ISH: Failed to get PCI regions\n");
144 /* allocates and initializes the ISH dev structure */
145 ishtp = ish_dev_init(pdev);
150 hw = to_ish_hw(ishtp);
151 ishtp->print_log = ish_event_tracer;
153 /* mapping IO device memory */
154 hw->mem_addr = pcim_iomap_table(pdev)[0];
156 pdev->dev_flags |= PCI_DEV_FLAGS_NO_D3;
158 /* request and enable interrupt */
159 ret = devm_request_irq(dev, pdev->irq, ish_irq_handler,
160 IRQF_SHARED, KBUILD_MODNAME, ishtp);
162 dev_err(dev, "ISH: request IRQ %d failed\n", pdev->irq);
166 dev_set_drvdata(ishtp->devc, ishtp);
168 init_waitqueue_head(&ishtp->suspend_wait);
169 init_waitqueue_head(&ishtp->resume_wait);
171 ret = ish_init(ishtp);
179 * ish_remove() - PCI driver remove callback
182 * This function does cleanup of ISH on pci remove callback
184 static void ish_remove(struct pci_dev *pdev)
186 struct ishtp_device *ishtp_dev = pci_get_drvdata(pdev);
188 ishtp_bus_remove_all_clients(ishtp_dev, false);
189 ish_device_disable(ishtp_dev);
192 static struct device __maybe_unused *ish_resume_device;
194 /* 50ms to get resume response */
195 #define WAIT_FOR_RESUME_ACK_MS 50
198 * ish_resume_handler() - Work function to complete resume
201 * The resume work function to complete resume function asynchronously.
202 * There are two resume paths, one where ISH is not powered off,
203 * in that case a simple resume message is enough, others we need
206 static void __maybe_unused ish_resume_handler(struct work_struct *work)
208 struct pci_dev *pdev = to_pci_dev(ish_resume_device);
209 struct ishtp_device *dev = pci_get_drvdata(pdev);
213 /* Get ISH FW status */
214 fwsts = IPC_GET_ISH_FWSTS(dev->ops->get_fw_status(dev));
217 * If currently, in ISH FW, sensor app is loaded or beyond that,
218 * it means ISH isn't powered off, in this case, send a resume message.
220 if (fwsts >= FWSTS_SENSOR_APP_LOADED) {
221 ishtp_send_resume(dev);
223 /* Waiting to get resume response */
224 if (dev->resume_flag)
225 ret = wait_event_interruptible_timeout(dev->resume_wait,
227 msecs_to_jiffies(WAIT_FOR_RESUME_ACK_MS));
231 * If in ISH FW, sensor app isn't loaded yet, or no resume response.
232 * That means this platform is not S0ix compatible, or something is
233 * wrong with ISH FW. So on resume, full reboot of ISH processor will
234 * happen, so need to go through init sequence again.
236 if (dev->resume_flag)
241 * ish_suspend() - ISH suspend callback
242 * @device: device pointer
244 * ISH suspend callback
246 * Return: 0 to the pm core
248 static int __maybe_unused ish_suspend(struct device *device)
250 struct pci_dev *pdev = to_pci_dev(device);
251 struct ishtp_device *dev = pci_get_drvdata(pdev);
253 enable_irq_wake(pdev->irq);
255 * If previous suspend hasn't been asnwered then ISH is likely dead,
256 * don't attempt nested notification
258 if (dev->suspend_flag)
261 dev->resume_flag = 0;
262 dev->suspend_flag = 1;
263 ishtp_send_suspend(dev);
265 /* 25 ms should be enough for live ISH to flush all IPC buf */
266 if (dev->suspend_flag)
267 wait_event_interruptible_timeout(dev->suspend_wait,
269 msecs_to_jiffies(25));
274 static __maybe_unused DECLARE_WORK(resume_work, ish_resume_handler);
276 * ish_resume() - ISH resume callback
277 * @device: device pointer
279 * ISH resume callback
281 * Return: 0 to the pm core
283 static int __maybe_unused ish_resume(struct device *device)
285 struct pci_dev *pdev = to_pci_dev(device);
286 struct ishtp_device *dev = pci_get_drvdata(pdev);
288 ish_resume_device = device;
289 dev->resume_flag = 1;
291 disable_irq_wake(pdev->irq);
292 schedule_work(&resume_work);
297 static SIMPLE_DEV_PM_OPS(ish_pm_ops, ish_suspend, ish_resume);
299 static struct pci_driver ish_driver = {
300 .name = KBUILD_MODNAME,
301 .id_table = ish_pci_tbl,
303 .remove = ish_remove,
304 .driver.pm = &ish_pm_ops,
307 module_pci_driver(ish_driver);
309 /* Original author */
310 MODULE_AUTHOR("Daniel Drubin <daniel.drubin@intel.com>");
311 /* Adoption to upstream Linux kernel */
312 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>");
314 MODULE_DESCRIPTION("Intel(R) Integrated Sensor Hub PCI Device Driver");
315 MODULE_LICENSE("GPL");