1 /* 2 * PCI glue for ISHTP provider device (ISH) driver 3 * 4 * Copyright (c) 2014-2016, Intel Corporation. 5 * 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. 9 * 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 13 * more details. 14 */ 15 16 #include <linux/module.h> 17 #include <linux/moduleparam.h> 18 #include <linux/kernel.h> 19 #include <linux/device.h> 20 #include <linux/fs.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" 30 #include "hw-ish.h" 31 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)}, 43 {0, } 44 }; 45 MODULE_DEVICE_TABLE(pci, ish_pci_tbl); 46 47 /** 48 * ish_event_tracer() - Callback function to dump trace messages 49 * @dev: ishtp device 50 * @format: printf style format 51 * 52 * Callback to direct log messages to Linux trace buffers 53 */ 54 static __printf(2, 3) 55 void ish_event_tracer(struct ishtp_device *dev, const char *format, ...) 56 { 57 if (trace_ishtp_dump_enabled()) { 58 va_list args; 59 char tmp_buf[100]; 60 61 va_start(args, format); 62 vsnprintf(tmp_buf, sizeof(tmp_buf), format, args); 63 va_end(args); 64 65 trace_ishtp_dump(tmp_buf); 66 } 67 } 68 69 /** 70 * ish_init() - Init function 71 * @dev: ishtp device 72 * 73 * This function initialize wait queues for suspend/resume and call 74 * calls hadware initialization function. This will initiate 75 * startup sequence 76 * 77 * Return: 0 for success or error code for failure 78 */ 79 static int ish_init(struct ishtp_device *dev) 80 { 81 int ret; 82 83 /* Set the state of ISH HW to start */ 84 ret = ish_hw_start(dev); 85 if (ret) { 86 dev_err(dev->devc, "ISH: hw start failed.\n"); 87 return ret; 88 } 89 90 /* Start the inter process communication to ISH processor */ 91 ret = ishtp_start(dev); 92 if (ret) { 93 dev_err(dev->devc, "ISHTP: Protocol init failed.\n"); 94 return ret; 95 } 96 97 return 0; 98 } 99 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)}, 104 {} 105 }; 106 107 /** 108 * ish_probe() - PCI driver probe callback 109 * @pdev: pci device 110 * @ent: pci device id 111 * 112 * Initialize PCI function, setup interrupt and call for ISH initialization 113 * 114 * Return: 0 for success or error code for failure 115 */ 116 static int ish_probe(struct pci_dev *pdev, const struct pci_device_id *ent) 117 { 118 int ret; 119 struct ish_hw *hw; 120 struct ishtp_device *ishtp; 121 struct device *dev = &pdev->dev; 122 123 /* Check for invalid platforms for ISH support */ 124 if (pci_dev_present(ish_invalid_pci_ids)) 125 return -ENODEV; 126 127 /* enable pci dev */ 128 ret = pcim_enable_device(pdev); 129 if (ret) { 130 dev_err(dev, "ISH: Failed to enable PCI device\n"); 131 return ret; 132 } 133 134 /* set PCI host mastering */ 135 pci_set_master(pdev); 136 137 /* pci request regions for ISH driver */ 138 ret = pcim_iomap_regions(pdev, 1 << 0, KBUILD_MODNAME); 139 if (ret) { 140 dev_err(dev, "ISH: Failed to get PCI regions\n"); 141 return ret; 142 } 143 144 /* allocates and initializes the ISH dev structure */ 145 ishtp = ish_dev_init(pdev); 146 if (!ishtp) { 147 ret = -ENOMEM; 148 return ret; 149 } 150 hw = to_ish_hw(ishtp); 151 ishtp->print_log = ish_event_tracer; 152 153 /* mapping IO device memory */ 154 hw->mem_addr = pcim_iomap_table(pdev)[0]; 155 ishtp->pdev = pdev; 156 pdev->dev_flags |= PCI_DEV_FLAGS_NO_D3; 157 158 /* request and enable interrupt */ 159 ret = devm_request_irq(dev, pdev->irq, ish_irq_handler, 160 IRQF_SHARED, KBUILD_MODNAME, ishtp); 161 if (ret) { 162 dev_err(dev, "ISH: request IRQ %d failed\n", pdev->irq); 163 return ret; 164 } 165 166 dev_set_drvdata(ishtp->devc, ishtp); 167 168 init_waitqueue_head(&ishtp->suspend_wait); 169 init_waitqueue_head(&ishtp->resume_wait); 170 171 ret = ish_init(ishtp); 172 if (ret) 173 return ret; 174 175 return 0; 176 } 177 178 /** 179 * ish_remove() - PCI driver remove callback 180 * @pdev: pci device 181 * 182 * This function does cleanup of ISH on pci remove callback 183 */ 184 static void ish_remove(struct pci_dev *pdev) 185 { 186 struct ishtp_device *ishtp_dev = pci_get_drvdata(pdev); 187 188 ishtp_bus_remove_all_clients(ishtp_dev, false); 189 ish_device_disable(ishtp_dev); 190 } 191 192 static struct device __maybe_unused *ish_resume_device; 193 194 /* 50ms to get resume response */ 195 #define WAIT_FOR_RESUME_ACK_MS 50 196 197 /** 198 * ish_resume_handler() - Work function to complete resume 199 * @work: work struct 200 * 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 204 * a reset sequence. 205 */ 206 static void __maybe_unused ish_resume_handler(struct work_struct *work) 207 { 208 struct pci_dev *pdev = to_pci_dev(ish_resume_device); 209 struct ishtp_device *dev = pci_get_drvdata(pdev); 210 uint32_t fwsts; 211 int ret; 212 213 /* Get ISH FW status */ 214 fwsts = IPC_GET_ISH_FWSTS(dev->ops->get_fw_status(dev)); 215 216 /* 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. 219 */ 220 if (fwsts >= FWSTS_SENSOR_APP_LOADED) { 221 ishtp_send_resume(dev); 222 223 /* Waiting to get resume response */ 224 if (dev->resume_flag) 225 ret = wait_event_interruptible_timeout(dev->resume_wait, 226 !dev->resume_flag, 227 msecs_to_jiffies(WAIT_FOR_RESUME_ACK_MS)); 228 } 229 230 /* 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. 235 */ 236 if (dev->resume_flag) 237 ish_init(dev); 238 } 239 240 /** 241 * ish_suspend() - ISH suspend callback 242 * @device: device pointer 243 * 244 * ISH suspend callback 245 * 246 * Return: 0 to the pm core 247 */ 248 static int __maybe_unused ish_suspend(struct device *device) 249 { 250 struct pci_dev *pdev = to_pci_dev(device); 251 struct ishtp_device *dev = pci_get_drvdata(pdev); 252 253 enable_irq_wake(pdev->irq); 254 /* 255 * If previous suspend hasn't been asnwered then ISH is likely dead, 256 * don't attempt nested notification 257 */ 258 if (dev->suspend_flag) 259 return 0; 260 261 dev->resume_flag = 0; 262 dev->suspend_flag = 1; 263 ishtp_send_suspend(dev); 264 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, 268 !dev->suspend_flag, 269 msecs_to_jiffies(25)); 270 271 return 0; 272 } 273 274 static __maybe_unused DECLARE_WORK(resume_work, ish_resume_handler); 275 /** 276 * ish_resume() - ISH resume callback 277 * @device: device pointer 278 * 279 * ISH resume callback 280 * 281 * Return: 0 to the pm core 282 */ 283 static int __maybe_unused ish_resume(struct device *device) 284 { 285 struct pci_dev *pdev = to_pci_dev(device); 286 struct ishtp_device *dev = pci_get_drvdata(pdev); 287 288 ish_resume_device = device; 289 dev->resume_flag = 1; 290 291 disable_irq_wake(pdev->irq); 292 schedule_work(&resume_work); 293 294 return 0; 295 } 296 297 static SIMPLE_DEV_PM_OPS(ish_pm_ops, ish_suspend, ish_resume); 298 299 static struct pci_driver ish_driver = { 300 .name = KBUILD_MODNAME, 301 .id_table = ish_pci_tbl, 302 .probe = ish_probe, 303 .remove = ish_remove, 304 .driver.pm = &ish_pm_ops, 305 }; 306 307 module_pci_driver(ish_driver); 308 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>"); 313 314 MODULE_DESCRIPTION("Intel(R) Integrated Sensor Hub PCI Device Driver"); 315 MODULE_LICENSE("GPL"); 316