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 <sound/core.h>
70 #include <sound/control.h>
71 #include <sound/initval.h>
72 #include <linux/uaccess.h>
73 #include <acpi/battery.h>
74 #include <acpi/video.h>
76 /* ThinkPad CMOS commands */
77 #define TP_CMOS_VOLUME_DOWN 0
78 #define TP_CMOS_VOLUME_UP 1
79 #define TP_CMOS_VOLUME_MUTE 2
80 #define TP_CMOS_BRIGHTNESS_UP 4
81 #define TP_CMOS_BRIGHTNESS_DOWN 5
82 #define TP_CMOS_THINKLIGHT_ON 12
83 #define TP_CMOS_THINKLIGHT_OFF 13
87 TP_NVRAM_ADDR_HK2 = 0x57,
88 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
89 TP_NVRAM_ADDR_VIDEO = 0x59,
90 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
91 TP_NVRAM_ADDR_MIXER = 0x60,
96 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
97 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
98 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
99 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
100 TP_NVRAM_MASK_THINKLIGHT = 0x10,
101 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
102 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
103 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
104 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
105 TP_NVRAM_MASK_MUTE = 0x40,
106 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
107 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
108 TP_NVRAM_POS_LEVEL_VOLUME = 0,
111 /* Misc NVRAM-related */
113 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
117 #define TPACPI_ACPI_IBM_HKEY_HID "IBM0068"
118 #define TPACPI_ACPI_LENOVO_HKEY_HID "LEN0068"
119 #define TPACPI_ACPI_LENOVO_HKEY_V2_HID "LEN0268"
120 #define TPACPI_ACPI_EC_HID "PNP0C09"
123 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
124 #define TPACPI_HKEY_INPUT_VERSION 0x4101
126 /* ACPI \WGSV commands */
128 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
129 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
130 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
131 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
134 /* TP_ACPI_WGSV_GET_STATE bits */
136 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
137 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
138 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
139 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
140 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
141 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
142 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
143 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
144 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
145 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
149 enum tpacpi_hkey_event_t {
151 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
152 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
153 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
154 TP_HKEY_EV_KBD_LIGHT = 0x1012, /* Thinklight/kbd backlight */
155 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
156 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
157 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
159 /* Reasons for waking up from S3/S4 */
160 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
161 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
162 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
163 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
164 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
165 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
167 /* Auto-sleep after eject request */
168 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
169 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
171 /* Misc bay events */
172 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
173 TP_HKEY_EV_HOTPLUG_DOCK = 0x4010, /* docked into hotplug dock
174 or port replicator */
175 TP_HKEY_EV_HOTPLUG_UNDOCK = 0x4011, /* undocked from hotplug
176 dock or port replicator */
178 /* User-interface events */
179 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
180 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
181 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
182 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
183 TP_HKEY_EV_TABLET_CHANGED = 0x60c0, /* X1 Yoga (2016):
184 * enter/leave tablet mode
186 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
187 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
188 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
190 /* Key-related user-interface events */
191 TP_HKEY_EV_KEY_NUMLOCK = 0x6000, /* NumLock key pressed */
192 TP_HKEY_EV_KEY_FN = 0x6005, /* Fn key pressed? E420 */
193 TP_HKEY_EV_KEY_FN_ESC = 0x6060, /* Fn+Esc key pressed X240 */
196 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
197 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
198 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
199 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
200 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* windows; thermal table changed */
201 TP_HKEY_EV_THM_CSM_COMPLETED = 0x6032, /* windows; thermal control set
202 * command completed. Related to
204 TP_HKEY_EV_THM_TRANSFM_CHANGED = 0x60F0, /* windows; thermal transformation
205 * changed. Related to AML GMTS */
207 /* AC-related events */
208 TP_HKEY_EV_AC_CHANGED = 0x6040, /* AC status changed */
210 /* Further user-interface events */
211 TP_HKEY_EV_PALM_DETECTED = 0x60b0, /* palm hoveres keyboard */
212 TP_HKEY_EV_PALM_UNDETECTED = 0x60b1, /* palm removed */
215 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
218 /****************************************************************************
222 #define TPACPI_NAME "thinkpad"
223 #define TPACPI_DESC "ThinkPad ACPI Extras"
224 #define TPACPI_FILE TPACPI_NAME "_acpi"
225 #define TPACPI_URL "http://ibm-acpi.sf.net/"
226 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
228 #define TPACPI_PROC_DIR "ibm"
229 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
230 #define TPACPI_DRVR_NAME TPACPI_FILE
231 #define TPACPI_DRVR_SHORTNAME "tpacpi"
232 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
234 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
235 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
237 #define TPACPI_MAX_ACPI_ARGS 3
239 /* Debugging printk groups */
240 #define TPACPI_DBG_ALL 0xffff
241 #define TPACPI_DBG_DISCLOSETASK 0x8000
242 #define TPACPI_DBG_INIT 0x0001
243 #define TPACPI_DBG_EXIT 0x0002
244 #define TPACPI_DBG_RFKILL 0x0004
245 #define TPACPI_DBG_HKEY 0x0008
246 #define TPACPI_DBG_FAN 0x0010
247 #define TPACPI_DBG_BRGHT 0x0020
248 #define TPACPI_DBG_MIXER 0x0040
250 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
251 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
252 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
255 /****************************************************************************
256 * Driver-wide structs and misc. variables
261 struct tp_acpi_drv_struct {
262 const struct acpi_device_id *hid;
263 struct acpi_driver *driver;
265 void (*notify) (struct ibm_struct *, u32);
268 struct acpi_device *device;
274 int (*read) (struct seq_file *);
275 int (*write) (char *);
277 void (*resume) (void);
278 void (*suspend) (void);
279 void (*shutdown) (void);
281 struct list_head all_drivers;
283 struct tp_acpi_drv_struct *acpi;
286 u8 acpi_driver_registered:1;
287 u8 acpi_notify_installed:1;
294 struct ibm_init_struct {
297 int (*init) (struct ibm_init_struct *);
298 umode_t base_procfs_mode;
299 struct ibm_struct *data;
308 TP_HOTKEY_TABLET_NONE = 0,
309 TP_HOTKEY_TABLET_USES_MHKG,
310 TP_HOTKEY_TABLET_USES_GMMS,
315 u32 bright_acpimode:1;
319 u32 fan_ctrl_status_undef:1;
321 u32 second_fan_ctl:1;
322 u32 beep_needs_two_args:1;
323 u32 mixer_no_level_control:1;
324 u32 battery_force_primary:1;
325 u32 input_device_registered:1;
326 u32 platform_drv_registered:1;
327 u32 platform_drv_attrs_registered:1;
328 u32 sensors_pdrv_registered:1;
329 u32 sensors_pdrv_attrs_registered:1;
330 u32 sensors_pdev_attrs_registered:1;
331 u32 hotkey_poll_active:1;
332 u32 has_adaptive_kbd:1;
336 u16 hotkey_mask_ff:1;
337 u16 volume_ctrl_forbidden:1;
340 struct thinkpad_id_data {
341 unsigned int vendor; /* ThinkPad vendor:
342 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
344 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
345 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
347 u32 bios_model; /* 1Y = 0x3159, 0 = unknown */
349 u16 bios_release; /* 1ZETK1WW = 0x4b31, 0 = unknown */
352 char *model_str; /* ThinkPad T43 */
353 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
355 static struct thinkpad_id_data thinkpad_id;
358 TPACPI_LIFE_INIT = 0,
363 static int experimental;
364 static u32 dbg_level;
366 static struct workqueue_struct *tpacpi_wq;
374 /* tpacpi LED class */
375 struct tpacpi_led_classdev {
376 struct led_classdev led_classdev;
380 /* brightness level capabilities */
381 static unsigned int bright_maxlvl; /* 0 = unknown */
383 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
384 static int dbg_wlswemul;
385 static bool tpacpi_wlsw_emulstate;
386 static int dbg_bluetoothemul;
387 static bool tpacpi_bluetooth_emulstate;
388 static int dbg_wwanemul;
389 static bool tpacpi_wwan_emulstate;
390 static int dbg_uwbemul;
391 static bool tpacpi_uwb_emulstate;
395 /*************************************************************************
399 #define dbg_printk(a_dbg_level, format, arg...) \
401 if (dbg_level & (a_dbg_level)) \
402 printk(KERN_DEBUG pr_fmt("%s: " format), \
406 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
407 #define vdbg_printk dbg_printk
408 static const char *str_supported(int is_supported);
410 static inline const char *str_supported(int is_supported) { return ""; }
411 #define vdbg_printk(a_dbg_level, format, arg...) \
412 do { if (0) no_printk(format, ##arg); } while (0)
415 static void tpacpi_log_usertask(const char * const what)
417 printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
418 what, task_tgid_vnr(current));
421 #define tpacpi_disclose_usertask(what, format, arg...) \
423 if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) && \
424 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
425 printk(KERN_DEBUG pr_fmt("%s: PID %d: " format), \
426 what, task_tgid_vnr(current), ## arg); \
431 * Quirk handling helpers
433 * ThinkPad IDs and versions seen in the field so far are
434 * two or three characters from the set [0-9A-Z], i.e. base 36.
436 * We use values well outside that range as specials.
439 #define TPACPI_MATCH_ANY 0xffffffffU
440 #define TPACPI_MATCH_ANY_VERSION 0xffffU
441 #define TPACPI_MATCH_UNKNOWN 0U
443 /* TPID('1', 'Y') == 0x3159 */
444 #define TPID(__c1, __c2) (((__c1) << 8) | (__c2))
445 #define TPID3(__c1, __c2, __c3) (((__c1) << 16) | ((__c2) << 8) | (__c3))
448 #define TPACPI_Q_IBM(__id1, __id2, __quirk) \
449 { .vendor = PCI_VENDOR_ID_IBM, \
450 .bios = TPID(__id1, __id2), \
451 .ec = TPACPI_MATCH_ANY, \
452 .quirks = (__quirk) }
454 #define TPACPI_Q_LNV(__id1, __id2, __quirk) \
455 { .vendor = PCI_VENDOR_ID_LENOVO, \
456 .bios = TPID(__id1, __id2), \
457 .ec = TPACPI_MATCH_ANY, \
458 .quirks = (__quirk) }
460 #define TPACPI_Q_LNV3(__id1, __id2, __id3, __quirk) \
461 { .vendor = PCI_VENDOR_ID_LENOVO, \
462 .bios = TPID3(__id1, __id2, __id3), \
463 .ec = TPACPI_MATCH_ANY, \
464 .quirks = (__quirk) }
466 #define TPACPI_QEC_IBM(__id1, __id2, __quirk) \
467 { .vendor = PCI_VENDOR_ID_IBM, \
468 .bios = TPACPI_MATCH_ANY, \
469 .ec = TPID(__id1, __id2), \
470 .quirks = (__quirk) }
472 #define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
473 { .vendor = PCI_VENDOR_ID_LENOVO, \
474 .bios = TPACPI_MATCH_ANY, \
475 .ec = TPID(__id1, __id2), \
476 .quirks = (__quirk) }
478 struct tpacpi_quirk {
482 unsigned long quirks;
486 * tpacpi_check_quirks() - search BIOS/EC version on a list
487 * @qlist: array of &struct tpacpi_quirk
488 * @qlist_size: number of elements in @qlist
490 * Iterates over a quirks list until one is found that matches the
491 * ThinkPad's vendor, BIOS and EC model.
493 * Returns 0 if nothing matches, otherwise returns the quirks field of
494 * the matching &struct tpacpi_quirk entry.
496 * The match criteria is: vendor, ec and bios much match.
498 static unsigned long __init tpacpi_check_quirks(
499 const struct tpacpi_quirk *qlist,
500 unsigned int qlist_size)
503 if ((qlist->vendor == thinkpad_id.vendor ||
504 qlist->vendor == TPACPI_MATCH_ANY) &&
505 (qlist->bios == thinkpad_id.bios_model ||
506 qlist->bios == TPACPI_MATCH_ANY) &&
507 (qlist->ec == thinkpad_id.ec_model ||
508 qlist->ec == TPACPI_MATCH_ANY))
509 return qlist->quirks;
517 static inline bool __pure __init tpacpi_is_lenovo(void)
519 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
522 static inline bool __pure __init tpacpi_is_ibm(void)
524 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
527 /****************************************************************************
528 ****************************************************************************
530 * ACPI Helpers and device model
532 ****************************************************************************
533 ****************************************************************************/
535 /*************************************************************************
539 static acpi_handle root_handle;
540 static acpi_handle ec_handle;
542 #define TPACPI_HANDLE(object, parent, paths...) \
543 static acpi_handle object##_handle; \
544 static const acpi_handle * const object##_parent __initconst = \
546 static char *object##_paths[] __initdata = { paths }
548 TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
549 TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
551 TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
553 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
554 "\\CMS", /* R40, R40e */
557 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
558 "^HKEY", /* R30, R31 */
559 "HKEY", /* all others */
562 /*************************************************************************
566 static int acpi_evalf(acpi_handle handle,
567 int *res, char *method, char *fmt, ...)
570 struct acpi_object_list params;
571 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
572 struct acpi_buffer result, *resultp;
573 union acpi_object out_obj;
581 pr_err("acpi_evalf() called with empty format\n");
594 params.pointer = &in_objs[0];
601 in_objs[params.count].integer.value = va_arg(ap, int);
602 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
604 /* add more types as needed */
606 pr_err("acpi_evalf() called with invalid format character '%c'\n",
614 if (res_type != 'v') {
615 result.length = sizeof(out_obj);
616 result.pointer = &out_obj;
621 status = acpi_evaluate_object(handle, method, ¶ms, resultp);
625 success = (status == AE_OK &&
626 out_obj.type == ACPI_TYPE_INTEGER);
628 *res = out_obj.integer.value;
631 success = status == AE_OK;
633 /* add more types as needed */
635 pr_err("acpi_evalf() called with invalid format character '%c'\n",
640 if (!success && !quiet)
641 pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
642 method, fmt0, acpi_format_exception(status));
647 static int acpi_ec_read(int i, u8 *p)
652 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
656 if (ec_read(i, p) < 0)
663 static int acpi_ec_write(int i, u8 v)
666 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
669 if (ec_write(i, v) < 0)
676 static int issue_thinkpad_cmos_command(int cmos_cmd)
681 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
687 /*************************************************************************
691 #define TPACPI_ACPIHANDLE_INIT(object) \
692 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
693 object##_paths, ARRAY_SIZE(object##_paths))
695 static void __init drv_acpi_handle_init(const char *name,
696 acpi_handle *handle, const acpi_handle parent,
697 char **paths, const int num_paths)
702 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
705 for (i = 0; i < num_paths; i++) {
706 status = acpi_get_handle(parent, paths[i], handle);
707 if (ACPI_SUCCESS(status)) {
708 dbg_printk(TPACPI_DBG_INIT,
709 "Found ACPI handle %s for %s\n",
715 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
720 static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
721 u32 level, void *context, void **return_value)
723 struct acpi_device *dev;
724 if (!strcmp(context, "video")) {
725 if (acpi_bus_get_device(handle, &dev))
727 if (strcmp(ACPI_VIDEO_HID, acpi_device_hid(dev)))
731 *(acpi_handle *)return_value = handle;
733 return AE_CTRL_TERMINATE;
736 static void __init tpacpi_acpi_handle_locate(const char *name,
741 acpi_handle device_found;
743 BUG_ON(!name || !handle);
744 vdbg_printk(TPACPI_DBG_INIT,
745 "trying to locate ACPI handle for %s, using HID %s\n",
746 name, hid ? hid : "NULL");
748 memset(&device_found, 0, sizeof(device_found));
749 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
750 (void *)name, &device_found);
754 if (ACPI_SUCCESS(status)) {
755 *handle = device_found;
756 dbg_printk(TPACPI_DBG_INIT,
757 "Found ACPI handle for %s\n", name);
759 vdbg_printk(TPACPI_DBG_INIT,
760 "Could not locate an ACPI handle for %s: %s\n",
761 name, acpi_format_exception(status));
765 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
767 struct ibm_struct *ibm = data;
769 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
772 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
775 ibm->acpi->notify(ibm, event);
778 static int __init setup_acpi_notify(struct ibm_struct *ibm)
785 if (!*ibm->acpi->handle)
788 vdbg_printk(TPACPI_DBG_INIT,
789 "setting up ACPI notify for %s\n", ibm->name);
791 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
793 pr_err("acpi_bus_get_device(%s) failed: %d\n", ibm->name, rc);
797 ibm->acpi->device->driver_data = ibm;
798 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
799 TPACPI_ACPI_EVENT_PREFIX,
802 status = acpi_install_notify_handler(*ibm->acpi->handle,
803 ibm->acpi->type, dispatch_acpi_notify, ibm);
804 if (ACPI_FAILURE(status)) {
805 if (status == AE_ALREADY_EXISTS) {
806 pr_notice("another device driver is already handling %s events\n",
809 pr_err("acpi_install_notify_handler(%s) failed: %s\n",
810 ibm->name, acpi_format_exception(status));
814 ibm->flags.acpi_notify_installed = 1;
818 static int __init tpacpi_device_add(struct acpi_device *device)
823 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
827 dbg_printk(TPACPI_DBG_INIT,
828 "registering %s as an ACPI driver\n", ibm->name);
832 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
833 if (!ibm->acpi->driver) {
834 pr_err("failed to allocate memory for ibm->acpi->driver\n");
838 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
839 ibm->acpi->driver->ids = ibm->acpi->hid;
841 ibm->acpi->driver->ops.add = &tpacpi_device_add;
843 rc = acpi_bus_register_driver(ibm->acpi->driver);
845 pr_err("acpi_bus_register_driver(%s) failed: %d\n",
847 kfree(ibm->acpi->driver);
848 ibm->acpi->driver = NULL;
850 ibm->flags.acpi_driver_registered = 1;
856 /****************************************************************************
857 ****************************************************************************
861 ****************************************************************************
862 ****************************************************************************/
864 static int dispatch_proc_show(struct seq_file *m, void *v)
866 struct ibm_struct *ibm = m->private;
868 if (!ibm || !ibm->read)
873 static int dispatch_proc_open(struct inode *inode, struct file *file)
875 return single_open(file, dispatch_proc_show, PDE_DATA(inode));
878 static ssize_t dispatch_proc_write(struct file *file,
879 const char __user *userbuf,
880 size_t count, loff_t *pos)
882 struct ibm_struct *ibm = PDE_DATA(file_inode(file));
886 if (!ibm || !ibm->write)
888 if (count > PAGE_SIZE - 1)
891 kernbuf = kmalloc(count + 1, GFP_KERNEL);
895 if (copy_from_user(kernbuf, userbuf, count)) {
901 ret = ibm->write(kernbuf);
910 static const struct proc_ops dispatch_proc_ops = {
911 .proc_open = dispatch_proc_open,
912 .proc_read = seq_read,
913 .proc_lseek = seq_lseek,
914 .proc_release = single_release,
915 .proc_write = dispatch_proc_write,
918 /****************************************************************************
919 ****************************************************************************
921 * Device model: input, hwmon and platform
923 ****************************************************************************
924 ****************************************************************************/
926 static struct platform_device *tpacpi_pdev;
927 static struct platform_device *tpacpi_sensors_pdev;
928 static struct device *tpacpi_hwmon;
929 static struct input_dev *tpacpi_inputdev;
930 static struct mutex tpacpi_inputdev_send_mutex;
931 static LIST_HEAD(tpacpi_all_drivers);
933 #ifdef CONFIG_PM_SLEEP
934 static int tpacpi_suspend_handler(struct device *dev)
936 struct ibm_struct *ibm, *itmp;
938 list_for_each_entry_safe(ibm, itmp,
948 static int tpacpi_resume_handler(struct device *dev)
950 struct ibm_struct *ibm, *itmp;
952 list_for_each_entry_safe(ibm, itmp,
963 static SIMPLE_DEV_PM_OPS(tpacpi_pm,
964 tpacpi_suspend_handler, tpacpi_resume_handler);
966 static void tpacpi_shutdown_handler(struct platform_device *pdev)
968 struct ibm_struct *ibm, *itmp;
970 list_for_each_entry_safe(ibm, itmp,
978 static struct platform_driver tpacpi_pdriver = {
980 .name = TPACPI_DRVR_NAME,
983 .shutdown = tpacpi_shutdown_handler,
986 static struct platform_driver tpacpi_hwmon_pdriver = {
988 .name = TPACPI_HWMON_DRVR_NAME,
992 /*************************************************************************
993 * sysfs support helpers
996 struct attribute_set {
997 unsigned int members, max_members;
998 struct attribute_group group;
1001 struct attribute_set_obj {
1002 struct attribute_set s;
1003 struct attribute *a;
1004 } __attribute__((packed));
1006 static struct attribute_set *create_attr_set(unsigned int max_members,
1009 struct attribute_set_obj *sobj;
1011 if (max_members == 0)
1014 /* Allocates space for implicit NULL at the end too */
1015 sobj = kzalloc(sizeof(struct attribute_set_obj) +
1016 max_members * sizeof(struct attribute *),
1020 sobj->s.max_members = max_members;
1021 sobj->s.group.attrs = &sobj->a;
1022 sobj->s.group.name = name;
1027 #define destroy_attr_set(_set) \
1030 /* not multi-threaded safe, use it in a single thread per set */
1031 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1036 if (s->members >= s->max_members)
1039 s->group.attrs[s->members] = attr;
1045 static int add_many_to_attr_set(struct attribute_set *s,
1046 struct attribute **attr,
1051 for (i = 0; i < count; i++) {
1052 res = add_to_attr_set(s, attr[i]);
1060 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1062 sysfs_remove_group(kobj, &s->group);
1063 destroy_attr_set(s);
1066 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1067 sysfs_create_group(_kobj, &_attr_set->group)
1069 static int parse_strtoul(const char *buf,
1070 unsigned long max, unsigned long *value)
1074 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1075 endp = skip_spaces(endp);
1076 if (*endp || *value > max)
1082 static void tpacpi_disable_brightness_delay(void)
1084 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1085 pr_notice("ACPI backlight control delay disabled\n");
1088 static void printk_deprecated_attribute(const char * const what,
1089 const char * const details)
1091 tpacpi_log_usertask("deprecated sysfs attribute");
1092 pr_warn("WARNING: sysfs attribute %s is deprecated and will be removed. %s\n",
1096 /*************************************************************************
1097 * rfkill and radio control support helpers
1101 * ThinkPad-ACPI firmware handling model:
1103 * WLSW (master wireless switch) is event-driven, and is common to all
1104 * firmware-controlled radios. It cannot be controlled, just monitored,
1105 * as expected. It overrides all radio state in firmware
1107 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1108 * (TODO: verify how WLSW interacts with the returned radio state).
1110 * The only time there are shadow radio state changes, is when
1111 * masked-off hotkeys are used.
1115 * Internal driver API for radio state:
1117 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1118 * bool: true means radio blocked (off)
1120 enum tpacpi_rfkill_state {
1121 TPACPI_RFK_RADIO_OFF = 0,
1125 /* rfkill switches */
1126 enum tpacpi_rfk_id {
1127 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1128 TPACPI_RFK_WWAN_SW_ID,
1129 TPACPI_RFK_UWB_SW_ID,
1133 static const char *tpacpi_rfkill_names[] = {
1134 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1135 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1136 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1137 [TPACPI_RFK_SW_MAX] = NULL
1140 /* ThinkPad-ACPI rfkill subdriver */
1142 struct rfkill *rfkill;
1143 enum tpacpi_rfk_id id;
1144 const struct tpacpi_rfk_ops *ops;
1147 struct tpacpi_rfk_ops {
1148 /* firmware interface */
1149 int (*get_status)(void);
1150 int (*set_status)(const enum tpacpi_rfkill_state);
1153 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1155 /* Query FW and update rfkill sw state for a given rfkill switch */
1156 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1163 status = (tp_rfk->ops->get_status)();
1167 rfkill_set_sw_state(tp_rfk->rfkill,
1168 (status == TPACPI_RFK_RADIO_OFF));
1174 * Sync the HW-blocking state of all rfkill switches,
1175 * do notice it causes the rfkill core to schedule uevents
1177 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1180 struct tpacpi_rfk *tp_rfk;
1182 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1183 tp_rfk = tpacpi_rfkill_switches[i];
1185 if (rfkill_set_hw_state(tp_rfk->rfkill,
1187 /* ignore -- we track sw block */
1193 /* Call to get the WLSW state from the firmware */
1194 static int hotkey_get_wlsw(void);
1196 /* Call to query WLSW state and update all rfkill switches */
1197 static bool tpacpi_rfk_check_hwblock_state(void)
1199 int res = hotkey_get_wlsw();
1202 /* When unknown or unsupported, we have to assume it is unblocked */
1206 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1207 tpacpi_rfk_update_hwblock_state(hw_blocked);
1212 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1214 struct tpacpi_rfk *tp_rfk = data;
1217 dbg_printk(TPACPI_DBG_RFKILL,
1218 "request to change radio state to %s\n",
1219 blocked ? "blocked" : "unblocked");
1221 /* try to set radio state */
1222 res = (tp_rfk->ops->set_status)(blocked ?
1223 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1225 /* and update the rfkill core with whatever the FW really did */
1226 tpacpi_rfk_update_swstate(tp_rfk);
1228 return (res < 0) ? res : 0;
1231 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1232 .set_block = tpacpi_rfk_hook_set_block,
1235 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1236 const struct tpacpi_rfk_ops *tp_rfkops,
1237 const enum rfkill_type rfktype,
1239 const bool set_default)
1241 struct tpacpi_rfk *atp_rfk;
1243 bool sw_state = false;
1247 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1249 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1251 atp_rfk->rfkill = rfkill_alloc(name,
1254 &tpacpi_rfk_rfkill_ops,
1256 if (!atp_rfk || !atp_rfk->rfkill) {
1257 pr_err("failed to allocate memory for rfkill class\n");
1263 atp_rfk->ops = tp_rfkops;
1265 sw_status = (tp_rfkops->get_status)();
1266 if (sw_status < 0) {
1267 pr_err("failed to read initial state for %s, error %d\n",
1270 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1272 /* try to keep the initial state, since we ask the
1273 * firmware to preserve it across S5 in NVRAM */
1274 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1277 hw_state = tpacpi_rfk_check_hwblock_state();
1278 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1280 res = rfkill_register(atp_rfk->rfkill);
1282 pr_err("failed to register %s rfkill switch: %d\n", name, res);
1283 rfkill_destroy(atp_rfk->rfkill);
1288 tpacpi_rfkill_switches[id] = atp_rfk;
1290 pr_info("rfkill switch %s: radio is %sblocked\n",
1291 name, (sw_state || hw_state) ? "" : "un");
1295 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1297 struct tpacpi_rfk *tp_rfk;
1299 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1301 tp_rfk = tpacpi_rfkill_switches[id];
1303 rfkill_unregister(tp_rfk->rfkill);
1304 rfkill_destroy(tp_rfk->rfkill);
1305 tpacpi_rfkill_switches[id] = NULL;
1310 static void printk_deprecated_rfkill_attribute(const char * const what)
1312 printk_deprecated_attribute(what,
1313 "Please switch to generic rfkill before year 2010");
1316 /* sysfs <radio> enable ------------------------------------------------ */
1317 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1318 struct device_attribute *attr,
1323 printk_deprecated_rfkill_attribute(attr->attr.name);
1325 /* This is in the ABI... */
1326 if (tpacpi_rfk_check_hwblock_state()) {
1327 status = TPACPI_RFK_RADIO_OFF;
1329 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1334 return snprintf(buf, PAGE_SIZE, "%d\n",
1335 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1338 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1339 struct device_attribute *attr,
1340 const char *buf, size_t count)
1345 printk_deprecated_rfkill_attribute(attr->attr.name);
1347 if (parse_strtoul(buf, 1, &t))
1350 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1352 /* This is in the ABI... */
1353 if (tpacpi_rfk_check_hwblock_state() && !!t)
1356 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1357 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1358 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1360 return (res < 0) ? res : count;
1363 /* procfs -------------------------------------------------------------- */
1364 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1366 if (id >= TPACPI_RFK_SW_MAX)
1367 seq_printf(m, "status:\t\tnot supported\n");
1371 /* This is in the ABI... */
1372 if (tpacpi_rfk_check_hwblock_state()) {
1373 status = TPACPI_RFK_RADIO_OFF;
1375 status = tpacpi_rfk_update_swstate(
1376 tpacpi_rfkill_switches[id]);
1381 seq_printf(m, "status:\t\t%s\n",
1382 (status == TPACPI_RFK_RADIO_ON) ?
1383 "enabled" : "disabled");
1384 seq_printf(m, "commands:\tenable, disable\n");
1390 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1396 if (id >= TPACPI_RFK_SW_MAX)
1399 while ((cmd = strsep(&buf, ","))) {
1400 if (strlencmp(cmd, "enable") == 0)
1401 status = TPACPI_RFK_RADIO_ON;
1402 else if (strlencmp(cmd, "disable") == 0)
1403 status = TPACPI_RFK_RADIO_OFF;
1409 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1410 (status == TPACPI_RFK_RADIO_ON) ?
1411 "enable" : "disable",
1412 tpacpi_rfkill_names[id]);
1413 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1414 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1420 /*************************************************************************
1421 * thinkpad-acpi driver attributes
1424 /* interface_version --------------------------------------------------- */
1425 static ssize_t interface_version_show(struct device_driver *drv, char *buf)
1427 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1429 static DRIVER_ATTR_RO(interface_version);
1431 /* debug_level --------------------------------------------------------- */
1432 static ssize_t debug_level_show(struct device_driver *drv, char *buf)
1434 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1437 static ssize_t debug_level_store(struct device_driver *drv, const char *buf,
1442 if (parse_strtoul(buf, 0xffff, &t))
1449 static DRIVER_ATTR_RW(debug_level);
1451 /* version ------------------------------------------------------------- */
1452 static ssize_t version_show(struct device_driver *drv, char *buf)
1454 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1455 TPACPI_DESC, TPACPI_VERSION);
1457 static DRIVER_ATTR_RO(version);
1459 /* --------------------------------------------------------------------- */
1461 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1463 /* wlsw_emulstate ------------------------------------------------------ */
1464 static ssize_t wlsw_emulstate_show(struct device_driver *drv, char *buf)
1466 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1469 static ssize_t wlsw_emulstate_store(struct device_driver *drv, const char *buf,
1474 if (parse_strtoul(buf, 1, &t))
1477 if (tpacpi_wlsw_emulstate != !!t) {
1478 tpacpi_wlsw_emulstate = !!t;
1479 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1484 static DRIVER_ATTR_RW(wlsw_emulstate);
1486 /* bluetooth_emulstate ------------------------------------------------- */
1487 static ssize_t bluetooth_emulstate_show(struct device_driver *drv, char *buf)
1489 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1492 static ssize_t bluetooth_emulstate_store(struct device_driver *drv,
1493 const char *buf, size_t count)
1497 if (parse_strtoul(buf, 1, &t))
1500 tpacpi_bluetooth_emulstate = !!t;
1504 static DRIVER_ATTR_RW(bluetooth_emulstate);
1506 /* wwan_emulstate ------------------------------------------------- */
1507 static ssize_t wwan_emulstate_show(struct device_driver *drv, char *buf)
1509 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1512 static ssize_t wwan_emulstate_store(struct device_driver *drv, const char *buf,
1517 if (parse_strtoul(buf, 1, &t))
1520 tpacpi_wwan_emulstate = !!t;
1524 static DRIVER_ATTR_RW(wwan_emulstate);
1526 /* uwb_emulstate ------------------------------------------------- */
1527 static ssize_t uwb_emulstate_show(struct device_driver *drv, char *buf)
1529 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1532 static ssize_t uwb_emulstate_store(struct device_driver *drv, const char *buf,
1537 if (parse_strtoul(buf, 1, &t))
1540 tpacpi_uwb_emulstate = !!t;
1544 static DRIVER_ATTR_RW(uwb_emulstate);
1547 /* --------------------------------------------------------------------- */
1549 static struct driver_attribute *tpacpi_driver_attributes[] = {
1550 &driver_attr_debug_level, &driver_attr_version,
1551 &driver_attr_interface_version,
1554 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1560 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1561 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1565 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1566 if (!res && dbg_wlswemul)
1567 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1568 if (!res && dbg_bluetoothemul)
1569 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1570 if (!res && dbg_wwanemul)
1571 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1572 if (!res && dbg_uwbemul)
1573 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1579 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1583 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1584 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1586 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1587 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1588 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1589 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1590 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1594 /*************************************************************************
1599 * Table of recommended minimum BIOS versions
1601 * Reasons for listing:
1602 * 1. Stable BIOS, listed because the unknown amount of
1603 * bugs and bad ACPI behaviour on older versions
1605 * 2. BIOS or EC fw with known bugs that trigger on Linux
1607 * 3. BIOS with known reduced functionality in older versions
1609 * We recommend the latest BIOS and EC version.
1610 * We only support the latest BIOS and EC fw version as a rule.
1612 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1613 * Information from users in ThinkWiki
1615 * WARNING: we use this table also to detect that the machine is
1616 * a ThinkPad in some cases, so don't remove entries lightly.
1619 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1620 { .vendor = (__v), \
1621 .bios = TPID(__id1, __id2), \
1622 .ec = TPACPI_MATCH_ANY, \
1623 .quirks = TPACPI_MATCH_ANY_VERSION << 16 \
1624 | TPVER(__bv1, __bv2) }
1626 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1627 __eid, __ev1, __ev2) \
1628 { .vendor = (__v), \
1629 .bios = TPID(__bid1, __bid2), \
1631 .quirks = TPVER(__ev1, __ev2) << 16 \
1632 | TPVER(__bv1, __bv2) }
1634 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1635 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1637 /* Outdated IBM BIOSes often lack the EC id string */
1638 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1639 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1640 __bv1, __bv2, TPID(__id1, __id2), \
1642 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1643 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1646 /* Outdated IBM BIOSes often lack the EC id string */
1647 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1648 __eid1, __eid2, __ev1, __ev2) \
1649 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1650 __bv1, __bv2, TPID(__eid1, __eid2), \
1652 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1653 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1656 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1657 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1659 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1660 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1661 __bv1, __bv2, TPID(__id1, __id2), \
1664 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1665 __eid1, __eid2, __ev1, __ev2) \
1666 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1667 __bv1, __bv2, TPID(__eid1, __eid2), \
1670 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1671 /* Numeric models ------------------ */
1672 /* FW MODEL BIOS VERS */
1673 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1674 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1675 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1676 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1677 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1678 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1679 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1680 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1681 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1683 /* A-series ------------------------- */
1684 /* FW MODEL BIOS VERS EC VERS */
1685 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1686 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1687 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1688 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1689 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1690 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1691 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1692 TPV_QI0('1', '3', '2', '0'), /* A22m */
1693 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1694 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1695 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1697 /* G-series ------------------------- */
1698 /* FW MODEL BIOS VERS */
1699 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1700 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1702 /* R-series, T-series --------------- */
1703 /* FW MODEL BIOS VERS EC VERS */
1704 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1705 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1706 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1707 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1708 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1709 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1710 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1711 T40/p, T41/p, T42/p (1) */
1712 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1713 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1714 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1715 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1717 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1718 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1719 TPV_QI0('1', '6', '3', '2'), /* T22 */
1720 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1721 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1722 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1724 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1725 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1726 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1728 /* BIOS FW BIOS VERS EC FW EC VERS */
1729 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1730 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1732 /* X-series ------------------------- */
1733 /* FW MODEL BIOS VERS EC VERS */
1734 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1735 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1736 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1737 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1738 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1739 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1740 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1742 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1743 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1745 /* (0) - older versions lack DMI EC fw string and functionality */
1746 /* (1) - older versions known to lack functionality */
1757 static void __init tpacpi_check_outdated_fw(void)
1759 unsigned long fwvers;
1760 u16 ec_version, bios_version;
1762 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1763 ARRAY_SIZE(tpacpi_bios_version_qtable));
1768 bios_version = fwvers & 0xffffU;
1769 ec_version = (fwvers >> 16) & 0xffffU;
1771 /* note that unknown versions are set to 0x0000 and we use that */
1772 if ((bios_version > thinkpad_id.bios_release) ||
1773 (ec_version > thinkpad_id.ec_release &&
1774 ec_version != TPACPI_MATCH_ANY_VERSION)) {
1776 * The changelogs would let us track down the exact
1777 * reason, but it is just too much of a pain to track
1778 * it. We only list BIOSes that are either really
1779 * broken, or really stable to begin with, so it is
1780 * best if the user upgrades the firmware anyway.
1782 pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1783 pr_warn("WARNING: This firmware may be missing critical bug fixes and/or important features\n");
1787 static bool __init tpacpi_is_fw_known(void)
1789 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1790 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1793 /****************************************************************************
1794 ****************************************************************************
1798 ****************************************************************************
1799 ****************************************************************************/
1801 /*************************************************************************
1802 * thinkpad-acpi metadata subdriver
1805 static int thinkpad_acpi_driver_read(struct seq_file *m)
1807 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1808 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1812 static struct ibm_struct thinkpad_acpi_driver_data = {
1814 .read = thinkpad_acpi_driver_read,
1817 /*************************************************************************
1822 * ThinkPad firmware event model
1824 * The ThinkPad firmware has two main event interfaces: normal ACPI
1825 * notifications (which follow the ACPI standard), and a private event
1828 * The private event interface also issues events for the hotkeys. As
1829 * the driver gained features, the event handling code ended up being
1830 * built around the hotkey subdriver. This will need to be refactored
1831 * to a more formal event API eventually.
1833 * Some "hotkeys" are actually supposed to be used as event reports,
1834 * such as "brightness has changed", "volume has changed", depending on
1835 * the ThinkPad model and how the firmware is operating.
1837 * Unlike other classes, hotkey-class events have mask/unmask control on
1838 * non-ancient firmware. However, how it behaves changes a lot with the
1839 * firmware model and version.
1842 enum { /* hot key scan codes (derived from ACPI DSDT) */
1843 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1844 TP_ACPI_HOTKEYSCAN_FNF2,
1845 TP_ACPI_HOTKEYSCAN_FNF3,
1846 TP_ACPI_HOTKEYSCAN_FNF4,
1847 TP_ACPI_HOTKEYSCAN_FNF5,
1848 TP_ACPI_HOTKEYSCAN_FNF6,
1849 TP_ACPI_HOTKEYSCAN_FNF7,
1850 TP_ACPI_HOTKEYSCAN_FNF8,
1851 TP_ACPI_HOTKEYSCAN_FNF9,
1852 TP_ACPI_HOTKEYSCAN_FNF10,
1853 TP_ACPI_HOTKEYSCAN_FNF11,
1854 TP_ACPI_HOTKEYSCAN_FNF12,
1855 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1856 TP_ACPI_HOTKEYSCAN_FNINSERT,
1857 TP_ACPI_HOTKEYSCAN_FNDELETE,
1858 TP_ACPI_HOTKEYSCAN_FNHOME,
1859 TP_ACPI_HOTKEYSCAN_FNEND,
1860 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1861 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1862 TP_ACPI_HOTKEYSCAN_FNSPACE,
1863 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1864 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1865 TP_ACPI_HOTKEYSCAN_MUTE,
1866 TP_ACPI_HOTKEYSCAN_THINKPAD,
1867 TP_ACPI_HOTKEYSCAN_UNK1,
1868 TP_ACPI_HOTKEYSCAN_UNK2,
1869 TP_ACPI_HOTKEYSCAN_UNK3,
1870 TP_ACPI_HOTKEYSCAN_UNK4,
1871 TP_ACPI_HOTKEYSCAN_UNK5,
1872 TP_ACPI_HOTKEYSCAN_UNK6,
1873 TP_ACPI_HOTKEYSCAN_UNK7,
1874 TP_ACPI_HOTKEYSCAN_UNK8,
1876 /* Adaptive keyboard keycodes */
1877 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1878 TP_ACPI_HOTKEYSCAN_MUTE2 = TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1879 TP_ACPI_HOTKEYSCAN_BRIGHTNESS_ZERO,
1880 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL,
1881 TP_ACPI_HOTKEYSCAN_CLOUD,
1882 TP_ACPI_HOTKEYSCAN_UNK9,
1883 TP_ACPI_HOTKEYSCAN_VOICE,
1884 TP_ACPI_HOTKEYSCAN_UNK10,
1885 TP_ACPI_HOTKEYSCAN_GESTURES,
1886 TP_ACPI_HOTKEYSCAN_UNK11,
1887 TP_ACPI_HOTKEYSCAN_UNK12,
1888 TP_ACPI_HOTKEYSCAN_UNK13,
1889 TP_ACPI_HOTKEYSCAN_CONFIG,
1890 TP_ACPI_HOTKEYSCAN_NEW_TAB,
1891 TP_ACPI_HOTKEYSCAN_RELOAD,
1892 TP_ACPI_HOTKEYSCAN_BACK,
1893 TP_ACPI_HOTKEYSCAN_MIC_DOWN,
1894 TP_ACPI_HOTKEYSCAN_MIC_UP,
1895 TP_ACPI_HOTKEYSCAN_MIC_CANCELLATION,
1896 TP_ACPI_HOTKEYSCAN_CAMERA_MODE,
1897 TP_ACPI_HOTKEYSCAN_ROTATE_DISPLAY,
1899 /* Lenovo extended keymap, starting at 0x1300 */
1900 TP_ACPI_HOTKEYSCAN_EXTENDED_START,
1901 /* first new observed key (star, favorites) is 0x1311 */
1902 TP_ACPI_HOTKEYSCAN_STAR = 69,
1903 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL2,
1904 TP_ACPI_HOTKEYSCAN_CALCULATOR,
1905 TP_ACPI_HOTKEYSCAN_BLUETOOTH,
1906 TP_ACPI_HOTKEYSCAN_KEYBOARD,
1907 TP_ACPI_HOTKEYSCAN_FN_RIGHT_SHIFT, /* Used by "Lenovo Quick Clean" */
1908 TP_ACPI_HOTKEYSCAN_NOTIFICATION_CENTER,
1909 TP_ACPI_HOTKEYSCAN_PICKUP_PHONE,
1910 TP_ACPI_HOTKEYSCAN_HANGUP_PHONE,
1912 /* Hotkey keymap size */
1913 TPACPI_HOTKEY_MAP_LEN
1916 enum { /* Keys/events available through NVRAM polling */
1917 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1918 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1921 enum { /* Positions of some of the keys in hotkey masks */
1922 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1923 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1924 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1925 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1926 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1927 TP_ACPI_HKEY_KBD_LIGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1928 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1929 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1930 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1931 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1932 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1935 enum { /* NVRAM to ACPI HKEY group map */
1936 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1937 TP_ACPI_HKEY_ZOOM_MASK |
1938 TP_ACPI_HKEY_DISPSWTCH_MASK |
1939 TP_ACPI_HKEY_HIBERNATE_MASK,
1940 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1941 TP_ACPI_HKEY_BRGHTDWN_MASK,
1942 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1943 TP_ACPI_HKEY_VOLDWN_MASK |
1944 TP_ACPI_HKEY_MUTE_MASK,
1947 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1948 struct tp_nvram_state {
1949 u16 thinkpad_toggle:1;
1951 u16 display_toggle:1;
1952 u16 thinklight_toggle:1;
1953 u16 hibernate_toggle:1;
1954 u16 displayexp_toggle:1;
1955 u16 display_state:1;
1956 u16 brightness_toggle:1;
1957 u16 volume_toggle:1;
1960 u8 brightness_level;
1964 /* kthread for the hotkey poller */
1965 static struct task_struct *tpacpi_hotkey_task;
1968 * Acquire mutex to write poller control variables as an
1971 * Increment hotkey_config_change when changing them if you
1972 * want the kthread to forget old state.
1974 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1976 static struct mutex hotkey_thread_data_mutex;
1977 static unsigned int hotkey_config_change;
1980 * hotkey poller control variables
1982 * Must be atomic or readers will also need to acquire mutex
1984 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1985 * should be used only when the changes need to be taken as
1986 * a block, OR when one needs to force the kthread to forget
1989 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
1990 static unsigned int hotkey_poll_freq = 10; /* Hz */
1992 #define HOTKEY_CONFIG_CRITICAL_START \
1994 mutex_lock(&hotkey_thread_data_mutex); \
1995 hotkey_config_change++; \
1997 #define HOTKEY_CONFIG_CRITICAL_END \
1998 mutex_unlock(&hotkey_thread_data_mutex);
2000 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2002 #define hotkey_source_mask 0U
2003 #define HOTKEY_CONFIG_CRITICAL_START
2004 #define HOTKEY_CONFIG_CRITICAL_END
2006 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2008 static struct mutex hotkey_mutex;
2010 static enum { /* Reasons for waking up */
2011 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2012 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2013 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2014 } hotkey_wakeup_reason;
2016 static int hotkey_autosleep_ack;
2018 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2019 static u32 hotkey_all_mask; /* all events supported in fw */
2020 static u32 hotkey_adaptive_all_mask; /* all adaptive events supported in fw */
2021 static u32 hotkey_reserved_mask; /* events better left disabled */
2022 static u32 hotkey_driver_mask; /* events needed by the driver */
2023 static u32 hotkey_user_mask; /* events visible to userspace */
2024 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2026 static u16 *hotkey_keycode_map;
2028 static struct attribute_set *hotkey_dev_attributes;
2030 static void tpacpi_driver_event(const unsigned int hkey_event);
2031 static void hotkey_driver_event(const unsigned int scancode);
2032 static void hotkey_poll_setup(const bool may_warn);
2034 /* HKEY.MHKG() return bits */
2035 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2037 TP_ACPI_MULTI_MODE_INVALID = 0,
2038 TP_ACPI_MULTI_MODE_UNKNOWN = 1 << 0,
2039 TP_ACPI_MULTI_MODE_LAPTOP = 1 << 1,
2040 TP_ACPI_MULTI_MODE_TABLET = 1 << 2,
2041 TP_ACPI_MULTI_MODE_FLAT = 1 << 3,
2042 TP_ACPI_MULTI_MODE_STAND = 1 << 4,
2043 TP_ACPI_MULTI_MODE_TENT = 1 << 5,
2044 TP_ACPI_MULTI_MODE_STAND_TENT = 1 << 6,
2048 /* The following modes are considered tablet mode for the purpose of
2049 * reporting the status to userspace. i.e. in all these modes it makes
2050 * sense to disable the laptop input devices such as touchpad and
2053 TP_ACPI_MULTI_MODE_TABLET_LIKE = TP_ACPI_MULTI_MODE_TABLET |
2054 TP_ACPI_MULTI_MODE_STAND |
2055 TP_ACPI_MULTI_MODE_TENT |
2056 TP_ACPI_MULTI_MODE_STAND_TENT,
2059 static int hotkey_get_wlsw(void)
2063 if (!tp_features.hotkey_wlsw)
2066 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2068 return (tpacpi_wlsw_emulstate) ?
2069 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2072 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2075 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2078 static int hotkey_gmms_get_tablet_mode(int s, int *has_tablet_mode)
2080 int type = (s >> 16) & 0xffff;
2081 int value = s & 0xffff;
2082 int mode = TP_ACPI_MULTI_MODE_INVALID;
2083 int valid_modes = 0;
2085 if (has_tablet_mode)
2086 *has_tablet_mode = 0;
2090 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2091 TP_ACPI_MULTI_MODE_TABLET |
2092 TP_ACPI_MULTI_MODE_STAND_TENT;
2095 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2096 TP_ACPI_MULTI_MODE_FLAT |
2097 TP_ACPI_MULTI_MODE_TABLET |
2098 TP_ACPI_MULTI_MODE_STAND |
2099 TP_ACPI_MULTI_MODE_TENT;
2102 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2103 TP_ACPI_MULTI_MODE_FLAT;
2107 /* In mode 4, FLAT is not specified as a valid mode. However,
2108 * it can be seen at least on the X1 Yoga 2nd Generation.
2110 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2111 TP_ACPI_MULTI_MODE_FLAT |
2112 TP_ACPI_MULTI_MODE_TABLET |
2113 TP_ACPI_MULTI_MODE_STAND |
2114 TP_ACPI_MULTI_MODE_TENT;
2117 pr_err("Unknown multi mode status type %d with value 0x%04X, please report this to %s\n",
2118 type, value, TPACPI_MAIL);
2122 if (has_tablet_mode && (valid_modes & TP_ACPI_MULTI_MODE_TABLET_LIKE))
2123 *has_tablet_mode = 1;
2127 mode = TP_ACPI_MULTI_MODE_LAPTOP;
2130 mode = TP_ACPI_MULTI_MODE_FLAT;
2133 mode = TP_ACPI_MULTI_MODE_TABLET;
2137 mode = TP_ACPI_MULTI_MODE_STAND_TENT;
2139 mode = TP_ACPI_MULTI_MODE_STAND;
2142 mode = TP_ACPI_MULTI_MODE_TENT;
2145 if (type == 5 && value == 0xffff) {
2146 pr_warn("Multi mode status is undetected, assuming laptop\n");
2151 if (!(mode & valid_modes)) {
2152 pr_err("Unknown/reserved multi mode value 0x%04X for type %d, please report this to %s\n",
2153 value, type, TPACPI_MAIL);
2157 return !!(mode & TP_ACPI_MULTI_MODE_TABLET_LIKE);
2160 static int hotkey_get_tablet_mode(int *status)
2164 switch (tp_features.hotkey_tablet) {
2165 case TP_HOTKEY_TABLET_USES_MHKG:
2166 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2169 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2171 case TP_HOTKEY_TABLET_USES_GMMS:
2172 if (!acpi_evalf(hkey_handle, &s, "GMMS", "dd", 0))
2175 *status = hotkey_gmms_get_tablet_mode(s, NULL);
2185 * Reads current event mask from firmware, and updates
2186 * hotkey_acpi_mask accordingly. Also resets any bits
2187 * from hotkey_user_mask that are unavailable to be
2188 * delivered (shadow requirement of the userspace ABI).
2190 * Call with hotkey_mutex held
2192 static int hotkey_mask_get(void)
2194 if (tp_features.hotkey_mask) {
2197 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2200 hotkey_acpi_mask = m;
2202 /* no mask support doesn't mean no event support... */
2203 hotkey_acpi_mask = hotkey_all_mask;
2206 /* sync userspace-visible mask */
2207 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2212 static void hotkey_mask_warn_incomplete_mask(void)
2214 /* log only what the user can fix... */
2215 const u32 wantedmask = hotkey_driver_mask &
2216 ~(hotkey_acpi_mask | hotkey_source_mask) &
2217 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2220 pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2224 * Set the firmware mask when supported
2226 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2228 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2230 * Call with hotkey_mutex held
2232 static int hotkey_mask_set(u32 mask)
2237 const u32 fwmask = mask & ~hotkey_source_mask;
2239 if (tp_features.hotkey_mask) {
2240 for (i = 0; i < 32; i++) {
2241 if (!acpi_evalf(hkey_handle,
2242 NULL, "MHKM", "vdd", i + 1,
2243 !!(mask & (1 << i)))) {
2251 * We *must* make an inconditional call to hotkey_mask_get to
2252 * refresh hotkey_acpi_mask and update hotkey_user_mask
2254 * Take the opportunity to also log when we cannot _enable_
2257 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2258 pr_notice("asked for hotkey mask 0x%08x, but firmware forced it to 0x%08x\n",
2259 fwmask, hotkey_acpi_mask);
2262 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2263 hotkey_mask_warn_incomplete_mask();
2269 * Sets hotkey_user_mask and tries to set the firmware mask
2271 * Call with hotkey_mutex held
2273 static int hotkey_user_mask_set(const u32 mask)
2277 /* Give people a chance to notice they are doing something that
2278 * is bound to go boom on their users sooner or later */
2279 if (!tp_warned.hotkey_mask_ff &&
2280 (mask == 0xffff || mask == 0xffffff ||
2281 mask == 0xffffffff)) {
2282 tp_warned.hotkey_mask_ff = 1;
2283 pr_notice("setting the hotkey mask to 0x%08x is likely not the best way to go about it\n",
2285 pr_notice("please consider using the driver defaults, and refer to up-to-date thinkpad-acpi documentation\n");
2288 /* Try to enable what the user asked for, plus whatever we need.
2289 * this syncs everything but won't enable bits in hotkey_user_mask */
2290 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2292 /* Enable the available bits in hotkey_user_mask */
2293 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2299 * Sets the driver hotkey mask.
2301 * Can be called even if the hotkey subdriver is inactive
2303 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2307 /* Do the right thing if hotkey_init has not been called yet */
2308 if (!tp_features.hotkey) {
2309 hotkey_driver_mask = mask;
2313 mutex_lock(&hotkey_mutex);
2315 HOTKEY_CONFIG_CRITICAL_START
2316 hotkey_driver_mask = mask;
2317 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2318 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2320 HOTKEY_CONFIG_CRITICAL_END
2322 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2323 ~hotkey_source_mask);
2324 hotkey_poll_setup(true);
2326 mutex_unlock(&hotkey_mutex);
2331 static int hotkey_status_get(int *status)
2333 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2339 static int hotkey_status_set(bool enable)
2341 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2347 static void tpacpi_input_send_tabletsw(void)
2351 if (tp_features.hotkey_tablet &&
2352 !hotkey_get_tablet_mode(&state)) {
2353 mutex_lock(&tpacpi_inputdev_send_mutex);
2355 input_report_switch(tpacpi_inputdev,
2356 SW_TABLET_MODE, !!state);
2357 input_sync(tpacpi_inputdev);
2359 mutex_unlock(&tpacpi_inputdev_send_mutex);
2363 /* Do NOT call without validating scancode first */
2364 static void tpacpi_input_send_key(const unsigned int scancode)
2366 const unsigned int keycode = hotkey_keycode_map[scancode];
2368 if (keycode != KEY_RESERVED) {
2369 mutex_lock(&tpacpi_inputdev_send_mutex);
2371 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2372 input_report_key(tpacpi_inputdev, keycode, 1);
2373 input_sync(tpacpi_inputdev);
2375 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2376 input_report_key(tpacpi_inputdev, keycode, 0);
2377 input_sync(tpacpi_inputdev);
2379 mutex_unlock(&tpacpi_inputdev_send_mutex);
2383 /* Do NOT call without validating scancode first */
2384 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2386 hotkey_driver_event(scancode);
2387 if (hotkey_user_mask & (1 << scancode))
2388 tpacpi_input_send_key(scancode);
2391 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2392 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2394 /* Do NOT call without validating scancode first */
2395 static void tpacpi_hotkey_send_key(unsigned int scancode)
2397 tpacpi_input_send_key_masked(scancode);
2400 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2404 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2405 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2406 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2407 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2408 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2409 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2411 if (m & TP_ACPI_HKEY_KBD_LIGHT_MASK) {
2412 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2413 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2415 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2416 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2417 n->displayexp_toggle =
2418 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2420 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2421 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2422 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2423 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2424 n->brightness_toggle =
2425 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2427 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2428 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2429 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2430 >> TP_NVRAM_POS_LEVEL_VOLUME;
2431 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2432 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2436 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2438 if ((event_mask & (1 << __scancode)) && \
2439 oldn->__member != newn->__member) \
2440 tpacpi_hotkey_send_key(__scancode); \
2443 #define TPACPI_MAY_SEND_KEY(__scancode) \
2445 if (event_mask & (1 << __scancode)) \
2446 tpacpi_hotkey_send_key(__scancode); \
2449 static void issue_volchange(const unsigned int oldvol,
2450 const unsigned int newvol,
2451 const u32 event_mask)
2453 unsigned int i = oldvol;
2455 while (i > newvol) {
2456 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2459 while (i < newvol) {
2460 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2465 static void issue_brightnesschange(const unsigned int oldbrt,
2466 const unsigned int newbrt,
2467 const u32 event_mask)
2469 unsigned int i = oldbrt;
2471 while (i > newbrt) {
2472 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2475 while (i < newbrt) {
2476 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2481 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2482 struct tp_nvram_state *newn,
2483 const u32 event_mask)
2486 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2487 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2488 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2489 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2491 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2493 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2498 * This code is supposed to duplicate the IBM firmware behaviour:
2499 * - Pressing MUTE issues mute hotkey message, even when already mute
2500 * - Pressing Volume up/down issues volume up/down hotkey messages,
2501 * even when already at maximum or minimum volume
2502 * - The act of unmuting issues volume up/down notification,
2503 * depending which key was used to unmute
2505 * We are constrained to what the NVRAM can tell us, which is not much
2506 * and certainly not enough if more than one volume hotkey was pressed
2507 * since the last poll cycle.
2509 * Just to make our life interesting, some newer Lenovo ThinkPads have
2510 * bugs in the BIOS and may fail to update volume_toggle properly.
2515 oldn->volume_toggle != newn->volume_toggle ||
2516 oldn->volume_level != newn->volume_level) {
2517 /* recently muted, or repeated mute keypress, or
2518 * multiple presses ending in mute */
2519 issue_volchange(oldn->volume_level, newn->volume_level,
2521 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2526 /* recently unmuted, issue 'unmute' keypress */
2527 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2529 if (oldn->volume_level != newn->volume_level) {
2530 issue_volchange(oldn->volume_level, newn->volume_level,
2532 } else if (oldn->volume_toggle != newn->volume_toggle) {
2533 /* repeated vol up/down keypress at end of scale ? */
2534 if (newn->volume_level == 0)
2535 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2536 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2537 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2541 /* handle brightness */
2542 if (oldn->brightness_level != newn->brightness_level) {
2543 issue_brightnesschange(oldn->brightness_level,
2544 newn->brightness_level, event_mask);
2545 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2546 /* repeated key presses that didn't change state */
2547 if (newn->brightness_level == 0)
2548 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2549 else if (newn->brightness_level >= bright_maxlvl
2550 && !tp_features.bright_unkfw)
2551 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2554 #undef TPACPI_COMPARE_KEY
2555 #undef TPACPI_MAY_SEND_KEY
2561 * We track all events in hotkey_source_mask all the time, since
2562 * most of them are edge-based. We only issue those requested by
2563 * hotkey_user_mask or hotkey_driver_mask, though.
2565 static int hotkey_kthread(void *data)
2567 struct tp_nvram_state s[2] = { 0 };
2568 u32 poll_mask, event_mask;
2569 unsigned int si, so;
2571 unsigned int change_detector;
2572 unsigned int poll_freq;
2575 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2584 /* Initial state for compares */
2585 mutex_lock(&hotkey_thread_data_mutex);
2586 change_detector = hotkey_config_change;
2587 poll_mask = hotkey_source_mask;
2588 event_mask = hotkey_source_mask &
2589 (hotkey_driver_mask | hotkey_user_mask);
2590 poll_freq = hotkey_poll_freq;
2591 mutex_unlock(&hotkey_thread_data_mutex);
2592 hotkey_read_nvram(&s[so], poll_mask);
2594 while (!kthread_should_stop()) {
2596 if (likely(poll_freq))
2599 t = 100; /* should never happen... */
2601 t = msleep_interruptible(t);
2602 if (unlikely(kthread_freezable_should_stop(&was_frozen)))
2605 if (t > 0 && !was_frozen)
2608 mutex_lock(&hotkey_thread_data_mutex);
2609 if (was_frozen || hotkey_config_change != change_detector) {
2610 /* forget old state on thaw or config change */
2613 change_detector = hotkey_config_change;
2615 poll_mask = hotkey_source_mask;
2616 event_mask = hotkey_source_mask &
2617 (hotkey_driver_mask | hotkey_user_mask);
2618 poll_freq = hotkey_poll_freq;
2619 mutex_unlock(&hotkey_thread_data_mutex);
2621 if (likely(poll_mask)) {
2622 hotkey_read_nvram(&s[si], poll_mask);
2623 if (likely(si != so)) {
2624 hotkey_compare_and_issue_event(&s[so], &s[si],
2637 /* call with hotkey_mutex held */
2638 static void hotkey_poll_stop_sync(void)
2640 if (tpacpi_hotkey_task) {
2641 kthread_stop(tpacpi_hotkey_task);
2642 tpacpi_hotkey_task = NULL;
2646 /* call with hotkey_mutex held */
2647 static void hotkey_poll_setup(const bool may_warn)
2649 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2650 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2652 if (hotkey_poll_freq > 0 &&
2653 (poll_driver_mask ||
2654 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2655 if (!tpacpi_hotkey_task) {
2656 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2657 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2658 if (IS_ERR(tpacpi_hotkey_task)) {
2659 tpacpi_hotkey_task = NULL;
2660 pr_err("could not create kernel thread for hotkey polling\n");
2664 hotkey_poll_stop_sync();
2665 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2666 hotkey_poll_freq == 0) {
2667 pr_notice("hot keys 0x%08x and/or events 0x%08x require polling, which is currently disabled\n",
2668 poll_user_mask, poll_driver_mask);
2673 static void hotkey_poll_setup_safe(const bool may_warn)
2675 mutex_lock(&hotkey_mutex);
2676 hotkey_poll_setup(may_warn);
2677 mutex_unlock(&hotkey_mutex);
2680 /* call with hotkey_mutex held */
2681 static void hotkey_poll_set_freq(unsigned int freq)
2684 hotkey_poll_stop_sync();
2686 hotkey_poll_freq = freq;
2689 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2691 static void hotkey_poll_setup(const bool __unused)
2695 static void hotkey_poll_setup_safe(const bool __unused)
2699 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2701 static int hotkey_inputdev_open(struct input_dev *dev)
2703 switch (tpacpi_lifecycle) {
2704 case TPACPI_LIFE_INIT:
2705 case TPACPI_LIFE_RUNNING:
2706 hotkey_poll_setup_safe(false);
2708 case TPACPI_LIFE_EXITING:
2712 /* Should only happen if tpacpi_lifecycle is corrupt */
2717 static void hotkey_inputdev_close(struct input_dev *dev)
2719 /* disable hotkey polling when possible */
2720 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2721 !(hotkey_source_mask & hotkey_driver_mask))
2722 hotkey_poll_setup_safe(false);
2725 /* sysfs hotkey enable ------------------------------------------------- */
2726 static ssize_t hotkey_enable_show(struct device *dev,
2727 struct device_attribute *attr,
2732 printk_deprecated_attribute("hotkey_enable",
2733 "Hotkey reporting is always enabled");
2735 res = hotkey_status_get(&status);
2739 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2742 static ssize_t hotkey_enable_store(struct device *dev,
2743 struct device_attribute *attr,
2744 const char *buf, size_t count)
2748 printk_deprecated_attribute("hotkey_enable",
2749 "Hotkeys can be disabled through hotkey_mask");
2751 if (parse_strtoul(buf, 1, &t))
2760 static DEVICE_ATTR_RW(hotkey_enable);
2762 /* sysfs hotkey mask --------------------------------------------------- */
2763 static ssize_t hotkey_mask_show(struct device *dev,
2764 struct device_attribute *attr,
2767 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2770 static ssize_t hotkey_mask_store(struct device *dev,
2771 struct device_attribute *attr,
2772 const char *buf, size_t count)
2777 if (parse_strtoul(buf, 0xffffffffUL, &t))
2780 if (mutex_lock_killable(&hotkey_mutex))
2781 return -ERESTARTSYS;
2783 res = hotkey_user_mask_set(t);
2785 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2786 hotkey_poll_setup(true);
2789 mutex_unlock(&hotkey_mutex);
2791 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2793 return (res) ? res : count;
2796 static DEVICE_ATTR_RW(hotkey_mask);
2798 /* sysfs hotkey bios_enabled ------------------------------------------- */
2799 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2800 struct device_attribute *attr,
2803 return sprintf(buf, "0\n");
2806 static DEVICE_ATTR_RO(hotkey_bios_enabled);
2808 /* sysfs hotkey bios_mask ---------------------------------------------- */
2809 static ssize_t hotkey_bios_mask_show(struct device *dev,
2810 struct device_attribute *attr,
2813 printk_deprecated_attribute("hotkey_bios_mask",
2814 "This attribute is useless.");
2815 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2818 static DEVICE_ATTR_RO(hotkey_bios_mask);
2820 /* sysfs hotkey all_mask ----------------------------------------------- */
2821 static ssize_t hotkey_all_mask_show(struct device *dev,
2822 struct device_attribute *attr,
2825 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2826 hotkey_all_mask | hotkey_source_mask);
2829 static DEVICE_ATTR_RO(hotkey_all_mask);
2831 /* sysfs hotkey all_mask ----------------------------------------------- */
2832 static ssize_t hotkey_adaptive_all_mask_show(struct device *dev,
2833 struct device_attribute *attr,
2836 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2837 hotkey_adaptive_all_mask | hotkey_source_mask);
2840 static DEVICE_ATTR_RO(hotkey_adaptive_all_mask);
2842 /* sysfs hotkey recommended_mask --------------------------------------- */
2843 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2844 struct device_attribute *attr,
2847 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2848 (hotkey_all_mask | hotkey_source_mask)
2849 & ~hotkey_reserved_mask);
2852 static DEVICE_ATTR_RO(hotkey_recommended_mask);
2854 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2856 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2857 static ssize_t hotkey_source_mask_show(struct device *dev,
2858 struct device_attribute *attr,
2861 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2864 static ssize_t hotkey_source_mask_store(struct device *dev,
2865 struct device_attribute *attr,
2866 const char *buf, size_t count)
2872 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2873 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2876 if (mutex_lock_killable(&hotkey_mutex))
2877 return -ERESTARTSYS;
2879 HOTKEY_CONFIG_CRITICAL_START
2880 hotkey_source_mask = t;
2881 HOTKEY_CONFIG_CRITICAL_END
2883 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2884 ~hotkey_source_mask);
2885 hotkey_poll_setup(true);
2887 /* check if events needed by the driver got disabled */
2888 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2889 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2891 mutex_unlock(&hotkey_mutex);
2894 pr_err("hotkey_source_mask: failed to update the firmware event mask!\n");
2897 pr_notice("hotkey_source_mask: some important events were disabled: 0x%04x\n",
2900 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2902 return (rc < 0) ? rc : count;
2905 static DEVICE_ATTR_RW(hotkey_source_mask);
2907 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2908 static ssize_t hotkey_poll_freq_show(struct device *dev,
2909 struct device_attribute *attr,
2912 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2915 static ssize_t hotkey_poll_freq_store(struct device *dev,
2916 struct device_attribute *attr,
2917 const char *buf, size_t count)
2921 if (parse_strtoul(buf, 25, &t))
2924 if (mutex_lock_killable(&hotkey_mutex))
2925 return -ERESTARTSYS;
2927 hotkey_poll_set_freq(t);
2928 hotkey_poll_setup(true);
2930 mutex_unlock(&hotkey_mutex);
2932 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2937 static DEVICE_ATTR_RW(hotkey_poll_freq);
2939 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2941 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2942 static ssize_t hotkey_radio_sw_show(struct device *dev,
2943 struct device_attribute *attr,
2947 res = hotkey_get_wlsw();
2951 /* Opportunistic update */
2952 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2954 return snprintf(buf, PAGE_SIZE, "%d\n",
2955 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2958 static DEVICE_ATTR_RO(hotkey_radio_sw);
2960 static void hotkey_radio_sw_notify_change(void)
2962 if (tp_features.hotkey_wlsw)
2963 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2967 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2968 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2969 struct device_attribute *attr,
2973 res = hotkey_get_tablet_mode(&s);
2977 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2980 static DEVICE_ATTR_RO(hotkey_tablet_mode);
2982 static void hotkey_tablet_mode_notify_change(void)
2984 if (tp_features.hotkey_tablet)
2985 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2986 "hotkey_tablet_mode");
2989 /* sysfs wakeup reason (pollable) -------------------------------------- */
2990 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2991 struct device_attribute *attr,
2994 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2997 static DEVICE_ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2999 static void hotkey_wakeup_reason_notify_change(void)
3001 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3005 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
3006 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
3007 struct device_attribute *attr,
3010 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
3013 static DEVICE_ATTR(wakeup_hotunplug_complete, S_IRUGO,
3014 hotkey_wakeup_hotunplug_complete_show, NULL);
3016 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
3018 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3019 "wakeup_hotunplug_complete");
3022 /* sysfs adaptive kbd mode --------------------------------------------- */
3024 static int adaptive_keyboard_get_mode(void);
3025 static int adaptive_keyboard_set_mode(int new_mode);
3027 enum ADAPTIVE_KEY_MODE {
3030 WEB_CONFERENCE_MODE,
3035 static ssize_t adaptive_kbd_mode_show(struct device *dev,
3036 struct device_attribute *attr,
3041 current_mode = adaptive_keyboard_get_mode();
3042 if (current_mode < 0)
3043 return current_mode;
3045 return snprintf(buf, PAGE_SIZE, "%d\n", current_mode);
3048 static ssize_t adaptive_kbd_mode_store(struct device *dev,
3049 struct device_attribute *attr,
3050 const char *buf, size_t count)
3055 if (parse_strtoul(buf, LAYFLAT_MODE, &t))
3058 res = adaptive_keyboard_set_mode(t);
3059 return (res < 0) ? res : count;
3062 static DEVICE_ATTR_RW(adaptive_kbd_mode);
3064 static struct attribute *adaptive_kbd_attributes[] = {
3065 &dev_attr_adaptive_kbd_mode.attr,
3069 static const struct attribute_group adaptive_kbd_attr_group = {
3070 .attrs = adaptive_kbd_attributes,
3073 /* --------------------------------------------------------------------- */
3075 static struct attribute *hotkey_attributes[] __initdata = {
3076 &dev_attr_hotkey_enable.attr,
3077 &dev_attr_hotkey_bios_enabled.attr,
3078 &dev_attr_hotkey_bios_mask.attr,
3079 &dev_attr_wakeup_reason.attr,
3080 &dev_attr_wakeup_hotunplug_complete.attr,
3081 &dev_attr_hotkey_mask.attr,
3082 &dev_attr_hotkey_all_mask.attr,
3083 &dev_attr_hotkey_adaptive_all_mask.attr,
3084 &dev_attr_hotkey_recommended_mask.attr,
3085 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3086 &dev_attr_hotkey_source_mask.attr,
3087 &dev_attr_hotkey_poll_freq.attr,
3092 * Sync both the hw and sw blocking state of all switches
3094 static void tpacpi_send_radiosw_update(void)
3099 * We must sync all rfkill controllers *before* issuing any
3100 * rfkill input events, or we will race the rfkill core input
3103 * tpacpi_inputdev_send_mutex works as a synchronization point
3106 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3109 wlsw = hotkey_get_wlsw();
3111 /* Sync hw blocking state first if it is hw-blocked */
3112 if (wlsw == TPACPI_RFK_RADIO_OFF)
3113 tpacpi_rfk_update_hwblock_state(true);
3115 /* Sync hw blocking state last if it is hw-unblocked */
3116 if (wlsw == TPACPI_RFK_RADIO_ON)
3117 tpacpi_rfk_update_hwblock_state(false);
3119 /* Issue rfkill input event for WLSW switch */
3121 mutex_lock(&tpacpi_inputdev_send_mutex);
3123 input_report_switch(tpacpi_inputdev,
3124 SW_RFKILL_ALL, (wlsw > 0));
3125 input_sync(tpacpi_inputdev);
3127 mutex_unlock(&tpacpi_inputdev_send_mutex);
3131 * this can be unconditional, as we will poll state again
3132 * if userspace uses the notify to read data
3134 hotkey_radio_sw_notify_change();
3137 static void hotkey_exit(void)
3139 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3140 mutex_lock(&hotkey_mutex);
3141 hotkey_poll_stop_sync();
3142 mutex_unlock(&hotkey_mutex);
3145 if (hotkey_dev_attributes)
3146 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3148 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3149 "restoring original HKEY status and mask\n");
3150 /* yes, there is a bitwise or below, we want the
3151 * functions to be called even if one of them fail */
3152 if (((tp_features.hotkey_mask &&
3153 hotkey_mask_set(hotkey_orig_mask)) |
3154 hotkey_status_set(false)) != 0)
3155 pr_err("failed to restore hot key mask to BIOS defaults\n");
3158 static void __init hotkey_unmap(const unsigned int scancode)
3160 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3161 clear_bit(hotkey_keycode_map[scancode],
3162 tpacpi_inputdev->keybit);
3163 hotkey_keycode_map[scancode] = KEY_RESERVED;
3169 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3172 #define TPACPI_HK_Q_INIMASK 0x0001
3174 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3175 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3176 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3177 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3178 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3179 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3180 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3181 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3182 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3183 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3184 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3185 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3186 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3187 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3188 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3189 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3190 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3191 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3192 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3193 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3196 typedef u16 tpacpi_keymap_entry_t;
3197 typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3199 static int hotkey_init_tablet_mode(void)
3201 int in_tablet_mode = 0, res;
3204 if (acpi_evalf(hkey_handle, &res, "GMMS", "qdd", 0)) {
3205 int has_tablet_mode;
3207 in_tablet_mode = hotkey_gmms_get_tablet_mode(res,
3210 * The Yoga 11e series has 2 accelerometers described by a
3211 * BOSC0200 ACPI node. This setup relies on a Windows service
3212 * which calls special ACPI methods on this node to report
3213 * the laptop/tent/tablet mode to the EC. The bmc150 iio driver
3214 * does not support this, so skip the hotkey on these models.
3216 if (has_tablet_mode && !acpi_dev_present("BOSC0200", "1", -1))
3217 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_GMMS;
3219 } else if (acpi_evalf(hkey_handle, &res, "MHKG", "qd")) {
3220 /* For X41t, X60t, X61t Tablets... */
3221 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_MHKG;
3222 in_tablet_mode = !!(res & TP_HOTKEY_TABLET_MASK);
3226 if (!tp_features.hotkey_tablet)
3229 pr_info("Tablet mode switch found (type: %s), currently in %s mode\n",
3230 type, in_tablet_mode ? "tablet" : "laptop");
3232 res = add_to_attr_set(hotkey_dev_attributes,
3233 &dev_attr_hotkey_tablet_mode.attr);
3237 return in_tablet_mode;
3240 static int __init hotkey_init(struct ibm_init_struct *iibm)
3242 /* Requirements for changing the default keymaps:
3244 * 1. Many of the keys are mapped to KEY_RESERVED for very
3245 * good reasons. Do not change them unless you have deep
3246 * knowledge on the IBM and Lenovo ThinkPad firmware for
3247 * the various ThinkPad models. The driver behaves
3248 * differently for KEY_RESERVED: such keys have their
3249 * hot key mask *unset* in mask_recommended, and also
3250 * in the initial hot key mask programmed into the
3251 * firmware at driver load time, which means the firm-
3252 * ware may react very differently if you change them to
3255 * 2. You must be subscribed to the linux-thinkpad and
3256 * ibm-acpi-devel mailing lists, and you should read the
3257 * list archives since 2007 if you want to change the
3258 * keymaps. This requirement exists so that you will
3259 * know the past history of problems with the thinkpad-
3260 * acpi driver keymaps, and also that you will be
3261 * listening to any bug reports;
3263 * 3. Do not send thinkpad-acpi specific patches directly to
3264 * for merging, *ever*. Send them to the linux-acpi
3265 * mailinglist for comments. Merging is to be done only
3266 * through acpi-test and the ACPI maintainer.
3268 * If the above is too much to ask, don't change the keymap.
3269 * Ask the thinkpad-acpi maintainer to do it, instead.
3273 TPACPI_KEYMAP_IBM_GENERIC = 0,
3274 TPACPI_KEYMAP_LENOVO_GENERIC,
3277 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3278 /* Generic keymap for IBM ThinkPads */
3279 [TPACPI_KEYMAP_IBM_GENERIC] = {
3280 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3281 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3282 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3283 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3285 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3286 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3287 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3288 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3290 /* brightness: firmware always reacts to them */
3291 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3292 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3294 /* Thinklight: firmware always react to it */
3295 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3297 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3298 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3300 /* Volume: firmware always react to it and reprograms
3301 * the built-in *extra* mixer. Never map it to control
3302 * another mixer by default. */
3303 KEY_RESERVED, /* 0x14: VOLUME UP */
3304 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3305 KEY_RESERVED, /* 0x16: MUTE */
3307 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3309 /* (assignments unknown, please report if found) */
3310 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3311 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3313 /* No assignments, only used for Adaptive keyboards. */
3314 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3315 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3316 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3317 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3318 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3320 /* No assignment, used for newer Lenovo models */
3321 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3322 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3323 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3324 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3325 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3326 KEY_UNKNOWN, KEY_UNKNOWN
3330 /* Generic keymap for Lenovo ThinkPads */
3331 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3332 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3333 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3334 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3335 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3337 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3338 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3339 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3340 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3342 /* These should be enabled --only-- when ACPI video
3343 * is disabled (i.e. in "vendor" mode), and are handled
3344 * in a special way by the init code */
3345 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3346 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3348 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3350 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3351 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3353 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3354 * react to it and reprograms the built-in *extra* mixer.
3355 * Never map it to control another mixer by default.
3357 * T60?, T61, R60?, R61: firmware and EC tries to send
3358 * these over the regular keyboard, so these are no-ops,
3359 * but there are still weird bugs re. MUTE, so do not
3360 * change unless you get test reports from all Lenovo
3361 * models. May cause the BIOS to interfere with the
3364 KEY_RESERVED, /* 0x14: VOLUME UP */
3365 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3366 KEY_RESERVED, /* 0x16: MUTE */
3368 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3370 /* (assignments unknown, please report if found) */
3371 KEY_UNKNOWN, KEY_UNKNOWN,
3374 * The mic mute button only sends 0x1a. It does not
3375 * automatically mute the mic or change the mute light.
3377 KEY_MICMUTE, /* 0x1a: Mic mute (since ?400 or so) */
3379 /* (assignments unknown, please report if found) */
3382 /* Extra keys in use since the X240 / T440 / T540 */
3383 KEY_CONFIG, KEY_SEARCH, KEY_SCALE, KEY_FILE,
3386 * These are the adaptive keyboard keycodes for Carbon X1 2014.
3387 * The first item in this list is the Mute button which is
3388 * emitted with 0x103 through
3389 * adaptive_keyboard_hotkey_notify_hotkey() when the sound
3391 * We'll need to offset those by 0x20.
3393 KEY_RESERVED, /* Mute held, 0x103 */
3394 KEY_BRIGHTNESS_MIN, /* Backlight off */
3395 KEY_RESERVED, /* Clipping tool */
3396 KEY_RESERVED, /* Cloud */
3398 KEY_VOICECOMMAND, /* Voice */
3400 KEY_RESERVED, /* Gestures */
3404 KEY_CONFIG, /* Settings */
3405 KEY_RESERVED, /* New tab */
3406 KEY_REFRESH, /* Reload */
3407 KEY_BACK, /* Back */
3408 KEY_RESERVED, /* Microphone down */
3409 KEY_RESERVED, /* Microphone up */
3410 KEY_RESERVED, /* Microphone cancellation */
3411 KEY_RESERVED, /* Camera mode */
3412 KEY_RESERVED, /* Rotate display, 0x116 */
3415 * These are found in 2017 models (e.g. T470s, X270).
3416 * The lowest known value is 0x311, which according to
3417 * the manual should launch a user defined favorite
3420 * The offset for these is TP_ACPI_HOTKEYSCAN_EXTENDED_START,
3421 * corresponding to 0x34.
3424 /* (assignments unknown, please report if found) */
3425 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3426 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3427 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3428 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3431 KEY_BOOKMARKS, /* Favorite app, 0x311 */
3432 KEY_SELECTIVE_SCREENSHOT, /* Clipping tool */
3433 KEY_CALC, /* Calculator (above numpad, P52) */
3434 KEY_BLUETOOTH, /* Bluetooth */
3435 KEY_KEYBOARD, /* Keyboard, 0x315 */
3436 KEY_FN_RIGHT_SHIFT, /* Fn + right Shift */
3437 KEY_NOTIFICATION_CENTER, /* Notification Center */
3438 KEY_PICKUP_PHONE, /* Answer incoming call */
3439 KEY_HANGUP_PHONE, /* Decline incoming call */
3443 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3444 /* Generic maps (fallback) */
3446 .vendor = PCI_VENDOR_ID_IBM,
3447 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3448 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3451 .vendor = PCI_VENDOR_ID_LENOVO,
3452 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3453 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3457 #define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3458 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3463 bool radiosw_state = false;
3464 bool tabletsw_state = false;
3466 unsigned long quirks;
3467 unsigned long keymap_id;
3469 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3470 "initializing hotkey subdriver\n");
3472 BUG_ON(!tpacpi_inputdev);
3473 BUG_ON(tpacpi_inputdev->open != NULL ||
3474 tpacpi_inputdev->close != NULL);
3476 TPACPI_ACPIHANDLE_INIT(hkey);
3477 mutex_init(&hotkey_mutex);
3479 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3480 mutex_init(&hotkey_thread_data_mutex);
3483 /* hotkey not supported on 570 */
3484 tp_features.hotkey = hkey_handle != NULL;
3486 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3488 str_supported(tp_features.hotkey));
3490 if (!tp_features.hotkey)
3493 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3494 ARRAY_SIZE(tpacpi_hotkey_qtable));
3496 tpacpi_disable_brightness_delay();
3498 /* MUST have enough space for all attributes to be added to
3499 * hotkey_dev_attributes */
3500 hotkey_dev_attributes = create_attr_set(
3501 ARRAY_SIZE(hotkey_attributes) + 2,
3503 if (!hotkey_dev_attributes)
3505 res = add_many_to_attr_set(hotkey_dev_attributes,
3507 ARRAY_SIZE(hotkey_attributes));
3511 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3512 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3513 for HKEY interface version 0x100 */
3514 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3515 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3516 "firmware HKEY interface version: 0x%x\n",
3519 switch (hkeyv >> 8) {
3522 * MHKV 0x100 in A31, R40, R40e,
3523 * T4x, X31, and later
3526 /* Paranoia check AND init hotkey_all_mask */
3527 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3529 pr_err("missing MHKA handler, please report this to %s\n",
3531 /* Fallback: pre-init for FN+F3,F4,F12 */
3532 hotkey_all_mask = 0x080cU;
3534 tp_features.hotkey_mask = 1;
3540 * MHKV 0x200 in X1, T460s, X260, T560, X1 Tablet (2016)
3543 /* Paranoia check AND init hotkey_all_mask */
3544 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3546 pr_err("missing MHKA handler, please report this to %s\n",
3548 /* Fallback: pre-init for FN+F3,F4,F12 */
3549 hotkey_all_mask = 0x080cU;
3551 tp_features.hotkey_mask = 1;
3555 * Check if we have an adaptive keyboard, like on the
3556 * Lenovo Carbon X1 2014 (2nd Gen).
3558 if (acpi_evalf(hkey_handle, &hotkey_adaptive_all_mask,
3560 if (hotkey_adaptive_all_mask != 0) {
3561 tp_features.has_adaptive_kbd = true;
3562 res = sysfs_create_group(
3563 &tpacpi_pdev->dev.kobj,
3564 &adaptive_kbd_attr_group);
3569 tp_features.has_adaptive_kbd = false;
3570 hotkey_adaptive_all_mask = 0x0U;
3575 pr_err("unknown version of the HKEY interface: 0x%x\n",
3577 pr_err("please report this to %s\n", TPACPI_MAIL);
3582 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3583 "hotkey masks are %s\n",
3584 str_supported(tp_features.hotkey_mask));
3586 /* Init hotkey_all_mask if not initialized yet */
3587 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3588 (quirks & TPACPI_HK_Q_INIMASK))
3589 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3591 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3592 if (tp_features.hotkey_mask) {
3593 /* hotkey_source_mask *must* be zero for
3594 * the first hotkey_mask_get to return hotkey_orig_mask */
3595 res = hotkey_mask_get();
3599 hotkey_orig_mask = hotkey_acpi_mask;
3601 hotkey_orig_mask = hotkey_all_mask;
3602 hotkey_acpi_mask = hotkey_all_mask;
3605 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3607 tp_features.hotkey_wlsw = 1;
3608 radiosw_state = !!tpacpi_wlsw_emulstate;
3609 pr_info("radio switch emulation enabled\n");
3612 /* Not all thinkpads have a hardware radio switch */
3613 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3614 tp_features.hotkey_wlsw = 1;
3615 radiosw_state = !!status;
3616 pr_info("radio switch found; radios are %s\n",
3617 enabled(status, 0));
3619 if (tp_features.hotkey_wlsw)
3620 res = add_to_attr_set(hotkey_dev_attributes,
3621 &dev_attr_hotkey_radio_sw.attr);
3623 res = hotkey_init_tablet_mode();
3627 tabletsw_state = res;
3629 res = register_attr_set_with_sysfs(hotkey_dev_attributes,
3630 &tpacpi_pdev->dev.kobj);
3634 /* Set up key map */
3635 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3636 ARRAY_SIZE(tpacpi_keymap_qtable));
3637 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3638 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3639 "using keymap number %lu\n", keymap_id);
3641 hotkey_keycode_map = kmemdup(&tpacpi_keymaps[keymap_id],
3642 TPACPI_HOTKEY_MAP_SIZE, GFP_KERNEL);
3643 if (!hotkey_keycode_map) {
3644 pr_err("failed to allocate memory for key map\n");
3649 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3650 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3651 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3652 tpacpi_inputdev->keycode = hotkey_keycode_map;
3653 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3654 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3655 input_set_capability(tpacpi_inputdev, EV_KEY,
3656 hotkey_keycode_map[i]);
3658 if (i < sizeof(hotkey_reserved_mask)*8)
3659 hotkey_reserved_mask |= 1 << i;
3663 if (tp_features.hotkey_wlsw) {
3664 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3665 input_report_switch(tpacpi_inputdev,
3666 SW_RFKILL_ALL, radiosw_state);
3668 if (tp_features.hotkey_tablet) {
3669 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3670 input_report_switch(tpacpi_inputdev,
3671 SW_TABLET_MODE, tabletsw_state);
3674 /* Do not issue duplicate brightness change events to
3675 * userspace. tpacpi_detect_brightness_capabilities() must have
3676 * been called before this point */
3677 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
3678 pr_info("This ThinkPad has standard ACPI backlight brightness control, supported by the ACPI video driver\n");
3679 pr_notice("Disabling thinkpad-acpi brightness events by default...\n");
3681 /* Disable brightness up/down on Lenovo thinkpads when
3682 * ACPI is handling them, otherwise it is plain impossible
3683 * for userspace to do something even remotely sane */
3684 hotkey_reserved_mask |=
3685 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3686 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3687 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3688 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3691 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3692 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3694 & ~hotkey_reserved_mask;
3696 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3697 "hotkey source mask 0x%08x, polling freq %u\n",
3698 hotkey_source_mask, hotkey_poll_freq);
3701 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3702 "enabling firmware HKEY event interface...\n");
3703 res = hotkey_status_set(true);
3708 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3709 | hotkey_driver_mask)
3710 & ~hotkey_source_mask);
3711 if (res < 0 && res != -ENXIO) {
3715 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3716 & ~hotkey_reserved_mask;
3717 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3718 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3719 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3721 tpacpi_inputdev->open = &hotkey_inputdev_open;
3722 tpacpi_inputdev->close = &hotkey_inputdev_close;
3724 hotkey_poll_setup_safe(true);
3729 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3730 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3731 &adaptive_kbd_attr_group);
3733 hotkey_dev_attributes = NULL;
3735 return (res < 0) ? res : 1;
3738 /* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3739 * mode, Web conference mode, Function mode and Lay-flat mode.
3740 * We support Home mode and Function mode currently.
3742 * Will consider support rest of modes in future.
3745 static const int adaptive_keyboard_modes[] = {
3747 /* WEB_BROWSER_MODE = 2,
3748 WEB_CONFERENCE_MODE = 3, */
3752 #define DFR_CHANGE_ROW 0x101
3753 #define DFR_SHOW_QUICKVIEW_ROW 0x102
3754 #define FIRST_ADAPTIVE_KEY 0x103
3756 /* press Fn key a while second, it will switch to Function Mode. Then
3757 * release Fn key, previous mode be restored.
3759 static bool adaptive_keyboard_mode_is_saved;
3760 static int adaptive_keyboard_prev_mode;
3762 static int adaptive_keyboard_get_mode(void)
3766 if (!acpi_evalf(hkey_handle, &mode, "GTRW", "dd", 0)) {
3767 pr_err("Cannot read adaptive keyboard mode\n");
3774 static int adaptive_keyboard_set_mode(int new_mode)
3777 new_mode > LAYFLAT_MODE)
3780 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3781 pr_err("Cannot set adaptive keyboard mode\n");
3788 static int adaptive_keyboard_get_next_mode(int mode)
3791 size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3793 for (i = 0; i <= max_mode; i++) {
3794 if (adaptive_keyboard_modes[i] == mode)
3803 return adaptive_keyboard_modes[i];
3806 static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3808 int current_mode = 0;
3813 case DFR_CHANGE_ROW:
3814 if (adaptive_keyboard_mode_is_saved) {
3815 new_mode = adaptive_keyboard_prev_mode;
3816 adaptive_keyboard_mode_is_saved = false;
3818 current_mode = adaptive_keyboard_get_mode();
3819 if (current_mode < 0)
3821 new_mode = adaptive_keyboard_get_next_mode(
3825 if (adaptive_keyboard_set_mode(new_mode) < 0)
3830 case DFR_SHOW_QUICKVIEW_ROW:
3831 current_mode = adaptive_keyboard_get_mode();
3832 if (current_mode < 0)
3835 adaptive_keyboard_prev_mode = current_mode;
3836 adaptive_keyboard_mode_is_saved = true;
3838 if (adaptive_keyboard_set_mode (FUNCTION_MODE) < 0)
3843 if (scancode < FIRST_ADAPTIVE_KEY ||
3844 scancode >= FIRST_ADAPTIVE_KEY +
3845 TP_ACPI_HOTKEYSCAN_EXTENDED_START -
3846 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3847 pr_info("Unhandled adaptive keyboard key: 0x%x\n",
3851 keycode = hotkey_keycode_map[scancode - FIRST_ADAPTIVE_KEY +
3852 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START];
3853 if (keycode != KEY_RESERVED) {
3854 mutex_lock(&tpacpi_inputdev_send_mutex);
3856 input_report_key(tpacpi_inputdev, keycode, 1);
3857 input_sync(tpacpi_inputdev);
3859 input_report_key(tpacpi_inputdev, keycode, 0);
3860 input_sync(tpacpi_inputdev);
3862 mutex_unlock(&tpacpi_inputdev_send_mutex);
3868 static bool hotkey_notify_hotkey(const u32 hkey,
3870 bool *ignore_acpi_ev)
3872 /* 0x1000-0x1FFF: key presses */
3873 unsigned int scancode = hkey & 0xfff;
3874 *send_acpi_ev = true;
3875 *ignore_acpi_ev = false;
3878 * Original events are in the 0x10XX range, the adaptive keyboard
3879 * found in 2014 X1 Carbon emits events are of 0x11XX. In 2017
3880 * models, additional keys are emitted through 0x13XX.
3882 switch ((hkey >> 8) & 0xf) {
3885 scancode <= TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3886 /* HKEY event 0x1001 is scancode 0x00 */
3888 if (!(hotkey_source_mask & (1 << scancode))) {
3889 tpacpi_input_send_key_masked(scancode);
3890 *send_acpi_ev = false;
3892 *ignore_acpi_ev = true;
3899 return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3902 /* Extended keycodes start at 0x300 and our offset into the map
3903 * TP_ACPI_HOTKEYSCAN_EXTENDED_START. The calculated scancode
3904 * will be positive, but might not be in the correct range.
3906 scancode -= (0x300 - TP_ACPI_HOTKEYSCAN_EXTENDED_START);
3907 if (scancode >= TP_ACPI_HOTKEYSCAN_EXTENDED_START &&
3908 scancode < TPACPI_HOTKEY_MAP_LEN) {
3909 tpacpi_input_send_key(scancode);
3918 static bool hotkey_notify_wakeup(const u32 hkey,
3920 bool *ignore_acpi_ev)
3922 /* 0x2000-0x2FFF: Wakeup reason */
3923 *send_acpi_ev = true;
3924 *ignore_acpi_ev = false;
3927 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3928 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3929 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3930 *ignore_acpi_ev = true;
3933 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3934 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3935 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3936 *ignore_acpi_ev = true;
3939 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3940 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3941 pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3942 /* how to auto-heal: */
3943 /* 2313: woke up from S3, go to S4/S5 */
3944 /* 2413: woke up from S4, go to S5 */
3951 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3952 pr_info("woke up due to a hot-unplug request...\n");
3953 hotkey_wakeup_reason_notify_change();
3958 static bool hotkey_notify_dockevent(const u32 hkey,
3960 bool *ignore_acpi_ev)
3962 /* 0x4000-0x4FFF: dock-related events */
3963 *send_acpi_ev = true;
3964 *ignore_acpi_ev = false;
3967 case TP_HKEY_EV_UNDOCK_ACK:
3968 /* ACPI undock operation completed after wakeup */
3969 hotkey_autosleep_ack = 1;
3970 pr_info("undocked\n");
3971 hotkey_wakeup_hotunplug_complete_notify_change();
3974 case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3975 pr_info("docked into hotplug port replicator\n");
3977 case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3978 pr_info("undocked from hotplug port replicator\n");
3986 static bool hotkey_notify_usrevent(const u32 hkey,
3988 bool *ignore_acpi_ev)
3990 /* 0x5000-0x5FFF: human interface helpers */
3991 *send_acpi_ev = true;
3992 *ignore_acpi_ev = false;
3995 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3996 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3999 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
4000 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
4001 tpacpi_input_send_tabletsw();
4002 hotkey_tablet_mode_notify_change();
4003 *send_acpi_ev = false;
4006 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
4007 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
4008 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
4009 /* do not propagate these events */
4010 *ignore_acpi_ev = true;
4018 static void thermal_dump_all_sensors(void);
4020 static bool hotkey_notify_6xxx(const u32 hkey,
4022 bool *ignore_acpi_ev)
4024 /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
4025 *send_acpi_ev = true;
4026 *ignore_acpi_ev = false;
4029 case TP_HKEY_EV_THM_TABLE_CHANGED:
4030 pr_debug("EC reports: Thermal Table has changed\n");
4031 /* recommended action: do nothing, we don't have
4032 * Lenovo ATM information */
4034 case TP_HKEY_EV_THM_CSM_COMPLETED:
4035 pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
4036 /* Thermal event - pass on to event handler */
4037 tpacpi_driver_event(hkey);
4039 case TP_HKEY_EV_THM_TRANSFM_CHANGED:
4040 pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
4041 /* recommended action: do nothing, we don't have
4042 * Lenovo ATM information */
4044 case TP_HKEY_EV_ALARM_BAT_HOT:
4045 pr_crit("THERMAL ALARM: battery is too hot!\n");
4046 /* recommended action: warn user through gui */
4048 case TP_HKEY_EV_ALARM_BAT_XHOT:
4049 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
4050 /* recommended action: immediate sleep/hibernate */
4052 case TP_HKEY_EV_ALARM_SENSOR_HOT:
4053 pr_crit("THERMAL ALARM: a sensor reports something is too hot!\n");
4054 /* recommended action: warn user through gui, that */
4055 /* some internal component is too hot */
4057 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
4058 pr_alert("THERMAL EMERGENCY: a sensor reports something is extremely hot!\n");
4059 /* recommended action: immediate sleep/hibernate */
4061 case TP_HKEY_EV_AC_CHANGED:
4062 /* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
4063 * AC status changed; can be triggered by plugging or
4064 * unplugging AC adapter, docking or undocking. */
4068 case TP_HKEY_EV_KEY_NUMLOCK:
4069 case TP_HKEY_EV_KEY_FN:
4070 /* key press events, we just ignore them as long as the EC
4071 * is still reporting them in the normal keyboard stream */
4072 *send_acpi_ev = false;
4073 *ignore_acpi_ev = true;
4076 case TP_HKEY_EV_KEY_FN_ESC:
4077 /* Get the media key status to foce the status LED to update */
4078 acpi_evalf(hkey_handle, NULL, "GMKS", "v");
4079 *send_acpi_ev = false;
4080 *ignore_acpi_ev = true;
4083 case TP_HKEY_EV_TABLET_CHANGED:
4084 tpacpi_input_send_tabletsw();
4085 hotkey_tablet_mode_notify_change();
4086 *send_acpi_ev = false;
4089 case TP_HKEY_EV_PALM_DETECTED:
4090 case TP_HKEY_EV_PALM_UNDETECTED:
4091 /* palm detected hovering the keyboard, forward to user-space
4092 * via netlink for consumption */
4096 /* report simply as unknown, no sensor dump */
4100 thermal_dump_all_sensors();
4104 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
4108 bool ignore_acpi_ev;
4111 if (event != 0x80) {
4112 pr_err("unknown HKEY notification event %d\n", event);
4113 /* forward it to userspace, maybe it knows how to handle it */
4114 acpi_bus_generate_netlink_event(
4115 ibm->acpi->device->pnp.device_class,
4116 dev_name(&ibm->acpi->device->dev),
4122 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
4123 pr_err("failed to retrieve HKEY event\n");
4132 send_acpi_ev = true;
4133 ignore_acpi_ev = false;
4135 switch (hkey >> 12) {
4137 /* 0x1000-0x1FFF: key presses */
4138 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
4142 /* 0x2000-0x2FFF: Wakeup reason */
4143 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
4147 /* 0x3000-0x3FFF: bay-related wakeups */
4149 case TP_HKEY_EV_BAYEJ_ACK:
4150 hotkey_autosleep_ack = 1;
4151 pr_info("bay ejected\n");
4152 hotkey_wakeup_hotunplug_complete_notify_change();
4155 case TP_HKEY_EV_OPTDRV_EJ:
4156 /* FIXME: kick libata if SATA link offline */
4164 /* 0x4000-0x4FFF: dock-related events */
4165 known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
4169 /* 0x5000-0x5FFF: human interface helpers */
4170 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
4174 /* 0x6000-0x6FFF: thermal alarms/notices and
4175 * keyboard events */
4176 known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
4180 /* 0x7000-0x7FFF: misc */
4181 if (tp_features.hotkey_wlsw &&
4182 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
4183 tpacpi_send_radiosw_update();
4188 fallthrough; /* to default */
4193 pr_notice("unhandled HKEY event 0x%04x\n", hkey);
4194 pr_notice("please report the conditions when this event happened to %s\n",
4198 /* netlink events */
4199 if (!ignore_acpi_ev && send_acpi_ev) {
4200 acpi_bus_generate_netlink_event(
4201 ibm->acpi->device->pnp.device_class,
4202 dev_name(&ibm->acpi->device->dev),
4208 static void hotkey_suspend(void)
4210 /* Do these on suspend, we get the events on early resume! */
4211 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
4212 hotkey_autosleep_ack = 0;
4214 /* save previous mode of adaptive keyboard of X1 Carbon */
4215 if (tp_features.has_adaptive_kbd) {
4216 if (!acpi_evalf(hkey_handle, &adaptive_keyboard_prev_mode,
4218 pr_err("Cannot read adaptive keyboard mode.\n");
4223 static void hotkey_resume(void)
4225 tpacpi_disable_brightness_delay();
4227 if (hotkey_status_set(true) < 0 ||
4228 hotkey_mask_set(hotkey_acpi_mask) < 0)
4229 pr_err("error while attempting to reset the event firmware interface\n");
4231 tpacpi_send_radiosw_update();
4232 tpacpi_input_send_tabletsw();
4233 hotkey_tablet_mode_notify_change();
4234 hotkey_wakeup_reason_notify_change();
4235 hotkey_wakeup_hotunplug_complete_notify_change();
4236 hotkey_poll_setup_safe(false);
4238 /* restore previous mode of adapive keyboard of X1 Carbon */
4239 if (tp_features.has_adaptive_kbd) {
4240 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd",
4241 adaptive_keyboard_prev_mode)) {
4242 pr_err("Cannot set adaptive keyboard mode.\n");
4247 /* procfs -------------------------------------------------------------- */
4248 static int hotkey_read(struct seq_file *m)
4252 if (!tp_features.hotkey) {
4253 seq_printf(m, "status:\t\tnot supported\n");
4257 if (mutex_lock_killable(&hotkey_mutex))
4258 return -ERESTARTSYS;
4259 res = hotkey_status_get(&status);
4261 res = hotkey_mask_get();
4262 mutex_unlock(&hotkey_mutex);
4266 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
4267 if (hotkey_all_mask) {
4268 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
4269 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
4271 seq_printf(m, "mask:\t\tnot supported\n");
4272 seq_printf(m, "commands:\tenable, disable, reset\n");
4278 static void hotkey_enabledisable_warn(bool enable)
4280 tpacpi_log_usertask("procfs hotkey enable/disable");
4281 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
4282 pr_fmt("hotkey enable/disable functionality has been removed from the driver. Hotkeys are always enabled.\n")))
4283 pr_err("Please remove the hotkey=enable module parameter, it is deprecated. Hotkeys are always enabled.\n");
4286 static int hotkey_write(char *buf)
4292 if (!tp_features.hotkey)
4295 if (mutex_lock_killable(&hotkey_mutex))
4296 return -ERESTARTSYS;
4298 mask = hotkey_user_mask;
4301 while ((cmd = strsep(&buf, ","))) {
4302 if (strlencmp(cmd, "enable") == 0) {
4303 hotkey_enabledisable_warn(1);
4304 } else if (strlencmp(cmd, "disable") == 0) {
4305 hotkey_enabledisable_warn(0);
4307 } else if (strlencmp(cmd, "reset") == 0) {
4308 mask = (hotkey_all_mask | hotkey_source_mask)
4309 & ~hotkey_reserved_mask;
4310 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
4312 } else if (sscanf(cmd, "%x", &mask) == 1) {
4321 tpacpi_disclose_usertask("procfs hotkey",
4322 "set mask to 0x%08x\n", mask);
4323 res = hotkey_user_mask_set(mask);
4327 mutex_unlock(&hotkey_mutex);
4331 static const struct acpi_device_id ibm_htk_device_ids[] = {
4332 {TPACPI_ACPI_IBM_HKEY_HID, 0},
4333 {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
4334 {TPACPI_ACPI_LENOVO_HKEY_V2_HID, 0},
4338 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
4339 .hid = ibm_htk_device_ids,
4340 .notify = hotkey_notify,
4341 .handle = &hkey_handle,
4342 .type = ACPI_DEVICE_NOTIFY,
4345 static struct ibm_struct hotkey_driver_data = {
4347 .read = hotkey_read,
4348 .write = hotkey_write,
4349 .exit = hotkey_exit,
4350 .resume = hotkey_resume,
4351 .suspend = hotkey_suspend,
4352 .acpi = &ibm_hotkey_acpidriver,
4355 /*************************************************************************
4356 * Bluetooth subdriver
4360 /* ACPI GBDC/SBDC bits */
4361 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
4362 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
4363 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
4364 0 = disable, 1 = enable */
4368 /* ACPI \BLTH commands */
4369 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
4370 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
4371 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
4372 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
4373 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
4376 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
4378 static int bluetooth_get_status(void)
4382 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4383 if (dbg_bluetoothemul)
4384 return (tpacpi_bluetooth_emulstate) ?
4385 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4388 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4391 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4392 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4395 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4399 vdbg_printk(TPACPI_DBG_RFKILL,
4400 "will attempt to %s bluetooth\n",
4401 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4403 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4404 if (dbg_bluetoothemul) {
4405 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4410 if (state == TPACPI_RFK_RADIO_ON)
4411 status = TP_ACPI_BLUETOOTH_RADIOSSW
4412 | TP_ACPI_BLUETOOTH_RESUMECTRL;
4416 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4422 /* sysfs bluetooth enable ---------------------------------------------- */
4423 static ssize_t bluetooth_enable_show(struct device *dev,
4424 struct device_attribute *attr,
4427 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4431 static ssize_t bluetooth_enable_store(struct device *dev,
4432 struct device_attribute *attr,
4433 const char *buf, size_t count)
4435 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4439 static DEVICE_ATTR_RW(bluetooth_enable);
4441 /* --------------------------------------------------------------------- */
4443 static struct attribute *bluetooth_attributes[] = {
4444 &dev_attr_bluetooth_enable.attr,
4448 static const struct attribute_group bluetooth_attr_group = {
4449 .attrs = bluetooth_attributes,
4452 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4453 .get_status = bluetooth_get_status,
4454 .set_status = bluetooth_set_status,
4457 static void bluetooth_shutdown(void)
4459 /* Order firmware to save current state to NVRAM */
4460 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4461 TP_ACPI_BLTH_SAVE_STATE))
4462 pr_notice("failed to save bluetooth state to NVRAM\n");
4464 vdbg_printk(TPACPI_DBG_RFKILL,
4465 "bluetooth state saved to NVRAM\n");
4468 static void bluetooth_exit(void)
4470 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4471 &bluetooth_attr_group);
4473 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4475 bluetooth_shutdown();
4478 static const struct dmi_system_id bt_fwbug_list[] __initconst = {
4480 .ident = "ThinkPad E485",
4482 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4483 DMI_MATCH(DMI_BOARD_NAME, "20KU"),
4487 .ident = "ThinkPad E585",
4489 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4490 DMI_MATCH(DMI_BOARD_NAME, "20KV"),
4494 .ident = "ThinkPad A285 - 20MW",
4496 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4497 DMI_MATCH(DMI_BOARD_NAME, "20MW"),
4501 .ident = "ThinkPad A285 - 20MX",
4503 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4504 DMI_MATCH(DMI_BOARD_NAME, "20MX"),
4508 .ident = "ThinkPad A485 - 20MU",
4510 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4511 DMI_MATCH(DMI_BOARD_NAME, "20MU"),
4515 .ident = "ThinkPad A485 - 20MV",
4517 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4518 DMI_MATCH(DMI_BOARD_NAME, "20MV"),
4524 static const struct pci_device_id fwbug_cards_ids[] __initconst = {
4525 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24F3) },
4526 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24FD) },
4527 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x2526) },
4532 static int __init have_bt_fwbug(void)
4535 * Some AMD based ThinkPads have a firmware bug that calling
4536 * "GBDC" will cause bluetooth on Intel wireless cards blocked
4538 if (dmi_check_system(bt_fwbug_list) && pci_dev_present(fwbug_cards_ids)) {
4539 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4540 FW_BUG "disable bluetooth subdriver for Intel cards\n");
4546 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4551 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4552 "initializing bluetooth subdriver\n");
4554 TPACPI_ACPIHANDLE_INIT(hkey);
4556 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4557 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4558 tp_features.bluetooth = !have_bt_fwbug() && hkey_handle &&
4559 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4561 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4562 "bluetooth is %s, status 0x%02x\n",
4563 str_supported(tp_features.bluetooth),
4566 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4567 if (dbg_bluetoothemul) {
4568 tp_features.bluetooth = 1;
4569 pr_info("bluetooth switch emulation enabled\n");
4572 if (tp_features.bluetooth &&
4573 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4574 /* no bluetooth hardware present in system */
4575 tp_features.bluetooth = 0;
4576 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4577 "bluetooth hardware not installed\n");
4580 if (!tp_features.bluetooth)
4583 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4584 &bluetooth_tprfk_ops,
4585 RFKILL_TYPE_BLUETOOTH,
4586 TPACPI_RFK_BLUETOOTH_SW_NAME,
4591 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4592 &bluetooth_attr_group);
4594 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4601 /* procfs -------------------------------------------------------------- */
4602 static int bluetooth_read(struct seq_file *m)
4604 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4607 static int bluetooth_write(char *buf)
4609 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4612 static struct ibm_struct bluetooth_driver_data = {
4613 .name = "bluetooth",
4614 .read = bluetooth_read,
4615 .write = bluetooth_write,
4616 .exit = bluetooth_exit,
4617 .shutdown = bluetooth_shutdown,
4620 /*************************************************************************
4625 /* ACPI GWAN/SWAN bits */
4626 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4627 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4628 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4629 0 = disable, 1 = enable */
4632 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4634 static int wan_get_status(void)
4638 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4640 return (tpacpi_wwan_emulstate) ?
4641 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4644 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4647 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4648 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4651 static int wan_set_status(enum tpacpi_rfkill_state state)
4655 vdbg_printk(TPACPI_DBG_RFKILL,
4656 "will attempt to %s wwan\n",
4657 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4659 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4661 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4666 if (state == TPACPI_RFK_RADIO_ON)
4667 status = TP_ACPI_WANCARD_RADIOSSW
4668 | TP_ACPI_WANCARD_RESUMECTRL;
4672 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4678 /* sysfs wan enable ---------------------------------------------------- */
4679 static ssize_t wan_enable_show(struct device *dev,
4680 struct device_attribute *attr,
4683 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4687 static ssize_t wan_enable_store(struct device *dev,
4688 struct device_attribute *attr,
4689 const char *buf, size_t count)
4691 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4695 static DEVICE_ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4696 wan_enable_show, wan_enable_store);
4698 /* --------------------------------------------------------------------- */
4700 static struct attribute *wan_attributes[] = {
4701 &dev_attr_wwan_enable.attr,
4705 static const struct attribute_group wan_attr_group = {
4706 .attrs = wan_attributes,
4709 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4710 .get_status = wan_get_status,
4711 .set_status = wan_set_status,
4714 static void wan_shutdown(void)
4716 /* Order firmware to save current state to NVRAM */
4717 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4718 TP_ACPI_WGSV_SAVE_STATE))
4719 pr_notice("failed to save WWAN state to NVRAM\n");
4721 vdbg_printk(TPACPI_DBG_RFKILL,
4722 "WWAN state saved to NVRAM\n");
4725 static void wan_exit(void)
4727 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4730 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4735 static int __init wan_init(struct ibm_init_struct *iibm)
4740 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4741 "initializing wan subdriver\n");
4743 TPACPI_ACPIHANDLE_INIT(hkey);
4745 tp_features.wan = hkey_handle &&
4746 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4748 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4749 "wan is %s, status 0x%02x\n",
4750 str_supported(tp_features.wan),
4753 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4755 tp_features.wan = 1;
4756 pr_info("wwan switch emulation enabled\n");
4759 if (tp_features.wan &&
4760 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4761 /* no wan hardware present in system */
4762 tp_features.wan = 0;
4763 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4764 "wan hardware not installed\n");
4767 if (!tp_features.wan)
4770 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4773 TPACPI_RFK_WWAN_SW_NAME,
4778 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4782 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4789 /* procfs -------------------------------------------------------------- */
4790 static int wan_read(struct seq_file *m)
4792 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4795 static int wan_write(char *buf)
4797 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4800 static struct ibm_struct wan_driver_data = {
4805 .shutdown = wan_shutdown,
4808 /*************************************************************************
4813 /* ACPI GUWB/SUWB bits */
4814 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4815 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4818 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4820 static int uwb_get_status(void)
4824 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4826 return (tpacpi_uwb_emulstate) ?
4827 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4830 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4833 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4834 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4837 static int uwb_set_status(enum tpacpi_rfkill_state state)
4841 vdbg_printk(TPACPI_DBG_RFKILL,
4842 "will attempt to %s UWB\n",
4843 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4845 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4847 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4852 if (state == TPACPI_RFK_RADIO_ON)
4853 status = TP_ACPI_UWB_RADIOSSW;
4857 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4863 /* --------------------------------------------------------------------- */
4865 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4866 .get_status = uwb_get_status,
4867 .set_status = uwb_set_status,
4870 static void uwb_exit(void)
4872 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4875 static int __init uwb_init(struct ibm_init_struct *iibm)
4880 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4881 "initializing uwb subdriver\n");
4883 TPACPI_ACPIHANDLE_INIT(hkey);
4885 tp_features.uwb = hkey_handle &&
4886 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4888 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4889 "uwb is %s, status 0x%02x\n",
4890 str_supported(tp_features.uwb),
4893 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4895 tp_features.uwb = 1;
4896 pr_info("uwb switch emulation enabled\n");
4899 if (tp_features.uwb &&
4900 !(status & TP_ACPI_UWB_HWPRESENT)) {
4901 /* no uwb hardware present in system */
4902 tp_features.uwb = 0;
4903 dbg_printk(TPACPI_DBG_INIT,
4904 "uwb hardware not installed\n");
4907 if (!tp_features.uwb)
4910 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4913 TPACPI_RFK_UWB_SW_NAME,
4918 static struct ibm_struct uwb_driver_data = {
4921 .flags.experimental = 1,
4924 /*************************************************************************
4928 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4930 enum video_access_mode {
4931 TPACPI_VIDEO_NONE = 0,
4932 TPACPI_VIDEO_570, /* 570 */
4933 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4934 TPACPI_VIDEO_NEW, /* all others */
4937 enum { /* video status flags, based on VIDEO_570 */
4938 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4939 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4940 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4943 enum { /* TPACPI_VIDEO_570 constants */
4944 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4945 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4946 * video_status_flags */
4947 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4948 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4951 static enum video_access_mode video_supported;
4952 static int video_orig_autosw;
4954 static int video_autosw_get(void);
4955 static int video_autosw_set(int enable);
4957 TPACPI_HANDLE(vid, root,
4958 "\\_SB.PCI.AGP.VGA", /* 570 */
4959 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
4960 "\\_SB.PCI0.VID0", /* 770e */
4961 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
4962 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
4963 "\\_SB.PCI0.AGP.VID", /* all others */
4966 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4968 static int __init video_init(struct ibm_init_struct *iibm)
4972 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4974 TPACPI_ACPIHANDLE_INIT(vid);
4975 if (tpacpi_is_ibm())
4976 TPACPI_ACPIHANDLE_INIT(vid2);
4978 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4979 /* G41, assume IVGA doesn't change */
4980 vid_handle = vid2_handle;
4983 /* video switching not supported on R30, R31 */
4984 video_supported = TPACPI_VIDEO_NONE;
4985 else if (tpacpi_is_ibm() &&
4986 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4988 video_supported = TPACPI_VIDEO_570;
4989 else if (tpacpi_is_ibm() &&
4990 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4991 /* 600e/x, 770e, 770x */
4992 video_supported = TPACPI_VIDEO_770;
4995 video_supported = TPACPI_VIDEO_NEW;
4997 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4998 str_supported(video_supported != TPACPI_VIDEO_NONE),
5001 return (video_supported != TPACPI_VIDEO_NONE) ? 0 : 1;
5004 static void video_exit(void)
5006 dbg_printk(TPACPI_DBG_EXIT,
5007 "restoring original video autoswitch mode\n");
5008 if (video_autosw_set(video_orig_autosw))
5009 pr_err("error while trying to restore original video autoswitch mode\n");
5012 static int video_outputsw_get(void)
5017 switch (video_supported) {
5018 case TPACPI_VIDEO_570:
5019 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
5020 TP_ACPI_VIDEO_570_PHSCMD))
5022 status = i & TP_ACPI_VIDEO_570_PHSMASK;
5024 case TPACPI_VIDEO_770:
5025 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
5028 status |= TP_ACPI_VIDEO_S_LCD;
5029 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
5032 status |= TP_ACPI_VIDEO_S_CRT;
5034 case TPACPI_VIDEO_NEW:
5035 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
5036 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
5039 status |= TP_ACPI_VIDEO_S_CRT;
5041 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
5042 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
5045 status |= TP_ACPI_VIDEO_S_LCD;
5046 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
5049 status |= TP_ACPI_VIDEO_S_DVI;
5058 static int video_outputsw_set(int status)
5063 switch (video_supported) {
5064 case TPACPI_VIDEO_570:
5065 res = acpi_evalf(NULL, NULL,
5066 "\\_SB.PHS2", "vdd",
5067 TP_ACPI_VIDEO_570_PHS2CMD,
5068 status | TP_ACPI_VIDEO_570_PHS2SET);
5070 case TPACPI_VIDEO_770:
5071 autosw = video_autosw_get();
5075 res = video_autosw_set(1);
5078 res = acpi_evalf(vid_handle, NULL,
5079 "ASWT", "vdd", status * 0x100, 0);
5080 if (!autosw && video_autosw_set(autosw)) {
5081 pr_err("video auto-switch left enabled due to error\n");
5085 case TPACPI_VIDEO_NEW:
5086 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
5087 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
5093 return (res) ? 0 : -EIO;
5096 static int video_autosw_get(void)
5100 switch (video_supported) {
5101 case TPACPI_VIDEO_570:
5102 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
5105 case TPACPI_VIDEO_770:
5106 case TPACPI_VIDEO_NEW:
5107 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
5117 static int video_autosw_set(int enable)
5119 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable) ? 1 : 0))
5124 static int video_outputsw_cycle(void)
5126 int autosw = video_autosw_get();
5132 switch (video_supported) {
5133 case TPACPI_VIDEO_570:
5134 res = video_autosw_set(1);
5137 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
5139 case TPACPI_VIDEO_770:
5140 case TPACPI_VIDEO_NEW:
5141 res = video_autosw_set(1);
5144 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
5149 if (!autosw && video_autosw_set(autosw)) {
5150 pr_err("video auto-switch left enabled due to error\n");
5154 return (res) ? 0 : -EIO;
5157 static int video_expand_toggle(void)
5159 switch (video_supported) {
5160 case TPACPI_VIDEO_570:
5161 return acpi_evalf(ec_handle, NULL, "_Q17", "v") ?
5163 case TPACPI_VIDEO_770:
5164 return acpi_evalf(vid_handle, NULL, "VEXP", "v") ?
5166 case TPACPI_VIDEO_NEW:
5167 return acpi_evalf(NULL, NULL, "\\VEXP", "v") ?
5175 static int video_read(struct seq_file *m)
5179 if (video_supported == TPACPI_VIDEO_NONE) {
5180 seq_printf(m, "status:\t\tnot supported\n");
5184 /* Even reads can crash X.org, so... */
5185 if (!capable(CAP_SYS_ADMIN))
5188 status = video_outputsw_get();
5192 autosw = video_autosw_get();
5196 seq_printf(m, "status:\t\tsupported\n");
5197 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
5198 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
5199 if (video_supported == TPACPI_VIDEO_NEW)
5200 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
5201 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
5202 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
5203 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
5204 if (video_supported == TPACPI_VIDEO_NEW)
5205 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
5206 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
5207 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
5212 static int video_write(char *buf)
5215 int enable, disable, status;
5218 if (video_supported == TPACPI_VIDEO_NONE)
5221 /* Even reads can crash X.org, let alone writes... */
5222 if (!capable(CAP_SYS_ADMIN))
5228 while ((cmd = strsep(&buf, ","))) {
5229 if (strlencmp(cmd, "lcd_enable") == 0) {
5230 enable |= TP_ACPI_VIDEO_S_LCD;
5231 } else if (strlencmp(cmd, "lcd_disable") == 0) {
5232 disable |= TP_ACPI_VIDEO_S_LCD;
5233 } else if (strlencmp(cmd, "crt_enable") == 0) {
5234 enable |= TP_ACPI_VIDEO_S_CRT;
5235 } else if (strlencmp(cmd, "crt_disable") == 0) {
5236 disable |= TP_ACPI_VIDEO_S_CRT;
5237 } else if (video_supported == TPACPI_VIDEO_NEW &&
5238 strlencmp(cmd, "dvi_enable") == 0) {
5239 enable |= TP_ACPI_VIDEO_S_DVI;
5240 } else if (video_supported == TPACPI_VIDEO_NEW &&
5241 strlencmp(cmd, "dvi_disable") == 0) {
5242 disable |= TP_ACPI_VIDEO_S_DVI;
5243 } else if (strlencmp(cmd, "auto_enable") == 0) {
5244 res = video_autosw_set(1);
5247 } else if (strlencmp(cmd, "auto_disable") == 0) {
5248 res = video_autosw_set(0);
5251 } else if (strlencmp(cmd, "video_switch") == 0) {
5252 res = video_outputsw_cycle();
5255 } else if (strlencmp(cmd, "expand_toggle") == 0) {
5256 res = video_expand_toggle();
5263 if (enable || disable) {
5264 status = video_outputsw_get();
5267 res = video_outputsw_set((status & ~disable) | enable);
5275 static struct ibm_struct video_driver_data = {
5278 .write = video_write,
5282 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
5284 /*************************************************************************
5285 * Keyboard backlight subdriver
5288 static enum led_brightness kbdlight_brightness;
5289 static DEFINE_MUTEX(kbdlight_mutex);
5291 static int kbdlight_set_level(int level)
5298 mutex_lock(&kbdlight_mutex);
5300 if (!acpi_evalf(hkey_handle, NULL, "MLCS", "dd", level))
5303 kbdlight_brightness = level;
5305 mutex_unlock(&kbdlight_mutex);
5310 static int kbdlight_get_level(void)
5317 if (!acpi_evalf(hkey_handle, &status, "MLCG", "dd", 0))
5323 return status & 0x3;
5326 static bool kbdlight_is_supported(void)
5333 if (!acpi_has_method(hkey_handle, "MLCG")) {
5334 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG is unavailable\n");
5338 if (!acpi_evalf(hkey_handle, &status, "MLCG", "qdd", 0)) {
5339 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG failed\n");
5344 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG err: %d\n", status);
5348 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG returned 0x%x\n", status);
5350 * Guessed test for keyboard backlight:
5352 * Machines with backlight keyboard return:
5353 * b010100000010000000XX - ThinkPad X1 Carbon 3rd
5354 * b110100010010000000XX - ThinkPad x230
5355 * b010100000010000000XX - ThinkPad x240
5356 * b010100000010000000XX - ThinkPad W541
5357 * (XX is current backlight level)
5359 * Machines without backlight keyboard return:
5360 * b10100001000000000000 - ThinkPad x230
5361 * b10110001000000000000 - ThinkPad E430
5362 * b00000000000000000000 - ThinkPad E450
5364 * Candidate BITs for detection test (XOR):
5365 * b01000000001000000000
5368 return status & BIT(9);
5371 static int kbdlight_sysfs_set(struct led_classdev *led_cdev,
5372 enum led_brightness brightness)
5374 return kbdlight_set_level(brightness);
5377 static enum led_brightness kbdlight_sysfs_get(struct led_classdev *led_cdev)
5381 level = kbdlight_get_level();
5388 static struct tpacpi_led_classdev tpacpi_led_kbdlight = {
5390 .name = "tpacpi::kbd_backlight",
5391 .max_brightness = 2,
5392 .flags = LED_BRIGHT_HW_CHANGED,
5393 .brightness_set_blocking = &kbdlight_sysfs_set,
5394 .brightness_get = &kbdlight_sysfs_get,
5398 static int __init kbdlight_init(struct ibm_init_struct *iibm)
5402 vdbg_printk(TPACPI_DBG_INIT, "initializing kbdlight subdriver\n");
5404 TPACPI_ACPIHANDLE_INIT(hkey);
5406 if (!kbdlight_is_supported()) {
5407 tp_features.kbdlight = 0;
5408 vdbg_printk(TPACPI_DBG_INIT, "kbdlight is unsupported\n");
5412 kbdlight_brightness = kbdlight_sysfs_get(NULL);
5413 tp_features.kbdlight = 1;
5415 rc = led_classdev_register(&tpacpi_pdev->dev,
5416 &tpacpi_led_kbdlight.led_classdev);
5418 tp_features.kbdlight = 0;
5422 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask |
5423 TP_ACPI_HKEY_KBD_LIGHT_MASK);
5427 static void kbdlight_exit(void)
5429 led_classdev_unregister(&tpacpi_led_kbdlight.led_classdev);
5432 static int kbdlight_set_level_and_update(int level)
5435 struct led_classdev *led_cdev;
5437 ret = kbdlight_set_level(level);
5438 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5440 if (ret == 0 && !(led_cdev->flags & LED_SUSPENDED))
5441 led_cdev->brightness = level;
5446 static int kbdlight_read(struct seq_file *m)
5450 if (!tp_features.kbdlight) {
5451 seq_printf(m, "status:\t\tnot supported\n");
5453 level = kbdlight_get_level();
5455 seq_printf(m, "status:\t\terror %d\n", level);
5457 seq_printf(m, "status:\t\t%d\n", level);
5458 seq_printf(m, "commands:\t0, 1, 2\n");
5464 static int kbdlight_write(char *buf)
5467 int res, level = -EINVAL;
5469 if (!tp_features.kbdlight)
5472 while ((cmd = strsep(&buf, ","))) {
5473 res = kstrtoint(cmd, 10, &level);
5478 if (level >= 3 || level < 0)
5481 return kbdlight_set_level_and_update(level);
5484 static void kbdlight_suspend(void)
5486 struct led_classdev *led_cdev;
5488 if (!tp_features.kbdlight)
5491 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5492 led_update_brightness(led_cdev);
5493 led_classdev_suspend(led_cdev);
5496 static void kbdlight_resume(void)
5498 if (!tp_features.kbdlight)
5501 led_classdev_resume(&tpacpi_led_kbdlight.led_classdev);
5504 static struct ibm_struct kbdlight_driver_data = {
5506 .read = kbdlight_read,
5507 .write = kbdlight_write,
5508 .suspend = kbdlight_suspend,
5509 .resume = kbdlight_resume,
5510 .exit = kbdlight_exit,
5513 /*************************************************************************
5514 * Light (thinklight) subdriver
5517 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
5518 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
5520 static int light_get_status(void)
5524 if (tp_features.light_status) {
5525 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
5533 static int light_set_status(int status)
5537 if (tp_features.light) {
5539 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
5541 TP_CMOS_THINKLIGHT_ON :
5542 TP_CMOS_THINKLIGHT_OFF);
5544 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
5547 return (rc) ? 0 : -EIO;
5553 static int light_sysfs_set(struct led_classdev *led_cdev,
5554 enum led_brightness brightness)
5556 return light_set_status((brightness != LED_OFF) ?
5557 TPACPI_LED_ON : TPACPI_LED_OFF);
5560 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
5562 return (light_get_status() == 1) ? LED_FULL : LED_OFF;
5565 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
5567 .name = "tpacpi::thinklight",
5568 .brightness_set_blocking = &light_sysfs_set,
5569 .brightness_get = &light_sysfs_get,
5573 static int __init light_init(struct ibm_init_struct *iibm)
5577 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
5579 if (tpacpi_is_ibm()) {
5580 TPACPI_ACPIHANDLE_INIT(ledb);
5581 TPACPI_ACPIHANDLE_INIT(lght);
5583 TPACPI_ACPIHANDLE_INIT(cmos);
5585 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
5586 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
5588 if (tp_features.light)
5589 /* light status not supported on
5590 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
5591 tp_features.light_status =
5592 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
5594 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
5595 str_supported(tp_features.light),
5596 str_supported(tp_features.light_status));
5598 if (!tp_features.light)
5601 rc = led_classdev_register(&tpacpi_pdev->dev,
5602 &tpacpi_led_thinklight.led_classdev);
5605 tp_features.light = 0;
5606 tp_features.light_status = 0;
5614 static void light_exit(void)
5616 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
5619 static int light_read(struct seq_file *m)
5623 if (!tp_features.light) {
5624 seq_printf(m, "status:\t\tnot supported\n");
5625 } else if (!tp_features.light_status) {
5626 seq_printf(m, "status:\t\tunknown\n");
5627 seq_printf(m, "commands:\ton, off\n");
5629 status = light_get_status();
5632 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
5633 seq_printf(m, "commands:\ton, off\n");
5639 static int light_write(char *buf)
5644 if (!tp_features.light)
5647 while ((cmd = strsep(&buf, ","))) {
5648 if (strlencmp(cmd, "on") == 0) {
5650 } else if (strlencmp(cmd, "off") == 0) {
5656 return light_set_status(newstatus);
5659 static struct ibm_struct light_driver_data = {
5662 .write = light_write,
5666 /*************************************************************************
5670 /* sysfs cmos_command -------------------------------------------------- */
5671 static ssize_t cmos_command_store(struct device *dev,
5672 struct device_attribute *attr,
5673 const char *buf, size_t count)
5675 unsigned long cmos_cmd;
5678 if (parse_strtoul(buf, 21, &cmos_cmd))
5681 res = issue_thinkpad_cmos_command(cmos_cmd);
5682 return (res) ? res : count;
5685 static DEVICE_ATTR_WO(cmos_command);
5687 /* --------------------------------------------------------------------- */
5689 static int __init cmos_init(struct ibm_init_struct *iibm)
5693 vdbg_printk(TPACPI_DBG_INIT,
5694 "initializing cmos commands subdriver\n");
5696 TPACPI_ACPIHANDLE_INIT(cmos);
5698 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5699 str_supported(cmos_handle != NULL));
5701 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5705 return (cmos_handle) ? 0 : 1;
5708 static void cmos_exit(void)
5710 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5713 static int cmos_read(struct seq_file *m)
5715 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5716 R30, R31, T20-22, X20-21 */
5718 seq_printf(m, "status:\t\tnot supported\n");
5720 seq_printf(m, "status:\t\tsupported\n");
5721 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5727 static int cmos_write(char *buf)
5732 while ((cmd = strsep(&buf, ","))) {
5733 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5734 cmos_cmd >= 0 && cmos_cmd <= 21) {
5739 res = issue_thinkpad_cmos_command(cmos_cmd);
5747 static struct ibm_struct cmos_driver_data = {
5750 .write = cmos_write,
5754 /*************************************************************************
5758 enum led_access_mode {
5759 TPACPI_LED_NONE = 0,
5760 TPACPI_LED_570, /* 570 */
5761 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5762 TPACPI_LED_NEW, /* all others */
5765 enum { /* For TPACPI_LED_OLD */
5766 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5767 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5768 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5771 static enum led_access_mode led_supported;
5773 static acpi_handle led_handle;
5775 #define TPACPI_LED_NUMLEDS 16
5776 static struct tpacpi_led_classdev *tpacpi_leds;
5777 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5778 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5779 /* there's a limit of 19 chars + NULL before 2.6.26 */
5781 "tpacpi:orange:batt",
5782 "tpacpi:green:batt",
5783 "tpacpi::dock_active",
5784 "tpacpi::bay_active",
5785 "tpacpi::dock_batt",
5786 "tpacpi::unknown_led",
5788 "tpacpi::dock_status1",
5789 "tpacpi::dock_status2",
5790 "tpacpi::unknown_led2",
5791 "tpacpi::unknown_led3",
5792 "tpacpi::thinkvantage",
5794 #define TPACPI_SAFE_LEDS 0x1081U
5796 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5798 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5801 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5805 static int led_get_status(const unsigned int led)
5808 enum led_status_t led_s;
5810 switch (led_supported) {
5811 case TPACPI_LED_570:
5812 if (!acpi_evalf(ec_handle,
5813 &status, "GLED", "dd", 1 << led))
5815 led_s = (status == 0) ?
5820 tpacpi_led_state_cache[led] = led_s;
5829 static int led_set_status(const unsigned int led,
5830 const enum led_status_t ledstatus)
5832 /* off, on, blink. Index is led_status_t */
5833 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5834 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5838 switch (led_supported) {
5839 case TPACPI_LED_570:
5841 if (unlikely(led > 7))
5843 if (unlikely(tpacpi_is_led_restricted(led)))
5845 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5846 (1 << led), led_sled_arg1[ledstatus]))
5849 case TPACPI_LED_OLD:
5850 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5851 if (unlikely(led > 7))
5853 if (unlikely(tpacpi_is_led_restricted(led)))
5855 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5857 rc = ec_write(TPACPI_LED_EC_HLBL,
5858 (ledstatus == TPACPI_LED_BLINK) << led);
5860 rc = ec_write(TPACPI_LED_EC_HLCL,
5861 (ledstatus != TPACPI_LED_OFF) << led);
5863 case TPACPI_LED_NEW:
5865 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5867 if (unlikely(tpacpi_is_led_restricted(led)))
5869 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5870 led, led_led_arg1[ledstatus]))
5878 tpacpi_led_state_cache[led] = ledstatus;
5883 static int led_sysfs_set(struct led_classdev *led_cdev,
5884 enum led_brightness brightness)
5886 struct tpacpi_led_classdev *data = container_of(led_cdev,
5887 struct tpacpi_led_classdev, led_classdev);
5888 enum led_status_t new_state;
5890 if (brightness == LED_OFF)
5891 new_state = TPACPI_LED_OFF;
5892 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5893 new_state = TPACPI_LED_ON;
5895 new_state = TPACPI_LED_BLINK;
5897 return led_set_status(data->led, new_state);
5900 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5901 unsigned long *delay_on, unsigned long *delay_off)
5903 struct tpacpi_led_classdev *data = container_of(led_cdev,
5904 struct tpacpi_led_classdev, led_classdev);
5906 /* Can we choose the flash rate? */
5907 if (*delay_on == 0 && *delay_off == 0) {
5908 /* yes. set them to the hardware blink rate (1 Hz) */
5909 *delay_on = 500; /* ms */
5910 *delay_off = 500; /* ms */
5911 } else if ((*delay_on != 500) || (*delay_off != 500))
5914 return led_set_status(data->led, TPACPI_LED_BLINK);
5917 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5921 struct tpacpi_led_classdev *data = container_of(led_cdev,
5922 struct tpacpi_led_classdev, led_classdev);
5924 rc = led_get_status(data->led);
5926 if (rc == TPACPI_LED_OFF || rc < 0)
5927 rc = LED_OFF; /* no error handling in led class :( */
5934 static void led_exit(void)
5938 for (i = 0; i < TPACPI_LED_NUMLEDS; i++)
5939 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5944 static int __init tpacpi_init_led(unsigned int led)
5946 /* LEDs with no name don't get registered */
5947 if (!tpacpi_led_names[led])
5950 tpacpi_leds[led].led_classdev.brightness_set_blocking = &led_sysfs_set;
5951 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5952 if (led_supported == TPACPI_LED_570)
5953 tpacpi_leds[led].led_classdev.brightness_get = &led_sysfs_get;
5955 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5956 tpacpi_leds[led].led = led;
5958 return led_classdev_register(&tpacpi_pdev->dev, &tpacpi_leds[led].led_classdev);
5961 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5962 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5963 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5964 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5966 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5967 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5968 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5969 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5970 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5971 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5972 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5973 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5975 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5976 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5977 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5978 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5979 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5981 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5982 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5983 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5984 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5986 /* (1) - may have excess leds enabled on MSB */
5988 /* Defaults (order matters, keep last, don't reorder!) */
5990 .vendor = PCI_VENDOR_ID_LENOVO,
5991 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5994 { /* IBM ThinkPads with no EC version string */
5995 .vendor = PCI_VENDOR_ID_IBM,
5996 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5999 { /* IBM ThinkPads with EC version string */
6000 .vendor = PCI_VENDOR_ID_IBM,
6001 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
6006 static enum led_access_mode __init led_init_detect_mode(void)
6010 if (tpacpi_is_ibm()) {
6012 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
6013 if (ACPI_SUCCESS(status))
6014 return TPACPI_LED_570;
6016 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
6017 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
6018 if (ACPI_SUCCESS(status))
6019 return TPACPI_LED_OLD;
6023 status = acpi_get_handle(ec_handle, "LED", &led_handle);
6024 if (ACPI_SUCCESS(status))
6025 return TPACPI_LED_NEW;
6027 /* R30, R31, and unknown firmwares */
6029 return TPACPI_LED_NONE;
6032 static int __init led_init(struct ibm_init_struct *iibm)
6036 unsigned long useful_leds;
6038 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
6040 led_supported = led_init_detect_mode();
6042 if (led_supported != TPACPI_LED_NONE) {
6043 useful_leds = tpacpi_check_quirks(led_useful_qtable,
6044 ARRAY_SIZE(led_useful_qtable));
6048 led_supported = TPACPI_LED_NONE;
6052 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
6053 str_supported(led_supported), led_supported);
6055 if (led_supported == TPACPI_LED_NONE)
6058 tpacpi_leds = kcalloc(TPACPI_LED_NUMLEDS, sizeof(*tpacpi_leds),
6061 pr_err("Out of memory for LED data\n");
6065 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
6066 tpacpi_leds[i].led = -1;
6068 if (!tpacpi_is_led_restricted(i) && test_bit(i, &useful_leds)) {
6069 rc = tpacpi_init_led(i);
6077 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
6078 pr_notice("warning: userspace override of important firmware LEDs is enabled\n");
6083 #define str_led_status(s) \
6084 ((s) == TPACPI_LED_OFF ? "off" : \
6085 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
6087 static int led_read(struct seq_file *m)
6089 if (!led_supported) {
6090 seq_printf(m, "status:\t\tnot supported\n");
6093 seq_printf(m, "status:\t\tsupported\n");
6095 if (led_supported == TPACPI_LED_570) {
6098 for (i = 0; i < 8; i++) {
6099 status = led_get_status(i);
6102 seq_printf(m, "%d:\t\t%s\n",
6103 i, str_led_status(status));
6107 seq_printf(m, "commands:\t<led> on, <led> off, <led> blink (<led> is 0-15)\n");
6112 static int led_write(char *buf)
6116 enum led_status_t s;
6121 while ((cmd = strsep(&buf, ","))) {
6122 if (sscanf(cmd, "%d", &led) != 1)
6125 if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1))
6128 if (tpacpi_leds[led].led < 0)
6131 if (strstr(cmd, "off")) {
6133 } else if (strstr(cmd, "on")) {
6135 } else if (strstr(cmd, "blink")) {
6136 s = TPACPI_LED_BLINK;
6141 rc = led_set_status(led, s);
6149 static struct ibm_struct led_driver_data = {
6156 /*************************************************************************
6160 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
6162 #define TPACPI_BEEP_Q1 0x0001
6164 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
6165 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
6166 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
6169 static int __init beep_init(struct ibm_init_struct *iibm)
6171 unsigned long quirks;
6173 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
6175 TPACPI_ACPIHANDLE_INIT(beep);
6177 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
6178 str_supported(beep_handle != NULL));
6180 quirks = tpacpi_check_quirks(beep_quirk_table,
6181 ARRAY_SIZE(beep_quirk_table));
6183 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
6185 return (beep_handle) ? 0 : 1;
6188 static int beep_read(struct seq_file *m)
6191 seq_printf(m, "status:\t\tnot supported\n");
6193 seq_printf(m, "status:\t\tsupported\n");
6194 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
6200 static int beep_write(char *buf)
6208 while ((cmd = strsep(&buf, ","))) {
6209 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
6210 beep_cmd >= 0 && beep_cmd <= 17) {
6214 if (tp_features.beep_needs_two_args) {
6215 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
6219 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
6228 static struct ibm_struct beep_driver_data = {
6231 .write = beep_write,
6234 /*************************************************************************
6238 enum thermal_access_mode {
6239 TPACPI_THERMAL_NONE = 0, /* No thermal support */
6240 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
6241 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
6242 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
6243 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
6246 enum { /* TPACPI_THERMAL_TPEC_* */
6247 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
6248 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
6249 TP_EC_FUNCREV = 0xEF, /* ACPI EC Functional revision */
6250 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
6252 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
6256 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
6257 struct ibm_thermal_sensors_struct {
6258 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
6261 static enum thermal_access_mode thermal_read_mode;
6263 /* idx is zero-based */
6264 static int thermal_get_sensor(int idx, s32 *value)
6270 t = TP_EC_THERMAL_TMP0;
6272 switch (thermal_read_mode) {
6273 #if TPACPI_MAX_THERMAL_SENSORS >= 16
6274 case TPACPI_THERMAL_TPEC_16:
6275 if (idx >= 8 && idx <= 15) {
6276 t = TP_EC_THERMAL_TMP8;
6281 case TPACPI_THERMAL_TPEC_8:
6283 if (!acpi_ec_read(t + idx, &tmp))
6285 *value = tmp * 1000;
6290 case TPACPI_THERMAL_ACPI_UPDT:
6292 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6293 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
6295 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6297 *value = (t - 2732) * 100;
6302 case TPACPI_THERMAL_ACPI_TMP07:
6304 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6305 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6307 if (t > 127 || t < -127)
6308 t = TP_EC_THERMAL_TMP_NA;
6314 case TPACPI_THERMAL_NONE:
6322 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
6333 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
6336 for (i = 0 ; i < n; i++) {
6337 res = thermal_get_sensor(i, &s->temp[i]);
6345 static void thermal_dump_all_sensors(void)
6348 struct ibm_thermal_sensors_struct t;
6350 n = thermal_get_sensors(&t);
6354 pr_notice("temperatures (Celsius):");
6356 for (i = 0; i < n; i++) {
6357 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
6358 pr_cont(" %d", (int)(t.temp[i] / 1000));
6366 /* sysfs temp##_input -------------------------------------------------- */
6368 static ssize_t thermal_temp_input_show(struct device *dev,
6369 struct device_attribute *attr,
6372 struct sensor_device_attribute *sensor_attr =
6373 to_sensor_dev_attr(attr);
6374 int idx = sensor_attr->index;
6378 res = thermal_get_sensor(idx, &value);
6381 if (value == TPACPI_THERMAL_SENSOR_NA)
6384 return snprintf(buf, PAGE_SIZE, "%d\n", value);
6387 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
6388 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
6389 thermal_temp_input_show, NULL, _idxB)
6391 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
6392 THERMAL_SENSOR_ATTR_TEMP(1, 0),
6393 THERMAL_SENSOR_ATTR_TEMP(2, 1),
6394 THERMAL_SENSOR_ATTR_TEMP(3, 2),
6395 THERMAL_SENSOR_ATTR_TEMP(4, 3),
6396 THERMAL_SENSOR_ATTR_TEMP(5, 4),
6397 THERMAL_SENSOR_ATTR_TEMP(6, 5),
6398 THERMAL_SENSOR_ATTR_TEMP(7, 6),
6399 THERMAL_SENSOR_ATTR_TEMP(8, 7),
6400 THERMAL_SENSOR_ATTR_TEMP(9, 8),
6401 THERMAL_SENSOR_ATTR_TEMP(10, 9),
6402 THERMAL_SENSOR_ATTR_TEMP(11, 10),
6403 THERMAL_SENSOR_ATTR_TEMP(12, 11),
6404 THERMAL_SENSOR_ATTR_TEMP(13, 12),
6405 THERMAL_SENSOR_ATTR_TEMP(14, 13),
6406 THERMAL_SENSOR_ATTR_TEMP(15, 14),
6407 THERMAL_SENSOR_ATTR_TEMP(16, 15),
6410 #define THERMAL_ATTRS(X) \
6411 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
6413 static struct attribute *thermal_temp_input_attr[] = {
6433 static const struct attribute_group thermal_temp_input16_group = {
6434 .attrs = thermal_temp_input_attr
6437 static const struct attribute_group thermal_temp_input8_group = {
6438 .attrs = &thermal_temp_input_attr[8]
6441 #undef THERMAL_SENSOR_ATTR_TEMP
6442 #undef THERMAL_ATTRS
6444 /* --------------------------------------------------------------------- */
6446 static int __init thermal_init(struct ibm_init_struct *iibm)
6448 u8 t, ta1, ta2, ver = 0;
6453 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
6455 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
6457 if (thinkpad_id.ec_model) {
6459 * Direct EC access mode: sensors at registers
6460 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
6461 * non-implemented, thermal sensors return 0x80 when
6463 * The above rule is unfortunately flawed. This has been seen with
6464 * 0xC2 (power supply ID) causing thermal control problems.
6465 * The EC version can be determined by offset 0xEF and at least for
6466 * version 3 the Lenovo firmware team confirmed that registers 0xC0-0xC7
6467 * are not thermal registers.
6469 if (!acpi_ec_read(TP_EC_FUNCREV, &ver))
6470 pr_warn("Thinkpad ACPI EC unable to access EC version\n");
6473 for (i = 0; i < 8; i++) {
6474 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
6481 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
6490 /* This is sheer paranoia, but we handle it anyway */
6492 pr_err("ThinkPad ACPI EC access misbehaving, falling back to ACPI TMPx access mode\n");
6493 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6495 pr_err("ThinkPad ACPI EC access misbehaving, disabling thermal sensors access\n");
6496 thermal_read_mode = TPACPI_THERMAL_NONE;
6500 thermal_read_mode = TPACPI_THERMAL_TPEC_8;
6504 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
6506 } else if (acpi_tmp7) {
6507 if (tpacpi_is_ibm() &&
6508 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
6509 /* 600e/x, 770e, 770x */
6510 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
6512 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
6513 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6516 /* temperatures not supported on 570, G4x, R30, R31, R32 */
6517 thermal_read_mode = TPACPI_THERMAL_NONE;
6520 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
6521 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
6524 switch (thermal_read_mode) {
6525 case TPACPI_THERMAL_TPEC_16:
6526 res = sysfs_create_group(&tpacpi_hwmon->kobj,
6527 &thermal_temp_input16_group);
6531 case TPACPI_THERMAL_TPEC_8:
6532 case TPACPI_THERMAL_ACPI_TMP07:
6533 case TPACPI_THERMAL_ACPI_UPDT:
6534 res = sysfs_create_group(&tpacpi_hwmon->kobj,
6535 &thermal_temp_input8_group);
6539 case TPACPI_THERMAL_NONE:
6547 static void thermal_exit(void)
6549 switch (thermal_read_mode) {
6550 case TPACPI_THERMAL_TPEC_16:
6551 sysfs_remove_group(&tpacpi_hwmon->kobj,
6552 &thermal_temp_input16_group);
6554 case TPACPI_THERMAL_TPEC_8:
6555 case TPACPI_THERMAL_ACPI_TMP07:
6556 case TPACPI_THERMAL_ACPI_UPDT:
6557 sysfs_remove_group(&tpacpi_hwmon->kobj,
6558 &thermal_temp_input8_group);
6560 case TPACPI_THERMAL_NONE:
6566 static int thermal_read(struct seq_file *m)
6569 struct ibm_thermal_sensors_struct t;
6571 n = thermal_get_sensors(&t);
6572 if (unlikely(n < 0))
6575 seq_printf(m, "temperatures:\t");
6578 for (i = 0; i < (n - 1); i++)
6579 seq_printf(m, "%d ", t.temp[i] / 1000);
6580 seq_printf(m, "%d\n", t.temp[i] / 1000);
6582 seq_printf(m, "not supported\n");
6587 static struct ibm_struct thermal_driver_data = {
6589 .read = thermal_read,
6590 .exit = thermal_exit,
6593 /*************************************************************************
6594 * Backlight/brightness subdriver
6597 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
6600 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
6601 * CMOS NVRAM byte 0x5E, bits 0-3.
6603 * EC HBRV (0x31) has the following layout
6604 * Bit 7: unknown function
6605 * Bit 6: unknown function
6606 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
6607 * Bit 4: must be set to zero to avoid problems
6608 * Bit 3-0: backlight brightness level
6610 * brightness_get_raw returns status data in the HBRV layout
6612 * WARNING: The X61 has been verified to use HBRV for something else, so
6613 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
6614 * testing on the very early *60 Lenovo models...
6618 TP_EC_BACKLIGHT = 0x31,
6620 /* TP_EC_BACKLIGHT bitmasks */
6621 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6622 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6623 TP_EC_BACKLIGHT_MAPSW = 0x20,
6626 enum tpacpi_brightness_access_mode {
6627 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
6628 TPACPI_BRGHT_MODE_EC, /* EC control */
6629 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
6630 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6631 TPACPI_BRGHT_MODE_MAX
6634 static struct backlight_device *ibm_backlight_device;
6636 static enum tpacpi_brightness_access_mode brightness_mode =
6637 TPACPI_BRGHT_MODE_MAX;
6639 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6641 static struct mutex brightness_mutex;
6643 /* NVRAM brightness access,
6644 * call with brightness_mutex held! */
6645 static unsigned int tpacpi_brightness_nvram_get(void)
6649 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6650 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6651 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6652 lnvram &= bright_maxlvl;
6657 static void tpacpi_brightness_checkpoint_nvram(void)
6662 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6665 vdbg_printk(TPACPI_DBG_BRGHT,
6666 "trying to checkpoint backlight level to NVRAM...\n");
6668 if (mutex_lock_killable(&brightness_mutex) < 0)
6671 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6673 lec &= TP_EC_BACKLIGHT_LVLMSK;
6674 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6676 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6677 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6678 /* NVRAM needs update */
6679 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6680 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6682 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6683 dbg_printk(TPACPI_DBG_BRGHT,
6684 "updated NVRAM backlight level to %u (0x%02x)\n",
6685 (unsigned int) lec, (unsigned int) b_nvram);
6687 vdbg_printk(TPACPI_DBG_BRGHT,
6688 "NVRAM backlight level already is %u (0x%02x)\n",
6689 (unsigned int) lec, (unsigned int) b_nvram);
6692 mutex_unlock(&brightness_mutex);
6696 /* call with brightness_mutex held! */
6697 static int tpacpi_brightness_get_raw(int *status)
6701 switch (brightness_mode) {
6702 case TPACPI_BRGHT_MODE_UCMS_STEP:
6703 *status = tpacpi_brightness_nvram_get();
6705 case TPACPI_BRGHT_MODE_EC:
6706 case TPACPI_BRGHT_MODE_ECNVRAM:
6707 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6716 /* call with brightness_mutex held! */
6717 /* do NOT call with illegal backlight level value */
6718 static int tpacpi_brightness_set_ec(unsigned int value)
6722 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6725 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6726 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6727 (value & TP_EC_BACKLIGHT_LVLMSK))))
6733 /* call with brightness_mutex held! */
6734 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6737 unsigned int current_value, i;
6739 current_value = tpacpi_brightness_nvram_get();
6741 if (value == current_value)
6744 cmos_cmd = (value > current_value) ?
6745 TP_CMOS_BRIGHTNESS_UP :
6746 TP_CMOS_BRIGHTNESS_DOWN;
6747 inc = (value > current_value) ? 1 : -1;
6749 for (i = current_value; i != value; i += inc)
6750 if (issue_thinkpad_cmos_command(cmos_cmd))
6756 /* May return EINTR which can always be mapped to ERESTARTSYS */
6757 static int brightness_set(unsigned int value)
6761 if (value > bright_maxlvl)
6764 vdbg_printk(TPACPI_DBG_BRGHT,
6765 "set backlight level to %d\n", value);
6767 res = mutex_lock_killable(&brightness_mutex);
6771 switch (brightness_mode) {
6772 case TPACPI_BRGHT_MODE_EC:
6773 case TPACPI_BRGHT_MODE_ECNVRAM:
6774 res = tpacpi_brightness_set_ec(value);
6776 case TPACPI_BRGHT_MODE_UCMS_STEP:
6777 res = tpacpi_brightness_set_ucmsstep(value);
6783 mutex_unlock(&brightness_mutex);
6787 /* sysfs backlight class ----------------------------------------------- */
6789 static int brightness_update_status(struct backlight_device *bd)
6791 unsigned int level =
6792 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6793 bd->props.power == FB_BLANK_UNBLANK) ?
6794 bd->props.brightness : 0;
6796 dbg_printk(TPACPI_DBG_BRGHT,
6797 "backlight: attempt to set level to %d\n",
6800 /* it is the backlight class's job (caller) to handle
6801 * EINTR and other errors properly */
6802 return brightness_set(level);
6805 static int brightness_get(struct backlight_device *bd)
6809 res = mutex_lock_killable(&brightness_mutex);
6813 res = tpacpi_brightness_get_raw(&status);
6815 mutex_unlock(&brightness_mutex);
6820 return status & TP_EC_BACKLIGHT_LVLMSK;
6823 static void tpacpi_brightness_notify_change(void)
6825 backlight_force_update(ibm_backlight_device,
6826 BACKLIGHT_UPDATE_HOTKEY);
6829 static const struct backlight_ops ibm_backlight_data = {
6830 .get_brightness = brightness_get,
6831 .update_status = brightness_update_status,
6834 /* --------------------------------------------------------------------- */
6837 * Call _BCL method of video device. On some ThinkPads this will
6838 * switch the firmware to the ACPI brightness control mode.
6841 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6843 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6844 union acpi_object *obj;
6845 struct acpi_device *device, *child;
6848 if (acpi_bus_get_device(handle, &device))
6852 list_for_each_entry(child, &device->children, node) {
6853 acpi_status status = acpi_evaluate_object(child->handle, "_BCL",
6855 if (ACPI_FAILURE(status)) {
6856 buffer.length = ACPI_ALLOCATE_BUFFER;
6860 obj = (union acpi_object *)buffer.pointer;
6861 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6862 pr_err("Unknown _BCL data, please report this to %s\n",
6866 rc = obj->package.count;
6871 kfree(buffer.pointer);
6877 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6879 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6881 acpi_handle video_device;
6884 tpacpi_acpi_handle_locate("video", NULL, &video_device);
6886 bcl_levels = tpacpi_query_bcl_levels(video_device);
6888 tp_features.bright_acpimode = (bcl_levels > 0);
6890 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6894 * These are only useful for models that have only one possibility
6895 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6898 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6899 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6900 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6902 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6903 /* Models with ATI GPUs known to require ECNVRAM mode */
6904 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6906 /* Models with ATI GPUs that can use ECNVRAM */
6907 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6908 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6909 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6910 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6912 /* Models with Intel Extreme Graphics 2 */
6913 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6914 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6915 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6917 /* Models with Intel GMA900 */
6918 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6919 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6920 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6924 * Returns < 0 for error, otherwise sets tp_features.bright_*
6925 * and bright_maxlvl.
6927 static void __init tpacpi_detect_brightness_capabilities(void)
6931 vdbg_printk(TPACPI_DBG_INIT,
6932 "detecting firmware brightness interface capabilities\n");
6934 /* we could run a quirks check here (same table used by
6935 * brightness_init) if needed */
6938 * We always attempt to detect acpi support, so as to switch
6939 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6940 * going to publish a backlight interface
6942 b = tpacpi_check_std_acpi_brightness_support();
6952 tp_features.bright_unkfw = 1;
6953 bright_maxlvl = b - 1;
6955 pr_debug("detected %u brightness levels\n", bright_maxlvl + 1);
6958 static int __init brightness_init(struct ibm_init_struct *iibm)
6960 struct backlight_properties props;
6962 unsigned long quirks;
6964 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6966 mutex_init(&brightness_mutex);
6968 quirks = tpacpi_check_quirks(brightness_quirk_table,
6969 ARRAY_SIZE(brightness_quirk_table));
6971 /* tpacpi_detect_brightness_capabilities() must have run already */
6973 /* if it is unknown, we don't handle it: it wouldn't be safe */
6974 if (tp_features.bright_unkfw)
6977 if (!brightness_enable) {
6978 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6979 "brightness support disabled by module parameter\n");
6983 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
6984 if (brightness_enable > 1) {
6985 pr_info("Standard ACPI backlight interface available, not loading native one\n");
6987 } else if (brightness_enable == 1) {
6988 pr_warn("Cannot enable backlight brightness support, ACPI is already handling it. Refer to the acpi_backlight kernel parameter.\n");
6991 } else if (!tp_features.bright_acpimode) {
6992 pr_notice("ACPI backlight interface not available\n");
6996 pr_notice("ACPI native brightness control enabled\n");
6999 * Check for module parameter bogosity, note that we
7000 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
7001 * able to detect "unspecified"
7003 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
7006 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
7007 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
7008 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
7009 if (quirks & TPACPI_BRGHT_Q_EC)
7010 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
7012 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
7014 dbg_printk(TPACPI_DBG_BRGHT,
7015 "driver auto-selected brightness_mode=%d\n",
7020 if (!tpacpi_is_ibm() &&
7021 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
7022 brightness_mode == TPACPI_BRGHT_MODE_EC))
7025 if (tpacpi_brightness_get_raw(&b) < 0)
7028 memset(&props, 0, sizeof(struct backlight_properties));
7029 props.type = BACKLIGHT_PLATFORM;
7030 props.max_brightness = bright_maxlvl;
7031 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
7032 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
7034 &ibm_backlight_data,
7036 if (IS_ERR(ibm_backlight_device)) {
7037 int rc = PTR_ERR(ibm_backlight_device);
7038 ibm_backlight_device = NULL;
7039 pr_err("Could not register backlight device\n");
7042 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
7043 "brightness is supported\n");
7045 if (quirks & TPACPI_BRGHT_Q_ASK) {
7046 pr_notice("brightness: will use unverified default: brightness_mode=%d\n",
7048 pr_notice("brightness: please report to %s whether it works well or not on your ThinkPad\n",
7052 /* Added by mistake in early 2007. Probably useless, but it could
7053 * be working around some unknown firmware problem where the value
7054 * read at startup doesn't match the real hardware state... so leave
7055 * it in place just in case */
7056 backlight_update_status(ibm_backlight_device);
7058 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
7059 "brightness: registering brightness hotkeys as change notification\n");
7060 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7061 | TP_ACPI_HKEY_BRGHTUP_MASK
7062 | TP_ACPI_HKEY_BRGHTDWN_MASK);
7066 static void brightness_suspend(void)
7068 tpacpi_brightness_checkpoint_nvram();
7071 static void brightness_shutdown(void)
7073 tpacpi_brightness_checkpoint_nvram();
7076 static void brightness_exit(void)
7078 if (ibm_backlight_device) {
7079 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
7080 "calling backlight_device_unregister()\n");
7081 backlight_device_unregister(ibm_backlight_device);
7084 tpacpi_brightness_checkpoint_nvram();
7087 static int brightness_read(struct seq_file *m)
7091 level = brightness_get(NULL);
7093 seq_printf(m, "level:\t\tunreadable\n");
7095 seq_printf(m, "level:\t\t%d\n", level);
7096 seq_printf(m, "commands:\tup, down\n");
7097 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7104 static int brightness_write(char *buf)
7110 level = brightness_get(NULL);
7114 while ((cmd = strsep(&buf, ","))) {
7115 if (strlencmp(cmd, "up") == 0) {
7116 if (level < bright_maxlvl)
7118 } else if (strlencmp(cmd, "down") == 0) {
7121 } else if (sscanf(cmd, "level %d", &level) == 1 &&
7122 level >= 0 && level <= bright_maxlvl) {
7128 tpacpi_disclose_usertask("procfs brightness",
7129 "set level to %d\n", level);
7132 * Now we know what the final level should be, so we try to set it.
7133 * Doing it this way makes the syscall restartable in case of EINTR
7135 rc = brightness_set(level);
7136 if (!rc && ibm_backlight_device)
7137 backlight_force_update(ibm_backlight_device,
7138 BACKLIGHT_UPDATE_SYSFS);
7139 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7142 static struct ibm_struct brightness_driver_data = {
7143 .name = "brightness",
7144 .read = brightness_read,
7145 .write = brightness_write,
7146 .exit = brightness_exit,
7147 .suspend = brightness_suspend,
7148 .shutdown = brightness_shutdown,
7151 /*************************************************************************
7156 * IBM ThinkPads have a simple volume controller with MUTE gating.
7157 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
7159 * Since the *61 series (and probably also the later *60 series), Lenovo
7160 * ThinkPads only implement the MUTE gate.
7163 * Bit 6: MUTE (1 mutes sound)
7165 * Other bits should be zero as far as we know.
7167 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
7168 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
7169 * such as bit 7 which is used to detect repeated presses of MUTE,
7170 * and we leave them unchanged.
7172 * On newer Lenovo ThinkPads, the EC can automatically change the volume
7173 * in response to user input. Unfortunately, this rarely works well.
7174 * The laptop changes the state of its internal MUTE gate and, on some
7175 * models, sends KEY_MUTE, causing any user code that responds to the
7176 * mute button to get confused. The hardware MUTE gate is also
7177 * unnecessary, since user code can handle the mute button without
7178 * kernel or EC help.
7180 * To avoid confusing userspace, we simply disable all EC-based mute
7181 * and volume controls when possible.
7184 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
7186 #define TPACPI_ALSA_DRVNAME "ThinkPad EC"
7187 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
7188 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
7190 #if SNDRV_CARDS <= 32
7191 #define DEFAULT_ALSA_IDX ~((1 << (SNDRV_CARDS - 3)) - 1)
7193 #define DEFAULT_ALSA_IDX ~((1 << (32 - 3)) - 1)
7195 static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
7196 static char *alsa_id = "ThinkPadEC";
7197 static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
7199 struct tpacpi_alsa_data {
7200 struct snd_card *card;
7201 struct snd_ctl_elem_id *ctl_mute_id;
7202 struct snd_ctl_elem_id *ctl_vol_id;
7205 static struct snd_card *alsa_card;
7210 /* TP_EC_AUDIO bits */
7211 TP_EC_AUDIO_MUTESW = 6,
7213 /* TP_EC_AUDIO bitmasks */
7214 TP_EC_AUDIO_LVL_MSK = 0x0F,
7215 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
7217 /* Maximum volume */
7218 TP_EC_VOLUME_MAX = 14,
7221 enum tpacpi_volume_access_mode {
7222 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
7223 TPACPI_VOL_MODE_EC, /* Pure EC control */
7224 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
7225 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
7229 enum tpacpi_volume_capabilities {
7230 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
7231 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
7232 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
7236 enum tpacpi_mute_btn_mode {
7237 TP_EC_MUTE_BTN_LATCH = 0, /* Mute mutes; up/down unmutes */
7238 /* We don't know what mode 1 is. */
7239 TP_EC_MUTE_BTN_NONE = 2, /* Mute and up/down are just keys */
7240 TP_EC_MUTE_BTN_TOGGLE = 3, /* Mute toggles; up/down unmutes */
7243 static enum tpacpi_volume_access_mode volume_mode =
7244 TPACPI_VOL_MODE_MAX;
7246 static enum tpacpi_volume_capabilities volume_capabilities;
7247 static bool volume_control_allowed;
7248 static bool software_mute_requested = true;
7249 static bool software_mute_active;
7250 static int software_mute_orig_mode;
7253 * Used to syncronize writers to TP_EC_AUDIO and
7254 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
7256 static struct mutex volume_mutex;
7258 static void tpacpi_volume_checkpoint_nvram(void)
7264 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
7266 if (!volume_control_allowed)
7268 if (software_mute_active)
7271 vdbg_printk(TPACPI_DBG_MIXER,
7272 "trying to checkpoint mixer state to NVRAM...\n");
7274 if (tp_features.mixer_no_level_control)
7275 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
7277 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
7279 if (mutex_lock_killable(&volume_mutex) < 0)
7282 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
7285 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
7287 if (lec != (b_nvram & ec_mask)) {
7288 /* NVRAM needs update */
7289 b_nvram &= ~ec_mask;
7291 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
7292 dbg_printk(TPACPI_DBG_MIXER,
7293 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
7294 (unsigned int) lec, (unsigned int) b_nvram);
7296 vdbg_printk(TPACPI_DBG_MIXER,
7297 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
7298 (unsigned int) lec, (unsigned int) b_nvram);
7302 mutex_unlock(&volume_mutex);
7305 static int volume_get_status_ec(u8 *status)
7309 if (!acpi_ec_read(TP_EC_AUDIO, &s))
7314 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
7319 static int volume_get_status(u8 *status)
7321 return volume_get_status_ec(status);
7324 static int volume_set_status_ec(const u8 status)
7326 if (!acpi_ec_write(TP_EC_AUDIO, status))
7329 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
7332 * On X200s, and possibly on others, it can take a while for
7333 * reads to become correct.
7340 static int volume_set_status(const u8 status)
7342 return volume_set_status_ec(status);
7345 /* returns < 0 on error, 0 on no change, 1 on change */
7346 static int __volume_set_mute_ec(const bool mute)
7351 if (mutex_lock_killable(&volume_mutex) < 0)
7354 rc = volume_get_status_ec(&s);
7358 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
7359 s & ~TP_EC_AUDIO_MUTESW_MSK;
7362 rc = volume_set_status_ec(n);
7368 mutex_unlock(&volume_mutex);
7372 static int volume_alsa_set_mute(const bool mute)
7374 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
7375 (mute) ? "" : "un");
7376 return __volume_set_mute_ec(mute);
7379 static int volume_set_mute(const bool mute)
7383 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
7384 (mute) ? "" : "un");
7386 rc = __volume_set_mute_ec(mute);
7387 return (rc < 0) ? rc : 0;
7390 /* returns < 0 on error, 0 on no change, 1 on change */
7391 static int __volume_set_volume_ec(const u8 vol)
7396 if (vol > TP_EC_VOLUME_MAX)
7399 if (mutex_lock_killable(&volume_mutex) < 0)
7402 rc = volume_get_status_ec(&s);
7406 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
7409 rc = volume_set_status_ec(n);
7415 mutex_unlock(&volume_mutex);
7419 static int volume_set_software_mute(bool startup)
7423 if (!tpacpi_is_lenovo())
7427 if (!acpi_evalf(ec_handle, &software_mute_orig_mode,
7431 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7432 "Initial HAUM setting was %d\n",
7433 software_mute_orig_mode);
7436 if (!acpi_evalf(ec_handle, &result, "SAUM", "qdd",
7437 (int)TP_EC_MUTE_BTN_NONE))
7440 if (result != TP_EC_MUTE_BTN_NONE)
7441 pr_warn("Unexpected SAUM result %d\n",
7445 * In software mute mode, the standard codec controls take
7446 * precendence, so we unmute the ThinkPad HW switch at
7447 * startup. Just on case there are SAUM-capable ThinkPads
7448 * with level controls, set max HW volume as well.
7450 if (tp_features.mixer_no_level_control)
7451 result = volume_set_mute(false);
7453 result = volume_set_status(TP_EC_VOLUME_MAX);
7456 pr_warn("Failed to unmute the HW mute switch\n");
7461 static void volume_exit_software_mute(void)
7465 if (!acpi_evalf(ec_handle, &r, "SAUM", "qdd", software_mute_orig_mode)
7466 || r != software_mute_orig_mode)
7467 pr_warn("Failed to restore mute mode\n");
7470 static int volume_alsa_set_volume(const u8 vol)
7472 dbg_printk(TPACPI_DBG_MIXER,
7473 "ALSA: trying to set volume level to %hu\n", vol);
7474 return __volume_set_volume_ec(vol);
7477 static void volume_alsa_notify_change(void)
7479 struct tpacpi_alsa_data *d;
7481 if (alsa_card && alsa_card->private_data) {
7482 d = alsa_card->private_data;
7484 snd_ctl_notify(alsa_card,
7485 SNDRV_CTL_EVENT_MASK_VALUE,
7488 snd_ctl_notify(alsa_card,
7489 SNDRV_CTL_EVENT_MASK_VALUE,
7494 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
7495 struct snd_ctl_elem_info *uinfo)
7497 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
7499 uinfo->value.integer.min = 0;
7500 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
7504 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
7505 struct snd_ctl_elem_value *ucontrol)
7510 rc = volume_get_status(&s);
7514 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
7518 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
7519 struct snd_ctl_elem_value *ucontrol)
7521 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
7522 ucontrol->value.integer.value[0]);
7523 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
7526 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
7528 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
7529 struct snd_ctl_elem_value *ucontrol)
7534 rc = volume_get_status(&s);
7538 ucontrol->value.integer.value[0] =
7539 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
7543 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
7544 struct snd_ctl_elem_value *ucontrol)
7546 tpacpi_disclose_usertask("ALSA", "%smute\n",
7547 ucontrol->value.integer.value[0] ?
7549 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
7552 static struct snd_kcontrol_new volume_alsa_control_vol __initdata = {
7553 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7554 .name = "Console Playback Volume",
7556 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7557 .info = volume_alsa_vol_info,
7558 .get = volume_alsa_vol_get,
7561 static struct snd_kcontrol_new volume_alsa_control_mute __initdata = {
7562 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7563 .name = "Console Playback Switch",
7565 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7566 .info = volume_alsa_mute_info,
7567 .get = volume_alsa_mute_get,
7570 static void volume_suspend(void)
7572 tpacpi_volume_checkpoint_nvram();
7575 static void volume_resume(void)
7577 if (software_mute_active) {
7578 if (volume_set_software_mute(false) < 0)
7579 pr_warn("Failed to restore software mute\n");
7581 volume_alsa_notify_change();
7585 static void volume_shutdown(void)
7587 tpacpi_volume_checkpoint_nvram();
7590 static void volume_exit(void)
7593 snd_card_free(alsa_card);
7597 tpacpi_volume_checkpoint_nvram();
7599 if (software_mute_active)
7600 volume_exit_software_mute();
7603 static int __init volume_create_alsa_mixer(void)
7605 struct snd_card *card;
7606 struct tpacpi_alsa_data *data;
7607 struct snd_kcontrol *ctl_vol;
7608 struct snd_kcontrol *ctl_mute;
7611 rc = snd_card_new(&tpacpi_pdev->dev,
7612 alsa_index, alsa_id, THIS_MODULE,
7613 sizeof(struct tpacpi_alsa_data), &card);
7614 if (rc < 0 || !card) {
7615 pr_err("Failed to create ALSA card structures: %d\n", rc);
7619 BUG_ON(!card->private_data);
7620 data = card->private_data;
7623 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
7624 sizeof(card->driver));
7625 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
7626 sizeof(card->shortname));
7627 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
7628 (thinkpad_id.ec_version_str) ?
7629 thinkpad_id.ec_version_str : "(unknown)");
7630 snprintf(card->longname, sizeof(card->longname),
7631 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
7632 (thinkpad_id.ec_version_str) ?
7633 thinkpad_id.ec_version_str : "unknown");
7635 if (volume_control_allowed) {
7636 volume_alsa_control_vol.put = volume_alsa_vol_put;
7637 volume_alsa_control_vol.access =
7638 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7640 volume_alsa_control_mute.put = volume_alsa_mute_put;
7641 volume_alsa_control_mute.access =
7642 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7645 if (!tp_features.mixer_no_level_control) {
7646 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
7647 rc = snd_ctl_add(card, ctl_vol);
7649 pr_err("Failed to create ALSA volume control: %d\n",
7653 data->ctl_vol_id = &ctl_vol->id;
7656 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
7657 rc = snd_ctl_add(card, ctl_mute);
7659 pr_err("Failed to create ALSA mute control: %d\n", rc);
7662 data->ctl_mute_id = &ctl_mute->id;
7664 rc = snd_card_register(card);
7666 pr_err("Failed to register ALSA card: %d\n", rc);
7674 snd_card_free(card);
7678 #define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
7679 #define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
7681 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
7682 /* Whitelist volume level on all IBM by default */
7683 { .vendor = PCI_VENDOR_ID_IBM,
7684 .bios = TPACPI_MATCH_ANY,
7685 .ec = TPACPI_MATCH_ANY,
7686 .quirks = TPACPI_VOL_Q_LEVEL },
7688 /* Lenovo models with volume control (needs confirmation) */
7689 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
7690 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
7691 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
7692 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
7693 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
7694 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
7695 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
7697 /* Whitelist mute-only on all Lenovo by default */
7698 { .vendor = PCI_VENDOR_ID_LENOVO,
7699 .bios = TPACPI_MATCH_ANY,
7700 .ec = TPACPI_MATCH_ANY,
7701 .quirks = TPACPI_VOL_Q_MUTEONLY }
7704 static int __init volume_init(struct ibm_init_struct *iibm)
7706 unsigned long quirks;
7709 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7711 mutex_init(&volume_mutex);
7714 * Check for module parameter bogosity, note that we
7715 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7716 * able to detect "unspecified"
7718 if (volume_mode > TPACPI_VOL_MODE_MAX)
7721 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7722 pr_err("UCMS step volume mode not implemented, please contact %s\n",
7727 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7731 * The ALSA mixer is our primary interface.
7732 * When disabled, don't install the subdriver at all
7735 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7736 "ALSA mixer disabled by parameter, not loading volume subdriver...\n");
7740 quirks = tpacpi_check_quirks(volume_quirk_table,
7741 ARRAY_SIZE(volume_quirk_table));
7743 switch (volume_capabilities) {
7744 case TPACPI_VOL_CAP_AUTO:
7745 if (quirks & TPACPI_VOL_Q_MUTEONLY)
7746 tp_features.mixer_no_level_control = 1;
7747 else if (quirks & TPACPI_VOL_Q_LEVEL)
7748 tp_features.mixer_no_level_control = 0;
7750 return 1; /* no mixer */
7752 case TPACPI_VOL_CAP_VOLMUTE:
7753 tp_features.mixer_no_level_control = 0;
7755 case TPACPI_VOL_CAP_MUTEONLY:
7756 tp_features.mixer_no_level_control = 1;
7762 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7763 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7764 "using user-supplied volume_capabilities=%d\n",
7765 volume_capabilities);
7767 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7768 volume_mode == TPACPI_VOL_MODE_MAX) {
7769 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7771 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7772 "driver auto-selected volume_mode=%d\n",
7775 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7776 "using user-supplied volume_mode=%d\n",
7780 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7781 "mute is supported, volume control is %s\n",
7782 str_supported(!tp_features.mixer_no_level_control));
7784 if (software_mute_requested && volume_set_software_mute(true) == 0) {
7785 software_mute_active = true;
7787 rc = volume_create_alsa_mixer();
7789 pr_err("Could not create the ALSA mixer interface\n");
7793 pr_info("Console audio control enabled, mode: %s\n",
7794 (volume_control_allowed) ?
7795 "override (read/write)" :
7796 "monitor (read only)");
7799 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7800 "registering volume hotkeys as change notification\n");
7801 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7802 | TP_ACPI_HKEY_VOLUP_MASK
7803 | TP_ACPI_HKEY_VOLDWN_MASK
7804 | TP_ACPI_HKEY_MUTE_MASK);
7809 static int volume_read(struct seq_file *m)
7813 if (volume_get_status(&status) < 0) {
7814 seq_printf(m, "level:\t\tunreadable\n");
7816 if (tp_features.mixer_no_level_control)
7817 seq_printf(m, "level:\t\tunsupported\n");
7819 seq_printf(m, "level:\t\t%d\n",
7820 status & TP_EC_AUDIO_LVL_MSK);
7822 seq_printf(m, "mute:\t\t%s\n",
7823 onoff(status, TP_EC_AUDIO_MUTESW));
7825 if (volume_control_allowed) {
7826 seq_printf(m, "commands:\tunmute, mute\n");
7827 if (!tp_features.mixer_no_level_control) {
7828 seq_printf(m, "commands:\tup, down\n");
7829 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7838 static int volume_write(char *buf)
7841 u8 new_level, new_mute;
7847 * We do allow volume control at driver startup, so that the
7848 * user can set initial state through the volume=... parameter hack.
7850 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7851 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7852 tp_warned.volume_ctrl_forbidden = 1;
7853 pr_notice("Console audio control in monitor mode, changes are not allowed\n");
7854 pr_notice("Use the volume_control=1 module parameter to enable volume control\n");
7859 rc = volume_get_status(&s);
7863 new_level = s & TP_EC_AUDIO_LVL_MSK;
7864 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7866 while ((cmd = strsep(&buf, ","))) {
7867 if (!tp_features.mixer_no_level_control) {
7868 if (strlencmp(cmd, "up") == 0) {
7871 else if (new_level < TP_EC_VOLUME_MAX)
7874 } else if (strlencmp(cmd, "down") == 0) {
7877 else if (new_level > 0)
7880 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7881 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7886 if (strlencmp(cmd, "mute") == 0)
7887 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7888 else if (strlencmp(cmd, "unmute") == 0)
7894 if (tp_features.mixer_no_level_control) {
7895 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7896 new_mute ? "" : "un");
7897 rc = volume_set_mute(!!new_mute);
7899 tpacpi_disclose_usertask("procfs volume",
7900 "%smute and set level to %d\n",
7901 new_mute ? "" : "un", new_level);
7902 rc = volume_set_status(new_mute | new_level);
7904 volume_alsa_notify_change();
7906 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7909 static struct ibm_struct volume_driver_data = {
7911 .read = volume_read,
7912 .write = volume_write,
7913 .exit = volume_exit,
7914 .suspend = volume_suspend,
7915 .resume = volume_resume,
7916 .shutdown = volume_shutdown,
7919 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7921 #define alsa_card NULL
7923 static inline void volume_alsa_notify_change(void)
7927 static int __init volume_init(struct ibm_init_struct *iibm)
7929 pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7934 static struct ibm_struct volume_driver_data = {
7938 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7940 /*************************************************************************
7947 * TPACPI_FAN_RD_ACPI_GFAN:
7948 * ACPI GFAN method: returns fan level
7950 * see TPACPI_FAN_WR_ACPI_SFAN
7951 * EC 0x2f (HFSP) not available if GFAN exists
7953 * TPACPI_FAN_WR_ACPI_SFAN:
7954 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7956 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7959 * TPACPI_FAN_WR_TPEC:
7960 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7961 * Supported on almost all ThinkPads
7963 * Fan speed changes of any sort (including those caused by the
7964 * disengaged mode) are usually done slowly by the firmware as the
7965 * maximum amount of fan duty cycle change per second seems to be
7968 * Reading is not available if GFAN exists.
7969 * Writing is not available if SFAN exists.
7972 * 7 automatic mode engaged;
7973 * (default operation mode of the ThinkPad)
7974 * fan level is ignored in this mode.
7975 * 6 full speed mode (takes precedence over bit 7);
7976 * not available on all thinkpads. May disable
7977 * the tachometer while the fan controller ramps up
7978 * the speed (which can take up to a few *minutes*).
7979 * Speeds up fan to 100% duty-cycle, which is far above
7980 * the standard RPM levels. It is not impossible that
7981 * it could cause hardware damage.
7982 * 5-3 unused in some models. Extra bits for fan level
7983 * in others, but still useless as all values above
7984 * 7 map to the same speed as level 7 in these models.
7985 * 2-0 fan level (0..7 usually)
7987 * 0x07 = max (set when temperatures critical)
7988 * Some ThinkPads may have other levels, see
7989 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7991 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7992 * boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7993 * does so, its initial value is meaningless (0x07).
7995 * For firmware bugs, refer to:
7996 * https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
8000 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
8001 * Main fan tachometer reading (in RPM)
8003 * This register is present on all ThinkPads with a new-style EC, and
8004 * it is known not to be present on the A21m/e, and T22, as there is
8005 * something else in offset 0x84 according to the ACPI DSDT. Other
8006 * ThinkPads from this same time period (and earlier) probably lack the
8007 * tachometer as well.
8009 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
8010 * was never fixed by IBM to report the EC firmware version string
8011 * probably support the tachometer (like the early X models), so
8012 * detecting it is quite hard. We need more data to know for sure.
8014 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
8017 * FIRMWARE BUG: may go stale while the EC is switching to full speed
8020 * For firmware bugs, refer to:
8021 * https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
8025 * ThinkPad EC register 0x31 bit 0 (only on select models)
8027 * When bit 0 of EC register 0x31 is zero, the tachometer registers
8028 * show the speed of the main fan. When bit 0 of EC register 0x31
8029 * is one, the tachometer registers show the speed of the auxiliary
8032 * Fan control seems to affect both fans, regardless of the state
8035 * So far, only the firmware for the X60/X61 non-tablet versions
8036 * seem to support this (firmware TP-7M).
8038 * TPACPI_FAN_WR_ACPI_FANS:
8039 * ThinkPad X31, X40, X41. Not available in the X60.
8041 * FANS ACPI handle: takes three arguments: low speed, medium speed,
8042 * high speed. ACPI DSDT seems to map these three speeds to levels
8043 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
8044 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
8046 * The speeds are stored on handles
8047 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
8049 * There are three default speed sets, accessible as handles:
8050 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
8052 * ACPI DSDT switches which set is in use depending on various
8055 * TPACPI_FAN_WR_TPEC is also available and should be used to
8056 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
8057 * but the ACPI tables just mention level 7.
8060 enum { /* Fan control constants */
8061 fan_status_offset = 0x2f, /* EC register 0x2f */
8062 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
8063 * 0x84 must be read before 0x85 */
8064 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
8065 bit 0 selects which fan is active */
8067 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
8068 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
8070 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
8073 enum fan_status_access_mode {
8074 TPACPI_FAN_NONE = 0, /* No fan status or control */
8075 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
8076 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
8079 enum fan_control_access_mode {
8080 TPACPI_FAN_WR_NONE = 0, /* No fan control */
8081 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
8082 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
8083 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
8086 enum fan_control_commands {
8087 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
8088 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
8089 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
8090 * and also watchdog cmd */
8093 static bool fan_control_allowed;
8095 static enum fan_status_access_mode fan_status_access_mode;
8096 static enum fan_control_access_mode fan_control_access_mode;
8097 static enum fan_control_commands fan_control_commands;
8099 static u8 fan_control_initial_status;
8100 static u8 fan_control_desired_level;
8101 static u8 fan_control_resume_level;
8102 static int fan_watchdog_maxinterval;
8104 static struct mutex fan_mutex;
8106 static void fan_watchdog_fire(struct work_struct *ignored);
8107 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
8109 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
8110 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
8111 "\\FSPD", /* 600e/x, 770e, 770x */
8113 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
8114 "JFNS", /* 770x-JL */
8118 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
8119 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
8120 * be in auto mode (0x80).
8122 * This is corrected by any write to HFSP either by the driver, or
8125 * We assume 0x07 really means auto mode while this quirk is active,
8126 * as this is far more likely than the ThinkPad being in level 7,
8127 * which is only used by the firmware during thermal emergencies.
8129 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
8130 * TP-70 (T43, R52), which are known to be buggy.
8133 static void fan_quirk1_setup(void)
8135 if (fan_control_initial_status == 0x07) {
8136 pr_notice("fan_init: initial fan status is unknown, assuming it is in auto mode\n");
8137 tp_features.fan_ctrl_status_undef = 1;
8141 static void fan_quirk1_handle(u8 *fan_status)
8143 if (unlikely(tp_features.fan_ctrl_status_undef)) {
8144 if (*fan_status != fan_control_initial_status) {
8145 /* something changed the HFSP regisnter since
8146 * driver init time, so it is not undefined
8148 tp_features.fan_ctrl_status_undef = 0;
8150 /* Return most likely status. In fact, it
8151 * might be the only possible status */
8152 *fan_status = TP_EC_FAN_AUTO;
8157 /* Select main fan on X60/X61, NOOP on others */
8158 static bool fan_select_fan1(void)
8160 if (tp_features.second_fan) {
8163 if (ec_read(fan_select_offset, &val) < 0)
8166 if (ec_write(fan_select_offset, val) < 0)
8172 /* Select secondary fan on X60/X61 */
8173 static bool fan_select_fan2(void)
8177 if (!tp_features.second_fan)
8180 if (ec_read(fan_select_offset, &val) < 0)
8183 if (ec_write(fan_select_offset, val) < 0)
8190 * Call with fan_mutex held
8192 static void fan_update_desired_level(u8 status)
8195 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8197 fan_control_desired_level = 7;
8199 fan_control_desired_level = status;
8203 static int fan_get_status(u8 *status)
8208 * Add TPACPI_FAN_RD_ACPI_FANS ? */
8210 switch (fan_status_access_mode) {
8211 case TPACPI_FAN_RD_ACPI_GFAN: {
8212 /* 570, 600e/x, 770e, 770x */
8215 if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
8219 *status = res & 0x07;
8223 case TPACPI_FAN_RD_TPEC:
8224 /* all except 570, 600e/x, 770e, 770x */
8225 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
8228 if (likely(status)) {
8230 fan_quirk1_handle(status);
8242 static int fan_get_status_safe(u8 *status)
8247 if (mutex_lock_killable(&fan_mutex))
8248 return -ERESTARTSYS;
8249 rc = fan_get_status(&s);
8251 fan_update_desired_level(s);
8252 mutex_unlock(&fan_mutex);
8262 static int fan_get_speed(unsigned int *speed)
8266 switch (fan_status_access_mode) {
8267 case TPACPI_FAN_RD_TPEC:
8268 /* all except 570, 600e/x, 770e, 770x */
8269 if (unlikely(!fan_select_fan1()))
8271 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
8272 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
8276 *speed = (hi << 8) | lo;
8287 static int fan2_get_speed(unsigned int *speed)
8292 switch (fan_status_access_mode) {
8293 case TPACPI_FAN_RD_TPEC:
8294 /* all except 570, 600e/x, 770e, 770x */
8295 if (unlikely(!fan_select_fan2()))
8297 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
8298 !acpi_ec_read(fan_rpm_offset + 1, &hi);
8299 fan_select_fan1(); /* play it safe */
8304 *speed = (hi << 8) | lo;
8315 static int fan_set_level(int level)
8317 if (!fan_control_allowed)
8320 switch (fan_control_access_mode) {
8321 case TPACPI_FAN_WR_ACPI_SFAN:
8322 if ((level < 0) || (level > 7))
8325 if (tp_features.second_fan_ctl) {
8326 if (!fan_select_fan2() ||
8327 !acpi_evalf(sfan_handle, NULL, NULL, "vd", level)) {
8328 pr_warn("Couldn't set 2nd fan level, disabling support\n");
8329 tp_features.second_fan_ctl = 0;
8333 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
8337 case TPACPI_FAN_WR_ACPI_FANS:
8338 case TPACPI_FAN_WR_TPEC:
8339 if (!(level & TP_EC_FAN_AUTO) &&
8340 !(level & TP_EC_FAN_FULLSPEED) &&
8341 ((level < 0) || (level > 7)))
8344 /* safety net should the EC not support AUTO
8345 * or FULLSPEED mode bits and just ignore them */
8346 if (level & TP_EC_FAN_FULLSPEED)
8347 level |= 7; /* safety min speed 7 */
8348 else if (level & TP_EC_FAN_AUTO)
8349 level |= 4; /* safety min speed 4 */
8351 if (tp_features.second_fan_ctl) {
8352 if (!fan_select_fan2() ||
8353 !acpi_ec_write(fan_status_offset, level)) {
8354 pr_warn("Couldn't set 2nd fan level, disabling support\n");
8355 tp_features.second_fan_ctl = 0;
8360 if (!acpi_ec_write(fan_status_offset, level))
8363 tp_features.fan_ctrl_status_undef = 0;
8370 vdbg_printk(TPACPI_DBG_FAN,
8371 "fan control: set fan control register to 0x%02x\n", level);
8375 static int fan_set_level_safe(int level)
8379 if (!fan_control_allowed)
8382 if (mutex_lock_killable(&fan_mutex))
8383 return -ERESTARTSYS;
8385 if (level == TPACPI_FAN_LAST_LEVEL)
8386 level = fan_control_desired_level;
8388 rc = fan_set_level(level);
8390 fan_update_desired_level(level);
8392 mutex_unlock(&fan_mutex);
8396 static int fan_set_enable(void)
8401 if (!fan_control_allowed)
8404 if (mutex_lock_killable(&fan_mutex))
8405 return -ERESTARTSYS;
8407 switch (fan_control_access_mode) {
8408 case TPACPI_FAN_WR_ACPI_FANS:
8409 case TPACPI_FAN_WR_TPEC:
8410 rc = fan_get_status(&s);
8414 /* Don't go out of emergency fan mode */
8417 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
8420 if (!acpi_ec_write(fan_status_offset, s))
8423 tp_features.fan_ctrl_status_undef = 0;
8428 case TPACPI_FAN_WR_ACPI_SFAN:
8429 rc = fan_get_status(&s);
8435 /* Set fan to at least level 4 */
8438 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
8448 mutex_unlock(&fan_mutex);
8451 vdbg_printk(TPACPI_DBG_FAN,
8452 "fan control: set fan control register to 0x%02x\n",
8457 static int fan_set_disable(void)
8461 if (!fan_control_allowed)
8464 if (mutex_lock_killable(&fan_mutex))
8465 return -ERESTARTSYS;
8468 switch (fan_control_access_mode) {
8469 case TPACPI_FAN_WR_ACPI_FANS:
8470 case TPACPI_FAN_WR_TPEC:
8471 if (!acpi_ec_write(fan_status_offset, 0x00))
8474 fan_control_desired_level = 0;
8475 tp_features.fan_ctrl_status_undef = 0;
8479 case TPACPI_FAN_WR_ACPI_SFAN:
8480 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
8483 fan_control_desired_level = 0;
8491 vdbg_printk(TPACPI_DBG_FAN,
8492 "fan control: set fan control register to 0\n");
8494 mutex_unlock(&fan_mutex);
8498 static int fan_set_speed(int speed)
8502 if (!fan_control_allowed)
8505 if (mutex_lock_killable(&fan_mutex))
8506 return -ERESTARTSYS;
8509 switch (fan_control_access_mode) {
8510 case TPACPI_FAN_WR_ACPI_FANS:
8511 if (speed >= 0 && speed <= 65535) {
8512 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
8513 speed, speed, speed))
8523 mutex_unlock(&fan_mutex);
8527 static void fan_watchdog_reset(void)
8529 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
8532 if (fan_watchdog_maxinterval > 0 &&
8533 tpacpi_lifecycle != TPACPI_LIFE_EXITING)
8534 mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
8535 msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
8537 cancel_delayed_work(&fan_watchdog_task);
8540 static void fan_watchdog_fire(struct work_struct *ignored)
8544 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
8547 pr_notice("fan watchdog: enabling fan\n");
8548 rc = fan_set_enable();
8550 pr_err("fan watchdog: error %d while enabling fan, will try again later...\n",
8552 /* reschedule for later */
8553 fan_watchdog_reset();
8558 * SYSFS fan layout: hwmon compatible (device)
8561 * 0: "disengaged" mode
8563 * 2: native EC "auto" mode (recommended, hardware default)
8565 * pwm*: set speed in manual mode, ignored otherwise.
8566 * 0 is level 0; 255 is level 7. Intermediate points done with linear
8569 * fan*_input: tachometer reading, RPM
8572 * SYSFS fan layout: extensions
8574 * fan_watchdog (driver):
8575 * fan watchdog interval in seconds, 0 disables (default), max 120
8578 /* sysfs fan pwm1_enable ----------------------------------------------- */
8579 static ssize_t fan_pwm1_enable_show(struct device *dev,
8580 struct device_attribute *attr,
8586 res = fan_get_status_safe(&status);
8590 if (status & TP_EC_FAN_FULLSPEED) {
8592 } else if (status & TP_EC_FAN_AUTO) {
8597 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
8600 static ssize_t fan_pwm1_enable_store(struct device *dev,
8601 struct device_attribute *attr,
8602 const char *buf, size_t count)
8607 if (parse_strtoul(buf, 2, &t))
8610 tpacpi_disclose_usertask("hwmon pwm1_enable",
8611 "set fan mode to %lu\n", t);
8615 level = TP_EC_FAN_FULLSPEED;
8618 level = TPACPI_FAN_LAST_LEVEL;
8621 level = TP_EC_FAN_AUTO;
8624 /* reserved for software-controlled auto mode */
8630 res = fan_set_level_safe(level);
8636 fan_watchdog_reset();
8641 static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
8642 fan_pwm1_enable_show, fan_pwm1_enable_store);
8644 /* sysfs fan pwm1 ------------------------------------------------------ */
8645 static ssize_t fan_pwm1_show(struct device *dev,
8646 struct device_attribute *attr,
8652 res = fan_get_status_safe(&status);
8657 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
8658 status = fan_control_desired_level;
8663 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
8666 static ssize_t fan_pwm1_store(struct device *dev,
8667 struct device_attribute *attr,
8668 const char *buf, size_t count)
8672 u8 status, newlevel;
8674 if (parse_strtoul(buf, 255, &s))
8677 tpacpi_disclose_usertask("hwmon pwm1",
8678 "set fan speed to %lu\n", s);
8680 /* scale down from 0-255 to 0-7 */
8681 newlevel = (s >> 5) & 0x07;
8683 if (mutex_lock_killable(&fan_mutex))
8684 return -ERESTARTSYS;
8686 rc = fan_get_status(&status);
8687 if (!rc && (status &
8688 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8689 rc = fan_set_level(newlevel);
8693 fan_update_desired_level(newlevel);
8694 fan_watchdog_reset();
8698 mutex_unlock(&fan_mutex);
8699 return (rc) ? rc : count;
8702 static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, fan_pwm1_show, fan_pwm1_store);
8704 /* sysfs fan fan1_input ------------------------------------------------ */
8705 static ssize_t fan_fan1_input_show(struct device *dev,
8706 struct device_attribute *attr,
8712 res = fan_get_speed(&speed);
8716 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8719 static DEVICE_ATTR(fan1_input, S_IRUGO, fan_fan1_input_show, NULL);
8721 /* sysfs fan fan2_input ------------------------------------------------ */
8722 static ssize_t fan_fan2_input_show(struct device *dev,
8723 struct device_attribute *attr,
8729 res = fan2_get_speed(&speed);
8733 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8736 static DEVICE_ATTR(fan2_input, S_IRUGO, fan_fan2_input_show, NULL);
8738 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8739 static ssize_t fan_watchdog_show(struct device_driver *drv, char *buf)
8741 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
8744 static ssize_t fan_watchdog_store(struct device_driver *drv, const char *buf,
8749 if (parse_strtoul(buf, 120, &t))
8752 if (!fan_control_allowed)
8755 fan_watchdog_maxinterval = t;
8756 fan_watchdog_reset();
8758 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8762 static DRIVER_ATTR_RW(fan_watchdog);
8764 /* --------------------------------------------------------------------- */
8765 static struct attribute *fan_attributes[] = {
8766 &dev_attr_pwm1_enable.attr, &dev_attr_pwm1.attr,
8767 &dev_attr_fan1_input.attr,
8768 NULL, /* for fan2_input */
8772 static const struct attribute_group fan_attr_group = {
8773 .attrs = fan_attributes,
8776 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
8777 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
8778 #define TPACPI_FAN_2CTL 0x0004 /* selects fan2 control */
8780 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8781 TPACPI_QEC_IBM('1', 'Y', TPACPI_FAN_Q1),
8782 TPACPI_QEC_IBM('7', '8', TPACPI_FAN_Q1),
8783 TPACPI_QEC_IBM('7', '6', TPACPI_FAN_Q1),
8784 TPACPI_QEC_IBM('7', '0', TPACPI_FAN_Q1),
8785 TPACPI_QEC_LNV('7', 'M', TPACPI_FAN_2FAN),
8786 TPACPI_Q_LNV('N', '1', TPACPI_FAN_2FAN),
8787 TPACPI_Q_LNV3('N', '1', 'D', TPACPI_FAN_2CTL), /* P70 */
8788 TPACPI_Q_LNV3('N', '1', 'E', TPACPI_FAN_2CTL), /* P50 */
8789 TPACPI_Q_LNV3('N', '1', 'T', TPACPI_FAN_2CTL), /* P71 */
8790 TPACPI_Q_LNV3('N', '1', 'U', TPACPI_FAN_2CTL), /* P51 */
8791 TPACPI_Q_LNV3('N', '2', 'C', TPACPI_FAN_2CTL), /* P52 / P72 */
8792 TPACPI_Q_LNV3('N', '2', 'N', TPACPI_FAN_2CTL), /* P53 / P73 */
8793 TPACPI_Q_LNV3('N', '2', 'E', TPACPI_FAN_2CTL), /* P1 / X1 Extreme (1st gen) */
8794 TPACPI_Q_LNV3('N', '2', 'O', TPACPI_FAN_2CTL), /* P1 / X1 Extreme (2nd gen) */
8795 TPACPI_Q_LNV3('N', '2', 'V', TPACPI_FAN_2CTL), /* P1 / X1 Extreme (3nd gen) */
8796 TPACPI_Q_LNV3('N', '4', '0', TPACPI_FAN_2CTL), /* P1 / X1 Extreme (4nd gen) */
8797 TPACPI_Q_LNV3('N', '3', '0', TPACPI_FAN_2CTL), /* P15 (1st gen) / P15v (1st gen) */
8798 TPACPI_Q_LNV3('N', '3', '2', TPACPI_FAN_2CTL), /* X1 Carbon (9th gen) */
8801 static int __init fan_init(struct ibm_init_struct *iibm)
8804 unsigned long quirks;
8806 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8807 "initializing fan subdriver\n");
8809 mutex_init(&fan_mutex);
8810 fan_status_access_mode = TPACPI_FAN_NONE;
8811 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8812 fan_control_commands = 0;
8813 fan_watchdog_maxinterval = 0;
8814 tp_features.fan_ctrl_status_undef = 0;
8815 tp_features.second_fan = 0;
8816 tp_features.second_fan_ctl = 0;
8817 fan_control_desired_level = 7;
8819 if (tpacpi_is_ibm()) {
8820 TPACPI_ACPIHANDLE_INIT(fans);
8821 TPACPI_ACPIHANDLE_INIT(gfan);
8822 TPACPI_ACPIHANDLE_INIT(sfan);
8825 quirks = tpacpi_check_quirks(fan_quirk_table,
8826 ARRAY_SIZE(fan_quirk_table));
8829 /* 570, 600e/x, 770e, 770x */
8830 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8832 /* all other ThinkPads: note that even old-style
8833 * ThinkPad ECs supports the fan control register */
8834 if (likely(acpi_ec_read(fan_status_offset,
8835 &fan_control_initial_status))) {
8836 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8837 if (quirks & TPACPI_FAN_Q1)
8839 if (quirks & TPACPI_FAN_2FAN) {
8840 tp_features.second_fan = 1;
8841 pr_info("secondary fan support enabled\n");
8843 if (quirks & TPACPI_FAN_2CTL) {
8844 tp_features.second_fan = 1;
8845 tp_features.second_fan_ctl = 1;
8846 pr_info("secondary fan control enabled\n");
8849 pr_err("ThinkPad ACPI EC access misbehaving, fan status and control unavailable\n");
8856 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8857 fan_control_commands |=
8858 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8861 /* gfan without sfan means no fan control */
8862 /* all other models implement TP EC 0x2f control */
8866 fan_control_access_mode =
8867 TPACPI_FAN_WR_ACPI_FANS;
8868 fan_control_commands |=
8869 TPACPI_FAN_CMD_SPEED |
8870 TPACPI_FAN_CMD_LEVEL |
8871 TPACPI_FAN_CMD_ENABLE;
8873 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8874 fan_control_commands |=
8875 TPACPI_FAN_CMD_LEVEL |
8876 TPACPI_FAN_CMD_ENABLE;
8881 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8882 "fan is %s, modes %d, %d\n",
8883 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8884 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8885 fan_status_access_mode, fan_control_access_mode);
8887 /* fan control master switch */
8888 if (!fan_control_allowed) {
8889 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8890 fan_control_commands = 0;
8891 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8892 "fan control features disabled by parameter\n");
8895 /* update fan_control_desired_level */
8896 if (fan_status_access_mode != TPACPI_FAN_NONE)
8897 fan_get_status_safe(NULL);
8899 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8900 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8901 if (tp_features.second_fan) {
8902 /* attach second fan tachometer */
8903 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8904 &dev_attr_fan2_input.attr;
8906 rc = sysfs_create_group(&tpacpi_hwmon->kobj,
8911 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8912 &driver_attr_fan_watchdog);
8914 sysfs_remove_group(&tpacpi_hwmon->kobj,
8923 static void fan_exit(void)
8925 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8926 "cancelling any pending fan watchdog tasks\n");
8928 /* FIXME: can we really do this unconditionally? */
8929 sysfs_remove_group(&tpacpi_hwmon->kobj, &fan_attr_group);
8930 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8931 &driver_attr_fan_watchdog);
8933 cancel_delayed_work(&fan_watchdog_task);
8934 flush_workqueue(tpacpi_wq);
8937 static void fan_suspend(void)
8941 if (!fan_control_allowed)
8944 /* Store fan status in cache */
8945 fan_control_resume_level = 0;
8946 rc = fan_get_status_safe(&fan_control_resume_level);
8948 pr_notice("failed to read fan level for later restore during resume: %d\n",
8951 /* if it is undefined, don't attempt to restore it.
8953 if (tp_features.fan_ctrl_status_undef)
8954 fan_control_resume_level = 0;
8957 static void fan_resume(void)
8959 u8 current_level = 7;
8960 bool do_set = false;
8963 /* DSDT *always* updates status on resume */
8964 tp_features.fan_ctrl_status_undef = 0;
8966 if (!fan_control_allowed ||
8967 !fan_control_resume_level ||
8968 (fan_get_status_safe(¤t_level) < 0))
8971 switch (fan_control_access_mode) {
8972 case TPACPI_FAN_WR_ACPI_SFAN:
8973 /* never decrease fan level */
8974 do_set = (fan_control_resume_level > current_level);
8976 case TPACPI_FAN_WR_ACPI_FANS:
8977 case TPACPI_FAN_WR_TPEC:
8978 /* never decrease fan level, scale is:
8979 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8981 * We expect the firmware to set either 7 or AUTO, but we
8982 * handle FULLSPEED out of paranoia.
8984 * So, we can safely only restore FULLSPEED or 7, anything
8985 * else could slow the fan. Restoring AUTO is useless, at
8986 * best that's exactly what the DSDT already set (it is the
8989 * Always keep in mind that the DSDT *will* have set the
8990 * fans to what the vendor supposes is the best level. We
8991 * muck with it only to speed the fan up.
8993 if (fan_control_resume_level != 7 &&
8994 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8997 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8998 (current_level != fan_control_resume_level);
9004 pr_notice("restoring fan level to 0x%02x\n",
9005 fan_control_resume_level);
9006 rc = fan_set_level_safe(fan_control_resume_level);
9008 pr_notice("failed to restore fan level: %d\n", rc);
9012 static int fan_read(struct seq_file *m)
9016 unsigned int speed = 0;
9018 switch (fan_status_access_mode) {
9019 case TPACPI_FAN_RD_ACPI_GFAN:
9020 /* 570, 600e/x, 770e, 770x */
9021 rc = fan_get_status_safe(&status);
9025 seq_printf(m, "status:\t\t%s\n"
9027 (status != 0) ? "enabled" : "disabled", status);
9030 case TPACPI_FAN_RD_TPEC:
9031 /* all except 570, 600e/x, 770e, 770x */
9032 rc = fan_get_status_safe(&status);
9036 seq_printf(m, "status:\t\t%s\n",
9037 (status != 0) ? "enabled" : "disabled");
9039 rc = fan_get_speed(&speed);
9043 seq_printf(m, "speed:\t\t%d\n", speed);
9045 if (status & TP_EC_FAN_FULLSPEED)
9046 /* Disengaged mode takes precedence */
9047 seq_printf(m, "level:\t\tdisengaged\n");
9048 else if (status & TP_EC_FAN_AUTO)
9049 seq_printf(m, "level:\t\tauto\n");
9051 seq_printf(m, "level:\t\t%d\n", status);
9054 case TPACPI_FAN_NONE:
9056 seq_printf(m, "status:\t\tnot supported\n");
9059 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
9060 seq_printf(m, "commands:\tlevel <level>");
9062 switch (fan_control_access_mode) {
9063 case TPACPI_FAN_WR_ACPI_SFAN:
9064 seq_printf(m, " (<level> is 0-7)\n");
9068 seq_printf(m, " (<level> is 0-7, auto, disengaged, full-speed)\n");
9073 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
9074 seq_printf(m, "commands:\tenable, disable\n"
9075 "commands:\twatchdog <timeout> (<timeout> is 0 (off), 1-120 (seconds))\n");
9077 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
9078 seq_printf(m, "commands:\tspeed <speed> (<speed> is 0-65535)\n");
9083 static int fan_write_cmd_level(const char *cmd, int *rc)
9087 if (strlencmp(cmd, "level auto") == 0)
9088 level = TP_EC_FAN_AUTO;
9089 else if ((strlencmp(cmd, "level disengaged") == 0) ||
9090 (strlencmp(cmd, "level full-speed") == 0))
9091 level = TP_EC_FAN_FULLSPEED;
9092 else if (sscanf(cmd, "level %d", &level) != 1)
9095 *rc = fan_set_level_safe(level);
9097 pr_err("level command accepted for unsupported access mode %d\n",
9098 fan_control_access_mode);
9100 tpacpi_disclose_usertask("procfs fan",
9101 "set level to %d\n", level);
9106 static int fan_write_cmd_enable(const char *cmd, int *rc)
9108 if (strlencmp(cmd, "enable") != 0)
9111 *rc = fan_set_enable();
9113 pr_err("enable command accepted for unsupported access mode %d\n",
9114 fan_control_access_mode);
9116 tpacpi_disclose_usertask("procfs fan", "enable\n");
9121 static int fan_write_cmd_disable(const char *cmd, int *rc)
9123 if (strlencmp(cmd, "disable") != 0)
9126 *rc = fan_set_disable();
9128 pr_err("disable command accepted for unsupported access mode %d\n",
9129 fan_control_access_mode);
9131 tpacpi_disclose_usertask("procfs fan", "disable\n");
9136 static int fan_write_cmd_speed(const char *cmd, int *rc)
9141 * Support speed <low> <medium> <high> ? */
9143 if (sscanf(cmd, "speed %d", &speed) != 1)
9146 *rc = fan_set_speed(speed);
9148 pr_err("speed command accepted for unsupported access mode %d\n",
9149 fan_control_access_mode);
9151 tpacpi_disclose_usertask("procfs fan",
9152 "set speed to %d\n", speed);
9157 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
9161 if (sscanf(cmd, "watchdog %d", &interval) != 1)
9164 if (interval < 0 || interval > 120)
9167 fan_watchdog_maxinterval = interval;
9168 tpacpi_disclose_usertask("procfs fan",
9169 "set watchdog timer to %d\n",
9176 static int fan_write(char *buf)
9181 while (!rc && (cmd = strsep(&buf, ","))) {
9182 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
9183 fan_write_cmd_level(cmd, &rc)) &&
9184 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
9185 (fan_write_cmd_enable(cmd, &rc) ||
9186 fan_write_cmd_disable(cmd, &rc) ||
9187 fan_write_cmd_watchdog(cmd, &rc))) &&
9188 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
9189 fan_write_cmd_speed(cmd, &rc))
9193 fan_watchdog_reset();
9199 static struct ibm_struct fan_driver_data = {
9204 .suspend = fan_suspend,
9205 .resume = fan_resume,
9208 /*************************************************************************
9209 * Mute LED subdriver
9212 #define TPACPI_LED_MAX 2
9214 struct tp_led_table {
9221 static struct tp_led_table led_tables[TPACPI_LED_MAX] = {
9222 [LED_AUDIO_MUTE] = {
9227 [LED_AUDIO_MICMUTE] = {
9234 static int mute_led_on_off(struct tp_led_table *t, bool state)
9239 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9240 pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
9244 if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
9245 state ? t->on_value : t->off_value))
9252 static int tpacpi_led_set(int whichled, bool on)
9254 struct tp_led_table *t;
9256 t = &led_tables[whichled];
9257 if (t->state < 0 || t->state == on)
9259 return mute_led_on_off(t, on);
9262 static int tpacpi_led_mute_set(struct led_classdev *led_cdev,
9263 enum led_brightness brightness)
9265 return tpacpi_led_set(LED_AUDIO_MUTE, brightness != LED_OFF);
9268 static int tpacpi_led_micmute_set(struct led_classdev *led_cdev,
9269 enum led_brightness brightness)
9271 return tpacpi_led_set(LED_AUDIO_MICMUTE, brightness != LED_OFF);
9274 static struct led_classdev mute_led_cdev[TPACPI_LED_MAX] = {
9275 [LED_AUDIO_MUTE] = {
9276 .name = "platform::mute",
9277 .max_brightness = 1,
9278 .brightness_set_blocking = tpacpi_led_mute_set,
9279 .default_trigger = "audio-mute",
9281 [LED_AUDIO_MICMUTE] = {
9282 .name = "platform::micmute",
9283 .max_brightness = 1,
9284 .brightness_set_blocking = tpacpi_led_micmute_set,
9285 .default_trigger = "audio-micmute",
9289 static int mute_led_init(struct ibm_init_struct *iibm)
9294 for (i = 0; i < TPACPI_LED_MAX; i++) {
9295 struct tp_led_table *t = &led_tables[i];
9296 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9301 mute_led_cdev[i].brightness = ledtrig_audio_get(i);
9302 err = led_classdev_register(&tpacpi_pdev->dev, &mute_led_cdev[i]);
9305 led_classdev_unregister(&mute_led_cdev[i]);
9312 static void mute_led_exit(void)
9316 for (i = 0; i < TPACPI_LED_MAX; i++) {
9317 led_classdev_unregister(&mute_led_cdev[i]);
9318 tpacpi_led_set(i, false);
9322 static void mute_led_resume(void)
9326 for (i = 0; i < TPACPI_LED_MAX; i++) {
9327 struct tp_led_table *t = &led_tables[i];
9329 mute_led_on_off(t, t->state);
9333 static struct ibm_struct mute_led_driver_data = {
9335 .exit = mute_led_exit,
9336 .resume = mute_led_resume,
9340 * Battery Wear Control Driver
9341 * Contact: Ognjen Galic <smclt30p@gmail.com>
9346 #define GET_START "BCTG"
9347 #define SET_START "BCCS"
9348 #define GET_STOP "BCSG"
9349 #define SET_STOP "BCSS"
9358 /* Error condition bit */
9359 METHOD_ERR = BIT(31),
9363 /* This is used in the get/set helpers */
9368 struct tpacpi_battery_data {
9375 struct tpacpi_battery_driver_data {
9376 struct tpacpi_battery_data batteries[3];
9377 int individual_addressing;
9380 static struct tpacpi_battery_driver_data battery_info;
9382 /* ACPI helpers/functions/probes */
9385 * This evaluates a ACPI method call specific to the battery
9386 * ACPI extension. The specifics are that an error is marked
9387 * in the 32rd bit of the response, so we just check that here.
9389 static acpi_status tpacpi_battery_acpi_eval(char *method, int *ret, int param)
9393 if (!acpi_evalf(hkey_handle, &response, method, "dd", param)) {
9394 acpi_handle_err(hkey_handle, "%s: evaluate failed", method);
9397 if (response & METHOD_ERR) {
9398 acpi_handle_err(hkey_handle,
9399 "%s evaluated but flagged as error", method);
9406 static int tpacpi_battery_get(int what, int battery, int *ret)
9409 case THRESHOLD_START:
9410 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, ret, battery))
9413 /* The value is in the low 8 bits of the response */
9416 case THRESHOLD_STOP:
9417 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, ret, battery))
9419 /* Value is in lower 8 bits */
9422 * On the stop value, if we return 0 that
9423 * does not make any sense. 0 means Default, which
9424 * means that charging stops at 100%, so we return
9431 pr_crit("wrong parameter: %d", what);
9436 static int tpacpi_battery_set(int what, int battery, int value)
9439 /* The first 8 bits are the value of the threshold */
9441 /* The battery ID is in bits 8-9, 2 bits */
9442 param |= battery << 8;
9445 case THRESHOLD_START:
9446 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_START, &ret, param)) {
9447 pr_err("failed to set charge threshold on battery %d",
9452 case THRESHOLD_STOP:
9453 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_STOP, &ret, param)) {
9454 pr_err("failed to set stop threshold: %d", battery);
9459 pr_crit("wrong parameter: %d", what);
9464 static int tpacpi_battery_probe(int battery)
9468 memset(&battery_info.batteries[battery], 0,
9469 sizeof(battery_info.batteries[battery]));
9472 * 1) Get the current start threshold
9473 * 2) Check for support
9474 * 3) Get the current stop threshold
9475 * 4) Check for support
9477 if (acpi_has_method(hkey_handle, GET_START)) {
9478 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, &ret, battery)) {
9479 pr_err("Error probing battery %d\n", battery);
9482 /* Individual addressing is in bit 9 */
9484 battery_info.individual_addressing = true;
9485 /* Support is marked in bit 8 */
9487 battery_info.batteries[battery].start_support = 1;
9490 if (tpacpi_battery_get(THRESHOLD_START, battery,
9491 &battery_info.batteries[battery].charge_start)) {
9492 pr_err("Error probing battery %d\n", battery);
9496 if (acpi_has_method(hkey_handle, GET_STOP)) {
9497 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, &ret, battery)) {
9498 pr_err("Error probing battery stop; %d\n", battery);
9501 /* Support is marked in bit 8 */
9503 battery_info.batteries[battery].stop_support = 1;
9506 if (tpacpi_battery_get(THRESHOLD_STOP, battery,
9507 &battery_info.batteries[battery].charge_stop)) {
9508 pr_err("Error probing battery stop: %d\n", battery);
9512 pr_info("battery %d registered (start %d, stop %d)",
9514 battery_info.batteries[battery].charge_start,
9515 battery_info.batteries[battery].charge_stop);
9520 /* General helper functions */
9522 static int tpacpi_battery_get_id(const char *battery_name)
9525 if (strcmp(battery_name, "BAT0") == 0 ||
9526 tp_features.battery_force_primary)
9528 if (strcmp(battery_name, "BAT1") == 0)
9529 return BAT_SECONDARY;
9531 * If for some reason the battery is not BAT0 nor is it
9532 * BAT1, we will assume it's the default, first battery,
9535 pr_warn("unknown battery %s, assuming primary", battery_name);
9539 /* sysfs interface */
9541 static ssize_t tpacpi_battery_store(int what,
9543 const char *buf, size_t count)
9545 struct power_supply *supply = to_power_supply(dev);
9546 unsigned long value;
9549 * Some systems have support for more than
9550 * one battery. If that is the case,
9551 * tpacpi_battery_probe marked that addressing
9552 * them individually is supported, so we do that
9553 * based on the device struct.
9555 * On systems that are not supported, we assume
9556 * the primary as most of the ACPI calls fail
9557 * with "Any Battery" as the parameter.
9559 if (battery_info.individual_addressing)
9560 /* BAT_PRIMARY or BAT_SECONDARY */
9561 battery = tpacpi_battery_get_id(supply->desc->name);
9563 battery = BAT_PRIMARY;
9565 rval = kstrtoul(buf, 10, &value);
9570 case THRESHOLD_START:
9571 if (!battery_info.batteries[battery].start_support)
9573 /* valid values are [0, 99] */
9576 if (value > battery_info.batteries[battery].charge_stop)
9578 if (tpacpi_battery_set(THRESHOLD_START, battery, value))
9580 battery_info.batteries[battery].charge_start = value;
9583 case THRESHOLD_STOP:
9584 if (!battery_info.batteries[battery].stop_support)
9586 /* valid values are [1, 100] */
9587 if (value < 1 || value > 100)
9589 if (value < battery_info.batteries[battery].charge_start)
9591 battery_info.batteries[battery].charge_stop = value;
9593 * When 100 is passed to stop, we need to flip
9594 * it to 0 as that the EC understands that as
9595 * "Default", which will charge to 100%
9599 if (tpacpi_battery_set(THRESHOLD_STOP, battery, value))
9603 pr_crit("Wrong parameter: %d", what);
9609 static ssize_t tpacpi_battery_show(int what,
9613 struct power_supply *supply = to_power_supply(dev);
9616 * Some systems have support for more than
9617 * one battery. If that is the case,
9618 * tpacpi_battery_probe marked that addressing
9619 * them individually is supported, so we;
9620 * based on the device struct.
9622 * On systems that are not supported, we assume
9623 * the primary as most of the ACPI calls fail
9624 * with "Any Battery" as the parameter.
9626 if (battery_info.individual_addressing)
9627 /* BAT_PRIMARY or BAT_SECONDARY */
9628 battery = tpacpi_battery_get_id(supply->desc->name);
9630 battery = BAT_PRIMARY;
9631 if (tpacpi_battery_get(what, battery, &ret))
9633 return sprintf(buf, "%d\n", ret);
9636 static ssize_t charge_control_start_threshold_show(struct device *device,
9637 struct device_attribute *attr,
9640 return tpacpi_battery_show(THRESHOLD_START, device, buf);
9643 static ssize_t charge_control_end_threshold_show(struct device *device,
9644 struct device_attribute *attr,
9647 return tpacpi_battery_show(THRESHOLD_STOP, device, buf);
9650 static ssize_t charge_control_start_threshold_store(struct device *dev,
9651 struct device_attribute *attr,
9652 const char *buf, size_t count)
9654 return tpacpi_battery_store(THRESHOLD_START, dev, buf, count);
9657 static ssize_t charge_control_end_threshold_store(struct device *dev,
9658 struct device_attribute *attr,
9659 const char *buf, size_t count)
9661 return tpacpi_battery_store(THRESHOLD_STOP, dev, buf, count);
9664 static DEVICE_ATTR_RW(charge_control_start_threshold);
9665 static DEVICE_ATTR_RW(charge_control_end_threshold);
9666 static struct device_attribute dev_attr_charge_start_threshold = __ATTR(
9667 charge_start_threshold,
9669 charge_control_start_threshold_show,
9670 charge_control_start_threshold_store
9672 static struct device_attribute dev_attr_charge_stop_threshold = __ATTR(
9673 charge_stop_threshold,
9675 charge_control_end_threshold_show,
9676 charge_control_end_threshold_store
9679 static struct attribute *tpacpi_battery_attrs[] = {
9680 &dev_attr_charge_control_start_threshold.attr,
9681 &dev_attr_charge_control_end_threshold.attr,
9682 &dev_attr_charge_start_threshold.attr,
9683 &dev_attr_charge_stop_threshold.attr,
9687 ATTRIBUTE_GROUPS(tpacpi_battery);
9689 /* ACPI battery hooking */
9691 static int tpacpi_battery_add(struct power_supply *battery)
9693 int batteryid = tpacpi_battery_get_id(battery->desc->name);
9695 if (tpacpi_battery_probe(batteryid))
9697 if (device_add_groups(&battery->dev, tpacpi_battery_groups))
9702 static int tpacpi_battery_remove(struct power_supply *battery)
9704 device_remove_groups(&battery->dev, tpacpi_battery_groups);
9708 static struct acpi_battery_hook battery_hook = {
9709 .add_battery = tpacpi_battery_add,
9710 .remove_battery = tpacpi_battery_remove,
9711 .name = "ThinkPad Battery Extension",
9714 /* Subdriver init/exit */
9716 static const struct tpacpi_quirk battery_quirk_table[] __initconst = {
9718 * Individual addressing is broken on models that expose the
9719 * primary battery as BAT1.
9721 TPACPI_Q_LNV('J', '7', true), /* B5400 */
9722 TPACPI_Q_LNV('J', 'I', true), /* Thinkpad 11e */
9723 TPACPI_Q_LNV3('R', '0', 'B', true), /* Thinkpad 11e gen 3 */
9724 TPACPI_Q_LNV3('R', '0', 'C', true), /* Thinkpad 13 */
9725 TPACPI_Q_LNV3('R', '0', 'J', true), /* Thinkpad 13 gen 2 */
9726 TPACPI_Q_LNV3('R', '0', 'K', true), /* Thinkpad 11e gen 4 celeron BIOS */
9729 static int __init tpacpi_battery_init(struct ibm_init_struct *ibm)
9731 memset(&battery_info, 0, sizeof(battery_info));
9733 tp_features.battery_force_primary = tpacpi_check_quirks(
9734 battery_quirk_table,
9735 ARRAY_SIZE(battery_quirk_table));
9737 battery_hook_register(&battery_hook);
9741 static void tpacpi_battery_exit(void)
9743 battery_hook_unregister(&battery_hook);
9746 static struct ibm_struct battery_driver_data = {
9748 .exit = tpacpi_battery_exit,
9751 /*************************************************************************
9752 * LCD Shadow subdriver, for the Lenovo PrivacyGuard feature
9755 static int lcdshadow_state;
9757 static int lcdshadow_on_off(bool state)
9759 acpi_handle set_shadow_handle;
9762 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "SSSS", &set_shadow_handle))) {
9763 pr_warn("Thinkpad ACPI has no %s interface.\n", "SSSS");
9767 if (!acpi_evalf(set_shadow_handle, &output, NULL, "dd", (int)state))
9770 lcdshadow_state = state;
9774 static int lcdshadow_set(bool on)
9776 if (lcdshadow_state < 0)
9777 return lcdshadow_state;
9778 if (lcdshadow_state == on)
9780 return lcdshadow_on_off(on);
9783 static int tpacpi_lcdshadow_init(struct ibm_init_struct *iibm)
9785 acpi_handle get_shadow_handle;
9788 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GSSS", &get_shadow_handle))) {
9789 lcdshadow_state = -ENODEV;
9793 if (!acpi_evalf(get_shadow_handle, &output, NULL, "dd", 0)) {
9794 lcdshadow_state = -EIO;
9797 if (!(output & 0x10000)) {
9798 lcdshadow_state = -ENODEV;
9801 lcdshadow_state = output & 0x1;
9806 static void lcdshadow_resume(void)
9808 if (lcdshadow_state >= 0)
9809 lcdshadow_on_off(lcdshadow_state);
9812 static int lcdshadow_read(struct seq_file *m)
9814 if (lcdshadow_state < 0) {
9815 seq_puts(m, "status:\t\tnot supported\n");
9817 seq_printf(m, "status:\t\t%d\n", lcdshadow_state);
9818 seq_puts(m, "commands:\t0, 1\n");
9824 static int lcdshadow_write(char *buf)
9827 int res, state = -EINVAL;
9829 if (lcdshadow_state < 0)
9832 while ((cmd = strsep(&buf, ","))) {
9833 res = kstrtoint(cmd, 10, &state);
9838 if (state >= 2 || state < 0)
9841 return lcdshadow_set(state);
9844 static struct ibm_struct lcdshadow_driver_data = {
9845 .name = "lcdshadow",
9846 .resume = lcdshadow_resume,
9847 .read = lcdshadow_read,
9848 .write = lcdshadow_write,
9851 /*************************************************************************
9852 * DYTC subdriver, for the Lenovo lapmode feature
9855 #define DYTC_CMD_GET 2 /* To get current IC function and mode */
9856 #define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
9858 static bool dytc_lapmode;
9860 static void dytc_lapmode_notify_change(void)
9862 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
9865 static int dytc_command(int command, int *output)
9867 acpi_handle dytc_handle;
9869 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
9870 /* Platform doesn't support DYTC */
9873 if (!acpi_evalf(dytc_handle, output, NULL, "dd", command))
9878 static int dytc_lapmode_get(bool *state)
9882 err = dytc_command(DYTC_CMD_GET, &output);
9885 *state = output & BIT(DYTC_GET_LAPMODE_BIT) ? true : false;
9889 static void dytc_lapmode_refresh(void)
9894 err = dytc_lapmode_get(&new_state);
9895 if (err || (new_state == dytc_lapmode))
9898 dytc_lapmode = new_state;
9899 dytc_lapmode_notify_change();
9902 /* sysfs lapmode entry */
9903 static ssize_t dytc_lapmode_show(struct device *dev,
9904 struct device_attribute *attr,
9907 return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
9910 static DEVICE_ATTR_RO(dytc_lapmode);
9912 static struct attribute *dytc_attributes[] = {
9913 &dev_attr_dytc_lapmode.attr,
9917 static const struct attribute_group dytc_attr_group = {
9918 .attrs = dytc_attributes,
9921 static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
9925 err = dytc_lapmode_get(&dytc_lapmode);
9926 /* If support isn't available (ENODEV) then don't return an error
9927 * but just don't create the sysfs group
9931 /* For all other errors we can flag the failure */
9935 /* Platform supports this feature - create the group */
9936 err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
9940 static void dytc_exit(void)
9942 sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
9945 static struct ibm_struct dytc_driver_data = {
9950 /****************************************************************************
9951 ****************************************************************************
9955 ****************************************************************************
9956 ****************************************************************************/
9959 * HKEY event callout for other subdrivers go here
9960 * (yes, it is ugly, but it is quick, safe, and gets the job done
9962 static void tpacpi_driver_event(const unsigned int hkey_event)
9964 if (ibm_backlight_device) {
9965 switch (hkey_event) {
9966 case TP_HKEY_EV_BRGHT_UP:
9967 case TP_HKEY_EV_BRGHT_DOWN:
9968 tpacpi_brightness_notify_change();
9972 switch (hkey_event) {
9973 case TP_HKEY_EV_VOL_UP:
9974 case TP_HKEY_EV_VOL_DOWN:
9975 case TP_HKEY_EV_VOL_MUTE:
9976 volume_alsa_notify_change();
9979 if (tp_features.kbdlight && hkey_event == TP_HKEY_EV_KBD_LIGHT) {
9980 enum led_brightness brightness;
9982 mutex_lock(&kbdlight_mutex);
9985 * Check the brightness actually changed, setting the brightness
9986 * through kbdlight_set_level() also triggers this event.
9988 brightness = kbdlight_sysfs_get(NULL);
9989 if (kbdlight_brightness != brightness) {
9990 kbdlight_brightness = brightness;
9991 led_classdev_notify_brightness_hw_changed(
9992 &tpacpi_led_kbdlight.led_classdev, brightness);
9995 mutex_unlock(&kbdlight_mutex);
9998 if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
9999 dytc_lapmode_refresh();
10003 static void hotkey_driver_event(const unsigned int scancode)
10005 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
10008 /* --------------------------------------------------------------------- */
10010 /* /proc support */
10011 static struct proc_dir_entry *proc_dir;
10014 * Module and infrastructure proble, init and exit handling
10017 static bool force_load;
10019 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
10020 static const char * __init str_supported(int is_supported)
10022 static char text_unsupported[] __initdata = "not supported";
10024 return (is_supported) ? &text_unsupported[4] : &text_unsupported[0];
10026 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
10028 static void ibm_exit(struct ibm_struct *ibm)
10030 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
10032 list_del_init(&ibm->all_drivers);
10034 if (ibm->flags.acpi_notify_installed) {
10035 dbg_printk(TPACPI_DBG_EXIT,
10036 "%s: acpi_remove_notify_handler\n", ibm->name);
10037 BUG_ON(!ibm->acpi);
10038 acpi_remove_notify_handler(*ibm->acpi->handle,
10040 dispatch_acpi_notify);
10041 ibm->flags.acpi_notify_installed = 0;
10044 if (ibm->flags.proc_created) {
10045 dbg_printk(TPACPI_DBG_EXIT,
10046 "%s: remove_proc_entry\n", ibm->name);
10047 remove_proc_entry(ibm->name, proc_dir);
10048 ibm->flags.proc_created = 0;
10051 if (ibm->flags.acpi_driver_registered) {
10052 dbg_printk(TPACPI_DBG_EXIT,
10053 "%s: acpi_bus_unregister_driver\n", ibm->name);
10054 BUG_ON(!ibm->acpi);
10055 acpi_bus_unregister_driver(ibm->acpi->driver);
10056 kfree(ibm->acpi->driver);
10057 ibm->acpi->driver = NULL;
10058 ibm->flags.acpi_driver_registered = 0;
10061 if (ibm->flags.init_called && ibm->exit) {
10063 ibm->flags.init_called = 0;
10066 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
10069 static int __init ibm_init(struct ibm_init_struct *iibm)
10072 struct ibm_struct *ibm = iibm->data;
10073 struct proc_dir_entry *entry;
10075 BUG_ON(ibm == NULL);
10077 INIT_LIST_HEAD(&ibm->all_drivers);
10079 if (ibm->flags.experimental && !experimental)
10082 dbg_printk(TPACPI_DBG_INIT,
10083 "probing for %s\n", ibm->name);
10086 ret = iibm->init(iibm);
10088 return 0; /* probe failed */
10092 ibm->flags.init_called = 1;
10096 if (ibm->acpi->hid) {
10097 ret = register_tpacpi_subdriver(ibm);
10102 if (ibm->acpi->notify) {
10103 ret = setup_acpi_notify(ibm);
10104 if (ret == -ENODEV) {
10105 pr_notice("disabling subdriver %s\n",
10115 dbg_printk(TPACPI_DBG_INIT,
10116 "%s installed\n", ibm->name);
10119 umode_t mode = iibm->base_procfs_mode;
10125 entry = proc_create_data(ibm->name, mode, proc_dir,
10126 &dispatch_proc_ops, ibm);
10128 pr_err("unable to create proc entry %s\n", ibm->name);
10132 ibm->flags.proc_created = 1;
10135 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
10140 dbg_printk(TPACPI_DBG_INIT,
10141 "%s: at error exit path with result %d\n",
10145 return (ret < 0) ? ret : 0;
10150 static char __init tpacpi_parse_fw_id(const char * const s,
10151 u32 *model, u16 *release)
10155 if (!s || strlen(s) < 8)
10158 for (i = 0; i < 8; i++)
10159 if (!((s[i] >= '0' && s[i] <= '9') ||
10160 (s[i] >= 'A' && s[i] <= 'Z')))
10164 * Most models: xxyTkkWW (#.##c)
10165 * Ancient 570/600 and -SL lacks (#.##c)
10167 if (s[3] == 'T' || s[3] == 'N') {
10168 *model = TPID(s[0], s[1]);
10169 *release = TPVER(s[4], s[5]);
10172 /* New models: xxxyTkkW (#.##c); T550 and some others */
10173 } else if (s[4] == 'T' || s[4] == 'N') {
10174 *model = TPID3(s[0], s[1], s[2]);
10175 *release = TPVER(s[5], s[6]);
10183 static void find_new_ec_fwstr(const struct dmi_header *dm, void *private)
10185 char *ec_fw_string = (char *) private;
10186 const char *dmi_data = (const char *)dm;
10188 * ThinkPad Embedded Controller Program Table on newer models
10190 * Offset | Name | Width | Description
10191 * ----------------------------------------------------
10192 * 0x00 | Type | BYTE | 0x8C
10193 * 0x01 | Length | BYTE |
10194 * 0x02 | Handle | WORD | Varies
10195 * 0x04 | Signature | BYTEx6 | ASCII for "LENOVO"
10196 * 0x0A | OEM struct offset | BYTE | 0x0B
10197 * 0x0B | OEM struct number | BYTE | 0x07, for this structure
10198 * 0x0C | OEM struct revision | BYTE | 0x01, for this format
10199 * 0x0D | ECP version ID | STR ID |
10200 * 0x0E | ECP release date | STR ID |
10203 /* Return if data structure not match */
10204 if (dm->type != 140 || dm->length < 0x0F ||
10205 memcmp(dmi_data + 4, "LENOVO", 6) != 0 ||
10206 dmi_data[0x0A] != 0x0B || dmi_data[0x0B] != 0x07 ||
10207 dmi_data[0x0C] != 0x01)
10210 /* fwstr is the first 8byte string */
10211 strncpy(ec_fw_string, dmi_data + 0x0F, 8);
10214 /* returns 0 - probe ok, or < 0 - probe error.
10215 * Probe ok doesn't mean thinkpad found.
10216 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
10217 static int __must_check __init get_thinkpad_model_data(
10218 struct thinkpad_id_data *tp)
10220 const struct dmi_device *dev = NULL;
10221 char ec_fw_string[18] = {0};
10228 memset(tp, 0, sizeof(*tp));
10230 if (dmi_name_in_vendors("IBM"))
10231 tp->vendor = PCI_VENDOR_ID_IBM;
10232 else if (dmi_name_in_vendors("LENOVO"))
10233 tp->vendor = PCI_VENDOR_ID_LENOVO;
10237 s = dmi_get_system_info(DMI_BIOS_VERSION);
10238 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
10239 if (s && !tp->bios_version_str)
10242 /* Really ancient ThinkPad 240X will fail this, which is fine */
10243 t = tpacpi_parse_fw_id(tp->bios_version_str,
10244 &tp->bios_model, &tp->bios_release);
10245 if (t != 'E' && t != 'C')
10249 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
10250 * X32 or newer, all Z series; Some models must have an
10251 * up-to-date BIOS or they will not be detected.
10253 * See https://thinkwiki.org/wiki/List_of_DMI_IDs
10255 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
10256 if (sscanf(dev->name,
10257 "IBM ThinkPad Embedded Controller -[%17c",
10258 ec_fw_string) == 1) {
10259 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
10260 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
10265 /* Newer ThinkPads have different EC program info table */
10266 if (!ec_fw_string[0])
10267 dmi_walk(find_new_ec_fwstr, &ec_fw_string);
10269 if (ec_fw_string[0]) {
10270 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
10271 if (!tp->ec_version_str)
10274 t = tpacpi_parse_fw_id(ec_fw_string,
10275 &tp->ec_model, &tp->ec_release);
10277 pr_notice("ThinkPad firmware release %s doesn't match the known patterns\n",
10279 pr_notice("please report this to %s\n", TPACPI_MAIL);
10283 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
10284 if (s && !(strncasecmp(s, "ThinkPad", 8) && strncasecmp(s, "Lenovo", 6))) {
10285 tp->model_str = kstrdup(s, GFP_KERNEL);
10286 if (!tp->model_str)
10289 s = dmi_get_system_info(DMI_BIOS_VENDOR);
10290 if (s && !(strncasecmp(s, "Lenovo", 6))) {
10291 tp->model_str = kstrdup(s, GFP_KERNEL);
10292 if (!tp->model_str)
10297 s = dmi_get_system_info(DMI_PRODUCT_NAME);
10298 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
10299 if (s && !tp->nummodel_str)
10305 static int __init probe_for_thinkpad(void)
10312 /* It would be dangerous to run the driver in this case */
10313 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
10317 * Non-ancient models have better DMI tagging, but very old models
10318 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
10320 is_thinkpad = (thinkpad_id.model_str != NULL) ||
10321 (thinkpad_id.ec_model != 0) ||
10322 tpacpi_is_fw_known();
10324 /* The EC handler is required */
10325 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
10328 pr_err("Not yet supported ThinkPad detected!\n");
10332 if (!is_thinkpad && !force_load)
10338 static void __init thinkpad_acpi_init_banner(void)
10340 pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
10341 pr_info("%s\n", TPACPI_URL);
10343 pr_info("ThinkPad BIOS %s, EC %s\n",
10344 (thinkpad_id.bios_version_str) ?
10345 thinkpad_id.bios_version_str : "unknown",
10346 (thinkpad_id.ec_version_str) ?
10347 thinkpad_id.ec_version_str : "unknown");
10349 BUG_ON(!thinkpad_id.vendor);
10351 if (thinkpad_id.model_str)
10352 pr_info("%s %s, model %s\n",
10353 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
10354 "IBM" : ((thinkpad_id.vendor ==
10355 PCI_VENDOR_ID_LENOVO) ?
10356 "Lenovo" : "Unknown vendor"),
10357 thinkpad_id.model_str,
10358 (thinkpad_id.nummodel_str) ?
10359 thinkpad_id.nummodel_str : "unknown");
10362 /* Module init, exit, parameters */
10364 static struct ibm_init_struct ibms_init[] __initdata = {
10366 .data = &thinkpad_acpi_driver_data,
10369 .init = hotkey_init,
10370 .data = &hotkey_driver_data,
10373 .init = bluetooth_init,
10374 .data = &bluetooth_driver_data,
10378 .data = &wan_driver_data,
10382 .data = &uwb_driver_data,
10384 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
10386 .init = video_init,
10387 .base_procfs_mode = S_IRUSR,
10388 .data = &video_driver_data,
10392 .init = kbdlight_init,
10393 .data = &kbdlight_driver_data,
10396 .init = light_init,
10397 .data = &light_driver_data,
10401 .data = &cmos_driver_data,
10405 .data = &led_driver_data,
10409 .data = &beep_driver_data,
10412 .init = thermal_init,
10413 .data = &thermal_driver_data,
10416 .init = brightness_init,
10417 .data = &brightness_driver_data,
10420 .init = volume_init,
10421 .data = &volume_driver_data,
10425 .data = &fan_driver_data,
10428 .init = mute_led_init,
10429 .data = &mute_led_driver_data,
10432 .init = tpacpi_battery_init,
10433 .data = &battery_driver_data,
10436 .init = tpacpi_lcdshadow_init,
10437 .data = &lcdshadow_driver_data,
10440 .init = tpacpi_dytc_init,
10441 .data = &dytc_driver_data,
10445 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
10448 struct ibm_struct *ibm;
10450 if (!kp || !kp->name || !val)
10453 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
10454 ibm = ibms_init[i].data;
10455 WARN_ON(ibm == NULL);
10457 if (!ibm || !ibm->name)
10460 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
10461 if (strlen(val) > sizeof(ibms_init[i].param) - 1)
10463 strcpy(ibms_init[i].param, val);
10471 module_param(experimental, int, 0444);
10472 MODULE_PARM_DESC(experimental,
10473 "Enables experimental features when non-zero");
10475 module_param_named(debug, dbg_level, uint, 0);
10476 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
10478 module_param(force_load, bool, 0444);
10479 MODULE_PARM_DESC(force_load,
10480 "Attempts to load the driver even on a mis-identified ThinkPad when true");
10482 module_param_named(fan_control, fan_control_allowed, bool, 0444);
10483 MODULE_PARM_DESC(fan_control,
10484 "Enables setting fan parameters features when true");
10486 module_param_named(brightness_mode, brightness_mode, uint, 0444);
10487 MODULE_PARM_DESC(brightness_mode,
10488 "Selects brightness control strategy: 0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
10490 module_param(brightness_enable, uint, 0444);
10491 MODULE_PARM_DESC(brightness_enable,
10492 "Enables backlight control when 1, disables when 0");
10494 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
10495 module_param_named(volume_mode, volume_mode, uint, 0444);
10496 MODULE_PARM_DESC(volume_mode,
10497 "Selects volume control strategy: 0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
10499 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
10500 MODULE_PARM_DESC(volume_capabilities,
10501 "Selects the mixer capabilities: 0=auto, 1=volume and mute, 2=mute only");
10503 module_param_named(volume_control, volume_control_allowed, bool, 0444);
10504 MODULE_PARM_DESC(volume_control,
10505 "Enables software override for the console audio control when true");
10507 module_param_named(software_mute, software_mute_requested, bool, 0444);
10508 MODULE_PARM_DESC(software_mute,
10509 "Request full software mute control");
10511 /* ALSA module API parameters */
10512 module_param_named(index, alsa_index, int, 0444);
10513 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
10514 module_param_named(id, alsa_id, charp, 0444);
10515 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
10516 module_param_named(enable, alsa_enable, bool, 0444);
10517 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
10518 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
10520 /* The module parameter can't be read back, that's why 0 is used here */
10521 #define TPACPI_PARAM(feature) \
10522 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
10523 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command at module load, see documentation")
10525 TPACPI_PARAM(hotkey);
10526 TPACPI_PARAM(bluetooth);
10527 TPACPI_PARAM(video);
10528 TPACPI_PARAM(light);
10529 TPACPI_PARAM(cmos);
10531 TPACPI_PARAM(beep);
10532 TPACPI_PARAM(brightness);
10533 TPACPI_PARAM(volume);
10536 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10537 module_param(dbg_wlswemul, uint, 0444);
10538 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
10539 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
10540 MODULE_PARM_DESC(wlsw_state,
10541 "Initial state of the emulated WLSW switch");
10543 module_param(dbg_bluetoothemul, uint, 0444);
10544 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
10545 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
10546 MODULE_PARM_DESC(bluetooth_state,
10547 "Initial state of the emulated bluetooth switch");
10549 module_param(dbg_wwanemul, uint, 0444);
10550 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
10551 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
10552 MODULE_PARM_DESC(wwan_state,
10553 "Initial state of the emulated WWAN switch");
10555 module_param(dbg_uwbemul, uint, 0444);
10556 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
10557 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
10558 MODULE_PARM_DESC(uwb_state,
10559 "Initial state of the emulated UWB switch");
10562 static void thinkpad_acpi_module_exit(void)
10564 struct ibm_struct *ibm, *itmp;
10566 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
10568 list_for_each_entry_safe_reverse(ibm, itmp,
10569 &tpacpi_all_drivers,
10574 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
10576 if (tpacpi_inputdev) {
10577 if (tp_features.input_device_registered)
10578 input_unregister_device(tpacpi_inputdev);
10580 input_free_device(tpacpi_inputdev);
10581 kfree(hotkey_keycode_map);
10585 hwmon_device_unregister(tpacpi_hwmon);
10587 if (tpacpi_sensors_pdev)
10588 platform_device_unregister(tpacpi_sensors_pdev);
10590 platform_device_unregister(tpacpi_pdev);
10592 if (tp_features.sensors_pdrv_attrs_registered)
10593 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
10594 if (tp_features.platform_drv_attrs_registered)
10595 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
10597 if (tp_features.sensors_pdrv_registered)
10598 platform_driver_unregister(&tpacpi_hwmon_pdriver);
10600 if (tp_features.platform_drv_registered)
10601 platform_driver_unregister(&tpacpi_pdriver);
10604 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
10607 destroy_workqueue(tpacpi_wq);
10609 kfree(thinkpad_id.bios_version_str);
10610 kfree(thinkpad_id.ec_version_str);
10611 kfree(thinkpad_id.model_str);
10612 kfree(thinkpad_id.nummodel_str);
10616 static int __init thinkpad_acpi_module_init(void)
10620 tpacpi_lifecycle = TPACPI_LIFE_INIT;
10622 /* Driver-level probe */
10624 ret = get_thinkpad_model_data(&thinkpad_id);
10626 pr_err("unable to get DMI data: %d\n", ret);
10627 thinkpad_acpi_module_exit();
10630 ret = probe_for_thinkpad();
10632 thinkpad_acpi_module_exit();
10636 /* Driver initialization */
10638 thinkpad_acpi_init_banner();
10639 tpacpi_check_outdated_fw();
10641 TPACPI_ACPIHANDLE_INIT(ecrd);
10642 TPACPI_ACPIHANDLE_INIT(ecwr);
10644 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
10646 thinkpad_acpi_module_exit();
10650 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
10652 pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
10653 thinkpad_acpi_module_exit();
10657 ret = platform_driver_register(&tpacpi_pdriver);
10659 pr_err("unable to register main platform driver\n");
10660 thinkpad_acpi_module_exit();
10663 tp_features.platform_drv_registered = 1;
10665 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
10667 pr_err("unable to register hwmon platform driver\n");
10668 thinkpad_acpi_module_exit();
10671 tp_features.sensors_pdrv_registered = 1;
10673 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
10675 tp_features.platform_drv_attrs_registered = 1;
10676 ret = tpacpi_create_driver_attributes(
10677 &tpacpi_hwmon_pdriver.driver);
10680 pr_err("unable to create sysfs driver attributes\n");
10681 thinkpad_acpi_module_exit();
10684 tp_features.sensors_pdrv_attrs_registered = 1;
10687 /* Device initialization */
10688 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
10690 if (IS_ERR(tpacpi_pdev)) {
10691 ret = PTR_ERR(tpacpi_pdev);
10692 tpacpi_pdev = NULL;
10693 pr_err("unable to register platform device\n");
10694 thinkpad_acpi_module_exit();
10697 tpacpi_sensors_pdev = platform_device_register_simple(
10698 TPACPI_HWMON_DRVR_NAME,
10700 if (IS_ERR(tpacpi_sensors_pdev)) {
10701 ret = PTR_ERR(tpacpi_sensors_pdev);
10702 tpacpi_sensors_pdev = NULL;
10703 pr_err("unable to register hwmon platform device\n");
10704 thinkpad_acpi_module_exit();
10707 tp_features.sensors_pdev_attrs_registered = 1;
10708 tpacpi_hwmon = hwmon_device_register_with_groups(
10709 &tpacpi_sensors_pdev->dev, TPACPI_NAME, NULL, NULL);
10711 if (IS_ERR(tpacpi_hwmon)) {
10712 ret = PTR_ERR(tpacpi_hwmon);
10713 tpacpi_hwmon = NULL;
10714 pr_err("unable to register hwmon device\n");
10715 thinkpad_acpi_module_exit();
10718 mutex_init(&tpacpi_inputdev_send_mutex);
10719 tpacpi_inputdev = input_allocate_device();
10720 if (!tpacpi_inputdev) {
10721 thinkpad_acpi_module_exit();
10724 /* Prepare input device, but don't register */
10725 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
10726 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
10727 tpacpi_inputdev->id.bustype = BUS_HOST;
10728 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
10729 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
10730 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
10731 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
10734 /* Init subdriver dependencies */
10735 tpacpi_detect_brightness_capabilities();
10737 /* Init subdrivers */
10738 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
10739 ret = ibm_init(&ibms_init[i]);
10740 if (ret >= 0 && *ibms_init[i].param)
10741 ret = ibms_init[i].data->write(ibms_init[i].param);
10743 thinkpad_acpi_module_exit();
10748 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
10750 ret = input_register_device(tpacpi_inputdev);
10752 pr_err("unable to register input device\n");
10753 thinkpad_acpi_module_exit();
10756 tp_features.input_device_registered = 1;
10762 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
10765 * This will autoload the driver in almost every ThinkPad
10766 * in widespread use.
10768 * Only _VERY_ old models, like the 240, 240x and 570 lack
10769 * the HKEY event interface.
10771 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
10774 * DMI matching for module autoloading
10776 * See https://thinkwiki.org/wiki/List_of_DMI_IDs
10777 * See https://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
10779 * Only models listed in thinkwiki will be supported, so add yours
10780 * if it is not there yet.
10782 #define IBM_BIOS_MODULE_ALIAS(__type) \
10783 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
10785 /* Ancient thinkpad BIOSes have to be identified by
10786 * BIOS type or model number, and there are far less
10787 * BIOS types than model numbers... */
10788 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
10790 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
10791 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
10792 MODULE_DESCRIPTION(TPACPI_DESC);
10793 MODULE_VERSION(TPACPI_VERSION);
10794 MODULE_LICENSE("GPL");
10796 module_init(thinkpad_acpi_module_init);
10797 module_exit(thinkpad_acpi_module_exit);