Merge tag 'drm-intel-next-2023-03-07' of git://anongit.freedesktop.org/drm/drm-intel...
[linux-2.6-block.git] / drivers / misc / mei / pci-me.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2003-2022, Intel Corporation. All rights reserved.
4  * Intel Management Engine Interface (Intel MEI) Linux driver
5  */
6
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/dma-mapping.h>
14 #include <linux/sched.h>
15 #include <linux/interrupt.h>
16
17 #include <linux/pm_domain.h>
18 #include <linux/pm_runtime.h>
19
20 #include <linux/mei.h>
21
22 #include "mei_dev.h"
23 #include "client.h"
24 #include "hw-me-regs.h"
25 #include "hw-me.h"
26
27 /* mei_pci_tbl - PCI Device ID Table */
28 static const struct pci_device_id mei_me_pci_tbl[] = {
29         {MEI_PCI_DEVICE(MEI_DEV_ID_82946GZ, MEI_ME_ICH_CFG)},
30         {MEI_PCI_DEVICE(MEI_DEV_ID_82G35, MEI_ME_ICH_CFG)},
31         {MEI_PCI_DEVICE(MEI_DEV_ID_82Q965, MEI_ME_ICH_CFG)},
32         {MEI_PCI_DEVICE(MEI_DEV_ID_82G965, MEI_ME_ICH_CFG)},
33         {MEI_PCI_DEVICE(MEI_DEV_ID_82GM965, MEI_ME_ICH_CFG)},
34         {MEI_PCI_DEVICE(MEI_DEV_ID_82GME965, MEI_ME_ICH_CFG)},
35         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82Q35, MEI_ME_ICH_CFG)},
36         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82G33, MEI_ME_ICH_CFG)},
37         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82Q33, MEI_ME_ICH_CFG)},
38         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_82X38, MEI_ME_ICH_CFG)},
39         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_3200, MEI_ME_ICH_CFG)},
40
41         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_6, MEI_ME_ICH_CFG)},
42         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_7, MEI_ME_ICH_CFG)},
43         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_8, MEI_ME_ICH_CFG)},
44         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_9, MEI_ME_ICH_CFG)},
45         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9_10, MEI_ME_ICH_CFG)},
46         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_1, MEI_ME_ICH_CFG)},
47         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_2, MEI_ME_ICH_CFG)},
48         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_3, MEI_ME_ICH_CFG)},
49         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH9M_4, MEI_ME_ICH_CFG)},
50
51         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_1, MEI_ME_ICH10_CFG)},
52         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_2, MEI_ME_ICH10_CFG)},
53         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_3, MEI_ME_ICH10_CFG)},
54         {MEI_PCI_DEVICE(MEI_DEV_ID_ICH10_4, MEI_ME_ICH10_CFG)},
55
56         {MEI_PCI_DEVICE(MEI_DEV_ID_IBXPK_1, MEI_ME_PCH6_CFG)},
57         {MEI_PCI_DEVICE(MEI_DEV_ID_IBXPK_2, MEI_ME_PCH6_CFG)},
58         {MEI_PCI_DEVICE(MEI_DEV_ID_CPT_1, MEI_ME_PCH_CPT_PBG_CFG)},
59         {MEI_PCI_DEVICE(MEI_DEV_ID_PBG_1, MEI_ME_PCH_CPT_PBG_CFG)},
60         {MEI_PCI_DEVICE(MEI_DEV_ID_PPT_1, MEI_ME_PCH7_CFG)},
61         {MEI_PCI_DEVICE(MEI_DEV_ID_PPT_2, MEI_ME_PCH7_CFG)},
62         {MEI_PCI_DEVICE(MEI_DEV_ID_PPT_3, MEI_ME_PCH7_CFG)},
63         {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_H, MEI_ME_PCH8_SPS_4_CFG)},
64         {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_W, MEI_ME_PCH8_SPS_4_CFG)},
65         {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_LP, MEI_ME_PCH8_CFG)},
66         {MEI_PCI_DEVICE(MEI_DEV_ID_LPT_HR, MEI_ME_PCH8_SPS_4_CFG)},
67         {MEI_PCI_DEVICE(MEI_DEV_ID_WPT_LP, MEI_ME_PCH8_CFG)},
68         {MEI_PCI_DEVICE(MEI_DEV_ID_WPT_LP_2, MEI_ME_PCH8_CFG)},
69
70         {MEI_PCI_DEVICE(MEI_DEV_ID_SPT, MEI_ME_PCH8_CFG)},
71         {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_2, MEI_ME_PCH8_CFG)},
72         {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_3, MEI_ME_PCH8_ITOUCH_CFG)},
73         {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_H, MEI_ME_PCH8_SPS_4_CFG)},
74         {MEI_PCI_DEVICE(MEI_DEV_ID_SPT_H_2, MEI_ME_PCH8_SPS_4_CFG)},
75         {MEI_PCI_DEVICE(MEI_DEV_ID_LBG, MEI_ME_PCH12_SPS_4_CFG)},
76
77         {MEI_PCI_DEVICE(MEI_DEV_ID_BXT_M, MEI_ME_PCH8_CFG)},
78         {MEI_PCI_DEVICE(MEI_DEV_ID_APL_I, MEI_ME_PCH8_CFG)},
79
80         {MEI_PCI_DEVICE(MEI_DEV_ID_DNV_IE, MEI_ME_PCH8_CFG)},
81
82         {MEI_PCI_DEVICE(MEI_DEV_ID_GLK, MEI_ME_PCH8_CFG)},
83
84         {MEI_PCI_DEVICE(MEI_DEV_ID_KBP, MEI_ME_PCH8_CFG)},
85         {MEI_PCI_DEVICE(MEI_DEV_ID_KBP_2, MEI_ME_PCH8_CFG)},
86         {MEI_PCI_DEVICE(MEI_DEV_ID_KBP_3, MEI_ME_PCH8_CFG)},
87
88         {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_LP, MEI_ME_PCH12_CFG)},
89         {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_LP_3, MEI_ME_PCH8_ITOUCH_CFG)},
90         {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_H, MEI_ME_PCH12_SPS_CFG)},
91         {MEI_PCI_DEVICE(MEI_DEV_ID_CNP_H_3, MEI_ME_PCH12_SPS_ITOUCH_CFG)},
92
93         {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_LP, MEI_ME_PCH12_CFG)},
94         {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_LP_3, MEI_ME_PCH8_ITOUCH_CFG)},
95         {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_V, MEI_ME_PCH12_CFG)},
96         {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_H, MEI_ME_PCH12_CFG)},
97         {MEI_PCI_DEVICE(MEI_DEV_ID_CMP_H_3, MEI_ME_PCH8_ITOUCH_CFG)},
98
99         {MEI_PCI_DEVICE(MEI_DEV_ID_ICP_LP, MEI_ME_PCH12_CFG)},
100         {MEI_PCI_DEVICE(MEI_DEV_ID_ICP_N, MEI_ME_PCH12_CFG)},
101
102         {MEI_PCI_DEVICE(MEI_DEV_ID_TGP_LP, MEI_ME_PCH15_CFG)},
103         {MEI_PCI_DEVICE(MEI_DEV_ID_TGP_H, MEI_ME_PCH15_SPS_CFG)},
104
105         {MEI_PCI_DEVICE(MEI_DEV_ID_JSP_N, MEI_ME_PCH15_CFG)},
106
107         {MEI_PCI_DEVICE(MEI_DEV_ID_MCC, MEI_ME_PCH15_CFG)},
108         {MEI_PCI_DEVICE(MEI_DEV_ID_MCC_4, MEI_ME_PCH8_CFG)},
109
110         {MEI_PCI_DEVICE(MEI_DEV_ID_CDF, MEI_ME_PCH8_CFG)},
111
112         {MEI_PCI_DEVICE(MEI_DEV_ID_EBG, MEI_ME_PCH15_SPS_CFG)},
113
114         {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_S, MEI_ME_PCH15_CFG)},
115         {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_LP, MEI_ME_PCH15_CFG)},
116         {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_P, MEI_ME_PCH15_CFG)},
117         {MEI_PCI_DEVICE(MEI_DEV_ID_ADP_N, MEI_ME_PCH15_CFG)},
118
119         {MEI_PCI_DEVICE(MEI_DEV_ID_RPL_S, MEI_ME_PCH15_CFG)},
120
121         {MEI_PCI_DEVICE(MEI_DEV_ID_MTL_M, MEI_ME_PCH15_CFG)},
122
123         /* required last entry */
124         {0, }
125 };
126
127 MODULE_DEVICE_TABLE(pci, mei_me_pci_tbl);
128
129 #ifdef CONFIG_PM
130 static inline void mei_me_set_pm_domain(struct mei_device *dev);
131 static inline void mei_me_unset_pm_domain(struct mei_device *dev);
132 #else
133 static inline void mei_me_set_pm_domain(struct mei_device *dev) {}
134 static inline void mei_me_unset_pm_domain(struct mei_device *dev) {}
135 #endif /* CONFIG_PM */
136
137 static int mei_me_read_fws(const struct mei_device *dev, int where, u32 *val)
138 {
139         struct pci_dev *pdev = to_pci_dev(dev->dev);
140
141         return pci_read_config_dword(pdev, where, val);
142 }
143
144 /**
145  * mei_me_quirk_probe - probe for devices that doesn't valid ME interface
146  *
147  * @pdev: PCI device structure
148  * @cfg: per generation config
149  *
150  * Return: true if ME Interface is valid, false otherwise
151  */
152 static bool mei_me_quirk_probe(struct pci_dev *pdev,
153                                 const struct mei_cfg *cfg)
154 {
155         if (cfg->quirk_probe && cfg->quirk_probe(pdev)) {
156                 dev_info(&pdev->dev, "Device doesn't have valid ME Interface\n");
157                 return false;
158         }
159
160         return true;
161 }
162
163 /**
164  * mei_me_probe - Device Initialization Routine
165  *
166  * @pdev: PCI device structure
167  * @ent: entry in kcs_pci_tbl
168  *
169  * Return: 0 on success, <0 on failure.
170  */
171 static int mei_me_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
172 {
173         const struct mei_cfg *cfg;
174         struct mei_device *dev;
175         struct mei_me_hw *hw;
176         unsigned int irqflags;
177         int err;
178
179         cfg = mei_me_get_cfg(ent->driver_data);
180         if (!cfg)
181                 return -ENODEV;
182
183         if (!mei_me_quirk_probe(pdev, cfg))
184                 return -ENODEV;
185
186         /* enable pci dev */
187         err = pcim_enable_device(pdev);
188         if (err) {
189                 dev_err(&pdev->dev, "failed to enable pci device.\n");
190                 goto end;
191         }
192         /* set PCI host mastering  */
193         pci_set_master(pdev);
194         /* pci request regions and mapping IO device memory for mei driver */
195         err = pcim_iomap_regions(pdev, BIT(0), KBUILD_MODNAME);
196         if (err) {
197                 dev_err(&pdev->dev, "failed to get pci regions.\n");
198                 goto end;
199         }
200
201         err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
202         if (err) {
203                 dev_err(&pdev->dev, "No usable DMA configuration, aborting\n");
204                 goto end;
205         }
206
207         /* allocates and initializes the mei dev structure */
208         dev = mei_me_dev_init(&pdev->dev, cfg, false);
209         if (!dev) {
210                 err = -ENOMEM;
211                 goto end;
212         }
213         hw = to_me_hw(dev);
214         hw->mem_addr = pcim_iomap_table(pdev)[0];
215         hw->read_fws = mei_me_read_fws;
216
217         pci_enable_msi(pdev);
218
219         hw->irq = pdev->irq;
220
221          /* request and enable interrupt */
222         irqflags = pci_dev_msi_enabled(pdev) ? IRQF_ONESHOT : IRQF_SHARED;
223
224         err = request_threaded_irq(pdev->irq,
225                         mei_me_irq_quick_handler,
226                         mei_me_irq_thread_handler,
227                         irqflags, KBUILD_MODNAME, dev);
228         if (err) {
229                 dev_err(&pdev->dev, "request_threaded_irq failure. irq = %d\n",
230                        pdev->irq);
231                 goto end;
232         }
233
234         if (mei_start(dev)) {
235                 dev_err(&pdev->dev, "init hw failure.\n");
236                 err = -ENODEV;
237                 goto release_irq;
238         }
239
240         pm_runtime_set_autosuspend_delay(&pdev->dev, MEI_ME_RPM_TIMEOUT);
241         pm_runtime_use_autosuspend(&pdev->dev);
242
243         err = mei_register(dev, &pdev->dev);
244         if (err)
245                 goto stop;
246
247         pci_set_drvdata(pdev, dev);
248
249         /*
250          * MEI requires to resume from runtime suspend mode
251          * in order to perform link reset flow upon system suspend.
252          */
253         dev_pm_set_driver_flags(&pdev->dev, DPM_FLAG_NO_DIRECT_COMPLETE);
254
255         /*
256          * ME maps runtime suspend/resume to D0i states,
257          * hence we need to go around native PCI runtime service which
258          * eventually brings the device into D3cold/hot state,
259          * but the mei device cannot wake up from D3 unlike from D0i3.
260          * To get around the PCI device native runtime pm,
261          * ME uses runtime pm domain handlers which take precedence
262          * over the driver's pm handlers.
263          */
264         mei_me_set_pm_domain(dev);
265
266         if (mei_pg_is_enabled(dev)) {
267                 pm_runtime_put_noidle(&pdev->dev);
268                 if (hw->d0i3_supported)
269                         pm_runtime_allow(&pdev->dev);
270         }
271
272         dev_dbg(&pdev->dev, "initialization successful.\n");
273
274         return 0;
275
276 stop:
277         mei_stop(dev);
278 release_irq:
279         mei_cancel_work(dev);
280         mei_disable_interrupts(dev);
281         free_irq(pdev->irq, dev);
282 end:
283         dev_err(&pdev->dev, "initialization failed.\n");
284         return err;
285 }
286
287 /**
288  * mei_me_shutdown - Device Removal Routine
289  *
290  * @pdev: PCI device structure
291  *
292  * mei_me_shutdown is called from the reboot notifier
293  * it's a simplified version of remove so we go down
294  * faster.
295  */
296 static void mei_me_shutdown(struct pci_dev *pdev)
297 {
298         struct mei_device *dev;
299
300         dev = pci_get_drvdata(pdev);
301         if (!dev)
302                 return;
303
304         dev_dbg(&pdev->dev, "shutdown\n");
305         mei_stop(dev);
306
307         mei_me_unset_pm_domain(dev);
308
309         mei_disable_interrupts(dev);
310         free_irq(pdev->irq, dev);
311 }
312
313 /**
314  * mei_me_remove - Device Removal Routine
315  *
316  * @pdev: PCI device structure
317  *
318  * mei_me_remove is called by the PCI subsystem to alert the driver
319  * that it should release a PCI device.
320  */
321 static void mei_me_remove(struct pci_dev *pdev)
322 {
323         struct mei_device *dev;
324
325         dev = pci_get_drvdata(pdev);
326         if (!dev)
327                 return;
328
329         if (mei_pg_is_enabled(dev))
330                 pm_runtime_get_noresume(&pdev->dev);
331
332         dev_dbg(&pdev->dev, "stop\n");
333         mei_stop(dev);
334
335         mei_me_unset_pm_domain(dev);
336
337         mei_disable_interrupts(dev);
338
339         free_irq(pdev->irq, dev);
340
341         mei_deregister(dev);
342 }
343
344 #ifdef CONFIG_PM_SLEEP
345 static int mei_me_pci_prepare(struct device *device)
346 {
347         pm_runtime_resume(device);
348         return 0;
349 }
350
351 static int mei_me_pci_suspend(struct device *device)
352 {
353         struct pci_dev *pdev = to_pci_dev(device);
354         struct mei_device *dev = pci_get_drvdata(pdev);
355
356         if (!dev)
357                 return -ENODEV;
358
359         dev_dbg(&pdev->dev, "suspend\n");
360
361         mei_stop(dev);
362
363         mei_disable_interrupts(dev);
364
365         free_irq(pdev->irq, dev);
366         pci_disable_msi(pdev);
367
368         return 0;
369 }
370
371 static int mei_me_pci_resume(struct device *device)
372 {
373         struct pci_dev *pdev = to_pci_dev(device);
374         struct mei_device *dev;
375         unsigned int irqflags;
376         int err;
377
378         dev = pci_get_drvdata(pdev);
379         if (!dev)
380                 return -ENODEV;
381
382         pci_enable_msi(pdev);
383
384         irqflags = pci_dev_msi_enabled(pdev) ? IRQF_ONESHOT : IRQF_SHARED;
385
386         /* request and enable interrupt */
387         err = request_threaded_irq(pdev->irq,
388                         mei_me_irq_quick_handler,
389                         mei_me_irq_thread_handler,
390                         irqflags, KBUILD_MODNAME, dev);
391
392         if (err) {
393                 dev_err(&pdev->dev, "request_threaded_irq failed: irq = %d.\n",
394                                 pdev->irq);
395                 return err;
396         }
397
398         err = mei_restart(dev);
399         if (err)
400                 return err;
401
402         /* Start timer if stopped in suspend */
403         schedule_delayed_work(&dev->timer_work, HZ);
404
405         return 0;
406 }
407
408 static void mei_me_pci_complete(struct device *device)
409 {
410         pm_runtime_suspend(device);
411 }
412 #else /* CONFIG_PM_SLEEP */
413
414 #define mei_me_pci_prepare NULL
415 #define mei_me_pci_complete NULL
416
417 #endif /* !CONFIG_PM_SLEEP */
418
419 #ifdef CONFIG_PM
420 static int mei_me_pm_runtime_idle(struct device *device)
421 {
422         struct mei_device *dev;
423
424         dev_dbg(device, "rpm: me: runtime_idle\n");
425
426         dev = dev_get_drvdata(device);
427         if (!dev)
428                 return -ENODEV;
429         if (mei_write_is_idle(dev))
430                 pm_runtime_autosuspend(device);
431
432         return -EBUSY;
433 }
434
435 static int mei_me_pm_runtime_suspend(struct device *device)
436 {
437         struct mei_device *dev;
438         int ret;
439
440         dev_dbg(device, "rpm: me: runtime suspend\n");
441
442         dev = dev_get_drvdata(device);
443         if (!dev)
444                 return -ENODEV;
445
446         mutex_lock(&dev->device_lock);
447
448         if (mei_write_is_idle(dev))
449                 ret = mei_me_pg_enter_sync(dev);
450         else
451                 ret = -EAGAIN;
452
453         mutex_unlock(&dev->device_lock);
454
455         dev_dbg(device, "rpm: me: runtime suspend ret=%d\n", ret);
456
457         if (ret && ret != -EAGAIN)
458                 schedule_work(&dev->reset_work);
459
460         return ret;
461 }
462
463 static int mei_me_pm_runtime_resume(struct device *device)
464 {
465         struct mei_device *dev;
466         int ret;
467
468         dev_dbg(device, "rpm: me: runtime resume\n");
469
470         dev = dev_get_drvdata(device);
471         if (!dev)
472                 return -ENODEV;
473
474         mutex_lock(&dev->device_lock);
475
476         ret = mei_me_pg_exit_sync(dev);
477
478         mutex_unlock(&dev->device_lock);
479
480         dev_dbg(device, "rpm: me: runtime resume ret = %d\n", ret);
481
482         if (ret)
483                 schedule_work(&dev->reset_work);
484
485         return ret;
486 }
487
488 /**
489  * mei_me_set_pm_domain - fill and set pm domain structure for device
490  *
491  * @dev: mei_device
492  */
493 static inline void mei_me_set_pm_domain(struct mei_device *dev)
494 {
495         struct pci_dev *pdev  = to_pci_dev(dev->dev);
496
497         if (pdev->dev.bus && pdev->dev.bus->pm) {
498                 dev->pg_domain.ops = *pdev->dev.bus->pm;
499
500                 dev->pg_domain.ops.runtime_suspend = mei_me_pm_runtime_suspend;
501                 dev->pg_domain.ops.runtime_resume = mei_me_pm_runtime_resume;
502                 dev->pg_domain.ops.runtime_idle = mei_me_pm_runtime_idle;
503
504                 dev_pm_domain_set(&pdev->dev, &dev->pg_domain);
505         }
506 }
507
508 /**
509  * mei_me_unset_pm_domain - clean pm domain structure for device
510  *
511  * @dev: mei_device
512  */
513 static inline void mei_me_unset_pm_domain(struct mei_device *dev)
514 {
515         /* stop using pm callbacks if any */
516         dev_pm_domain_set(dev->dev, NULL);
517 }
518
519 static const struct dev_pm_ops mei_me_pm_ops = {
520         .prepare = mei_me_pci_prepare,
521         .complete = mei_me_pci_complete,
522         SET_SYSTEM_SLEEP_PM_OPS(mei_me_pci_suspend,
523                                 mei_me_pci_resume)
524         SET_RUNTIME_PM_OPS(
525                 mei_me_pm_runtime_suspend,
526                 mei_me_pm_runtime_resume,
527                 mei_me_pm_runtime_idle)
528 };
529
530 #define MEI_ME_PM_OPS   (&mei_me_pm_ops)
531 #else
532 #define MEI_ME_PM_OPS   NULL
533 #endif /* CONFIG_PM */
534 /*
535  *  PCI driver structure
536  */
537 static struct pci_driver mei_me_driver = {
538         .name = KBUILD_MODNAME,
539         .id_table = mei_me_pci_tbl,
540         .probe = mei_me_probe,
541         .remove = mei_me_remove,
542         .shutdown = mei_me_shutdown,
543         .driver.pm = MEI_ME_PM_OPS,
544         .driver.probe_type = PROBE_PREFER_ASYNCHRONOUS,
545 };
546
547 module_pci_driver(mei_me_driver);
548
549 MODULE_AUTHOR("Intel Corporation");
550 MODULE_DESCRIPTION("Intel(R) Management Engine Interface");
551 MODULE_LICENSE("GPL v2");