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_CFG)},
63 {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_W, MEI_ME_PCH8_SPS_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_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_H, MEI_ME_PCH8_SPS_CFG)},
72 {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_H_2, MEI_ME_PCH8_SPS_CFG)},
73 {MEI_PCI_DEVICE(MEI_DEV_ID_LBG, MEI_ME_PCH12_SPS_CFG)},
75 {MEI_PCI_DEVICE(MEI_DEV_ID_BXT_M, MEI_ME_PCH8_CFG)},
76 {MEI_PCI_DEVICE(MEI_DEV_ID_APL_I, MEI_ME_PCH8_CFG)},
78 {MEI_PCI_DEVICE(MEI_DEV_ID_DNV_IE, MEI_ME_PCH8_CFG)},
80 {MEI_PCI_DEVICE(MEI_DEV_ID_GLK, MEI_ME_PCH8_CFG)},
82 {MEI_PCI_DEVICE(MEI_DEV_ID_KBP, MEI_ME_PCH8_CFG)},
83 {MEI_PCI_DEVICE(MEI_DEV_ID_KBP_2, MEI_ME_PCH8_CFG)},
85 {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_LP, MEI_ME_PCH12_CFG)},
86 {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_LP_3, MEI_ME_PCH8_CFG)},
87 {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_H, MEI_ME_PCH12_CFG)},
88 {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_H_3, MEI_ME_PCH8_CFG)},
90 {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_LP, MEI_ME_PCH12_CFG)},
91 {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_LP_3, MEI_ME_PCH8_CFG)},
92 {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_V, MEI_ME_PCH12_CFG)},
93 {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_H, MEI_ME_PCH12_CFG)},
94 {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_H_3, MEI_ME_PCH8_CFG)},
96 {MEI_PCI_DEVICE(MEI_DEV_ID_ICP_LP, MEI_ME_PCH12_CFG)},
98 {MEI_PCI_DEVICE(MEI_DEV_ID_TGP_LP, MEI_ME_PCH15_CFG)},
100 {MEI_PCI_DEVICE(MEI_DEV_ID_JSP_N, MEI_ME_PCH15_CFG)},
102 {MEI_PCI_DEVICE(MEI_DEV_ID_MCC, MEI_ME_PCH15_CFG)},
103 {MEI_PCI_DEVICE(MEI_DEV_ID_MCC_4, MEI_ME_PCH8_CFG)},
105 {MEI_PCI_DEVICE(MEI_DEV_ID_CDF, MEI_ME_PCH8_CFG)},
107 /* required last entry */
111 MODULE_DEVICE_TABLE(pci, mei_me_pci_tbl);
114 static inline void mei_me_set_pm_domain(struct mei_device *dev);
115 static inline void mei_me_unset_pm_domain(struct mei_device *dev);
117 static inline void mei_me_set_pm_domain(struct mei_device *dev) {}
118 static inline void mei_me_unset_pm_domain(struct mei_device *dev) {}
119 #endif /* CONFIG_PM */
121 static int mei_me_read_fws(const struct mei_device *dev, int where, u32 *val)
123 struct pci_dev *pdev = to_pci_dev(dev->dev);
125 return pci_read_config_dword(pdev, where, val);
129 * mei_me_quirk_probe - probe for devices that doesn't valid ME interface
131 * @pdev: PCI device structure
132 * @cfg: per generation config
134 * Return: true if ME Interface is valid, false otherwise
136 static bool mei_me_quirk_probe(struct pci_dev *pdev,
137 const struct mei_cfg *cfg)
139 if (cfg->quirk_probe && cfg->quirk_probe(pdev)) {
140 dev_info(&pdev->dev, "Device doesn't have valid ME Interface\n");
148 * mei_me_probe - Device Initialization Routine
150 * @pdev: PCI device structure
151 * @ent: entry in kcs_pci_tbl
153 * Return: 0 on success, <0 on failure.
155 static int mei_me_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
157 const struct mei_cfg *cfg;
158 struct mei_device *dev;
159 struct mei_me_hw *hw;
160 unsigned int irqflags;
163 cfg = mei_me_get_cfg(ent->driver_data);
167 if (!mei_me_quirk_probe(pdev, cfg))
171 err = pcim_enable_device(pdev);
173 dev_err(&pdev->dev, "failed to enable pci device.\n");
176 /* set PCI host mastering */
177 pci_set_master(pdev);
178 /* pci request regions and mapping IO device memory for mei driver */
179 err = pcim_iomap_regions(pdev, BIT(0), KBUILD_MODNAME);
181 dev_err(&pdev->dev, "failed to get pci regions.\n");
185 if (dma_set_mask(&pdev->dev, DMA_BIT_MASK(64)) ||
186 dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(64))) {
188 err = dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
190 err = dma_set_coherent_mask(&pdev->dev,
194 dev_err(&pdev->dev, "No usable DMA configuration, aborting\n");
198 /* allocates and initializes the mei dev structure */
199 dev = mei_me_dev_init(&pdev->dev, cfg);
205 hw->mem_addr = pcim_iomap_table(pdev)[0];
206 hw->read_fws = mei_me_read_fws;
208 pci_enable_msi(pdev);
212 /* request and enable interrupt */
213 irqflags = pci_dev_msi_enabled(pdev) ? IRQF_ONESHOT : IRQF_SHARED;
215 err = request_threaded_irq(pdev->irq,
216 mei_me_irq_quick_handler,
217 mei_me_irq_thread_handler,
218 irqflags, KBUILD_MODNAME, dev);
220 dev_err(&pdev->dev, "request_threaded_irq failure. irq = %d\n",
225 if (mei_start(dev)) {
226 dev_err(&pdev->dev, "init hw failure.\n");
231 pm_runtime_set_autosuspend_delay(&pdev->dev, MEI_ME_RPM_TIMEOUT);
232 pm_runtime_use_autosuspend(&pdev->dev);
234 err = mei_register(dev, &pdev->dev);
238 pci_set_drvdata(pdev, dev);
241 * MEI requires to resume from runtime suspend mode
242 * in order to perform link reset flow upon system suspend.
244 dev_pm_set_driver_flags(&pdev->dev, DPM_FLAG_NEVER_SKIP);
247 * ME maps runtime suspend/resume to D0i states,
248 * hence we need to go around native PCI runtime service which
249 * eventually brings the device into D3cold/hot state,
250 * but the mei device cannot wake up from D3 unlike from D0i3.
251 * To get around the PCI device native runtime pm,
252 * ME uses runtime pm domain handlers which take precedence
253 * over the driver's pm handlers.
255 mei_me_set_pm_domain(dev);
257 if (mei_pg_is_enabled(dev)) {
258 pm_runtime_put_noidle(&pdev->dev);
259 if (hw->d0i3_supported)
260 pm_runtime_allow(&pdev->dev);
263 dev_dbg(&pdev->dev, "initialization successful.\n");
270 mei_cancel_work(dev);
271 mei_disable_interrupts(dev);
272 free_irq(pdev->irq, dev);
274 dev_err(&pdev->dev, "initialization failed.\n");
279 * mei_me_shutdown - Device Removal Routine
281 * @pdev: PCI device structure
283 * mei_me_shutdown is called from the reboot notifier
284 * it's a simplified version of remove so we go down
287 static void mei_me_shutdown(struct pci_dev *pdev)
289 struct mei_device *dev;
291 dev = pci_get_drvdata(pdev);
295 dev_dbg(&pdev->dev, "shutdown\n");
298 mei_me_unset_pm_domain(dev);
300 mei_disable_interrupts(dev);
301 free_irq(pdev->irq, dev);
305 * mei_me_remove - Device Removal Routine
307 * @pdev: PCI device structure
309 * mei_me_remove is called by the PCI subsystem to alert the driver
310 * that it should release a PCI device.
312 static void mei_me_remove(struct pci_dev *pdev)
314 struct mei_device *dev;
316 dev = pci_get_drvdata(pdev);
320 if (mei_pg_is_enabled(dev))
321 pm_runtime_get_noresume(&pdev->dev);
323 dev_dbg(&pdev->dev, "stop\n");
326 mei_me_unset_pm_domain(dev);
328 mei_disable_interrupts(dev);
330 free_irq(pdev->irq, dev);
335 #ifdef CONFIG_PM_SLEEP
336 static int mei_me_pci_suspend(struct device *device)
338 struct pci_dev *pdev = to_pci_dev(device);
339 struct mei_device *dev = pci_get_drvdata(pdev);
344 dev_dbg(&pdev->dev, "suspend\n");
348 mei_disable_interrupts(dev);
350 free_irq(pdev->irq, dev);
351 pci_disable_msi(pdev);
356 static int mei_me_pci_resume(struct device *device)
358 struct pci_dev *pdev = to_pci_dev(device);
359 struct mei_device *dev;
360 unsigned int irqflags;
363 dev = pci_get_drvdata(pdev);
367 pci_enable_msi(pdev);
369 irqflags = pci_dev_msi_enabled(pdev) ? IRQF_ONESHOT : IRQF_SHARED;
371 /* request and enable interrupt */
372 err = request_threaded_irq(pdev->irq,
373 mei_me_irq_quick_handler,
374 mei_me_irq_thread_handler,
375 irqflags, KBUILD_MODNAME, dev);
378 dev_err(&pdev->dev, "request_threaded_irq failed: irq = %d.\n",
383 err = mei_restart(dev);
387 /* Start timer if stopped in suspend */
388 schedule_delayed_work(&dev->timer_work, HZ);
392 #endif /* CONFIG_PM_SLEEP */
395 static int mei_me_pm_runtime_idle(struct device *device)
397 struct mei_device *dev;
399 dev_dbg(device, "rpm: me: runtime_idle\n");
401 dev = dev_get_drvdata(device);
404 if (mei_write_is_idle(dev))
405 pm_runtime_autosuspend(device);
410 static int mei_me_pm_runtime_suspend(struct device *device)
412 struct mei_device *dev;
415 dev_dbg(device, "rpm: me: runtime suspend\n");
417 dev = dev_get_drvdata(device);
421 mutex_lock(&dev->device_lock);
423 if (mei_write_is_idle(dev))
424 ret = mei_me_pg_enter_sync(dev);
428 mutex_unlock(&dev->device_lock);
430 dev_dbg(device, "rpm: me: runtime suspend ret=%d\n", ret);
432 if (ret && ret != -EAGAIN)
433 schedule_work(&dev->reset_work);
438 static int mei_me_pm_runtime_resume(struct device *device)
440 struct mei_device *dev;
443 dev_dbg(device, "rpm: me: runtime resume\n");
445 dev = dev_get_drvdata(device);
449 mutex_lock(&dev->device_lock);
451 ret = mei_me_pg_exit_sync(dev);
453 mutex_unlock(&dev->device_lock);
455 dev_dbg(device, "rpm: me: runtime resume ret = %d\n", ret);
458 schedule_work(&dev->reset_work);
464 * mei_me_set_pm_domain - fill and set pm domain structure for device
468 static inline void mei_me_set_pm_domain(struct mei_device *dev)
470 struct pci_dev *pdev = to_pci_dev(dev->dev);
472 if (pdev->dev.bus && pdev->dev.bus->pm) {
473 dev->pg_domain.ops = *pdev->dev.bus->pm;
475 dev->pg_domain.ops.runtime_suspend = mei_me_pm_runtime_suspend;
476 dev->pg_domain.ops.runtime_resume = mei_me_pm_runtime_resume;
477 dev->pg_domain.ops.runtime_idle = mei_me_pm_runtime_idle;
479 dev_pm_domain_set(&pdev->dev, &dev->pg_domain);
484 * mei_me_unset_pm_domain - clean pm domain structure for device
488 static inline void mei_me_unset_pm_domain(struct mei_device *dev)
490 /* stop using pm callbacks if any */
491 dev_pm_domain_set(dev->dev, NULL);
494 static const struct dev_pm_ops mei_me_pm_ops = {
495 SET_SYSTEM_SLEEP_PM_OPS(mei_me_pci_suspend,
498 mei_me_pm_runtime_suspend,
499 mei_me_pm_runtime_resume,
500 mei_me_pm_runtime_idle)
503 #define MEI_ME_PM_OPS (&mei_me_pm_ops)
505 #define MEI_ME_PM_OPS NULL
506 #endif /* CONFIG_PM */
508 * PCI driver structure
510 static struct pci_driver mei_me_driver = {
511 .name = KBUILD_MODNAME,
512 .id_table = mei_me_pci_tbl,
513 .probe = mei_me_probe,
514 .remove = mei_me_remove,
515 .shutdown = mei_me_shutdown,
516 .driver.pm = MEI_ME_PM_OPS,
517 .driver.probe_type = PROBE_PREFER_ASYNCHRONOUS,
520 module_pci_driver(mei_me_driver);
522 MODULE_AUTHOR("Intel Corporation");
523 MODULE_DESCRIPTION("Intel(R) Management Engine Interface");
524 MODULE_LICENSE("GPL v2");