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