1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * PCI glue for ISHTP provider device (ISH) driver 4 * 5 * Copyright (c) 2014-2016, Intel Corporation. 6 */ 7 8 #include <linux/acpi.h> 9 #include <linux/module.h> 10 #include <linux/moduleparam.h> 11 #include <linux/kernel.h> 12 #include <linux/device.h> 13 #include <linux/fs.h> 14 #include <linux/errno.h> 15 #include <linux/types.h> 16 #include <linux/pci.h> 17 #include <linux/sched.h> 18 #include <linux/suspend.h> 19 #include <linux/interrupt.h> 20 #include <linux/workqueue.h> 21 #define CREATE_TRACE_POINTS 22 #include <trace/events/intel_ish.h> 23 #include "ishtp-dev.h" 24 #include "hw-ish.h" 25 26 static const struct pci_device_id ish_pci_tbl[] = { 27 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CHV_DEVICE_ID)}, 28 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, BXT_Ax_DEVICE_ID)}, 29 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, BXT_Bx_DEVICE_ID)}, 30 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, APL_Ax_DEVICE_ID)}, 31 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, SPT_Ax_DEVICE_ID)}, 32 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CNL_Ax_DEVICE_ID)}, 33 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, GLK_Ax_DEVICE_ID)}, 34 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CNL_H_DEVICE_ID)}, 35 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, ICL_MOBILE_DEVICE_ID)}, 36 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, SPT_H_DEVICE_ID)}, 37 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CML_LP_DEVICE_ID)}, 38 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, CMP_H_DEVICE_ID)}, 39 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, EHL_Ax_DEVICE_ID)}, 40 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, TGL_LP_DEVICE_ID)}, 41 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, TGL_H_DEVICE_ID)}, 42 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, ADL_S_DEVICE_ID)}, 43 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, ADL_P_DEVICE_ID)}, 44 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, ADL_N_DEVICE_ID)}, 45 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, RPL_S_DEVICE_ID)}, 46 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MTL_P_DEVICE_ID)}, 47 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, ARL_H_DEVICE_ID)}, 48 {0, } 49 }; 50 MODULE_DEVICE_TABLE(pci, ish_pci_tbl); 51 52 /** 53 * ish_event_tracer() - Callback function to dump trace messages 54 * @dev: ishtp device 55 * @format: printf style format 56 * 57 * Callback to direct log messages to Linux trace buffers 58 */ 59 static __printf(2, 3) 60 void ish_event_tracer(struct ishtp_device *dev, const char *format, ...) 61 { 62 if (trace_ishtp_dump_enabled()) { 63 va_list args; 64 char tmp_buf[100]; 65 66 va_start(args, format); 67 vsnprintf(tmp_buf, sizeof(tmp_buf), format, args); 68 va_end(args); 69 70 trace_ishtp_dump(tmp_buf); 71 } 72 } 73 74 /** 75 * ish_init() - Init function 76 * @dev: ishtp device 77 * 78 * This function initialize wait queues for suspend/resume and call 79 * calls hadware initialization function. This will initiate 80 * startup sequence 81 * 82 * Return: 0 for success or error code for failure 83 */ 84 static int ish_init(struct ishtp_device *dev) 85 { 86 int ret; 87 88 /* Set the state of ISH HW to start */ 89 ret = ish_hw_start(dev); 90 if (ret) { 91 dev_err(dev->devc, "ISH: hw start failed.\n"); 92 return ret; 93 } 94 95 /* Start the inter process communication to ISH processor */ 96 ret = ishtp_start(dev); 97 if (ret) { 98 dev_err(dev->devc, "ISHTP: Protocol init failed.\n"); 99 return ret; 100 } 101 102 return 0; 103 } 104 105 static const struct pci_device_id ish_invalid_pci_ids[] = { 106 /* Mehlow platform special pci ids */ 107 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0xA309)}, 108 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0xA30A)}, 109 {} 110 }; 111 112 static inline bool ish_should_enter_d0i3(struct pci_dev *pdev) 113 { 114 return !pm_suspend_via_firmware() || pdev->device == CHV_DEVICE_ID; 115 } 116 117 static inline bool ish_should_leave_d0i3(struct pci_dev *pdev) 118 { 119 return !pm_resume_via_firmware() || pdev->device == CHV_DEVICE_ID; 120 } 121 122 static int enable_gpe(struct device *dev) 123 { 124 #ifdef CONFIG_ACPI 125 acpi_status acpi_sts; 126 struct acpi_device *adev; 127 struct acpi_device_wakeup *wakeup; 128 129 adev = ACPI_COMPANION(dev); 130 if (!adev) { 131 dev_err(dev, "get acpi handle failed\n"); 132 return -ENODEV; 133 } 134 wakeup = &adev->wakeup; 135 136 acpi_sts = acpi_enable_gpe(wakeup->gpe_device, wakeup->gpe_number); 137 if (ACPI_FAILURE(acpi_sts)) { 138 dev_err(dev, "enable ose_gpe failed\n"); 139 return -EIO; 140 } 141 142 return 0; 143 #else 144 return -ENODEV; 145 #endif 146 } 147 148 static void enable_pme_wake(struct pci_dev *pdev) 149 { 150 if ((pci_pme_capable(pdev, PCI_D0) || 151 pci_pme_capable(pdev, PCI_D3hot) || 152 pci_pme_capable(pdev, PCI_D3cold)) && !enable_gpe(&pdev->dev)) { 153 pci_pme_active(pdev, true); 154 dev_dbg(&pdev->dev, "ish ipc driver pme wake enabled\n"); 155 } 156 } 157 158 /** 159 * ish_probe() - PCI driver probe callback 160 * @pdev: pci device 161 * @ent: pci device id 162 * 163 * Initialize PCI function, setup interrupt and call for ISH initialization 164 * 165 * Return: 0 for success or error code for failure 166 */ 167 static int ish_probe(struct pci_dev *pdev, const struct pci_device_id *ent) 168 { 169 int ret; 170 struct ish_hw *hw; 171 unsigned long irq_flag = 0; 172 struct ishtp_device *ishtp; 173 struct device *dev = &pdev->dev; 174 175 /* Check for invalid platforms for ISH support */ 176 if (pci_dev_present(ish_invalid_pci_ids)) 177 return -ENODEV; 178 179 /* enable pci dev */ 180 ret = pcim_enable_device(pdev); 181 if (ret) { 182 dev_err(dev, "ISH: Failed to enable PCI device\n"); 183 return ret; 184 } 185 186 /* set PCI host mastering */ 187 pci_set_master(pdev); 188 189 /* pci request regions for ISH driver */ 190 ret = pcim_iomap_regions(pdev, 1 << 0, KBUILD_MODNAME); 191 if (ret) { 192 dev_err(dev, "ISH: Failed to get PCI regions\n"); 193 return ret; 194 } 195 196 /* allocates and initializes the ISH dev structure */ 197 ishtp = ish_dev_init(pdev); 198 if (!ishtp) { 199 ret = -ENOMEM; 200 return ret; 201 } 202 hw = to_ish_hw(ishtp); 203 ishtp->print_log = ish_event_tracer; 204 205 /* mapping IO device memory */ 206 hw->mem_addr = pcim_iomap_table(pdev)[0]; 207 ishtp->pdev = pdev; 208 209 /* request and enable interrupt */ 210 ret = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_ALL_TYPES); 211 if (!pdev->msi_enabled && !pdev->msix_enabled) 212 irq_flag = IRQF_SHARED; 213 214 ret = devm_request_irq(dev, pdev->irq, ish_irq_handler, 215 irq_flag, KBUILD_MODNAME, ishtp); 216 if (ret) { 217 dev_err(dev, "ISH: request IRQ %d failed\n", pdev->irq); 218 return ret; 219 } 220 221 dev_set_drvdata(ishtp->devc, ishtp); 222 223 init_waitqueue_head(&ishtp->suspend_wait); 224 init_waitqueue_head(&ishtp->resume_wait); 225 226 /* Enable PME for EHL */ 227 if (pdev->device == EHL_Ax_DEVICE_ID) 228 enable_pme_wake(pdev); 229 230 ret = ish_init(ishtp); 231 if (ret) 232 return ret; 233 234 return 0; 235 } 236 237 /** 238 * ish_remove() - PCI driver remove callback 239 * @pdev: pci device 240 * 241 * This function does cleanup of ISH on pci remove callback 242 */ 243 static void ish_remove(struct pci_dev *pdev) 244 { 245 struct ishtp_device *ishtp_dev = pci_get_drvdata(pdev); 246 247 ishtp_bus_remove_all_clients(ishtp_dev, false); 248 ish_device_disable(ishtp_dev); 249 } 250 251 static struct device __maybe_unused *ish_resume_device; 252 253 /* 50ms to get resume response */ 254 #define WAIT_FOR_RESUME_ACK_MS 50 255 256 /** 257 * ish_resume_handler() - Work function to complete resume 258 * @work: work struct 259 * 260 * The resume work function to complete resume function asynchronously. 261 * There are two resume paths, one where ISH is not powered off, 262 * in that case a simple resume message is enough, others we need 263 * a reset sequence. 264 */ 265 static void __maybe_unused ish_resume_handler(struct work_struct *work) 266 { 267 struct pci_dev *pdev = to_pci_dev(ish_resume_device); 268 struct ishtp_device *dev = pci_get_drvdata(pdev); 269 uint32_t fwsts = dev->ops->get_fw_status(dev); 270 271 if (ish_should_leave_d0i3(pdev) && !dev->suspend_flag 272 && IPC_IS_ISH_ILUP(fwsts)) { 273 if (device_may_wakeup(&pdev->dev)) 274 disable_irq_wake(pdev->irq); 275 276 ish_set_host_ready(dev); 277 278 ishtp_send_resume(dev); 279 280 /* Waiting to get resume response */ 281 if (dev->resume_flag) 282 wait_event_interruptible_timeout(dev->resume_wait, 283 !dev->resume_flag, 284 msecs_to_jiffies(WAIT_FOR_RESUME_ACK_MS)); 285 286 /* 287 * If the flag is not cleared, something is wrong with ISH FW. 288 * So on resume, need to go through init sequence again. 289 */ 290 if (dev->resume_flag) 291 ish_init(dev); 292 } else { 293 /* 294 * Resume from the D3, full reboot of ISH processor will happen, 295 * so need to go through init sequence again. 296 */ 297 ish_init(dev); 298 } 299 } 300 301 /** 302 * ish_suspend() - ISH suspend callback 303 * @device: device pointer 304 * 305 * ISH suspend callback 306 * 307 * Return: 0 to the pm core 308 */ 309 static int __maybe_unused ish_suspend(struct device *device) 310 { 311 struct pci_dev *pdev = to_pci_dev(device); 312 struct ishtp_device *dev = pci_get_drvdata(pdev); 313 314 if (ish_should_enter_d0i3(pdev)) { 315 /* 316 * If previous suspend hasn't been asnwered then ISH is likely 317 * dead, don't attempt nested notification 318 */ 319 if (dev->suspend_flag) 320 return 0; 321 322 dev->resume_flag = 0; 323 dev->suspend_flag = 1; 324 ishtp_send_suspend(dev); 325 326 /* 25 ms should be enough for live ISH to flush all IPC buf */ 327 if (dev->suspend_flag) 328 wait_event_interruptible_timeout(dev->suspend_wait, 329 !dev->suspend_flag, 330 msecs_to_jiffies(25)); 331 332 if (dev->suspend_flag) { 333 /* 334 * It looks like FW halt, clear the DMA bit, and put 335 * ISH into D3, and FW would reset on resume. 336 */ 337 ish_disable_dma(dev); 338 } else { 339 /* 340 * Save state so PCI core will keep the device at D0, 341 * the ISH would enter D0i3 342 */ 343 pci_save_state(pdev); 344 345 if (device_may_wakeup(&pdev->dev)) 346 enable_irq_wake(pdev->irq); 347 } 348 } else { 349 /* 350 * Clear the DMA bit before putting ISH into D3, 351 * or ISH FW would reset automatically. 352 */ 353 ish_disable_dma(dev); 354 } 355 356 return 0; 357 } 358 359 static __maybe_unused DECLARE_WORK(resume_work, ish_resume_handler); 360 /** 361 * ish_resume() - ISH resume callback 362 * @device: device pointer 363 * 364 * ISH resume callback 365 * 366 * Return: 0 to the pm core 367 */ 368 static int __maybe_unused ish_resume(struct device *device) 369 { 370 struct pci_dev *pdev = to_pci_dev(device); 371 struct ishtp_device *dev = pci_get_drvdata(pdev); 372 373 /* add this to finish power flow for EHL */ 374 if (dev->pdev->device == EHL_Ax_DEVICE_ID) { 375 pci_set_power_state(pdev, PCI_D0); 376 enable_pme_wake(pdev); 377 dev_dbg(dev->devc, "set power state to D0 for ehl\n"); 378 } 379 380 ish_resume_device = device; 381 dev->resume_flag = 1; 382 383 schedule_work(&resume_work); 384 385 return 0; 386 } 387 388 static SIMPLE_DEV_PM_OPS(ish_pm_ops, ish_suspend, ish_resume); 389 390 static struct pci_driver ish_driver = { 391 .name = KBUILD_MODNAME, 392 .id_table = ish_pci_tbl, 393 .probe = ish_probe, 394 .remove = ish_remove, 395 .driver.pm = &ish_pm_ops, 396 }; 397 398 module_pci_driver(ish_driver); 399 400 /* Original author */ 401 MODULE_AUTHOR("Daniel Drubin <daniel.drubin@intel.com>"); 402 /* Adoption to upstream Linux kernel */ 403 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>"); 404 405 MODULE_DESCRIPTION("Intel(R) Integrated Sensor Hub PCI Device Driver"); 406 MODULE_LICENSE("GPL"); 407