xref: /dragonfly/sys/dev/drm/i915/intel_opregion.c (revision 4d962a29)
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 
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 
48 #define OPREGION_SIGNATURE "IntelGraphicsMem"
49 #define MBOX_ACPI      (1<<0)
50 #define MBOX_SWSCI     (1<<1)
51 #define MBOX_ASLE      (1<<2)
52 
53 struct opregion_header {
54 	u8 signature[16];
55 	u32 size;
56 	u32 opregion_ver;
57 	u8 bios_ver[32];
58 	u8 vbios_ver[16];
59 	u8 driver_ver[16];
60 	u32 mboxes;
61 	u8 reserved[164];
62 } __attribute__((packed));
63 
64 /* OpRegion mailbox #1: public ACPI methods */
65 struct opregion_acpi {
66 	u32 drdy;       /* driver readiness */
67 	u32 csts;       /* notification status */
68 	u32 cevt;       /* current event */
69 	u8 rsvd1[20];
70 	u32 didl[8];    /* supported display devices ID list */
71 	u32 cpdl[8];    /* currently presented display list */
72 	u32 cadl[8];    /* currently active display list */
73 	u32 nadl[8];    /* next active devices list */
74 	u32 aslp;       /* ASL sleep time-out */
75 	u32 tidx;       /* toggle table index */
76 	u32 chpd;       /* current hotplug enable indicator */
77 	u32 clid;       /* current lid state*/
78 	u32 cdck;       /* current docking state */
79 	u32 sxsw;       /* Sx state resume */
80 	u32 evts;       /* ASL supported events */
81 	u32 cnot;       /* current OS notification */
82 	u32 nrdy;       /* driver status */
83 	u8 rsvd2[60];
84 } __attribute__((packed));
85 
86 /* OpRegion mailbox #2: SWSCI */
87 struct opregion_swsci {
88 	u32 scic;       /* SWSCI command|status|data */
89 	u32 parm;       /* command parameters */
90 	u32 dslp;       /* driver sleep time-out */
91 	u8 rsvd[244];
92 } __attribute__((packed));
93 
94 /* OpRegion mailbox #3: ASLE */
95 struct opregion_asle {
96 	u32 ardy;       /* driver readiness */
97 	u32 aslc;       /* ASLE interrupt command */
98 	u32 tche;       /* technology enabled indicator */
99 	u32 alsi;       /* current ALS illuminance reading */
100 	u32 bclp;       /* backlight brightness to set */
101 	u32 pfit;       /* panel fitting state */
102 	u32 cblv;       /* current brightness level */
103 	u16 bclm[20];   /* backlight level duty cycle mapping table */
104 	u32 cpfm;       /* current panel fitting mode */
105 	u32 epfm;       /* enabled panel fitting modes */
106 	u8 plut[74];    /* panel LUT and identifier */
107 	u32 pfmb;       /* PWM freq and min brightness */
108 	u8 rsvd[102];
109 } __attribute__((packed));
110 
111 /* ASLE irq request bits */
112 #define ASLE_SET_ALS_ILLUM     (1 << 0)
113 #define ASLE_SET_BACKLIGHT     (1 << 1)
114 #define ASLE_SET_PFIT          (1 << 2)
115 #define ASLE_SET_PWM_FREQ      (1 << 3)
116 #define ASLE_REQ_MSK           0xf
117 
118 /* response bits of ASLE irq request */
119 #define ASLE_ALS_ILLUM_FAILED	(1<<10)
120 #define ASLE_BACKLIGHT_FAILED	(1<<12)
121 #define ASLE_PFIT_FAILED	(1<<14)
122 #define ASLE_PWM_FREQ_FAILED	(1<<16)
123 
124 /* ASLE backlight brightness to set */
125 #define ASLE_BCLP_VALID                (1<<31)
126 #define ASLE_BCLP_MSK          (~(1<<31))
127 
128 /* ASLE panel fitting request */
129 #define ASLE_PFIT_VALID         (1<<31)
130 #define ASLE_PFIT_CENTER (1<<0)
131 #define ASLE_PFIT_STRETCH_TEXT (1<<1)
132 #define ASLE_PFIT_STRETCH_GFX (1<<2)
133 
134 /* PWM frequency and minimum brightness */
135 #define ASLE_PFMB_BRIGHTNESS_MASK (0xff)
136 #define ASLE_PFMB_BRIGHTNESS_VALID (1<<8)
137 #define ASLE_PFMB_PWM_MASK (0x7ffffe00)
138 #define ASLE_PFMB_PWM_VALID (1<<31)
139 
140 #define ASLE_CBLV_VALID         (1<<31)
141 
142 #define ACPI_OTHER_OUTPUT (0<<8)
143 #define ACPI_VGA_OUTPUT (1<<8)
144 #define ACPI_TV_OUTPUT (2<<8)
145 #define ACPI_DIGITAL_OUTPUT (3<<8)
146 #define ACPI_LVDS_OUTPUT (4<<8)
147 
148 static u32 asle_set_backlight(struct drm_device *dev, u32 bclp)
149 {
150 	struct drm_i915_private *dev_priv = dev->dev_private;
151 	struct opregion_asle __iomem *asle = dev_priv->opregion.asle;
152 	u32 max;
153 
154 	DRM_DEBUG_DRIVER("bclp = 0x%08x\n", bclp);
155 
156 	if (!(bclp & ASLE_BCLP_VALID))
157 		return ASLE_BACKLIGHT_FAILED;
158 
159 	bclp &= ASLE_BCLP_MSK;
160 	if (bclp > 255)
161 		return ASLE_BACKLIGHT_FAILED;
162 
163 	max = intel_panel_get_max_backlight(dev);
164 	intel_panel_set_backlight(dev, bclp * max / 255);
165 	iowrite32((bclp*0x64)/0xff | ASLE_CBLV_VALID, &asle->cblv);
166 
167 	return 0;
168 }
169 
170 static u32 asle_set_als_illum(struct drm_device *dev, u32 alsi)
171 {
172 	/* alsi is the current ALS reading in lux. 0 indicates below sensor
173 	   range, 0xffff indicates above sensor range. 1-0xfffe are valid */
174 	return 0;
175 }
176 
177 static u32 asle_set_pwm_freq(struct drm_device *dev, u32 pfmb)
178 {
179 	struct drm_i915_private *dev_priv = dev->dev_private;
180 	if (pfmb & ASLE_PFMB_PWM_VALID) {
181 		u32 blc_pwm_ctl = I915_READ(BLC_PWM_CTL);
182 		u32 pwm = pfmb & ASLE_PFMB_PWM_MASK;
183 		blc_pwm_ctl &= BACKLIGHT_DUTY_CYCLE_MASK;
184 		pwm = pwm >> 9;
185 		/* FIXME - what do we do with the PWM? */
186 	}
187 	return 0;
188 }
189 
190 static u32 asle_set_pfit(struct drm_device *dev, u32 pfit)
191 {
192 	/* Panel fitting is currently controlled by the X code, so this is a
193 	   noop until modesetting support works fully */
194 	if (!(pfit & ASLE_PFIT_VALID))
195 		return ASLE_PFIT_FAILED;
196 	return 0;
197 }
198 
199 void intel_opregion_asle_intr(struct drm_device *dev)
200 {
201 	struct drm_i915_private *dev_priv = dev->dev_private;
202 	struct opregion_asle __iomem *asle = dev_priv->opregion.asle;
203 	u32 asle_stat = 0;
204 	u32 asle_req;
205 
206 	if (!asle)
207 		return;
208 
209 	asle_req = ioread32(&asle->aslc) & ASLE_REQ_MSK;
210 
211 	if (!asle_req) {
212 		DRM_DEBUG_DRIVER("non asle set request??\n");
213 		return;
214 	}
215 
216 	if (asle_req & ASLE_SET_ALS_ILLUM)
217 		asle_stat |= asle_set_als_illum(dev, ioread32(&asle->alsi));
218 
219 	if (asle_req & ASLE_SET_BACKLIGHT)
220 		asle_stat |= asle_set_backlight(dev, ioread32(&asle->bclp));
221 
222 	if (asle_req & ASLE_SET_PFIT)
223 		asle_stat |= asle_set_pfit(dev, ioread32(&asle->pfit));
224 
225 	if (asle_req & ASLE_SET_PWM_FREQ)
226 		asle_stat |= asle_set_pwm_freq(dev, ioread32(&asle->pfmb));
227 
228 	iowrite32(asle_stat, &asle->aslc);
229 }
230 
231 void intel_opregion_gse_intr(struct drm_device *dev)
232 {
233 	struct drm_i915_private *dev_priv = dev->dev_private;
234 	struct opregion_asle __iomem *asle = dev_priv->opregion.asle;
235 	u32 asle_stat = 0;
236 	u32 asle_req;
237 
238 	if (!asle)
239 		return;
240 
241 	asle_req = ioread32(&asle->aslc) & ASLE_REQ_MSK;
242 
243 	if (!asle_req) {
244 		DRM_DEBUG_DRIVER("non asle set request??\n");
245 		return;
246 	}
247 
248 	if (asle_req & ASLE_SET_ALS_ILLUM) {
249 		DRM_DEBUG_DRIVER("Illum is not supported\n");
250 		asle_stat |= ASLE_ALS_ILLUM_FAILED;
251 	}
252 
253 	if (asle_req & ASLE_SET_BACKLIGHT)
254 		asle_stat |= asle_set_backlight(dev, ioread32(&asle->bclp));
255 
256 	if (asle_req & ASLE_SET_PFIT) {
257 		DRM_DEBUG_DRIVER("Pfit is not supported\n");
258 		asle_stat |= ASLE_PFIT_FAILED;
259 	}
260 
261 	if (asle_req & ASLE_SET_PWM_FREQ) {
262 		DRM_DEBUG_DRIVER("PWM freq is not supported\n");
263 		asle_stat |= ASLE_PWM_FREQ_FAILED;
264 	}
265 
266 	iowrite32(asle_stat, &asle->aslc);
267 }
268 #define ASLE_ALS_EN    (1<<0)
269 #define ASLE_BLC_EN    (1<<1)
270 #define ASLE_PFIT_EN   (1<<2)
271 #define ASLE_PFMB_EN   (1<<3)
272 
273 void intel_opregion_enable_asle(struct drm_device *dev)
274 {
275 	struct drm_i915_private *dev_priv = dev->dev_private;
276 	struct opregion_asle __iomem *asle = dev_priv->opregion.asle;
277 
278 	if (asle) {
279 		if (IS_MOBILE(dev))
280 			intel_enable_asle(dev);
281 
282 		iowrite32(ASLE_ALS_EN | ASLE_BLC_EN | ASLE_PFIT_EN |
283 			  ASLE_PFMB_EN,
284 			  &asle->tche);
285 		iowrite32(1, &asle->ardy);
286 	}
287 }
288 
289 #define ACPI_EV_DISPLAY_SWITCH (1<<0)
290 #define ACPI_EV_LID            (1<<1)
291 #define ACPI_EV_DOCK           (1<<2)
292 
293 static struct intel_opregion *system_opregion;
294 
295 #if 0
296 static int intel_opregion_video_event(struct notifier_block *nb,
297 				      unsigned long val, void *data)
298 {
299 	/* The only video events relevant to opregion are 0x80. These indicate
300 	   either a docking event, lid switch or display switch request. In
301 	   Linux, these are handled by the dock, button and video drivers.
302 	*/
303 
304 	struct opregion_acpi __iomem *acpi;
305 	struct acpi_bus_event *event = data;
306 	int ret = NOTIFY_OK;
307 
308 	if (strcmp(event->device_class, ACPI_VIDEO_CLASS) != 0)
309 		return NOTIFY_DONE;
310 
311 	if (!system_opregion)
312 		return NOTIFY_DONE;
313 
314 	acpi = system_opregion->acpi;
315 
316 	if (event->type == 0x80 &&
317 	    (ioread32(&acpi->cevt) & 1) == 0)
318 		ret = NOTIFY_BAD;
319 
320 	iowrite32(0, &acpi->csts);
321 
322 	return ret;
323 }
324 
325 static struct notifier_block intel_opregion_notifier = {
326 	.notifier_call = intel_opregion_video_event,
327 };
328 #endif
329 
330 static int acpi_is_video_device(ACPI_HANDLE devh) {
331 	ACPI_HANDLE h;
332 	if (ACPI_FAILURE(AcpiGetHandle(devh, "_DOD", &h)) ||
333 	    ACPI_FAILURE(AcpiGetHandle(devh, "_DOS", &h))) {
334 		return 0;
335 	}
336 	return 1;
337 }
338 
339 /*
340  * Initialise the DIDL field in opregion. This passes a list of devices to
341  * the firmware. Values are defined by section B.4.2 of the ACPI specification
342  * (version 3)
343  */
344 
345 static void intel_didl_outputs(struct drm_device *dev)
346 {
347 	struct drm_i915_private *dev_priv = dev->dev_private;
348 	struct intel_opregion *opregion = &dev_priv->opregion;
349 	struct drm_connector *connector;
350 	ACPI_HANDLE handle, acpi_cdev, acpi_video_bus;
351 	u32 device_id;
352 	ACPI_STATUS status;
353 	u32 temp;
354 	int i = 0;
355 
356 	handle = acpi_get_handle(dev->dev);
357 	if (!handle)
358 		return;
359 
360 	if (acpi_is_video_device(handle))
361 		acpi_video_bus = handle;
362 	else {
363 		acpi_cdev = NULL;
364 		acpi_video_bus = NULL;
365 		while (AcpiGetNextObject(ACPI_TYPE_DEVICE, handle, acpi_cdev,
366 					 &acpi_cdev) != AE_NOT_FOUND) {
367 			if (acpi_is_video_device(acpi_cdev)) {
368 				acpi_video_bus = acpi_cdev;
369 				break;
370 			}
371 		}
372 	}
373 
374 	if (!acpi_video_bus) {
375 		pr_warn("No ACPI video bus found\n");
376 		return;
377 	}
378 
379 	acpi_cdev = NULL;
380 	while (AcpiGetNextObject(ACPI_TYPE_DEVICE, acpi_video_bus, acpi_cdev,
381 				 &acpi_cdev) != AE_NOT_FOUND) {
382 		if (i >= 8) {
383 			device_printf(dev->dev,
384 				    "More than 8 outputs detected\n");
385 			return;
386 		}
387 		status = acpi_GetInteger(acpi_cdev, "_ADR", &device_id);
388 		if (ACPI_SUCCESS(status)) {
389 			if (!device_id)
390 				goto blind_set;
391 			iowrite32((u32)(device_id & 0x0f0f),
392 				  &opregion->acpi->didl[i]);
393 			i++;
394 		}
395 	}
396 
397 end:
398 	/* If fewer than 8 outputs, the list must be null terminated */
399 	if (i < 8)
400 		iowrite32(0, &opregion->acpi->didl[i]);
401 	return;
402 
403 blind_set:
404 	i = 0;
405 	list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
406 		int output_type = ACPI_OTHER_OUTPUT;
407 		if (i >= 8) {
408 			device_printf(dev->dev,
409 				    "More than 8 outputs detected\n");
410 			return;
411 		}
412 		switch (connector->connector_type) {
413 		case DRM_MODE_CONNECTOR_VGA:
414 		case DRM_MODE_CONNECTOR_DVIA:
415 			output_type = ACPI_VGA_OUTPUT;
416 			break;
417 		case DRM_MODE_CONNECTOR_Composite:
418 		case DRM_MODE_CONNECTOR_SVIDEO:
419 		case DRM_MODE_CONNECTOR_Component:
420 		case DRM_MODE_CONNECTOR_9PinDIN:
421 			output_type = ACPI_TV_OUTPUT;
422 			break;
423 		case DRM_MODE_CONNECTOR_DVII:
424 		case DRM_MODE_CONNECTOR_DVID:
425 		case DRM_MODE_CONNECTOR_DisplayPort:
426 		case DRM_MODE_CONNECTOR_HDMIA:
427 		case DRM_MODE_CONNECTOR_HDMIB:
428 			output_type = ACPI_DIGITAL_OUTPUT;
429 			break;
430 		case DRM_MODE_CONNECTOR_LVDS:
431 			output_type = ACPI_LVDS_OUTPUT;
432 			break;
433 		}
434 		temp = ioread32(&opregion->acpi->didl[i]);
435 		iowrite32(temp | (1<<31) | output_type | i,
436 			  &opregion->acpi->didl[i]);
437 		i++;
438 	}
439 	goto end;
440 }
441 
442 static void intel_setup_cadls(struct drm_device *dev)
443 {
444 	struct drm_i915_private *dev_priv = dev->dev_private;
445 	struct intel_opregion *opregion = &dev_priv->opregion;
446 	int i = 0;
447 	u32 disp_id;
448 
449 	/* Initialize the CADL field by duplicating the DIDL values.
450 	 * Technically, this is not always correct as display outputs may exist,
451 	 * but not active. This initialization is necessary for some Clevo
452 	 * laptops that check this field before processing the brightness and
453 	 * display switching hotkeys. Just like DIDL, CADL is NULL-terminated if
454 	 * there are less than eight devices. */
455 	do {
456 		disp_id = ioread32(&opregion->acpi->didl[i]);
457 		iowrite32(disp_id, &opregion->acpi->cadl[i]);
458 	} while (++i < 8 && disp_id != 0);
459 }
460 
461 void intel_opregion_init(struct drm_device *dev)
462 {
463 	struct drm_i915_private *dev_priv = dev->dev_private;
464 	struct intel_opregion *opregion = &dev_priv->opregion;
465 
466 	if (!opregion->header)
467 		return;
468 
469 	if (opregion->acpi) {
470 		if (drm_core_check_feature(dev, DRIVER_MODESET)) {
471 			intel_didl_outputs(dev);
472 			intel_setup_cadls(dev);
473 		}
474 
475 		/* Notify BIOS we are ready to handle ACPI video ext notifs.
476 		 * Right now, all the events are handled by the ACPI video module.
477 		 * We don't actually need to do anything with them. */
478 		iowrite32(0, &opregion->acpi->csts);
479 		iowrite32(1, &opregion->acpi->drdy);
480 
481 		system_opregion = opregion;
482 	}
483 
484 	if (opregion->asle)
485 		intel_opregion_enable_asle(dev);
486 }
487 
488 void intel_opregion_fini(struct drm_device *dev)
489 {
490 	struct drm_i915_private *dev_priv = dev->dev_private;
491 	struct intel_opregion *opregion = &dev_priv->opregion;
492 
493 	if (!opregion->header)
494 		return;
495 
496 	if (opregion->acpi) {
497 		iowrite32(0, &opregion->acpi->drdy);
498 
499 		system_opregion = NULL;
500 	}
501 
502 	/* just clear all opregion memory pointers now */
503 	pmap_unmapdev((vm_offset_t)opregion->header, OPREGION_SIZE);
504 	opregion->header = NULL;
505 	opregion->acpi = NULL;
506 	opregion->swsci = NULL;
507 	opregion->asle = NULL;
508 	opregion->vbt = NULL;
509 }
510 
511 int intel_opregion_setup(struct drm_device *dev)
512 {
513 	struct drm_i915_private *dev_priv = dev->dev_private;
514 	struct intel_opregion *opregion = &dev_priv->opregion;
515 	char *base;
516 	u32 asls, mboxes;
517 	char buf[sizeof(OPREGION_SIGNATURE)];
518 	int err = 0;
519 
520 	pci_read_config_dword(dev->pdev, PCI_ASLS, &asls);
521 	DRM_DEBUG_DRIVER("graphic opregion physical addr: 0x%x\n", asls);
522 	if (asls == 0) {
523 		DRM_DEBUG_DRIVER("ACPI OpRegion not supported!\n");
524 		return -ENOTSUP;
525 	}
526 
527 	base = (void *)pmap_mapbios(asls, OPREGION_SIZE);
528 	if (!base)
529 		return -ENOMEM;
530 
531 	memcpy_fromio(buf, base, sizeof(buf));
532 
533 	if (memcmp(buf, OPREGION_SIGNATURE, 16)) {
534 		DRM_DEBUG_DRIVER("opregion signature mismatch\n");
535 		err = -EINVAL;
536 		goto err_out;
537 	}
538 	opregion->header = (struct opregion_header *)base;
539 	opregion->vbt = base + OPREGION_VBT_OFFSET;
540 
541 	opregion->lid_state = (u32 *)(base + ACPI_CLID);
542 
543 	mboxes = ioread32(&opregion->header->mboxes);
544 	if (mboxes & MBOX_ACPI) {
545 		DRM_DEBUG_DRIVER("Public ACPI methods supported\n");
546 		opregion->acpi = (struct opregion_acpi *)(base + OPREGION_ACPI_OFFSET);
547 	}
548 
549 	if (mboxes & MBOX_SWSCI) {
550 		DRM_DEBUG_DRIVER("SWSCI supported\n");
551 		opregion->swsci = (struct opregion_swsci *)(base + OPREGION_SWSCI_OFFSET);
552 	}
553 	if (mboxes & MBOX_ASLE) {
554 		DRM_DEBUG_DRIVER("ASLE supported\n");
555 		opregion->asle = (struct opregion_asle *)(base + OPREGION_ASLE_OFFSET);
556 	}
557 
558 	return 0;
559 
560 err_out:
561 	pmap_unmapdev((vm_offset_t)base, OPREGION_SIZE);
562 	return err;
563 }
564