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
27 * $FreeBSD: head/sys/dev/acpi_support/acpi_ibm.c 246128 2013-01-30 18:01:20Z sbz $
31 * Driver for extra ACPI-controlled gadgets found on IBM and Lenovo ThinkPad
32 * laptops. Inspired by the ibm-acpi and tpb projects which implement these
35 * acpi-ibm: <http://ibm-acpi.sourceforge.net/>
36 * tpb: <http://www.nongnu.org/tpb/>
40 #include <sys/param.h>
41 #include <sys/kernel.h>
43 #include <machine/cpufunc.h>
44 #include <sys/module.h>
45 #include <sys/sensors.h>
47 #include <sys/sysctl.h>
49 #include <sys/thread2.h>
50 #include <machine/clock.h>
51 #include <dev/misc/led/led.h>
57 #define _COMPONENT ACPI_OEM
58 ACPI_MODULE_NAME("THINKPAD")
60 /* Internal methods */
61 #define ACPI_THINKPAD_METHOD_EVENTS 1
62 #define ACPI_THINKPAD_METHOD_EVENTMASK 2
63 #define ACPI_THINKPAD_METHOD_HOTKEY 3
64 #define ACPI_THINKPAD_METHOD_BRIGHTNESS 4
65 #define ACPI_THINKPAD_METHOD_VOLUME 5
66 #define ACPI_THINKPAD_METHOD_MUTE 6
67 #define ACPI_THINKPAD_METHOD_THINKLIGHT 7
68 #define ACPI_THINKPAD_METHOD_BLUETOOTH 8
69 #define ACPI_THINKPAD_METHOD_WLAN 9
70 #define ACPI_THINKPAD_METHOD_FANSPEED 10
71 #define ACPI_THINKPAD_METHOD_FANLEVEL 11
72 #define ACPI_THINKPAD_METHOD_FANSTATUS 12
73 #define ACPI_THINKPAD_METHOD_THERMAL 13
74 #define ACPI_THINKPAD_METHOD_HANDLEREVENTS 14
77 #define THINKPAD_RTC_HOTKEY1 0x64
78 #define THINKPAD_RTC_MASK_HOME (1 << 0)
79 #define THINKPAD_RTC_MASK_SEARCH (1 << 1)
80 #define THINKPAD_RTC_MASK_MAIL (1 << 2)
81 #define THINKPAD_RTC_MASK_WLAN (1 << 5)
82 #define THINKPAD_RTC_HOTKEY2 0x65
83 #define THINKPAD_RTC_MASK_THINKPAD (1 << 3)
84 #define THINKPAD_RTC_MASK_ZOOM (1 << 5)
85 #define THINKPAD_RTC_MASK_VIDEO (1 << 6)
86 #define THINKPAD_RTC_MASK_HIBERNATE (1 << 7)
87 #define THINKPAD_RTC_THINKLIGHT 0x66
88 #define THINKPAD_RTC_MASK_THINKLIGHT (1 << 4)
89 #define THINKPAD_RTC_SCREENEXPAND 0x67
90 #define THINKPAD_RTC_MASK_SCREENEXPAND (1 << 5)
91 #define THINKPAD_RTC_BRIGHTNESS 0x6c
92 #define THINKPAD_RTC_MASK_BRIGHTNESS (1 << 5)
93 #define THINKPAD_RTC_VOLUME 0x6e
94 #define THINKPAD_RTC_MASK_VOLUME (1 << 7)
96 /* Embedded Controller registers */
97 #define THINKPAD_EC_BRIGHTNESS 0x31
98 #define THINKPAD_EC_MASK_BRI 0x7
99 #define THINKPAD_EC_VOLUME 0x30
100 #define THINKPAD_EC_MASK_VOL 0xf
101 #define THINKPAD_EC_MASK_MUTE (1 << 6)
102 #define THINKPAD_EC_FANSTATUS 0x2F
103 #define THINKPAD_EC_MASK_FANLEVEL 0x3f
104 #define THINKPAD_EC_MASK_FANDISENGAGED (1 << 6)
105 #define THINKPAD_EC_MASK_FANSTATUS (1 << 7)
106 #define THINKPAD_EC_FANSPEED 0x84
109 #define THINKPAD_CMOS_VOLUME_DOWN 0
110 #define THINKPAD_CMOS_VOLUME_UP 1
111 #define THINKPAD_CMOS_VOLUME_MUTE 2
112 #define THINKPAD_CMOS_BRIGHTNESS_UP 4
113 #define THINKPAD_CMOS_BRIGHTNESS_DOWN 5
116 #define THINKPAD_NAME_KEYLIGHT "KBLT"
117 #define THINKPAD_NAME_WLAN_BT_GET "GBDC"
118 #define THINKPAD_NAME_WLAN_BT_SET "SBDC"
119 #define THINKPAD_NAME_MASK_BT (1 << 1)
120 #define THINKPAD_NAME_MASK_WLAN (1 << 2)
121 #define THINKPAD_NAME_THERMAL_GET "TMP7"
122 #define THINKPAD_NAME_THERMAL_UPDT "UPDT"
124 #define THINKPAD_NAME_EVENTS_STATUS_GET "DHKC"
125 #define THINKPAD_NAME_EVENTS_MASK_GET "DHKN"
126 #define THINKPAD_NAME_EVENTS_STATUS_SET "MHKC"
127 #define THINKPAD_NAME_EVENTS_MASK_SET "MHKM"
128 #define THINKPAD_NAME_EVENTS_GET "MHKP"
129 #define THINKPAD_NAME_EVENTS_AVAILMASK "MHKA"
131 #define THINKPAD_NUM_SENSORS 9
132 #define THINKPAD_TEMP_SENSORS 8
135 #define THINKPAD_EVENT_LCD_BACKLIGHT 0x03
136 #define THINKPAD_EVENT_SUSPEND_TO_RAM 0x04
137 #define THINKPAD_EVENT_BLUETOOTH 0x05
138 #define THINKPAD_EVENT_SCREEN_EXPAND 0x07
139 #define THINKPAD_EVENT_SUSPEND_TO_DISK 0x0c
140 #define THINKPAD_EVENT_BRIGHTNESS_UP 0x10
141 #define THINKPAD_EVENT_BRIGHTNESS_DOWN 0x11
142 #define THINKPAD_EVENT_THINKLIGHT 0x12
143 #define THINKPAD_EVENT_ZOOM 0x14
144 #define THINKPAD_EVENT_VOLUME_UP 0x15
145 #define THINKPAD_EVENT_VOLUME_DOWN 0x16
146 #define THINKPAD_EVENT_MUTE 0x17
147 #define THINKPAD_EVENT_ACCESS_THINKPAD_BUTTON 0x18
149 #define ABS(x) (((x) < 0)? -(x) : (x))
151 struct acpi_thinkpad_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 int thermal_updt_supported;
182 unsigned int events_availmask;
183 unsigned int events_initialmask;
184 int events_mask_supported;
187 /* sensors(9) related */
188 struct ksensordev sensordev;
189 struct ksensor sensors[THINKPAD_NUM_SENSORS];
191 unsigned int handler_events;
193 struct sysctl_ctx_list sysctl_ctx;
194 struct sysctl_oid *sysctl_tree;
202 } acpi_thinkpad_sysctls[] = {
205 .method = ACPI_THINKPAD_METHOD_EVENTS,
206 .description = "ACPI events enable",
207 .access = CTLTYPE_INT | CTLFLAG_RW
211 .method = ACPI_THINKPAD_METHOD_EVENTMASK,
212 .description = "ACPI eventmask",
213 .access = CTLTYPE_INT | CTLFLAG_RW
217 .method = ACPI_THINKPAD_METHOD_HOTKEY,
218 .description = "Key Status",
219 .access = CTLTYPE_INT | CTLFLAG_RD
222 .name = "lcd_brightness",
223 .method = ACPI_THINKPAD_METHOD_BRIGHTNESS,
224 .description = "LCD Brightness",
225 .access = CTLTYPE_INT | CTLFLAG_RW
229 .method = ACPI_THINKPAD_METHOD_VOLUME,
230 .description = "Volume",
231 .access = CTLTYPE_INT | CTLFLAG_RW
235 .method = ACPI_THINKPAD_METHOD_MUTE,
236 .description = "Mute",
237 .access = CTLTYPE_INT | CTLFLAG_RW
240 .name = "thinklight",
241 .method = ACPI_THINKPAD_METHOD_THINKLIGHT,
242 .description = "Thinklight enable",
243 .access = CTLTYPE_INT | CTLFLAG_RW
247 .method = ACPI_THINKPAD_METHOD_BLUETOOTH,
248 .description = "Bluetooth enable",
249 .access = CTLTYPE_INT | CTLFLAG_RW
253 .method = ACPI_THINKPAD_METHOD_WLAN,
254 .description = "WLAN enable",
255 .access = CTLTYPE_INT | CTLFLAG_RD
259 .method = ACPI_THINKPAD_METHOD_FANSPEED,
260 .description = "Fan speed",
261 .access = CTLTYPE_INT | CTLFLAG_RD
265 .method = ACPI_THINKPAD_METHOD_FANLEVEL,
266 .description = "Fan level",
267 .access = CTLTYPE_INT | CTLFLAG_RW
271 .method = ACPI_THINKPAD_METHOD_FANSTATUS,
272 .description = "Fan enable",
273 .access = CTLTYPE_INT | CTLFLAG_RW
279 ACPI_SERIAL_DECL(thinkpad, "ACPI Thinkpad extras");
281 static int acpi_thinkpad_probe(device_t dev);
282 static int acpi_thinkpad_attach(device_t dev);
283 static int acpi_thinkpad_detach(device_t dev);
284 static int acpi_thinkpad_resume(device_t dev);
286 static void thinkpad_led(void *softc, int onoff);
287 static void thinkpad_led_task(struct acpi_thinkpad_softc *sc, int pending __unused);
289 static int acpi_thinkpad_sysctl(SYSCTL_HANDLER_ARGS);
290 static int acpi_thinkpad_sysctl_init(struct acpi_thinkpad_softc *sc,
292 static int acpi_thinkpad_sysctl_get(struct acpi_thinkpad_softc *sc,
294 static int acpi_thinkpad_sysctl_set(struct acpi_thinkpad_softc *sc,
295 int method, int val);
297 static int acpi_thinkpad_eventmask_set(struct acpi_thinkpad_softc *sc,
299 static int acpi_thinkpad_handlerevents_sysctl(SYSCTL_HANDLER_ARGS);
300 static void acpi_thinkpad_notify(ACPI_HANDLE h, UINT32 notify,
302 static void acpi_thinkpad_refresh(void *);
304 static int acpi_thinkpad_brightness_set(struct acpi_thinkpad_softc *sc, int arg);
305 static int acpi_thinkpad_bluetooth_set(struct acpi_thinkpad_softc *sc, int arg);
306 static int acpi_thinkpad_thinklight_set(struct acpi_thinkpad_softc *sc, int arg);
307 static int acpi_thinkpad_volume_set(struct acpi_thinkpad_softc *sc, int arg);
308 static int acpi_thinkpad_mute_set(struct acpi_thinkpad_softc *sc, int arg);
310 static device_method_t acpi_thinkpad_methods[] = {
311 /* Device interface */
312 DEVMETHOD(device_probe, acpi_thinkpad_probe),
313 DEVMETHOD(device_attach, acpi_thinkpad_attach),
314 DEVMETHOD(device_detach, acpi_thinkpad_detach),
315 DEVMETHOD(device_resume, acpi_thinkpad_resume),
320 static driver_t acpi_thinkpad_driver = {
322 acpi_thinkpad_methods,
323 sizeof(struct acpi_thinkpad_softc),
326 static devclass_t acpi_thinkpad_devclass;
328 DRIVER_MODULE(acpi_thinkpad, acpi, acpi_thinkpad_driver,
329 acpi_thinkpad_devclass, NULL, NULL);
330 MODULE_DEPEND(acpi_thinkpad, acpi, 1, 1, 1);
331 static char *thinkpad_ids[] = {"IBM0068", "LEN0068", NULL};
334 thinkpad_led(void *softc, int onoff)
336 struct acpi_thinkpad_softc* sc = (struct acpi_thinkpad_softc*) softc;
338 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
344 sc->led_state = onoff;
346 AcpiOsExecute(OSL_NOTIFY_HANDLER, (void *)thinkpad_led_task, sc);
350 thinkpad_led_task(struct acpi_thinkpad_softc *sc, int pending __unused)
352 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
354 ACPI_SERIAL_BEGIN(thinkpad);
355 acpi_thinkpad_sysctl_set(sc, ACPI_THINKPAD_METHOD_THINKLIGHT, sc->led_state);
356 ACPI_SERIAL_END(thinkpad);
362 acpi_thinkpad_probe(device_t dev)
364 if (acpi_disabled("thinkpad") ||
365 ACPI_ID_PROBE(device_get_parent(dev), dev, thinkpad_ids) == NULL ||
366 device_get_unit(dev) != 0)
369 device_set_desc(dev, "IBM/Lenovo ThinkPad ACPI Extras");
374 acpi_thinkpad_attach(device_t dev)
376 struct acpi_thinkpad_softc *sc;
377 struct acpi_softc *acpi_sc;
378 devclass_t ec_devclass;
381 ACPI_SERIAL_INIT(thinkpad);
382 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
384 sc = device_get_softc(dev);
386 sc->handle = acpi_get_handle(dev);
388 acpi_sc = acpi_device_get_parent_softc(dev);
390 /* Look for the first embedded controller */
391 if (!(ec_devclass = devclass_find ("acpi_ec"))) {
393 device_printf(dev, "Couldn't find acpi_ec devclass\n");
396 if (!(sc->ec_dev = devclass_get_device(ec_devclass, 0))) {
398 device_printf(dev, "Couldn't find acpi_ec device\n");
401 sc->ec_handle = acpi_get_handle(sc->ec_dev);
403 sysctl_ctx_init(&sc->sysctl_ctx);
404 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
405 SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree), OID_AUTO,
406 "thinkpad", CTLFLAG_RD, 0, "");
408 /* Look for event mask and hook up the nodes */
409 sc->events_mask_supported = ACPI_SUCCESS(acpi_GetInteger(sc->handle,
410 THINKPAD_NAME_EVENTS_MASK_GET, &sc->events_initialmask));
412 if (sc->events_mask_supported) {
413 SYSCTL_ADD_UINT(&sc->sysctl_ctx,
414 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
415 "initialmask", CTLFLAG_RD,
416 &sc->events_initialmask, 0, "Initial eventmask");
418 /* The availmask is the bitmask of supported events */
419 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
420 THINKPAD_NAME_EVENTS_AVAILMASK, &sc->events_availmask)))
421 sc->events_availmask = 0xffffffff;
423 SYSCTL_ADD_UINT(&sc->sysctl_ctx,
424 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
425 "availmask", CTLFLAG_RD,
426 &sc->events_availmask, 0, "Mask of supported events");
429 /* Hook up proc nodes */
430 for (i = 0; acpi_thinkpad_sysctls[i].name != NULL; i++) {
431 if (!acpi_thinkpad_sysctl_init(sc,
432 acpi_thinkpad_sysctls[i].method))
435 SYSCTL_ADD_PROC(&sc->sysctl_ctx,
436 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
437 acpi_thinkpad_sysctls[i].name,
438 acpi_thinkpad_sysctls[i].access,
439 sc, i, acpi_thinkpad_sysctl, "I",
440 acpi_thinkpad_sysctls[i].description);
443 /* Hook up handlerevents node */
444 if (acpi_thinkpad_sysctl_init(sc, ACPI_THINKPAD_METHOD_HANDLEREVENTS)) {
445 SYSCTL_ADD_PROC(&sc->sysctl_ctx,
446 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
447 "handlerevents", CTLTYPE_STRING | CTLFLAG_RW,
448 sc, 0, acpi_thinkpad_handlerevents_sysctl, "I",
449 "devd(8) events handled by acpi_thinkpad");
452 /* Handle notifies */
453 AcpiInstallNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
454 acpi_thinkpad_notify, dev);
456 /* Attach sensors(9). */
457 if (sensor_task_register(sc, acpi_thinkpad_refresh, 5)) {
458 device_printf(sc->dev, "unable to register update task\n");
462 strlcpy(sc->sensordev.xname, device_get_nameunit(sc->dev),
463 sizeof(sc->sensordev.xname));
465 for (i = 0; i < THINKPAD_TEMP_SENSORS; i++) {
466 sc->sensors[i].type = SENSOR_TEMP;
467 sensor_attach(&sc->sensordev, &sc->sensors[i]);
470 sc->sensors[i].type = SENSOR_FANRPM;
471 sensor_attach(&sc->sensordev, &sc->sensors[i]);
473 sensordev_install(&sc->sensordev);
475 /* Hook up light to led(4) */
476 if (sc->light_set_supported)
477 sc->led_dev = led_create_state(thinkpad_led, sc, "thinklight", sc->light_val);
483 acpi_thinkpad_detach(device_t dev)
487 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
489 struct acpi_thinkpad_softc *sc = device_get_softc(dev);
491 /* Disable events and restore eventmask */
492 ACPI_SERIAL_BEGIN(thinkpad);
493 acpi_thinkpad_sysctl_set(sc, ACPI_THINKPAD_METHOD_EVENTS, 0);
494 acpi_thinkpad_sysctl_set(sc, ACPI_THINKPAD_METHOD_EVENTMASK,
495 sc->events_initialmask);
496 ACPI_SERIAL_END(thinkpad);
498 AcpiRemoveNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
499 acpi_thinkpad_notify);
501 if (sc->sysctl_tree != NULL)
502 sysctl_ctx_free(&sc->sysctl_ctx);
504 sensordev_deinstall(&sc->sensordev);
505 for (i = 0; i < THINKPAD_NUM_SENSORS; i++)
506 sensor_detach(&sc->sensordev, &sc->sensors[i]);
507 sensor_task_unregister(sc);
509 if (sc->led_dev != NULL)
510 led_destroy(sc->led_dev);
516 acpi_thinkpad_resume(device_t dev)
518 struct acpi_thinkpad_softc *sc = device_get_softc(dev);
520 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
522 ACPI_SERIAL_BEGIN(thinkpad);
523 for (int i = 0; acpi_thinkpad_sysctls[i].name != NULL; i++) {
526 if ((acpi_thinkpad_sysctls[i].access & CTLFLAG_RD) == 0) {
530 val = acpi_thinkpad_sysctl_get(sc, i);
532 if ((acpi_thinkpad_sysctls[i].access & CTLFLAG_WR) == 0) {
536 acpi_thinkpad_sysctl_set(sc, i, val);
538 ACPI_SERIAL_END(thinkpad);
544 acpi_thinkpad_eventmask_set(struct acpi_thinkpad_softc *sc, int val)
548 ACPI_OBJECT_LIST args;
551 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
552 ACPI_SERIAL_ASSERT(thinkpad);
556 arg[0].Type = ACPI_TYPE_INTEGER;
557 arg[1].Type = ACPI_TYPE_INTEGER;
559 for (i = 0; i < 32; ++i) {
560 arg[0].Integer.Value = i+1;
561 arg[1].Integer.Value = (((1 << i) & val) != 0);
562 status = AcpiEvaluateObject(sc->handle,
563 THINKPAD_NAME_EVENTS_MASK_SET, &args, NULL);
565 if (ACPI_FAILURE(status))
573 acpi_thinkpad_sysctl(SYSCTL_HANDLER_ARGS)
575 struct acpi_thinkpad_softc *sc;
581 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
583 sc = (struct acpi_thinkpad_softc *)oidp->oid_arg1;
584 function = oidp->oid_arg2;
585 method = acpi_thinkpad_sysctls[function].method;
587 ACPI_SERIAL_BEGIN(thinkpad);
588 arg = acpi_thinkpad_sysctl_get(sc, method);
589 error = sysctl_handle_int(oidp, &arg, 0, req);
592 if (error != 0 || req->newptr == NULL)
596 error = acpi_thinkpad_sysctl_set(sc, method, arg);
599 ACPI_SERIAL_END(thinkpad);
604 acpi_thinkpad_sysctl_get(struct acpi_thinkpad_softc *sc, int method)
609 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
610 ACPI_SERIAL_ASSERT(thinkpad);
613 case ACPI_THINKPAD_METHOD_EVENTS:
614 acpi_GetInteger(sc->handle, THINKPAD_NAME_EVENTS_STATUS_GET,
618 case ACPI_THINKPAD_METHOD_EVENTMASK:
619 if (sc->events_mask_supported)
620 acpi_GetInteger(sc->handle,
621 THINKPAD_NAME_EVENTS_MASK_GET, &val);
624 case ACPI_THINKPAD_METHOD_HOTKEY:
626 * Construct the hotkey as a bitmask as illustrated below.
627 * Note that whenever a key was pressed, the respecting bit
628 * toggles and nothing else changes.
629 * +--+--+-+-+-+-+-+-+-+-+-+-+
630 * |11|10|9|8|7|6|5|4|3|2|1|0|
631 * +--+--+-+-+-+-+-+-+-+-+-+-+
632 * | | | | | | | | | | | |
633 * | | | | | | | | | | | +- Home Button
634 * | | | | | | | | | | +--- Search Button
635 * | | | | | | | | | +----- Mail Button
636 * | | | | | | | | +------- Thinkpad Button
637 * | | | | | | | +--------- Zoom (Fn + Space)
638 * | | | | | | +----------- WLAN Button
639 * | | | | | +------------- Video Button
640 * | | | | +--------------- Hibernate Button
641 * | | | +----------------- Thinklight Button
642 * | | +------------------- Screen expand (Fn + F8)
643 * | +--------------------- Brightness
644 * +------------------------ Volume/Mute
646 key = rtcin(THINKPAD_RTC_HOTKEY1);
647 val = (THINKPAD_RTC_MASK_HOME | THINKPAD_RTC_MASK_SEARCH |
648 THINKPAD_RTC_MASK_MAIL | THINKPAD_RTC_MASK_WLAN) & key;
649 key = rtcin(THINKPAD_RTC_HOTKEY2);
650 val |= (THINKPAD_RTC_MASK_THINKPAD | THINKPAD_RTC_MASK_VIDEO |
651 THINKPAD_RTC_MASK_HIBERNATE) & key;
652 val |= (THINKPAD_RTC_MASK_ZOOM & key) >> 1;
653 key = rtcin(THINKPAD_RTC_THINKLIGHT);
654 val |= (THINKPAD_RTC_MASK_THINKLIGHT & key) << 4;
655 key = rtcin(THINKPAD_RTC_SCREENEXPAND);
656 val |= (THINKPAD_RTC_MASK_THINKLIGHT & key) << 4;
657 key = rtcin(THINKPAD_RTC_BRIGHTNESS);
658 val |= (THINKPAD_RTC_MASK_BRIGHTNESS & key) << 5;
659 key = rtcin(THINKPAD_RTC_VOLUME);
660 val |= (THINKPAD_RTC_MASK_VOLUME & key) << 4;
663 case ACPI_THINKPAD_METHOD_BRIGHTNESS:
664 ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_BRIGHTNESS, &val_ec, 1);
665 val = val_ec & THINKPAD_EC_MASK_BRI;
668 case ACPI_THINKPAD_METHOD_VOLUME:
669 ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_VOLUME, &val_ec, 1);
670 val = val_ec & THINKPAD_EC_MASK_VOL;
673 case ACPI_THINKPAD_METHOD_MUTE:
674 ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_VOLUME, &val_ec, 1);
675 val = ((val_ec & THINKPAD_EC_MASK_MUTE) ==
676 THINKPAD_EC_MASK_MUTE);
679 case ACPI_THINKPAD_METHOD_THINKLIGHT:
680 if (sc->light_get_supported)
681 acpi_GetInteger(sc->ec_handle, THINKPAD_NAME_KEYLIGHT,
687 case ACPI_THINKPAD_METHOD_BLUETOOTH:
688 acpi_GetInteger(sc->handle, THINKPAD_NAME_WLAN_BT_GET, &val);
689 sc->wlan_bt_flags = val;
690 val = ((val & THINKPAD_NAME_MASK_BT) != 0);
693 case ACPI_THINKPAD_METHOD_WLAN:
694 acpi_GetInteger(sc->handle, THINKPAD_NAME_WLAN_BT_GET, &val);
695 sc->wlan_bt_flags = val;
696 val = ((val & THINKPAD_NAME_MASK_WLAN) != 0);
699 case ACPI_THINKPAD_METHOD_FANSPEED:
700 if (sc->fan_handle) {
701 if (ACPI_FAILURE(acpi_GetInteger(sc->fan_handle,
706 ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_FANSPEED,
712 case ACPI_THINKPAD_METHOD_FANLEVEL:
714 * The THINKPAD_EC_FANSTATUS register works as follows:
715 * Bit 0-5 indicate the level at which the fan operates. Only
716 * values between 0 and 7 have an effect. Everything
717 * above 7 is treated the same as level 7
718 * Bit 6 overrides the fan speed limit if set to 1
719 * Bit 7 indicates at which mode the fan operates:
720 * manual (0) or automatic (1)
722 if (!sc->fan_handle) {
723 ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_FANSTATUS,
725 val = val_ec & THINKPAD_EC_MASK_FANLEVEL;
729 case ACPI_THINKPAD_METHOD_FANSTATUS:
730 if (!sc->fan_handle) {
731 ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_FANSTATUS,
733 val = (val_ec & THINKPAD_EC_MASK_FANSTATUS) ==
734 THINKPAD_EC_MASK_FANSTATUS;
745 acpi_thinkpad_sysctl_set(struct acpi_thinkpad_softc *sc, int method, int arg)
751 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
752 ACPI_SERIAL_ASSERT(thinkpad);
755 case ACPI_THINKPAD_METHOD_EVENTS:
756 if (arg < 0 || arg > 1)
759 status = acpi_SetInteger(sc->handle,
760 THINKPAD_NAME_EVENTS_STATUS_SET, arg);
761 if (ACPI_FAILURE(status))
763 if (sc->events_mask_supported)
764 return acpi_thinkpad_eventmask_set(sc,
765 sc->events_availmask);
768 case ACPI_THINKPAD_METHOD_EVENTMASK:
769 if (sc->events_mask_supported)
770 return acpi_thinkpad_eventmask_set(sc, arg);
773 case ACPI_THINKPAD_METHOD_BRIGHTNESS:
774 return acpi_thinkpad_brightness_set(sc, arg);
777 case ACPI_THINKPAD_METHOD_VOLUME:
778 return acpi_thinkpad_volume_set(sc, arg);
781 case ACPI_THINKPAD_METHOD_MUTE:
782 return acpi_thinkpad_mute_set(sc, arg);
785 case ACPI_THINKPAD_METHOD_THINKLIGHT:
786 return acpi_thinkpad_thinklight_set(sc, arg);
789 case ACPI_THINKPAD_METHOD_BLUETOOTH:
790 return acpi_thinkpad_bluetooth_set(sc, arg);
793 case ACPI_THINKPAD_METHOD_FANLEVEL:
794 if (arg < 0 || arg > 7)
797 if (!sc->fan_handle) {
798 /* Read the current fanstatus */
799 ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_FANSTATUS,
801 val = val_ec & (~THINKPAD_EC_MASK_FANLEVEL);
803 return ACPI_EC_WRITE(sc->ec_dev, THINKPAD_EC_FANSTATUS,
808 case ACPI_THINKPAD_METHOD_FANSTATUS:
809 if (arg < 0 || arg > 1)
812 if (!sc->fan_handle) {
813 /* Read the current fanstatus */
814 ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_FANSTATUS,
817 return ACPI_EC_WRITE(sc->ec_dev, THINKPAD_EC_FANSTATUS,
818 (arg == 1) ? (val_ec | THINKPAD_EC_MASK_FANSTATUS) :
819 (val_ec & (~THINKPAD_EC_MASK_FANSTATUS)), 1);
828 acpi_thinkpad_sysctl_init(struct acpi_thinkpad_softc *sc, int method)
831 ACPI_OBJECT_TYPE cmos_t;
832 ACPI_HANDLE ledb_handle;
835 case ACPI_THINKPAD_METHOD_EVENTS:
836 /* Events are disabled by default */
839 case ACPI_THINKPAD_METHOD_EVENTMASK:
840 return (sc->events_mask_supported);
842 case ACPI_THINKPAD_METHOD_HOTKEY:
843 case ACPI_THINKPAD_METHOD_BRIGHTNESS:
844 case ACPI_THINKPAD_METHOD_VOLUME:
845 case ACPI_THINKPAD_METHOD_MUTE:
846 /* EC is required here, which was already checked before */
849 case ACPI_THINKPAD_METHOD_THINKLIGHT:
850 sc->cmos_handle = NULL;
851 sc->light_get_supported = ACPI_SUCCESS(acpi_GetInteger(
852 sc->ec_handle, THINKPAD_NAME_KEYLIGHT, &sc->light_val));
854 if ((ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\UCMS",
855 &sc->light_handle)) ||
856 ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\CMOS",
857 &sc->light_handle)) ||
858 ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\CMS",
859 &sc->light_handle))) &&
860 ACPI_SUCCESS(AcpiGetType(sc->light_handle, &cmos_t)) &&
861 cmos_t == ACPI_TYPE_METHOD) {
862 sc->light_cmd_on = 0x0c;
863 sc->light_cmd_off = 0x0d;
864 sc->cmos_handle = sc->light_handle;
866 else if (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\LGHT",
867 &sc->light_handle))) {
868 sc->light_cmd_on = 1;
869 sc->light_cmd_off = 0;
872 sc->light_handle = NULL;
874 sc->light_set_supported = (sc->light_handle &&
875 ACPI_FAILURE(AcpiGetHandle(sc->ec_handle, "LEDB",
878 if (sc->light_get_supported)
881 if (sc->light_set_supported) {
888 case ACPI_THINKPAD_METHOD_BLUETOOTH:
889 case ACPI_THINKPAD_METHOD_WLAN:
890 if (ACPI_SUCCESS(acpi_GetInteger(sc->handle,
891 THINKPAD_NAME_WLAN_BT_GET, &dummy)))
895 case ACPI_THINKPAD_METHOD_FANSPEED:
897 * Some models report the fan speed in levels from 0-7
898 * Newer models report it contiguously
900 sc->fan_levels = (ACPI_SUCCESS(AcpiGetHandle(sc->handle, "GFAN",
902 ACPI_SUCCESS(AcpiGetHandle(sc->handle, "\\FSPD",
906 case ACPI_THINKPAD_METHOD_FANLEVEL:
907 case ACPI_THINKPAD_METHOD_FANSTATUS:
909 * Fan status is only supported on those models,
910 * which report fan RPM contiguously, not in levels
916 case ACPI_THINKPAD_METHOD_THERMAL:
917 if (ACPI_SUCCESS(acpi_GetInteger(sc->ec_handle,
918 THINKPAD_NAME_THERMAL_GET, &dummy))) {
919 sc->thermal_updt_supported =
920 ACPI_SUCCESS(acpi_GetInteger(sc->ec_handle,
921 THINKPAD_NAME_THERMAL_UPDT, &dummy));
926 case ACPI_THINKPAD_METHOD_HANDLEREVENTS:
933 acpi_thinkpad_handlerevents_sysctl(SYSCTL_HANDLER_ARGS)
935 struct acpi_thinkpad_softc *sc;
940 unsigned int handler_events;
942 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
944 sc = (struct acpi_thinkpad_softc *)oidp->oid_arg1;
946 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
949 ACPI_SERIAL_BEGIN(thinkpad);
951 /* Get old values if this is a get request. */
952 if (req->newptr == NULL) {
953 for (int i = 0; i < 8 * sizeof(sc->handler_events); i++)
954 if (sc->handler_events & (1 << i))
955 sbuf_printf(&sb, "0x%02x ", i + 1);
956 if (sbuf_len(&sb) == 0)
957 sbuf_printf(&sb, "NONE");
963 /* Copy out the old values to the user. */
964 error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
967 if (error != 0 || req->newptr == NULL)
970 /* If the user is setting a string, parse it. */
972 cp = (char *)req->newptr;
981 while (*ep && !isspace(*ep))
988 if (strncmp(cp, "NONE", 4) == 0) {
993 if (l >= 3 && cp[0] == '0' && (cp[1] == 'X' || cp[1] == 'x'))
994 val = strtoul(cp, &ep, 16);
996 val = strtoul(cp, &ep, 10);
998 if (val == 0 || ep == cp || val >= 8 * sizeof(handler_events)) {
1000 device_printf(sc->dev, "invalid event code: %s\n", cp);
1005 handler_events |= 1 << (val - 1);
1010 sc->handler_events = handler_events;
1012 ACPI_SERIAL_END(thinkpad);
1017 acpi_thinkpad_brightness_set(struct acpi_thinkpad_softc *sc, int arg)
1022 ACPI_OBJECT_LIST Args;
1025 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1026 ACPI_SERIAL_ASSERT(thinkpad);
1028 if (arg < 0 || arg > 7)
1031 /* Read the current brightness */
1032 status = ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_BRIGHTNESS, &val_ec, 1);
1033 if (ACPI_FAILURE(status))
1036 if (sc->cmos_handle) {
1037 val = val_ec & THINKPAD_EC_MASK_BRI;
1040 Args.Pointer = &Arg;
1041 Arg.Type = ACPI_TYPE_INTEGER;
1042 Arg.Integer.Value = (arg > val) ? THINKPAD_CMOS_BRIGHTNESS_UP :
1043 THINKPAD_CMOS_BRIGHTNESS_DOWN;
1045 step = (arg > val) ? 1 : -1;
1046 for (int i = val; i != arg; i += step) {
1047 status = AcpiEvaluateObject(sc->cmos_handle, NULL,
1049 if (ACPI_FAILURE(status)) {
1050 /* Record the last value */
1052 ACPI_EC_WRITE(sc->ec_dev,
1053 THINKPAD_EC_BRIGHTNESS, i - step, 1);
1060 return ACPI_EC_WRITE(sc->ec_dev, THINKPAD_EC_BRIGHTNESS, arg, 1);
1064 acpi_thinkpad_bluetooth_set(struct acpi_thinkpad_softc *sc, int arg)
1068 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1069 ACPI_SERIAL_ASSERT(thinkpad);
1071 if (arg < 0 || arg > 1)
1074 val = (arg == 1) ? sc->wlan_bt_flags | THINKPAD_NAME_MASK_BT :
1075 sc->wlan_bt_flags & (~THINKPAD_NAME_MASK_BT);
1076 return acpi_SetInteger(sc->handle, THINKPAD_NAME_WLAN_BT_SET, val);
1080 acpi_thinkpad_thinklight_set(struct acpi_thinkpad_softc *sc, int arg)
1083 ACPI_OBJECT_LIST Args;
1086 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1087 ACPI_SERIAL_ASSERT(thinkpad);
1089 if (arg < 0 || arg > 1)
1092 if (sc->light_set_supported) {
1094 Args.Pointer = &Arg;
1095 Arg.Type = ACPI_TYPE_INTEGER;
1096 Arg.Integer.Value = arg ? sc->light_cmd_on : sc->light_cmd_off;
1098 status = AcpiEvaluateObject(sc->light_handle, NULL,
1100 if (ACPI_SUCCESS(status))
1101 sc->light_val = arg;
1109 acpi_thinkpad_volume_set(struct acpi_thinkpad_softc *sc, int arg)
1114 ACPI_OBJECT_LIST Args;
1117 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1118 ACPI_SERIAL_ASSERT(thinkpad);
1120 if (arg < 0 || arg > 14)
1123 /* Read the current volume */
1124 status = ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_VOLUME, &val_ec, 1);
1125 if (ACPI_FAILURE(status))
1128 if (sc->cmos_handle) {
1129 val = val_ec & THINKPAD_EC_MASK_VOL;
1132 Args.Pointer = &Arg;
1133 Arg.Type = ACPI_TYPE_INTEGER;
1134 Arg.Integer.Value = (arg > val) ? THINKPAD_CMOS_VOLUME_UP :
1135 THINKPAD_CMOS_VOLUME_DOWN;
1137 step = (arg > val) ? 1 : -1;
1138 for (int i = val; i != arg; i += step) {
1139 status = AcpiEvaluateObject(sc->cmos_handle, NULL,
1141 if (ACPI_FAILURE(status)) {
1142 /* Record the last value */
1145 (val_ec & (~THINKPAD_EC_MASK_VOL));
1146 ACPI_EC_WRITE(sc->ec_dev, THINKPAD_EC_VOLUME,
1154 val_ec = arg + (val_ec & (~THINKPAD_EC_MASK_VOL));
1155 return ACPI_EC_WRITE(sc->ec_dev, THINKPAD_EC_VOLUME, val_ec, 1);
1159 acpi_thinkpad_mute_set(struct acpi_thinkpad_softc *sc, int arg)
1163 ACPI_OBJECT_LIST Args;
1166 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1167 ACPI_SERIAL_ASSERT(thinkpad);
1169 if (arg < 0 || arg > 1)
1172 status = ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_VOLUME, &val_ec, 1);
1173 if (ACPI_FAILURE(status))
1176 if (sc->cmos_handle) {
1178 Args.Pointer = &Arg;
1179 Arg.Type = ACPI_TYPE_INTEGER;
1180 Arg.Integer.Value = THINKPAD_CMOS_VOLUME_MUTE;
1182 status = AcpiEvaluateObject(sc->cmos_handle, NULL, &Args, NULL);
1183 if (ACPI_FAILURE(status))
1187 val_ec = (arg == 1) ? val_ec | THINKPAD_EC_MASK_MUTE :
1188 val_ec & (~THINKPAD_EC_MASK_MUTE);
1189 return ACPI_EC_WRITE(sc->ec_dev, THINKPAD_EC_VOLUME, val_ec, 1);
1193 acpi_thinkpad_eventhandler(struct acpi_thinkpad_softc *sc, int arg)
1199 ACPI_SERIAL_BEGIN(thinkpad);
1202 case THINKPAD_EVENT_SUSPEND_TO_RAM:
1203 power_pm_suspend(POWER_SLEEP_STATE_SUSPEND);
1207 case THINKPAD_EVENT_BLUETOOTH:
1208 acpi_thinkpad_bluetooth_set(sc, (sc->wlan_bt_flags == 0));
1211 case THINKPAD_EVENT_BRIGHTNESS_UP:
1212 case THINKPAD_EVENT_BRIGHTNESS_DOWN:
1213 /* Read the current brightness */
1214 status = ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_BRIGHTNESS,
1216 if (ACPI_FAILURE(status))
1219 val = val_ec & THINKPAD_EC_MASK_BRI;
1220 val = (arg == THINKPAD_EVENT_BRIGHTNESS_UP) ? val + 1 : val - 1;
1221 acpi_thinkpad_brightness_set(sc, val);
1224 case THINKPAD_EVENT_THINKLIGHT:
1225 acpi_thinkpad_thinklight_set(sc, (sc->light_val == 0));
1228 case THINKPAD_EVENT_VOLUME_UP:
1229 case THINKPAD_EVENT_VOLUME_DOWN:
1230 /* Read the current volume */
1231 status = ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_VOLUME, &val_ec, 1);
1232 if (ACPI_FAILURE(status))
1235 val = val_ec & THINKPAD_EC_MASK_VOL;
1236 val = (arg == THINKPAD_EVENT_VOLUME_UP) ? val + 1 : val - 1;
1237 acpi_thinkpad_volume_set(sc, val);
1240 case THINKPAD_EVENT_MUTE:
1241 /* Read the current value */
1242 status = ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_VOLUME, &val_ec, 1);
1243 if (ACPI_FAILURE(status))
1246 val = ((val_ec & THINKPAD_EC_MASK_MUTE) == THINKPAD_EC_MASK_MUTE);
1247 acpi_thinkpad_mute_set(sc, (val == 0));
1254 ACPI_SERIAL_END(thinkpad);
1258 acpi_thinkpad_notify(ACPI_HANDLE h, UINT32 notify, void *context)
1260 int event, arg, type;
1261 device_t dev = context;
1262 struct acpi_thinkpad_softc *sc = device_get_softc(dev);
1264 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
1267 device_printf(dev, "Unknown notify\n");
1270 acpi_GetInteger(acpi_get_handle(dev), THINKPAD_NAME_EVENTS_GET,
1276 type = (event >> 12) & 0xf;
1277 arg = event & 0xfff;
1280 if (!(sc->events_availmask & (1 << (arg - 1)))) {
1281 device_printf(dev, "Unknown key %d\n", arg);
1285 /* Execute event handler */
1286 if (sc->handler_events & (1 << (arg - 1)))
1287 acpi_thinkpad_eventhandler(sc, (arg & 0xff));
1289 /* Notify devd(8) */
1290 acpi_UserNotify("THINKPAD", h, (arg & 0xff));
1299 acpi_thinkpad_refresh(void *arg)
1301 struct acpi_thinkpad_softc *sc = (struct acpi_thinkpad_softc *)arg;
1304 for (i = 0; i < THINKPAD_TEMP_SENSORS; i++) {
1305 char temp_cmd[] = "TMP0";
1307 temp_cmd[3] = '0' + i;
1309 * The TMPx methods seem to return +/- 128 or 0
1310 * when the respecting sensor is not available
1312 if (ACPI_FAILURE(acpi_GetInteger(sc->ec_handle, temp_cmd,
1313 &data)) || ABS(data) == 128 || data == 0) {
1314 sc->sensors[i].flags |= SENSOR_FINVALID;
1317 if (sc->thermal_updt_supported)
1318 /* Temperature is reported in tenth of Kelvin */
1319 sc->sensors[i].value = data * 100000 - 50000;
1321 sc->sensors[i].value = data * 1000000 + 273150000;
1322 sc->sensors[i].flags &= ~SENSOR_FINVALID;
1325 if (sc->fan_handle) {
1326 if (ACPI_FAILURE(acpi_GetInteger(sc->fan_handle,
1328 sc->sensors[i].flags |= SENSOR_FINVALID;
1329 sc->sensors[i].value = data;
1330 sc->sensors[i].flags &= ~SENSOR_FINVALID;
1334 ACPI_EC_READ(sc->ec_dev, THINKPAD_EC_FANSPEED, &speed, 2);
1335 sc->sensors[i].value = speed;
1336 sc->sensors[i].flags &= ~SENSOR_FINVALID;