1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * 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>
9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11 #define TPACPI_VERSION "0.26"
12 #define TPACPI_SYSFS_VERSION 0x030000
16 * 2007-10-20 changelog trimmed down
18 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
21 * 2006-11-22 0.13 new maintainer
22 * changelog now lives in git commit history, and will
23 * not be updated further in-file.
25 * 2005-03-17 0.11 support for 600e, 770x
26 * thanks to Jamie Lentin <lentinj@dial.pipex.com>
28 * 2005-01-16 0.9 use MODULE_VERSION
29 * thanks to Henrik Brix Andersen <brix@gentoo.org>
30 * fix parameter passing on module loading
31 * thanks to Rusty Russell <rusty@rustcorp.com.au>
32 * thanks to Jim Radford <radford@blackbean.org>
33 * 2004-11-08 0.8 fix init error case, don't return from a macro
34 * thanks to Chris Wright <chrisw@osdl.org>
37 #include <linux/kernel.h>
38 #include <linux/module.h>
39 #include <linux/init.h>
40 #include <linux/types.h>
41 #include <linux/string.h>
42 #include <linux/list.h>
43 #include <linux/mutex.h>
44 #include <linux/sched.h>
45 #include <linux/sched/signal.h>
46 #include <linux/kthread.h>
47 #include <linux/freezer.h>
48 #include <linux/delay.h>
49 #include <linux/slab.h>
50 #include <linux/nvram.h>
51 #include <linux/proc_fs.h>
52 #include <linux/seq_file.h>
53 #include <linux/sysfs.h>
54 #include <linux/backlight.h>
55 #include <linux/bitops.h>
57 #include <linux/platform_device.h>
58 #include <linux/hwmon.h>
59 #include <linux/hwmon-sysfs.h>
60 #include <linux/input.h>
61 #include <linux/leds.h>
62 #include <linux/rfkill.h>
63 #include <linux/dmi.h>
64 #include <linux/jiffies.h>
65 #include <linux/workqueue.h>
66 #include <linux/acpi.h>
67 #include <linux/pci.h>
68 #include <linux/power_supply.h>
69 #include <linux/platform_profile.h>
70 #include <sound/core.h>
71 #include <sound/control.h>
72 #include <sound/initval.h>
73 #include <linux/uaccess.h>
74 #include <acpi/battery.h>
75 #include <acpi/video.h>
76 #include <drm/drm_privacy_screen_driver.h>
77 #include "dual_accel_detect.h"
79 /* ThinkPad CMOS commands */
80 #define TP_CMOS_VOLUME_DOWN 0
81 #define TP_CMOS_VOLUME_UP 1
82 #define TP_CMOS_VOLUME_MUTE 2
83 #define TP_CMOS_BRIGHTNESS_UP 4
84 #define TP_CMOS_BRIGHTNESS_DOWN 5
85 #define TP_CMOS_THINKLIGHT_ON 12
86 #define TP_CMOS_THINKLIGHT_OFF 13
90 TP_NVRAM_ADDR_HK2 = 0x57,
91 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
92 TP_NVRAM_ADDR_VIDEO = 0x59,
93 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
94 TP_NVRAM_ADDR_MIXER = 0x60,
99 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
100 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
101 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
102 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
103 TP_NVRAM_MASK_THINKLIGHT = 0x10,
104 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
105 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
106 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
107 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
108 TP_NVRAM_MASK_MUTE = 0x40,
109 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
110 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
111 TP_NVRAM_POS_LEVEL_VOLUME = 0,
114 /* Misc NVRAM-related */
116 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
120 #define TPACPI_ACPI_IBM_HKEY_HID "IBM0068"
121 #define TPACPI_ACPI_LENOVO_HKEY_HID "LEN0068"
122 #define TPACPI_ACPI_LENOVO_HKEY_V2_HID "LEN0268"
123 #define TPACPI_ACPI_EC_HID "PNP0C09"
126 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
127 #define TPACPI_HKEY_INPUT_VERSION 0x4101
129 /* ACPI \WGSV commands */
131 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
132 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
133 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
134 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
137 /* TP_ACPI_WGSV_GET_STATE bits */
139 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
140 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
141 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
142 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
143 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
144 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
145 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
146 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
147 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
148 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
152 enum tpacpi_hkey_event_t {
154 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
155 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
156 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
157 TP_HKEY_EV_KBD_LIGHT = 0x1012, /* Thinklight/kbd backlight */
158 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
159 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
160 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
161 TP_HKEY_EV_PRIVACYGUARD_TOGGLE = 0x130f, /* Toggle priv.guard on/off */
163 /* Reasons for waking up from S3/S4 */
164 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
165 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
166 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
167 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
168 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
169 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
171 /* Auto-sleep after eject request */
172 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
173 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
175 /* Misc bay events */
176 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
177 TP_HKEY_EV_HOTPLUG_DOCK = 0x4010, /* docked into hotplug dock
178 or port replicator */
179 TP_HKEY_EV_HOTPLUG_UNDOCK = 0x4011, /* undocked from hotplug
180 dock or port replicator */
182 * Thinkpad X1 Tablet series devices emit 0x4012 and 0x4013
183 * when keyboard cover is attached, detached or folded onto the back
185 TP_HKEY_EV_KBD_COVER_ATTACH = 0x4012, /* keyboard cover attached */
186 TP_HKEY_EV_KBD_COVER_DETACH = 0x4013, /* keyboard cover detached or folded back */
188 /* User-interface events */
189 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
190 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
191 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
192 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
193 TP_HKEY_EV_TABLET_CHANGED = 0x60c0, /* X1 Yoga (2016):
194 * enter/leave tablet mode
196 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
197 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
198 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
200 /* Key-related user-interface events */
201 TP_HKEY_EV_KEY_NUMLOCK = 0x6000, /* NumLock key pressed */
202 TP_HKEY_EV_KEY_FN = 0x6005, /* Fn key pressed? E420 */
203 TP_HKEY_EV_KEY_FN_ESC = 0x6060, /* Fn+Esc key pressed X240 */
206 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
207 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
208 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
209 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
210 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* windows; thermal table changed */
211 TP_HKEY_EV_THM_CSM_COMPLETED = 0x6032, /* windows; thermal control set
212 * command completed. Related to
214 TP_HKEY_EV_THM_TRANSFM_CHANGED = 0x60F0, /* windows; thermal transformation
215 * changed. Related to AML GMTS */
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 static struct quirk_entry quirk_btusb_bug = {
322 static struct quirk_entry quirk_s2idle_bug = {
323 .s2idle_bug_mmio = 0xfed80380,
332 TP_HOTKEY_TABLET_NONE = 0,
333 TP_HOTKEY_TABLET_USES_MHKG,
334 TP_HOTKEY_TABLET_USES_GMMS,
339 u32 bright_acpimode:1;
343 u32 fan_ctrl_status_undef:1;
345 u32 second_fan_ctl:1;
346 u32 beep_needs_two_args:1;
347 u32 mixer_no_level_control:1;
348 u32 battery_force_primary:1;
349 u32 input_device_registered:1;
350 u32 platform_drv_registered:1;
351 u32 sensors_pdrv_registered:1;
352 u32 hotkey_poll_active:1;
353 u32 has_adaptive_kbd:1;
355 struct quirk_entry *quirks;
359 u16 hotkey_mask_ff:1;
360 u16 volume_ctrl_forbidden:1;
363 struct thinkpad_id_data {
364 unsigned int vendor; /* ThinkPad vendor:
365 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
367 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
368 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
370 u32 bios_model; /* 1Y = 0x3159, 0 = unknown */
372 u16 bios_release; /* 1ZETK1WW = 0x4b31, 0 = unknown */
375 char *model_str; /* ThinkPad T43 */
376 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
378 static struct thinkpad_id_data thinkpad_id;
381 TPACPI_LIFE_INIT = 0,
386 static int experimental;
387 static u32 dbg_level;
389 static struct workqueue_struct *tpacpi_wq;
397 /* tpacpi LED class */
398 struct tpacpi_led_classdev {
399 struct led_classdev led_classdev;
403 /* brightness level capabilities */
404 static unsigned int bright_maxlvl; /* 0 = unknown */
406 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
407 static int dbg_wlswemul;
408 static bool tpacpi_wlsw_emulstate;
409 static int dbg_bluetoothemul;
410 static bool tpacpi_bluetooth_emulstate;
411 static int dbg_wwanemul;
412 static bool tpacpi_wwan_emulstate;
413 static int dbg_uwbemul;
414 static bool tpacpi_uwb_emulstate;
418 /*************************************************************************
422 #define dbg_printk(a_dbg_level, format, arg...) \
424 if (dbg_level & (a_dbg_level)) \
425 printk(KERN_DEBUG pr_fmt("%s: " format), \
429 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
430 #define vdbg_printk dbg_printk
431 static const char *str_supported(int is_supported);
433 static inline const char *str_supported(int is_supported) { return ""; }
434 #define vdbg_printk(a_dbg_level, format, arg...) \
435 do { if (0) no_printk(format, ##arg); } while (0)
438 static void tpacpi_log_usertask(const char * const what)
440 printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
441 what, task_tgid_vnr(current));
444 #define tpacpi_disclose_usertask(what, format, arg...) \
446 if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) && \
447 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
448 printk(KERN_DEBUG pr_fmt("%s: PID %d: " format), \
449 what, task_tgid_vnr(current), ## arg); \
454 * Quirk handling helpers
456 * ThinkPad IDs and versions seen in the field so far are
457 * two or three characters from the set [0-9A-Z], i.e. base 36.
459 * We use values well outside that range as specials.
462 #define TPACPI_MATCH_ANY 0xffffffffU
463 #define TPACPI_MATCH_ANY_VERSION 0xffffU
464 #define TPACPI_MATCH_UNKNOWN 0U
466 /* TPID('1', 'Y') == 0x3159 */
467 #define TPID(__c1, __c2) (((__c1) << 8) | (__c2))
468 #define TPID3(__c1, __c2, __c3) (((__c1) << 16) | ((__c2) << 8) | (__c3))
471 #define TPACPI_Q_IBM(__id1, __id2, __quirk) \
472 { .vendor = PCI_VENDOR_ID_IBM, \
473 .bios = TPID(__id1, __id2), \
474 .ec = TPACPI_MATCH_ANY, \
475 .quirks = (__quirk) }
477 #define TPACPI_Q_LNV(__id1, __id2, __quirk) \
478 { .vendor = PCI_VENDOR_ID_LENOVO, \
479 .bios = TPID(__id1, __id2), \
480 .ec = TPACPI_MATCH_ANY, \
481 .quirks = (__quirk) }
483 #define TPACPI_Q_LNV3(__id1, __id2, __id3, __quirk) \
484 { .vendor = PCI_VENDOR_ID_LENOVO, \
485 .bios = TPID3(__id1, __id2, __id3), \
486 .ec = TPACPI_MATCH_ANY, \
487 .quirks = (__quirk) }
489 #define TPACPI_QEC_IBM(__id1, __id2, __quirk) \
490 { .vendor = PCI_VENDOR_ID_IBM, \
491 .bios = TPACPI_MATCH_ANY, \
492 .ec = TPID(__id1, __id2), \
493 .quirks = (__quirk) }
495 #define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
496 { .vendor = PCI_VENDOR_ID_LENOVO, \
497 .bios = TPACPI_MATCH_ANY, \
498 .ec = TPID(__id1, __id2), \
499 .quirks = (__quirk) }
501 struct tpacpi_quirk {
505 unsigned long quirks;
509 * tpacpi_check_quirks() - search BIOS/EC version on a list
510 * @qlist: array of &struct tpacpi_quirk
511 * @qlist_size: number of elements in @qlist
513 * Iterates over a quirks list until one is found that matches the
514 * ThinkPad's vendor, BIOS and EC model.
516 * Returns 0 if nothing matches, otherwise returns the quirks field of
517 * the matching &struct tpacpi_quirk entry.
519 * The match criteria is: vendor, ec and bios much match.
521 static unsigned long __init tpacpi_check_quirks(
522 const struct tpacpi_quirk *qlist,
523 unsigned int qlist_size)
526 if ((qlist->vendor == thinkpad_id.vendor ||
527 qlist->vendor == TPACPI_MATCH_ANY) &&
528 (qlist->bios == thinkpad_id.bios_model ||
529 qlist->bios == TPACPI_MATCH_ANY) &&
530 (qlist->ec == thinkpad_id.ec_model ||
531 qlist->ec == TPACPI_MATCH_ANY))
532 return qlist->quirks;
540 static inline bool __pure __init tpacpi_is_lenovo(void)
542 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
545 static inline bool __pure __init tpacpi_is_ibm(void)
547 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
550 /****************************************************************************
551 ****************************************************************************
553 * ACPI Helpers and device model
555 ****************************************************************************
556 ****************************************************************************/
558 /*************************************************************************
562 static acpi_handle root_handle;
563 static acpi_handle ec_handle;
565 #define TPACPI_HANDLE(object, parent, paths...) \
566 static acpi_handle object##_handle; \
567 static const acpi_handle * const object##_parent __initconst = \
569 static char *object##_paths[] __initdata = { paths }
571 TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
572 TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
574 TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
576 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
577 "\\CMS", /* R40, R40e */
580 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
581 "^HKEY", /* R30, R31 */
582 "HKEY", /* all others */
585 /*************************************************************************
589 static int acpi_evalf(acpi_handle handle,
590 int *res, char *method, char *fmt, ...)
593 struct acpi_object_list params;
594 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
595 struct acpi_buffer result, *resultp;
596 union acpi_object out_obj;
604 pr_err("acpi_evalf() called with empty format\n");
617 params.pointer = &in_objs[0];
624 in_objs[params.count].integer.value = va_arg(ap, int);
625 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
627 /* add more types as needed */
629 pr_err("acpi_evalf() called with invalid format character '%c'\n",
637 if (res_type != 'v') {
638 result.length = sizeof(out_obj);
639 result.pointer = &out_obj;
644 status = acpi_evaluate_object(handle, method, ¶ms, resultp);
648 success = (status == AE_OK &&
649 out_obj.type == ACPI_TYPE_INTEGER);
651 *res = out_obj.integer.value;
654 success = status == AE_OK;
656 /* add more types as needed */
658 pr_err("acpi_evalf() called with invalid format character '%c'\n",
663 if (!success && !quiet)
664 pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
665 method, fmt0, acpi_format_exception(status));
670 static int acpi_ec_read(int i, u8 *p)
675 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
679 if (ec_read(i, p) < 0)
686 static int acpi_ec_write(int i, u8 v)
689 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
692 if (ec_write(i, v) < 0)
699 static int issue_thinkpad_cmos_command(int cmos_cmd)
704 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
710 /*************************************************************************
714 #define TPACPI_ACPIHANDLE_INIT(object) \
715 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
716 object##_paths, ARRAY_SIZE(object##_paths))
718 static void __init drv_acpi_handle_init(const char *name,
719 acpi_handle *handle, const acpi_handle parent,
720 char **paths, const int num_paths)
725 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
728 for (i = 0; i < num_paths; i++) {
729 status = acpi_get_handle(parent, paths[i], handle);
730 if (ACPI_SUCCESS(status)) {
731 dbg_printk(TPACPI_DBG_INIT,
732 "Found ACPI handle %s for %s\n",
738 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
743 static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
744 u32 level, void *context, void **return_value)
746 if (!strcmp(context, "video")) {
747 struct acpi_device *dev = acpi_fetch_acpi_dev(handle);
749 if (!dev || strcmp(ACPI_VIDEO_HID, acpi_device_hid(dev)))
753 *(acpi_handle *)return_value = handle;
755 return AE_CTRL_TERMINATE;
758 static void __init tpacpi_acpi_handle_locate(const char *name,
763 acpi_handle device_found;
765 BUG_ON(!name || !handle);
766 vdbg_printk(TPACPI_DBG_INIT,
767 "trying to locate ACPI handle for %s, using HID %s\n",
768 name, hid ? hid : "NULL");
770 memset(&device_found, 0, sizeof(device_found));
771 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
772 (void *)name, &device_found);
776 if (ACPI_SUCCESS(status)) {
777 *handle = device_found;
778 dbg_printk(TPACPI_DBG_INIT,
779 "Found ACPI handle for %s\n", name);
781 vdbg_printk(TPACPI_DBG_INIT,
782 "Could not locate an ACPI handle for %s: %s\n",
783 name, acpi_format_exception(status));
787 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
789 struct ibm_struct *ibm = data;
791 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
794 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
797 ibm->acpi->notify(ibm, event);
800 static int __init setup_acpi_notify(struct ibm_struct *ibm)
806 if (!*ibm->acpi->handle)
809 vdbg_printk(TPACPI_DBG_INIT,
810 "setting up ACPI notify for %s\n", ibm->name);
812 ibm->acpi->device = acpi_fetch_acpi_dev(*ibm->acpi->handle);
813 if (!ibm->acpi->device) {
814 pr_err("acpi_fetch_acpi_dev(%s) failed\n", ibm->name);
818 ibm->acpi->device->driver_data = ibm;
819 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
820 TPACPI_ACPI_EVENT_PREFIX,
823 status = acpi_install_notify_handler(*ibm->acpi->handle,
824 ibm->acpi->type, dispatch_acpi_notify, ibm);
825 if (ACPI_FAILURE(status)) {
826 if (status == AE_ALREADY_EXISTS) {
827 pr_notice("another device driver is already handling %s events\n",
830 pr_err("acpi_install_notify_handler(%s) failed: %s\n",
831 ibm->name, acpi_format_exception(status));
835 ibm->flags.acpi_notify_installed = 1;
839 static int __init tpacpi_device_add(struct acpi_device *device)
844 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
848 dbg_printk(TPACPI_DBG_INIT,
849 "registering %s as an ACPI driver\n", ibm->name);
853 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
854 if (!ibm->acpi->driver) {
855 pr_err("failed to allocate memory for ibm->acpi->driver\n");
859 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
860 ibm->acpi->driver->ids = ibm->acpi->hid;
862 ibm->acpi->driver->ops.add = &tpacpi_device_add;
864 rc = acpi_bus_register_driver(ibm->acpi->driver);
866 pr_err("acpi_bus_register_driver(%s) failed: %d\n",
868 kfree(ibm->acpi->driver);
869 ibm->acpi->driver = NULL;
871 ibm->flags.acpi_driver_registered = 1;
877 /****************************************************************************
878 ****************************************************************************
882 ****************************************************************************
883 ****************************************************************************/
885 static int dispatch_proc_show(struct seq_file *m, void *v)
887 struct ibm_struct *ibm = m->private;
889 if (!ibm || !ibm->read)
894 static int dispatch_proc_open(struct inode *inode, struct file *file)
896 return single_open(file, dispatch_proc_show, pde_data(inode));
899 static ssize_t dispatch_proc_write(struct file *file,
900 const char __user *userbuf,
901 size_t count, loff_t *pos)
903 struct ibm_struct *ibm = pde_data(file_inode(file));
907 if (!ibm || !ibm->write)
909 if (count > PAGE_SIZE - 1)
912 kernbuf = kmalloc(count + 1, GFP_KERNEL);
916 if (copy_from_user(kernbuf, userbuf, count)) {
922 ret = ibm->write(kernbuf);
931 static const struct proc_ops dispatch_proc_ops = {
932 .proc_open = dispatch_proc_open,
933 .proc_read = seq_read,
934 .proc_lseek = seq_lseek,
935 .proc_release = single_release,
936 .proc_write = dispatch_proc_write,
939 /****************************************************************************
940 ****************************************************************************
942 * Device model: input, hwmon and platform
944 ****************************************************************************
945 ****************************************************************************/
947 static struct platform_device *tpacpi_pdev;
948 static struct platform_device *tpacpi_sensors_pdev;
949 static struct device *tpacpi_hwmon;
950 static struct input_dev *tpacpi_inputdev;
951 static struct mutex tpacpi_inputdev_send_mutex;
952 static LIST_HEAD(tpacpi_all_drivers);
954 #ifdef CONFIG_PM_SLEEP
955 static int tpacpi_suspend_handler(struct device *dev)
957 struct ibm_struct *ibm, *itmp;
959 list_for_each_entry_safe(ibm, itmp,
969 static int tpacpi_resume_handler(struct device *dev)
971 struct ibm_struct *ibm, *itmp;
973 list_for_each_entry_safe(ibm, itmp,
984 static SIMPLE_DEV_PM_OPS(tpacpi_pm,
985 tpacpi_suspend_handler, tpacpi_resume_handler);
987 static void tpacpi_shutdown_handler(struct platform_device *pdev)
989 struct ibm_struct *ibm, *itmp;
991 list_for_each_entry_safe(ibm, itmp,
999 /*************************************************************************
1000 * sysfs support helpers
1003 static int parse_strtoul(const char *buf,
1004 unsigned long max, unsigned long *value)
1008 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1009 endp = skip_spaces(endp);
1010 if (*endp || *value > max)
1016 static void tpacpi_disable_brightness_delay(void)
1018 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1019 pr_notice("ACPI backlight control delay disabled\n");
1022 static void printk_deprecated_attribute(const char * const what,
1023 const char * const details)
1025 tpacpi_log_usertask("deprecated sysfs attribute");
1026 pr_warn("WARNING: sysfs attribute %s is deprecated and will be removed. %s\n",
1030 /*************************************************************************
1031 * rfkill and radio control support helpers
1035 * ThinkPad-ACPI firmware handling model:
1037 * WLSW (master wireless switch) is event-driven, and is common to all
1038 * firmware-controlled radios. It cannot be controlled, just monitored,
1039 * as expected. It overrides all radio state in firmware
1041 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1042 * (TODO: verify how WLSW interacts with the returned radio state).
1044 * The only time there are shadow radio state changes, is when
1045 * masked-off hotkeys are used.
1049 * Internal driver API for radio state:
1051 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1052 * bool: true means radio blocked (off)
1054 enum tpacpi_rfkill_state {
1055 TPACPI_RFK_RADIO_OFF = 0,
1059 /* rfkill switches */
1060 enum tpacpi_rfk_id {
1061 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1062 TPACPI_RFK_WWAN_SW_ID,
1063 TPACPI_RFK_UWB_SW_ID,
1067 static const char *tpacpi_rfkill_names[] = {
1068 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1069 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1070 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1071 [TPACPI_RFK_SW_MAX] = NULL
1074 /* ThinkPad-ACPI rfkill subdriver */
1076 struct rfkill *rfkill;
1077 enum tpacpi_rfk_id id;
1078 const struct tpacpi_rfk_ops *ops;
1081 struct tpacpi_rfk_ops {
1082 /* firmware interface */
1083 int (*get_status)(void);
1084 int (*set_status)(const enum tpacpi_rfkill_state);
1087 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1089 /* Query FW and update rfkill sw state for a given rfkill switch */
1090 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1097 status = (tp_rfk->ops->get_status)();
1101 rfkill_set_sw_state(tp_rfk->rfkill,
1102 (status == TPACPI_RFK_RADIO_OFF));
1108 * Sync the HW-blocking state of all rfkill switches,
1109 * do notice it causes the rfkill core to schedule uevents
1111 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1114 struct tpacpi_rfk *tp_rfk;
1116 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1117 tp_rfk = tpacpi_rfkill_switches[i];
1119 if (rfkill_set_hw_state(tp_rfk->rfkill,
1121 /* ignore -- we track sw block */
1127 /* Call to get the WLSW state from the firmware */
1128 static int hotkey_get_wlsw(void);
1130 /* Call to query WLSW state and update all rfkill switches */
1131 static bool tpacpi_rfk_check_hwblock_state(void)
1133 int res = hotkey_get_wlsw();
1136 /* When unknown or unsupported, we have to assume it is unblocked */
1140 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1141 tpacpi_rfk_update_hwblock_state(hw_blocked);
1146 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1148 struct tpacpi_rfk *tp_rfk = data;
1151 dbg_printk(TPACPI_DBG_RFKILL,
1152 "request to change radio state to %s\n",
1153 blocked ? "blocked" : "unblocked");
1155 /* try to set radio state */
1156 res = (tp_rfk->ops->set_status)(blocked ?
1157 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1159 /* and update the rfkill core with whatever the FW really did */
1160 tpacpi_rfk_update_swstate(tp_rfk);
1162 return (res < 0) ? res : 0;
1165 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1166 .set_block = tpacpi_rfk_hook_set_block,
1169 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1170 const struct tpacpi_rfk_ops *tp_rfkops,
1171 const enum rfkill_type rfktype,
1173 const bool set_default)
1175 struct tpacpi_rfk *atp_rfk;
1177 bool sw_state = false;
1181 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1183 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1185 atp_rfk->rfkill = rfkill_alloc(name,
1188 &tpacpi_rfk_rfkill_ops,
1190 if (!atp_rfk || !atp_rfk->rfkill) {
1191 pr_err("failed to allocate memory for rfkill class\n");
1197 atp_rfk->ops = tp_rfkops;
1199 sw_status = (tp_rfkops->get_status)();
1200 if (sw_status < 0) {
1201 pr_err("failed to read initial state for %s, error %d\n",
1204 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1206 /* try to keep the initial state, since we ask the
1207 * firmware to preserve it across S5 in NVRAM */
1208 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1211 hw_state = tpacpi_rfk_check_hwblock_state();
1212 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1214 res = rfkill_register(atp_rfk->rfkill);
1216 pr_err("failed to register %s rfkill switch: %d\n", name, res);
1217 rfkill_destroy(atp_rfk->rfkill);
1222 tpacpi_rfkill_switches[id] = atp_rfk;
1224 pr_info("rfkill switch %s: radio is %sblocked\n",
1225 name, (sw_state || hw_state) ? "" : "un");
1229 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1231 struct tpacpi_rfk *tp_rfk;
1233 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1235 tp_rfk = tpacpi_rfkill_switches[id];
1237 rfkill_unregister(tp_rfk->rfkill);
1238 rfkill_destroy(tp_rfk->rfkill);
1239 tpacpi_rfkill_switches[id] = NULL;
1244 static void printk_deprecated_rfkill_attribute(const char * const what)
1246 printk_deprecated_attribute(what,
1247 "Please switch to generic rfkill before year 2010");
1250 /* sysfs <radio> enable ------------------------------------------------ */
1251 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1252 struct device_attribute *attr,
1257 printk_deprecated_rfkill_attribute(attr->attr.name);
1259 /* This is in the ABI... */
1260 if (tpacpi_rfk_check_hwblock_state()) {
1261 status = TPACPI_RFK_RADIO_OFF;
1263 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1268 return sysfs_emit(buf, "%d\n",
1269 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1272 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1273 struct device_attribute *attr,
1274 const char *buf, size_t count)
1279 printk_deprecated_rfkill_attribute(attr->attr.name);
1281 if (parse_strtoul(buf, 1, &t))
1284 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1286 /* This is in the ABI... */
1287 if (tpacpi_rfk_check_hwblock_state() && !!t)
1290 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1291 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1292 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1294 return (res < 0) ? res : count;
1297 /* procfs -------------------------------------------------------------- */
1298 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1300 if (id >= TPACPI_RFK_SW_MAX)
1301 seq_printf(m, "status:\t\tnot supported\n");
1305 /* This is in the ABI... */
1306 if (tpacpi_rfk_check_hwblock_state()) {
1307 status = TPACPI_RFK_RADIO_OFF;
1309 status = tpacpi_rfk_update_swstate(
1310 tpacpi_rfkill_switches[id]);
1315 seq_printf(m, "status:\t\t%s\n",
1316 (status == TPACPI_RFK_RADIO_ON) ?
1317 "enabled" : "disabled");
1318 seq_printf(m, "commands:\tenable, disable\n");
1324 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1330 if (id >= TPACPI_RFK_SW_MAX)
1333 while ((cmd = strsep(&buf, ","))) {
1334 if (strlencmp(cmd, "enable") == 0)
1335 status = TPACPI_RFK_RADIO_ON;
1336 else if (strlencmp(cmd, "disable") == 0)
1337 status = TPACPI_RFK_RADIO_OFF;
1343 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1344 (status == TPACPI_RFK_RADIO_ON) ?
1345 "enable" : "disable",
1346 tpacpi_rfkill_names[id]);
1347 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1348 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1354 /*************************************************************************
1355 * thinkpad-acpi driver attributes
1358 /* interface_version --------------------------------------------------- */
1359 static ssize_t interface_version_show(struct device_driver *drv, char *buf)
1361 return sysfs_emit(buf, "0x%08x\n", TPACPI_SYSFS_VERSION);
1363 static DRIVER_ATTR_RO(interface_version);
1365 /* debug_level --------------------------------------------------------- */
1366 static ssize_t debug_level_show(struct device_driver *drv, char *buf)
1368 return sysfs_emit(buf, "0x%04x\n", dbg_level);
1371 static ssize_t debug_level_store(struct device_driver *drv, const char *buf,
1376 if (parse_strtoul(buf, 0xffff, &t))
1383 static DRIVER_ATTR_RW(debug_level);
1385 /* version ------------------------------------------------------------- */
1386 static ssize_t version_show(struct device_driver *drv, char *buf)
1388 return sysfs_emit(buf, "%s v%s\n",
1389 TPACPI_DESC, TPACPI_VERSION);
1391 static DRIVER_ATTR_RO(version);
1393 /* --------------------------------------------------------------------- */
1395 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1397 /* wlsw_emulstate ------------------------------------------------------ */
1398 static ssize_t wlsw_emulstate_show(struct device_driver *drv, char *buf)
1400 return sysfs_emit(buf, "%d\n", !!tpacpi_wlsw_emulstate);
1403 static ssize_t wlsw_emulstate_store(struct device_driver *drv, const char *buf,
1408 if (parse_strtoul(buf, 1, &t))
1411 if (tpacpi_wlsw_emulstate != !!t) {
1412 tpacpi_wlsw_emulstate = !!t;
1413 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1418 static DRIVER_ATTR_RW(wlsw_emulstate);
1420 /* bluetooth_emulstate ------------------------------------------------- */
1421 static ssize_t bluetooth_emulstate_show(struct device_driver *drv, char *buf)
1423 return sysfs_emit(buf, "%d\n", !!tpacpi_bluetooth_emulstate);
1426 static ssize_t bluetooth_emulstate_store(struct device_driver *drv,
1427 const char *buf, size_t count)
1431 if (parse_strtoul(buf, 1, &t))
1434 tpacpi_bluetooth_emulstate = !!t;
1438 static DRIVER_ATTR_RW(bluetooth_emulstate);
1440 /* wwan_emulstate ------------------------------------------------- */
1441 static ssize_t wwan_emulstate_show(struct device_driver *drv, char *buf)
1443 return sysfs_emit(buf, "%d\n", !!tpacpi_wwan_emulstate);
1446 static ssize_t wwan_emulstate_store(struct device_driver *drv, const char *buf,
1451 if (parse_strtoul(buf, 1, &t))
1454 tpacpi_wwan_emulstate = !!t;
1458 static DRIVER_ATTR_RW(wwan_emulstate);
1460 /* uwb_emulstate ------------------------------------------------- */
1461 static ssize_t uwb_emulstate_show(struct device_driver *drv, char *buf)
1463 return sysfs_emit(buf, "%d\n", !!tpacpi_uwb_emulstate);
1466 static ssize_t uwb_emulstate_store(struct device_driver *drv, const char *buf,
1471 if (parse_strtoul(buf, 1, &t))
1474 tpacpi_uwb_emulstate = !!t;
1478 static DRIVER_ATTR_RW(uwb_emulstate);
1481 /*************************************************************************
1486 * Table of recommended minimum BIOS versions
1488 * Reasons for listing:
1489 * 1. Stable BIOS, listed because the unknown amount of
1490 * bugs and bad ACPI behaviour on older versions
1492 * 2. BIOS or EC fw with known bugs that trigger on Linux
1494 * 3. BIOS with known reduced functionality in older versions
1496 * We recommend the latest BIOS and EC version.
1497 * We only support the latest BIOS and EC fw version as a rule.
1499 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1500 * Information from users in ThinkWiki
1502 * WARNING: we use this table also to detect that the machine is
1503 * a ThinkPad in some cases, so don't remove entries lightly.
1506 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1507 { .vendor = (__v), \
1508 .bios = TPID(__id1, __id2), \
1509 .ec = TPACPI_MATCH_ANY, \
1510 .quirks = TPACPI_MATCH_ANY_VERSION << 16 \
1511 | TPVER(__bv1, __bv2) }
1513 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1514 __eid, __ev1, __ev2) \
1515 { .vendor = (__v), \
1516 .bios = TPID(__bid1, __bid2), \
1518 .quirks = TPVER(__ev1, __ev2) << 16 \
1519 | TPVER(__bv1, __bv2) }
1521 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1522 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1524 /* Outdated IBM BIOSes often lack the EC id string */
1525 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1526 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1527 __bv1, __bv2, TPID(__id1, __id2), \
1529 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1530 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1533 /* Outdated IBM BIOSes often lack the EC id string */
1534 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1535 __eid1, __eid2, __ev1, __ev2) \
1536 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1537 __bv1, __bv2, TPID(__eid1, __eid2), \
1539 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1540 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1543 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1544 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1546 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1547 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1548 __bv1, __bv2, TPID(__id1, __id2), \
1551 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1552 __eid1, __eid2, __ev1, __ev2) \
1553 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1554 __bv1, __bv2, TPID(__eid1, __eid2), \
1557 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1558 /* Numeric models ------------------ */
1559 /* FW MODEL BIOS VERS */
1560 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1561 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1562 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1563 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1564 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1565 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1566 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1567 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1568 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1570 /* A-series ------------------------- */
1571 /* FW MODEL BIOS VERS EC VERS */
1572 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1573 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1574 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1575 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1576 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1577 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1578 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1579 TPV_QI0('1', '3', '2', '0'), /* A22m */
1580 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1581 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1582 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1584 /* G-series ------------------------- */
1585 /* FW MODEL BIOS VERS */
1586 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1587 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1589 /* R-series, T-series --------------- */
1590 /* FW MODEL BIOS VERS EC VERS */
1591 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1592 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1593 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1594 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1595 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1596 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1597 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1598 T40/p, T41/p, T42/p (1) */
1599 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1600 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1601 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1602 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1604 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1605 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1606 TPV_QI0('1', '6', '3', '2'), /* T22 */
1607 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1608 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1609 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1611 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1612 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1613 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1615 /* BIOS FW BIOS VERS EC FW EC VERS */
1616 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1617 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1619 /* X-series ------------------------- */
1620 /* FW MODEL BIOS VERS EC VERS */
1621 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1622 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1623 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1624 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1625 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1626 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1627 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1629 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1630 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1632 /* (0) - older versions lack DMI EC fw string and functionality */
1633 /* (1) - older versions known to lack functionality */
1644 static void __init tpacpi_check_outdated_fw(void)
1646 unsigned long fwvers;
1647 u16 ec_version, bios_version;
1649 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1650 ARRAY_SIZE(tpacpi_bios_version_qtable));
1655 bios_version = fwvers & 0xffffU;
1656 ec_version = (fwvers >> 16) & 0xffffU;
1658 /* note that unknown versions are set to 0x0000 and we use that */
1659 if ((bios_version > thinkpad_id.bios_release) ||
1660 (ec_version > thinkpad_id.ec_release &&
1661 ec_version != TPACPI_MATCH_ANY_VERSION)) {
1663 * The changelogs would let us track down the exact
1664 * reason, but it is just too much of a pain to track
1665 * it. We only list BIOSes that are either really
1666 * broken, or really stable to begin with, so it is
1667 * best if the user upgrades the firmware anyway.
1669 pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1670 pr_warn("WARNING: This firmware may be missing critical bug fixes and/or important features\n");
1674 static bool __init tpacpi_is_fw_known(void)
1676 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1677 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1680 /****************************************************************************
1681 ****************************************************************************
1685 ****************************************************************************
1686 ****************************************************************************/
1688 /*************************************************************************
1689 * thinkpad-acpi metadata subdriver
1692 static int thinkpad_acpi_driver_read(struct seq_file *m)
1694 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1695 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1699 static struct ibm_struct thinkpad_acpi_driver_data = {
1701 .read = thinkpad_acpi_driver_read,
1704 /*************************************************************************
1709 * ThinkPad firmware event model
1711 * The ThinkPad firmware has two main event interfaces: normal ACPI
1712 * notifications (which follow the ACPI standard), and a private event
1715 * The private event interface also issues events for the hotkeys. As
1716 * the driver gained features, the event handling code ended up being
1717 * built around the hotkey subdriver. This will need to be refactored
1718 * to a more formal event API eventually.
1720 * Some "hotkeys" are actually supposed to be used as event reports,
1721 * such as "brightness has changed", "volume has changed", depending on
1722 * the ThinkPad model and how the firmware is operating.
1724 * Unlike other classes, hotkey-class events have mask/unmask control on
1725 * non-ancient firmware. However, how it behaves changes a lot with the
1726 * firmware model and version.
1729 enum { /* hot key scan codes (derived from ACPI DSDT) */
1730 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1731 TP_ACPI_HOTKEYSCAN_FNF2,
1732 TP_ACPI_HOTKEYSCAN_FNF3,
1733 TP_ACPI_HOTKEYSCAN_FNF4,
1734 TP_ACPI_HOTKEYSCAN_FNF5,
1735 TP_ACPI_HOTKEYSCAN_FNF6,
1736 TP_ACPI_HOTKEYSCAN_FNF7,
1737 TP_ACPI_HOTKEYSCAN_FNF8,
1738 TP_ACPI_HOTKEYSCAN_FNF9,
1739 TP_ACPI_HOTKEYSCAN_FNF10,
1740 TP_ACPI_HOTKEYSCAN_FNF11,
1741 TP_ACPI_HOTKEYSCAN_FNF12,
1742 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1743 TP_ACPI_HOTKEYSCAN_FNINSERT,
1744 TP_ACPI_HOTKEYSCAN_FNDELETE,
1745 TP_ACPI_HOTKEYSCAN_FNHOME,
1746 TP_ACPI_HOTKEYSCAN_FNEND,
1747 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1748 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1749 TP_ACPI_HOTKEYSCAN_FNSPACE,
1750 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1751 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1752 TP_ACPI_HOTKEYSCAN_MUTE,
1753 TP_ACPI_HOTKEYSCAN_THINKPAD,
1754 TP_ACPI_HOTKEYSCAN_UNK1,
1755 TP_ACPI_HOTKEYSCAN_UNK2,
1756 TP_ACPI_HOTKEYSCAN_UNK3,
1757 TP_ACPI_HOTKEYSCAN_UNK4,
1758 TP_ACPI_HOTKEYSCAN_UNK5,
1759 TP_ACPI_HOTKEYSCAN_UNK6,
1760 TP_ACPI_HOTKEYSCAN_UNK7,
1761 TP_ACPI_HOTKEYSCAN_UNK8,
1763 /* Adaptive keyboard keycodes */
1764 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1765 TP_ACPI_HOTKEYSCAN_MUTE2 = TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1766 TP_ACPI_HOTKEYSCAN_BRIGHTNESS_ZERO,
1767 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL,
1768 TP_ACPI_HOTKEYSCAN_CLOUD,
1769 TP_ACPI_HOTKEYSCAN_UNK9,
1770 TP_ACPI_HOTKEYSCAN_VOICE,
1771 TP_ACPI_HOTKEYSCAN_UNK10,
1772 TP_ACPI_HOTKEYSCAN_GESTURES,
1773 TP_ACPI_HOTKEYSCAN_UNK11,
1774 TP_ACPI_HOTKEYSCAN_UNK12,
1775 TP_ACPI_HOTKEYSCAN_UNK13,
1776 TP_ACPI_HOTKEYSCAN_CONFIG,
1777 TP_ACPI_HOTKEYSCAN_NEW_TAB,
1778 TP_ACPI_HOTKEYSCAN_RELOAD,
1779 TP_ACPI_HOTKEYSCAN_BACK,
1780 TP_ACPI_HOTKEYSCAN_MIC_DOWN,
1781 TP_ACPI_HOTKEYSCAN_MIC_UP,
1782 TP_ACPI_HOTKEYSCAN_MIC_CANCELLATION,
1783 TP_ACPI_HOTKEYSCAN_CAMERA_MODE,
1784 TP_ACPI_HOTKEYSCAN_ROTATE_DISPLAY,
1786 /* Lenovo extended keymap, starting at 0x1300 */
1787 TP_ACPI_HOTKEYSCAN_EXTENDED_START,
1788 /* first new observed key (star, favorites) is 0x1311 */
1789 TP_ACPI_HOTKEYSCAN_STAR = 69,
1790 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL2,
1791 TP_ACPI_HOTKEYSCAN_CALCULATOR,
1792 TP_ACPI_HOTKEYSCAN_BLUETOOTH,
1793 TP_ACPI_HOTKEYSCAN_KEYBOARD,
1794 TP_ACPI_HOTKEYSCAN_FN_RIGHT_SHIFT, /* Used by "Lenovo Quick Clean" */
1795 TP_ACPI_HOTKEYSCAN_NOTIFICATION_CENTER,
1796 TP_ACPI_HOTKEYSCAN_PICKUP_PHONE,
1797 TP_ACPI_HOTKEYSCAN_HANGUP_PHONE,
1799 /* Hotkey keymap size */
1800 TPACPI_HOTKEY_MAP_LEN
1803 enum { /* Keys/events available through NVRAM polling */
1804 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1805 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1808 enum { /* Positions of some of the keys in hotkey masks */
1809 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1810 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1811 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1812 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1813 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1814 TP_ACPI_HKEY_KBD_LIGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1815 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1816 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1817 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1818 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1819 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1822 enum { /* NVRAM to ACPI HKEY group map */
1823 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1824 TP_ACPI_HKEY_ZOOM_MASK |
1825 TP_ACPI_HKEY_DISPSWTCH_MASK |
1826 TP_ACPI_HKEY_HIBERNATE_MASK,
1827 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1828 TP_ACPI_HKEY_BRGHTDWN_MASK,
1829 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1830 TP_ACPI_HKEY_VOLDWN_MASK |
1831 TP_ACPI_HKEY_MUTE_MASK,
1834 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1835 struct tp_nvram_state {
1836 u16 thinkpad_toggle:1;
1838 u16 display_toggle:1;
1839 u16 thinklight_toggle:1;
1840 u16 hibernate_toggle:1;
1841 u16 displayexp_toggle:1;
1842 u16 display_state:1;
1843 u16 brightness_toggle:1;
1844 u16 volume_toggle:1;
1847 u8 brightness_level;
1851 /* kthread for the hotkey poller */
1852 static struct task_struct *tpacpi_hotkey_task;
1855 * Acquire mutex to write poller control variables as an
1858 * Increment hotkey_config_change when changing them if you
1859 * want the kthread to forget old state.
1861 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1863 static struct mutex hotkey_thread_data_mutex;
1864 static unsigned int hotkey_config_change;
1867 * hotkey poller control variables
1869 * Must be atomic or readers will also need to acquire mutex
1871 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1872 * should be used only when the changes need to be taken as
1873 * a block, OR when one needs to force the kthread to forget
1876 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
1877 static unsigned int hotkey_poll_freq = 10; /* Hz */
1879 #define HOTKEY_CONFIG_CRITICAL_START \
1881 mutex_lock(&hotkey_thread_data_mutex); \
1882 hotkey_config_change++; \
1884 #define HOTKEY_CONFIG_CRITICAL_END \
1885 mutex_unlock(&hotkey_thread_data_mutex);
1887 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
1889 #define hotkey_source_mask 0U
1890 #define HOTKEY_CONFIG_CRITICAL_START
1891 #define HOTKEY_CONFIG_CRITICAL_END
1893 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
1895 static struct mutex hotkey_mutex;
1897 static enum { /* Reasons for waking up */
1898 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
1899 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
1900 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
1901 } hotkey_wakeup_reason;
1903 static int hotkey_autosleep_ack;
1905 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
1906 static u32 hotkey_all_mask; /* all events supported in fw */
1907 static u32 hotkey_adaptive_all_mask; /* all adaptive events supported in fw */
1908 static u32 hotkey_reserved_mask; /* events better left disabled */
1909 static u32 hotkey_driver_mask; /* events needed by the driver */
1910 static u32 hotkey_user_mask; /* events visible to userspace */
1911 static u32 hotkey_acpi_mask; /* events enabled in firmware */
1913 static u16 *hotkey_keycode_map;
1915 static void tpacpi_driver_event(const unsigned int hkey_event);
1916 static void hotkey_driver_event(const unsigned int scancode);
1917 static void hotkey_poll_setup(const bool may_warn);
1919 /* HKEY.MHKG() return bits */
1920 #define TP_HOTKEY_TABLET_MASK (1 << 3)
1922 TP_ACPI_MULTI_MODE_INVALID = 0,
1923 TP_ACPI_MULTI_MODE_UNKNOWN = 1 << 0,
1924 TP_ACPI_MULTI_MODE_LAPTOP = 1 << 1,
1925 TP_ACPI_MULTI_MODE_TABLET = 1 << 2,
1926 TP_ACPI_MULTI_MODE_FLAT = 1 << 3,
1927 TP_ACPI_MULTI_MODE_STAND = 1 << 4,
1928 TP_ACPI_MULTI_MODE_TENT = 1 << 5,
1929 TP_ACPI_MULTI_MODE_STAND_TENT = 1 << 6,
1933 /* The following modes are considered tablet mode for the purpose of
1934 * reporting the status to userspace. i.e. in all these modes it makes
1935 * sense to disable the laptop input devices such as touchpad and
1938 TP_ACPI_MULTI_MODE_TABLET_LIKE = TP_ACPI_MULTI_MODE_TABLET |
1939 TP_ACPI_MULTI_MODE_STAND |
1940 TP_ACPI_MULTI_MODE_TENT |
1941 TP_ACPI_MULTI_MODE_STAND_TENT,
1944 static int hotkey_get_wlsw(void)
1948 if (!tp_features.hotkey_wlsw)
1951 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1953 return (tpacpi_wlsw_emulstate) ?
1954 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
1957 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
1960 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
1963 static int hotkey_gmms_get_tablet_mode(int s, int *has_tablet_mode)
1965 int type = (s >> 16) & 0xffff;
1966 int value = s & 0xffff;
1967 int mode = TP_ACPI_MULTI_MODE_INVALID;
1968 int valid_modes = 0;
1970 if (has_tablet_mode)
1971 *has_tablet_mode = 0;
1975 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1976 TP_ACPI_MULTI_MODE_TABLET |
1977 TP_ACPI_MULTI_MODE_STAND_TENT;
1980 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1981 TP_ACPI_MULTI_MODE_FLAT |
1982 TP_ACPI_MULTI_MODE_TABLET |
1983 TP_ACPI_MULTI_MODE_STAND |
1984 TP_ACPI_MULTI_MODE_TENT;
1987 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1988 TP_ACPI_MULTI_MODE_FLAT;
1992 /* In mode 4, FLAT is not specified as a valid mode. However,
1993 * it can be seen at least on the X1 Yoga 2nd Generation.
1995 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1996 TP_ACPI_MULTI_MODE_FLAT |
1997 TP_ACPI_MULTI_MODE_TABLET |
1998 TP_ACPI_MULTI_MODE_STAND |
1999 TP_ACPI_MULTI_MODE_TENT;
2002 pr_err("Unknown multi mode status type %d with value 0x%04X, please report this to %s\n",
2003 type, value, TPACPI_MAIL);
2007 if (has_tablet_mode && (valid_modes & TP_ACPI_MULTI_MODE_TABLET_LIKE))
2008 *has_tablet_mode = 1;
2012 mode = TP_ACPI_MULTI_MODE_LAPTOP;
2015 mode = TP_ACPI_MULTI_MODE_FLAT;
2018 mode = TP_ACPI_MULTI_MODE_TABLET;
2022 mode = TP_ACPI_MULTI_MODE_STAND_TENT;
2024 mode = TP_ACPI_MULTI_MODE_STAND;
2027 mode = TP_ACPI_MULTI_MODE_TENT;
2030 if (type == 5 && value == 0xffff) {
2031 pr_warn("Multi mode status is undetected, assuming laptop\n");
2036 if (!(mode & valid_modes)) {
2037 pr_err("Unknown/reserved multi mode value 0x%04X for type %d, please report this to %s\n",
2038 value, type, TPACPI_MAIL);
2042 return !!(mode & TP_ACPI_MULTI_MODE_TABLET_LIKE);
2045 static int hotkey_get_tablet_mode(int *status)
2049 switch (tp_features.hotkey_tablet) {
2050 case TP_HOTKEY_TABLET_USES_MHKG:
2051 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2054 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2056 case TP_HOTKEY_TABLET_USES_GMMS:
2057 if (!acpi_evalf(hkey_handle, &s, "GMMS", "dd", 0))
2060 *status = hotkey_gmms_get_tablet_mode(s, NULL);
2070 * Reads current event mask from firmware, and updates
2071 * hotkey_acpi_mask accordingly. Also resets any bits
2072 * from hotkey_user_mask that are unavailable to be
2073 * delivered (shadow requirement of the userspace ABI).
2075 * Call with hotkey_mutex held
2077 static int hotkey_mask_get(void)
2079 if (tp_features.hotkey_mask) {
2082 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2085 hotkey_acpi_mask = m;
2087 /* no mask support doesn't mean no event support... */
2088 hotkey_acpi_mask = hotkey_all_mask;
2091 /* sync userspace-visible mask */
2092 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2097 static void hotkey_mask_warn_incomplete_mask(void)
2099 /* log only what the user can fix... */
2100 const u32 wantedmask = hotkey_driver_mask &
2101 ~(hotkey_acpi_mask | hotkey_source_mask) &
2102 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2105 pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2109 * Set the firmware mask when supported
2111 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2113 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2115 * Call with hotkey_mutex held
2117 static int hotkey_mask_set(u32 mask)
2122 const u32 fwmask = mask & ~hotkey_source_mask;
2124 if (tp_features.hotkey_mask) {
2125 for (i = 0; i < 32; i++) {
2126 if (!acpi_evalf(hkey_handle,
2127 NULL, "MHKM", "vdd", i + 1,
2128 !!(mask & (1 << i)))) {
2136 * We *must* make an inconditional call to hotkey_mask_get to
2137 * refresh hotkey_acpi_mask and update hotkey_user_mask
2139 * Take the opportunity to also log when we cannot _enable_
2142 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2143 pr_notice("asked for hotkey mask 0x%08x, but firmware forced it to 0x%08x\n",
2144 fwmask, hotkey_acpi_mask);
2147 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2148 hotkey_mask_warn_incomplete_mask();
2154 * Sets hotkey_user_mask and tries to set the firmware mask
2156 * Call with hotkey_mutex held
2158 static int hotkey_user_mask_set(const u32 mask)
2162 /* Give people a chance to notice they are doing something that
2163 * is bound to go boom on their users sooner or later */
2164 if (!tp_warned.hotkey_mask_ff &&
2165 (mask == 0xffff || mask == 0xffffff ||
2166 mask == 0xffffffff)) {
2167 tp_warned.hotkey_mask_ff = 1;
2168 pr_notice("setting the hotkey mask to 0x%08x is likely not the best way to go about it\n",
2170 pr_notice("please consider using the driver defaults, and refer to up-to-date thinkpad-acpi documentation\n");
2173 /* Try to enable what the user asked for, plus whatever we need.
2174 * this syncs everything but won't enable bits in hotkey_user_mask */
2175 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2177 /* Enable the available bits in hotkey_user_mask */
2178 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2184 * Sets the driver hotkey mask.
2186 * Can be called even if the hotkey subdriver is inactive
2188 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2192 /* Do the right thing if hotkey_init has not been called yet */
2193 if (!tp_features.hotkey) {
2194 hotkey_driver_mask = mask;
2198 mutex_lock(&hotkey_mutex);
2200 HOTKEY_CONFIG_CRITICAL_START
2201 hotkey_driver_mask = mask;
2202 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2203 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2205 HOTKEY_CONFIG_CRITICAL_END
2207 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2208 ~hotkey_source_mask);
2209 hotkey_poll_setup(true);
2211 mutex_unlock(&hotkey_mutex);
2216 static int hotkey_status_get(int *status)
2218 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2224 static int hotkey_status_set(bool enable)
2226 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2232 static void tpacpi_input_send_tabletsw(void)
2236 if (tp_features.hotkey_tablet &&
2237 !hotkey_get_tablet_mode(&state)) {
2238 mutex_lock(&tpacpi_inputdev_send_mutex);
2240 input_report_switch(tpacpi_inputdev,
2241 SW_TABLET_MODE, !!state);
2242 input_sync(tpacpi_inputdev);
2244 mutex_unlock(&tpacpi_inputdev_send_mutex);
2248 /* Do NOT call without validating scancode first */
2249 static void tpacpi_input_send_key(const unsigned int scancode)
2251 const unsigned int keycode = hotkey_keycode_map[scancode];
2253 if (keycode != KEY_RESERVED) {
2254 mutex_lock(&tpacpi_inputdev_send_mutex);
2256 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2257 input_report_key(tpacpi_inputdev, keycode, 1);
2258 input_sync(tpacpi_inputdev);
2260 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2261 input_report_key(tpacpi_inputdev, keycode, 0);
2262 input_sync(tpacpi_inputdev);
2264 mutex_unlock(&tpacpi_inputdev_send_mutex);
2268 /* Do NOT call without validating scancode first */
2269 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2271 hotkey_driver_event(scancode);
2272 if (hotkey_user_mask & (1 << scancode))
2273 tpacpi_input_send_key(scancode);
2276 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2277 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2279 /* Do NOT call without validating scancode first */
2280 static void tpacpi_hotkey_send_key(unsigned int scancode)
2282 tpacpi_input_send_key_masked(scancode);
2285 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2289 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2290 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2291 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2292 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2293 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2294 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2296 if (m & TP_ACPI_HKEY_KBD_LIGHT_MASK) {
2297 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2298 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2300 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2301 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2302 n->displayexp_toggle =
2303 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2305 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2306 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2307 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2308 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2309 n->brightness_toggle =
2310 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2312 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2313 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2314 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2315 >> TP_NVRAM_POS_LEVEL_VOLUME;
2316 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2317 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2321 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2323 if ((event_mask & (1 << __scancode)) && \
2324 oldn->__member != newn->__member) \
2325 tpacpi_hotkey_send_key(__scancode); \
2328 #define TPACPI_MAY_SEND_KEY(__scancode) \
2330 if (event_mask & (1 << __scancode)) \
2331 tpacpi_hotkey_send_key(__scancode); \
2334 static void issue_volchange(const unsigned int oldvol,
2335 const unsigned int newvol,
2336 const u32 event_mask)
2338 unsigned int i = oldvol;
2340 while (i > newvol) {
2341 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2344 while (i < newvol) {
2345 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2350 static void issue_brightnesschange(const unsigned int oldbrt,
2351 const unsigned int newbrt,
2352 const u32 event_mask)
2354 unsigned int i = oldbrt;
2356 while (i > newbrt) {
2357 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2360 while (i < newbrt) {
2361 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2366 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2367 struct tp_nvram_state *newn,
2368 const u32 event_mask)
2371 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2372 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2373 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2374 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2376 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2378 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2383 * This code is supposed to duplicate the IBM firmware behaviour:
2384 * - Pressing MUTE issues mute hotkey message, even when already mute
2385 * - Pressing Volume up/down issues volume up/down hotkey messages,
2386 * even when already at maximum or minimum volume
2387 * - The act of unmuting issues volume up/down notification,
2388 * depending which key was used to unmute
2390 * We are constrained to what the NVRAM can tell us, which is not much
2391 * and certainly not enough if more than one volume hotkey was pressed
2392 * since the last poll cycle.
2394 * Just to make our life interesting, some newer Lenovo ThinkPads have
2395 * bugs in the BIOS and may fail to update volume_toggle properly.
2400 oldn->volume_toggle != newn->volume_toggle ||
2401 oldn->volume_level != newn->volume_level) {
2402 /* recently muted, or repeated mute keypress, or
2403 * multiple presses ending in mute */
2404 issue_volchange(oldn->volume_level, newn->volume_level,
2406 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2411 /* recently unmuted, issue 'unmute' keypress */
2412 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2414 if (oldn->volume_level != newn->volume_level) {
2415 issue_volchange(oldn->volume_level, newn->volume_level,
2417 } else if (oldn->volume_toggle != newn->volume_toggle) {
2418 /* repeated vol up/down keypress at end of scale ? */
2419 if (newn->volume_level == 0)
2420 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2421 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2422 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2426 /* handle brightness */
2427 if (oldn->brightness_level != newn->brightness_level) {
2428 issue_brightnesschange(oldn->brightness_level,
2429 newn->brightness_level, event_mask);
2430 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2431 /* repeated key presses that didn't change state */
2432 if (newn->brightness_level == 0)
2433 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2434 else if (newn->brightness_level >= bright_maxlvl
2435 && !tp_features.bright_unkfw)
2436 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2439 #undef TPACPI_COMPARE_KEY
2440 #undef TPACPI_MAY_SEND_KEY
2446 * We track all events in hotkey_source_mask all the time, since
2447 * most of them are edge-based. We only issue those requested by
2448 * hotkey_user_mask or hotkey_driver_mask, though.
2450 static int hotkey_kthread(void *data)
2452 struct tp_nvram_state s[2] = { 0 };
2453 u32 poll_mask, event_mask;
2454 unsigned int si, so;
2456 unsigned int change_detector;
2457 unsigned int poll_freq;
2460 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2469 /* Initial state for compares */
2470 mutex_lock(&hotkey_thread_data_mutex);
2471 change_detector = hotkey_config_change;
2472 poll_mask = hotkey_source_mask;
2473 event_mask = hotkey_source_mask &
2474 (hotkey_driver_mask | hotkey_user_mask);
2475 poll_freq = hotkey_poll_freq;
2476 mutex_unlock(&hotkey_thread_data_mutex);
2477 hotkey_read_nvram(&s[so], poll_mask);
2479 while (!kthread_should_stop()) {
2481 if (likely(poll_freq))
2484 t = 100; /* should never happen... */
2486 t = msleep_interruptible(t);
2487 if (unlikely(kthread_freezable_should_stop(&was_frozen)))
2490 if (t > 0 && !was_frozen)
2493 mutex_lock(&hotkey_thread_data_mutex);
2494 if (was_frozen || hotkey_config_change != change_detector) {
2495 /* forget old state on thaw or config change */
2498 change_detector = hotkey_config_change;
2500 poll_mask = hotkey_source_mask;
2501 event_mask = hotkey_source_mask &
2502 (hotkey_driver_mask | hotkey_user_mask);
2503 poll_freq = hotkey_poll_freq;
2504 mutex_unlock(&hotkey_thread_data_mutex);
2506 if (likely(poll_mask)) {
2507 hotkey_read_nvram(&s[si], poll_mask);
2508 if (likely(si != so)) {
2509 hotkey_compare_and_issue_event(&s[so], &s[si],
2522 /* call with hotkey_mutex held */
2523 static void hotkey_poll_stop_sync(void)
2525 if (tpacpi_hotkey_task) {
2526 kthread_stop(tpacpi_hotkey_task);
2527 tpacpi_hotkey_task = NULL;
2531 /* call with hotkey_mutex held */
2532 static void hotkey_poll_setup(const bool may_warn)
2534 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2535 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2537 if (hotkey_poll_freq > 0 &&
2538 (poll_driver_mask ||
2539 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2540 if (!tpacpi_hotkey_task) {
2541 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2542 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2543 if (IS_ERR(tpacpi_hotkey_task)) {
2544 tpacpi_hotkey_task = NULL;
2545 pr_err("could not create kernel thread for hotkey polling\n");
2549 hotkey_poll_stop_sync();
2550 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2551 hotkey_poll_freq == 0) {
2552 pr_notice("hot keys 0x%08x and/or events 0x%08x require polling, which is currently disabled\n",
2553 poll_user_mask, poll_driver_mask);
2558 static void hotkey_poll_setup_safe(const bool may_warn)
2560 mutex_lock(&hotkey_mutex);
2561 hotkey_poll_setup(may_warn);
2562 mutex_unlock(&hotkey_mutex);
2565 /* call with hotkey_mutex held */
2566 static void hotkey_poll_set_freq(unsigned int freq)
2569 hotkey_poll_stop_sync();
2571 hotkey_poll_freq = freq;
2574 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2576 static void hotkey_poll_setup(const bool __unused)
2580 static void hotkey_poll_setup_safe(const bool __unused)
2584 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2586 static int hotkey_inputdev_open(struct input_dev *dev)
2588 switch (tpacpi_lifecycle) {
2589 case TPACPI_LIFE_INIT:
2590 case TPACPI_LIFE_RUNNING:
2591 hotkey_poll_setup_safe(false);
2593 case TPACPI_LIFE_EXITING:
2597 /* Should only happen if tpacpi_lifecycle is corrupt */
2602 static void hotkey_inputdev_close(struct input_dev *dev)
2604 /* disable hotkey polling when possible */
2605 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2606 !(hotkey_source_mask & hotkey_driver_mask))
2607 hotkey_poll_setup_safe(false);
2610 /* sysfs hotkey enable ------------------------------------------------- */
2611 static ssize_t hotkey_enable_show(struct device *dev,
2612 struct device_attribute *attr,
2617 printk_deprecated_attribute("hotkey_enable",
2618 "Hotkey reporting is always enabled");
2620 res = hotkey_status_get(&status);
2624 return sysfs_emit(buf, "%d\n", status);
2627 static ssize_t hotkey_enable_store(struct device *dev,
2628 struct device_attribute *attr,
2629 const char *buf, size_t count)
2633 printk_deprecated_attribute("hotkey_enable",
2634 "Hotkeys can be disabled through hotkey_mask");
2636 if (parse_strtoul(buf, 1, &t))
2645 static DEVICE_ATTR_RW(hotkey_enable);
2647 /* sysfs hotkey mask --------------------------------------------------- */
2648 static ssize_t hotkey_mask_show(struct device *dev,
2649 struct device_attribute *attr,
2652 return sysfs_emit(buf, "0x%08x\n", hotkey_user_mask);
2655 static ssize_t hotkey_mask_store(struct device *dev,
2656 struct device_attribute *attr,
2657 const char *buf, size_t count)
2662 if (parse_strtoul(buf, 0xffffffffUL, &t))
2665 if (mutex_lock_killable(&hotkey_mutex))
2666 return -ERESTARTSYS;
2668 res = hotkey_user_mask_set(t);
2670 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2671 hotkey_poll_setup(true);
2674 mutex_unlock(&hotkey_mutex);
2676 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2678 return (res) ? res : count;
2681 static DEVICE_ATTR_RW(hotkey_mask);
2683 /* sysfs hotkey bios_enabled ------------------------------------------- */
2684 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2685 struct device_attribute *attr,
2688 return sprintf(buf, "0\n");
2691 static DEVICE_ATTR_RO(hotkey_bios_enabled);
2693 /* sysfs hotkey bios_mask ---------------------------------------------- */
2694 static ssize_t hotkey_bios_mask_show(struct device *dev,
2695 struct device_attribute *attr,
2698 printk_deprecated_attribute("hotkey_bios_mask",
2699 "This attribute is useless.");
2700 return sysfs_emit(buf, "0x%08x\n", hotkey_orig_mask);
2703 static DEVICE_ATTR_RO(hotkey_bios_mask);
2705 /* sysfs hotkey all_mask ----------------------------------------------- */
2706 static ssize_t hotkey_all_mask_show(struct device *dev,
2707 struct device_attribute *attr,
2710 return sysfs_emit(buf, "0x%08x\n",
2711 hotkey_all_mask | hotkey_source_mask);
2714 static DEVICE_ATTR_RO(hotkey_all_mask);
2716 /* sysfs hotkey all_mask ----------------------------------------------- */
2717 static ssize_t hotkey_adaptive_all_mask_show(struct device *dev,
2718 struct device_attribute *attr,
2721 return sysfs_emit(buf, "0x%08x\n",
2722 hotkey_adaptive_all_mask | hotkey_source_mask);
2725 static DEVICE_ATTR_RO(hotkey_adaptive_all_mask);
2727 /* sysfs hotkey recommended_mask --------------------------------------- */
2728 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2729 struct device_attribute *attr,
2732 return sysfs_emit(buf, "0x%08x\n",
2733 (hotkey_all_mask | hotkey_source_mask)
2734 & ~hotkey_reserved_mask);
2737 static DEVICE_ATTR_RO(hotkey_recommended_mask);
2739 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2741 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2742 static ssize_t hotkey_source_mask_show(struct device *dev,
2743 struct device_attribute *attr,
2746 return sysfs_emit(buf, "0x%08x\n", hotkey_source_mask);
2749 static ssize_t hotkey_source_mask_store(struct device *dev,
2750 struct device_attribute *attr,
2751 const char *buf, size_t count)
2757 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2758 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2761 if (mutex_lock_killable(&hotkey_mutex))
2762 return -ERESTARTSYS;
2764 HOTKEY_CONFIG_CRITICAL_START
2765 hotkey_source_mask = t;
2766 HOTKEY_CONFIG_CRITICAL_END
2768 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2769 ~hotkey_source_mask);
2770 hotkey_poll_setup(true);
2772 /* check if events needed by the driver got disabled */
2773 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2774 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2776 mutex_unlock(&hotkey_mutex);
2779 pr_err("hotkey_source_mask: failed to update the firmware event mask!\n");
2782 pr_notice("hotkey_source_mask: some important events were disabled: 0x%04x\n",
2785 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2787 return (rc < 0) ? rc : count;
2790 static DEVICE_ATTR_RW(hotkey_source_mask);
2792 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2793 static ssize_t hotkey_poll_freq_show(struct device *dev,
2794 struct device_attribute *attr,
2797 return sysfs_emit(buf, "%d\n", hotkey_poll_freq);
2800 static ssize_t hotkey_poll_freq_store(struct device *dev,
2801 struct device_attribute *attr,
2802 const char *buf, size_t count)
2806 if (parse_strtoul(buf, 25, &t))
2809 if (mutex_lock_killable(&hotkey_mutex))
2810 return -ERESTARTSYS;
2812 hotkey_poll_set_freq(t);
2813 hotkey_poll_setup(true);
2815 mutex_unlock(&hotkey_mutex);
2817 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2822 static DEVICE_ATTR_RW(hotkey_poll_freq);
2824 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2826 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2827 static ssize_t hotkey_radio_sw_show(struct device *dev,
2828 struct device_attribute *attr,
2832 res = hotkey_get_wlsw();
2836 /* Opportunistic update */
2837 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2839 return sysfs_emit(buf, "%d\n",
2840 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2843 static DEVICE_ATTR_RO(hotkey_radio_sw);
2845 static void hotkey_radio_sw_notify_change(void)
2847 if (tp_features.hotkey_wlsw)
2848 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2852 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2853 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2854 struct device_attribute *attr,
2858 res = hotkey_get_tablet_mode(&s);
2862 return sysfs_emit(buf, "%d\n", !!s);
2865 static DEVICE_ATTR_RO(hotkey_tablet_mode);
2867 static void hotkey_tablet_mode_notify_change(void)
2869 if (tp_features.hotkey_tablet)
2870 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2871 "hotkey_tablet_mode");
2874 /* sysfs wakeup reason (pollable) -------------------------------------- */
2875 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2876 struct device_attribute *attr,
2879 return sysfs_emit(buf, "%d\n", hotkey_wakeup_reason);
2882 static DEVICE_ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2884 static void hotkey_wakeup_reason_notify_change(void)
2886 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2890 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2891 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2892 struct device_attribute *attr,
2895 return sysfs_emit(buf, "%d\n", hotkey_autosleep_ack);
2898 static DEVICE_ATTR(wakeup_hotunplug_complete, S_IRUGO,
2899 hotkey_wakeup_hotunplug_complete_show, NULL);
2901 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2903 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2904 "wakeup_hotunplug_complete");
2907 /* sysfs adaptive kbd mode --------------------------------------------- */
2909 static int adaptive_keyboard_get_mode(void);
2910 static int adaptive_keyboard_set_mode(int new_mode);
2912 enum ADAPTIVE_KEY_MODE {
2915 WEB_CONFERENCE_MODE,
2920 static ssize_t adaptive_kbd_mode_show(struct device *dev,
2921 struct device_attribute *attr,
2926 current_mode = adaptive_keyboard_get_mode();
2927 if (current_mode < 0)
2928 return current_mode;
2930 return sysfs_emit(buf, "%d\n", current_mode);
2933 static ssize_t adaptive_kbd_mode_store(struct device *dev,
2934 struct device_attribute *attr,
2935 const char *buf, size_t count)
2940 if (parse_strtoul(buf, LAYFLAT_MODE, &t))
2943 res = adaptive_keyboard_set_mode(t);
2944 return (res < 0) ? res : count;
2947 static DEVICE_ATTR_RW(adaptive_kbd_mode);
2949 static struct attribute *adaptive_kbd_attributes[] = {
2950 &dev_attr_adaptive_kbd_mode.attr,
2954 static umode_t hadaptive_kbd_attr_is_visible(struct kobject *kobj,
2955 struct attribute *attr, int n)
2957 return tp_features.has_adaptive_kbd ? attr->mode : 0;
2960 static const struct attribute_group adaptive_kbd_attr_group = {
2961 .is_visible = hadaptive_kbd_attr_is_visible,
2962 .attrs = adaptive_kbd_attributes,
2965 /* --------------------------------------------------------------------- */
2967 static struct attribute *hotkey_attributes[] = {
2968 &dev_attr_hotkey_enable.attr,
2969 &dev_attr_hotkey_bios_enabled.attr,
2970 &dev_attr_hotkey_bios_mask.attr,
2971 &dev_attr_wakeup_reason.attr,
2972 &dev_attr_wakeup_hotunplug_complete.attr,
2973 &dev_attr_hotkey_mask.attr,
2974 &dev_attr_hotkey_all_mask.attr,
2975 &dev_attr_hotkey_adaptive_all_mask.attr,
2976 &dev_attr_hotkey_recommended_mask.attr,
2977 &dev_attr_hotkey_tablet_mode.attr,
2978 &dev_attr_hotkey_radio_sw.attr,
2979 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2980 &dev_attr_hotkey_source_mask.attr,
2981 &dev_attr_hotkey_poll_freq.attr,
2986 static umode_t hotkey_attr_is_visible(struct kobject *kobj,
2987 struct attribute *attr, int n)
2989 if (attr == &dev_attr_hotkey_tablet_mode.attr) {
2990 if (!tp_features.hotkey_tablet)
2992 } else if (attr == &dev_attr_hotkey_radio_sw.attr) {
2993 if (!tp_features.hotkey_wlsw)
3000 static const struct attribute_group hotkey_attr_group = {
3001 .is_visible = hotkey_attr_is_visible,
3002 .attrs = hotkey_attributes,
3006 * Sync both the hw and sw blocking state of all switches
3008 static void tpacpi_send_radiosw_update(void)
3013 * We must sync all rfkill controllers *before* issuing any
3014 * rfkill input events, or we will race the rfkill core input
3017 * tpacpi_inputdev_send_mutex works as a synchronization point
3020 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3023 wlsw = hotkey_get_wlsw();
3025 /* Sync hw blocking state first if it is hw-blocked */
3026 if (wlsw == TPACPI_RFK_RADIO_OFF)
3027 tpacpi_rfk_update_hwblock_state(true);
3029 /* Sync hw blocking state last if it is hw-unblocked */
3030 if (wlsw == TPACPI_RFK_RADIO_ON)
3031 tpacpi_rfk_update_hwblock_state(false);
3033 /* Issue rfkill input event for WLSW switch */
3035 mutex_lock(&tpacpi_inputdev_send_mutex);
3037 input_report_switch(tpacpi_inputdev,
3038 SW_RFKILL_ALL, (wlsw > 0));
3039 input_sync(tpacpi_inputdev);
3041 mutex_unlock(&tpacpi_inputdev_send_mutex);
3045 * this can be unconditional, as we will poll state again
3046 * if userspace uses the notify to read data
3048 hotkey_radio_sw_notify_change();
3051 static void hotkey_exit(void)
3053 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3054 mutex_lock(&hotkey_mutex);
3055 hotkey_poll_stop_sync();
3056 mutex_unlock(&hotkey_mutex);
3058 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3059 "restoring original HKEY status and mask\n");
3060 /* yes, there is a bitwise or below, we want the
3061 * functions to be called even if one of them fail */
3062 if (((tp_features.hotkey_mask &&
3063 hotkey_mask_set(hotkey_orig_mask)) |
3064 hotkey_status_set(false)) != 0)
3065 pr_err("failed to restore hot key mask to BIOS defaults\n");
3068 static void __init hotkey_unmap(const unsigned int scancode)
3070 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3071 clear_bit(hotkey_keycode_map[scancode],
3072 tpacpi_inputdev->keybit);
3073 hotkey_keycode_map[scancode] = KEY_RESERVED;
3079 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3082 #define TPACPI_HK_Q_INIMASK 0x0001
3084 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3085 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3086 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3087 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3088 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3089 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3090 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3091 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3092 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3093 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3094 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3095 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3096 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3097 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3098 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3099 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3100 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3101 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3102 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3103 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3106 typedef u16 tpacpi_keymap_entry_t;
3107 typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3109 static int hotkey_init_tablet_mode(void)
3111 int in_tablet_mode = 0, res;
3114 if (acpi_evalf(hkey_handle, &res, "GMMS", "qdd", 0)) {
3115 int has_tablet_mode;
3117 in_tablet_mode = hotkey_gmms_get_tablet_mode(res,
3120 * The Yoga 11e series has 2 accelerometers described by a
3121 * BOSC0200 ACPI node. This setup relies on a Windows service
3122 * which calls special ACPI methods on this node to report
3123 * the laptop/tent/tablet mode to the EC. The bmc150 iio driver
3124 * does not support this, so skip the hotkey on these models.
3126 if (has_tablet_mode && !dual_accel_detect())
3127 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_GMMS;
3129 } else if (acpi_evalf(hkey_handle, &res, "MHKG", "qd")) {
3130 /* For X41t, X60t, X61t Tablets... */
3131 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_MHKG;
3132 in_tablet_mode = !!(res & TP_HOTKEY_TABLET_MASK);
3136 if (!tp_features.hotkey_tablet)
3139 pr_info("Tablet mode switch found (type: %s), currently in %s mode\n",
3140 type, in_tablet_mode ? "tablet" : "laptop");
3142 return in_tablet_mode;
3145 static int __init hotkey_init(struct ibm_init_struct *iibm)
3147 /* Requirements for changing the default keymaps:
3149 * 1. Many of the keys are mapped to KEY_RESERVED for very
3150 * good reasons. Do not change them unless you have deep
3151 * knowledge on the IBM and Lenovo ThinkPad firmware for
3152 * the various ThinkPad models. The driver behaves
3153 * differently for KEY_RESERVED: such keys have their
3154 * hot key mask *unset* in mask_recommended, and also
3155 * in the initial hot key mask programmed into the
3156 * firmware at driver load time, which means the firm-
3157 * ware may react very differently if you change them to
3160 * 2. You must be subscribed to the linux-thinkpad and
3161 * ibm-acpi-devel mailing lists, and you should read the
3162 * list archives since 2007 if you want to change the
3163 * keymaps. This requirement exists so that you will
3164 * know the past history of problems with the thinkpad-
3165 * acpi driver keymaps, and also that you will be
3166 * listening to any bug reports;
3168 * 3. Do not send thinkpad-acpi specific patches directly to
3169 * for merging, *ever*. Send them to the linux-acpi
3170 * mailinglist for comments. Merging is to be done only
3171 * through acpi-test and the ACPI maintainer.
3173 * If the above is too much to ask, don't change the keymap.
3174 * Ask the thinkpad-acpi maintainer to do it, instead.
3178 TPACPI_KEYMAP_IBM_GENERIC = 0,
3179 TPACPI_KEYMAP_LENOVO_GENERIC,
3182 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3183 /* Generic keymap for IBM ThinkPads */
3184 [TPACPI_KEYMAP_IBM_GENERIC] = {
3185 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3186 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3187 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3188 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3190 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3191 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3192 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3193 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3195 /* brightness: firmware always reacts to them */
3196 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3197 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3199 /* Thinklight: firmware always react to it */
3200 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3202 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3203 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3205 /* Volume: firmware always react to it and reprograms
3206 * the built-in *extra* mixer. Never map it to control
3207 * another mixer by default. */
3208 KEY_RESERVED, /* 0x14: VOLUME UP */
3209 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3210 KEY_RESERVED, /* 0x16: MUTE */
3212 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3214 /* (assignments unknown, please report if found) */
3215 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3216 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3218 /* No assignments, only used for Adaptive keyboards. */
3219 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3220 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3221 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3222 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3223 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3225 /* No assignment, used for newer Lenovo models */
3226 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3227 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3228 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3229 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3230 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3231 KEY_UNKNOWN, KEY_UNKNOWN
3235 /* Generic keymap for Lenovo ThinkPads */
3236 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3237 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3238 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3239 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3240 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3242 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3243 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3244 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3245 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3247 /* These should be enabled --only-- when ACPI video
3248 * is disabled (i.e. in "vendor" mode), and are handled
3249 * in a special way by the init code */
3250 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3251 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3253 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3255 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3256 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3258 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3259 * react to it and reprograms the built-in *extra* mixer.
3260 * Never map it to control another mixer by default.
3262 * T60?, T61, R60?, R61: firmware and EC tries to send
3263 * these over the regular keyboard, so these are no-ops,
3264 * but there are still weird bugs re. MUTE, so do not
3265 * change unless you get test reports from all Lenovo
3266 * models. May cause the BIOS to interfere with the
3269 KEY_RESERVED, /* 0x14: VOLUME UP */
3270 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3271 KEY_RESERVED, /* 0x16: MUTE */
3273 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3275 /* (assignments unknown, please report if found) */
3276 KEY_UNKNOWN, KEY_UNKNOWN,
3279 * The mic mute button only sends 0x1a. It does not
3280 * automatically mute the mic or change the mute light.
3282 KEY_MICMUTE, /* 0x1a: Mic mute (since ?400 or so) */
3284 /* (assignments unknown, please report if found) */
3287 /* Extra keys in use since the X240 / T440 / T540 */
3288 KEY_CONFIG, KEY_SEARCH, KEY_SCALE, KEY_FILE,
3291 * These are the adaptive keyboard keycodes for Carbon X1 2014.
3292 * The first item in this list is the Mute button which is
3293 * emitted with 0x103 through
3294 * adaptive_keyboard_hotkey_notify_hotkey() when the sound
3296 * We'll need to offset those by 0x20.
3298 KEY_RESERVED, /* Mute held, 0x103 */
3299 KEY_BRIGHTNESS_MIN, /* Backlight off */
3300 KEY_RESERVED, /* Clipping tool */
3301 KEY_RESERVED, /* Cloud */
3303 KEY_VOICECOMMAND, /* Voice */
3305 KEY_RESERVED, /* Gestures */
3309 KEY_CONFIG, /* Settings */
3310 KEY_RESERVED, /* New tab */
3311 KEY_REFRESH, /* Reload */
3312 KEY_BACK, /* Back */
3313 KEY_RESERVED, /* Microphone down */
3314 KEY_RESERVED, /* Microphone up */
3315 KEY_RESERVED, /* Microphone cancellation */
3316 KEY_RESERVED, /* Camera mode */
3317 KEY_RESERVED, /* Rotate display, 0x116 */
3320 * These are found in 2017 models (e.g. T470s, X270).
3321 * The lowest known value is 0x311, which according to
3322 * the manual should launch a user defined favorite
3325 * The offset for these is TP_ACPI_HOTKEYSCAN_EXTENDED_START,
3326 * corresponding to 0x34.
3329 /* (assignments unknown, please report if found) */
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, KEY_UNKNOWN,
3333 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3336 KEY_BOOKMARKS, /* Favorite app, 0x311 */
3337 KEY_SELECTIVE_SCREENSHOT, /* Clipping tool */
3338 KEY_CALC, /* Calculator (above numpad, P52) */
3339 KEY_BLUETOOTH, /* Bluetooth */
3340 KEY_KEYBOARD, /* Keyboard, 0x315 */
3341 KEY_FN_RIGHT_SHIFT, /* Fn + right Shift */
3342 KEY_NOTIFICATION_CENTER, /* Notification Center */
3343 KEY_PICKUP_PHONE, /* Answer incoming call */
3344 KEY_HANGUP_PHONE, /* Decline incoming call */
3348 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3349 /* Generic maps (fallback) */
3351 .vendor = PCI_VENDOR_ID_IBM,
3352 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3353 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3356 .vendor = PCI_VENDOR_ID_LENOVO,
3357 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3358 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3362 #define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3363 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3368 bool radiosw_state = false;
3369 bool tabletsw_state = false;
3371 unsigned long quirks;
3372 unsigned long keymap_id;
3374 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3375 "initializing hotkey subdriver\n");
3377 BUG_ON(!tpacpi_inputdev);
3378 BUG_ON(tpacpi_inputdev->open != NULL ||
3379 tpacpi_inputdev->close != NULL);
3381 TPACPI_ACPIHANDLE_INIT(hkey);
3382 mutex_init(&hotkey_mutex);
3384 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3385 mutex_init(&hotkey_thread_data_mutex);
3388 /* hotkey not supported on 570 */
3389 tp_features.hotkey = hkey_handle != NULL;
3391 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3393 str_supported(tp_features.hotkey));
3395 if (!tp_features.hotkey)
3398 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3399 ARRAY_SIZE(tpacpi_hotkey_qtable));
3401 tpacpi_disable_brightness_delay();
3403 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3404 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3405 for HKEY interface version 0x100 */
3406 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3407 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3408 "firmware HKEY interface version: 0x%x\n",
3411 switch (hkeyv >> 8) {
3414 * MHKV 0x100 in A31, R40, R40e,
3415 * T4x, X31, and later
3418 /* Paranoia check AND init hotkey_all_mask */
3419 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3421 pr_err("missing MHKA handler, please report this to %s\n",
3423 /* Fallback: pre-init for FN+F3,F4,F12 */
3424 hotkey_all_mask = 0x080cU;
3426 tp_features.hotkey_mask = 1;
3432 * MHKV 0x200 in X1, T460s, X260, T560, X1 Tablet (2016)
3435 /* Paranoia check AND init hotkey_all_mask */
3436 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3438 pr_err("missing MHKA handler, please report this to %s\n",
3440 /* Fallback: pre-init for FN+F3,F4,F12 */
3441 hotkey_all_mask = 0x080cU;
3443 tp_features.hotkey_mask = 1;
3447 * Check if we have an adaptive keyboard, like on the
3448 * Lenovo Carbon X1 2014 (2nd Gen).
3450 if (acpi_evalf(hkey_handle, &hotkey_adaptive_all_mask,
3452 if (hotkey_adaptive_all_mask != 0)
3453 tp_features.has_adaptive_kbd = true;
3455 tp_features.has_adaptive_kbd = false;
3456 hotkey_adaptive_all_mask = 0x0U;
3461 pr_err("unknown version of the HKEY interface: 0x%x\n",
3463 pr_err("please report this to %s\n", TPACPI_MAIL);
3468 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3469 "hotkey masks are %s\n",
3470 str_supported(tp_features.hotkey_mask));
3472 /* Init hotkey_all_mask if not initialized yet */
3473 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3474 (quirks & TPACPI_HK_Q_INIMASK))
3475 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3477 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3478 if (tp_features.hotkey_mask) {
3479 /* hotkey_source_mask *must* be zero for
3480 * the first hotkey_mask_get to return hotkey_orig_mask */
3481 res = hotkey_mask_get();
3485 hotkey_orig_mask = hotkey_acpi_mask;
3487 hotkey_orig_mask = hotkey_all_mask;
3488 hotkey_acpi_mask = hotkey_all_mask;
3491 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3493 tp_features.hotkey_wlsw = 1;
3494 radiosw_state = !!tpacpi_wlsw_emulstate;
3495 pr_info("radio switch emulation enabled\n");
3498 /* Not all thinkpads have a hardware radio switch */
3499 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3500 tp_features.hotkey_wlsw = 1;
3501 radiosw_state = !!status;
3502 pr_info("radio switch found; radios are %s\n",
3503 enabled(status, 0));
3506 tabletsw_state = hotkey_init_tablet_mode();
3508 /* Set up key map */
3509 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3510 ARRAY_SIZE(tpacpi_keymap_qtable));
3511 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3512 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3513 "using keymap number %lu\n", keymap_id);
3515 hotkey_keycode_map = kmemdup(&tpacpi_keymaps[keymap_id],
3516 TPACPI_HOTKEY_MAP_SIZE, GFP_KERNEL);
3517 if (!hotkey_keycode_map) {
3518 pr_err("failed to allocate memory for key map\n");
3522 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3523 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3524 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3525 tpacpi_inputdev->keycode = hotkey_keycode_map;
3526 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3527 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3528 input_set_capability(tpacpi_inputdev, EV_KEY,
3529 hotkey_keycode_map[i]);
3531 if (i < sizeof(hotkey_reserved_mask)*8)
3532 hotkey_reserved_mask |= 1 << i;
3536 if (tp_features.hotkey_wlsw) {
3537 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3538 input_report_switch(tpacpi_inputdev,
3539 SW_RFKILL_ALL, radiosw_state);
3541 if (tp_features.hotkey_tablet) {
3542 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3543 input_report_switch(tpacpi_inputdev,
3544 SW_TABLET_MODE, tabletsw_state);
3547 /* Do not issue duplicate brightness change events to
3548 * userspace. tpacpi_detect_brightness_capabilities() must have
3549 * been called before this point */
3550 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
3551 pr_info("This ThinkPad has standard ACPI backlight brightness control, supported by the ACPI video driver\n");
3552 pr_notice("Disabling thinkpad-acpi brightness events by default...\n");
3554 /* Disable brightness up/down on Lenovo thinkpads when
3555 * ACPI is handling them, otherwise it is plain impossible
3556 * for userspace to do something even remotely sane */
3557 hotkey_reserved_mask |=
3558 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3559 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3560 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3561 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3564 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3565 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3567 & ~hotkey_reserved_mask;
3569 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3570 "hotkey source mask 0x%08x, polling freq %u\n",
3571 hotkey_source_mask, hotkey_poll_freq);
3574 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3575 "enabling firmware HKEY event interface...\n");
3576 res = hotkey_status_set(true);
3581 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3582 | hotkey_driver_mask)
3583 & ~hotkey_source_mask);
3584 if (res < 0 && res != -ENXIO) {
3588 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3589 & ~hotkey_reserved_mask;
3590 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3591 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3592 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3594 tpacpi_inputdev->open = &hotkey_inputdev_open;
3595 tpacpi_inputdev->close = &hotkey_inputdev_close;
3597 hotkey_poll_setup_safe(true);
3602 /* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3603 * mode, Web conference mode, Function mode and Lay-flat mode.
3604 * We support Home mode and Function mode currently.
3606 * Will consider support rest of modes in future.
3609 static const int adaptive_keyboard_modes[] = {
3611 /* WEB_BROWSER_MODE = 2,
3612 WEB_CONFERENCE_MODE = 3, */
3616 #define DFR_CHANGE_ROW 0x101
3617 #define DFR_SHOW_QUICKVIEW_ROW 0x102
3618 #define FIRST_ADAPTIVE_KEY 0x103
3620 /* press Fn key a while second, it will switch to Function Mode. Then
3621 * release Fn key, previous mode be restored.
3623 static bool adaptive_keyboard_mode_is_saved;
3624 static int adaptive_keyboard_prev_mode;
3626 static int adaptive_keyboard_get_mode(void)
3630 if (!acpi_evalf(hkey_handle, &mode, "GTRW", "dd", 0)) {
3631 pr_err("Cannot read adaptive keyboard mode\n");
3638 static int adaptive_keyboard_set_mode(int new_mode)
3641 new_mode > LAYFLAT_MODE)
3644 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3645 pr_err("Cannot set adaptive keyboard mode\n");
3652 static int adaptive_keyboard_get_next_mode(int mode)
3655 size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3657 for (i = 0; i <= max_mode; i++) {
3658 if (adaptive_keyboard_modes[i] == mode)
3667 return adaptive_keyboard_modes[i];
3670 static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3672 int current_mode = 0;
3677 case DFR_CHANGE_ROW:
3678 if (adaptive_keyboard_mode_is_saved) {
3679 new_mode = adaptive_keyboard_prev_mode;
3680 adaptive_keyboard_mode_is_saved = false;
3682 current_mode = adaptive_keyboard_get_mode();
3683 if (current_mode < 0)
3685 new_mode = adaptive_keyboard_get_next_mode(
3689 if (adaptive_keyboard_set_mode(new_mode) < 0)
3694 case DFR_SHOW_QUICKVIEW_ROW:
3695 current_mode = adaptive_keyboard_get_mode();
3696 if (current_mode < 0)
3699 adaptive_keyboard_prev_mode = current_mode;
3700 adaptive_keyboard_mode_is_saved = true;
3702 if (adaptive_keyboard_set_mode (FUNCTION_MODE) < 0)
3707 if (scancode < FIRST_ADAPTIVE_KEY ||
3708 scancode >= FIRST_ADAPTIVE_KEY +
3709 TP_ACPI_HOTKEYSCAN_EXTENDED_START -
3710 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3711 pr_info("Unhandled adaptive keyboard key: 0x%x\n",
3715 keycode = hotkey_keycode_map[scancode - FIRST_ADAPTIVE_KEY +
3716 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START];
3717 if (keycode != KEY_RESERVED) {
3718 mutex_lock(&tpacpi_inputdev_send_mutex);
3720 input_report_key(tpacpi_inputdev, keycode, 1);
3721 input_sync(tpacpi_inputdev);
3723 input_report_key(tpacpi_inputdev, keycode, 0);
3724 input_sync(tpacpi_inputdev);
3726 mutex_unlock(&tpacpi_inputdev_send_mutex);
3732 static bool hotkey_notify_extended_hotkey(const u32 hkey)
3734 unsigned int scancode;
3737 case TP_HKEY_EV_PRIVACYGUARD_TOGGLE:
3738 tpacpi_driver_event(hkey);
3742 /* Extended keycodes start at 0x300 and our offset into the map
3743 * TP_ACPI_HOTKEYSCAN_EXTENDED_START. The calculated scancode
3744 * will be positive, but might not be in the correct range.
3746 scancode = (hkey & 0xfff) - (0x300 - TP_ACPI_HOTKEYSCAN_EXTENDED_START);
3747 if (scancode >= TP_ACPI_HOTKEYSCAN_EXTENDED_START &&
3748 scancode < TPACPI_HOTKEY_MAP_LEN) {
3749 tpacpi_input_send_key(scancode);
3756 static bool hotkey_notify_hotkey(const u32 hkey,
3758 bool *ignore_acpi_ev)
3760 /* 0x1000-0x1FFF: key presses */
3761 unsigned int scancode = hkey & 0xfff;
3762 *send_acpi_ev = true;
3763 *ignore_acpi_ev = false;
3766 * Original events are in the 0x10XX range, the adaptive keyboard
3767 * found in 2014 X1 Carbon emits events are of 0x11XX. In 2017
3768 * models, additional keys are emitted through 0x13XX.
3770 switch ((hkey >> 8) & 0xf) {
3773 scancode <= TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3774 /* HKEY event 0x1001 is scancode 0x00 */
3776 if (!(hotkey_source_mask & (1 << scancode))) {
3777 tpacpi_input_send_key_masked(scancode);
3778 *send_acpi_ev = false;
3780 *ignore_acpi_ev = true;
3787 return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3790 return hotkey_notify_extended_hotkey(hkey);
3796 static bool hotkey_notify_wakeup(const u32 hkey,
3798 bool *ignore_acpi_ev)
3800 /* 0x2000-0x2FFF: Wakeup reason */
3801 *send_acpi_ev = true;
3802 *ignore_acpi_ev = false;
3805 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3806 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3807 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3808 *ignore_acpi_ev = true;
3811 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3812 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3813 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3814 *ignore_acpi_ev = true;
3817 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3818 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3819 pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3820 /* how to auto-heal: */
3821 /* 2313: woke up from S3, go to S4/S5 */
3822 /* 2413: woke up from S4, go to S5 */
3829 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3830 pr_info("woke up due to a hot-unplug request...\n");
3831 hotkey_wakeup_reason_notify_change();
3836 static bool hotkey_notify_dockevent(const u32 hkey,
3838 bool *ignore_acpi_ev)
3840 /* 0x4000-0x4FFF: dock-related events */
3841 *send_acpi_ev = true;
3842 *ignore_acpi_ev = false;
3845 case TP_HKEY_EV_UNDOCK_ACK:
3846 /* ACPI undock operation completed after wakeup */
3847 hotkey_autosleep_ack = 1;
3848 pr_info("undocked\n");
3849 hotkey_wakeup_hotunplug_complete_notify_change();
3852 case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3853 pr_info("docked into hotplug port replicator\n");
3855 case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3856 pr_info("undocked from hotplug port replicator\n");
3860 * Deliberately ignore attaching and detaching the keybord cover to avoid
3861 * duplicates from intel-vbtn, which already emits SW_TABLET_MODE events
3864 * Please refer to the following thread for more information and a preliminary
3865 * implementation using the GTOP ("Get Tablet OPtions") interface that could be
3866 * extended to other attachment options of the ThinkPad X1 Tablet series, such as
3867 * the Pico cartridge dock module:
3868 * https://lore.kernel.org/platform-driver-x86/38cb8265-1e30-d547-9e12-b4ae290be737@a-kobel.de/
3870 case TP_HKEY_EV_KBD_COVER_ATTACH:
3871 case TP_HKEY_EV_KBD_COVER_DETACH:
3872 *send_acpi_ev = false;
3873 *ignore_acpi_ev = true;
3881 static bool hotkey_notify_usrevent(const u32 hkey,
3883 bool *ignore_acpi_ev)
3885 /* 0x5000-0x5FFF: human interface helpers */
3886 *send_acpi_ev = true;
3887 *ignore_acpi_ev = false;
3890 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3891 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3894 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3895 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3896 tpacpi_input_send_tabletsw();
3897 hotkey_tablet_mode_notify_change();
3898 *send_acpi_ev = false;
3901 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3902 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3903 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3904 /* do not propagate these events */
3905 *ignore_acpi_ev = true;
3913 static void thermal_dump_all_sensors(void);
3914 static void palmsensor_refresh(void);
3916 static bool hotkey_notify_6xxx(const u32 hkey,
3918 bool *ignore_acpi_ev)
3920 /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
3921 *send_acpi_ev = true;
3922 *ignore_acpi_ev = false;
3925 case TP_HKEY_EV_THM_TABLE_CHANGED:
3926 pr_debug("EC reports: Thermal Table has changed\n");
3927 /* recommended action: do nothing, we don't have
3928 * Lenovo ATM information */
3930 case TP_HKEY_EV_THM_CSM_COMPLETED:
3931 pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
3932 /* Thermal event - pass on to event handler */
3933 tpacpi_driver_event(hkey);
3935 case TP_HKEY_EV_THM_TRANSFM_CHANGED:
3936 pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
3937 /* recommended action: do nothing, we don't have
3938 * Lenovo ATM information */
3940 case TP_HKEY_EV_ALARM_BAT_HOT:
3941 pr_crit("THERMAL ALARM: battery is too hot!\n");
3942 /* recommended action: warn user through gui */
3944 case TP_HKEY_EV_ALARM_BAT_XHOT:
3945 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
3946 /* recommended action: immediate sleep/hibernate */
3948 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3949 pr_crit("THERMAL ALARM: a sensor reports something is too hot!\n");
3950 /* recommended action: warn user through gui, that */
3951 /* some internal component is too hot */
3953 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3954 pr_alert("THERMAL EMERGENCY: a sensor reports something is extremely hot!\n");
3955 /* recommended action: immediate sleep/hibernate */
3957 case TP_HKEY_EV_AC_CHANGED:
3958 /* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
3959 * AC status changed; can be triggered by plugging or
3960 * unplugging AC adapter, docking or undocking. */
3964 case TP_HKEY_EV_KEY_NUMLOCK:
3965 case TP_HKEY_EV_KEY_FN:
3966 /* key press events, we just ignore them as long as the EC
3967 * is still reporting them in the normal keyboard stream */
3968 *send_acpi_ev = false;
3969 *ignore_acpi_ev = true;
3972 case TP_HKEY_EV_KEY_FN_ESC:
3973 /* Get the media key status to force the status LED to update */
3974 acpi_evalf(hkey_handle, NULL, "GMKS", "v");
3975 *send_acpi_ev = false;
3976 *ignore_acpi_ev = true;
3979 case TP_HKEY_EV_TABLET_CHANGED:
3980 tpacpi_input_send_tabletsw();
3981 hotkey_tablet_mode_notify_change();
3982 *send_acpi_ev = false;
3985 case TP_HKEY_EV_PALM_DETECTED:
3986 case TP_HKEY_EV_PALM_UNDETECTED:
3987 /* palm detected - pass on to event handler */
3988 palmsensor_refresh();
3992 /* report simply as unknown, no sensor dump */
3996 thermal_dump_all_sensors();
4000 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
4004 bool ignore_acpi_ev;
4007 if (event != 0x80) {
4008 pr_err("unknown HKEY notification event %d\n", event);
4009 /* forward it to userspace, maybe it knows how to handle it */
4010 acpi_bus_generate_netlink_event(
4011 ibm->acpi->device->pnp.device_class,
4012 dev_name(&ibm->acpi->device->dev),
4018 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
4019 pr_err("failed to retrieve HKEY event\n");
4028 send_acpi_ev = true;
4029 ignore_acpi_ev = false;
4031 switch (hkey >> 12) {
4033 /* 0x1000-0x1FFF: key presses */
4034 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
4038 /* 0x2000-0x2FFF: Wakeup reason */
4039 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
4043 /* 0x3000-0x3FFF: bay-related wakeups */
4045 case TP_HKEY_EV_BAYEJ_ACK:
4046 hotkey_autosleep_ack = 1;
4047 pr_info("bay ejected\n");
4048 hotkey_wakeup_hotunplug_complete_notify_change();
4051 case TP_HKEY_EV_OPTDRV_EJ:
4052 /* FIXME: kick libata if SATA link offline */
4060 /* 0x4000-0x4FFF: dock-related events */
4061 known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
4065 /* 0x5000-0x5FFF: human interface helpers */
4066 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
4070 /* 0x6000-0x6FFF: thermal alarms/notices and
4071 * keyboard events */
4072 known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
4076 /* 0x7000-0x7FFF: misc */
4077 if (tp_features.hotkey_wlsw &&
4078 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
4079 tpacpi_send_radiosw_update();
4084 fallthrough; /* to default */
4089 pr_notice("unhandled HKEY event 0x%04x\n", hkey);
4090 pr_notice("please report the conditions when this event happened to %s\n",
4094 /* netlink events */
4095 if (!ignore_acpi_ev && send_acpi_ev) {
4096 acpi_bus_generate_netlink_event(
4097 ibm->acpi->device->pnp.device_class,
4098 dev_name(&ibm->acpi->device->dev),
4104 static void hotkey_suspend(void)
4106 /* Do these on suspend, we get the events on early resume! */
4107 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
4108 hotkey_autosleep_ack = 0;
4110 /* save previous mode of adaptive keyboard of X1 Carbon */
4111 if (tp_features.has_adaptive_kbd) {
4112 if (!acpi_evalf(hkey_handle, &adaptive_keyboard_prev_mode,
4114 pr_err("Cannot read adaptive keyboard mode.\n");
4119 static void hotkey_resume(void)
4121 tpacpi_disable_brightness_delay();
4123 if (hotkey_status_set(true) < 0 ||
4124 hotkey_mask_set(hotkey_acpi_mask) < 0)
4125 pr_err("error while attempting to reset the event firmware interface\n");
4127 tpacpi_send_radiosw_update();
4128 tpacpi_input_send_tabletsw();
4129 hotkey_tablet_mode_notify_change();
4130 hotkey_wakeup_reason_notify_change();
4131 hotkey_wakeup_hotunplug_complete_notify_change();
4132 hotkey_poll_setup_safe(false);
4134 /* restore previous mode of adapive keyboard of X1 Carbon */
4135 if (tp_features.has_adaptive_kbd) {
4136 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd",
4137 adaptive_keyboard_prev_mode)) {
4138 pr_err("Cannot set adaptive keyboard mode.\n");
4143 /* procfs -------------------------------------------------------------- */
4144 static int hotkey_read(struct seq_file *m)
4148 if (!tp_features.hotkey) {
4149 seq_printf(m, "status:\t\tnot supported\n");
4153 if (mutex_lock_killable(&hotkey_mutex))
4154 return -ERESTARTSYS;
4155 res = hotkey_status_get(&status);
4157 res = hotkey_mask_get();
4158 mutex_unlock(&hotkey_mutex);
4162 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
4163 if (hotkey_all_mask) {
4164 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
4165 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
4167 seq_printf(m, "mask:\t\tnot supported\n");
4168 seq_printf(m, "commands:\tenable, disable, reset\n");
4174 static void hotkey_enabledisable_warn(bool enable)
4176 tpacpi_log_usertask("procfs hotkey enable/disable");
4177 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
4178 pr_fmt("hotkey enable/disable functionality has been removed from the driver. Hotkeys are always enabled.\n")))
4179 pr_err("Please remove the hotkey=enable module parameter, it is deprecated. Hotkeys are always enabled.\n");
4182 static int hotkey_write(char *buf)
4188 if (!tp_features.hotkey)
4191 if (mutex_lock_killable(&hotkey_mutex))
4192 return -ERESTARTSYS;
4194 mask = hotkey_user_mask;
4197 while ((cmd = strsep(&buf, ","))) {
4198 if (strlencmp(cmd, "enable") == 0) {
4199 hotkey_enabledisable_warn(1);
4200 } else if (strlencmp(cmd, "disable") == 0) {
4201 hotkey_enabledisable_warn(0);
4203 } else if (strlencmp(cmd, "reset") == 0) {
4204 mask = (hotkey_all_mask | hotkey_source_mask)
4205 & ~hotkey_reserved_mask;
4206 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
4208 } else if (sscanf(cmd, "%x", &mask) == 1) {
4217 tpacpi_disclose_usertask("procfs hotkey",
4218 "set mask to 0x%08x\n", mask);
4219 res = hotkey_user_mask_set(mask);
4223 mutex_unlock(&hotkey_mutex);
4227 static const struct acpi_device_id ibm_htk_device_ids[] = {
4228 {TPACPI_ACPI_IBM_HKEY_HID, 0},
4229 {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
4230 {TPACPI_ACPI_LENOVO_HKEY_V2_HID, 0},
4234 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
4235 .hid = ibm_htk_device_ids,
4236 .notify = hotkey_notify,
4237 .handle = &hkey_handle,
4238 .type = ACPI_DEVICE_NOTIFY,
4241 static struct ibm_struct hotkey_driver_data = {
4243 .read = hotkey_read,
4244 .write = hotkey_write,
4245 .exit = hotkey_exit,
4246 .resume = hotkey_resume,
4247 .suspend = hotkey_suspend,
4248 .acpi = &ibm_hotkey_acpidriver,
4251 /*************************************************************************
4252 * Bluetooth subdriver
4256 /* ACPI GBDC/SBDC bits */
4257 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
4258 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
4259 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
4260 0 = disable, 1 = enable */
4264 /* ACPI \BLTH commands */
4265 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
4266 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
4267 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
4268 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
4269 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
4272 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
4274 static int bluetooth_get_status(void)
4278 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4279 if (dbg_bluetoothemul)
4280 return (tpacpi_bluetooth_emulstate) ?
4281 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4284 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4287 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4288 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4291 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4295 vdbg_printk(TPACPI_DBG_RFKILL,
4296 "will attempt to %s bluetooth\n",
4297 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4299 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4300 if (dbg_bluetoothemul) {
4301 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4306 if (state == TPACPI_RFK_RADIO_ON)
4307 status = TP_ACPI_BLUETOOTH_RADIOSSW
4308 | TP_ACPI_BLUETOOTH_RESUMECTRL;
4312 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4318 /* sysfs bluetooth enable ---------------------------------------------- */
4319 static ssize_t bluetooth_enable_show(struct device *dev,
4320 struct device_attribute *attr,
4323 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4327 static ssize_t bluetooth_enable_store(struct device *dev,
4328 struct device_attribute *attr,
4329 const char *buf, size_t count)
4331 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4335 static DEVICE_ATTR_RW(bluetooth_enable);
4337 /* --------------------------------------------------------------------- */
4339 static struct attribute *bluetooth_attributes[] = {
4340 &dev_attr_bluetooth_enable.attr,
4344 static umode_t bluetooth_attr_is_visible(struct kobject *kobj,
4345 struct attribute *attr, int n)
4347 return tp_features.bluetooth ? attr->mode : 0;
4350 static const struct attribute_group bluetooth_attr_group = {
4351 .is_visible = bluetooth_attr_is_visible,
4352 .attrs = bluetooth_attributes,
4355 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4356 .get_status = bluetooth_get_status,
4357 .set_status = bluetooth_set_status,
4360 static void bluetooth_shutdown(void)
4362 /* Order firmware to save current state to NVRAM */
4363 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4364 TP_ACPI_BLTH_SAVE_STATE))
4365 pr_notice("failed to save bluetooth state to NVRAM\n");
4367 vdbg_printk(TPACPI_DBG_RFKILL,
4368 "bluetooth state saved to NVRAM\n");
4371 static void bluetooth_exit(void)
4373 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4374 bluetooth_shutdown();
4377 static const struct dmi_system_id fwbug_list[] __initconst = {
4379 .ident = "ThinkPad E485",
4380 .driver_data = &quirk_btusb_bug,
4382 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4383 DMI_MATCH(DMI_BOARD_NAME, "20KU"),
4387 .ident = "ThinkPad E585",
4388 .driver_data = &quirk_btusb_bug,
4390 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4391 DMI_MATCH(DMI_BOARD_NAME, "20KV"),
4395 .ident = "ThinkPad A285 - 20MW",
4396 .driver_data = &quirk_btusb_bug,
4398 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4399 DMI_MATCH(DMI_BOARD_NAME, "20MW"),
4403 .ident = "ThinkPad A285 - 20MX",
4404 .driver_data = &quirk_btusb_bug,
4406 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4407 DMI_MATCH(DMI_BOARD_NAME, "20MX"),
4411 .ident = "ThinkPad A485 - 20MU",
4412 .driver_data = &quirk_btusb_bug,
4414 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4415 DMI_MATCH(DMI_BOARD_NAME, "20MU"),
4419 .ident = "ThinkPad A485 - 20MV",
4420 .driver_data = &quirk_btusb_bug,
4422 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4423 DMI_MATCH(DMI_BOARD_NAME, "20MV"),
4427 .ident = "L14 Gen2 AMD",
4428 .driver_data = &quirk_s2idle_bug,
4430 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4431 DMI_MATCH(DMI_PRODUCT_NAME, "20X5"),
4435 .ident = "T14s Gen2 AMD",
4436 .driver_data = &quirk_s2idle_bug,
4438 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4439 DMI_MATCH(DMI_PRODUCT_NAME, "20XF"),
4443 .ident = "X13 Gen2 AMD",
4444 .driver_data = &quirk_s2idle_bug,
4446 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4447 DMI_MATCH(DMI_PRODUCT_NAME, "20XH"),
4451 .ident = "T14 Gen2 AMD",
4452 .driver_data = &quirk_s2idle_bug,
4454 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4455 DMI_MATCH(DMI_PRODUCT_NAME, "20XK"),
4459 .ident = "T14 Gen1 AMD",
4460 .driver_data = &quirk_s2idle_bug,
4462 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4463 DMI_MATCH(DMI_PRODUCT_NAME, "20UD"),
4467 .ident = "T14 Gen1 AMD",
4468 .driver_data = &quirk_s2idle_bug,
4470 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4471 DMI_MATCH(DMI_PRODUCT_NAME, "20UE"),
4475 .ident = "T14s Gen1 AMD",
4476 .driver_data = &quirk_s2idle_bug,
4478 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4479 DMI_MATCH(DMI_PRODUCT_NAME, "20UH"),
4483 .ident = "P14s Gen1 AMD",
4484 .driver_data = &quirk_s2idle_bug,
4486 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4487 DMI_MATCH(DMI_PRODUCT_NAME, "20Y1"),
4491 .ident = "P14s Gen2 AMD",
4492 .driver_data = &quirk_s2idle_bug,
4494 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4495 DMI_MATCH(DMI_PRODUCT_NAME, "21A0"),
4501 #ifdef CONFIG_SUSPEND
4503 * Lenovo laptops from a variety of generations run a SMI handler during the D3->D0
4504 * transition that occurs specifically when exiting suspend to idle which can cause
4505 * large delays during resume when the IOMMU translation layer is enabled (the default
4506 * behavior) for NVME devices:
4508 * To avoid this firmware problem, skip the SMI handler on these machines before the
4509 * D0 transition occurs.
4511 static void thinkpad_acpi_amd_s2idle_restore(void)
4513 struct resource *res;
4517 res = request_mem_region_muxed(tp_features.quirks->s2idle_bug_mmio, 1,
4518 "thinkpad_acpi_pm80");
4522 addr = ioremap(tp_features.quirks->s2idle_bug_mmio, 1);
4524 goto cleanup_resource;
4526 val = ioread8(addr);
4527 iowrite8(val & ~BIT(0), addr);
4531 release_resource(res);
4534 static struct acpi_s2idle_dev_ops thinkpad_acpi_s2idle_dev_ops = {
4535 .restore = thinkpad_acpi_amd_s2idle_restore,
4539 static const struct pci_device_id fwbug_cards_ids[] __initconst = {
4540 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24F3) },
4541 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24FD) },
4542 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x2526) },
4547 static int __init have_bt_fwbug(void)
4550 * Some AMD based ThinkPads have a firmware bug that calling
4551 * "GBDC" will cause bluetooth on Intel wireless cards blocked
4553 if (tp_features.quirks && tp_features.quirks->btusb_bug &&
4554 pci_dev_present(fwbug_cards_ids)) {
4555 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4556 FW_BUG "disable bluetooth subdriver for Intel cards\n");
4562 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4567 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4568 "initializing bluetooth subdriver\n");
4570 TPACPI_ACPIHANDLE_INIT(hkey);
4572 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4573 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4574 tp_features.bluetooth = !have_bt_fwbug() && hkey_handle &&
4575 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4577 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4578 "bluetooth is %s, status 0x%02x\n",
4579 str_supported(tp_features.bluetooth),
4582 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4583 if (dbg_bluetoothemul) {
4584 tp_features.bluetooth = 1;
4585 pr_info("bluetooth switch emulation enabled\n");
4588 if (tp_features.bluetooth &&
4589 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4590 /* no bluetooth hardware present in system */
4591 tp_features.bluetooth = 0;
4592 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4593 "bluetooth hardware not installed\n");
4596 if (!tp_features.bluetooth)
4599 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4600 &bluetooth_tprfk_ops,
4601 RFKILL_TYPE_BLUETOOTH,
4602 TPACPI_RFK_BLUETOOTH_SW_NAME,
4607 /* procfs -------------------------------------------------------------- */
4608 static int bluetooth_read(struct seq_file *m)
4610 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4613 static int bluetooth_write(char *buf)
4615 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4618 static struct ibm_struct bluetooth_driver_data = {
4619 .name = "bluetooth",
4620 .read = bluetooth_read,
4621 .write = bluetooth_write,
4622 .exit = bluetooth_exit,
4623 .shutdown = bluetooth_shutdown,
4626 /*************************************************************************
4631 /* ACPI GWAN/SWAN bits */
4632 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4633 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4634 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4635 0 = disable, 1 = enable */
4638 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4640 static int wan_get_status(void)
4644 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4646 return (tpacpi_wwan_emulstate) ?
4647 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4650 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4653 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4654 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4657 static int wan_set_status(enum tpacpi_rfkill_state state)
4661 vdbg_printk(TPACPI_DBG_RFKILL,
4662 "will attempt to %s wwan\n",
4663 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4665 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4667 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4672 if (state == TPACPI_RFK_RADIO_ON)
4673 status = TP_ACPI_WANCARD_RADIOSSW
4674 | TP_ACPI_WANCARD_RESUMECTRL;
4678 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4684 /* sysfs wan enable ---------------------------------------------------- */
4685 static ssize_t wan_enable_show(struct device *dev,
4686 struct device_attribute *attr,
4689 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4693 static ssize_t wan_enable_store(struct device *dev,
4694 struct device_attribute *attr,
4695 const char *buf, size_t count)
4697 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4701 static DEVICE_ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4702 wan_enable_show, wan_enable_store);
4704 /* --------------------------------------------------------------------- */
4706 static struct attribute *wan_attributes[] = {
4707 &dev_attr_wwan_enable.attr,
4711 static umode_t wan_attr_is_visible(struct kobject *kobj, struct attribute *attr,
4714 return tp_features.wan ? attr->mode : 0;
4717 static const struct attribute_group wan_attr_group = {
4718 .is_visible = wan_attr_is_visible,
4719 .attrs = wan_attributes,
4722 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4723 .get_status = wan_get_status,
4724 .set_status = wan_set_status,
4727 static void wan_shutdown(void)
4729 /* Order firmware to save current state to NVRAM */
4730 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4731 TP_ACPI_WGSV_SAVE_STATE))
4732 pr_notice("failed to save WWAN state to NVRAM\n");
4734 vdbg_printk(TPACPI_DBG_RFKILL,
4735 "WWAN state saved to NVRAM\n");
4738 static void wan_exit(void)
4740 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4744 static int __init wan_init(struct ibm_init_struct *iibm)
4749 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4750 "initializing wan subdriver\n");
4752 TPACPI_ACPIHANDLE_INIT(hkey);
4754 tp_features.wan = hkey_handle &&
4755 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4757 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4758 "wan is %s, status 0x%02x\n",
4759 str_supported(tp_features.wan),
4762 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4764 tp_features.wan = 1;
4765 pr_info("wwan switch emulation enabled\n");
4768 if (tp_features.wan &&
4769 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4770 /* no wan hardware present in system */
4771 tp_features.wan = 0;
4772 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4773 "wan hardware not installed\n");
4776 if (!tp_features.wan)
4779 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4782 TPACPI_RFK_WWAN_SW_NAME,
4787 /* procfs -------------------------------------------------------------- */
4788 static int wan_read(struct seq_file *m)
4790 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4793 static int wan_write(char *buf)
4795 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4798 static struct ibm_struct wan_driver_data = {
4803 .shutdown = wan_shutdown,
4806 /*************************************************************************
4811 /* ACPI GUWB/SUWB bits */
4812 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4813 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4816 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4818 static int uwb_get_status(void)
4822 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4824 return (tpacpi_uwb_emulstate) ?
4825 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4828 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4831 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4832 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4835 static int uwb_set_status(enum tpacpi_rfkill_state state)
4839 vdbg_printk(TPACPI_DBG_RFKILL,
4840 "will attempt to %s UWB\n",
4841 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4843 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4845 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4850 if (state == TPACPI_RFK_RADIO_ON)
4851 status = TP_ACPI_UWB_RADIOSSW;
4855 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4861 /* --------------------------------------------------------------------- */
4863 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4864 .get_status = uwb_get_status,
4865 .set_status = uwb_set_status,
4868 static void uwb_exit(void)
4870 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4873 static int __init uwb_init(struct ibm_init_struct *iibm)
4878 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4879 "initializing uwb subdriver\n");
4881 TPACPI_ACPIHANDLE_INIT(hkey);
4883 tp_features.uwb = hkey_handle &&
4884 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4886 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4887 "uwb is %s, status 0x%02x\n",
4888 str_supported(tp_features.uwb),
4891 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4893 tp_features.uwb = 1;
4894 pr_info("uwb switch emulation enabled\n");
4897 if (tp_features.uwb &&
4898 !(status & TP_ACPI_UWB_HWPRESENT)) {
4899 /* no uwb hardware present in system */
4900 tp_features.uwb = 0;
4901 dbg_printk(TPACPI_DBG_INIT,
4902 "uwb hardware not installed\n");
4905 if (!tp_features.uwb)
4908 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4911 TPACPI_RFK_UWB_SW_NAME,
4916 static struct ibm_struct uwb_driver_data = {
4919 .flags.experimental = 1,
4922 /*************************************************************************
4926 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4928 enum video_access_mode {
4929 TPACPI_VIDEO_NONE = 0,
4930 TPACPI_VIDEO_570, /* 570 */
4931 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4932 TPACPI_VIDEO_NEW, /* all others */
4935 enum { /* video status flags, based on VIDEO_570 */
4936 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4937 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4938 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4941 enum { /* TPACPI_VIDEO_570 constants */
4942 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4943 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4944 * video_status_flags */
4945 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4946 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4949 static enum video_access_mode video_supported;
4950 static int video_orig_autosw;
4952 static int video_autosw_get(void);
4953 static int video_autosw_set(int enable);
4955 TPACPI_HANDLE(vid, root,
4956 "\\_SB.PCI.AGP.VGA", /* 570 */
4957 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
4958 "\\_SB.PCI0.VID0", /* 770e */
4959 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
4960 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
4961 "\\_SB.PCI0.AGP.VID", /* all others */
4964 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4966 static int __init video_init(struct ibm_init_struct *iibm)
4970 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4972 TPACPI_ACPIHANDLE_INIT(vid);
4973 if (tpacpi_is_ibm())
4974 TPACPI_ACPIHANDLE_INIT(vid2);
4976 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4977 /* G41, assume IVGA doesn't change */
4978 vid_handle = vid2_handle;
4981 /* video switching not supported on R30, R31 */
4982 video_supported = TPACPI_VIDEO_NONE;
4983 else if (tpacpi_is_ibm() &&
4984 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4986 video_supported = TPACPI_VIDEO_570;
4987 else if (tpacpi_is_ibm() &&
4988 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4989 /* 600e/x, 770e, 770x */
4990 video_supported = TPACPI_VIDEO_770;
4993 video_supported = TPACPI_VIDEO_NEW;
4995 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4996 str_supported(video_supported != TPACPI_VIDEO_NONE),
4999 return (video_supported != TPACPI_VIDEO_NONE) ? 0 : -ENODEV;
5002 static void video_exit(void)
5004 dbg_printk(TPACPI_DBG_EXIT,
5005 "restoring original video autoswitch mode\n");
5006 if (video_autosw_set(video_orig_autosw))
5007 pr_err("error while trying to restore original video autoswitch mode\n");
5010 static int video_outputsw_get(void)
5015 switch (video_supported) {
5016 case TPACPI_VIDEO_570:
5017 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
5018 TP_ACPI_VIDEO_570_PHSCMD))
5020 status = i & TP_ACPI_VIDEO_570_PHSMASK;
5022 case TPACPI_VIDEO_770:
5023 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
5026 status |= TP_ACPI_VIDEO_S_LCD;
5027 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
5030 status |= TP_ACPI_VIDEO_S_CRT;
5032 case TPACPI_VIDEO_NEW:
5033 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
5034 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
5037 status |= TP_ACPI_VIDEO_S_CRT;
5039 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
5040 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
5043 status |= TP_ACPI_VIDEO_S_LCD;
5044 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
5047 status |= TP_ACPI_VIDEO_S_DVI;
5056 static int video_outputsw_set(int status)
5061 switch (video_supported) {
5062 case TPACPI_VIDEO_570:
5063 res = acpi_evalf(NULL, NULL,
5064 "\\_SB.PHS2", "vdd",
5065 TP_ACPI_VIDEO_570_PHS2CMD,
5066 status | TP_ACPI_VIDEO_570_PHS2SET);
5068 case TPACPI_VIDEO_770:
5069 autosw = video_autosw_get();
5073 res = video_autosw_set(1);
5076 res = acpi_evalf(vid_handle, NULL,
5077 "ASWT", "vdd", status * 0x100, 0);
5078 if (!autosw && video_autosw_set(autosw)) {
5079 pr_err("video auto-switch left enabled due to error\n");
5083 case TPACPI_VIDEO_NEW:
5084 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
5085 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
5091 return (res) ? 0 : -EIO;
5094 static int video_autosw_get(void)
5098 switch (video_supported) {
5099 case TPACPI_VIDEO_570:
5100 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
5103 case TPACPI_VIDEO_770:
5104 case TPACPI_VIDEO_NEW:
5105 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
5115 static int video_autosw_set(int enable)
5117 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable) ? 1 : 0))
5122 static int video_outputsw_cycle(void)
5124 int autosw = video_autosw_get();
5130 switch (video_supported) {
5131 case TPACPI_VIDEO_570:
5132 res = video_autosw_set(1);
5135 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
5137 case TPACPI_VIDEO_770:
5138 case TPACPI_VIDEO_NEW:
5139 res = video_autosw_set(1);
5142 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
5147 if (!autosw && video_autosw_set(autosw)) {
5148 pr_err("video auto-switch left enabled due to error\n");
5152 return (res) ? 0 : -EIO;
5155 static int video_expand_toggle(void)
5157 switch (video_supported) {
5158 case TPACPI_VIDEO_570:
5159 return acpi_evalf(ec_handle, NULL, "_Q17", "v") ?
5161 case TPACPI_VIDEO_770:
5162 return acpi_evalf(vid_handle, NULL, "VEXP", "v") ?
5164 case TPACPI_VIDEO_NEW:
5165 return acpi_evalf(NULL, NULL, "\\VEXP", "v") ?
5173 static int video_read(struct seq_file *m)
5177 if (video_supported == TPACPI_VIDEO_NONE) {
5178 seq_printf(m, "status:\t\tnot supported\n");
5182 /* Even reads can crash X.org, so... */
5183 if (!capable(CAP_SYS_ADMIN))
5186 status = video_outputsw_get();
5190 autosw = video_autosw_get();
5194 seq_printf(m, "status:\t\tsupported\n");
5195 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
5196 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
5197 if (video_supported == TPACPI_VIDEO_NEW)
5198 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
5199 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
5200 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
5201 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
5202 if (video_supported == TPACPI_VIDEO_NEW)
5203 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
5204 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
5205 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
5210 static int video_write(char *buf)
5213 int enable, disable, status;
5216 if (video_supported == TPACPI_VIDEO_NONE)
5219 /* Even reads can crash X.org, let alone writes... */
5220 if (!capable(CAP_SYS_ADMIN))
5226 while ((cmd = strsep(&buf, ","))) {
5227 if (strlencmp(cmd, "lcd_enable") == 0) {
5228 enable |= TP_ACPI_VIDEO_S_LCD;
5229 } else if (strlencmp(cmd, "lcd_disable") == 0) {
5230 disable |= TP_ACPI_VIDEO_S_LCD;
5231 } else if (strlencmp(cmd, "crt_enable") == 0) {
5232 enable |= TP_ACPI_VIDEO_S_CRT;
5233 } else if (strlencmp(cmd, "crt_disable") == 0) {
5234 disable |= TP_ACPI_VIDEO_S_CRT;
5235 } else if (video_supported == TPACPI_VIDEO_NEW &&
5236 strlencmp(cmd, "dvi_enable") == 0) {
5237 enable |= TP_ACPI_VIDEO_S_DVI;
5238 } else if (video_supported == TPACPI_VIDEO_NEW &&
5239 strlencmp(cmd, "dvi_disable") == 0) {
5240 disable |= TP_ACPI_VIDEO_S_DVI;
5241 } else if (strlencmp(cmd, "auto_enable") == 0) {
5242 res = video_autosw_set(1);
5245 } else if (strlencmp(cmd, "auto_disable") == 0) {
5246 res = video_autosw_set(0);
5249 } else if (strlencmp(cmd, "video_switch") == 0) {
5250 res = video_outputsw_cycle();
5253 } else if (strlencmp(cmd, "expand_toggle") == 0) {
5254 res = video_expand_toggle();
5261 if (enable || disable) {
5262 status = video_outputsw_get();
5265 res = video_outputsw_set((status & ~disable) | enable);
5273 static struct ibm_struct video_driver_data = {
5276 .write = video_write,
5280 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
5282 /*************************************************************************
5283 * Keyboard backlight subdriver
5286 static enum led_brightness kbdlight_brightness;
5287 static DEFINE_MUTEX(kbdlight_mutex);
5289 static int kbdlight_set_level(int level)
5296 mutex_lock(&kbdlight_mutex);
5298 if (!acpi_evalf(hkey_handle, NULL, "MLCS", "dd", level))
5301 kbdlight_brightness = level;
5303 mutex_unlock(&kbdlight_mutex);
5308 static int kbdlight_get_level(void)
5315 if (!acpi_evalf(hkey_handle, &status, "MLCG", "dd", 0))
5321 return status & 0x3;
5324 static bool kbdlight_is_supported(void)
5331 if (!acpi_has_method(hkey_handle, "MLCG")) {
5332 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG is unavailable\n");
5336 if (!acpi_evalf(hkey_handle, &status, "MLCG", "qdd", 0)) {
5337 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG failed\n");
5342 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG err: %d\n", status);
5346 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG returned 0x%x\n", status);
5348 * Guessed test for keyboard backlight:
5350 * Machines with backlight keyboard return:
5351 * b010100000010000000XX - ThinkPad X1 Carbon 3rd
5352 * b110100010010000000XX - ThinkPad x230
5353 * b010100000010000000XX - ThinkPad x240
5354 * b010100000010000000XX - ThinkPad W541
5355 * (XX is current backlight level)
5357 * Machines without backlight keyboard return:
5358 * b10100001000000000000 - ThinkPad x230
5359 * b10110001000000000000 - ThinkPad E430
5360 * b00000000000000000000 - ThinkPad E450
5362 * Candidate BITs for detection test (XOR):
5363 * b01000000001000000000
5366 return status & BIT(9);
5369 static int kbdlight_sysfs_set(struct led_classdev *led_cdev,
5370 enum led_brightness brightness)
5372 return kbdlight_set_level(brightness);
5375 static enum led_brightness kbdlight_sysfs_get(struct led_classdev *led_cdev)
5379 level = kbdlight_get_level();
5386 static struct tpacpi_led_classdev tpacpi_led_kbdlight = {
5388 .name = "tpacpi::kbd_backlight",
5389 .max_brightness = 2,
5390 .flags = LED_BRIGHT_HW_CHANGED,
5391 .brightness_set_blocking = &kbdlight_sysfs_set,
5392 .brightness_get = &kbdlight_sysfs_get,
5396 static int __init kbdlight_init(struct ibm_init_struct *iibm)
5400 vdbg_printk(TPACPI_DBG_INIT, "initializing kbdlight subdriver\n");
5402 TPACPI_ACPIHANDLE_INIT(hkey);
5404 if (!kbdlight_is_supported()) {
5405 tp_features.kbdlight = 0;
5406 vdbg_printk(TPACPI_DBG_INIT, "kbdlight is unsupported\n");
5410 kbdlight_brightness = kbdlight_sysfs_get(NULL);
5411 tp_features.kbdlight = 1;
5413 rc = led_classdev_register(&tpacpi_pdev->dev,
5414 &tpacpi_led_kbdlight.led_classdev);
5416 tp_features.kbdlight = 0;
5420 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask |
5421 TP_ACPI_HKEY_KBD_LIGHT_MASK);
5425 static void kbdlight_exit(void)
5427 led_classdev_unregister(&tpacpi_led_kbdlight.led_classdev);
5430 static int kbdlight_set_level_and_update(int level)
5433 struct led_classdev *led_cdev;
5435 ret = kbdlight_set_level(level);
5436 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5438 if (ret == 0 && !(led_cdev->flags & LED_SUSPENDED))
5439 led_cdev->brightness = level;
5444 static int kbdlight_read(struct seq_file *m)
5448 if (!tp_features.kbdlight) {
5449 seq_printf(m, "status:\t\tnot supported\n");
5451 level = kbdlight_get_level();
5453 seq_printf(m, "status:\t\terror %d\n", level);
5455 seq_printf(m, "status:\t\t%d\n", level);
5456 seq_printf(m, "commands:\t0, 1, 2\n");
5462 static int kbdlight_write(char *buf)
5465 int res, level = -EINVAL;
5467 if (!tp_features.kbdlight)
5470 while ((cmd = strsep(&buf, ","))) {
5471 res = kstrtoint(cmd, 10, &level);
5476 if (level >= 3 || level < 0)
5479 return kbdlight_set_level_and_update(level);
5482 static void kbdlight_suspend(void)
5484 struct led_classdev *led_cdev;
5486 if (!tp_features.kbdlight)
5489 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5490 led_update_brightness(led_cdev);
5491 led_classdev_suspend(led_cdev);
5494 static void kbdlight_resume(void)
5496 if (!tp_features.kbdlight)
5499 led_classdev_resume(&tpacpi_led_kbdlight.led_classdev);
5502 static struct ibm_struct kbdlight_driver_data = {
5504 .read = kbdlight_read,
5505 .write = kbdlight_write,
5506 .suspend = kbdlight_suspend,
5507 .resume = kbdlight_resume,
5508 .exit = kbdlight_exit,
5511 /*************************************************************************
5512 * Light (thinklight) subdriver
5515 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
5516 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
5518 static int light_get_status(void)
5522 if (tp_features.light_status) {
5523 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
5531 static int light_set_status(int status)
5535 if (tp_features.light) {
5537 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
5539 TP_CMOS_THINKLIGHT_ON :
5540 TP_CMOS_THINKLIGHT_OFF);
5542 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
5545 return (rc) ? 0 : -EIO;
5551 static int light_sysfs_set(struct led_classdev *led_cdev,
5552 enum led_brightness brightness)
5554 return light_set_status((brightness != LED_OFF) ?
5555 TPACPI_LED_ON : TPACPI_LED_OFF);
5558 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
5560 return (light_get_status() == 1) ? LED_FULL : LED_OFF;
5563 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
5565 .name = "tpacpi::thinklight",
5566 .brightness_set_blocking = &light_sysfs_set,
5567 .brightness_get = &light_sysfs_get,
5571 static int __init light_init(struct ibm_init_struct *iibm)
5575 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
5577 if (tpacpi_is_ibm()) {
5578 TPACPI_ACPIHANDLE_INIT(ledb);
5579 TPACPI_ACPIHANDLE_INIT(lght);
5581 TPACPI_ACPIHANDLE_INIT(cmos);
5583 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
5584 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
5586 if (tp_features.light)
5587 /* light status not supported on
5588 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
5589 tp_features.light_status =
5590 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
5592 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
5593 str_supported(tp_features.light),
5594 str_supported(tp_features.light_status));
5596 if (!tp_features.light)
5599 rc = led_classdev_register(&tpacpi_pdev->dev,
5600 &tpacpi_led_thinklight.led_classdev);
5603 tp_features.light = 0;
5604 tp_features.light_status = 0;
5612 static void light_exit(void)
5614 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
5617 static int light_read(struct seq_file *m)
5621 if (!tp_features.light) {
5622 seq_printf(m, "status:\t\tnot supported\n");
5623 } else if (!tp_features.light_status) {
5624 seq_printf(m, "status:\t\tunknown\n");
5625 seq_printf(m, "commands:\ton, off\n");
5627 status = light_get_status();
5630 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
5631 seq_printf(m, "commands:\ton, off\n");
5637 static int light_write(char *buf)
5642 if (!tp_features.light)
5645 while ((cmd = strsep(&buf, ","))) {
5646 if (strlencmp(cmd, "on") == 0) {
5648 } else if (strlencmp(cmd, "off") == 0) {
5654 return light_set_status(newstatus);
5657 static struct ibm_struct light_driver_data = {
5660 .write = light_write,
5664 /*************************************************************************
5668 /* sysfs cmos_command -------------------------------------------------- */
5669 static ssize_t cmos_command_store(struct device *dev,
5670 struct device_attribute *attr,
5671 const char *buf, size_t count)
5673 unsigned long cmos_cmd;
5676 if (parse_strtoul(buf, 21, &cmos_cmd))
5679 res = issue_thinkpad_cmos_command(cmos_cmd);
5680 return (res) ? res : count;
5683 static DEVICE_ATTR_WO(cmos_command);
5685 static struct attribute *cmos_attributes[] = {
5686 &dev_attr_cmos_command.attr,
5690 static umode_t cmos_attr_is_visible(struct kobject *kobj,
5691 struct attribute *attr, int n)
5693 return cmos_handle ? attr->mode : 0;
5696 static const struct attribute_group cmos_attr_group = {
5697 .is_visible = cmos_attr_is_visible,
5698 .attrs = cmos_attributes,
5701 /* --------------------------------------------------------------------- */
5703 static int __init cmos_init(struct ibm_init_struct *iibm)
5705 vdbg_printk(TPACPI_DBG_INIT,
5706 "initializing cmos commands subdriver\n");
5708 TPACPI_ACPIHANDLE_INIT(cmos);
5710 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5711 str_supported(cmos_handle != NULL));
5713 return cmos_handle ? 0 : -ENODEV;
5716 static int cmos_read(struct seq_file *m)
5718 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5719 R30, R31, T20-22, X20-21 */
5721 seq_printf(m, "status:\t\tnot supported\n");
5723 seq_printf(m, "status:\t\tsupported\n");
5724 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5730 static int cmos_write(char *buf)
5735 while ((cmd = strsep(&buf, ","))) {
5736 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5737 cmos_cmd >= 0 && cmos_cmd <= 21) {
5742 res = issue_thinkpad_cmos_command(cmos_cmd);
5750 static struct ibm_struct cmos_driver_data = {
5753 .write = cmos_write,
5756 /*************************************************************************
5760 enum led_access_mode {
5761 TPACPI_LED_NONE = 0,
5762 TPACPI_LED_570, /* 570 */
5763 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5764 TPACPI_LED_NEW, /* all others */
5767 enum { /* For TPACPI_LED_OLD */
5768 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5769 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5770 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5773 static enum led_access_mode led_supported;
5775 static acpi_handle led_handle;
5777 #define TPACPI_LED_NUMLEDS 16
5778 static struct tpacpi_led_classdev *tpacpi_leds;
5779 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5780 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5781 /* there's a limit of 19 chars + NULL before 2.6.26 */
5783 "tpacpi:orange:batt",
5784 "tpacpi:green:batt",
5785 "tpacpi::dock_active",
5786 "tpacpi::bay_active",
5787 "tpacpi::dock_batt",
5788 "tpacpi::unknown_led",
5790 "tpacpi::dock_status1",
5791 "tpacpi::dock_status2",
5792 "tpacpi::lid_logo_dot",
5793 "tpacpi::unknown_led3",
5794 "tpacpi::thinkvantage",
5796 #define TPACPI_SAFE_LEDS 0x1481U
5798 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5800 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5803 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5807 static int led_get_status(const unsigned int led)
5810 enum led_status_t led_s;
5812 switch (led_supported) {
5813 case TPACPI_LED_570:
5814 if (!acpi_evalf(ec_handle,
5815 &status, "GLED", "dd", 1 << led))
5817 led_s = (status == 0) ?
5822 tpacpi_led_state_cache[led] = led_s;
5831 static int led_set_status(const unsigned int led,
5832 const enum led_status_t ledstatus)
5834 /* off, on, blink. Index is led_status_t */
5835 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5836 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5840 switch (led_supported) {
5841 case TPACPI_LED_570:
5843 if (unlikely(led > 7))
5845 if (unlikely(tpacpi_is_led_restricted(led)))
5847 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5848 (1 << led), led_sled_arg1[ledstatus]))
5851 case TPACPI_LED_OLD:
5852 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5853 if (unlikely(led > 7))
5855 if (unlikely(tpacpi_is_led_restricted(led)))
5857 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5859 rc = ec_write(TPACPI_LED_EC_HLBL,
5860 (ledstatus == TPACPI_LED_BLINK) << led);
5862 rc = ec_write(TPACPI_LED_EC_HLCL,
5863 (ledstatus != TPACPI_LED_OFF) << led);
5865 case TPACPI_LED_NEW:
5867 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5869 if (unlikely(tpacpi_is_led_restricted(led)))
5871 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5872 led, led_led_arg1[ledstatus]))
5880 tpacpi_led_state_cache[led] = ledstatus;
5885 static int led_sysfs_set(struct led_classdev *led_cdev,
5886 enum led_brightness brightness)
5888 struct tpacpi_led_classdev *data = container_of(led_cdev,
5889 struct tpacpi_led_classdev, led_classdev);
5890 enum led_status_t new_state;
5892 if (brightness == LED_OFF)
5893 new_state = TPACPI_LED_OFF;
5894 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5895 new_state = TPACPI_LED_ON;
5897 new_state = TPACPI_LED_BLINK;
5899 return led_set_status(data->led, new_state);
5902 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5903 unsigned long *delay_on, unsigned long *delay_off)
5905 struct tpacpi_led_classdev *data = container_of(led_cdev,
5906 struct tpacpi_led_classdev, led_classdev);
5908 /* Can we choose the flash rate? */
5909 if (*delay_on == 0 && *delay_off == 0) {
5910 /* yes. set them to the hardware blink rate (1 Hz) */
5911 *delay_on = 500; /* ms */
5912 *delay_off = 500; /* ms */
5913 } else if ((*delay_on != 500) || (*delay_off != 500))
5916 return led_set_status(data->led, TPACPI_LED_BLINK);
5919 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5923 struct tpacpi_led_classdev *data = container_of(led_cdev,
5924 struct tpacpi_led_classdev, led_classdev);
5926 rc = led_get_status(data->led);
5928 if (rc == TPACPI_LED_OFF || rc < 0)
5929 rc = LED_OFF; /* no error handling in led class :( */
5936 static void led_exit(void)
5940 for (i = 0; i < TPACPI_LED_NUMLEDS; i++)
5941 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5946 static int __init tpacpi_init_led(unsigned int led)
5948 /* LEDs with no name don't get registered */
5949 if (!tpacpi_led_names[led])
5952 tpacpi_leds[led].led_classdev.brightness_set_blocking = &led_sysfs_set;
5953 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5954 if (led_supported == TPACPI_LED_570)
5955 tpacpi_leds[led].led_classdev.brightness_get = &led_sysfs_get;
5957 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5958 tpacpi_leds[led].led_classdev.flags = LED_RETAIN_AT_SHUTDOWN;
5959 tpacpi_leds[led].led = led;
5961 return led_classdev_register(&tpacpi_pdev->dev, &tpacpi_leds[led].led_classdev);
5964 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5965 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5966 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5967 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5969 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5970 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5971 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5972 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5973 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5974 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5975 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5976 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5978 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5979 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5980 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5981 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5982 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5984 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5985 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5986 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5987 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5989 /* (1) - may have excess leds enabled on MSB */
5991 /* Defaults (order matters, keep last, don't reorder!) */
5993 .vendor = PCI_VENDOR_ID_LENOVO,
5994 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5997 { /* IBM ThinkPads with no EC version string */
5998 .vendor = PCI_VENDOR_ID_IBM,
5999 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
6002 { /* IBM ThinkPads with EC version string */
6003 .vendor = PCI_VENDOR_ID_IBM,
6004 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
6009 static enum led_access_mode __init led_init_detect_mode(void)
6013 if (tpacpi_is_ibm()) {
6015 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
6016 if (ACPI_SUCCESS(status))
6017 return TPACPI_LED_570;
6019 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
6020 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
6021 if (ACPI_SUCCESS(status))
6022 return TPACPI_LED_OLD;
6026 status = acpi_get_handle(ec_handle, "LED", &led_handle);
6027 if (ACPI_SUCCESS(status))
6028 return TPACPI_LED_NEW;
6030 /* R30, R31, and unknown firmwares */
6032 return TPACPI_LED_NONE;
6035 static int __init led_init(struct ibm_init_struct *iibm)
6039 unsigned long useful_leds;
6041 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
6043 led_supported = led_init_detect_mode();
6045 if (led_supported != TPACPI_LED_NONE) {
6046 useful_leds = tpacpi_check_quirks(led_useful_qtable,
6047 ARRAY_SIZE(led_useful_qtable));
6051 led_supported = TPACPI_LED_NONE;
6055 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
6056 str_supported(led_supported), led_supported);
6058 if (led_supported == TPACPI_LED_NONE)
6061 tpacpi_leds = kcalloc(TPACPI_LED_NUMLEDS, sizeof(*tpacpi_leds),
6064 pr_err("Out of memory for LED data\n");
6068 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
6069 tpacpi_leds[i].led = -1;
6071 if (!tpacpi_is_led_restricted(i) && test_bit(i, &useful_leds)) {
6072 rc = tpacpi_init_led(i);
6080 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
6081 pr_notice("warning: userspace override of important firmware LEDs is enabled\n");
6086 #define str_led_status(s) \
6087 ((s) == TPACPI_LED_OFF ? "off" : \
6088 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
6090 static int led_read(struct seq_file *m)
6092 if (!led_supported) {
6093 seq_printf(m, "status:\t\tnot supported\n");
6096 seq_printf(m, "status:\t\tsupported\n");
6098 if (led_supported == TPACPI_LED_570) {
6101 for (i = 0; i < 8; i++) {
6102 status = led_get_status(i);
6105 seq_printf(m, "%d:\t\t%s\n",
6106 i, str_led_status(status));
6110 seq_printf(m, "commands:\t<led> on, <led> off, <led> blink (<led> is 0-15)\n");
6115 static int led_write(char *buf)
6119 enum led_status_t s;
6124 while ((cmd = strsep(&buf, ","))) {
6125 if (sscanf(cmd, "%d", &led) != 1)
6128 if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1))
6131 if (tpacpi_leds[led].led < 0)
6134 if (strstr(cmd, "off")) {
6136 } else if (strstr(cmd, "on")) {
6138 } else if (strstr(cmd, "blink")) {
6139 s = TPACPI_LED_BLINK;
6144 rc = led_set_status(led, s);
6152 static struct ibm_struct led_driver_data = {
6159 /*************************************************************************
6163 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
6165 #define TPACPI_BEEP_Q1 0x0001
6167 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
6168 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
6169 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
6172 static int __init beep_init(struct ibm_init_struct *iibm)
6174 unsigned long quirks;
6176 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
6178 TPACPI_ACPIHANDLE_INIT(beep);
6180 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
6181 str_supported(beep_handle != NULL));
6183 quirks = tpacpi_check_quirks(beep_quirk_table,
6184 ARRAY_SIZE(beep_quirk_table));
6186 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
6188 return (beep_handle) ? 0 : -ENODEV;
6191 static int beep_read(struct seq_file *m)
6194 seq_printf(m, "status:\t\tnot supported\n");
6196 seq_printf(m, "status:\t\tsupported\n");
6197 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
6203 static int beep_write(char *buf)
6211 while ((cmd = strsep(&buf, ","))) {
6212 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
6213 beep_cmd >= 0 && beep_cmd <= 17) {
6217 if (tp_features.beep_needs_two_args) {
6218 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
6222 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
6231 static struct ibm_struct beep_driver_data = {
6234 .write = beep_write,
6237 /*************************************************************************
6241 enum thermal_access_mode {
6242 TPACPI_THERMAL_NONE = 0, /* No thermal support */
6243 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
6244 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
6245 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
6246 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
6249 enum { /* TPACPI_THERMAL_TPEC_* */
6250 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
6251 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
6252 TP_EC_FUNCREV = 0xEF, /* ACPI EC Functional revision */
6253 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
6255 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
6259 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
6260 struct ibm_thermal_sensors_struct {
6261 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
6264 static enum thermal_access_mode thermal_read_mode;
6265 static bool thermal_use_labels;
6267 /* idx is zero-based */
6268 static int thermal_get_sensor(int idx, s32 *value)
6274 t = TP_EC_THERMAL_TMP0;
6276 switch (thermal_read_mode) {
6277 #if TPACPI_MAX_THERMAL_SENSORS >= 16
6278 case TPACPI_THERMAL_TPEC_16:
6279 if (idx >= 8 && idx <= 15) {
6280 t = TP_EC_THERMAL_TMP8;
6285 case TPACPI_THERMAL_TPEC_8:
6287 if (!acpi_ec_read(t + idx, &tmp))
6289 *value = tmp * 1000;
6294 case TPACPI_THERMAL_ACPI_UPDT:
6296 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6297 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
6299 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6301 *value = (t - 2732) * 100;
6306 case TPACPI_THERMAL_ACPI_TMP07:
6308 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6309 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6311 if (t > 127 || t < -127)
6312 t = TP_EC_THERMAL_TMP_NA;
6318 case TPACPI_THERMAL_NONE:
6326 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
6337 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
6340 for (i = 0 ; i < n; i++) {
6341 res = thermal_get_sensor(i, &s->temp[i]);
6349 static void thermal_dump_all_sensors(void)
6352 struct ibm_thermal_sensors_struct t;
6354 n = thermal_get_sensors(&t);
6358 pr_notice("temperatures (Celsius):");
6360 for (i = 0; i < n; i++) {
6361 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
6362 pr_cont(" %d", (int)(t.temp[i] / 1000));
6370 /* sysfs temp##_input -------------------------------------------------- */
6372 static ssize_t thermal_temp_input_show(struct device *dev,
6373 struct device_attribute *attr,
6376 struct sensor_device_attribute *sensor_attr =
6377 to_sensor_dev_attr(attr);
6378 int idx = sensor_attr->index;
6382 res = thermal_get_sensor(idx, &value);
6385 if (value == TPACPI_THERMAL_SENSOR_NA)
6388 return sysfs_emit(buf, "%d\n", value);
6391 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
6392 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
6393 thermal_temp_input_show, NULL, _idxB)
6395 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
6396 THERMAL_SENSOR_ATTR_TEMP(1, 0),
6397 THERMAL_SENSOR_ATTR_TEMP(2, 1),
6398 THERMAL_SENSOR_ATTR_TEMP(3, 2),
6399 THERMAL_SENSOR_ATTR_TEMP(4, 3),
6400 THERMAL_SENSOR_ATTR_TEMP(5, 4),
6401 THERMAL_SENSOR_ATTR_TEMP(6, 5),
6402 THERMAL_SENSOR_ATTR_TEMP(7, 6),
6403 THERMAL_SENSOR_ATTR_TEMP(8, 7),
6404 THERMAL_SENSOR_ATTR_TEMP(9, 8),
6405 THERMAL_SENSOR_ATTR_TEMP(10, 9),
6406 THERMAL_SENSOR_ATTR_TEMP(11, 10),
6407 THERMAL_SENSOR_ATTR_TEMP(12, 11),
6408 THERMAL_SENSOR_ATTR_TEMP(13, 12),
6409 THERMAL_SENSOR_ATTR_TEMP(14, 13),
6410 THERMAL_SENSOR_ATTR_TEMP(15, 14),
6411 THERMAL_SENSOR_ATTR_TEMP(16, 15),
6414 #define THERMAL_ATTRS(X) \
6415 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
6417 static struct attribute *thermal_temp_input_attr[] = {
6437 static umode_t thermal_attr_is_visible(struct kobject *kobj,
6438 struct attribute *attr, int n)
6440 if (thermal_read_mode == TPACPI_THERMAL_NONE)
6443 if (attr == THERMAL_ATTRS(8) || attr == THERMAL_ATTRS(9) ||
6444 attr == THERMAL_ATTRS(10) || attr == THERMAL_ATTRS(11) ||
6445 attr == THERMAL_ATTRS(12) || attr == THERMAL_ATTRS(13) ||
6446 attr == THERMAL_ATTRS(14) || attr == THERMAL_ATTRS(15)) {
6447 if (thermal_read_mode != TPACPI_THERMAL_TPEC_16)
6454 static const struct attribute_group thermal_attr_group = {
6455 .is_visible = thermal_attr_is_visible,
6456 .attrs = thermal_temp_input_attr,
6459 #undef THERMAL_SENSOR_ATTR_TEMP
6460 #undef THERMAL_ATTRS
6462 static ssize_t temp1_label_show(struct device *dev, struct device_attribute *attr, char *buf)
6464 return sysfs_emit(buf, "CPU\n");
6466 static DEVICE_ATTR_RO(temp1_label);
6468 static ssize_t temp2_label_show(struct device *dev, struct device_attribute *attr, char *buf)
6470 return sysfs_emit(buf, "GPU\n");
6472 static DEVICE_ATTR_RO(temp2_label);
6474 static struct attribute *temp_label_attributes[] = {
6475 &dev_attr_temp1_label.attr,
6476 &dev_attr_temp2_label.attr,
6480 static umode_t temp_label_attr_is_visible(struct kobject *kobj,
6481 struct attribute *attr, int n)
6483 return thermal_use_labels ? attr->mode : 0;
6486 static const struct attribute_group temp_label_attr_group = {
6487 .is_visible = temp_label_attr_is_visible,
6488 .attrs = temp_label_attributes,
6491 /* --------------------------------------------------------------------- */
6493 static int __init thermal_init(struct ibm_init_struct *iibm)
6495 u8 t, ta1, ta2, ver = 0;
6499 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
6501 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
6503 if (thinkpad_id.ec_model) {
6505 * Direct EC access mode: sensors at registers
6506 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
6507 * non-implemented, thermal sensors return 0x80 when
6509 * The above rule is unfortunately flawed. This has been seen with
6510 * 0xC2 (power supply ID) causing thermal control problems.
6511 * The EC version can be determined by offset 0xEF and at least for
6512 * version 3 the Lenovo firmware team confirmed that registers 0xC0-0xC7
6513 * are not thermal registers.
6515 if (!acpi_ec_read(TP_EC_FUNCREV, &ver))
6516 pr_warn("Thinkpad ACPI EC unable to access EC version\n");
6519 for (i = 0; i < 8; i++) {
6520 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
6527 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
6536 /* This is sheer paranoia, but we handle it anyway */
6538 pr_err("ThinkPad ACPI EC access misbehaving, falling back to ACPI TMPx access mode\n");
6539 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6541 pr_err("ThinkPad ACPI EC access misbehaving, disabling thermal sensors access\n");
6542 thermal_read_mode = TPACPI_THERMAL_NONE;
6546 thermal_read_mode = TPACPI_THERMAL_TPEC_8;
6547 thermal_use_labels = true;
6551 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
6554 } else if (acpi_tmp7) {
6555 if (tpacpi_is_ibm() &&
6556 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
6557 /* 600e/x, 770e, 770x */
6558 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
6560 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
6561 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6564 /* temperatures not supported on 570, G4x, R30, R31, R32 */
6565 thermal_read_mode = TPACPI_THERMAL_NONE;
6568 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
6569 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
6572 return thermal_read_mode != TPACPI_THERMAL_NONE ? 0 : -ENODEV;
6575 static int thermal_read(struct seq_file *m)
6578 struct ibm_thermal_sensors_struct t;
6580 n = thermal_get_sensors(&t);
6581 if (unlikely(n < 0))
6584 seq_printf(m, "temperatures:\t");
6587 for (i = 0; i < (n - 1); i++)
6588 seq_printf(m, "%d ", t.temp[i] / 1000);
6589 seq_printf(m, "%d\n", t.temp[i] / 1000);
6591 seq_printf(m, "not supported\n");
6596 static struct ibm_struct thermal_driver_data = {
6598 .read = thermal_read,
6601 /*************************************************************************
6602 * Backlight/brightness subdriver
6605 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
6608 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
6609 * CMOS NVRAM byte 0x5E, bits 0-3.
6611 * EC HBRV (0x31) has the following layout
6612 * Bit 7: unknown function
6613 * Bit 6: unknown function
6614 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
6615 * Bit 4: must be set to zero to avoid problems
6616 * Bit 3-0: backlight brightness level
6618 * brightness_get_raw returns status data in the HBRV layout
6620 * WARNING: The X61 has been verified to use HBRV for something else, so
6621 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
6622 * testing on the very early *60 Lenovo models...
6626 TP_EC_BACKLIGHT = 0x31,
6628 /* TP_EC_BACKLIGHT bitmasks */
6629 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6630 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6631 TP_EC_BACKLIGHT_MAPSW = 0x20,
6634 enum tpacpi_brightness_access_mode {
6635 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
6636 TPACPI_BRGHT_MODE_EC, /* EC control */
6637 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
6638 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6639 TPACPI_BRGHT_MODE_MAX
6642 static struct backlight_device *ibm_backlight_device;
6644 static enum tpacpi_brightness_access_mode brightness_mode =
6645 TPACPI_BRGHT_MODE_MAX;
6647 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6649 static struct mutex brightness_mutex;
6651 /* NVRAM brightness access,
6652 * call with brightness_mutex held! */
6653 static unsigned int tpacpi_brightness_nvram_get(void)
6657 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6658 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6659 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6660 lnvram &= bright_maxlvl;
6665 static void tpacpi_brightness_checkpoint_nvram(void)
6670 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6673 vdbg_printk(TPACPI_DBG_BRGHT,
6674 "trying to checkpoint backlight level to NVRAM...\n");
6676 if (mutex_lock_killable(&brightness_mutex) < 0)
6679 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6681 lec &= TP_EC_BACKLIGHT_LVLMSK;
6682 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6684 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6685 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6686 /* NVRAM needs update */
6687 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6688 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6690 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6691 dbg_printk(TPACPI_DBG_BRGHT,
6692 "updated NVRAM backlight level to %u (0x%02x)\n",
6693 (unsigned int) lec, (unsigned int) b_nvram);
6695 vdbg_printk(TPACPI_DBG_BRGHT,
6696 "NVRAM backlight level already is %u (0x%02x)\n",
6697 (unsigned int) lec, (unsigned int) b_nvram);
6700 mutex_unlock(&brightness_mutex);
6704 /* call with brightness_mutex held! */
6705 static int tpacpi_brightness_get_raw(int *status)
6709 switch (brightness_mode) {
6710 case TPACPI_BRGHT_MODE_UCMS_STEP:
6711 *status = tpacpi_brightness_nvram_get();
6713 case TPACPI_BRGHT_MODE_EC:
6714 case TPACPI_BRGHT_MODE_ECNVRAM:
6715 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6724 /* call with brightness_mutex held! */
6725 /* do NOT call with illegal backlight level value */
6726 static int tpacpi_brightness_set_ec(unsigned int value)
6730 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6733 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6734 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6735 (value & TP_EC_BACKLIGHT_LVLMSK))))
6741 /* call with brightness_mutex held! */
6742 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6745 unsigned int current_value, i;
6747 current_value = tpacpi_brightness_nvram_get();
6749 if (value == current_value)
6752 cmos_cmd = (value > current_value) ?
6753 TP_CMOS_BRIGHTNESS_UP :
6754 TP_CMOS_BRIGHTNESS_DOWN;
6755 inc = (value > current_value) ? 1 : -1;
6757 for (i = current_value; i != value; i += inc)
6758 if (issue_thinkpad_cmos_command(cmos_cmd))
6764 /* May return EINTR which can always be mapped to ERESTARTSYS */
6765 static int brightness_set(unsigned int value)
6769 if (value > bright_maxlvl)
6772 vdbg_printk(TPACPI_DBG_BRGHT,
6773 "set backlight level to %d\n", value);
6775 res = mutex_lock_killable(&brightness_mutex);
6779 switch (brightness_mode) {
6780 case TPACPI_BRGHT_MODE_EC:
6781 case TPACPI_BRGHT_MODE_ECNVRAM:
6782 res = tpacpi_brightness_set_ec(value);
6784 case TPACPI_BRGHT_MODE_UCMS_STEP:
6785 res = tpacpi_brightness_set_ucmsstep(value);
6791 mutex_unlock(&brightness_mutex);
6795 /* sysfs backlight class ----------------------------------------------- */
6797 static int brightness_update_status(struct backlight_device *bd)
6799 unsigned int level =
6800 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6801 bd->props.power == FB_BLANK_UNBLANK) ?
6802 bd->props.brightness : 0;
6804 dbg_printk(TPACPI_DBG_BRGHT,
6805 "backlight: attempt to set level to %d\n",
6808 /* it is the backlight class's job (caller) to handle
6809 * EINTR and other errors properly */
6810 return brightness_set(level);
6813 static int brightness_get(struct backlight_device *bd)
6817 res = mutex_lock_killable(&brightness_mutex);
6821 res = tpacpi_brightness_get_raw(&status);
6823 mutex_unlock(&brightness_mutex);
6828 return status & TP_EC_BACKLIGHT_LVLMSK;
6831 static void tpacpi_brightness_notify_change(void)
6833 backlight_force_update(ibm_backlight_device,
6834 BACKLIGHT_UPDATE_HOTKEY);
6837 static const struct backlight_ops ibm_backlight_data = {
6838 .get_brightness = brightness_get,
6839 .update_status = brightness_update_status,
6842 /* --------------------------------------------------------------------- */
6845 * Call _BCL method of video device. On some ThinkPads this will
6846 * switch the firmware to the ACPI brightness control mode.
6849 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6851 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6852 union acpi_object *obj;
6853 struct acpi_device *device, *child;
6856 device = acpi_fetch_acpi_dev(handle);
6861 list_for_each_entry(child, &device->children, node) {
6862 acpi_status status = acpi_evaluate_object(child->handle, "_BCL",
6864 if (ACPI_FAILURE(status)) {
6865 buffer.length = ACPI_ALLOCATE_BUFFER;
6869 obj = (union acpi_object *)buffer.pointer;
6870 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6871 pr_err("Unknown _BCL data, please report this to %s\n",
6875 rc = obj->package.count;
6880 kfree(buffer.pointer);
6886 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6888 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6890 acpi_handle video_device;
6893 tpacpi_acpi_handle_locate("video", NULL, &video_device);
6895 bcl_levels = tpacpi_query_bcl_levels(video_device);
6897 tp_features.bright_acpimode = (bcl_levels > 0);
6899 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6903 * These are only useful for models that have only one possibility
6904 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6907 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6908 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6909 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6911 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6912 /* Models with ATI GPUs known to require ECNVRAM mode */
6913 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6915 /* Models with ATI GPUs that can use ECNVRAM */
6916 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6917 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6918 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6919 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6921 /* Models with Intel Extreme Graphics 2 */
6922 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6923 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6924 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6926 /* Models with Intel GMA900 */
6927 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6928 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6929 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6933 * Returns < 0 for error, otherwise sets tp_features.bright_*
6934 * and bright_maxlvl.
6936 static void __init tpacpi_detect_brightness_capabilities(void)
6940 vdbg_printk(TPACPI_DBG_INIT,
6941 "detecting firmware brightness interface capabilities\n");
6943 /* we could run a quirks check here (same table used by
6944 * brightness_init) if needed */
6947 * We always attempt to detect acpi support, so as to switch
6948 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6949 * going to publish a backlight interface
6951 b = tpacpi_check_std_acpi_brightness_support();
6961 tp_features.bright_unkfw = 1;
6962 bright_maxlvl = b - 1;
6964 pr_debug("detected %u brightness levels\n", bright_maxlvl + 1);
6967 static int __init brightness_init(struct ibm_init_struct *iibm)
6969 struct backlight_properties props;
6971 unsigned long quirks;
6973 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6975 mutex_init(&brightness_mutex);
6977 quirks = tpacpi_check_quirks(brightness_quirk_table,
6978 ARRAY_SIZE(brightness_quirk_table));
6980 /* tpacpi_detect_brightness_capabilities() must have run already */
6982 /* if it is unknown, we don't handle it: it wouldn't be safe */
6983 if (tp_features.bright_unkfw)
6986 if (!brightness_enable) {
6987 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6988 "brightness support disabled by module parameter\n");
6992 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
6993 if (brightness_enable > 1) {
6994 pr_info("Standard ACPI backlight interface available, not loading native one\n");
6996 } else if (brightness_enable == 1) {
6997 pr_warn("Cannot enable backlight brightness support, ACPI is already handling it. Refer to the acpi_backlight kernel parameter.\n");
7000 } else if (!tp_features.bright_acpimode) {
7001 pr_notice("ACPI backlight interface not available\n");
7005 pr_notice("ACPI native brightness control enabled\n");
7008 * Check for module parameter bogosity, note that we
7009 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
7010 * able to detect "unspecified"
7012 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
7015 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
7016 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
7017 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
7018 if (quirks & TPACPI_BRGHT_Q_EC)
7019 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
7021 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
7023 dbg_printk(TPACPI_DBG_BRGHT,
7024 "driver auto-selected brightness_mode=%d\n",
7029 if (!tpacpi_is_ibm() &&
7030 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
7031 brightness_mode == TPACPI_BRGHT_MODE_EC))
7034 if (tpacpi_brightness_get_raw(&b) < 0)
7037 memset(&props, 0, sizeof(struct backlight_properties));
7038 props.type = BACKLIGHT_PLATFORM;
7039 props.max_brightness = bright_maxlvl;
7040 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
7041 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
7043 &ibm_backlight_data,
7045 if (IS_ERR(ibm_backlight_device)) {
7046 int rc = PTR_ERR(ibm_backlight_device);
7047 ibm_backlight_device = NULL;
7048 pr_err("Could not register backlight device\n");
7051 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
7052 "brightness is supported\n");
7054 if (quirks & TPACPI_BRGHT_Q_ASK) {
7055 pr_notice("brightness: will use unverified default: brightness_mode=%d\n",
7057 pr_notice("brightness: please report to %s whether it works well or not on your ThinkPad\n",
7061 /* Added by mistake in early 2007. Probably useless, but it could
7062 * be working around some unknown firmware problem where the value
7063 * read at startup doesn't match the real hardware state... so leave
7064 * it in place just in case */
7065 backlight_update_status(ibm_backlight_device);
7067 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
7068 "brightness: registering brightness hotkeys as change notification\n");
7069 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7070 | TP_ACPI_HKEY_BRGHTUP_MASK
7071 | TP_ACPI_HKEY_BRGHTDWN_MASK);
7075 static void brightness_suspend(void)
7077 tpacpi_brightness_checkpoint_nvram();
7080 static void brightness_shutdown(void)
7082 tpacpi_brightness_checkpoint_nvram();
7085 static void brightness_exit(void)
7087 if (ibm_backlight_device) {
7088 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
7089 "calling backlight_device_unregister()\n");
7090 backlight_device_unregister(ibm_backlight_device);
7093 tpacpi_brightness_checkpoint_nvram();
7096 static int brightness_read(struct seq_file *m)
7100 level = brightness_get(NULL);
7102 seq_printf(m, "level:\t\tunreadable\n");
7104 seq_printf(m, "level:\t\t%d\n", level);
7105 seq_printf(m, "commands:\tup, down\n");
7106 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7113 static int brightness_write(char *buf)
7119 level = brightness_get(NULL);
7123 while ((cmd = strsep(&buf, ","))) {
7124 if (strlencmp(cmd, "up") == 0) {
7125 if (level < bright_maxlvl)
7127 } else if (strlencmp(cmd, "down") == 0) {
7130 } else if (sscanf(cmd, "level %d", &level) == 1 &&
7131 level >= 0 && level <= bright_maxlvl) {
7137 tpacpi_disclose_usertask("procfs brightness",
7138 "set level to %d\n", level);
7141 * Now we know what the final level should be, so we try to set it.
7142 * Doing it this way makes the syscall restartable in case of EINTR
7144 rc = brightness_set(level);
7145 if (!rc && ibm_backlight_device)
7146 backlight_force_update(ibm_backlight_device,
7147 BACKLIGHT_UPDATE_SYSFS);
7148 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7151 static struct ibm_struct brightness_driver_data = {
7152 .name = "brightness",
7153 .read = brightness_read,
7154 .write = brightness_write,
7155 .exit = brightness_exit,
7156 .suspend = brightness_suspend,
7157 .shutdown = brightness_shutdown,
7160 /*************************************************************************
7165 * IBM ThinkPads have a simple volume controller with MUTE gating.
7166 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
7168 * Since the *61 series (and probably also the later *60 series), Lenovo
7169 * ThinkPads only implement the MUTE gate.
7172 * Bit 6: MUTE (1 mutes sound)
7174 * Other bits should be zero as far as we know.
7176 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
7177 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
7178 * such as bit 7 which is used to detect repeated presses of MUTE,
7179 * and we leave them unchanged.
7181 * On newer Lenovo ThinkPads, the EC can automatically change the volume
7182 * in response to user input. Unfortunately, this rarely works well.
7183 * The laptop changes the state of its internal MUTE gate and, on some
7184 * models, sends KEY_MUTE, causing any user code that responds to the
7185 * mute button to get confused. The hardware MUTE gate is also
7186 * unnecessary, since user code can handle the mute button without
7187 * kernel or EC help.
7189 * To avoid confusing userspace, we simply disable all EC-based mute
7190 * and volume controls when possible.
7193 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
7195 #define TPACPI_ALSA_DRVNAME "ThinkPad EC"
7196 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
7197 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
7199 #if SNDRV_CARDS <= 32
7200 #define DEFAULT_ALSA_IDX ~((1 << (SNDRV_CARDS - 3)) - 1)
7202 #define DEFAULT_ALSA_IDX ~((1 << (32 - 3)) - 1)
7204 static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
7205 static char *alsa_id = "ThinkPadEC";
7206 static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
7208 struct tpacpi_alsa_data {
7209 struct snd_card *card;
7210 struct snd_ctl_elem_id *ctl_mute_id;
7211 struct snd_ctl_elem_id *ctl_vol_id;
7214 static struct snd_card *alsa_card;
7219 /* TP_EC_AUDIO bits */
7220 TP_EC_AUDIO_MUTESW = 6,
7222 /* TP_EC_AUDIO bitmasks */
7223 TP_EC_AUDIO_LVL_MSK = 0x0F,
7224 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
7226 /* Maximum volume */
7227 TP_EC_VOLUME_MAX = 14,
7230 enum tpacpi_volume_access_mode {
7231 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
7232 TPACPI_VOL_MODE_EC, /* Pure EC control */
7233 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
7234 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
7238 enum tpacpi_volume_capabilities {
7239 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
7240 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
7241 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
7245 enum tpacpi_mute_btn_mode {
7246 TP_EC_MUTE_BTN_LATCH = 0, /* Mute mutes; up/down unmutes */
7247 /* We don't know what mode 1 is. */
7248 TP_EC_MUTE_BTN_NONE = 2, /* Mute and up/down are just keys */
7249 TP_EC_MUTE_BTN_TOGGLE = 3, /* Mute toggles; up/down unmutes */
7252 static enum tpacpi_volume_access_mode volume_mode =
7253 TPACPI_VOL_MODE_MAX;
7255 static enum tpacpi_volume_capabilities volume_capabilities;
7256 static bool volume_control_allowed;
7257 static bool software_mute_requested = true;
7258 static bool software_mute_active;
7259 static int software_mute_orig_mode;
7262 * Used to syncronize writers to TP_EC_AUDIO and
7263 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
7265 static struct mutex volume_mutex;
7267 static void tpacpi_volume_checkpoint_nvram(void)
7273 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
7275 if (!volume_control_allowed)
7277 if (software_mute_active)
7280 vdbg_printk(TPACPI_DBG_MIXER,
7281 "trying to checkpoint mixer state to NVRAM...\n");
7283 if (tp_features.mixer_no_level_control)
7284 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
7286 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
7288 if (mutex_lock_killable(&volume_mutex) < 0)
7291 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
7294 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
7296 if (lec != (b_nvram & ec_mask)) {
7297 /* NVRAM needs update */
7298 b_nvram &= ~ec_mask;
7300 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
7301 dbg_printk(TPACPI_DBG_MIXER,
7302 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
7303 (unsigned int) lec, (unsigned int) b_nvram);
7305 vdbg_printk(TPACPI_DBG_MIXER,
7306 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
7307 (unsigned int) lec, (unsigned int) b_nvram);
7311 mutex_unlock(&volume_mutex);
7314 static int volume_get_status_ec(u8 *status)
7318 if (!acpi_ec_read(TP_EC_AUDIO, &s))
7323 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
7328 static int volume_get_status(u8 *status)
7330 return volume_get_status_ec(status);
7333 static int volume_set_status_ec(const u8 status)
7335 if (!acpi_ec_write(TP_EC_AUDIO, status))
7338 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
7341 * On X200s, and possibly on others, it can take a while for
7342 * reads to become correct.
7349 static int volume_set_status(const u8 status)
7351 return volume_set_status_ec(status);
7354 /* returns < 0 on error, 0 on no change, 1 on change */
7355 static int __volume_set_mute_ec(const bool mute)
7360 if (mutex_lock_killable(&volume_mutex) < 0)
7363 rc = volume_get_status_ec(&s);
7367 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
7368 s & ~TP_EC_AUDIO_MUTESW_MSK;
7371 rc = volume_set_status_ec(n);
7377 mutex_unlock(&volume_mutex);
7381 static int volume_alsa_set_mute(const bool mute)
7383 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
7384 (mute) ? "" : "un");
7385 return __volume_set_mute_ec(mute);
7388 static int volume_set_mute(const bool mute)
7392 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
7393 (mute) ? "" : "un");
7395 rc = __volume_set_mute_ec(mute);
7396 return (rc < 0) ? rc : 0;
7399 /* returns < 0 on error, 0 on no change, 1 on change */
7400 static int __volume_set_volume_ec(const u8 vol)
7405 if (vol > TP_EC_VOLUME_MAX)
7408 if (mutex_lock_killable(&volume_mutex) < 0)
7411 rc = volume_get_status_ec(&s);
7415 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
7418 rc = volume_set_status_ec(n);
7424 mutex_unlock(&volume_mutex);
7428 static int volume_set_software_mute(bool startup)
7432 if (!tpacpi_is_lenovo())
7436 if (!acpi_evalf(ec_handle, &software_mute_orig_mode,
7440 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7441 "Initial HAUM setting was %d\n",
7442 software_mute_orig_mode);
7445 if (!acpi_evalf(ec_handle, &result, "SAUM", "qdd",
7446 (int)TP_EC_MUTE_BTN_NONE))
7449 if (result != TP_EC_MUTE_BTN_NONE)
7450 pr_warn("Unexpected SAUM result %d\n",
7454 * In software mute mode, the standard codec controls take
7455 * precendence, so we unmute the ThinkPad HW switch at
7456 * startup. Just on case there are SAUM-capable ThinkPads
7457 * with level controls, set max HW volume as well.
7459 if (tp_features.mixer_no_level_control)
7460 result = volume_set_mute(false);
7462 result = volume_set_status(TP_EC_VOLUME_MAX);
7465 pr_warn("Failed to unmute the HW mute switch\n");
7470 static void volume_exit_software_mute(void)
7474 if (!acpi_evalf(ec_handle, &r, "SAUM", "qdd", software_mute_orig_mode)
7475 || r != software_mute_orig_mode)
7476 pr_warn("Failed to restore mute mode\n");
7479 static int volume_alsa_set_volume(const u8 vol)
7481 dbg_printk(TPACPI_DBG_MIXER,
7482 "ALSA: trying to set volume level to %hu\n", vol);
7483 return __volume_set_volume_ec(vol);
7486 static void volume_alsa_notify_change(void)
7488 struct tpacpi_alsa_data *d;
7490 if (alsa_card && alsa_card->private_data) {
7491 d = alsa_card->private_data;
7493 snd_ctl_notify(alsa_card,
7494 SNDRV_CTL_EVENT_MASK_VALUE,
7497 snd_ctl_notify(alsa_card,
7498 SNDRV_CTL_EVENT_MASK_VALUE,
7503 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
7504 struct snd_ctl_elem_info *uinfo)
7506 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
7508 uinfo->value.integer.min = 0;
7509 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
7513 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
7514 struct snd_ctl_elem_value *ucontrol)
7519 rc = volume_get_status(&s);
7523 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
7527 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
7528 struct snd_ctl_elem_value *ucontrol)
7530 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
7531 ucontrol->value.integer.value[0]);
7532 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
7535 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
7537 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
7538 struct snd_ctl_elem_value *ucontrol)
7543 rc = volume_get_status(&s);
7547 ucontrol->value.integer.value[0] =
7548 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
7552 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
7553 struct snd_ctl_elem_value *ucontrol)
7555 tpacpi_disclose_usertask("ALSA", "%smute\n",
7556 ucontrol->value.integer.value[0] ?
7558 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
7561 static struct snd_kcontrol_new volume_alsa_control_vol __initdata = {
7562 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7563 .name = "Console Playback Volume",
7565 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7566 .info = volume_alsa_vol_info,
7567 .get = volume_alsa_vol_get,
7570 static struct snd_kcontrol_new volume_alsa_control_mute __initdata = {
7571 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7572 .name = "Console Playback Switch",
7574 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7575 .info = volume_alsa_mute_info,
7576 .get = volume_alsa_mute_get,
7579 static void volume_suspend(void)
7581 tpacpi_volume_checkpoint_nvram();
7584 static void volume_resume(void)
7586 if (software_mute_active) {
7587 if (volume_set_software_mute(false) < 0)
7588 pr_warn("Failed to restore software mute\n");
7590 volume_alsa_notify_change();
7594 static void volume_shutdown(void)
7596 tpacpi_volume_checkpoint_nvram();
7599 static void volume_exit(void)
7602 snd_card_free(alsa_card);
7606 tpacpi_volume_checkpoint_nvram();
7608 if (software_mute_active)
7609 volume_exit_software_mute();
7612 static int __init volume_create_alsa_mixer(void)
7614 struct snd_card *card;
7615 struct tpacpi_alsa_data *data;
7616 struct snd_kcontrol *ctl_vol;
7617 struct snd_kcontrol *ctl_mute;
7620 rc = snd_card_new(&tpacpi_pdev->dev,
7621 alsa_index, alsa_id, THIS_MODULE,
7622 sizeof(struct tpacpi_alsa_data), &card);
7623 if (rc < 0 || !card) {
7624 pr_err("Failed to create ALSA card structures: %d\n", rc);
7628 BUG_ON(!card->private_data);
7629 data = card->private_data;
7632 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
7633 sizeof(card->driver));
7634 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
7635 sizeof(card->shortname));
7636 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
7637 (thinkpad_id.ec_version_str) ?
7638 thinkpad_id.ec_version_str : "(unknown)");
7639 snprintf(card->longname, sizeof(card->longname),
7640 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
7641 (thinkpad_id.ec_version_str) ?
7642 thinkpad_id.ec_version_str : "unknown");
7644 if (volume_control_allowed) {
7645 volume_alsa_control_vol.put = volume_alsa_vol_put;
7646 volume_alsa_control_vol.access =
7647 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7649 volume_alsa_control_mute.put = volume_alsa_mute_put;
7650 volume_alsa_control_mute.access =
7651 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7654 if (!tp_features.mixer_no_level_control) {
7655 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
7656 rc = snd_ctl_add(card, ctl_vol);
7658 pr_err("Failed to create ALSA volume control: %d\n",
7662 data->ctl_vol_id = &ctl_vol->id;
7665 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
7666 rc = snd_ctl_add(card, ctl_mute);
7668 pr_err("Failed to create ALSA mute control: %d\n", rc);
7671 data->ctl_mute_id = &ctl_mute->id;
7673 rc = snd_card_register(card);
7675 pr_err("Failed to register ALSA card: %d\n", rc);
7683 snd_card_free(card);
7687 #define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
7688 #define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
7690 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
7691 /* Whitelist volume level on all IBM by default */
7692 { .vendor = PCI_VENDOR_ID_IBM,
7693 .bios = TPACPI_MATCH_ANY,
7694 .ec = TPACPI_MATCH_ANY,
7695 .quirks = TPACPI_VOL_Q_LEVEL },
7697 /* Lenovo models with volume control (needs confirmation) */
7698 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
7699 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
7700 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
7701 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
7702 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
7703 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
7704 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
7706 /* Whitelist mute-only on all Lenovo by default */
7707 { .vendor = PCI_VENDOR_ID_LENOVO,
7708 .bios = TPACPI_MATCH_ANY,
7709 .ec = TPACPI_MATCH_ANY,
7710 .quirks = TPACPI_VOL_Q_MUTEONLY }
7713 static int __init volume_init(struct ibm_init_struct *iibm)
7715 unsigned long quirks;
7718 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7720 mutex_init(&volume_mutex);
7723 * Check for module parameter bogosity, note that we
7724 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7725 * able to detect "unspecified"
7727 if (volume_mode > TPACPI_VOL_MODE_MAX)
7730 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7731 pr_err("UCMS step volume mode not implemented, please contact %s\n",
7736 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7740 * The ALSA mixer is our primary interface.
7741 * When disabled, don't install the subdriver at all
7744 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7745 "ALSA mixer disabled by parameter, not loading volume subdriver...\n");
7749 quirks = tpacpi_check_quirks(volume_quirk_table,
7750 ARRAY_SIZE(volume_quirk_table));
7752 switch (volume_capabilities) {
7753 case TPACPI_VOL_CAP_AUTO:
7754 if (quirks & TPACPI_VOL_Q_MUTEONLY)
7755 tp_features.mixer_no_level_control = 1;
7756 else if (quirks & TPACPI_VOL_Q_LEVEL)
7757 tp_features.mixer_no_level_control = 0;
7759 return -ENODEV; /* no mixer */
7761 case TPACPI_VOL_CAP_VOLMUTE:
7762 tp_features.mixer_no_level_control = 0;
7764 case TPACPI_VOL_CAP_MUTEONLY:
7765 tp_features.mixer_no_level_control = 1;
7771 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7772 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7773 "using user-supplied volume_capabilities=%d\n",
7774 volume_capabilities);
7776 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7777 volume_mode == TPACPI_VOL_MODE_MAX) {
7778 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7780 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7781 "driver auto-selected volume_mode=%d\n",
7784 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7785 "using user-supplied volume_mode=%d\n",
7789 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7790 "mute is supported, volume control is %s\n",
7791 str_supported(!tp_features.mixer_no_level_control));
7793 if (software_mute_requested && volume_set_software_mute(true) == 0) {
7794 software_mute_active = true;
7796 rc = volume_create_alsa_mixer();
7798 pr_err("Could not create the ALSA mixer interface\n");
7802 pr_info("Console audio control enabled, mode: %s\n",
7803 (volume_control_allowed) ?
7804 "override (read/write)" :
7805 "monitor (read only)");
7808 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7809 "registering volume hotkeys as change notification\n");
7810 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7811 | TP_ACPI_HKEY_VOLUP_MASK
7812 | TP_ACPI_HKEY_VOLDWN_MASK
7813 | TP_ACPI_HKEY_MUTE_MASK);
7818 static int volume_read(struct seq_file *m)
7822 if (volume_get_status(&status) < 0) {
7823 seq_printf(m, "level:\t\tunreadable\n");
7825 if (tp_features.mixer_no_level_control)
7826 seq_printf(m, "level:\t\tunsupported\n");
7828 seq_printf(m, "level:\t\t%d\n",
7829 status & TP_EC_AUDIO_LVL_MSK);
7831 seq_printf(m, "mute:\t\t%s\n",
7832 onoff(status, TP_EC_AUDIO_MUTESW));
7834 if (volume_control_allowed) {
7835 seq_printf(m, "commands:\tunmute, mute\n");
7836 if (!tp_features.mixer_no_level_control) {
7837 seq_printf(m, "commands:\tup, down\n");
7838 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7847 static int volume_write(char *buf)
7850 u8 new_level, new_mute;
7856 * We do allow volume control at driver startup, so that the
7857 * user can set initial state through the volume=... parameter hack.
7859 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7860 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7861 tp_warned.volume_ctrl_forbidden = 1;
7862 pr_notice("Console audio control in monitor mode, changes are not allowed\n");
7863 pr_notice("Use the volume_control=1 module parameter to enable volume control\n");
7868 rc = volume_get_status(&s);
7872 new_level = s & TP_EC_AUDIO_LVL_MSK;
7873 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7875 while ((cmd = strsep(&buf, ","))) {
7876 if (!tp_features.mixer_no_level_control) {
7877 if (strlencmp(cmd, "up") == 0) {
7880 else if (new_level < TP_EC_VOLUME_MAX)
7883 } else if (strlencmp(cmd, "down") == 0) {
7886 else if (new_level > 0)
7889 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7890 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7895 if (strlencmp(cmd, "mute") == 0)
7896 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7897 else if (strlencmp(cmd, "unmute") == 0)
7903 if (tp_features.mixer_no_level_control) {
7904 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7905 new_mute ? "" : "un");
7906 rc = volume_set_mute(!!new_mute);
7908 tpacpi_disclose_usertask("procfs volume",
7909 "%smute and set level to %d\n",
7910 new_mute ? "" : "un", new_level);
7911 rc = volume_set_status(new_mute | new_level);
7913 volume_alsa_notify_change();
7915 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7918 static struct ibm_struct volume_driver_data = {
7920 .read = volume_read,
7921 .write = volume_write,
7922 .exit = volume_exit,
7923 .suspend = volume_suspend,
7924 .resume = volume_resume,
7925 .shutdown = volume_shutdown,
7928 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7930 #define alsa_card NULL
7932 static inline void volume_alsa_notify_change(void)
7936 static int __init volume_init(struct ibm_init_struct *iibm)
7938 pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7943 static struct ibm_struct volume_driver_data = {
7947 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7949 /*************************************************************************
7956 * TPACPI_FAN_RD_ACPI_GFAN:
7957 * ACPI GFAN method: returns fan level
7959 * see TPACPI_FAN_WR_ACPI_SFAN
7960 * EC 0x2f (HFSP) not available if GFAN exists
7962 * TPACPI_FAN_WR_ACPI_SFAN:
7963 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7965 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7968 * TPACPI_FAN_WR_TPEC:
7969 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7970 * Supported on almost all ThinkPads
7972 * Fan speed changes of any sort (including those caused by the
7973 * disengaged mode) are usually done slowly by the firmware as the
7974 * maximum amount of fan duty cycle change per second seems to be
7977 * Reading is not available if GFAN exists.
7978 * Writing is not available if SFAN exists.
7981 * 7 automatic mode engaged;
7982 * (default operation mode of the ThinkPad)
7983 * fan level is ignored in this mode.
7984 * 6 full speed mode (takes precedence over bit 7);
7985 * not available on all thinkpads. May disable
7986 * the tachometer while the fan controller ramps up
7987 * the speed (which can take up to a few *minutes*).
7988 * Speeds up fan to 100% duty-cycle, which is far above
7989 * the standard RPM levels. It is not impossible that
7990 * it could cause hardware damage.
7991 * 5-3 unused in some models. Extra bits for fan level
7992 * in others, but still useless as all values above
7993 * 7 map to the same speed as level 7 in these models.
7994 * 2-0 fan level (0..7 usually)
7996 * 0x07 = max (set when temperatures critical)
7997 * Some ThinkPads may have other levels, see
7998 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
8000 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
8001 * boot. Apparently the EC does not initialize it, so unless ACPI DSDT
8002 * does so, its initial value is meaningless (0x07).
8004 * For firmware bugs, refer to:
8005 * https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
8009 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
8010 * Main fan tachometer reading (in RPM)
8012 * This register is present on all ThinkPads with a new-style EC, and
8013 * it is known not to be present on the A21m/e, and T22, as there is
8014 * something else in offset 0x84 according to the ACPI DSDT. Other
8015 * ThinkPads from this same time period (and earlier) probably lack the
8016 * tachometer as well.
8018 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
8019 * was never fixed by IBM to report the EC firmware version string
8020 * probably support the tachometer (like the early X models), so
8021 * detecting it is quite hard. We need more data to know for sure.
8023 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
8026 * FIRMWARE BUG: may go stale while the EC is switching to full speed
8029 * For firmware bugs, refer to:
8030 * https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
8034 * ThinkPad EC register 0x31 bit 0 (only on select models)
8036 * When bit 0 of EC register 0x31 is zero, the tachometer registers
8037 * show the speed of the main fan. When bit 0 of EC register 0x31
8038 * is one, the tachometer registers show the speed of the auxiliary
8041 * Fan control seems to affect both fans, regardless of the state
8044 * So far, only the firmware for the X60/X61 non-tablet versions
8045 * seem to support this (firmware TP-7M).
8047 * TPACPI_FAN_WR_ACPI_FANS:
8048 * ThinkPad X31, X40, X41. Not available in the X60.
8050 * FANS ACPI handle: takes three arguments: low speed, medium speed,
8051 * high speed. ACPI DSDT seems to map these three speeds to levels
8052 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
8053 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
8055 * The speeds are stored on handles
8056 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
8058 * There are three default speed sets, accessible as handles:
8059 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
8061 * ACPI DSDT switches which set is in use depending on various
8064 * TPACPI_FAN_WR_TPEC is also available and should be used to
8065 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
8066 * but the ACPI tables just mention level 7.
8069 enum { /* Fan control constants */
8070 fan_status_offset = 0x2f, /* EC register 0x2f */
8071 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
8072 * 0x84 must be read before 0x85 */
8073 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
8074 bit 0 selects which fan is active */
8076 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
8077 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
8079 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
8082 enum fan_status_access_mode {
8083 TPACPI_FAN_NONE = 0, /* No fan status or control */
8084 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
8085 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
8088 enum fan_control_access_mode {
8089 TPACPI_FAN_WR_NONE = 0, /* No fan control */
8090 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
8091 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
8092 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
8095 enum fan_control_commands {
8096 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
8097 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
8098 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
8099 * and also watchdog cmd */
8102 static bool fan_control_allowed;
8104 static enum fan_status_access_mode fan_status_access_mode;
8105 static enum fan_control_access_mode fan_control_access_mode;
8106 static enum fan_control_commands fan_control_commands;
8108 static u8 fan_control_initial_status;
8109 static u8 fan_control_desired_level;
8110 static u8 fan_control_resume_level;
8111 static int fan_watchdog_maxinterval;
8113 static struct mutex fan_mutex;
8115 static void fan_watchdog_fire(struct work_struct *ignored);
8116 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
8118 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
8119 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
8120 "\\FSPD", /* 600e/x, 770e, 770x */
8122 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
8123 "JFNS", /* 770x-JL */
8127 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
8128 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
8129 * be in auto mode (0x80).
8131 * This is corrected by any write to HFSP either by the driver, or
8134 * We assume 0x07 really means auto mode while this quirk is active,
8135 * as this is far more likely than the ThinkPad being in level 7,
8136 * which is only used by the firmware during thermal emergencies.
8138 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
8139 * TP-70 (T43, R52), which are known to be buggy.
8142 static void fan_quirk1_setup(void)
8144 if (fan_control_initial_status == 0x07) {
8145 pr_notice("fan_init: initial fan status is unknown, assuming it is in auto mode\n");
8146 tp_features.fan_ctrl_status_undef = 1;
8150 static void fan_quirk1_handle(u8 *fan_status)
8152 if (unlikely(tp_features.fan_ctrl_status_undef)) {
8153 if (*fan_status != fan_control_initial_status) {
8154 /* something changed the HFSP regisnter since
8155 * driver init time, so it is not undefined
8157 tp_features.fan_ctrl_status_undef = 0;
8159 /* Return most likely status. In fact, it
8160 * might be the only possible status */
8161 *fan_status = TP_EC_FAN_AUTO;
8166 /* Select main fan on X60/X61, NOOP on others */
8167 static bool fan_select_fan1(void)
8169 if (tp_features.second_fan) {
8172 if (ec_read(fan_select_offset, &val) < 0)
8175 if (ec_write(fan_select_offset, val) < 0)
8181 /* Select secondary fan on X60/X61 */
8182 static bool fan_select_fan2(void)
8186 if (!tp_features.second_fan)
8189 if (ec_read(fan_select_offset, &val) < 0)
8192 if (ec_write(fan_select_offset, val) < 0)
8199 * Call with fan_mutex held
8201 static void fan_update_desired_level(u8 status)
8204 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8206 fan_control_desired_level = 7;
8208 fan_control_desired_level = status;
8212 static int fan_get_status(u8 *status)
8217 * Add TPACPI_FAN_RD_ACPI_FANS ? */
8219 switch (fan_status_access_mode) {
8220 case TPACPI_FAN_RD_ACPI_GFAN: {
8221 /* 570, 600e/x, 770e, 770x */
8224 if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
8228 *status = res & 0x07;
8232 case TPACPI_FAN_RD_TPEC:
8233 /* all except 570, 600e/x, 770e, 770x */
8234 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
8237 if (likely(status)) {
8239 fan_quirk1_handle(status);
8251 static int fan_get_status_safe(u8 *status)
8256 if (mutex_lock_killable(&fan_mutex))
8257 return -ERESTARTSYS;
8258 rc = fan_get_status(&s);
8260 fan_update_desired_level(s);
8261 mutex_unlock(&fan_mutex);
8271 static int fan_get_speed(unsigned int *speed)
8275 switch (fan_status_access_mode) {
8276 case TPACPI_FAN_RD_TPEC:
8277 /* all except 570, 600e/x, 770e, 770x */
8278 if (unlikely(!fan_select_fan1()))
8280 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
8281 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
8285 *speed = (hi << 8) | lo;
8296 static int fan2_get_speed(unsigned int *speed)
8301 switch (fan_status_access_mode) {
8302 case TPACPI_FAN_RD_TPEC:
8303 /* all except 570, 600e/x, 770e, 770x */
8304 if (unlikely(!fan_select_fan2()))
8306 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
8307 !acpi_ec_read(fan_rpm_offset + 1, &hi);
8308 fan_select_fan1(); /* play it safe */
8313 *speed = (hi << 8) | lo;
8324 static int fan_set_level(int level)
8326 if (!fan_control_allowed)
8329 switch (fan_control_access_mode) {
8330 case TPACPI_FAN_WR_ACPI_SFAN:
8331 if ((level < 0) || (level > 7))
8334 if (tp_features.second_fan_ctl) {
8335 if (!fan_select_fan2() ||
8336 !acpi_evalf(sfan_handle, NULL, NULL, "vd", level)) {
8337 pr_warn("Couldn't set 2nd fan level, disabling support\n");
8338 tp_features.second_fan_ctl = 0;
8342 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
8346 case TPACPI_FAN_WR_ACPI_FANS:
8347 case TPACPI_FAN_WR_TPEC:
8348 if (!(level & TP_EC_FAN_AUTO) &&
8349 !(level & TP_EC_FAN_FULLSPEED) &&
8350 ((level < 0) || (level > 7)))
8353 /* safety net should the EC not support AUTO
8354 * or FULLSPEED mode bits and just ignore them */
8355 if (level & TP_EC_FAN_FULLSPEED)
8356 level |= 7; /* safety min speed 7 */
8357 else if (level & TP_EC_FAN_AUTO)
8358 level |= 4; /* safety min speed 4 */
8360 if (tp_features.second_fan_ctl) {
8361 if (!fan_select_fan2() ||
8362 !acpi_ec_write(fan_status_offset, level)) {
8363 pr_warn("Couldn't set 2nd fan level, disabling support\n");
8364 tp_features.second_fan_ctl = 0;
8369 if (!acpi_ec_write(fan_status_offset, level))
8372 tp_features.fan_ctrl_status_undef = 0;
8379 vdbg_printk(TPACPI_DBG_FAN,
8380 "fan control: set fan control register to 0x%02x\n", level);
8384 static int fan_set_level_safe(int level)
8388 if (!fan_control_allowed)
8391 if (mutex_lock_killable(&fan_mutex))
8392 return -ERESTARTSYS;
8394 if (level == TPACPI_FAN_LAST_LEVEL)
8395 level = fan_control_desired_level;
8397 rc = fan_set_level(level);
8399 fan_update_desired_level(level);
8401 mutex_unlock(&fan_mutex);
8405 static int fan_set_enable(void)
8410 if (!fan_control_allowed)
8413 if (mutex_lock_killable(&fan_mutex))
8414 return -ERESTARTSYS;
8416 switch (fan_control_access_mode) {
8417 case TPACPI_FAN_WR_ACPI_FANS:
8418 case TPACPI_FAN_WR_TPEC:
8419 rc = fan_get_status(&s);
8423 /* Don't go out of emergency fan mode */
8426 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
8429 if (!acpi_ec_write(fan_status_offset, s))
8432 tp_features.fan_ctrl_status_undef = 0;
8437 case TPACPI_FAN_WR_ACPI_SFAN:
8438 rc = fan_get_status(&s);
8444 /* Set fan to at least level 4 */
8447 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
8457 mutex_unlock(&fan_mutex);
8460 vdbg_printk(TPACPI_DBG_FAN,
8461 "fan control: set fan control register to 0x%02x\n",
8466 static int fan_set_disable(void)
8470 if (!fan_control_allowed)
8473 if (mutex_lock_killable(&fan_mutex))
8474 return -ERESTARTSYS;
8477 switch (fan_control_access_mode) {
8478 case TPACPI_FAN_WR_ACPI_FANS:
8479 case TPACPI_FAN_WR_TPEC:
8480 if (!acpi_ec_write(fan_status_offset, 0x00))
8483 fan_control_desired_level = 0;
8484 tp_features.fan_ctrl_status_undef = 0;
8488 case TPACPI_FAN_WR_ACPI_SFAN:
8489 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
8492 fan_control_desired_level = 0;
8500 vdbg_printk(TPACPI_DBG_FAN,
8501 "fan control: set fan control register to 0\n");
8503 mutex_unlock(&fan_mutex);
8507 static int fan_set_speed(int speed)
8511 if (!fan_control_allowed)
8514 if (mutex_lock_killable(&fan_mutex))
8515 return -ERESTARTSYS;
8518 switch (fan_control_access_mode) {
8519 case TPACPI_FAN_WR_ACPI_FANS:
8520 if (speed >= 0 && speed <= 65535) {
8521 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
8522 speed, speed, speed))
8532 mutex_unlock(&fan_mutex);
8536 static void fan_watchdog_reset(void)
8538 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
8541 if (fan_watchdog_maxinterval > 0 &&
8542 tpacpi_lifecycle != TPACPI_LIFE_EXITING)
8543 mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
8544 msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
8546 cancel_delayed_work(&fan_watchdog_task);
8549 static void fan_watchdog_fire(struct work_struct *ignored)
8553 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
8556 pr_notice("fan watchdog: enabling fan\n");
8557 rc = fan_set_enable();
8559 pr_err("fan watchdog: error %d while enabling fan, will try again later...\n",
8561 /* reschedule for later */
8562 fan_watchdog_reset();
8567 * SYSFS fan layout: hwmon compatible (device)
8570 * 0: "disengaged" mode
8572 * 2: native EC "auto" mode (recommended, hardware default)
8574 * pwm*: set speed in manual mode, ignored otherwise.
8575 * 0 is level 0; 255 is level 7. Intermediate points done with linear
8578 * fan*_input: tachometer reading, RPM
8581 * SYSFS fan layout: extensions
8583 * fan_watchdog (driver):
8584 * fan watchdog interval in seconds, 0 disables (default), max 120
8587 /* sysfs fan pwm1_enable ----------------------------------------------- */
8588 static ssize_t fan_pwm1_enable_show(struct device *dev,
8589 struct device_attribute *attr,
8595 res = fan_get_status_safe(&status);
8599 if (status & TP_EC_FAN_FULLSPEED) {
8601 } else if (status & TP_EC_FAN_AUTO) {
8606 return sysfs_emit(buf, "%d\n", mode);
8609 static ssize_t fan_pwm1_enable_store(struct device *dev,
8610 struct device_attribute *attr,
8611 const char *buf, size_t count)
8616 if (parse_strtoul(buf, 2, &t))
8619 tpacpi_disclose_usertask("hwmon pwm1_enable",
8620 "set fan mode to %lu\n", t);
8624 level = TP_EC_FAN_FULLSPEED;
8627 level = TPACPI_FAN_LAST_LEVEL;
8630 level = TP_EC_FAN_AUTO;
8633 /* reserved for software-controlled auto mode */
8639 res = fan_set_level_safe(level);
8645 fan_watchdog_reset();
8650 static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
8651 fan_pwm1_enable_show, fan_pwm1_enable_store);
8653 /* sysfs fan pwm1 ------------------------------------------------------ */
8654 static ssize_t fan_pwm1_show(struct device *dev,
8655 struct device_attribute *attr,
8661 res = fan_get_status_safe(&status);
8666 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
8667 status = fan_control_desired_level;
8672 return sysfs_emit(buf, "%u\n", (status * 255) / 7);
8675 static ssize_t fan_pwm1_store(struct device *dev,
8676 struct device_attribute *attr,
8677 const char *buf, size_t count)
8681 u8 status, newlevel;
8683 if (parse_strtoul(buf, 255, &s))
8686 tpacpi_disclose_usertask("hwmon pwm1",
8687 "set fan speed to %lu\n", s);
8689 /* scale down from 0-255 to 0-7 */
8690 newlevel = (s >> 5) & 0x07;
8692 if (mutex_lock_killable(&fan_mutex))
8693 return -ERESTARTSYS;
8695 rc = fan_get_status(&status);
8696 if (!rc && (status &
8697 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8698 rc = fan_set_level(newlevel);
8702 fan_update_desired_level(newlevel);
8703 fan_watchdog_reset();
8707 mutex_unlock(&fan_mutex);
8708 return (rc) ? rc : count;
8711 static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, fan_pwm1_show, fan_pwm1_store);
8713 /* sysfs fan fan1_input ------------------------------------------------ */
8714 static ssize_t fan_fan1_input_show(struct device *dev,
8715 struct device_attribute *attr,
8721 res = fan_get_speed(&speed);
8725 return sysfs_emit(buf, "%u\n", speed);
8728 static DEVICE_ATTR(fan1_input, S_IRUGO, fan_fan1_input_show, NULL);
8730 /* sysfs fan fan2_input ------------------------------------------------ */
8731 static ssize_t fan_fan2_input_show(struct device *dev,
8732 struct device_attribute *attr,
8738 res = fan2_get_speed(&speed);
8742 return sysfs_emit(buf, "%u\n", speed);
8745 static DEVICE_ATTR(fan2_input, S_IRUGO, fan_fan2_input_show, NULL);
8747 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8748 static ssize_t fan_watchdog_show(struct device_driver *drv, char *buf)
8750 return sysfs_emit(buf, "%u\n", fan_watchdog_maxinterval);
8753 static ssize_t fan_watchdog_store(struct device_driver *drv, const char *buf,
8758 if (parse_strtoul(buf, 120, &t))
8761 if (!fan_control_allowed)
8764 fan_watchdog_maxinterval = t;
8765 fan_watchdog_reset();
8767 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8771 static DRIVER_ATTR_RW(fan_watchdog);
8773 /* --------------------------------------------------------------------- */
8775 static struct attribute *fan_attributes[] = {
8776 &dev_attr_pwm1_enable.attr,
8777 &dev_attr_pwm1.attr,
8778 &dev_attr_fan1_input.attr,
8779 &dev_attr_fan2_input.attr,
8783 static umode_t fan_attr_is_visible(struct kobject *kobj, struct attribute *attr,
8786 if (fan_status_access_mode == TPACPI_FAN_NONE &&
8787 fan_control_access_mode == TPACPI_FAN_WR_NONE)
8790 if (attr == &dev_attr_fan2_input.attr) {
8791 if (!tp_features.second_fan)
8798 static const struct attribute_group fan_attr_group = {
8799 .is_visible = fan_attr_is_visible,
8800 .attrs = fan_attributes,
8803 static struct attribute *fan_driver_attributes[] = {
8804 &driver_attr_fan_watchdog.attr,
8808 static const struct attribute_group fan_driver_attr_group = {
8809 .is_visible = fan_attr_is_visible,
8810 .attrs = fan_driver_attributes,
8813 #define TPACPI_FAN_Q1 0x0001 /* Uninitialized HFSP */
8814 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
8815 #define TPACPI_FAN_2CTL 0x0004 /* selects fan2 control */
8816 #define TPACPI_FAN_NOFAN 0x0008 /* no fan available */
8818 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8819 TPACPI_QEC_IBM('1', 'Y', TPACPI_FAN_Q1),
8820 TPACPI_QEC_IBM('7', '8', TPACPI_FAN_Q1),
8821 TPACPI_QEC_IBM('7', '6', TPACPI_FAN_Q1),
8822 TPACPI_QEC_IBM('7', '0', TPACPI_FAN_Q1),
8823 TPACPI_QEC_LNV('7', 'M', TPACPI_FAN_2FAN),
8824 TPACPI_Q_LNV('N', '1', TPACPI_FAN_2FAN),
8825 TPACPI_Q_LNV3('N', '1', 'D', TPACPI_FAN_2CTL), /* P70 */
8826 TPACPI_Q_LNV3('N', '1', 'E', TPACPI_FAN_2CTL), /* P50 */
8827 TPACPI_Q_LNV3('N', '1', 'T', TPACPI_FAN_2CTL), /* P71 */
8828 TPACPI_Q_LNV3('N', '1', 'U', TPACPI_FAN_2CTL), /* P51 */
8829 TPACPI_Q_LNV3('N', '2', 'C', TPACPI_FAN_2CTL), /* P52 / P72 */
8830 TPACPI_Q_LNV3('N', '2', 'N', TPACPI_FAN_2CTL), /* P53 / P73 */
8831 TPACPI_Q_LNV3('N', '2', 'E', TPACPI_FAN_2CTL), /* P1 / X1 Extreme (1st gen) */
8832 TPACPI_Q_LNV3('N', '2', 'O', TPACPI_FAN_2CTL), /* P1 / X1 Extreme (2nd gen) */
8833 TPACPI_Q_LNV3('N', '3', '0', TPACPI_FAN_2CTL), /* P15 (1st gen) / P15v (1st gen) */
8834 TPACPI_Q_LNV3('N', '3', '7', TPACPI_FAN_2CTL), /* T15g (2nd gen) */
8835 TPACPI_Q_LNV3('N', '1', 'O', TPACPI_FAN_NOFAN), /* X1 Tablet (2nd gen) */
8838 static int __init fan_init(struct ibm_init_struct *iibm)
8840 unsigned long quirks;
8842 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8843 "initializing fan subdriver\n");
8845 mutex_init(&fan_mutex);
8846 fan_status_access_mode = TPACPI_FAN_NONE;
8847 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8848 fan_control_commands = 0;
8849 fan_watchdog_maxinterval = 0;
8850 tp_features.fan_ctrl_status_undef = 0;
8851 tp_features.second_fan = 0;
8852 tp_features.second_fan_ctl = 0;
8853 fan_control_desired_level = 7;
8855 if (tpacpi_is_ibm()) {
8856 TPACPI_ACPIHANDLE_INIT(fans);
8857 TPACPI_ACPIHANDLE_INIT(gfan);
8858 TPACPI_ACPIHANDLE_INIT(sfan);
8861 quirks = tpacpi_check_quirks(fan_quirk_table,
8862 ARRAY_SIZE(fan_quirk_table));
8864 if (quirks & TPACPI_FAN_NOFAN) {
8865 pr_info("No integrated ThinkPad fan available\n");
8870 /* 570, 600e/x, 770e, 770x */
8871 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8873 /* all other ThinkPads: note that even old-style
8874 * ThinkPad ECs supports the fan control register */
8875 if (likely(acpi_ec_read(fan_status_offset,
8876 &fan_control_initial_status))) {
8880 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8881 if (quirks & TPACPI_FAN_Q1)
8883 /* Try and probe the 2nd fan */
8884 tp_features.second_fan = 1; /* needed for get_speed to work */
8885 res = fan2_get_speed(&speed);
8887 /* It responded - so let's assume it's there */
8888 tp_features.second_fan = 1;
8889 tp_features.second_fan_ctl = 1;
8890 pr_info("secondary fan control detected & enabled\n");
8892 /* Fan not auto-detected */
8893 tp_features.second_fan = 0;
8894 if (quirks & TPACPI_FAN_2FAN) {
8895 tp_features.second_fan = 1;
8896 pr_info("secondary fan support enabled\n");
8898 if (quirks & TPACPI_FAN_2CTL) {
8899 tp_features.second_fan = 1;
8900 tp_features.second_fan_ctl = 1;
8901 pr_info("secondary fan control enabled\n");
8905 pr_err("ThinkPad ACPI EC access misbehaving, fan status and control unavailable\n");
8912 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8913 fan_control_commands |=
8914 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8917 /* gfan without sfan means no fan control */
8918 /* all other models implement TP EC 0x2f control */
8922 fan_control_access_mode =
8923 TPACPI_FAN_WR_ACPI_FANS;
8924 fan_control_commands |=
8925 TPACPI_FAN_CMD_SPEED |
8926 TPACPI_FAN_CMD_LEVEL |
8927 TPACPI_FAN_CMD_ENABLE;
8929 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8930 fan_control_commands |=
8931 TPACPI_FAN_CMD_LEVEL |
8932 TPACPI_FAN_CMD_ENABLE;
8937 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8938 "fan is %s, modes %d, %d\n",
8939 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8940 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8941 fan_status_access_mode, fan_control_access_mode);
8943 /* fan control master switch */
8944 if (!fan_control_allowed) {
8945 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8946 fan_control_commands = 0;
8947 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8948 "fan control features disabled by parameter\n");
8951 /* update fan_control_desired_level */
8952 if (fan_status_access_mode != TPACPI_FAN_NONE)
8953 fan_get_status_safe(NULL);
8955 if (fan_status_access_mode == TPACPI_FAN_NONE &&
8956 fan_control_access_mode == TPACPI_FAN_WR_NONE)
8962 static void fan_exit(void)
8964 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8965 "cancelling any pending fan watchdog tasks\n");
8967 cancel_delayed_work(&fan_watchdog_task);
8968 flush_workqueue(tpacpi_wq);
8971 static void fan_suspend(void)
8975 if (!fan_control_allowed)
8978 /* Store fan status in cache */
8979 fan_control_resume_level = 0;
8980 rc = fan_get_status_safe(&fan_control_resume_level);
8982 pr_notice("failed to read fan level for later restore during resume: %d\n",
8985 /* if it is undefined, don't attempt to restore it.
8987 if (tp_features.fan_ctrl_status_undef)
8988 fan_control_resume_level = 0;
8991 static void fan_resume(void)
8993 u8 current_level = 7;
8994 bool do_set = false;
8997 /* DSDT *always* updates status on resume */
8998 tp_features.fan_ctrl_status_undef = 0;
9000 if (!fan_control_allowed ||
9001 !fan_control_resume_level ||
9002 fan_get_status_safe(¤t_level))
9005 switch (fan_control_access_mode) {
9006 case TPACPI_FAN_WR_ACPI_SFAN:
9007 /* never decrease fan level */
9008 do_set = (fan_control_resume_level > current_level);
9010 case TPACPI_FAN_WR_ACPI_FANS:
9011 case TPACPI_FAN_WR_TPEC:
9012 /* never decrease fan level, scale is:
9013 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
9015 * We expect the firmware to set either 7 or AUTO, but we
9016 * handle FULLSPEED out of paranoia.
9018 * So, we can safely only restore FULLSPEED or 7, anything
9019 * else could slow the fan. Restoring AUTO is useless, at
9020 * best that's exactly what the DSDT already set (it is the
9023 * Always keep in mind that the DSDT *will* have set the
9024 * fans to what the vendor supposes is the best level. We
9025 * muck with it only to speed the fan up.
9027 if (fan_control_resume_level != 7 &&
9028 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
9031 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
9032 (current_level != fan_control_resume_level);
9038 pr_notice("restoring fan level to 0x%02x\n",
9039 fan_control_resume_level);
9040 rc = fan_set_level_safe(fan_control_resume_level);
9042 pr_notice("failed to restore fan level: %d\n", rc);
9046 static int fan_read(struct seq_file *m)
9050 unsigned int speed = 0;
9052 switch (fan_status_access_mode) {
9053 case TPACPI_FAN_RD_ACPI_GFAN:
9054 /* 570, 600e/x, 770e, 770x */
9055 rc = fan_get_status_safe(&status);
9059 seq_printf(m, "status:\t\t%s\n"
9061 (status != 0) ? "enabled" : "disabled", status);
9064 case TPACPI_FAN_RD_TPEC:
9065 /* all except 570, 600e/x, 770e, 770x */
9066 rc = fan_get_status_safe(&status);
9070 seq_printf(m, "status:\t\t%s\n",
9071 (status != 0) ? "enabled" : "disabled");
9073 rc = fan_get_speed(&speed);
9077 seq_printf(m, "speed:\t\t%d\n", speed);
9079 if (status & TP_EC_FAN_FULLSPEED)
9080 /* Disengaged mode takes precedence */
9081 seq_printf(m, "level:\t\tdisengaged\n");
9082 else if (status & TP_EC_FAN_AUTO)
9083 seq_printf(m, "level:\t\tauto\n");
9085 seq_printf(m, "level:\t\t%d\n", status);
9088 case TPACPI_FAN_NONE:
9090 seq_printf(m, "status:\t\tnot supported\n");
9093 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
9094 seq_printf(m, "commands:\tlevel <level>");
9096 switch (fan_control_access_mode) {
9097 case TPACPI_FAN_WR_ACPI_SFAN:
9098 seq_printf(m, " (<level> is 0-7)\n");
9102 seq_printf(m, " (<level> is 0-7, auto, disengaged, full-speed)\n");
9107 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
9108 seq_printf(m, "commands:\tenable, disable\n"
9109 "commands:\twatchdog <timeout> (<timeout> is 0 (off), 1-120 (seconds))\n");
9111 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
9112 seq_printf(m, "commands:\tspeed <speed> (<speed> is 0-65535)\n");
9117 static int fan_write_cmd_level(const char *cmd, int *rc)
9121 if (strlencmp(cmd, "level auto") == 0)
9122 level = TP_EC_FAN_AUTO;
9123 else if ((strlencmp(cmd, "level disengaged") == 0) ||
9124 (strlencmp(cmd, "level full-speed") == 0))
9125 level = TP_EC_FAN_FULLSPEED;
9126 else if (sscanf(cmd, "level %d", &level) != 1)
9129 *rc = fan_set_level_safe(level);
9131 pr_err("level command accepted for unsupported access mode %d\n",
9132 fan_control_access_mode);
9134 tpacpi_disclose_usertask("procfs fan",
9135 "set level to %d\n", level);
9140 static int fan_write_cmd_enable(const char *cmd, int *rc)
9142 if (strlencmp(cmd, "enable") != 0)
9145 *rc = fan_set_enable();
9147 pr_err("enable command accepted for unsupported access mode %d\n",
9148 fan_control_access_mode);
9150 tpacpi_disclose_usertask("procfs fan", "enable\n");
9155 static int fan_write_cmd_disable(const char *cmd, int *rc)
9157 if (strlencmp(cmd, "disable") != 0)
9160 *rc = fan_set_disable();
9162 pr_err("disable command accepted for unsupported access mode %d\n",
9163 fan_control_access_mode);
9165 tpacpi_disclose_usertask("procfs fan", "disable\n");
9170 static int fan_write_cmd_speed(const char *cmd, int *rc)
9175 * Support speed <low> <medium> <high> ? */
9177 if (sscanf(cmd, "speed %d", &speed) != 1)
9180 *rc = fan_set_speed(speed);
9182 pr_err("speed command accepted for unsupported access mode %d\n",
9183 fan_control_access_mode);
9185 tpacpi_disclose_usertask("procfs fan",
9186 "set speed to %d\n", speed);
9191 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
9195 if (sscanf(cmd, "watchdog %d", &interval) != 1)
9198 if (interval < 0 || interval > 120)
9201 fan_watchdog_maxinterval = interval;
9202 tpacpi_disclose_usertask("procfs fan",
9203 "set watchdog timer to %d\n",
9210 static int fan_write(char *buf)
9215 while (!rc && (cmd = strsep(&buf, ","))) {
9216 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
9217 fan_write_cmd_level(cmd, &rc)) &&
9218 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
9219 (fan_write_cmd_enable(cmd, &rc) ||
9220 fan_write_cmd_disable(cmd, &rc) ||
9221 fan_write_cmd_watchdog(cmd, &rc))) &&
9222 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
9223 fan_write_cmd_speed(cmd, &rc))
9227 fan_watchdog_reset();
9233 static struct ibm_struct fan_driver_data = {
9238 .suspend = fan_suspend,
9239 .resume = fan_resume,
9242 /*************************************************************************
9243 * Mute LED subdriver
9246 #define TPACPI_LED_MAX 2
9248 struct tp_led_table {
9255 static struct tp_led_table led_tables[TPACPI_LED_MAX] = {
9256 [LED_AUDIO_MUTE] = {
9261 [LED_AUDIO_MICMUTE] = {
9268 static int mute_led_on_off(struct tp_led_table *t, bool state)
9273 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9274 pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
9278 if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
9279 state ? t->on_value : t->off_value))
9286 static int tpacpi_led_set(int whichled, bool on)
9288 struct tp_led_table *t;
9290 t = &led_tables[whichled];
9291 if (t->state < 0 || t->state == on)
9293 return mute_led_on_off(t, on);
9296 static int tpacpi_led_mute_set(struct led_classdev *led_cdev,
9297 enum led_brightness brightness)
9299 return tpacpi_led_set(LED_AUDIO_MUTE, brightness != LED_OFF);
9302 static int tpacpi_led_micmute_set(struct led_classdev *led_cdev,
9303 enum led_brightness brightness)
9305 return tpacpi_led_set(LED_AUDIO_MICMUTE, brightness != LED_OFF);
9308 static struct led_classdev mute_led_cdev[TPACPI_LED_MAX] = {
9309 [LED_AUDIO_MUTE] = {
9310 .name = "platform::mute",
9311 .max_brightness = 1,
9312 .brightness_set_blocking = tpacpi_led_mute_set,
9313 .default_trigger = "audio-mute",
9315 [LED_AUDIO_MICMUTE] = {
9316 .name = "platform::micmute",
9317 .max_brightness = 1,
9318 .brightness_set_blocking = tpacpi_led_micmute_set,
9319 .default_trigger = "audio-micmute",
9323 static int mute_led_init(struct ibm_init_struct *iibm)
9328 for (i = 0; i < TPACPI_LED_MAX; i++) {
9329 struct tp_led_table *t = &led_tables[i];
9330 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9335 mute_led_cdev[i].brightness = ledtrig_audio_get(i);
9336 err = led_classdev_register(&tpacpi_pdev->dev, &mute_led_cdev[i]);
9339 led_classdev_unregister(&mute_led_cdev[i]);
9346 static void mute_led_exit(void)
9350 for (i = 0; i < TPACPI_LED_MAX; i++) {
9351 led_classdev_unregister(&mute_led_cdev[i]);
9352 tpacpi_led_set(i, false);
9356 static void mute_led_resume(void)
9360 for (i = 0; i < TPACPI_LED_MAX; i++) {
9361 struct tp_led_table *t = &led_tables[i];
9363 mute_led_on_off(t, t->state);
9367 static struct ibm_struct mute_led_driver_data = {
9369 .exit = mute_led_exit,
9370 .resume = mute_led_resume,
9374 * Battery Wear Control Driver
9375 * Contact: Ognjen Galic <smclt30p@gmail.com>
9380 #define GET_START "BCTG"
9381 #define SET_START "BCCS"
9382 #define GET_STOP "BCSG"
9383 #define SET_STOP "BCSS"
9384 #define GET_DISCHARGE "BDSG"
9385 #define SET_DISCHARGE "BDSS"
9386 #define GET_INHIBIT "BICG"
9387 #define SET_INHIBIT "BICS"
9396 /* Error condition bit */
9397 METHOD_ERR = BIT(31),
9401 /* This is used in the get/set helpers */
9408 struct tpacpi_battery_data {
9413 unsigned int charge_behaviours;
9416 struct tpacpi_battery_driver_data {
9417 struct tpacpi_battery_data batteries[3];
9418 int individual_addressing;
9421 static struct tpacpi_battery_driver_data battery_info;
9423 /* ACPI helpers/functions/probes */
9426 * This evaluates a ACPI method call specific to the battery
9427 * ACPI extension. The specifics are that an error is marked
9428 * in the 32rd bit of the response, so we just check that here.
9430 static acpi_status tpacpi_battery_acpi_eval(char *method, int *ret, int param)
9434 if (!acpi_evalf(hkey_handle, &response, method, "dd", param)) {
9435 acpi_handle_err(hkey_handle, "%s: evaluate failed", method);
9438 if (response & METHOD_ERR) {
9439 acpi_handle_err(hkey_handle,
9440 "%s evaluated but flagged as error", method);
9447 static int tpacpi_battery_get(int what, int battery, int *ret)
9450 case THRESHOLD_START:
9451 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, ret, battery))
9454 /* The value is in the low 8 bits of the response */
9457 case THRESHOLD_STOP:
9458 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, ret, battery))
9460 /* Value is in lower 8 bits */
9463 * On the stop value, if we return 0 that
9464 * does not make any sense. 0 means Default, which
9465 * means that charging stops at 100%, so we return
9471 case FORCE_DISCHARGE:
9472 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_DISCHARGE, ret, battery))
9474 /* The force discharge status is in bit 0 */
9477 case INHIBIT_CHARGE:
9478 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_INHIBIT, ret, battery))
9480 /* The inhibit charge status is in bit 0 */
9484 pr_crit("wrong parameter: %d", what);
9489 static int tpacpi_battery_set(int what, int battery, int value)
9492 /* The first 8 bits are the value of the threshold */
9494 /* The battery ID is in bits 8-9, 2 bits */
9495 param |= battery << 8;
9498 case THRESHOLD_START:
9499 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_START, &ret, param)) {
9500 pr_err("failed to set charge threshold on battery %d",
9505 case THRESHOLD_STOP:
9506 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_STOP, &ret, param)) {
9507 pr_err("failed to set stop threshold: %d", battery);
9511 case FORCE_DISCHARGE:
9512 /* Force discharge is in bit 0,
9513 * break on AC attach is in bit 1 (won't work on some ThinkPads),
9514 * battery ID is in bits 8-9, 2 bits.
9516 if (ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_DISCHARGE, &ret, param))) {
9517 pr_err("failed to set force discharge on %d", battery);
9521 case INHIBIT_CHARGE:
9522 /* When setting inhibit charge, we set a default value of
9523 * always breaking on AC detach and the effective time is set to
9525 * The battery ID is in bits 4-5, 2 bits,
9526 * the effective time is in bits 8-23, 2 bytes.
9527 * A time of FFFF indicates forever.
9530 param |= battery << 4;
9531 param |= 0xFFFF << 8;
9532 if (ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_INHIBIT, &ret, param))) {
9533 pr_err("failed to set inhibit charge on %d", battery);
9538 pr_crit("wrong parameter: %d", what);
9543 static int tpacpi_battery_set_validate(int what, int battery, int value)
9547 ret = tpacpi_battery_set(what, battery, value);
9551 ret = tpacpi_battery_get(what, battery, &v);
9560 ret = tpacpi_battery_get(what, battery, &v);
9570 static int tpacpi_battery_probe(int battery)
9574 memset(&battery_info.batteries[battery], 0,
9575 sizeof(battery_info.batteries[battery]));
9578 * 1) Get the current start threshold
9579 * 2) Check for support
9580 * 3) Get the current stop threshold
9581 * 4) Check for support
9582 * 5) Get the current force discharge status
9583 * 6) Check for support
9584 * 7) Get the current inhibit charge status
9585 * 8) Check for support
9587 if (acpi_has_method(hkey_handle, GET_START)) {
9588 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, &ret, battery)) {
9589 pr_err("Error probing battery %d\n", battery);
9592 /* Individual addressing is in bit 9 */
9594 battery_info.individual_addressing = true;
9595 /* Support is marked in bit 8 */
9597 battery_info.batteries[battery].start_support = 1;
9600 if (tpacpi_battery_get(THRESHOLD_START, battery,
9601 &battery_info.batteries[battery].charge_start)) {
9602 pr_err("Error probing battery %d\n", battery);
9606 if (acpi_has_method(hkey_handle, GET_STOP)) {
9607 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, &ret, battery)) {
9608 pr_err("Error probing battery stop; %d\n", battery);
9611 /* Support is marked in bit 8 */
9613 battery_info.batteries[battery].stop_support = 1;
9616 if (tpacpi_battery_get(THRESHOLD_STOP, battery,
9617 &battery_info.batteries[battery].charge_stop)) {
9618 pr_err("Error probing battery stop: %d\n", battery);
9622 if (acpi_has_method(hkey_handle, GET_DISCHARGE)) {
9623 if (ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_DISCHARGE, &ret, battery))) {
9624 pr_err("Error probing battery discharge; %d\n", battery);
9627 /* Support is marked in bit 8 */
9629 battery_info.batteries[battery].charge_behaviours |=
9630 BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE);
9632 if (acpi_has_method(hkey_handle, GET_INHIBIT)) {
9633 if (ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_INHIBIT, &ret, battery))) {
9634 pr_err("Error probing battery inhibit charge; %d\n", battery);
9637 /* Support is marked in bit 5 */
9639 battery_info.batteries[battery].charge_behaviours |=
9640 BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE);
9643 battery_info.batteries[battery].charge_behaviours |=
9644 BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_AUTO);
9646 pr_info("battery %d registered (start %d, stop %d, behaviours: 0x%x)\n",
9648 battery_info.batteries[battery].charge_start,
9649 battery_info.batteries[battery].charge_stop,
9650 battery_info.batteries[battery].charge_behaviours);
9655 /* General helper functions */
9657 static int tpacpi_battery_get_id(const char *battery_name)
9660 if (strcmp(battery_name, "BAT0") == 0 ||
9661 tp_features.battery_force_primary)
9663 if (strcmp(battery_name, "BAT1") == 0)
9664 return BAT_SECONDARY;
9666 * If for some reason the battery is not BAT0 nor is it
9667 * BAT1, we will assume it's the default, first battery,
9670 pr_warn("unknown battery %s, assuming primary", battery_name);
9674 /* sysfs interface */
9676 static ssize_t tpacpi_battery_store(int what,
9678 const char *buf, size_t count)
9680 struct power_supply *supply = to_power_supply(dev);
9681 unsigned long value;
9684 * Some systems have support for more than
9685 * one battery. If that is the case,
9686 * tpacpi_battery_probe marked that addressing
9687 * them individually is supported, so we do that
9688 * based on the device struct.
9690 * On systems that are not supported, we assume
9691 * the primary as most of the ACPI calls fail
9692 * with "Any Battery" as the parameter.
9694 if (battery_info.individual_addressing)
9695 /* BAT_PRIMARY or BAT_SECONDARY */
9696 battery = tpacpi_battery_get_id(supply->desc->name);
9698 battery = BAT_PRIMARY;
9700 rval = kstrtoul(buf, 10, &value);
9705 case THRESHOLD_START:
9706 if (!battery_info.batteries[battery].start_support)
9708 /* valid values are [0, 99] */
9711 if (value > battery_info.batteries[battery].charge_stop)
9713 if (tpacpi_battery_set(THRESHOLD_START, battery, value))
9715 battery_info.batteries[battery].charge_start = value;
9718 case THRESHOLD_STOP:
9719 if (!battery_info.batteries[battery].stop_support)
9721 /* valid values are [1, 100] */
9722 if (value < 1 || value > 100)
9724 if (value < battery_info.batteries[battery].charge_start)
9726 battery_info.batteries[battery].charge_stop = value;
9728 * When 100 is passed to stop, we need to flip
9729 * it to 0 as that the EC understands that as
9730 * "Default", which will charge to 100%
9734 if (tpacpi_battery_set(THRESHOLD_STOP, battery, value))
9738 pr_crit("Wrong parameter: %d", what);
9744 static ssize_t tpacpi_battery_show(int what,
9748 struct power_supply *supply = to_power_supply(dev);
9751 * Some systems have support for more than
9752 * one battery. If that is the case,
9753 * tpacpi_battery_probe marked that addressing
9754 * them individually is supported, so we;
9755 * based on the device struct.
9757 * On systems that are not supported, we assume
9758 * the primary as most of the ACPI calls fail
9759 * with "Any Battery" as the parameter.
9761 if (battery_info.individual_addressing)
9762 /* BAT_PRIMARY or BAT_SECONDARY */
9763 battery = tpacpi_battery_get_id(supply->desc->name);
9765 battery = BAT_PRIMARY;
9766 if (tpacpi_battery_get(what, battery, &ret))
9768 return sprintf(buf, "%d\n", ret);
9771 static ssize_t charge_control_start_threshold_show(struct device *device,
9772 struct device_attribute *attr,
9775 return tpacpi_battery_show(THRESHOLD_START, device, buf);
9778 static ssize_t charge_control_end_threshold_show(struct device *device,
9779 struct device_attribute *attr,
9782 return tpacpi_battery_show(THRESHOLD_STOP, device, buf);
9785 static ssize_t charge_behaviour_show(struct device *dev,
9786 struct device_attribute *attr,
9789 enum power_supply_charge_behaviour active = POWER_SUPPLY_CHARGE_BEHAVIOUR_AUTO;
9790 struct power_supply *supply = to_power_supply(dev);
9791 unsigned int available;
9794 battery = tpacpi_battery_get_id(supply->desc->name);
9795 available = battery_info.batteries[battery].charge_behaviours;
9797 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE)) {
9798 if (tpacpi_battery_get(FORCE_DISCHARGE, battery, &ret))
9801 active = POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE;
9806 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE)) {
9807 if (tpacpi_battery_get(INHIBIT_CHARGE, battery, &ret))
9810 active = POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE;
9816 return power_supply_charge_behaviour_show(dev, available, active, buf);
9819 static ssize_t charge_control_start_threshold_store(struct device *dev,
9820 struct device_attribute *attr,
9821 const char *buf, size_t count)
9823 return tpacpi_battery_store(THRESHOLD_START, dev, buf, count);
9826 static ssize_t charge_control_end_threshold_store(struct device *dev,
9827 struct device_attribute *attr,
9828 const char *buf, size_t count)
9830 return tpacpi_battery_store(THRESHOLD_STOP, dev, buf, count);
9833 static ssize_t charge_behaviour_store(struct device *dev,
9834 struct device_attribute *attr,
9835 const char *buf, size_t count)
9837 struct power_supply *supply = to_power_supply(dev);
9838 int selected, battery, ret = 0;
9839 unsigned int available;
9841 battery = tpacpi_battery_get_id(supply->desc->name);
9842 available = battery_info.batteries[battery].charge_behaviours;
9843 selected = power_supply_charge_behaviour_parse(available, buf);
9849 case POWER_SUPPLY_CHARGE_BEHAVIOUR_AUTO:
9850 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE))
9851 ret = tpacpi_battery_set_validate(FORCE_DISCHARGE, battery, 0);
9852 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE))
9853 ret = min(ret, tpacpi_battery_set_validate(INHIBIT_CHARGE, battery, 0));
9857 case POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE:
9858 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE))
9859 ret = tpacpi_battery_set_validate(INHIBIT_CHARGE, battery, 0);
9860 ret = min(ret, tpacpi_battery_set_validate(FORCE_DISCHARGE, battery, 1));
9864 case POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE:
9865 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE))
9866 ret = tpacpi_battery_set_validate(FORCE_DISCHARGE, battery, 0);
9867 ret = min(ret, tpacpi_battery_set_validate(INHIBIT_CHARGE, battery, 1));
9872 dev_err(dev, "Unexpected charge behaviour: %d\n", selected);
9879 static DEVICE_ATTR_RW(charge_control_start_threshold);
9880 static DEVICE_ATTR_RW(charge_control_end_threshold);
9881 static DEVICE_ATTR_RW(charge_behaviour);
9882 static struct device_attribute dev_attr_charge_start_threshold = __ATTR(
9883 charge_start_threshold,
9885 charge_control_start_threshold_show,
9886 charge_control_start_threshold_store
9888 static struct device_attribute dev_attr_charge_stop_threshold = __ATTR(
9889 charge_stop_threshold,
9891 charge_control_end_threshold_show,
9892 charge_control_end_threshold_store
9895 static struct attribute *tpacpi_battery_attrs[] = {
9896 &dev_attr_charge_control_start_threshold.attr,
9897 &dev_attr_charge_control_end_threshold.attr,
9898 &dev_attr_charge_start_threshold.attr,
9899 &dev_attr_charge_stop_threshold.attr,
9900 &dev_attr_charge_behaviour.attr,
9904 ATTRIBUTE_GROUPS(tpacpi_battery);
9906 /* ACPI battery hooking */
9908 static int tpacpi_battery_add(struct power_supply *battery)
9910 int batteryid = tpacpi_battery_get_id(battery->desc->name);
9912 if (tpacpi_battery_probe(batteryid))
9914 if (device_add_groups(&battery->dev, tpacpi_battery_groups))
9919 static int tpacpi_battery_remove(struct power_supply *battery)
9921 device_remove_groups(&battery->dev, tpacpi_battery_groups);
9925 static struct acpi_battery_hook battery_hook = {
9926 .add_battery = tpacpi_battery_add,
9927 .remove_battery = tpacpi_battery_remove,
9928 .name = "ThinkPad Battery Extension",
9931 /* Subdriver init/exit */
9933 static const struct tpacpi_quirk battery_quirk_table[] __initconst = {
9935 * Individual addressing is broken on models that expose the
9936 * primary battery as BAT1.
9938 TPACPI_Q_LNV('J', '7', true), /* B5400 */
9939 TPACPI_Q_LNV('J', 'I', true), /* Thinkpad 11e */
9940 TPACPI_Q_LNV3('R', '0', 'B', true), /* Thinkpad 11e gen 3 */
9941 TPACPI_Q_LNV3('R', '0', 'C', true), /* Thinkpad 13 */
9942 TPACPI_Q_LNV3('R', '0', 'J', true), /* Thinkpad 13 gen 2 */
9943 TPACPI_Q_LNV3('R', '0', 'K', true), /* Thinkpad 11e gen 4 celeron BIOS */
9946 static int __init tpacpi_battery_init(struct ibm_init_struct *ibm)
9948 memset(&battery_info, 0, sizeof(battery_info));
9950 tp_features.battery_force_primary = tpacpi_check_quirks(
9951 battery_quirk_table,
9952 ARRAY_SIZE(battery_quirk_table));
9954 battery_hook_register(&battery_hook);
9958 static void tpacpi_battery_exit(void)
9960 battery_hook_unregister(&battery_hook);
9963 static struct ibm_struct battery_driver_data = {
9965 .exit = tpacpi_battery_exit,
9968 /*************************************************************************
9969 * LCD Shadow subdriver, for the Lenovo PrivacyGuard feature
9972 static struct drm_privacy_screen *lcdshadow_dev;
9973 static acpi_handle lcdshadow_get_handle;
9974 static acpi_handle lcdshadow_set_handle;
9976 static int lcdshadow_set_sw_state(struct drm_privacy_screen *priv,
9977 enum drm_privacy_screen_status state)
9981 if (WARN_ON(!mutex_is_locked(&priv->lock)))
9984 if (!acpi_evalf(lcdshadow_set_handle, &output, NULL, "dd", (int)state))
9987 priv->hw_state = priv->sw_state = state;
9991 static void lcdshadow_get_hw_state(struct drm_privacy_screen *priv)
9995 if (!acpi_evalf(lcdshadow_get_handle, &output, NULL, "dd", 0))
9998 priv->hw_state = priv->sw_state = output & 0x1;
10001 static const struct drm_privacy_screen_ops lcdshadow_ops = {
10002 .set_sw_state = lcdshadow_set_sw_state,
10003 .get_hw_state = lcdshadow_get_hw_state,
10006 static int tpacpi_lcdshadow_init(struct ibm_init_struct *iibm)
10008 acpi_status status1, status2;
10011 status1 = acpi_get_handle(hkey_handle, "GSSS", &lcdshadow_get_handle);
10012 status2 = acpi_get_handle(hkey_handle, "SSSS", &lcdshadow_set_handle);
10013 if (ACPI_FAILURE(status1) || ACPI_FAILURE(status2))
10016 if (!acpi_evalf(lcdshadow_get_handle, &output, NULL, "dd", 0))
10019 if (!(output & 0x10000))
10022 lcdshadow_dev = drm_privacy_screen_register(&tpacpi_pdev->dev,
10023 &lcdshadow_ops, NULL);
10024 if (IS_ERR(lcdshadow_dev))
10025 return PTR_ERR(lcdshadow_dev);
10030 static void lcdshadow_exit(void)
10032 drm_privacy_screen_unregister(lcdshadow_dev);
10035 static void lcdshadow_resume(void)
10037 if (!lcdshadow_dev)
10040 mutex_lock(&lcdshadow_dev->lock);
10041 lcdshadow_set_sw_state(lcdshadow_dev, lcdshadow_dev->sw_state);
10042 mutex_unlock(&lcdshadow_dev->lock);
10045 static int lcdshadow_read(struct seq_file *m)
10047 if (!lcdshadow_dev) {
10048 seq_puts(m, "status:\t\tnot supported\n");
10050 seq_printf(m, "status:\t\t%d\n", lcdshadow_dev->hw_state);
10051 seq_puts(m, "commands:\t0, 1\n");
10057 static int lcdshadow_write(char *buf)
10060 int res, state = -EINVAL;
10062 if (!lcdshadow_dev)
10065 while ((cmd = strsep(&buf, ","))) {
10066 res = kstrtoint(cmd, 10, &state);
10071 if (state >= 2 || state < 0)
10074 mutex_lock(&lcdshadow_dev->lock);
10075 res = lcdshadow_set_sw_state(lcdshadow_dev, state);
10076 mutex_unlock(&lcdshadow_dev->lock);
10078 drm_privacy_screen_call_notifier_chain(lcdshadow_dev);
10083 static struct ibm_struct lcdshadow_driver_data = {
10084 .name = "lcdshadow",
10085 .exit = lcdshadow_exit,
10086 .resume = lcdshadow_resume,
10087 .read = lcdshadow_read,
10088 .write = lcdshadow_write,
10091 /*************************************************************************
10092 * Thinkpad sensor interfaces
10095 #define DYTC_CMD_QUERY 0 /* To get DYTC status - enable/revision */
10096 #define DYTC_QUERY_ENABLE_BIT 8 /* Bit 8 - 0 = disabled, 1 = enabled */
10097 #define DYTC_QUERY_SUBREV_BIT 16 /* Bits 16 - 27 - sub revision */
10098 #define DYTC_QUERY_REV_BIT 28 /* Bits 28 - 31 - revision */
10100 #define DYTC_CMD_GET 2 /* To get current IC function and mode */
10101 #define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
10103 #define PALMSENSOR_PRESENT_BIT 0 /* Determine if psensor present */
10104 #define PALMSENSOR_ON_BIT 1 /* psensor status */
10106 static bool has_palmsensor;
10107 static bool has_lapsensor;
10108 static bool palm_state;
10109 static bool lap_state;
10110 static int dytc_version;
10112 static int dytc_command(int command, int *output)
10114 acpi_handle dytc_handle;
10116 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
10117 /* Platform doesn't support DYTC */
10120 if (!acpi_evalf(dytc_handle, output, NULL, "dd", command))
10125 static int lapsensor_get(bool *present, bool *state)
10130 err = dytc_command(DYTC_CMD_GET, &output);
10134 *present = true; /*If we get his far, we have lapmode support*/
10135 *state = output & BIT(DYTC_GET_LAPMODE_BIT) ? true : false;
10139 static int palmsensor_get(bool *present, bool *state)
10141 acpi_handle psensor_handle;
10145 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GPSS", &psensor_handle)))
10147 if (!acpi_evalf(psensor_handle, &output, NULL, "d"))
10150 *present = output & BIT(PALMSENSOR_PRESENT_BIT) ? true : false;
10151 *state = output & BIT(PALMSENSOR_ON_BIT) ? true : false;
10155 static void lapsensor_refresh(void)
10160 if (has_lapsensor) {
10161 err = lapsensor_get(&has_lapsensor, &state);
10164 if (lap_state != state) {
10166 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
10171 static void palmsensor_refresh(void)
10176 if (has_palmsensor) {
10177 err = palmsensor_get(&has_palmsensor, &state);
10180 if (palm_state != state) {
10181 palm_state = state;
10182 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "palmsensor");
10187 static ssize_t dytc_lapmode_show(struct device *dev,
10188 struct device_attribute *attr,
10192 return sysfs_emit(buf, "%d\n", lap_state);
10193 return sysfs_emit(buf, "\n");
10195 static DEVICE_ATTR_RO(dytc_lapmode);
10197 static ssize_t palmsensor_show(struct device *dev,
10198 struct device_attribute *attr,
10201 if (has_palmsensor)
10202 return sysfs_emit(buf, "%d\n", palm_state);
10203 return sysfs_emit(buf, "\n");
10205 static DEVICE_ATTR_RO(palmsensor);
10207 static struct attribute *proxsensor_attributes[] = {
10208 &dev_attr_dytc_lapmode.attr,
10209 &dev_attr_palmsensor.attr,
10213 static umode_t proxsensor_attr_is_visible(struct kobject *kobj,
10214 struct attribute *attr, int n)
10216 if (attr == &dev_attr_dytc_lapmode.attr) {
10218 * Platforms before DYTC version 5 claim to have a lap sensor,
10219 * but it doesn't work, so we ignore them.
10221 if (!has_lapsensor || dytc_version < 5)
10223 } else if (attr == &dev_attr_palmsensor.attr) {
10224 if (!has_palmsensor)
10231 static const struct attribute_group proxsensor_attr_group = {
10232 .is_visible = proxsensor_attr_is_visible,
10233 .attrs = proxsensor_attributes,
10236 static int tpacpi_proxsensor_init(struct ibm_init_struct *iibm)
10238 int palm_err, lap_err;
10240 palm_err = palmsensor_get(&has_palmsensor, &palm_state);
10241 lap_err = lapsensor_get(&has_lapsensor, &lap_state);
10242 /* If support isn't available for both devices return -ENODEV */
10243 if ((palm_err == -ENODEV) && (lap_err == -ENODEV))
10245 /* Otherwise, if there was an error return it */
10246 if (palm_err && (palm_err != -ENODEV))
10248 if (lap_err && (lap_err != -ENODEV))
10254 static struct ibm_struct proxsensor_driver_data = {
10255 .name = "proximity-sensor",
10258 /*************************************************************************
10259 * DYTC Platform Profile interface
10262 #define DYTC_CMD_SET 1 /* To enable/disable IC function mode */
10263 #define DYTC_CMD_MMC_GET 8 /* To get current MMC function and mode */
10264 #define DYTC_CMD_RESET 0x1ff /* To reset back to default */
10266 #define DYTC_CMD_FUNC_CAP 3 /* To get DYTC capabilities */
10267 #define DYTC_FC_MMC 27 /* MMC Mode supported */
10268 #define DYTC_FC_PSC 29 /* PSC Mode supported */
10270 #define DYTC_GET_FUNCTION_BIT 8 /* Bits 8-11 - function setting */
10271 #define DYTC_GET_MODE_BIT 12 /* Bits 12-15 - mode setting */
10273 #define DYTC_SET_FUNCTION_BIT 12 /* Bits 12-15 - function setting */
10274 #define DYTC_SET_MODE_BIT 16 /* Bits 16-19 - mode setting */
10275 #define DYTC_SET_VALID_BIT 20 /* Bit 20 - 1 = on, 0 = off */
10277 #define DYTC_FUNCTION_STD 0 /* Function = 0, standard mode */
10278 #define DYTC_FUNCTION_CQL 1 /* Function = 1, lap mode */
10279 #define DYTC_FUNCTION_MMC 11 /* Function = 11, MMC mode */
10280 #define DYTC_FUNCTION_PSC 13 /* Function = 13, PSC mode */
10282 #define DYTC_MODE_MMC_PERFORM 2 /* High power mode aka performance */
10283 #define DYTC_MODE_MMC_LOWPOWER 3 /* Low power mode */
10284 #define DYTC_MODE_MMC_BALANCE 0xF /* Default mode aka balanced */
10285 #define DYTC_MODE_MMC_DEFAULT 0 /* Default mode from MMC_GET, aka balanced */
10287 #define DYTC_MODE_PSC_LOWPOWER 3 /* Low power mode */
10288 #define DYTC_MODE_PSC_BALANCE 5 /* Default mode aka balanced */
10289 #define DYTC_MODE_PSC_PERFORM 7 /* High power mode aka performance */
10291 #define DYTC_ERR_MASK 0xF /* Bits 0-3 in cmd result are the error result */
10292 #define DYTC_ERR_SUCCESS 1 /* CMD completed successful */
10294 #define DYTC_SET_COMMAND(function, mode, on) \
10295 (DYTC_CMD_SET | (function) << DYTC_SET_FUNCTION_BIT | \
10296 (mode) << DYTC_SET_MODE_BIT | \
10297 (on) << DYTC_SET_VALID_BIT)
10299 #define DYTC_DISABLE_CQL DYTC_SET_COMMAND(DYTC_FUNCTION_CQL, DYTC_MODE_MMC_BALANCE, 0)
10300 #define DYTC_ENABLE_CQL DYTC_SET_COMMAND(DYTC_FUNCTION_CQL, DYTC_MODE_MMC_BALANCE, 1)
10302 enum dytc_profile_funcmode {
10303 DYTC_FUNCMODE_NONE = 0,
10308 static enum dytc_profile_funcmode dytc_profile_available;
10309 static enum platform_profile_option dytc_current_profile;
10310 static atomic_t dytc_ignore_event = ATOMIC_INIT(0);
10311 static DEFINE_MUTEX(dytc_mutex);
10312 static bool dytc_mmc_get_available;
10314 static int convert_dytc_to_profile(int dytcmode, enum platform_profile_option *profile)
10316 if (dytc_profile_available == DYTC_FUNCMODE_MMC) {
10317 switch (dytcmode) {
10318 case DYTC_MODE_MMC_LOWPOWER:
10319 *profile = PLATFORM_PROFILE_LOW_POWER;
10321 case DYTC_MODE_MMC_DEFAULT:
10322 case DYTC_MODE_MMC_BALANCE:
10323 *profile = PLATFORM_PROFILE_BALANCED;
10325 case DYTC_MODE_MMC_PERFORM:
10326 *profile = PLATFORM_PROFILE_PERFORMANCE;
10328 default: /* Unknown mode */
10333 if (dytc_profile_available == DYTC_FUNCMODE_PSC) {
10334 switch (dytcmode) {
10335 case DYTC_MODE_PSC_LOWPOWER:
10336 *profile = PLATFORM_PROFILE_LOW_POWER;
10338 case DYTC_MODE_PSC_BALANCE:
10339 *profile = PLATFORM_PROFILE_BALANCED;
10341 case DYTC_MODE_PSC_PERFORM:
10342 *profile = PLATFORM_PROFILE_PERFORMANCE;
10344 default: /* Unknown mode */
10351 static int convert_profile_to_dytc(enum platform_profile_option profile, int *perfmode)
10354 case PLATFORM_PROFILE_LOW_POWER:
10355 if (dytc_profile_available == DYTC_FUNCMODE_MMC)
10356 *perfmode = DYTC_MODE_MMC_LOWPOWER;
10357 else if (dytc_profile_available == DYTC_FUNCMODE_PSC)
10358 *perfmode = DYTC_MODE_PSC_LOWPOWER;
10360 case PLATFORM_PROFILE_BALANCED:
10361 if (dytc_profile_available == DYTC_FUNCMODE_MMC)
10362 *perfmode = DYTC_MODE_MMC_BALANCE;
10363 else if (dytc_profile_available == DYTC_FUNCMODE_PSC)
10364 *perfmode = DYTC_MODE_PSC_BALANCE;
10366 case PLATFORM_PROFILE_PERFORMANCE:
10367 if (dytc_profile_available == DYTC_FUNCMODE_MMC)
10368 *perfmode = DYTC_MODE_MMC_PERFORM;
10369 else if (dytc_profile_available == DYTC_FUNCMODE_PSC)
10370 *perfmode = DYTC_MODE_PSC_PERFORM;
10372 default: /* Unknown profile */
10373 return -EOPNOTSUPP;
10379 * dytc_profile_get: Function to register with platform_profile
10380 * handler. Returns current platform profile.
10382 static int dytc_profile_get(struct platform_profile_handler *pprof,
10383 enum platform_profile_option *profile)
10385 *profile = dytc_current_profile;
10390 * Helper function - check if we are in CQL mode and if we are
10392 * - run the command
10394 * If not in CQL mode, just run the command
10396 static int dytc_cql_command(int command, int *output)
10398 int err, cmd_err, dummy;
10401 /* Determine if we are in CQL mode. This alters the commands we do */
10402 err = dytc_command(DYTC_CMD_GET, output);
10406 cur_funcmode = (*output >> DYTC_GET_FUNCTION_BIT) & 0xF;
10407 /* Check if we're OK to return immediately */
10408 if ((command == DYTC_CMD_GET) && (cur_funcmode != DYTC_FUNCTION_CQL))
10411 if (cur_funcmode == DYTC_FUNCTION_CQL) {
10412 atomic_inc(&dytc_ignore_event);
10413 err = dytc_command(DYTC_DISABLE_CQL, &dummy);
10418 cmd_err = dytc_command(command, output);
10419 /* Check return condition after we've restored CQL state */
10421 if (cur_funcmode == DYTC_FUNCTION_CQL) {
10422 err = dytc_command(DYTC_ENABLE_CQL, &dummy);
10430 * dytc_profile_set: Function to register with platform_profile
10431 * handler. Sets current platform profile.
10433 static int dytc_profile_set(struct platform_profile_handler *pprof,
10434 enum platform_profile_option profile)
10440 err = mutex_lock_interruptible(&dytc_mutex);
10444 err = convert_profile_to_dytc(profile, &perfmode);
10448 if (dytc_profile_available == DYTC_FUNCMODE_MMC) {
10449 if (profile == PLATFORM_PROFILE_BALANCED) {
10451 * To get back to balanced mode we need to issue a reset command.
10452 * Note we still need to disable CQL mode before hand and re-enable
10453 * it afterwards, otherwise dytc_lapmode gets reset to 0 and stays
10454 * stuck at 0 for aprox. 30 minutes.
10456 err = dytc_cql_command(DYTC_CMD_RESET, &output);
10460 /* Determine if we are in CQL mode. This alters the commands we do */
10461 err = dytc_cql_command(DYTC_SET_COMMAND(DYTC_FUNCTION_MMC, perfmode, 1),
10467 if (dytc_profile_available == DYTC_FUNCMODE_PSC) {
10468 err = dytc_command(DYTC_SET_COMMAND(DYTC_FUNCTION_PSC, perfmode, 1), &output);
10472 /* Success - update current profile */
10473 dytc_current_profile = profile;
10475 mutex_unlock(&dytc_mutex);
10479 static void dytc_profile_refresh(void)
10481 enum platform_profile_option profile;
10482 int output, err = 0;
10485 mutex_lock(&dytc_mutex);
10486 if (dytc_profile_available == DYTC_FUNCMODE_MMC) {
10487 if (dytc_mmc_get_available)
10488 err = dytc_command(DYTC_CMD_MMC_GET, &output);
10490 err = dytc_cql_command(DYTC_CMD_GET, &output);
10491 } else if (dytc_profile_available == DYTC_FUNCMODE_PSC)
10492 err = dytc_command(DYTC_CMD_GET, &output);
10494 mutex_unlock(&dytc_mutex);
10498 perfmode = (output >> DYTC_GET_MODE_BIT) & 0xF;
10499 convert_dytc_to_profile(perfmode, &profile);
10500 if (profile != dytc_current_profile) {
10501 dytc_current_profile = profile;
10502 platform_profile_notify();
10506 static struct platform_profile_handler dytc_profile = {
10507 .profile_get = dytc_profile_get,
10508 .profile_set = dytc_profile_set,
10511 static int tpacpi_dytc_profile_init(struct ibm_init_struct *iibm)
10515 /* Setup supported modes */
10516 set_bit(PLATFORM_PROFILE_LOW_POWER, dytc_profile.choices);
10517 set_bit(PLATFORM_PROFILE_BALANCED, dytc_profile.choices);
10518 set_bit(PLATFORM_PROFILE_PERFORMANCE, dytc_profile.choices);
10520 dytc_profile_available = DYTC_FUNCMODE_NONE;
10521 err = dytc_command(DYTC_CMD_QUERY, &output);
10525 if (output & BIT(DYTC_QUERY_ENABLE_BIT))
10526 dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
10528 /* Check DYTC is enabled and supports mode setting */
10529 if (dytc_version < 5)
10532 /* Check what capabilities are supported */
10533 err = dytc_command(DYTC_CMD_FUNC_CAP, &output);
10537 if (output & BIT(DYTC_FC_MMC)) { /* MMC MODE */
10538 dytc_profile_available = DYTC_FUNCMODE_MMC;
10541 * Check if MMC_GET functionality available
10542 * Version > 6 and return success from MMC_GET command
10544 dytc_mmc_get_available = false;
10545 if (dytc_version >= 6) {
10546 err = dytc_command(DYTC_CMD_MMC_GET, &output);
10547 if (!err && ((output & DYTC_ERR_MASK) == DYTC_ERR_SUCCESS))
10548 dytc_mmc_get_available = true;
10550 } else if (output & BIT(DYTC_FC_PSC)) { /* PSC MODE */
10551 dytc_profile_available = DYTC_FUNCMODE_PSC;
10553 dbg_printk(TPACPI_DBG_INIT, "No DYTC support available\n");
10557 dbg_printk(TPACPI_DBG_INIT,
10558 "DYTC version %d: thermal mode available\n", dytc_version);
10560 /* Create platform_profile structure and register */
10561 err = platform_profile_register(&dytc_profile);
10563 * If for some reason platform_profiles aren't enabled
10564 * don't quit terminally.
10569 /* Ensure initial values are correct */
10570 dytc_profile_refresh();
10575 static void dytc_profile_exit(void)
10577 dytc_profile_available = DYTC_FUNCMODE_NONE;
10578 platform_profile_remove();
10581 static struct ibm_struct dytc_profile_driver_data = {
10582 .name = "dytc-profile",
10583 .exit = dytc_profile_exit,
10586 /*************************************************************************
10587 * Keyboard language interface
10590 struct keyboard_lang_data {
10591 const char *lang_str;
10595 static const struct keyboard_lang_data keyboard_lang_data[] = {
10617 static int set_keyboard_lang_command(int command)
10619 acpi_handle sskl_handle;
10622 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "SSKL", &sskl_handle))) {
10623 /* Platform doesn't support SSKL */
10627 if (!acpi_evalf(sskl_handle, &output, NULL, "dd", command))
10633 static int get_keyboard_lang(int *output)
10635 acpi_handle gskl_handle;
10638 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GSKL", &gskl_handle))) {
10639 /* Platform doesn't support GSKL */
10643 if (!acpi_evalf(gskl_handle, &kbd_lang, NULL, "dd", 0x02000000))
10647 * METHOD_ERR gets returned on devices where there are no special (e.g. '=',
10648 * '(' and ')') keys which use layout dependent key-press emulation.
10650 if (kbd_lang & METHOD_ERR)
10653 *output = kbd_lang;
10658 /* sysfs keyboard language entry */
10659 static ssize_t keyboard_lang_show(struct device *dev,
10660 struct device_attribute *attr,
10663 int output, err, i, len = 0;
10665 err = get_keyboard_lang(&output);
10669 for (i = 0; i < ARRAY_SIZE(keyboard_lang_data); i++) {
10671 len += sysfs_emit_at(buf, len, "%s", " ");
10673 if (output == keyboard_lang_data[i].lang_code) {
10674 len += sysfs_emit_at(buf, len, "[%s]", keyboard_lang_data[i].lang_str);
10676 len += sysfs_emit_at(buf, len, "%s", keyboard_lang_data[i].lang_str);
10679 len += sysfs_emit_at(buf, len, "\n");
10684 static ssize_t keyboard_lang_store(struct device *dev,
10685 struct device_attribute *attr,
10686 const char *buf, size_t count)
10689 bool lang_found = false;
10692 for (i = 0; i < ARRAY_SIZE(keyboard_lang_data); i++) {
10693 if (sysfs_streq(buf, keyboard_lang_data[i].lang_str)) {
10694 lang_code = keyboard_lang_data[i].lang_code;
10701 lang_code = lang_code | 1 << 24;
10703 /* Set language code */
10704 err = set_keyboard_lang_command(lang_code);
10708 dev_err(&tpacpi_pdev->dev, "Unknown Keyboard language. Ignoring\n");
10712 tpacpi_disclose_usertask(attr->attr.name,
10713 "keyboard language is set to %s\n", buf);
10715 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "keyboard_lang");
10719 static DEVICE_ATTR_RW(keyboard_lang);
10721 static struct attribute *kbdlang_attributes[] = {
10722 &dev_attr_keyboard_lang.attr,
10726 static umode_t kbdlang_attr_is_visible(struct kobject *kobj,
10727 struct attribute *attr, int n)
10729 return tp_features.kbd_lang ? attr->mode : 0;
10732 static const struct attribute_group kbdlang_attr_group = {
10733 .is_visible = kbdlang_attr_is_visible,
10734 .attrs = kbdlang_attributes,
10737 static int tpacpi_kbdlang_init(struct ibm_init_struct *iibm)
10741 err = get_keyboard_lang(&output);
10742 tp_features.kbd_lang = !err;
10746 static struct ibm_struct kbdlang_driver_data = {
10750 /*************************************************************************
10751 * DPRC(Dynamic Power Reduction Control) subdriver, for the Lenovo WWAN
10752 * and WLAN feature.
10754 #define DPRC_GET_WWAN_ANTENNA_TYPE 0x40000
10755 #define DPRC_WWAN_ANTENNA_TYPE_A_BIT BIT(4)
10756 #define DPRC_WWAN_ANTENNA_TYPE_B_BIT BIT(8)
10757 static bool has_antennatype;
10758 static int wwan_antennatype;
10760 static int dprc_command(int command, int *output)
10762 acpi_handle dprc_handle;
10764 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DPRC", &dprc_handle))) {
10765 /* Platform doesn't support DPRC */
10769 if (!acpi_evalf(dprc_handle, output, NULL, "dd", command))
10773 * METHOD_ERR gets returned on devices where few commands are not supported
10774 * for example command to get WWAN Antenna type command is not supported on
10777 if (*output & METHOD_ERR)
10783 static int get_wwan_antenna(int *wwan_antennatype)
10787 /* Get current Antenna type */
10788 err = dprc_command(DPRC_GET_WWAN_ANTENNA_TYPE, &output);
10792 if (output & DPRC_WWAN_ANTENNA_TYPE_A_BIT)
10793 *wwan_antennatype = 1;
10794 else if (output & DPRC_WWAN_ANTENNA_TYPE_B_BIT)
10795 *wwan_antennatype = 2;
10802 /* sysfs wwan antenna type entry */
10803 static ssize_t wwan_antenna_type_show(struct device *dev,
10804 struct device_attribute *attr,
10807 switch (wwan_antennatype) {
10809 return sysfs_emit(buf, "type a\n");
10811 return sysfs_emit(buf, "type b\n");
10816 static DEVICE_ATTR_RO(wwan_antenna_type);
10818 static struct attribute *dprc_attributes[] = {
10819 &dev_attr_wwan_antenna_type.attr,
10823 static umode_t dprc_attr_is_visible(struct kobject *kobj,
10824 struct attribute *attr, int n)
10826 return has_antennatype ? attr->mode : 0;
10829 static const struct attribute_group dprc_attr_group = {
10830 .is_visible = dprc_attr_is_visible,
10831 .attrs = dprc_attributes,
10834 static int tpacpi_dprc_init(struct ibm_init_struct *iibm)
10838 err = get_wwan_antenna(&wwan_antennatype);
10842 has_antennatype = true;
10846 static struct ibm_struct dprc_driver_data = {
10850 /* --------------------------------------------------------------------- */
10852 static struct attribute *tpacpi_driver_attributes[] = {
10853 &driver_attr_debug_level.attr,
10854 &driver_attr_version.attr,
10855 &driver_attr_interface_version.attr,
10856 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10857 &driver_attr_wlsw_emulstate.attr,
10858 &driver_attr_bluetooth_emulstate.attr,
10859 &driver_attr_wwan_emulstate.attr,
10860 &driver_attr_uwb_emulstate.attr,
10865 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10866 static umode_t tpacpi_attr_is_visible(struct kobject *kobj,
10867 struct attribute *attr, int n)
10869 if (attr == &driver_attr_wlsw_emulstate.attr) {
10872 } else if (attr == &driver_attr_bluetooth_emulstate.attr) {
10873 if (!dbg_bluetoothemul)
10875 } else if (attr == &driver_attr_wwan_emulstate.attr) {
10878 } else if (attr == &driver_attr_uwb_emulstate.attr) {
10887 static const struct attribute_group tpacpi_driver_attr_group = {
10888 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10889 .is_visible = tpacpi_attr_is_visible,
10891 .attrs = tpacpi_driver_attributes,
10894 static const struct attribute_group *tpacpi_driver_groups[] = {
10895 &tpacpi_driver_attr_group,
10899 static const struct attribute_group *tpacpi_groups[] = {
10900 &adaptive_kbd_attr_group,
10901 &hotkey_attr_group,
10902 &bluetooth_attr_group,
10905 &proxsensor_attr_group,
10906 &kbdlang_attr_group,
10911 static const struct attribute_group *tpacpi_hwmon_groups[] = {
10912 &thermal_attr_group,
10913 &temp_label_attr_group,
10918 static const struct attribute_group *tpacpi_hwmon_driver_groups[] = {
10919 &fan_driver_attr_group,
10923 /****************************************************************************
10924 ****************************************************************************
10928 ****************************************************************************
10929 ****************************************************************************/
10931 static struct platform_driver tpacpi_pdriver = {
10933 .name = TPACPI_DRVR_NAME,
10935 .groups = tpacpi_driver_groups,
10936 .dev_groups = tpacpi_groups,
10938 .shutdown = tpacpi_shutdown_handler,
10941 static struct platform_driver tpacpi_hwmon_pdriver = {
10943 .name = TPACPI_HWMON_DRVR_NAME,
10944 .groups = tpacpi_hwmon_driver_groups,
10948 /****************************************************************************
10949 ****************************************************************************
10953 ****************************************************************************
10954 ****************************************************************************/
10957 * HKEY event callout for other subdrivers go here
10958 * (yes, it is ugly, but it is quick, safe, and gets the job done
10960 static void tpacpi_driver_event(const unsigned int hkey_event)
10962 if (ibm_backlight_device) {
10963 switch (hkey_event) {
10964 case TP_HKEY_EV_BRGHT_UP:
10965 case TP_HKEY_EV_BRGHT_DOWN:
10966 tpacpi_brightness_notify_change();
10970 switch (hkey_event) {
10971 case TP_HKEY_EV_VOL_UP:
10972 case TP_HKEY_EV_VOL_DOWN:
10973 case TP_HKEY_EV_VOL_MUTE:
10974 volume_alsa_notify_change();
10977 if (tp_features.kbdlight && hkey_event == TP_HKEY_EV_KBD_LIGHT) {
10978 enum led_brightness brightness;
10980 mutex_lock(&kbdlight_mutex);
10983 * Check the brightness actually changed, setting the brightness
10984 * through kbdlight_set_level() also triggers this event.
10986 brightness = kbdlight_sysfs_get(NULL);
10987 if (kbdlight_brightness != brightness) {
10988 kbdlight_brightness = brightness;
10989 led_classdev_notify_brightness_hw_changed(
10990 &tpacpi_led_kbdlight.led_classdev, brightness);
10993 mutex_unlock(&kbdlight_mutex);
10996 if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED) {
10997 lapsensor_refresh();
10998 /* If we are already accessing DYTC then skip dytc update */
10999 if (!atomic_add_unless(&dytc_ignore_event, -1, 0))
11000 dytc_profile_refresh();
11003 if (lcdshadow_dev && hkey_event == TP_HKEY_EV_PRIVACYGUARD_TOGGLE) {
11004 enum drm_privacy_screen_status old_hw_state;
11007 mutex_lock(&lcdshadow_dev->lock);
11008 old_hw_state = lcdshadow_dev->hw_state;
11009 lcdshadow_get_hw_state(lcdshadow_dev);
11010 changed = lcdshadow_dev->hw_state != old_hw_state;
11011 mutex_unlock(&lcdshadow_dev->lock);
11014 drm_privacy_screen_call_notifier_chain(lcdshadow_dev);
11018 static void hotkey_driver_event(const unsigned int scancode)
11020 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
11023 /* --------------------------------------------------------------------- */
11025 /* /proc support */
11026 static struct proc_dir_entry *proc_dir;
11029 * Module and infrastructure proble, init and exit handling
11032 static bool force_load;
11034 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
11035 static const char * __init str_supported(int is_supported)
11037 static char text_unsupported[] __initdata = "not supported";
11039 return (is_supported) ? &text_unsupported[4] : &text_unsupported[0];
11041 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
11043 static void ibm_exit(struct ibm_struct *ibm)
11045 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
11047 list_del_init(&ibm->all_drivers);
11049 if (ibm->flags.acpi_notify_installed) {
11050 dbg_printk(TPACPI_DBG_EXIT,
11051 "%s: acpi_remove_notify_handler\n", ibm->name);
11052 BUG_ON(!ibm->acpi);
11053 acpi_remove_notify_handler(*ibm->acpi->handle,
11055 dispatch_acpi_notify);
11056 ibm->flags.acpi_notify_installed = 0;
11059 if (ibm->flags.proc_created) {
11060 dbg_printk(TPACPI_DBG_EXIT,
11061 "%s: remove_proc_entry\n", ibm->name);
11062 remove_proc_entry(ibm->name, proc_dir);
11063 ibm->flags.proc_created = 0;
11066 if (ibm->flags.acpi_driver_registered) {
11067 dbg_printk(TPACPI_DBG_EXIT,
11068 "%s: acpi_bus_unregister_driver\n", ibm->name);
11069 BUG_ON(!ibm->acpi);
11070 acpi_bus_unregister_driver(ibm->acpi->driver);
11071 kfree(ibm->acpi->driver);
11072 ibm->acpi->driver = NULL;
11073 ibm->flags.acpi_driver_registered = 0;
11076 if (ibm->flags.init_called && ibm->exit) {
11078 ibm->flags.init_called = 0;
11081 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
11084 static int __init ibm_init(struct ibm_init_struct *iibm)
11087 struct ibm_struct *ibm = iibm->data;
11088 struct proc_dir_entry *entry;
11090 BUG_ON(ibm == NULL);
11092 INIT_LIST_HEAD(&ibm->all_drivers);
11094 if (ibm->flags.experimental && !experimental)
11097 dbg_printk(TPACPI_DBG_INIT,
11098 "probing for %s\n", ibm->name);
11101 ret = iibm->init(iibm);
11102 if (ret > 0 || ret == -ENODEV)
11103 return 0; /* subdriver functionality not available */
11107 ibm->flags.init_called = 1;
11111 if (ibm->acpi->hid) {
11112 ret = register_tpacpi_subdriver(ibm);
11117 if (ibm->acpi->notify) {
11118 ret = setup_acpi_notify(ibm);
11119 if (ret == -ENODEV) {
11120 pr_notice("disabling subdriver %s\n",
11130 dbg_printk(TPACPI_DBG_INIT,
11131 "%s installed\n", ibm->name);
11134 umode_t mode = iibm->base_procfs_mode;
11140 entry = proc_create_data(ibm->name, mode, proc_dir,
11141 &dispatch_proc_ops, ibm);
11143 pr_err("unable to create proc entry %s\n", ibm->name);
11147 ibm->flags.proc_created = 1;
11150 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
11155 dbg_printk(TPACPI_DBG_INIT,
11156 "%s: at error exit path with result %d\n",
11160 return (ret < 0) ? ret : 0;
11165 static char __init tpacpi_parse_fw_id(const char * const s,
11166 u32 *model, u16 *release)
11170 if (!s || strlen(s) < 8)
11173 for (i = 0; i < 8; i++)
11174 if (!((s[i] >= '0' && s[i] <= '9') ||
11175 (s[i] >= 'A' && s[i] <= 'Z')))
11179 * Most models: xxyTkkWW (#.##c)
11180 * Ancient 570/600 and -SL lacks (#.##c)
11182 if (s[3] == 'T' || s[3] == 'N') {
11183 *model = TPID(s[0], s[1]);
11184 *release = TPVER(s[4], s[5]);
11187 /* New models: xxxyTkkW (#.##c); T550 and some others */
11188 } else if (s[4] == 'T' || s[4] == 'N') {
11189 *model = TPID3(s[0], s[1], s[2]);
11190 *release = TPVER(s[5], s[6]);
11198 static void find_new_ec_fwstr(const struct dmi_header *dm, void *private)
11200 char *ec_fw_string = (char *) private;
11201 const char *dmi_data = (const char *)dm;
11203 * ThinkPad Embedded Controller Program Table on newer models
11205 * Offset | Name | Width | Description
11206 * ----------------------------------------------------
11207 * 0x00 | Type | BYTE | 0x8C
11208 * 0x01 | Length | BYTE |
11209 * 0x02 | Handle | WORD | Varies
11210 * 0x04 | Signature | BYTEx6 | ASCII for "LENOVO"
11211 * 0x0A | OEM struct offset | BYTE | 0x0B
11212 * 0x0B | OEM struct number | BYTE | 0x07, for this structure
11213 * 0x0C | OEM struct revision | BYTE | 0x01, for this format
11214 * 0x0D | ECP version ID | STR ID |
11215 * 0x0E | ECP release date | STR ID |
11218 /* Return if data structure not match */
11219 if (dm->type != 140 || dm->length < 0x0F ||
11220 memcmp(dmi_data + 4, "LENOVO", 6) != 0 ||
11221 dmi_data[0x0A] != 0x0B || dmi_data[0x0B] != 0x07 ||
11222 dmi_data[0x0C] != 0x01)
11225 /* fwstr is the first 8byte string */
11226 strncpy(ec_fw_string, dmi_data + 0x0F, 8);
11229 /* returns 0 - probe ok, or < 0 - probe error.
11230 * Probe ok doesn't mean thinkpad found.
11231 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
11232 static int __must_check __init get_thinkpad_model_data(
11233 struct thinkpad_id_data *tp)
11235 const struct dmi_device *dev = NULL;
11236 char ec_fw_string[18] = {0};
11243 memset(tp, 0, sizeof(*tp));
11245 if (dmi_name_in_vendors("IBM"))
11246 tp->vendor = PCI_VENDOR_ID_IBM;
11247 else if (dmi_name_in_vendors("LENOVO"))
11248 tp->vendor = PCI_VENDOR_ID_LENOVO;
11252 s = dmi_get_system_info(DMI_BIOS_VERSION);
11253 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
11254 if (s && !tp->bios_version_str)
11257 /* Really ancient ThinkPad 240X will fail this, which is fine */
11258 t = tpacpi_parse_fw_id(tp->bios_version_str,
11259 &tp->bios_model, &tp->bios_release);
11260 if (t != 'E' && t != 'C')
11264 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
11265 * X32 or newer, all Z series; Some models must have an
11266 * up-to-date BIOS or they will not be detected.
11268 * See https://thinkwiki.org/wiki/List_of_DMI_IDs
11270 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
11271 if (sscanf(dev->name,
11272 "IBM ThinkPad Embedded Controller -[%17c",
11273 ec_fw_string) == 1) {
11274 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
11275 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
11280 /* Newer ThinkPads have different EC program info table */
11281 if (!ec_fw_string[0])
11282 dmi_walk(find_new_ec_fwstr, &ec_fw_string);
11284 if (ec_fw_string[0]) {
11285 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
11286 if (!tp->ec_version_str)
11289 t = tpacpi_parse_fw_id(ec_fw_string,
11290 &tp->ec_model, &tp->ec_release);
11292 pr_notice("ThinkPad firmware release %s doesn't match the known patterns\n",
11294 pr_notice("please report this to %s\n", TPACPI_MAIL);
11298 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
11299 if (s && !(strncasecmp(s, "ThinkPad", 8) && strncasecmp(s, "Lenovo", 6))) {
11300 tp->model_str = kstrdup(s, GFP_KERNEL);
11301 if (!tp->model_str)
11304 s = dmi_get_system_info(DMI_BIOS_VENDOR);
11305 if (s && !(strncasecmp(s, "Lenovo", 6))) {
11306 tp->model_str = kstrdup(s, GFP_KERNEL);
11307 if (!tp->model_str)
11312 s = dmi_get_system_info(DMI_PRODUCT_NAME);
11313 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
11314 if (s && !tp->nummodel_str)
11320 static int __init probe_for_thinkpad(void)
11327 /* It would be dangerous to run the driver in this case */
11328 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
11332 * Non-ancient models have better DMI tagging, but very old models
11333 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
11335 is_thinkpad = (thinkpad_id.model_str != NULL) ||
11336 (thinkpad_id.ec_model != 0) ||
11337 tpacpi_is_fw_known();
11339 /* The EC handler is required */
11340 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
11343 pr_err("Not yet supported ThinkPad detected!\n");
11347 if (!is_thinkpad && !force_load)
11353 static void __init thinkpad_acpi_init_banner(void)
11355 pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
11356 pr_info("%s\n", TPACPI_URL);
11358 pr_info("ThinkPad BIOS %s, EC %s\n",
11359 (thinkpad_id.bios_version_str) ?
11360 thinkpad_id.bios_version_str : "unknown",
11361 (thinkpad_id.ec_version_str) ?
11362 thinkpad_id.ec_version_str : "unknown");
11364 BUG_ON(!thinkpad_id.vendor);
11366 if (thinkpad_id.model_str)
11367 pr_info("%s %s, model %s\n",
11368 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
11369 "IBM" : ((thinkpad_id.vendor ==
11370 PCI_VENDOR_ID_LENOVO) ?
11371 "Lenovo" : "Unknown vendor"),
11372 thinkpad_id.model_str,
11373 (thinkpad_id.nummodel_str) ?
11374 thinkpad_id.nummodel_str : "unknown");
11377 /* Module init, exit, parameters */
11379 static struct ibm_init_struct ibms_init[] __initdata = {
11381 .data = &thinkpad_acpi_driver_data,
11384 .init = hotkey_init,
11385 .data = &hotkey_driver_data,
11388 .init = bluetooth_init,
11389 .data = &bluetooth_driver_data,
11393 .data = &wan_driver_data,
11397 .data = &uwb_driver_data,
11399 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
11401 .init = video_init,
11402 .base_procfs_mode = S_IRUSR,
11403 .data = &video_driver_data,
11407 .init = kbdlight_init,
11408 .data = &kbdlight_driver_data,
11411 .init = light_init,
11412 .data = &light_driver_data,
11416 .data = &cmos_driver_data,
11420 .data = &led_driver_data,
11424 .data = &beep_driver_data,
11427 .init = thermal_init,
11428 .data = &thermal_driver_data,
11431 .init = brightness_init,
11432 .data = &brightness_driver_data,
11435 .init = volume_init,
11436 .data = &volume_driver_data,
11440 .data = &fan_driver_data,
11443 .init = mute_led_init,
11444 .data = &mute_led_driver_data,
11447 .init = tpacpi_battery_init,
11448 .data = &battery_driver_data,
11451 .init = tpacpi_lcdshadow_init,
11452 .data = &lcdshadow_driver_data,
11455 .init = tpacpi_proxsensor_init,
11456 .data = &proxsensor_driver_data,
11459 .init = tpacpi_dytc_profile_init,
11460 .data = &dytc_profile_driver_data,
11463 .init = tpacpi_kbdlang_init,
11464 .data = &kbdlang_driver_data,
11467 .init = tpacpi_dprc_init,
11468 .data = &dprc_driver_data,
11472 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
11475 struct ibm_struct *ibm;
11477 if (!kp || !kp->name || !val)
11480 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
11481 ibm = ibms_init[i].data;
11482 if (!ibm || !ibm->name)
11485 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
11486 if (strlen(val) > sizeof(ibms_init[i].param) - 1)
11488 strcpy(ibms_init[i].param, val);
11496 module_param(experimental, int, 0444);
11497 MODULE_PARM_DESC(experimental,
11498 "Enables experimental features when non-zero");
11500 module_param_named(debug, dbg_level, uint, 0);
11501 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
11503 module_param(force_load, bool, 0444);
11504 MODULE_PARM_DESC(force_load,
11505 "Attempts to load the driver even on a mis-identified ThinkPad when true");
11507 module_param_named(fan_control, fan_control_allowed, bool, 0444);
11508 MODULE_PARM_DESC(fan_control,
11509 "Enables setting fan parameters features when true");
11511 module_param_named(brightness_mode, brightness_mode, uint, 0444);
11512 MODULE_PARM_DESC(brightness_mode,
11513 "Selects brightness control strategy: 0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
11515 module_param(brightness_enable, uint, 0444);
11516 MODULE_PARM_DESC(brightness_enable,
11517 "Enables backlight control when 1, disables when 0");
11519 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
11520 module_param_named(volume_mode, volume_mode, uint, 0444);
11521 MODULE_PARM_DESC(volume_mode,
11522 "Selects volume control strategy: 0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
11524 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
11525 MODULE_PARM_DESC(volume_capabilities,
11526 "Selects the mixer capabilities: 0=auto, 1=volume and mute, 2=mute only");
11528 module_param_named(volume_control, volume_control_allowed, bool, 0444);
11529 MODULE_PARM_DESC(volume_control,
11530 "Enables software override for the console audio control when true");
11532 module_param_named(software_mute, software_mute_requested, bool, 0444);
11533 MODULE_PARM_DESC(software_mute,
11534 "Request full software mute control");
11536 /* ALSA module API parameters */
11537 module_param_named(index, alsa_index, int, 0444);
11538 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
11539 module_param_named(id, alsa_id, charp, 0444);
11540 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
11541 module_param_named(enable, alsa_enable, bool, 0444);
11542 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
11543 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
11545 /* The module parameter can't be read back, that's why 0 is used here */
11546 #define TPACPI_PARAM(feature) \
11547 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
11548 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command at module load, see documentation")
11550 TPACPI_PARAM(hotkey);
11551 TPACPI_PARAM(bluetooth);
11552 TPACPI_PARAM(video);
11553 TPACPI_PARAM(light);
11554 TPACPI_PARAM(cmos);
11556 TPACPI_PARAM(beep);
11557 TPACPI_PARAM(brightness);
11558 TPACPI_PARAM(volume);
11561 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
11562 module_param(dbg_wlswemul, uint, 0444);
11563 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
11564 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
11565 MODULE_PARM_DESC(wlsw_state,
11566 "Initial state of the emulated WLSW switch");
11568 module_param(dbg_bluetoothemul, uint, 0444);
11569 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
11570 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
11571 MODULE_PARM_DESC(bluetooth_state,
11572 "Initial state of the emulated bluetooth switch");
11574 module_param(dbg_wwanemul, uint, 0444);
11575 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
11576 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
11577 MODULE_PARM_DESC(wwan_state,
11578 "Initial state of the emulated WWAN switch");
11580 module_param(dbg_uwbemul, uint, 0444);
11581 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
11582 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
11583 MODULE_PARM_DESC(uwb_state,
11584 "Initial state of the emulated UWB switch");
11587 static void thinkpad_acpi_module_exit(void)
11589 struct ibm_struct *ibm, *itmp;
11591 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
11593 #ifdef CONFIG_SUSPEND
11594 if (tp_features.quirks && tp_features.quirks->s2idle_bug_mmio)
11595 acpi_unregister_lps0_dev(&thinkpad_acpi_s2idle_dev_ops);
11598 hwmon_device_unregister(tpacpi_hwmon);
11599 if (tp_features.sensors_pdrv_registered)
11600 platform_driver_unregister(&tpacpi_hwmon_pdriver);
11601 if (tp_features.platform_drv_registered)
11602 platform_driver_unregister(&tpacpi_pdriver);
11604 list_for_each_entry_safe_reverse(ibm, itmp,
11605 &tpacpi_all_drivers,
11610 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
11612 if (tpacpi_inputdev) {
11613 if (tp_features.input_device_registered)
11614 input_unregister_device(tpacpi_inputdev);
11616 input_free_device(tpacpi_inputdev);
11617 kfree(hotkey_keycode_map);
11620 if (tpacpi_sensors_pdev)
11621 platform_device_unregister(tpacpi_sensors_pdev);
11623 platform_device_unregister(tpacpi_pdev);
11625 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
11627 destroy_workqueue(tpacpi_wq);
11629 kfree(thinkpad_id.bios_version_str);
11630 kfree(thinkpad_id.ec_version_str);
11631 kfree(thinkpad_id.model_str);
11632 kfree(thinkpad_id.nummodel_str);
11636 static int __init thinkpad_acpi_module_init(void)
11638 const struct dmi_system_id *dmi_id;
11641 tpacpi_lifecycle = TPACPI_LIFE_INIT;
11643 /* Driver-level probe */
11645 ret = get_thinkpad_model_data(&thinkpad_id);
11647 pr_err("unable to get DMI data: %d\n", ret);
11648 thinkpad_acpi_module_exit();
11651 ret = probe_for_thinkpad();
11653 thinkpad_acpi_module_exit();
11657 /* Driver initialization */
11659 thinkpad_acpi_init_banner();
11660 tpacpi_check_outdated_fw();
11662 TPACPI_ACPIHANDLE_INIT(ecrd);
11663 TPACPI_ACPIHANDLE_INIT(ecwr);
11665 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
11667 thinkpad_acpi_module_exit();
11671 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
11673 pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
11674 thinkpad_acpi_module_exit();
11678 dmi_id = dmi_first_match(fwbug_list);
11680 tp_features.quirks = dmi_id->driver_data;
11682 /* Device initialization */
11683 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
11685 if (IS_ERR(tpacpi_pdev)) {
11686 ret = PTR_ERR(tpacpi_pdev);
11687 tpacpi_pdev = NULL;
11688 pr_err("unable to register platform device\n");
11689 thinkpad_acpi_module_exit();
11692 tpacpi_sensors_pdev = platform_device_register_simple(
11693 TPACPI_HWMON_DRVR_NAME,
11695 if (IS_ERR(tpacpi_sensors_pdev)) {
11696 ret = PTR_ERR(tpacpi_sensors_pdev);
11697 tpacpi_sensors_pdev = NULL;
11698 pr_err("unable to register hwmon platform device\n");
11699 thinkpad_acpi_module_exit();
11703 mutex_init(&tpacpi_inputdev_send_mutex);
11704 tpacpi_inputdev = input_allocate_device();
11705 if (!tpacpi_inputdev) {
11706 thinkpad_acpi_module_exit();
11709 /* Prepare input device, but don't register */
11710 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
11711 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
11712 tpacpi_inputdev->id.bustype = BUS_HOST;
11713 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
11714 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
11715 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
11716 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
11719 /* Init subdriver dependencies */
11720 tpacpi_detect_brightness_capabilities();
11722 /* Init subdrivers */
11723 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
11724 ret = ibm_init(&ibms_init[i]);
11725 if (ret >= 0 && *ibms_init[i].param)
11726 ret = ibms_init[i].data->write(ibms_init[i].param);
11728 thinkpad_acpi_module_exit();
11733 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
11735 ret = platform_driver_register(&tpacpi_pdriver);
11737 pr_err("unable to register main platform driver\n");
11738 thinkpad_acpi_module_exit();
11741 tp_features.platform_drv_registered = 1;
11743 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
11745 pr_err("unable to register hwmon platform driver\n");
11746 thinkpad_acpi_module_exit();
11749 tp_features.sensors_pdrv_registered = 1;
11751 tpacpi_hwmon = hwmon_device_register_with_groups(
11752 &tpacpi_sensors_pdev->dev, TPACPI_NAME, NULL, tpacpi_hwmon_groups);
11753 if (IS_ERR(tpacpi_hwmon)) {
11754 ret = PTR_ERR(tpacpi_hwmon);
11755 tpacpi_hwmon = NULL;
11756 pr_err("unable to register hwmon device\n");
11757 thinkpad_acpi_module_exit();
11761 ret = input_register_device(tpacpi_inputdev);
11763 pr_err("unable to register input device\n");
11764 thinkpad_acpi_module_exit();
11767 tp_features.input_device_registered = 1;
11770 #ifdef CONFIG_SUSPEND
11771 if (tp_features.quirks && tp_features.quirks->s2idle_bug_mmio) {
11772 if (!acpi_register_lps0_dev(&thinkpad_acpi_s2idle_dev_ops))
11773 pr_info("Using s2idle quirk to avoid %s platform firmware bug\n",
11774 (dmi_id && dmi_id->ident) ? dmi_id->ident : "");
11780 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
11783 * This will autoload the driver in almost every ThinkPad
11784 * in widespread use.
11786 * Only _VERY_ old models, like the 240, 240x and 570 lack
11787 * the HKEY event interface.
11789 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
11792 * DMI matching for module autoloading
11794 * See https://thinkwiki.org/wiki/List_of_DMI_IDs
11795 * See https://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
11797 * Only models listed in thinkwiki will be supported, so add yours
11798 * if it is not there yet.
11800 #define IBM_BIOS_MODULE_ALIAS(__type) \
11801 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
11803 /* Ancient thinkpad BIOSes have to be identified by
11804 * BIOS type or model number, and there are far less
11805 * BIOS types than model numbers... */
11806 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
11808 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
11809 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
11810 MODULE_DESCRIPTION(TPACPI_DESC);
11811 MODULE_VERSION(TPACPI_VERSION);
11812 MODULE_LICENSE("GPL");
11814 module_init(thinkpad_acpi_module_init);
11815 module_exit(thinkpad_acpi_module_exit);