Merge tag 'gvt-next-2017-12-14' of https://github.com/intel/gvt-linux into drm-intel...
[sfrench/cifs-2.6.git] / drivers / gpu / drm / i915 / gvt / gvt.c
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 #include <linux/types.h>
34 #include <xen/xen.h>
35 #include <linux/kthread.h>
36
37 #include "i915_drv.h"
38 #include "gvt.h"
39 #include <linux/vfio.h>
40 #include <linux/mdev.h>
41
42 struct intel_gvt_host intel_gvt_host;
43
44 static const char * const supported_hypervisors[] = {
45         [INTEL_GVT_HYPERVISOR_XEN] = "XEN",
46         [INTEL_GVT_HYPERVISOR_KVM] = "KVM",
47 };
48
49 static struct intel_vgpu_type *intel_gvt_find_vgpu_type(struct intel_gvt *gvt,
50                 const char *name)
51 {
52         int i;
53         struct intel_vgpu_type *t;
54         const char *driver_name = dev_driver_string(
55                         &gvt->dev_priv->drm.pdev->dev);
56
57         for (i = 0; i < gvt->num_types; i++) {
58                 t = &gvt->types[i];
59                 if (!strncmp(t->name, name + strlen(driver_name) + 1,
60                         sizeof(t->name)))
61                         return t;
62         }
63
64         return NULL;
65 }
66
67 static ssize_t available_instances_show(struct kobject *kobj,
68                                         struct device *dev, char *buf)
69 {
70         struct intel_vgpu_type *type;
71         unsigned int num = 0;
72         void *gvt = kdev_to_i915(dev)->gvt;
73
74         type = intel_gvt_find_vgpu_type(gvt, kobject_name(kobj));
75         if (!type)
76                 num = 0;
77         else
78                 num = type->avail_instance;
79
80         return sprintf(buf, "%u\n", num);
81 }
82
83 static ssize_t device_api_show(struct kobject *kobj, struct device *dev,
84                 char *buf)
85 {
86         return sprintf(buf, "%s\n", VFIO_DEVICE_API_PCI_STRING);
87 }
88
89 static ssize_t description_show(struct kobject *kobj, struct device *dev,
90                 char *buf)
91 {
92         struct intel_vgpu_type *type;
93         void *gvt = kdev_to_i915(dev)->gvt;
94
95         type = intel_gvt_find_vgpu_type(gvt, kobject_name(kobj));
96         if (!type)
97                 return 0;
98
99         return sprintf(buf, "low_gm_size: %dMB\nhigh_gm_size: %dMB\n"
100                        "fence: %d\nresolution: %s\n"
101                        "weight: %d\n",
102                        BYTES_TO_MB(type->low_gm_size),
103                        BYTES_TO_MB(type->high_gm_size),
104                        type->fence, vgpu_edid_str(type->resolution),
105                        type->weight);
106 }
107
108 static MDEV_TYPE_ATTR_RO(available_instances);
109 static MDEV_TYPE_ATTR_RO(device_api);
110 static MDEV_TYPE_ATTR_RO(description);
111
112 static struct attribute *gvt_type_attrs[] = {
113         &mdev_type_attr_available_instances.attr,
114         &mdev_type_attr_device_api.attr,
115         &mdev_type_attr_description.attr,
116         NULL,
117 };
118
119 static struct attribute_group *gvt_vgpu_type_groups[] = {
120         [0 ... NR_MAX_INTEL_VGPU_TYPES - 1] = NULL,
121 };
122
123 static bool intel_get_gvt_attrs(struct attribute ***type_attrs,
124                 struct attribute_group ***intel_vgpu_type_groups)
125 {
126         *type_attrs = gvt_type_attrs;
127         *intel_vgpu_type_groups = gvt_vgpu_type_groups;
128         return true;
129 }
130
131 static bool intel_gvt_init_vgpu_type_groups(struct intel_gvt *gvt)
132 {
133         int i, j;
134         struct intel_vgpu_type *type;
135         struct attribute_group *group;
136
137         for (i = 0; i < gvt->num_types; i++) {
138                 type = &gvt->types[i];
139
140                 group = kzalloc(sizeof(struct attribute_group), GFP_KERNEL);
141                 if (WARN_ON(!group))
142                         goto unwind;
143
144                 group->name = type->name;
145                 group->attrs = gvt_type_attrs;
146                 gvt_vgpu_type_groups[i] = group;
147         }
148
149         return true;
150
151 unwind:
152         for (j = 0; j < i; j++) {
153                 group = gvt_vgpu_type_groups[j];
154                 kfree(group);
155         }
156
157         return false;
158 }
159
160 static void intel_gvt_cleanup_vgpu_type_groups(struct intel_gvt *gvt)
161 {
162         int i;
163         struct attribute_group *group;
164
165         for (i = 0; i < gvt->num_types; i++) {
166                 group = gvt_vgpu_type_groups[i];
167                 gvt_vgpu_type_groups[i] = NULL;
168                 kfree(group);
169         }
170 }
171
172 static const struct intel_gvt_ops intel_gvt_ops = {
173         .emulate_cfg_read = intel_vgpu_emulate_cfg_read,
174         .emulate_cfg_write = intel_vgpu_emulate_cfg_write,
175         .emulate_mmio_read = intel_vgpu_emulate_mmio_read,
176         .emulate_mmio_write = intel_vgpu_emulate_mmio_write,
177         .vgpu_create = intel_gvt_create_vgpu,
178         .vgpu_destroy = intel_gvt_destroy_vgpu,
179         .vgpu_reset = intel_gvt_reset_vgpu,
180         .vgpu_activate = intel_gvt_activate_vgpu,
181         .vgpu_deactivate = intel_gvt_deactivate_vgpu,
182         .gvt_find_vgpu_type = intel_gvt_find_vgpu_type,
183         .get_gvt_attrs = intel_get_gvt_attrs,
184         .vgpu_query_plane = intel_vgpu_query_plane,
185         .vgpu_get_dmabuf = intel_vgpu_get_dmabuf,
186 };
187
188 /**
189  * intel_gvt_init_host - Load MPT modules and detect if we're running in host
190  * @gvt: intel gvt device
191  *
192  * This function is called at the driver loading stage. If failed to find a
193  * loadable MPT module or detect currently we're running in a VM, then GVT-g
194  * will be disabled
195  *
196  * Returns:
197  * Zero on success, negative error code if failed.
198  *
199  */
200 int intel_gvt_init_host(void)
201 {
202         if (intel_gvt_host.initialized)
203                 return 0;
204
205         /* Xen DOM U */
206         if (xen_domain() && !xen_initial_domain())
207                 return -ENODEV;
208
209         /* Try to load MPT modules for hypervisors */
210         if (xen_initial_domain()) {
211                 /* In Xen dom0 */
212                 intel_gvt_host.mpt = try_then_request_module(
213                                 symbol_get(xengt_mpt), "xengt");
214                 intel_gvt_host.hypervisor_type = INTEL_GVT_HYPERVISOR_XEN;
215         } else {
216 #if IS_ENABLED(CONFIG_DRM_I915_GVT_KVMGT)
217                 /* not in Xen. Try KVMGT */
218                 intel_gvt_host.mpt = try_then_request_module(
219                                 symbol_get(kvmgt_mpt), "kvmgt");
220                 intel_gvt_host.hypervisor_type = INTEL_GVT_HYPERVISOR_KVM;
221 #endif
222         }
223
224         /* Fail to load MPT modules - bail out */
225         if (!intel_gvt_host.mpt)
226                 return -EINVAL;
227
228         gvt_dbg_core("Running with hypervisor %s in host mode\n",
229                         supported_hypervisors[intel_gvt_host.hypervisor_type]);
230
231         intel_gvt_host.initialized = true;
232         return 0;
233 }
234
235 static void init_device_info(struct intel_gvt *gvt)
236 {
237         struct intel_gvt_device_info *info = &gvt->device_info;
238         struct pci_dev *pdev = gvt->dev_priv->drm.pdev;
239
240         if (IS_BROADWELL(gvt->dev_priv) || IS_SKYLAKE(gvt->dev_priv)
241                 || IS_KABYLAKE(gvt->dev_priv)) {
242                 info->max_support_vgpus = 8;
243                 info->cfg_space_size = PCI_CFG_SPACE_EXP_SIZE;
244                 info->mmio_size = 2 * 1024 * 1024;
245                 info->mmio_bar = 0;
246                 info->gtt_start_offset = 8 * 1024 * 1024;
247                 info->gtt_entry_size = 8;
248                 info->gtt_entry_size_shift = 3;
249                 info->gmadr_bytes_in_cmd = 8;
250                 info->max_surface_size = 36 * 1024 * 1024;
251         }
252         info->msi_cap_offset = pdev->msi_cap;
253 }
254
255 static int gvt_service_thread(void *data)
256 {
257         struct intel_gvt *gvt = (struct intel_gvt *)data;
258         int ret;
259
260         gvt_dbg_core("service thread start\n");
261
262         while (!kthread_should_stop()) {
263                 ret = wait_event_interruptible(gvt->service_thread_wq,
264                                 kthread_should_stop() || gvt->service_request);
265
266                 if (kthread_should_stop())
267                         break;
268
269                 if (WARN_ONCE(ret, "service thread is waken up by signal.\n"))
270                         continue;
271
272                 if (test_and_clear_bit(INTEL_GVT_REQUEST_EMULATE_VBLANK,
273                                         (void *)&gvt->service_request)) {
274                         mutex_lock(&gvt->lock);
275                         intel_gvt_emulate_vblank(gvt);
276                         mutex_unlock(&gvt->lock);
277                 }
278
279                 if (test_bit(INTEL_GVT_REQUEST_SCHED,
280                                 (void *)&gvt->service_request) ||
281                         test_bit(INTEL_GVT_REQUEST_EVENT_SCHED,
282                                         (void *)&gvt->service_request)) {
283                         intel_gvt_schedule(gvt);
284                 }
285         }
286
287         return 0;
288 }
289
290 static void clean_service_thread(struct intel_gvt *gvt)
291 {
292         kthread_stop(gvt->service_thread);
293 }
294
295 static int init_service_thread(struct intel_gvt *gvt)
296 {
297         init_waitqueue_head(&gvt->service_thread_wq);
298
299         gvt->service_thread = kthread_run(gvt_service_thread,
300                         gvt, "gvt_service_thread");
301         if (IS_ERR(gvt->service_thread)) {
302                 gvt_err("fail to start service thread.\n");
303                 return PTR_ERR(gvt->service_thread);
304         }
305         return 0;
306 }
307
308 /**
309  * intel_gvt_clean_device - clean a GVT device
310  * @gvt: intel gvt device
311  *
312  * This function is called at the driver unloading stage, to free the
313  * resources owned by a GVT device.
314  *
315  */
316 void intel_gvt_clean_device(struct drm_i915_private *dev_priv)
317 {
318         struct intel_gvt *gvt = to_gvt(dev_priv);
319
320         if (WARN_ON(!gvt))
321                 return;
322
323         intel_gvt_debugfs_clean(gvt);
324         clean_service_thread(gvt);
325         intel_gvt_clean_cmd_parser(gvt);
326         intel_gvt_clean_sched_policy(gvt);
327         intel_gvt_clean_workload_scheduler(gvt);
328         intel_gvt_clean_gtt(gvt);
329         intel_gvt_clean_irq(gvt);
330         intel_gvt_clean_mmio_info(gvt);
331         intel_gvt_free_firmware(gvt);
332
333         intel_gvt_hypervisor_host_exit(&dev_priv->drm.pdev->dev, gvt);
334         intel_gvt_cleanup_vgpu_type_groups(gvt);
335         intel_gvt_clean_vgpu_types(gvt);
336
337         idr_destroy(&gvt->vgpu_idr);
338
339         intel_gvt_destroy_idle_vgpu(gvt->idle_vgpu);
340
341         kfree(dev_priv->gvt);
342         dev_priv->gvt = NULL;
343 }
344
345 /**
346  * intel_gvt_init_device - initialize a GVT device
347  * @dev_priv: drm i915 private data
348  *
349  * This function is called at the initialization stage, to initialize
350  * necessary GVT components.
351  *
352  * Returns:
353  * Zero on success, negative error code if failed.
354  *
355  */
356 int intel_gvt_init_device(struct drm_i915_private *dev_priv)
357 {
358         struct intel_gvt *gvt;
359         struct intel_vgpu *vgpu;
360         int ret;
361
362         /*
363          * Cannot initialize GVT device without intel_gvt_host gets
364          * initialized first.
365          */
366         if (WARN_ON(!intel_gvt_host.initialized))
367                 return -EINVAL;
368
369         if (WARN_ON(dev_priv->gvt))
370                 return -EEXIST;
371
372         gvt = kzalloc(sizeof(struct intel_gvt), GFP_KERNEL);
373         if (!gvt)
374                 return -ENOMEM;
375
376         gvt_dbg_core("init gvt device\n");
377
378         idr_init(&gvt->vgpu_idr);
379         spin_lock_init(&gvt->scheduler.mmio_context_lock);
380         mutex_init(&gvt->lock);
381         gvt->dev_priv = dev_priv;
382
383         init_device_info(gvt);
384
385         ret = intel_gvt_setup_mmio_info(gvt);
386         if (ret)
387                 goto out_clean_idr;
388
389         intel_gvt_init_engine_mmio_context(gvt);
390
391         ret = intel_gvt_load_firmware(gvt);
392         if (ret)
393                 goto out_clean_mmio_info;
394
395         ret = intel_gvt_init_irq(gvt);
396         if (ret)
397                 goto out_free_firmware;
398
399         ret = intel_gvt_init_gtt(gvt);
400         if (ret)
401                 goto out_clean_irq;
402
403         ret = intel_gvt_init_workload_scheduler(gvt);
404         if (ret)
405                 goto out_clean_gtt;
406
407         ret = intel_gvt_init_sched_policy(gvt);
408         if (ret)
409                 goto out_clean_workload_scheduler;
410
411         ret = intel_gvt_init_cmd_parser(gvt);
412         if (ret)
413                 goto out_clean_sched_policy;
414
415         ret = init_service_thread(gvt);
416         if (ret)
417                 goto out_clean_cmd_parser;
418
419         ret = intel_gvt_init_vgpu_types(gvt);
420         if (ret)
421                 goto out_clean_thread;
422
423         ret = intel_gvt_init_vgpu_type_groups(gvt);
424         if (ret == false) {
425                 gvt_err("failed to init vgpu type groups: %d\n", ret);
426                 goto out_clean_types;
427         }
428
429         ret = intel_gvt_hypervisor_host_init(&dev_priv->drm.pdev->dev, gvt,
430                                 &intel_gvt_ops);
431         if (ret) {
432                 gvt_err("failed to register gvt-g host device: %d\n", ret);
433                 goto out_clean_types;
434         }
435
436         vgpu = intel_gvt_create_idle_vgpu(gvt);
437         if (IS_ERR(vgpu)) {
438                 ret = PTR_ERR(vgpu);
439                 gvt_err("failed to create idle vgpu\n");
440                 goto out_clean_types;
441         }
442         gvt->idle_vgpu = vgpu;
443
444         ret = intel_gvt_debugfs_init(gvt);
445         if (ret)
446                 gvt_err("debugfs registeration failed, go on.\n");
447
448         gvt_dbg_core("gvt device initialization is done\n");
449         dev_priv->gvt = gvt;
450         return 0;
451
452 out_clean_types:
453         intel_gvt_clean_vgpu_types(gvt);
454 out_clean_thread:
455         clean_service_thread(gvt);
456 out_clean_cmd_parser:
457         intel_gvt_clean_cmd_parser(gvt);
458 out_clean_sched_policy:
459         intel_gvt_clean_sched_policy(gvt);
460 out_clean_workload_scheduler:
461         intel_gvt_clean_workload_scheduler(gvt);
462 out_clean_gtt:
463         intel_gvt_clean_gtt(gvt);
464 out_clean_irq:
465         intel_gvt_clean_irq(gvt);
466 out_free_firmware:
467         intel_gvt_free_firmware(gvt);
468 out_clean_mmio_info:
469         intel_gvt_clean_mmio_info(gvt);
470 out_clean_idr:
471         idr_destroy(&gvt->vgpu_idr);
472         kfree(gvt);
473         return ret;
474 }