xref: /openbmc/linux/drivers/gpu/drm/i915/gvt/opregion.c (revision fb960bd2)
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 <linux/acpi.h>
25 #include "i915_drv.h"
26 #include "gvt.h"
27 
28 /*
29  * Note: Only for GVT-g virtual VBT generation, other usage must
30  * not do like this.
31  */
32 #define _INTEL_BIOS_PRIVATE
33 #include "intel_vbt_defs.h"
34 
35 #define OPREGION_SIGNATURE "IntelGraphicsMem"
36 #define MBOX_VBT      (1<<3)
37 
38 /* device handle */
39 #define DEVICE_TYPE_CRT    0x01
40 #define DEVICE_TYPE_EFP1   0x04
41 #define DEVICE_TYPE_EFP2   0x40
42 #define DEVICE_TYPE_EFP3   0x20
43 #define DEVICE_TYPE_EFP4   0x10
44 
45 #define DEV_SIZE	38
46 
47 struct opregion_header {
48 	u8 signature[16];
49 	u32 size;
50 	u32 opregion_ver;
51 	u8 bios_ver[32];
52 	u8 vbios_ver[16];
53 	u8 driver_ver[16];
54 	u32 mboxes;
55 	u32 driver_model;
56 	u32 pcon;
57 	u8 dver[32];
58 	u8 rsvd[124];
59 } __packed;
60 
61 struct bdb_data_header {
62 	u8 id;
63 	u16 size; /* data size */
64 } __packed;
65 
66 struct efp_child_device_config {
67 	u16 handle;
68 	u16 device_type;
69 	u16 device_class;
70 	u8 i2c_speed;
71 	u8 dp_onboard_redriver; /* 158 */
72 	u8 dp_ondock_redriver; /* 158 */
73 	u8 hdmi_level_shifter_value:4; /* 169 */
74 	u8 hdmi_max_data_rate:4; /* 204 */
75 	u16 dtd_buf_ptr; /* 161 */
76 	u8 edidless_efp:1; /* 161 */
77 	u8 compression_enable:1; /* 198 */
78 	u8 compression_method:1; /* 198 */
79 	u8 ganged_edp:1; /* 202 */
80 	u8 skip0:4;
81 	u8 compression_structure_index:4; /* 198 */
82 	u8 skip1:4;
83 	u8 slave_port; /*  202 */
84 	u8 skip2;
85 	u8 dvo_port;
86 	u8 i2c_pin; /* for add-in card */
87 	u8 slave_addr; /* for add-in card */
88 	u8 ddc_pin;
89 	u16 edid_ptr;
90 	u8 dvo_config;
91 	u8 efp_docked_port:1; /* 158 */
92 	u8 lane_reversal:1; /* 184 */
93 	u8 onboard_lspcon:1; /* 192 */
94 	u8 iboost_enable:1; /* 196 */
95 	u8 hpd_invert:1; /* BXT 196 */
96 	u8 slip3:3;
97 	u8 hdmi_compat:1;
98 	u8 dp_compat:1;
99 	u8 tmds_compat:1;
100 	u8 skip4:5;
101 	u8 aux_channel;
102 	u8 dongle_detect;
103 	u8 pipe_cap:2;
104 	u8 sdvo_stall:1; /* 158 */
105 	u8 hpd_status:2;
106 	u8 integrated_encoder:1;
107 	u8 skip5:2;
108 	u8 dvo_wiring;
109 	u8 mipi_bridge_type; /* 171 */
110 	u16 device_class_ext;
111 	u8 dvo_function;
112 	u8 dp_usb_type_c:1; /* 195 */
113 	u8 skip6:7;
114 	u8 dp_usb_type_c_2x_gpio_index; /* 195 */
115 	u16 dp_usb_type_c_2x_gpio_pin; /* 195 */
116 	u8 iboost_dp:4; /* 196 */
117 	u8 iboost_hdmi:4; /* 196 */
118 } __packed;
119 
120 struct vbt {
121 	/* header->bdb_offset point to bdb_header offset */
122 	struct vbt_header header;
123 	struct bdb_header bdb_header;
124 
125 	struct bdb_data_header general_features_header;
126 	struct bdb_general_features general_features;
127 
128 	struct bdb_data_header general_definitions_header;
129 	struct bdb_general_definitions general_definitions;
130 
131 	struct efp_child_device_config child0;
132 	struct efp_child_device_config child1;
133 	struct efp_child_device_config child2;
134 	struct efp_child_device_config child3;
135 
136 	struct bdb_data_header driver_features_header;
137 	struct bdb_driver_features driver_features;
138 };
139 
140 static void virt_vbt_generation(struct vbt *v)
141 {
142 	int num_child;
143 
144 	memset(v, 0, sizeof(struct vbt));
145 
146 	v->header.signature[0] = '$';
147 	v->header.signature[1] = 'V';
148 	v->header.signature[2] = 'B';
149 	v->header.signature[3] = 'T';
150 
151 	/* there's features depending on version! */
152 	v->header.version = 155;
153 	v->header.header_size = sizeof(v->header);
154 	v->header.vbt_size = sizeof(struct vbt) - sizeof(v->header);
155 	v->header.bdb_offset = offsetof(struct vbt, bdb_header);
156 
157 	strcpy(&v->bdb_header.signature[0], "BIOS_DATA_BLOCK");
158 	v->bdb_header.version = 186; /* child_dev_size = 38 */
159 	v->bdb_header.header_size = sizeof(v->bdb_header);
160 
161 	v->bdb_header.bdb_size = sizeof(struct vbt) - sizeof(struct vbt_header)
162 		- sizeof(struct bdb_header);
163 
164 	/* general features */
165 	v->general_features_header.id = BDB_GENERAL_FEATURES;
166 	v->general_features_header.size = sizeof(struct bdb_general_features);
167 	v->general_features.int_crt_support = 0;
168 	v->general_features.int_tv_support = 0;
169 
170 	/* child device */
171 	num_child = 4; /* each port has one child */
172 	v->general_definitions_header.id = BDB_GENERAL_DEFINITIONS;
173 	/* size will include child devices */
174 	v->general_definitions_header.size =
175 		sizeof(struct bdb_general_definitions) + num_child * DEV_SIZE;
176 	v->general_definitions.child_dev_size = DEV_SIZE;
177 
178 	/* portA */
179 	v->child0.handle = DEVICE_TYPE_EFP1;
180 	v->child0.device_type = DEVICE_TYPE_DP;
181 	v->child0.dvo_port = DVO_PORT_DPA;
182 	v->child0.aux_channel = DP_AUX_A;
183 	v->child0.dp_compat = true;
184 	v->child0.integrated_encoder = true;
185 
186 	/* portB */
187 	v->child1.handle = DEVICE_TYPE_EFP2;
188 	v->child1.device_type = DEVICE_TYPE_DP;
189 	v->child1.dvo_port = DVO_PORT_DPB;
190 	v->child1.aux_channel = DP_AUX_B;
191 	v->child1.dp_compat = true;
192 	v->child1.integrated_encoder = true;
193 
194 	/* portC */
195 	v->child2.handle = DEVICE_TYPE_EFP3;
196 	v->child2.device_type = DEVICE_TYPE_DP;
197 	v->child2.dvo_port = DVO_PORT_DPC;
198 	v->child2.aux_channel = DP_AUX_C;
199 	v->child2.dp_compat = true;
200 	v->child2.integrated_encoder = true;
201 
202 	/* portD */
203 	v->child3.handle = DEVICE_TYPE_EFP4;
204 	v->child3.device_type = DEVICE_TYPE_DP;
205 	v->child3.dvo_port = DVO_PORT_DPD;
206 	v->child3.aux_channel = DP_AUX_D;
207 	v->child3.dp_compat = true;
208 	v->child3.integrated_encoder = true;
209 
210 	/* driver features */
211 	v->driver_features_header.id = BDB_DRIVER_FEATURES;
212 	v->driver_features_header.size = sizeof(struct bdb_driver_features);
213 	v->driver_features.lvds_config = BDB_DRIVER_FEATURE_NO_LVDS;
214 }
215 
216 static int alloc_and_init_virt_opregion(struct intel_vgpu *vgpu)
217 {
218 	u8 *buf;
219 	struct opregion_header *header;
220 	struct vbt v;
221 
222 	gvt_dbg_core("init vgpu%d opregion\n", vgpu->id);
223 	vgpu_opregion(vgpu)->va = (void *)__get_free_pages(GFP_KERNEL |
224 			__GFP_ZERO,
225 			get_order(INTEL_GVT_OPREGION_SIZE));
226 	if (!vgpu_opregion(vgpu)->va) {
227 		gvt_err("fail to get memory for vgpu virt opregion\n");
228 		return -ENOMEM;
229 	}
230 
231 	/* emulated opregion with VBT mailbox only */
232 	buf = (u8 *)vgpu_opregion(vgpu)->va;
233 	header = (struct opregion_header *)buf;
234 	memcpy(header->signature, OPREGION_SIGNATURE,
235 			sizeof(OPREGION_SIGNATURE));
236 	header->size = 0x8;
237 	header->opregion_ver = 0x02000000;
238 	header->mboxes = MBOX_VBT;
239 
240 	/* for unknown reason, the value in LID field is incorrect
241 	 * which block the windows guest, so workaround it by force
242 	 * setting it to "OPEN"
243 	 */
244 	buf[INTEL_GVT_OPREGION_CLID] = 0x3;
245 
246 	/* emulated vbt from virt vbt generation */
247 	virt_vbt_generation(&v);
248 	memcpy(buf + INTEL_GVT_OPREGION_VBT_OFFSET, &v, sizeof(struct vbt));
249 
250 	return 0;
251 }
252 
253 static int init_vgpu_opregion(struct intel_vgpu *vgpu, u32 gpa)
254 {
255 	int i, ret;
256 
257 	if (WARN((vgpu_opregion(vgpu)->va),
258 			"vgpu%d: opregion has been initialized already.\n",
259 			vgpu->id))
260 		return -EINVAL;
261 
262 	ret = alloc_and_init_virt_opregion(vgpu);
263 	if (ret < 0)
264 		return ret;
265 
266 	for (i = 0; i < INTEL_GVT_OPREGION_PAGES; i++)
267 		vgpu_opregion(vgpu)->gfn[i] = (gpa >> PAGE_SHIFT) + i;
268 
269 	return 0;
270 }
271 
272 static int map_vgpu_opregion(struct intel_vgpu *vgpu, bool map)
273 {
274 	u64 mfn;
275 	int i, ret;
276 
277 	for (i = 0; i < INTEL_GVT_OPREGION_PAGES; i++) {
278 		mfn = intel_gvt_hypervisor_virt_to_mfn(vgpu_opregion(vgpu)->va
279 			+ i * PAGE_SIZE);
280 		if (mfn == INTEL_GVT_INVALID_ADDR) {
281 			gvt_vgpu_err("fail to get MFN from VA\n");
282 			return -EINVAL;
283 		}
284 		ret = intel_gvt_hypervisor_map_gfn_to_mfn(vgpu,
285 				vgpu_opregion(vgpu)->gfn[i],
286 				mfn, 1, map);
287 		if (ret) {
288 			gvt_vgpu_err("fail to map GFN to MFN, errno: %d\n",
289 				ret);
290 			return ret;
291 		}
292 	}
293 	return 0;
294 }
295 
296 /**
297  * intel_vgpu_clean_opregion - clean the stuff used to emulate opregion
298  * @vgpu: a vGPU
299  *
300  */
301 void intel_vgpu_clean_opregion(struct intel_vgpu *vgpu)
302 {
303 	gvt_dbg_core("vgpu%d: clean vgpu opregion\n", vgpu->id);
304 
305 	if (!vgpu_opregion(vgpu)->va)
306 		return;
307 
308 	if (intel_gvt_host.hypervisor_type == INTEL_GVT_HYPERVISOR_XEN) {
309 		map_vgpu_opregion(vgpu, false);
310 		free_pages((unsigned long)vgpu_opregion(vgpu)->va,
311 				get_order(INTEL_GVT_OPREGION_SIZE));
312 
313 		vgpu_opregion(vgpu)->va = NULL;
314 	}
315 }
316 
317 /**
318  * intel_vgpu_init_opregion - initialize the stuff used to emulate opregion
319  * @vgpu: a vGPU
320  * @gpa: guest physical address of opregion
321  *
322  * Returns:
323  * Zero on success, negative error code if failed.
324  */
325 int intel_vgpu_init_opregion(struct intel_vgpu *vgpu, u32 gpa)
326 {
327 	int ret;
328 
329 	gvt_dbg_core("vgpu%d: init vgpu opregion\n", vgpu->id);
330 
331 	if (intel_gvt_host.hypervisor_type == INTEL_GVT_HYPERVISOR_XEN) {
332 		gvt_dbg_core("emulate opregion from kernel\n");
333 
334 		ret = init_vgpu_opregion(vgpu, gpa);
335 		if (ret)
336 			return ret;
337 
338 		ret = map_vgpu_opregion(vgpu, true);
339 		if (ret)
340 			return ret;
341 	}
342 
343 	return 0;
344 }
345 
346 #define GVT_OPREGION_FUNC(scic)					\
347 	({							\
348 	 u32 __ret;						\
349 	 __ret = (scic & OPREGION_SCIC_FUNC_MASK) >>		\
350 	 OPREGION_SCIC_FUNC_SHIFT;				\
351 	 __ret;							\
352 	 })
353 
354 #define GVT_OPREGION_SUBFUNC(scic)				\
355 	({							\
356 	 u32 __ret;						\
357 	 __ret = (scic & OPREGION_SCIC_SUBFUNC_MASK) >>		\
358 	 OPREGION_SCIC_SUBFUNC_SHIFT;				\
359 	 __ret;							\
360 	 })
361 
362 static const char *opregion_func_name(u32 func)
363 {
364 	const char *name = NULL;
365 
366 	switch (func) {
367 	case 0 ... 3:
368 	case 5:
369 	case 7 ... 15:
370 		name = "Reserved";
371 		break;
372 
373 	case 4:
374 		name = "Get BIOS Data";
375 		break;
376 
377 	case 6:
378 		name = "System BIOS Callbacks";
379 		break;
380 
381 	default:
382 		name = "Unknown";
383 		break;
384 	}
385 	return name;
386 }
387 
388 static const char *opregion_subfunc_name(u32 subfunc)
389 {
390 	const char *name = NULL;
391 
392 	switch (subfunc) {
393 	case 0:
394 		name = "Supported Calls";
395 		break;
396 
397 	case 1:
398 		name = "Requested Callbacks";
399 		break;
400 
401 	case 2 ... 3:
402 	case 8 ... 9:
403 		name = "Reserved";
404 		break;
405 
406 	case 5:
407 		name = "Boot Display";
408 		break;
409 
410 	case 6:
411 		name = "TV-Standard/Video-Connector";
412 		break;
413 
414 	case 7:
415 		name = "Internal Graphics";
416 		break;
417 
418 	case 10:
419 		name = "Spread Spectrum Clocks";
420 		break;
421 
422 	case 11:
423 		name = "Get AKSV";
424 		break;
425 
426 	default:
427 		name = "Unknown";
428 		break;
429 	}
430 	return name;
431 };
432 
433 static bool querying_capabilities(u32 scic)
434 {
435 	u32 func, subfunc;
436 
437 	func = GVT_OPREGION_FUNC(scic);
438 	subfunc = GVT_OPREGION_SUBFUNC(scic);
439 
440 	if ((func == INTEL_GVT_OPREGION_SCIC_F_GETBIOSDATA &&
441 		subfunc == INTEL_GVT_OPREGION_SCIC_SF_SUPPRTEDCALLS)
442 		|| (func == INTEL_GVT_OPREGION_SCIC_F_GETBIOSDATA &&
443 		 subfunc == INTEL_GVT_OPREGION_SCIC_SF_REQEUSTEDCALLBACKS)
444 		|| (func == INTEL_GVT_OPREGION_SCIC_F_GETBIOSCALLBACKS &&
445 		 subfunc == INTEL_GVT_OPREGION_SCIC_SF_SUPPRTEDCALLS)) {
446 		return true;
447 	}
448 	return false;
449 }
450 
451 /**
452  * intel_vgpu_emulate_opregion_request - emulating OpRegion request
453  * @vgpu: a vGPU
454  * @swsci: SWSCI request
455  *
456  * Returns:
457  * Zero on success, negative error code if failed
458  */
459 int intel_vgpu_emulate_opregion_request(struct intel_vgpu *vgpu, u32 swsci)
460 {
461 	u32 *scic, *parm;
462 	u32 func, subfunc;
463 
464 	scic = vgpu_opregion(vgpu)->va + INTEL_GVT_OPREGION_SCIC;
465 	parm = vgpu_opregion(vgpu)->va + INTEL_GVT_OPREGION_PARM;
466 
467 	if (!(swsci & SWSCI_SCI_SELECT)) {
468 		gvt_vgpu_err("requesting SMI service\n");
469 		return 0;
470 	}
471 	/* ignore non 0->1 trasitions */
472 	if ((vgpu_cfg_space(vgpu)[INTEL_GVT_PCI_SWSCI]
473 				& SWSCI_SCI_TRIGGER) ||
474 			!(swsci & SWSCI_SCI_TRIGGER)) {
475 		return 0;
476 	}
477 
478 	func = GVT_OPREGION_FUNC(*scic);
479 	subfunc = GVT_OPREGION_SUBFUNC(*scic);
480 	if (!querying_capabilities(*scic)) {
481 		gvt_vgpu_err("requesting runtime service: func \"%s\","
482 				" subfunc \"%s\"\n",
483 				opregion_func_name(func),
484 				opregion_subfunc_name(subfunc));
485 		/*
486 		 * emulate exit status of function call, '0' means
487 		 * "failure, generic, unsupported or unknown cause"
488 		 */
489 		*scic &= ~OPREGION_SCIC_EXIT_MASK;
490 		return 0;
491 	}
492 
493 	*scic = 0;
494 	*parm = 0;
495 	return 0;
496 }
497