2 * thinkpad_acpi.c - ThinkPad ACPI Extras
5 * Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6 * Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
26 #define TPACPI_VERSION "0.26"
27 #define TPACPI_SYSFS_VERSION 0x030000
31 * 2007-10-20 changelog trimmed down
33 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
36 * 2006-11-22 0.13 new maintainer
37 * changelog now lives in git commit history, and will
38 * not be updated further in-file.
40 * 2005-03-17 0.11 support for 600e, 770x
41 * thanks to Jamie Lentin <lentinj@dial.pipex.com>
43 * 2005-01-16 0.9 use MODULE_VERSION
44 * thanks to Henrik Brix Andersen <brix@gentoo.org>
45 * fix parameter passing on module loading
46 * thanks to Rusty Russell <rusty@rustcorp.com.au>
47 * thanks to Jim Radford <radford@blackbean.org>
48 * 2004-11-08 0.8 fix init error case, don't return from a macro
49 * thanks to Chris Wright <chrisw@osdl.org>
52 #include <linux/kernel.h>
53 #include <linux/module.h>
54 #include <linux/init.h>
55 #include <linux/types.h>
56 #include <linux/string.h>
57 #include <linux/list.h>
58 #include <linux/mutex.h>
59 #include <linux/sched.h>
60 #include <linux/kthread.h>
61 #include <linux/freezer.h>
62 #include <linux/delay.h>
63 #include <linux/slab.h>
64 #include <linux/nvram.h>
65 #include <linux/proc_fs.h>
66 #include <linux/seq_file.h>
67 #include <linux/sysfs.h>
68 #include <linux/backlight.h>
69 #include <linux/bitops.h>
71 #include <linux/platform_device.h>
72 #include <linux/hwmon.h>
73 #include <linux/hwmon-sysfs.h>
74 #include <linux/input.h>
75 #include <linux/leds.h>
76 #include <linux/rfkill.h>
77 #include <linux/dmi.h>
78 #include <linux/jiffies.h>
79 #include <linux/workqueue.h>
80 #include <linux/acpi.h>
81 #include <linux/pci_ids.h>
82 #include <linux/power_supply.h>
83 #include <linux/thinkpad_acpi.h>
84 #include <sound/core.h>
85 #include <sound/control.h>
86 #include <sound/initval.h>
87 #include <linux/uaccess.h>
88 #include <acpi/battery.h>
89 #include <acpi/video.h>
91 /* ThinkPad CMOS commands */
92 #define TP_CMOS_VOLUME_DOWN 0
93 #define TP_CMOS_VOLUME_UP 1
94 #define TP_CMOS_VOLUME_MUTE 2
95 #define TP_CMOS_BRIGHTNESS_UP 4
96 #define TP_CMOS_BRIGHTNESS_DOWN 5
97 #define TP_CMOS_THINKLIGHT_ON 12
98 #define TP_CMOS_THINKLIGHT_OFF 13
100 /* NVRAM Addresses */
102 TP_NVRAM_ADDR_HK2 = 0x57,
103 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
104 TP_NVRAM_ADDR_VIDEO = 0x59,
105 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
106 TP_NVRAM_ADDR_MIXER = 0x60,
109 /* NVRAM bit masks */
111 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
112 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
113 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
114 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
115 TP_NVRAM_MASK_THINKLIGHT = 0x10,
116 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
117 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
118 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
119 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
120 TP_NVRAM_MASK_MUTE = 0x40,
121 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
122 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
123 TP_NVRAM_POS_LEVEL_VOLUME = 0,
126 /* Misc NVRAM-related */
128 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
132 #define TPACPI_ACPI_IBM_HKEY_HID "IBM0068"
133 #define TPACPI_ACPI_LENOVO_HKEY_HID "LEN0068"
134 #define TPACPI_ACPI_LENOVO_HKEY_V2_HID "LEN0268"
135 #define TPACPI_ACPI_EC_HID "PNP0C09"
138 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
139 #define TPACPI_HKEY_INPUT_VERSION 0x4101
141 /* ACPI \WGSV commands */
143 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
144 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
145 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
146 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
149 /* TP_ACPI_WGSV_GET_STATE bits */
151 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
152 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
153 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
154 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
155 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
156 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
157 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
158 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
159 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
160 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
164 enum tpacpi_hkey_event_t {
166 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
167 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
168 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
169 TP_HKEY_EV_KBD_LIGHT = 0x1012, /* Thinklight/kbd backlight */
170 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
171 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
172 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
174 /* Reasons for waking up from S3/S4 */
175 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
176 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
177 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
178 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
179 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
180 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
182 /* Auto-sleep after eject request */
183 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
184 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
186 /* Misc bay events */
187 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
188 TP_HKEY_EV_HOTPLUG_DOCK = 0x4010, /* docked into hotplug dock
189 or port replicator */
190 TP_HKEY_EV_HOTPLUG_UNDOCK = 0x4011, /* undocked from hotplug
191 dock or port replicator */
193 /* User-interface events */
194 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
195 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
196 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
197 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
198 TP_HKEY_EV_TABLET_CHANGED = 0x60c0, /* X1 Yoga (2016):
199 * enter/leave tablet mode
201 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
202 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
203 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
205 /* Key-related user-interface events */
206 TP_HKEY_EV_KEY_NUMLOCK = 0x6000, /* NumLock key pressed */
207 TP_HKEY_EV_KEY_FN = 0x6005, /* Fn key pressed? E420 */
208 TP_HKEY_EV_KEY_FN_ESC = 0x6060, /* Fn+Esc key pressed X240 */
211 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
212 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
213 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
214 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
215 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* thermal table changed */
217 /* AC-related events */
218 TP_HKEY_EV_AC_CHANGED = 0x6040, /* AC status changed */
220 /* Further user-interface events */
221 TP_HKEY_EV_PALM_DETECTED = 0x60b0, /* palm hoveres keyboard */
222 TP_HKEY_EV_PALM_UNDETECTED = 0x60b1, /* palm removed */
225 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
228 /****************************************************************************
232 #define TPACPI_NAME "thinkpad"
233 #define TPACPI_DESC "ThinkPad ACPI Extras"
234 #define TPACPI_FILE TPACPI_NAME "_acpi"
235 #define TPACPI_URL "http://ibm-acpi.sf.net/"
236 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
238 #define TPACPI_PROC_DIR "ibm"
239 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
240 #define TPACPI_DRVR_NAME TPACPI_FILE
241 #define TPACPI_DRVR_SHORTNAME "tpacpi"
242 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
244 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
245 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
247 #define TPACPI_MAX_ACPI_ARGS 3
249 /* Debugging printk groups */
250 #define TPACPI_DBG_ALL 0xffff
251 #define TPACPI_DBG_DISCLOSETASK 0x8000
252 #define TPACPI_DBG_INIT 0x0001
253 #define TPACPI_DBG_EXIT 0x0002
254 #define TPACPI_DBG_RFKILL 0x0004
255 #define TPACPI_DBG_HKEY 0x0008
256 #define TPACPI_DBG_FAN 0x0010
257 #define TPACPI_DBG_BRGHT 0x0020
258 #define TPACPI_DBG_MIXER 0x0040
260 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
261 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
262 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
265 /****************************************************************************
266 * Driver-wide structs and misc. variables
271 struct tp_acpi_drv_struct {
272 const struct acpi_device_id *hid;
273 struct acpi_driver *driver;
275 void (*notify) (struct ibm_struct *, u32);
278 struct acpi_device *device;
284 int (*read) (struct seq_file *);
285 int (*write) (char *);
287 void (*resume) (void);
288 void (*suspend) (void);
289 void (*shutdown) (void);
291 struct list_head all_drivers;
293 struct tp_acpi_drv_struct *acpi;
296 u8 acpi_driver_registered:1;
297 u8 acpi_notify_installed:1;
304 struct ibm_init_struct {
307 int (*init) (struct ibm_init_struct *);
308 umode_t base_procfs_mode;
309 struct ibm_struct *data;
318 TP_HOTKEY_TABLET_NONE = 0,
319 TP_HOTKEY_TABLET_USES_MHKG,
320 TP_HOTKEY_TABLET_USES_GMMS,
325 u32 bright_acpimode:1;
329 u32 fan_ctrl_status_undef:1;
331 u32 beep_needs_two_args:1;
332 u32 mixer_no_level_control:1;
333 u32 input_device_registered:1;
334 u32 platform_drv_registered:1;
335 u32 platform_drv_attrs_registered:1;
336 u32 sensors_pdrv_registered:1;
337 u32 sensors_pdrv_attrs_registered:1;
338 u32 sensors_pdev_attrs_registered:1;
339 u32 hotkey_poll_active:1;
340 u32 has_adaptive_kbd:1;
345 u16 hotkey_mask_ff:1;
346 u16 volume_ctrl_forbidden:1;
349 struct thinkpad_id_data {
350 unsigned int vendor; /* ThinkPad vendor:
351 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
353 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
354 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
356 u16 bios_model; /* 1Y = 0x5931, 0 = unknown */
358 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
361 char *model_str; /* ThinkPad T43 */
362 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
364 static struct thinkpad_id_data thinkpad_id;
367 TPACPI_LIFE_INIT = 0,
372 static int experimental;
373 static u32 dbg_level;
375 static struct workqueue_struct *tpacpi_wq;
383 /* tpacpi LED class */
384 struct tpacpi_led_classdev {
385 struct led_classdev led_classdev;
389 /* brightness level capabilities */
390 static unsigned int bright_maxlvl; /* 0 = unknown */
392 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
393 static int dbg_wlswemul;
394 static bool tpacpi_wlsw_emulstate;
395 static int dbg_bluetoothemul;
396 static bool tpacpi_bluetooth_emulstate;
397 static int dbg_wwanemul;
398 static bool tpacpi_wwan_emulstate;
399 static int dbg_uwbemul;
400 static bool tpacpi_uwb_emulstate;
404 /*************************************************************************
408 #define dbg_printk(a_dbg_level, format, arg...) \
410 if (dbg_level & (a_dbg_level)) \
411 printk(KERN_DEBUG pr_fmt("%s: " format), \
415 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
416 #define vdbg_printk dbg_printk
417 static const char *str_supported(int is_supported);
419 static inline const char *str_supported(int is_supported) { return ""; }
420 #define vdbg_printk(a_dbg_level, format, arg...) \
421 do { if (0) no_printk(format, ##arg); } while (0)
424 static void tpacpi_log_usertask(const char * const what)
426 printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
427 what, task_tgid_vnr(current));
430 #define tpacpi_disclose_usertask(what, format, arg...) \
432 if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) && \
433 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
434 printk(KERN_DEBUG pr_fmt("%s: PID %d: " format), \
435 what, task_tgid_vnr(current), ## arg); \
440 * Quirk handling helpers
442 * ThinkPad IDs and versions seen in the field so far
443 * are two-characters from the set [0-9A-Z], i.e. base 36.
445 * We use values well outside that range as specials.
448 #define TPACPI_MATCH_ANY 0xffffU
449 #define TPACPI_MATCH_UNKNOWN 0U
451 /* TPID('1', 'Y') == 0x5931 */
452 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
454 #define TPACPI_Q_IBM(__id1, __id2, __quirk) \
455 { .vendor = PCI_VENDOR_ID_IBM, \
456 .bios = TPID(__id1, __id2), \
457 .ec = TPACPI_MATCH_ANY, \
458 .quirks = (__quirk) }
460 #define TPACPI_Q_LNV(__id1, __id2, __quirk) \
461 { .vendor = PCI_VENDOR_ID_LENOVO, \
462 .bios = TPID(__id1, __id2), \
463 .ec = TPACPI_MATCH_ANY, \
464 .quirks = (__quirk) }
466 #define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
467 { .vendor = PCI_VENDOR_ID_LENOVO, \
468 .bios = TPACPI_MATCH_ANY, \
469 .ec = TPID(__id1, __id2), \
470 .quirks = (__quirk) }
472 struct tpacpi_quirk {
476 unsigned long quirks;
480 * tpacpi_check_quirks() - search BIOS/EC version on a list
481 * @qlist: array of &struct tpacpi_quirk
482 * @qlist_size: number of elements in @qlist
484 * Iterates over a quirks list until one is found that matches the
485 * ThinkPad's vendor, BIOS and EC model.
487 * Returns 0 if nothing matches, otherwise returns the quirks field of
488 * the matching &struct tpacpi_quirk entry.
490 * The match criteria is: vendor, ec and bios much match.
492 static unsigned long __init tpacpi_check_quirks(
493 const struct tpacpi_quirk *qlist,
494 unsigned int qlist_size)
497 if ((qlist->vendor == thinkpad_id.vendor ||
498 qlist->vendor == TPACPI_MATCH_ANY) &&
499 (qlist->bios == thinkpad_id.bios_model ||
500 qlist->bios == TPACPI_MATCH_ANY) &&
501 (qlist->ec == thinkpad_id.ec_model ||
502 qlist->ec == TPACPI_MATCH_ANY))
503 return qlist->quirks;
511 static inline bool __pure __init tpacpi_is_lenovo(void)
513 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
516 static inline bool __pure __init tpacpi_is_ibm(void)
518 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
521 /****************************************************************************
522 ****************************************************************************
524 * ACPI Helpers and device model
526 ****************************************************************************
527 ****************************************************************************/
529 /*************************************************************************
533 static acpi_handle root_handle;
534 static acpi_handle ec_handle;
536 #define TPACPI_HANDLE(object, parent, paths...) \
537 static acpi_handle object##_handle; \
538 static const acpi_handle * const object##_parent __initconst = \
540 static char *object##_paths[] __initdata = { paths }
542 TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
543 TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
545 TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
547 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
548 "\\CMS", /* R40, R40e */
551 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
552 "^HKEY", /* R30, R31 */
553 "HKEY", /* all others */
556 /*************************************************************************
560 static int acpi_evalf(acpi_handle handle,
561 int *res, char *method, char *fmt, ...)
564 struct acpi_object_list params;
565 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
566 struct acpi_buffer result, *resultp;
567 union acpi_object out_obj;
575 pr_err("acpi_evalf() called with empty format\n");
588 params.pointer = &in_objs[0];
595 in_objs[params.count].integer.value = va_arg(ap, int);
596 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
598 /* add more types as needed */
600 pr_err("acpi_evalf() called with invalid format character '%c'\n",
608 if (res_type != 'v') {
609 result.length = sizeof(out_obj);
610 result.pointer = &out_obj;
615 status = acpi_evaluate_object(handle, method, ¶ms, resultp);
619 success = (status == AE_OK &&
620 out_obj.type == ACPI_TYPE_INTEGER);
622 *res = out_obj.integer.value;
625 success = status == AE_OK;
627 /* add more types as needed */
629 pr_err("acpi_evalf() called with invalid format character '%c'\n",
634 if (!success && !quiet)
635 pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
636 method, fmt0, acpi_format_exception(status));
641 static int acpi_ec_read(int i, u8 *p)
646 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
650 if (ec_read(i, p) < 0)
657 static int acpi_ec_write(int i, u8 v)
660 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
663 if (ec_write(i, v) < 0)
670 static int issue_thinkpad_cmos_command(int cmos_cmd)
675 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
681 /*************************************************************************
685 #define TPACPI_ACPIHANDLE_INIT(object) \
686 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
687 object##_paths, ARRAY_SIZE(object##_paths))
689 static void __init drv_acpi_handle_init(const char *name,
690 acpi_handle *handle, const acpi_handle parent,
691 char **paths, const int num_paths)
696 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
699 for (i = 0; i < num_paths; i++) {
700 status = acpi_get_handle(parent, paths[i], handle);
701 if (ACPI_SUCCESS(status)) {
702 dbg_printk(TPACPI_DBG_INIT,
703 "Found ACPI handle %s for %s\n",
709 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
714 static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
715 u32 level, void *context, void **return_value)
717 struct acpi_device *dev;
718 if (!strcmp(context, "video")) {
719 if (acpi_bus_get_device(handle, &dev))
721 if (strcmp(ACPI_VIDEO_HID, acpi_device_hid(dev)))
725 *(acpi_handle *)return_value = handle;
727 return AE_CTRL_TERMINATE;
730 static void __init tpacpi_acpi_handle_locate(const char *name,
735 acpi_handle device_found;
737 BUG_ON(!name || !handle);
738 vdbg_printk(TPACPI_DBG_INIT,
739 "trying to locate ACPI handle for %s, using HID %s\n",
740 name, hid ? hid : "NULL");
742 memset(&device_found, 0, sizeof(device_found));
743 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
744 (void *)name, &device_found);
748 if (ACPI_SUCCESS(status)) {
749 *handle = device_found;
750 dbg_printk(TPACPI_DBG_INIT,
751 "Found ACPI handle for %s\n", name);
753 vdbg_printk(TPACPI_DBG_INIT,
754 "Could not locate an ACPI handle for %s: %s\n",
755 name, acpi_format_exception(status));
759 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
761 struct ibm_struct *ibm = data;
763 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
766 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
769 ibm->acpi->notify(ibm, event);
772 static int __init setup_acpi_notify(struct ibm_struct *ibm)
779 if (!*ibm->acpi->handle)
782 vdbg_printk(TPACPI_DBG_INIT,
783 "setting up ACPI notify for %s\n", ibm->name);
785 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
787 pr_err("acpi_bus_get_device(%s) failed: %d\n", ibm->name, rc);
791 ibm->acpi->device->driver_data = ibm;
792 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
793 TPACPI_ACPI_EVENT_PREFIX,
796 status = acpi_install_notify_handler(*ibm->acpi->handle,
797 ibm->acpi->type, dispatch_acpi_notify, ibm);
798 if (ACPI_FAILURE(status)) {
799 if (status == AE_ALREADY_EXISTS) {
800 pr_notice("another device driver is already handling %s events\n",
803 pr_err("acpi_install_notify_handler(%s) failed: %s\n",
804 ibm->name, acpi_format_exception(status));
808 ibm->flags.acpi_notify_installed = 1;
812 static int __init tpacpi_device_add(struct acpi_device *device)
817 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
821 dbg_printk(TPACPI_DBG_INIT,
822 "registering %s as an ACPI driver\n", ibm->name);
826 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
827 if (!ibm->acpi->driver) {
828 pr_err("failed to allocate memory for ibm->acpi->driver\n");
832 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
833 ibm->acpi->driver->ids = ibm->acpi->hid;
835 ibm->acpi->driver->ops.add = &tpacpi_device_add;
837 rc = acpi_bus_register_driver(ibm->acpi->driver);
839 pr_err("acpi_bus_register_driver(%s) failed: %d\n",
841 kfree(ibm->acpi->driver);
842 ibm->acpi->driver = NULL;
844 ibm->flags.acpi_driver_registered = 1;
850 /****************************************************************************
851 ****************************************************************************
855 ****************************************************************************
856 ****************************************************************************/
858 static int dispatch_proc_show(struct seq_file *m, void *v)
860 struct ibm_struct *ibm = m->private;
862 if (!ibm || !ibm->read)
867 static int dispatch_proc_open(struct inode *inode, struct file *file)
869 return single_open(file, dispatch_proc_show, PDE_DATA(inode));
872 static ssize_t dispatch_proc_write(struct file *file,
873 const char __user *userbuf,
874 size_t count, loff_t *pos)
876 struct ibm_struct *ibm = PDE_DATA(file_inode(file));
880 if (!ibm || !ibm->write)
882 if (count > PAGE_SIZE - 2)
885 kernbuf = kmalloc(count + 2, GFP_KERNEL);
889 if (copy_from_user(kernbuf, userbuf, count)) {
895 strcat(kernbuf, ",");
896 ret = ibm->write(kernbuf);
905 static const struct file_operations dispatch_proc_fops = {
906 .owner = THIS_MODULE,
907 .open = dispatch_proc_open,
910 .release = single_release,
911 .write = dispatch_proc_write,
914 static char *next_cmd(char **cmds)
919 while ((end = strchr(start, ',')) && end == start)
931 /****************************************************************************
932 ****************************************************************************
934 * Device model: input, hwmon and platform
936 ****************************************************************************
937 ****************************************************************************/
939 static struct platform_device *tpacpi_pdev;
940 static struct platform_device *tpacpi_sensors_pdev;
941 static struct device *tpacpi_hwmon;
942 static struct input_dev *tpacpi_inputdev;
943 static struct mutex tpacpi_inputdev_send_mutex;
944 static LIST_HEAD(tpacpi_all_drivers);
946 #ifdef CONFIG_PM_SLEEP
947 static int tpacpi_suspend_handler(struct device *dev)
949 struct ibm_struct *ibm, *itmp;
951 list_for_each_entry_safe(ibm, itmp,
961 static int tpacpi_resume_handler(struct device *dev)
963 struct ibm_struct *ibm, *itmp;
965 list_for_each_entry_safe(ibm, itmp,
976 static SIMPLE_DEV_PM_OPS(tpacpi_pm,
977 tpacpi_suspend_handler, tpacpi_resume_handler);
979 static void tpacpi_shutdown_handler(struct platform_device *pdev)
981 struct ibm_struct *ibm, *itmp;
983 list_for_each_entry_safe(ibm, itmp,
991 static struct platform_driver tpacpi_pdriver = {
993 .name = TPACPI_DRVR_NAME,
996 .shutdown = tpacpi_shutdown_handler,
999 static struct platform_driver tpacpi_hwmon_pdriver = {
1001 .name = TPACPI_HWMON_DRVR_NAME,
1005 /*************************************************************************
1006 * sysfs support helpers
1009 struct attribute_set {
1010 unsigned int members, max_members;
1011 struct attribute_group group;
1014 struct attribute_set_obj {
1015 struct attribute_set s;
1016 struct attribute *a;
1017 } __attribute__((packed));
1019 static struct attribute_set *create_attr_set(unsigned int max_members,
1022 struct attribute_set_obj *sobj;
1024 if (max_members == 0)
1027 /* Allocates space for implicit NULL at the end too */
1028 sobj = kzalloc(sizeof(struct attribute_set_obj) +
1029 max_members * sizeof(struct attribute *),
1033 sobj->s.max_members = max_members;
1034 sobj->s.group.attrs = &sobj->a;
1035 sobj->s.group.name = name;
1040 #define destroy_attr_set(_set) \
1043 /* not multi-threaded safe, use it in a single thread per set */
1044 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1049 if (s->members >= s->max_members)
1052 s->group.attrs[s->members] = attr;
1058 static int add_many_to_attr_set(struct attribute_set *s,
1059 struct attribute **attr,
1064 for (i = 0; i < count; i++) {
1065 res = add_to_attr_set(s, attr[i]);
1073 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1075 sysfs_remove_group(kobj, &s->group);
1076 destroy_attr_set(s);
1079 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1080 sysfs_create_group(_kobj, &_attr_set->group)
1082 static int parse_strtoul(const char *buf,
1083 unsigned long max, unsigned long *value)
1087 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1088 endp = skip_spaces(endp);
1089 if (*endp || *value > max)
1095 static void tpacpi_disable_brightness_delay(void)
1097 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1098 pr_notice("ACPI backlight control delay disabled\n");
1101 static void printk_deprecated_attribute(const char * const what,
1102 const char * const details)
1104 tpacpi_log_usertask("deprecated sysfs attribute");
1105 pr_warn("WARNING: sysfs attribute %s is deprecated and will be removed. %s\n",
1109 /*************************************************************************
1110 * rfkill and radio control support helpers
1114 * ThinkPad-ACPI firmware handling model:
1116 * WLSW (master wireless switch) is event-driven, and is common to all
1117 * firmware-controlled radios. It cannot be controlled, just monitored,
1118 * as expected. It overrides all radio state in firmware
1120 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1121 * (TODO: verify how WLSW interacts with the returned radio state).
1123 * The only time there are shadow radio state changes, is when
1124 * masked-off hotkeys are used.
1128 * Internal driver API for radio state:
1130 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1131 * bool: true means radio blocked (off)
1133 enum tpacpi_rfkill_state {
1134 TPACPI_RFK_RADIO_OFF = 0,
1138 /* rfkill switches */
1139 enum tpacpi_rfk_id {
1140 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1141 TPACPI_RFK_WWAN_SW_ID,
1142 TPACPI_RFK_UWB_SW_ID,
1146 static const char *tpacpi_rfkill_names[] = {
1147 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1148 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1149 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1150 [TPACPI_RFK_SW_MAX] = NULL
1153 /* ThinkPad-ACPI rfkill subdriver */
1155 struct rfkill *rfkill;
1156 enum tpacpi_rfk_id id;
1157 const struct tpacpi_rfk_ops *ops;
1160 struct tpacpi_rfk_ops {
1161 /* firmware interface */
1162 int (*get_status)(void);
1163 int (*set_status)(const enum tpacpi_rfkill_state);
1166 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1168 /* Query FW and update rfkill sw state for a given rfkill switch */
1169 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1176 status = (tp_rfk->ops->get_status)();
1180 rfkill_set_sw_state(tp_rfk->rfkill,
1181 (status == TPACPI_RFK_RADIO_OFF));
1186 /* Query FW and update rfkill sw state for all rfkill switches */
1187 static void tpacpi_rfk_update_swstate_all(void)
1191 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1192 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1196 * Sync the HW-blocking state of all rfkill switches,
1197 * do notice it causes the rfkill core to schedule uevents
1199 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1202 struct tpacpi_rfk *tp_rfk;
1204 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1205 tp_rfk = tpacpi_rfkill_switches[i];
1207 if (rfkill_set_hw_state(tp_rfk->rfkill,
1209 /* ignore -- we track sw block */
1215 /* Call to get the WLSW state from the firmware */
1216 static int hotkey_get_wlsw(void);
1218 /* Call to query WLSW state and update all rfkill switches */
1219 static bool tpacpi_rfk_check_hwblock_state(void)
1221 int res = hotkey_get_wlsw();
1224 /* When unknown or unsupported, we have to assume it is unblocked */
1228 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1229 tpacpi_rfk_update_hwblock_state(hw_blocked);
1234 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1236 struct tpacpi_rfk *tp_rfk = data;
1239 dbg_printk(TPACPI_DBG_RFKILL,
1240 "request to change radio state to %s\n",
1241 blocked ? "blocked" : "unblocked");
1243 /* try to set radio state */
1244 res = (tp_rfk->ops->set_status)(blocked ?
1245 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1247 /* and update the rfkill core with whatever the FW really did */
1248 tpacpi_rfk_update_swstate(tp_rfk);
1250 return (res < 0) ? res : 0;
1253 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1254 .set_block = tpacpi_rfk_hook_set_block,
1257 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1258 const struct tpacpi_rfk_ops *tp_rfkops,
1259 const enum rfkill_type rfktype,
1261 const bool set_default)
1263 struct tpacpi_rfk *atp_rfk;
1265 bool sw_state = false;
1269 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1271 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1273 atp_rfk->rfkill = rfkill_alloc(name,
1276 &tpacpi_rfk_rfkill_ops,
1278 if (!atp_rfk || !atp_rfk->rfkill) {
1279 pr_err("failed to allocate memory for rfkill class\n");
1285 atp_rfk->ops = tp_rfkops;
1287 sw_status = (tp_rfkops->get_status)();
1288 if (sw_status < 0) {
1289 pr_err("failed to read initial state for %s, error %d\n",
1292 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1294 /* try to keep the initial state, since we ask the
1295 * firmware to preserve it across S5 in NVRAM */
1296 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1299 hw_state = tpacpi_rfk_check_hwblock_state();
1300 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1302 res = rfkill_register(atp_rfk->rfkill);
1304 pr_err("failed to register %s rfkill switch: %d\n", name, res);
1305 rfkill_destroy(atp_rfk->rfkill);
1310 tpacpi_rfkill_switches[id] = atp_rfk;
1312 pr_info("rfkill switch %s: radio is %sblocked\n",
1313 name, (sw_state || hw_state) ? "" : "un");
1317 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1319 struct tpacpi_rfk *tp_rfk;
1321 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1323 tp_rfk = tpacpi_rfkill_switches[id];
1325 rfkill_unregister(tp_rfk->rfkill);
1326 rfkill_destroy(tp_rfk->rfkill);
1327 tpacpi_rfkill_switches[id] = NULL;
1332 static void printk_deprecated_rfkill_attribute(const char * const what)
1334 printk_deprecated_attribute(what,
1335 "Please switch to generic rfkill before year 2010");
1338 /* sysfs <radio> enable ------------------------------------------------ */
1339 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1340 struct device_attribute *attr,
1345 printk_deprecated_rfkill_attribute(attr->attr.name);
1347 /* This is in the ABI... */
1348 if (tpacpi_rfk_check_hwblock_state()) {
1349 status = TPACPI_RFK_RADIO_OFF;
1351 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1356 return snprintf(buf, PAGE_SIZE, "%d\n",
1357 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1360 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1361 struct device_attribute *attr,
1362 const char *buf, size_t count)
1367 printk_deprecated_rfkill_attribute(attr->attr.name);
1369 if (parse_strtoul(buf, 1, &t))
1372 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1374 /* This is in the ABI... */
1375 if (tpacpi_rfk_check_hwblock_state() && !!t)
1378 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1379 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1380 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1382 return (res < 0) ? res : count;
1385 /* procfs -------------------------------------------------------------- */
1386 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1388 if (id >= TPACPI_RFK_SW_MAX)
1389 seq_printf(m, "status:\t\tnot supported\n");
1393 /* This is in the ABI... */
1394 if (tpacpi_rfk_check_hwblock_state()) {
1395 status = TPACPI_RFK_RADIO_OFF;
1397 status = tpacpi_rfk_update_swstate(
1398 tpacpi_rfkill_switches[id]);
1403 seq_printf(m, "status:\t\t%s\n",
1404 (status == TPACPI_RFK_RADIO_ON) ?
1405 "enabled" : "disabled");
1406 seq_printf(m, "commands:\tenable, disable\n");
1412 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1418 if (id >= TPACPI_RFK_SW_MAX)
1421 while ((cmd = next_cmd(&buf))) {
1422 if (strlencmp(cmd, "enable") == 0)
1423 status = TPACPI_RFK_RADIO_ON;
1424 else if (strlencmp(cmd, "disable") == 0)
1425 status = TPACPI_RFK_RADIO_OFF;
1431 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1432 (status == TPACPI_RFK_RADIO_ON) ?
1433 "enable" : "disable",
1434 tpacpi_rfkill_names[id]);
1435 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1436 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1442 /*************************************************************************
1443 * thinkpad-acpi driver attributes
1446 /* interface_version --------------------------------------------------- */
1447 static ssize_t interface_version_show(struct device_driver *drv, char *buf)
1449 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1451 static DRIVER_ATTR_RO(interface_version);
1453 /* debug_level --------------------------------------------------------- */
1454 static ssize_t debug_level_show(struct device_driver *drv, char *buf)
1456 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1459 static ssize_t debug_level_store(struct device_driver *drv, const char *buf,
1464 if (parse_strtoul(buf, 0xffff, &t))
1471 static DRIVER_ATTR_RW(debug_level);
1473 /* version ------------------------------------------------------------- */
1474 static ssize_t version_show(struct device_driver *drv, char *buf)
1476 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1477 TPACPI_DESC, TPACPI_VERSION);
1479 static DRIVER_ATTR_RO(version);
1481 /* --------------------------------------------------------------------- */
1483 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1485 /* wlsw_emulstate ------------------------------------------------------ */
1486 static ssize_t wlsw_emulstate_show(struct device_driver *drv, char *buf)
1488 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1491 static ssize_t wlsw_emulstate_store(struct device_driver *drv, const char *buf,
1496 if (parse_strtoul(buf, 1, &t))
1499 if (tpacpi_wlsw_emulstate != !!t) {
1500 tpacpi_wlsw_emulstate = !!t;
1501 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1506 static DRIVER_ATTR_RW(wlsw_emulstate);
1508 /* bluetooth_emulstate ------------------------------------------------- */
1509 static ssize_t bluetooth_emulstate_show(struct device_driver *drv, char *buf)
1511 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1514 static ssize_t bluetooth_emulstate_store(struct device_driver *drv,
1515 const char *buf, size_t count)
1519 if (parse_strtoul(buf, 1, &t))
1522 tpacpi_bluetooth_emulstate = !!t;
1526 static DRIVER_ATTR_RW(bluetooth_emulstate);
1528 /* wwan_emulstate ------------------------------------------------- */
1529 static ssize_t wwan_emulstate_show(struct device_driver *drv, char *buf)
1531 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1534 static ssize_t wwan_emulstate_store(struct device_driver *drv, const char *buf,
1539 if (parse_strtoul(buf, 1, &t))
1542 tpacpi_wwan_emulstate = !!t;
1546 static DRIVER_ATTR_RW(wwan_emulstate);
1548 /* uwb_emulstate ------------------------------------------------- */
1549 static ssize_t uwb_emulstate_show(struct device_driver *drv, char *buf)
1551 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1554 static ssize_t uwb_emulstate_store(struct device_driver *drv, const char *buf,
1559 if (parse_strtoul(buf, 1, &t))
1562 tpacpi_uwb_emulstate = !!t;
1566 static DRIVER_ATTR_RW(uwb_emulstate);
1569 /* --------------------------------------------------------------------- */
1571 static struct driver_attribute *tpacpi_driver_attributes[] = {
1572 &driver_attr_debug_level, &driver_attr_version,
1573 &driver_attr_interface_version,
1576 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1582 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1583 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1587 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1588 if (!res && dbg_wlswemul)
1589 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1590 if (!res && dbg_bluetoothemul)
1591 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1592 if (!res && dbg_wwanemul)
1593 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1594 if (!res && dbg_uwbemul)
1595 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1601 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1605 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1606 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1608 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1609 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1610 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1611 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1612 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1616 /*************************************************************************
1621 * Table of recommended minimum BIOS versions
1623 * Reasons for listing:
1624 * 1. Stable BIOS, listed because the unknown amount of
1625 * bugs and bad ACPI behaviour on older versions
1627 * 2. BIOS or EC fw with known bugs that trigger on Linux
1629 * 3. BIOS with known reduced functionality in older versions
1631 * We recommend the latest BIOS and EC version.
1632 * We only support the latest BIOS and EC fw version as a rule.
1634 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1635 * Information from users in ThinkWiki
1637 * WARNING: we use this table also to detect that the machine is
1638 * a ThinkPad in some cases, so don't remove entries lightly.
1641 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1642 { .vendor = (__v), \
1643 .bios = TPID(__id1, __id2), \
1644 .ec = TPACPI_MATCH_ANY, \
1645 .quirks = TPACPI_MATCH_ANY << 16 \
1646 | (__bv1) << 8 | (__bv2) }
1648 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1649 __eid, __ev1, __ev2) \
1650 { .vendor = (__v), \
1651 .bios = TPID(__bid1, __bid2), \
1653 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1654 | (__bv1) << 8 | (__bv2) }
1656 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1657 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1659 /* Outdated IBM BIOSes often lack the EC id string */
1660 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1661 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1662 __bv1, __bv2, TPID(__id1, __id2), \
1664 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1665 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1668 /* Outdated IBM BIOSes often lack the EC id string */
1669 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1670 __eid1, __eid2, __ev1, __ev2) \
1671 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1672 __bv1, __bv2, TPID(__eid1, __eid2), \
1674 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1675 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1678 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1679 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1681 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1682 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1683 __bv1, __bv2, TPID(__id1, __id2), \
1686 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1687 __eid1, __eid2, __ev1, __ev2) \
1688 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1689 __bv1, __bv2, TPID(__eid1, __eid2), \
1692 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1693 /* Numeric models ------------------ */
1694 /* FW MODEL BIOS VERS */
1695 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1696 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1697 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1698 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1699 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1700 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1701 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1702 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1703 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1705 /* A-series ------------------------- */
1706 /* FW MODEL BIOS VERS EC VERS */
1707 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1708 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1709 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1710 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1711 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1712 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1713 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1714 TPV_QI0('1', '3', '2', '0'), /* A22m */
1715 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1716 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1717 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1719 /* G-series ------------------------- */
1720 /* FW MODEL BIOS VERS */
1721 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1722 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1724 /* R-series, T-series --------------- */
1725 /* FW MODEL BIOS VERS EC VERS */
1726 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1727 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1728 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1729 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1730 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1731 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1732 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1733 T40/p, T41/p, T42/p (1) */
1734 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1735 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1736 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1737 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1739 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1740 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1741 TPV_QI0('1', '6', '3', '2'), /* T22 */
1742 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1743 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1744 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1746 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1747 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1748 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1750 /* BIOS FW BIOS VERS EC FW EC VERS */
1751 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1752 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1754 /* X-series ------------------------- */
1755 /* FW MODEL BIOS VERS EC VERS */
1756 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1757 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1758 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1759 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1760 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1761 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1762 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1764 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1765 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1767 /* (0) - older versions lack DMI EC fw string and functionality */
1768 /* (1) - older versions known to lack functionality */
1779 static void __init tpacpi_check_outdated_fw(void)
1781 unsigned long fwvers;
1782 u16 ec_version, bios_version;
1784 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1785 ARRAY_SIZE(tpacpi_bios_version_qtable));
1790 bios_version = fwvers & 0xffffU;
1791 ec_version = (fwvers >> 16) & 0xffffU;
1793 /* note that unknown versions are set to 0x0000 and we use that */
1794 if ((bios_version > thinkpad_id.bios_release) ||
1795 (ec_version > thinkpad_id.ec_release &&
1796 ec_version != TPACPI_MATCH_ANY)) {
1798 * The changelogs would let us track down the exact
1799 * reason, but it is just too much of a pain to track
1800 * it. We only list BIOSes that are either really
1801 * broken, or really stable to begin with, so it is
1802 * best if the user upgrades the firmware anyway.
1804 pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1805 pr_warn("WARNING: This firmware may be missing critical bug fixes and/or important features\n");
1809 static bool __init tpacpi_is_fw_known(void)
1811 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1812 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1815 /****************************************************************************
1816 ****************************************************************************
1820 ****************************************************************************
1821 ****************************************************************************/
1823 /*************************************************************************
1824 * thinkpad-acpi metadata subdriver
1827 static int thinkpad_acpi_driver_read(struct seq_file *m)
1829 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1830 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1834 static struct ibm_struct thinkpad_acpi_driver_data = {
1836 .read = thinkpad_acpi_driver_read,
1839 /*************************************************************************
1844 * ThinkPad firmware event model
1846 * The ThinkPad firmware has two main event interfaces: normal ACPI
1847 * notifications (which follow the ACPI standard), and a private event
1850 * The private event interface also issues events for the hotkeys. As
1851 * the driver gained features, the event handling code ended up being
1852 * built around the hotkey subdriver. This will need to be refactored
1853 * to a more formal event API eventually.
1855 * Some "hotkeys" are actually supposed to be used as event reports,
1856 * such as "brightness has changed", "volume has changed", depending on
1857 * the ThinkPad model and how the firmware is operating.
1859 * Unlike other classes, hotkey-class events have mask/unmask control on
1860 * non-ancient firmware. However, how it behaves changes a lot with the
1861 * firmware model and version.
1864 enum { /* hot key scan codes (derived from ACPI DSDT) */
1865 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1866 TP_ACPI_HOTKEYSCAN_FNF2,
1867 TP_ACPI_HOTKEYSCAN_FNF3,
1868 TP_ACPI_HOTKEYSCAN_FNF4,
1869 TP_ACPI_HOTKEYSCAN_FNF5,
1870 TP_ACPI_HOTKEYSCAN_FNF6,
1871 TP_ACPI_HOTKEYSCAN_FNF7,
1872 TP_ACPI_HOTKEYSCAN_FNF8,
1873 TP_ACPI_HOTKEYSCAN_FNF9,
1874 TP_ACPI_HOTKEYSCAN_FNF10,
1875 TP_ACPI_HOTKEYSCAN_FNF11,
1876 TP_ACPI_HOTKEYSCAN_FNF12,
1877 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1878 TP_ACPI_HOTKEYSCAN_FNINSERT,
1879 TP_ACPI_HOTKEYSCAN_FNDELETE,
1880 TP_ACPI_HOTKEYSCAN_FNHOME,
1881 TP_ACPI_HOTKEYSCAN_FNEND,
1882 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1883 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1884 TP_ACPI_HOTKEYSCAN_FNSPACE,
1885 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1886 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1887 TP_ACPI_HOTKEYSCAN_MUTE,
1888 TP_ACPI_HOTKEYSCAN_THINKPAD,
1889 TP_ACPI_HOTKEYSCAN_UNK1,
1890 TP_ACPI_HOTKEYSCAN_UNK2,
1891 TP_ACPI_HOTKEYSCAN_UNK3,
1892 TP_ACPI_HOTKEYSCAN_UNK4,
1893 TP_ACPI_HOTKEYSCAN_UNK5,
1894 TP_ACPI_HOTKEYSCAN_UNK6,
1895 TP_ACPI_HOTKEYSCAN_UNK7,
1896 TP_ACPI_HOTKEYSCAN_UNK8,
1898 /* Adaptive keyboard keycodes */
1899 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1900 TP_ACPI_HOTKEYSCAN_MUTE2 = TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1901 TP_ACPI_HOTKEYSCAN_BRIGHTNESS_ZERO,
1902 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL,
1903 TP_ACPI_HOTKEYSCAN_CLOUD,
1904 TP_ACPI_HOTKEYSCAN_UNK9,
1905 TP_ACPI_HOTKEYSCAN_VOICE,
1906 TP_ACPI_HOTKEYSCAN_UNK10,
1907 TP_ACPI_HOTKEYSCAN_GESTURES,
1908 TP_ACPI_HOTKEYSCAN_UNK11,
1909 TP_ACPI_HOTKEYSCAN_UNK12,
1910 TP_ACPI_HOTKEYSCAN_UNK13,
1911 TP_ACPI_HOTKEYSCAN_CONFIG,
1912 TP_ACPI_HOTKEYSCAN_NEW_TAB,
1913 TP_ACPI_HOTKEYSCAN_RELOAD,
1914 TP_ACPI_HOTKEYSCAN_BACK,
1915 TP_ACPI_HOTKEYSCAN_MIC_DOWN,
1916 TP_ACPI_HOTKEYSCAN_MIC_UP,
1917 TP_ACPI_HOTKEYSCAN_MIC_CANCELLATION,
1918 TP_ACPI_HOTKEYSCAN_CAMERA_MODE,
1919 TP_ACPI_HOTKEYSCAN_ROTATE_DISPLAY,
1921 /* Lenovo extended keymap, starting at 0x1300 */
1922 TP_ACPI_HOTKEYSCAN_EXTENDED_START,
1923 /* first new observed key (star, favorites) is 0x1311 */
1924 TP_ACPI_HOTKEYSCAN_STAR = 69,
1925 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL2,
1926 TP_ACPI_HOTKEYSCAN_UNK25,
1927 TP_ACPI_HOTKEYSCAN_BLUETOOTH,
1928 TP_ACPI_HOTKEYSCAN_KEYBOARD,
1930 /* Hotkey keymap size */
1931 TPACPI_HOTKEY_MAP_LEN
1934 enum { /* Keys/events available through NVRAM polling */
1935 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1936 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1939 enum { /* Positions of some of the keys in hotkey masks */
1940 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1941 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1942 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1943 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1944 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1945 TP_ACPI_HKEY_KBD_LIGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1946 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1947 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1948 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1949 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1950 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1953 enum { /* NVRAM to ACPI HKEY group map */
1954 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1955 TP_ACPI_HKEY_ZOOM_MASK |
1956 TP_ACPI_HKEY_DISPSWTCH_MASK |
1957 TP_ACPI_HKEY_HIBERNATE_MASK,
1958 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1959 TP_ACPI_HKEY_BRGHTDWN_MASK,
1960 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1961 TP_ACPI_HKEY_VOLDWN_MASK |
1962 TP_ACPI_HKEY_MUTE_MASK,
1965 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1966 struct tp_nvram_state {
1967 u16 thinkpad_toggle:1;
1969 u16 display_toggle:1;
1970 u16 thinklight_toggle:1;
1971 u16 hibernate_toggle:1;
1972 u16 displayexp_toggle:1;
1973 u16 display_state:1;
1974 u16 brightness_toggle:1;
1975 u16 volume_toggle:1;
1978 u8 brightness_level;
1982 /* kthread for the hotkey poller */
1983 static struct task_struct *tpacpi_hotkey_task;
1986 * Acquire mutex to write poller control variables as an
1989 * Increment hotkey_config_change when changing them if you
1990 * want the kthread to forget old state.
1992 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1994 static struct mutex hotkey_thread_data_mutex;
1995 static unsigned int hotkey_config_change;
1998 * hotkey poller control variables
2000 * Must be atomic or readers will also need to acquire mutex
2002 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2003 * should be used only when the changes need to be taken as
2004 * a block, OR when one needs to force the kthread to forget
2007 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2008 static unsigned int hotkey_poll_freq = 10; /* Hz */
2010 #define HOTKEY_CONFIG_CRITICAL_START \
2012 mutex_lock(&hotkey_thread_data_mutex); \
2013 hotkey_config_change++; \
2015 #define HOTKEY_CONFIG_CRITICAL_END \
2016 mutex_unlock(&hotkey_thread_data_mutex);
2018 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2020 #define hotkey_source_mask 0U
2021 #define HOTKEY_CONFIG_CRITICAL_START
2022 #define HOTKEY_CONFIG_CRITICAL_END
2024 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2026 static struct mutex hotkey_mutex;
2028 static enum { /* Reasons for waking up */
2029 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2030 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2031 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2032 } hotkey_wakeup_reason;
2034 static int hotkey_autosleep_ack;
2036 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2037 static u32 hotkey_all_mask; /* all events supported in fw */
2038 static u32 hotkey_adaptive_all_mask; /* all adaptive events supported in fw */
2039 static u32 hotkey_reserved_mask; /* events better left disabled */
2040 static u32 hotkey_driver_mask; /* events needed by the driver */
2041 static u32 hotkey_user_mask; /* events visible to userspace */
2042 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2044 static u16 *hotkey_keycode_map;
2046 static struct attribute_set *hotkey_dev_attributes;
2048 static void tpacpi_driver_event(const unsigned int hkey_event);
2049 static void hotkey_driver_event(const unsigned int scancode);
2050 static void hotkey_poll_setup(const bool may_warn);
2052 /* HKEY.MHKG() return bits */
2053 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2055 TP_ACPI_MULTI_MODE_INVALID = 0,
2056 TP_ACPI_MULTI_MODE_UNKNOWN = 1 << 0,
2057 TP_ACPI_MULTI_MODE_LAPTOP = 1 << 1,
2058 TP_ACPI_MULTI_MODE_TABLET = 1 << 2,
2059 TP_ACPI_MULTI_MODE_FLAT = 1 << 3,
2060 TP_ACPI_MULTI_MODE_STAND = 1 << 4,
2061 TP_ACPI_MULTI_MODE_TENT = 1 << 5,
2062 TP_ACPI_MULTI_MODE_STAND_TENT = 1 << 6,
2066 /* The following modes are considered tablet mode for the purpose of
2067 * reporting the status to userspace. i.e. in all these modes it makes
2068 * sense to disable the laptop input devices such as touchpad and
2071 TP_ACPI_MULTI_MODE_TABLET_LIKE = TP_ACPI_MULTI_MODE_TABLET |
2072 TP_ACPI_MULTI_MODE_STAND |
2073 TP_ACPI_MULTI_MODE_TENT |
2074 TP_ACPI_MULTI_MODE_STAND_TENT,
2077 static int hotkey_get_wlsw(void)
2081 if (!tp_features.hotkey_wlsw)
2084 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2086 return (tpacpi_wlsw_emulstate) ?
2087 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2090 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2093 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2096 static int hotkey_gmms_get_tablet_mode(int s, int *has_tablet_mode)
2098 int type = (s >> 16) & 0xffff;
2099 int value = s & 0xffff;
2100 int mode = TP_ACPI_MULTI_MODE_INVALID;
2101 int valid_modes = 0;
2103 if (has_tablet_mode)
2104 *has_tablet_mode = 0;
2108 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2109 TP_ACPI_MULTI_MODE_TABLET |
2110 TP_ACPI_MULTI_MODE_STAND_TENT;
2113 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2114 TP_ACPI_MULTI_MODE_FLAT |
2115 TP_ACPI_MULTI_MODE_TABLET |
2116 TP_ACPI_MULTI_MODE_STAND |
2117 TP_ACPI_MULTI_MODE_TENT;
2120 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2121 TP_ACPI_MULTI_MODE_FLAT;
2125 /* In mode 4, FLAT is not specified as a valid mode. However,
2126 * it can be seen at least on the X1 Yoga 2nd Generation.
2128 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2129 TP_ACPI_MULTI_MODE_FLAT |
2130 TP_ACPI_MULTI_MODE_TABLET |
2131 TP_ACPI_MULTI_MODE_STAND |
2132 TP_ACPI_MULTI_MODE_TENT;
2135 pr_err("Unknown multi mode status type %d with value 0x%04X, please report this to %s\n",
2136 type, value, TPACPI_MAIL);
2140 if (has_tablet_mode && (valid_modes & TP_ACPI_MULTI_MODE_TABLET_LIKE))
2141 *has_tablet_mode = 1;
2145 mode = TP_ACPI_MULTI_MODE_LAPTOP;
2148 mode = TP_ACPI_MULTI_MODE_FLAT;
2151 mode = TP_ACPI_MULTI_MODE_TABLET;
2155 mode = TP_ACPI_MULTI_MODE_STAND_TENT;
2157 mode = TP_ACPI_MULTI_MODE_STAND;
2160 mode = TP_ACPI_MULTI_MODE_TENT;
2163 if (type == 5 && value == 0xffff) {
2164 pr_warn("Multi mode status is undetected, assuming laptop\n");
2169 if (!(mode & valid_modes)) {
2170 pr_err("Unknown/reserved multi mode value 0x%04X for type %d, please report this to %s\n",
2171 value, type, TPACPI_MAIL);
2175 return !!(mode & TP_ACPI_MULTI_MODE_TABLET_LIKE);
2178 static int hotkey_get_tablet_mode(int *status)
2182 switch (tp_features.hotkey_tablet) {
2183 case TP_HOTKEY_TABLET_USES_MHKG:
2184 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2187 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2189 case TP_HOTKEY_TABLET_USES_GMMS:
2190 if (!acpi_evalf(hkey_handle, &s, "GMMS", "dd", 0))
2193 *status = hotkey_gmms_get_tablet_mode(s, NULL);
2203 * Reads current event mask from firmware, and updates
2204 * hotkey_acpi_mask accordingly. Also resets any bits
2205 * from hotkey_user_mask that are unavailable to be
2206 * delivered (shadow requirement of the userspace ABI).
2208 * Call with hotkey_mutex held
2210 static int hotkey_mask_get(void)
2212 if (tp_features.hotkey_mask) {
2215 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2218 hotkey_acpi_mask = m;
2220 /* no mask support doesn't mean no event support... */
2221 hotkey_acpi_mask = hotkey_all_mask;
2224 /* sync userspace-visible mask */
2225 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2230 static void hotkey_mask_warn_incomplete_mask(void)
2232 /* log only what the user can fix... */
2233 const u32 wantedmask = hotkey_driver_mask &
2234 ~(hotkey_acpi_mask | hotkey_source_mask) &
2235 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2238 pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2242 * Set the firmware mask when supported
2244 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2246 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2248 * Call with hotkey_mutex held
2250 static int hotkey_mask_set(u32 mask)
2255 const u32 fwmask = mask & ~hotkey_source_mask;
2257 if (tp_features.hotkey_mask) {
2258 for (i = 0; i < 32; i++) {
2259 if (!acpi_evalf(hkey_handle,
2260 NULL, "MHKM", "vdd", i + 1,
2261 !!(mask & (1 << i)))) {
2269 * We *must* make an inconditional call to hotkey_mask_get to
2270 * refresh hotkey_acpi_mask and update hotkey_user_mask
2272 * Take the opportunity to also log when we cannot _enable_
2275 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2276 pr_notice("asked for hotkey mask 0x%08x, but firmware forced it to 0x%08x\n",
2277 fwmask, hotkey_acpi_mask);
2280 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2281 hotkey_mask_warn_incomplete_mask();
2287 * Sets hotkey_user_mask and tries to set the firmware mask
2289 * Call with hotkey_mutex held
2291 static int hotkey_user_mask_set(const u32 mask)
2295 /* Give people a chance to notice they are doing something that
2296 * is bound to go boom on their users sooner or later */
2297 if (!tp_warned.hotkey_mask_ff &&
2298 (mask == 0xffff || mask == 0xffffff ||
2299 mask == 0xffffffff)) {
2300 tp_warned.hotkey_mask_ff = 1;
2301 pr_notice("setting the hotkey mask to 0x%08x is likely not the best way to go about it\n",
2303 pr_notice("please consider using the driver defaults, and refer to up-to-date thinkpad-acpi documentation\n");
2306 /* Try to enable what the user asked for, plus whatever we need.
2307 * this syncs everything but won't enable bits in hotkey_user_mask */
2308 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2310 /* Enable the available bits in hotkey_user_mask */
2311 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2317 * Sets the driver hotkey mask.
2319 * Can be called even if the hotkey subdriver is inactive
2321 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2325 /* Do the right thing if hotkey_init has not been called yet */
2326 if (!tp_features.hotkey) {
2327 hotkey_driver_mask = mask;
2331 mutex_lock(&hotkey_mutex);
2333 HOTKEY_CONFIG_CRITICAL_START
2334 hotkey_driver_mask = mask;
2335 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2336 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2338 HOTKEY_CONFIG_CRITICAL_END
2340 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2341 ~hotkey_source_mask);
2342 hotkey_poll_setup(true);
2344 mutex_unlock(&hotkey_mutex);
2349 static int hotkey_status_get(int *status)
2351 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2357 static int hotkey_status_set(bool enable)
2359 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2365 static void tpacpi_input_send_tabletsw(void)
2369 if (tp_features.hotkey_tablet &&
2370 !hotkey_get_tablet_mode(&state)) {
2371 mutex_lock(&tpacpi_inputdev_send_mutex);
2373 input_report_switch(tpacpi_inputdev,
2374 SW_TABLET_MODE, !!state);
2375 input_sync(tpacpi_inputdev);
2377 mutex_unlock(&tpacpi_inputdev_send_mutex);
2381 /* Do NOT call without validating scancode first */
2382 static void tpacpi_input_send_key(const unsigned int scancode)
2384 const unsigned int keycode = hotkey_keycode_map[scancode];
2386 if (keycode != KEY_RESERVED) {
2387 mutex_lock(&tpacpi_inputdev_send_mutex);
2389 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2390 input_report_key(tpacpi_inputdev, keycode, 1);
2391 input_sync(tpacpi_inputdev);
2393 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2394 input_report_key(tpacpi_inputdev, keycode, 0);
2395 input_sync(tpacpi_inputdev);
2397 mutex_unlock(&tpacpi_inputdev_send_mutex);
2401 /* Do NOT call without validating scancode first */
2402 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2404 hotkey_driver_event(scancode);
2405 if (hotkey_user_mask & (1 << scancode))
2406 tpacpi_input_send_key(scancode);
2409 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2410 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2412 /* Do NOT call without validating scancode first */
2413 static void tpacpi_hotkey_send_key(unsigned int scancode)
2415 tpacpi_input_send_key_masked(scancode);
2418 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2422 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2423 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2424 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2425 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2426 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2427 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2429 if (m & TP_ACPI_HKEY_KBD_LIGHT_MASK) {
2430 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2431 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2433 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2434 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2435 n->displayexp_toggle =
2436 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2438 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2439 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2440 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2441 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2442 n->brightness_toggle =
2443 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2445 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2446 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2447 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2448 >> TP_NVRAM_POS_LEVEL_VOLUME;
2449 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2450 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2454 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2456 if ((event_mask & (1 << __scancode)) && \
2457 oldn->__member != newn->__member) \
2458 tpacpi_hotkey_send_key(__scancode); \
2461 #define TPACPI_MAY_SEND_KEY(__scancode) \
2463 if (event_mask & (1 << __scancode)) \
2464 tpacpi_hotkey_send_key(__scancode); \
2467 static void issue_volchange(const unsigned int oldvol,
2468 const unsigned int newvol,
2469 const u32 event_mask)
2471 unsigned int i = oldvol;
2473 while (i > newvol) {
2474 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2477 while (i < newvol) {
2478 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2483 static void issue_brightnesschange(const unsigned int oldbrt,
2484 const unsigned int newbrt,
2485 const u32 event_mask)
2487 unsigned int i = oldbrt;
2489 while (i > newbrt) {
2490 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2493 while (i < newbrt) {
2494 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2499 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2500 struct tp_nvram_state *newn,
2501 const u32 event_mask)
2504 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2505 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2506 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2507 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2509 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2511 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2516 * This code is supposed to duplicate the IBM firmware behaviour:
2517 * - Pressing MUTE issues mute hotkey message, even when already mute
2518 * - Pressing Volume up/down issues volume up/down hotkey messages,
2519 * even when already at maximum or minimum volume
2520 * - The act of unmuting issues volume up/down notification,
2521 * depending which key was used to unmute
2523 * We are constrained to what the NVRAM can tell us, which is not much
2524 * and certainly not enough if more than one volume hotkey was pressed
2525 * since the last poll cycle.
2527 * Just to make our life interesting, some newer Lenovo ThinkPads have
2528 * bugs in the BIOS and may fail to update volume_toggle properly.
2533 oldn->volume_toggle != newn->volume_toggle ||
2534 oldn->volume_level != newn->volume_level) {
2535 /* recently muted, or repeated mute keypress, or
2536 * multiple presses ending in mute */
2537 issue_volchange(oldn->volume_level, newn->volume_level,
2539 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2544 /* recently unmuted, issue 'unmute' keypress */
2545 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2547 if (oldn->volume_level != newn->volume_level) {
2548 issue_volchange(oldn->volume_level, newn->volume_level,
2550 } else if (oldn->volume_toggle != newn->volume_toggle) {
2551 /* repeated vol up/down keypress at end of scale ? */
2552 if (newn->volume_level == 0)
2553 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2554 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2555 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2559 /* handle brightness */
2560 if (oldn->brightness_level != newn->brightness_level) {
2561 issue_brightnesschange(oldn->brightness_level,
2562 newn->brightness_level, event_mask);
2563 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2564 /* repeated key presses that didn't change state */
2565 if (newn->brightness_level == 0)
2566 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2567 else if (newn->brightness_level >= bright_maxlvl
2568 && !tp_features.bright_unkfw)
2569 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2572 #undef TPACPI_COMPARE_KEY
2573 #undef TPACPI_MAY_SEND_KEY
2579 * We track all events in hotkey_source_mask all the time, since
2580 * most of them are edge-based. We only issue those requested by
2581 * hotkey_user_mask or hotkey_driver_mask, though.
2583 static int hotkey_kthread(void *data)
2585 struct tp_nvram_state s[2];
2586 u32 poll_mask, event_mask;
2587 unsigned int si, so;
2589 unsigned int change_detector;
2590 unsigned int poll_freq;
2593 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2602 /* Initial state for compares */
2603 mutex_lock(&hotkey_thread_data_mutex);
2604 change_detector = hotkey_config_change;
2605 poll_mask = hotkey_source_mask;
2606 event_mask = hotkey_source_mask &
2607 (hotkey_driver_mask | hotkey_user_mask);
2608 poll_freq = hotkey_poll_freq;
2609 mutex_unlock(&hotkey_thread_data_mutex);
2610 hotkey_read_nvram(&s[so], poll_mask);
2612 while (!kthread_should_stop()) {
2614 if (likely(poll_freq))
2617 t = 100; /* should never happen... */
2619 t = msleep_interruptible(t);
2620 if (unlikely(kthread_freezable_should_stop(&was_frozen)))
2623 if (t > 0 && !was_frozen)
2626 mutex_lock(&hotkey_thread_data_mutex);
2627 if (was_frozen || hotkey_config_change != change_detector) {
2628 /* forget old state on thaw or config change */
2631 change_detector = hotkey_config_change;
2633 poll_mask = hotkey_source_mask;
2634 event_mask = hotkey_source_mask &
2635 (hotkey_driver_mask | hotkey_user_mask);
2636 poll_freq = hotkey_poll_freq;
2637 mutex_unlock(&hotkey_thread_data_mutex);
2639 if (likely(poll_mask)) {
2640 hotkey_read_nvram(&s[si], poll_mask);
2641 if (likely(si != so)) {
2642 hotkey_compare_and_issue_event(&s[so], &s[si],
2655 /* call with hotkey_mutex held */
2656 static void hotkey_poll_stop_sync(void)
2658 if (tpacpi_hotkey_task) {
2659 kthread_stop(tpacpi_hotkey_task);
2660 tpacpi_hotkey_task = NULL;
2664 /* call with hotkey_mutex held */
2665 static void hotkey_poll_setup(const bool may_warn)
2667 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2668 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2670 if (hotkey_poll_freq > 0 &&
2671 (poll_driver_mask ||
2672 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2673 if (!tpacpi_hotkey_task) {
2674 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2675 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2676 if (IS_ERR(tpacpi_hotkey_task)) {
2677 tpacpi_hotkey_task = NULL;
2678 pr_err("could not create kernel thread for hotkey polling\n");
2682 hotkey_poll_stop_sync();
2683 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2684 hotkey_poll_freq == 0) {
2685 pr_notice("hot keys 0x%08x and/or events 0x%08x require polling, which is currently disabled\n",
2686 poll_user_mask, poll_driver_mask);
2691 static void hotkey_poll_setup_safe(const bool may_warn)
2693 mutex_lock(&hotkey_mutex);
2694 hotkey_poll_setup(may_warn);
2695 mutex_unlock(&hotkey_mutex);
2698 /* call with hotkey_mutex held */
2699 static void hotkey_poll_set_freq(unsigned int freq)
2702 hotkey_poll_stop_sync();
2704 hotkey_poll_freq = freq;
2707 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2709 static void hotkey_poll_setup(const bool __unused)
2713 static void hotkey_poll_setup_safe(const bool __unused)
2717 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2719 static int hotkey_inputdev_open(struct input_dev *dev)
2721 switch (tpacpi_lifecycle) {
2722 case TPACPI_LIFE_INIT:
2723 case TPACPI_LIFE_RUNNING:
2724 hotkey_poll_setup_safe(false);
2726 case TPACPI_LIFE_EXITING:
2730 /* Should only happen if tpacpi_lifecycle is corrupt */
2735 static void hotkey_inputdev_close(struct input_dev *dev)
2737 /* disable hotkey polling when possible */
2738 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2739 !(hotkey_source_mask & hotkey_driver_mask))
2740 hotkey_poll_setup_safe(false);
2743 /* sysfs hotkey enable ------------------------------------------------- */
2744 static ssize_t hotkey_enable_show(struct device *dev,
2745 struct device_attribute *attr,
2750 printk_deprecated_attribute("hotkey_enable",
2751 "Hotkey reporting is always enabled");
2753 res = hotkey_status_get(&status);
2757 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2760 static ssize_t hotkey_enable_store(struct device *dev,
2761 struct device_attribute *attr,
2762 const char *buf, size_t count)
2766 printk_deprecated_attribute("hotkey_enable",
2767 "Hotkeys can be disabled through hotkey_mask");
2769 if (parse_strtoul(buf, 1, &t))
2778 static DEVICE_ATTR_RW(hotkey_enable);
2780 /* sysfs hotkey mask --------------------------------------------------- */
2781 static ssize_t hotkey_mask_show(struct device *dev,
2782 struct device_attribute *attr,
2785 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2788 static ssize_t hotkey_mask_store(struct device *dev,
2789 struct device_attribute *attr,
2790 const char *buf, size_t count)
2795 if (parse_strtoul(buf, 0xffffffffUL, &t))
2798 if (mutex_lock_killable(&hotkey_mutex))
2799 return -ERESTARTSYS;
2801 res = hotkey_user_mask_set(t);
2803 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2804 hotkey_poll_setup(true);
2807 mutex_unlock(&hotkey_mutex);
2809 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2811 return (res) ? res : count;
2814 static DEVICE_ATTR_RW(hotkey_mask);
2816 /* sysfs hotkey bios_enabled ------------------------------------------- */
2817 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2818 struct device_attribute *attr,
2821 return sprintf(buf, "0\n");
2824 static DEVICE_ATTR_RO(hotkey_bios_enabled);
2826 /* sysfs hotkey bios_mask ---------------------------------------------- */
2827 static ssize_t hotkey_bios_mask_show(struct device *dev,
2828 struct device_attribute *attr,
2831 printk_deprecated_attribute("hotkey_bios_mask",
2832 "This attribute is useless.");
2833 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2836 static DEVICE_ATTR_RO(hotkey_bios_mask);
2838 /* sysfs hotkey all_mask ----------------------------------------------- */
2839 static ssize_t hotkey_all_mask_show(struct device *dev,
2840 struct device_attribute *attr,
2843 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2844 hotkey_all_mask | hotkey_source_mask);
2847 static DEVICE_ATTR_RO(hotkey_all_mask);
2849 /* sysfs hotkey all_mask ----------------------------------------------- */
2850 static ssize_t hotkey_adaptive_all_mask_show(struct device *dev,
2851 struct device_attribute *attr,
2854 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2855 hotkey_adaptive_all_mask | hotkey_source_mask);
2858 static DEVICE_ATTR_RO(hotkey_adaptive_all_mask);
2860 /* sysfs hotkey recommended_mask --------------------------------------- */
2861 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2862 struct device_attribute *attr,
2865 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2866 (hotkey_all_mask | hotkey_source_mask)
2867 & ~hotkey_reserved_mask);
2870 static DEVICE_ATTR_RO(hotkey_recommended_mask);
2872 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2874 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2875 static ssize_t hotkey_source_mask_show(struct device *dev,
2876 struct device_attribute *attr,
2879 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2882 static ssize_t hotkey_source_mask_store(struct device *dev,
2883 struct device_attribute *attr,
2884 const char *buf, size_t count)
2890 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2891 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2894 if (mutex_lock_killable(&hotkey_mutex))
2895 return -ERESTARTSYS;
2897 HOTKEY_CONFIG_CRITICAL_START
2898 hotkey_source_mask = t;
2899 HOTKEY_CONFIG_CRITICAL_END
2901 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2902 ~hotkey_source_mask);
2903 hotkey_poll_setup(true);
2905 /* check if events needed by the driver got disabled */
2906 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2907 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2909 mutex_unlock(&hotkey_mutex);
2912 pr_err("hotkey_source_mask: failed to update the firmware event mask!\n");
2915 pr_notice("hotkey_source_mask: some important events were disabled: 0x%04x\n",
2918 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2920 return (rc < 0) ? rc : count;
2923 static DEVICE_ATTR_RW(hotkey_source_mask);
2925 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2926 static ssize_t hotkey_poll_freq_show(struct device *dev,
2927 struct device_attribute *attr,
2930 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2933 static ssize_t hotkey_poll_freq_store(struct device *dev,
2934 struct device_attribute *attr,
2935 const char *buf, size_t count)
2939 if (parse_strtoul(buf, 25, &t))
2942 if (mutex_lock_killable(&hotkey_mutex))
2943 return -ERESTARTSYS;
2945 hotkey_poll_set_freq(t);
2946 hotkey_poll_setup(true);
2948 mutex_unlock(&hotkey_mutex);
2950 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2955 static DEVICE_ATTR_RW(hotkey_poll_freq);
2957 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2959 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2960 static ssize_t hotkey_radio_sw_show(struct device *dev,
2961 struct device_attribute *attr,
2965 res = hotkey_get_wlsw();
2969 /* Opportunistic update */
2970 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2972 return snprintf(buf, PAGE_SIZE, "%d\n",
2973 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2976 static DEVICE_ATTR_RO(hotkey_radio_sw);
2978 static void hotkey_radio_sw_notify_change(void)
2980 if (tp_features.hotkey_wlsw)
2981 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2985 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2986 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2987 struct device_attribute *attr,
2991 res = hotkey_get_tablet_mode(&s);
2995 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2998 static DEVICE_ATTR_RO(hotkey_tablet_mode);
3000 static void hotkey_tablet_mode_notify_change(void)
3002 if (tp_features.hotkey_tablet)
3003 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3004 "hotkey_tablet_mode");
3007 /* sysfs wakeup reason (pollable) -------------------------------------- */
3008 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
3009 struct device_attribute *attr,
3012 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
3015 static DEVICE_ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
3017 static void hotkey_wakeup_reason_notify_change(void)
3019 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3023 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
3024 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
3025 struct device_attribute *attr,
3028 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
3031 static DEVICE_ATTR(wakeup_hotunplug_complete, S_IRUGO,
3032 hotkey_wakeup_hotunplug_complete_show, NULL);
3034 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
3036 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3037 "wakeup_hotunplug_complete");
3040 /* sysfs adaptive kbd mode --------------------------------------------- */
3042 static int adaptive_keyboard_get_mode(void);
3043 static int adaptive_keyboard_set_mode(int new_mode);
3045 enum ADAPTIVE_KEY_MODE {
3048 WEB_CONFERENCE_MODE,
3053 static ssize_t adaptive_kbd_mode_show(struct device *dev,
3054 struct device_attribute *attr,
3059 current_mode = adaptive_keyboard_get_mode();
3060 if (current_mode < 0)
3061 return current_mode;
3063 return snprintf(buf, PAGE_SIZE, "%d\n", current_mode);
3066 static ssize_t adaptive_kbd_mode_store(struct device *dev,
3067 struct device_attribute *attr,
3068 const char *buf, size_t count)
3073 if (parse_strtoul(buf, LAYFLAT_MODE, &t))
3076 res = adaptive_keyboard_set_mode(t);
3077 return (res < 0) ? res : count;
3080 static DEVICE_ATTR_RW(adaptive_kbd_mode);
3082 static struct attribute *adaptive_kbd_attributes[] = {
3083 &dev_attr_adaptive_kbd_mode.attr,
3087 static const struct attribute_group adaptive_kbd_attr_group = {
3088 .attrs = adaptive_kbd_attributes,
3091 /* --------------------------------------------------------------------- */
3093 static struct attribute *hotkey_attributes[] __initdata = {
3094 &dev_attr_hotkey_enable.attr,
3095 &dev_attr_hotkey_bios_enabled.attr,
3096 &dev_attr_hotkey_bios_mask.attr,
3097 &dev_attr_wakeup_reason.attr,
3098 &dev_attr_wakeup_hotunplug_complete.attr,
3099 &dev_attr_hotkey_mask.attr,
3100 &dev_attr_hotkey_all_mask.attr,
3101 &dev_attr_hotkey_adaptive_all_mask.attr,
3102 &dev_attr_hotkey_recommended_mask.attr,
3103 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3104 &dev_attr_hotkey_source_mask.attr,
3105 &dev_attr_hotkey_poll_freq.attr,
3110 * Sync both the hw and sw blocking state of all switches
3112 static void tpacpi_send_radiosw_update(void)
3117 * We must sync all rfkill controllers *before* issuing any
3118 * rfkill input events, or we will race the rfkill core input
3121 * tpacpi_inputdev_send_mutex works as a synchronization point
3124 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3127 wlsw = hotkey_get_wlsw();
3129 /* Sync hw blocking state first if it is hw-blocked */
3130 if (wlsw == TPACPI_RFK_RADIO_OFF)
3131 tpacpi_rfk_update_hwblock_state(true);
3133 /* Sync sw blocking state */
3134 tpacpi_rfk_update_swstate_all();
3136 /* Sync hw blocking state last if it is hw-unblocked */
3137 if (wlsw == TPACPI_RFK_RADIO_ON)
3138 tpacpi_rfk_update_hwblock_state(false);
3140 /* Issue rfkill input event for WLSW switch */
3142 mutex_lock(&tpacpi_inputdev_send_mutex);
3144 input_report_switch(tpacpi_inputdev,
3145 SW_RFKILL_ALL, (wlsw > 0));
3146 input_sync(tpacpi_inputdev);
3148 mutex_unlock(&tpacpi_inputdev_send_mutex);
3152 * this can be unconditional, as we will poll state again
3153 * if userspace uses the notify to read data
3155 hotkey_radio_sw_notify_change();
3158 static void hotkey_exit(void)
3160 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3161 mutex_lock(&hotkey_mutex);
3162 hotkey_poll_stop_sync();
3163 mutex_unlock(&hotkey_mutex);
3166 if (hotkey_dev_attributes)
3167 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3169 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3170 "restoring original HKEY status and mask\n");
3171 /* yes, there is a bitwise or below, we want the
3172 * functions to be called even if one of them fail */
3173 if (((tp_features.hotkey_mask &&
3174 hotkey_mask_set(hotkey_orig_mask)) |
3175 hotkey_status_set(false)) != 0)
3176 pr_err("failed to restore hot key mask to BIOS defaults\n");
3179 static void __init hotkey_unmap(const unsigned int scancode)
3181 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3182 clear_bit(hotkey_keycode_map[scancode],
3183 tpacpi_inputdev->keybit);
3184 hotkey_keycode_map[scancode] = KEY_RESERVED;
3190 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3193 #define TPACPI_HK_Q_INIMASK 0x0001
3195 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3196 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3197 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3198 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3199 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3200 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3201 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3202 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3203 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3204 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3205 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3206 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3207 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3208 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3209 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3210 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3211 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3212 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3213 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3214 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3217 typedef u16 tpacpi_keymap_entry_t;
3218 typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3220 static int hotkey_init_tablet_mode(void)
3222 int in_tablet_mode = 0, res;
3225 if (acpi_evalf(hkey_handle, &res, "GMMS", "qdd", 0)) {
3226 int has_tablet_mode;
3228 in_tablet_mode = hotkey_gmms_get_tablet_mode(res,
3230 if (has_tablet_mode)
3231 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_GMMS;
3233 } else if (acpi_evalf(hkey_handle, &res, "MHKG", "qd")) {
3234 /* For X41t, X60t, X61t Tablets... */
3235 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_MHKG;
3236 in_tablet_mode = !!(res & TP_HOTKEY_TABLET_MASK);
3240 if (!tp_features.hotkey_tablet)
3243 pr_info("Tablet mode switch found (type: %s), currently in %s mode\n",
3244 type, in_tablet_mode ? "tablet" : "laptop");
3246 res = add_to_attr_set(hotkey_dev_attributes,
3247 &dev_attr_hotkey_tablet_mode.attr);
3251 return in_tablet_mode;
3254 static int __init hotkey_init(struct ibm_init_struct *iibm)
3256 /* Requirements for changing the default keymaps:
3258 * 1. Many of the keys are mapped to KEY_RESERVED for very
3259 * good reasons. Do not change them unless you have deep
3260 * knowledge on the IBM and Lenovo ThinkPad firmware for
3261 * the various ThinkPad models. The driver behaves
3262 * differently for KEY_RESERVED: such keys have their
3263 * hot key mask *unset* in mask_recommended, and also
3264 * in the initial hot key mask programmed into the
3265 * firmware at driver load time, which means the firm-
3266 * ware may react very differently if you change them to
3269 * 2. You must be subscribed to the linux-thinkpad and
3270 * ibm-acpi-devel mailing lists, and you should read the
3271 * list archives since 2007 if you want to change the
3272 * keymaps. This requirement exists so that you will
3273 * know the past history of problems with the thinkpad-
3274 * acpi driver keymaps, and also that you will be
3275 * listening to any bug reports;
3277 * 3. Do not send thinkpad-acpi specific patches directly to
3278 * for merging, *ever*. Send them to the linux-acpi
3279 * mailinglist for comments. Merging is to be done only
3280 * through acpi-test and the ACPI maintainer.
3282 * If the above is too much to ask, don't change the keymap.
3283 * Ask the thinkpad-acpi maintainer to do it, instead.
3287 TPACPI_KEYMAP_IBM_GENERIC = 0,
3288 TPACPI_KEYMAP_LENOVO_GENERIC,
3291 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3292 /* Generic keymap for IBM ThinkPads */
3293 [TPACPI_KEYMAP_IBM_GENERIC] = {
3294 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3295 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3296 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3297 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3299 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3300 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3301 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3302 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3304 /* brightness: firmware always reacts to them */
3305 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3306 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3308 /* Thinklight: firmware always react to it */
3309 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3311 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3312 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3314 /* Volume: firmware always react to it and reprograms
3315 * the built-in *extra* mixer. Never map it to control
3316 * another mixer by default. */
3317 KEY_RESERVED, /* 0x14: VOLUME UP */
3318 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3319 KEY_RESERVED, /* 0x16: MUTE */
3321 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3323 /* (assignments unknown, please report if found) */
3324 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3325 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3327 /* No assignments, only used for Adaptive keyboards. */
3328 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3329 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3330 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3331 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3332 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3334 /* No assignment, used for newer Lenovo models */
3335 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3336 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3337 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3338 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3339 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3340 KEY_UNKNOWN, KEY_UNKNOWN
3344 /* Generic keymap for Lenovo ThinkPads */
3345 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3346 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3347 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3348 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3349 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3351 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3352 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3353 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3354 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3356 /* These should be enabled --only-- when ACPI video
3357 * is disabled (i.e. in "vendor" mode), and are handled
3358 * in a special way by the init code */
3359 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3360 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3362 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3364 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3365 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3367 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3368 * react to it and reprograms the built-in *extra* mixer.
3369 * Never map it to control another mixer by default.
3371 * T60?, T61, R60?, R61: firmware and EC tries to send
3372 * these over the regular keyboard, so these are no-ops,
3373 * but there are still weird bugs re. MUTE, so do not
3374 * change unless you get test reports from all Lenovo
3375 * models. May cause the BIOS to interfere with the
3378 KEY_RESERVED, /* 0x14: VOLUME UP */
3379 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3380 KEY_RESERVED, /* 0x16: MUTE */
3382 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3384 /* (assignments unknown, please report if found) */
3385 KEY_UNKNOWN, KEY_UNKNOWN,
3388 * The mic mute button only sends 0x1a. It does not
3389 * automatically mute the mic or change the mute light.
3391 KEY_MICMUTE, /* 0x1a: Mic mute (since ?400 or so) */
3393 /* (assignments unknown, please report if found) */
3396 /* Extra keys in use since the X240 / T440 / T540 */
3397 KEY_CONFIG, KEY_SEARCH, KEY_SCALE, KEY_FILE,
3400 * These are the adaptive keyboard keycodes for Carbon X1 2014.
3401 * The first item in this list is the Mute button which is
3402 * emitted with 0x103 through
3403 * adaptive_keyboard_hotkey_notify_hotkey() when the sound
3405 * We'll need to offset those by 0x20.
3407 KEY_RESERVED, /* Mute held, 0x103 */
3408 KEY_BRIGHTNESS_MIN, /* Backlight off */
3409 KEY_RESERVED, /* Clipping tool */
3410 KEY_RESERVED, /* Cloud */
3412 KEY_VOICECOMMAND, /* Voice */
3414 KEY_RESERVED, /* Gestures */
3418 KEY_CONFIG, /* Settings */
3419 KEY_RESERVED, /* New tab */
3420 KEY_REFRESH, /* Reload */
3421 KEY_BACK, /* Back */
3422 KEY_RESERVED, /* Microphone down */
3423 KEY_RESERVED, /* Microphone up */
3424 KEY_RESERVED, /* Microphone cancellation */
3425 KEY_RESERVED, /* Camera mode */
3426 KEY_RESERVED, /* Rotate display, 0x116 */
3429 * These are found in 2017 models (e.g. T470s, X270).
3430 * The lowest known value is 0x311, which according to
3431 * the manual should launch a user defined favorite
3434 * The offset for these is TP_ACPI_HOTKEYSCAN_EXTENDED_START,
3435 * corresponding to 0x34.
3438 /* (assignments unknown, please report if found) */
3439 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3440 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3441 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3442 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3445 KEY_FAVORITES, /* Favorite app, 0x311 */
3446 KEY_RESERVED, /* Clipping tool */
3448 KEY_BLUETOOTH, /* Bluetooth */
3449 KEY_KEYBOARD /* Keyboard, 0x315 */
3453 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3454 /* Generic maps (fallback) */
3456 .vendor = PCI_VENDOR_ID_IBM,
3457 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3458 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3461 .vendor = PCI_VENDOR_ID_LENOVO,
3462 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3463 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3467 #define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3468 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3473 bool radiosw_state = false;
3474 bool tabletsw_state = false;
3476 unsigned long quirks;
3477 unsigned long keymap_id;
3479 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3480 "initializing hotkey subdriver\n");
3482 BUG_ON(!tpacpi_inputdev);
3483 BUG_ON(tpacpi_inputdev->open != NULL ||
3484 tpacpi_inputdev->close != NULL);
3486 TPACPI_ACPIHANDLE_INIT(hkey);
3487 mutex_init(&hotkey_mutex);
3489 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3490 mutex_init(&hotkey_thread_data_mutex);
3493 /* hotkey not supported on 570 */
3494 tp_features.hotkey = hkey_handle != NULL;
3496 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3498 str_supported(tp_features.hotkey));
3500 if (!tp_features.hotkey)
3503 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3504 ARRAY_SIZE(tpacpi_hotkey_qtable));
3506 tpacpi_disable_brightness_delay();
3508 /* MUST have enough space for all attributes to be added to
3509 * hotkey_dev_attributes */
3510 hotkey_dev_attributes = create_attr_set(
3511 ARRAY_SIZE(hotkey_attributes) + 2,
3513 if (!hotkey_dev_attributes)
3515 res = add_many_to_attr_set(hotkey_dev_attributes,
3517 ARRAY_SIZE(hotkey_attributes));
3521 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3522 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3523 for HKEY interface version 0x100 */
3524 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3525 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3526 "firmware HKEY interface version: 0x%x\n",
3529 switch (hkeyv >> 8) {
3532 * MHKV 0x100 in A31, R40, R40e,
3533 * T4x, X31, and later
3536 /* Paranoia check AND init hotkey_all_mask */
3537 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3539 pr_err("missing MHKA handler, please report this to %s\n",
3541 /* Fallback: pre-init for FN+F3,F4,F12 */
3542 hotkey_all_mask = 0x080cU;
3544 tp_features.hotkey_mask = 1;
3550 * MHKV 0x200 in X1, T460s, X260, T560, X1 Tablet (2016)
3553 /* Paranoia check AND init hotkey_all_mask */
3554 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3556 pr_err("missing MHKA handler, please report this to %s\n",
3558 /* Fallback: pre-init for FN+F3,F4,F12 */
3559 hotkey_all_mask = 0x080cU;
3561 tp_features.hotkey_mask = 1;
3565 * Check if we have an adaptive keyboard, like on the
3566 * Lenovo Carbon X1 2014 (2nd Gen).
3568 if (acpi_evalf(hkey_handle, &hotkey_adaptive_all_mask,
3570 if (hotkey_adaptive_all_mask != 0) {
3571 tp_features.has_adaptive_kbd = true;
3572 res = sysfs_create_group(
3573 &tpacpi_pdev->dev.kobj,
3574 &adaptive_kbd_attr_group);
3579 tp_features.has_adaptive_kbd = false;
3580 hotkey_adaptive_all_mask = 0x0U;
3585 pr_err("unknown version of the HKEY interface: 0x%x\n",
3587 pr_err("please report this to %s\n", TPACPI_MAIL);
3592 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3593 "hotkey masks are %s\n",
3594 str_supported(tp_features.hotkey_mask));
3596 /* Init hotkey_all_mask if not initialized yet */
3597 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3598 (quirks & TPACPI_HK_Q_INIMASK))
3599 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3601 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3602 if (tp_features.hotkey_mask) {
3603 /* hotkey_source_mask *must* be zero for
3604 * the first hotkey_mask_get to return hotkey_orig_mask */
3605 res = hotkey_mask_get();
3609 hotkey_orig_mask = hotkey_acpi_mask;
3611 hotkey_orig_mask = hotkey_all_mask;
3612 hotkey_acpi_mask = hotkey_all_mask;
3615 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3617 tp_features.hotkey_wlsw = 1;
3618 radiosw_state = !!tpacpi_wlsw_emulstate;
3619 pr_info("radio switch emulation enabled\n");
3622 /* Not all thinkpads have a hardware radio switch */
3623 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3624 tp_features.hotkey_wlsw = 1;
3625 radiosw_state = !!status;
3626 pr_info("radio switch found; radios are %s\n",
3627 enabled(status, 0));
3629 if (tp_features.hotkey_wlsw)
3630 res = add_to_attr_set(hotkey_dev_attributes,
3631 &dev_attr_hotkey_radio_sw.attr);
3633 res = hotkey_init_tablet_mode();
3637 tabletsw_state = res;
3639 res = register_attr_set_with_sysfs(hotkey_dev_attributes,
3640 &tpacpi_pdev->dev.kobj);
3644 /* Set up key map */
3645 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3647 if (!hotkey_keycode_map) {
3648 pr_err("failed to allocate memory for key map\n");
3653 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3654 ARRAY_SIZE(tpacpi_keymap_qtable));
3655 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3656 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3657 "using keymap number %lu\n", keymap_id);
3659 memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3660 TPACPI_HOTKEY_MAP_SIZE);
3662 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3663 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3664 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3665 tpacpi_inputdev->keycode = hotkey_keycode_map;
3666 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3667 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3668 input_set_capability(tpacpi_inputdev, EV_KEY,
3669 hotkey_keycode_map[i]);
3671 if (i < sizeof(hotkey_reserved_mask)*8)
3672 hotkey_reserved_mask |= 1 << i;
3676 if (tp_features.hotkey_wlsw) {
3677 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3678 input_report_switch(tpacpi_inputdev,
3679 SW_RFKILL_ALL, radiosw_state);
3681 if (tp_features.hotkey_tablet) {
3682 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3683 input_report_switch(tpacpi_inputdev,
3684 SW_TABLET_MODE, tabletsw_state);
3687 /* Do not issue duplicate brightness change events to
3688 * userspace. tpacpi_detect_brightness_capabilities() must have
3689 * been called before this point */
3690 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
3691 pr_info("This ThinkPad has standard ACPI backlight brightness control, supported by the ACPI video driver\n");
3692 pr_notice("Disabling thinkpad-acpi brightness events by default...\n");
3694 /* Disable brightness up/down on Lenovo thinkpads when
3695 * ACPI is handling them, otherwise it is plain impossible
3696 * for userspace to do something even remotely sane */
3697 hotkey_reserved_mask |=
3698 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3699 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3700 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3701 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3704 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3705 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3707 & ~hotkey_reserved_mask;
3709 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3710 "hotkey source mask 0x%08x, polling freq %u\n",
3711 hotkey_source_mask, hotkey_poll_freq);
3714 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3715 "enabling firmware HKEY event interface...\n");
3716 res = hotkey_status_set(true);
3721 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3722 | hotkey_driver_mask)
3723 & ~hotkey_source_mask);
3724 if (res < 0 && res != -ENXIO) {
3728 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3729 & ~hotkey_reserved_mask;
3730 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3731 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3732 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3734 tpacpi_inputdev->open = &hotkey_inputdev_open;
3735 tpacpi_inputdev->close = &hotkey_inputdev_close;
3737 hotkey_poll_setup_safe(true);
3742 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3743 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3744 &adaptive_kbd_attr_group);
3746 hotkey_dev_attributes = NULL;
3748 return (res < 0) ? res : 1;
3751 /* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3752 * mode, Web conference mode, Function mode and Lay-flat mode.
3753 * We support Home mode and Function mode currently.
3755 * Will consider support rest of modes in future.
3758 static const int adaptive_keyboard_modes[] = {
3760 /* WEB_BROWSER_MODE = 2,
3761 WEB_CONFERENCE_MODE = 3, */
3765 #define DFR_CHANGE_ROW 0x101
3766 #define DFR_SHOW_QUICKVIEW_ROW 0x102
3767 #define FIRST_ADAPTIVE_KEY 0x103
3769 /* press Fn key a while second, it will switch to Function Mode. Then
3770 * release Fn key, previous mode be restored.
3772 static bool adaptive_keyboard_mode_is_saved;
3773 static int adaptive_keyboard_prev_mode;
3775 static int adaptive_keyboard_get_mode(void)
3779 if (!acpi_evalf(hkey_handle, &mode, "GTRW", "dd", 0)) {
3780 pr_err("Cannot read adaptive keyboard mode\n");
3787 static int adaptive_keyboard_set_mode(int new_mode)
3790 new_mode > LAYFLAT_MODE)
3793 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3794 pr_err("Cannot set adaptive keyboard mode\n");
3801 static int adaptive_keyboard_get_next_mode(int mode)
3804 size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3806 for (i = 0; i <= max_mode; i++) {
3807 if (adaptive_keyboard_modes[i] == mode)
3816 return adaptive_keyboard_modes[i];
3819 static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3821 int current_mode = 0;
3826 case DFR_CHANGE_ROW:
3827 if (adaptive_keyboard_mode_is_saved) {
3828 new_mode = adaptive_keyboard_prev_mode;
3829 adaptive_keyboard_mode_is_saved = false;
3831 current_mode = adaptive_keyboard_get_mode();
3832 if (current_mode < 0)
3834 new_mode = adaptive_keyboard_get_next_mode(
3838 if (adaptive_keyboard_set_mode(new_mode) < 0)
3843 case DFR_SHOW_QUICKVIEW_ROW:
3844 current_mode = adaptive_keyboard_get_mode();
3845 if (current_mode < 0)
3848 adaptive_keyboard_prev_mode = current_mode;
3849 adaptive_keyboard_mode_is_saved = true;
3851 if (adaptive_keyboard_set_mode (FUNCTION_MODE) < 0)
3856 if (scancode < FIRST_ADAPTIVE_KEY ||
3857 scancode >= FIRST_ADAPTIVE_KEY +
3858 TP_ACPI_HOTKEYSCAN_EXTENDED_START -
3859 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3860 pr_info("Unhandled adaptive keyboard key: 0x%x\n",
3864 keycode = hotkey_keycode_map[scancode - FIRST_ADAPTIVE_KEY +
3865 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START];
3866 if (keycode != KEY_RESERVED) {
3867 mutex_lock(&tpacpi_inputdev_send_mutex);
3869 input_report_key(tpacpi_inputdev, keycode, 1);
3870 input_sync(tpacpi_inputdev);
3872 input_report_key(tpacpi_inputdev, keycode, 0);
3873 input_sync(tpacpi_inputdev);
3875 mutex_unlock(&tpacpi_inputdev_send_mutex);
3881 static bool hotkey_notify_hotkey(const u32 hkey,
3883 bool *ignore_acpi_ev)
3885 /* 0x1000-0x1FFF: key presses */
3886 unsigned int scancode = hkey & 0xfff;
3887 *send_acpi_ev = true;
3888 *ignore_acpi_ev = false;
3891 * Original events are in the 0x10XX range, the adaptive keyboard
3892 * found in 2014 X1 Carbon emits events are of 0x11XX. In 2017
3893 * models, additional keys are emitted through 0x13XX.
3895 switch ((hkey >> 8) & 0xf) {
3898 scancode <= TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3899 /* HKEY event 0x1001 is scancode 0x00 */
3901 if (!(hotkey_source_mask & (1 << scancode))) {
3902 tpacpi_input_send_key_masked(scancode);
3903 *send_acpi_ev = false;
3905 *ignore_acpi_ev = true;
3912 return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3915 /* Extended keycodes start at 0x300 and our offset into the map
3916 * TP_ACPI_HOTKEYSCAN_EXTENDED_START. The calculated scancode
3917 * will be positive, but might not be in the correct range.
3919 scancode -= (0x300 - TP_ACPI_HOTKEYSCAN_EXTENDED_START);
3920 if (scancode >= TP_ACPI_HOTKEYSCAN_EXTENDED_START &&
3921 scancode < TPACPI_HOTKEY_MAP_LEN) {
3922 tpacpi_input_send_key(scancode);
3931 static bool hotkey_notify_wakeup(const u32 hkey,
3933 bool *ignore_acpi_ev)
3935 /* 0x2000-0x2FFF: Wakeup reason */
3936 *send_acpi_ev = true;
3937 *ignore_acpi_ev = false;
3940 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3941 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3942 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3943 *ignore_acpi_ev = true;
3946 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3947 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3948 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3949 *ignore_acpi_ev = true;
3952 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3953 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3954 pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3955 /* how to auto-heal: */
3956 /* 2313: woke up from S3, go to S4/S5 */
3957 /* 2413: woke up from S4, go to S5 */
3964 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3965 pr_info("woke up due to a hot-unplug request...\n");
3966 hotkey_wakeup_reason_notify_change();
3971 static bool hotkey_notify_dockevent(const u32 hkey,
3973 bool *ignore_acpi_ev)
3975 /* 0x4000-0x4FFF: dock-related events */
3976 *send_acpi_ev = true;
3977 *ignore_acpi_ev = false;
3980 case TP_HKEY_EV_UNDOCK_ACK:
3981 /* ACPI undock operation completed after wakeup */
3982 hotkey_autosleep_ack = 1;
3983 pr_info("undocked\n");
3984 hotkey_wakeup_hotunplug_complete_notify_change();
3987 case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3988 pr_info("docked into hotplug port replicator\n");
3990 case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3991 pr_info("undocked from hotplug port replicator\n");
3999 static bool hotkey_notify_usrevent(const u32 hkey,
4001 bool *ignore_acpi_ev)
4003 /* 0x5000-0x5FFF: human interface helpers */
4004 *send_acpi_ev = true;
4005 *ignore_acpi_ev = false;
4008 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
4009 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
4012 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
4013 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
4014 tpacpi_input_send_tabletsw();
4015 hotkey_tablet_mode_notify_change();
4016 *send_acpi_ev = false;
4019 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
4020 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
4021 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
4022 /* do not propagate these events */
4023 *ignore_acpi_ev = true;
4031 static void thermal_dump_all_sensors(void);
4033 static bool hotkey_notify_6xxx(const u32 hkey,
4035 bool *ignore_acpi_ev)
4039 /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
4040 *send_acpi_ev = true;
4041 *ignore_acpi_ev = false;
4044 case TP_HKEY_EV_THM_TABLE_CHANGED:
4045 pr_info("EC reports that Thermal Table has changed\n");
4046 /* recommended action: do nothing, we don't have
4047 * Lenovo ATM information */
4049 case TP_HKEY_EV_ALARM_BAT_HOT:
4050 pr_crit("THERMAL ALARM: battery is too hot!\n");
4051 /* recommended action: warn user through gui */
4053 case TP_HKEY_EV_ALARM_BAT_XHOT:
4054 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
4055 /* recommended action: immediate sleep/hibernate */
4057 case TP_HKEY_EV_ALARM_SENSOR_HOT:
4058 pr_crit("THERMAL ALARM: a sensor reports something is too hot!\n");
4059 /* recommended action: warn user through gui, that */
4060 /* some internal component is too hot */
4062 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
4063 pr_alert("THERMAL EMERGENCY: a sensor reports something is extremely hot!\n");
4064 /* recommended action: immediate sleep/hibernate */
4066 case TP_HKEY_EV_AC_CHANGED:
4067 /* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
4068 * AC status changed; can be triggered by plugging or
4069 * unplugging AC adapter, docking or undocking. */
4073 case TP_HKEY_EV_KEY_NUMLOCK:
4074 case TP_HKEY_EV_KEY_FN:
4075 case TP_HKEY_EV_KEY_FN_ESC:
4076 /* key press events, we just ignore them as long as the EC
4077 * is still reporting them in the normal keyboard stream */
4078 *send_acpi_ev = false;
4079 *ignore_acpi_ev = true;
4082 case TP_HKEY_EV_TABLET_CHANGED:
4083 tpacpi_input_send_tabletsw();
4084 hotkey_tablet_mode_notify_change();
4085 *send_acpi_ev = false;
4088 case TP_HKEY_EV_PALM_DETECTED:
4089 case TP_HKEY_EV_PALM_UNDETECTED:
4090 /* palm detected hovering the keyboard, forward to user-space
4091 * via netlink for consumption */
4095 pr_warn("unknown possible thermal alarm or keyboard event received\n");
4099 thermal_dump_all_sensors();
4104 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
4108 bool ignore_acpi_ev;
4111 if (event != 0x80) {
4112 pr_err("unknown HKEY notification event %d\n", event);
4113 /* forward it to userspace, maybe it knows how to handle it */
4114 acpi_bus_generate_netlink_event(
4115 ibm->acpi->device->pnp.device_class,
4116 dev_name(&ibm->acpi->device->dev),
4122 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
4123 pr_err("failed to retrieve HKEY event\n");
4132 send_acpi_ev = true;
4133 ignore_acpi_ev = false;
4135 switch (hkey >> 12) {
4137 /* 0x1000-0x1FFF: key presses */
4138 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
4142 /* 0x2000-0x2FFF: Wakeup reason */
4143 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
4147 /* 0x3000-0x3FFF: bay-related wakeups */
4149 case TP_HKEY_EV_BAYEJ_ACK:
4150 hotkey_autosleep_ack = 1;
4151 pr_info("bay ejected\n");
4152 hotkey_wakeup_hotunplug_complete_notify_change();
4155 case TP_HKEY_EV_OPTDRV_EJ:
4156 /* FIXME: kick libata if SATA link offline */
4164 /* 0x4000-0x4FFF: dock-related events */
4165 known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
4169 /* 0x5000-0x5FFF: human interface helpers */
4170 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
4174 /* 0x6000-0x6FFF: thermal alarms/notices and
4175 * keyboard events */
4176 known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
4180 /* 0x7000-0x7FFF: misc */
4181 if (tp_features.hotkey_wlsw &&
4182 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
4183 tpacpi_send_radiosw_update();
4188 /* fallthrough to default */
4193 pr_notice("unhandled HKEY event 0x%04x\n", hkey);
4194 pr_notice("please report the conditions when this event happened to %s\n",
4198 /* netlink events */
4199 if (!ignore_acpi_ev && send_acpi_ev) {
4200 acpi_bus_generate_netlink_event(
4201 ibm->acpi->device->pnp.device_class,
4202 dev_name(&ibm->acpi->device->dev),
4208 static void hotkey_suspend(void)
4210 /* Do these on suspend, we get the events on early resume! */
4211 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
4212 hotkey_autosleep_ack = 0;
4214 /* save previous mode of adaptive keyboard of X1 Carbon */
4215 if (tp_features.has_adaptive_kbd) {
4216 if (!acpi_evalf(hkey_handle, &adaptive_keyboard_prev_mode,
4218 pr_err("Cannot read adaptive keyboard mode.\n");
4223 static void hotkey_resume(void)
4225 tpacpi_disable_brightness_delay();
4227 if (hotkey_status_set(true) < 0 ||
4228 hotkey_mask_set(hotkey_acpi_mask) < 0)
4229 pr_err("error while attempting to reset the event firmware interface\n");
4231 tpacpi_send_radiosw_update();
4232 hotkey_tablet_mode_notify_change();
4233 hotkey_wakeup_reason_notify_change();
4234 hotkey_wakeup_hotunplug_complete_notify_change();
4235 hotkey_poll_setup_safe(false);
4237 /* restore previous mode of adapive keyboard of X1 Carbon */
4238 if (tp_features.has_adaptive_kbd) {
4239 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd",
4240 adaptive_keyboard_prev_mode)) {
4241 pr_err("Cannot set adaptive keyboard mode.\n");
4246 /* procfs -------------------------------------------------------------- */
4247 static int hotkey_read(struct seq_file *m)
4251 if (!tp_features.hotkey) {
4252 seq_printf(m, "status:\t\tnot supported\n");
4256 if (mutex_lock_killable(&hotkey_mutex))
4257 return -ERESTARTSYS;
4258 res = hotkey_status_get(&status);
4260 res = hotkey_mask_get();
4261 mutex_unlock(&hotkey_mutex);
4265 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
4266 if (hotkey_all_mask) {
4267 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
4268 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
4270 seq_printf(m, "mask:\t\tnot supported\n");
4271 seq_printf(m, "commands:\tenable, disable, reset\n");
4277 static void hotkey_enabledisable_warn(bool enable)
4279 tpacpi_log_usertask("procfs hotkey enable/disable");
4280 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
4281 pr_fmt("hotkey enable/disable functionality has been removed from the driver. Hotkeys are always enabled.\n")))
4282 pr_err("Please remove the hotkey=enable module parameter, it is deprecated. Hotkeys are always enabled.\n");
4285 static int hotkey_write(char *buf)
4291 if (!tp_features.hotkey)
4294 if (mutex_lock_killable(&hotkey_mutex))
4295 return -ERESTARTSYS;
4297 mask = hotkey_user_mask;
4300 while ((cmd = next_cmd(&buf))) {
4301 if (strlencmp(cmd, "enable") == 0) {
4302 hotkey_enabledisable_warn(1);
4303 } else if (strlencmp(cmd, "disable") == 0) {
4304 hotkey_enabledisable_warn(0);
4306 } else if (strlencmp(cmd, "reset") == 0) {
4307 mask = (hotkey_all_mask | hotkey_source_mask)
4308 & ~hotkey_reserved_mask;
4309 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
4311 } else if (sscanf(cmd, "%x", &mask) == 1) {
4320 tpacpi_disclose_usertask("procfs hotkey",
4321 "set mask to 0x%08x\n", mask);
4322 res = hotkey_user_mask_set(mask);
4326 mutex_unlock(&hotkey_mutex);
4330 static const struct acpi_device_id ibm_htk_device_ids[] = {
4331 {TPACPI_ACPI_IBM_HKEY_HID, 0},
4332 {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
4333 {TPACPI_ACPI_LENOVO_HKEY_V2_HID, 0},
4337 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
4338 .hid = ibm_htk_device_ids,
4339 .notify = hotkey_notify,
4340 .handle = &hkey_handle,
4341 .type = ACPI_DEVICE_NOTIFY,
4344 static struct ibm_struct hotkey_driver_data = {
4346 .read = hotkey_read,
4347 .write = hotkey_write,
4348 .exit = hotkey_exit,
4349 .resume = hotkey_resume,
4350 .suspend = hotkey_suspend,
4351 .acpi = &ibm_hotkey_acpidriver,
4354 /*************************************************************************
4355 * Bluetooth subdriver
4359 /* ACPI GBDC/SBDC bits */
4360 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
4361 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
4362 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
4363 0 = disable, 1 = enable */
4367 /* ACPI \BLTH commands */
4368 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
4369 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
4370 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
4371 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
4372 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
4375 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
4377 static int bluetooth_get_status(void)
4381 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4382 if (dbg_bluetoothemul)
4383 return (tpacpi_bluetooth_emulstate) ?
4384 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4387 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4390 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4391 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4394 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4398 vdbg_printk(TPACPI_DBG_RFKILL,
4399 "will attempt to %s bluetooth\n",
4400 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4402 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4403 if (dbg_bluetoothemul) {
4404 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4409 if (state == TPACPI_RFK_RADIO_ON)
4410 status = TP_ACPI_BLUETOOTH_RADIOSSW
4411 | TP_ACPI_BLUETOOTH_RESUMECTRL;
4415 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4421 /* sysfs bluetooth enable ---------------------------------------------- */
4422 static ssize_t bluetooth_enable_show(struct device *dev,
4423 struct device_attribute *attr,
4426 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4430 static ssize_t bluetooth_enable_store(struct device *dev,
4431 struct device_attribute *attr,
4432 const char *buf, size_t count)
4434 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4438 static DEVICE_ATTR_RW(bluetooth_enable);
4440 /* --------------------------------------------------------------------- */
4442 static struct attribute *bluetooth_attributes[] = {
4443 &dev_attr_bluetooth_enable.attr,
4447 static const struct attribute_group bluetooth_attr_group = {
4448 .attrs = bluetooth_attributes,
4451 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4452 .get_status = bluetooth_get_status,
4453 .set_status = bluetooth_set_status,
4456 static void bluetooth_shutdown(void)
4458 /* Order firmware to save current state to NVRAM */
4459 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4460 TP_ACPI_BLTH_SAVE_STATE))
4461 pr_notice("failed to save bluetooth state to NVRAM\n");
4463 vdbg_printk(TPACPI_DBG_RFKILL,
4464 "bluetooth state saved to NVRAM\n");
4467 static void bluetooth_exit(void)
4469 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4470 &bluetooth_attr_group);
4472 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4474 bluetooth_shutdown();
4477 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4482 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4483 "initializing bluetooth subdriver\n");
4485 TPACPI_ACPIHANDLE_INIT(hkey);
4487 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4488 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4489 tp_features.bluetooth = hkey_handle &&
4490 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4492 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4493 "bluetooth is %s, status 0x%02x\n",
4494 str_supported(tp_features.bluetooth),
4497 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4498 if (dbg_bluetoothemul) {
4499 tp_features.bluetooth = 1;
4500 pr_info("bluetooth switch emulation enabled\n");
4503 if (tp_features.bluetooth &&
4504 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4505 /* no bluetooth hardware present in system */
4506 tp_features.bluetooth = 0;
4507 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4508 "bluetooth hardware not installed\n");
4511 if (!tp_features.bluetooth)
4514 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4515 &bluetooth_tprfk_ops,
4516 RFKILL_TYPE_BLUETOOTH,
4517 TPACPI_RFK_BLUETOOTH_SW_NAME,
4522 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4523 &bluetooth_attr_group);
4525 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4532 /* procfs -------------------------------------------------------------- */
4533 static int bluetooth_read(struct seq_file *m)
4535 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4538 static int bluetooth_write(char *buf)
4540 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4543 static struct ibm_struct bluetooth_driver_data = {
4544 .name = "bluetooth",
4545 .read = bluetooth_read,
4546 .write = bluetooth_write,
4547 .exit = bluetooth_exit,
4548 .shutdown = bluetooth_shutdown,
4551 /*************************************************************************
4556 /* ACPI GWAN/SWAN bits */
4557 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4558 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4559 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4560 0 = disable, 1 = enable */
4563 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4565 static int wan_get_status(void)
4569 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4571 return (tpacpi_wwan_emulstate) ?
4572 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4575 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4578 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4579 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4582 static int wan_set_status(enum tpacpi_rfkill_state state)
4586 vdbg_printk(TPACPI_DBG_RFKILL,
4587 "will attempt to %s wwan\n",
4588 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4590 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4592 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4597 if (state == TPACPI_RFK_RADIO_ON)
4598 status = TP_ACPI_WANCARD_RADIOSSW
4599 | TP_ACPI_WANCARD_RESUMECTRL;
4603 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4609 /* sysfs wan enable ---------------------------------------------------- */
4610 static ssize_t wan_enable_show(struct device *dev,
4611 struct device_attribute *attr,
4614 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4618 static ssize_t wan_enable_store(struct device *dev,
4619 struct device_attribute *attr,
4620 const char *buf, size_t count)
4622 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4626 static DEVICE_ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4627 wan_enable_show, wan_enable_store);
4629 /* --------------------------------------------------------------------- */
4631 static struct attribute *wan_attributes[] = {
4632 &dev_attr_wwan_enable.attr,
4636 static const struct attribute_group wan_attr_group = {
4637 .attrs = wan_attributes,
4640 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4641 .get_status = wan_get_status,
4642 .set_status = wan_set_status,
4645 static void wan_shutdown(void)
4647 /* Order firmware to save current state to NVRAM */
4648 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4649 TP_ACPI_WGSV_SAVE_STATE))
4650 pr_notice("failed to save WWAN state to NVRAM\n");
4652 vdbg_printk(TPACPI_DBG_RFKILL,
4653 "WWAN state saved to NVRAM\n");
4656 static void wan_exit(void)
4658 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4661 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4666 static int __init wan_init(struct ibm_init_struct *iibm)
4671 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4672 "initializing wan subdriver\n");
4674 TPACPI_ACPIHANDLE_INIT(hkey);
4676 tp_features.wan = hkey_handle &&
4677 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4679 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4680 "wan is %s, status 0x%02x\n",
4681 str_supported(tp_features.wan),
4684 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4686 tp_features.wan = 1;
4687 pr_info("wwan switch emulation enabled\n");
4690 if (tp_features.wan &&
4691 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4692 /* no wan hardware present in system */
4693 tp_features.wan = 0;
4694 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4695 "wan hardware not installed\n");
4698 if (!tp_features.wan)
4701 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4704 TPACPI_RFK_WWAN_SW_NAME,
4709 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4713 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4720 /* procfs -------------------------------------------------------------- */
4721 static int wan_read(struct seq_file *m)
4723 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4726 static int wan_write(char *buf)
4728 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4731 static struct ibm_struct wan_driver_data = {
4736 .shutdown = wan_shutdown,
4739 /*************************************************************************
4744 /* ACPI GUWB/SUWB bits */
4745 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4746 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4749 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4751 static int uwb_get_status(void)
4755 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4757 return (tpacpi_uwb_emulstate) ?
4758 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4761 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4764 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4765 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4768 static int uwb_set_status(enum tpacpi_rfkill_state state)
4772 vdbg_printk(TPACPI_DBG_RFKILL,
4773 "will attempt to %s UWB\n",
4774 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4776 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4778 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4783 if (state == TPACPI_RFK_RADIO_ON)
4784 status = TP_ACPI_UWB_RADIOSSW;
4788 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4794 /* --------------------------------------------------------------------- */
4796 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4797 .get_status = uwb_get_status,
4798 .set_status = uwb_set_status,
4801 static void uwb_exit(void)
4803 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4806 static int __init uwb_init(struct ibm_init_struct *iibm)
4811 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4812 "initializing uwb subdriver\n");
4814 TPACPI_ACPIHANDLE_INIT(hkey);
4816 tp_features.uwb = hkey_handle &&
4817 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4819 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4820 "uwb is %s, status 0x%02x\n",
4821 str_supported(tp_features.uwb),
4824 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4826 tp_features.uwb = 1;
4827 pr_info("uwb switch emulation enabled\n");
4830 if (tp_features.uwb &&
4831 !(status & TP_ACPI_UWB_HWPRESENT)) {
4832 /* no uwb hardware present in system */
4833 tp_features.uwb = 0;
4834 dbg_printk(TPACPI_DBG_INIT,
4835 "uwb hardware not installed\n");
4838 if (!tp_features.uwb)
4841 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4844 TPACPI_RFK_UWB_SW_NAME,
4849 static struct ibm_struct uwb_driver_data = {
4852 .flags.experimental = 1,
4855 /*************************************************************************
4859 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4861 enum video_access_mode {
4862 TPACPI_VIDEO_NONE = 0,
4863 TPACPI_VIDEO_570, /* 570 */
4864 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4865 TPACPI_VIDEO_NEW, /* all others */
4868 enum { /* video status flags, based on VIDEO_570 */
4869 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4870 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4871 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4874 enum { /* TPACPI_VIDEO_570 constants */
4875 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4876 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4877 * video_status_flags */
4878 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4879 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4882 static enum video_access_mode video_supported;
4883 static int video_orig_autosw;
4885 static int video_autosw_get(void);
4886 static int video_autosw_set(int enable);
4888 TPACPI_HANDLE(vid, root,
4889 "\\_SB.PCI.AGP.VGA", /* 570 */
4890 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
4891 "\\_SB.PCI0.VID0", /* 770e */
4892 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
4893 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
4894 "\\_SB.PCI0.AGP.VID", /* all others */
4897 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4899 static int __init video_init(struct ibm_init_struct *iibm)
4903 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4905 TPACPI_ACPIHANDLE_INIT(vid);
4906 if (tpacpi_is_ibm())
4907 TPACPI_ACPIHANDLE_INIT(vid2);
4909 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4910 /* G41, assume IVGA doesn't change */
4911 vid_handle = vid2_handle;
4914 /* video switching not supported on R30, R31 */
4915 video_supported = TPACPI_VIDEO_NONE;
4916 else if (tpacpi_is_ibm() &&
4917 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4919 video_supported = TPACPI_VIDEO_570;
4920 else if (tpacpi_is_ibm() &&
4921 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4922 /* 600e/x, 770e, 770x */
4923 video_supported = TPACPI_VIDEO_770;
4926 video_supported = TPACPI_VIDEO_NEW;
4928 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4929 str_supported(video_supported != TPACPI_VIDEO_NONE),
4932 return (video_supported != TPACPI_VIDEO_NONE) ? 0 : 1;
4935 static void video_exit(void)
4937 dbg_printk(TPACPI_DBG_EXIT,
4938 "restoring original video autoswitch mode\n");
4939 if (video_autosw_set(video_orig_autosw))
4940 pr_err("error while trying to restore original video autoswitch mode\n");
4943 static int video_outputsw_get(void)
4948 switch (video_supported) {
4949 case TPACPI_VIDEO_570:
4950 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4951 TP_ACPI_VIDEO_570_PHSCMD))
4953 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4955 case TPACPI_VIDEO_770:
4956 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4959 status |= TP_ACPI_VIDEO_S_LCD;
4960 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4963 status |= TP_ACPI_VIDEO_S_CRT;
4965 case TPACPI_VIDEO_NEW:
4966 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4967 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4970 status |= TP_ACPI_VIDEO_S_CRT;
4972 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4973 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4976 status |= TP_ACPI_VIDEO_S_LCD;
4977 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4980 status |= TP_ACPI_VIDEO_S_DVI;
4989 static int video_outputsw_set(int status)
4994 switch (video_supported) {
4995 case TPACPI_VIDEO_570:
4996 res = acpi_evalf(NULL, NULL,
4997 "\\_SB.PHS2", "vdd",
4998 TP_ACPI_VIDEO_570_PHS2CMD,
4999 status | TP_ACPI_VIDEO_570_PHS2SET);
5001 case TPACPI_VIDEO_770:
5002 autosw = video_autosw_get();
5006 res = video_autosw_set(1);
5009 res = acpi_evalf(vid_handle, NULL,
5010 "ASWT", "vdd", status * 0x100, 0);
5011 if (!autosw && video_autosw_set(autosw)) {
5012 pr_err("video auto-switch left enabled due to error\n");
5016 case TPACPI_VIDEO_NEW:
5017 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
5018 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
5024 return (res) ? 0 : -EIO;
5027 static int video_autosw_get(void)
5031 switch (video_supported) {
5032 case TPACPI_VIDEO_570:
5033 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
5036 case TPACPI_VIDEO_770:
5037 case TPACPI_VIDEO_NEW:
5038 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
5048 static int video_autosw_set(int enable)
5050 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable) ? 1 : 0))
5055 static int video_outputsw_cycle(void)
5057 int autosw = video_autosw_get();
5063 switch (video_supported) {
5064 case TPACPI_VIDEO_570:
5065 res = video_autosw_set(1);
5068 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
5070 case TPACPI_VIDEO_770:
5071 case TPACPI_VIDEO_NEW:
5072 res = video_autosw_set(1);
5075 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
5080 if (!autosw && video_autosw_set(autosw)) {
5081 pr_err("video auto-switch left enabled due to error\n");
5085 return (res) ? 0 : -EIO;
5088 static int video_expand_toggle(void)
5090 switch (video_supported) {
5091 case TPACPI_VIDEO_570:
5092 return acpi_evalf(ec_handle, NULL, "_Q17", "v") ?
5094 case TPACPI_VIDEO_770:
5095 return acpi_evalf(vid_handle, NULL, "VEXP", "v") ?
5097 case TPACPI_VIDEO_NEW:
5098 return acpi_evalf(NULL, NULL, "\\VEXP", "v") ?
5106 static int video_read(struct seq_file *m)
5110 if (video_supported == TPACPI_VIDEO_NONE) {
5111 seq_printf(m, "status:\t\tnot supported\n");
5115 /* Even reads can crash X.org, so... */
5116 if (!capable(CAP_SYS_ADMIN))
5119 status = video_outputsw_get();
5123 autosw = video_autosw_get();
5127 seq_printf(m, "status:\t\tsupported\n");
5128 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
5129 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
5130 if (video_supported == TPACPI_VIDEO_NEW)
5131 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
5132 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
5133 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
5134 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
5135 if (video_supported == TPACPI_VIDEO_NEW)
5136 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
5137 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
5138 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
5143 static int video_write(char *buf)
5146 int enable, disable, status;
5149 if (video_supported == TPACPI_VIDEO_NONE)
5152 /* Even reads can crash X.org, let alone writes... */
5153 if (!capable(CAP_SYS_ADMIN))
5159 while ((cmd = next_cmd(&buf))) {
5160 if (strlencmp(cmd, "lcd_enable") == 0) {
5161 enable |= TP_ACPI_VIDEO_S_LCD;
5162 } else if (strlencmp(cmd, "lcd_disable") == 0) {
5163 disable |= TP_ACPI_VIDEO_S_LCD;
5164 } else if (strlencmp(cmd, "crt_enable") == 0) {
5165 enable |= TP_ACPI_VIDEO_S_CRT;
5166 } else if (strlencmp(cmd, "crt_disable") == 0) {
5167 disable |= TP_ACPI_VIDEO_S_CRT;
5168 } else if (video_supported == TPACPI_VIDEO_NEW &&
5169 strlencmp(cmd, "dvi_enable") == 0) {
5170 enable |= TP_ACPI_VIDEO_S_DVI;
5171 } else if (video_supported == TPACPI_VIDEO_NEW &&
5172 strlencmp(cmd, "dvi_disable") == 0) {
5173 disable |= TP_ACPI_VIDEO_S_DVI;
5174 } else if (strlencmp(cmd, "auto_enable") == 0) {
5175 res = video_autosw_set(1);
5178 } else if (strlencmp(cmd, "auto_disable") == 0) {
5179 res = video_autosw_set(0);
5182 } else if (strlencmp(cmd, "video_switch") == 0) {
5183 res = video_outputsw_cycle();
5186 } else if (strlencmp(cmd, "expand_toggle") == 0) {
5187 res = video_expand_toggle();
5194 if (enable || disable) {
5195 status = video_outputsw_get();
5198 res = video_outputsw_set((status & ~disable) | enable);
5206 static struct ibm_struct video_driver_data = {
5209 .write = video_write,
5213 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
5215 /*************************************************************************
5216 * Keyboard backlight subdriver
5219 static enum led_brightness kbdlight_brightness;
5220 static DEFINE_MUTEX(kbdlight_mutex);
5222 static int kbdlight_set_level(int level)
5229 mutex_lock(&kbdlight_mutex);
5231 if (!acpi_evalf(hkey_handle, NULL, "MLCS", "dd", level))
5234 kbdlight_brightness = level;
5236 mutex_unlock(&kbdlight_mutex);
5241 static int kbdlight_get_level(void)
5248 if (!acpi_evalf(hkey_handle, &status, "MLCG", "dd", 0))
5254 return status & 0x3;
5257 static bool kbdlight_is_supported(void)
5264 if (!acpi_has_method(hkey_handle, "MLCG")) {
5265 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG is unavailable\n");
5269 if (!acpi_evalf(hkey_handle, &status, "MLCG", "qdd", 0)) {
5270 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG failed\n");
5275 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG err: %d\n", status);
5279 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG returned 0x%x\n", status);
5281 * Guessed test for keyboard backlight:
5283 * Machines with backlight keyboard return:
5284 * b010100000010000000XX - ThinkPad X1 Carbon 3rd
5285 * b110100010010000000XX - ThinkPad x230
5286 * b010100000010000000XX - ThinkPad x240
5287 * b010100000010000000XX - ThinkPad W541
5288 * (XX is current backlight level)
5290 * Machines without backlight keyboard return:
5291 * b10100001000000000000 - ThinkPad x230
5292 * b10110001000000000000 - ThinkPad E430
5293 * b00000000000000000000 - ThinkPad E450
5295 * Candidate BITs for detection test (XOR):
5296 * b01000000001000000000
5299 return status & BIT(9);
5302 static int kbdlight_sysfs_set(struct led_classdev *led_cdev,
5303 enum led_brightness brightness)
5305 return kbdlight_set_level(brightness);
5308 static enum led_brightness kbdlight_sysfs_get(struct led_classdev *led_cdev)
5312 level = kbdlight_get_level();
5319 static struct tpacpi_led_classdev tpacpi_led_kbdlight = {
5321 .name = "tpacpi::kbd_backlight",
5322 .max_brightness = 2,
5323 .flags = LED_BRIGHT_HW_CHANGED,
5324 .brightness_set_blocking = &kbdlight_sysfs_set,
5325 .brightness_get = &kbdlight_sysfs_get,
5329 static int __init kbdlight_init(struct ibm_init_struct *iibm)
5333 vdbg_printk(TPACPI_DBG_INIT, "initializing kbdlight subdriver\n");
5335 TPACPI_ACPIHANDLE_INIT(hkey);
5337 if (!kbdlight_is_supported()) {
5338 tp_features.kbdlight = 0;
5339 vdbg_printk(TPACPI_DBG_INIT, "kbdlight is unsupported\n");
5343 kbdlight_brightness = kbdlight_sysfs_get(NULL);
5344 tp_features.kbdlight = 1;
5346 rc = led_classdev_register(&tpacpi_pdev->dev,
5347 &tpacpi_led_kbdlight.led_classdev);
5349 tp_features.kbdlight = 0;
5353 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask |
5354 TP_ACPI_HKEY_KBD_LIGHT_MASK);
5358 static void kbdlight_exit(void)
5360 if (tp_features.kbdlight)
5361 led_classdev_unregister(&tpacpi_led_kbdlight.led_classdev);
5364 static int kbdlight_set_level_and_update(int level)
5367 struct led_classdev *led_cdev;
5369 ret = kbdlight_set_level(level);
5370 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5372 if (ret == 0 && !(led_cdev->flags & LED_SUSPENDED))
5373 led_cdev->brightness = level;
5378 static int kbdlight_read(struct seq_file *m)
5382 if (!tp_features.kbdlight) {
5383 seq_printf(m, "status:\t\tnot supported\n");
5385 level = kbdlight_get_level();
5387 seq_printf(m, "status:\t\terror %d\n", level);
5389 seq_printf(m, "status:\t\t%d\n", level);
5390 seq_printf(m, "commands:\t0, 1, 2\n");
5396 static int kbdlight_write(char *buf)
5401 if (!tp_features.kbdlight)
5404 while ((cmd = next_cmd(&buf))) {
5405 if (strlencmp(cmd, "0") == 0)
5407 else if (strlencmp(cmd, "1") == 0)
5409 else if (strlencmp(cmd, "2") == 0)
5418 return kbdlight_set_level_and_update(level);
5421 static void kbdlight_suspend(void)
5423 struct led_classdev *led_cdev;
5425 if (!tp_features.kbdlight)
5428 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5429 led_update_brightness(led_cdev);
5430 led_classdev_suspend(led_cdev);
5433 static void kbdlight_resume(void)
5435 if (!tp_features.kbdlight)
5438 led_classdev_resume(&tpacpi_led_kbdlight.led_classdev);
5441 static struct ibm_struct kbdlight_driver_data = {
5443 .read = kbdlight_read,
5444 .write = kbdlight_write,
5445 .suspend = kbdlight_suspend,
5446 .resume = kbdlight_resume,
5447 .exit = kbdlight_exit,
5450 /*************************************************************************
5451 * Light (thinklight) subdriver
5454 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
5455 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
5457 static int light_get_status(void)
5461 if (tp_features.light_status) {
5462 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
5470 static int light_set_status(int status)
5474 if (tp_features.light) {
5476 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
5478 TP_CMOS_THINKLIGHT_ON :
5479 TP_CMOS_THINKLIGHT_OFF);
5481 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
5484 return (rc) ? 0 : -EIO;
5490 static int light_sysfs_set(struct led_classdev *led_cdev,
5491 enum led_brightness brightness)
5493 return light_set_status((brightness != LED_OFF) ?
5494 TPACPI_LED_ON : TPACPI_LED_OFF);
5497 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
5499 return (light_get_status() == 1) ? LED_FULL : LED_OFF;
5502 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
5504 .name = "tpacpi::thinklight",
5505 .brightness_set_blocking = &light_sysfs_set,
5506 .brightness_get = &light_sysfs_get,
5510 static int __init light_init(struct ibm_init_struct *iibm)
5514 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
5516 if (tpacpi_is_ibm()) {
5517 TPACPI_ACPIHANDLE_INIT(ledb);
5518 TPACPI_ACPIHANDLE_INIT(lght);
5520 TPACPI_ACPIHANDLE_INIT(cmos);
5522 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
5523 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
5525 if (tp_features.light)
5526 /* light status not supported on
5527 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
5528 tp_features.light_status =
5529 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
5531 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
5532 str_supported(tp_features.light),
5533 str_supported(tp_features.light_status));
5535 if (!tp_features.light)
5538 rc = led_classdev_register(&tpacpi_pdev->dev,
5539 &tpacpi_led_thinklight.led_classdev);
5542 tp_features.light = 0;
5543 tp_features.light_status = 0;
5551 static void light_exit(void)
5553 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
5556 static int light_read(struct seq_file *m)
5560 if (!tp_features.light) {
5561 seq_printf(m, "status:\t\tnot supported\n");
5562 } else if (!tp_features.light_status) {
5563 seq_printf(m, "status:\t\tunknown\n");
5564 seq_printf(m, "commands:\ton, off\n");
5566 status = light_get_status();
5569 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
5570 seq_printf(m, "commands:\ton, off\n");
5576 static int light_write(char *buf)
5581 if (!tp_features.light)
5584 while ((cmd = next_cmd(&buf))) {
5585 if (strlencmp(cmd, "on") == 0) {
5587 } else if (strlencmp(cmd, "off") == 0) {
5593 return light_set_status(newstatus);
5596 static struct ibm_struct light_driver_data = {
5599 .write = light_write,
5603 /*************************************************************************
5607 /* sysfs cmos_command -------------------------------------------------- */
5608 static ssize_t cmos_command_store(struct device *dev,
5609 struct device_attribute *attr,
5610 const char *buf, size_t count)
5612 unsigned long cmos_cmd;
5615 if (parse_strtoul(buf, 21, &cmos_cmd))
5618 res = issue_thinkpad_cmos_command(cmos_cmd);
5619 return (res) ? res : count;
5622 static DEVICE_ATTR_WO(cmos_command);
5624 /* --------------------------------------------------------------------- */
5626 static int __init cmos_init(struct ibm_init_struct *iibm)
5630 vdbg_printk(TPACPI_DBG_INIT,
5631 "initializing cmos commands subdriver\n");
5633 TPACPI_ACPIHANDLE_INIT(cmos);
5635 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5636 str_supported(cmos_handle != NULL));
5638 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5642 return (cmos_handle) ? 0 : 1;
5645 static void cmos_exit(void)
5647 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5650 static int cmos_read(struct seq_file *m)
5652 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5653 R30, R31, T20-22, X20-21 */
5655 seq_printf(m, "status:\t\tnot supported\n");
5657 seq_printf(m, "status:\t\tsupported\n");
5658 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5664 static int cmos_write(char *buf)
5669 while ((cmd = next_cmd(&buf))) {
5670 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5671 cmos_cmd >= 0 && cmos_cmd <= 21) {
5676 res = issue_thinkpad_cmos_command(cmos_cmd);
5684 static struct ibm_struct cmos_driver_data = {
5687 .write = cmos_write,
5691 /*************************************************************************
5695 enum led_access_mode {
5696 TPACPI_LED_NONE = 0,
5697 TPACPI_LED_570, /* 570 */
5698 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5699 TPACPI_LED_NEW, /* all others */
5702 enum { /* For TPACPI_LED_OLD */
5703 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5704 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5705 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5708 static enum led_access_mode led_supported;
5710 static acpi_handle led_handle;
5712 #define TPACPI_LED_NUMLEDS 16
5713 static struct tpacpi_led_classdev *tpacpi_leds;
5714 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5715 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5716 /* there's a limit of 19 chars + NULL before 2.6.26 */
5718 "tpacpi:orange:batt",
5719 "tpacpi:green:batt",
5720 "tpacpi::dock_active",
5721 "tpacpi::bay_active",
5722 "tpacpi::dock_batt",
5723 "tpacpi::unknown_led",
5725 "tpacpi::dock_status1",
5726 "tpacpi::dock_status2",
5727 "tpacpi::unknown_led2",
5728 "tpacpi::unknown_led3",
5729 "tpacpi::thinkvantage",
5731 #define TPACPI_SAFE_LEDS 0x1081U
5733 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5735 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5738 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5742 static int led_get_status(const unsigned int led)
5745 enum led_status_t led_s;
5747 switch (led_supported) {
5748 case TPACPI_LED_570:
5749 if (!acpi_evalf(ec_handle,
5750 &status, "GLED", "dd", 1 << led))
5752 led_s = (status == 0) ?
5757 tpacpi_led_state_cache[led] = led_s;
5766 static int led_set_status(const unsigned int led,
5767 const enum led_status_t ledstatus)
5769 /* off, on, blink. Index is led_status_t */
5770 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5771 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5775 switch (led_supported) {
5776 case TPACPI_LED_570:
5778 if (unlikely(led > 7))
5780 if (unlikely(tpacpi_is_led_restricted(led)))
5782 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5783 (1 << led), led_sled_arg1[ledstatus]))
5786 case TPACPI_LED_OLD:
5787 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5788 if (unlikely(led > 7))
5790 if (unlikely(tpacpi_is_led_restricted(led)))
5792 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5794 rc = ec_write(TPACPI_LED_EC_HLBL,
5795 (ledstatus == TPACPI_LED_BLINK) << led);
5797 rc = ec_write(TPACPI_LED_EC_HLCL,
5798 (ledstatus != TPACPI_LED_OFF) << led);
5800 case TPACPI_LED_NEW:
5802 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5804 if (unlikely(tpacpi_is_led_restricted(led)))
5806 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5807 led, led_led_arg1[ledstatus]))
5815 tpacpi_led_state_cache[led] = ledstatus;
5820 static int led_sysfs_set(struct led_classdev *led_cdev,
5821 enum led_brightness brightness)
5823 struct tpacpi_led_classdev *data = container_of(led_cdev,
5824 struct tpacpi_led_classdev, led_classdev);
5825 enum led_status_t new_state;
5827 if (brightness == LED_OFF)
5828 new_state = TPACPI_LED_OFF;
5829 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5830 new_state = TPACPI_LED_ON;
5832 new_state = TPACPI_LED_BLINK;
5834 return led_set_status(data->led, new_state);
5837 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5838 unsigned long *delay_on, unsigned long *delay_off)
5840 struct tpacpi_led_classdev *data = container_of(led_cdev,
5841 struct tpacpi_led_classdev, led_classdev);
5843 /* Can we choose the flash rate? */
5844 if (*delay_on == 0 && *delay_off == 0) {
5845 /* yes. set them to the hardware blink rate (1 Hz) */
5846 *delay_on = 500; /* ms */
5847 *delay_off = 500; /* ms */
5848 } else if ((*delay_on != 500) || (*delay_off != 500))
5851 return led_set_status(data->led, TPACPI_LED_BLINK);
5854 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5858 struct tpacpi_led_classdev *data = container_of(led_cdev,
5859 struct tpacpi_led_classdev, led_classdev);
5861 rc = led_get_status(data->led);
5863 if (rc == TPACPI_LED_OFF || rc < 0)
5864 rc = LED_OFF; /* no error handling in led class :( */
5871 static void led_exit(void)
5875 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5876 if (tpacpi_leds[i].led_classdev.name)
5877 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5883 static int __init tpacpi_init_led(unsigned int led)
5887 tpacpi_leds[led].led = led;
5889 /* LEDs with no name don't get registered */
5890 if (!tpacpi_led_names[led])
5893 tpacpi_leds[led].led_classdev.brightness_set_blocking = &led_sysfs_set;
5894 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5895 if (led_supported == TPACPI_LED_570)
5896 tpacpi_leds[led].led_classdev.brightness_get =
5899 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5901 rc = led_classdev_register(&tpacpi_pdev->dev,
5902 &tpacpi_leds[led].led_classdev);
5904 tpacpi_leds[led].led_classdev.name = NULL;
5909 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5910 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5911 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5912 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5914 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5915 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5916 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5917 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5918 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5919 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5920 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5921 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5923 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5924 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5925 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5926 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5927 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5929 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5930 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5931 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5932 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5934 /* (1) - may have excess leds enabled on MSB */
5936 /* Defaults (order matters, keep last, don't reorder!) */
5938 .vendor = PCI_VENDOR_ID_LENOVO,
5939 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5942 { /* IBM ThinkPads with no EC version string */
5943 .vendor = PCI_VENDOR_ID_IBM,
5944 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5947 { /* IBM ThinkPads with EC version string */
5948 .vendor = PCI_VENDOR_ID_IBM,
5949 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5954 #undef TPACPI_LEDQ_IBM
5955 #undef TPACPI_LEDQ_LNV
5957 static enum led_access_mode __init led_init_detect_mode(void)
5961 if (tpacpi_is_ibm()) {
5963 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5964 if (ACPI_SUCCESS(status))
5965 return TPACPI_LED_570;
5967 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5968 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5969 if (ACPI_SUCCESS(status))
5970 return TPACPI_LED_OLD;
5974 status = acpi_get_handle(ec_handle, "LED", &led_handle);
5975 if (ACPI_SUCCESS(status))
5976 return TPACPI_LED_NEW;
5978 /* R30, R31, and unknown firmwares */
5980 return TPACPI_LED_NONE;
5983 static int __init led_init(struct ibm_init_struct *iibm)
5987 unsigned long useful_leds;
5989 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5991 led_supported = led_init_detect_mode();
5993 if (led_supported != TPACPI_LED_NONE) {
5994 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5995 ARRAY_SIZE(led_useful_qtable));
5999 led_supported = TPACPI_LED_NONE;
6003 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
6004 str_supported(led_supported), led_supported);
6006 if (led_supported == TPACPI_LED_NONE)
6009 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
6012 pr_err("Out of memory for LED data\n");
6016 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
6017 tpacpi_leds[i].led = -1;
6019 if (!tpacpi_is_led_restricted(i) &&
6020 test_bit(i, &useful_leds)) {
6021 rc = tpacpi_init_led(i);
6029 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
6030 pr_notice("warning: userspace override of important firmware LEDs is enabled\n");
6035 #define str_led_status(s) \
6036 ((s) == TPACPI_LED_OFF ? "off" : \
6037 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
6039 static int led_read(struct seq_file *m)
6041 if (!led_supported) {
6042 seq_printf(m, "status:\t\tnot supported\n");
6045 seq_printf(m, "status:\t\tsupported\n");
6047 if (led_supported == TPACPI_LED_570) {
6050 for (i = 0; i < 8; i++) {
6051 status = led_get_status(i);
6054 seq_printf(m, "%d:\t\t%s\n",
6055 i, str_led_status(status));
6059 seq_printf(m, "commands:\t<led> on, <led> off, <led> blink (<led> is 0-15)\n");
6064 static int led_write(char *buf)
6068 enum led_status_t s;
6073 while ((cmd = next_cmd(&buf))) {
6074 if (sscanf(cmd, "%d", &led) != 1)
6077 if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1) ||
6078 tpacpi_leds[led].led < 0)
6081 if (strstr(cmd, "off")) {
6083 } else if (strstr(cmd, "on")) {
6085 } else if (strstr(cmd, "blink")) {
6086 s = TPACPI_LED_BLINK;
6091 rc = led_set_status(led, s);
6099 static struct ibm_struct led_driver_data = {
6106 /*************************************************************************
6110 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
6112 #define TPACPI_BEEP_Q1 0x0001
6114 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
6115 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
6116 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
6119 static int __init beep_init(struct ibm_init_struct *iibm)
6121 unsigned long quirks;
6123 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
6125 TPACPI_ACPIHANDLE_INIT(beep);
6127 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
6128 str_supported(beep_handle != NULL));
6130 quirks = tpacpi_check_quirks(beep_quirk_table,
6131 ARRAY_SIZE(beep_quirk_table));
6133 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
6135 return (beep_handle) ? 0 : 1;
6138 static int beep_read(struct seq_file *m)
6141 seq_printf(m, "status:\t\tnot supported\n");
6143 seq_printf(m, "status:\t\tsupported\n");
6144 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
6150 static int beep_write(char *buf)
6158 while ((cmd = next_cmd(&buf))) {
6159 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
6160 beep_cmd >= 0 && beep_cmd <= 17) {
6164 if (tp_features.beep_needs_two_args) {
6165 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
6169 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
6178 static struct ibm_struct beep_driver_data = {
6181 .write = beep_write,
6184 /*************************************************************************
6188 enum thermal_access_mode {
6189 TPACPI_THERMAL_NONE = 0, /* No thermal support */
6190 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
6191 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
6192 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
6193 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
6196 enum { /* TPACPI_THERMAL_TPEC_* */
6197 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
6198 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
6199 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
6201 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
6205 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
6206 struct ibm_thermal_sensors_struct {
6207 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
6210 static enum thermal_access_mode thermal_read_mode;
6212 /* idx is zero-based */
6213 static int thermal_get_sensor(int idx, s32 *value)
6219 t = TP_EC_THERMAL_TMP0;
6221 switch (thermal_read_mode) {
6222 #if TPACPI_MAX_THERMAL_SENSORS >= 16
6223 case TPACPI_THERMAL_TPEC_16:
6224 if (idx >= 8 && idx <= 15) {
6225 t = TP_EC_THERMAL_TMP8;
6230 case TPACPI_THERMAL_TPEC_8:
6232 if (!acpi_ec_read(t + idx, &tmp))
6234 *value = tmp * 1000;
6239 case TPACPI_THERMAL_ACPI_UPDT:
6241 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6242 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
6244 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6246 *value = (t - 2732) * 100;
6251 case TPACPI_THERMAL_ACPI_TMP07:
6253 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6254 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6256 if (t > 127 || t < -127)
6257 t = TP_EC_THERMAL_TMP_NA;
6263 case TPACPI_THERMAL_NONE:
6271 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
6282 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
6285 for (i = 0 ; i < n; i++) {
6286 res = thermal_get_sensor(i, &s->temp[i]);
6294 static void thermal_dump_all_sensors(void)
6297 struct ibm_thermal_sensors_struct t;
6299 n = thermal_get_sensors(&t);
6303 pr_notice("temperatures (Celsius):");
6305 for (i = 0; i < n; i++) {
6306 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
6307 pr_cont(" %d", (int)(t.temp[i] / 1000));
6315 /* sysfs temp##_input -------------------------------------------------- */
6317 static ssize_t thermal_temp_input_show(struct device *dev,
6318 struct device_attribute *attr,
6321 struct sensor_device_attribute *sensor_attr =
6322 to_sensor_dev_attr(attr);
6323 int idx = sensor_attr->index;
6327 res = thermal_get_sensor(idx, &value);
6330 if (value == TPACPI_THERMAL_SENSOR_NA)
6333 return snprintf(buf, PAGE_SIZE, "%d\n", value);
6336 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
6337 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
6338 thermal_temp_input_show, NULL, _idxB)
6340 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
6341 THERMAL_SENSOR_ATTR_TEMP(1, 0),
6342 THERMAL_SENSOR_ATTR_TEMP(2, 1),
6343 THERMAL_SENSOR_ATTR_TEMP(3, 2),
6344 THERMAL_SENSOR_ATTR_TEMP(4, 3),
6345 THERMAL_SENSOR_ATTR_TEMP(5, 4),
6346 THERMAL_SENSOR_ATTR_TEMP(6, 5),
6347 THERMAL_SENSOR_ATTR_TEMP(7, 6),
6348 THERMAL_SENSOR_ATTR_TEMP(8, 7),
6349 THERMAL_SENSOR_ATTR_TEMP(9, 8),
6350 THERMAL_SENSOR_ATTR_TEMP(10, 9),
6351 THERMAL_SENSOR_ATTR_TEMP(11, 10),
6352 THERMAL_SENSOR_ATTR_TEMP(12, 11),
6353 THERMAL_SENSOR_ATTR_TEMP(13, 12),
6354 THERMAL_SENSOR_ATTR_TEMP(14, 13),
6355 THERMAL_SENSOR_ATTR_TEMP(15, 14),
6356 THERMAL_SENSOR_ATTR_TEMP(16, 15),
6359 #define THERMAL_ATTRS(X) \
6360 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
6362 static struct attribute *thermal_temp_input_attr[] = {
6382 static const struct attribute_group thermal_temp_input16_group = {
6383 .attrs = thermal_temp_input_attr
6386 static const struct attribute_group thermal_temp_input8_group = {
6387 .attrs = &thermal_temp_input_attr[8]
6390 #undef THERMAL_SENSOR_ATTR_TEMP
6391 #undef THERMAL_ATTRS
6393 /* --------------------------------------------------------------------- */
6395 static int __init thermal_init(struct ibm_init_struct *iibm)
6402 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
6404 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
6406 if (thinkpad_id.ec_model) {
6408 * Direct EC access mode: sensors at registers
6409 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
6410 * non-implemented, thermal sensors return 0x80 when
6415 for (i = 0; i < 8; i++) {
6416 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
6422 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
6430 /* This is sheer paranoia, but we handle it anyway */
6432 pr_err("ThinkPad ACPI EC access misbehaving, falling back to ACPI TMPx access mode\n");
6433 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6435 pr_err("ThinkPad ACPI EC access misbehaving, disabling thermal sensors access\n");
6436 thermal_read_mode = TPACPI_THERMAL_NONE;
6441 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
6443 } else if (acpi_tmp7) {
6444 if (tpacpi_is_ibm() &&
6445 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
6446 /* 600e/x, 770e, 770x */
6447 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
6449 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
6450 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6453 /* temperatures not supported on 570, G4x, R30, R31, R32 */
6454 thermal_read_mode = TPACPI_THERMAL_NONE;
6457 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
6458 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
6461 switch (thermal_read_mode) {
6462 case TPACPI_THERMAL_TPEC_16:
6463 res = sysfs_create_group(&tpacpi_hwmon->kobj,
6464 &thermal_temp_input16_group);
6468 case TPACPI_THERMAL_TPEC_8:
6469 case TPACPI_THERMAL_ACPI_TMP07:
6470 case TPACPI_THERMAL_ACPI_UPDT:
6471 res = sysfs_create_group(&tpacpi_hwmon->kobj,
6472 &thermal_temp_input8_group);
6476 case TPACPI_THERMAL_NONE:
6484 static void thermal_exit(void)
6486 switch (thermal_read_mode) {
6487 case TPACPI_THERMAL_TPEC_16:
6488 sysfs_remove_group(&tpacpi_hwmon->kobj,
6489 &thermal_temp_input16_group);
6491 case TPACPI_THERMAL_TPEC_8:
6492 case TPACPI_THERMAL_ACPI_TMP07:
6493 case TPACPI_THERMAL_ACPI_UPDT:
6494 sysfs_remove_group(&tpacpi_hwmon->kobj,
6495 &thermal_temp_input8_group);
6497 case TPACPI_THERMAL_NONE:
6503 static int thermal_read(struct seq_file *m)
6506 struct ibm_thermal_sensors_struct t;
6508 n = thermal_get_sensors(&t);
6509 if (unlikely(n < 0))
6512 seq_printf(m, "temperatures:\t");
6515 for (i = 0; i < (n - 1); i++)
6516 seq_printf(m, "%d ", t.temp[i] / 1000);
6517 seq_printf(m, "%d\n", t.temp[i] / 1000);
6519 seq_printf(m, "not supported\n");
6524 static struct ibm_struct thermal_driver_data = {
6526 .read = thermal_read,
6527 .exit = thermal_exit,
6530 /*************************************************************************
6531 * Backlight/brightness subdriver
6534 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
6537 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
6538 * CMOS NVRAM byte 0x5E, bits 0-3.
6540 * EC HBRV (0x31) has the following layout
6541 * Bit 7: unknown function
6542 * Bit 6: unknown function
6543 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
6544 * Bit 4: must be set to zero to avoid problems
6545 * Bit 3-0: backlight brightness level
6547 * brightness_get_raw returns status data in the HBRV layout
6549 * WARNING: The X61 has been verified to use HBRV for something else, so
6550 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
6551 * testing on the very early *60 Lenovo models...
6555 TP_EC_BACKLIGHT = 0x31,
6557 /* TP_EC_BACKLIGHT bitmasks */
6558 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6559 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6560 TP_EC_BACKLIGHT_MAPSW = 0x20,
6563 enum tpacpi_brightness_access_mode {
6564 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
6565 TPACPI_BRGHT_MODE_EC, /* EC control */
6566 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
6567 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6568 TPACPI_BRGHT_MODE_MAX
6571 static struct backlight_device *ibm_backlight_device;
6573 static enum tpacpi_brightness_access_mode brightness_mode =
6574 TPACPI_BRGHT_MODE_MAX;
6576 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6578 static struct mutex brightness_mutex;
6580 /* NVRAM brightness access,
6581 * call with brightness_mutex held! */
6582 static unsigned int tpacpi_brightness_nvram_get(void)
6586 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6587 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6588 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6589 lnvram &= bright_maxlvl;
6594 static void tpacpi_brightness_checkpoint_nvram(void)
6599 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6602 vdbg_printk(TPACPI_DBG_BRGHT,
6603 "trying to checkpoint backlight level to NVRAM...\n");
6605 if (mutex_lock_killable(&brightness_mutex) < 0)
6608 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6610 lec &= TP_EC_BACKLIGHT_LVLMSK;
6611 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6613 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6614 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6615 /* NVRAM needs update */
6616 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6617 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6619 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6620 dbg_printk(TPACPI_DBG_BRGHT,
6621 "updated NVRAM backlight level to %u (0x%02x)\n",
6622 (unsigned int) lec, (unsigned int) b_nvram);
6624 vdbg_printk(TPACPI_DBG_BRGHT,
6625 "NVRAM backlight level already is %u (0x%02x)\n",
6626 (unsigned int) lec, (unsigned int) b_nvram);
6629 mutex_unlock(&brightness_mutex);
6633 /* call with brightness_mutex held! */
6634 static int tpacpi_brightness_get_raw(int *status)
6638 switch (brightness_mode) {
6639 case TPACPI_BRGHT_MODE_UCMS_STEP:
6640 *status = tpacpi_brightness_nvram_get();
6642 case TPACPI_BRGHT_MODE_EC:
6643 case TPACPI_BRGHT_MODE_ECNVRAM:
6644 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6653 /* call with brightness_mutex held! */
6654 /* do NOT call with illegal backlight level value */
6655 static int tpacpi_brightness_set_ec(unsigned int value)
6659 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6662 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6663 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6664 (value & TP_EC_BACKLIGHT_LVLMSK))))
6670 /* call with brightness_mutex held! */
6671 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6674 unsigned int current_value, i;
6676 current_value = tpacpi_brightness_nvram_get();
6678 if (value == current_value)
6681 cmos_cmd = (value > current_value) ?
6682 TP_CMOS_BRIGHTNESS_UP :
6683 TP_CMOS_BRIGHTNESS_DOWN;
6684 inc = (value > current_value) ? 1 : -1;
6686 for (i = current_value; i != value; i += inc)
6687 if (issue_thinkpad_cmos_command(cmos_cmd))
6693 /* May return EINTR which can always be mapped to ERESTARTSYS */
6694 static int brightness_set(unsigned int value)
6698 if (value > bright_maxlvl)
6701 vdbg_printk(TPACPI_DBG_BRGHT,
6702 "set backlight level to %d\n", value);
6704 res = mutex_lock_killable(&brightness_mutex);
6708 switch (brightness_mode) {
6709 case TPACPI_BRGHT_MODE_EC:
6710 case TPACPI_BRGHT_MODE_ECNVRAM:
6711 res = tpacpi_brightness_set_ec(value);
6713 case TPACPI_BRGHT_MODE_UCMS_STEP:
6714 res = tpacpi_brightness_set_ucmsstep(value);
6720 mutex_unlock(&brightness_mutex);
6724 /* sysfs backlight class ----------------------------------------------- */
6726 static int brightness_update_status(struct backlight_device *bd)
6728 unsigned int level =
6729 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6730 bd->props.power == FB_BLANK_UNBLANK) ?
6731 bd->props.brightness : 0;
6733 dbg_printk(TPACPI_DBG_BRGHT,
6734 "backlight: attempt to set level to %d\n",
6737 /* it is the backlight class's job (caller) to handle
6738 * EINTR and other errors properly */
6739 return brightness_set(level);
6742 static int brightness_get(struct backlight_device *bd)
6746 res = mutex_lock_killable(&brightness_mutex);
6750 res = tpacpi_brightness_get_raw(&status);
6752 mutex_unlock(&brightness_mutex);
6757 return status & TP_EC_BACKLIGHT_LVLMSK;
6760 static void tpacpi_brightness_notify_change(void)
6762 backlight_force_update(ibm_backlight_device,
6763 BACKLIGHT_UPDATE_HOTKEY);
6766 static const struct backlight_ops ibm_backlight_data = {
6767 .get_brightness = brightness_get,
6768 .update_status = brightness_update_status,
6771 /* --------------------------------------------------------------------- */
6774 * Call _BCL method of video device. On some ThinkPads this will
6775 * switch the firmware to the ACPI brightness control mode.
6778 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6780 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6781 union acpi_object *obj;
6782 struct acpi_device *device, *child;
6785 if (acpi_bus_get_device(handle, &device))
6789 list_for_each_entry(child, &device->children, node) {
6790 acpi_status status = acpi_evaluate_object(child->handle, "_BCL",
6792 if (ACPI_FAILURE(status))
6795 obj = (union acpi_object *)buffer.pointer;
6796 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6797 pr_err("Unknown _BCL data, please report this to %s\n",
6801 rc = obj->package.count;
6806 kfree(buffer.pointer);
6812 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6814 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6816 acpi_handle video_device;
6819 tpacpi_acpi_handle_locate("video", NULL, &video_device);
6821 bcl_levels = tpacpi_query_bcl_levels(video_device);
6823 tp_features.bright_acpimode = (bcl_levels > 0);
6825 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6829 * These are only useful for models that have only one possibility
6830 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6833 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6834 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6835 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6837 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6838 /* Models with ATI GPUs known to require ECNVRAM mode */
6839 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6841 /* Models with ATI GPUs that can use ECNVRAM */
6842 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6843 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6844 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6845 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6847 /* Models with Intel Extreme Graphics 2 */
6848 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6849 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6850 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6852 /* Models with Intel GMA900 */
6853 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6854 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6855 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6859 * Returns < 0 for error, otherwise sets tp_features.bright_*
6860 * and bright_maxlvl.
6862 static void __init tpacpi_detect_brightness_capabilities(void)
6866 vdbg_printk(TPACPI_DBG_INIT,
6867 "detecting firmware brightness interface capabilities\n");
6869 /* we could run a quirks check here (same table used by
6870 * brightness_init) if needed */
6873 * We always attempt to detect acpi support, so as to switch
6874 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6875 * going to publish a backlight interface
6877 b = tpacpi_check_std_acpi_brightness_support();
6887 tp_features.bright_unkfw = 1;
6888 bright_maxlvl = b - 1;
6890 pr_debug("detected %u brightness levels\n", bright_maxlvl + 1);
6893 static int __init brightness_init(struct ibm_init_struct *iibm)
6895 struct backlight_properties props;
6897 unsigned long quirks;
6899 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6901 mutex_init(&brightness_mutex);
6903 quirks = tpacpi_check_quirks(brightness_quirk_table,
6904 ARRAY_SIZE(brightness_quirk_table));
6906 /* tpacpi_detect_brightness_capabilities() must have run already */
6908 /* if it is unknown, we don't handle it: it wouldn't be safe */
6909 if (tp_features.bright_unkfw)
6912 if (!brightness_enable) {
6913 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6914 "brightness support disabled by module parameter\n");
6918 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
6919 if (brightness_enable > 1) {
6920 pr_info("Standard ACPI backlight interface available, not loading native one\n");
6922 } else if (brightness_enable == 1) {
6923 pr_warn("Cannot enable backlight brightness support, ACPI is already handling it. Refer to the acpi_backlight kernel parameter.\n");
6926 } else if (tp_features.bright_acpimode && brightness_enable > 1) {
6927 pr_notice("Standard ACPI backlight interface not available, thinkpad_acpi native brightness control enabled\n");
6931 * Check for module parameter bogosity, note that we
6932 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6933 * able to detect "unspecified"
6935 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6938 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6939 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6940 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6941 if (quirks & TPACPI_BRGHT_Q_EC)
6942 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6944 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6946 dbg_printk(TPACPI_DBG_BRGHT,
6947 "driver auto-selected brightness_mode=%d\n",
6952 if (!tpacpi_is_ibm() &&
6953 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6954 brightness_mode == TPACPI_BRGHT_MODE_EC))
6957 if (tpacpi_brightness_get_raw(&b) < 0)
6960 memset(&props, 0, sizeof(struct backlight_properties));
6961 props.type = BACKLIGHT_PLATFORM;
6962 props.max_brightness = bright_maxlvl;
6963 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6964 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6966 &ibm_backlight_data,
6968 if (IS_ERR(ibm_backlight_device)) {
6969 int rc = PTR_ERR(ibm_backlight_device);
6970 ibm_backlight_device = NULL;
6971 pr_err("Could not register backlight device\n");
6974 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6975 "brightness is supported\n");
6977 if (quirks & TPACPI_BRGHT_Q_ASK) {
6978 pr_notice("brightness: will use unverified default: brightness_mode=%d\n",
6980 pr_notice("brightness: please report to %s whether it works well or not on your ThinkPad\n",
6984 /* Added by mistake in early 2007. Probably useless, but it could
6985 * be working around some unknown firmware problem where the value
6986 * read at startup doesn't match the real hardware state... so leave
6987 * it in place just in case */
6988 backlight_update_status(ibm_backlight_device);
6990 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6991 "brightness: registering brightness hotkeys as change notification\n");
6992 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6993 | TP_ACPI_HKEY_BRGHTUP_MASK
6994 | TP_ACPI_HKEY_BRGHTDWN_MASK);
6998 static void brightness_suspend(void)
7000 tpacpi_brightness_checkpoint_nvram();
7003 static void brightness_shutdown(void)
7005 tpacpi_brightness_checkpoint_nvram();
7008 static void brightness_exit(void)
7010 if (ibm_backlight_device) {
7011 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
7012 "calling backlight_device_unregister()\n");
7013 backlight_device_unregister(ibm_backlight_device);
7016 tpacpi_brightness_checkpoint_nvram();
7019 static int brightness_read(struct seq_file *m)
7023 level = brightness_get(NULL);
7025 seq_printf(m, "level:\t\tunreadable\n");
7027 seq_printf(m, "level:\t\t%d\n", level);
7028 seq_printf(m, "commands:\tup, down\n");
7029 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7036 static int brightness_write(char *buf)
7042 level = brightness_get(NULL);
7046 while ((cmd = next_cmd(&buf))) {
7047 if (strlencmp(cmd, "up") == 0) {
7048 if (level < bright_maxlvl)
7050 } else if (strlencmp(cmd, "down") == 0) {
7053 } else if (sscanf(cmd, "level %d", &level) == 1 &&
7054 level >= 0 && level <= bright_maxlvl) {
7060 tpacpi_disclose_usertask("procfs brightness",
7061 "set level to %d\n", level);
7064 * Now we know what the final level should be, so we try to set it.
7065 * Doing it this way makes the syscall restartable in case of EINTR
7067 rc = brightness_set(level);
7068 if (!rc && ibm_backlight_device)
7069 backlight_force_update(ibm_backlight_device,
7070 BACKLIGHT_UPDATE_SYSFS);
7071 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7074 static struct ibm_struct brightness_driver_data = {
7075 .name = "brightness",
7076 .read = brightness_read,
7077 .write = brightness_write,
7078 .exit = brightness_exit,
7079 .suspend = brightness_suspend,
7080 .shutdown = brightness_shutdown,
7083 /*************************************************************************
7088 * IBM ThinkPads have a simple volume controller with MUTE gating.
7089 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
7091 * Since the *61 series (and probably also the later *60 series), Lenovo
7092 * ThinkPads only implement the MUTE gate.
7095 * Bit 6: MUTE (1 mutes sound)
7097 * Other bits should be zero as far as we know.
7099 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
7100 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
7101 * such as bit 7 which is used to detect repeated presses of MUTE,
7102 * and we leave them unchanged.
7104 * On newer Lenovo ThinkPads, the EC can automatically change the volume
7105 * in response to user input. Unfortunately, this rarely works well.
7106 * The laptop changes the state of its internal MUTE gate and, on some
7107 * models, sends KEY_MUTE, causing any user code that responds to the
7108 * mute button to get confused. The hardware MUTE gate is also
7109 * unnecessary, since user code can handle the mute button without
7110 * kernel or EC help.
7112 * To avoid confusing userspace, we simply disable all EC-based mute
7113 * and volume controls when possible.
7116 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
7118 #define TPACPI_ALSA_DRVNAME "ThinkPad EC"
7119 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
7120 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
7122 #if SNDRV_CARDS <= 32
7123 #define DEFAULT_ALSA_IDX ~((1 << (SNDRV_CARDS - 3)) - 1)
7125 #define DEFAULT_ALSA_IDX ~((1 << (32 - 3)) - 1)
7127 static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
7128 static char *alsa_id = "ThinkPadEC";
7129 static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
7131 struct tpacpi_alsa_data {
7132 struct snd_card *card;
7133 struct snd_ctl_elem_id *ctl_mute_id;
7134 struct snd_ctl_elem_id *ctl_vol_id;
7137 static struct snd_card *alsa_card;
7142 /* TP_EC_AUDIO bits */
7143 TP_EC_AUDIO_MUTESW = 6,
7145 /* TP_EC_AUDIO bitmasks */
7146 TP_EC_AUDIO_LVL_MSK = 0x0F,
7147 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
7149 /* Maximum volume */
7150 TP_EC_VOLUME_MAX = 14,
7153 enum tpacpi_volume_access_mode {
7154 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
7155 TPACPI_VOL_MODE_EC, /* Pure EC control */
7156 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
7157 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
7161 enum tpacpi_volume_capabilities {
7162 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
7163 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
7164 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
7168 enum tpacpi_mute_btn_mode {
7169 TP_EC_MUTE_BTN_LATCH = 0, /* Mute mutes; up/down unmutes */
7170 /* We don't know what mode 1 is. */
7171 TP_EC_MUTE_BTN_NONE = 2, /* Mute and up/down are just keys */
7172 TP_EC_MUTE_BTN_TOGGLE = 3, /* Mute toggles; up/down unmutes */
7175 static enum tpacpi_volume_access_mode volume_mode =
7176 TPACPI_VOL_MODE_MAX;
7178 static enum tpacpi_volume_capabilities volume_capabilities;
7179 static bool volume_control_allowed;
7180 static bool software_mute_requested = true;
7181 static bool software_mute_active;
7182 static int software_mute_orig_mode;
7185 * Used to syncronize writers to TP_EC_AUDIO and
7186 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
7188 static struct mutex volume_mutex;
7190 static void tpacpi_volume_checkpoint_nvram(void)
7196 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
7198 if (!volume_control_allowed)
7200 if (software_mute_active)
7203 vdbg_printk(TPACPI_DBG_MIXER,
7204 "trying to checkpoint mixer state to NVRAM...\n");
7206 if (tp_features.mixer_no_level_control)
7207 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
7209 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
7211 if (mutex_lock_killable(&volume_mutex) < 0)
7214 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
7217 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
7219 if (lec != (b_nvram & ec_mask)) {
7220 /* NVRAM needs update */
7221 b_nvram &= ~ec_mask;
7223 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
7224 dbg_printk(TPACPI_DBG_MIXER,
7225 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
7226 (unsigned int) lec, (unsigned int) b_nvram);
7228 vdbg_printk(TPACPI_DBG_MIXER,
7229 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
7230 (unsigned int) lec, (unsigned int) b_nvram);
7234 mutex_unlock(&volume_mutex);
7237 static int volume_get_status_ec(u8 *status)
7241 if (!acpi_ec_read(TP_EC_AUDIO, &s))
7246 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
7251 static int volume_get_status(u8 *status)
7253 return volume_get_status_ec(status);
7256 static int volume_set_status_ec(const u8 status)
7258 if (!acpi_ec_write(TP_EC_AUDIO, status))
7261 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
7264 * On X200s, and possibly on others, it can take a while for
7265 * reads to become correct.
7272 static int volume_set_status(const u8 status)
7274 return volume_set_status_ec(status);
7277 /* returns < 0 on error, 0 on no change, 1 on change */
7278 static int __volume_set_mute_ec(const bool mute)
7283 if (mutex_lock_killable(&volume_mutex) < 0)
7286 rc = volume_get_status_ec(&s);
7290 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
7291 s & ~TP_EC_AUDIO_MUTESW_MSK;
7294 rc = volume_set_status_ec(n);
7300 mutex_unlock(&volume_mutex);
7304 static int volume_alsa_set_mute(const bool mute)
7306 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
7307 (mute) ? "" : "un");
7308 return __volume_set_mute_ec(mute);
7311 static int volume_set_mute(const bool mute)
7315 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
7316 (mute) ? "" : "un");
7318 rc = __volume_set_mute_ec(mute);
7319 return (rc < 0) ? rc : 0;
7322 /* returns < 0 on error, 0 on no change, 1 on change */
7323 static int __volume_set_volume_ec(const u8 vol)
7328 if (vol > TP_EC_VOLUME_MAX)
7331 if (mutex_lock_killable(&volume_mutex) < 0)
7334 rc = volume_get_status_ec(&s);
7338 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
7341 rc = volume_set_status_ec(n);
7347 mutex_unlock(&volume_mutex);
7351 static int volume_set_software_mute(bool startup)
7355 if (!tpacpi_is_lenovo())
7359 if (!acpi_evalf(ec_handle, &software_mute_orig_mode,
7363 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7364 "Initial HAUM setting was %d\n",
7365 software_mute_orig_mode);
7368 if (!acpi_evalf(ec_handle, &result, "SAUM", "qdd",
7369 (int)TP_EC_MUTE_BTN_NONE))
7372 if (result != TP_EC_MUTE_BTN_NONE)
7373 pr_warn("Unexpected SAUM result %d\n",
7377 * In software mute mode, the standard codec controls take
7378 * precendence, so we unmute the ThinkPad HW switch at
7379 * startup. Just on case there are SAUM-capable ThinkPads
7380 * with level controls, set max HW volume as well.
7382 if (tp_features.mixer_no_level_control)
7383 result = volume_set_mute(false);
7385 result = volume_set_status(TP_EC_VOLUME_MAX);
7388 pr_warn("Failed to unmute the HW mute switch\n");
7393 static void volume_exit_software_mute(void)
7397 if (!acpi_evalf(ec_handle, &r, "SAUM", "qdd", software_mute_orig_mode)
7398 || r != software_mute_orig_mode)
7399 pr_warn("Failed to restore mute mode\n");
7402 static int volume_alsa_set_volume(const u8 vol)
7404 dbg_printk(TPACPI_DBG_MIXER,
7405 "ALSA: trying to set volume level to %hu\n", vol);
7406 return __volume_set_volume_ec(vol);
7409 static void volume_alsa_notify_change(void)
7411 struct tpacpi_alsa_data *d;
7413 if (alsa_card && alsa_card->private_data) {
7414 d = alsa_card->private_data;
7416 snd_ctl_notify(alsa_card,
7417 SNDRV_CTL_EVENT_MASK_VALUE,
7420 snd_ctl_notify(alsa_card,
7421 SNDRV_CTL_EVENT_MASK_VALUE,
7426 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
7427 struct snd_ctl_elem_info *uinfo)
7429 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
7431 uinfo->value.integer.min = 0;
7432 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
7436 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
7437 struct snd_ctl_elem_value *ucontrol)
7442 rc = volume_get_status(&s);
7446 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
7450 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
7451 struct snd_ctl_elem_value *ucontrol)
7453 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
7454 ucontrol->value.integer.value[0]);
7455 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
7458 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
7460 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
7461 struct snd_ctl_elem_value *ucontrol)
7466 rc = volume_get_status(&s);
7470 ucontrol->value.integer.value[0] =
7471 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
7475 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
7476 struct snd_ctl_elem_value *ucontrol)
7478 tpacpi_disclose_usertask("ALSA", "%smute\n",
7479 ucontrol->value.integer.value[0] ?
7481 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
7484 static struct snd_kcontrol_new volume_alsa_control_vol __initdata = {
7485 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7486 .name = "Console Playback Volume",
7488 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7489 .info = volume_alsa_vol_info,
7490 .get = volume_alsa_vol_get,
7493 static struct snd_kcontrol_new volume_alsa_control_mute __initdata = {
7494 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7495 .name = "Console Playback Switch",
7497 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7498 .info = volume_alsa_mute_info,
7499 .get = volume_alsa_mute_get,
7502 static void volume_suspend(void)
7504 tpacpi_volume_checkpoint_nvram();
7507 static void volume_resume(void)
7509 if (software_mute_active) {
7510 if (volume_set_software_mute(false) < 0)
7511 pr_warn("Failed to restore software mute\n");
7513 volume_alsa_notify_change();
7517 static void volume_shutdown(void)
7519 tpacpi_volume_checkpoint_nvram();
7522 static void volume_exit(void)
7525 snd_card_free(alsa_card);
7529 tpacpi_volume_checkpoint_nvram();
7531 if (software_mute_active)
7532 volume_exit_software_mute();
7535 static int __init volume_create_alsa_mixer(void)
7537 struct snd_card *card;
7538 struct tpacpi_alsa_data *data;
7539 struct snd_kcontrol *ctl_vol;
7540 struct snd_kcontrol *ctl_mute;
7543 rc = snd_card_new(&tpacpi_pdev->dev,
7544 alsa_index, alsa_id, THIS_MODULE,
7545 sizeof(struct tpacpi_alsa_data), &card);
7546 if (rc < 0 || !card) {
7547 pr_err("Failed to create ALSA card structures: %d\n", rc);
7551 BUG_ON(!card->private_data);
7552 data = card->private_data;
7555 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
7556 sizeof(card->driver));
7557 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
7558 sizeof(card->shortname));
7559 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
7560 (thinkpad_id.ec_version_str) ?
7561 thinkpad_id.ec_version_str : "(unknown)");
7562 snprintf(card->longname, sizeof(card->longname),
7563 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
7564 (thinkpad_id.ec_version_str) ?
7565 thinkpad_id.ec_version_str : "unknown");
7567 if (volume_control_allowed) {
7568 volume_alsa_control_vol.put = volume_alsa_vol_put;
7569 volume_alsa_control_vol.access =
7570 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7572 volume_alsa_control_mute.put = volume_alsa_mute_put;
7573 volume_alsa_control_mute.access =
7574 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7577 if (!tp_features.mixer_no_level_control) {
7578 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
7579 rc = snd_ctl_add(card, ctl_vol);
7581 pr_err("Failed to create ALSA volume control: %d\n",
7585 data->ctl_vol_id = &ctl_vol->id;
7588 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
7589 rc = snd_ctl_add(card, ctl_mute);
7591 pr_err("Failed to create ALSA mute control: %d\n", rc);
7594 data->ctl_mute_id = &ctl_mute->id;
7596 rc = snd_card_register(card);
7598 pr_err("Failed to register ALSA card: %d\n", rc);
7606 snd_card_free(card);
7610 #define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
7611 #define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
7613 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
7614 /* Whitelist volume level on all IBM by default */
7615 { .vendor = PCI_VENDOR_ID_IBM,
7616 .bios = TPACPI_MATCH_ANY,
7617 .ec = TPACPI_MATCH_ANY,
7618 .quirks = TPACPI_VOL_Q_LEVEL },
7620 /* Lenovo models with volume control (needs confirmation) */
7621 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
7622 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
7623 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
7624 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
7625 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
7626 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
7627 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
7629 /* Whitelist mute-only on all Lenovo by default */
7630 { .vendor = PCI_VENDOR_ID_LENOVO,
7631 .bios = TPACPI_MATCH_ANY,
7632 .ec = TPACPI_MATCH_ANY,
7633 .quirks = TPACPI_VOL_Q_MUTEONLY }
7636 static int __init volume_init(struct ibm_init_struct *iibm)
7638 unsigned long quirks;
7641 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7643 mutex_init(&volume_mutex);
7646 * Check for module parameter bogosity, note that we
7647 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7648 * able to detect "unspecified"
7650 if (volume_mode > TPACPI_VOL_MODE_MAX)
7653 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7654 pr_err("UCMS step volume mode not implemented, please contact %s\n",
7659 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7663 * The ALSA mixer is our primary interface.
7664 * When disabled, don't install the subdriver at all
7667 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7668 "ALSA mixer disabled by parameter, not loading volume subdriver...\n");
7672 quirks = tpacpi_check_quirks(volume_quirk_table,
7673 ARRAY_SIZE(volume_quirk_table));
7675 switch (volume_capabilities) {
7676 case TPACPI_VOL_CAP_AUTO:
7677 if (quirks & TPACPI_VOL_Q_MUTEONLY)
7678 tp_features.mixer_no_level_control = 1;
7679 else if (quirks & TPACPI_VOL_Q_LEVEL)
7680 tp_features.mixer_no_level_control = 0;
7682 return 1; /* no mixer */
7684 case TPACPI_VOL_CAP_VOLMUTE:
7685 tp_features.mixer_no_level_control = 0;
7687 case TPACPI_VOL_CAP_MUTEONLY:
7688 tp_features.mixer_no_level_control = 1;
7694 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7695 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7696 "using user-supplied volume_capabilities=%d\n",
7697 volume_capabilities);
7699 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7700 volume_mode == TPACPI_VOL_MODE_MAX) {
7701 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7703 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7704 "driver auto-selected volume_mode=%d\n",
7707 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7708 "using user-supplied volume_mode=%d\n",
7712 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7713 "mute is supported, volume control is %s\n",
7714 str_supported(!tp_features.mixer_no_level_control));
7716 if (software_mute_requested && volume_set_software_mute(true) == 0) {
7717 software_mute_active = true;
7719 rc = volume_create_alsa_mixer();
7721 pr_err("Could not create the ALSA mixer interface\n");
7725 pr_info("Console audio control enabled, mode: %s\n",
7726 (volume_control_allowed) ?
7727 "override (read/write)" :
7728 "monitor (read only)");
7731 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7732 "registering volume hotkeys as change notification\n");
7733 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7734 | TP_ACPI_HKEY_VOLUP_MASK
7735 | TP_ACPI_HKEY_VOLDWN_MASK
7736 | TP_ACPI_HKEY_MUTE_MASK);
7741 static int volume_read(struct seq_file *m)
7745 if (volume_get_status(&status) < 0) {
7746 seq_printf(m, "level:\t\tunreadable\n");
7748 if (tp_features.mixer_no_level_control)
7749 seq_printf(m, "level:\t\tunsupported\n");
7751 seq_printf(m, "level:\t\t%d\n",
7752 status & TP_EC_AUDIO_LVL_MSK);
7754 seq_printf(m, "mute:\t\t%s\n",
7755 onoff(status, TP_EC_AUDIO_MUTESW));
7757 if (volume_control_allowed) {
7758 seq_printf(m, "commands:\tunmute, mute\n");
7759 if (!tp_features.mixer_no_level_control) {
7760 seq_printf(m, "commands:\tup, down\n");
7761 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7770 static int volume_write(char *buf)
7773 u8 new_level, new_mute;
7779 * We do allow volume control at driver startup, so that the
7780 * user can set initial state through the volume=... parameter hack.
7782 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7783 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7784 tp_warned.volume_ctrl_forbidden = 1;
7785 pr_notice("Console audio control in monitor mode, changes are not allowed\n");
7786 pr_notice("Use the volume_control=1 module parameter to enable volume control\n");
7791 rc = volume_get_status(&s);
7795 new_level = s & TP_EC_AUDIO_LVL_MSK;
7796 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7798 while ((cmd = next_cmd(&buf))) {
7799 if (!tp_features.mixer_no_level_control) {
7800 if (strlencmp(cmd, "up") == 0) {
7803 else if (new_level < TP_EC_VOLUME_MAX)
7806 } else if (strlencmp(cmd, "down") == 0) {
7809 else if (new_level > 0)
7812 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7813 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7818 if (strlencmp(cmd, "mute") == 0)
7819 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7820 else if (strlencmp(cmd, "unmute") == 0)
7826 if (tp_features.mixer_no_level_control) {
7827 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7828 new_mute ? "" : "un");
7829 rc = volume_set_mute(!!new_mute);
7831 tpacpi_disclose_usertask("procfs volume",
7832 "%smute and set level to %d\n",
7833 new_mute ? "" : "un", new_level);
7834 rc = volume_set_status(new_mute | new_level);
7836 volume_alsa_notify_change();
7838 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7841 static struct ibm_struct volume_driver_data = {
7843 .read = volume_read,
7844 .write = volume_write,
7845 .exit = volume_exit,
7846 .suspend = volume_suspend,
7847 .resume = volume_resume,
7848 .shutdown = volume_shutdown,
7851 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7853 #define alsa_card NULL
7855 static inline void volume_alsa_notify_change(void)
7859 static int __init volume_init(struct ibm_init_struct *iibm)
7861 pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7866 static struct ibm_struct volume_driver_data = {
7870 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7872 /*************************************************************************
7879 * TPACPI_FAN_RD_ACPI_GFAN:
7880 * ACPI GFAN method: returns fan level
7882 * see TPACPI_FAN_WR_ACPI_SFAN
7883 * EC 0x2f (HFSP) not available if GFAN exists
7885 * TPACPI_FAN_WR_ACPI_SFAN:
7886 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7888 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7891 * TPACPI_FAN_WR_TPEC:
7892 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7893 * Supported on almost all ThinkPads
7895 * Fan speed changes of any sort (including those caused by the
7896 * disengaged mode) are usually done slowly by the firmware as the
7897 * maximum amount of fan duty cycle change per second seems to be
7900 * Reading is not available if GFAN exists.
7901 * Writing is not available if SFAN exists.
7904 * 7 automatic mode engaged;
7905 * (default operation mode of the ThinkPad)
7906 * fan level is ignored in this mode.
7907 * 6 full speed mode (takes precedence over bit 7);
7908 * not available on all thinkpads. May disable
7909 * the tachometer while the fan controller ramps up
7910 * the speed (which can take up to a few *minutes*).
7911 * Speeds up fan to 100% duty-cycle, which is far above
7912 * the standard RPM levels. It is not impossible that
7913 * it could cause hardware damage.
7914 * 5-3 unused in some models. Extra bits for fan level
7915 * in others, but still useless as all values above
7916 * 7 map to the same speed as level 7 in these models.
7917 * 2-0 fan level (0..7 usually)
7919 * 0x07 = max (set when temperatures critical)
7920 * Some ThinkPads may have other levels, see
7921 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7923 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7924 * boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7925 * does so, its initial value is meaningless (0x07).
7927 * For firmware bugs, refer to:
7928 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7932 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7933 * Main fan tachometer reading (in RPM)
7935 * This register is present on all ThinkPads with a new-style EC, and
7936 * it is known not to be present on the A21m/e, and T22, as there is
7937 * something else in offset 0x84 according to the ACPI DSDT. Other
7938 * ThinkPads from this same time period (and earlier) probably lack the
7939 * tachometer as well.
7941 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7942 * was never fixed by IBM to report the EC firmware version string
7943 * probably support the tachometer (like the early X models), so
7944 * detecting it is quite hard. We need more data to know for sure.
7946 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7949 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7952 * For firmware bugs, refer to:
7953 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7957 * ThinkPad EC register 0x31 bit 0 (only on select models)
7959 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7960 * show the speed of the main fan. When bit 0 of EC register 0x31
7961 * is one, the tachometer registers show the speed of the auxiliary
7964 * Fan control seems to affect both fans, regardless of the state
7967 * So far, only the firmware for the X60/X61 non-tablet versions
7968 * seem to support this (firmware TP-7M).
7970 * TPACPI_FAN_WR_ACPI_FANS:
7971 * ThinkPad X31, X40, X41. Not available in the X60.
7973 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7974 * high speed. ACPI DSDT seems to map these three speeds to levels
7975 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7976 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7978 * The speeds are stored on handles
7979 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7981 * There are three default speed sets, accessible as handles:
7982 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7984 * ACPI DSDT switches which set is in use depending on various
7987 * TPACPI_FAN_WR_TPEC is also available and should be used to
7988 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7989 * but the ACPI tables just mention level 7.
7992 enum { /* Fan control constants */
7993 fan_status_offset = 0x2f, /* EC register 0x2f */
7994 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7995 * 0x84 must be read before 0x85 */
7996 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7997 bit 0 selects which fan is active */
7999 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
8000 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
8002 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
8005 enum fan_status_access_mode {
8006 TPACPI_FAN_NONE = 0, /* No fan status or control */
8007 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
8008 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
8011 enum fan_control_access_mode {
8012 TPACPI_FAN_WR_NONE = 0, /* No fan control */
8013 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
8014 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
8015 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
8018 enum fan_control_commands {
8019 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
8020 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
8021 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
8022 * and also watchdog cmd */
8025 static bool fan_control_allowed;
8027 static enum fan_status_access_mode fan_status_access_mode;
8028 static enum fan_control_access_mode fan_control_access_mode;
8029 static enum fan_control_commands fan_control_commands;
8031 static u8 fan_control_initial_status;
8032 static u8 fan_control_desired_level;
8033 static u8 fan_control_resume_level;
8034 static int fan_watchdog_maxinterval;
8036 static struct mutex fan_mutex;
8038 static void fan_watchdog_fire(struct work_struct *ignored);
8039 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
8041 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
8042 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
8043 "\\FSPD", /* 600e/x, 770e, 770x */
8045 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
8046 "JFNS", /* 770x-JL */
8050 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
8051 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
8052 * be in auto mode (0x80).
8054 * This is corrected by any write to HFSP either by the driver, or
8057 * We assume 0x07 really means auto mode while this quirk is active,
8058 * as this is far more likely than the ThinkPad being in level 7,
8059 * which is only used by the firmware during thermal emergencies.
8061 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
8062 * TP-70 (T43, R52), which are known to be buggy.
8065 static void fan_quirk1_setup(void)
8067 if (fan_control_initial_status == 0x07) {
8068 pr_notice("fan_init: initial fan status is unknown, assuming it is in auto mode\n");
8069 tp_features.fan_ctrl_status_undef = 1;
8073 static void fan_quirk1_handle(u8 *fan_status)
8075 if (unlikely(tp_features.fan_ctrl_status_undef)) {
8076 if (*fan_status != fan_control_initial_status) {
8077 /* something changed the HFSP regisnter since
8078 * driver init time, so it is not undefined
8080 tp_features.fan_ctrl_status_undef = 0;
8082 /* Return most likely status. In fact, it
8083 * might be the only possible status */
8084 *fan_status = TP_EC_FAN_AUTO;
8089 /* Select main fan on X60/X61, NOOP on others */
8090 static bool fan_select_fan1(void)
8092 if (tp_features.second_fan) {
8095 if (ec_read(fan_select_offset, &val) < 0)
8098 if (ec_write(fan_select_offset, val) < 0)
8104 /* Select secondary fan on X60/X61 */
8105 static bool fan_select_fan2(void)
8109 if (!tp_features.second_fan)
8112 if (ec_read(fan_select_offset, &val) < 0)
8115 if (ec_write(fan_select_offset, val) < 0)
8122 * Call with fan_mutex held
8124 static void fan_update_desired_level(u8 status)
8127 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8129 fan_control_desired_level = 7;
8131 fan_control_desired_level = status;
8135 static int fan_get_status(u8 *status)
8140 * Add TPACPI_FAN_RD_ACPI_FANS ? */
8142 switch (fan_status_access_mode) {
8143 case TPACPI_FAN_RD_ACPI_GFAN: {
8144 /* 570, 600e/x, 770e, 770x */
8147 if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
8151 *status = res & 0x07;
8155 case TPACPI_FAN_RD_TPEC:
8156 /* all except 570, 600e/x, 770e, 770x */
8157 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
8160 if (likely(status)) {
8162 fan_quirk1_handle(status);
8174 static int fan_get_status_safe(u8 *status)
8179 if (mutex_lock_killable(&fan_mutex))
8180 return -ERESTARTSYS;
8181 rc = fan_get_status(&s);
8183 fan_update_desired_level(s);
8184 mutex_unlock(&fan_mutex);
8194 static int fan_get_speed(unsigned int *speed)
8198 switch (fan_status_access_mode) {
8199 case TPACPI_FAN_RD_TPEC:
8200 /* all except 570, 600e/x, 770e, 770x */
8201 if (unlikely(!fan_select_fan1()))
8203 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
8204 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
8208 *speed = (hi << 8) | lo;
8219 static int fan2_get_speed(unsigned int *speed)
8224 switch (fan_status_access_mode) {
8225 case TPACPI_FAN_RD_TPEC:
8226 /* all except 570, 600e/x, 770e, 770x */
8227 if (unlikely(!fan_select_fan2()))
8229 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
8230 !acpi_ec_read(fan_rpm_offset + 1, &hi);
8231 fan_select_fan1(); /* play it safe */
8236 *speed = (hi << 8) | lo;
8247 static int fan_set_level(int level)
8249 if (!fan_control_allowed)
8252 switch (fan_control_access_mode) {
8253 case TPACPI_FAN_WR_ACPI_SFAN:
8254 if (level >= 0 && level <= 7) {
8255 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
8261 case TPACPI_FAN_WR_ACPI_FANS:
8262 case TPACPI_FAN_WR_TPEC:
8263 if (!(level & TP_EC_FAN_AUTO) &&
8264 !(level & TP_EC_FAN_FULLSPEED) &&
8265 ((level < 0) || (level > 7)))
8268 /* safety net should the EC not support AUTO
8269 * or FULLSPEED mode bits and just ignore them */
8270 if (level & TP_EC_FAN_FULLSPEED)
8271 level |= 7; /* safety min speed 7 */
8272 else if (level & TP_EC_FAN_AUTO)
8273 level |= 4; /* safety min speed 4 */
8275 if (!acpi_ec_write(fan_status_offset, level))
8278 tp_features.fan_ctrl_status_undef = 0;
8285 vdbg_printk(TPACPI_DBG_FAN,
8286 "fan control: set fan control register to 0x%02x\n", level);
8290 static int fan_set_level_safe(int level)
8294 if (!fan_control_allowed)
8297 if (mutex_lock_killable(&fan_mutex))
8298 return -ERESTARTSYS;
8300 if (level == TPACPI_FAN_LAST_LEVEL)
8301 level = fan_control_desired_level;
8303 rc = fan_set_level(level);
8305 fan_update_desired_level(level);
8307 mutex_unlock(&fan_mutex);
8311 static int fan_set_enable(void)
8316 if (!fan_control_allowed)
8319 if (mutex_lock_killable(&fan_mutex))
8320 return -ERESTARTSYS;
8322 switch (fan_control_access_mode) {
8323 case TPACPI_FAN_WR_ACPI_FANS:
8324 case TPACPI_FAN_WR_TPEC:
8325 rc = fan_get_status(&s);
8329 /* Don't go out of emergency fan mode */
8332 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
8335 if (!acpi_ec_write(fan_status_offset, s))
8338 tp_features.fan_ctrl_status_undef = 0;
8343 case TPACPI_FAN_WR_ACPI_SFAN:
8344 rc = fan_get_status(&s);
8350 /* Set fan to at least level 4 */
8353 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
8363 mutex_unlock(&fan_mutex);
8366 vdbg_printk(TPACPI_DBG_FAN,
8367 "fan control: set fan control register to 0x%02x\n",
8372 static int fan_set_disable(void)
8376 if (!fan_control_allowed)
8379 if (mutex_lock_killable(&fan_mutex))
8380 return -ERESTARTSYS;
8383 switch (fan_control_access_mode) {
8384 case TPACPI_FAN_WR_ACPI_FANS:
8385 case TPACPI_FAN_WR_TPEC:
8386 if (!acpi_ec_write(fan_status_offset, 0x00))
8389 fan_control_desired_level = 0;
8390 tp_features.fan_ctrl_status_undef = 0;
8394 case TPACPI_FAN_WR_ACPI_SFAN:
8395 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
8398 fan_control_desired_level = 0;
8406 vdbg_printk(TPACPI_DBG_FAN,
8407 "fan control: set fan control register to 0\n");
8409 mutex_unlock(&fan_mutex);
8413 static int fan_set_speed(int speed)
8417 if (!fan_control_allowed)
8420 if (mutex_lock_killable(&fan_mutex))
8421 return -ERESTARTSYS;
8424 switch (fan_control_access_mode) {
8425 case TPACPI_FAN_WR_ACPI_FANS:
8426 if (speed >= 0 && speed <= 65535) {
8427 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
8428 speed, speed, speed))
8438 mutex_unlock(&fan_mutex);
8442 static void fan_watchdog_reset(void)
8444 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
8447 if (fan_watchdog_maxinterval > 0 &&
8448 tpacpi_lifecycle != TPACPI_LIFE_EXITING)
8449 mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
8450 msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
8452 cancel_delayed_work(&fan_watchdog_task);
8455 static void fan_watchdog_fire(struct work_struct *ignored)
8459 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
8462 pr_notice("fan watchdog: enabling fan\n");
8463 rc = fan_set_enable();
8465 pr_err("fan watchdog: error %d while enabling fan, will try again later...\n",
8467 /* reschedule for later */
8468 fan_watchdog_reset();
8473 * SYSFS fan layout: hwmon compatible (device)
8476 * 0: "disengaged" mode
8478 * 2: native EC "auto" mode (recommended, hardware default)
8480 * pwm*: set speed in manual mode, ignored otherwise.
8481 * 0 is level 0; 255 is level 7. Intermediate points done with linear
8484 * fan*_input: tachometer reading, RPM
8487 * SYSFS fan layout: extensions
8489 * fan_watchdog (driver):
8490 * fan watchdog interval in seconds, 0 disables (default), max 120
8493 /* sysfs fan pwm1_enable ----------------------------------------------- */
8494 static ssize_t fan_pwm1_enable_show(struct device *dev,
8495 struct device_attribute *attr,
8501 res = fan_get_status_safe(&status);
8505 if (status & TP_EC_FAN_FULLSPEED) {
8507 } else if (status & TP_EC_FAN_AUTO) {
8512 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
8515 static ssize_t fan_pwm1_enable_store(struct device *dev,
8516 struct device_attribute *attr,
8517 const char *buf, size_t count)
8522 if (parse_strtoul(buf, 2, &t))
8525 tpacpi_disclose_usertask("hwmon pwm1_enable",
8526 "set fan mode to %lu\n", t);
8530 level = TP_EC_FAN_FULLSPEED;
8533 level = TPACPI_FAN_LAST_LEVEL;
8536 level = TP_EC_FAN_AUTO;
8539 /* reserved for software-controlled auto mode */
8545 res = fan_set_level_safe(level);
8551 fan_watchdog_reset();
8556 static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
8557 fan_pwm1_enable_show, fan_pwm1_enable_store);
8559 /* sysfs fan pwm1 ------------------------------------------------------ */
8560 static ssize_t fan_pwm1_show(struct device *dev,
8561 struct device_attribute *attr,
8567 res = fan_get_status_safe(&status);
8572 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
8573 status = fan_control_desired_level;
8578 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
8581 static ssize_t fan_pwm1_store(struct device *dev,
8582 struct device_attribute *attr,
8583 const char *buf, size_t count)
8587 u8 status, newlevel;
8589 if (parse_strtoul(buf, 255, &s))
8592 tpacpi_disclose_usertask("hwmon pwm1",
8593 "set fan speed to %lu\n", s);
8595 /* scale down from 0-255 to 0-7 */
8596 newlevel = (s >> 5) & 0x07;
8598 if (mutex_lock_killable(&fan_mutex))
8599 return -ERESTARTSYS;
8601 rc = fan_get_status(&status);
8602 if (!rc && (status &
8603 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8604 rc = fan_set_level(newlevel);
8608 fan_update_desired_level(newlevel);
8609 fan_watchdog_reset();
8613 mutex_unlock(&fan_mutex);
8614 return (rc) ? rc : count;
8617 static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, fan_pwm1_show, fan_pwm1_store);
8619 /* sysfs fan fan1_input ------------------------------------------------ */
8620 static ssize_t fan_fan1_input_show(struct device *dev,
8621 struct device_attribute *attr,
8627 res = fan_get_speed(&speed);
8631 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8634 static DEVICE_ATTR(fan1_input, S_IRUGO, fan_fan1_input_show, NULL);
8636 /* sysfs fan fan2_input ------------------------------------------------ */
8637 static ssize_t fan_fan2_input_show(struct device *dev,
8638 struct device_attribute *attr,
8644 res = fan2_get_speed(&speed);
8648 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8651 static DEVICE_ATTR(fan2_input, S_IRUGO, fan_fan2_input_show, NULL);
8653 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8654 static ssize_t fan_watchdog_show(struct device_driver *drv, char *buf)
8656 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
8659 static ssize_t fan_watchdog_store(struct device_driver *drv, const char *buf,
8664 if (parse_strtoul(buf, 120, &t))
8667 if (!fan_control_allowed)
8670 fan_watchdog_maxinterval = t;
8671 fan_watchdog_reset();
8673 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8677 static DRIVER_ATTR_RW(fan_watchdog);
8679 /* --------------------------------------------------------------------- */
8680 static struct attribute *fan_attributes[] = {
8681 &dev_attr_pwm1_enable.attr, &dev_attr_pwm1.attr,
8682 &dev_attr_fan1_input.attr,
8683 NULL, /* for fan2_input */
8687 static const struct attribute_group fan_attr_group = {
8688 .attrs = fan_attributes,
8691 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
8692 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
8694 #define TPACPI_FAN_QI(__id1, __id2, __quirks) \
8695 { .vendor = PCI_VENDOR_ID_IBM, \
8696 .bios = TPACPI_MATCH_ANY, \
8697 .ec = TPID(__id1, __id2), \
8698 .quirks = __quirks }
8700 #define TPACPI_FAN_QL(__id1, __id2, __quirks) \
8701 { .vendor = PCI_VENDOR_ID_LENOVO, \
8702 .bios = TPACPI_MATCH_ANY, \
8703 .ec = TPID(__id1, __id2), \
8704 .quirks = __quirks }
8706 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8707 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
8708 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
8709 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
8710 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
8711 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
8714 #undef TPACPI_FAN_QL
8715 #undef TPACPI_FAN_QI
8717 static int __init fan_init(struct ibm_init_struct *iibm)
8720 unsigned long quirks;
8722 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8723 "initializing fan subdriver\n");
8725 mutex_init(&fan_mutex);
8726 fan_status_access_mode = TPACPI_FAN_NONE;
8727 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8728 fan_control_commands = 0;
8729 fan_watchdog_maxinterval = 0;
8730 tp_features.fan_ctrl_status_undef = 0;
8731 tp_features.second_fan = 0;
8732 fan_control_desired_level = 7;
8734 if (tpacpi_is_ibm()) {
8735 TPACPI_ACPIHANDLE_INIT(fans);
8736 TPACPI_ACPIHANDLE_INIT(gfan);
8737 TPACPI_ACPIHANDLE_INIT(sfan);
8740 quirks = tpacpi_check_quirks(fan_quirk_table,
8741 ARRAY_SIZE(fan_quirk_table));
8744 /* 570, 600e/x, 770e, 770x */
8745 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8747 /* all other ThinkPads: note that even old-style
8748 * ThinkPad ECs supports the fan control register */
8749 if (likely(acpi_ec_read(fan_status_offset,
8750 &fan_control_initial_status))) {
8751 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8752 if (quirks & TPACPI_FAN_Q1)
8754 if (quirks & TPACPI_FAN_2FAN) {
8755 tp_features.second_fan = 1;
8756 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8757 "secondary fan support enabled\n");
8760 pr_err("ThinkPad ACPI EC access misbehaving, fan status and control unavailable\n");
8767 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8768 fan_control_commands |=
8769 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8772 /* gfan without sfan means no fan control */
8773 /* all other models implement TP EC 0x2f control */
8777 fan_control_access_mode =
8778 TPACPI_FAN_WR_ACPI_FANS;
8779 fan_control_commands |=
8780 TPACPI_FAN_CMD_SPEED |
8781 TPACPI_FAN_CMD_LEVEL |
8782 TPACPI_FAN_CMD_ENABLE;
8784 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8785 fan_control_commands |=
8786 TPACPI_FAN_CMD_LEVEL |
8787 TPACPI_FAN_CMD_ENABLE;
8792 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8793 "fan is %s, modes %d, %d\n",
8794 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8795 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8796 fan_status_access_mode, fan_control_access_mode);
8798 /* fan control master switch */
8799 if (!fan_control_allowed) {
8800 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8801 fan_control_commands = 0;
8802 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8803 "fan control features disabled by parameter\n");
8806 /* update fan_control_desired_level */
8807 if (fan_status_access_mode != TPACPI_FAN_NONE)
8808 fan_get_status_safe(NULL);
8810 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8811 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8812 if (tp_features.second_fan) {
8813 /* attach second fan tachometer */
8814 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8815 &dev_attr_fan2_input.attr;
8817 rc = sysfs_create_group(&tpacpi_hwmon->kobj,
8822 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8823 &driver_attr_fan_watchdog);
8825 sysfs_remove_group(&tpacpi_hwmon->kobj,
8834 static void fan_exit(void)
8836 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8837 "cancelling any pending fan watchdog tasks\n");
8839 /* FIXME: can we really do this unconditionally? */
8840 sysfs_remove_group(&tpacpi_hwmon->kobj, &fan_attr_group);
8841 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8842 &driver_attr_fan_watchdog);
8844 cancel_delayed_work(&fan_watchdog_task);
8845 flush_workqueue(tpacpi_wq);
8848 static void fan_suspend(void)
8852 if (!fan_control_allowed)
8855 /* Store fan status in cache */
8856 fan_control_resume_level = 0;
8857 rc = fan_get_status_safe(&fan_control_resume_level);
8859 pr_notice("failed to read fan level for later restore during resume: %d\n",
8862 /* if it is undefined, don't attempt to restore it.
8864 if (tp_features.fan_ctrl_status_undef)
8865 fan_control_resume_level = 0;
8868 static void fan_resume(void)
8870 u8 current_level = 7;
8871 bool do_set = false;
8874 /* DSDT *always* updates status on resume */
8875 tp_features.fan_ctrl_status_undef = 0;
8877 if (!fan_control_allowed ||
8878 !fan_control_resume_level ||
8879 (fan_get_status_safe(¤t_level) < 0))
8882 switch (fan_control_access_mode) {
8883 case TPACPI_FAN_WR_ACPI_SFAN:
8884 /* never decrease fan level */
8885 do_set = (fan_control_resume_level > current_level);
8887 case TPACPI_FAN_WR_ACPI_FANS:
8888 case TPACPI_FAN_WR_TPEC:
8889 /* never decrease fan level, scale is:
8890 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8892 * We expect the firmware to set either 7 or AUTO, but we
8893 * handle FULLSPEED out of paranoia.
8895 * So, we can safely only restore FULLSPEED or 7, anything
8896 * else could slow the fan. Restoring AUTO is useless, at
8897 * best that's exactly what the DSDT already set (it is the
8900 * Always keep in mind that the DSDT *will* have set the
8901 * fans to what the vendor supposes is the best level. We
8902 * muck with it only to speed the fan up.
8904 if (fan_control_resume_level != 7 &&
8905 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8908 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8909 (current_level != fan_control_resume_level);
8915 pr_notice("restoring fan level to 0x%02x\n",
8916 fan_control_resume_level);
8917 rc = fan_set_level_safe(fan_control_resume_level);
8919 pr_notice("failed to restore fan level: %d\n", rc);
8923 static int fan_read(struct seq_file *m)
8927 unsigned int speed = 0;
8929 switch (fan_status_access_mode) {
8930 case TPACPI_FAN_RD_ACPI_GFAN:
8931 /* 570, 600e/x, 770e, 770x */
8932 rc = fan_get_status_safe(&status);
8936 seq_printf(m, "status:\t\t%s\n"
8938 (status != 0) ? "enabled" : "disabled", status);
8941 case TPACPI_FAN_RD_TPEC:
8942 /* all except 570, 600e/x, 770e, 770x */
8943 rc = fan_get_status_safe(&status);
8947 seq_printf(m, "status:\t\t%s\n",
8948 (status != 0) ? "enabled" : "disabled");
8950 rc = fan_get_speed(&speed);
8954 seq_printf(m, "speed:\t\t%d\n", speed);
8956 if (status & TP_EC_FAN_FULLSPEED)
8957 /* Disengaged mode takes precedence */
8958 seq_printf(m, "level:\t\tdisengaged\n");
8959 else if (status & TP_EC_FAN_AUTO)
8960 seq_printf(m, "level:\t\tauto\n");
8962 seq_printf(m, "level:\t\t%d\n", status);
8965 case TPACPI_FAN_NONE:
8967 seq_printf(m, "status:\t\tnot supported\n");
8970 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8971 seq_printf(m, "commands:\tlevel <level>");
8973 switch (fan_control_access_mode) {
8974 case TPACPI_FAN_WR_ACPI_SFAN:
8975 seq_printf(m, " (<level> is 0-7)\n");
8979 seq_printf(m, " (<level> is 0-7, auto, disengaged, full-speed)\n");
8984 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8985 seq_printf(m, "commands:\tenable, disable\n"
8986 "commands:\twatchdog <timeout> (<timeout> is 0 (off), 1-120 (seconds))\n");
8988 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8989 seq_printf(m, "commands:\tspeed <speed> (<speed> is 0-65535)\n");
8994 static int fan_write_cmd_level(const char *cmd, int *rc)
8998 if (strlencmp(cmd, "level auto") == 0)
8999 level = TP_EC_FAN_AUTO;
9000 else if ((strlencmp(cmd, "level disengaged") == 0) |
9001 (strlencmp(cmd, "level full-speed") == 0))
9002 level = TP_EC_FAN_FULLSPEED;
9003 else if (sscanf(cmd, "level %d", &level) != 1)
9006 *rc = fan_set_level_safe(level);
9008 pr_err("level command accepted for unsupported access mode %d\n",
9009 fan_control_access_mode);
9011 tpacpi_disclose_usertask("procfs fan",
9012 "set level to %d\n", level);
9017 static int fan_write_cmd_enable(const char *cmd, int *rc)
9019 if (strlencmp(cmd, "enable") != 0)
9022 *rc = fan_set_enable();
9024 pr_err("enable command accepted for unsupported access mode %d\n",
9025 fan_control_access_mode);
9027 tpacpi_disclose_usertask("procfs fan", "enable\n");
9032 static int fan_write_cmd_disable(const char *cmd, int *rc)
9034 if (strlencmp(cmd, "disable") != 0)
9037 *rc = fan_set_disable();
9039 pr_err("disable command accepted for unsupported access mode %d\n",
9040 fan_control_access_mode);
9042 tpacpi_disclose_usertask("procfs fan", "disable\n");
9047 static int fan_write_cmd_speed(const char *cmd, int *rc)
9052 * Support speed <low> <medium> <high> ? */
9054 if (sscanf(cmd, "speed %d", &speed) != 1)
9057 *rc = fan_set_speed(speed);
9059 pr_err("speed command accepted for unsupported access mode %d\n",
9060 fan_control_access_mode);
9062 tpacpi_disclose_usertask("procfs fan",
9063 "set speed to %d\n", speed);
9068 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
9072 if (sscanf(cmd, "watchdog %d", &interval) != 1)
9075 if (interval < 0 || interval > 120)
9078 fan_watchdog_maxinterval = interval;
9079 tpacpi_disclose_usertask("procfs fan",
9080 "set watchdog timer to %d\n",
9087 static int fan_write(char *buf)
9092 while (!rc && (cmd = next_cmd(&buf))) {
9093 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
9094 fan_write_cmd_level(cmd, &rc)) &&
9095 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
9096 (fan_write_cmd_enable(cmd, &rc) ||
9097 fan_write_cmd_disable(cmd, &rc) ||
9098 fan_write_cmd_watchdog(cmd, &rc))) &&
9099 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
9100 fan_write_cmd_speed(cmd, &rc))
9104 fan_watchdog_reset();
9110 static struct ibm_struct fan_driver_data = {
9115 .suspend = fan_suspend,
9116 .resume = fan_resume,
9119 /*************************************************************************
9120 * Mute LED subdriver
9124 struct tp_led_table {
9131 static struct tp_led_table led_tables[] = {
9132 [TPACPI_LED_MUTE] = {
9137 [TPACPI_LED_MICMUTE] = {
9144 static int mute_led_on_off(struct tp_led_table *t, bool state)
9149 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9150 pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
9154 if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
9155 state ? t->on_value : t->off_value))
9162 int tpacpi_led_set(int whichled, bool on)
9164 struct tp_led_table *t;
9166 if (whichled < 0 || whichled >= TPACPI_LED_MAX)
9169 t = &led_tables[whichled];
9170 if (t->state < 0 || t->state == on)
9172 return mute_led_on_off(t, on);
9174 EXPORT_SYMBOL_GPL(tpacpi_led_set);
9176 static int mute_led_init(struct ibm_init_struct *iibm)
9181 for (i = 0; i < TPACPI_LED_MAX; i++) {
9182 struct tp_led_table *t = &led_tables[i];
9183 if (ACPI_SUCCESS(acpi_get_handle(hkey_handle, t->name, &temp)))
9184 mute_led_on_off(t, false);
9191 static void mute_led_exit(void)
9195 for (i = 0; i < TPACPI_LED_MAX; i++)
9196 tpacpi_led_set(i, false);
9199 static void mute_led_resume(void)
9203 for (i = 0; i < TPACPI_LED_MAX; i++) {
9204 struct tp_led_table *t = &led_tables[i];
9206 mute_led_on_off(t, t->state);
9210 static struct ibm_struct mute_led_driver_data = {
9212 .exit = mute_led_exit,
9213 .resume = mute_led_resume,
9217 * Battery Wear Control Driver
9218 * Contact: Ognjen Galic <smclt30p@gmail.com>
9223 #define GET_START "BCTG"
9224 #define SET_START "BCCS"
9225 #define GET_STOP "BCSG"
9226 #define SET_STOP "BCSS"
9228 #define START_ATTR "charge_start_threshold"
9229 #define STOP_ATTR "charge_stop_threshold"
9238 /* Error condition bit */
9239 METHOD_ERR = BIT(31),
9243 /* This is used in the get/set helpers */
9248 struct tpacpi_battery_data {
9255 struct tpacpi_battery_driver_data {
9256 struct tpacpi_battery_data batteries[3];
9257 int individual_addressing;
9260 static struct tpacpi_battery_driver_data battery_info;
9262 /* ACPI helpers/functions/probes */
9265 * This evaluates a ACPI method call specific to the battery
9266 * ACPI extension. The specifics are that an error is marked
9267 * in the 32rd bit of the response, so we just check that here.
9269 static acpi_status tpacpi_battery_acpi_eval(char *method, int *ret, int param)
9273 if (!acpi_evalf(hkey_handle, &response, method, "dd", param)) {
9274 acpi_handle_err(hkey_handle, "%s: evaluate failed", method);
9277 if (response & METHOD_ERR) {
9278 acpi_handle_err(hkey_handle,
9279 "%s evaluated but flagged as error", method);
9286 static int tpacpi_battery_get(int what, int battery, int *ret)
9289 case THRESHOLD_START:
9290 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, ret, battery))
9293 /* The value is in the low 8 bits of the response */
9296 case THRESHOLD_STOP:
9297 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, ret, battery))
9299 /* Value is in lower 8 bits */
9302 * On the stop value, if we return 0 that
9303 * does not make any sense. 0 means Default, which
9304 * means that charging stops at 100%, so we return
9311 pr_crit("wrong parameter: %d", what);
9316 static int tpacpi_battery_set(int what, int battery, int value)
9319 /* The first 8 bits are the value of the threshold */
9321 /* The battery ID is in bits 8-9, 2 bits */
9322 param |= battery << 8;
9325 case THRESHOLD_START:
9326 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_START, &ret, param)) {
9327 pr_err("failed to set charge threshold on battery %d",
9332 case THRESHOLD_STOP:
9333 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_STOP, &ret, param)) {
9334 pr_err("failed to set stop threshold: %d", battery);
9339 pr_crit("wrong parameter: %d", what);
9344 static int tpacpi_battery_probe(int battery)
9348 memset(&battery_info, 0, sizeof(struct tpacpi_battery_driver_data));
9350 * 1) Get the current start threshold
9351 * 2) Check for support
9352 * 3) Get the current stop threshold
9353 * 4) Check for support
9355 if (acpi_has_method(hkey_handle, GET_START)) {
9356 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, &ret, battery)) {
9357 pr_err("Error probing battery %d\n", battery);
9360 /* Individual addressing is in bit 9 */
9362 battery_info.individual_addressing = true;
9363 /* Support is marked in bit 8 */
9365 battery_info.batteries[battery].start_support = 1;
9368 if (tpacpi_battery_get(THRESHOLD_START, battery,
9369 &battery_info.batteries[battery].charge_start)) {
9370 pr_err("Error probing battery %d\n", battery);
9374 if (acpi_has_method(hkey_handle, GET_STOP)) {
9375 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, &ret, battery)) {
9376 pr_err("Error probing battery stop; %d\n", battery);
9379 /* Support is marked in bit 8 */
9381 battery_info.batteries[battery].stop_support = 1;
9384 if (tpacpi_battery_get(THRESHOLD_STOP, battery,
9385 &battery_info.batteries[battery].charge_stop)) {
9386 pr_err("Error probing battery stop: %d\n", battery);
9390 pr_info("battery %d registered (start %d, stop %d)",
9392 battery_info.batteries[battery].charge_start,
9393 battery_info.batteries[battery].charge_stop);
9398 /* General helper functions */
9400 static int tpacpi_battery_get_id(const char *battery_name)
9403 if (strcmp(battery_name, "BAT0") == 0)
9405 if (strcmp(battery_name, "BAT1") == 0)
9406 return BAT_SECONDARY;
9408 * If for some reason the battery is not BAT0 nor is it
9409 * BAT1, we will assume it's the default, first battery,
9412 pr_warn("unknown battery %s, assuming primary", battery_name);
9416 /* sysfs interface */
9418 static ssize_t tpacpi_battery_store(int what,
9420 const char *buf, size_t count)
9422 struct power_supply *supply = to_power_supply(dev);
9423 unsigned long value;
9426 * Some systems have support for more than
9427 * one battery. If that is the case,
9428 * tpacpi_battery_probe marked that addressing
9429 * them individually is supported, so we do that
9430 * based on the device struct.
9432 * On systems that are not supported, we assume
9433 * the primary as most of the ACPI calls fail
9434 * with "Any Battery" as the parameter.
9436 if (battery_info.individual_addressing)
9437 /* BAT_PRIMARY or BAT_SECONDARY */
9438 battery = tpacpi_battery_get_id(supply->desc->name);
9440 battery = BAT_PRIMARY;
9442 rval = kstrtoul(buf, 10, &value);
9447 case THRESHOLD_START:
9448 if (!battery_info.batteries[battery].start_support)
9450 /* valid values are [0, 99] */
9451 if (value < 0 || value > 99)
9453 if (value > battery_info.batteries[battery].charge_stop)
9455 if (tpacpi_battery_set(THRESHOLD_START, battery, value))
9457 battery_info.batteries[battery].charge_start = value;
9460 case THRESHOLD_STOP:
9461 if (!battery_info.batteries[battery].stop_support)
9463 /* valid values are [1, 100] */
9464 if (value < 1 || value > 100)
9466 if (value < battery_info.batteries[battery].charge_start)
9468 battery_info.batteries[battery].charge_stop = value;
9470 * When 100 is passed to stop, we need to flip
9471 * it to 0 as that the EC understands that as
9472 * "Default", which will charge to 100%
9476 if (tpacpi_battery_set(THRESHOLD_STOP, battery, value))
9480 pr_crit("Wrong parameter: %d", what);
9486 static ssize_t tpacpi_battery_show(int what,
9490 struct power_supply *supply = to_power_supply(dev);
9493 * Some systems have support for more than
9494 * one battery. If that is the case,
9495 * tpacpi_battery_probe marked that addressing
9496 * them individually is supported, so we;
9497 * based on the device struct.
9499 * On systems that are not supported, we assume
9500 * the primary as most of the ACPI calls fail
9501 * with "Any Battery" as the parameter.
9503 if (battery_info.individual_addressing)
9504 /* BAT_PRIMARY or BAT_SECONDARY */
9505 battery = tpacpi_battery_get_id(supply->desc->name);
9507 battery = BAT_PRIMARY;
9508 if (tpacpi_battery_get(what, battery, &ret))
9510 return sprintf(buf, "%d\n", ret);
9513 static ssize_t charge_start_threshold_show(struct device *device,
9514 struct device_attribute *attr,
9517 return tpacpi_battery_show(THRESHOLD_START, device, buf);
9520 static ssize_t charge_stop_threshold_show(struct device *device,
9521 struct device_attribute *attr,
9524 return tpacpi_battery_show(THRESHOLD_STOP, device, buf);
9527 static ssize_t charge_start_threshold_store(struct device *dev,
9528 struct device_attribute *attr,
9529 const char *buf, size_t count)
9531 return tpacpi_battery_store(THRESHOLD_START, dev, buf, count);
9534 static ssize_t charge_stop_threshold_store(struct device *dev,
9535 struct device_attribute *attr,
9536 const char *buf, size_t count)
9538 return tpacpi_battery_store(THRESHOLD_STOP, dev, buf, count);
9541 static DEVICE_ATTR_RW(charge_start_threshold);
9542 static DEVICE_ATTR_RW(charge_stop_threshold);
9544 static struct attribute *tpacpi_battery_attrs[] = {
9545 &dev_attr_charge_start_threshold.attr,
9546 &dev_attr_charge_stop_threshold.attr,
9550 ATTRIBUTE_GROUPS(tpacpi_battery);
9552 /* ACPI battery hooking */
9554 static int tpacpi_battery_add(struct power_supply *battery)
9556 int batteryid = tpacpi_battery_get_id(battery->desc->name);
9558 if (tpacpi_battery_probe(batteryid))
9560 if (device_add_groups(&battery->dev, tpacpi_battery_groups))
9565 static int tpacpi_battery_remove(struct power_supply *battery)
9567 device_remove_groups(&battery->dev, tpacpi_battery_groups);
9571 static struct acpi_battery_hook battery_hook = {
9572 .add_battery = tpacpi_battery_add,
9573 .remove_battery = tpacpi_battery_remove,
9574 .name = "ThinkPad Battery Extension",
9577 /* Subdriver init/exit */
9579 static int __init tpacpi_battery_init(struct ibm_init_struct *ibm)
9581 battery_hook_register(&battery_hook);
9585 static void tpacpi_battery_exit(void)
9587 battery_hook_unregister(&battery_hook);
9590 static struct ibm_struct battery_driver_data = {
9592 .exit = tpacpi_battery_exit,
9595 /****************************************************************************
9596 ****************************************************************************
9600 ****************************************************************************
9601 ****************************************************************************/
9604 * HKEY event callout for other subdrivers go here
9605 * (yes, it is ugly, but it is quick, safe, and gets the job done
9607 static void tpacpi_driver_event(const unsigned int hkey_event)
9609 if (ibm_backlight_device) {
9610 switch (hkey_event) {
9611 case TP_HKEY_EV_BRGHT_UP:
9612 case TP_HKEY_EV_BRGHT_DOWN:
9613 tpacpi_brightness_notify_change();
9617 switch (hkey_event) {
9618 case TP_HKEY_EV_VOL_UP:
9619 case TP_HKEY_EV_VOL_DOWN:
9620 case TP_HKEY_EV_VOL_MUTE:
9621 volume_alsa_notify_change();
9624 if (tp_features.kbdlight && hkey_event == TP_HKEY_EV_KBD_LIGHT) {
9625 enum led_brightness brightness;
9627 mutex_lock(&kbdlight_mutex);
9630 * Check the brightness actually changed, setting the brightness
9631 * through kbdlight_set_level() also triggers this event.
9633 brightness = kbdlight_sysfs_get(NULL);
9634 if (kbdlight_brightness != brightness) {
9635 kbdlight_brightness = brightness;
9636 led_classdev_notify_brightness_hw_changed(
9637 &tpacpi_led_kbdlight.led_classdev, brightness);
9640 mutex_unlock(&kbdlight_mutex);
9644 static void hotkey_driver_event(const unsigned int scancode)
9646 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
9649 /* --------------------------------------------------------------------- */
9652 static struct proc_dir_entry *proc_dir;
9655 * Module and infrastructure proble, init and exit handling
9658 static bool force_load;
9660 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
9661 static const char * __init str_supported(int is_supported)
9663 static char text_unsupported[] __initdata = "not supported";
9665 return (is_supported) ? &text_unsupported[4] : &text_unsupported[0];
9667 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
9669 static void ibm_exit(struct ibm_struct *ibm)
9671 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
9673 list_del_init(&ibm->all_drivers);
9675 if (ibm->flags.acpi_notify_installed) {
9676 dbg_printk(TPACPI_DBG_EXIT,
9677 "%s: acpi_remove_notify_handler\n", ibm->name);
9679 acpi_remove_notify_handler(*ibm->acpi->handle,
9681 dispatch_acpi_notify);
9682 ibm->flags.acpi_notify_installed = 0;
9685 if (ibm->flags.proc_created) {
9686 dbg_printk(TPACPI_DBG_EXIT,
9687 "%s: remove_proc_entry\n", ibm->name);
9688 remove_proc_entry(ibm->name, proc_dir);
9689 ibm->flags.proc_created = 0;
9692 if (ibm->flags.acpi_driver_registered) {
9693 dbg_printk(TPACPI_DBG_EXIT,
9694 "%s: acpi_bus_unregister_driver\n", ibm->name);
9696 acpi_bus_unregister_driver(ibm->acpi->driver);
9697 kfree(ibm->acpi->driver);
9698 ibm->acpi->driver = NULL;
9699 ibm->flags.acpi_driver_registered = 0;
9702 if (ibm->flags.init_called && ibm->exit) {
9704 ibm->flags.init_called = 0;
9707 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
9710 static int __init ibm_init(struct ibm_init_struct *iibm)
9713 struct ibm_struct *ibm = iibm->data;
9714 struct proc_dir_entry *entry;
9716 BUG_ON(ibm == NULL);
9718 INIT_LIST_HEAD(&ibm->all_drivers);
9720 if (ibm->flags.experimental && !experimental)
9723 dbg_printk(TPACPI_DBG_INIT,
9724 "probing for %s\n", ibm->name);
9727 ret = iibm->init(iibm);
9729 return 0; /* probe failed */
9733 ibm->flags.init_called = 1;
9737 if (ibm->acpi->hid) {
9738 ret = register_tpacpi_subdriver(ibm);
9743 if (ibm->acpi->notify) {
9744 ret = setup_acpi_notify(ibm);
9745 if (ret == -ENODEV) {
9746 pr_notice("disabling subdriver %s\n",
9756 dbg_printk(TPACPI_DBG_INIT,
9757 "%s installed\n", ibm->name);
9760 umode_t mode = iibm->base_procfs_mode;
9766 entry = proc_create_data(ibm->name, mode, proc_dir,
9767 &dispatch_proc_fops, ibm);
9769 pr_err("unable to create proc entry %s\n", ibm->name);
9773 ibm->flags.proc_created = 1;
9776 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
9781 dbg_printk(TPACPI_DBG_INIT,
9782 "%s: at error exit path with result %d\n",
9786 return (ret < 0) ? ret : 0;
9791 static bool __pure __init tpacpi_is_fw_digit(const char c)
9793 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
9796 static bool __pure __init tpacpi_is_valid_fw_id(const char * const s,
9800 * Most models: xxyTkkWW (#.##c)
9801 * Ancient 570/600 and -SL lacks (#.##c)
9803 if (s && strlen(s) >= 8 &&
9804 tpacpi_is_fw_digit(s[0]) &&
9805 tpacpi_is_fw_digit(s[1]) &&
9807 (s[3] == 'T' || s[3] == 'N') &&
9808 tpacpi_is_fw_digit(s[4]) &&
9809 tpacpi_is_fw_digit(s[5]))
9812 /* New models: xxxyTkkW (#.##c); T550 and some others */
9813 return s && strlen(s) >= 8 &&
9814 tpacpi_is_fw_digit(s[0]) &&
9815 tpacpi_is_fw_digit(s[1]) &&
9816 tpacpi_is_fw_digit(s[2]) &&
9818 (s[4] == 'T' || s[4] == 'N') &&
9819 tpacpi_is_fw_digit(s[5]) &&
9820 tpacpi_is_fw_digit(s[6]);
9823 /* returns 0 - probe ok, or < 0 - probe error.
9824 * Probe ok doesn't mean thinkpad found.
9825 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
9826 static int __must_check __init get_thinkpad_model_data(
9827 struct thinkpad_id_data *tp)
9829 const struct dmi_device *dev = NULL;
9830 char ec_fw_string[18];
9836 memset(tp, 0, sizeof(*tp));
9838 if (dmi_name_in_vendors("IBM"))
9839 tp->vendor = PCI_VENDOR_ID_IBM;
9840 else if (dmi_name_in_vendors("LENOVO"))
9841 tp->vendor = PCI_VENDOR_ID_LENOVO;
9845 s = dmi_get_system_info(DMI_BIOS_VERSION);
9846 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
9847 if (s && !tp->bios_version_str)
9850 /* Really ancient ThinkPad 240X will fail this, which is fine */
9851 if (!(tpacpi_is_valid_fw_id(tp->bios_version_str, 'E') ||
9852 tpacpi_is_valid_fw_id(tp->bios_version_str, 'C')))
9855 tp->bios_model = tp->bios_version_str[0]
9856 | (tp->bios_version_str[1] << 8);
9857 tp->bios_release = (tp->bios_version_str[4] << 8)
9858 | tp->bios_version_str[5];
9861 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
9862 * X32 or newer, all Z series; Some models must have an
9863 * up-to-date BIOS or they will not be detected.
9865 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9867 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
9868 if (sscanf(dev->name,
9869 "IBM ThinkPad Embedded Controller -[%17c",
9870 ec_fw_string) == 1) {
9871 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
9872 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
9874 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
9875 if (!tp->ec_version_str)
9878 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
9879 tp->ec_model = ec_fw_string[0]
9880 | (ec_fw_string[1] << 8);
9881 tp->ec_release = (ec_fw_string[4] << 8)
9884 pr_notice("ThinkPad firmware release %s doesn't match the known patterns\n",
9886 pr_notice("please report this to %s\n",
9893 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
9894 if (s && !(strncasecmp(s, "ThinkPad", 8) && strncasecmp(s, "Lenovo", 6))) {
9895 tp->model_str = kstrdup(s, GFP_KERNEL);
9899 s = dmi_get_system_info(DMI_BIOS_VENDOR);
9900 if (s && !(strncasecmp(s, "Lenovo", 6))) {
9901 tp->model_str = kstrdup(s, GFP_KERNEL);
9907 s = dmi_get_system_info(DMI_PRODUCT_NAME);
9908 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
9909 if (s && !tp->nummodel_str)
9915 static int __init probe_for_thinkpad(void)
9922 /* It would be dangerous to run the driver in this case */
9923 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
9927 * Non-ancient models have better DMI tagging, but very old models
9928 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
9930 is_thinkpad = (thinkpad_id.model_str != NULL) ||
9931 (thinkpad_id.ec_model != 0) ||
9932 tpacpi_is_fw_known();
9934 /* The EC handler is required */
9935 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
9938 pr_err("Not yet supported ThinkPad detected!\n");
9942 if (!is_thinkpad && !force_load)
9948 static void __init thinkpad_acpi_init_banner(void)
9950 pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
9951 pr_info("%s\n", TPACPI_URL);
9953 pr_info("ThinkPad BIOS %s, EC %s\n",
9954 (thinkpad_id.bios_version_str) ?
9955 thinkpad_id.bios_version_str : "unknown",
9956 (thinkpad_id.ec_version_str) ?
9957 thinkpad_id.ec_version_str : "unknown");
9959 BUG_ON(!thinkpad_id.vendor);
9961 if (thinkpad_id.model_str)
9962 pr_info("%s %s, model %s\n",
9963 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
9964 "IBM" : ((thinkpad_id.vendor ==
9965 PCI_VENDOR_ID_LENOVO) ?
9966 "Lenovo" : "Unknown vendor"),
9967 thinkpad_id.model_str,
9968 (thinkpad_id.nummodel_str) ?
9969 thinkpad_id.nummodel_str : "unknown");
9972 /* Module init, exit, parameters */
9974 static struct ibm_init_struct ibms_init[] __initdata = {
9976 .data = &thinkpad_acpi_driver_data,
9979 .init = hotkey_init,
9980 .data = &hotkey_driver_data,
9983 .init = bluetooth_init,
9984 .data = &bluetooth_driver_data,
9988 .data = &wan_driver_data,
9992 .data = &uwb_driver_data,
9994 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
9997 .base_procfs_mode = S_IRUSR,
9998 .data = &video_driver_data,
10002 .init = kbdlight_init,
10003 .data = &kbdlight_driver_data,
10006 .init = light_init,
10007 .data = &light_driver_data,
10011 .data = &cmos_driver_data,
10015 .data = &led_driver_data,
10019 .data = &beep_driver_data,
10022 .init = thermal_init,
10023 .data = &thermal_driver_data,
10026 .init = brightness_init,
10027 .data = &brightness_driver_data,
10030 .init = volume_init,
10031 .data = &volume_driver_data,
10035 .data = &fan_driver_data,
10038 .init = mute_led_init,
10039 .data = &mute_led_driver_data,
10042 .init = tpacpi_battery_init,
10043 .data = &battery_driver_data,
10047 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
10050 struct ibm_struct *ibm;
10052 if (!kp || !kp->name || !val)
10055 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
10056 ibm = ibms_init[i].data;
10057 WARN_ON(ibm == NULL);
10059 if (!ibm || !ibm->name)
10062 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
10063 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
10065 strcpy(ibms_init[i].param, val);
10066 strcat(ibms_init[i].param, ",");
10074 module_param(experimental, int, 0444);
10075 MODULE_PARM_DESC(experimental,
10076 "Enables experimental features when non-zero");
10078 module_param_named(debug, dbg_level, uint, 0);
10079 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
10081 module_param(force_load, bool, 0444);
10082 MODULE_PARM_DESC(force_load,
10083 "Attempts to load the driver even on a mis-identified ThinkPad when true");
10085 module_param_named(fan_control, fan_control_allowed, bool, 0444);
10086 MODULE_PARM_DESC(fan_control,
10087 "Enables setting fan parameters features when true");
10089 module_param_named(brightness_mode, brightness_mode, uint, 0444);
10090 MODULE_PARM_DESC(brightness_mode,
10091 "Selects brightness control strategy: 0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
10093 module_param(brightness_enable, uint, 0444);
10094 MODULE_PARM_DESC(brightness_enable,
10095 "Enables backlight control when 1, disables when 0");
10097 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
10098 module_param_named(volume_mode, volume_mode, uint, 0444);
10099 MODULE_PARM_DESC(volume_mode,
10100 "Selects volume control strategy: 0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
10102 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
10103 MODULE_PARM_DESC(volume_capabilities,
10104 "Selects the mixer capabilites: 0=auto, 1=volume and mute, 2=mute only");
10106 module_param_named(volume_control, volume_control_allowed, bool, 0444);
10107 MODULE_PARM_DESC(volume_control,
10108 "Enables software override for the console audio control when true");
10110 module_param_named(software_mute, software_mute_requested, bool, 0444);
10111 MODULE_PARM_DESC(software_mute,
10112 "Request full software mute control");
10114 /* ALSA module API parameters */
10115 module_param_named(index, alsa_index, int, 0444);
10116 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
10117 module_param_named(id, alsa_id, charp, 0444);
10118 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
10119 module_param_named(enable, alsa_enable, bool, 0444);
10120 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
10121 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
10123 /* The module parameter can't be read back, that's why 0 is used here */
10124 #define TPACPI_PARAM(feature) \
10125 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
10126 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command at module load, see documentation")
10128 TPACPI_PARAM(hotkey);
10129 TPACPI_PARAM(bluetooth);
10130 TPACPI_PARAM(video);
10131 TPACPI_PARAM(light);
10132 TPACPI_PARAM(cmos);
10134 TPACPI_PARAM(beep);
10135 TPACPI_PARAM(brightness);
10136 TPACPI_PARAM(volume);
10139 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10140 module_param(dbg_wlswemul, uint, 0444);
10141 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
10142 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
10143 MODULE_PARM_DESC(wlsw_state,
10144 "Initial state of the emulated WLSW switch");
10146 module_param(dbg_bluetoothemul, uint, 0444);
10147 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
10148 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
10149 MODULE_PARM_DESC(bluetooth_state,
10150 "Initial state of the emulated bluetooth switch");
10152 module_param(dbg_wwanemul, uint, 0444);
10153 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
10154 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
10155 MODULE_PARM_DESC(wwan_state,
10156 "Initial state of the emulated WWAN switch");
10158 module_param(dbg_uwbemul, uint, 0444);
10159 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
10160 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
10161 MODULE_PARM_DESC(uwb_state,
10162 "Initial state of the emulated UWB switch");
10165 static void thinkpad_acpi_module_exit(void)
10167 struct ibm_struct *ibm, *itmp;
10169 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
10171 list_for_each_entry_safe_reverse(ibm, itmp,
10172 &tpacpi_all_drivers,
10177 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
10179 if (tpacpi_inputdev) {
10180 if (tp_features.input_device_registered)
10181 input_unregister_device(tpacpi_inputdev);
10183 input_free_device(tpacpi_inputdev);
10184 kfree(hotkey_keycode_map);
10188 hwmon_device_unregister(tpacpi_hwmon);
10190 if (tpacpi_sensors_pdev)
10191 platform_device_unregister(tpacpi_sensors_pdev);
10193 platform_device_unregister(tpacpi_pdev);
10195 if (tp_features.sensors_pdrv_attrs_registered)
10196 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
10197 if (tp_features.platform_drv_attrs_registered)
10198 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
10200 if (tp_features.sensors_pdrv_registered)
10201 platform_driver_unregister(&tpacpi_hwmon_pdriver);
10203 if (tp_features.platform_drv_registered)
10204 platform_driver_unregister(&tpacpi_pdriver);
10207 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
10210 destroy_workqueue(tpacpi_wq);
10212 kfree(thinkpad_id.bios_version_str);
10213 kfree(thinkpad_id.ec_version_str);
10214 kfree(thinkpad_id.model_str);
10215 kfree(thinkpad_id.nummodel_str);
10219 static int __init thinkpad_acpi_module_init(void)
10223 tpacpi_lifecycle = TPACPI_LIFE_INIT;
10225 /* Driver-level probe */
10227 ret = get_thinkpad_model_data(&thinkpad_id);
10229 pr_err("unable to get DMI data: %d\n", ret);
10230 thinkpad_acpi_module_exit();
10233 ret = probe_for_thinkpad();
10235 thinkpad_acpi_module_exit();
10239 /* Driver initialization */
10241 thinkpad_acpi_init_banner();
10242 tpacpi_check_outdated_fw();
10244 TPACPI_ACPIHANDLE_INIT(ecrd);
10245 TPACPI_ACPIHANDLE_INIT(ecwr);
10247 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
10249 thinkpad_acpi_module_exit();
10253 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
10255 pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
10256 thinkpad_acpi_module_exit();
10260 ret = platform_driver_register(&tpacpi_pdriver);
10262 pr_err("unable to register main platform driver\n");
10263 thinkpad_acpi_module_exit();
10266 tp_features.platform_drv_registered = 1;
10268 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
10270 pr_err("unable to register hwmon platform driver\n");
10271 thinkpad_acpi_module_exit();
10274 tp_features.sensors_pdrv_registered = 1;
10276 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
10278 tp_features.platform_drv_attrs_registered = 1;
10279 ret = tpacpi_create_driver_attributes(
10280 &tpacpi_hwmon_pdriver.driver);
10283 pr_err("unable to create sysfs driver attributes\n");
10284 thinkpad_acpi_module_exit();
10287 tp_features.sensors_pdrv_attrs_registered = 1;
10290 /* Device initialization */
10291 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
10293 if (IS_ERR(tpacpi_pdev)) {
10294 ret = PTR_ERR(tpacpi_pdev);
10295 tpacpi_pdev = NULL;
10296 pr_err("unable to register platform device\n");
10297 thinkpad_acpi_module_exit();
10300 tpacpi_sensors_pdev = platform_device_register_simple(
10301 TPACPI_HWMON_DRVR_NAME,
10303 if (IS_ERR(tpacpi_sensors_pdev)) {
10304 ret = PTR_ERR(tpacpi_sensors_pdev);
10305 tpacpi_sensors_pdev = NULL;
10306 pr_err("unable to register hwmon platform device\n");
10307 thinkpad_acpi_module_exit();
10310 tp_features.sensors_pdev_attrs_registered = 1;
10311 tpacpi_hwmon = hwmon_device_register_with_groups(
10312 &tpacpi_sensors_pdev->dev, TPACPI_NAME, NULL, NULL);
10314 if (IS_ERR(tpacpi_hwmon)) {
10315 ret = PTR_ERR(tpacpi_hwmon);
10316 tpacpi_hwmon = NULL;
10317 pr_err("unable to register hwmon device\n");
10318 thinkpad_acpi_module_exit();
10321 mutex_init(&tpacpi_inputdev_send_mutex);
10322 tpacpi_inputdev = input_allocate_device();
10323 if (!tpacpi_inputdev) {
10324 thinkpad_acpi_module_exit();
10327 /* Prepare input device, but don't register */
10328 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
10329 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
10330 tpacpi_inputdev->id.bustype = BUS_HOST;
10331 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
10332 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
10333 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
10334 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
10337 /* Init subdriver dependencies */
10338 tpacpi_detect_brightness_capabilities();
10340 /* Init subdrivers */
10341 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
10342 ret = ibm_init(&ibms_init[i]);
10343 if (ret >= 0 && *ibms_init[i].param)
10344 ret = ibms_init[i].data->write(ibms_init[i].param);
10346 thinkpad_acpi_module_exit();
10351 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
10353 ret = input_register_device(tpacpi_inputdev);
10355 pr_err("unable to register input device\n");
10356 thinkpad_acpi_module_exit();
10359 tp_features.input_device_registered = 1;
10365 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
10368 * This will autoload the driver in almost every ThinkPad
10369 * in widespread use.
10371 * Only _VERY_ old models, like the 240, 240x and 570 lack
10372 * the HKEY event interface.
10374 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
10377 * DMI matching for module autoloading
10379 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
10380 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
10382 * Only models listed in thinkwiki will be supported, so add yours
10383 * if it is not there yet.
10385 #define IBM_BIOS_MODULE_ALIAS(__type) \
10386 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
10388 /* Ancient thinkpad BIOSes have to be identified by
10389 * BIOS type or model number, and there are far less
10390 * BIOS types than model numbers... */
10391 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
10393 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
10394 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
10395 MODULE_DESCRIPTION(TPACPI_DESC);
10396 MODULE_VERSION(TPACPI_VERSION);
10397 MODULE_LICENSE("GPL");
10399 module_init(thinkpad_acpi_module_init);
10400 module_exit(thinkpad_acpi_module_exit);