drivers/gpu/drm/i915/gvt/gtt.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  *    Zhi Wang <[email protected]>
  25  *    Zhenyu Wang <[email protected]>
  26  *    Xiao Zheng <[email protected]>
  27  *
  28  * Contributors:
  29  *    Min He <[email protected]>
  30  *    Bing Niu <[email protected]>
  31  *
  32  */
  33
  34 #ifndef _GVT_GTT_H_
  35 #define _GVT_GTT_H_
  36
  37 #define I915_GTT_PAGE_SHIFT         12
  38 #define I915_GTT_PAGE_MASK              (~(I915_GTT_PAGE_SIZE - 1))
  39
  40 struct intel_vgpu_mm;
  41
  42 #define INTEL_GVT_INVALID_ADDR (~0UL)
  43
  44 struct intel_gvt_gtt_entry {
  45         u64 val64;
  46         int type;
  47 };
  48
  49 struct intel_gvt_gtt_pte_ops {
  50         int (*get_entry)(void *pt,
  51                          struct intel_gvt_gtt_entry *e,
  52                          unsigned long index,
  53                          bool hypervisor_access,
  54                          unsigned long gpa,
  55                          struct intel_vgpu *vgpu);
  56         int (*set_entry)(void *pt,
  57                          struct intel_gvt_gtt_entry *e,
  58                          unsigned long index,
  59                          bool hypervisor_access,
  60                          unsigned long gpa,
  61                          struct intel_vgpu *vgpu);
  62         bool (*test_present)(struct intel_gvt_gtt_entry *e);
  63         void (*clear_present)(struct intel_gvt_gtt_entry *e);
  64         void (*set_present)(struct intel_gvt_gtt_entry *e);
  65         bool (*test_pse)(struct intel_gvt_gtt_entry *e);
  66         void (*clear_pse)(struct intel_gvt_gtt_entry *e);
  67         bool (*test_ips)(struct intel_gvt_gtt_entry *e);
  68         void (*clear_ips)(struct intel_gvt_gtt_entry *e);
  69         bool (*test_64k_splited)(struct intel_gvt_gtt_entry *e);
  70         void (*clear_64k_splited)(struct intel_gvt_gtt_entry *e);
  71         void (*set_64k_splited)(struct intel_gvt_gtt_entry *e);
  72         void (*set_pfn)(struct intel_gvt_gtt_entry *e, unsigned long pfn);
  73         unsigned long (*get_pfn)(struct intel_gvt_gtt_entry *e);
  74 };
  75
  76 struct intel_gvt_gtt_gma_ops {
  77         unsigned long (*gma_to_ggtt_pte_index)(unsigned long gma);
  78         unsigned long (*gma_to_pte_index)(unsigned long gma);
  79         unsigned long (*gma_to_pde_index)(unsigned long gma);
  80         unsigned long (*gma_to_l3_pdp_index)(unsigned long gma);
  81         unsigned long (*gma_to_l4_pdp_index)(unsigned long gma);
  82         unsigned long (*gma_to_pml4_index)(unsigned long gma);
  83 };
  84
  85 struct intel_gvt_gtt {
  86         struct intel_gvt_gtt_pte_ops *pte_ops;
  87         struct intel_gvt_gtt_gma_ops *gma_ops;
  88         int (*mm_alloc_page_table)(struct intel_vgpu_mm *mm);
  89         void (*mm_free_page_table)(struct intel_vgpu_mm *mm);
  90         struct list_head oos_page_use_list_head;
  91         struct list_head oos_page_free_list_head;
  92         struct list_head ppgtt_mm_lru_list_head;
  93
  94         struct page *scratch_page;
  95         unsigned long scratch_mfn;
  96 };
  97
  98 typedef enum {
  99         GTT_TYPE_INVALID = -1,
 100
 101         GTT_TYPE_GGTT_PTE,
 102
 103         GTT_TYPE_PPGTT_PTE_4K_ENTRY,
 104         GTT_TYPE_PPGTT_PTE_64K_ENTRY,
 105         GTT_TYPE_PPGTT_PTE_2M_ENTRY,
 106         GTT_TYPE_PPGTT_PTE_1G_ENTRY,
 107
 108         GTT_TYPE_PPGTT_PTE_ENTRY,
 109
 110         GTT_TYPE_PPGTT_PDE_ENTRY,
 111         GTT_TYPE_PPGTT_PDP_ENTRY,
 112         GTT_TYPE_PPGTT_PML4_ENTRY,
 113
 114         GTT_TYPE_PPGTT_ROOT_ENTRY,
 115
 116         GTT_TYPE_PPGTT_ROOT_L3_ENTRY,
 117         GTT_TYPE_PPGTT_ROOT_L4_ENTRY,
 118
 119         GTT_TYPE_PPGTT_ENTRY,
 120
 121         GTT_TYPE_PPGTT_PTE_PT,
 122         GTT_TYPE_PPGTT_PDE_PT,
 123         GTT_TYPE_PPGTT_PDP_PT,
 124         GTT_TYPE_PPGTT_PML4_PT,
 125
 126         GTT_TYPE_MAX,
 127 } intel_gvt_gtt_type_t;
 128
 129 enum intel_gvt_mm_type {
 130         INTEL_GVT_MM_GGTT,
 131         INTEL_GVT_MM_PPGTT,
 132 };
 133
 134 #define GVT_RING_CTX_NR_PDPS    GEN8_3LVL_PDPES
 135
 136 struct intel_vgpu_mm {
 137         enum intel_gvt_mm_type type;
 138         struct intel_vgpu *vgpu;
 139
 140         struct kref ref;
 141         atomic_t pincount;
 142
 143         union {
 144                 struct {
 145                         intel_gvt_gtt_type_t root_entry_type;
 146                         /*
 147                          * The 4 PDPs in ring context. For 48bit addressing,
 148                          * only PDP0 is valid and point to PML4. For 32it
 149                          * addressing, all 4 are used as true PDPs.
 150                          */
 151                         u64 guest_pdps[GVT_RING_CTX_NR_PDPS];
 152                         u64 shadow_pdps[GVT_RING_CTX_NR_PDPS];
 153                         bool shadowed;
 154
 155                         struct list_head list;
 156                         struct list_head lru_list;
 157                 } ppgtt_mm;
 158                 struct {
 159                         void *virtual_ggtt;
 160                 } ggtt_mm;
 161         };
 162 };
 163
 164 struct intel_vgpu_mm *intel_vgpu_create_ppgtt_mm(struct intel_vgpu *vgpu,
 165                 intel_gvt_gtt_type_t root_entry_type, u64 pdps[]);
 166
 167 static inline void intel_vgpu_mm_get(struct intel_vgpu_mm *mm)
 168 {
 169         kref_get(&mm->ref);
 170 }
 171
 172 void _intel_vgpu_mm_release(struct kref *mm_ref);
 173
 174 static inline void intel_vgpu_mm_put(struct intel_vgpu_mm *mm)
 175 {
 176         kref_put(&mm->ref, _intel_vgpu_mm_release);
 177 }
 178
 179 static inline void intel_vgpu_destroy_mm(struct intel_vgpu_mm *mm)
 180 {
 181         intel_vgpu_mm_put(mm);
 182 }
 183
 184 struct intel_vgpu_guest_page;
 185
 186 struct intel_vgpu_scratch_pt {
 187         struct page *page;
 188         unsigned long page_mfn;
 189 };
 190
 191 struct intel_vgpu_gtt {
 192         struct intel_vgpu_mm *ggtt_mm;
 193         unsigned long active_ppgtt_mm_bitmap;
 194         struct list_head ppgtt_mm_list_head;
 195         struct radix_tree_root spt_tree;
 196         struct list_head oos_page_list_head;
 197         struct list_head post_shadow_list_head;
 198         struct intel_vgpu_scratch_pt scratch_pt[GTT_TYPE_MAX];
 199 };
 200
 201 extern int intel_vgpu_init_gtt(struct intel_vgpu *vgpu);
 202 extern void intel_vgpu_clean_gtt(struct intel_vgpu *vgpu);
 203 void intel_vgpu_reset_ggtt(struct intel_vgpu *vgpu, bool invalidate_old);
 204 void intel_vgpu_invalidate_ppgtt(struct intel_vgpu *vgpu);
 205
 206 extern int intel_gvt_init_gtt(struct intel_gvt *gvt);
 207 void intel_vgpu_reset_gtt(struct intel_vgpu *vgpu);
 208 extern void intel_gvt_clean_gtt(struct intel_gvt *gvt);
 209
 210 extern struct intel_vgpu_mm *intel_gvt_find_ppgtt_mm(struct intel_vgpu *vgpu,
 211                 int page_table_level, void *root_entry);
 212
 213 struct intel_vgpu_oos_page {
 214         struct intel_vgpu_ppgtt_spt *spt;
 215         struct list_head list;
 216         struct list_head vm_list;
 217         int id;
 218         unsigned char mem[I915_GTT_PAGE_SIZE];
 219 };
 220
 221 #define GTT_ENTRY_NUM_IN_ONE_PAGE 512
 222
 223 /* Represent a vgpu shadow page table. */
 224 struct intel_vgpu_ppgtt_spt {
 225         atomic_t refcount;
 226         struct intel_vgpu *vgpu;
 227
 228         struct {
 229                 intel_gvt_gtt_type_t type;
 230                 bool pde_ips; /* for 64KB PTEs */
 231                 void *vaddr;
 232                 struct page *page;
 233                 unsigned long mfn;
 234         } shadow_page;
 235
 236         struct {
 237                 intel_gvt_gtt_type_t type;
 238                 bool pde_ips; /* for 64KB PTEs */
 239                 unsigned long gfn;
 240                 unsigned long write_cnt;
 241                 struct intel_vgpu_oos_page *oos_page;
 242         } guest_page;
 243
 244         DECLARE_BITMAP(post_shadow_bitmap, GTT_ENTRY_NUM_IN_ONE_PAGE);
 245         struct list_head post_shadow_list;
 246 };
 247
 248 int intel_vgpu_sync_oos_pages(struct intel_vgpu *vgpu);
 249
 250 int intel_vgpu_flush_post_shadow(struct intel_vgpu *vgpu);
 251
 252 int intel_vgpu_pin_mm(struct intel_vgpu_mm *mm);
 253
 254 void intel_vgpu_unpin_mm(struct intel_vgpu_mm *mm);
 255
 256 unsigned long intel_vgpu_gma_to_gpa(struct intel_vgpu_mm *mm,
 257                 unsigned long gma);
 258
 259 struct intel_vgpu_mm *intel_vgpu_find_ppgtt_mm(struct intel_vgpu *vgpu,
 260                 u64 pdps[]);
 261
 262 struct intel_vgpu_mm *intel_vgpu_get_ppgtt_mm(struct intel_vgpu *vgpu,
 263                 intel_gvt_gtt_type_t root_entry_type, u64 pdps[]);
 264
 265 int intel_vgpu_put_ppgtt_mm(struct intel_vgpu *vgpu, u64 pdps[]);
 266
 267 int intel_vgpu_emulate_ggtt_mmio_read(struct intel_vgpu *vgpu,
 268         unsigned int off, void *p_data, unsigned int bytes);
 269
 270 int intel_vgpu_emulate_ggtt_mmio_write(struct intel_vgpu *vgpu,
 271         unsigned int off, void *p_data, unsigned int bytes);
 272
 273 #endif /* _GVT_GTT_H_ */