3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2012, Intel Corporation.
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.
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
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/module.h>
20 #include <linux/moduleparam.h>
21 #include <linux/kernel.h>
22 #include <linux/device.h>
24 #include <linux/errno.h>
25 #include <linux/types.h>
26 #include <linux/fcntl.h>
27 #include <linux/aio.h>
28 #include <linux/pci.h>
29 #include <linux/poll.h>
30 #include <linux/init.h>
31 #include <linux/ioctl.h>
32 #include <linux/cdev.h>
33 #include <linux/sched.h>
34 #include <linux/uuid.h>
35 #include <linux/compat.h>
36 #include <linux/jiffies.h>
37 #include <linux/interrupt.h>
38 #include <linux/miscdevice.h>
40 #include <linux/mei.h>
46 /* AMT device is a singleton on the platform */
47 static struct pci_dev *mei_pdev;
49 /* mei_pci_tbl - PCI Device ID Table */
50 static DEFINE_PCI_DEVICE_TABLE(mei_pci_tbl) = {
51 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82946GZ)},
52 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82G35)},
53 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82Q965)},
54 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82G965)},
55 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82GM965)},
56 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82GME965)},
57 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82Q35)},
58 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82G33)},
59 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82Q33)},
60 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82X38)},
61 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_3200)},
62 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_6)},
63 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_7)},
64 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_8)},
65 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_9)},
66 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_10)},
67 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_1)},
68 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_2)},
69 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_3)},
70 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_4)},
71 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_1)},
72 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_2)},
73 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_3)},
74 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_4)},
75 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_IBXPK_1)},
76 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_IBXPK_2)},
77 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_CPT_1)},
78 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PBG_1)},
79 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PPT_1)},
80 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PPT_2)},
81 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PPT_3)},
82 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_LPT)},
83 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_LPT_LP)},
85 /* required last entry */
89 MODULE_DEVICE_TABLE(pci, mei_pci_tbl);
91 static DEFINE_MUTEX(mei_mutex);
94 * mei_quirk_probe - probe for devices that doesn't valid ME interface
95 * @pdev: PCI device structure
96 * @ent: entry into pci_device_table
98 * returns true if ME Interface is valid, false otherwise
100 static bool mei_quirk_probe(struct pci_dev *pdev,
101 const struct pci_device_id *ent)
104 if (ent->device == MEI_DEV_ID_PBG_1) {
105 pci_read_config_dword(pdev, 0x48, ®);
106 /* make sure that bit 9 is up and bit 10 is down */
107 if ((reg & 0x600) == 0x200) {
108 dev_info(&pdev->dev, "Device doesn't have valid ME Interface\n");
115 * mei_probe - Device Initialization Routine
117 * @pdev: PCI device structure
118 * @ent: entry in kcs_pci_tbl
120 * returns 0 on success, <0 on failure.
122 static int mei_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
124 struct mei_device *dev;
125 struct mei_me_hw *hw;
128 mutex_lock(&mei_mutex);
130 if (!mei_quirk_probe(pdev, ent)) {
140 err = pci_enable_device(pdev);
142 dev_err(&pdev->dev, "failed to enable pci device.\n");
145 /* set PCI host mastering */
146 pci_set_master(pdev);
147 /* pci request regions for mei driver */
148 err = pci_request_regions(pdev, KBUILD_MODNAME);
150 dev_err(&pdev->dev, "failed to get pci regions.\n");
153 /* allocates and initializes the mei dev structure */
154 dev = mei_me_dev_init(pdev);
157 goto release_regions;
160 /* mapping IO device memory */
161 hw->mem_addr = pci_iomap(pdev, 0, 0);
163 dev_err(&pdev->dev, "mapping I/O device memory failure.\n");
167 pci_enable_msi(pdev);
169 /* request and enable interrupt */
170 if (pci_dev_msi_enabled(pdev))
171 err = request_threaded_irq(pdev->irq,
173 mei_me_irq_thread_handler,
174 IRQF_ONESHOT, KBUILD_MODNAME, dev);
176 err = request_threaded_irq(pdev->irq,
177 mei_me_irq_quick_handler,
178 mei_me_irq_thread_handler,
179 IRQF_SHARED, KBUILD_MODNAME, dev);
182 dev_err(&pdev->dev, "request_threaded_irq failure. irq = %d\n",
187 if (mei_hw_init(dev)) {
188 dev_err(&pdev->dev, "init hw failure.\n");
193 err = mei_register(&pdev->dev);
198 pci_set_drvdata(pdev, dev);
201 schedule_delayed_work(&dev->timer_work, HZ);
203 mutex_unlock(&mei_mutex);
205 pr_debug("initialization successful.\n");
210 mei_disable_interrupts(dev);
211 flush_scheduled_work();
212 free_irq(pdev->irq, dev);
214 pci_disable_msi(pdev);
215 pci_iounmap(pdev, hw->mem_addr);
219 pci_release_regions(pdev);
221 pci_disable_device(pdev);
223 mutex_unlock(&mei_mutex);
224 dev_err(&pdev->dev, "initialization failed.\n");
229 * mei_remove - Device Removal Routine
231 * @pdev: PCI device structure
233 * mei_remove is called by the PCI subsystem to alert the driver
234 * that it should release a PCI device.
236 static void mei_remove(struct pci_dev *pdev)
238 struct mei_device *dev;
239 struct mei_me_hw *hw;
241 if (mei_pdev != pdev)
244 dev = pci_get_drvdata(pdev);
251 dev_err(&pdev->dev, "stop\n");
256 mei_watchdog_unregister(dev);
258 /* disable interrupts */
259 mei_disable_interrupts(dev);
261 free_irq(pdev->irq, dev);
262 pci_disable_msi(pdev);
263 pci_set_drvdata(pdev, NULL);
266 pci_iounmap(pdev, hw->mem_addr);
270 pci_release_regions(pdev);
271 pci_disable_device(pdev);
277 static int mei_pci_suspend(struct device *device)
279 struct pci_dev *pdev = to_pci_dev(device);
280 struct mei_device *dev = pci_get_drvdata(pdev);
285 dev_err(&pdev->dev, "suspend\n");
289 mei_disable_interrupts(dev);
291 free_irq(pdev->irq, dev);
292 pci_disable_msi(pdev);
297 static int mei_pci_resume(struct device *device)
299 struct pci_dev *pdev = to_pci_dev(device);
300 struct mei_device *dev;
303 dev = pci_get_drvdata(pdev);
307 pci_enable_msi(pdev);
309 /* request and enable interrupt */
310 if (pci_dev_msi_enabled(pdev))
311 err = request_threaded_irq(pdev->irq,
313 mei_me_irq_thread_handler,
314 IRQF_ONESHOT, KBUILD_MODNAME, dev);
316 err = request_threaded_irq(pdev->irq,
317 mei_me_irq_quick_handler,
318 mei_me_irq_thread_handler,
319 IRQF_SHARED, KBUILD_MODNAME, dev);
322 dev_err(&pdev->dev, "request_threaded_irq failed: irq = %d.\n",
327 mutex_lock(&dev->device_lock);
328 dev->dev_state = MEI_DEV_POWER_UP;
330 mutex_unlock(&dev->device_lock);
332 /* Start timer if stopped in suspend */
333 schedule_delayed_work(&dev->timer_work, HZ);
337 static SIMPLE_DEV_PM_OPS(mei_pm_ops, mei_pci_suspend, mei_pci_resume);
338 #define MEI_PM_OPS (&mei_pm_ops)
340 #define MEI_PM_OPS NULL
341 #endif /* CONFIG_PM */
343 * PCI driver structure
345 static struct pci_driver mei_driver = {
346 .name = KBUILD_MODNAME,
347 .id_table = mei_pci_tbl,
349 .remove = mei_remove,
350 .shutdown = mei_remove,
351 .driver.pm = MEI_PM_OPS,
354 module_pci_driver(mei_driver);
356 MODULE_AUTHOR("Intel Corporation");
357 MODULE_DESCRIPTION("Intel(R) Management Engine Interface");
358 MODULE_LICENSE("GPL v2");