drivers/gpu/drm/i915/gvt/gvt.h

   1 /*
   2  * Copyright(c) 2011-2016 Intel Corporation. All rights reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  *
  23  * Authors:
  24  *    Kevin Tian <kevin.tian@intel.com>
  25  *    Eddie Dong <eddie.dong@intel.com>
  26  *
  27  * Contributors:
  28  *    Niu Bing <bing.niu@intel.com>
  29  *    Zhi Wang <zhi.a.wang@intel.com>
  30  *
  31  */
  32
  33 #ifndef _GVT_H_
  34 #define _GVT_H_
  35
  36 #include "debug.h"
  37 #include "hypercall.h"
  38 #include "mmio.h"
  39 #include "reg.h"
  40 #include "interrupt.h"
  41 #include "gtt.h"
  42 #include "display.h"
  43 #include "edid.h"
  44 #include "execlist.h"
  45 #include "scheduler.h"
  46 #include "sched_policy.h"
  47 #include "render.h"
  48 #include "cmd_parser.h"
  49
  50 #define GVT_MAX_VGPU 8
  51
  52 enum {
  53         INTEL_GVT_HYPERVISOR_XEN = 0,
  54         INTEL_GVT_HYPERVISOR_KVM,
  55 };
  56
  57 struct intel_gvt_host {
  58         bool initialized;
  59         int hypervisor_type;
  60         struct intel_gvt_mpt *mpt;
  61 };
  62
  63 extern struct intel_gvt_host intel_gvt_host;
  64
  65 /* Describe per-platform limitations. */
  66 struct intel_gvt_device_info {
  67         u32 max_support_vgpus;
  68         u32 cfg_space_size;
  69         u32 mmio_size;
  70         u32 mmio_bar;
  71         unsigned long msi_cap_offset;
  72         u32 gtt_start_offset;
  73         u32 gtt_entry_size;
  74         u32 gtt_entry_size_shift;
  75         int gmadr_bytes_in_cmd;
  76         u32 max_surface_size;
  77 };
  78
  79 /* GM resources owned by a vGPU */
  80 struct intel_vgpu_gm {
  81         u64 aperture_sz;
  82         u64 hidden_sz;
  83         struct drm_mm_node low_gm_node;
  84         struct drm_mm_node high_gm_node;
  85 };
  86
  87 #define INTEL_GVT_MAX_NUM_FENCES 32
  88
  89 /* Fences owned by a vGPU */
  90 struct intel_vgpu_fence {
  91         struct drm_i915_fence_reg *regs[INTEL_GVT_MAX_NUM_FENCES];
  92         u32 base;
  93         u32 size;
  94 };
  95
  96 struct intel_vgpu_mmio {
  97         void *vreg;
  98         void *sreg;
  99         bool disable_warn_untrack;
 100 };
 101
 102 #define INTEL_GVT_MAX_CFG_SPACE_SZ 256
 103 #define INTEL_GVT_MAX_BAR_NUM 4
 104
 105 struct intel_vgpu_pci_bar {
 106         u64 size;
 107         bool tracked;
 108 };
 109
 110 struct intel_vgpu_cfg_space {
 111         unsigned char virtual_cfg_space[INTEL_GVT_MAX_CFG_SPACE_SZ];
 112         struct intel_vgpu_pci_bar bar[INTEL_GVT_MAX_BAR_NUM];
 113 };
 114
 115 #define vgpu_cfg_space(vgpu) ((vgpu)->cfg_space.virtual_cfg_space)
 116
 117 #define INTEL_GVT_MAX_PIPE 4
 118
 119 struct intel_vgpu_irq {
 120         bool irq_warn_once[INTEL_GVT_EVENT_MAX];
 121         DECLARE_BITMAP(flip_done_event[INTEL_GVT_MAX_PIPE],
 122                        INTEL_GVT_EVENT_MAX);
 123 };
 124
 125 struct intel_vgpu_opregion {
 126         void *va;
 127         u32 gfn[INTEL_GVT_OPREGION_PAGES];
 128         struct page *pages[INTEL_GVT_OPREGION_PAGES];
 129 };
 130
 131 #define vgpu_opregion(vgpu) (&(vgpu->opregion))
 132
 133 #define INTEL_GVT_MAX_PORT 5
 134
 135 struct intel_vgpu_display {
 136         struct intel_vgpu_i2c_edid i2c_edid;
 137         struct intel_vgpu_port ports[INTEL_GVT_MAX_PORT];
 138         struct intel_vgpu_sbi sbi;
 139 };
 140
 141 struct vgpu_sched_ctl {
 142         int weight;
 143 };
 144
 145 struct intel_vgpu {
 146         struct intel_gvt *gvt;
 147         int id;
 148         unsigned long handle; /* vGPU handle used by hypervisor MPT modules */
 149         bool active;
 150         bool pv_notified;
 151         bool failsafe;
 152         bool resetting;
 153         void *sched_data;
 154         struct vgpu_sched_ctl sched_ctl;
 155
 156         struct intel_vgpu_fence fence;
 157         struct intel_vgpu_gm gm;
 158         struct intel_vgpu_cfg_space cfg_space;
 159         struct intel_vgpu_mmio mmio;
 160         struct intel_vgpu_irq irq;
 161         struct intel_vgpu_gtt gtt;
 162         struct intel_vgpu_opregion opregion;
 163         struct intel_vgpu_display display;
 164         struct intel_vgpu_execlist execlist[I915_NUM_ENGINES];
 165         struct list_head workload_q_head[I915_NUM_ENGINES];
 166         struct kmem_cache *workloads;
 167         atomic_t running_workload_num;
 168         ktime_t last_ctx_submit_time;
 169         DECLARE_BITMAP(tlb_handle_pending, I915_NUM_ENGINES);
 170         struct i915_gem_context *shadow_ctx;
 171
 172 #if IS_ENABLED(CONFIG_DRM_I915_GVT_KVMGT)
 173         struct {
 174                 struct mdev_device *mdev;
 175                 struct vfio_region *region;
 176                 int num_regions;
 177                 struct eventfd_ctx *intx_trigger;
 178                 struct eventfd_ctx *msi_trigger;
 179                 struct rb_root cache;
 180                 struct mutex cache_lock;
 181                 struct notifier_block iommu_notifier;
 182                 struct notifier_block group_notifier;
 183                 struct kvm *kvm;
 184                 struct work_struct release_work;
 185                 atomic_t released;
 186                 struct work_struct unpin_work;
 187                 spinlock_t unpin_lock; /* To protect unpin_list */
 188                 struct list_head unpin_list;
 189         } vdev;
 190 #endif
 191 };
 192
 193 struct intel_gvt_gm {
 194         unsigned long vgpu_allocated_low_gm_size;
 195         unsigned long vgpu_allocated_high_gm_size;
 196 };
 197
 198 struct intel_gvt_fence {
 199         unsigned long vgpu_allocated_fence_num;
 200 };
 201
 202 #define INTEL_GVT_MMIO_HASH_BITS 9
 203
 204 struct intel_gvt_mmio {
 205         u32 *mmio_attribute;
 206         DECLARE_HASHTABLE(mmio_info_table, INTEL_GVT_MMIO_HASH_BITS);
 207 };
 208
 209 struct intel_gvt_firmware {
 210         void *cfg_space;
 211         void *mmio;
 212         bool firmware_loaded;
 213 };
 214
 215 struct intel_gvt_opregion {
 216         void *opregion_va;
 217         u32 opregion_pa;
 218 };
 219
 220 #define NR_MAX_INTEL_VGPU_TYPES 20
 221 struct intel_vgpu_type {
 222         char name[16];
 223         unsigned int avail_instance;
 224         unsigned int low_gm_size;
 225         unsigned int high_gm_size;
 226         unsigned int fence;
 227         unsigned int weight;
 228         enum intel_vgpu_edid resolution;
 229 };
 230
 231 struct intel_gvt {
 232         struct mutex lock;
 233         struct drm_i915_private *dev_priv;
 234         struct idr vgpu_idr;    /* vGPU IDR pool */
 235
 236         struct intel_gvt_device_info device_info;
 237         struct intel_gvt_gm gm;
 238         struct intel_gvt_fence fence;
 239         struct intel_gvt_mmio mmio;
 240         struct intel_gvt_firmware firmware;
 241         struct intel_gvt_irq irq;
 242         struct intel_gvt_gtt gtt;
 243         struct intel_gvt_opregion opregion;
 244         struct intel_gvt_workload_scheduler scheduler;
 245         struct notifier_block shadow_ctx_notifier_block[I915_NUM_ENGINES];
 246         DECLARE_HASHTABLE(cmd_table, GVT_CMD_HASH_BITS);
 247         struct intel_vgpu_type *types;
 248         unsigned int num_types;
 249         struct intel_vgpu *idle_vgpu;
 250
 251         struct task_struct *service_thread;
 252         wait_queue_head_t service_thread_wq;
 253         unsigned long service_request;
 254 };
 255
 256 static inline struct intel_gvt *to_gvt(struct drm_i915_private *i915)
 257 {
 258         return i915->gvt;
 259 }
 260
 261 enum {
 262         INTEL_GVT_REQUEST_EMULATE_VBLANK = 0,
 263         INTEL_GVT_REQUEST_SCHED = 1,
 264 };
 265
 266 static inline void intel_gvt_request_service(struct intel_gvt *gvt,
 267                 int service)
 268 {
 269         set_bit(service, (void *)&gvt->service_request);
 270         wake_up(&gvt->service_thread_wq);
 271 }
 272
 273 void intel_gvt_free_firmware(struct intel_gvt *gvt);
 274 int intel_gvt_load_firmware(struct intel_gvt *gvt);
 275
 276 /* Aperture/GM space definitions for GVT device */
 277 #define MB_TO_BYTES(mb) ((mb) << 20ULL)
 278 #define BYTES_TO_MB(b) ((b) >> 20ULL)
 279
 280 #define HOST_LOW_GM_SIZE MB_TO_BYTES(128)
 281 #define HOST_HIGH_GM_SIZE MB_TO_BYTES(384)
 282 #define HOST_FENCE 4
 283
 284 /* Aperture/GM space definitions for GVT device */
 285 #define gvt_aperture_sz(gvt)      (gvt->dev_priv->ggtt.mappable_end)
 286 #define gvt_aperture_pa_base(gvt) (gvt->dev_priv->ggtt.mappable_base)
 287
 288 #define gvt_ggtt_gm_sz(gvt)       (gvt->dev_priv->ggtt.base.total)
 289 #define gvt_ggtt_sz(gvt) \
 290         ((gvt->dev_priv->ggtt.base.total >> PAGE_SHIFT) << 3)
 291 #define gvt_hidden_sz(gvt)        (gvt_ggtt_gm_sz(gvt) - gvt_aperture_sz(gvt))
 292
 293 #define gvt_aperture_gmadr_base(gvt) (0)
 294 #define gvt_aperture_gmadr_end(gvt) (gvt_aperture_gmadr_base(gvt) \
 295                                      + gvt_aperture_sz(gvt) - 1)
 296
 297 #define gvt_hidden_gmadr_base(gvt) (gvt_aperture_gmadr_base(gvt) \
 298                                     + gvt_aperture_sz(gvt))
 299 #define gvt_hidden_gmadr_end(gvt) (gvt_hidden_gmadr_base(gvt) \
 300                                    + gvt_hidden_sz(gvt) - 1)
 301
 302 #define gvt_fence_sz(gvt) (gvt->dev_priv->num_fence_regs)
 303
 304 /* Aperture/GM space definitions for vGPU */
 305 #define vgpu_aperture_offset(vgpu)      ((vgpu)->gm.low_gm_node.start)
 306 #define vgpu_hidden_offset(vgpu)        ((vgpu)->gm.high_gm_node.start)
 307 #define vgpu_aperture_sz(vgpu)          ((vgpu)->gm.aperture_sz)
 308 #define vgpu_hidden_sz(vgpu)            ((vgpu)->gm.hidden_sz)
 309
 310 #define vgpu_aperture_pa_base(vgpu) \
 311         (gvt_aperture_pa_base(vgpu->gvt) + vgpu_aperture_offset(vgpu))
 312
 313 #define vgpu_ggtt_gm_sz(vgpu) ((vgpu)->gm.aperture_sz + (vgpu)->gm.hidden_sz)
 314
 315 #define vgpu_aperture_pa_end(vgpu) \
 316         (vgpu_aperture_pa_base(vgpu) + vgpu_aperture_sz(vgpu) - 1)
 317
 318 #define vgpu_aperture_gmadr_base(vgpu) (vgpu_aperture_offset(vgpu))
 319 #define vgpu_aperture_gmadr_end(vgpu) \
 320         (vgpu_aperture_gmadr_base(vgpu) + vgpu_aperture_sz(vgpu) - 1)
 321
 322 #define vgpu_hidden_gmadr_base(vgpu) (vgpu_hidden_offset(vgpu))
 323 #define vgpu_hidden_gmadr_end(vgpu) \
 324         (vgpu_hidden_gmadr_base(vgpu) + vgpu_hidden_sz(vgpu) - 1)
 325
 326 #define vgpu_fence_base(vgpu) (vgpu->fence.base)
 327 #define vgpu_fence_sz(vgpu) (vgpu->fence.size)
 328
 329 struct intel_vgpu_creation_params {
 330         __u64 handle;
 331         __u64 low_gm_sz;  /* in MB */
 332         __u64 high_gm_sz; /* in MB */
 333         __u64 fence_sz;
 334         __u64 resolution;
 335         __s32 primary;
 336         __u64 vgpu_id;
 337
 338         __u32 weight;
 339 };
 340
 341 int intel_vgpu_alloc_resource(struct intel_vgpu *vgpu,
 342                               struct intel_vgpu_creation_params *param);
 343 void intel_vgpu_reset_resource(struct intel_vgpu *vgpu);
 344 void intel_vgpu_free_resource(struct intel_vgpu *vgpu);
 345 void intel_vgpu_write_fence(struct intel_vgpu *vgpu,
 346         u32 fence, u64 value);
 347
 348 /* Macros for easily accessing vGPU virtual/shadow register */
 349 #define vgpu_vreg(vgpu, reg) \
 350         (*(u32 *)(vgpu->mmio.vreg + INTEL_GVT_MMIO_OFFSET(reg)))
 351 #define vgpu_vreg8(vgpu, reg) \
 352         (*(u8 *)(vgpu->mmio.vreg + INTEL_GVT_MMIO_OFFSET(reg)))
 353 #define vgpu_vreg16(vgpu, reg) \
 354         (*(u16 *)(vgpu->mmio.vreg + INTEL_GVT_MMIO_OFFSET(reg)))
 355 #define vgpu_vreg64(vgpu, reg) \
 356         (*(u64 *)(vgpu->mmio.vreg + INTEL_GVT_MMIO_OFFSET(reg)))
 357 #define vgpu_sreg(vgpu, reg) \
 358         (*(u32 *)(vgpu->mmio.sreg + INTEL_GVT_MMIO_OFFSET(reg)))
 359 #define vgpu_sreg8(vgpu, reg) \
 360         (*(u8 *)(vgpu->mmio.sreg + INTEL_GVT_MMIO_OFFSET(reg)))
 361 #define vgpu_sreg16(vgpu, reg) \
 362         (*(u16 *)(vgpu->mmio.sreg + INTEL_GVT_MMIO_OFFSET(reg)))
 363 #define vgpu_sreg64(vgpu, reg) \
 364         (*(u64 *)(vgpu->mmio.sreg + INTEL_GVT_MMIO_OFFSET(reg)))
 365
 366 #define for_each_active_vgpu(gvt, vgpu, id) \
 367         idr_for_each_entry((&(gvt)->vgpu_idr), (vgpu), (id)) \
 368                 for_each_if(vgpu->active)
 369
 370 static inline void intel_vgpu_write_pci_bar(struct intel_vgpu *vgpu,
 371                                             u32 offset, u32 val, bool low)
 372 {
 373         u32 *pval;
 374
 375         /* BAR offset should be 32 bits algiend */
 376         offset = rounddown(offset, 4);
 377         pval = (u32 *)(vgpu_cfg_space(vgpu) + offset);
 378
 379         if (low) {
 380                 /*
 381                  * only update bit 31 - bit 4,
 382                  * leave the bit 3 - bit 0 unchanged.
 383                  */
 384                 *pval = (val & GENMASK(31, 4)) | (*pval & GENMASK(3, 0));
 385         } else {
 386                 *pval = val;
 387         }
 388 }
 389
 390 int intel_gvt_init_vgpu_types(struct intel_gvt *gvt);
 391 void intel_gvt_clean_vgpu_types(struct intel_gvt *gvt);
 392
 393 struct intel_vgpu *intel_gvt_create_idle_vgpu(struct intel_gvt *gvt);
 394 void intel_gvt_destroy_idle_vgpu(struct intel_vgpu *vgpu);
 395 struct intel_vgpu *intel_gvt_create_vgpu(struct intel_gvt *gvt,
 396                                          struct intel_vgpu_type *type);
 397 void intel_gvt_destroy_vgpu(struct intel_vgpu *vgpu);
 398 void intel_gvt_reset_vgpu_locked(struct intel_vgpu *vgpu, bool dmlr,
 399                                  unsigned int engine_mask);
 400 void intel_gvt_reset_vgpu(struct intel_vgpu *vgpu);
 401 void intel_gvt_activate_vgpu(struct intel_vgpu *vgpu);
 402 void intel_gvt_deactivate_vgpu(struct intel_vgpu *vgpu);
 403
 404 /* validating GM functions */
 405 #define vgpu_gmadr_is_aperture(vgpu, gmadr) \
 406         ((gmadr >= vgpu_aperture_gmadr_base(vgpu)) && \
 407          (gmadr <= vgpu_aperture_gmadr_end(vgpu)))
 408
 409 #define vgpu_gmadr_is_hidden(vgpu, gmadr) \
 410         ((gmadr >= vgpu_hidden_gmadr_base(vgpu)) && \
 411          (gmadr <= vgpu_hidden_gmadr_end(vgpu)))
 412
 413 #define vgpu_gmadr_is_valid(vgpu, gmadr) \
 414          ((vgpu_gmadr_is_aperture(vgpu, gmadr) || \
 415           (vgpu_gmadr_is_hidden(vgpu, gmadr))))
 416
 417 #define gvt_gmadr_is_aperture(gvt, gmadr) \
 418          ((gmadr >= gvt_aperture_gmadr_base(gvt)) && \
 419           (gmadr <= gvt_aperture_gmadr_end(gvt)))
 420
 421 #define gvt_gmadr_is_hidden(gvt, gmadr) \
 422           ((gmadr >= gvt_hidden_gmadr_base(gvt)) && \
 423            (gmadr <= gvt_hidden_gmadr_end(gvt)))
 424
 425 #define gvt_gmadr_is_valid(gvt, gmadr) \
 426           (gvt_gmadr_is_aperture(gvt, gmadr) || \
 427             gvt_gmadr_is_hidden(gvt, gmadr))
 428
 429 bool intel_gvt_ggtt_validate_range(struct intel_vgpu *vgpu, u64 addr, u32 size);
 430 int intel_gvt_ggtt_gmadr_g2h(struct intel_vgpu *vgpu, u64 g_addr, u64 *h_addr);
 431 int intel_gvt_ggtt_gmadr_h2g(struct intel_vgpu *vgpu, u64 h_addr, u64 *g_addr);
 432 int intel_gvt_ggtt_index_g2h(struct intel_vgpu *vgpu, unsigned long g_index,
 433                              unsigned long *h_index);
 434 int intel_gvt_ggtt_h2g_index(struct intel_vgpu *vgpu, unsigned long h_index,
 435                              unsigned long *g_index);
 436
 437 void intel_vgpu_init_cfg_space(struct intel_vgpu *vgpu,
 438                 bool primary);
 439 void intel_vgpu_reset_cfg_space(struct intel_vgpu *vgpu);
 440
 441 int intel_vgpu_emulate_cfg_read(struct intel_vgpu *vgpu, unsigned int offset,
 442                 void *p_data, unsigned int bytes);
 443
 444 int intel_vgpu_emulate_cfg_write(struct intel_vgpu *vgpu, unsigned int offset,
 445                 void *p_data, unsigned int bytes);
 446
 447 void intel_gvt_clean_opregion(struct intel_gvt *gvt);
 448 int intel_gvt_init_opregion(struct intel_gvt *gvt);
 449
 450 void intel_vgpu_clean_opregion(struct intel_vgpu *vgpu);
 451 int intel_vgpu_init_opregion(struct intel_vgpu *vgpu, u32 gpa);
 452
 453 int intel_vgpu_emulate_opregion_request(struct intel_vgpu *vgpu, u32 swsci);
 454 void populate_pvinfo_page(struct intel_vgpu *vgpu);
 455
 456 struct intel_gvt_ops {
 457         int (*emulate_cfg_read)(struct intel_vgpu *, unsigned int, void *,
 458                                 unsigned int);
 459         int (*emulate_cfg_write)(struct intel_vgpu *, unsigned int, void *,
 460                                 unsigned int);
 461         int (*emulate_mmio_read)(struct intel_vgpu *, u64, void *,
 462                                 unsigned int);
 463         int (*emulate_mmio_write)(struct intel_vgpu *, u64, void *,
 464                                 unsigned int);
 465         struct intel_vgpu *(*vgpu_create)(struct intel_gvt *,
 466                                 struct intel_vgpu_type *);
 467         void (*vgpu_destroy)(struct intel_vgpu *);
 468         void (*vgpu_reset)(struct intel_vgpu *);
 469         void (*vgpu_activate)(struct intel_vgpu *);
 470         void (*vgpu_deactivate)(struct intel_vgpu *);
 471 };
 472
 473
 474 enum {
 475         GVT_FAILSAFE_UNSUPPORTED_GUEST,
 476         GVT_FAILSAFE_INSUFFICIENT_RESOURCE,
 477 };
 478
 479 #include "mpt.h"
 480
 481 #endif