12703d4b2STomas Winkler /* 22703d4b2STomas Winkler * 32703d4b2STomas Winkler * Intel Management Engine Interface (Intel MEI) Linux driver 42703d4b2STomas Winkler * Copyright (c) 2003-2012, Intel Corporation. 52703d4b2STomas Winkler * 62703d4b2STomas Winkler * This program is free software; you can redistribute it and/or modify it 72703d4b2STomas Winkler * under the terms and conditions of the GNU General Public License, 82703d4b2STomas Winkler * version 2, as published by the Free Software Foundation. 92703d4b2STomas Winkler * 102703d4b2STomas Winkler * This program is distributed in the hope it will be useful, but WITHOUT 112703d4b2STomas Winkler * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 122703d4b2STomas Winkler * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 132703d4b2STomas Winkler * more details. 142703d4b2STomas Winkler * 152703d4b2STomas Winkler */ 162703d4b2STomas Winkler 172703d4b2STomas Winkler #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 182703d4b2STomas Winkler 192703d4b2STomas Winkler #include <linux/module.h> 202703d4b2STomas Winkler #include <linux/moduleparam.h> 212703d4b2STomas Winkler #include <linux/kernel.h> 222703d4b2STomas Winkler #include <linux/device.h> 232703d4b2STomas Winkler #include <linux/fs.h> 242703d4b2STomas Winkler #include <linux/errno.h> 252703d4b2STomas Winkler #include <linux/types.h> 262703d4b2STomas Winkler #include <linux/fcntl.h> 272703d4b2STomas Winkler #include <linux/aio.h> 282703d4b2STomas Winkler #include <linux/pci.h> 292703d4b2STomas Winkler #include <linux/poll.h> 302703d4b2STomas Winkler #include <linux/init.h> 312703d4b2STomas Winkler #include <linux/ioctl.h> 322703d4b2STomas Winkler #include <linux/cdev.h> 332703d4b2STomas Winkler #include <linux/sched.h> 342703d4b2STomas Winkler #include <linux/uuid.h> 352703d4b2STomas Winkler #include <linux/compat.h> 362703d4b2STomas Winkler #include <linux/jiffies.h> 372703d4b2STomas Winkler #include <linux/interrupt.h> 382703d4b2STomas Winkler #include <linux/miscdevice.h> 392703d4b2STomas Winkler 402703d4b2STomas Winkler #include <linux/mei.h> 412703d4b2STomas Winkler 422703d4b2STomas Winkler #include "mei_dev.h" 432703d4b2STomas Winkler #include "hw-me.h" 442703d4b2STomas Winkler #include "client.h" 452703d4b2STomas Winkler 462703d4b2STomas Winkler /* AMT device is a singleton on the platform */ 472703d4b2STomas Winkler static struct pci_dev *mei_pdev; 482703d4b2STomas Winkler 492703d4b2STomas Winkler /* mei_pci_tbl - PCI Device ID Table */ 502703d4b2STomas Winkler static DEFINE_PCI_DEVICE_TABLE(mei_pci_tbl) = { 512703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82946GZ)}, 522703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82G35)}, 532703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82Q965)}, 542703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82G965)}, 552703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82GM965)}, 562703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82GME965)}, 572703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82Q35)}, 582703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82G33)}, 592703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82Q33)}, 602703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82X38)}, 612703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_3200)}, 622703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_6)}, 632703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_7)}, 642703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_8)}, 652703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_9)}, 662703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_10)}, 672703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_1)}, 682703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_2)}, 692703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_3)}, 702703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_4)}, 712703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_1)}, 722703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_2)}, 732703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_3)}, 742703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_4)}, 752703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_IBXPK_1)}, 762703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_IBXPK_2)}, 772703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_CPT_1)}, 782703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PBG_1)}, 792703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PPT_1)}, 802703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PPT_2)}, 812703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PPT_3)}, 822703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_LPT)}, 832703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_LPT_LP)}, 842703d4b2STomas Winkler 852703d4b2STomas Winkler /* required last entry */ 862703d4b2STomas Winkler {0, } 872703d4b2STomas Winkler }; 882703d4b2STomas Winkler 892703d4b2STomas Winkler MODULE_DEVICE_TABLE(pci, mei_pci_tbl); 902703d4b2STomas Winkler 912703d4b2STomas Winkler static DEFINE_MUTEX(mei_mutex); 922703d4b2STomas Winkler 932703d4b2STomas Winkler /** 942703d4b2STomas Winkler * mei_quirk_probe - probe for devices that doesn't valid ME interface 952703d4b2STomas Winkler * @pdev: PCI device structure 962703d4b2STomas Winkler * @ent: entry into pci_device_table 972703d4b2STomas Winkler * 982703d4b2STomas Winkler * returns true if ME Interface is valid, false otherwise 992703d4b2STomas Winkler */ 1002703d4b2STomas Winkler static bool mei_quirk_probe(struct pci_dev *pdev, 1012703d4b2STomas Winkler const struct pci_device_id *ent) 1022703d4b2STomas Winkler { 1032703d4b2STomas Winkler u32 reg; 1042703d4b2STomas Winkler if (ent->device == MEI_DEV_ID_PBG_1) { 1052703d4b2STomas Winkler pci_read_config_dword(pdev, 0x48, ®); 1062703d4b2STomas Winkler /* make sure that bit 9 is up and bit 10 is down */ 1072703d4b2STomas Winkler if ((reg & 0x600) == 0x200) { 1082703d4b2STomas Winkler dev_info(&pdev->dev, "Device doesn't have valid ME Interface\n"); 1092703d4b2STomas Winkler return false; 1102703d4b2STomas Winkler } 1112703d4b2STomas Winkler } 1122703d4b2STomas Winkler return true; 1132703d4b2STomas Winkler } 1142703d4b2STomas Winkler /** 1152703d4b2STomas Winkler * mei_probe - Device Initialization Routine 1162703d4b2STomas Winkler * 1172703d4b2STomas Winkler * @pdev: PCI device structure 1182703d4b2STomas Winkler * @ent: entry in kcs_pci_tbl 1192703d4b2STomas Winkler * 1202703d4b2STomas Winkler * returns 0 on success, <0 on failure. 1212703d4b2STomas Winkler */ 12252c34561STomas Winkler static int mei_probe(struct pci_dev *pdev, const struct pci_device_id *ent) 1232703d4b2STomas Winkler { 1242703d4b2STomas Winkler struct mei_device *dev; 12552c34561STomas Winkler struct mei_me_hw *hw; 1262703d4b2STomas Winkler int err; 1272703d4b2STomas Winkler 1282703d4b2STomas Winkler mutex_lock(&mei_mutex); 1292703d4b2STomas Winkler 1302703d4b2STomas Winkler if (!mei_quirk_probe(pdev, ent)) { 1312703d4b2STomas Winkler err = -ENODEV; 1322703d4b2STomas Winkler goto end; 1332703d4b2STomas Winkler } 1342703d4b2STomas Winkler 1352703d4b2STomas Winkler if (mei_pdev) { 1362703d4b2STomas Winkler err = -EEXIST; 1372703d4b2STomas Winkler goto end; 1382703d4b2STomas Winkler } 1392703d4b2STomas Winkler /* enable pci dev */ 1402703d4b2STomas Winkler err = pci_enable_device(pdev); 1412703d4b2STomas Winkler if (err) { 1422703d4b2STomas Winkler dev_err(&pdev->dev, "failed to enable pci device.\n"); 1432703d4b2STomas Winkler goto end; 1442703d4b2STomas Winkler } 1452703d4b2STomas Winkler /* set PCI host mastering */ 1462703d4b2STomas Winkler pci_set_master(pdev); 1472703d4b2STomas Winkler /* pci request regions for mei driver */ 1482703d4b2STomas Winkler err = pci_request_regions(pdev, KBUILD_MODNAME); 1492703d4b2STomas Winkler if (err) { 1502703d4b2STomas Winkler dev_err(&pdev->dev, "failed to get pci regions.\n"); 1512703d4b2STomas Winkler goto disable_device; 1522703d4b2STomas Winkler } 1532703d4b2STomas Winkler /* allocates and initializes the mei dev structure */ 15452c34561STomas Winkler dev = mei_me_dev_init(pdev); 1552703d4b2STomas Winkler if (!dev) { 1562703d4b2STomas Winkler err = -ENOMEM; 1572703d4b2STomas Winkler goto release_regions; 1582703d4b2STomas Winkler } 15952c34561STomas Winkler hw = to_me_hw(dev); 1602703d4b2STomas Winkler /* mapping IO device memory */ 16152c34561STomas Winkler hw->mem_addr = pci_iomap(pdev, 0, 0); 16252c34561STomas Winkler if (!hw->mem_addr) { 1632703d4b2STomas Winkler dev_err(&pdev->dev, "mapping I/O device memory failure.\n"); 1642703d4b2STomas Winkler err = -ENOMEM; 1652703d4b2STomas Winkler goto free_device; 1662703d4b2STomas Winkler } 1672703d4b2STomas Winkler pci_enable_msi(pdev); 1682703d4b2STomas Winkler 1692703d4b2STomas Winkler /* request and enable interrupt */ 1702703d4b2STomas Winkler if (pci_dev_msi_enabled(pdev)) 1712703d4b2STomas Winkler err = request_threaded_irq(pdev->irq, 1722703d4b2STomas Winkler NULL, 17306ecd645STomas Winkler mei_me_irq_thread_handler, 1742703d4b2STomas Winkler IRQF_ONESHOT, KBUILD_MODNAME, dev); 1752703d4b2STomas Winkler else 1762703d4b2STomas Winkler err = request_threaded_irq(pdev->irq, 17706ecd645STomas Winkler mei_me_irq_quick_handler, 17806ecd645STomas Winkler mei_me_irq_thread_handler, 1792703d4b2STomas Winkler IRQF_SHARED, KBUILD_MODNAME, dev); 1802703d4b2STomas Winkler 1812703d4b2STomas Winkler if (err) { 1822703d4b2STomas Winkler dev_err(&pdev->dev, "request_threaded_irq failure. irq = %d\n", 1832703d4b2STomas Winkler pdev->irq); 1842703d4b2STomas Winkler goto disable_msi; 1852703d4b2STomas Winkler } 1862703d4b2STomas Winkler 187c4d589beSTomas Winkler if (mei_start(dev)) { 1882703d4b2STomas Winkler dev_err(&pdev->dev, "init hw failure.\n"); 1892703d4b2STomas Winkler err = -ENODEV; 1902703d4b2STomas Winkler goto release_irq; 1912703d4b2STomas Winkler } 1922703d4b2STomas Winkler 1932703d4b2STomas Winkler err = mei_register(&pdev->dev); 1942703d4b2STomas Winkler if (err) 1952703d4b2STomas Winkler goto release_irq; 1962703d4b2STomas Winkler 1972703d4b2STomas Winkler mei_pdev = pdev; 1982703d4b2STomas Winkler pci_set_drvdata(pdev, dev); 1992703d4b2STomas Winkler 2002703d4b2STomas Winkler 2012703d4b2STomas Winkler schedule_delayed_work(&dev->timer_work, HZ); 2022703d4b2STomas Winkler 2032703d4b2STomas Winkler mutex_unlock(&mei_mutex); 2042703d4b2STomas Winkler 2052703d4b2STomas Winkler pr_debug("initialization successful.\n"); 2062703d4b2STomas Winkler 2072703d4b2STomas Winkler return 0; 2082703d4b2STomas Winkler 2092703d4b2STomas Winkler release_irq: 2102703d4b2STomas Winkler mei_disable_interrupts(dev); 2112703d4b2STomas Winkler flush_scheduled_work(); 2122703d4b2STomas Winkler free_irq(pdev->irq, dev); 2132703d4b2STomas Winkler disable_msi: 2142703d4b2STomas Winkler pci_disable_msi(pdev); 21552c34561STomas Winkler pci_iounmap(pdev, hw->mem_addr); 2162703d4b2STomas Winkler free_device: 2172703d4b2STomas Winkler kfree(dev); 2182703d4b2STomas Winkler release_regions: 2192703d4b2STomas Winkler pci_release_regions(pdev); 2202703d4b2STomas Winkler disable_device: 2212703d4b2STomas Winkler pci_disable_device(pdev); 2222703d4b2STomas Winkler end: 2232703d4b2STomas Winkler mutex_unlock(&mei_mutex); 2242703d4b2STomas Winkler dev_err(&pdev->dev, "initialization failed.\n"); 2252703d4b2STomas Winkler return err; 2262703d4b2STomas Winkler } 2272703d4b2STomas Winkler 2282703d4b2STomas Winkler /** 2292703d4b2STomas Winkler * mei_remove - Device Removal Routine 2302703d4b2STomas Winkler * 2312703d4b2STomas Winkler * @pdev: PCI device structure 2322703d4b2STomas Winkler * 2332703d4b2STomas Winkler * mei_remove is called by the PCI subsystem to alert the driver 2342703d4b2STomas Winkler * that it should release a PCI device. 2352703d4b2STomas Winkler */ 2362703d4b2STomas Winkler static void mei_remove(struct pci_dev *pdev) 2372703d4b2STomas Winkler { 2382703d4b2STomas Winkler struct mei_device *dev; 23952c34561STomas Winkler struct mei_me_hw *hw; 2402703d4b2STomas Winkler 2412703d4b2STomas Winkler if (mei_pdev != pdev) 2422703d4b2STomas Winkler return; 2432703d4b2STomas Winkler 2442703d4b2STomas Winkler dev = pci_get_drvdata(pdev); 2452703d4b2STomas Winkler if (!dev) 2462703d4b2STomas Winkler return; 2472703d4b2STomas Winkler 24852c34561STomas Winkler hw = to_me_hw(dev); 24952c34561STomas Winkler 2502703d4b2STomas Winkler 2517cb035d9STomas Winkler dev_err(&pdev->dev, "stop\n"); 2527cb035d9STomas Winkler mei_stop(dev); 2532703d4b2STomas Winkler 2542703d4b2STomas Winkler mei_pdev = NULL; 2552703d4b2STomas Winkler 2562703d4b2STomas Winkler /* disable interrupts */ 2572703d4b2STomas Winkler mei_disable_interrupts(dev); 2582703d4b2STomas Winkler 2592703d4b2STomas Winkler free_irq(pdev->irq, dev); 2602703d4b2STomas Winkler pci_disable_msi(pdev); 2612703d4b2STomas Winkler pci_set_drvdata(pdev, NULL); 2622703d4b2STomas Winkler 26352c34561STomas Winkler if (hw->mem_addr) 26452c34561STomas Winkler pci_iounmap(pdev, hw->mem_addr); 2652703d4b2STomas Winkler 2662703d4b2STomas Winkler kfree(dev); 2672703d4b2STomas Winkler 2682703d4b2STomas Winkler pci_release_regions(pdev); 2692703d4b2STomas Winkler pci_disable_device(pdev); 2702703d4b2STomas Winkler 2712703d4b2STomas Winkler mei_deregister(); 2722703d4b2STomas Winkler 2732703d4b2STomas Winkler } 2742703d4b2STomas Winkler #ifdef CONFIG_PM 2752703d4b2STomas Winkler static int mei_pci_suspend(struct device *device) 2762703d4b2STomas Winkler { 2772703d4b2STomas Winkler struct pci_dev *pdev = to_pci_dev(device); 2782703d4b2STomas Winkler struct mei_device *dev = pci_get_drvdata(pdev); 2792703d4b2STomas Winkler 2802703d4b2STomas Winkler if (!dev) 2812703d4b2STomas Winkler return -ENODEV; 2822703d4b2STomas Winkler 2837cb035d9STomas Winkler dev_err(&pdev->dev, "suspend\n"); 2842703d4b2STomas Winkler 2857cb035d9STomas Winkler mei_stop(dev); 2867cb035d9STomas Winkler 2877cb035d9STomas Winkler mei_disable_interrupts(dev); 2882703d4b2STomas Winkler 2892703d4b2STomas Winkler free_irq(pdev->irq, dev); 2902703d4b2STomas Winkler pci_disable_msi(pdev); 2912703d4b2STomas Winkler 2927cb035d9STomas Winkler return 0; 2932703d4b2STomas Winkler } 2942703d4b2STomas Winkler 2952703d4b2STomas Winkler static int mei_pci_resume(struct device *device) 2962703d4b2STomas Winkler { 2972703d4b2STomas Winkler struct pci_dev *pdev = to_pci_dev(device); 2982703d4b2STomas Winkler struct mei_device *dev; 2992703d4b2STomas Winkler int err; 3002703d4b2STomas Winkler 3012703d4b2STomas Winkler dev = pci_get_drvdata(pdev); 3022703d4b2STomas Winkler if (!dev) 3032703d4b2STomas Winkler return -ENODEV; 3042703d4b2STomas Winkler 3052703d4b2STomas Winkler pci_enable_msi(pdev); 3062703d4b2STomas Winkler 3072703d4b2STomas Winkler /* request and enable interrupt */ 3082703d4b2STomas Winkler if (pci_dev_msi_enabled(pdev)) 3092703d4b2STomas Winkler err = request_threaded_irq(pdev->irq, 3102703d4b2STomas Winkler NULL, 31106ecd645STomas Winkler mei_me_irq_thread_handler, 3122703d4b2STomas Winkler IRQF_ONESHOT, KBUILD_MODNAME, dev); 3132703d4b2STomas Winkler else 3142703d4b2STomas Winkler err = request_threaded_irq(pdev->irq, 31506ecd645STomas Winkler mei_me_irq_quick_handler, 31606ecd645STomas Winkler mei_me_irq_thread_handler, 3172703d4b2STomas Winkler IRQF_SHARED, KBUILD_MODNAME, dev); 3182703d4b2STomas Winkler 3192703d4b2STomas Winkler if (err) { 3202703d4b2STomas Winkler dev_err(&pdev->dev, "request_threaded_irq failed: irq = %d.\n", 3212703d4b2STomas Winkler pdev->irq); 3222703d4b2STomas Winkler return err; 3232703d4b2STomas Winkler } 3242703d4b2STomas Winkler 3252703d4b2STomas Winkler mutex_lock(&dev->device_lock); 3262703d4b2STomas Winkler dev->dev_state = MEI_DEV_POWER_UP; 3272703d4b2STomas Winkler mei_reset(dev, 1); 3282703d4b2STomas Winkler mutex_unlock(&dev->device_lock); 3292703d4b2STomas Winkler 3302703d4b2STomas Winkler /* Start timer if stopped in suspend */ 3312703d4b2STomas Winkler schedule_delayed_work(&dev->timer_work, HZ); 3322703d4b2STomas Winkler 3332703d4b2STomas Winkler return err; 3342703d4b2STomas Winkler } 3352703d4b2STomas Winkler static SIMPLE_DEV_PM_OPS(mei_pm_ops, mei_pci_suspend, mei_pci_resume); 3362703d4b2STomas Winkler #define MEI_PM_OPS (&mei_pm_ops) 3372703d4b2STomas Winkler #else 3382703d4b2STomas Winkler #define MEI_PM_OPS NULL 3392703d4b2STomas Winkler #endif /* CONFIG_PM */ 3402703d4b2STomas Winkler /* 3412703d4b2STomas Winkler * PCI driver structure 3422703d4b2STomas Winkler */ 3432703d4b2STomas Winkler static struct pci_driver mei_driver = { 3442703d4b2STomas Winkler .name = KBUILD_MODNAME, 3452703d4b2STomas Winkler .id_table = mei_pci_tbl, 3462703d4b2STomas Winkler .probe = mei_probe, 3472703d4b2STomas Winkler .remove = mei_remove, 3482703d4b2STomas Winkler .shutdown = mei_remove, 3492703d4b2STomas Winkler .driver.pm = MEI_PM_OPS, 3502703d4b2STomas Winkler }; 3512703d4b2STomas Winkler 3522703d4b2STomas Winkler module_pci_driver(mei_driver); 3532703d4b2STomas Winkler 3542703d4b2STomas Winkler MODULE_AUTHOR("Intel Corporation"); 3552703d4b2STomas Winkler MODULE_DESCRIPTION("Intel(R) Management Engine Interface"); 3562703d4b2STomas Winkler MODULE_LICENSE("GPL v2"); 357