1 /*-
2  * Copyright (c) 2002-2003 Taku YAMAMOTO <taku@cent.saitama-u.ac.jp>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: head/sys/dev/acpica/acpi_video.c 258780 2013-11-30 22:17:27Z eadler $
27  *	$Id: acpi_vid.c,v 1.4 2003/10/13 10:07:36 taku Exp $
28  */
29 
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/malloc.h>
33 #include <sys/module.h>
34 #include <sys/bus.h>
35 #include <sys/power.h>
36 #include <sys/queue.h>
37 #include <sys/sysctl.h>
38 
39 #include "acpi.h"
40 #include "acpivar.h"
41 
42 /* ACPI video extension driver. */
43 struct acpi_video_output {
44 	ACPI_HANDLE	handle;
45 	UINT32		adr;
46 	STAILQ_ENTRY(acpi_video_output) vo_next;
47 	struct {
48 		int	num;
49 		STAILQ_ENTRY(acpi_video_output) next;
50 	} vo_unit;
51 	int		vo_brightness;
52 	int		vo_fullpower;
53 	int		vo_economy;
54 	int		vo_numlevels;
55 	int		*vo_levels;
56 	struct sysctl_ctx_list vo_sysctl_ctx;
57 	struct sysctl_oid *vo_sysctl_tree;
58 };
59 
60 STAILQ_HEAD(acpi_video_output_queue, acpi_video_output);
61 
62 struct acpi_video_softc {
63 	device_t		device;
64 	ACPI_HANDLE		handle;
65 	struct acpi_video_output_queue vid_outputs;
66 	eventhandler_tag	vid_pwr_evh;
67 };
68 
69 /* interfaces */
70 static int	acpi_video_modevent(struct module*, int, void *);
71 static void	acpi_video_identify(driver_t *driver, device_t parent);
72 static int	acpi_video_probe(device_t);
73 static int	acpi_video_attach(device_t);
74 static int	acpi_video_detach(device_t);
75 static int	acpi_video_resume(device_t);
76 static int	acpi_video_shutdown(device_t);
77 static void	acpi_video_notify_handler(ACPI_HANDLE, UINT32, void *);
78 static void	acpi_video_power_profile(void *);
79 static void	acpi_video_bind_outputs(struct acpi_video_softc *);
80 static struct acpi_video_output *acpi_video_vo_init(UINT32);
81 static void	acpi_video_vo_bind(struct acpi_video_output *, ACPI_HANDLE);
82 static void	acpi_video_vo_destroy(struct acpi_video_output *);
83 static int	acpi_video_vo_check_level(struct acpi_video_output *, int);
84 static void	acpi_video_vo_notify_handler(ACPI_HANDLE, UINT32, void *);
85 static int	acpi_video_vo_active_sysctl(SYSCTL_HANDLER_ARGS);
86 static int	acpi_video_vo_bright_sysctl(SYSCTL_HANDLER_ARGS);
87 static int	acpi_video_vo_presets_sysctl(SYSCTL_HANDLER_ARGS);
88 static int	acpi_video_vo_levels_sysctl(SYSCTL_HANDLER_ARGS);
89 
90 /* operations */
91 static void	vid_set_switch_policy(ACPI_HANDLE, UINT32);
92 static int	vid_enum_outputs(ACPI_HANDLE,
93 		    void(*)(ACPI_HANDLE, UINT32, void *), void *);
94 static int	vo_get_brightness_levels(ACPI_HANDLE, int **);
95 static int	vo_get_brightness(ACPI_HANDLE);
96 static void	vo_set_brightness(ACPI_HANDLE, int);
97 static UINT32	vo_get_device_status(ACPI_HANDLE);
98 static UINT32	vo_get_graphics_state(ACPI_HANDLE);
99 static void	vo_set_device_state(ACPI_HANDLE, UINT32);
100 
101 /* events */
102 #define VID_NOTIFY_SWITCHED	0x80
103 #define VID_NOTIFY_REPROBE	0x81
104 #define	VID_NOTIFY_CYCLE_BRN	0x85
105 #define	VID_NOTIFY_INC_BRN	0x86
106 #define	VID_NOTIFY_DEC_BRN	0x87
107 #define	VID_NOTIFY_ZERO_BRN	0x88
108 
109 /* _DOS (Enable/Disable Output Switching) argument bits */
110 #define DOS_SWITCH_MASK		3
111 #define DOS_SWITCH_BY_OSPM	0
112 #define DOS_SWITCH_BY_BIOS	1
113 #define DOS_SWITCH_LOCKED	2
114 #define	DOS_BRIGHTNESS_BY_OSPM	(1 << 2)
115 
116 /* _DOD and subdev's _ADR */
117 #define DOD_DEVID_MASK		0x0f00
118 #define DOD_DEVID_MASK_FULL	0xffff
119 #define DOD_DEVID_MASK_DISPIDX	0x000f
120 #define DOD_DEVID_MASK_DISPPORT	0x00f0
121 #define DOD_DEVID_MONITOR	0x0100
122 #define DOD_DEVID_LCD		0x0110
123 #define DOD_DEVID_TV		0x0200
124 #define DOD_DEVID_EXT		0x0300
125 #define DOD_DEVID_INTDFP	0x0400
126 #define DOD_BIOS		(1 << 16)
127 #define DOD_NONVGA		(1 << 17)
128 #define DOD_HEAD_ID_SHIFT	18
129 #define DOD_HEAD_ID_BITS	3
130 #define DOD_HEAD_ID_MASK \
131 		(((1 << DOD_HEAD_ID_BITS) - 1) << DOD_HEAD_ID_SHIFT)
132 #define DOD_DEVID_SCHEME_STD	(1 << 31)
133 
134 /* _BCL related constants */
135 #define BCL_FULLPOWER		0
136 #define BCL_ECONOMY		1
137 
138 /* _DCS (Device Currrent Status) value bits and masks. */
139 #define DCS_EXISTS		(1 << 0)
140 #define DCS_ACTIVE		(1 << 1)
141 #define DCS_READY		(1 << 2)
142 #define DCS_FUNCTIONAL		(1 << 3)
143 #define DCS_ATTACHED		(1 << 4)
144 
145 /* _DSS (Device Set Status) argument bits and masks. */
146 #define DSS_INACTIVE		0
147 #define DSS_ACTIVE		(1 << 0)
148 #define DSS_SETNEXT		(1 << 30)
149 #define DSS_COMMIT		(1 << 31)
150 
151 static device_method_t acpi_video_methods[] = {
152 	DEVMETHOD(device_identify, acpi_video_identify),
153 	DEVMETHOD(device_probe, acpi_video_probe),
154 	DEVMETHOD(device_attach, acpi_video_attach),
155 	DEVMETHOD(device_detach, acpi_video_detach),
156 	DEVMETHOD(device_resume, acpi_video_resume),
157 	DEVMETHOD(device_shutdown, acpi_video_shutdown),
158 
159 	DEVMETHOD_END
160 };
161 
162 static driver_t acpi_video_driver = {
163 	"acpi_video",
164 	acpi_video_methods,
165 	sizeof(struct acpi_video_softc),
166 };
167 
168 static devclass_t acpi_video_devclass;
169 
170 DRIVER_MODULE(acpi_video, vgapci, acpi_video_driver, acpi_video_devclass,
171 	      acpi_video_modevent, NULL);
172 MODULE_DEPEND(acpi_video, acpi, 1, 1, 1);
173 
174 static struct sysctl_ctx_list	acpi_video_sysctl_ctx;
175 static struct sysctl_oid	*acpi_video_sysctl_tree;
176 static struct acpi_video_output_queue crt_units, tv_units,
177     ext_units, lcd_units, other_units;
178 
179 /*
180  * The 'video' lock protects the hierarchy of video output devices
181  * (the video "bus").  The 'video_output' lock protects per-output
182  * data is equivalent to a softc lock for each video output.
183  */
184 ACPI_SERIAL_DECL(video, "ACPI video");
185 ACPI_SERIAL_DECL(video_output, "ACPI video output");
186 static MALLOC_DEFINE(M_ACPIVIDEO, "acpivideo", "ACPI video extension");
187 
188 static int
189 acpi_video_modevent(struct module *mod __unused, int evt, void *cookie __unused)
190 {
191 	int err;
192 
193 	err = 0;
194 	switch (evt) {
195 	case MOD_LOAD:
196 		sysctl_ctx_init(&acpi_video_sysctl_ctx);
197 		STAILQ_INIT(&crt_units);
198 		STAILQ_INIT(&tv_units);
199 		STAILQ_INIT(&ext_units);
200 		STAILQ_INIT(&lcd_units);
201 		STAILQ_INIT(&other_units);
202 		break;
203 	case MOD_UNLOAD:
204 		sysctl_ctx_free(&acpi_video_sysctl_ctx);
205 		acpi_video_sysctl_tree = NULL;
206 		break;
207 	default:
208 		err = EINVAL;
209 	}
210 
211 	return (err);
212 }
213 
214 static void
215 acpi_video_identify(driver_t *driver, device_t parent)
216 {
217 
218 	if (device_find_child(parent, "acpi_video", -1) == NULL)
219 		device_add_child(parent, "acpi_video", -1);
220 }
221 
222 static int
223 acpi_video_probe(device_t dev)
224 {
225 	ACPI_HANDLE devh, h;
226 	ACPI_OBJECT_TYPE t_dos;
227 
228 	devh = acpi_get_handle(dev);
229 	if (acpi_disabled("video") ||
230 	    ACPI_FAILURE(AcpiGetHandle(devh, "_DOD", &h)) ||
231 	    ACPI_FAILURE(AcpiGetHandle(devh, "_DOS", &h)) ||
232 	    ACPI_FAILURE(AcpiGetType(h, &t_dos)) ||
233 	    t_dos != ACPI_TYPE_METHOD)
234 		return (ENXIO);
235 
236 	device_set_desc(dev, "ACPI video extension");
237 	return (0);
238 }
239 
240 static int
241 acpi_video_attach(device_t dev)
242 {
243 	struct acpi_softc *acpi_sc;
244 	struct acpi_video_softc *sc;
245 
246 	sc = device_get_softc(dev);
247 
248 	acpi_sc = devclass_get_softc(devclass_find("acpi"), 0);
249 	if (acpi_sc == NULL)
250 		return (ENXIO);
251 	ACPI_SERIAL_INIT(video);
252 	ACPI_SERIAL_INIT(video_output);
253 	ACPI_SERIAL_BEGIN(video);
254 	if (acpi_video_sysctl_tree == NULL) {
255 		acpi_video_sysctl_tree = SYSCTL_ADD_NODE(&acpi_video_sysctl_ctx,
256 				    SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree),
257 				    OID_AUTO, "video", CTLFLAG_RD, 0,
258 				    "video extension control");
259 	}
260 	ACPI_SERIAL_END(video);
261 
262 	sc->device = dev;
263 	sc->handle = acpi_get_handle(dev);
264 	STAILQ_INIT(&sc->vid_outputs);
265 
266 	AcpiInstallNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
267 				 acpi_video_notify_handler, sc);
268 	sc->vid_pwr_evh = EVENTHANDLER_REGISTER(power_profile_change,
269 				 acpi_video_power_profile, sc, 0);
270 
271 	ACPI_SERIAL_BEGIN(video);
272 	acpi_video_bind_outputs(sc);
273 	ACPI_SERIAL_END(video);
274 
275 	/*
276 	 * Notify the BIOS that we want to switch both active outputs and
277 	 * brightness levels.
278 	 */
279 	vid_set_switch_policy(sc->handle, DOS_SWITCH_BY_OSPM |
280 	    DOS_BRIGHTNESS_BY_OSPM);
281 
282 	acpi_video_power_profile(sc);
283 
284 	return (0);
285 }
286 
287 static int
288 acpi_video_detach(device_t dev)
289 {
290 	struct acpi_video_softc *sc;
291 	struct acpi_video_output *vo, *vn;
292 
293 	sc = device_get_softc(dev);
294 
295 	vid_set_switch_policy(sc->handle, DOS_SWITCH_BY_BIOS);
296 	EVENTHANDLER_DEREGISTER(power_profile_change, sc->vid_pwr_evh);
297 	AcpiRemoveNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
298 				acpi_video_notify_handler);
299 
300 	ACPI_SERIAL_BEGIN(video);
301 	STAILQ_FOREACH_MUTABLE(vo, &sc->vid_outputs, vo_next, vn) {
302 		acpi_video_vo_destroy(vo);
303 	}
304 	ACPI_SERIAL_END(video);
305 
306 	return (0);
307 }
308 
309 static int
310 acpi_video_resume(device_t dev)
311 {
312 	struct acpi_video_softc *sc;
313 	struct acpi_video_output *vo, *vn;
314 	int level;
315 
316 	sc = device_get_softc(dev);
317 
318 	/* Restore brightness level */
319 	ACPI_SERIAL_BEGIN(video);
320 	ACPI_SERIAL_BEGIN(video_output);
321 	STAILQ_FOREACH_MUTABLE(vo, &sc->vid_outputs, vo_next, vn) {
322 		if ((vo->adr & DOD_DEVID_MASK_FULL) != DOD_DEVID_LCD &&
323 		    (vo->adr & DOD_DEVID_MASK) != DOD_DEVID_INTDFP)
324 			continue;
325 
326 		if ((vo_get_device_status(vo->handle) & DCS_ACTIVE) == 0)
327 			continue;
328 
329 		level = vo_get_brightness(vo->handle);
330 		if (level != -1)
331 			vo_set_brightness(vo->handle, level);
332 	}
333 	ACPI_SERIAL_END(video_output);
334 	ACPI_SERIAL_END(video);
335 
336 	return (0);
337 }
338 
339 static int
340 acpi_video_shutdown(device_t dev)
341 {
342 	struct acpi_video_softc *sc;
343 
344 	sc = device_get_softc(dev);
345 	vid_set_switch_policy(sc->handle, DOS_SWITCH_BY_BIOS);
346 
347 	return (0);
348 }
349 
350 static void
351 acpi_video_notify_handler(ACPI_HANDLE handle, UINT32 notify, void *context)
352 {
353 	struct acpi_video_softc *sc;
354 	struct acpi_video_output *vo, *vo_tmp;
355 	ACPI_HANDLE lasthand;
356 	UINT32 dcs, dss, dss_p;
357 
358 	sc = (struct acpi_video_softc *)context;
359 
360 	switch (notify) {
361 	case VID_NOTIFY_SWITCHED:
362 		dss_p = 0;
363 		lasthand = NULL;
364 		ACPI_SERIAL_BEGIN(video);
365 		ACPI_SERIAL_BEGIN(video_output);
366 		STAILQ_FOREACH(vo, &sc->vid_outputs, vo_next) {
367 			dss = vo_get_graphics_state(vo->handle);
368 			dcs = vo_get_device_status(vo->handle);
369 			if (!(dcs & DCS_READY))
370 				dss = DSS_INACTIVE;
371 			if (((dcs & DCS_ACTIVE) && dss == DSS_INACTIVE) ||
372 			    (!(dcs & DCS_ACTIVE) && dss == DSS_ACTIVE)) {
373 				if (lasthand != NULL)
374 					vo_set_device_state(lasthand, dss_p);
375 				dss_p = dss;
376 				lasthand = vo->handle;
377 			}
378 		}
379 		if (lasthand != NULL)
380 			vo_set_device_state(lasthand, dss_p|DSS_COMMIT);
381 		ACPI_SERIAL_END(video_output);
382 		ACPI_SERIAL_END(video);
383 		break;
384 	case VID_NOTIFY_REPROBE:
385 		ACPI_SERIAL_BEGIN(video);
386 		STAILQ_FOREACH(vo, &sc->vid_outputs, vo_next)
387 			vo->handle = NULL;
388 		acpi_video_bind_outputs(sc);
389 		STAILQ_FOREACH_MUTABLE(vo, &sc->vid_outputs, vo_next, vo_tmp) {
390 			if (vo->handle == NULL) {
391 				STAILQ_REMOVE(&sc->vid_outputs, vo,
392 				    acpi_video_output, vo_next);
393 				acpi_video_vo_destroy(vo);
394 			}
395 		}
396 		ACPI_SERIAL_END(video);
397 		break;
398 	default:
399 		device_printf(sc->device, "unknown notify event 0x%x\n",
400 		    notify);
401 	}
402 }
403 
404 static void
405 acpi_video_power_profile(void *context)
406 {
407 	int state;
408 	struct acpi_video_softc *sc;
409 	struct acpi_video_output *vo;
410 
411 	sc = context;
412 	state = power_profile_get_state();
413 	if (state != POWER_PROFILE_PERFORMANCE &&
414 	    state != POWER_PROFILE_ECONOMY)
415 		return;
416 
417 	ACPI_SERIAL_BEGIN(video);
418 	ACPI_SERIAL_BEGIN(video_output);
419 	STAILQ_FOREACH(vo, &sc->vid_outputs, vo_next) {
420 		if (vo->vo_levels != NULL && vo->vo_brightness == -1)
421 			vo_set_brightness(vo->handle,
422 			    state == POWER_PROFILE_ECONOMY ?
423 			    vo->vo_economy : vo->vo_fullpower);
424 	}
425 	ACPI_SERIAL_END(video_output);
426 	ACPI_SERIAL_END(video);
427 }
428 
429 static void
430 acpi_video_bind_outputs_subr(ACPI_HANDLE handle, UINT32 adr, void *context)
431 {
432 	struct acpi_video_softc *sc;
433 	struct acpi_video_output *vo;
434 
435 	ACPI_SERIAL_ASSERT(video);
436 	sc = context;
437 
438 	STAILQ_FOREACH(vo, &sc->vid_outputs, vo_next) {
439 		if (vo->adr == adr) {
440 			acpi_video_vo_bind(vo, handle);
441 			return;
442 		}
443 	}
444 	vo = acpi_video_vo_init(adr);
445 	if (vo != NULL) {
446 		acpi_video_vo_bind(vo, handle);
447 		STAILQ_INSERT_TAIL(&sc->vid_outputs, vo, vo_next);
448 	}
449 }
450 
451 static void
452 acpi_video_bind_outputs(struct acpi_video_softc *sc)
453 {
454 	ACPI_SERIAL_ASSERT(video);
455 	vid_enum_outputs(sc->handle, acpi_video_bind_outputs_subr, sc);
456 }
457 
458 static struct acpi_video_output *
459 acpi_video_vo_init(UINT32 adr)
460 {
461 	struct acpi_video_output *vn, *vo, *vp;
462 	int n, x;
463 	char name[8], env[32];
464 	const char *type, *desc;
465 	struct acpi_video_output_queue *voqh;
466 
467 	ACPI_SERIAL_ASSERT(video);
468 
469 	switch (adr & DOD_DEVID_MASK) {
470 	case DOD_DEVID_MONITOR:
471 		if ((adr & DOD_DEVID_MASK_FULL) == DOD_DEVID_LCD) {
472 			/* DOD_DEVID_LCD is a common, backward compatible ID */
473 			desc = "Internal/Integrated Digital Flat Panel";
474 			type = "lcd";
475 			voqh = &lcd_units;
476 		} else {
477 			desc = "VGA CRT or VESA Compatible Analog Monitor";
478 			type = "crt";
479 			voqh = &crt_units;
480 		}
481 		break;
482 	case DOD_DEVID_TV:
483 		desc = "TV/HDTV or Analog-Video Monitor";
484 		type = "tv";
485 		voqh = &tv_units;
486 		break;
487 	case DOD_DEVID_EXT:
488 		desc = "External Digital Monitor";
489 		type = "ext";
490 		voqh = &ext_units;
491 		break;
492 	case DOD_DEVID_INTDFP:
493 		desc = "Internal/Integrated Digital Flat Panel";
494 		type = "lcd";
495 		voqh = &lcd_units;
496 		break;
497 	default:
498 		desc = "unknown output";
499 		type = "out";
500 		voqh = &other_units;
501 	}
502 
503 	n = 0;
504 	vp = NULL;
505 	STAILQ_FOREACH(vn, voqh, vo_unit.next) {
506 		if (vn->vo_unit.num != n)
507 			break;
508 		vp = vn;
509 		n++;
510 	}
511 
512 	ksnprintf(name, sizeof(name), "%s%d", type, n);
513 
514 	vo = kmalloc(sizeof(*vo), M_ACPIVIDEO, M_NOWAIT);
515 	if (vo != NULL) {
516 		vo->handle = NULL;
517 		vo->adr = adr;
518 		vo->vo_unit.num = n;
519 		vo->vo_brightness = -1;
520 		vo->vo_fullpower = -1;	/* TODO: override with tunables */
521 		vo->vo_economy = -1;
522 		vo->vo_numlevels = 0;
523 		vo->vo_levels = NULL;
524 		ksnprintf(env, sizeof(env), "hw.acpi.video.%s.fullpower", name);
525 		if (kgetenv_int(env, &x))
526 			vo->vo_fullpower = x;
527 		ksnprintf(env, sizeof(env), "hw.acpi.video.%s.economy", name);
528 		if (kgetenv_int(env, &x))
529 			vo->vo_economy = x;
530 
531 		sysctl_ctx_init(&vo->vo_sysctl_ctx);
532 		if (vp != NULL)
533 			STAILQ_INSERT_AFTER(voqh, vp, vo, vo_unit.next);
534 		else
535 			STAILQ_INSERT_TAIL(voqh, vo, vo_unit.next);
536 		if (acpi_video_sysctl_tree != NULL)
537 			vo->vo_sysctl_tree =
538 			    SYSCTL_ADD_NODE(&vo->vo_sysctl_ctx,
539 				SYSCTL_CHILDREN(acpi_video_sysctl_tree),
540 				OID_AUTO, name, CTLFLAG_RD, 0, desc);
541 		if (vo->vo_sysctl_tree != NULL) {
542 			SYSCTL_ADD_PROC(&vo->vo_sysctl_ctx,
543 			    SYSCTL_CHILDREN(vo->vo_sysctl_tree),
544 			    OID_AUTO, "active",
545 			    CTLTYPE_INT|CTLFLAG_RW, vo, 0,
546 			    acpi_video_vo_active_sysctl, "I",
547 			    "current activity of this device");
548 			SYSCTL_ADD_PROC(&vo->vo_sysctl_ctx,
549 			    SYSCTL_CHILDREN(vo->vo_sysctl_tree),
550 			    OID_AUTO, "brightness",
551 			    CTLTYPE_INT|CTLFLAG_RW, vo, 0,
552 			    acpi_video_vo_bright_sysctl, "I",
553 			    "current brightness level");
554 			SYSCTL_ADD_PROC(&vo->vo_sysctl_ctx,
555 			    SYSCTL_CHILDREN(vo->vo_sysctl_tree),
556 			    OID_AUTO, "fullpower",
557 			    CTLTYPE_INT|CTLFLAG_RW, vo,
558 			    POWER_PROFILE_PERFORMANCE,
559 			    acpi_video_vo_presets_sysctl, "I",
560 			    "preset level for full power mode");
561 			SYSCTL_ADD_PROC(&vo->vo_sysctl_ctx,
562 			    SYSCTL_CHILDREN(vo->vo_sysctl_tree),
563 			    OID_AUTO, "economy",
564 			    CTLTYPE_INT|CTLFLAG_RW, vo,
565 			    POWER_PROFILE_ECONOMY,
566 			    acpi_video_vo_presets_sysctl, "I",
567 			    "preset level for economy mode");
568 			SYSCTL_ADD_PROC(&vo->vo_sysctl_ctx,
569 			    SYSCTL_CHILDREN(vo->vo_sysctl_tree),
570 			    OID_AUTO, "levels",
571 			    CTLTYPE_INT|CTLFLAG_RD, vo, 0,
572 			    acpi_video_vo_levels_sysctl, "I",
573 			    "supported brightness levels");
574 		} else
575 			kprintf("%s: sysctl node creation failed\n", type);
576 	} else
577 		kprintf("%s: softc allocation failed\n", type);
578 
579 	if (bootverbose) {
580 		kprintf("found %s(%x)", desc, adr & DOD_DEVID_MASK_FULL);
581 		kprintf(", idx#%x", adr & DOD_DEVID_MASK_DISPIDX);
582 		kprintf(", port#%x", (adr & DOD_DEVID_MASK_DISPPORT) >> 4);
583 		if (adr & DOD_BIOS)
584 			kprintf(", detectable by BIOS");
585 		if (adr & DOD_NONVGA)
586 			kprintf(" (Non-VGA output device whose power "
587 			    "is related to the VGA device)");
588 		kprintf(", head #%d\n",
589 			(adr & DOD_HEAD_ID_MASK) >> DOD_HEAD_ID_SHIFT);
590 	}
591 	return (vo);
592 }
593 
594 static void
595 acpi_video_vo_bind(struct acpi_video_output *vo, ACPI_HANDLE handle)
596 {
597 	ACPI_SERIAL_BEGIN(video_output);
598 	if (vo->vo_levels != NULL)
599 		AcpiOsFree(vo->vo_levels);
600 	vo->handle = handle;
601 	vo->vo_numlevels = vo_get_brightness_levels(handle, &vo->vo_levels);
602 	if (vo->vo_numlevels >= 2) {
603 		if (vo->vo_fullpower == -1
604 		    || acpi_video_vo_check_level(vo, vo->vo_fullpower) != 0)
605 			/* XXX - can't deal with rebinding... */
606 			vo->vo_fullpower = vo->vo_levels[BCL_FULLPOWER];
607 		if (vo->vo_economy == -1
608 		    || acpi_video_vo_check_level(vo, vo->vo_economy) != 0)
609 			/* XXX - see above. */
610 			vo->vo_economy = vo->vo_levels[BCL_ECONOMY];
611 	}
612 	if (vo->vo_levels != NULL)
613 		AcpiInstallNotifyHandler(handle, ACPI_DEVICE_NOTIFY,
614 		    acpi_video_vo_notify_handler, vo);
615 	ACPI_SERIAL_END(video_output);
616 }
617 
618 static void
619 acpi_video_vo_destroy(struct acpi_video_output *vo)
620 {
621 	struct acpi_video_output_queue *voqh;
622 
623 	ACPI_SERIAL_ASSERT(video);
624 	if (vo->vo_sysctl_tree != NULL) {
625 		vo->vo_sysctl_tree = NULL;
626 		sysctl_ctx_free(&vo->vo_sysctl_ctx);
627 	}
628 	if (vo->vo_levels != NULL) {
629 		AcpiRemoveNotifyHandler(vo->handle, ACPI_DEVICE_NOTIFY,
630 		    acpi_video_vo_notify_handler);
631 		AcpiOsFree(vo->vo_levels);
632 	}
633 
634 	switch (vo->adr & DOD_DEVID_MASK) {
635 	case DOD_DEVID_MONITOR:
636 		if ((vo->adr & DOD_DEVID_MASK_FULL) == DOD_DEVID_LCD) {
637 			voqh = &lcd_units;
638 		} else {
639 			voqh = &crt_units;
640 		}
641 		break;
642 	case DOD_DEVID_TV:
643 		voqh = &tv_units;
644 		break;
645 	case DOD_DEVID_EXT:
646 		voqh = &ext_units;
647 		break;
648 	case DOD_DEVID_INTDFP:
649 		voqh = &lcd_units;
650 		break;
651 	default:
652 		voqh = &other_units;
653 	}
654 	STAILQ_REMOVE(voqh, vo, acpi_video_output, vo_unit.next);
655 	kfree(vo, M_ACPIVIDEO);
656 }
657 
658 static int
659 acpi_video_vo_check_level(struct acpi_video_output *vo, int level)
660 {
661 	int i;
662 
663 	ACPI_SERIAL_ASSERT(video_output);
664 	if (vo->vo_levels == NULL)
665 		return (ENODEV);
666 	for (i = 0; i < vo->vo_numlevels; i++)
667 		if (vo->vo_levels[i] == level)
668 			return (0);
669 	return (EINVAL);
670 }
671 
672 static void
673 acpi_video_vo_notify_handler(ACPI_HANDLE handle, UINT32 notify, void *context)
674 {
675 	struct acpi_video_output *vo;
676 	int i, j, level, new_level;
677 
678 	vo = context;
679 	ACPI_SERIAL_BEGIN(video_output);
680 	if (vo->handle != handle)
681 		goto out;
682 
683 	switch (notify) {
684 	case VID_NOTIFY_CYCLE_BRN:
685 		if (vo->vo_numlevels <= 3)
686 			goto out;
687 		/* FALLTHROUGH */
688 	case VID_NOTIFY_INC_BRN:
689 	case VID_NOTIFY_DEC_BRN:
690 	case VID_NOTIFY_ZERO_BRN:
691 		if (vo->vo_levels == NULL)
692 			goto out;
693 		level = vo_get_brightness(handle);
694 		if (level < 0)
695 			goto out;
696 		break;
697 	default:
698 		kprintf("unknown notify event 0x%x from %s\n",
699 		    notify, acpi_name(handle));
700 		goto out;
701 	}
702 
703 	new_level = level;
704 	switch (notify) {
705 	case VID_NOTIFY_CYCLE_BRN:
706 		for (i = 2; i < vo->vo_numlevels; i++)
707 			if (vo->vo_levels[i] == level) {
708 				new_level = vo->vo_numlevels > i + 1 ?
709 				     vo->vo_levels[i + 1] : vo->vo_levels[2];
710 				break;
711 			}
712 		break;
713 	case VID_NOTIFY_INC_BRN:
714 	case VID_NOTIFY_DEC_BRN:
715 		for (i = 0; i < vo->vo_numlevels; i++) {
716 			j = vo->vo_levels[i];
717 			if (notify == VID_NOTIFY_INC_BRN) {
718 				if (j > level &&
719 				    (j < new_level || level == new_level))
720 					new_level = j;
721 			} else {
722 				if (j < level &&
723 				    (j > new_level || level == new_level))
724 					new_level = j;
725 			}
726 		}
727 		break;
728 	case VID_NOTIFY_ZERO_BRN:
729 		for (i = 0; i < vo->vo_numlevels; i++)
730 			if (vo->vo_levels[i] == 0) {
731 				new_level = 0;
732 				break;
733 			}
734 		break;
735 	}
736 	if (new_level != level) {
737 		vo_set_brightness(handle, new_level);
738 		vo->vo_brightness = new_level;
739 	}
740 
741 out:
742 	ACPI_SERIAL_END(video_output);
743 }
744 
745 /* ARGSUSED */
746 static int
747 acpi_video_vo_active_sysctl(SYSCTL_HANDLER_ARGS)
748 {
749 	struct acpi_video_output *vo;
750 	int state, err;
751 
752 	vo = (struct acpi_video_output *)arg1;
753 	if (vo->handle == NULL)
754 		return (ENXIO);
755 	ACPI_SERIAL_BEGIN(video_output);
756 	state = (vo_get_device_status(vo->handle) & DCS_ACTIVE) ? 1 : 0;
757 	err = sysctl_handle_int(oidp, &state, 0, req);
758 	if (err != 0 || req->newptr == NULL)
759 		goto out;
760 	vo_set_device_state(vo->handle,
761 	    DSS_COMMIT | (state ? DSS_ACTIVE : DSS_INACTIVE));
762 out:
763 	ACPI_SERIAL_END(video_output);
764 	return (err);
765 }
766 
767 /* ARGSUSED */
768 static int
769 acpi_video_vo_bright_sysctl(SYSCTL_HANDLER_ARGS)
770 {
771 	struct acpi_video_output *vo;
772 	int level, preset, err;
773 
774 	vo = (struct acpi_video_output *)arg1;
775 	ACPI_SERIAL_BEGIN(video_output);
776 	if (vo->handle == NULL) {
777 		err = ENXIO;
778 		goto out;
779 	}
780 	if (vo->vo_levels == NULL) {
781 		err = ENODEV;
782 		goto out;
783 	}
784 
785 	preset = (power_profile_get_state() == POWER_PROFILE_ECONOMY) ?
786 		  vo->vo_economy : vo->vo_fullpower;
787 	level = vo->vo_brightness;
788 	if (level == -1)
789 		level = preset;
790 
791 	err = sysctl_handle_int(oidp, &level, 0, req);
792 	if (err != 0 || req->newptr == NULL)
793 		goto out;
794 	if (level < -1 || level > 100) {
795 		err = EINVAL;
796 		goto out;
797 	}
798 
799 	if (level != -1 && (err = acpi_video_vo_check_level(vo, level)))
800 		goto out;
801 	vo->vo_brightness = level;
802 	vo_set_brightness(vo->handle, (level == -1) ? preset : level);
803 
804 out:
805 	ACPI_SERIAL_END(video_output);
806 	return (err);
807 }
808 
809 static int
810 acpi_video_vo_presets_sysctl(SYSCTL_HANDLER_ARGS)
811 {
812 	struct acpi_video_output *vo;
813 	int i, level, *preset, err;
814 
815 	vo = (struct acpi_video_output *)arg1;
816 	ACPI_SERIAL_BEGIN(video_output);
817 	if (vo->handle == NULL) {
818 		err = ENXIO;
819 		goto out;
820 	}
821 	if (vo->vo_levels == NULL) {
822 		err = ENODEV;
823 		goto out;
824 	}
825 	preset = (arg2 == POWER_PROFILE_ECONOMY) ?
826 		  &vo->vo_economy : &vo->vo_fullpower;
827 	level = *preset;
828 	err = sysctl_handle_int(oidp, &level, 0, req);
829 	if (err != 0 || req->newptr == NULL)
830 		goto out;
831 	if (level < -1 || level > 100) {
832 		err = EINVAL;
833 		goto out;
834 	}
835 	if (level == -1) {
836 		i = (arg2 == POWER_PROFILE_ECONOMY) ?
837 		    BCL_ECONOMY : BCL_FULLPOWER;
838 		level = vo->vo_levels[i];
839 	} else if ((err = acpi_video_vo_check_level(vo, level)) != 0)
840 		goto out;
841 
842 	if (vo->vo_brightness == -1 && (power_profile_get_state() == arg2))
843 		vo_set_brightness(vo->handle, level);
844 	*preset = level;
845 
846 out:
847 	ACPI_SERIAL_END(video_output);
848 	return (err);
849 }
850 
851 /* ARGSUSED */
852 static int
853 acpi_video_vo_levels_sysctl(SYSCTL_HANDLER_ARGS)
854 {
855 	struct acpi_video_output *vo;
856 	int err;
857 
858 	vo = (struct acpi_video_output *)arg1;
859 	ACPI_SERIAL_BEGIN(video_output);
860 	if (vo->vo_levels == NULL) {
861 		err = ENODEV;
862 		goto out;
863 	}
864 	if (req->newptr != NULL) {
865 		err = EPERM;
866 		goto out;
867 	}
868 	err = sysctl_handle_opaque(oidp, vo->vo_levels,
869 	    vo->vo_numlevels * sizeof(*vo->vo_levels), req);
870 
871 out:
872 	ACPI_SERIAL_END(video_output);
873 	return (err);
874 }
875 
876 static void
877 vid_set_switch_policy(ACPI_HANDLE handle, UINT32 policy)
878 {
879 	ACPI_STATUS status;
880 
881 	status = acpi_SetInteger(handle, "_DOS", policy);
882 	if (ACPI_FAILURE(status))
883 		kprintf("can't evaluate %s._DOS - %s\n",
884 		       acpi_name(handle), AcpiFormatException(status));
885 }
886 
887 struct enum_callback_arg {
888 	void (*callback)(ACPI_HANDLE, UINT32, void *);
889 	void *context;
890 	ACPI_OBJECT *dod_pkg;
891 	int count;
892 };
893 
894 static ACPI_STATUS
895 vid_enum_outputs_subr(ACPI_HANDLE handle, UINT32 level __unused,
896 		      void *context, void **retp __unused)
897 {
898 	ACPI_STATUS status;
899 	UINT32 adr, val;
900 	struct enum_callback_arg *argset;
901 	size_t i;
902 
903 	ACPI_SERIAL_ASSERT(video);
904 	argset = context;
905 	status = acpi_GetInteger(handle, "_ADR", &adr);
906 	if (ACPI_FAILURE(status))
907 		return (AE_OK);
908 
909 	for (i = 0; i < argset->dod_pkg->Package.Count; i++) {
910 		if (acpi_PkgInt32(argset->dod_pkg, i, &val) == 0 &&
911 		    (val & DOD_DEVID_MASK_FULL) ==
912 		    (adr & DOD_DEVID_MASK_FULL)) {
913 			argset->callback(handle, val, argset->context);
914 			argset->count++;
915 		}
916 	}
917 
918 	return (AE_OK);
919 }
920 
921 static int
922 vid_enum_outputs(ACPI_HANDLE handle,
923 		 void (*callback)(ACPI_HANDLE, UINT32, void *), void *context)
924 {
925 	ACPI_STATUS status;
926 	ACPI_BUFFER dod_buf;
927 	ACPI_OBJECT *res;
928 	struct enum_callback_arg argset;
929 
930 	ACPI_SERIAL_ASSERT(video);
931 	dod_buf.Length = ACPI_ALLOCATE_BUFFER;
932 	dod_buf.Pointer = NULL;
933 	status = AcpiEvaluateObject(handle, "_DOD", NULL, &dod_buf);
934 	if (ACPI_FAILURE(status)) {
935 		if (status != AE_NOT_FOUND)
936 			kprintf("can't evaluate %s._DOD - %s\n",
937 			       acpi_name(handle), AcpiFormatException(status));
938 		argset.count = -1;
939 		goto out;
940 	}
941 	res = (ACPI_OBJECT *)dod_buf.Pointer;
942 	if (!ACPI_PKG_VALID(res, 1)) {
943 		kprintf("evaluation of %s._DOD makes no sense\n",
944 		       acpi_name(handle));
945 		argset.count = -1;
946 		goto out;
947 	}
948 	if (callback == NULL) {
949 		argset.count = res->Package.Count;
950 		goto out;
951 	}
952 	argset.callback = callback;
953 	argset.context  = context;
954 	argset.dod_pkg  = res;
955 	argset.count    = 0;
956 	status = AcpiWalkNamespace(ACPI_TYPE_DEVICE, handle, 1,
957 	    vid_enum_outputs_subr, NULL, &argset, NULL);
958 	if (ACPI_FAILURE(status))
959 		kprintf("failed walking down %s - %s\n",
960 		       acpi_name(handle), AcpiFormatException(status));
961 out:
962 	if (dod_buf.Pointer != NULL)
963 		AcpiOsFree(dod_buf.Pointer);
964 	return (argset.count);
965 }
966 
967 static int
968 vo_get_brightness_levels(ACPI_HANDLE handle, int **levelp)
969 {
970 	ACPI_STATUS status;
971 	ACPI_BUFFER bcl_buf;
972 	ACPI_OBJECT *res;
973 	int num, i, n, *levels;
974 
975 	bcl_buf.Length = ACPI_ALLOCATE_BUFFER;
976 	bcl_buf.Pointer = NULL;
977 	status = AcpiEvaluateObject(handle, "_BCL", NULL, &bcl_buf);
978 	if (ACPI_FAILURE(status)) {
979 		if (status != AE_NOT_FOUND)
980 			kprintf("can't evaluate %s._BCL - %s\n",
981 			       acpi_name(handle), AcpiFormatException(status));
982 		goto out;
983 	}
984 	res = (ACPI_OBJECT *)bcl_buf.Pointer;
985 	if (!ACPI_PKG_VALID(res, 2)) {
986 		kprintf("evaluation of %s._BCL makes no sense\n",
987 		       acpi_name(handle));
988 		goto out;
989 	}
990 	num = res->Package.Count;
991 	if (num < 2 || levelp == NULL)
992 		goto out;
993 	levels = AcpiOsAllocate(num * sizeof(*levels));
994 	if (levels == NULL)
995 		goto out;
996 	for (i = 0, n = 0; i < num; i++)
997 		if (acpi_PkgInt32(res, i, &levels[n]) == 0)
998 			n++;
999 	if (n < 2) {
1000 		AcpiOsFree(levels);
1001 		goto out;
1002 	}
1003 	*levelp = levels;
1004 	return (n);
1005 
1006 out:
1007 	if (bcl_buf.Pointer != NULL)
1008 		AcpiOsFree(bcl_buf.Pointer);
1009 	return (0);
1010 }
1011 
1012 static int
1013 vo_get_brightness(ACPI_HANDLE handle)
1014 {
1015 	UINT32 level;
1016 	ACPI_STATUS status;
1017 
1018 	ACPI_SERIAL_ASSERT(video_output);
1019 	status = acpi_GetInteger(handle, "_BQC", &level);
1020 	if (ACPI_FAILURE(status)) {
1021 		kprintf("can't evaluate %s._BQC - %s\n", acpi_name(handle),
1022 		    AcpiFormatException(status));
1023 		return (-1);
1024 	}
1025 	if (level > 100)
1026 		return (-1);
1027 
1028 	return (level);
1029 }
1030 
1031 static void
1032 vo_set_brightness(ACPI_HANDLE handle, int level)
1033 {
1034 	ACPI_STATUS status;
1035 
1036 	ACPI_SERIAL_ASSERT(video_output);
1037 	status = acpi_SetInteger(handle, "_BCM", level);
1038 	if (ACPI_FAILURE(status))
1039 		kprintf("can't evaluate %s._BCM - %s\n",
1040 		       acpi_name(handle), AcpiFormatException(status));
1041 }
1042 
1043 static UINT32
1044 vo_get_device_status(ACPI_HANDLE handle)
1045 {
1046 	UINT32 dcs;
1047 	ACPI_STATUS status;
1048 
1049 	ACPI_SERIAL_ASSERT(video_output);
1050 	dcs = 0;
1051 	status = acpi_GetInteger(handle, "_DCS", &dcs);
1052 	if (ACPI_FAILURE(status))
1053 		kprintf("can't evaluate %s._DCS - %s\n",
1054 		       acpi_name(handle), AcpiFormatException(status));
1055 
1056 	return (dcs);
1057 }
1058 
1059 static UINT32
1060 vo_get_graphics_state(ACPI_HANDLE handle)
1061 {
1062 	UINT32 dgs;
1063 	ACPI_STATUS status;
1064 
1065 	dgs = 0;
1066 	status = acpi_GetInteger(handle, "_DGS", &dgs);
1067 	if (ACPI_FAILURE(status))
1068 		kprintf("can't evaluate %s._DGS - %s\n",
1069 		       acpi_name(handle), AcpiFormatException(status));
1070 
1071 	return (dgs);
1072 }
1073 
1074 static void
1075 vo_set_device_state(ACPI_HANDLE handle, UINT32 state)
1076 {
1077 	ACPI_STATUS status;
1078 
1079 	ACPI_SERIAL_ASSERT(video_output);
1080 	status = acpi_SetInteger(handle, "_DSS", state);
1081 	if (ACPI_FAILURE(status))
1082 		kprintf("can't evaluate %s._DSS - %s\n",
1083 		       acpi_name(handle), AcpiFormatException(status));
1084 }
1085