drivers/accel/ivpu/ivpu_drv.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (C) 2020-2023 Intel Corporation
   4  */
   5
   6 #ifndef __IVPU_DRV_H__
   7 #define __IVPU_DRV_H__
   8
   9 #include <drm/drm_device.h>
  10 #include <drm/drm_drv.h>
  11 #include <drm/drm_managed.h>
  12 #include <drm/drm_mm.h>
  13 #include <drm/drm_print.h>
  14
  15 #include <linux/pci.h>
  16 #include <linux/xarray.h>
  17 #include <uapi/drm/ivpu_accel.h>
  18
  19 #include "ivpu_mmu_context.h"
  20
  21 #define DRIVER_NAME "intel_vpu"
  22 #define DRIVER_DESC "Driver for Intel Versatile Processing Unit (VPU)"
  23 #define DRIVER_DATE "20230117"
  24
  25 #define PCI_DEVICE_ID_MTL   0x7d1d
  26
  27 #define IVPU_GLOBAL_CONTEXT_MMU_SSID 0
  28 /* SSID 1 is used by the VPU to represent invalid context */
  29 #define IVPU_USER_CONTEXT_MIN_SSID   2
  30 #define IVPU_USER_CONTEXT_MAX_SSID   (IVPU_USER_CONTEXT_MIN_SSID + 63)
  31
  32 #define IVPU_NUM_ENGINES             2
  33
  34 #define IVPU_PLATFORM_SILICON 0
  35 #define IVPU_PLATFORM_SIMICS  2
  36 #define IVPU_PLATFORM_FPGA    3
  37 #define IVPU_PLATFORM_INVALID 8
  38
  39 #define IVPU_DBG_REG     BIT(0)
  40 #define IVPU_DBG_IRQ     BIT(1)
  41 #define IVPU_DBG_MMU     BIT(2)
  42 #define IVPU_DBG_FILE    BIT(3)
  43 #define IVPU_DBG_MISC    BIT(4)
  44 #define IVPU_DBG_FW_BOOT BIT(5)
  45 #define IVPU_DBG_PM      BIT(6)
  46 #define IVPU_DBG_IPC     BIT(7)
  47 #define IVPU_DBG_BO      BIT(8)
  48 #define IVPU_DBG_JOB     BIT(9)
  49 #define IVPU_DBG_JSM     BIT(10)
  50 #define IVPU_DBG_KREF    BIT(11)
  51 #define IVPU_DBG_RPM     BIT(12)
  52
  53 #define ivpu_err(vdev, fmt, ...) \
  54         drm_err(&(vdev)->drm, "%s(): " fmt, __func__, ##__VA_ARGS__)
  55
  56 #define ivpu_err_ratelimited(vdev, fmt, ...) \
  57         drm_err_ratelimited(&(vdev)->drm, "%s(): " fmt, __func__, ##__VA_ARGS__)
  58
  59 #define ivpu_warn(vdev, fmt, ...) \
  60         drm_warn(&(vdev)->drm, "%s(): " fmt, __func__, ##__VA_ARGS__)
  61
  62 #define ivpu_warn_ratelimited(vdev, fmt, ...) \
  63         drm_err_ratelimited(&(vdev)->drm, "%s(): " fmt, __func__, ##__VA_ARGS__)
  64
  65 #define ivpu_info(vdev, fmt, ...) drm_info(&(vdev)->drm, fmt, ##__VA_ARGS__)
  66
  67 #define ivpu_dbg(vdev, type, fmt, args...) do {                                \
  68         if (unlikely(IVPU_DBG_##type & ivpu_dbg_mask))                         \
  69                 dev_dbg((vdev)->drm.dev, "[%s] " fmt, #type, ##args);          \
  70 } while (0)
  71
  72 #define IVPU_WA(wa_name) (vdev->wa.wa_name)
  73
  74 struct ivpu_wa_table {
  75         bool punit_disabled;
  76         bool clear_runtime_mem;
  77         bool d3hot_after_power_off;
  78 };
  79
  80 struct ivpu_hw_info;
  81 struct ivpu_mmu_info;
  82 struct ivpu_fw_info;
  83 struct ivpu_ipc_info;
  84 struct ivpu_pm_info;
  85
  86 struct ivpu_device {
  87         struct drm_device drm;
  88         void __iomem *regb;
  89         void __iomem *regv;
  90         u32 platform;
  91         u32 irq;
  92
  93         struct ivpu_wa_table wa;
  94         struct ivpu_hw_info *hw;
  95         struct ivpu_mmu_info *mmu;
  96         struct ivpu_fw_info *fw;
  97         struct ivpu_ipc_info *ipc;
  98         struct ivpu_pm_info *pm;
  99
 100         struct ivpu_mmu_context gctx;
 101         struct xarray context_xa;
 102         struct xa_limit context_xa_limit;
 103
 104         struct xarray submitted_jobs_xa;
 105         struct task_struct *job_done_thread;
 106
 107         atomic64_t unique_id_counter;
 108
 109         struct {
 110                 int boot;
 111                 int jsm;
 112                 int tdr;
 113                 int reschedule_suspend;
 114         } timeout;
 115 };
 116
 117 /*
 118  * file_priv has its own refcount (ref) that allows user space to close the fd
 119  * without blocking even if VPU is still processing some jobs.
 120  */
 121 struct ivpu_file_priv {
 122         struct kref ref;
 123         struct ivpu_device *vdev;
 124         struct mutex lock; /* Protects cmdq */
 125         struct ivpu_cmdq *cmdq[IVPU_NUM_ENGINES];
 126         struct ivpu_mmu_context ctx;
 127         u32 priority;
 128         bool has_mmu_faults;
 129 };
 130
 131 extern int ivpu_dbg_mask;
 132 extern u8 ivpu_pll_min_ratio;
 133 extern u8 ivpu_pll_max_ratio;
 134
 135 #define IVPU_TEST_MODE_DISABLED  0
 136 #define IVPU_TEST_MODE_FW_TEST   1
 137 #define IVPU_TEST_MODE_NULL_HW   2
 138 extern int ivpu_test_mode;
 139
 140 struct ivpu_file_priv *ivpu_file_priv_get(struct ivpu_file_priv *file_priv);
 141 struct ivpu_file_priv *ivpu_file_priv_get_by_ctx_id(struct ivpu_device *vdev, unsigned long id);
 142 void ivpu_file_priv_put(struct ivpu_file_priv **link);
 143
 144 int ivpu_boot(struct ivpu_device *vdev);
 145 int ivpu_shutdown(struct ivpu_device *vdev);
 146
 147 static inline bool ivpu_is_mtl(struct ivpu_device *vdev)
 148 {
 149         return to_pci_dev(vdev->drm.dev)->device == PCI_DEVICE_ID_MTL;
 150 }
 151
 152 static inline u8 ivpu_revision(struct ivpu_device *vdev)
 153 {
 154         return to_pci_dev(vdev->drm.dev)->revision;
 155 }
 156
 157 static inline u16 ivpu_device_id(struct ivpu_device *vdev)
 158 {
 159         return to_pci_dev(vdev->drm.dev)->device;
 160 }
 161
 162 static inline struct ivpu_device *to_ivpu_device(struct drm_device *dev)
 163 {
 164         return container_of(dev, struct ivpu_device, drm);
 165 }
 166
 167 static inline u32 ivpu_get_context_count(struct ivpu_device *vdev)
 168 {
 169         struct xa_limit ctx_limit = vdev->context_xa_limit;
 170
 171         return (ctx_limit.max - ctx_limit.min + 1);
 172 }
 173
 174 static inline u32 ivpu_get_platform(struct ivpu_device *vdev)
 175 {
 176         WARN_ON_ONCE(vdev->platform == IVPU_PLATFORM_INVALID);
 177         return vdev->platform;
 178 }
 179
 180 static inline bool ivpu_is_silicon(struct ivpu_device *vdev)
 181 {
 182         return ivpu_get_platform(vdev) == IVPU_PLATFORM_SILICON;
 183 }
 184
 185 static inline bool ivpu_is_simics(struct ivpu_device *vdev)
 186 {
 187         return ivpu_get_platform(vdev) == IVPU_PLATFORM_SIMICS;
 188 }
 189
 190 static inline bool ivpu_is_fpga(struct ivpu_device *vdev)
 191 {
 192         return ivpu_get_platform(vdev) == IVPU_PLATFORM_FPGA;
 193 }
 194
 195 #endif /* __IVPU_DRV_H__ */