2 * Copyright (c) 2004 Takanori Watanabe
3 * Copyright (c) 2005 Markus Brueffer <markus@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
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
36 * acpi-ibm: <http://ibm-acpi.sourceforge.net/>
37 * tpb: <http://www.nongnu.org/tpb/>
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
45 #include <machine/cpufunc.h>
47 #include <contrib/dev/acpica/include/acpi.h>
48 #include <contrib/dev/acpica/include/accommon.h>
51 #include <sys/module.h>
52 #include <dev/acpica/acpivar.h>
53 #include <dev/led/led.h>
54 #include <sys/power.h>
56 #include <sys/sysctl.h>
59 #define _COMPONENT ACPI_OEM
60 ACPI_MODULE_NAME("IBM")
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
80 #define IBM_RTC_HOTKEY1 0x64
81 #define IBM_RTC_MASK_HOME (1 << 0)
82 #define IBM_RTC_MASK_SEARCH (1 << 1)
83 #define IBM_RTC_MASK_MAIL (1 << 2)
84 #define IBM_RTC_MASK_WLAN (1 << 5)
85 #define IBM_RTC_HOTKEY2 0x65
86 #define IBM_RTC_MASK_THINKPAD (1 << 3)
87 #define IBM_RTC_MASK_ZOOM (1 << 5)
88 #define IBM_RTC_MASK_VIDEO (1 << 6)
89 #define IBM_RTC_MASK_HIBERNATE (1 << 7)
90 #define IBM_RTC_THINKLIGHT 0x66
91 #define IBM_RTC_MASK_THINKLIGHT (1 << 4)
92 #define IBM_RTC_SCREENEXPAND 0x67
93 #define IBM_RTC_MASK_SCREENEXPAND (1 << 5)
94 #define IBM_RTC_BRIGHTNESS 0x6c
95 #define IBM_RTC_MASK_BRIGHTNESS (1 << 5)
96 #define IBM_RTC_VOLUME 0x6e
97 #define IBM_RTC_MASK_VOLUME (1 << 7)
99 /* Embedded Controller registers */
100 #define IBM_EC_BRIGHTNESS 0x31
101 #define IBM_EC_MASK_BRI 0x7
102 #define IBM_EC_VOLUME 0x30
103 #define IBM_EC_MASK_VOL 0xf
104 #define IBM_EC_MASK_MUTE (1 << 6)
105 #define IBM_EC_FANSTATUS 0x2F
106 #define IBM_EC_MASK_FANLEVEL 0x3f
107 #define IBM_EC_MASK_FANDISENGAGED (1 << 6)
108 #define IBM_EC_MASK_FANSTATUS (1 << 7)
109 #define IBM_EC_FANSPEED 0x84
112 #define IBM_CMOS_VOLUME_DOWN 0
113 #define IBM_CMOS_VOLUME_UP 1
114 #define IBM_CMOS_VOLUME_MUTE 2
115 #define IBM_CMOS_BRIGHTNESS_UP 4
116 #define IBM_CMOS_BRIGHTNESS_DOWN 5
119 #define IBM_NAME_KEYLIGHT "KBLT"
120 #define IBM_NAME_WLAN_BT_GET "GBDC"
121 #define IBM_NAME_WLAN_BT_SET "SBDC"
122 #define IBM_NAME_MASK_BT (1 << 1)
123 #define IBM_NAME_MASK_WLAN (1 << 2)
124 #define IBM_NAME_THERMAL_GET "TMP7"
125 #define IBM_NAME_THERMAL_UPDT "UPDT"
127 #define IBM_NAME_EVENTS_STATUS_GET "DHKC"
128 #define IBM_NAME_EVENTS_MASK_GET "DHKN"
129 #define IBM_NAME_EVENTS_STATUS_SET "MHKC"
130 #define IBM_NAME_EVENTS_MASK_SET "MHKM"
131 #define IBM_NAME_EVENTS_GET "MHKP"
132 #define IBM_NAME_EVENTS_AVAILMASK "MHKA"
135 #define IBM_EVENT_LCD_BACKLIGHT 0x03
136 #define IBM_EVENT_SUSPEND_TO_RAM 0x04
137 #define IBM_EVENT_BLUETOOTH 0x05
138 #define IBM_EVENT_SCREEN_EXPAND 0x07
139 #define IBM_EVENT_SUSPEND_TO_DISK 0x0c
140 #define IBM_EVENT_BRIGHTNESS_UP 0x10
141 #define IBM_EVENT_BRIGHTNESS_DOWN 0x11
142 #define IBM_EVENT_THINKLIGHT 0x12
143 #define IBM_EVENT_ZOOM 0x14
144 #define IBM_EVENT_VOLUME_UP 0x15
145 #define IBM_EVENT_VOLUME_DOWN 0x16
146 #define IBM_EVENT_MUTE 0x17
147 #define IBM_EVENT_ACCESS_IBM_BUTTON 0x18
149 #define ABS(x) (((x) < 0)? -(x) : (x))
151 struct acpi_ibm_softc {
155 /* Embedded controller */
157 ACPI_HANDLE ec_handle;
160 ACPI_HANDLE cmos_handle;
163 ACPI_HANDLE fan_handle;
166 /* Keylight commands and states */
167 ACPI_HANDLE light_handle;
171 int light_get_supported;
172 int light_set_supported;
174 /* led(4) interface */
175 struct cdev *led_dev;
180 ACPI_HANDLE mic_led_handle;
184 int thermal_updt_supported;
186 unsigned int events_availmask;
187 unsigned int events_initialmask;
188 int events_mask_supported;
191 unsigned int handler_events;
193 struct sysctl_ctx_list *sysctl_ctx;
194 struct sysctl_oid *sysctl_tree;
202 } acpi_ibm_sysctls[] = {
205 .method = ACPI_IBM_METHOD_EVENTS,
206 .description = "ACPI events enable",
210 .method = ACPI_IBM_METHOD_EVENTMASK,
211 .description = "ACPI eventmask",
215 .method = ACPI_IBM_METHOD_HOTKEY,
216 .description = "Key Status",
220 .name = "lcd_brightness",
221 .method = ACPI_IBM_METHOD_BRIGHTNESS,
222 .description = "LCD Brightness",
226 .method = ACPI_IBM_METHOD_VOLUME,
227 .description = "Volume",
231 .method = ACPI_IBM_METHOD_MUTE,
232 .description = "Mute",
235 .name = "thinklight",
236 .method = ACPI_IBM_METHOD_THINKLIGHT,
237 .description = "Thinklight enable",
241 .method = ACPI_IBM_METHOD_BLUETOOTH,
242 .description = "Bluetooth enable",
246 .method = ACPI_IBM_METHOD_WLAN,
247 .description = "WLAN enable",
252 .method = ACPI_IBM_METHOD_FANSPEED,
253 .description = "Fan speed",
258 .method = ACPI_IBM_METHOD_FANLEVEL,
259 .description = "Fan level",
263 .method = ACPI_IBM_METHOD_FANSTATUS,
264 .description = "Fan enable",
268 .method = ACPI_IBM_METHOD_MIC_LED,
269 .description = "Mic led",
275 * Per-model default list of event mask.
277 #define ACPI_IBM_HKEY_RFKILL_MASK (1 << 4)
278 #define ACPI_IBM_HKEY_DSWITCH_MASK (1 << 6)
279 #define ACPI_IBM_HKEY_BRIGHTNESS_UP_MASK (1 << 15)
280 #define ACPI_IBM_HKEY_BRIGHTNESS_DOWN_MASK (1 << 16)
281 #define ACPI_IBM_HKEY_SEARCH_MASK (1 << 18)
282 #define ACPI_IBM_HKEY_MICMUTE_MASK (1 << 26)
283 #define ACPI_IBM_HKEY_SETTINGS_MASK (1 << 28)
284 #define ACPI_IBM_HKEY_VIEWOPEN_MASK (1 << 30)
285 #define ACPI_IBM_HKEY_VIEWALL_MASK (1 << 31)
287 struct acpi_ibm_models {
291 } acpi_ibm_models[] = {
292 { "LENOVO", "20BSCTO1WW",
293 ACPI_IBM_HKEY_RFKILL_MASK |
294 ACPI_IBM_HKEY_DSWITCH_MASK |
295 ACPI_IBM_HKEY_BRIGHTNESS_UP_MASK |
296 ACPI_IBM_HKEY_BRIGHTNESS_DOWN_MASK |
297 ACPI_IBM_HKEY_SEARCH_MASK |
298 ACPI_IBM_HKEY_MICMUTE_MASK |
299 ACPI_IBM_HKEY_SETTINGS_MASK |
300 ACPI_IBM_HKEY_VIEWOPEN_MASK |
301 ACPI_IBM_HKEY_VIEWALL_MASK
305 ACPI_SERIAL_DECL(ibm, "ACPI IBM extras");
307 static int acpi_ibm_probe(device_t dev);
308 static int acpi_ibm_attach(device_t dev);
309 static int acpi_ibm_detach(device_t dev);
310 static int acpi_ibm_resume(device_t dev);
312 static void ibm_led(void *softc, int onoff);
313 static void ibm_led_task(struct acpi_ibm_softc *sc, int pending __unused);
315 static int acpi_ibm_sysctl(SYSCTL_HANDLER_ARGS);
316 static int acpi_ibm_sysctl_init(struct acpi_ibm_softc *sc, int method);
317 static int acpi_ibm_sysctl_get(struct acpi_ibm_softc *sc, int method);
318 static int acpi_ibm_sysctl_set(struct acpi_ibm_softc *sc, int method, int val);
320 static int acpi_ibm_eventmask_set(struct acpi_ibm_softc *sc, int val);
321 static int acpi_ibm_thermal_sysctl(SYSCTL_HANDLER_ARGS);
322 static int acpi_ibm_handlerevents_sysctl(SYSCTL_HANDLER_ARGS);
323 static void acpi_ibm_notify(ACPI_HANDLE h, UINT32 notify, void *context);
325 static int acpi_ibm_brightness_set(struct acpi_ibm_softc *sc, int arg);
326 static int acpi_ibm_bluetooth_set(struct acpi_ibm_softc *sc, int arg);
327 static int acpi_ibm_thinklight_set(struct acpi_ibm_softc *sc, int arg);
328 static int acpi_ibm_volume_set(struct acpi_ibm_softc *sc, int arg);
329 static int acpi_ibm_mute_set(struct acpi_ibm_softc *sc, int arg);
331 static device_method_t acpi_ibm_methods[] = {
332 /* Device interface */
333 DEVMETHOD(device_probe, acpi_ibm_probe),
334 DEVMETHOD(device_attach, acpi_ibm_attach),
335 DEVMETHOD(device_detach, acpi_ibm_detach),
336 DEVMETHOD(device_resume, acpi_ibm_resume),
341 static driver_t acpi_ibm_driver = {
344 sizeof(struct acpi_ibm_softc),
347 static devclass_t acpi_ibm_devclass;
349 DRIVER_MODULE(acpi_ibm, acpi, acpi_ibm_driver, acpi_ibm_devclass,
351 MODULE_DEPEND(acpi_ibm, acpi, 1, 1, 1);
352 static char *ibm_ids[] = {"IBM0068", "LEN0068", NULL};
355 ibm_led(void *softc, int onoff)
357 struct acpi_ibm_softc* sc = (struct acpi_ibm_softc*) softc;
359 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
365 sc->led_state = onoff;
367 AcpiOsExecute(OSL_NOTIFY_HANDLER, (void *)ibm_led_task, sc);
371 ibm_led_task(struct acpi_ibm_softc *sc, int pending __unused)
373 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
375 ACPI_SERIAL_BEGIN(ibm);
376 acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_THINKLIGHT, sc->led_state);
377 ACPI_SERIAL_END(ibm);
383 acpi_ibm_mic_led_set (struct acpi_ibm_softc *sc, int arg)
385 ACPI_OBJECT_LIST input;
386 ACPI_OBJECT params[1];
389 if (arg < 0 || arg > 1)
392 if (sc->mic_led_handle) {
393 params[0].Type = ACPI_TYPE_INTEGER;
394 params[0].Integer.Value = 0;
395 /* mic led: 0 off, 2 on */
397 params[0].Integer.Value = 2;
399 input.Pointer = params;
402 status = AcpiEvaluateObject (sc->handle, "MMTS", &input, NULL);
403 if (ACPI_SUCCESS(status))
404 sc->mic_led_state = arg;
412 acpi_ibm_probe(device_t dev)
414 if (acpi_disabled("ibm") ||
415 ACPI_ID_PROBE(device_get_parent(dev), dev, ibm_ids) == NULL ||
416 device_get_unit(dev) != 0)
419 device_set_desc(dev, "IBM ThinkPad ACPI Extras");
425 acpi_ibm_attach(device_t dev)
428 struct acpi_ibm_softc *sc;
429 char *maker, *product;
430 devclass_t ec_devclass;
432 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
434 sc = device_get_softc(dev);
436 sc->handle = acpi_get_handle(dev);
438 /* Look for the first embedded controller */
439 if (!(ec_devclass = devclass_find ("acpi_ec"))) {
441 device_printf(dev, "Couldn't find acpi_ec devclass\n");
444 if (!(sc->ec_dev = devclass_get_device(ec_devclass, 0))) {
446 device_printf(dev, "Couldn't find acpi_ec device\n");
449 sc->ec_handle = acpi_get_handle(sc->ec_dev);
451 /* Get the sysctl tree */
452 sc->sysctl_ctx = device_get_sysctl_ctx(dev);
453 sc->sysctl_tree = device_get_sysctl_tree(dev);
455 /* Look for event mask and hook up the nodes */
456 sc->events_mask_supported = ACPI_SUCCESS(acpi_GetInteger(sc->handle,
457 IBM_NAME_EVENTS_MASK_GET, &sc->events_initialmask));
459 if (sc->events_mask_supported) {
460 SYSCTL_ADD_UINT(sc->sysctl_ctx,
461 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
462 "initialmask", CTLFLAG_RD,
463 &sc->events_initialmask, 0, "Initial eventmask");
465 /* The availmask is the bitmask of supported events */
466 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
467 IBM_NAME_EVENTS_AVAILMASK, &sc->events_availmask)))
468 sc->events_availmask = 0xffffffff;
470 SYSCTL_ADD_UINT(sc->sysctl_ctx,
471 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
472 "availmask", CTLFLAG_RD,
473 &sc->events_availmask, 0, "Mask of supported events");
476 /* Hook up proc nodes */
477 for (int i = 0; acpi_ibm_sysctls[i].name != NULL; i++) {
478 if (!acpi_ibm_sysctl_init(sc, acpi_ibm_sysctls[i].method))
481 if (acpi_ibm_sysctls[i].flag_rdonly != 0) {
482 SYSCTL_ADD_PROC(sc->sysctl_ctx,
483 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
484 acpi_ibm_sysctls[i].name, CTLTYPE_INT | CTLFLAG_RD,
485 sc, i, acpi_ibm_sysctl, "I",
486 acpi_ibm_sysctls[i].description);
488 SYSCTL_ADD_PROC(sc->sysctl_ctx,
489 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
490 acpi_ibm_sysctls[i].name, CTLTYPE_INT | CTLFLAG_RW,
491 sc, i, acpi_ibm_sysctl, "I",
492 acpi_ibm_sysctls[i].description);
496 /* Hook up thermal node */
497 if (acpi_ibm_sysctl_init(sc, ACPI_IBM_METHOD_THERMAL)) {
498 SYSCTL_ADD_PROC(sc->sysctl_ctx,
499 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
500 "thermal", CTLTYPE_INT | CTLFLAG_RD,
501 sc, 0, acpi_ibm_thermal_sysctl, "I",
505 /* Hook up handlerevents node */
506 if (acpi_ibm_sysctl_init(sc, ACPI_IBM_METHOD_HANDLEREVENTS)) {
507 SYSCTL_ADD_PROC(sc->sysctl_ctx,
508 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
509 "handlerevents", CTLTYPE_STRING | CTLFLAG_RW,
510 sc, 0, acpi_ibm_handlerevents_sysctl, "I",
511 "devd(8) events handled by acpi_ibm");
514 /* Handle notifies */
515 AcpiInstallNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
516 acpi_ibm_notify, dev);
518 /* Hook up light to led(4) */
519 if (sc->light_set_supported)
520 sc->led_dev = led_create_state(ibm_led, sc, "thinklight",
521 (sc->light_val ? 1 : 0));
523 /* Enable per-model events. */
524 maker = kern_getenv("smbios.system.maker");
525 product = kern_getenv("smbios.system.product");
526 if (maker == NULL || product == NULL)
529 for (i = 0; i < nitems(acpi_ibm_models); i++) {
530 if (strcmp(maker, acpi_ibm_models[i].maker) == 0 &&
531 strcmp(product, acpi_ibm_models[i].product) == 0) {
532 ACPI_SERIAL_BEGIN(ibm);
533 acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTMASK,
534 acpi_ibm_models[i].eventmask);
535 ACPI_SERIAL_END(ibm);
543 /* Enable events by default. */
544 ACPI_SERIAL_BEGIN(ibm);
545 acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTS, 1);
546 ACPI_SERIAL_END(ibm);
553 acpi_ibm_detach(device_t dev)
555 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
557 struct acpi_ibm_softc *sc = device_get_softc(dev);
559 /* Disable events and restore eventmask */
560 ACPI_SERIAL_BEGIN(ibm);
561 acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTS, 0);
562 acpi_ibm_sysctl_set(sc, ACPI_IBM_METHOD_EVENTMASK, sc->events_initialmask);
563 ACPI_SERIAL_END(ibm);
565 AcpiRemoveNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY, acpi_ibm_notify);
567 if (sc->led_dev != NULL)
568 led_destroy(sc->led_dev);
574 acpi_ibm_resume(device_t dev)
576 struct acpi_ibm_softc *sc = device_get_softc(dev);
578 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
580 ACPI_SERIAL_BEGIN(ibm);
581 for (int i = 0; acpi_ibm_sysctls[i].name != NULL; i++) {
584 val = acpi_ibm_sysctl_get(sc, i);
586 if (acpi_ibm_sysctls[i].flag_rdonly != 0)
589 acpi_ibm_sysctl_set(sc, i, val);
591 ACPI_SERIAL_END(ibm);
593 /* The mic led does not turn back on when sysctl_set is called in the above loop */
594 acpi_ibm_mic_led_set(sc, sc->mic_led_state);
600 acpi_ibm_eventmask_set(struct acpi_ibm_softc *sc, int val)
603 ACPI_OBJECT_LIST args;
606 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
607 ACPI_SERIAL_ASSERT(ibm);
611 arg[0].Type = ACPI_TYPE_INTEGER;
612 arg[1].Type = ACPI_TYPE_INTEGER;
614 for (int i = 0; i < 32; ++i) {
615 arg[0].Integer.Value = i+1;
616 arg[1].Integer.Value = (((1 << i) & val) != 0);
617 status = AcpiEvaluateObject(sc->handle,
618 IBM_NAME_EVENTS_MASK_SET, &args, NULL);
620 if (ACPI_FAILURE(status))
628 acpi_ibm_sysctl(SYSCTL_HANDLER_ARGS)
630 struct acpi_ibm_softc *sc;
636 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
638 sc = (struct acpi_ibm_softc *)oidp->oid_arg1;
639 function = oidp->oid_arg2;
640 method = acpi_ibm_sysctls[function].method;
642 ACPI_SERIAL_BEGIN(ibm);
643 arg = acpi_ibm_sysctl_get(sc, method);
644 error = sysctl_handle_int(oidp, &arg, 0, req);
647 if (error != 0 || req->newptr == NULL)
651 error = acpi_ibm_sysctl_set(sc, method, arg);
654 ACPI_SERIAL_END(ibm);
659 acpi_ibm_sysctl_get(struct acpi_ibm_softc *sc, int method)
664 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
665 ACPI_SERIAL_ASSERT(ibm);
668 case ACPI_IBM_METHOD_EVENTS:
669 acpi_GetInteger(sc->handle, IBM_NAME_EVENTS_STATUS_GET, &val);
672 case ACPI_IBM_METHOD_EVENTMASK:
673 if (sc->events_mask_supported)
674 acpi_GetInteger(sc->handle, IBM_NAME_EVENTS_MASK_GET, &val);
677 case ACPI_IBM_METHOD_HOTKEY:
679 * Construct the hotkey as a bitmask as illustrated below.
680 * Note that whenever a key was pressed, the respecting bit
681 * toggles and nothing else changes.
682 * +--+--+-+-+-+-+-+-+-+-+-+-+
683 * |11|10|9|8|7|6|5|4|3|2|1|0|
684 * +--+--+-+-+-+-+-+-+-+-+-+-+
685 * | | | | | | | | | | | |
686 * | | | | | | | | | | | +- Home Button
687 * | | | | | | | | | | +--- Search Button
688 * | | | | | | | | | +----- Mail Button
689 * | | | | | | | | +------- Thinkpad Button
690 * | | | | | | | +--------- Zoom (Fn + Space)
691 * | | | | | | +----------- WLAN Button
692 * | | | | | +------------- Video Button
693 * | | | | +--------------- Hibernate Button
694 * | | | +----------------- Thinklight Button
695 * | | +------------------- Screen expand (Fn + F8)
696 * | +--------------------- Brightness
697 * +------------------------ Volume/Mute
699 key = rtcin(IBM_RTC_HOTKEY1);
700 val = (IBM_RTC_MASK_HOME | IBM_RTC_MASK_SEARCH | IBM_RTC_MASK_MAIL | IBM_RTC_MASK_WLAN) & key;
701 key = rtcin(IBM_RTC_HOTKEY2);
702 val |= (IBM_RTC_MASK_THINKPAD | IBM_RTC_MASK_VIDEO | IBM_RTC_MASK_HIBERNATE) & key;
703 val |= (IBM_RTC_MASK_ZOOM & key) >> 1;
704 key = rtcin(IBM_RTC_THINKLIGHT);
705 val |= (IBM_RTC_MASK_THINKLIGHT & key) << 4;
706 key = rtcin(IBM_RTC_SCREENEXPAND);
707 val |= (IBM_RTC_MASK_THINKLIGHT & key) << 4;
708 key = rtcin(IBM_RTC_BRIGHTNESS);
709 val |= (IBM_RTC_MASK_BRIGHTNESS & key) << 5;
710 key = rtcin(IBM_RTC_VOLUME);
711 val |= (IBM_RTC_MASK_VOLUME & key) << 4;
714 case ACPI_IBM_METHOD_BRIGHTNESS:
715 ACPI_EC_READ(sc->ec_dev, IBM_EC_BRIGHTNESS, &val_ec, 1);
716 val = val_ec & IBM_EC_MASK_BRI;
719 case ACPI_IBM_METHOD_VOLUME:
720 ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
721 val = val_ec & IBM_EC_MASK_VOL;
724 case ACPI_IBM_METHOD_MUTE:
725 ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
726 val = ((val_ec & IBM_EC_MASK_MUTE) == IBM_EC_MASK_MUTE);
729 case ACPI_IBM_METHOD_THINKLIGHT:
730 if (sc->light_get_supported)
731 acpi_GetInteger(sc->ec_handle, IBM_NAME_KEYLIGHT, &val);
736 case ACPI_IBM_METHOD_BLUETOOTH:
737 acpi_GetInteger(sc->handle, IBM_NAME_WLAN_BT_GET, &val);
738 sc->wlan_bt_flags = val;
739 val = ((val & IBM_NAME_MASK_BT) != 0);
742 case ACPI_IBM_METHOD_WLAN:
743 acpi_GetInteger(sc->handle, IBM_NAME_WLAN_BT_GET, &val);
744 sc->wlan_bt_flags = val;
745 val = ((val & IBM_NAME_MASK_WLAN) != 0);
748 case ACPI_IBM_METHOD_FANSPEED:
749 if (sc->fan_handle) {
750 if(ACPI_FAILURE(acpi_GetInteger(sc->fan_handle, NULL, &val)))
754 ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSPEED, &val_ec, 2);
759 case ACPI_IBM_METHOD_FANLEVEL:
761 * The IBM_EC_FANSTATUS register works as follows:
762 * Bit 0-5 indicate the level at which the fan operates. Only
763 * values between 0 and 7 have an effect. Everything
764 * above 7 is treated the same as level 7
765 * Bit 6 overrides the fan speed limit if set to 1
766 * Bit 7 indicates at which mode the fan operates:
767 * manual (0) or automatic (1)
769 if (!sc->fan_handle) {
770 ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
771 val = val_ec & IBM_EC_MASK_FANLEVEL;
775 case ACPI_IBM_METHOD_FANSTATUS:
776 if (!sc->fan_handle) {
777 ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
778 val = (val_ec & IBM_EC_MASK_FANSTATUS) == IBM_EC_MASK_FANSTATUS;
783 case ACPI_IBM_METHOD_MIC_LED:
784 if (sc->mic_led_handle)
785 return sc->mic_led_state;
795 acpi_ibm_sysctl_set(struct acpi_ibm_softc *sc, int method, int arg)
801 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
802 ACPI_SERIAL_ASSERT(ibm);
805 case ACPI_IBM_METHOD_EVENTS:
806 if (arg < 0 || arg > 1)
809 status = acpi_SetInteger(sc->handle, IBM_NAME_EVENTS_STATUS_SET, arg);
810 if (ACPI_FAILURE(status))
812 if (sc->events_mask_supported)
813 return acpi_ibm_eventmask_set(sc, sc->events_availmask);
816 case ACPI_IBM_METHOD_EVENTMASK:
817 if (sc->events_mask_supported)
818 return acpi_ibm_eventmask_set(sc, arg);
821 case ACPI_IBM_METHOD_BRIGHTNESS:
822 return acpi_ibm_brightness_set(sc, arg);
825 case ACPI_IBM_METHOD_VOLUME:
826 return acpi_ibm_volume_set(sc, arg);
829 case ACPI_IBM_METHOD_MUTE:
830 return acpi_ibm_mute_set(sc, arg);
833 case ACPI_IBM_METHOD_MIC_LED:
834 return acpi_ibm_mic_led_set (sc, arg);
837 case ACPI_IBM_METHOD_THINKLIGHT:
838 return acpi_ibm_thinklight_set(sc, arg);
841 case ACPI_IBM_METHOD_BLUETOOTH:
842 return acpi_ibm_bluetooth_set(sc, arg);
845 case ACPI_IBM_METHOD_FANLEVEL:
846 if (arg < 0 || arg > 7)
849 if (!sc->fan_handle) {
850 /* Read the current fanstatus */
851 ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
852 val = val_ec & (~IBM_EC_MASK_FANLEVEL);
854 return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_FANSTATUS, val | arg, 1);
858 case ACPI_IBM_METHOD_FANSTATUS:
859 if (arg < 0 || arg > 1)
862 if (!sc->fan_handle) {
863 /* Read the current fanstatus */
864 ACPI_EC_READ(sc->ec_dev, IBM_EC_FANSTATUS, &val_ec, 1);
866 return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_FANSTATUS,
867 (arg == 1) ? (val_ec | IBM_EC_MASK_FANSTATUS) : (val_ec & (~IBM_EC_MASK_FANSTATUS)), 1);
876 acpi_ibm_sysctl_init(struct acpi_ibm_softc *sc, int method)
879 ACPI_OBJECT_TYPE cmos_t;
880 ACPI_HANDLE ledb_handle;
883 case ACPI_IBM_METHOD_EVENTS:
886 case ACPI_IBM_METHOD_EVENTMASK:
887 return (sc->events_mask_supported);
889 case ACPI_IBM_METHOD_HOTKEY:
890 case ACPI_IBM_METHOD_BRIGHTNESS:
891 case ACPI_IBM_METHOD_VOLUME:
892 case ACPI_IBM_METHOD_MUTE:
893 /* EC is required here, which was already checked before */
896 case ACPI_IBM_METHOD_MIC_LED:
897 if (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "MMTS", &sc->mic_led_handle)))
899 /* Turn off mic led by default */
900 acpi_ibm_mic_led_set (sc, 0);
904 sc->mic_led_handle = NULL;
907 case ACPI_IBM_METHOD_THINKLIGHT:
908 sc->cmos_handle = NULL;
909 sc->light_get_supported = ACPI_SUCCESS(acpi_GetInteger(
910 sc->ec_handle, IBM_NAME_KEYLIGHT, &sc->light_val));
912 if ((ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\UCMS", &sc->light_handle)) ||
913 ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\CMOS", &sc->light_handle)) ||
914 ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\CMS", &sc->light_handle))) &&
915 ACPI_SUCCESS(AcpiGetType(sc->light_handle, &cmos_t)) &&
916 cmos_t == ACPI_TYPE_METHOD) {
917 sc->light_cmd_on = 0x0c;
918 sc->light_cmd_off = 0x0d;
919 sc->cmos_handle = sc->light_handle;
921 else if (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\LGHT", &sc->light_handle))) {
922 sc->light_cmd_on = 1;
923 sc->light_cmd_off = 0;
926 sc->light_handle = NULL;
928 sc->light_set_supported = (sc->light_handle &&
929 ACPI_FAILURE(AcpiGetHandle(sc->ec_handle, "LEDB", &ledb_handle)));
931 if (sc->light_get_supported)
934 if (sc->light_set_supported) {
941 case ACPI_IBM_METHOD_BLUETOOTH:
942 case ACPI_IBM_METHOD_WLAN:
943 if (ACPI_SUCCESS(acpi_GetInteger(sc->handle, IBM_NAME_WLAN_BT_GET, &dummy)))
947 case ACPI_IBM_METHOD_FANSPEED:
949 * Some models report the fan speed in levels from 0-7
950 * Newer models report it contiguously
953 (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "GFAN", &sc->fan_handle)) ||
954 ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\FSPD", &sc->fan_handle)));
957 case ACPI_IBM_METHOD_FANLEVEL:
958 case ACPI_IBM_METHOD_FANSTATUS:
960 * Fan status is only supported on those models,
961 * which report fan RPM contiguously, not in levels
967 case ACPI_IBM_METHOD_THERMAL:
968 if (ACPI_SUCCESS(acpi_GetInteger(sc->ec_handle, IBM_NAME_THERMAL_GET, &dummy))) {
969 sc->thermal_updt_supported = ACPI_SUCCESS(acpi_GetInteger(sc->ec_handle, IBM_NAME_THERMAL_UPDT, &dummy));
974 case ACPI_IBM_METHOD_HANDLEREVENTS:
981 acpi_ibm_thermal_sysctl(SYSCTL_HANDLER_ARGS)
983 struct acpi_ibm_softc *sc;
985 char temp_cmd[] = "TMP0";
988 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
990 sc = (struct acpi_ibm_softc *)oidp->oid_arg1;
992 ACPI_SERIAL_BEGIN(ibm);
994 for (int i = 0; i < 8; ++i) {
995 temp_cmd[3] = '0' + i;
998 * The TMPx methods seem to return +/- 128 or 0
999 * when the respecting sensor is not available
1001 if (ACPI_FAILURE(acpi_GetInteger(sc->ec_handle, temp_cmd,
1002 &temp[i])) || ABS(temp[i]) == 128 || temp[i] == 0)
1004 else if (sc->thermal_updt_supported)
1005 /* Temperature is reported in tenth of Kelvin */
1006 temp[i] = (temp[i] - 2731 + 5) / 10;
1009 error = sysctl_handle_opaque(oidp, &temp, 8*sizeof(int), req);
1011 ACPI_SERIAL_END(ibm);
1016 acpi_ibm_handlerevents_sysctl(SYSCTL_HANDLER_ARGS)
1018 struct acpi_ibm_softc *sc;
1023 unsigned int handler_events;
1026 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1028 sc = (struct acpi_ibm_softc *)oidp->oid_arg1;
1030 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
1033 ACPI_SERIAL_BEGIN(ibm);
1035 /* Get old values if this is a get request. */
1036 if (req->newptr == NULL) {
1037 for (int i = 0; i < 8 * sizeof(sc->handler_events); i++)
1038 if (sc->handler_events & (1 << i))
1039 sbuf_printf(&sb, "0x%02x ", i + 1);
1040 if (sbuf_len(&sb) == 0)
1041 sbuf_printf(&sb, "NONE");
1046 strlcpy(temp, sbuf_data(&sb), sizeof(temp));
1049 error = sysctl_handle_string(oidp, temp, sizeof(temp), req);
1051 /* Check for error or no change */
1052 if (error != 0 || req->newptr == NULL)
1055 /* If the user is setting a string, parse it. */
1066 while (*ep && !isspace(*ep))
1073 if (strncmp(cp, "NONE", 4) == 0) {
1078 if (l >= 3 && cp[0] == '0' && (cp[1] == 'X' || cp[1] == 'x'))
1079 val = strtoul(cp, &ep, 16);
1081 val = strtoul(cp, &ep, 10);
1083 if (val == 0 || ep == cp || val >= 8 * sizeof(handler_events)) {
1085 device_printf(sc->dev, "invalid event code: %s\n", cp);
1090 handler_events |= 1 << (val - 1);
1095 sc->handler_events = handler_events;
1097 ACPI_SERIAL_END(ibm);
1102 acpi_ibm_brightness_set(struct acpi_ibm_softc *sc, int arg)
1107 ACPI_OBJECT_LIST Args;
1110 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1111 ACPI_SERIAL_ASSERT(ibm);
1113 if (arg < 0 || arg > 7)
1116 /* Read the current brightness */
1117 status = ACPI_EC_READ(sc->ec_dev, IBM_EC_BRIGHTNESS, &val_ec, 1);
1118 if (ACPI_FAILURE(status))
1121 if (sc->cmos_handle) {
1122 val = val_ec & IBM_EC_MASK_BRI;
1125 Args.Pointer = &Arg;
1126 Arg.Type = ACPI_TYPE_INTEGER;
1127 Arg.Integer.Value = (arg > val) ? IBM_CMOS_BRIGHTNESS_UP :
1128 IBM_CMOS_BRIGHTNESS_DOWN;
1130 step = (arg > val) ? 1 : -1;
1131 for (int i = val; i != arg; i += step) {
1132 status = AcpiEvaluateObject(sc->cmos_handle, NULL,
1134 if (ACPI_FAILURE(status)) {
1135 /* Record the last value */
1137 ACPI_EC_WRITE(sc->ec_dev,
1138 IBM_EC_BRIGHTNESS, i - step, 1);
1145 return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_BRIGHTNESS, arg, 1);
1149 acpi_ibm_bluetooth_set(struct acpi_ibm_softc *sc, int arg)
1153 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1154 ACPI_SERIAL_ASSERT(ibm);
1156 if (arg < 0 || arg > 1)
1159 val = (arg == 1) ? sc->wlan_bt_flags | IBM_NAME_MASK_BT :
1160 sc->wlan_bt_flags & (~IBM_NAME_MASK_BT);
1161 return acpi_SetInteger(sc->handle, IBM_NAME_WLAN_BT_SET, val);
1165 acpi_ibm_thinklight_set(struct acpi_ibm_softc *sc, int arg)
1168 ACPI_OBJECT_LIST Args;
1171 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1172 ACPI_SERIAL_ASSERT(ibm);
1174 if (arg < 0 || arg > 1)
1177 if (sc->light_set_supported) {
1179 Args.Pointer = &Arg;
1180 Arg.Type = ACPI_TYPE_INTEGER;
1181 Arg.Integer.Value = arg ? sc->light_cmd_on : sc->light_cmd_off;
1183 status = AcpiEvaluateObject(sc->light_handle, NULL,
1185 if (ACPI_SUCCESS(status))
1186 sc->light_val = arg;
1194 acpi_ibm_volume_set(struct acpi_ibm_softc *sc, int arg)
1199 ACPI_OBJECT_LIST Args;
1202 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1203 ACPI_SERIAL_ASSERT(ibm);
1205 if (arg < 0 || arg > 14)
1208 /* Read the current volume */
1209 status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1210 if (ACPI_FAILURE(status))
1213 if (sc->cmos_handle) {
1214 val = val_ec & IBM_EC_MASK_VOL;
1217 Args.Pointer = &Arg;
1218 Arg.Type = ACPI_TYPE_INTEGER;
1219 Arg.Integer.Value = (arg > val) ? IBM_CMOS_VOLUME_UP :
1220 IBM_CMOS_VOLUME_DOWN;
1222 step = (arg > val) ? 1 : -1;
1223 for (int i = val; i != arg; i += step) {
1224 status = AcpiEvaluateObject(sc->cmos_handle, NULL,
1226 if (ACPI_FAILURE(status)) {
1227 /* Record the last value */
1230 (val_ec & (~IBM_EC_MASK_VOL));
1231 ACPI_EC_WRITE(sc->ec_dev, IBM_EC_VOLUME,
1239 val_ec = arg + (val_ec & (~IBM_EC_MASK_VOL));
1240 return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_VOLUME, val_ec, 1);
1244 acpi_ibm_mute_set(struct acpi_ibm_softc *sc, int arg)
1248 ACPI_OBJECT_LIST Args;
1251 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1252 ACPI_SERIAL_ASSERT(ibm);
1254 if (arg < 0 || arg > 1)
1257 status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1258 if (ACPI_FAILURE(status))
1261 if (sc->cmos_handle) {
1263 Args.Pointer = &Arg;
1264 Arg.Type = ACPI_TYPE_INTEGER;
1265 Arg.Integer.Value = IBM_CMOS_VOLUME_MUTE;
1267 status = AcpiEvaluateObject(sc->cmos_handle, NULL, &Args, NULL);
1268 if (ACPI_FAILURE(status))
1272 val_ec = (arg == 1) ? val_ec | IBM_EC_MASK_MUTE :
1273 val_ec & (~IBM_EC_MASK_MUTE);
1274 return ACPI_EC_WRITE(sc->ec_dev, IBM_EC_VOLUME, val_ec, 1);
1278 acpi_ibm_eventhandler(struct acpi_ibm_softc *sc, int arg)
1284 ACPI_SERIAL_BEGIN(ibm);
1286 case IBM_EVENT_SUSPEND_TO_RAM:
1287 power_pm_suspend(POWER_SLEEP_STATE_SUSPEND);
1290 case IBM_EVENT_BLUETOOTH:
1291 acpi_ibm_bluetooth_set(sc, (sc->wlan_bt_flags == 0));
1294 case IBM_EVENT_BRIGHTNESS_UP:
1295 case IBM_EVENT_BRIGHTNESS_DOWN:
1296 /* Read the current brightness */
1297 status = ACPI_EC_READ(sc->ec_dev, IBM_EC_BRIGHTNESS,
1299 if (ACPI_FAILURE(status))
1302 val = val_ec & IBM_EC_MASK_BRI;
1303 val = (arg == IBM_EVENT_BRIGHTNESS_UP) ? val + 1 : val - 1;
1304 acpi_ibm_brightness_set(sc, val);
1307 case IBM_EVENT_THINKLIGHT:
1308 acpi_ibm_thinklight_set(sc, (sc->light_val == 0));
1311 case IBM_EVENT_VOLUME_UP:
1312 case IBM_EVENT_VOLUME_DOWN:
1313 /* Read the current volume */
1314 status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1315 if (ACPI_FAILURE(status))
1318 val = val_ec & IBM_EC_MASK_VOL;
1319 val = (arg == IBM_EVENT_VOLUME_UP) ? val + 1 : val - 1;
1320 acpi_ibm_volume_set(sc, val);
1323 case IBM_EVENT_MUTE:
1324 /* Read the current value */
1325 status = ACPI_EC_READ(sc->ec_dev, IBM_EC_VOLUME, &val_ec, 1);
1326 if (ACPI_FAILURE(status))
1329 val = ((val_ec & IBM_EC_MASK_MUTE) == IBM_EC_MASK_MUTE);
1330 acpi_ibm_mute_set(sc, (val == 0));
1336 ACPI_SERIAL_END(ibm);
1340 acpi_ibm_notify(ACPI_HANDLE h, UINT32 notify, void *context)
1342 int event, arg, type;
1343 device_t dev = context;
1344 struct acpi_ibm_softc *sc = device_get_softc(dev);
1346 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
1349 device_printf(dev, "Unknown notify\n");
1352 acpi_GetInteger(acpi_get_handle(dev), IBM_NAME_EVENTS_GET, &event);
1357 type = (event >> 12) & 0xf;
1358 arg = event & 0xfff;
1361 if (!(sc->events_availmask & (1 << (arg - 1)))) {
1362 device_printf(dev, "Unknown key %d\n", arg);
1366 /* Execute event handler */
1367 if (sc->handler_events & (1 << (arg - 1)))
1368 acpi_ibm_eventhandler(sc, (arg & 0xff));
1370 /* Notify devd(8) */
1371 acpi_UserNotify("IBM", h, (arg & 0xff));