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