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/ioctl.h> 312703d4b2STomas Winkler #include <linux/cdev.h> 322703d4b2STomas Winkler #include <linux/sched.h> 332703d4b2STomas Winkler #include <linux/uuid.h> 342703d4b2STomas Winkler #include <linux/compat.h> 352703d4b2STomas Winkler #include <linux/jiffies.h> 362703d4b2STomas Winkler #include <linux/interrupt.h> 372703d4b2STomas Winkler #include <linux/miscdevice.h> 382703d4b2STomas Winkler 392703d4b2STomas Winkler #include <linux/mei.h> 402703d4b2STomas Winkler 412703d4b2STomas Winkler #include "mei_dev.h" 422703d4b2STomas Winkler #include "hw-me.h" 432703d4b2STomas Winkler #include "client.h" 442703d4b2STomas Winkler 452703d4b2STomas Winkler /* mei_pci_tbl - PCI Device ID Table */ 46b68301e9STomas Winkler static DEFINE_PCI_DEVICE_TABLE(mei_me_pci_tbl) = { 472703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82946GZ)}, 482703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82G35)}, 492703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82Q965)}, 502703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82G965)}, 512703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82GM965)}, 522703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_82GME965)}, 532703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82Q35)}, 542703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82G33)}, 552703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82Q33)}, 562703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_82X38)}, 572703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_3200)}, 582703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_6)}, 592703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_7)}, 602703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_8)}, 612703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_9)}, 622703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9_10)}, 632703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_1)}, 642703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_2)}, 652703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_3)}, 662703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH9M_4)}, 672703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_1)}, 682703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_2)}, 692703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_3)}, 702703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_ICH10_4)}, 712703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_IBXPK_1)}, 722703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_IBXPK_2)}, 732703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_CPT_1)}, 742703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PBG_1)}, 752703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PPT_1)}, 762703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PPT_2)}, 772703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_PPT_3)}, 7876a96359STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_LPT_H)}, 79838b3a6dSTomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_LPT_W)}, 802703d4b2STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_LPT_LP)}, 8176a96359STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_LPT_HR)}, 8276a96359STomas Winkler {PCI_DEVICE(PCI_VENDOR_ID_INTEL, MEI_DEV_ID_WPT_LP)}, 832703d4b2STomas Winkler 842703d4b2STomas Winkler /* required last entry */ 852703d4b2STomas Winkler {0, } 862703d4b2STomas Winkler }; 872703d4b2STomas Winkler 88b68301e9STomas Winkler MODULE_DEVICE_TABLE(pci, mei_me_pci_tbl); 892703d4b2STomas Winkler 902703d4b2STomas Winkler /** 912703d4b2STomas Winkler * mei_quirk_probe - probe for devices that doesn't valid ME interface 92393b148fSMasanari Iida * 932703d4b2STomas Winkler * @pdev: PCI device structure 942703d4b2STomas Winkler * @ent: entry into pci_device_table 952703d4b2STomas Winkler * 962703d4b2STomas Winkler * returns true if ME Interface is valid, false otherwise 972703d4b2STomas Winkler */ 98b68301e9STomas Winkler static bool mei_me_quirk_probe(struct pci_dev *pdev, 992703d4b2STomas Winkler const struct pci_device_id *ent) 1002703d4b2STomas Winkler { 1012703d4b2STomas Winkler u32 reg; 1022703d4b2STomas Winkler if (ent->device == MEI_DEV_ID_PBG_1) { 1032703d4b2STomas Winkler pci_read_config_dword(pdev, 0x48, ®); 1042703d4b2STomas Winkler /* make sure that bit 9 is up and bit 10 is down */ 1052703d4b2STomas Winkler if ((reg & 0x600) == 0x200) { 1062703d4b2STomas Winkler dev_info(&pdev->dev, "Device doesn't have valid ME Interface\n"); 1072703d4b2STomas Winkler return false; 1082703d4b2STomas Winkler } 1092703d4b2STomas Winkler } 1102703d4b2STomas Winkler return true; 1112703d4b2STomas Winkler } 1122703d4b2STomas Winkler /** 1132703d4b2STomas Winkler * mei_probe - Device Initialization Routine 1142703d4b2STomas Winkler * 1152703d4b2STomas Winkler * @pdev: PCI device structure 1162703d4b2STomas Winkler * @ent: entry in kcs_pci_tbl 1172703d4b2STomas Winkler * 1182703d4b2STomas Winkler * returns 0 on success, <0 on failure. 1192703d4b2STomas Winkler */ 120b68301e9STomas Winkler static int mei_me_probe(struct pci_dev *pdev, const struct pci_device_id *ent) 1212703d4b2STomas Winkler { 1222703d4b2STomas Winkler struct mei_device *dev; 12352c34561STomas Winkler struct mei_me_hw *hw; 1242703d4b2STomas Winkler int err; 1252703d4b2STomas Winkler 1262703d4b2STomas Winkler 127b68301e9STomas Winkler if (!mei_me_quirk_probe(pdev, ent)) { 1282703d4b2STomas Winkler err = -ENODEV; 1292703d4b2STomas Winkler goto end; 1302703d4b2STomas Winkler } 1312703d4b2STomas Winkler 1322703d4b2STomas Winkler /* enable pci dev */ 1332703d4b2STomas Winkler err = pci_enable_device(pdev); 1342703d4b2STomas Winkler if (err) { 1352703d4b2STomas Winkler dev_err(&pdev->dev, "failed to enable pci device.\n"); 1362703d4b2STomas Winkler goto end; 1372703d4b2STomas Winkler } 1382703d4b2STomas Winkler /* set PCI host mastering */ 1392703d4b2STomas Winkler pci_set_master(pdev); 1402703d4b2STomas Winkler /* pci request regions for mei driver */ 1412703d4b2STomas Winkler err = pci_request_regions(pdev, KBUILD_MODNAME); 1422703d4b2STomas Winkler if (err) { 1432703d4b2STomas Winkler dev_err(&pdev->dev, "failed to get pci regions.\n"); 1442703d4b2STomas Winkler goto disable_device; 1452703d4b2STomas Winkler } 1463ecfb168STomas Winkler 1473ecfb168STomas Winkler if (dma_set_mask(&pdev->dev, DMA_BIT_MASK(64)) || 1483ecfb168STomas Winkler dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(64))) { 1493ecfb168STomas Winkler 1503ecfb168STomas Winkler err = dma_set_mask(&pdev->dev, DMA_BIT_MASK(32)); 1513ecfb168STomas Winkler if (err) 1523ecfb168STomas Winkler err = dma_set_coherent_mask(&pdev->dev, 1533ecfb168STomas Winkler DMA_BIT_MASK(32)); 1543ecfb168STomas Winkler } 1553ecfb168STomas Winkler if (err) { 1563ecfb168STomas Winkler dev_err(&pdev->dev, "No usable DMA configuration, aborting\n"); 1573ecfb168STomas Winkler goto release_regions; 1583ecfb168STomas Winkler } 1593ecfb168STomas Winkler 1603ecfb168STomas Winkler 1612703d4b2STomas Winkler /* allocates and initializes the mei dev structure */ 16252c34561STomas Winkler dev = mei_me_dev_init(pdev); 1632703d4b2STomas Winkler if (!dev) { 1642703d4b2STomas Winkler err = -ENOMEM; 1652703d4b2STomas Winkler goto release_regions; 1662703d4b2STomas Winkler } 16752c34561STomas Winkler hw = to_me_hw(dev); 1682703d4b2STomas Winkler /* mapping IO device memory */ 16952c34561STomas Winkler hw->mem_addr = pci_iomap(pdev, 0, 0); 17052c34561STomas Winkler if (!hw->mem_addr) { 1712703d4b2STomas Winkler dev_err(&pdev->dev, "mapping I/O device memory failure.\n"); 1722703d4b2STomas Winkler err = -ENOMEM; 1732703d4b2STomas Winkler goto free_device; 1742703d4b2STomas Winkler } 1752703d4b2STomas Winkler pci_enable_msi(pdev); 1762703d4b2STomas Winkler 1772703d4b2STomas Winkler /* request and enable interrupt */ 1782703d4b2STomas Winkler if (pci_dev_msi_enabled(pdev)) 1792703d4b2STomas Winkler err = request_threaded_irq(pdev->irq, 1802703d4b2STomas Winkler NULL, 18106ecd645STomas Winkler mei_me_irq_thread_handler, 1822703d4b2STomas Winkler IRQF_ONESHOT, KBUILD_MODNAME, dev); 1832703d4b2STomas Winkler else 1842703d4b2STomas Winkler err = request_threaded_irq(pdev->irq, 18506ecd645STomas Winkler mei_me_irq_quick_handler, 18606ecd645STomas Winkler mei_me_irq_thread_handler, 1872703d4b2STomas Winkler IRQF_SHARED, KBUILD_MODNAME, dev); 1882703d4b2STomas Winkler 1892703d4b2STomas Winkler if (err) { 1902703d4b2STomas Winkler dev_err(&pdev->dev, "request_threaded_irq failure. irq = %d\n", 1912703d4b2STomas Winkler pdev->irq); 1922703d4b2STomas Winkler goto disable_msi; 1932703d4b2STomas Winkler } 1942703d4b2STomas Winkler 195c4d589beSTomas Winkler if (mei_start(dev)) { 1962703d4b2STomas Winkler dev_err(&pdev->dev, "init hw failure.\n"); 1972703d4b2STomas Winkler err = -ENODEV; 1982703d4b2STomas Winkler goto release_irq; 1992703d4b2STomas Winkler } 2002703d4b2STomas Winkler 20130e53bb8STomas Winkler err = mei_register(dev); 2022703d4b2STomas Winkler if (err) 2032703d4b2STomas Winkler goto release_irq; 2042703d4b2STomas Winkler 2052703d4b2STomas Winkler pci_set_drvdata(pdev, dev); 2062703d4b2STomas Winkler 2072703d4b2STomas Winkler schedule_delayed_work(&dev->timer_work, HZ); 2082703d4b2STomas Winkler 209c4e87b52SAlexander Usyskin dev_dbg(&pdev->dev, "initialization successful.\n"); 2102703d4b2STomas Winkler 2112703d4b2STomas Winkler return 0; 2122703d4b2STomas Winkler 2132703d4b2STomas Winkler release_irq: 214dc844b0dSTomas Winkler mei_cancel_work(dev); 2152703d4b2STomas Winkler mei_disable_interrupts(dev); 2162703d4b2STomas Winkler free_irq(pdev->irq, dev); 2172703d4b2STomas Winkler disable_msi: 2182703d4b2STomas Winkler pci_disable_msi(pdev); 21952c34561STomas Winkler pci_iounmap(pdev, hw->mem_addr); 2202703d4b2STomas Winkler free_device: 2212703d4b2STomas Winkler kfree(dev); 2222703d4b2STomas Winkler release_regions: 2232703d4b2STomas Winkler pci_release_regions(pdev); 2242703d4b2STomas Winkler disable_device: 2252703d4b2STomas Winkler pci_disable_device(pdev); 2262703d4b2STomas Winkler end: 2272703d4b2STomas Winkler dev_err(&pdev->dev, "initialization failed.\n"); 2282703d4b2STomas Winkler return err; 2292703d4b2STomas Winkler } 2302703d4b2STomas Winkler 2312703d4b2STomas Winkler /** 2322703d4b2STomas Winkler * mei_remove - Device Removal Routine 2332703d4b2STomas Winkler * 2342703d4b2STomas Winkler * @pdev: PCI device structure 2352703d4b2STomas Winkler * 2362703d4b2STomas Winkler * mei_remove is called by the PCI subsystem to alert the driver 2372703d4b2STomas Winkler * that it should release a PCI device. 2382703d4b2STomas Winkler */ 239b68301e9STomas Winkler static void mei_me_remove(struct pci_dev *pdev) 2402703d4b2STomas Winkler { 2412703d4b2STomas Winkler struct mei_device *dev; 24252c34561STomas Winkler struct mei_me_hw *hw; 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 251ed6f7ac1SPaul Bolle dev_dbg(&pdev->dev, "stop\n"); 2527cb035d9STomas Winkler mei_stop(dev); 2532703d4b2STomas Winkler 2542703d4b2STomas Winkler /* disable interrupts */ 2552703d4b2STomas Winkler mei_disable_interrupts(dev); 2562703d4b2STomas Winkler 2572703d4b2STomas Winkler free_irq(pdev->irq, dev); 2582703d4b2STomas Winkler pci_disable_msi(pdev); 2592703d4b2STomas Winkler 26052c34561STomas Winkler if (hw->mem_addr) 26152c34561STomas Winkler pci_iounmap(pdev, hw->mem_addr); 2622703d4b2STomas Winkler 26330e53bb8STomas Winkler mei_deregister(dev); 26430e53bb8STomas Winkler 2652703d4b2STomas Winkler kfree(dev); 2662703d4b2STomas Winkler 2672703d4b2STomas Winkler pci_release_regions(pdev); 2682703d4b2STomas Winkler pci_disable_device(pdev); 2692703d4b2STomas Winkler 2702703d4b2STomas Winkler 2712703d4b2STomas Winkler } 27216833257SAlexander Usyskin #ifdef CONFIG_PM_SLEEP 273b68301e9STomas Winkler static int mei_me_pci_suspend(struct device *device) 2742703d4b2STomas Winkler { 2752703d4b2STomas Winkler struct pci_dev *pdev = to_pci_dev(device); 2762703d4b2STomas Winkler struct mei_device *dev = pci_get_drvdata(pdev); 2772703d4b2STomas Winkler 2782703d4b2STomas Winkler if (!dev) 2792703d4b2STomas Winkler return -ENODEV; 2802703d4b2STomas Winkler 281ed6f7ac1SPaul Bolle dev_dbg(&pdev->dev, "suspend\n"); 2822703d4b2STomas Winkler 2837cb035d9STomas Winkler mei_stop(dev); 2847cb035d9STomas Winkler 2857cb035d9STomas Winkler mei_disable_interrupts(dev); 2862703d4b2STomas Winkler 2872703d4b2STomas Winkler free_irq(pdev->irq, dev); 2882703d4b2STomas Winkler pci_disable_msi(pdev); 2892703d4b2STomas Winkler 2907cb035d9STomas Winkler return 0; 2912703d4b2STomas Winkler } 2922703d4b2STomas Winkler 293b68301e9STomas Winkler static int mei_me_pci_resume(struct device *device) 2942703d4b2STomas Winkler { 2952703d4b2STomas Winkler struct pci_dev *pdev = to_pci_dev(device); 2962703d4b2STomas Winkler struct mei_device *dev; 2972703d4b2STomas Winkler int err; 2982703d4b2STomas Winkler 2992703d4b2STomas Winkler dev = pci_get_drvdata(pdev); 3002703d4b2STomas Winkler if (!dev) 3012703d4b2STomas Winkler return -ENODEV; 3022703d4b2STomas Winkler 3032703d4b2STomas Winkler pci_enable_msi(pdev); 3042703d4b2STomas Winkler 3052703d4b2STomas Winkler /* request and enable interrupt */ 3062703d4b2STomas Winkler if (pci_dev_msi_enabled(pdev)) 3072703d4b2STomas Winkler err = request_threaded_irq(pdev->irq, 3082703d4b2STomas Winkler NULL, 30906ecd645STomas Winkler mei_me_irq_thread_handler, 3102703d4b2STomas Winkler IRQF_ONESHOT, KBUILD_MODNAME, dev); 3112703d4b2STomas Winkler else 3122703d4b2STomas Winkler err = request_threaded_irq(pdev->irq, 31306ecd645STomas Winkler mei_me_irq_quick_handler, 31406ecd645STomas Winkler mei_me_irq_thread_handler, 3152703d4b2STomas Winkler IRQF_SHARED, KBUILD_MODNAME, dev); 3162703d4b2STomas Winkler 3172703d4b2STomas Winkler if (err) { 3182703d4b2STomas Winkler dev_err(&pdev->dev, "request_threaded_irq failed: irq = %d.\n", 3192703d4b2STomas Winkler pdev->irq); 3202703d4b2STomas Winkler return err; 3212703d4b2STomas Winkler } 3222703d4b2STomas Winkler 32333ec0826STomas Winkler err = mei_restart(dev); 32433ec0826STomas Winkler if (err) 32533ec0826STomas Winkler return err; 3262703d4b2STomas Winkler 3272703d4b2STomas Winkler /* Start timer if stopped in suspend */ 3282703d4b2STomas Winkler schedule_delayed_work(&dev->timer_work, HZ); 3292703d4b2STomas Winkler 33033ec0826STomas Winkler return 0; 3312703d4b2STomas Winkler } 33216833257SAlexander Usyskin 333b68301e9STomas Winkler static SIMPLE_DEV_PM_OPS(mei_me_pm_ops, mei_me_pci_suspend, mei_me_pci_resume); 334b68301e9STomas Winkler #define MEI_ME_PM_OPS (&mei_me_pm_ops) 3352703d4b2STomas Winkler #else 336b68301e9STomas Winkler #define MEI_ME_PM_OPS NULL 33716833257SAlexander Usyskin #endif /* CONFIG_PM_SLEEP */ 3382703d4b2STomas Winkler /* 3392703d4b2STomas Winkler * PCI driver structure 3402703d4b2STomas Winkler */ 341b68301e9STomas Winkler static struct pci_driver mei_me_driver = { 3422703d4b2STomas Winkler .name = KBUILD_MODNAME, 343b68301e9STomas Winkler .id_table = mei_me_pci_tbl, 344b68301e9STomas Winkler .probe = mei_me_probe, 345b68301e9STomas Winkler .remove = mei_me_remove, 346b68301e9STomas Winkler .shutdown = mei_me_remove, 347b68301e9STomas Winkler .driver.pm = MEI_ME_PM_OPS, 3482703d4b2STomas Winkler }; 3492703d4b2STomas Winkler 350b68301e9STomas Winkler module_pci_driver(mei_me_driver); 3512703d4b2STomas Winkler 3522703d4b2STomas Winkler MODULE_AUTHOR("Intel Corporation"); 3532703d4b2STomas Winkler MODULE_DESCRIPTION("Intel(R) Management Engine Interface"); 3542703d4b2STomas Winkler MODULE_LICENSE("GPL v2"); 355