135b13763SJacek Lawrynowicz /* SPDX-License-Identifier: GPL-2.0-only */
235b13763SJacek Lawrynowicz /*
335b13763SJacek Lawrynowicz * Copyright (C) 2020-2023 Intel Corporation
435b13763SJacek Lawrynowicz */
535b13763SJacek Lawrynowicz
635b13763SJacek Lawrynowicz #ifndef __IVPU_DRV_H__
735b13763SJacek Lawrynowicz #define __IVPU_DRV_H__
835b13763SJacek Lawrynowicz
935b13763SJacek Lawrynowicz #include <drm/drm_device.h>
104522ad76SStanislaw Gruszka #include <drm/drm_drv.h>
1135b13763SJacek Lawrynowicz #include <drm/drm_managed.h>
1235b13763SJacek Lawrynowicz #include <drm/drm_mm.h>
1335b13763SJacek Lawrynowicz #include <drm/drm_print.h>
1435b13763SJacek Lawrynowicz
1535b13763SJacek Lawrynowicz #include <linux/pci.h>
1635b13763SJacek Lawrynowicz #include <linux/xarray.h>
1735b13763SJacek Lawrynowicz #include <uapi/drm/ivpu_accel.h>
1835b13763SJacek Lawrynowicz
19263b2ba5SJacek Lawrynowicz #include "ivpu_mmu_context.h"
20263b2ba5SJacek Lawrynowicz
2135b13763SJacek Lawrynowicz #define DRIVER_NAME "intel_vpu"
2235b13763SJacek Lawrynowicz #define DRIVER_DESC "Driver for Intel Versatile Processing Unit (VPU)"
2335b13763SJacek Lawrynowicz #define DRIVER_DATE "20230117"
2435b13763SJacek Lawrynowicz
2535b13763SJacek Lawrynowicz #define PCI_DEVICE_ID_MTL 0x7d1d
269c1b2429SStanislaw Gruszka #define PCI_DEVICE_ID_ARL 0xad1d
2779cdc56cSStanislaw Gruszka #define PCI_DEVICE_ID_LNL 0x643e
2835b13763SJacek Lawrynowicz
2951d66a7bSJacek Lawrynowicz #define IVPU_HW_37XX 37
3079cdc56cSStanislaw Gruszka #define IVPU_HW_40XX 40
3151d66a7bSJacek Lawrynowicz
3235b13763SJacek Lawrynowicz #define IVPU_GLOBAL_CONTEXT_MMU_SSID 0
333ff6edbcSStanislaw Gruszka /* SSID 1 is used by the VPU to represent invalid context */
343ff6edbcSStanislaw Gruszka #define IVPU_USER_CONTEXT_MIN_SSID 2
353ff6edbcSStanislaw Gruszka #define IVPU_USER_CONTEXT_MAX_SSID (IVPU_USER_CONTEXT_MIN_SSID + 63)
363ff6edbcSStanislaw Gruszka
3735b13763SJacek Lawrynowicz #define IVPU_NUM_ENGINES 2
3835b13763SJacek Lawrynowicz
3935b13763SJacek Lawrynowicz #define IVPU_PLATFORM_SILICON 0
4035b13763SJacek Lawrynowicz #define IVPU_PLATFORM_SIMICS 2
4135b13763SJacek Lawrynowicz #define IVPU_PLATFORM_FPGA 3
4235b13763SJacek Lawrynowicz #define IVPU_PLATFORM_INVALID 8
4335b13763SJacek Lawrynowicz
4435b13763SJacek Lawrynowicz #define IVPU_DBG_REG BIT(0)
4535b13763SJacek Lawrynowicz #define IVPU_DBG_IRQ BIT(1)
4635b13763SJacek Lawrynowicz #define IVPU_DBG_MMU BIT(2)
4735b13763SJacek Lawrynowicz #define IVPU_DBG_FILE BIT(3)
4835b13763SJacek Lawrynowicz #define IVPU_DBG_MISC BIT(4)
4935b13763SJacek Lawrynowicz #define IVPU_DBG_FW_BOOT BIT(5)
5035b13763SJacek Lawrynowicz #define IVPU_DBG_PM BIT(6)
5135b13763SJacek Lawrynowicz #define IVPU_DBG_IPC BIT(7)
5235b13763SJacek Lawrynowicz #define IVPU_DBG_BO BIT(8)
5335b13763SJacek Lawrynowicz #define IVPU_DBG_JOB BIT(9)
5435b13763SJacek Lawrynowicz #define IVPU_DBG_JSM BIT(10)
5535b13763SJacek Lawrynowicz #define IVPU_DBG_KREF BIT(11)
5635b13763SJacek Lawrynowicz #define IVPU_DBG_RPM BIT(12)
5735b13763SJacek Lawrynowicz
5835b13763SJacek Lawrynowicz #define ivpu_err(vdev, fmt, ...) \
5935b13763SJacek Lawrynowicz drm_err(&(vdev)->drm, "%s(): " fmt, __func__, ##__VA_ARGS__)
6035b13763SJacek Lawrynowicz
6135b13763SJacek Lawrynowicz #define ivpu_err_ratelimited(vdev, fmt, ...) \
6235b13763SJacek Lawrynowicz drm_err_ratelimited(&(vdev)->drm, "%s(): " fmt, __func__, ##__VA_ARGS__)
6335b13763SJacek Lawrynowicz
6435b13763SJacek Lawrynowicz #define ivpu_warn(vdev, fmt, ...) \
6535b13763SJacek Lawrynowicz drm_warn(&(vdev)->drm, "%s(): " fmt, __func__, ##__VA_ARGS__)
6635b13763SJacek Lawrynowicz
6735b13763SJacek Lawrynowicz #define ivpu_warn_ratelimited(vdev, fmt, ...) \
6835b13763SJacek Lawrynowicz drm_err_ratelimited(&(vdev)->drm, "%s(): " fmt, __func__, ##__VA_ARGS__)
6935b13763SJacek Lawrynowicz
7035b13763SJacek Lawrynowicz #define ivpu_info(vdev, fmt, ...) drm_info(&(vdev)->drm, fmt, ##__VA_ARGS__)
7135b13763SJacek Lawrynowicz
7235b13763SJacek Lawrynowicz #define ivpu_dbg(vdev, type, fmt, args...) do { \
7335b13763SJacek Lawrynowicz if (unlikely(IVPU_DBG_##type & ivpu_dbg_mask)) \
7435b13763SJacek Lawrynowicz dev_dbg((vdev)->drm.dev, "[%s] " fmt, #type, ##args); \
7535b13763SJacek Lawrynowicz } while (0)
7635b13763SJacek Lawrynowicz
7735b13763SJacek Lawrynowicz #define IVPU_WA(wa_name) (vdev->wa.wa_name)
7835b13763SJacek Lawrynowicz
79*0afcc629SStanislaw Gruszka #define IVPU_PRINT_WA(wa_name) do { \
80*0afcc629SStanislaw Gruszka if (IVPU_WA(wa_name)) \
81*0afcc629SStanislaw Gruszka ivpu_dbg(vdev, MISC, "Using WA: " #wa_name "\n"); \
82*0afcc629SStanislaw Gruszka } while (0)
83*0afcc629SStanislaw Gruszka
8435b13763SJacek Lawrynowicz struct ivpu_wa_table {
8535b13763SJacek Lawrynowicz bool punit_disabled;
8635b13763SJacek Lawrynowicz bool clear_runtime_mem;
873d8b2727SStanislaw Gruszka bool d3hot_after_power_off;
887f34e01fSKarol Wachowski bool interrupt_clear_with_0;
8979cdc56cSStanislaw Gruszka bool disable_clock_relinquish;
9035b13763SJacek Lawrynowicz };
9135b13763SJacek Lawrynowicz
9235b13763SJacek Lawrynowicz struct ivpu_hw_info;
93263b2ba5SJacek Lawrynowicz struct ivpu_mmu_info;
9402d5b0aaSJacek Lawrynowicz struct ivpu_fw_info;
955d7422cfSJacek Lawrynowicz struct ivpu_ipc_info;
96852be13fSJacek Lawrynowicz struct ivpu_pm_info;
9735b13763SJacek Lawrynowicz
9835b13763SJacek Lawrynowicz struct ivpu_device {
9935b13763SJacek Lawrynowicz struct drm_device drm;
10035b13763SJacek Lawrynowicz void __iomem *regb;
10135b13763SJacek Lawrynowicz void __iomem *regv;
10235b13763SJacek Lawrynowicz u32 platform;
10335b13763SJacek Lawrynowicz u32 irq;
10435b13763SJacek Lawrynowicz
10535b13763SJacek Lawrynowicz struct ivpu_wa_table wa;
10635b13763SJacek Lawrynowicz struct ivpu_hw_info *hw;
107263b2ba5SJacek Lawrynowicz struct ivpu_mmu_info *mmu;
10802d5b0aaSJacek Lawrynowicz struct ivpu_fw_info *fw;
1095d7422cfSJacek Lawrynowicz struct ivpu_ipc_info *ipc;
110852be13fSJacek Lawrynowicz struct ivpu_pm_info *pm;
11135b13763SJacek Lawrynowicz
112263b2ba5SJacek Lawrynowicz struct ivpu_mmu_context gctx;
11335b13763SJacek Lawrynowicz struct xarray context_xa;
11435b13763SJacek Lawrynowicz struct xa_limit context_xa_limit;
11535b13763SJacek Lawrynowicz
116cd727221SJacek Lawrynowicz struct xarray submitted_jobs_xa;
117cd727221SJacek Lawrynowicz struct task_struct *job_done_thread;
118cd727221SJacek Lawrynowicz
11902d5b0aaSJacek Lawrynowicz atomic64_t unique_id_counter;
12002d5b0aaSJacek Lawrynowicz
12135b13763SJacek Lawrynowicz struct {
12235b13763SJacek Lawrynowicz int boot;
12335b13763SJacek Lawrynowicz int jsm;
12435b13763SJacek Lawrynowicz int tdr;
12535b13763SJacek Lawrynowicz int reschedule_suspend;
12635b13763SJacek Lawrynowicz } timeout;
12735b13763SJacek Lawrynowicz };
12835b13763SJacek Lawrynowicz
12935b13763SJacek Lawrynowicz /*
13035b13763SJacek Lawrynowicz * file_priv has its own refcount (ref) that allows user space to close the fd
13135b13763SJacek Lawrynowicz * without blocking even if VPU is still processing some jobs.
13235b13763SJacek Lawrynowicz */
13335b13763SJacek Lawrynowicz struct ivpu_file_priv {
13435b13763SJacek Lawrynowicz struct kref ref;
13535b13763SJacek Lawrynowicz struct ivpu_device *vdev;
136cd727221SJacek Lawrynowicz struct mutex lock; /* Protects cmdq */
137cd727221SJacek Lawrynowicz struct ivpu_cmdq *cmdq[IVPU_NUM_ENGINES];
138263b2ba5SJacek Lawrynowicz struct ivpu_mmu_context ctx;
13935b13763SJacek Lawrynowicz u32 priority;
140263b2ba5SJacek Lawrynowicz bool has_mmu_faults;
14135b13763SJacek Lawrynowicz };
14235b13763SJacek Lawrynowicz
14335b13763SJacek Lawrynowicz extern int ivpu_dbg_mask;
14435b13763SJacek Lawrynowicz extern u8 ivpu_pll_min_ratio;
14535b13763SJacek Lawrynowicz extern u8 ivpu_pll_max_ratio;
14695d44018SKarol Wachowski extern bool ivpu_disable_mmu_cont_pages;
14735b13763SJacek Lawrynowicz
14802d5b0aaSJacek Lawrynowicz #define IVPU_TEST_MODE_DISABLED 0
14902d5b0aaSJacek Lawrynowicz #define IVPU_TEST_MODE_FW_TEST 1
15002d5b0aaSJacek Lawrynowicz #define IVPU_TEST_MODE_NULL_HW 2
15102d5b0aaSJacek Lawrynowicz extern int ivpu_test_mode;
15202d5b0aaSJacek Lawrynowicz
15335b13763SJacek Lawrynowicz struct ivpu_file_priv *ivpu_file_priv_get(struct ivpu_file_priv *file_priv);
154647371a6SJacek Lawrynowicz struct ivpu_file_priv *ivpu_file_priv_get_by_ctx_id(struct ivpu_device *vdev, unsigned long id);
15535b13763SJacek Lawrynowicz void ivpu_file_priv_put(struct ivpu_file_priv **link);
15602d5b0aaSJacek Lawrynowicz
15702d5b0aaSJacek Lawrynowicz int ivpu_boot(struct ivpu_device *vdev);
15835b13763SJacek Lawrynowicz int ivpu_shutdown(struct ivpu_device *vdev);
159828d6304SJacek Lawrynowicz void ivpu_prepare_for_reset(struct ivpu_device *vdev);
16035b13763SJacek Lawrynowicz
ivpu_revision(struct ivpu_device * vdev)16135b13763SJacek Lawrynowicz static inline u8 ivpu_revision(struct ivpu_device *vdev)
16235b13763SJacek Lawrynowicz {
16335b13763SJacek Lawrynowicz return to_pci_dev(vdev->drm.dev)->revision;
16435b13763SJacek Lawrynowicz }
16535b13763SJacek Lawrynowicz
ivpu_device_id(struct ivpu_device * vdev)16635b13763SJacek Lawrynowicz static inline u16 ivpu_device_id(struct ivpu_device *vdev)
16735b13763SJacek Lawrynowicz {
16835b13763SJacek Lawrynowicz return to_pci_dev(vdev->drm.dev)->device;
16935b13763SJacek Lawrynowicz }
17035b13763SJacek Lawrynowicz
ivpu_hw_gen(struct ivpu_device * vdev)17151d66a7bSJacek Lawrynowicz static inline int ivpu_hw_gen(struct ivpu_device *vdev)
17251d66a7bSJacek Lawrynowicz {
17351d66a7bSJacek Lawrynowicz switch (ivpu_device_id(vdev)) {
17451d66a7bSJacek Lawrynowicz case PCI_DEVICE_ID_MTL:
1759c1b2429SStanislaw Gruszka case PCI_DEVICE_ID_ARL:
17651d66a7bSJacek Lawrynowicz return IVPU_HW_37XX;
17779cdc56cSStanislaw Gruszka case PCI_DEVICE_ID_LNL:
17879cdc56cSStanislaw Gruszka return IVPU_HW_40XX;
17951d66a7bSJacek Lawrynowicz default:
18051d66a7bSJacek Lawrynowicz ivpu_err(vdev, "Unknown VPU device\n");
18151d66a7bSJacek Lawrynowicz return 0;
18251d66a7bSJacek Lawrynowicz }
18351d66a7bSJacek Lawrynowicz }
18451d66a7bSJacek Lawrynowicz
to_ivpu_device(struct drm_device * dev)18535b13763SJacek Lawrynowicz static inline struct ivpu_device *to_ivpu_device(struct drm_device *dev)
18635b13763SJacek Lawrynowicz {
18735b13763SJacek Lawrynowicz return container_of(dev, struct ivpu_device, drm);
18835b13763SJacek Lawrynowicz }
18935b13763SJacek Lawrynowicz
ivpu_get_context_count(struct ivpu_device * vdev)19035b13763SJacek Lawrynowicz static inline u32 ivpu_get_context_count(struct ivpu_device *vdev)
19135b13763SJacek Lawrynowicz {
19235b13763SJacek Lawrynowicz struct xa_limit ctx_limit = vdev->context_xa_limit;
19335b13763SJacek Lawrynowicz
19435b13763SJacek Lawrynowicz return (ctx_limit.max - ctx_limit.min + 1);
19535b13763SJacek Lawrynowicz }
19635b13763SJacek Lawrynowicz
ivpu_get_platform(struct ivpu_device * vdev)19735b13763SJacek Lawrynowicz static inline u32 ivpu_get_platform(struct ivpu_device *vdev)
19835b13763SJacek Lawrynowicz {
19935b13763SJacek Lawrynowicz WARN_ON_ONCE(vdev->platform == IVPU_PLATFORM_INVALID);
20035b13763SJacek Lawrynowicz return vdev->platform;
20135b13763SJacek Lawrynowicz }
20235b13763SJacek Lawrynowicz
ivpu_is_silicon(struct ivpu_device * vdev)20335b13763SJacek Lawrynowicz static inline bool ivpu_is_silicon(struct ivpu_device *vdev)
20435b13763SJacek Lawrynowicz {
20535b13763SJacek Lawrynowicz return ivpu_get_platform(vdev) == IVPU_PLATFORM_SILICON;
20635b13763SJacek Lawrynowicz }
20735b13763SJacek Lawrynowicz
ivpu_is_simics(struct ivpu_device * vdev)20835b13763SJacek Lawrynowicz static inline bool ivpu_is_simics(struct ivpu_device *vdev)
20935b13763SJacek Lawrynowicz {
21035b13763SJacek Lawrynowicz return ivpu_get_platform(vdev) == IVPU_PLATFORM_SIMICS;
21135b13763SJacek Lawrynowicz }
21235b13763SJacek Lawrynowicz
ivpu_is_fpga(struct ivpu_device * vdev)21335b13763SJacek Lawrynowicz static inline bool ivpu_is_fpga(struct ivpu_device *vdev)
21435b13763SJacek Lawrynowicz {
21535b13763SJacek Lawrynowicz return ivpu_get_platform(vdev) == IVPU_PLATFORM_FPGA;
21635b13763SJacek Lawrynowicz }
21735b13763SJacek Lawrynowicz
21835b13763SJacek Lawrynowicz #endif /* __IVPU_DRV_H__ */
219