1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2003-2020, Intel Corporation. All rights reserved.
4 * Intel Management Engine Interface (Intel MEI) Linux driver
7 #include <linux/module.h>
8 #include <linux/kernel.h>
9 #include <linux/device.h>
10 #include <linux/errno.h>
11 #include <linux/types.h>
12 #include <linux/pci.h>
13 #include <linux/sched.h>
14 #include <linux/interrupt.h>
16 #include <linux/pm_domain.h>
17 #include <linux/pm_runtime.h>
19 #include <linux/mei.h>
23 #include "hw-me-regs.h"
26 /* mei_pci_tbl - PCI Device ID Table */
27 static const struct pci_device_id mei_me_pci_tbl[] = {
28 {MEI_PCI_DEVICE(MEI_DEV_ID_82946GZ, MEI_ME_ICH_CFG)},
29 {MEI_PCI_DEVICE(MEI_DEV_ID_82G35, MEI_ME_ICH_CFG)},
30 {MEI_PCI_DEVICE(MEI_DEV_ID_82Q965, MEI_ME_ICH_CFG)},
31 {MEI_PCI_DEVICE(MEI_DEV_ID_82G965, MEI_ME_ICH_CFG)},
32 {MEI_PCI_DEVICE(MEI_DEV_ID_82GM965, MEI_ME_ICH_CFG)},
33 {MEI_PCI_DEVICE(MEI_DEV_ID_82GME965, MEI_ME_ICH_CFG)},
34 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82Q35, MEI_ME_ICH_CFG)},
35 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82G33, MEI_ME_ICH_CFG)},
36 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82Q33, MEI_ME_ICH_CFG)},
37 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82X38, MEI_ME_ICH_CFG)},
38 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_3200, MEI_ME_ICH_CFG)},
40 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_6, MEI_ME_ICH_CFG)},
41 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_7, MEI_ME_ICH_CFG)},
42 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_8, MEI_ME_ICH_CFG)},
43 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_9, MEI_ME_ICH_CFG)},
44 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_10, MEI_ME_ICH_CFG)},
45 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_1, MEI_ME_ICH_CFG)},
46 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_2, MEI_ME_ICH_CFG)},
47 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_3, MEI_ME_ICH_CFG)},
48 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_4, MEI_ME_ICH_CFG)},
50 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_1, MEI_ME_ICH10_CFG)},
51 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_2, MEI_ME_ICH10_CFG)},
52 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_3, MEI_ME_ICH10_CFG)},
53 {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_4, MEI_ME_ICH10_CFG)},
55 {MEI_PCI_DEVICE(MEI_DEV_ID_IBXPK_1, MEI_ME_PCH6_CFG)},
56 {MEI_PCI_DEVICE(MEI_DEV_ID_IBXPK_2, MEI_ME_PCH6_CFG)},
57 {MEI_PCI_DEVICE(MEI_DEV_ID_CPT_1, MEI_ME_PCH_CPT_PBG_CFG)},
58 {MEI_PCI_DEVICE(MEI_DEV_ID_PBG_1, MEI_ME_PCH_CPT_PBG_CFG)},
59 {MEI_PCI_DEVICE(MEI_DEV_ID_PPT_1, MEI_ME_PCH7_CFG)},
60 {MEI_PCI_DEVICE(MEI_DEV_ID_PPT_2, MEI_ME_PCH7_CFG)},
61 {MEI_PCI_DEVICE(MEI_DEV_ID_PPT_3, MEI_ME_PCH7_CFG)},
62 {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_H, MEI_ME_PCH8_SPS_4_CFG)},
63 {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_W, MEI_ME_PCH8_SPS_4_CFG)},
64 {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_LP, MEI_ME_PCH8_CFG)},
65 {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_HR, MEI_ME_PCH8_SPS_4_CFG)},
66 {MEI_PCI_DEVICE(MEI_DEV_ID_WPT_LP, MEI_ME_PCH8_CFG)},
67 {MEI_PCI_DEVICE(MEI_DEV_ID_WPT_LP_2, MEI_ME_PCH8_CFG)},
69 {MEI_PCI_DEVICE(MEI_DEV_ID_SPT, MEI_ME_PCH8_CFG)},
70 {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_2, MEI_ME_PCH8_CFG)},
71 {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_3, MEI_ME_PCH8_ITOUCH_CFG)},
72 {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_H, MEI_ME_PCH8_SPS_4_CFG)},
73 {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_H_2, MEI_ME_PCH8_SPS_4_CFG)},
74 {MEI_PCI_DEVICE(MEI_DEV_ID_LBG, MEI_ME_PCH12_SPS_4_CFG)},
76 {MEI_PCI_DEVICE(MEI_DEV_ID_BXT_M, MEI_ME_PCH8_CFG)},
77 {MEI_PCI_DEVICE(MEI_DEV_ID_APL_I, MEI_ME_PCH8_CFG)},
79 {MEI_PCI_DEVICE(MEI_DEV_ID_DNV_IE, MEI_ME_PCH8_CFG)},
81 {MEI_PCI_DEVICE(MEI_DEV_ID_GLK, MEI_ME_PCH8_CFG)},
83 {MEI_PCI_DEVICE(MEI_DEV_ID_KBP, MEI_ME_PCH8_CFG)},
84 {MEI_PCI_DEVICE(MEI_DEV_ID_KBP_2, MEI_ME_PCH8_CFG)},
85 {MEI_PCI_DEVICE(MEI_DEV_ID_KBP_3, MEI_ME_PCH8_CFG)},
87 {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_LP, MEI_ME_PCH12_CFG)},
88 {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_LP_3, MEI_ME_PCH8_ITOUCH_CFG)},
89 {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_H, MEI_ME_PCH12_SPS_CFG)},
90 {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_H_3, MEI_ME_PCH12_SPS_ITOUCH_CFG)},
92 {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_LP, MEI_ME_PCH12_CFG)},
93 {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_LP_3, MEI_ME_PCH8_ITOUCH_CFG)},
94 {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_V, MEI_ME_PCH12_CFG)},
95 {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_H, MEI_ME_PCH12_CFG)},
96 {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_H_3, MEI_ME_PCH8_ITOUCH_CFG)},
98 {MEI_PCI_DEVICE(MEI_DEV_ID_ICP_LP, MEI_ME_PCH12_CFG)},
99 {MEI_PCI_DEVICE(MEI_DEV_ID_ICP_N, MEI_ME_PCH12_CFG)},
101 {MEI_PCI_DEVICE(MEI_DEV_ID_TGP_LP, MEI_ME_PCH15_CFG)},
102 {MEI_PCI_DEVICE(MEI_DEV_ID_TGP_H, MEI_ME_PCH15_SPS_CFG)},
104 {MEI_PCI_DEVICE(MEI_DEV_ID_JSP_N, MEI_ME_PCH15_CFG)},
106 {MEI_PCI_DEVICE(MEI_DEV_ID_MCC, MEI_ME_PCH15_CFG)},
107 {MEI_PCI_DEVICE(MEI_DEV_ID_MCC_4, MEI_ME_PCH8_CFG)},
109 {MEI_PCI_DEVICE(MEI_DEV_ID_CDF, MEI_ME_PCH8_CFG)},
111 {MEI_PCI_DEVICE(MEI_DEV_ID_EBG, MEI_ME_PCH15_SPS_CFG)},
113 {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_S, MEI_ME_PCH15_CFG)},
114 {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_LP, MEI_ME_PCH15_CFG)},
115 {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_P, MEI_ME_PCH15_CFG)},
116 {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_N, MEI_ME_PCH15_CFG)},
118 {MEI_PCI_DEVICE(MEI_DEV_ID_RPL_S, MEI_ME_PCH15_CFG)},
120 {MEI_PCI_DEVICE(MEI_DEV_ID_MTL_M, MEI_ME_PCH15_CFG)},
121 {MEI_PCI_DEVICE(MEI_DEV_ID_ARL_S, MEI_ME_PCH15_CFG)},
122 {MEI_PCI_DEVICE(MEI_DEV_ID_ARL_H, MEI_ME_PCH15_CFG)},
124 /* required last entry */
128 MODULE_DEVICE_TABLE(pci, mei_me_pci_tbl);
131 static inline void mei_me_set_pm_domain(struct mei_device *dev);
132 static inline void mei_me_unset_pm_domain(struct mei_device *dev);
134 static inline void mei_me_set_pm_domain(struct mei_device *dev) {}
135 static inline void mei_me_unset_pm_domain(struct mei_device *dev) {}
136 #endif /* CONFIG_PM */
138 static int mei_me_read_fws(const struct mei_device *dev, int where, u32 *val)
140 struct pci_dev *pdev = to_pci_dev(dev->dev);
142 return pci_read_config_dword(pdev, where, val);
146 * mei_me_quirk_probe - probe for devices that doesn't valid ME interface
148 * @pdev: PCI device structure
149 * @cfg: per generation config
151 * Return: true if ME Interface is valid, false otherwise
153 static bool mei_me_quirk_probe(struct pci_dev *pdev,
154 const struct mei_cfg *cfg)
156 if (cfg->quirk_probe && cfg->quirk_probe(pdev)) {
157 dev_info(&pdev->dev, "Device doesn't have valid ME Interface\n");
165 * mei_me_probe - Device Initialization Routine
167 * @pdev: PCI device structure
168 * @ent: entry in kcs_pci_tbl
170 * Return: 0 on success, <0 on failure.
172 static int mei_me_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
174 const struct mei_cfg *cfg;
175 struct mei_device *dev;
176 struct mei_me_hw *hw;
177 unsigned int irqflags;
180 cfg = mei_me_get_cfg(ent->driver_data);
184 if (!mei_me_quirk_probe(pdev, cfg))
188 err = pcim_enable_device(pdev);
190 dev_err(&pdev->dev, "failed to enable pci device.\n");
193 /* set PCI host mastering */
194 pci_set_master(pdev);
195 /* pci request regions and mapping IO device memory for mei driver */
196 err = pcim_iomap_regions(pdev, BIT(0), KBUILD_MODNAME);
198 dev_err(&pdev->dev, "failed to get pci regions.\n");
202 if (dma_set_mask(&pdev->dev, DMA_BIT_MASK(64)) ||
203 dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(64))) {
205 err = dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
207 err = dma_set_coherent_mask(&pdev->dev,
211 dev_err(&pdev->dev, "No usable DMA configuration, aborting\n");
215 /* allocates and initializes the mei dev structure */
216 dev = mei_me_dev_init(&pdev->dev, cfg);
222 hw->mem_addr = pcim_iomap_table(pdev)[0];
223 hw->read_fws = mei_me_read_fws;
225 pci_enable_msi(pdev);
229 /* request and enable interrupt */
230 irqflags = pci_dev_msi_enabled(pdev) ? IRQF_ONESHOT : IRQF_SHARED;
232 err = request_threaded_irq(pdev->irq,
233 mei_me_irq_quick_handler,
234 mei_me_irq_thread_handler,
235 irqflags, KBUILD_MODNAME, dev);
237 dev_err(&pdev->dev, "request_threaded_irq failure. irq = %d\n",
242 if (mei_start(dev)) {
243 dev_err(&pdev->dev, "init hw failure.\n");
248 pm_runtime_set_autosuspend_delay(&pdev->dev, MEI_ME_RPM_TIMEOUT);
249 pm_runtime_use_autosuspend(&pdev->dev);
251 err = mei_register(dev, &pdev->dev);
255 pci_set_drvdata(pdev, dev);
258 * MEI requires to resume from runtime suspend mode
259 * in order to perform link reset flow upon system suspend.
261 dev_pm_set_driver_flags(&pdev->dev, DPM_FLAG_NO_DIRECT_COMPLETE);
264 * ME maps runtime suspend/resume to D0i states,
265 * hence we need to go around native PCI runtime service which
266 * eventually brings the device into D3cold/hot state,
267 * but the mei device cannot wake up from D3 unlike from D0i3.
268 * To get around the PCI device native runtime pm,
269 * ME uses runtime pm domain handlers which take precedence
270 * over the driver's pm handlers.
272 mei_me_set_pm_domain(dev);
274 if (mei_pg_is_enabled(dev)) {
275 pm_runtime_put_noidle(&pdev->dev);
276 if (hw->d0i3_supported)
277 pm_runtime_allow(&pdev->dev);
280 dev_dbg(&pdev->dev, "initialization successful.\n");
287 mei_cancel_work(dev);
288 mei_disable_interrupts(dev);
289 free_irq(pdev->irq, dev);
291 dev_err(&pdev->dev, "initialization failed.\n");
296 * mei_me_shutdown - Device Removal Routine
298 * @pdev: PCI device structure
300 * mei_me_shutdown is called from the reboot notifier
301 * it's a simplified version of remove so we go down
304 static void mei_me_shutdown(struct pci_dev *pdev)
306 struct mei_device *dev;
308 dev = pci_get_drvdata(pdev);
312 dev_dbg(&pdev->dev, "shutdown\n");
315 mei_me_unset_pm_domain(dev);
317 mei_disable_interrupts(dev);
318 free_irq(pdev->irq, dev);
322 * mei_me_remove - Device Removal Routine
324 * @pdev: PCI device structure
326 * mei_me_remove is called by the PCI subsystem to alert the driver
327 * that it should release a PCI device.
329 static void mei_me_remove(struct pci_dev *pdev)
331 struct mei_device *dev;
333 dev = pci_get_drvdata(pdev);
337 if (mei_pg_is_enabled(dev))
338 pm_runtime_get_noresume(&pdev->dev);
340 dev_dbg(&pdev->dev, "stop\n");
343 mei_me_unset_pm_domain(dev);
345 mei_disable_interrupts(dev);
347 free_irq(pdev->irq, dev);
352 #ifdef CONFIG_PM_SLEEP
353 static int mei_me_pci_suspend(struct device *device)
355 struct pci_dev *pdev = to_pci_dev(device);
356 struct mei_device *dev = pci_get_drvdata(pdev);
361 dev_dbg(&pdev->dev, "suspend\n");
365 mei_disable_interrupts(dev);
367 free_irq(pdev->irq, dev);
368 pci_disable_msi(pdev);
373 static int mei_me_pci_resume(struct device *device)
375 struct pci_dev *pdev = to_pci_dev(device);
376 struct mei_device *dev;
377 unsigned int irqflags;
380 dev = pci_get_drvdata(pdev);
384 pci_enable_msi(pdev);
386 irqflags = pci_dev_msi_enabled(pdev) ? IRQF_ONESHOT : IRQF_SHARED;
388 /* request and enable interrupt */
389 err = request_threaded_irq(pdev->irq,
390 mei_me_irq_quick_handler,
391 mei_me_irq_thread_handler,
392 irqflags, KBUILD_MODNAME, dev);
395 dev_err(&pdev->dev, "request_threaded_irq failed: irq = %d.\n",
400 err = mei_restart(dev);
404 /* Start timer if stopped in suspend */
405 schedule_delayed_work(&dev->timer_work, HZ);
409 #endif /* CONFIG_PM_SLEEP */
412 static int mei_me_pm_runtime_idle(struct device *device)
414 struct mei_device *dev;
416 dev_dbg(device, "rpm: me: runtime_idle\n");
418 dev = dev_get_drvdata(device);
421 if (mei_write_is_idle(dev))
422 pm_runtime_autosuspend(device);
427 static int mei_me_pm_runtime_suspend(struct device *device)
429 struct mei_device *dev;
432 dev_dbg(device, "rpm: me: runtime suspend\n");
434 dev = dev_get_drvdata(device);
438 mutex_lock(&dev->device_lock);
440 if (mei_write_is_idle(dev))
441 ret = mei_me_pg_enter_sync(dev);
445 mutex_unlock(&dev->device_lock);
447 dev_dbg(device, "rpm: me: runtime suspend ret=%d\n", ret);
449 if (ret && ret != -EAGAIN)
450 schedule_work(&dev->reset_work);
455 static int mei_me_pm_runtime_resume(struct device *device)
457 struct mei_device *dev;
460 dev_dbg(device, "rpm: me: runtime resume\n");
462 dev = dev_get_drvdata(device);
466 mutex_lock(&dev->device_lock);
468 ret = mei_me_pg_exit_sync(dev);
470 mutex_unlock(&dev->device_lock);
472 dev_dbg(device, "rpm: me: runtime resume ret = %d\n", ret);
475 schedule_work(&dev->reset_work);
481 * mei_me_set_pm_domain - fill and set pm domain structure for device
485 static inline void mei_me_set_pm_domain(struct mei_device *dev)
487 struct pci_dev *pdev = to_pci_dev(dev->dev);
489 if (pdev->dev.bus && pdev->dev.bus->pm) {
490 dev->pg_domain.ops = *pdev->dev.bus->pm;
492 dev->pg_domain.ops.runtime_suspend = mei_me_pm_runtime_suspend;
493 dev->pg_domain.ops.runtime_resume = mei_me_pm_runtime_resume;
494 dev->pg_domain.ops.runtime_idle = mei_me_pm_runtime_idle;
496 dev_pm_domain_set(&pdev->dev, &dev->pg_domain);
501 * mei_me_unset_pm_domain - clean pm domain structure for device
505 static inline void mei_me_unset_pm_domain(struct mei_device *dev)
507 /* stop using pm callbacks if any */
508 dev_pm_domain_set(dev->dev, NULL);
511 static const struct dev_pm_ops mei_me_pm_ops = {
512 SET_SYSTEM_SLEEP_PM_OPS(mei_me_pci_suspend,
515 mei_me_pm_runtime_suspend,
516 mei_me_pm_runtime_resume,
517 mei_me_pm_runtime_idle)
520 #define MEI_ME_PM_OPS (&mei_me_pm_ops)
522 #define MEI_ME_PM_OPS NULL
523 #endif /* CONFIG_PM */
525 * PCI driver structure
527 static struct pci_driver mei_me_driver = {
528 .name = KBUILD_MODNAME,
529 .id_table = mei_me_pci_tbl,
530 .probe = mei_me_probe,
531 .remove = mei_me_remove,
532 .shutdown = mei_me_shutdown,
533 .driver.pm = MEI_ME_PM_OPS,
534 .driver.probe_type = PROBE_PREFER_ASYNCHRONOUS,
537 module_pci_driver(mei_me_driver);
539 MODULE_AUTHOR("Intel Corporation");
540 MODULE_DESCRIPTION("Intel(R) Management Engine Interface");
541 MODULE_LICENSE("GPL v2");