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/acpi.h>
29#include <linux/dmi.h>
30#include <linux/firmware.h>
31#include <acpi/video.h>
32
33#include "display/intel_panel.h"
34
35#include "i915_drv.h"
36#include "intel_acpi.h"
37#include "intel_display_types.h"
38#include "intel_opregion.h"
39
40#define OPREGION_HEADER_OFFSET 0
41#define OPREGION_ACPI_OFFSET   0x100
42#define   ACPI_CLID 0x01ac /* current lid state indicator */
43#define   ACPI_CDCK 0x01b0 /* current docking state indicator */
44#define OPREGION_SWSCI_OFFSET  0x200
45#define OPREGION_ASLE_OFFSET   0x300
46#define OPREGION_VBT_OFFSET    0x400
47#define OPREGION_ASLE_EXT_OFFSET	0x1C00
48
49#define OPREGION_SIGNATURE "IntelGraphicsMem"
50#define MBOX_ACPI      (1<<0)
51#define MBOX_SWSCI     (1<<1)
52#define MBOX_ASLE      (1<<2)
53#define MBOX_ASLE_EXT  (1<<4)
54
55struct opregion_header {
56	u8 signature[16];
57	u32 size;
58	struct {
59		u8 rsvd;
60		u8 revision;
61		u8 minor;
62		u8 major;
63	}  __packed over;
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 */
75struct 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 */
99struct 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 */
107struct 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 (2.0) or relative from opregion (2.1+)
128			 * address of raw VBT data. */
129	u32 rvds;	/* Size of raw vbt data */
130	u8 rsvd[58];
131} __packed;
132
133/* OpRegion mailbox #5: ASLE ext */
134struct opregion_asle_ext {
135	u32 phed;	/* Panel Header */
136	u8 bddc[256];	/* Panel EDID */
137	u8 rsvd[764];
138} __packed;
139
140/* Driver readiness indicator */
141#define ASLE_ARDY_READY		(1 << 0)
142#define ASLE_ARDY_NOT_READY	(0 << 0)
143
144/* ASLE Interrupt Command (ASLC) bits */
145#define ASLC_SET_ALS_ILLUM		(1 << 0)
146#define ASLC_SET_BACKLIGHT		(1 << 1)
147#define ASLC_SET_PFIT			(1 << 2)
148#define ASLC_SET_PWM_FREQ		(1 << 3)
149#define ASLC_SUPPORTED_ROTATION_ANGLES	(1 << 4)
150#define ASLC_BUTTON_ARRAY		(1 << 5)
151#define ASLC_CONVERTIBLE_INDICATOR	(1 << 6)
152#define ASLC_DOCKING_INDICATOR		(1 << 7)
153#define ASLC_ISCT_STATE_CHANGE		(1 << 8)
154#define ASLC_REQ_MSK			0x1ff
155/* response bits */
156#define ASLC_ALS_ILLUM_FAILED		(1 << 10)
157#define ASLC_BACKLIGHT_FAILED		(1 << 12)
158#define ASLC_PFIT_FAILED		(1 << 14)
159#define ASLC_PWM_FREQ_FAILED		(1 << 16)
160#define ASLC_ROTATION_ANGLES_FAILED	(1 << 18)
161#define ASLC_BUTTON_ARRAY_FAILED	(1 << 20)
162#define ASLC_CONVERTIBLE_FAILED		(1 << 22)
163#define ASLC_DOCKING_FAILED		(1 << 24)
164#define ASLC_ISCT_STATE_FAILED		(1 << 26)
165
166/* Technology enabled indicator */
167#define ASLE_TCHE_ALS_EN	(1 << 0)
168#define ASLE_TCHE_BLC_EN	(1 << 1)
169#define ASLE_TCHE_PFIT_EN	(1 << 2)
170#define ASLE_TCHE_PFMB_EN	(1 << 3)
171
172/* ASLE backlight brightness to set */
173#define ASLE_BCLP_VALID                (1<<31)
174#define ASLE_BCLP_MSK          (~(1<<31))
175
176/* ASLE panel fitting request */
177#define ASLE_PFIT_VALID         (1<<31)
178#define ASLE_PFIT_CENTER (1<<0)
179#define ASLE_PFIT_STRETCH_TEXT (1<<1)
180#define ASLE_PFIT_STRETCH_GFX (1<<2)
181
182/* PWM frequency and minimum brightness */
183#define ASLE_PFMB_BRIGHTNESS_MASK (0xff)
184#define ASLE_PFMB_BRIGHTNESS_VALID (1<<8)
185#define ASLE_PFMB_PWM_MASK (0x7ffffe00)
186#define ASLE_PFMB_PWM_VALID (1<<31)
187
188#define ASLE_CBLV_VALID         (1<<31)
189
190/* IUER */
191#define ASLE_IUER_DOCKING		(1 << 7)
192#define ASLE_IUER_CONVERTIBLE		(1 << 6)
193#define ASLE_IUER_ROTATION_LOCK_BTN	(1 << 4)
194#define ASLE_IUER_VOLUME_DOWN_BTN	(1 << 3)
195#define ASLE_IUER_VOLUME_UP_BTN		(1 << 2)
196#define ASLE_IUER_WINDOWS_BTN		(1 << 1)
197#define ASLE_IUER_POWER_BTN		(1 << 0)
198
199/* Software System Control Interrupt (SWSCI) */
200#define SWSCI_SCIC_INDICATOR		(1 << 0)
201#define SWSCI_SCIC_MAIN_FUNCTION_SHIFT	1
202#define SWSCI_SCIC_MAIN_FUNCTION_MASK	(0xf << 1)
203#define SWSCI_SCIC_SUB_FUNCTION_SHIFT	8
204#define SWSCI_SCIC_SUB_FUNCTION_MASK	(0xff << 8)
205#define SWSCI_SCIC_EXIT_PARAMETER_SHIFT	8
206#define SWSCI_SCIC_EXIT_PARAMETER_MASK	(0xff << 8)
207#define SWSCI_SCIC_EXIT_STATUS_SHIFT	5
208#define SWSCI_SCIC_EXIT_STATUS_MASK	(7 << 5)
209#define SWSCI_SCIC_EXIT_STATUS_SUCCESS	1
210
211#define SWSCI_FUNCTION_CODE(main, sub) \
212	((main) << SWSCI_SCIC_MAIN_FUNCTION_SHIFT | \
213	 (sub) << SWSCI_SCIC_SUB_FUNCTION_SHIFT)
214
215/* SWSCI: Get BIOS Data (GBDA) */
216#define SWSCI_GBDA			4
217#define SWSCI_GBDA_SUPPORTED_CALLS	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 0)
218#define SWSCI_GBDA_REQUESTED_CALLBACKS	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 1)
219#define SWSCI_GBDA_BOOT_DISPLAY_PREF	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 4)
220#define SWSCI_GBDA_PANEL_DETAILS	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 5)
221#define SWSCI_GBDA_TV_STANDARD		SWSCI_FUNCTION_CODE(SWSCI_GBDA, 6)
222#define SWSCI_GBDA_INTERNAL_GRAPHICS	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 7)
223#define SWSCI_GBDA_SPREAD_SPECTRUM	SWSCI_FUNCTION_CODE(SWSCI_GBDA, 10)
224
225/* SWSCI: System BIOS Callbacks (SBCB) */
226#define SWSCI_SBCB			6
227#define SWSCI_SBCB_SUPPORTED_CALLBACKS	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 0)
228#define SWSCI_SBCB_INIT_COMPLETION	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 1)
229#define SWSCI_SBCB_PRE_HIRES_SET_MODE	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 3)
230#define SWSCI_SBCB_POST_HIRES_SET_MODE	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 4)
231#define SWSCI_SBCB_DISPLAY_SWITCH	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 5)
232#define SWSCI_SBCB_SET_TV_FORMAT	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 6)
233#define SWSCI_SBCB_ADAPTER_POWER_STATE	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 7)
234#define SWSCI_SBCB_DISPLAY_POWER_STATE	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 8)
235#define SWSCI_SBCB_SET_BOOT_DISPLAY	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 9)
236#define SWSCI_SBCB_SET_PANEL_DETAILS	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 10)
237#define SWSCI_SBCB_SET_INTERNAL_GFX	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 11)
238#define SWSCI_SBCB_POST_HIRES_TO_DOS_FS	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 16)
239#define SWSCI_SBCB_SUSPEND_RESUME	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 17)
240#define SWSCI_SBCB_SET_SPREAD_SPECTRUM	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 18)
241#define SWSCI_SBCB_POST_VBE_PM		SWSCI_FUNCTION_CODE(SWSCI_SBCB, 19)
242#define SWSCI_SBCB_ENABLE_DISABLE_AUDIO	SWSCI_FUNCTION_CODE(SWSCI_SBCB, 21)
243
244#define MAX_DSLP	1500
245
246static int swsci(struct drm_i915_private *dev_priv,
247		 u32 function, u32 parm, u32 *parm_out)
248{
249	struct opregion_swsci *swsci = dev_priv->opregion.swsci;
250	struct pci_dev *pdev = dev_priv->drm.pdev;
251	u32 main_function, sub_function, scic;
252	u16 swsci_val;
253	u32 dslp;
254
255	if (!swsci)
256		return -ENODEV;
257
258	main_function = (function & SWSCI_SCIC_MAIN_FUNCTION_MASK) >>
259		SWSCI_SCIC_MAIN_FUNCTION_SHIFT;
260	sub_function = (function & SWSCI_SCIC_SUB_FUNCTION_MASK) >>
261		SWSCI_SCIC_SUB_FUNCTION_SHIFT;
262
263	/* Check if we can call the function. See swsci_setup for details. */
264	if (main_function == SWSCI_SBCB) {
265		if ((dev_priv->opregion.swsci_sbcb_sub_functions &
266		     (1 << sub_function)) == 0)
267			return -EINVAL;
268	} else if (main_function == SWSCI_GBDA) {
269		if ((dev_priv->opregion.swsci_gbda_sub_functions &
270		     (1 << sub_function)) == 0)
271			return -EINVAL;
272	}
273
274	/* Driver sleep timeout in ms. */
275	dslp = swsci->dslp;
276	if (!dslp) {
277		/* The spec says 2ms should be the default, but it's too small
278		 * for some machines. */
279		dslp = 50;
280	} else if (dslp > MAX_DSLP) {
281		/* Hey bios, trust must be earned. */
282		DRM_INFO_ONCE("ACPI BIOS requests an excessive sleep of %u ms, "
283			      "using %u ms instead\n", dslp, MAX_DSLP);
284		dslp = MAX_DSLP;
285	}
286
287	/* The spec tells us to do this, but we are the only user... */
288	scic = swsci->scic;
289	if (scic & SWSCI_SCIC_INDICATOR) {
290		drm_dbg(&dev_priv->drm, "SWSCI request already in progress\n");
291		return -EBUSY;
292	}
293
294	scic = function | SWSCI_SCIC_INDICATOR;
295
296	swsci->parm = parm;
297	swsci->scic = scic;
298
299	/* Ensure SCI event is selected and event trigger is cleared. */
300	pci_read_config_word(pdev, SWSCI, &swsci_val);
301	if (!(swsci_val & SWSCI_SCISEL) || (swsci_val & SWSCI_GSSCIE)) {
302		swsci_val |= SWSCI_SCISEL;
303		swsci_val &= ~SWSCI_GSSCIE;
304		pci_write_config_word(pdev, SWSCI, swsci_val);
305	}
306
307	/* Use event trigger to tell bios to check the mail. */
308	swsci_val |= SWSCI_GSSCIE;
309	pci_write_config_word(pdev, SWSCI, swsci_val);
310
311	/* Poll for the result. */
312#define C (((scic = swsci->scic) & SWSCI_SCIC_INDICATOR) == 0)
313	if (wait_for(C, dslp)) {
314		drm_dbg(&dev_priv->drm, "SWSCI request timed out\n");
315		return -ETIMEDOUT;
316	}
317
318	scic = (scic & SWSCI_SCIC_EXIT_STATUS_MASK) >>
319		SWSCI_SCIC_EXIT_STATUS_SHIFT;
320
321	/* Note: scic == 0 is an error! */
322	if (scic != SWSCI_SCIC_EXIT_STATUS_SUCCESS) {
323		drm_dbg(&dev_priv->drm, "SWSCI request error %u\n", scic);
324		return -EIO;
325	}
326
327	if (parm_out)
328		*parm_out = swsci->parm;
329
330	return 0;
331
332#undef C
333}
334
335#define DISPLAY_TYPE_CRT			0
336#define DISPLAY_TYPE_TV				1
337#define DISPLAY_TYPE_EXTERNAL_FLAT_PANEL	2
338#define DISPLAY_TYPE_INTERNAL_FLAT_PANEL	3
339
340int intel_opregion_notify_encoder(struct intel_encoder *intel_encoder,
341				  bool enable)
342{
343	struct drm_i915_private *dev_priv = to_i915(intel_encoder->base.dev);
344	u32 parm = 0;
345	u32 type = 0;
346	u32 port;
347
348	/* don't care about old stuff for now */
349	if (!HAS_DDI(dev_priv))
350		return 0;
351
352	if (intel_encoder->type == INTEL_OUTPUT_DSI)
353		port = 0;
354	else
355		port = intel_encoder->port;
356
357	if (port == PORT_E)  {
358		port = 0;
359	} else {
360		parm |= 1 << port;
361		port++;
362	}
363
364	/*
365	 * The port numbering and mapping here is bizarre. The now-obsolete
366	 * swsci spec supports ports numbered [0..4]. Port E is handled as a
367	 * special case, but port F and beyond are not. The functionality is
368	 * supposed to be obsolete for new platforms. Just bail out if the port
369	 * number is out of bounds after mapping.
370	 */
371	if (port > 4) {
372		drm_dbg_kms(&dev_priv->drm,
373			    "[ENCODER:%d:%s] port %c (index %u) out of bounds for display power state notification\n",
374			    intel_encoder->base.base.id, intel_encoder->base.name,
375			    port_name(intel_encoder->port), port);
376		return -EINVAL;
377	}
378
379	if (!enable)
380		parm |= 4 << 8;
381
382	switch (intel_encoder->type) {
383	case INTEL_OUTPUT_ANALOG:
384		type = DISPLAY_TYPE_CRT;
385		break;
386	case INTEL_OUTPUT_DDI:
387	case INTEL_OUTPUT_DP:
388	case INTEL_OUTPUT_HDMI:
389	case INTEL_OUTPUT_DP_MST:
390		type = DISPLAY_TYPE_EXTERNAL_FLAT_PANEL;
391		break;
392	case INTEL_OUTPUT_EDP:
393	case INTEL_OUTPUT_DSI:
394		type = DISPLAY_TYPE_INTERNAL_FLAT_PANEL;
395		break;
396	default:
397		drm_WARN_ONCE(&dev_priv->drm, 1,
398			      "unsupported intel_encoder type %d\n",
399			      intel_encoder->type);
400		return -EINVAL;
401	}
402
403	parm |= type << (16 + port * 3);
404
405	return swsci(dev_priv, SWSCI_SBCB_DISPLAY_POWER_STATE, parm, NULL);
406}
407
408static const struct {
409	pci_power_t pci_power_state;
410	u32 parm;
411} power_state_map[] = {
412	{ PCI_D0,	0x00 },
413	{ PCI_D1,	0x01 },
414	{ PCI_D2,	0x02 },
415	{ PCI_D3hot,	0x04 },
416	{ PCI_D3cold,	0x04 },
417};
418
419int intel_opregion_notify_adapter(struct drm_i915_private *dev_priv,
420				  pci_power_t state)
421{
422	int i;
423
424	if (!HAS_DDI(dev_priv))
425		return 0;
426
427	for (i = 0; i < ARRAY_SIZE(power_state_map); i++) {
428		if (state == power_state_map[i].pci_power_state)
429			return swsci(dev_priv, SWSCI_SBCB_ADAPTER_POWER_STATE,
430				     power_state_map[i].parm, NULL);
431	}
432
433	return -EINVAL;
434}
435
436static u32 asle_set_backlight(struct drm_i915_private *dev_priv, u32 bclp)
437{
438	struct intel_connector *connector;
439	struct drm_connector_list_iter conn_iter;
440	struct opregion_asle *asle = dev_priv->opregion.asle;
441	struct drm_device *dev = &dev_priv->drm;
442
443	drm_dbg(&dev_priv->drm, "bclp = 0x%08x\n", bclp);
444
445	if (acpi_video_get_backlight_type() == acpi_backlight_native) {
446		drm_dbg_kms(&dev_priv->drm,
447			    "opregion backlight request ignored\n");
448		return 0;
449	}
450
451	if (!(bclp & ASLE_BCLP_VALID))
452		return ASLC_BACKLIGHT_FAILED;
453
454	bclp &= ASLE_BCLP_MSK;
455	if (bclp > 255)
456		return ASLC_BACKLIGHT_FAILED;
457
458	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
459
460	/*
461	 * Update backlight on all connectors that support backlight (usually
462	 * only one).
463	 */
464	drm_dbg_kms(&dev_priv->drm, "updating opregion backlight %d/255\n",
465		    bclp);
466	drm_connector_list_iter_begin(dev, &conn_iter);
467	for_each_intel_connector_iter(connector, &conn_iter)
468		intel_panel_set_backlight_acpi(connector->base.state, bclp, 255);
469	drm_connector_list_iter_end(&conn_iter);
470	asle->cblv = DIV_ROUND_UP(bclp * 100, 255) | ASLE_CBLV_VALID;
471
472	drm_modeset_unlock(&dev->mode_config.connection_mutex);
473
474
475	return 0;
476}
477
478static u32 asle_set_als_illum(struct drm_i915_private *dev_priv, u32 alsi)
479{
480	/* alsi is the current ALS reading in lux. 0 indicates below sensor
481	   range, 0xffff indicates above sensor range. 1-0xfffe are valid */
482	drm_dbg(&dev_priv->drm, "Illum is not supported\n");
483	return ASLC_ALS_ILLUM_FAILED;
484}
485
486static u32 asle_set_pwm_freq(struct drm_i915_private *dev_priv, u32 pfmb)
487{
488	drm_dbg(&dev_priv->drm, "PWM freq is not supported\n");
489	return ASLC_PWM_FREQ_FAILED;
490}
491
492static u32 asle_set_pfit(struct drm_i915_private *dev_priv, u32 pfit)
493{
494	/* Panel fitting is currently controlled by the X code, so this is a
495	   noop until modesetting support works fully */
496	drm_dbg(&dev_priv->drm, "Pfit is not supported\n");
497	return ASLC_PFIT_FAILED;
498}
499
500static u32 asle_set_supported_rotation_angles(struct drm_i915_private *dev_priv, u32 srot)
501{
502	drm_dbg(&dev_priv->drm, "SROT is not supported\n");
503	return ASLC_ROTATION_ANGLES_FAILED;
504}
505
506static u32 asle_set_button_array(struct drm_i915_private *dev_priv, u32 iuer)
507{
508	if (!iuer)
509		drm_dbg(&dev_priv->drm,
510			"Button array event is not supported (nothing)\n");
511	if (iuer & ASLE_IUER_ROTATION_LOCK_BTN)
512		drm_dbg(&dev_priv->drm,
513			"Button array event is not supported (rotation lock)\n");
514	if (iuer & ASLE_IUER_VOLUME_DOWN_BTN)
515		drm_dbg(&dev_priv->drm,
516			"Button array event is not supported (volume down)\n");
517	if (iuer & ASLE_IUER_VOLUME_UP_BTN)
518		drm_dbg(&dev_priv->drm,
519			"Button array event is not supported (volume up)\n");
520	if (iuer & ASLE_IUER_WINDOWS_BTN)
521		drm_dbg(&dev_priv->drm,
522			"Button array event is not supported (windows)\n");
523	if (iuer & ASLE_IUER_POWER_BTN)
524		drm_dbg(&dev_priv->drm,
525			"Button array event is not supported (power)\n");
526
527	return ASLC_BUTTON_ARRAY_FAILED;
528}
529
530static u32 asle_set_convertible(struct drm_i915_private *dev_priv, u32 iuer)
531{
532	if (iuer & ASLE_IUER_CONVERTIBLE)
533		drm_dbg(&dev_priv->drm,
534			"Convertible is not supported (clamshell)\n");
535	else
536		drm_dbg(&dev_priv->drm,
537			"Convertible is not supported (slate)\n");
538
539	return ASLC_CONVERTIBLE_FAILED;
540}
541
542static u32 asle_set_docking(struct drm_i915_private *dev_priv, u32 iuer)
543{
544	if (iuer & ASLE_IUER_DOCKING)
545		drm_dbg(&dev_priv->drm, "Docking is not supported (docked)\n");
546	else
547		drm_dbg(&dev_priv->drm,
548			"Docking is not supported (undocked)\n");
549
550	return ASLC_DOCKING_FAILED;
551}
552
553static u32 asle_isct_state(struct drm_i915_private *dev_priv)
554{
555	drm_dbg(&dev_priv->drm, "ISCT is not supported\n");
556	return ASLC_ISCT_STATE_FAILED;
557}
558
559static void asle_work(struct work_struct *work)
560{
561	struct intel_opregion *opregion =
562		container_of(work, struct intel_opregion, asle_work);
563	struct drm_i915_private *dev_priv =
564		container_of(opregion, struct drm_i915_private, opregion);
565	struct opregion_asle *asle = dev_priv->opregion.asle;
566	u32 aslc_stat = 0;
567	u32 aslc_req;
568
569	if (!asle)
570		return;
571
572	aslc_req = asle->aslc;
573
574	if (!(aslc_req & ASLC_REQ_MSK)) {
575		drm_dbg(&dev_priv->drm,
576			"No request on ASLC interrupt 0x%08x\n", aslc_req);
577		return;
578	}
579
580	if (aslc_req & ASLC_SET_ALS_ILLUM)
581		aslc_stat |= asle_set_als_illum(dev_priv, asle->alsi);
582
583	if (aslc_req & ASLC_SET_BACKLIGHT)
584		aslc_stat |= asle_set_backlight(dev_priv, asle->bclp);
585
586	if (aslc_req & ASLC_SET_PFIT)
587		aslc_stat |= asle_set_pfit(dev_priv, asle->pfit);
588
589	if (aslc_req & ASLC_SET_PWM_FREQ)
590		aslc_stat |= asle_set_pwm_freq(dev_priv, asle->pfmb);
591
592	if (aslc_req & ASLC_SUPPORTED_ROTATION_ANGLES)
593		aslc_stat |= asle_set_supported_rotation_angles(dev_priv,
594							asle->srot);
595
596	if (aslc_req & ASLC_BUTTON_ARRAY)
597		aslc_stat |= asle_set_button_array(dev_priv, asle->iuer);
598
599	if (aslc_req & ASLC_CONVERTIBLE_INDICATOR)
600		aslc_stat |= asle_set_convertible(dev_priv, asle->iuer);
601
602	if (aslc_req & ASLC_DOCKING_INDICATOR)
603		aslc_stat |= asle_set_docking(dev_priv, asle->iuer);
604
605	if (aslc_req & ASLC_ISCT_STATE_CHANGE)
606		aslc_stat |= asle_isct_state(dev_priv);
607
608	asle->aslc = aslc_stat;
609}
610
611void intel_opregion_asle_intr(struct drm_i915_private *dev_priv)
612{
613	if (dev_priv->opregion.asle)
614		schedule_work(&dev_priv->opregion.asle_work);
615}
616
617#define ACPI_EV_DISPLAY_SWITCH (1<<0)
618#define ACPI_EV_LID            (1<<1)
619#define ACPI_EV_DOCK           (1<<2)
620
621/*
622 * The only video events relevant to opregion are 0x80. These indicate either a
623 * docking event, lid switch or display switch request. In Linux, these are
624 * handled by the dock, button and video drivers.
625 */
626static int intel_opregion_video_event(struct notifier_block *nb,
627				      unsigned long val, void *data)
628{
629	struct intel_opregion *opregion = container_of(nb, struct intel_opregion,
630						       acpi_notifier);
631	struct acpi_bus_event *event = data;
632	struct opregion_acpi *acpi;
633	int ret = NOTIFY_OK;
634
635	if (strcmp(event->device_class, ACPI_VIDEO_CLASS) != 0)
636		return NOTIFY_DONE;
637
638	acpi = opregion->acpi;
639
640	if (event->type == 0x80 && ((acpi->cevt & 1) == 0))
641		ret = NOTIFY_BAD;
642
643	acpi->csts = 0;
644
645	return ret;
646}
647
648/*
649 * Initialise the DIDL field in opregion. This passes a list of devices to
650 * the firmware. Values are defined by section B.4.2 of the ACPI specification
651 * (version 3)
652 */
653
654static void set_did(struct intel_opregion *opregion, int i, u32 val)
655{
656	if (i < ARRAY_SIZE(opregion->acpi->didl)) {
657		opregion->acpi->didl[i] = val;
658	} else {
659		i -= ARRAY_SIZE(opregion->acpi->didl);
660
661		if (WARN_ON(i >= ARRAY_SIZE(opregion->acpi->did2)))
662			return;
663
664		opregion->acpi->did2[i] = val;
665	}
666}
667
668static void intel_didl_outputs(struct drm_i915_private *dev_priv)
669{
670	struct intel_opregion *opregion = &dev_priv->opregion;
671	struct intel_connector *connector;
672	struct drm_connector_list_iter conn_iter;
673	int i = 0, max_outputs;
674
675	/*
676	 * In theory, did2, the extended didl, gets added at opregion version
677	 * 3.0. In practice, however, we're supposed to set it for earlier
678	 * versions as well, since a BIOS that doesn't understand did2 should
679	 * not look at it anyway. Use a variable so we can tweak this if a need
680	 * arises later.
681	 */
682	max_outputs = ARRAY_SIZE(opregion->acpi->didl) +
683		ARRAY_SIZE(opregion->acpi->did2);
684
685	intel_acpi_device_id_update(dev_priv);
686
687	drm_connector_list_iter_begin(&dev_priv->drm, &conn_iter);
688	for_each_intel_connector_iter(connector, &conn_iter) {
689		if (i < max_outputs)
690			set_did(opregion, i, connector->acpi_device_id);
691		i++;
692	}
693	drm_connector_list_iter_end(&conn_iter);
694
695	drm_dbg_kms(&dev_priv->drm, "%d outputs detected\n", i);
696
697	if (i > max_outputs)
698		drm_err(&dev_priv->drm,
699			"More than %d outputs in connector list\n",
700			max_outputs);
701
702	/* If fewer than max outputs, the list must be null terminated */
703	if (i < max_outputs)
704		set_did(opregion, i, 0);
705}
706
707static void intel_setup_cadls(struct drm_i915_private *dev_priv)
708{
709	struct intel_opregion *opregion = &dev_priv->opregion;
710	struct intel_connector *connector;
711	struct drm_connector_list_iter conn_iter;
712	int i = 0;
713
714	/*
715	 * Initialize the CADL field from the connector device ids. This is
716	 * essentially the same as copying from the DIDL. Technically, this is
717	 * not always correct as display outputs may exist, but not active. This
718	 * initialization is necessary for some Clevo laptops that check this
719	 * field before processing the brightness and display switching hotkeys.
720	 *
721	 * Note that internal panels should be at the front of the connector
722	 * list already, ensuring they're not left out.
723	 */
724	drm_connector_list_iter_begin(&dev_priv->drm, &conn_iter);
725	for_each_intel_connector_iter(connector, &conn_iter) {
726		if (i >= ARRAY_SIZE(opregion->acpi->cadl))
727			break;
728		opregion->acpi->cadl[i++] = connector->acpi_device_id;
729	}
730	drm_connector_list_iter_end(&conn_iter);
731
732	/* If fewer than 8 active devices, the list must be null terminated */
733	if (i < ARRAY_SIZE(opregion->acpi->cadl))
734		opregion->acpi->cadl[i] = 0;
735}
736
737static void swsci_setup(struct drm_i915_private *dev_priv)
738{
739	struct intel_opregion *opregion = &dev_priv->opregion;
740	bool requested_callbacks = false;
741	u32 tmp;
742
743	/* Sub-function code 0 is okay, let's allow them. */
744	opregion->swsci_gbda_sub_functions = 1;
745	opregion->swsci_sbcb_sub_functions = 1;
746
747	/* We use GBDA to ask for supported GBDA calls. */
748	if (swsci(dev_priv, SWSCI_GBDA_SUPPORTED_CALLS, 0, &tmp) == 0) {
749		/* make the bits match the sub-function codes */
750		tmp <<= 1;
751		opregion->swsci_gbda_sub_functions |= tmp;
752	}
753
754	/*
755	 * We also use GBDA to ask for _requested_ SBCB callbacks. The driver
756	 * must not call interfaces that are not specifically requested by the
757	 * bios.
758	 */
759	if (swsci(dev_priv, SWSCI_GBDA_REQUESTED_CALLBACKS, 0, &tmp) == 0) {
760		/* here, the bits already match sub-function codes */
761		opregion->swsci_sbcb_sub_functions |= tmp;
762		requested_callbacks = true;
763	}
764
765	/*
766	 * But we use SBCB to ask for _supported_ SBCB calls. This does not mean
767	 * the callback is _requested_. But we still can't call interfaces that
768	 * are not requested.
769	 */
770	if (swsci(dev_priv, SWSCI_SBCB_SUPPORTED_CALLBACKS, 0, &tmp) == 0) {
771		/* make the bits match the sub-function codes */
772		u32 low = tmp & 0x7ff;
773		u32 high = tmp & ~0xfff; /* bit 11 is reserved */
774		tmp = (high << 4) | (low << 1) | 1;
775
776		/* best guess what to do with supported wrt requested */
777		if (requested_callbacks) {
778			u32 req = opregion->swsci_sbcb_sub_functions;
779			if ((req & tmp) != req)
780				drm_dbg(&dev_priv->drm,
781					"SWSCI BIOS requested (%08x) SBCB callbacks that are not supported (%08x)\n",
782					req, tmp);
783			/* XXX: for now, trust the requested callbacks */
784			/* opregion->swsci_sbcb_sub_functions &= tmp; */
785		} else {
786			opregion->swsci_sbcb_sub_functions |= tmp;
787		}
788	}
789
790	drm_dbg(&dev_priv->drm,
791		"SWSCI GBDA callbacks %08x, SBCB callbacks %08x\n",
792		opregion->swsci_gbda_sub_functions,
793		opregion->swsci_sbcb_sub_functions);
794}
795
796static int intel_no_opregion_vbt_callback(const struct dmi_system_id *id)
797{
798	DRM_DEBUG_KMS("Falling back to manually reading VBT from "
799		      "VBIOS ROM for %s\n", id->ident);
800	return 1;
801}
802
803static const struct dmi_system_id intel_no_opregion_vbt[] = {
804	{
805		.callback = intel_no_opregion_vbt_callback,
806		.ident = "ThinkCentre A57",
807		.matches = {
808			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
809			DMI_MATCH(DMI_PRODUCT_NAME, "97027RG"),
810		},
811	},
812	{ }
813};
814
815static int intel_load_vbt_firmware(struct drm_i915_private *dev_priv)
816{
817	struct intel_opregion *opregion = &dev_priv->opregion;
818	const struct firmware *fw = NULL;
819	const char *name = dev_priv->params.vbt_firmware;
820	int ret;
821
822	if (!name || !*name)
823		return -ENOENT;
824
825	ret = request_firmware(&fw, name, &dev_priv->drm.pdev->dev);
826	if (ret) {
827		drm_err(&dev_priv->drm,
828			"Requesting VBT firmware \"%s\" failed (%d)\n",
829			name, ret);
830		return ret;
831	}
832
833	if (intel_bios_is_valid_vbt(fw->data, fw->size)) {
834		opregion->vbt_firmware = kmemdup(fw->data, fw->size, GFP_KERNEL);
835		if (opregion->vbt_firmware) {
836			drm_dbg_kms(&dev_priv->drm,
837				    "Found valid VBT firmware \"%s\"\n", name);
838			opregion->vbt = opregion->vbt_firmware;
839			opregion->vbt_size = fw->size;
840			ret = 0;
841		} else {
842			ret = -ENOMEM;
843		}
844	} else {
845		drm_dbg_kms(&dev_priv->drm, "Invalid VBT firmware \"%s\"\n",
846			    name);
847		ret = -EINVAL;
848	}
849
850	release_firmware(fw);
851
852	return ret;
853}
854
855int intel_opregion_setup(struct drm_i915_private *dev_priv)
856{
857	struct intel_opregion *opregion = &dev_priv->opregion;
858	struct pci_dev *pdev = dev_priv->drm.pdev;
859	u32 asls, mboxes;
860	char buf[sizeof(OPREGION_SIGNATURE)];
861	int err = 0;
862	void *base;
863	const void *vbt;
864	u32 vbt_size;
865
866	BUILD_BUG_ON(sizeof(struct opregion_header) != 0x100);
867	BUILD_BUG_ON(sizeof(struct opregion_acpi) != 0x100);
868	BUILD_BUG_ON(sizeof(struct opregion_swsci) != 0x100);
869	BUILD_BUG_ON(sizeof(struct opregion_asle) != 0x100);
870	BUILD_BUG_ON(sizeof(struct opregion_asle_ext) != 0x400);
871
872	pci_read_config_dword(pdev, ASLS, &asls);
873	drm_dbg(&dev_priv->drm, "graphic opregion physical addr: 0x%x\n",
874		asls);
875	if (asls == 0) {
876		drm_dbg(&dev_priv->drm, "ACPI OpRegion not supported!\n");
877		return -ENOTSUPP;
878	}
879
880	INIT_WORK(&opregion->asle_work, asle_work);
881
882	base = memremap(asls, OPREGION_SIZE, MEMREMAP_WB);
883	if (!base)
884		return -ENOMEM;
885
886	memcpy(buf, base, sizeof(buf));
887
888	if (memcmp(buf, OPREGION_SIGNATURE, 16)) {
889		drm_dbg(&dev_priv->drm, "opregion signature mismatch\n");
890		err = -EINVAL;
891		goto err_out;
892	}
893	opregion->header = base;
894	opregion->lid_state = base + ACPI_CLID;
895
896	drm_dbg(&dev_priv->drm, "ACPI OpRegion version %u.%u.%u\n",
897		opregion->header->over.major,
898		opregion->header->over.minor,
899		opregion->header->over.revision);
900
901	mboxes = opregion->header->mboxes;
902	if (mboxes & MBOX_ACPI) {
903		drm_dbg(&dev_priv->drm, "Public ACPI methods supported\n");
904		opregion->acpi = base + OPREGION_ACPI_OFFSET;
905		/*
906		 * Indicate we handle monitor hotplug events ourselves so we do
907		 * not need ACPI notifications for them. Disabling these avoids
908		 * triggering the AML code doing the notifation, which may be
909		 * broken as Windows also seems to disable these.
910		 */
911		opregion->acpi->chpd = 1;
912	}
913
914	if (mboxes & MBOX_SWSCI) {
915		drm_dbg(&dev_priv->drm, "SWSCI supported\n");
916		opregion->swsci = base + OPREGION_SWSCI_OFFSET;
917		swsci_setup(dev_priv);
918	}
919
920	if (mboxes & MBOX_ASLE) {
921		drm_dbg(&dev_priv->drm, "ASLE supported\n");
922		opregion->asle = base + OPREGION_ASLE_OFFSET;
923
924		opregion->asle->ardy = ASLE_ARDY_NOT_READY;
925	}
926
927	if (mboxes & MBOX_ASLE_EXT)
928		drm_dbg(&dev_priv->drm, "ASLE extension supported\n");
929
930	if (intel_load_vbt_firmware(dev_priv) == 0)
931		goto out;
932
933	if (dmi_check_system(intel_no_opregion_vbt))
934		goto out;
935
936	if (opregion->header->over.major >= 2 && opregion->asle &&
937	    opregion->asle->rvda && opregion->asle->rvds) {
938		resource_size_t rvda = opregion->asle->rvda;
939
940		/*
941		 * opregion 2.0: rvda is the physical VBT address.
942		 *
943		 * opregion 2.1+: rvda is unsigned, relative offset from
944		 * opregion base, and should never point within opregion.
945		 */
946		if (opregion->header->over.major > 2 ||
947		    opregion->header->over.minor >= 1) {
948			drm_WARN_ON(&dev_priv->drm, rvda < OPREGION_SIZE);
949
950			rvda += asls;
951		}
952
953		opregion->rvda = memremap(rvda, opregion->asle->rvds,
954					  MEMREMAP_WB);
955
956		vbt = opregion->rvda;
957		vbt_size = opregion->asle->rvds;
958		if (intel_bios_is_valid_vbt(vbt, vbt_size)) {
959			drm_dbg_kms(&dev_priv->drm,
960				    "Found valid VBT in ACPI OpRegion (RVDA)\n");
961			opregion->vbt = vbt;
962			opregion->vbt_size = vbt_size;
963			goto out;
964		} else {
965			drm_dbg_kms(&dev_priv->drm,
966				    "Invalid VBT in ACPI OpRegion (RVDA)\n");
967			memunmap(opregion->rvda);
968			opregion->rvda = NULL;
969		}
970	}
971
972	vbt = base + OPREGION_VBT_OFFSET;
973	/*
974	 * The VBT specification says that if the ASLE ext mailbox is not used
975	 * its area is reserved, but on some CHT boards the VBT extends into the
976	 * ASLE ext area. Allow this even though it is against the spec, so we
977	 * do not end up rejecting the VBT on those boards (and end up not
978	 * finding the LCD panel because of this).
979	 */
980	vbt_size = (mboxes & MBOX_ASLE_EXT) ?
981		OPREGION_ASLE_EXT_OFFSET : OPREGION_SIZE;
982	vbt_size -= OPREGION_VBT_OFFSET;
983	if (intel_bios_is_valid_vbt(vbt, vbt_size)) {
984		drm_dbg_kms(&dev_priv->drm,
985			    "Found valid VBT in ACPI OpRegion (Mailbox #4)\n");
986		opregion->vbt = vbt;
987		opregion->vbt_size = vbt_size;
988	} else {
989		drm_dbg_kms(&dev_priv->drm,
990			    "Invalid VBT in ACPI OpRegion (Mailbox #4)\n");
991	}
992
993out:
994	return 0;
995
996err_out:
997	memunmap(base);
998	return err;
999}
1000
1001static int intel_use_opregion_panel_type_callback(const struct dmi_system_id *id)
1002{
1003	DRM_INFO("Using panel type from OpRegion on %s\n", id->ident);
1004	return 1;
1005}
1006
1007static const struct dmi_system_id intel_use_opregion_panel_type[] = {
1008	{
1009		.callback = intel_use_opregion_panel_type_callback,
1010		.ident = "Conrac GmbH IX45GM2",
1011		.matches = {DMI_MATCH(DMI_SYS_VENDOR, "Conrac GmbH"),
1012			    DMI_MATCH(DMI_PRODUCT_NAME, "IX45GM2"),
1013		},
1014	},
1015	{ }
1016};
1017
1018int
1019intel_opregion_get_panel_type(struct drm_i915_private *dev_priv)
1020{
1021	u32 panel_details;
1022	int ret;
1023
1024	ret = swsci(dev_priv, SWSCI_GBDA_PANEL_DETAILS, 0x0, &panel_details);
1025	if (ret) {
1026		drm_dbg_kms(&dev_priv->drm,
1027			    "Failed to get panel details from OpRegion (%d)\n",
1028			    ret);
1029		return ret;
1030	}
1031
1032	ret = (panel_details >> 8) & 0xff;
1033	if (ret > 0x10) {
1034		drm_dbg_kms(&dev_priv->drm,
1035			    "Invalid OpRegion panel type 0x%x\n", ret);
1036		return -EINVAL;
1037	}
1038
1039	/* fall back to VBT panel type? */
1040	if (ret == 0x0) {
1041		drm_dbg_kms(&dev_priv->drm, "No panel type in OpRegion\n");
1042		return -ENODEV;
1043	}
1044
1045	/*
1046	 * So far we know that some machined must use it, others must not use it.
1047	 * There doesn't seem to be any way to determine which way to go, except
1048	 * via a quirk list :(
1049	 */
1050	if (!dmi_check_system(intel_use_opregion_panel_type)) {
1051		drm_dbg_kms(&dev_priv->drm,
1052			    "Ignoring OpRegion panel type (%d)\n", ret - 1);
1053		return -ENODEV;
1054	}
1055
1056	return ret - 1;
1057}
1058
1059void intel_opregion_register(struct drm_i915_private *i915)
1060{
1061	struct intel_opregion *opregion = &i915->opregion;
1062
1063	if (!opregion->header)
1064		return;
1065
1066	if (opregion->acpi) {
1067		opregion->acpi_notifier.notifier_call =
1068			intel_opregion_video_event;
1069		register_acpi_notifier(&opregion->acpi_notifier);
1070	}
1071
1072	intel_opregion_resume(i915);
1073}
1074
1075void intel_opregion_resume(struct drm_i915_private *i915)
1076{
1077	struct intel_opregion *opregion = &i915->opregion;
1078
1079	if (!opregion->header)
1080		return;
1081
1082	if (opregion->acpi) {
1083		intel_didl_outputs(i915);
1084		intel_setup_cadls(i915);
1085
1086		/*
1087		 * Notify BIOS we are ready to handle ACPI video ext notifs.
1088		 * Right now, all the events are handled by the ACPI video
1089		 * module. We don't actually need to do anything with them.
1090		 */
1091		opregion->acpi->csts = 0;
1092		opregion->acpi->drdy = 1;
1093	}
1094
1095	if (opregion->asle) {
1096		opregion->asle->tche = ASLE_TCHE_BLC_EN;
1097		opregion->asle->ardy = ASLE_ARDY_READY;
1098	}
1099
1100	intel_opregion_notify_adapter(i915, PCI_D0);
1101}
1102
1103void intel_opregion_suspend(struct drm_i915_private *i915, pci_power_t state)
1104{
1105	struct intel_opregion *opregion = &i915->opregion;
1106
1107	if (!opregion->header)
1108		return;
1109
1110	intel_opregion_notify_adapter(i915, state);
1111
1112	if (opregion->asle)
1113		opregion->asle->ardy = ASLE_ARDY_NOT_READY;
1114
1115	cancel_work_sync(&i915->opregion.asle_work);
1116
1117	if (opregion->acpi)
1118		opregion->acpi->drdy = 0;
1119}
1120
1121void intel_opregion_unregister(struct drm_i915_private *i915)
1122{
1123	struct intel_opregion *opregion = &i915->opregion;
1124
1125	intel_opregion_suspend(i915, PCI_D1);
1126
1127	if (!opregion->header)
1128		return;
1129
1130	if (opregion->acpi_notifier.notifier_call) {
1131		unregister_acpi_notifier(&opregion->acpi_notifier);
1132		opregion->acpi_notifier.notifier_call = NULL;
1133	}
1134
1135	/* just clear all opregion memory pointers now */
1136	memunmap(opregion->header);
1137	if (opregion->rvda) {
1138		memunmap(opregion->rvda);
1139		opregion->rvda = NULL;
1140	}
1141	if (opregion->vbt_firmware) {
1142		kfree(opregion->vbt_firmware);
1143		opregion->vbt_firmware = NULL;
1144	}
1145	opregion->header = NULL;
1146	opregion->acpi = NULL;
1147	opregion->swsci = NULL;
1148	opregion->asle = NULL;
1149	opregion->vbt = NULL;
1150	opregion->lid_state = NULL;
1151}
1152