1 // SPDX-License-Identifier: GPL-2.0-only
3 * PCI glue for ISHTP provider device (ISH) driver
5 * Copyright (c) 2014-2016, Intel Corporation.
8 #include <linux/module.h>
9 #include <linux/moduleparam.h>
10 #include <linux/kernel.h>
11 #include <linux/device.h>
13 #include <linux/errno.h>
14 #include <linux/types.h>
15 #include <linux/pci.h>
16 #include <linux/sched.h>
17 #include <linux/interrupt.h>
18 #include <linux/workqueue.h>
19 #define CREATE_TRACE_POINTS
20 #include <trace/events/intel_ish.h>
21 #include "ishtp-dev.h"
24 static const struct pci_device_id ish_pci_tbl[] = {
25 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CHV_DEVICE_ID)},
26 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, BXT_Ax_DEVICE_ID)},
27 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, BXT_Bx_DEVICE_ID)},
28 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, APL_Ax_DEVICE_ID)},
29 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, SPT_Ax_DEVICE_ID)},
30 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CNL_Ax_DEVICE_ID)},
31 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, GLK_Ax_DEVICE_ID)},
32 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CNL_H_DEVICE_ID)},
33 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, ICL_MOBILE_DEVICE_ID)},
34 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, SPT_H_DEVICE_ID)},
35 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CML_LP_DEVICE_ID)},
36 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, EHL_Ax_DEVICE_ID)},
39 MODULE_DEVICE_TABLE(pci, ish_pci_tbl);
42 * ish_event_tracer() - Callback function to dump trace messages
44 * @format: printf style format
46 * Callback to direct log messages to Linux trace buffers
49 void ish_event_tracer(struct ishtp_device *dev, const char *format, ...)
51 if (trace_ishtp_dump_enabled()) {
55 va_start(args, format);
56 vsnprintf(tmp_buf, sizeof(tmp_buf), format, args);
59 trace_ishtp_dump(tmp_buf);
64 * ish_init() - Init function
67 * This function initialize wait queues for suspend/resume and call
68 * calls hadware initialization function. This will initiate
71 * Return: 0 for success or error code for failure
73 static int ish_init(struct ishtp_device *dev)
77 /* Set the state of ISH HW to start */
78 ret = ish_hw_start(dev);
80 dev_err(dev->devc, "ISH: hw start failed.\n");
84 /* Start the inter process communication to ISH processor */
85 ret = ishtp_start(dev);
87 dev_err(dev->devc, "ISHTP: Protocol init failed.\n");
94 static const struct pci_device_id ish_invalid_pci_ids[] = {
95 /* Mehlow platform special pci ids */
96 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0xA309)},
97 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0xA30A)},
102 * ish_probe() - PCI driver probe callback
104 * @ent: pci device id
106 * Initialize PCI function, setup interrupt and call for ISH initialization
108 * Return: 0 for success or error code for failure
110 static int ish_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
114 unsigned long irq_flag = 0;
115 struct ishtp_device *ishtp;
116 struct device *dev = &pdev->dev;
118 /* Check for invalid platforms for ISH support */
119 if (pci_dev_present(ish_invalid_pci_ids))
123 ret = pcim_enable_device(pdev);
125 dev_err(dev, "ISH: Failed to enable PCI device\n");
129 /* set PCI host mastering */
130 pci_set_master(pdev);
132 /* pci request regions for ISH driver */
133 ret = pcim_iomap_regions(pdev, 1 << 0, KBUILD_MODNAME);
135 dev_err(dev, "ISH: Failed to get PCI regions\n");
139 /* allocates and initializes the ISH dev structure */
140 ishtp = ish_dev_init(pdev);
145 hw = to_ish_hw(ishtp);
146 ishtp->print_log = ish_event_tracer;
148 /* mapping IO device memory */
149 hw->mem_addr = pcim_iomap_table(pdev)[0];
151 pdev->dev_flags |= PCI_DEV_FLAGS_NO_D3;
153 /* request and enable interrupt */
154 ret = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_ALL_TYPES);
155 if (!pdev->msi_enabled && !pdev->msix_enabled)
156 irq_flag = IRQF_SHARED;
158 ret = devm_request_irq(dev, pdev->irq, ish_irq_handler,
159 irq_flag, KBUILD_MODNAME, ishtp);
161 dev_err(dev, "ISH: request IRQ %d failed\n", pdev->irq);
165 dev_set_drvdata(ishtp->devc, ishtp);
167 init_waitqueue_head(&ishtp->suspend_wait);
168 init_waitqueue_head(&ishtp->resume_wait);
170 ret = ish_init(ishtp);
178 * ish_remove() - PCI driver remove callback
181 * This function does cleanup of ISH on pci remove callback
183 static void ish_remove(struct pci_dev *pdev)
185 struct ishtp_device *ishtp_dev = pci_get_drvdata(pdev);
187 ishtp_bus_remove_all_clients(ishtp_dev, false);
188 pdev->dev_flags &= ~PCI_DEV_FLAGS_NO_D3;
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");