xref: /freebsd/sys/dev/acpi_support/acpi_ibm.c (revision 53071ed1c96db7f89defc99c95b0ad1031d48f45)
1 /*-
2  * Copyright (c) 2004 Takanori Watanabe
3  * Copyright (c) 2005 Markus Brueffer <markus@FreeBSD.org>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
30 
31 /*
32  * Driver for extra ACPI-controlled gadgets found on ThinkPad laptops.
33  * Inspired by the ibm-acpi and tpb projects which implement these features
34  * on Linux.
35  *
36  *   acpi-ibm: <http://ibm-acpi.sourceforge.net/>
37  *        tpb: <http://www.nongnu.org/tpb/>
38  */
39 
40 #include "opt_acpi.h"
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/bus.h>
45 #include <machine/cpufunc.h>
46 
47 #include <contrib/dev/acpica/include/acpi.h>
48 #include <contrib/dev/acpica/include/accommon.h>
49 
50 #include "acpi_if.h"
51 #include <sys/module.h>
52 #include <dev/acpica/acpivar.h>
53 #include <dev/led/led.h>
54 #include <sys/power.h>
55 #include <sys/sbuf.h>
56 #include <sys/sysctl.h>
57 #include <isa/rtc.h>
58 
59 #define _COMPONENT	ACPI_OEM
60 ACPI_MODULE_NAME("IBM")
61 
62 /* Internal methods */
63 #define ACPI_IBM_METHOD_EVENTS		1
64 #define ACPI_IBM_METHOD_EVENTMASK	2
65 #define ACPI_IBM_METHOD_HOTKEY		3
66 #define ACPI_IBM_METHOD_BRIGHTNESS	4
67 #define ACPI_IBM_METHOD_VOLUME		5
68 #define ACPI_IBM_METHOD_MUTE		6
69 #define ACPI_IBM_METHOD_THINKLIGHT	7
70 #define ACPI_IBM_METHOD_BLUETOOTH	8
71 #define ACPI_IBM_METHOD_WLAN		9
72 #define ACPI_IBM_METHOD_FANSPEED	10
73 #define ACPI_IBM_METHOD_FANLEVEL	11
74 #define ACPI_IBM_METHOD_FANSTATUS	12
75 #define ACPI_IBM_METHOD_THERMAL		13
76 #define ACPI_IBM_METHOD_HANDLEREVENTS	14
77 #define ACPI_IBM_METHOD_MIC_LED		15
78 #define ACPI_IBM_METHOD_PRIVACYGUARD	16
79 
80 /* Hotkeys/Buttons */
81 #define IBM_RTC_HOTKEY1			0x64
82 #define   IBM_RTC_MASK_HOME		(1 << 0)
83 #define   IBM_RTC_MASK_SEARCH		(1 << 1)
84 #define   IBM_RTC_MASK_MAIL		(1 << 2)
85 #define   IBM_RTC_MASK_WLAN		(1 << 5)
86 #define IBM_RTC_HOTKEY2			0x65
87 #define   IBM_RTC_MASK_THINKPAD		(1 << 3)
88 #define   IBM_RTC_MASK_ZOOM		(1 << 5)
89 #define   IBM_RTC_MASK_VIDEO		(1 << 6)
90 #define   IBM_RTC_MASK_HIBERNATE	(1 << 7)
91 #define IBM_RTC_THINKLIGHT		0x66
92 #define   IBM_RTC_MASK_THINKLIGHT	(1 << 4)
93 #define IBM_RTC_SCREENEXPAND		0x67
94 #define   IBM_RTC_MASK_SCREENEXPAND	(1 << 5)
95 #define IBM_RTC_BRIGHTNESS		0x6c
96 #define   IBM_RTC_MASK_BRIGHTNESS	(1 << 5)
97 #define IBM_RTC_VOLUME			0x6e
98 #define   IBM_RTC_MASK_VOLUME		(1 << 7)
99 
100 /* Embedded Controller registers */
101 #define IBM_EC_BRIGHTNESS		0x31
102 #define   IBM_EC_MASK_BRI		0x7
103 #define IBM_EC_VOLUME			0x30
104 #define   IBM_EC_MASK_VOL		0xf
105 #define   IBM_EC_MASK_MUTE		(1 << 6)
106 #define IBM_EC_FANSTATUS		0x2F
107 #define   IBM_EC_MASK_FANLEVEL		0x3f
108 #define   IBM_EC_MASK_FANDISENGAGED	(1 << 6)
109 #define   IBM_EC_MASK_FANSTATUS		(1 << 7)
110 #define IBM_EC_FANSPEED			0x84
111 
112 /* CMOS Commands */
113 #define IBM_CMOS_VOLUME_DOWN		0
114 #define IBM_CMOS_VOLUME_UP		1
115 #define IBM_CMOS_VOLUME_MUTE		2
116 #define IBM_CMOS_BRIGHTNESS_UP		4
117 #define IBM_CMOS_BRIGHTNESS_DOWN	5
118 
119 /* ACPI methods */
120 #define IBM_NAME_KEYLIGHT		"KBLT"
121 #define IBM_NAME_WLAN_BT_GET		"GBDC"
122 #define IBM_NAME_WLAN_BT_SET		"SBDC"
123 #define   IBM_NAME_MASK_BT		(1 << 1)
124 #define   IBM_NAME_MASK_WLAN		(1 << 2)
125 #define IBM_NAME_THERMAL_GET		"TMP7"
126 #define IBM_NAME_THERMAL_UPDT		"UPDT"
127 #define IBM_NAME_PRIVACYGUARD_GET	"GSSS"
128 #define IBM_NAME_PRIVACYGUARD_SET	"SSSS"
129 
130 #define IBM_NAME_EVENTS_STATUS_GET	"DHKC"
131 #define IBM_NAME_EVENTS_MASK_GET	"DHKN"
132 #define IBM_NAME_EVENTS_STATUS_SET	"MHKC"
133 #define IBM_NAME_EVENTS_MASK_SET	"MHKM"
134 #define IBM_NAME_EVENTS_GET		"MHKP"
135 #define IBM_NAME_EVENTS_AVAILMASK	"MHKA"
136 
137 /* Event Code */
138 #define IBM_EVENT_LCD_BACKLIGHT		0x03
139 #define IBM_EVENT_SUSPEND_TO_RAM	0x04
140 #define IBM_EVENT_BLUETOOTH		0x05
141 #define IBM_EVENT_SCREEN_EXPAND		0x07
142 #define IBM_EVENT_SUSPEND_TO_DISK	0x0c
143 #define IBM_EVENT_BRIGHTNESS_UP		0x10
144 #define IBM_EVENT_BRIGHTNESS_DOWN	0x11
145 #define IBM_EVENT_THINKLIGHT		0x12
146 #define IBM_EVENT_ZOOM			0x14
147 #define IBM_EVENT_VOLUME_UP		0x15
148 #define IBM_EVENT_VOLUME_DOWN		0x16
149 #define IBM_EVENT_MUTE			0x17
150 #define IBM_EVENT_ACCESS_IBM_BUTTON	0x18
151 
152 /* Device-specific register flags */
153 #define IBM_FLAG_PRIVACYGUARD_DEVICE_PRESENT	0x10000
154 #define IBM_FLAG_PRIVACYGUARD_ON	0x1
155 
156 #define ABS(x) (((x) < 0)? -(x) : (x))
157 
158 struct acpi_ibm_softc {
159 	device_t	dev;
160 	ACPI_HANDLE	handle;
161 
162 	/* Embedded controller */
163 	device_t	ec_dev;
164 	ACPI_HANDLE	ec_handle;
165 
166 	/* CMOS */
167 	ACPI_HANDLE	cmos_handle;
168 
169 	/* Fan status */
170 	ACPI_HANDLE	fan_handle;
171 	int		fan_levels;
172 
173 	/* Keylight commands and states */
174 	ACPI_HANDLE	light_handle;
175 	int		light_cmd_on;
176 	int		light_cmd_off;
177 	int		light_val;
178 	int		light_get_supported;
179 	int		light_set_supported;
180 
181 	/* led(4) interface */
182 	struct cdev	*led_dev;
183 	int		led_busy;
184 	int		led_state;
185 
186 	/* Mic led handle */
187 	ACPI_HANDLE	mic_led_handle;
188 	int		mic_led_state;
189 
190 	int		wlan_bt_flags;
191 	int		thermal_updt_supported;
192 
193 	unsigned int	events_availmask;
194 	unsigned int	events_initialmask;
195 	int		events_mask_supported;
196 	int		events_enable;
197 
198 	unsigned int	handler_events;
199 
200 	struct sysctl_ctx_list	*sysctl_ctx;
201 	struct sysctl_oid	*sysctl_tree;
202 };
203 
204 static struct {
205 	char	*name;
206 	int	method;
207 	char	*description;
208 	int	flag_rdonly;
209 } acpi_ibm_sysctls[] = {
210 	{
211 		.name		= "events",
212 		.method		= ACPI_IBM_METHOD_EVENTS,
213 		.description	= "ACPI events enable",
214 	},
215 	{
216 		.name		= "eventmask",
217 		.method		= ACPI_IBM_METHOD_EVENTMASK,
218 		.description	= "ACPI eventmask",
219 	},
220 	{
221 		.name		= "hotkey",
222 		.method		= ACPI_IBM_METHOD_HOTKEY,
223 		.description	= "Key Status",
224 		.flag_rdonly	= 1
225 	},
226 	{
227 		.name		= "lcd_brightness",
228 		.method		= ACPI_IBM_METHOD_BRIGHTNESS,
229 		.description	= "LCD Brightness",
230 	},
231 	{
232 		.name		= "volume",
233 		.method		= ACPI_IBM_METHOD_VOLUME,
234 		.description	= "Volume",
235 	},
236 	{
237 		.name		= "mute",
238 		.method		= ACPI_IBM_METHOD_MUTE,
239 		.description	= "Mute",
240 	},
241 	{
242 		.name		= "thinklight",
243 		.method		= ACPI_IBM_METHOD_THINKLIGHT,
244 		.description	= "Thinklight enable",
245 	},
246 	{
247 		.name		= "bluetooth",
248 		.method		= ACPI_IBM_METHOD_BLUETOOTH,
249 		.description	= "Bluetooth enable",
250 	},
251 	{
252 		.name		= "wlan",
253 		.method		= ACPI_IBM_METHOD_WLAN,
254 		.description	= "WLAN enable",
255 		.flag_rdonly	= 1
256 	},
257 	{
258 		.name		= "fan_speed",
259 		.method		= ACPI_IBM_METHOD_FANSPEED,
260 		.description	= "Fan speed",
261 		.flag_rdonly	= 1
262 	},
263 	{
264 		.name		= "fan_level",
265 		.method		= ACPI_IBM_METHOD_FANLEVEL,
266 		.description	= "Fan level",
267 	},
268 	{
269 		.name		= "fan",
270 		.method		= ACPI_IBM_METHOD_FANSTATUS,
271 		.description	= "Fan enable",
272 	},
273 	{
274 		.name		= "mic_led",
275 		.method		= ACPI_IBM_METHOD_MIC_LED,
276 		.description	= "Mic led",
277 	},
278 	{
279 		.name		= "privacyguard",
280 		.method		= ACPI_IBM_METHOD_PRIVACYGUARD,
281 		.description	= "PrivacyGuard enable",
282 	},
283 	{ NULL, 0, NULL, 0 }
284 };
285 
286 /*
287  * Per-model default list of event mask.
288  */
289 #define	ACPI_IBM_HKEY_RFKILL_MASK		(1 << 4)
290 #define	ACPI_IBM_HKEY_DSWITCH_MASK		(1 << 6)
291 #define	ACPI_IBM_HKEY_BRIGHTNESS_UP_MASK	(1 << 15)
292 #define	ACPI_IBM_HKEY_BRIGHTNESS_DOWN_MASK	(1 << 16)
293 #define	ACPI_IBM_HKEY_SEARCH_MASK		(1 << 18)
294 #define	ACPI_IBM_HKEY_MICMUTE_MASK		(1 << 26)
295 #define	ACPI_IBM_HKEY_SETTINGS_MASK		(1 << 28)
296 #define	ACPI_IBM_HKEY_VIEWOPEN_MASK		(1 << 30)
297 #define	ACPI_IBM_HKEY_VIEWALL_MASK		(1 << 31)
298 
299 struct acpi_ibm_models {
300 	const char *maker;
301 	const char *product;
302 	uint32_t eventmask;
303 } acpi_ibm_models[] = {
304 	{ "LENOVO", "20BSCTO1WW",
305 	  ACPI_IBM_HKEY_RFKILL_MASK |
306 	  ACPI_IBM_HKEY_DSWITCH_MASK |
307 	  ACPI_IBM_HKEY_BRIGHTNESS_UP_MASK |
308 	  ACPI_IBM_HKEY_BRIGHTNESS_DOWN_MASK |
309 	  ACPI_IBM_HKEY_SEARCH_MASK |
310 	  ACPI_IBM_HKEY_MICMUTE_MASK |
311 	  ACPI_IBM_HKEY_SETTINGS_MASK |
312 	  ACPI_IBM_HKEY_VIEWOPEN_MASK |
313 	  ACPI_IBM_HKEY_VIEWALL_MASK
314 	}
315 };
316 
317 ACPI_SERIAL_DECL(ibm, "ThinkPad ACPI Extras");
318 
319 static int	acpi_ibm_probe(device_t dev);
320 static int	acpi_ibm_attach(device_t dev);
321 static int	acpi_ibm_detach(device_t dev);
322 static int	acpi_ibm_resume(device_t dev);
323 
324 static void	ibm_led(void *softc, int onoff);
325 static void	ibm_led_task(struct acpi_ibm_softc *sc, int pending __unused);
326 
327 static int	acpi_ibm_sysctl(SYSCTL_HANDLER_ARGS);
328 static int	acpi_ibm_sysctl_init(struct acpi_ibm_softc *sc, int method);
329 static int	acpi_ibm_sysctl_get(struct acpi_ibm_softc *sc, int method);
330 static int	acpi_ibm_sysctl_set(struct acpi_ibm_softc *sc, int method, int val);
331 
332 static int	acpi_ibm_eventmask_set(struct acpi_ibm_softc *sc, int val);
333 static int	acpi_ibm_thermal_sysctl(SYSCTL_HANDLER_ARGS);
334 static int	acpi_ibm_handlerevents_sysctl(SYSCTL_HANDLER_ARGS);
335 static void	acpi_ibm_notify(ACPI_HANDLE h, UINT32 notify, void *context);
336 
337 static int	acpi_ibm_brightness_set(struct acpi_ibm_softc *sc, int arg);
338 static int	acpi_ibm_bluetooth_set(struct acpi_ibm_softc *sc, int arg);
339 static int	acpi_ibm_thinklight_set(struct acpi_ibm_softc *sc, int arg);
340 static int	acpi_ibm_volume_set(struct acpi_ibm_softc *sc, int arg);
341 static int	acpi_ibm_mute_set(struct acpi_ibm_softc *sc, int arg);
342 static int	acpi_ibm_privacyguard_get(struct acpi_ibm_softc *sc);
343 static ACPI_STATUS	acpi_ibm_privacyguard_set(struct acpi_ibm_softc *sc, int arg);
344 static ACPI_STATUS	acpi_ibm_privacyguard_acpi_call(struct acpi_ibm_softc *sc, bool write, int *arg);
345 
346 static int	acpi_status_to_errno(ACPI_STATUS status);
347 
348 static device_method_t acpi_ibm_methods[] = {
349 	/* Device interface */
350 	DEVMETHOD(device_probe, acpi_ibm_probe),
351 	DEVMETHOD(device_attach, acpi_ibm_attach),
352 	DEVMETHOD(device_detach, acpi_ibm_detach),
353 	DEVMETHOD(device_resume, acpi_ibm_resume),
354 
355 	DEVMETHOD_END
356 };
357 
358 static driver_t	acpi_ibm_driver = {
359 	"acpi_ibm",
360 	acpi_ibm_methods,
361 	sizeof(struct acpi_ibm_softc),
362 };
363 
364 static devclass_t acpi_ibm_devclass;
365 
366 DRIVER_MODULE(acpi_ibm, acpi, acpi_ibm_driver, acpi_ibm_devclass, 0, 0);
367 MODULE_DEPEND(acpi_ibm, acpi, 1, 1, 1);
368 static char    *ibm_ids[] = {"IBM0068", "LEN0068", "LEN0268", NULL};
369 
370 static int
371 acpi_status_to_errno(ACPI_STATUS status)
372 {
373 	switch (status) {
374 	case AE_OK:
375 		return (0);
376 	case AE_BAD_PARAMETER:
377 		return (EINVAL);
378 	default:
379 		return (ENODEV);
380 	}
381 }
382 
383 static void
384 ibm_led(void *softc, int onoff)
385 {
386 	struct acpi_ibm_softc *sc = softc;
387 
388 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
389 
390 	if (sc->led_busy)
391 		return;
392 
393 	sc->led_busy = 1;
394 	sc->led_state = onoff;
395 
396 	AcpiOsExecute(OSL_NOTIFY_HANDLER, (void *)ibm_led_task, sc);
397 }
398 
399 static void
400 ibm_led_task(struct acpi_ibm_softc *sc, int pending __unused)
401 {
402 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
403 
404 	ACPI_SERIAL_BEGIN(ibm);
405 	acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_THINKLIGHT, sc->led_state);
406 	ACPI_SERIAL_END(ibm);
407 
408 	sc->led_busy = 0;
409 }
410 
411 static int
412 acpi_ibm_mic_led_set(struct acpi_ibm_softc *sc, int arg)
413 {
414 	ACPI_OBJECT_LIST input;
415 	ACPI_OBJECT params[1];
416 	ACPI_STATUS status;
417 
418 	if (arg < 0 || arg > 1)
419 		return (EINVAL);
420 
421 	if (sc->mic_led_handle) {
422 		params[0].Type = ACPI_TYPE_INTEGER;
423 		params[0].Integer.Value = 0;
424 		/* mic led: 0 off, 2 on */
425 		if (arg == 1)
426 			params[0].Integer.Value = 2;
427 
428 		input.Pointer = params;
429 		input.Count = 1;
430 
431 		status = AcpiEvaluateObject(sc->handle, "MMTS", &input, NULL);
432 		if (ACPI_SUCCESS(status))
433 			sc->mic_led_state = arg;
434 		return (status);
435 	}
436 
437 	return (0);
438 }
439 
440 static int
441 acpi_ibm_probe(device_t dev)
442 {
443 	int rv;
444 
445 	if (acpi_disabled("ibm") || device_get_unit(dev) != 0)
446 		return (ENXIO);
447 	rv = ACPI_ID_PROBE(device_get_parent(dev), dev, ibm_ids, NULL);
448 
449 	if (rv <= 0)
450 		device_set_desc(dev, "ThinkPad ACPI Extras");
451 
452 	return (rv);
453 }
454 
455 static int
456 acpi_ibm_attach(device_t dev)
457 {
458 	int i;
459 	int hkey;
460 	struct acpi_ibm_softc *sc;
461 	char *maker, *product;
462 	ACPI_OBJECT_LIST input;
463 	ACPI_OBJECT params[1];
464 	ACPI_OBJECT out_obj;
465 	ACPI_BUFFER result;
466 	devclass_t ec_devclass;
467 
468 	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
469 
470 	sc = device_get_softc(dev);
471 	sc->dev = dev;
472 	sc->handle = acpi_get_handle(dev);
473 
474 	/* Look for the first embedded controller */
475 	if (!(ec_devclass = devclass_find ("acpi_ec"))) {
476 		if (bootverbose)
477 			device_printf(dev, "Couldn't find acpi_ec devclass\n");
478 		return (EINVAL);
479 	}
480 	if (!(sc->ec_dev = devclass_get_device(ec_devclass, 0))) {
481 		if (bootverbose)
482 			device_printf(dev, "Couldn't find acpi_ec device\n");
483 		return (EINVAL);
484 	}
485 	sc->ec_handle = acpi_get_handle(sc->ec_dev);
486 
487 	/* Get the sysctl tree */
488 	sc->sysctl_ctx = device_get_sysctl_ctx(dev);
489 	sc->sysctl_tree = device_get_sysctl_tree(dev);
490 
491 	/* Look for event mask and hook up the nodes */
492 	sc->events_mask_supported = ACPI_SUCCESS(acpi_GetInteger(sc->handle,
493 	    IBM_NAME_EVENTS_MASK_GET, &sc->events_initialmask));
494 
495 	if (sc->events_mask_supported) {
496 		SYSCTL_ADD_UINT(sc->sysctl_ctx,
497 		    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO, "initialmask",
498 		    CTLFLAG_RD, &sc->events_initialmask, 0,
499 		    "Initial eventmask");
500 
501 		if (ACPI_SUCCESS (acpi_GetInteger(sc->handle, "MHKV", &hkey))) {
502 			device_printf(dev, "Firmware version is 0x%X\n", hkey);
503 			switch (hkey >> 8) {
504 			case 1:
505 				/* The availmask is the bitmask of supported events */
506 				if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
507 				    IBM_NAME_EVENTS_AVAILMASK, &sc->events_availmask)))
508 					sc->events_availmask = 0xffffffff;
509 				break;
510 
511 			case 2:
512 				result.Length = sizeof(out_obj);
513 				result.Pointer = &out_obj;
514 				params[0].Type = ACPI_TYPE_INTEGER;
515 				params[0].Integer.Value = 1;
516 				input.Pointer = params;
517 				input.Count = 1;
518 
519 				sc->events_availmask = 0xffffffff;
520 
521 				if (ACPI_SUCCESS(AcpiEvaluateObject (sc->handle,
522 				    IBM_NAME_EVENTS_AVAILMASK, &input, &result)))
523 					sc->events_availmask = out_obj.Integer.Value;
524 				break;
525 			default:
526 				device_printf(dev, "Unknown firmware version 0x%x\n", hkey);
527 				break;
528 			}
529 		} else
530 			sc->events_availmask = 0xffffffff;
531 
532 		SYSCTL_ADD_UINT(sc->sysctl_ctx,
533 				SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
534 				"availmask", CTLFLAG_RD,
535 				&sc->events_availmask, 0, "Mask of supported events");
536 	}
537 
538 	/* Hook up proc nodes */
539 	for (int i = 0; acpi_ibm_sysctls[i].name != NULL; i++) {
540 		if (!acpi_ibm_sysctl_init(sc, acpi_ibm_sysctls[i].method))
541 			continue;
542 
543 		if (acpi_ibm_sysctls[i].flag_rdonly != 0) {
544 			SYSCTL_ADD_PROC(sc->sysctl_ctx,
545 			    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
546 			    acpi_ibm_sysctls[i].name, CTLTYPE_INT | CTLFLAG_RD,
547 			    sc, i, acpi_ibm_sysctl, "I",
548 			    acpi_ibm_sysctls[i].description);
549 		} else {
550 			SYSCTL_ADD_PROC(sc->sysctl_ctx,
551 			    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
552 			    acpi_ibm_sysctls[i].name, CTLTYPE_INT | CTLFLAG_RW,
553 			    sc, i, acpi_ibm_sysctl, "I",
554 			    acpi_ibm_sysctls[i].description);
555 		}
556 	}
557 
558 	/* Hook up thermal node */
559 	if (acpi_ibm_sysctl_init(sc, ACPI_IBM_METHOD_THERMAL)) {
560 		SYSCTL_ADD_PROC(sc->sysctl_ctx,
561 		    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO, "thermal",
562 		    CTLTYPE_INT | CTLFLAG_RD, sc, 0, acpi_ibm_thermal_sysctl,
563 		    "I", "Thermal zones");
564 	}
565 
566 	/* Hook up handlerevents node */
567 	if (acpi_ibm_sysctl_init(sc, ACPI_IBM_METHOD_HANDLEREVENTS)) {
568 		SYSCTL_ADD_PROC(sc->sysctl_ctx,
569 		    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO, "handlerevents",
570 		    CTLTYPE_STRING | CTLFLAG_RW, sc, 0,
571 		    acpi_ibm_handlerevents_sysctl, "I",
572 		    "devd(8) events handled by acpi_ibm");
573 	}
574 
575 	/* Handle notifies */
576 	AcpiInstallNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
577 	    acpi_ibm_notify, dev);
578 
579 	/* Hook up light to led(4) */
580 	if (sc->light_set_supported)
581 		sc->led_dev = led_create_state(ibm_led, sc, "thinklight",
582 		    (sc->light_val ? 1 : 0));
583 
584 	/* Enable per-model events. */
585 	maker = kern_getenv("smbios.system.maker");
586 	product = kern_getenv("smbios.system.product");
587 	if (maker == NULL || product == NULL)
588 		goto nosmbios;
589 
590 	for (i = 0; i < nitems(acpi_ibm_models); i++) {
591 		if (strcmp(maker, acpi_ibm_models[i].maker) == 0 &&
592 		    strcmp(product, acpi_ibm_models[i].product) == 0) {
593 			ACPI_SERIAL_BEGIN(ibm);
594 			acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTMASK,
595 			    acpi_ibm_models[i].eventmask);
596 			ACPI_SERIAL_END(ibm);
597 		}
598 	}
599 
600 nosmbios:
601 	freeenv(maker);
602 	freeenv(product);
603 
604 	/* Enable events by default. */
605 	ACPI_SERIAL_BEGIN(ibm);
606 	acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTS, 1);
607 	ACPI_SERIAL_END(ibm);
608 
609 	return (0);
610 }
611 
612 static int
613 acpi_ibm_detach(device_t dev)
614 {
615 	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
616 
617 	struct acpi_ibm_softc *sc = device_get_softc(dev);
618 
619 	/* Disable events and restore eventmask */
620 	ACPI_SERIAL_BEGIN(ibm);
621 	acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTS, 0);
622 	acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTMASK, sc->events_initialmask);
623 	ACPI_SERIAL_END(ibm);
624 
625 	AcpiRemoveNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY, acpi_ibm_notify);
626 
627 	if (sc->led_dev != NULL)
628 		led_destroy(sc->led_dev);
629 
630 	return (0);
631 }
632 
633 static int
634 acpi_ibm_resume(device_t dev)
635 {
636 	struct acpi_ibm_softc *sc = device_get_softc(dev);
637 
638 	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
639 
640 	ACPI_SERIAL_BEGIN(ibm);
641 	for (int i = 0; acpi_ibm_sysctls[i].name != NULL; i++) {
642 		int val;
643 
644 		val = acpi_ibm_sysctl_get(sc, i);
645 
646 		if (acpi_ibm_sysctls[i].flag_rdonly != 0)
647 			continue;
648 
649 		acpi_ibm_sysctl_set(sc, i, val);
650 	}
651 	ACPI_SERIAL_END(ibm);
652 
653 	/* The mic led does not turn back on when sysctl_set is called in the above loop */
654 	acpi_ibm_mic_led_set(sc, sc->mic_led_state);
655 
656 	return (0);
657 }
658 
659 static int
660 acpi_ibm_eventmask_set(struct acpi_ibm_softc *sc, int val)
661 {
662 	ACPI_OBJECT		arg[2];
663 	ACPI_OBJECT_LIST	args;
664 	ACPI_STATUS		status;
665 
666 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
667 	ACPI_SERIAL_ASSERT(ibm);
668 
669 	args.Count = 2;
670 	args.Pointer = arg;
671 	arg[0].Type = ACPI_TYPE_INTEGER;
672 	arg[1].Type = ACPI_TYPE_INTEGER;
673 
674 	for (int i = 0; i < 32; ++i) {
675 		arg[0].Integer.Value = i + 1;
676 		arg[1].Integer.Value = (((1 << i) & val) != 0);
677 		status = AcpiEvaluateObject(sc->handle,
678 		    IBM_NAME_EVENTS_MASK_SET, &args, NULL);
679 
680 		if (ACPI_FAILURE(status))
681 			return (status);
682 	}
683 
684 	return (0);
685 }
686 
687 static int
688 acpi_ibm_sysctl(SYSCTL_HANDLER_ARGS)
689 {
690 	struct acpi_ibm_softc	*sc;
691 	int			arg;
692 	int			error = 0;
693 	int			function;
694 	int			method;
695 
696 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
697 
698 	sc = (struct acpi_ibm_softc *)oidp->oid_arg1;
699 	function = oidp->oid_arg2;
700 	method = acpi_ibm_sysctls[function].method;
701 
702 	ACPI_SERIAL_BEGIN(ibm);
703 	arg = acpi_ibm_sysctl_get(sc, method);
704 	error = sysctl_handle_int(oidp, &arg, 0, req);
705 
706 	/* Sanity check */
707 	if (error != 0 || req->newptr == NULL)
708 		goto out;
709 
710 	/* Update */
711 	error = acpi_ibm_sysctl_set(sc, method, arg);
712 
713 out:
714 	ACPI_SERIAL_END(ibm);
715 	return (error);
716 }
717 
718 static int
719 acpi_ibm_sysctl_get(struct acpi_ibm_softc *sc, int method)
720 {
721 	UINT64		val_ec;
722 	int 		val = 0, key;
723 
724 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
725 	ACPI_SERIAL_ASSERT(ibm);
726 
727 	switch (method) {
728 	case ACPI_IBM_METHOD_EVENTS:
729 		acpi_GetInteger(sc->handle, IBM_NAME_EVENTS_STATUS_GET, &val);
730 		break;
731 
732 	case ACPI_IBM_METHOD_EVENTMASK:
733 		if (sc->events_mask_supported)
734 			acpi_GetInteger(sc->handle, IBM_NAME_EVENTS_MASK_GET, &val);
735 		break;
736 
737 	case ACPI_IBM_METHOD_HOTKEY:
738 		/*
739 		 * Construct the hotkey as a bitmask as illustrated below.
740 		 * Note that whenever a key was pressed, the respecting bit
741 		 * toggles and nothing else changes.
742 		 * +--+--+-+-+-+-+-+-+-+-+-+-+
743 		 * |11|10|9|8|7|6|5|4|3|2|1|0|
744 		 * +--+--+-+-+-+-+-+-+-+-+-+-+
745 		 *   |  | | | | | | | | | | |
746 		 *   |  | | | | | | | | | | +- Home Button
747 		 *   |  | | | | | | | | | +--- Search Button
748 		 *   |  | | | | | | | | +----- Mail Button
749 		 *   |  | | | | | | | +------- Thinkpad Button
750 		 *   |  | | | | | | +--------- Zoom (Fn + Space)
751 		 *   |  | | | | | +----------- WLAN Button
752 		 *   |  | | | | +------------- Video Button
753 		 *   |  | | | +--------------- Hibernate Button
754 		 *   |  | | +----------------- Thinklight Button
755 		 *   |  | +------------------- Screen expand (Fn + F8)
756 		 *   |  +--------------------- Brightness
757 		 *   +------------------------ Volume/Mute
758 		 */
759 		key = rtcin(IBM_RTC_HOTKEY1);
760 		val = (IBM_RTC_MASK_HOME | IBM_RTC_MASK_SEARCH | IBM_RTC_MASK_MAIL | IBM_RTC_MASK_WLAN) & key;
761 		key = rtcin(IBM_RTC_HOTKEY2);
762 		val |= (IBM_RTC_MASK_THINKPAD | IBM_RTC_MASK_VIDEO | IBM_RTC_MASK_HIBERNATE) & key;
763 		val |= (IBM_RTC_MASK_ZOOM & key) >> 1;
764 		key = rtcin(IBM_RTC_THINKLIGHT);
765 		val |= (IBM_RTC_MASK_THINKLIGHT & key) << 4;
766 		key = rtcin(IBM_RTC_SCREENEXPAND);
767 		val |= (IBM_RTC_MASK_THINKLIGHT & key) << 4;
768 		key = rtcin(IBM_RTC_BRIGHTNESS);
769 		val |= (IBM_RTC_MASK_BRIGHTNESS & key) << 5;
770 		key = rtcin(IBM_RTC_VOLUME);
771 		val |= (IBM_RTC_MASK_VOLUME & key) << 4;
772 		break;
773 
774 	case ACPI_IBM_METHOD_BRIGHTNESS:
775 		ACPI_EC_READ(sc->ec_dev, IBM_EC_BRIGHTNESS, &val_ec, 1);
776 		val = val_ec & IBM_EC_MASK_BRI;
777 		break;
778 
779 	case ACPI_IBM_METHOD_VOLUME:
780 		ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
781 		val = val_ec & IBM_EC_MASK_VOL;
782 		break;
783 
784 	case ACPI_IBM_METHOD_MUTE:
785 		ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
786 		val = ((val_ec & IBM_EC_MASK_MUTE) == IBM_EC_MASK_MUTE);
787 		break;
788 
789 	case ACPI_IBM_METHOD_THINKLIGHT:
790 		if (sc->light_get_supported)
791 			acpi_GetInteger(sc->ec_handle, IBM_NAME_KEYLIGHT, &val);
792 		else
793 			val = sc->light_val;
794 		break;
795 
796 	case ACPI_IBM_METHOD_BLUETOOTH:
797 		acpi_GetInteger(sc->handle, IBM_NAME_WLAN_BT_GET, &val);
798 		sc->wlan_bt_flags = val;
799 		val = ((val & IBM_NAME_MASK_BT) != 0);
800 		break;
801 
802 	case ACPI_IBM_METHOD_WLAN:
803 		acpi_GetInteger(sc->handle, IBM_NAME_WLAN_BT_GET, &val);
804 		sc->wlan_bt_flags = val;
805 		val = ((val & IBM_NAME_MASK_WLAN) != 0);
806 		break;
807 
808 	case ACPI_IBM_METHOD_FANSPEED:
809 		if (sc->fan_handle) {
810 			if(ACPI_FAILURE(acpi_GetInteger(sc->fan_handle, NULL, &val)))
811 				val = -1;
812 		} else {
813 			ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSPEED, &val_ec, 2);
814 			val = val_ec;
815 		}
816 		break;
817 
818 	case ACPI_IBM_METHOD_FANLEVEL:
819 		/*
820 		 * The IBM_EC_FANSTATUS register works as follows:
821 		 * Bit 0-5 indicate the level at which the fan operates. Only
822 		 *       values between 0 and 7 have an effect. Everything
823 		 *       above 7 is treated the same as level 7
824 		 * Bit 6 overrides the fan speed limit if set to 1
825 		 * Bit 7 indicates at which mode the fan operates:
826 		 *       manual (0) or automatic (1)
827 		 */
828 		if (!sc->fan_handle) {
829 			ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
830 			val = val_ec & IBM_EC_MASK_FANLEVEL;
831 		}
832 		break;
833 
834 	case ACPI_IBM_METHOD_FANSTATUS:
835 		if (!sc->fan_handle) {
836 			ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
837 			val = (val_ec & IBM_EC_MASK_FANSTATUS) == IBM_EC_MASK_FANSTATUS;
838 		} else
839 			val = -1;
840 		break;
841 
842 	case ACPI_IBM_METHOD_MIC_LED:
843 		if (sc->mic_led_handle)
844 			return sc->mic_led_state;
845 		else
846 			val = -1;
847 		break;
848 
849 	case ACPI_IBM_METHOD_PRIVACYGUARD:
850 		val = acpi_ibm_privacyguard_get(sc);
851 		break;
852 	}
853 
854 	return (val);
855 }
856 
857 static int
858 acpi_ibm_sysctl_set(struct acpi_ibm_softc *sc, int method, int arg)
859 {
860 	int			val;
861 	UINT64			val_ec;
862 	ACPI_STATUS		status;
863 
864 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
865 	ACPI_SERIAL_ASSERT(ibm);
866 
867 	switch (method) {
868 	case ACPI_IBM_METHOD_EVENTS:
869 		if (arg < 0 || arg > 1)
870 			return (EINVAL);
871 
872 		status = acpi_SetInteger(sc->handle, IBM_NAME_EVENTS_STATUS_SET, arg);
873 		if (ACPI_FAILURE(status))
874 			return (status);
875 		if (sc->events_mask_supported)
876 			return acpi_ibm_eventmask_set(sc, sc->events_availmask);
877 		break;
878 
879 	case ACPI_IBM_METHOD_EVENTMASK:
880 		if (sc->events_mask_supported)
881 			return acpi_ibm_eventmask_set(sc, arg);
882 		break;
883 
884 	case ACPI_IBM_METHOD_BRIGHTNESS:
885 		return acpi_ibm_brightness_set(sc, arg);
886 		break;
887 
888 	case ACPI_IBM_METHOD_VOLUME:
889 		return acpi_ibm_volume_set(sc, arg);
890 		break;
891 
892 	case ACPI_IBM_METHOD_MUTE:
893 		return acpi_ibm_mute_set(sc, arg);
894 		break;
895 
896 	case ACPI_IBM_METHOD_MIC_LED:
897 		return acpi_ibm_mic_led_set(sc, arg);
898 		break;
899 
900 	case ACPI_IBM_METHOD_THINKLIGHT:
901 		return acpi_ibm_thinklight_set(sc, arg);
902 		break;
903 
904 	case ACPI_IBM_METHOD_BLUETOOTH:
905 		return acpi_ibm_bluetooth_set(sc, arg);
906 		break;
907 
908 	case ACPI_IBM_METHOD_PRIVACYGUARD:
909 		return (acpi_status_to_errno(acpi_ibm_privacyguard_set(sc, arg)));
910 		break;
911 
912 	case ACPI_IBM_METHOD_FANLEVEL:
913 		if (arg < 0 || arg > 7)
914 			return (EINVAL);
915 
916 		if (!sc->fan_handle) {
917 			/* Read the current fanstatus */
918 			ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
919 			val = val_ec & (~IBM_EC_MASK_FANLEVEL);
920 
921 			return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_FANSTATUS, val | arg, 1);
922 		}
923 		break;
924 
925 	case ACPI_IBM_METHOD_FANSTATUS:
926 		if (arg < 0 || arg > 1)
927 			return (EINVAL);
928 
929 		if (!sc->fan_handle) {
930 			/* Read the current fanstatus */
931 			ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
932 
933 			return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_FANSTATUS,
934 				(arg == 1) ? (val_ec | IBM_EC_MASK_FANSTATUS) : (val_ec & (~IBM_EC_MASK_FANSTATUS)), 1);
935 		}
936 		break;
937 	}
938 
939 	return (0);
940 }
941 
942 static int
943 acpi_ibm_sysctl_init(struct acpi_ibm_softc *sc, int method)
944 {
945 	int 			dummy;
946 	ACPI_OBJECT_TYPE 	cmos_t;
947 	ACPI_HANDLE		ledb_handle;
948 
949 	switch (method) {
950 	case ACPI_IBM_METHOD_EVENTS:
951 		return (TRUE);
952 
953 	case ACPI_IBM_METHOD_EVENTMASK:
954 		return (sc->events_mask_supported);
955 
956 	case ACPI_IBM_METHOD_HOTKEY:
957 	case ACPI_IBM_METHOD_BRIGHTNESS:
958 	case ACPI_IBM_METHOD_VOLUME:
959 	case ACPI_IBM_METHOD_MUTE:
960 		/* EC is required here, which was already checked before */
961 		return (TRUE);
962 
963 	case ACPI_IBM_METHOD_MIC_LED:
964 		if (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "MMTS", &sc->mic_led_handle)))
965 		{
966 			/* Turn off mic led by default */
967 			acpi_ibm_mic_led_set(sc, 0);
968 			return (TRUE);
969 		} else
970 			sc->mic_led_handle = NULL;
971 		return (FALSE);
972 
973 	case ACPI_IBM_METHOD_THINKLIGHT:
974 		sc->cmos_handle = NULL;
975 		sc->light_get_supported = ACPI_SUCCESS(acpi_GetInteger(
976 		    sc->ec_handle, IBM_NAME_KEYLIGHT, &sc->light_val));
977 
978 		if ((ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\UCMS", &sc->light_handle)) ||
979 		     ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\CMOS", &sc->light_handle)) ||
980 		     ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\CMS", &sc->light_handle))) &&
981 		     ACPI_SUCCESS(AcpiGetType(sc->light_handle, &cmos_t)) &&
982 		     cmos_t == ACPI_TYPE_METHOD) {
983 			sc->light_cmd_on = 0x0c;
984 			sc->light_cmd_off = 0x0d;
985 			sc->cmos_handle = sc->light_handle;
986 		}
987 		else if (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\LGHT", &sc->light_handle))) {
988 			sc->light_cmd_on = 1;
989 			sc->light_cmd_off = 0;
990 		} else
991 			sc->light_handle = NULL;
992 
993 		sc->light_set_supported = (sc->light_handle &&
994 		    ACPI_FAILURE(AcpiGetHandle(sc->ec_handle, "LEDB", &ledb_handle)));
995 
996 		if (sc->light_get_supported)
997 			return (TRUE);
998 
999 		if (sc->light_set_supported) {
1000 			sc->light_val = 0;
1001 			return (TRUE);
1002 		}
1003 
1004 		return (FALSE);
1005 
1006 	case ACPI_IBM_METHOD_BLUETOOTH:
1007 	case ACPI_IBM_METHOD_WLAN:
1008 		if (ACPI_SUCCESS(acpi_GetInteger(sc->handle, IBM_NAME_WLAN_BT_GET, &dummy)))
1009 			return (TRUE);
1010 		return (FALSE);
1011 
1012 	case ACPI_IBM_METHOD_FANSPEED:
1013 		/*
1014 		 * Some models report the fan speed in levels from 0-7
1015 		 * Newer models report it contiguously
1016 		 */
1017 		sc->fan_levels =
1018 		    (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "GFAN", &sc->fan_handle)) ||
1019 		     ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\FSPD", &sc->fan_handle)));
1020 		return (TRUE);
1021 
1022 	case ACPI_IBM_METHOD_FANLEVEL:
1023 	case ACPI_IBM_METHOD_FANSTATUS:
1024 		/*
1025 		 * Fan status is only supported on those models,
1026 		 * which report fan RPM contiguously, not in levels
1027 		 */
1028 		if (sc->fan_levels)
1029 			return (FALSE);
1030 		return (TRUE);
1031 
1032 	case ACPI_IBM_METHOD_THERMAL:
1033 		if (ACPI_SUCCESS(acpi_GetInteger(sc->ec_handle, IBM_NAME_THERMAL_GET, &dummy))) {
1034 			sc->thermal_updt_supported = ACPI_SUCCESS(acpi_GetInteger(sc->ec_handle, IBM_NAME_THERMAL_UPDT, &dummy));
1035 			return (TRUE);
1036 		}
1037 		return (FALSE);
1038 
1039 	case ACPI_IBM_METHOD_HANDLEREVENTS:
1040 		return (TRUE);
1041 
1042 	case ACPI_IBM_METHOD_PRIVACYGUARD:
1043 		return (acpi_ibm_privacyguard_get(sc) != -1);
1044 	}
1045 	return (FALSE);
1046 }
1047 
1048 static int
1049 acpi_ibm_thermal_sysctl(SYSCTL_HANDLER_ARGS)
1050 {
1051 	struct acpi_ibm_softc	*sc;
1052 	int			error = 0;
1053 	char			temp_cmd[] = "TMP0";
1054 	int			temp[8];
1055 
1056 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1057 
1058 	sc = (struct acpi_ibm_softc *)oidp->oid_arg1;
1059 
1060 	ACPI_SERIAL_BEGIN(ibm);
1061 
1062 	for (int i = 0; i < 8; ++i) {
1063 		temp_cmd[3] = '0' + i;
1064 
1065 		/*
1066 		 * The TMPx methods seem to return +/- 128 or 0
1067 		 * when the respecting sensor is not available
1068 		 */
1069 		if (ACPI_FAILURE(acpi_GetInteger(sc->ec_handle, temp_cmd,
1070 		    &temp[i])) || ABS(temp[i]) == 128 || temp[i] == 0)
1071 			temp[i] = -1;
1072 		else if (sc->thermal_updt_supported)
1073 			/* Temperature is reported in tenth of Kelvin */
1074 			temp[i] = (temp[i] - 2731 + 5) / 10;
1075 	}
1076 
1077 	error = sysctl_handle_opaque(oidp, &temp, 8*sizeof(int), req);
1078 
1079 	ACPI_SERIAL_END(ibm);
1080 	return (error);
1081 }
1082 
1083 static int
1084 acpi_ibm_handlerevents_sysctl(SYSCTL_HANDLER_ARGS)
1085 {
1086 	struct acpi_ibm_softc	*sc;
1087 	int			error = 0;
1088 	struct sbuf		sb;
1089 	char			*cp, *ep;
1090 	int			l, val;
1091 	unsigned int		handler_events;
1092 	char			temp[128];
1093 
1094 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1095 
1096 	sc = (struct acpi_ibm_softc *)oidp->oid_arg1;
1097 
1098 	if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
1099 		return (ENOMEM);
1100 
1101 	ACPI_SERIAL_BEGIN(ibm);
1102 
1103 	/* Get old values if this is a get request. */
1104 	if (req->newptr == NULL) {
1105 		for (int i = 0; i < 8 * sizeof(sc->handler_events); i++)
1106 			if (sc->handler_events & (1 << i))
1107 				sbuf_printf(&sb, "0x%02x ", i + 1);
1108 		if (sbuf_len(&sb) == 0)
1109 			sbuf_printf(&sb, "NONE");
1110 	}
1111 
1112 	sbuf_trim(&sb);
1113 	sbuf_finish(&sb);
1114 	strlcpy(temp, sbuf_data(&sb), sizeof(temp));
1115 	sbuf_delete(&sb);
1116 
1117 	error = sysctl_handle_string(oidp, temp, sizeof(temp), req);
1118 
1119 	/* Check for error or no change */
1120 	if (error != 0 || req->newptr == NULL)
1121 		goto out;
1122 
1123 	/* If the user is setting a string, parse it. */
1124 	handler_events = 0;
1125 	cp = temp;
1126 	while (*cp) {
1127 		if (isspace(*cp)) {
1128 			cp++;
1129 			continue;
1130 		}
1131 
1132 		ep = cp;
1133 
1134 		while (*ep && !isspace(*ep))
1135 			ep++;
1136 
1137 		l = ep - cp;
1138 		if (l == 0)
1139 			break;
1140 
1141 		if (strncmp(cp, "NONE", 4) == 0) {
1142 			cp = ep;
1143 			continue;
1144 		}
1145 
1146 		if (l >= 3 && cp[0] == '0' && (cp[1] == 'X' || cp[1] == 'x'))
1147 			val = strtoul(cp, &ep, 16);
1148 		else
1149 			val = strtoul(cp, &ep, 10);
1150 
1151 		if (val == 0 || ep == cp || val >= 8 * sizeof(handler_events)) {
1152 			cp[l] = '\0';
1153 			device_printf(sc->dev, "invalid event code: %s\n", cp);
1154 			error = EINVAL;
1155 			goto out;
1156 		}
1157 
1158 		handler_events |= 1 << (val - 1);
1159 
1160 		cp = ep;
1161 	}
1162 
1163 	sc->handler_events = handler_events;
1164 out:
1165 	ACPI_SERIAL_END(ibm);
1166 	return (error);
1167 }
1168 
1169 static int
1170 acpi_ibm_brightness_set(struct acpi_ibm_softc *sc, int arg)
1171 {
1172 	int			val, step;
1173 	UINT64			val_ec;
1174 	ACPI_OBJECT		Arg;
1175 	ACPI_OBJECT_LIST	Args;
1176 	ACPI_STATUS		status;
1177 
1178 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1179 	ACPI_SERIAL_ASSERT(ibm);
1180 
1181 	if (arg < 0 || arg > 7)
1182 		return (EINVAL);
1183 
1184 	/* Read the current brightness */
1185 	status = ACPI_EC_READ(sc->ec_dev, IBM_EC_BRIGHTNESS, &val_ec, 1);
1186 	if (ACPI_FAILURE(status))
1187 		return (status);
1188 
1189 	if (sc->cmos_handle) {
1190 		val = val_ec & IBM_EC_MASK_BRI;
1191 
1192 		Args.Count = 1;
1193 		Args.Pointer = &Arg;
1194 		Arg.Type = ACPI_TYPE_INTEGER;
1195 		Arg.Integer.Value = (arg > val) ? IBM_CMOS_BRIGHTNESS_UP :
1196 						  IBM_CMOS_BRIGHTNESS_DOWN;
1197 
1198 		step = (arg > val) ? 1 : -1;
1199 		for (int i = val; i != arg; i += step) {
1200 			status = AcpiEvaluateObject(sc->cmos_handle, NULL,
1201 						    &Args, NULL);
1202 			if (ACPI_FAILURE(status)) {
1203 				/* Record the last value */
1204 				if (i != val) {
1205 					ACPI_EC_WRITE(sc->ec_dev,
1206 					    IBM_EC_BRIGHTNESS, i - step, 1);
1207 				}
1208 				return (status);
1209 			}
1210 		}
1211 	}
1212 
1213 	return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_BRIGHTNESS, arg, 1);
1214 }
1215 
1216 static int
1217 acpi_ibm_bluetooth_set(struct acpi_ibm_softc *sc, int arg)
1218 {
1219 	int			val;
1220 
1221 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1222 	ACPI_SERIAL_ASSERT(ibm);
1223 
1224 	if (arg < 0 || arg > 1)
1225 		return (EINVAL);
1226 
1227 	val = (arg == 1) ? sc->wlan_bt_flags | IBM_NAME_MASK_BT :
1228 			   sc->wlan_bt_flags & (~IBM_NAME_MASK_BT);
1229 	return acpi_SetInteger(sc->handle, IBM_NAME_WLAN_BT_SET, val);
1230 }
1231 
1232 static int
1233 acpi_ibm_thinklight_set(struct acpi_ibm_softc *sc, int arg)
1234 {
1235 	ACPI_OBJECT		Arg;
1236 	ACPI_OBJECT_LIST	Args;
1237 	ACPI_STATUS		status;
1238 
1239 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1240 	ACPI_SERIAL_ASSERT(ibm);
1241 
1242 	if (arg < 0 || arg > 1)
1243 		return (EINVAL);
1244 
1245 	if (sc->light_set_supported) {
1246 		Args.Count = 1;
1247 		Args.Pointer = &Arg;
1248 		Arg.Type = ACPI_TYPE_INTEGER;
1249 		Arg.Integer.Value = arg ? sc->light_cmd_on : sc->light_cmd_off;
1250 
1251 		status = AcpiEvaluateObject(sc->light_handle, NULL,
1252 					    &Args, NULL);
1253 		if (ACPI_SUCCESS(status))
1254 			sc->light_val = arg;
1255 		return (status);
1256 	}
1257 
1258 	return (0);
1259 }
1260 
1261 /*
1262  * Helper function to make a get or set ACPI call to the PrivacyGuard handle.
1263  * Only meant to be used internally by the get/set functions below.
1264  */
1265 static ACPI_STATUS
1266 acpi_ibm_privacyguard_acpi_call(struct acpi_ibm_softc *sc, bool write, int *arg)
1267 {
1268 	ACPI_OBJECT		Arg;
1269 	ACPI_OBJECT_LIST	Args;
1270 	ACPI_STATUS		status;
1271 	ACPI_OBJECT		out_obj;
1272 	ACPI_BUFFER		result;
1273 
1274 	Arg.Type = ACPI_TYPE_INTEGER;
1275 	Arg.Integer.Value = (write ? *arg : 0);
1276 	Args.Count = 1;
1277 	Args.Pointer = &Arg;
1278 	result.Length = sizeof(out_obj);
1279 	result.Pointer = &out_obj;
1280 
1281 	status = AcpiEvaluateObject(sc->handle,
1282 	    (write ? IBM_NAME_PRIVACYGUARD_SET : IBM_NAME_PRIVACYGUARD_GET),
1283 	    &Args, &result);
1284 	if (ACPI_SUCCESS(status) && !write)
1285 		*arg = out_obj.Integer.Value;
1286 
1287 	return (status);
1288 }
1289 
1290 /*
1291  * Returns -1 if the device is not present.
1292  */
1293 static int
1294 acpi_ibm_privacyguard_get(struct acpi_ibm_softc *sc)
1295 {
1296 	ACPI_STATUS status;
1297 	int val;
1298 
1299 	status = acpi_ibm_privacyguard_acpi_call(sc, false, &val);
1300 	if (ACPI_SUCCESS(status) &&
1301 	    (val & IBM_FLAG_PRIVACYGUARD_DEVICE_PRESENT))
1302 		return (val & IBM_FLAG_PRIVACYGUARD_ON);
1303 
1304 	return (-1);
1305 }
1306 
1307 static ACPI_STATUS
1308 acpi_ibm_privacyguard_set(struct acpi_ibm_softc *sc, int arg)
1309 {
1310 	if (arg < 0 || arg > 1)
1311 		return (AE_BAD_PARAMETER);
1312 
1313 	return (acpi_ibm_privacyguard_acpi_call(sc, true, &arg));
1314 }
1315 
1316 static int
1317 acpi_ibm_volume_set(struct acpi_ibm_softc *sc, int arg)
1318 {
1319 	int			val, step;
1320 	UINT64			val_ec;
1321 	ACPI_OBJECT		Arg;
1322 	ACPI_OBJECT_LIST	Args;
1323 	ACPI_STATUS		status;
1324 
1325 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1326 	ACPI_SERIAL_ASSERT(ibm);
1327 
1328 	if (arg < 0 || arg > 14)
1329 		return (EINVAL);
1330 
1331 	/* Read the current volume */
1332 	status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1333 	if (ACPI_FAILURE(status))
1334 		return (status);
1335 
1336 	if (sc->cmos_handle) {
1337 		val = val_ec & IBM_EC_MASK_VOL;
1338 
1339 		Args.Count = 1;
1340 		Args.Pointer = &Arg;
1341 		Arg.Type = ACPI_TYPE_INTEGER;
1342 		Arg.Integer.Value = (arg > val) ? IBM_CMOS_VOLUME_UP :
1343 						  IBM_CMOS_VOLUME_DOWN;
1344 
1345 		step = (arg > val) ? 1 : -1;
1346 		for (int i = val; i != arg; i += step) {
1347 			status = AcpiEvaluateObject(sc->cmos_handle, NULL,
1348 						    &Args, NULL);
1349 			if (ACPI_FAILURE(status)) {
1350 				/* Record the last value */
1351 				if (i != val) {
1352 					val_ec = i - step +
1353 						 (val_ec & (~IBM_EC_MASK_VOL));
1354 					ACPI_EC_WRITE(sc->ec_dev, IBM_EC_VOLUME,
1355 						      val_ec, 1);
1356 				}
1357 				return (status);
1358 			}
1359 		}
1360 	}
1361 
1362 	val_ec = arg + (val_ec & (~IBM_EC_MASK_VOL));
1363 	return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_VOLUME, val_ec, 1);
1364 }
1365 
1366 static int
1367 acpi_ibm_mute_set(struct acpi_ibm_softc *sc, int arg)
1368 {
1369 	UINT64			val_ec;
1370 	ACPI_OBJECT		Arg;
1371 	ACPI_OBJECT_LIST	Args;
1372 	ACPI_STATUS		status;
1373 
1374 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1375 	ACPI_SERIAL_ASSERT(ibm);
1376 
1377 	if (arg < 0 || arg > 1)
1378 		return (EINVAL);
1379 
1380 	status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1381 	if (ACPI_FAILURE(status))
1382 		return (status);
1383 
1384 	if (sc->cmos_handle) {
1385 		Args.Count = 1;
1386 		Args.Pointer = &Arg;
1387 		Arg.Type = ACPI_TYPE_INTEGER;
1388 		Arg.Integer.Value = IBM_CMOS_VOLUME_MUTE;
1389 
1390 		status = AcpiEvaluateObject(sc->cmos_handle, NULL, &Args, NULL);
1391 		if (ACPI_FAILURE(status))
1392 			return (status);
1393 	}
1394 
1395 	val_ec = (arg == 1) ? val_ec | IBM_EC_MASK_MUTE :
1396 			      val_ec & (~IBM_EC_MASK_MUTE);
1397 	return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_VOLUME, val_ec, 1);
1398 }
1399 
1400 static void
1401 acpi_ibm_eventhandler(struct acpi_ibm_softc *sc, int arg)
1402 {
1403 	int			val;
1404 	UINT64			val_ec;
1405 	ACPI_STATUS		status;
1406 
1407 	ACPI_SERIAL_BEGIN(ibm);
1408 	switch (arg) {
1409 	case IBM_EVENT_SUSPEND_TO_RAM:
1410 		power_pm_suspend(POWER_SLEEP_STATE_SUSPEND);
1411 		break;
1412 
1413 	case IBM_EVENT_BLUETOOTH:
1414 		acpi_ibm_bluetooth_set(sc, (sc->wlan_bt_flags == 0));
1415 		break;
1416 
1417 	case IBM_EVENT_BRIGHTNESS_UP:
1418 	case IBM_EVENT_BRIGHTNESS_DOWN:
1419 		/* Read the current brightness */
1420 		status = ACPI_EC_READ(sc->ec_dev, IBM_EC_BRIGHTNESS,
1421 				      &val_ec, 1);
1422 		if (ACPI_FAILURE(status))
1423 			return;
1424 
1425 		val = val_ec & IBM_EC_MASK_BRI;
1426 		val = (arg == IBM_EVENT_BRIGHTNESS_UP) ? val + 1 : val - 1;
1427 		acpi_ibm_brightness_set(sc, val);
1428 		break;
1429 
1430 	case IBM_EVENT_THINKLIGHT:
1431 		acpi_ibm_thinklight_set(sc, (sc->light_val == 0));
1432 		break;
1433 
1434 	case IBM_EVENT_VOLUME_UP:
1435 	case IBM_EVENT_VOLUME_DOWN:
1436 		/* Read the current volume */
1437 		status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1438 		if (ACPI_FAILURE(status))
1439 			return;
1440 
1441 		val = val_ec & IBM_EC_MASK_VOL;
1442 		val = (arg == IBM_EVENT_VOLUME_UP) ? val + 1 : val - 1;
1443 		acpi_ibm_volume_set(sc, val);
1444 		break;
1445 
1446 	case IBM_EVENT_MUTE:
1447 		/* Read the current value */
1448 		status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1449 		if (ACPI_FAILURE(status))
1450 			return;
1451 
1452 		val = ((val_ec & IBM_EC_MASK_MUTE) == IBM_EC_MASK_MUTE);
1453 		acpi_ibm_mute_set(sc, (val == 0));
1454 		break;
1455 
1456 	default:
1457 		break;
1458 	}
1459 	ACPI_SERIAL_END(ibm);
1460 }
1461 
1462 static void
1463 acpi_ibm_notify(ACPI_HANDLE h, UINT32 notify, void *context)
1464 {
1465 	int		event, arg, type;
1466 	device_t	dev = context;
1467 	struct acpi_ibm_softc *sc = device_get_softc(dev);
1468 
1469 	ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
1470 
1471 	if (notify != 0x80)
1472 		device_printf(dev, "Unknown notify\n");
1473 
1474 	for (;;) {
1475 		acpi_GetInteger(acpi_get_handle(dev), IBM_NAME_EVENTS_GET, &event);
1476 		if (event == 0)
1477 			break;
1478 
1479 		type = (event >> 12) & 0xf;
1480 		arg = event & 0xfff;
1481 		switch (type) {
1482 		case 1:
1483 			if (!(sc->events_availmask & (1 << (arg - 1)))) {
1484 				device_printf(dev, "Unknown key %d\n", arg);
1485 				break;
1486 			}
1487 
1488 			/* Execute event handler */
1489 			if (sc->handler_events & (1 << (arg - 1)))
1490 				acpi_ibm_eventhandler(sc, (arg & 0xff));
1491 
1492 			/* Notify devd(8) */
1493 			acpi_UserNotify("IBM", h, (arg & 0xff));
1494 			break;
1495 		default:
1496 			break;
1497 		}
1498 	}
1499 }
1500