1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2020-2023 Intel Corporation
6 #include <linux/firmware.h>
7 #include <linux/module.h>
10 #include <drm/drm_accel.h>
11 #include <drm/drm_file.h>
12 #include <drm/drm_gem.h>
13 #include <drm/drm_ioctl.h>
14 #include <drm/drm_prime.h>
16 #include "vpu_boot_api.h"
17 #include "ivpu_debugfs.h"
24 #include "ivpu_jsm_msg.h"
26 #include "ivpu_mmu_context.h"
29 #ifndef DRIVER_VERSION_STR
30 #define DRIVER_VERSION_STR __stringify(DRM_IVPU_DRIVER_MAJOR) "." \
31 __stringify(DRM_IVPU_DRIVER_MINOR) "."
34 static const struct drm_driver driver;
36 static struct lock_class_key submitted_jobs_xa_lock_class_key;
39 module_param_named(dbg_mask, ivpu_dbg_mask, int, 0644);
40 MODULE_PARM_DESC(dbg_mask, "Driver debug mask. See IVPU_DBG_* macros.");
43 module_param_named_unsafe(test_mode, ivpu_test_mode, int, 0644);
44 MODULE_PARM_DESC(test_mode, "Test mode: 0 - normal operation, 1 - fw unit test, 2 - null hw");
46 u8 ivpu_pll_min_ratio;
47 module_param_named(pll_min_ratio, ivpu_pll_min_ratio, byte, 0644);
48 MODULE_PARM_DESC(pll_min_ratio, "Minimum PLL ratio used to set VPU frequency");
50 u8 ivpu_pll_max_ratio = U8_MAX;
51 module_param_named(pll_max_ratio, ivpu_pll_max_ratio, byte, 0644);
52 MODULE_PARM_DESC(pll_max_ratio, "Maximum PLL ratio used to set VPU frequency");
54 bool ivpu_disable_mmu_cont_pages;
55 module_param_named(disable_mmu_cont_pages, ivpu_disable_mmu_cont_pages, bool, 0644);
56 MODULE_PARM_DESC(disable_mmu_cont_pages, "Disable MMU contiguous pages optimization");
58 struct ivpu_file_priv *ivpu_file_priv_get(struct ivpu_file_priv *file_priv)
60 struct ivpu_device *vdev = file_priv->vdev;
62 kref_get(&file_priv->ref);
64 ivpu_dbg(vdev, KREF, "file_priv get: ctx %u refcount %u\n",
65 file_priv->ctx.id, kref_read(&file_priv->ref));
70 struct ivpu_file_priv *ivpu_file_priv_get_by_ctx_id(struct ivpu_device *vdev, unsigned long id)
72 struct ivpu_file_priv *file_priv;
74 xa_lock_irq(&vdev->context_xa);
75 file_priv = xa_load(&vdev->context_xa, id);
76 /* file_priv may still be in context_xa during file_priv_release() */
77 if (file_priv && !kref_get_unless_zero(&file_priv->ref))
79 xa_unlock_irq(&vdev->context_xa);
82 ivpu_dbg(vdev, KREF, "file_priv get by id: ctx %u refcount %u\n",
83 file_priv->ctx.id, kref_read(&file_priv->ref));
88 static void file_priv_release(struct kref *ref)
90 struct ivpu_file_priv *file_priv = container_of(ref, struct ivpu_file_priv, ref);
91 struct ivpu_device *vdev = file_priv->vdev;
93 ivpu_dbg(vdev, FILE, "file_priv release: ctx %u\n", file_priv->ctx.id);
95 ivpu_cmdq_release_all(file_priv);
96 ivpu_bo_remove_all_bos_from_context(&file_priv->ctx);
97 ivpu_jsm_context_release(vdev, file_priv->ctx.id);
98 ivpu_mmu_user_context_fini(vdev, &file_priv->ctx);
99 drm_WARN_ON(&vdev->drm, xa_erase_irq(&vdev->context_xa, file_priv->ctx.id) != file_priv);
100 mutex_destroy(&file_priv->lock);
104 void ivpu_file_priv_put(struct ivpu_file_priv **link)
106 struct ivpu_file_priv *file_priv = *link;
107 struct ivpu_device *vdev = file_priv->vdev;
109 drm_WARN_ON(&vdev->drm, !file_priv);
111 ivpu_dbg(vdev, KREF, "file_priv put: ctx %u refcount %u\n",
112 file_priv->ctx.id, kref_read(&file_priv->ref));
115 kref_put(&file_priv->ref, file_priv_release);
118 static int ivpu_get_capabilities(struct ivpu_device *vdev, struct drm_ivpu_param *args)
120 switch (args->index) {
121 case DRM_IVPU_CAP_METRIC_STREAMER:
124 case DRM_IVPU_CAP_DMA_MEMORY_RANGE:
134 static int ivpu_get_param_ioctl(struct drm_device *dev, void *data, struct drm_file *file)
136 struct ivpu_file_priv *file_priv = file->driver_priv;
137 struct ivpu_device *vdev = file_priv->vdev;
138 struct pci_dev *pdev = to_pci_dev(vdev->drm.dev);
139 struct drm_ivpu_param *args = data;
143 if (!drm_dev_enter(dev, &idx))
146 switch (args->param) {
147 case DRM_IVPU_PARAM_DEVICE_ID:
148 args->value = pdev->device;
150 case DRM_IVPU_PARAM_DEVICE_REVISION:
151 args->value = pdev->revision;
153 case DRM_IVPU_PARAM_PLATFORM_TYPE:
154 args->value = vdev->platform;
156 case DRM_IVPU_PARAM_CORE_CLOCK_RATE:
157 args->value = ivpu_hw_reg_pll_freq_get(vdev);
159 case DRM_IVPU_PARAM_NUM_CONTEXTS:
160 args->value = ivpu_get_context_count(vdev);
162 case DRM_IVPU_PARAM_CONTEXT_BASE_ADDRESS:
163 args->value = vdev->hw->ranges.user.start;
165 case DRM_IVPU_PARAM_CONTEXT_PRIORITY:
166 args->value = file_priv->priority;
168 case DRM_IVPU_PARAM_CONTEXT_ID:
169 args->value = file_priv->ctx.id;
171 case DRM_IVPU_PARAM_FW_API_VERSION:
172 if (args->index < VPU_FW_API_VER_NUM) {
173 struct vpu_firmware_header *fw_hdr;
175 fw_hdr = (struct vpu_firmware_header *)vdev->fw->file->data;
176 args->value = fw_hdr->api_version[args->index];
181 case DRM_IVPU_PARAM_ENGINE_HEARTBEAT:
182 ret = ivpu_jsm_get_heartbeat(vdev, args->index, &args->value);
184 case DRM_IVPU_PARAM_UNIQUE_INFERENCE_ID:
185 args->value = (u64)atomic64_inc_return(&vdev->unique_id_counter);
187 case DRM_IVPU_PARAM_TILE_CONFIG:
188 args->value = vdev->hw->tile_fuse;
190 case DRM_IVPU_PARAM_SKU:
191 args->value = vdev->hw->sku;
193 case DRM_IVPU_PARAM_CAPABILITIES:
194 ret = ivpu_get_capabilities(vdev, args);
205 static int ivpu_set_param_ioctl(struct drm_device *dev, void *data, struct drm_file *file)
207 struct ivpu_file_priv *file_priv = file->driver_priv;
208 struct drm_ivpu_param *args = data;
211 switch (args->param) {
212 case DRM_IVPU_PARAM_CONTEXT_PRIORITY:
213 if (args->value <= DRM_IVPU_CONTEXT_PRIORITY_REALTIME)
214 file_priv->priority = args->value;
225 static int ivpu_open(struct drm_device *dev, struct drm_file *file)
227 struct ivpu_device *vdev = to_ivpu_device(dev);
228 struct ivpu_file_priv *file_priv;
233 ret = xa_alloc_irq(&vdev->context_xa, &ctx_id, NULL, vdev->context_xa_limit, GFP_KERNEL);
235 ivpu_err(vdev, "Failed to allocate context id: %d\n", ret);
239 file_priv = kzalloc(sizeof(*file_priv), GFP_KERNEL);
245 file_priv->vdev = vdev;
246 file_priv->priority = DRM_IVPU_CONTEXT_PRIORITY_NORMAL;
247 kref_init(&file_priv->ref);
248 mutex_init(&file_priv->lock);
250 ret = ivpu_mmu_user_context_init(vdev, &file_priv->ctx, ctx_id);
252 goto err_mutex_destroy;
254 old = xa_store_irq(&vdev->context_xa, ctx_id, file_priv, GFP_KERNEL);
255 if (xa_is_err(old)) {
257 ivpu_err(vdev, "Failed to store context %u: %d\n", ctx_id, ret);
261 ivpu_dbg(vdev, FILE, "file_priv create: ctx %u process %s pid %d\n",
262 ctx_id, current->comm, task_pid_nr(current));
264 file->driver_priv = file_priv;
268 ivpu_mmu_user_context_fini(vdev, &file_priv->ctx);
270 mutex_destroy(&file_priv->lock);
273 xa_erase_irq(&vdev->context_xa, ctx_id);
277 static void ivpu_postclose(struct drm_device *dev, struct drm_file *file)
279 struct ivpu_file_priv *file_priv = file->driver_priv;
280 struct ivpu_device *vdev = to_ivpu_device(dev);
282 ivpu_dbg(vdev, FILE, "file_priv close: ctx %u process %s pid %d\n",
283 file_priv->ctx.id, current->comm, task_pid_nr(current));
285 ivpu_file_priv_put(&file_priv);
288 static const struct drm_ioctl_desc ivpu_drm_ioctls[] = {
289 DRM_IOCTL_DEF_DRV(IVPU_GET_PARAM, ivpu_get_param_ioctl, 0),
290 DRM_IOCTL_DEF_DRV(IVPU_SET_PARAM, ivpu_set_param_ioctl, 0),
291 DRM_IOCTL_DEF_DRV(IVPU_BO_CREATE, ivpu_bo_create_ioctl, 0),
292 DRM_IOCTL_DEF_DRV(IVPU_BO_INFO, ivpu_bo_info_ioctl, 0),
293 DRM_IOCTL_DEF_DRV(IVPU_SUBMIT, ivpu_submit_ioctl, 0),
294 DRM_IOCTL_DEF_DRV(IVPU_BO_WAIT, ivpu_bo_wait_ioctl, 0),
297 static int ivpu_wait_for_ready(struct ivpu_device *vdev)
299 struct ivpu_ipc_consumer cons;
300 struct ivpu_ipc_hdr ipc_hdr;
301 unsigned long timeout;
304 if (ivpu_test_mode == IVPU_TEST_MODE_FW_TEST)
307 ivpu_ipc_consumer_add(vdev, &cons, IVPU_IPC_CHAN_BOOT_MSG);
309 timeout = jiffies + msecs_to_jiffies(vdev->timeout.boot);
311 ret = ivpu_ipc_irq_handler(vdev);
314 ret = ivpu_ipc_receive(vdev, &cons, &ipc_hdr, NULL, 0);
315 if (ret != -ETIMEDOUT || time_after_eq(jiffies, timeout))
321 ivpu_ipc_consumer_del(vdev, &cons);
323 if (!ret && ipc_hdr.data_addr != IVPU_IPC_BOOT_MSG_DATA_ADDR) {
324 ivpu_err(vdev, "Invalid VPU ready message: 0x%x\n",
330 ivpu_dbg(vdev, PM, "VPU ready message received successfully\n");
332 ivpu_hw_diagnose_failure(vdev);
338 * ivpu_boot() - Start VPU firmware
341 * This function is paired with ivpu_shutdown() but it doesn't power up the
342 * VPU because power up has to be called very early in ivpu_probe().
344 int ivpu_boot(struct ivpu_device *vdev)
348 /* Update boot params located at first 4KB of FW memory */
349 ivpu_fw_boot_params_setup(vdev, vdev->fw->mem->kvaddr);
351 ret = ivpu_hw_boot_fw(vdev);
353 ivpu_err(vdev, "Failed to start the firmware: %d\n", ret);
357 ret = ivpu_wait_for_ready(vdev);
359 ivpu_err(vdev, "Failed to boot the firmware: %d\n", ret);
363 ivpu_hw_irq_clear(vdev);
364 enable_irq(vdev->irq);
365 ivpu_hw_irq_enable(vdev);
366 ivpu_ipc_enable(vdev);
370 int ivpu_shutdown(struct ivpu_device *vdev)
374 ivpu_hw_irq_disable(vdev);
375 disable_irq(vdev->irq);
376 ivpu_ipc_disable(vdev);
377 ivpu_mmu_disable(vdev);
379 ret = ivpu_hw_power_down(vdev);
381 ivpu_warn(vdev, "Failed to power down HW: %d\n", ret);
386 static const struct file_operations ivpu_fops = {
387 .owner = THIS_MODULE,
391 static const struct drm_driver driver = {
392 .driver_features = DRIVER_GEM | DRIVER_COMPUTE_ACCEL,
395 .postclose = ivpu_postclose,
396 .gem_prime_import = ivpu_gem_prime_import,
398 #if defined(CONFIG_DEBUG_FS)
399 .debugfs_init = ivpu_debugfs_init,
402 .ioctls = ivpu_drm_ioctls,
403 .num_ioctls = ARRAY_SIZE(ivpu_drm_ioctls),
409 .major = DRM_IVPU_DRIVER_MAJOR,
410 .minor = DRM_IVPU_DRIVER_MINOR,
413 static int ivpu_irq_init(struct ivpu_device *vdev)
415 struct pci_dev *pdev = to_pci_dev(vdev->drm.dev);
418 ret = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_MSI | PCI_IRQ_MSIX);
420 ivpu_err(vdev, "Failed to allocate a MSI IRQ: %d\n", ret);
424 vdev->irq = pci_irq_vector(pdev, 0);
426 ret = devm_request_irq(vdev->drm.dev, vdev->irq, vdev->hw->ops->irq_handler,
427 IRQF_NO_AUTOEN, DRIVER_NAME, vdev);
429 ivpu_err(vdev, "Failed to request an IRQ %d\n", ret);
434 static int ivpu_pci_init(struct ivpu_device *vdev)
436 struct pci_dev *pdev = to_pci_dev(vdev->drm.dev);
437 struct resource *bar0 = &pdev->resource[0];
438 struct resource *bar4 = &pdev->resource[4];
441 ivpu_dbg(vdev, MISC, "Mapping BAR0 (RegV) %pR\n", bar0);
442 vdev->regv = devm_ioremap_resource(vdev->drm.dev, bar0);
443 if (IS_ERR(vdev->regv)) {
444 ivpu_err(vdev, "Failed to map bar 0: %pe\n", vdev->regv);
445 return PTR_ERR(vdev->regv);
448 ivpu_dbg(vdev, MISC, "Mapping BAR4 (RegB) %pR\n", bar4);
449 vdev->regb = devm_ioremap_resource(vdev->drm.dev, bar4);
450 if (IS_ERR(vdev->regb)) {
451 ivpu_err(vdev, "Failed to map bar 4: %pe\n", vdev->regb);
452 return PTR_ERR(vdev->regb);
455 ret = dma_set_mask_and_coherent(vdev->drm.dev, DMA_BIT_MASK(vdev->hw->dma_bits));
457 ivpu_err(vdev, "Failed to set DMA mask: %d\n", ret);
460 dma_set_max_seg_size(vdev->drm.dev, UINT_MAX);
462 /* Clear any pending errors */
463 pcie_capability_clear_word(pdev, PCI_EXP_DEVSTA, 0x3f);
465 /* VPU 37XX does not require 10m D3hot delay */
466 if (ivpu_hw_gen(vdev) == IVPU_HW_37XX)
467 pdev->d3hot_delay = 0;
469 ret = pcim_enable_device(pdev);
471 ivpu_err(vdev, "Failed to enable PCI device: %d\n", ret);
475 pci_set_master(pdev);
480 static int ivpu_dev_init(struct ivpu_device *vdev)
484 vdev->hw = drmm_kzalloc(&vdev->drm, sizeof(*vdev->hw), GFP_KERNEL);
488 vdev->mmu = drmm_kzalloc(&vdev->drm, sizeof(*vdev->mmu), GFP_KERNEL);
492 vdev->fw = drmm_kzalloc(&vdev->drm, sizeof(*vdev->fw), GFP_KERNEL);
496 vdev->ipc = drmm_kzalloc(&vdev->drm, sizeof(*vdev->ipc), GFP_KERNEL);
500 vdev->pm = drmm_kzalloc(&vdev->drm, sizeof(*vdev->pm), GFP_KERNEL);
504 if (ivpu_hw_gen(vdev) >= IVPU_HW_40XX) {
505 vdev->hw->ops = &ivpu_hw_40xx_ops;
506 vdev->hw->dma_bits = 48;
508 vdev->hw->ops = &ivpu_hw_37xx_ops;
509 vdev->hw->dma_bits = 38;
512 vdev->platform = IVPU_PLATFORM_INVALID;
513 vdev->context_xa_limit.min = IVPU_USER_CONTEXT_MIN_SSID;
514 vdev->context_xa_limit.max = IVPU_USER_CONTEXT_MAX_SSID;
515 atomic64_set(&vdev->unique_id_counter, 0);
516 xa_init_flags(&vdev->context_xa, XA_FLAGS_ALLOC);
517 xa_init_flags(&vdev->submitted_jobs_xa, XA_FLAGS_ALLOC1);
518 lockdep_set_class(&vdev->submitted_jobs_xa.xa_lock, &submitted_jobs_xa_lock_class_key);
520 ret = ivpu_pci_init(vdev);
522 ivpu_err(vdev, "Failed to initialize PCI device: %d\n", ret);
526 ret = ivpu_irq_init(vdev);
528 ivpu_err(vdev, "Failed to initialize IRQs: %d\n", ret);
532 /* Init basic HW info based on buttress registers which are accessible before power up */
533 ret = ivpu_hw_info_init(vdev);
535 ivpu_err(vdev, "Failed to initialize HW info: %d\n", ret);
539 /* Power up early so the rest of init code can access VPU registers */
540 ret = ivpu_hw_power_up(vdev);
542 ivpu_err(vdev, "Failed to power up HW: %d\n", ret);
546 ret = ivpu_mmu_global_context_init(vdev);
548 ivpu_err(vdev, "Failed to initialize global MMU context: %d\n", ret);
552 ret = ivpu_mmu_init(vdev);
554 ivpu_err(vdev, "Failed to initialize MMU device: %d\n", ret);
555 goto err_mmu_gctx_fini;
558 ret = ivpu_fw_init(vdev);
560 ivpu_err(vdev, "Failed to initialize firmware: %d\n", ret);
561 goto err_mmu_gctx_fini;
564 ret = ivpu_ipc_init(vdev);
566 ivpu_err(vdev, "Failed to initialize IPC: %d\n", ret);
570 ret = ivpu_pm_init(vdev);
572 ivpu_err(vdev, "Failed to initialize PM: %d\n", ret);
576 ret = ivpu_job_done_thread_init(vdev);
578 ivpu_err(vdev, "Failed to initialize job done thread: %d\n", ret);
582 ret = ivpu_fw_load(vdev);
584 ivpu_err(vdev, "Failed to load firmware: %d\n", ret);
585 goto err_job_done_thread_fini;
588 ret = ivpu_boot(vdev);
590 ivpu_err(vdev, "Failed to boot: %d\n", ret);
591 goto err_job_done_thread_fini;
594 ivpu_pm_enable(vdev);
598 err_job_done_thread_fini:
599 ivpu_job_done_thread_fini(vdev);
605 ivpu_mmu_global_context_fini(vdev);
607 ivpu_hw_power_down(vdev);
608 if (IVPU_WA(d3hot_after_power_off))
609 pci_set_power_state(to_pci_dev(vdev->drm.dev), PCI_D3hot);
611 xa_destroy(&vdev->submitted_jobs_xa);
612 xa_destroy(&vdev->context_xa);
616 static void ivpu_dev_fini(struct ivpu_device *vdev)
618 ivpu_pm_disable(vdev);
620 if (IVPU_WA(d3hot_after_power_off))
621 pci_set_power_state(to_pci_dev(vdev->drm.dev), PCI_D3hot);
622 ivpu_job_done_thread_fini(vdev);
623 ivpu_pm_cancel_recovery(vdev);
627 ivpu_mmu_global_context_fini(vdev);
629 drm_WARN_ON(&vdev->drm, !xa_empty(&vdev->submitted_jobs_xa));
630 xa_destroy(&vdev->submitted_jobs_xa);
631 drm_WARN_ON(&vdev->drm, !xa_empty(&vdev->context_xa));
632 xa_destroy(&vdev->context_xa);
635 static struct pci_device_id ivpu_pci_ids[] = {
636 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_MTL) },
637 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_ARL) },
638 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_LNL) },
641 MODULE_DEVICE_TABLE(pci, ivpu_pci_ids);
643 static int ivpu_probe(struct pci_dev *pdev, const struct pci_device_id *id)
645 struct ivpu_device *vdev;
648 vdev = devm_drm_dev_alloc(&pdev->dev, &driver, struct ivpu_device, drm);
650 return PTR_ERR(vdev);
652 pci_set_drvdata(pdev, vdev);
654 ret = ivpu_dev_init(vdev);
656 dev_err(&pdev->dev, "Failed to initialize VPU device: %d\n", ret);
660 ret = drm_dev_register(&vdev->drm, 0);
662 dev_err(&pdev->dev, "Failed to register DRM device: %d\n", ret);
669 static void ivpu_remove(struct pci_dev *pdev)
671 struct ivpu_device *vdev = pci_get_drvdata(pdev);
673 drm_dev_unplug(&vdev->drm);
677 static const struct dev_pm_ops ivpu_drv_pci_pm = {
678 SET_SYSTEM_SLEEP_PM_OPS(ivpu_pm_suspend_cb, ivpu_pm_resume_cb)
679 SET_RUNTIME_PM_OPS(ivpu_pm_runtime_suspend_cb, ivpu_pm_runtime_resume_cb, NULL)
682 static const struct pci_error_handlers ivpu_drv_pci_err = {
683 .reset_prepare = ivpu_pm_reset_prepare_cb,
684 .reset_done = ivpu_pm_reset_done_cb,
687 static struct pci_driver ivpu_pci_driver = {
688 .name = KBUILD_MODNAME,
689 .id_table = ivpu_pci_ids,
691 .remove = ivpu_remove,
693 .pm = &ivpu_drv_pci_pm,
695 .err_handler = &ivpu_drv_pci_err,
698 module_pci_driver(ivpu_pci_driver);
700 MODULE_AUTHOR("Intel Corporation");
701 MODULE_DESCRIPTION(DRIVER_DESC);
702 MODULE_LICENSE("GPL and additional rights");
703 MODULE_VERSION(DRIVER_VERSION_STR);