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