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
 24#include "i915_drv.h"
 25#include "i915_vgpu.h"
 26#include "intel_gvt.h"
 27
 28/**
 29 * DOC: Intel GVT-g host support
 30 *
 31 * Intel GVT-g is a graphics virtualization technology which shares the
 32 * GPU among multiple virtual machines on a time-sharing basis. Each
 33 * virtual machine is presented a virtual GPU (vGPU), which has equivalent
 34 * features as the underlying physical GPU (pGPU), so i915 driver can run
 35 * seamlessly in a virtual machine.
 36 *
 37 * To virtualize GPU resources GVT-g driver depends on hypervisor technology
 38 * e.g KVM/VFIO/mdev, Xen, etc. to provide resource access trapping capability
 39 * and be virtualized within GVT-g device module. More architectural design
 40 * doc is available on https://01.org/group/2230/documentation-list.
 41 */
 42
 43static bool is_supported_device(struct drm_i915_private *dev_priv)
 44{
 45	if (IS_BROADWELL(dev_priv))
 46		return true;
 47	if (IS_SKYLAKE(dev_priv))
 48		return true;
 49	if (IS_KABYLAKE(dev_priv))
 50		return true;
 51	if (IS_BROXTON(dev_priv))
 52		return true;
 53	if (IS_COFFEELAKE(dev_priv))
 54		return true;
 55	if (IS_COMETLAKE(dev_priv))
 56		return true;
 57
 58	return false;
 59}
 60
 61/**
 62 * intel_gvt_sanitize_options - sanitize GVT related options
 63 * @dev_priv: drm i915 private data
 64 *
 65 * This function is called at the i915 options sanitize stage.
 66 */
 67void intel_gvt_sanitize_options(struct drm_i915_private *dev_priv)
 68{
 69	if (!dev_priv->params.enable_gvt)
 70		return;
 71
 72	if (intel_vgpu_active(dev_priv)) {
 73		drm_info(&dev_priv->drm, "GVT-g is disabled for guest\n");
 74		goto bail;
 75	}
 76
 77	if (!is_supported_device(dev_priv)) {
 78		drm_info(&dev_priv->drm,
 79			 "Unsupported device. GVT-g is disabled\n");
 80		goto bail;
 81	}
 82
 83	return;
 84bail:
 85	dev_priv->params.enable_gvt = 0;
 86}
 87
 88/**
 89 * intel_gvt_init - initialize GVT components
 90 * @dev_priv: drm i915 private data
 91 *
 92 * This function is called at the initialization stage to create a GVT device.
 93 *
 94 * Returns:
 95 * Zero on success, negative error code if failed.
 96 *
 97 */
 98int intel_gvt_init(struct drm_i915_private *dev_priv)
 99{
100	int ret;
101
102	if (i915_inject_probe_failure(dev_priv))
103		return -ENODEV;
104
105	if (!dev_priv->params.enable_gvt) {
106		drm_dbg(&dev_priv->drm,
107			"GVT-g is disabled by kernel params\n");
108		return 0;
109	}
110
111	if (intel_uc_wants_guc_submission(&dev_priv->gt.uc)) {
112		drm_err(&dev_priv->drm,
113			"i915 GVT-g loading failed due to Graphics virtualization is not yet supported with GuC submission\n");
114		return -EIO;
115	}
116
117	ret = intel_gvt_init_device(dev_priv);
118	if (ret) {
119		drm_dbg(&dev_priv->drm, "Fail to init GVT device\n");
120		goto bail;
121	}
122
123	return 0;
124
125bail:
126	dev_priv->params.enable_gvt = 0;
127	return 0;
128}
129
130static inline bool intel_gvt_active(struct drm_i915_private *dev_priv)
131{
132	return dev_priv->gvt;
133}
134
135/**
136 * intel_gvt_driver_remove - cleanup GVT components when i915 driver is
137 *			     unbinding
138 * @dev_priv: drm i915 private *
139 *
140 * This function is called at the i915 driver unloading stage, to shutdown
141 * GVT components and release the related resources.
142 */
143void intel_gvt_driver_remove(struct drm_i915_private *dev_priv)
144{
145	if (!intel_gvt_active(dev_priv))
146		return;
147
148	intel_gvt_clean_device(dev_priv);
149}