xref: /freebsd/sys/dev/acpi_support/acpi_ibm.c (revision 02aeba837468fad6e0a91c9acbddfd4e1eb006e0)
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,
367 	      0, 0);
368 MODULE_DEPEND(acpi_ibm, acpi, 1, 1, 1);
369 static char    *ibm_ids[] = {"IBM0068", "LEN0068", "LEN0268", NULL};
370 
371 static int
372 acpi_status_to_errno(ACPI_STATUS status)
373 {
374 	switch (status) {
375 	case AE_OK:
376 		return (0);
377 	case AE_BAD_PARAMETER:
378 		return (EINVAL);
379 	default:
380 		return (ENODEV);
381 	}
382 }
383 
384 static void
385 ibm_led(void *softc, int onoff)
386 {
387 	struct acpi_ibm_softc* sc = (struct acpi_ibm_softc*) softc;
388 
389 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
390 
391 	if (sc->led_busy)
392 		return;
393 
394 	sc->led_busy = 1;
395 	sc->led_state = onoff;
396 
397 	AcpiOsExecute(OSL_NOTIFY_HANDLER, (void *)ibm_led_task, sc);
398 }
399 
400 static void
401 ibm_led_task(struct acpi_ibm_softc *sc, int pending __unused)
402 {
403 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
404 
405 	ACPI_SERIAL_BEGIN(ibm);
406 	acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_THINKLIGHT, sc->led_state);
407 	ACPI_SERIAL_END(ibm);
408 
409 	sc->led_busy = 0;
410 }
411 
412 static int
413 acpi_ibm_mic_led_set (struct acpi_ibm_softc *sc, int arg)
414 {
415 	ACPI_OBJECT_LIST input;
416 	ACPI_OBJECT params[1];
417 	ACPI_STATUS status;
418 
419 	if (arg < 0 || arg > 1)
420 		return (EINVAL);
421 
422 	if (sc->mic_led_handle) {
423 		params[0].Type = ACPI_TYPE_INTEGER;
424 		params[0].Integer.Value = 0;
425 		/* mic led: 0 off, 2 on */
426 		if (arg == 1)
427 			params[0].Integer.Value = 2;
428 
429 		input.Pointer = params;
430 		input.Count = 1;
431 
432 		status = AcpiEvaluateObject (sc->handle, "MMTS", &input, NULL);
433 		if (ACPI_SUCCESS(status))
434 			sc->mic_led_state = arg;
435 		return(status);
436 	}
437 
438 	return (0);
439 }
440 
441 static int
442 acpi_ibm_probe(device_t dev)
443 {
444 	int rv;
445 
446 	if (acpi_disabled("ibm") ||
447 	    device_get_unit(dev) != 0)
448 		return (ENXIO);
449 	rv = ACPI_ID_PROBE(device_get_parent(dev), dev, ibm_ids, NULL);
450 
451 	if (rv <= 0)
452 		device_set_desc(dev, "ThinkPad ACPI Extras");
453 
454 	return (rv);
455 }
456 
457 static int
458 acpi_ibm_attach(device_t dev)
459 {
460 	int i;
461 	int hkey;
462 	struct acpi_ibm_softc	*sc;
463 	char *maker, *product;
464 	ACPI_OBJECT_LIST input;
465 	ACPI_OBJECT params[1];
466 	ACPI_OBJECT out_obj;
467 	ACPI_BUFFER result;
468 	devclass_t ec_devclass;
469 
470 	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
471 
472 	sc = device_get_softc(dev);
473 	sc->dev = dev;
474 	sc->handle = acpi_get_handle(dev);
475 
476 	/* Look for the first embedded controller */
477         if (!(ec_devclass = devclass_find ("acpi_ec"))) {
478 		if (bootverbose)
479 			device_printf(dev, "Couldn't find acpi_ec devclass\n");
480 		return (EINVAL);
481 	}
482         if (!(sc->ec_dev = devclass_get_device(ec_devclass, 0))) {
483 		if (bootverbose)
484 			device_printf(dev, "Couldn't find acpi_ec device\n");
485 		return (EINVAL);
486 	}
487 	sc->ec_handle = acpi_get_handle(sc->ec_dev);
488 
489 	/* Get the sysctl tree */
490 	sc->sysctl_ctx = device_get_sysctl_ctx(dev);
491 	sc->sysctl_tree = device_get_sysctl_tree(dev);
492 
493 	/* Look for event mask and hook up the nodes */
494 	sc->events_mask_supported = ACPI_SUCCESS(acpi_GetInteger(sc->handle,
495 	    IBM_NAME_EVENTS_MASK_GET, &sc->events_initialmask));
496 
497 	if (sc->events_mask_supported) {
498 		SYSCTL_ADD_UINT(sc->sysctl_ctx,
499 		    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
500 		    "initialmask", CTLFLAG_RD,
501 		    &sc->events_initialmask, 0, "Initial eventmask");
502 
503 		if (ACPI_SUCCESS (acpi_GetInteger(sc->handle, "MHKV", &hkey))) {
504 			device_printf(dev, "Firmware version is 0x%X\n", hkey);
505 			switch(hkey >> 8)
506 			{
507 			case 1:
508 				/* The availmask is the bitmask of supported events */
509 				if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
510 				    IBM_NAME_EVENTS_AVAILMASK, &sc->events_availmask)))
511 					sc->events_availmask = 0xffffffff;
512 				break;
513 
514 			case 2:
515 				result.Length = sizeof(out_obj);
516 				result.Pointer = &out_obj;
517 				params[0].Type = ACPI_TYPE_INTEGER;
518 				params[0].Integer.Value = 1;
519 				input.Pointer = params;
520 				input.Count = 1;
521 
522 				sc->events_availmask = 0xffffffff;
523 
524 				if (ACPI_SUCCESS(AcpiEvaluateObject (sc->handle,
525 				    IBM_NAME_EVENTS_AVAILMASK, &input, &result)))
526 					sc->events_availmask = out_obj.Integer.Value;
527 				break;
528 			default:
529 				device_printf(dev, "Unknown firmware version 0x%x\n", hkey);
530 				break;
531 			}
532 		} else
533 			sc->events_availmask = 0xffffffff;
534 
535 		SYSCTL_ADD_UINT(sc->sysctl_ctx,
536 				SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
537 				"availmask", CTLFLAG_RD,
538 				&sc->events_availmask, 0, "Mask of supported events");
539 	}
540 
541 	/* Hook up proc nodes */
542 	for (int i = 0; acpi_ibm_sysctls[i].name != NULL; i++) {
543 		if (!acpi_ibm_sysctl_init(sc, acpi_ibm_sysctls[i].method))
544 			continue;
545 
546 		if (acpi_ibm_sysctls[i].flag_rdonly != 0) {
547 			SYSCTL_ADD_PROC(sc->sysctl_ctx,
548 			    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
549 			    acpi_ibm_sysctls[i].name, CTLTYPE_INT | CTLFLAG_RD,
550 			    sc, i, acpi_ibm_sysctl, "I",
551 			    acpi_ibm_sysctls[i].description);
552 		} else {
553 			SYSCTL_ADD_PROC(sc->sysctl_ctx,
554 			    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
555 			    acpi_ibm_sysctls[i].name, CTLTYPE_INT | CTLFLAG_RW,
556 			    sc, i, acpi_ibm_sysctl, "I",
557 			    acpi_ibm_sysctls[i].description);
558 		}
559 	}
560 
561 	/* Hook up thermal node */
562 	if (acpi_ibm_sysctl_init(sc, ACPI_IBM_METHOD_THERMAL)) {
563 		SYSCTL_ADD_PROC(sc->sysctl_ctx,
564 		    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
565 		    "thermal", CTLTYPE_INT | CTLFLAG_RD,
566 		    sc, 0, acpi_ibm_thermal_sysctl, "I",
567 		    "Thermal zones");
568 	}
569 
570 	/* Hook up handlerevents node */
571 	if (acpi_ibm_sysctl_init(sc, ACPI_IBM_METHOD_HANDLEREVENTS)) {
572 		SYSCTL_ADD_PROC(sc->sysctl_ctx,
573 		    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
574 		    "handlerevents", CTLTYPE_STRING | CTLFLAG_RW,
575 		    sc, 0, acpi_ibm_handlerevents_sysctl, "I",
576 		    "devd(8) events handled by acpi_ibm");
577 	}
578 
579 	/* Handle notifies */
580 	AcpiInstallNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
581 	    acpi_ibm_notify, dev);
582 
583 	/* Hook up light to led(4) */
584 	if (sc->light_set_supported)
585 		sc->led_dev = led_create_state(ibm_led, sc, "thinklight",
586 		    (sc->light_val ? 1 : 0));
587 
588 	/* Enable per-model events. */
589 	maker = kern_getenv("smbios.system.maker");
590 	product = kern_getenv("smbios.system.product");
591 	if (maker == NULL || product == NULL)
592 		goto nosmbios;
593 
594 	for (i = 0; i < nitems(acpi_ibm_models); i++) {
595 		if (strcmp(maker, acpi_ibm_models[i].maker) == 0 &&
596 		    strcmp(product, acpi_ibm_models[i].product) == 0) {
597 			ACPI_SERIAL_BEGIN(ibm);
598 			acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTMASK,
599 			    acpi_ibm_models[i].eventmask);
600 			ACPI_SERIAL_END(ibm);
601 		}
602 	}
603 
604 nosmbios:
605 	freeenv(maker);
606 	freeenv(product);
607 
608 	/* Enable events by default. */
609 	ACPI_SERIAL_BEGIN(ibm);
610 	acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTS, 1);
611 	ACPI_SERIAL_END(ibm);
612 
613 
614 	return (0);
615 }
616 
617 static int
618 acpi_ibm_detach(device_t dev)
619 {
620 	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
621 
622 	struct acpi_ibm_softc *sc = device_get_softc(dev);
623 
624 	/* Disable events and restore eventmask */
625 	ACPI_SERIAL_BEGIN(ibm);
626 	acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTS, 0);
627 	acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTMASK, sc->events_initialmask);
628 	ACPI_SERIAL_END(ibm);
629 
630 	AcpiRemoveNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY, acpi_ibm_notify);
631 
632 	if (sc->led_dev != NULL)
633 		led_destroy(sc->led_dev);
634 
635 	return (0);
636 }
637 
638 static int
639 acpi_ibm_resume(device_t dev)
640 {
641 	struct acpi_ibm_softc *sc = device_get_softc(dev);
642 
643 	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
644 
645 	ACPI_SERIAL_BEGIN(ibm);
646 	for (int i = 0; acpi_ibm_sysctls[i].name != NULL; i++) {
647 		int val;
648 
649 		val = acpi_ibm_sysctl_get(sc, i);
650 
651 		if (acpi_ibm_sysctls[i].flag_rdonly != 0)
652 			continue;
653 
654 		acpi_ibm_sysctl_set(sc, i, val);
655 	}
656 	ACPI_SERIAL_END(ibm);
657 
658 	/* The mic led does not turn back on when sysctl_set is called in the above loop */
659 	acpi_ibm_mic_led_set(sc, sc->mic_led_state);
660 
661 	return (0);
662 }
663 
664 static int
665 acpi_ibm_eventmask_set(struct acpi_ibm_softc *sc, int val)
666 {
667 	ACPI_OBJECT		arg[2];
668 	ACPI_OBJECT_LIST	args;
669 	ACPI_STATUS		status;
670 
671 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
672 	ACPI_SERIAL_ASSERT(ibm);
673 
674 	args.Count = 2;
675 	args.Pointer = arg;
676 	arg[0].Type = ACPI_TYPE_INTEGER;
677 	arg[1].Type = ACPI_TYPE_INTEGER;
678 
679 	for (int i = 0; i < 32; ++i) {
680 		arg[0].Integer.Value = i+1;
681 		arg[1].Integer.Value = (((1 << i) & val) != 0);
682 		status = AcpiEvaluateObject(sc->handle,
683 		    IBM_NAME_EVENTS_MASK_SET, &args, NULL);
684 
685 		if (ACPI_FAILURE(status))
686 			return (status);
687 	}
688 
689 	return (0);
690 }
691 
692 static int
693 acpi_ibm_sysctl(SYSCTL_HANDLER_ARGS)
694 {
695 	struct acpi_ibm_softc	*sc;
696 	int			arg;
697 	int			error = 0;
698 	int			function;
699 	int			method;
700 
701 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
702 
703 	sc = (struct acpi_ibm_softc *)oidp->oid_arg1;
704 	function = oidp->oid_arg2;
705 	method = acpi_ibm_sysctls[function].method;
706 
707 	ACPI_SERIAL_BEGIN(ibm);
708 	arg = acpi_ibm_sysctl_get(sc, method);
709 	error = sysctl_handle_int(oidp, &arg, 0, req);
710 
711 	/* Sanity check */
712 	if (error != 0 || req->newptr == NULL)
713 		goto out;
714 
715 	/* Update */
716 	error = acpi_ibm_sysctl_set(sc, method, arg);
717 
718 out:
719 	ACPI_SERIAL_END(ibm);
720 	return (error);
721 }
722 
723 static int
724 acpi_ibm_sysctl_get(struct acpi_ibm_softc *sc, int method)
725 {
726 	UINT64		val_ec;
727 	int 		val = 0, key;
728 
729 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
730 	ACPI_SERIAL_ASSERT(ibm);
731 
732 	switch (method) {
733 	case ACPI_IBM_METHOD_EVENTS:
734 		acpi_GetInteger(sc->handle, IBM_NAME_EVENTS_STATUS_GET, &val);
735 		break;
736 
737 	case ACPI_IBM_METHOD_EVENTMASK:
738 		if (sc->events_mask_supported)
739 			acpi_GetInteger(sc->handle, IBM_NAME_EVENTS_MASK_GET, &val);
740 		break;
741 
742 	case ACPI_IBM_METHOD_HOTKEY:
743 		/*
744 		 * Construct the hotkey as a bitmask as illustrated below.
745 		 * Note that whenever a key was pressed, the respecting bit
746 		 * toggles and nothing else changes.
747 		 * +--+--+-+-+-+-+-+-+-+-+-+-+
748 		 * |11|10|9|8|7|6|5|4|3|2|1|0|
749 		 * +--+--+-+-+-+-+-+-+-+-+-+-+
750 		 *   |  | | | | | | | | | | |
751 		 *   |  | | | | | | | | | | +- Home Button
752 		 *   |  | | | | | | | | | +--- Search Button
753 		 *   |  | | | | | | | | +----- Mail Button
754 		 *   |  | | | | | | | +------- Thinkpad Button
755 		 *   |  | | | | | | +--------- Zoom (Fn + Space)
756 		 *   |  | | | | | +----------- WLAN Button
757 		 *   |  | | | | +------------- Video Button
758 		 *   |  | | | +--------------- Hibernate Button
759 		 *   |  | | +----------------- Thinklight Button
760 		 *   |  | +------------------- Screen expand (Fn + F8)
761 		 *   |  +--------------------- Brightness
762 		 *   +------------------------ Volume/Mute
763 		 */
764 		key = rtcin(IBM_RTC_HOTKEY1);
765 		val = (IBM_RTC_MASK_HOME | IBM_RTC_MASK_SEARCH | IBM_RTC_MASK_MAIL | IBM_RTC_MASK_WLAN) & key;
766 		key = rtcin(IBM_RTC_HOTKEY2);
767 		val |= (IBM_RTC_MASK_THINKPAD | IBM_RTC_MASK_VIDEO | IBM_RTC_MASK_HIBERNATE) & key;
768 		val |= (IBM_RTC_MASK_ZOOM & key) >> 1;
769 		key = rtcin(IBM_RTC_THINKLIGHT);
770 		val |= (IBM_RTC_MASK_THINKLIGHT & key) << 4;
771 		key = rtcin(IBM_RTC_SCREENEXPAND);
772 		val |= (IBM_RTC_MASK_THINKLIGHT & key) << 4;
773 		key = rtcin(IBM_RTC_BRIGHTNESS);
774 		val |= (IBM_RTC_MASK_BRIGHTNESS & key) << 5;
775 		key = rtcin(IBM_RTC_VOLUME);
776 		val |= (IBM_RTC_MASK_VOLUME & key) << 4;
777 		break;
778 
779 	case ACPI_IBM_METHOD_BRIGHTNESS:
780 		ACPI_EC_READ(sc->ec_dev, IBM_EC_BRIGHTNESS, &val_ec, 1);
781 		val = val_ec & IBM_EC_MASK_BRI;
782 		break;
783 
784 	case ACPI_IBM_METHOD_VOLUME:
785 		ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
786 		val = val_ec & IBM_EC_MASK_VOL;
787 		break;
788 
789 	case ACPI_IBM_METHOD_MUTE:
790 		ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
791 		val = ((val_ec & IBM_EC_MASK_MUTE) == IBM_EC_MASK_MUTE);
792 		break;
793 
794 	case ACPI_IBM_METHOD_THINKLIGHT:
795 		if (sc->light_get_supported)
796 			acpi_GetInteger(sc->ec_handle, IBM_NAME_KEYLIGHT, &val);
797 		else
798 			val = sc->light_val;
799 		break;
800 
801 	case ACPI_IBM_METHOD_BLUETOOTH:
802 		acpi_GetInteger(sc->handle, IBM_NAME_WLAN_BT_GET, &val);
803 		sc->wlan_bt_flags = val;
804 		val = ((val & IBM_NAME_MASK_BT) != 0);
805 		break;
806 
807 	case ACPI_IBM_METHOD_WLAN:
808 		acpi_GetInteger(sc->handle, IBM_NAME_WLAN_BT_GET, &val);
809 		sc->wlan_bt_flags = val;
810 		val = ((val & IBM_NAME_MASK_WLAN) != 0);
811 		break;
812 
813 	case ACPI_IBM_METHOD_FANSPEED:
814 		if (sc->fan_handle) {
815 			if(ACPI_FAILURE(acpi_GetInteger(sc->fan_handle, NULL, &val)))
816 				val = -1;
817 		}
818 		else {
819 			ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSPEED, &val_ec, 2);
820 			val = val_ec;
821 		}
822 		break;
823 
824 	case ACPI_IBM_METHOD_FANLEVEL:
825 		/*
826 		 * The IBM_EC_FANSTATUS register works as follows:
827 		 * Bit 0-5 indicate the level at which the fan operates. Only
828 		 *       values between 0 and 7 have an effect. Everything
829 		 *       above 7 is treated the same as level 7
830 		 * Bit 6 overrides the fan speed limit if set to 1
831 		 * Bit 7 indicates at which mode the fan operates:
832 		 *       manual (0) or automatic (1)
833 		 */
834 		if (!sc->fan_handle) {
835 			ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
836 			val = val_ec & IBM_EC_MASK_FANLEVEL;
837 		}
838 		break;
839 
840 	case ACPI_IBM_METHOD_FANSTATUS:
841 		if (!sc->fan_handle) {
842 			ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
843 			val = (val_ec & IBM_EC_MASK_FANSTATUS) == IBM_EC_MASK_FANSTATUS;
844 		}
845 		else
846 			val = -1;
847 		break;
848 	case ACPI_IBM_METHOD_MIC_LED:
849 		if (sc->mic_led_handle)
850 			return sc->mic_led_state;
851 		else
852 			val = -1;
853 		break;
854 
855 	case ACPI_IBM_METHOD_PRIVACYGUARD:
856 		val = acpi_ibm_privacyguard_get(sc);
857 		break;
858 
859 	}
860 
861 	return (val);
862 }
863 
864 static int
865 acpi_ibm_sysctl_set(struct acpi_ibm_softc *sc, int method, int arg)
866 {
867 	int			val;
868 	UINT64			val_ec;
869 	ACPI_STATUS		status;
870 
871 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
872 	ACPI_SERIAL_ASSERT(ibm);
873 
874 	switch (method) {
875 	case ACPI_IBM_METHOD_EVENTS:
876 		if (arg < 0 || arg > 1)
877 			return (EINVAL);
878 
879 		status = acpi_SetInteger(sc->handle, IBM_NAME_EVENTS_STATUS_SET, arg);
880 		if (ACPI_FAILURE(status))
881 			return (status);
882 		if (sc->events_mask_supported)
883 			return acpi_ibm_eventmask_set(sc, sc->events_availmask);
884 		break;
885 
886 	case ACPI_IBM_METHOD_EVENTMASK:
887 		if (sc->events_mask_supported)
888 			return acpi_ibm_eventmask_set(sc, arg);
889 		break;
890 
891 	case ACPI_IBM_METHOD_BRIGHTNESS:
892 		return acpi_ibm_brightness_set(sc, arg);
893 		break;
894 
895 	case ACPI_IBM_METHOD_VOLUME:
896 		return acpi_ibm_volume_set(sc, arg);
897 		break;
898 
899 	case ACPI_IBM_METHOD_MUTE:
900 		return acpi_ibm_mute_set(sc, arg);
901 		break;
902 
903 	case ACPI_IBM_METHOD_MIC_LED:
904 		return acpi_ibm_mic_led_set (sc, arg);
905 		break;
906 
907 	case ACPI_IBM_METHOD_THINKLIGHT:
908 		return acpi_ibm_thinklight_set(sc, arg);
909 		break;
910 
911 	case ACPI_IBM_METHOD_BLUETOOTH:
912 		return acpi_ibm_bluetooth_set(sc, arg);
913 		break;
914 
915 	case ACPI_IBM_METHOD_PRIVACYGUARD:
916 		return (acpi_status_to_errno(acpi_ibm_privacyguard_set(sc, arg)));
917 		break;
918 
919 	case ACPI_IBM_METHOD_FANLEVEL:
920 		if (arg < 0 || arg > 7)
921 			return (EINVAL);
922 
923 		if (!sc->fan_handle) {
924 			/* Read the current fanstatus */
925 			ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
926 			val = val_ec & (~IBM_EC_MASK_FANLEVEL);
927 
928 			return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_FANSTATUS, val | arg, 1);
929 		}
930 		break;
931 
932 	case ACPI_IBM_METHOD_FANSTATUS:
933 		if (arg < 0 || arg > 1)
934 			return (EINVAL);
935 
936 		if (!sc->fan_handle) {
937 			/* Read the current fanstatus */
938 			ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
939 
940 			return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_FANSTATUS,
941 				(arg == 1) ? (val_ec | IBM_EC_MASK_FANSTATUS) : (val_ec & (~IBM_EC_MASK_FANSTATUS)), 1);
942 		}
943 		break;
944 	}
945 
946 	return (0);
947 }
948 
949 static int
950 acpi_ibm_sysctl_init(struct acpi_ibm_softc *sc, int method)
951 {
952 	int 			dummy;
953 	ACPI_OBJECT_TYPE 	cmos_t;
954 	ACPI_HANDLE		ledb_handle;
955 
956 	switch (method) {
957 	case ACPI_IBM_METHOD_EVENTS:
958 		return (TRUE);
959 
960 	case ACPI_IBM_METHOD_EVENTMASK:
961 		return (sc->events_mask_supported);
962 
963 	case ACPI_IBM_METHOD_HOTKEY:
964 	case ACPI_IBM_METHOD_BRIGHTNESS:
965 	case ACPI_IBM_METHOD_VOLUME:
966 	case ACPI_IBM_METHOD_MUTE:
967 		/* EC is required here, which was already checked before */
968 		return (TRUE);
969 
970 	case ACPI_IBM_METHOD_MIC_LED:
971 		if (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "MMTS", &sc->mic_led_handle)))
972 		{
973 			/* Turn off mic led by default */
974 			acpi_ibm_mic_led_set (sc, 0);
975 			return(TRUE);
976 		}
977 		else
978 			sc->mic_led_handle = NULL;
979 		return (FALSE);
980 
981 	case ACPI_IBM_METHOD_THINKLIGHT:
982 		sc->cmos_handle = NULL;
983 		sc->light_get_supported = ACPI_SUCCESS(acpi_GetInteger(
984 		    sc->ec_handle, IBM_NAME_KEYLIGHT, &sc->light_val));
985 
986 		if ((ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\UCMS", &sc->light_handle)) ||
987 		     ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\CMOS", &sc->light_handle)) ||
988 		     ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\CMS", &sc->light_handle))) &&
989 		     ACPI_SUCCESS(AcpiGetType(sc->light_handle, &cmos_t)) &&
990 		     cmos_t == ACPI_TYPE_METHOD) {
991 			sc->light_cmd_on = 0x0c;
992 			sc->light_cmd_off = 0x0d;
993 			sc->cmos_handle = sc->light_handle;
994 		}
995 		else if (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\LGHT", &sc->light_handle))) {
996 			sc->light_cmd_on = 1;
997 			sc->light_cmd_off = 0;
998 		}
999 		else
1000 			sc->light_handle = NULL;
1001 
1002 		sc->light_set_supported = (sc->light_handle &&
1003 		    ACPI_FAILURE(AcpiGetHandle(sc->ec_handle, "LEDB", &ledb_handle)));
1004 
1005 		if (sc->light_get_supported)
1006 			return (TRUE);
1007 
1008 		if (sc->light_set_supported) {
1009 			sc->light_val = 0;
1010 			return (TRUE);
1011 		}
1012 
1013 		return (FALSE);
1014 
1015 	case ACPI_IBM_METHOD_BLUETOOTH:
1016 	case ACPI_IBM_METHOD_WLAN:
1017 		if (ACPI_SUCCESS(acpi_GetInteger(sc->handle, IBM_NAME_WLAN_BT_GET, &dummy)))
1018 			return (TRUE);
1019 		return (FALSE);
1020 
1021 	case ACPI_IBM_METHOD_FANSPEED:
1022 		/*
1023 		 * Some models report the fan speed in levels from 0-7
1024 		 * Newer models report it contiguously
1025 		 */
1026 		sc->fan_levels =
1027 		    (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "GFAN", &sc->fan_handle)) ||
1028 		     ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\FSPD", &sc->fan_handle)));
1029 		return (TRUE);
1030 
1031 	case ACPI_IBM_METHOD_FANLEVEL:
1032 	case ACPI_IBM_METHOD_FANSTATUS:
1033 		/*
1034 		 * Fan status is only supported on those models,
1035 		 * which report fan RPM contiguously, not in levels
1036 		 */
1037 		if (sc->fan_levels)
1038 			return (FALSE);
1039 		return (TRUE);
1040 
1041 	case ACPI_IBM_METHOD_THERMAL:
1042 		if (ACPI_SUCCESS(acpi_GetInteger(sc->ec_handle, IBM_NAME_THERMAL_GET, &dummy))) {
1043 			sc->thermal_updt_supported = ACPI_SUCCESS(acpi_GetInteger(sc->ec_handle, IBM_NAME_THERMAL_UPDT, &dummy));
1044 			return (TRUE);
1045 		}
1046 		return (FALSE);
1047 
1048 	case ACPI_IBM_METHOD_HANDLEREVENTS:
1049 		return (TRUE);
1050 
1051 	case ACPI_IBM_METHOD_PRIVACYGUARD:
1052 		return (acpi_ibm_privacyguard_get(sc) != -1);
1053 
1054 	}
1055 	return (FALSE);
1056 }
1057 
1058 static int
1059 acpi_ibm_thermal_sysctl(SYSCTL_HANDLER_ARGS)
1060 {
1061 	struct acpi_ibm_softc	*sc;
1062 	int			error = 0;
1063 	char			temp_cmd[] = "TMP0";
1064 	int			temp[8];
1065 
1066 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1067 
1068 	sc = (struct acpi_ibm_softc *)oidp->oid_arg1;
1069 
1070 	ACPI_SERIAL_BEGIN(ibm);
1071 
1072 	for (int i = 0; i < 8; ++i) {
1073 		temp_cmd[3] = '0' + i;
1074 
1075 		/*
1076 		 * The TMPx methods seem to return +/- 128 or 0
1077 		 * when the respecting sensor is not available
1078 		 */
1079 		if (ACPI_FAILURE(acpi_GetInteger(sc->ec_handle, temp_cmd,
1080 		    &temp[i])) || ABS(temp[i]) == 128 || temp[i] == 0)
1081 			temp[i] = -1;
1082 		else if (sc->thermal_updt_supported)
1083 			/* Temperature is reported in tenth of Kelvin */
1084 			temp[i] = (temp[i] - 2731 + 5) / 10;
1085 	}
1086 
1087 	error = sysctl_handle_opaque(oidp, &temp, 8*sizeof(int), req);
1088 
1089 	ACPI_SERIAL_END(ibm);
1090 	return (error);
1091 }
1092 
1093 static int
1094 acpi_ibm_handlerevents_sysctl(SYSCTL_HANDLER_ARGS)
1095 {
1096 	struct acpi_ibm_softc	*sc;
1097 	int			error = 0;
1098 	struct sbuf		sb;
1099 	char			*cp, *ep;
1100 	int			l, val;
1101 	unsigned int		handler_events;
1102 	char			temp[128];
1103 
1104 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1105 
1106 	sc = (struct acpi_ibm_softc *)oidp->oid_arg1;
1107 
1108 	if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
1109 		return (ENOMEM);
1110 
1111 	ACPI_SERIAL_BEGIN(ibm);
1112 
1113 	/* Get old values if this is a get request. */
1114 	if (req->newptr == NULL) {
1115 		for (int i = 0; i < 8 * sizeof(sc->handler_events); i++)
1116 			if (sc->handler_events & (1 << i))
1117 				sbuf_printf(&sb, "0x%02x ", i + 1);
1118 		if (sbuf_len(&sb) == 0)
1119 			sbuf_printf(&sb, "NONE");
1120 	}
1121 
1122 	sbuf_trim(&sb);
1123 	sbuf_finish(&sb);
1124 	strlcpy(temp, sbuf_data(&sb), sizeof(temp));
1125 	sbuf_delete(&sb);
1126 
1127 	error = sysctl_handle_string(oidp, temp, sizeof(temp), req);
1128 
1129 	/* Check for error or no change */
1130 	if (error != 0 || req->newptr == NULL)
1131 		goto out;
1132 
1133 	/* If the user is setting a string, parse it. */
1134 	handler_events = 0;
1135 	cp = temp;
1136 	while (*cp) {
1137 		if (isspace(*cp)) {
1138 			cp++;
1139 			continue;
1140 		}
1141 
1142 		ep = cp;
1143 
1144 		while (*ep && !isspace(*ep))
1145 			ep++;
1146 
1147 		l = ep - cp;
1148 		if (l == 0)
1149 			break;
1150 
1151 		if (strncmp(cp, "NONE", 4) == 0) {
1152 			cp = ep;
1153 			continue;
1154 		}
1155 
1156 		if (l >= 3 && cp[0] == '0' && (cp[1] == 'X' || cp[1] == 'x'))
1157 			val = strtoul(cp, &ep, 16);
1158 		else
1159 			val = strtoul(cp, &ep, 10);
1160 
1161 		if (val == 0 || ep == cp || val >= 8 * sizeof(handler_events)) {
1162 			cp[l] = '\0';
1163 			device_printf(sc->dev, "invalid event code: %s\n", cp);
1164 			error = EINVAL;
1165 			goto out;
1166 		}
1167 
1168 		handler_events |= 1 << (val - 1);
1169 
1170 		cp = ep;
1171 	}
1172 
1173 	sc->handler_events = handler_events;
1174 out:
1175 	ACPI_SERIAL_END(ibm);
1176 	return (error);
1177 }
1178 
1179 static int
1180 acpi_ibm_brightness_set(struct acpi_ibm_softc *sc, int arg)
1181 {
1182 	int			val, step;
1183 	UINT64			val_ec;
1184 	ACPI_OBJECT		Arg;
1185 	ACPI_OBJECT_LIST	Args;
1186 	ACPI_STATUS		status;
1187 
1188 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1189 	ACPI_SERIAL_ASSERT(ibm);
1190 
1191 	if (arg < 0 || arg > 7)
1192 		return (EINVAL);
1193 
1194 	/* Read the current brightness */
1195 	status = ACPI_EC_READ(sc->ec_dev, IBM_EC_BRIGHTNESS, &val_ec, 1);
1196 	if (ACPI_FAILURE(status))
1197 		return (status);
1198 
1199 	if (sc->cmos_handle) {
1200 		val = val_ec & IBM_EC_MASK_BRI;
1201 
1202 		Args.Count = 1;
1203 		Args.Pointer = &Arg;
1204 		Arg.Type = ACPI_TYPE_INTEGER;
1205 		Arg.Integer.Value = (arg > val) ? IBM_CMOS_BRIGHTNESS_UP :
1206 						  IBM_CMOS_BRIGHTNESS_DOWN;
1207 
1208 		step = (arg > val) ? 1 : -1;
1209 		for (int i = val; i != arg; i += step) {
1210 			status = AcpiEvaluateObject(sc->cmos_handle, NULL,
1211 						    &Args, NULL);
1212 			if (ACPI_FAILURE(status)) {
1213 				/* Record the last value */
1214 				if (i != val) {
1215 					ACPI_EC_WRITE(sc->ec_dev,
1216 					    IBM_EC_BRIGHTNESS, i - step, 1);
1217 				}
1218 				return (status);
1219 			}
1220 		}
1221 	}
1222 
1223 	return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_BRIGHTNESS, arg, 1);
1224 }
1225 
1226 static int
1227 acpi_ibm_bluetooth_set(struct acpi_ibm_softc *sc, int arg)
1228 {
1229 	int			val;
1230 
1231 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1232 	ACPI_SERIAL_ASSERT(ibm);
1233 
1234 	if (arg < 0 || arg > 1)
1235 		return (EINVAL);
1236 
1237 	val = (arg == 1) ? sc->wlan_bt_flags | IBM_NAME_MASK_BT :
1238 			   sc->wlan_bt_flags & (~IBM_NAME_MASK_BT);
1239 	return acpi_SetInteger(sc->handle, IBM_NAME_WLAN_BT_SET, val);
1240 }
1241 
1242 static int
1243 acpi_ibm_thinklight_set(struct acpi_ibm_softc *sc, int arg)
1244 {
1245 	ACPI_OBJECT		Arg;
1246 	ACPI_OBJECT_LIST	Args;
1247 	ACPI_STATUS		status;
1248 
1249 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1250 	ACPI_SERIAL_ASSERT(ibm);
1251 
1252 	if (arg < 0 || arg > 1)
1253 		return (EINVAL);
1254 
1255 	if (sc->light_set_supported) {
1256 		Args.Count = 1;
1257 		Args.Pointer = &Arg;
1258 		Arg.Type = ACPI_TYPE_INTEGER;
1259 		Arg.Integer.Value = arg ? sc->light_cmd_on : sc->light_cmd_off;
1260 
1261 		status = AcpiEvaluateObject(sc->light_handle, NULL,
1262 					    &Args, NULL);
1263 		if (ACPI_SUCCESS(status))
1264 			sc->light_val = arg;
1265 		return (status);
1266 	}
1267 
1268 	return (0);
1269 }
1270 
1271 /*
1272  * Helper function to make a get or set ACPI call to the PrivacyGuard handle.
1273  * Only meant to be used internally by the get/set functions below.
1274  */
1275 static ACPI_STATUS
1276 acpi_ibm_privacyguard_acpi_call(struct acpi_ibm_softc *sc, bool write, int *arg) {
1277 	ACPI_OBJECT		Arg;
1278 	ACPI_OBJECT_LIST	Args;
1279 	ACPI_STATUS		status;
1280 	ACPI_OBJECT		out_obj;
1281 	ACPI_BUFFER		result;
1282 
1283 	Arg.Type = ACPI_TYPE_INTEGER;
1284 	Arg.Integer.Value = (write ? *arg : 0);
1285 	Args.Count = 1;
1286 	Args.Pointer = &Arg;
1287 	result.Length = sizeof(out_obj);
1288 	result.Pointer = &out_obj;
1289 
1290 	status = AcpiEvaluateObject(sc->handle,
1291 	    (write ? IBM_NAME_PRIVACYGUARD_SET : IBM_NAME_PRIVACYGUARD_GET),
1292 	    &Args, &result);
1293 	if (ACPI_SUCCESS(status) && !write)
1294 		*arg = out_obj.Integer.Value;
1295 
1296 	return (status);
1297 }
1298 
1299 /*
1300  * Returns -1 if the device is not present.
1301  */
1302 static int
1303 acpi_ibm_privacyguard_get(struct acpi_ibm_softc *sc)
1304 {
1305 	ACPI_STATUS status;
1306 	int val;
1307 
1308 	status = acpi_ibm_privacyguard_acpi_call(sc, false, &val);
1309 	if (ACPI_SUCCESS(status) &&
1310 	    (val & IBM_FLAG_PRIVACYGUARD_DEVICE_PRESENT))
1311 		return (val & IBM_FLAG_PRIVACYGUARD_ON);
1312 
1313 	return (-1);
1314 }
1315 
1316 static ACPI_STATUS
1317 acpi_ibm_privacyguard_set(struct acpi_ibm_softc *sc, int arg)
1318 {
1319 	if (arg < 0 || arg > 1)
1320 		return (AE_BAD_PARAMETER);
1321 
1322 	return (acpi_ibm_privacyguard_acpi_call(sc, true, &arg));
1323 }
1324 
1325 static int
1326 acpi_ibm_volume_set(struct acpi_ibm_softc *sc, int arg)
1327 {
1328 	int			val, step;
1329 	UINT64			val_ec;
1330 	ACPI_OBJECT		Arg;
1331 	ACPI_OBJECT_LIST	Args;
1332 	ACPI_STATUS		status;
1333 
1334 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1335 	ACPI_SERIAL_ASSERT(ibm);
1336 
1337 	if (arg < 0 || arg > 14)
1338 		return (EINVAL);
1339 
1340 	/* Read the current volume */
1341 	status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1342 	if (ACPI_FAILURE(status))
1343 		return (status);
1344 
1345 	if (sc->cmos_handle) {
1346 		val = val_ec & IBM_EC_MASK_VOL;
1347 
1348 		Args.Count = 1;
1349 		Args.Pointer = &Arg;
1350 		Arg.Type = ACPI_TYPE_INTEGER;
1351 		Arg.Integer.Value = (arg > val) ? IBM_CMOS_VOLUME_UP :
1352 						  IBM_CMOS_VOLUME_DOWN;
1353 
1354 		step = (arg > val) ? 1 : -1;
1355 		for (int i = val; i != arg; i += step) {
1356 			status = AcpiEvaluateObject(sc->cmos_handle, NULL,
1357 						    &Args, NULL);
1358 			if (ACPI_FAILURE(status)) {
1359 				/* Record the last value */
1360 				if (i != val) {
1361 					val_ec = i - step +
1362 						 (val_ec & (~IBM_EC_MASK_VOL));
1363 					ACPI_EC_WRITE(sc->ec_dev, IBM_EC_VOLUME,
1364 						      val_ec, 1);
1365 				}
1366 				return (status);
1367 			}
1368 		}
1369 	}
1370 
1371 	val_ec = arg + (val_ec & (~IBM_EC_MASK_VOL));
1372 	return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_VOLUME, val_ec, 1);
1373 }
1374 
1375 static int
1376 acpi_ibm_mute_set(struct acpi_ibm_softc *sc, int arg)
1377 {
1378 	UINT64			val_ec;
1379 	ACPI_OBJECT		Arg;
1380 	ACPI_OBJECT_LIST	Args;
1381 	ACPI_STATUS		status;
1382 
1383 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1384 	ACPI_SERIAL_ASSERT(ibm);
1385 
1386 	if (arg < 0 || arg > 1)
1387 		return (EINVAL);
1388 
1389 	status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1390 	if (ACPI_FAILURE(status))
1391 		return (status);
1392 
1393 	if (sc->cmos_handle) {
1394 		Args.Count = 1;
1395 		Args.Pointer = &Arg;
1396 		Arg.Type = ACPI_TYPE_INTEGER;
1397 		Arg.Integer.Value = IBM_CMOS_VOLUME_MUTE;
1398 
1399 		status = AcpiEvaluateObject(sc->cmos_handle, NULL, &Args, NULL);
1400 		if (ACPI_FAILURE(status))
1401 			return (status);
1402 	}
1403 
1404 	val_ec = (arg == 1) ? val_ec | IBM_EC_MASK_MUTE :
1405 			      val_ec & (~IBM_EC_MASK_MUTE);
1406 	return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_VOLUME, val_ec, 1);
1407 }
1408 
1409 static void
1410 acpi_ibm_eventhandler(struct acpi_ibm_softc *sc, int arg)
1411 {
1412 	int			val;
1413 	UINT64			val_ec;
1414 	ACPI_STATUS		status;
1415 
1416 	ACPI_SERIAL_BEGIN(ibm);
1417 	switch (arg) {
1418 	case IBM_EVENT_SUSPEND_TO_RAM:
1419 		power_pm_suspend(POWER_SLEEP_STATE_SUSPEND);
1420 		break;
1421 
1422 	case IBM_EVENT_BLUETOOTH:
1423 		acpi_ibm_bluetooth_set(sc, (sc->wlan_bt_flags == 0));
1424 		break;
1425 
1426 	case IBM_EVENT_BRIGHTNESS_UP:
1427 	case IBM_EVENT_BRIGHTNESS_DOWN:
1428 		/* Read the current brightness */
1429 		status = ACPI_EC_READ(sc->ec_dev, IBM_EC_BRIGHTNESS,
1430 				      &val_ec, 1);
1431 		if (ACPI_FAILURE(status))
1432 			return;
1433 
1434 		val = val_ec & IBM_EC_MASK_BRI;
1435 		val = (arg == IBM_EVENT_BRIGHTNESS_UP) ? val + 1 : val - 1;
1436 		acpi_ibm_brightness_set(sc, val);
1437 		break;
1438 
1439 	case IBM_EVENT_THINKLIGHT:
1440 		acpi_ibm_thinklight_set(sc, (sc->light_val == 0));
1441 		break;
1442 
1443 	case IBM_EVENT_VOLUME_UP:
1444 	case IBM_EVENT_VOLUME_DOWN:
1445 		/* Read the current volume */
1446 		status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1447 		if (ACPI_FAILURE(status))
1448 			return;
1449 
1450 		val = val_ec & IBM_EC_MASK_VOL;
1451 		val = (arg == IBM_EVENT_VOLUME_UP) ? val + 1 : val - 1;
1452 		acpi_ibm_volume_set(sc, val);
1453 		break;
1454 
1455 	case IBM_EVENT_MUTE:
1456 		/* Read the current value */
1457 		status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1458 		if (ACPI_FAILURE(status))
1459 			return;
1460 
1461 		val = ((val_ec & IBM_EC_MASK_MUTE) == IBM_EC_MASK_MUTE);
1462 		acpi_ibm_mute_set(sc, (val == 0));
1463 		break;
1464 
1465 	default:
1466 		break;
1467 	}
1468 	ACPI_SERIAL_END(ibm);
1469 }
1470 
1471 static void
1472 acpi_ibm_notify(ACPI_HANDLE h, UINT32 notify, void *context)
1473 {
1474 	int		event, arg, type;
1475 	device_t	dev = context;
1476 	struct acpi_ibm_softc *sc = device_get_softc(dev);
1477 
1478 	ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
1479 
1480 	if (notify != 0x80)
1481 		device_printf(dev, "Unknown notify\n");
1482 
1483 	for (;;) {
1484 		acpi_GetInteger(acpi_get_handle(dev), IBM_NAME_EVENTS_GET, &event);
1485 		if (event == 0)
1486 			break;
1487 
1488 
1489 		type = (event >> 12) & 0xf;
1490 		arg = event & 0xfff;
1491 		switch (type) {
1492 		case 1:
1493 			if (!(sc->events_availmask & (1 << (arg - 1)))) {
1494 				device_printf(dev, "Unknown key %d\n", arg);
1495 				break;
1496 			}
1497 
1498 			/* Execute event handler */
1499 			if (sc->handler_events & (1 << (arg - 1)))
1500 				acpi_ibm_eventhandler(sc, (arg & 0xff));
1501 
1502 			/* Notify devd(8) */
1503 			acpi_UserNotify("IBM", h, (arg & 0xff));
1504 			break;
1505 		default:
1506 			break;
1507 		}
1508 	}
1509 }
1510