19fff0425STomas Winkler // SPDX-License-Identifier: GPL-2.0 22703d4b2STomas Winkler /* 395953618SAlexander Usyskin * Copyright (c) 2003-2022, Intel Corporation. All rights reserved. 42703d4b2STomas Winkler * Intel Management Engine Interface (Intel MEI) Linux driver 52703d4b2STomas Winkler */ 69fff0425STomas Winkler 72703d4b2STomas Winkler #include <linux/module.h> 82703d4b2STomas Winkler #include <linux/kernel.h> 92703d4b2STomas Winkler #include <linux/device.h> 102703d4b2STomas Winkler #include <linux/errno.h> 112703d4b2STomas Winkler #include <linux/types.h> 122703d4b2STomas Winkler #include <linux/pci.h> 13515a2f50SChristophe JAILLET #include <linux/dma-mapping.h> 142703d4b2STomas Winkler #include <linux/sched.h> 152703d4b2STomas Winkler #include <linux/interrupt.h> 162703d4b2STomas Winkler 17989561deSTomeu Vizoso #include <linux/pm_domain.h> 18180ea05bSTomas Winkler #include <linux/pm_runtime.h> 19180ea05bSTomas Winkler 202703d4b2STomas Winkler #include <linux/mei.h> 212703d4b2STomas Winkler 222703d4b2STomas Winkler #include "mei_dev.h" 232703d4b2STomas Winkler #include "client.h" 246e4cd27aSTomas Winkler #include "hw-me-regs.h" 256e4cd27aSTomas Winkler #include "hw-me.h" 262703d4b2STomas Winkler 272703d4b2STomas Winkler /* mei_pci_tbl - PCI Device ID Table */ 28a05f8f86STomas Winkler static const struct pci_device_id mei_me_pci_tbl[] = { 29f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_82946GZ, MEI_ME_ICH_CFG)}, 30f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_82G35, MEI_ME_ICH_CFG)}, 31f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_82Q965, MEI_ME_ICH_CFG)}, 32f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_82G965, MEI_ME_ICH_CFG)}, 33f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_82GM965, MEI_ME_ICH_CFG)}, 34f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_82GME965, MEI_ME_ICH_CFG)}, 35f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82Q35, MEI_ME_ICH_CFG)}, 36f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82G33, MEI_ME_ICH_CFG)}, 37f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82Q33, MEI_ME_ICH_CFG)}, 38f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82X38, MEI_ME_ICH_CFG)}, 39f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_3200, MEI_ME_ICH_CFG)}, 408d929d48SAlexander Usyskin 41f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_6, MEI_ME_ICH_CFG)}, 42f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_7, MEI_ME_ICH_CFG)}, 43f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_8, MEI_ME_ICH_CFG)}, 44f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_9, MEI_ME_ICH_CFG)}, 45f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_10, MEI_ME_ICH_CFG)}, 46f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_1, MEI_ME_ICH_CFG)}, 47f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_2, MEI_ME_ICH_CFG)}, 48f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_3, MEI_ME_ICH_CFG)}, 49f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_4, MEI_ME_ICH_CFG)}, 508d929d48SAlexander Usyskin 51f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_1, MEI_ME_ICH10_CFG)}, 52f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_2, MEI_ME_ICH10_CFG)}, 53f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_3, MEI_ME_ICH10_CFG)}, 54f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_4, MEI_ME_ICH10_CFG)}, 552703d4b2STomas Winkler 56f8204f0dSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_IBXPK_1, MEI_ME_PCH6_CFG)}, 57f8204f0dSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_IBXPK_2, MEI_ME_PCH6_CFG)}, 58f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_CPT_1, MEI_ME_PCH_CPT_PBG_CFG)}, 59f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_PBG_1, MEI_ME_PCH_CPT_PBG_CFG)}, 60f8204f0dSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_PPT_1, MEI_ME_PCH7_CFG)}, 61f8204f0dSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_PPT_2, MEI_ME_PCH7_CFG)}, 62f8204f0dSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_PPT_3, MEI_ME_PCH7_CFG)}, 63f76d77f5STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_H, MEI_ME_PCH8_SPS_4_CFG)}, 64f76d77f5STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_W, MEI_ME_PCH8_SPS_4_CFG)}, 65f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_LP, MEI_ME_PCH8_CFG)}, 66f76d77f5STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_HR, MEI_ME_PCH8_SPS_4_CFG)}, 67f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_WPT_LP, MEI_ME_PCH8_CFG)}, 68f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_WPT_LP_2, MEI_ME_PCH8_CFG)}, 691625c7ecSTomas Winkler 70f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_SPT, MEI_ME_PCH8_CFG)}, 71f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_2, MEI_ME_PCH8_CFG)}, 722f79d3d1SAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_3, MEI_ME_PCH8_ITOUCH_CFG)}, 73f76d77f5STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_H, MEI_ME_PCH8_SPS_4_CFG)}, 74f76d77f5STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_H_2, MEI_ME_PCH8_SPS_4_CFG)}, 75f76d77f5STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_LBG, MEI_ME_PCH12_SPS_4_CFG)}, 76dd16f6cdSTomas Winkler 77f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_BXT_M, MEI_ME_PCH8_CFG)}, 78f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_APL_I, MEI_ME_PCH8_CFG)}, 79f5ac3c49STomas Winkler 80f7ee8eadSTomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_DNV_IE, MEI_ME_PCH8_CFG)}, 81f7ee8eadSTomas Winkler 82688cb678STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_GLK, MEI_ME_PCH8_CFG)}, 83688cb678STomas Winkler 84f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_KBP, MEI_ME_PCH8_CFG)}, 85f5ac3c49STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_KBP_2, MEI_ME_PCH8_CFG)}, 864afc339eSTomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_KBP_3, MEI_ME_PCH8_CFG)}, 87ac182e8aSAlexander Usyskin 881dbfe7f2SAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_LP, MEI_ME_PCH12_CFG)}, 892f79d3d1SAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_LP_3, MEI_ME_PCH8_ITOUCH_CFG)}, 90f76d77f5STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_H, MEI_ME_PCH12_SPS_CFG)}, 912f79d3d1SAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_H_3, MEI_ME_PCH12_SPS_ITOUCH_CFG)}, 92f8f4aa68SAlexander Usyskin 934d86dfd3STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_LP, MEI_ME_PCH12_CFG)}, 942f79d3d1SAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_LP_3, MEI_ME_PCH8_ITOUCH_CFG)}, 9582b29b9fSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_V, MEI_ME_PCH12_CFG)}, 96559e575aSTomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_H, MEI_ME_PCH12_CFG)}, 972f79d3d1SAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_H_3, MEI_ME_PCH8_ITOUCH_CFG)}, 984d86dfd3STomas Winkler 99efe814e9STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ICP_LP, MEI_ME_PCH12_CFG)}, 10075c10c5eSAndy Shevchenko {MEI_PCI_DEVICE(MEI_DEV_ID_ICP_N, MEI_ME_PCH12_CFG)}, 101efe814e9STomas Winkler 10252f6efdfSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_TGP_LP, MEI_ME_PCH15_CFG)}, 1038c289ea0SAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_TGP_H, MEI_ME_PCH15_SPS_CFG)}, 104587f1740STomas Winkler 1050db4a15dSTomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_JSP_N, MEI_ME_PCH15_CFG)}, 1060db4a15dSTomas Winkler 10752f6efdfSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_MCC, MEI_ME_PCH15_CFG)}, 1081be8624aSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_MCC_4, MEI_ME_PCH8_CFG)}, 1091be8624aSAlexander Usyskin 11099397d33SAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_CDF, MEI_ME_PCH8_CFG)}, 11199397d33SAlexander Usyskin 112372726cbSTomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_EBG, MEI_ME_PCH15_SPS_CFG)}, 113372726cbSTomas Winkler 114f7545efaSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_S, MEI_ME_PCH15_CFG)}, 115930c922aSAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_LP, MEI_ME_PCH15_CFG)}, 1160df74278STomas Winkler {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_P, MEI_ME_PCH15_CFG)}, 1177bbbd084SAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_N, MEI_ME_PCH15_CFG)}, 118f7545efaSAlexander Usyskin 1193ed8c7d3SAlexander Usyskin {MEI_PCI_DEVICE(MEI_DEV_ID_RPL_S, MEI_ME_PCH15_CFG)}, 1203ed8c7d3SAlexander Usyskin 1212703d4b2STomas Winkler /* required last entry */ 1222703d4b2STomas Winkler {0, } 1232703d4b2STomas Winkler }; 1242703d4b2STomas Winkler 125b68301e9STomas Winkler MODULE_DEVICE_TABLE(pci, mei_me_pci_tbl); 1262703d4b2STomas Winkler 127bbd6d050SRafael J. Wysocki #ifdef CONFIG_PM 128e13fa90cSTomas Winkler static inline void mei_me_set_pm_domain(struct mei_device *dev); 129e13fa90cSTomas Winkler static inline void mei_me_unset_pm_domain(struct mei_device *dev); 130e13fa90cSTomas Winkler #else 131e13fa90cSTomas Winkler static inline void mei_me_set_pm_domain(struct mei_device *dev) {} 132e13fa90cSTomas Winkler static inline void mei_me_unset_pm_domain(struct mei_device *dev) {} 133bbd6d050SRafael J. Wysocki #endif /* CONFIG_PM */ 134e13fa90cSTomas Winkler 135261e071aSTomas Winkler static int mei_me_read_fws(const struct mei_device *dev, int where, u32 *val) 136261e071aSTomas Winkler { 137261e071aSTomas Winkler struct pci_dev *pdev = to_pci_dev(dev->dev); 138261e071aSTomas Winkler 139261e071aSTomas Winkler return pci_read_config_dword(pdev, where, val); 140261e071aSTomas Winkler } 141261e071aSTomas Winkler 1422703d4b2STomas Winkler /** 143ce23139cSAlexander Usyskin * mei_me_quirk_probe - probe for devices that doesn't valid ME interface 144393b148fSMasanari Iida * 1452703d4b2STomas Winkler * @pdev: PCI device structure 146c919951dSTomas Winkler * @cfg: per generation config 1472703d4b2STomas Winkler * 148a8605ea2SAlexander Usyskin * Return: true if ME Interface is valid, false otherwise 1492703d4b2STomas Winkler */ 150b68301e9STomas Winkler static bool mei_me_quirk_probe(struct pci_dev *pdev, 151c919951dSTomas Winkler const struct mei_cfg *cfg) 1522703d4b2STomas Winkler { 153c919951dSTomas Winkler if (cfg->quirk_probe && cfg->quirk_probe(pdev)) { 1542703d4b2STomas Winkler dev_info(&pdev->dev, "Device doesn't have valid ME Interface\n"); 1552703d4b2STomas Winkler return false; 1562703d4b2STomas Winkler } 157c919951dSTomas Winkler 158c919951dSTomas Winkler return true; 159c919951dSTomas Winkler } 160c919951dSTomas Winkler 1612703d4b2STomas Winkler /** 162ce23139cSAlexander Usyskin * mei_me_probe - Device Initialization Routine 1632703d4b2STomas Winkler * 1642703d4b2STomas Winkler * @pdev: PCI device structure 1652703d4b2STomas Winkler * @ent: entry in kcs_pci_tbl 1662703d4b2STomas Winkler * 167a8605ea2SAlexander Usyskin * Return: 0 on success, <0 on failure. 1682703d4b2STomas Winkler */ 169b68301e9STomas Winkler static int mei_me_probe(struct pci_dev *pdev, const struct pci_device_id *ent) 1702703d4b2STomas Winkler { 171f5ac3c49STomas Winkler const struct mei_cfg *cfg; 1722703d4b2STomas Winkler struct mei_device *dev; 17352c34561STomas Winkler struct mei_me_hw *hw; 1741fa55b4eSAlexander Usyskin unsigned int irqflags; 1752703d4b2STomas Winkler int err; 1762703d4b2STomas Winkler 177f5ac3c49STomas Winkler cfg = mei_me_get_cfg(ent->driver_data); 178f5ac3c49STomas Winkler if (!cfg) 179f5ac3c49STomas Winkler return -ENODEV; 1802703d4b2STomas Winkler 181c919951dSTomas Winkler if (!mei_me_quirk_probe(pdev, cfg)) 182c919951dSTomas Winkler return -ENODEV; 1832703d4b2STomas Winkler 1842703d4b2STomas Winkler /* enable pci dev */ 185f8a09605STomas Winkler err = pcim_enable_device(pdev); 1862703d4b2STomas Winkler if (err) { 1872703d4b2STomas Winkler dev_err(&pdev->dev, "failed to enable pci device.\n"); 1882703d4b2STomas Winkler goto end; 1892703d4b2STomas Winkler } 1902703d4b2STomas Winkler /* set PCI host mastering */ 1912703d4b2STomas Winkler pci_set_master(pdev); 192f8a09605STomas Winkler /* pci request regions and mapping IO device memory for mei driver */ 193f8a09605STomas Winkler err = pcim_iomap_regions(pdev, BIT(0), KBUILD_MODNAME); 1942703d4b2STomas Winkler if (err) { 1952703d4b2STomas Winkler dev_err(&pdev->dev, "failed to get pci regions.\n"); 196f8a09605STomas Winkler goto end; 1972703d4b2STomas Winkler } 1983ecfb168STomas Winkler 199515a2f50SChristophe JAILLET err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64)); 2003ecfb168STomas Winkler if (err) { 2013ecfb168STomas Winkler dev_err(&pdev->dev, "No usable DMA configuration, aborting\n"); 202f8a09605STomas Winkler goto end; 2033ecfb168STomas Winkler } 2043ecfb168STomas Winkler 2052703d4b2STomas Winkler /* allocates and initializes the mei dev structure */ 20695953618SAlexander Usyskin dev = mei_me_dev_init(&pdev->dev, cfg, false); 2072703d4b2STomas Winkler if (!dev) { 2082703d4b2STomas Winkler err = -ENOMEM; 209f8a09605STomas Winkler goto end; 2102703d4b2STomas Winkler } 21152c34561STomas Winkler hw = to_me_hw(dev); 212f8a09605STomas Winkler hw->mem_addr = pcim_iomap_table(pdev)[0]; 213261e071aSTomas Winkler hw->read_fws = mei_me_read_fws; 214f8a09605STomas Winkler 2152703d4b2STomas Winkler pci_enable_msi(pdev); 2162703d4b2STomas Winkler 217fec874a8SBenjamin Lee hw->irq = pdev->irq; 218fec874a8SBenjamin Lee 2192703d4b2STomas Winkler /* request and enable interrupt */ 2201fa55b4eSAlexander Usyskin irqflags = pci_dev_msi_enabled(pdev) ? IRQF_ONESHOT : IRQF_SHARED; 2211fa55b4eSAlexander Usyskin 2222703d4b2STomas Winkler err = request_threaded_irq(pdev->irq, 22306ecd645STomas Winkler mei_me_irq_quick_handler, 22406ecd645STomas Winkler mei_me_irq_thread_handler, 2251fa55b4eSAlexander Usyskin irqflags, KBUILD_MODNAME, dev); 2262703d4b2STomas Winkler if (err) { 2272703d4b2STomas Winkler dev_err(&pdev->dev, "request_threaded_irq failure. irq = %d\n", 2282703d4b2STomas Winkler pdev->irq); 229f8a09605STomas Winkler goto end; 2302703d4b2STomas Winkler } 2312703d4b2STomas Winkler 232c4d589beSTomas Winkler if (mei_start(dev)) { 2332703d4b2STomas Winkler dev_err(&pdev->dev, "init hw failure.\n"); 2342703d4b2STomas Winkler err = -ENODEV; 2352703d4b2STomas Winkler goto release_irq; 2362703d4b2STomas Winkler } 2372703d4b2STomas Winkler 238180ea05bSTomas Winkler pm_runtime_set_autosuspend_delay(&pdev->dev, MEI_ME_RPM_TIMEOUT); 239180ea05bSTomas Winkler pm_runtime_use_autosuspend(&pdev->dev); 240180ea05bSTomas Winkler 241f3d8e878SAlexander Usyskin err = mei_register(dev, &pdev->dev); 2422703d4b2STomas Winkler if (err) 2431f7e489aSAlexander Usyskin goto stop; 2442703d4b2STomas Winkler 2452703d4b2STomas Winkler pci_set_drvdata(pdev, dev); 2462703d4b2STomas Winkler 247e13fa90cSTomas Winkler /* 248557909e1SAlexander Usyskin * MEI requires to resume from runtime suspend mode 249557909e1SAlexander Usyskin * in order to perform link reset flow upon system suspend. 250557909e1SAlexander Usyskin */ 251e0751556SRafael J. Wysocki dev_pm_set_driver_flags(&pdev->dev, DPM_FLAG_NO_DIRECT_COMPLETE); 252557909e1SAlexander Usyskin 253557909e1SAlexander Usyskin /* 254b42dc063SAlexander Usyskin * ME maps runtime suspend/resume to D0i states, 255b42dc063SAlexander Usyskin * hence we need to go around native PCI runtime service which 256b42dc063SAlexander Usyskin * eventually brings the device into D3cold/hot state, 257b42dc063SAlexander Usyskin * but the mei device cannot wake up from D3 unlike from D0i3. 258b42dc063SAlexander Usyskin * To get around the PCI device native runtime pm, 259b42dc063SAlexander Usyskin * ME uses runtime pm domain handlers which take precedence 260b42dc063SAlexander Usyskin * over the driver's pm handlers. 261e13fa90cSTomas Winkler */ 262e13fa90cSTomas Winkler mei_me_set_pm_domain(dev); 263e13fa90cSTomas Winkler 264cc365dcfSTomas Winkler if (mei_pg_is_enabled(dev)) { 265180ea05bSTomas Winkler pm_runtime_put_noidle(&pdev->dev); 266cc365dcfSTomas Winkler if (hw->d0i3_supported) 267cc365dcfSTomas Winkler pm_runtime_allow(&pdev->dev); 268cc365dcfSTomas Winkler } 269180ea05bSTomas Winkler 270c4e87b52SAlexander Usyskin dev_dbg(&pdev->dev, "initialization successful.\n"); 2712703d4b2STomas Winkler 2722703d4b2STomas Winkler return 0; 2732703d4b2STomas Winkler 2741f7e489aSAlexander Usyskin stop: 2751f7e489aSAlexander Usyskin mei_stop(dev); 2762703d4b2STomas Winkler release_irq: 277dc844b0dSTomas Winkler mei_cancel_work(dev); 2782703d4b2STomas Winkler mei_disable_interrupts(dev); 2792703d4b2STomas Winkler free_irq(pdev->irq, dev); 2802703d4b2STomas Winkler end: 2812703d4b2STomas Winkler dev_err(&pdev->dev, "initialization failed.\n"); 2822703d4b2STomas Winkler return err; 2832703d4b2STomas Winkler } 2842703d4b2STomas Winkler 2852703d4b2STomas Winkler /** 2865c4c0106STomas Winkler * mei_me_shutdown - Device Removal Routine 2875c4c0106STomas Winkler * 2885c4c0106STomas Winkler * @pdev: PCI device structure 2895c4c0106STomas Winkler * 2905c4c0106STomas Winkler * mei_me_shutdown is called from the reboot notifier 2915c4c0106STomas Winkler * it's a simplified version of remove so we go down 2925c4c0106STomas Winkler * faster. 2935c4c0106STomas Winkler */ 2945c4c0106STomas Winkler static void mei_me_shutdown(struct pci_dev *pdev) 2955c4c0106STomas Winkler { 2965c4c0106STomas Winkler struct mei_device *dev; 2975c4c0106STomas Winkler 2985c4c0106STomas Winkler dev = pci_get_drvdata(pdev); 2995c4c0106STomas Winkler if (!dev) 3005c4c0106STomas Winkler return; 3015c4c0106STomas Winkler 3025c4c0106STomas Winkler dev_dbg(&pdev->dev, "shutdown\n"); 3035c4c0106STomas Winkler mei_stop(dev); 3045c4c0106STomas Winkler 3055c4c0106STomas Winkler mei_me_unset_pm_domain(dev); 3065c4c0106STomas Winkler 3075c4c0106STomas Winkler mei_disable_interrupts(dev); 3085c4c0106STomas Winkler free_irq(pdev->irq, dev); 3095c4c0106STomas Winkler } 3105c4c0106STomas Winkler 3115c4c0106STomas Winkler /** 312ce23139cSAlexander Usyskin * mei_me_remove - Device Removal Routine 3132703d4b2STomas Winkler * 3142703d4b2STomas Winkler * @pdev: PCI device structure 3152703d4b2STomas Winkler * 3165c4c0106STomas Winkler * mei_me_remove is called by the PCI subsystem to alert the driver 3172703d4b2STomas Winkler * that it should release a PCI device. 3182703d4b2STomas Winkler */ 319b68301e9STomas Winkler static void mei_me_remove(struct pci_dev *pdev) 3202703d4b2STomas Winkler { 3212703d4b2STomas Winkler struct mei_device *dev; 3222703d4b2STomas Winkler 3232703d4b2STomas Winkler dev = pci_get_drvdata(pdev); 3242703d4b2STomas Winkler if (!dev) 3252703d4b2STomas Winkler return; 3262703d4b2STomas Winkler 327180ea05bSTomas Winkler if (mei_pg_is_enabled(dev)) 328180ea05bSTomas Winkler pm_runtime_get_noresume(&pdev->dev); 329180ea05bSTomas Winkler 330ed6f7ac1SPaul Bolle dev_dbg(&pdev->dev, "stop\n"); 3317cb035d9STomas Winkler mei_stop(dev); 3322703d4b2STomas Winkler 333e13fa90cSTomas Winkler mei_me_unset_pm_domain(dev); 334e13fa90cSTomas Winkler 3352703d4b2STomas Winkler mei_disable_interrupts(dev); 3362703d4b2STomas Winkler 3372703d4b2STomas Winkler free_irq(pdev->irq, dev); 3382703d4b2STomas Winkler 33930e53bb8STomas Winkler mei_deregister(dev); 3402703d4b2STomas Winkler } 341f8a09605STomas Winkler 34216833257SAlexander Usyskin #ifdef CONFIG_PM_SLEEP 343*907deab2SAlexander Usyskin static int mei_me_pci_prepare(struct device *device) 344*907deab2SAlexander Usyskin { 345*907deab2SAlexander Usyskin pm_runtime_resume(device); 346*907deab2SAlexander Usyskin return 0; 347*907deab2SAlexander Usyskin } 348*907deab2SAlexander Usyskin 349b68301e9STomas Winkler static int mei_me_pci_suspend(struct device *device) 3502703d4b2STomas Winkler { 3512703d4b2STomas Winkler struct pci_dev *pdev = to_pci_dev(device); 3522703d4b2STomas Winkler struct mei_device *dev = pci_get_drvdata(pdev); 3532703d4b2STomas Winkler 3542703d4b2STomas Winkler if (!dev) 3552703d4b2STomas Winkler return -ENODEV; 3562703d4b2STomas Winkler 357ed6f7ac1SPaul Bolle dev_dbg(&pdev->dev, "suspend\n"); 3582703d4b2STomas Winkler 3597cb035d9STomas Winkler mei_stop(dev); 3607cb035d9STomas Winkler 3617cb035d9STomas Winkler mei_disable_interrupts(dev); 3622703d4b2STomas Winkler 3632703d4b2STomas Winkler free_irq(pdev->irq, dev); 3642703d4b2STomas Winkler pci_disable_msi(pdev); 3652703d4b2STomas Winkler 3667cb035d9STomas Winkler return 0; 3672703d4b2STomas Winkler } 3682703d4b2STomas Winkler 369b68301e9STomas Winkler static int mei_me_pci_resume(struct device *device) 3702703d4b2STomas Winkler { 3712703d4b2STomas Winkler struct pci_dev *pdev = to_pci_dev(device); 3722703d4b2STomas Winkler struct mei_device *dev; 3731fa55b4eSAlexander Usyskin unsigned int irqflags; 3742703d4b2STomas Winkler int err; 3752703d4b2STomas Winkler 3762703d4b2STomas Winkler dev = pci_get_drvdata(pdev); 3772703d4b2STomas Winkler if (!dev) 3782703d4b2STomas Winkler return -ENODEV; 3792703d4b2STomas Winkler 3802703d4b2STomas Winkler pci_enable_msi(pdev); 3812703d4b2STomas Winkler 3821fa55b4eSAlexander Usyskin irqflags = pci_dev_msi_enabled(pdev) ? IRQF_ONESHOT : IRQF_SHARED; 3831fa55b4eSAlexander Usyskin 3842703d4b2STomas Winkler /* request and enable interrupt */ 3852703d4b2STomas Winkler err = request_threaded_irq(pdev->irq, 38606ecd645STomas Winkler mei_me_irq_quick_handler, 38706ecd645STomas Winkler mei_me_irq_thread_handler, 3881fa55b4eSAlexander Usyskin irqflags, KBUILD_MODNAME, dev); 3892703d4b2STomas Winkler 3902703d4b2STomas Winkler if (err) { 3912703d4b2STomas Winkler dev_err(&pdev->dev, "request_threaded_irq failed: irq = %d.\n", 3922703d4b2STomas Winkler pdev->irq); 3932703d4b2STomas Winkler return err; 3942703d4b2STomas Winkler } 3952703d4b2STomas Winkler 39633ec0826STomas Winkler err = mei_restart(dev); 39733ec0826STomas Winkler if (err) 39833ec0826STomas Winkler return err; 3992703d4b2STomas Winkler 4002703d4b2STomas Winkler /* Start timer if stopped in suspend */ 4012703d4b2STomas Winkler schedule_delayed_work(&dev->timer_work, HZ); 4022703d4b2STomas Winkler 40333ec0826STomas Winkler return 0; 4042703d4b2STomas Winkler } 405*907deab2SAlexander Usyskin 406*907deab2SAlexander Usyskin static void mei_me_pci_complete(struct device *device) 407*907deab2SAlexander Usyskin { 408*907deab2SAlexander Usyskin pm_runtime_suspend(device); 409*907deab2SAlexander Usyskin } 410*907deab2SAlexander Usyskin #else /* CONFIG_PM_SLEEP */ 411*907deab2SAlexander Usyskin 412*907deab2SAlexander Usyskin #define mei_me_pci_prepare NULL 413*907deab2SAlexander Usyskin #define mei_me_pci_complete NULL 414*907deab2SAlexander Usyskin 415*907deab2SAlexander Usyskin #endif /* !CONFIG_PM_SLEEP */ 41616833257SAlexander Usyskin 417bbd6d050SRafael J. Wysocki #ifdef CONFIG_PM 418180ea05bSTomas Winkler static int mei_me_pm_runtime_idle(struct device *device) 419180ea05bSTomas Winkler { 420180ea05bSTomas Winkler struct mei_device *dev; 421180ea05bSTomas Winkler 422ab81f3f3SChuhong Yuan dev_dbg(device, "rpm: me: runtime_idle\n"); 423180ea05bSTomas Winkler 424ab81f3f3SChuhong Yuan dev = dev_get_drvdata(device); 425180ea05bSTomas Winkler if (!dev) 426180ea05bSTomas Winkler return -ENODEV; 427180ea05bSTomas Winkler if (mei_write_is_idle(dev)) 428d5d83f8aSAlexander Usyskin pm_runtime_autosuspend(device); 429180ea05bSTomas Winkler 430180ea05bSTomas Winkler return -EBUSY; 431180ea05bSTomas Winkler } 432180ea05bSTomas Winkler 433180ea05bSTomas Winkler static int mei_me_pm_runtime_suspend(struct device *device) 434180ea05bSTomas Winkler { 435180ea05bSTomas Winkler struct mei_device *dev; 436180ea05bSTomas Winkler int ret; 437180ea05bSTomas Winkler 438ab81f3f3SChuhong Yuan dev_dbg(device, "rpm: me: runtime suspend\n"); 439180ea05bSTomas Winkler 440ab81f3f3SChuhong Yuan dev = dev_get_drvdata(device); 441180ea05bSTomas Winkler if (!dev) 442180ea05bSTomas Winkler return -ENODEV; 443180ea05bSTomas Winkler 444180ea05bSTomas Winkler mutex_lock(&dev->device_lock); 445180ea05bSTomas Winkler 446180ea05bSTomas Winkler if (mei_write_is_idle(dev)) 4472d1995fcSAlexander Usyskin ret = mei_me_pg_enter_sync(dev); 448180ea05bSTomas Winkler else 449180ea05bSTomas Winkler ret = -EAGAIN; 450180ea05bSTomas Winkler 451180ea05bSTomas Winkler mutex_unlock(&dev->device_lock); 452180ea05bSTomas Winkler 453ab81f3f3SChuhong Yuan dev_dbg(device, "rpm: me: runtime suspend ret=%d\n", ret); 454180ea05bSTomas Winkler 45577537ad2SAlexander Usyskin if (ret && ret != -EAGAIN) 45677537ad2SAlexander Usyskin schedule_work(&dev->reset_work); 45777537ad2SAlexander Usyskin 458180ea05bSTomas Winkler return ret; 459180ea05bSTomas Winkler } 460180ea05bSTomas Winkler 461180ea05bSTomas Winkler static int mei_me_pm_runtime_resume(struct device *device) 462180ea05bSTomas Winkler { 463180ea05bSTomas Winkler struct mei_device *dev; 464180ea05bSTomas Winkler int ret; 465180ea05bSTomas Winkler 466ab81f3f3SChuhong Yuan dev_dbg(device, "rpm: me: runtime resume\n"); 467180ea05bSTomas Winkler 468ab81f3f3SChuhong Yuan dev = dev_get_drvdata(device); 469180ea05bSTomas Winkler if (!dev) 470180ea05bSTomas Winkler return -ENODEV; 471180ea05bSTomas Winkler 472180ea05bSTomas Winkler mutex_lock(&dev->device_lock); 473180ea05bSTomas Winkler 4742d1995fcSAlexander Usyskin ret = mei_me_pg_exit_sync(dev); 475180ea05bSTomas Winkler 476180ea05bSTomas Winkler mutex_unlock(&dev->device_lock); 477180ea05bSTomas Winkler 478ab81f3f3SChuhong Yuan dev_dbg(device, "rpm: me: runtime resume ret = %d\n", ret); 479180ea05bSTomas Winkler 48077537ad2SAlexander Usyskin if (ret) 48177537ad2SAlexander Usyskin schedule_work(&dev->reset_work); 48277537ad2SAlexander Usyskin 483180ea05bSTomas Winkler return ret; 484180ea05bSTomas Winkler } 485e13fa90cSTomas Winkler 486e13fa90cSTomas Winkler /** 4877efceb55SGeert Uytterhoeven * mei_me_set_pm_domain - fill and set pm domain structure for device 488e13fa90cSTomas Winkler * 489e13fa90cSTomas Winkler * @dev: mei_device 490e13fa90cSTomas Winkler */ 491e13fa90cSTomas Winkler static inline void mei_me_set_pm_domain(struct mei_device *dev) 492e13fa90cSTomas Winkler { 493d08b8fc0STomas Winkler struct pci_dev *pdev = to_pci_dev(dev->dev); 494e13fa90cSTomas Winkler 495e13fa90cSTomas Winkler if (pdev->dev.bus && pdev->dev.bus->pm) { 496e13fa90cSTomas Winkler dev->pg_domain.ops = *pdev->dev.bus->pm; 497e13fa90cSTomas Winkler 498e13fa90cSTomas Winkler dev->pg_domain.ops.runtime_suspend = mei_me_pm_runtime_suspend; 499e13fa90cSTomas Winkler dev->pg_domain.ops.runtime_resume = mei_me_pm_runtime_resume; 500e13fa90cSTomas Winkler dev->pg_domain.ops.runtime_idle = mei_me_pm_runtime_idle; 501e13fa90cSTomas Winkler 502989561deSTomeu Vizoso dev_pm_domain_set(&pdev->dev, &dev->pg_domain); 503e13fa90cSTomas Winkler } 504e13fa90cSTomas Winkler } 505e13fa90cSTomas Winkler 506e13fa90cSTomas Winkler /** 5077efceb55SGeert Uytterhoeven * mei_me_unset_pm_domain - clean pm domain structure for device 508e13fa90cSTomas Winkler * 509e13fa90cSTomas Winkler * @dev: mei_device 510e13fa90cSTomas Winkler */ 511e13fa90cSTomas Winkler static inline void mei_me_unset_pm_domain(struct mei_device *dev) 512e13fa90cSTomas Winkler { 513e13fa90cSTomas Winkler /* stop using pm callbacks if any */ 514989561deSTomeu Vizoso dev_pm_domain_set(dev->dev, NULL); 515e13fa90cSTomas Winkler } 516180ea05bSTomas Winkler 517180ea05bSTomas Winkler static const struct dev_pm_ops mei_me_pm_ops = { 518*907deab2SAlexander Usyskin .prepare = mei_me_pci_prepare, 519*907deab2SAlexander Usyskin .complete = mei_me_pci_complete, 520180ea05bSTomas Winkler SET_SYSTEM_SLEEP_PM_OPS(mei_me_pci_suspend, 521180ea05bSTomas Winkler mei_me_pci_resume) 522180ea05bSTomas Winkler SET_RUNTIME_PM_OPS( 523180ea05bSTomas Winkler mei_me_pm_runtime_suspend, 524180ea05bSTomas Winkler mei_me_pm_runtime_resume, 525180ea05bSTomas Winkler mei_me_pm_runtime_idle) 526180ea05bSTomas Winkler }; 527180ea05bSTomas Winkler 528b68301e9STomas Winkler #define MEI_ME_PM_OPS (&mei_me_pm_ops) 5292703d4b2STomas Winkler #else 530b68301e9STomas Winkler #define MEI_ME_PM_OPS NULL 531180ea05bSTomas Winkler #endif /* CONFIG_PM */ 5322703d4b2STomas Winkler /* 5332703d4b2STomas Winkler * PCI driver structure 5342703d4b2STomas Winkler */ 535b68301e9STomas Winkler static struct pci_driver mei_me_driver = { 5362703d4b2STomas Winkler .name = KBUILD_MODNAME, 537b68301e9STomas Winkler .id_table = mei_me_pci_tbl, 538b68301e9STomas Winkler .probe = mei_me_probe, 539b68301e9STomas Winkler .remove = mei_me_remove, 5405c4c0106STomas Winkler .shutdown = mei_me_shutdown, 541b68301e9STomas Winkler .driver.pm = MEI_ME_PM_OPS, 54267de6bf1SAlexander Usyskin .driver.probe_type = PROBE_PREFER_ASYNCHRONOUS, 5432703d4b2STomas Winkler }; 5442703d4b2STomas Winkler 545b68301e9STomas Winkler module_pci_driver(mei_me_driver); 5462703d4b2STomas Winkler 5472703d4b2STomas Winkler MODULE_AUTHOR("Intel Corporation"); 5482703d4b2STomas Winkler MODULE_DESCRIPTION("Intel(R) Management Engine Interface"); 5492703d4b2STomas Winkler MODULE_LICENSE("GPL v2"); 550