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