xref: /dragonfly/sys/dev/drm/i915/intel_opregion.c (revision 02318f07)
1 /*
2  * Copyright 2008 Intel Corporation <hong.liu@intel.com>
3  * Copyright 2008 Red Hat <mjg@redhat.com>
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sub license, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice (including the
14  * next paragraph) shall be included in all copies or substantial
15  * portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20  * NON-INFRINGEMENT.  IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE
21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
22  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24  * SOFTWARE.
25  *
26  */
27 
28 #include <linux/dmi.h>
29 
30 #include <drm/drmP.h>
31 #include <drm/i915_drm.h>
32 #include "i915_drv.h"
33 #include "intel_drv.h"
34 
35 #include <contrib/dev/acpica/source/include/acpi.h>
36 #include <contrib/dev/acpica/source/include/accommon.h>
37 #include <dev/acpica/acpivar.h>
38 
39 #define PCI_ASLE		0xe4
40 #define PCI_ASLS		0xfc
41 #define PCI_SWSCI		0xe8
42 #define PCI_SWSCI_SCISEL	(1 << 15)
43 #define PCI_SWSCI_GSSCIE	(1 << 0)
44 
45 #define OPREGION_HEADER_OFFSET 0
46 #define OPREGION_ACPI_OFFSET   0x100
47 #define   ACPI_CLID 0x01ac /* current lid state indicator */
48 #define   ACPI_CDCK 0x01b0 /* current docking state indicator */
49 #define OPREGION_SWSCI_OFFSET  0x200
50 #define OPREGION_ASLE_OFFSET   0x300
51 #define OPREGION_VBT_OFFSET    0x400
52 #define OPREGION_ASLE_EXT_OFFSET	0x1C00
53 
54 #define OPREGION_SIGNATURE "IntelGraphicsMem"
55 #define MBOX_ACPI      (1<<0)
56 #define MBOX_SWSCI     (1<<1)
57 #define MBOX_ASLE      (1<<2)
58 #define MBOX_ASLE_EXT  (1<<4)
59 
60 struct opregion_header {
61 	u8 signature[16];
62 	u32 size;
63 	u32 opregion_ver;
64 	u8 bios_ver[32];
65 	u8 vbios_ver[16];
66 	u8 driver_ver[16];
67 	u32 mboxes;
68 	u32 driver_model;
69 	u32 pcon;
70 	u8 dver[32];
71 	u8 rsvd[124];
72 } __packed;
73 
74 /* OpRegion mailbox #1: public ACPI methods */
75 struct opregion_acpi {
76 	u32 drdy;       /* driver readiness */
77 	u32 csts;       /* notification status */
78 	u32 cevt;       /* current event */
79 	u8 rsvd1[20];
80 	u32 didl[8];    /* supported display devices ID list */
81 	u32 cpdl[8];    /* currently presented display list */
82 	u32 cadl[8];    /* currently active display list */
83 	u32 nadl[8];    /* next active devices list */
84 	u32 aslp;       /* ASL sleep time-out */
85 	u32 tidx;       /* toggle table index */
86 	u32 chpd;       /* current hotplug enable indicator */
87 	u32 clid;       /* current lid state*/
88 	u32 cdck;       /* current docking state */
89 	u32 sxsw;       /* Sx state resume */
90 	u32 evts;       /* ASL supported events */
91 	u32 cnot;       /* current OS notification */
92 	u32 nrdy;       /* driver status */
93 	u32 did2[7];	/* extended supported display devices ID list */
94 	u32 cpd2[7];	/* extended attached display devices list */
95 	u8 rsvd2[4];
96 } __packed;
97 
98 /* OpRegion mailbox #2: SWSCI */
99 struct opregion_swsci {
100 	u32 scic;       /* SWSCI command|status|data */
101 	u32 parm;       /* command parameters */
102 	u32 dslp;       /* driver sleep time-out */
103 	u8 rsvd[244];
104 } __packed;
105 
106 /* OpRegion mailbox #3: ASLE */
107 struct opregion_asle {
108 	u32 ardy;       /* driver readiness */
109 	u32 aslc;       /* ASLE interrupt command */
110 	u32 tche;       /* technology enabled indicator */
111 	u32 alsi;       /* current ALS illuminance reading */
112 	u32 bclp;       /* backlight brightness to set */
113 	u32 pfit;       /* panel fitting state */
114 	u32 cblv;       /* current brightness level */
115 	u16 bclm[20];   /* backlight level duty cycle mapping table */
116 	u32 cpfm;       /* current panel fitting mode */
117 	u32 epfm;       /* enabled panel fitting modes */
118 	u8 plut[74];    /* panel LUT and identifier */
119 	u32 pfmb;       /* PWM freq and min brightness */
120 	u32 cddv;       /* color correction default values */
121 	u32 pcft;       /* power conservation features */
122 	u32 srot;       /* supported rotation angles */
123 	u32 iuer;       /* IUER events */
124 	u64 fdss;
125 	u32 fdsp;
126 	u32 stat;
127 	u64 rvda;	/* Physical address of raw vbt data */
128 	u32 rvds;	/* Size of raw vbt data */
129 	u8 rsvd[58];
130 } __packed;
131 
132 /* OpRegion mailbox #5: ASLE ext */
133 struct opregion_asle_ext {
134 	u32 phed;	/* Panel Header */
135 	u8 bddc[256];	/* Panel EDID */
136 	u8 rsvd[764];
137 } __packed;
138 
139 /* Driver readiness indicator */
140 #define ASLE_ARDY_READY		(1 << 0)
141 #define ASLE_ARDY_NOT_READY	(0 << 0)
142 
143 /* ASLE Interrupt Command (ASLC) bits */
144 #define ASLC_SET_ALS_ILLUM		(1 << 0)
145 #define ASLC_SET_BACKLIGHT		(1 << 1)
146 #define ASLC_SET_PFIT			(1 << 2)
147 #define ASLC_SET_PWM_FREQ		(1 << 3)
148 #define ASLC_SUPPORTED_ROTATION_ANGLES	(1 << 4)
149 #define ASLC_BUTTON_ARRAY		(1 << 5)
150 #define ASLC_CONVERTIBLE_INDICATOR	(1 << 6)
151 #define ASLC_DOCKING_INDICATOR		(1 << 7)
152 #define ASLC_ISCT_STATE_CHANGE		(1 << 8)
153 #define ASLC_REQ_MSK			0x1ff
154 /* response bits */
155 #define ASLC_ALS_ILLUM_FAILED		(1 << 10)
156 #define ASLC_BACKLIGHT_FAILED		(1 << 12)
157 #define ASLC_PFIT_FAILED		(1 << 14)
158 #define ASLC_PWM_FREQ_FAILED		(1 << 16)
159 #define ASLC_ROTATION_ANGLES_FAILED	(1 << 18)
160 #define ASLC_BUTTON_ARRAY_FAILED	(1 << 20)
161 #define ASLC_CONVERTIBLE_FAILED		(1 << 22)
162 #define ASLC_DOCKING_FAILED		(1 << 24)
163 #define ASLC_ISCT_STATE_FAILED		(1 << 26)
164 
165 /* Technology enabled indicator */
166 #define ASLE_TCHE_ALS_EN	(1 << 0)
167 #define ASLE_TCHE_BLC_EN	(1 << 1)
168 #define ASLE_TCHE_PFIT_EN	(1 << 2)
169 #define ASLE_TCHE_PFMB_EN	(1 << 3)
170 
171 /* ASLE backlight brightness to set */
172 #define ASLE_BCLP_VALID                (1<<31)
173 #define ASLE_BCLP_MSK          (~(1<<31))
174 
175 /* ASLE panel fitting request */
176 #define ASLE_PFIT_VALID         (1<<31)
177 #define ASLE_PFIT_CENTER (1<<0)
178 #define ASLE_PFIT_STRETCH_TEXT (1<<1)
179 #define ASLE_PFIT_STRETCH_GFX (1<<2)
180 
181 /* PWM frequency and minimum brightness */
182 #define ASLE_PFMB_BRIGHTNESS_MASK (0xff)
183 #define ASLE_PFMB_BRIGHTNESS_VALID (1<<8)
184 #define ASLE_PFMB_PWM_MASK (0x7ffffe00)
185 #define ASLE_PFMB_PWM_VALID (1<<31)
186 
187 #define ASLE_CBLV_VALID         (1<<31)
188 
189 /* IUER */
190 #define ASLE_IUER_DOCKING		(1 << 7)
191 #define ASLE_IUER_CONVERTIBLE		(1 << 6)
192 #define ASLE_IUER_ROTATION_LOCK_BTN	(1 << 4)
193 #define ASLE_IUER_VOLUME_DOWN_BTN	(1 << 3)
194 #define ASLE_IUER_VOLUME_UP_BTN		(1 << 2)
195 #define ASLE_IUER_WINDOWS_BTN		(1 << 1)
196 #define ASLE_IUER_POWER_BTN		(1 << 0)
197 
198 /* Software System Control Interrupt (SWSCI) */
199 #define SWSCI_SCIC_INDICATOR		(1 << 0)
200 #define SWSCI_SCIC_MAIN_FUNCTION_SHIFT	1
201 #define SWSCI_SCIC_MAIN_FUNCTION_MASK	(0xf << 1)
202 #define SWSCI_SCIC_SUB_FUNCTION_SHIFT	8
203 #define SWSCI_SCIC_SUB_FUNCTION_MASK	(0xff << 8)
204 #define SWSCI_SCIC_EXIT_PARAMETER_SHIFT	8
205 #define SWSCI_SCIC_EXIT_PARAMETER_MASK	(0xff << 8)
206 #define SWSCI_SCIC_EXIT_STATUS_SHIFT	5
207 #define SWSCI_SCIC_EXIT_STATUS_MASK	(7 << 5)
208 #define SWSCI_SCIC_EXIT_STATUS_SUCCESS	1
209 
210 #define SWSCI_FUNCTION_CODE(main, sub) \
211 	((main) << SWSCI_SCIC_MAIN_FUNCTION_SHIFT | \
212 	 (sub) << SWSCI_SCIC_SUB_FUNCTION_SHIFT)
213 
214 /* SWSCI: Get BIOS Data (GBDA) */
215 #define SWSCI_GBDA			4
216 #define SWSCI_GBDA_SUPPORTED_CALLS	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 0)
217 #define SWSCI_GBDA_REQUESTED_CALLBACKS	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 1)
218 #define SWSCI_GBDA_BOOT_DISPLAY_PREF	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 4)
219 #define SWSCI_GBDA_PANEL_DETAILS	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 5)
220 #define SWSCI_GBDA_TV_STANDARD		SWSCI_FUNCTION_CODE(SWSCI_GBDA, 6)
221 #define SWSCI_GBDA_INTERNAL_GRAPHICS	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 7)
222 #define SWSCI_GBDA_SPREAD_SPECTRUM	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 10)
223 
224 /* SWSCI: System BIOS Callbacks (SBCB) */
225 #define SWSCI_SBCB			6
226 #define SWSCI_SBCB_SUPPORTED_CALLBACKS	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 0)
227 #define SWSCI_SBCB_INIT_COMPLETION	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 1)
228 #define SWSCI_SBCB_PRE_HIRES_SET_MODE	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 3)
229 #define SWSCI_SBCB_POST_HIRES_SET_MODE	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 4)
230 #define SWSCI_SBCB_DISPLAY_SWITCH	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 5)
231 #define SWSCI_SBCB_SET_TV_FORMAT	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 6)
232 #define SWSCI_SBCB_ADAPTER_POWER_STATE	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 7)
233 #define SWSCI_SBCB_DISPLAY_POWER_STATE	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 8)
234 #define SWSCI_SBCB_SET_BOOT_DISPLAY	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 9)
235 #define SWSCI_SBCB_SET_PANEL_DETAILS	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 10)
236 #define SWSCI_SBCB_SET_INTERNAL_GFX	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 11)
237 #define SWSCI_SBCB_POST_HIRES_TO_DOS_FS	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 16)
238 #define SWSCI_SBCB_SUSPEND_RESUME	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 17)
239 #define SWSCI_SBCB_SET_SPREAD_SPECTRUM	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 18)
240 #define SWSCI_SBCB_POST_VBE_PM		SWSCI_FUNCTION_CODE(SWSCI_SBCB, 19)
241 #define SWSCI_SBCB_ENABLE_DISABLE_AUDIO	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 21)
242 
243 #define ACPI_OTHER_OUTPUT (0<<8)
244 #define ACPI_VGA_OUTPUT (1<<8)
245 #define ACPI_TV_OUTPUT (2<<8)
246 #define ACPI_DIGITAL_OUTPUT (3<<8)
247 #define ACPI_LVDS_OUTPUT (4<<8)
248 
249 #define MAX_DSLP	1500
250 
251 #ifdef CONFIG_ACPI
252 static int swsci(struct drm_device *dev, u32 function, u32 parm, u32 *parm_out)
253 {
254 	struct drm_i915_private *dev_priv = dev->dev_private;
255 	struct opregion_swsci *swsci = dev_priv->opregion.swsci;
256 	u32 main_function, sub_function, scic;
257 	u16 pci_swsci;
258 	u32 dslp;
259 
260 	if (!swsci)
261 		return -ENODEV;
262 
263 	main_function = (function & SWSCI_SCIC_MAIN_FUNCTION_MASK) >>
264 		SWSCI_SCIC_MAIN_FUNCTION_SHIFT;
265 	sub_function = (function & SWSCI_SCIC_SUB_FUNCTION_MASK) >>
266 		SWSCI_SCIC_SUB_FUNCTION_SHIFT;
267 
268 	/* Check if we can call the function. See swsci_setup for details. */
269 	if (main_function == SWSCI_SBCB) {
270 		if ((dev_priv->opregion.swsci_sbcb_sub_functions &
271 		     (1 << sub_function)) == 0)
272 			return -EINVAL;
273 	} else if (main_function == SWSCI_GBDA) {
274 		if ((dev_priv->opregion.swsci_gbda_sub_functions &
275 		     (1 << sub_function)) == 0)
276 			return -EINVAL;
277 	}
278 
279 	/* Driver sleep timeout in ms. */
280 	dslp = swsci->dslp;
281 	if (!dslp) {
282 		/* The spec says 2ms should be the default, but it's too small
283 		 * for some machines. */
284 		dslp = 50;
285 	} else if (dslp > MAX_DSLP) {
286 		/* Hey bios, trust must be earned. */
287 		DRM_INFO_ONCE("ACPI BIOS requests an excessive sleep of %u ms, "
288 			      "using %u ms instead\n", dslp, MAX_DSLP);
289 		dslp = MAX_DSLP;
290 	}
291 
292 	/* The spec tells us to do this, but we are the only user... */
293 	scic = swsci->scic;
294 	if (scic & SWSCI_SCIC_INDICATOR) {
295 		DRM_DEBUG_DRIVER("SWSCI request already in progress\n");
296 		return -EBUSY;
297 	}
298 
299 	scic = function | SWSCI_SCIC_INDICATOR;
300 
301 	swsci->parm = parm;
302 	swsci->scic = scic;
303 
304 	/* Ensure SCI event is selected and event trigger is cleared. */
305 	pci_read_config_word(dev->pdev, PCI_SWSCI, &pci_swsci);
306 	if (!(pci_swsci & PCI_SWSCI_SCISEL) || (pci_swsci & PCI_SWSCI_GSSCIE)) {
307 		pci_swsci |= PCI_SWSCI_SCISEL;
308 		pci_swsci &= ~PCI_SWSCI_GSSCIE;
309 		pci_write_config_word(dev->pdev, PCI_SWSCI, pci_swsci);
310 	}
311 
312 	/* Use event trigger to tell bios to check the mail. */
313 	pci_swsci |= PCI_SWSCI_GSSCIE;
314 	pci_write_config_word(dev->pdev, PCI_SWSCI, pci_swsci);
315 
316 	/* Poll for the result. */
317 #define C (((scic = swsci->scic) & SWSCI_SCIC_INDICATOR) == 0)
318 	if (wait_for(C, dslp)) {
319 		DRM_DEBUG_DRIVER("SWSCI request timed out\n");
320 		return -ETIMEDOUT;
321 	}
322 
323 	scic = (scic & SWSCI_SCIC_EXIT_STATUS_MASK) >>
324 		SWSCI_SCIC_EXIT_STATUS_SHIFT;
325 
326 	/* Note: scic == 0 is an error! */
327 	if (scic != SWSCI_SCIC_EXIT_STATUS_SUCCESS) {
328 		DRM_DEBUG_DRIVER("SWSCI request error %u\n", scic);
329 		return -EIO;
330 	}
331 
332 	if (parm_out)
333 		*parm_out = swsci->parm;
334 
335 	return 0;
336 
337 #undef C
338 }
339 
340 #define DISPLAY_TYPE_CRT			0
341 #define DISPLAY_TYPE_TV				1
342 #define DISPLAY_TYPE_EXTERNAL_FLAT_PANEL	2
343 #define DISPLAY_TYPE_INTERNAL_FLAT_PANEL	3
344 
345 int intel_opregion_notify_encoder(struct intel_encoder *intel_encoder,
346 				  bool enable)
347 {
348 	struct drm_device *dev = intel_encoder->base.dev;
349 	u32 parm = 0;
350 	u32 type = 0;
351 	u32 port;
352 
353 	/* don't care about old stuff for now */
354 	if (!HAS_DDI(dev))
355 		return 0;
356 
357 	if (intel_encoder->type == INTEL_OUTPUT_DSI)
358 		port = 0;
359 	else
360 		port = intel_ddi_get_encoder_port(intel_encoder);
361 
362 	if (port == PORT_E)  {
363 		port = 0;
364 	} else {
365 		parm |= 1 << port;
366 		port++;
367 	}
368 
369 	if (!enable)
370 		parm |= 4 << 8;
371 
372 	switch (intel_encoder->type) {
373 	case INTEL_OUTPUT_ANALOG:
374 		type = DISPLAY_TYPE_CRT;
375 		break;
376 	case INTEL_OUTPUT_UNKNOWN:
377 	case INTEL_OUTPUT_DISPLAYPORT:
378 	case INTEL_OUTPUT_HDMI:
379 	case INTEL_OUTPUT_DP_MST:
380 		type = DISPLAY_TYPE_EXTERNAL_FLAT_PANEL;
381 		break;
382 	case INTEL_OUTPUT_EDP:
383 	case INTEL_OUTPUT_DSI:
384 		type = DISPLAY_TYPE_INTERNAL_FLAT_PANEL;
385 		break;
386 	default:
387 		WARN_ONCE(1, "unsupported intel_encoder type %d\n",
388 			  intel_encoder->type);
389 		return -EINVAL;
390 	}
391 
392 	parm |= type << (16 + port * 3);
393 
394 	return swsci(dev, SWSCI_SBCB_DISPLAY_POWER_STATE, parm, NULL);
395 }
396 
397 static const struct {
398 	pci_power_t pci_power_state;
399 	u32 parm;
400 } power_state_map[] = {
401 	{ PCI_D0,	0x00 },
402 	{ PCI_D1,	0x01 },
403 	{ PCI_D2,	0x02 },
404 	{ PCI_D3hot,	0x04 },
405 	{ PCI_D3cold,	0x04 },
406 };
407 
408 int intel_opregion_notify_adapter(struct drm_device *dev, pci_power_t state)
409 {
410 	int i;
411 
412 	if (!HAS_DDI(dev))
413 		return 0;
414 
415 	for (i = 0; i < ARRAY_SIZE(power_state_map); i++) {
416 		if (state == power_state_map[i].pci_power_state)
417 			return swsci(dev, SWSCI_SBCB_ADAPTER_POWER_STATE,
418 				     power_state_map[i].parm, NULL);
419 	}
420 
421 	return -EINVAL;
422 }
423 
424 static u32 asle_set_backlight(struct drm_device *dev, u32 bclp)
425 {
426 	struct drm_i915_private *dev_priv = dev->dev_private;
427 	struct intel_connector *connector;
428 	struct opregion_asle *asle = dev_priv->opregion.asle;
429 
430 	DRM_DEBUG_DRIVER("bclp = 0x%08x\n", bclp);
431 
432 #ifndef __DragonFly__
433 	if (acpi_video_get_backlight_type() == acpi_backlight_native) {
434 		DRM_DEBUG_KMS("opregion backlight request ignored\n");
435 		return 0;
436 	}
437 #endif
438 
439 	if (!(bclp & ASLE_BCLP_VALID))
440 		return ASLC_BACKLIGHT_FAILED;
441 
442 	bclp &= ASLE_BCLP_MSK;
443 	if (bclp > 255)
444 		return ASLC_BACKLIGHT_FAILED;
445 
446 	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
447 
448 	/*
449 	 * Update backlight on all connectors that support backlight (usually
450 	 * only one).
451 	 */
452 	DRM_DEBUG_KMS("updating opregion backlight %d/255\n", bclp);
453 	for_each_intel_connector(dev, connector)
454 		intel_panel_set_backlight_acpi(connector, bclp, 255);
455 	asle->cblv = DIV_ROUND_UP(bclp * 100, 255) | ASLE_CBLV_VALID;
456 
457 	drm_modeset_unlock(&dev->mode_config.connection_mutex);
458 
459 
460 	return 0;
461 }
462 
463 static u32 asle_set_als_illum(struct drm_device *dev, u32 alsi)
464 {
465 	/* alsi is the current ALS reading in lux. 0 indicates below sensor
466 	   range, 0xffff indicates above sensor range. 1-0xfffe are valid */
467 	DRM_DEBUG_DRIVER("Illum is not supported\n");
468 	return ASLC_ALS_ILLUM_FAILED;
469 }
470 
471 static u32 asle_set_pwm_freq(struct drm_device *dev, u32 pfmb)
472 {
473 	DRM_DEBUG_DRIVER("PWM freq is not supported\n");
474 	return ASLC_PWM_FREQ_FAILED;
475 }
476 
477 static u32 asle_set_pfit(struct drm_device *dev, u32 pfit)
478 {
479 	/* Panel fitting is currently controlled by the X code, so this is a
480 	   noop until modesetting support works fully */
481 	DRM_DEBUG_DRIVER("Pfit is not supported\n");
482 	return ASLC_PFIT_FAILED;
483 }
484 
485 static u32 asle_set_supported_rotation_angles(struct drm_device *dev, u32 srot)
486 {
487 	DRM_DEBUG_DRIVER("SROT is not supported\n");
488 	return ASLC_ROTATION_ANGLES_FAILED;
489 }
490 
491 static u32 asle_set_button_array(struct drm_device *dev, u32 iuer)
492 {
493 	if (!iuer)
494 		DRM_DEBUG_DRIVER("Button array event is not supported (nothing)\n");
495 	if (iuer & ASLE_IUER_ROTATION_LOCK_BTN)
496 		DRM_DEBUG_DRIVER("Button array event is not supported (rotation lock)\n");
497 	if (iuer & ASLE_IUER_VOLUME_DOWN_BTN)
498 		DRM_DEBUG_DRIVER("Button array event is not supported (volume down)\n");
499 	if (iuer & ASLE_IUER_VOLUME_UP_BTN)
500 		DRM_DEBUG_DRIVER("Button array event is not supported (volume up)\n");
501 	if (iuer & ASLE_IUER_WINDOWS_BTN)
502 		DRM_DEBUG_DRIVER("Button array event is not supported (windows)\n");
503 	if (iuer & ASLE_IUER_POWER_BTN)
504 		DRM_DEBUG_DRIVER("Button array event is not supported (power)\n");
505 
506 	return ASLC_BUTTON_ARRAY_FAILED;
507 }
508 
509 static u32 asle_set_convertible(struct drm_device *dev, u32 iuer)
510 {
511 	if (iuer & ASLE_IUER_CONVERTIBLE)
512 		DRM_DEBUG_DRIVER("Convertible is not supported (clamshell)\n");
513 	else
514 		DRM_DEBUG_DRIVER("Convertible is not supported (slate)\n");
515 
516 	return ASLC_CONVERTIBLE_FAILED;
517 }
518 
519 static u32 asle_set_docking(struct drm_device *dev, u32 iuer)
520 {
521 	if (iuer & ASLE_IUER_DOCKING)
522 		DRM_DEBUG_DRIVER("Docking is not supported (docked)\n");
523 	else
524 		DRM_DEBUG_DRIVER("Docking is not supported (undocked)\n");
525 
526 	return ASLC_DOCKING_FAILED;
527 }
528 
529 static u32 asle_isct_state(struct drm_device *dev)
530 {
531 	DRM_DEBUG_DRIVER("ISCT is not supported\n");
532 	return ASLC_ISCT_STATE_FAILED;
533 }
534 
535 static void asle_work(struct work_struct *work)
536 {
537 	struct intel_opregion *opregion =
538 		container_of(work, struct intel_opregion, asle_work);
539 	struct drm_i915_private *dev_priv =
540 		container_of(opregion, struct drm_i915_private, opregion);
541 	struct drm_device *dev = dev_priv->dev;
542 	struct opregion_asle *asle = dev_priv->opregion.asle;
543 	u32 aslc_stat = 0;
544 	u32 aslc_req;
545 
546 	if (!asle)
547 		return;
548 
549 	aslc_req = asle->aslc;
550 
551 	if (!(aslc_req & ASLC_REQ_MSK)) {
552 		DRM_DEBUG_DRIVER("No request on ASLC interrupt 0x%08x\n",
553 				 aslc_req);
554 		return;
555 	}
556 
557 	if (aslc_req & ASLC_SET_ALS_ILLUM)
558 		aslc_stat |= asle_set_als_illum(dev, asle->alsi);
559 
560 	if (aslc_req & ASLC_SET_BACKLIGHT)
561 		aslc_stat |= asle_set_backlight(dev, asle->bclp);
562 
563 	if (aslc_req & ASLC_SET_PFIT)
564 		aslc_stat |= asle_set_pfit(dev, asle->pfit);
565 
566 	if (aslc_req & ASLC_SET_PWM_FREQ)
567 		aslc_stat |= asle_set_pwm_freq(dev, asle->pfmb);
568 
569 	if (aslc_req & ASLC_SUPPORTED_ROTATION_ANGLES)
570 		aslc_stat |= asle_set_supported_rotation_angles(dev,
571 							asle->srot);
572 
573 	if (aslc_req & ASLC_BUTTON_ARRAY)
574 		aslc_stat |= asle_set_button_array(dev, asle->iuer);
575 
576 	if (aslc_req & ASLC_CONVERTIBLE_INDICATOR)
577 		aslc_stat |= asle_set_convertible(dev, asle->iuer);
578 
579 	if (aslc_req & ASLC_DOCKING_INDICATOR)
580 		aslc_stat |= asle_set_docking(dev, asle->iuer);
581 
582 	if (aslc_req & ASLC_ISCT_STATE_CHANGE)
583 		aslc_stat |= asle_isct_state(dev);
584 
585 	asle->aslc = aslc_stat;
586 }
587 
588 void intel_opregion_asle_intr(struct drm_device *dev)
589 {
590 	struct drm_i915_private *dev_priv = dev->dev_private;
591 
592 	if (dev_priv->opregion.asle)
593 		schedule_work(&dev_priv->opregion.asle_work);
594 }
595 
596 #define ACPI_EV_DISPLAY_SWITCH (1<<0)
597 #define ACPI_EV_LID            (1<<1)
598 #define ACPI_EV_DOCK           (1<<2)
599 
600 static struct intel_opregion *system_opregion;
601 
602 #if 0
603 static int intel_opregion_video_event(struct notifier_block *nb,
604 				      unsigned long val, void *data)
605 {
606 	/* The only video events relevant to opregion are 0x80. These indicate
607 	   either a docking event, lid switch or display switch request. In
608 	   Linux, these are handled by the dock, button and video drivers.
609 	*/
610 
611 	struct acpi_bus_event *event = data;
612 	struct opregion_acpi *acpi;
613 	int ret = NOTIFY_OK;
614 
615 	if (strcmp(event->device_class, ACPI_VIDEO_CLASS) != 0)
616 		return NOTIFY_DONE;
617 
618 	if (!system_opregion)
619 		return NOTIFY_DONE;
620 
621 	acpi = system_opregion->acpi;
622 
623 	if (event->type == 0x80 && ((acpi->cevt & 1) == 0))
624 		ret = NOTIFY_BAD;
625 
626 	acpi->csts = 0;
627 
628 	return ret;
629 }
630 
631 static struct notifier_block intel_opregion_notifier = {
632 	.notifier_call = intel_opregion_video_event,
633 };
634 #endif
635 
636 static int acpi_is_video_device(ACPI_HANDLE devh) {
637 	ACPI_HANDLE h;
638 	if (ACPI_FAILURE(AcpiGetHandle(devh, "_DOD", &h)) ||
639 	    ACPI_FAILURE(AcpiGetHandle(devh, "_DOS", &h))) {
640 		return 0;
641 	}
642 	return 1;
643 }
644 
645 /*
646  * Initialise the DIDL field in opregion. This passes a list of devices to
647  * the firmware. Values are defined by section B.4.2 of the ACPI specification
648  * (version 3)
649  */
650 
651 static u32 get_did(struct intel_opregion *opregion, int i)
652 {
653 	u32 did;
654 
655 	if (i < ARRAY_SIZE(opregion->acpi->didl)) {
656 		did = opregion->acpi->didl[i];
657 	} else {
658 		i -= ARRAY_SIZE(opregion->acpi->didl);
659 
660 		if (WARN_ON(i >= ARRAY_SIZE(opregion->acpi->did2)))
661 			return 0;
662 
663 		did = opregion->acpi->did2[i];
664 	}
665 
666 	return did;
667 }
668 
669 static void set_did(struct intel_opregion *opregion, int i, u32 val)
670 {
671 	if (i < ARRAY_SIZE(opregion->acpi->didl)) {
672 		opregion->acpi->didl[i] = val;
673 	} else {
674 		i -= ARRAY_SIZE(opregion->acpi->didl);
675 
676 		if (WARN_ON(i >= ARRAY_SIZE(opregion->acpi->did2)))
677 			return;
678 
679 		opregion->acpi->did2[i] = val;
680 	}
681 }
682 
683 static void intel_didl_outputs(struct drm_device *dev)
684 {
685 	struct drm_i915_private *dev_priv = dev->dev_private;
686 	struct intel_opregion *opregion = &dev_priv->opregion;
687 	struct drm_connector *connector;
688 	ACPI_HANDLE handle, acpi_cdev, acpi_video_bus;
689 	u32 device_id;
690 	ACPI_STATUS status;
691 	u32 temp, max_outputs;
692 	int i = 0;
693 
694 	handle = acpi_get_handle(dev->dev->bsddev);
695 	if (!handle)
696 		return;
697 
698 	if (acpi_is_video_device(handle))
699 		acpi_video_bus = handle;
700 	else {
701 		acpi_cdev = NULL;
702 		acpi_video_bus = NULL;
703 		while (AcpiGetNextObject(ACPI_TYPE_DEVICE, handle, acpi_cdev,
704 					 &acpi_cdev) != AE_NOT_FOUND) {
705 			if (acpi_is_video_device(acpi_cdev)) {
706 				acpi_video_bus = acpi_cdev;
707 				break;
708 			}
709 		}
710 	}
711 
712 	if (!acpi_video_bus) {
713 		DRM_DEBUG_KMS("No ACPI video bus found\n");
714 		return;
715 	}
716 
717 	/*
718 	 * In theory, did2, the extended didl, gets added at opregion version
719 	 * 3.0. In practice, however, we're supposed to set it for earlier
720 	 * versions as well, since a BIOS that doesn't understand did2 should
721 	 * not look at it anyway. Use a variable so we can tweak this if a need
722 	 * arises later.
723 	 */
724 	max_outputs = ARRAY_SIZE(opregion->acpi->didl) +
725 		ARRAY_SIZE(opregion->acpi->did2);
726 
727 	while (AcpiGetNextObject(ACPI_TYPE_DEVICE, acpi_video_bus, acpi_cdev,
728 				 &acpi_cdev) != AE_NOT_FOUND) {
729 		if (i >= max_outputs) {
730 			DRM_DEBUG_KMS("More than %u outputs detected via ACPI\n",
731 				      max_outputs);
732 			return;
733 		}
734 		status = acpi_GetInteger(acpi_cdev, "_ADR", &device_id);
735 		if (ACPI_SUCCESS(status)) {
736 			if (!device_id)
737 				goto blind_set;
738 			set_did(opregion, i++, (u32)(device_id & 0x0f0f));
739 		}
740 	}
741 
742 end:
743 	DRM_DEBUG_KMS("%d outputs detected\n", i);
744 
745 	/* If fewer than max outputs, the list must be null terminated */
746 	if (i < max_outputs)
747 		set_did(opregion, i, 0);
748 	return;
749 
750 blind_set:
751 	i = 0;
752 	list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
753 		int output_type = ACPI_OTHER_OUTPUT;
754 		if (i >= max_outputs) {
755 			DRM_DEBUG_KMS("More than %u outputs in connector list\n",
756 				      max_outputs);
757 			return;
758 		}
759 		switch (connector->connector_type) {
760 		case DRM_MODE_CONNECTOR_VGA:
761 		case DRM_MODE_CONNECTOR_DVIA:
762 			output_type = ACPI_VGA_OUTPUT;
763 			break;
764 		case DRM_MODE_CONNECTOR_Composite:
765 		case DRM_MODE_CONNECTOR_SVIDEO:
766 		case DRM_MODE_CONNECTOR_Component:
767 		case DRM_MODE_CONNECTOR_9PinDIN:
768 			output_type = ACPI_TV_OUTPUT;
769 			break;
770 		case DRM_MODE_CONNECTOR_DVII:
771 		case DRM_MODE_CONNECTOR_DVID:
772 		case DRM_MODE_CONNECTOR_DisplayPort:
773 		case DRM_MODE_CONNECTOR_HDMIA:
774 		case DRM_MODE_CONNECTOR_HDMIB:
775 			output_type = ACPI_DIGITAL_OUTPUT;
776 			break;
777 		case DRM_MODE_CONNECTOR_LVDS:
778 			output_type = ACPI_LVDS_OUTPUT;
779 			break;
780 		}
781 		temp = get_did(opregion, i);
782 		set_did(opregion, i, temp | (1 << 31) | output_type | i);
783 		i++;
784 	}
785 	goto end;
786 }
787 
788 static void intel_setup_cadls(struct drm_device *dev)
789 {
790 	struct drm_i915_private *dev_priv = dev->dev_private;
791 	struct intel_opregion *opregion = &dev_priv->opregion;
792 	int i = 0;
793 	u32 disp_id;
794 
795 	/* Initialize the CADL field by duplicating the DIDL values.
796 	 * Technically, this is not always correct as display outputs may exist,
797 	 * but not active. This initialization is necessary for some Clevo
798 	 * laptops that check this field before processing the brightness and
799 	 * display switching hotkeys. Just like DIDL, CADL is NULL-terminated if
800 	 * there are less than eight devices. */
801 	do {
802 		disp_id = get_did(opregion, i);
803 		opregion->acpi->cadl[i] = disp_id;
804 	} while (++i < 8 && disp_id != 0);
805 }
806 
807 void intel_opregion_init(struct drm_device *dev)
808 {
809 	struct drm_i915_private *dev_priv = dev->dev_private;
810 	struct intel_opregion *opregion = &dev_priv->opregion;
811 
812 	if (!opregion->header)
813 		return;
814 
815 	if (opregion->acpi) {
816 		intel_didl_outputs(dev);
817 		intel_setup_cadls(dev);
818 
819 		/* Notify BIOS we are ready to handle ACPI video ext notifs.
820 		 * Right now, all the events are handled by the ACPI video module.
821 		 * We don't actually need to do anything with them. */
822 		opregion->acpi->csts = 0;
823 		opregion->acpi->drdy = 1;
824 
825 		system_opregion = opregion;
826 	}
827 
828 	if (opregion->asle) {
829 		opregion->asle->tche = ASLE_TCHE_BLC_EN;
830 		opregion->asle->ardy = ASLE_ARDY_READY;
831 	}
832 }
833 
834 void intel_opregion_fini(struct drm_device *dev)
835 {
836 	struct drm_i915_private *dev_priv = dev->dev_private;
837 	struct intel_opregion *opregion = &dev_priv->opregion;
838 
839 	if (!opregion->header)
840 		return;
841 
842 	if (opregion->asle)
843 		opregion->asle->ardy = ASLE_ARDY_NOT_READY;
844 
845 	cancel_work_sync(&dev_priv->opregion.asle_work);
846 
847 	if (opregion->acpi) {
848 		opregion->acpi->drdy = 0;
849 
850 		system_opregion = NULL;
851 	}
852 
853 	/* just clear all opregion memory pointers now */
854 	iounmap(opregion->header);
855 	if (opregion->rvda) {
856 		iounmap(opregion->rvda);
857 		opregion->rvda = NULL;
858 	}
859 	opregion->header = NULL;
860 	opregion->acpi = NULL;
861 	opregion->swsci = NULL;
862 	opregion->asle = NULL;
863 	opregion->vbt = NULL;
864 	opregion->lid_state = NULL;
865 }
866 
867 static void swsci_setup(struct drm_device *dev)
868 {
869 	struct drm_i915_private *dev_priv = dev->dev_private;
870 	struct intel_opregion *opregion = &dev_priv->opregion;
871 	bool requested_callbacks = false;
872 	u32 tmp;
873 
874 	/* Sub-function code 0 is okay, let's allow them. */
875 	opregion->swsci_gbda_sub_functions = 1;
876 	opregion->swsci_sbcb_sub_functions = 1;
877 
878 	/* We use GBDA to ask for supported GBDA calls. */
879 	if (swsci(dev, SWSCI_GBDA_SUPPORTED_CALLS, 0, &tmp) == 0) {
880 		/* make the bits match the sub-function codes */
881 		tmp <<= 1;
882 		opregion->swsci_gbda_sub_functions |= tmp;
883 	}
884 
885 	/*
886 	 * We also use GBDA to ask for _requested_ SBCB callbacks. The driver
887 	 * must not call interfaces that are not specifically requested by the
888 	 * bios.
889 	 */
890 	if (swsci(dev, SWSCI_GBDA_REQUESTED_CALLBACKS, 0, &tmp) == 0) {
891 		/* here, the bits already match sub-function codes */
892 		opregion->swsci_sbcb_sub_functions |= tmp;
893 		requested_callbacks = true;
894 	}
895 
896 	/*
897 	 * But we use SBCB to ask for _supported_ SBCB calls. This does not mean
898 	 * the callback is _requested_. But we still can't call interfaces that
899 	 * are not requested.
900 	 */
901 	if (swsci(dev, SWSCI_SBCB_SUPPORTED_CALLBACKS, 0, &tmp) == 0) {
902 		/* make the bits match the sub-function codes */
903 		u32 low = tmp & 0x7ff;
904 		u32 high = tmp & ~0xfff; /* bit 11 is reserved */
905 		tmp = (high << 4) | (low << 1) | 1;
906 
907 		/* best guess what to do with supported wrt requested */
908 		if (requested_callbacks) {
909 			u32 req = opregion->swsci_sbcb_sub_functions;
910 			if ((req & tmp) != req)
911 				DRM_DEBUG_DRIVER("SWSCI BIOS requested (%08x) SBCB callbacks that are not supported (%08x)\n", req, tmp);
912 			/* XXX: for now, trust the requested callbacks */
913 			/* opregion->swsci_sbcb_sub_functions &= tmp; */
914 		} else {
915 			opregion->swsci_sbcb_sub_functions |= tmp;
916 		}
917 	}
918 
919 	DRM_DEBUG_DRIVER("SWSCI GBDA callbacks %08x, SBCB callbacks %08x\n",
920 			 opregion->swsci_gbda_sub_functions,
921 			 opregion->swsci_sbcb_sub_functions);
922 }
923 #else /* CONFIG_ACPI */
924 static inline void swsci_setup(struct drm_device *dev) {}
925 #endif  /* CONFIG_ACPI */
926 
927 static int intel_no_opregion_vbt_callback(const struct dmi_system_id *id)
928 {
929 	DRM_DEBUG_KMS("Falling back to manually reading VBT from "
930 		      "VBIOS ROM for %s\n", id->ident);
931 	return 1;
932 }
933 
934 static const struct dmi_system_id intel_no_opregion_vbt[] = {
935 	{
936 		.callback = intel_no_opregion_vbt_callback,
937 		.ident = "ThinkCentre A57",
938 		.matches = {
939 			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
940 			DMI_MATCH(DMI_PRODUCT_NAME, "97027RG"),
941 		},
942 	},
943 	{ }
944 };
945 
946 int intel_opregion_setup(struct drm_device *dev)
947 {
948 	struct drm_i915_private *dev_priv = dev->dev_private;
949 	struct intel_opregion *opregion = &dev_priv->opregion;
950 	u32 asls, mboxes;
951 	char buf[sizeof(OPREGION_SIGNATURE)];
952 	int err = 0;
953 	char *base;
954 
955 	BUILD_BUG_ON(sizeof(struct opregion_header) != 0x100);
956 	BUILD_BUG_ON(sizeof(struct opregion_acpi) != 0x100);
957 	BUILD_BUG_ON(sizeof(struct opregion_swsci) != 0x100);
958 	BUILD_BUG_ON(sizeof(struct opregion_asle) != 0x100);
959 	BUILD_BUG_ON(sizeof(struct opregion_asle_ext) != 0x400);
960 
961 	pci_read_config_dword(dev->pdev, PCI_ASLS, &asls);
962 	DRM_DEBUG_DRIVER("graphic opregion physical addr: 0x%x\n", asls);
963 	if (asls == 0) {
964 		DRM_DEBUG_DRIVER("ACPI OpRegion not supported!\n");
965 		return -ENOTSUP;
966 	}
967 
968 #ifdef CONFIG_ACPI
969 	INIT_WORK(&opregion->asle_work, asle_work);
970 #endif
971 
972 	base = (void *)pmap_mapbios(asls, OPREGION_SIZE);
973 	if (!base)
974 		return -ENOMEM;
975 
976 	memcpy(buf, base, sizeof(buf));
977 
978 	if (memcmp(buf, OPREGION_SIGNATURE, 16)) {
979 		DRM_DEBUG_DRIVER("opregion signature mismatch\n");
980 		err = -EINVAL;
981 		goto err_out;
982 	}
983 	opregion->header = (struct opregion_header *)base;
984 
985 	opregion->lid_state = (u32 *)(base + ACPI_CLID);
986 
987 	mboxes = opregion->header->mboxes;
988 	if (mboxes & MBOX_ACPI) {
989 		DRM_DEBUG_DRIVER("Public ACPI methods supported\n");
990 		opregion->acpi = (struct opregion_acpi *)(base + OPREGION_ACPI_OFFSET);
991 	}
992 
993 	if (mboxes & MBOX_SWSCI) {
994 		DRM_DEBUG_DRIVER("SWSCI supported\n");
995 		opregion->swsci = (struct opregion_swsci *)(base + OPREGION_SWSCI_OFFSET);
996 		swsci_setup(dev);
997 	}
998 
999 	if (mboxes & MBOX_ASLE) {
1000 		DRM_DEBUG_DRIVER("ASLE supported\n");
1001 		opregion->asle = (struct opregion_asle *)(base + OPREGION_ASLE_OFFSET);
1002 
1003 		opregion->asle->ardy = ASLE_ARDY_NOT_READY;
1004 	}
1005 
1006 	if (mboxes & MBOX_ASLE_EXT)
1007 		DRM_DEBUG_DRIVER("ASLE extension supported\n");
1008 
1009 	if (!dmi_check_system(intel_no_opregion_vbt)) {
1010 		const void *vbt = NULL;
1011 		u32 vbt_size = 0;
1012 
1013 		if (opregion->header->opregion_ver >= 2 && opregion->asle &&
1014 		    opregion->asle->rvda && opregion->asle->rvds) {
1015 			opregion->rvda = pmap_mapbios(opregion->asle->rvda,
1016 						  opregion->asle->rvds);
1017 			vbt = opregion->rvda;
1018 			vbt_size = opregion->asle->rvds;
1019 		}
1020 
1021 		if (intel_bios_is_valid_vbt(vbt, vbt_size)) {
1022 			DRM_DEBUG_KMS("Found valid VBT in ACPI OpRegion (RVDA)\n");
1023 			opregion->vbt = vbt;
1024 			opregion->vbt_size = vbt_size;
1025 		} else {
1026 			vbt = base + OPREGION_VBT_OFFSET;
1027 			vbt_size = OPREGION_ASLE_EXT_OFFSET - OPREGION_VBT_OFFSET;
1028 			if (intel_bios_is_valid_vbt(vbt, vbt_size)) {
1029 				DRM_DEBUG_KMS("Found valid VBT in ACPI OpRegion (Mailbox #4)\n");
1030 				opregion->vbt = vbt;
1031 				opregion->vbt_size = vbt_size;
1032 			}
1033 		}
1034 	}
1035 
1036 	return 0;
1037 
1038 err_out:
1039 	iounmap(base);
1040 	return err;
1041 }
1042