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