2 * thinkpad_acpi.c - ThinkPad ACPI Extras
5 * Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6 * Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 #define TPACPI_VERSION "0.24"
25 #define TPACPI_SYSFS_VERSION 0x020700
29 * 2007-10-20 changelog trimmed down
31 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
34 * 2006-11-22 0.13 new maintainer
35 * changelog now lives in git commit history, and will
36 * not be updated further in-file.
38 * 2005-03-17 0.11 support for 600e, 770x
39 * thanks to Jamie Lentin <lentinj@dial.pipex.com>
41 * 2005-01-16 0.9 use MODULE_VERSION
42 * thanks to Henrik Brix Andersen <brix@gentoo.org>
43 * fix parameter passing on module loading
44 * thanks to Rusty Russell <rusty@rustcorp.com.au>
45 * thanks to Jim Radford <radford@blackbean.org>
46 * 2004-11-08 0.8 fix init error case, don't return from a macro
47 * thanks to Chris Wright <chrisw@osdl.org>
50 #include <linux/kernel.h>
51 #include <linux/module.h>
52 #include <linux/init.h>
53 #include <linux/types.h>
54 #include <linux/string.h>
55 #include <linux/list.h>
56 #include <linux/mutex.h>
57 #include <linux/sched.h>
58 #include <linux/kthread.h>
59 #include <linux/freezer.h>
60 #include <linux/delay.h>
61 #include <linux/slab.h>
63 #include <linux/nvram.h>
64 #include <linux/proc_fs.h>
65 #include <linux/seq_file.h>
66 #include <linux/sysfs.h>
67 #include <linux/backlight.h>
69 #include <linux/platform_device.h>
70 #include <linux/hwmon.h>
71 #include <linux/hwmon-sysfs.h>
72 #include <linux/input.h>
73 #include <linux/leds.h>
74 #include <linux/rfkill.h>
75 #include <asm/uaccess.h>
77 #include <linux/dmi.h>
78 #include <linux/jiffies.h>
79 #include <linux/workqueue.h>
81 #include <sound/core.h>
82 #include <sound/control.h>
83 #include <sound/initval.h>
85 #include <acpi/acpi_drivers.h>
87 #include <linux/pci_ids.h>
90 /* ThinkPad CMOS commands */
91 #define TP_CMOS_VOLUME_DOWN 0
92 #define TP_CMOS_VOLUME_UP 1
93 #define TP_CMOS_VOLUME_MUTE 2
94 #define TP_CMOS_BRIGHTNESS_UP 4
95 #define TP_CMOS_BRIGHTNESS_DOWN 5
96 #define TP_CMOS_THINKLIGHT_ON 12
97 #define TP_CMOS_THINKLIGHT_OFF 13
101 TP_NVRAM_ADDR_HK2 = 0x57,
102 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
103 TP_NVRAM_ADDR_VIDEO = 0x59,
104 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
105 TP_NVRAM_ADDR_MIXER = 0x60,
108 /* NVRAM bit masks */
110 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
111 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
112 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
113 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
114 TP_NVRAM_MASK_THINKLIGHT = 0x10,
115 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
116 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
117 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
118 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
119 TP_NVRAM_MASK_MUTE = 0x40,
120 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
121 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
122 TP_NVRAM_POS_LEVEL_VOLUME = 0,
125 /* Misc NVRAM-related */
127 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
131 #define TPACPI_ACPI_HKEY_HID "IBM0068"
132 #define TPACPI_ACPI_EC_HID "PNP0C09"
135 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
136 #define TPACPI_HKEY_INPUT_VERSION 0x4101
138 /* ACPI \WGSV commands */
140 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
141 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
142 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
143 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
146 /* TP_ACPI_WGSV_GET_STATE bits */
148 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
149 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
150 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
151 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
152 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
153 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
154 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
155 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
156 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
157 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
161 enum tpacpi_hkey_event_t {
163 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
164 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
165 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
166 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
167 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
168 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
170 /* Reasons for waking up from S3/S4 */
171 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
172 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
173 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
174 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
175 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
176 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
178 /* Auto-sleep after eject request */
179 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
180 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
182 /* Misc bay events */
183 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
185 /* User-interface events */
186 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
187 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
188 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
189 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
190 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
191 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
192 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
195 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
196 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
197 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
198 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
199 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* thermal table changed */
202 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
205 /****************************************************************************
209 #define TPACPI_NAME "thinkpad"
210 #define TPACPI_DESC "ThinkPad ACPI Extras"
211 #define TPACPI_FILE TPACPI_NAME "_acpi"
212 #define TPACPI_URL "http://ibm-acpi.sf.net/"
213 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
215 #define TPACPI_PROC_DIR "ibm"
216 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
217 #define TPACPI_DRVR_NAME TPACPI_FILE
218 #define TPACPI_DRVR_SHORTNAME "tpacpi"
219 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
221 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
222 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
224 #define TPACPI_MAX_ACPI_ARGS 3
227 #define TPACPI_LOG TPACPI_FILE ": "
228 #define TPACPI_EMERG KERN_EMERG TPACPI_LOG
229 #define TPACPI_ALERT KERN_ALERT TPACPI_LOG
230 #define TPACPI_CRIT KERN_CRIT TPACPI_LOG
231 #define TPACPI_ERR KERN_ERR TPACPI_LOG
232 #define TPACPI_WARN KERN_WARNING TPACPI_LOG
233 #define TPACPI_NOTICE KERN_NOTICE TPACPI_LOG
234 #define TPACPI_INFO KERN_INFO TPACPI_LOG
235 #define TPACPI_DEBUG KERN_DEBUG TPACPI_LOG
237 /* Debugging printk groups */
238 #define TPACPI_DBG_ALL 0xffff
239 #define TPACPI_DBG_DISCLOSETASK 0x8000
240 #define TPACPI_DBG_INIT 0x0001
241 #define TPACPI_DBG_EXIT 0x0002
242 #define TPACPI_DBG_RFKILL 0x0004
243 #define TPACPI_DBG_HKEY 0x0008
244 #define TPACPI_DBG_FAN 0x0010
245 #define TPACPI_DBG_BRGHT 0x0020
246 #define TPACPI_DBG_MIXER 0x0040
248 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
249 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
250 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
253 /****************************************************************************
254 * Driver-wide structs and misc. variables
259 struct tp_acpi_drv_struct {
260 const struct acpi_device_id *hid;
261 struct acpi_driver *driver;
263 void (*notify) (struct ibm_struct *, u32);
266 struct acpi_device *device;
272 int (*read) (struct seq_file *);
273 int (*write) (char *);
275 void (*resume) (void);
276 void (*suspend) (pm_message_t state);
277 void (*shutdown) (void);
279 struct list_head all_drivers;
281 struct tp_acpi_drv_struct *acpi;
284 u8 acpi_driver_registered:1;
285 u8 acpi_notify_installed:1;
292 struct ibm_init_struct {
295 int (*init) (struct ibm_init_struct *);
296 mode_t base_procfs_mode;
297 struct ibm_struct *data;
308 u32 bright_acpimode:1;
312 u32 fan_ctrl_status_undef:1;
314 u32 beep_needs_two_args:1;
315 u32 mixer_no_level_control:1;
316 u32 input_device_registered:1;
317 u32 platform_drv_registered:1;
318 u32 platform_drv_attrs_registered:1;
319 u32 sensors_pdrv_registered:1;
320 u32 sensors_pdrv_attrs_registered:1;
321 u32 sensors_pdev_attrs_registered:1;
322 u32 hotkey_poll_active:1;
326 u16 hotkey_mask_ff:1;
327 u16 volume_ctrl_forbidden:1;
330 struct thinkpad_id_data {
331 unsigned int vendor; /* ThinkPad vendor:
332 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
334 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
335 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
337 u16 bios_model; /* 1Y = 0x5931, 0 = unknown */
339 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
342 char *model_str; /* ThinkPad T43 */
343 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
345 static struct thinkpad_id_data thinkpad_id;
348 TPACPI_LIFE_INIT = 0,
353 static int experimental;
354 static u32 dbg_level;
356 static struct workqueue_struct *tpacpi_wq;
364 /* Special LED class that can defer work */
365 struct tpacpi_led_classdev {
366 struct led_classdev led_classdev;
367 struct work_struct work;
368 enum led_status_t new_state;
372 /* brightness level capabilities */
373 static unsigned int bright_maxlvl; /* 0 = unknown */
375 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
376 static int dbg_wlswemul;
377 static int tpacpi_wlsw_emulstate;
378 static int dbg_bluetoothemul;
379 static int tpacpi_bluetooth_emulstate;
380 static int dbg_wwanemul;
381 static int tpacpi_wwan_emulstate;
382 static int dbg_uwbemul;
383 static int tpacpi_uwb_emulstate;
387 /*************************************************************************
391 #define dbg_printk(a_dbg_level, format, arg...) \
392 do { if (dbg_level & (a_dbg_level)) \
393 printk(TPACPI_DEBUG "%s: " format, __func__ , ## arg); \
396 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
397 #define vdbg_printk dbg_printk
398 static const char *str_supported(int is_supported);
400 #define vdbg_printk(a_dbg_level, format, arg...) \
404 static void tpacpi_log_usertask(const char * const what)
406 printk(TPACPI_DEBUG "%s: access by process with PID %d\n",
407 what, task_tgid_vnr(current));
410 #define tpacpi_disclose_usertask(what, format, arg...) \
413 (dbg_level & TPACPI_DBG_DISCLOSETASK) && \
414 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
415 printk(TPACPI_DEBUG "%s: PID %d: " format, \
416 what, task_tgid_vnr(current), ## arg); \
421 * Quirk handling helpers
423 * ThinkPad IDs and versions seen in the field so far
424 * are two-characters from the set [0-9A-Z], i.e. base 36.
426 * We use values well outside that range as specials.
429 #define TPACPI_MATCH_ANY 0xffffU
430 #define TPACPI_MATCH_UNKNOWN 0U
432 /* TPID('1', 'Y') == 0x5931 */
433 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
435 #define TPACPI_Q_IBM(__id1, __id2, __quirk) \
436 { .vendor = PCI_VENDOR_ID_IBM, \
437 .bios = TPID(__id1, __id2), \
438 .ec = TPACPI_MATCH_ANY, \
439 .quirks = (__quirk) }
441 #define TPACPI_Q_LNV(__id1, __id2, __quirk) \
442 { .vendor = PCI_VENDOR_ID_LENOVO, \
443 .bios = TPID(__id1, __id2), \
444 .ec = TPACPI_MATCH_ANY, \
445 .quirks = (__quirk) }
447 #define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
448 { .vendor = PCI_VENDOR_ID_LENOVO, \
449 .bios = TPACPI_MATCH_ANY, \
450 .ec = TPID(__id1, __id2), \
451 .quirks = (__quirk) }
453 struct tpacpi_quirk {
457 unsigned long quirks;
461 * tpacpi_check_quirks() - search BIOS/EC version on a list
462 * @qlist: array of &struct tpacpi_quirk
463 * @qlist_size: number of elements in @qlist
465 * Iterates over a quirks list until one is found that matches the
466 * ThinkPad's vendor, BIOS and EC model.
468 * Returns 0 if nothing matches, otherwise returns the quirks field of
469 * the matching &struct tpacpi_quirk entry.
471 * The match criteria is: vendor, ec and bios much match.
473 static unsigned long __init tpacpi_check_quirks(
474 const struct tpacpi_quirk *qlist,
475 unsigned int qlist_size)
478 if ((qlist->vendor == thinkpad_id.vendor ||
479 qlist->vendor == TPACPI_MATCH_ANY) &&
480 (qlist->bios == thinkpad_id.bios_model ||
481 qlist->bios == TPACPI_MATCH_ANY) &&
482 (qlist->ec == thinkpad_id.ec_model ||
483 qlist->ec == TPACPI_MATCH_ANY))
484 return qlist->quirks;
492 static inline bool __pure __init tpacpi_is_lenovo(void)
494 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
497 static inline bool __pure __init tpacpi_is_ibm(void)
499 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
502 /****************************************************************************
503 ****************************************************************************
505 * ACPI Helpers and device model
507 ****************************************************************************
508 ****************************************************************************/
510 /*************************************************************************
514 static acpi_handle root_handle;
515 static acpi_handle ec_handle;
517 #define TPACPI_HANDLE(object, parent, paths...) \
518 static acpi_handle object##_handle; \
519 static const acpi_handle *object##_parent __initdata = \
521 static char *object##_paths[] __initdata = { paths }
523 TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
524 TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
526 TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
528 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
529 "\\CMS", /* R40, R40e */
532 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
533 "^HKEY", /* R30, R31 */
534 "HKEY", /* all others */
537 TPACPI_HANDLE(vid, root, "\\_SB.PCI.AGP.VGA", /* 570 */
538 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
539 "\\_SB.PCI0.VID0", /* 770e */
540 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
541 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
542 "\\_SB.PCI0.AGP.VID", /* all others */
546 /*************************************************************************
550 static int acpi_evalf(acpi_handle handle,
551 void *res, char *method, char *fmt, ...)
554 struct acpi_object_list params;
555 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
556 struct acpi_buffer result, *resultp;
557 union acpi_object out_obj;
565 printk(TPACPI_ERR "acpi_evalf() called with empty format\n");
578 params.pointer = &in_objs[0];
585 in_objs[params.count].integer.value = va_arg(ap, int);
586 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
588 /* add more types as needed */
590 printk(TPACPI_ERR "acpi_evalf() called "
591 "with invalid format character '%c'\n", c);
598 if (res_type != 'v') {
599 result.length = sizeof(out_obj);
600 result.pointer = &out_obj;
605 status = acpi_evaluate_object(handle, method, ¶ms, resultp);
609 success = (status == AE_OK &&
610 out_obj.type == ACPI_TYPE_INTEGER);
612 *(int *)res = out_obj.integer.value;
615 success = status == AE_OK;
617 /* add more types as needed */
619 printk(TPACPI_ERR "acpi_evalf() called "
620 "with invalid format character '%c'\n", res_type);
624 if (!success && !quiet)
625 printk(TPACPI_ERR "acpi_evalf(%s, %s, ...) failed: %s\n",
626 method, fmt0, acpi_format_exception(status));
631 static int acpi_ec_read(int i, u8 *p)
636 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
640 if (ec_read(i, p) < 0)
647 static int acpi_ec_write(int i, u8 v)
650 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
653 if (ec_write(i, v) < 0)
660 static int issue_thinkpad_cmos_command(int cmos_cmd)
665 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
671 /*************************************************************************
675 #define TPACPI_ACPIHANDLE_INIT(object) \
676 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
677 object##_paths, ARRAY_SIZE(object##_paths))
679 static void __init drv_acpi_handle_init(const char *name,
680 acpi_handle *handle, const acpi_handle parent,
681 char **paths, const int num_paths)
686 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
689 for (i = 0; i < num_paths; i++) {
690 status = acpi_get_handle(parent, paths[i], handle);
691 if (ACPI_SUCCESS(status)) {
692 dbg_printk(TPACPI_DBG_INIT,
693 "Found ACPI handle %s for %s\n",
699 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
704 static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
705 u32 level, void *context, void **return_value)
707 *(acpi_handle *)return_value = handle;
709 return AE_CTRL_TERMINATE;
712 static void __init tpacpi_acpi_handle_locate(const char *name,
717 acpi_handle device_found;
719 BUG_ON(!name || !hid || !handle);
720 vdbg_printk(TPACPI_DBG_INIT,
721 "trying to locate ACPI handle for %s, using HID %s\n",
724 memset(&device_found, 0, sizeof(device_found));
725 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
726 (void *)name, &device_found);
730 if (ACPI_SUCCESS(status)) {
731 *handle = device_found;
732 dbg_printk(TPACPI_DBG_INIT,
733 "Found ACPI handle for %s\n", name);
735 vdbg_printk(TPACPI_DBG_INIT,
736 "Could not locate an ACPI handle for %s: %s\n",
737 name, acpi_format_exception(status));
741 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
743 struct ibm_struct *ibm = data;
745 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
748 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
751 ibm->acpi->notify(ibm, event);
754 static int __init setup_acpi_notify(struct ibm_struct *ibm)
761 if (!*ibm->acpi->handle)
764 vdbg_printk(TPACPI_DBG_INIT,
765 "setting up ACPI notify for %s\n", ibm->name);
767 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
769 printk(TPACPI_ERR "acpi_bus_get_device(%s) failed: %d\n",
774 ibm->acpi->device->driver_data = ibm;
775 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
776 TPACPI_ACPI_EVENT_PREFIX,
779 status = acpi_install_notify_handler(*ibm->acpi->handle,
780 ibm->acpi->type, dispatch_acpi_notify, ibm);
781 if (ACPI_FAILURE(status)) {
782 if (status == AE_ALREADY_EXISTS) {
784 "another device driver is already "
785 "handling %s events\n", ibm->name);
788 "acpi_install_notify_handler(%s) failed: %s\n",
789 ibm->name, acpi_format_exception(status));
793 ibm->flags.acpi_notify_installed = 1;
797 static int __init tpacpi_device_add(struct acpi_device *device)
802 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
806 dbg_printk(TPACPI_DBG_INIT,
807 "registering %s as an ACPI driver\n", ibm->name);
811 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
812 if (!ibm->acpi->driver) {
814 "failed to allocate memory for ibm->acpi->driver\n");
818 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
819 ibm->acpi->driver->ids = ibm->acpi->hid;
821 ibm->acpi->driver->ops.add = &tpacpi_device_add;
823 rc = acpi_bus_register_driver(ibm->acpi->driver);
825 printk(TPACPI_ERR "acpi_bus_register_driver(%s) failed: %d\n",
827 kfree(ibm->acpi->driver);
828 ibm->acpi->driver = NULL;
830 ibm->flags.acpi_driver_registered = 1;
836 /****************************************************************************
837 ****************************************************************************
841 ****************************************************************************
842 ****************************************************************************/
844 static int dispatch_proc_show(struct seq_file *m, void *v)
846 struct ibm_struct *ibm = m->private;
848 if (!ibm || !ibm->read)
853 static int dispatch_proc_open(struct inode *inode, struct file *file)
855 return single_open(file, dispatch_proc_show, PDE(inode)->data);
858 static ssize_t dispatch_proc_write(struct file *file,
859 const char __user *userbuf,
860 size_t count, loff_t *pos)
862 struct ibm_struct *ibm = PDE(file->f_path.dentry->d_inode)->data;
866 if (!ibm || !ibm->write)
868 if (count > PAGE_SIZE - 2)
871 kernbuf = kmalloc(count + 2, GFP_KERNEL);
875 if (copy_from_user(kernbuf, userbuf, count)) {
881 strcat(kernbuf, ",");
882 ret = ibm->write(kernbuf);
891 static const struct file_operations dispatch_proc_fops = {
892 .owner = THIS_MODULE,
893 .open = dispatch_proc_open,
896 .release = single_release,
897 .write = dispatch_proc_write,
900 static char *next_cmd(char **cmds)
905 while ((end = strchr(start, ',')) && end == start)
917 /****************************************************************************
918 ****************************************************************************
920 * Device model: input, hwmon and platform
922 ****************************************************************************
923 ****************************************************************************/
925 static struct platform_device *tpacpi_pdev;
926 static struct platform_device *tpacpi_sensors_pdev;
927 static struct device *tpacpi_hwmon;
928 static struct input_dev *tpacpi_inputdev;
929 static struct mutex tpacpi_inputdev_send_mutex;
930 static LIST_HEAD(tpacpi_all_drivers);
932 static int tpacpi_suspend_handler(struct platform_device *pdev,
935 struct ibm_struct *ibm, *itmp;
937 list_for_each_entry_safe(ibm, itmp,
941 (ibm->suspend)(state);
947 static int tpacpi_resume_handler(struct platform_device *pdev)
949 struct ibm_struct *ibm, *itmp;
951 list_for_each_entry_safe(ibm, itmp,
961 static void tpacpi_shutdown_handler(struct platform_device *pdev)
963 struct ibm_struct *ibm, *itmp;
965 list_for_each_entry_safe(ibm, itmp,
973 static struct platform_driver tpacpi_pdriver = {
975 .name = TPACPI_DRVR_NAME,
976 .owner = THIS_MODULE,
978 .suspend = tpacpi_suspend_handler,
979 .resume = tpacpi_resume_handler,
980 .shutdown = tpacpi_shutdown_handler,
983 static struct platform_driver tpacpi_hwmon_pdriver = {
985 .name = TPACPI_HWMON_DRVR_NAME,
986 .owner = THIS_MODULE,
990 /*************************************************************************
991 * sysfs support helpers
994 struct attribute_set {
995 unsigned int members, max_members;
996 struct attribute_group group;
999 struct attribute_set_obj {
1000 struct attribute_set s;
1001 struct attribute *a;
1002 } __attribute__((packed));
1004 static struct attribute_set *create_attr_set(unsigned int max_members,
1007 struct attribute_set_obj *sobj;
1009 if (max_members == 0)
1012 /* Allocates space for implicit NULL at the end too */
1013 sobj = kzalloc(sizeof(struct attribute_set_obj) +
1014 max_members * sizeof(struct attribute *),
1018 sobj->s.max_members = max_members;
1019 sobj->s.group.attrs = &sobj->a;
1020 sobj->s.group.name = name;
1025 #define destroy_attr_set(_set) \
1028 /* not multi-threaded safe, use it in a single thread per set */
1029 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1034 if (s->members >= s->max_members)
1037 s->group.attrs[s->members] = attr;
1043 static int add_many_to_attr_set(struct attribute_set *s,
1044 struct attribute **attr,
1049 for (i = 0; i < count; i++) {
1050 res = add_to_attr_set(s, attr[i]);
1058 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1060 sysfs_remove_group(kobj, &s->group);
1061 destroy_attr_set(s);
1064 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1065 sysfs_create_group(_kobj, &_attr_set->group)
1067 static int parse_strtoul(const char *buf,
1068 unsigned long max, unsigned long *value)
1072 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1073 endp = skip_spaces(endp);
1074 if (*endp || *value > max)
1080 static void tpacpi_disable_brightness_delay(void)
1082 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1083 printk(TPACPI_NOTICE
1084 "ACPI backlight control delay disabled\n");
1087 static void printk_deprecated_attribute(const char * const what,
1088 const char * const details)
1090 tpacpi_log_usertask("deprecated sysfs attribute");
1091 printk(TPACPI_WARN "WARNING: sysfs attribute %s is deprecated and "
1092 "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));
1173 /* Query FW and update rfkill sw state for all rfkill switches */
1174 static void tpacpi_rfk_update_swstate_all(void)
1178 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1179 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1183 * Sync the HW-blocking state of all rfkill switches,
1184 * do notice it causes the rfkill core to schedule uevents
1186 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1189 struct tpacpi_rfk *tp_rfk;
1191 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1192 tp_rfk = tpacpi_rfkill_switches[i];
1194 if (rfkill_set_hw_state(tp_rfk->rfkill,
1196 /* ignore -- we track sw block */
1202 /* Call to get the WLSW state from the firmware */
1203 static int hotkey_get_wlsw(void);
1205 /* Call to query WLSW state and update all rfkill switches */
1206 static bool tpacpi_rfk_check_hwblock_state(void)
1208 int res = hotkey_get_wlsw();
1211 /* When unknown or unsupported, we have to assume it is unblocked */
1215 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1216 tpacpi_rfk_update_hwblock_state(hw_blocked);
1221 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1223 struct tpacpi_rfk *tp_rfk = data;
1226 dbg_printk(TPACPI_DBG_RFKILL,
1227 "request to change radio state to %s\n",
1228 blocked ? "blocked" : "unblocked");
1230 /* try to set radio state */
1231 res = (tp_rfk->ops->set_status)(blocked ?
1232 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1234 /* and update the rfkill core with whatever the FW really did */
1235 tpacpi_rfk_update_swstate(tp_rfk);
1237 return (res < 0) ? res : 0;
1240 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1241 .set_block = tpacpi_rfk_hook_set_block,
1244 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1245 const struct tpacpi_rfk_ops *tp_rfkops,
1246 const enum rfkill_type rfktype,
1248 const bool set_default)
1250 struct tpacpi_rfk *atp_rfk;
1252 bool sw_state = false;
1256 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1258 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1260 atp_rfk->rfkill = rfkill_alloc(name,
1263 &tpacpi_rfk_rfkill_ops,
1265 if (!atp_rfk || !atp_rfk->rfkill) {
1267 "failed to allocate memory for rfkill class\n");
1273 atp_rfk->ops = tp_rfkops;
1275 sw_status = (tp_rfkops->get_status)();
1276 if (sw_status < 0) {
1278 "failed to read initial state for %s, error %d\n",
1281 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1283 /* try to keep the initial state, since we ask the
1284 * firmware to preserve it across S5 in NVRAM */
1285 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1288 hw_state = tpacpi_rfk_check_hwblock_state();
1289 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1291 res = rfkill_register(atp_rfk->rfkill);
1294 "failed to register %s rfkill switch: %d\n",
1296 rfkill_destroy(atp_rfk->rfkill);
1301 tpacpi_rfkill_switches[id] = atp_rfk;
1303 printk(TPACPI_INFO "rfkill switch %s: radio is %sblocked\n",
1304 name, (sw_state || hw_state) ? "" : "un");
1308 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1310 struct tpacpi_rfk *tp_rfk;
1312 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1314 tp_rfk = tpacpi_rfkill_switches[id];
1316 rfkill_unregister(tp_rfk->rfkill);
1317 rfkill_destroy(tp_rfk->rfkill);
1318 tpacpi_rfkill_switches[id] = NULL;
1323 static void printk_deprecated_rfkill_attribute(const char * const what)
1325 printk_deprecated_attribute(what,
1326 "Please switch to generic rfkill before year 2010");
1329 /* sysfs <radio> enable ------------------------------------------------ */
1330 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1331 struct device_attribute *attr,
1336 printk_deprecated_rfkill_attribute(attr->attr.name);
1338 /* This is in the ABI... */
1339 if (tpacpi_rfk_check_hwblock_state()) {
1340 status = TPACPI_RFK_RADIO_OFF;
1342 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1347 return snprintf(buf, PAGE_SIZE, "%d\n",
1348 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1351 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1352 struct device_attribute *attr,
1353 const char *buf, size_t count)
1358 printk_deprecated_rfkill_attribute(attr->attr.name);
1360 if (parse_strtoul(buf, 1, &t))
1363 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1365 /* This is in the ABI... */
1366 if (tpacpi_rfk_check_hwblock_state() && !!t)
1369 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1370 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1371 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1373 return (res < 0) ? res : count;
1376 /* procfs -------------------------------------------------------------- */
1377 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1379 if (id >= TPACPI_RFK_SW_MAX)
1380 seq_printf(m, "status:\t\tnot supported\n");
1384 /* This is in the ABI... */
1385 if (tpacpi_rfk_check_hwblock_state()) {
1386 status = TPACPI_RFK_RADIO_OFF;
1388 status = tpacpi_rfk_update_swstate(
1389 tpacpi_rfkill_switches[id]);
1394 seq_printf(m, "status:\t\t%s\n",
1395 (status == TPACPI_RFK_RADIO_ON) ?
1396 "enabled" : "disabled");
1397 seq_printf(m, "commands:\tenable, disable\n");
1403 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1409 if (id >= TPACPI_RFK_SW_MAX)
1412 while ((cmd = next_cmd(&buf))) {
1413 if (strlencmp(cmd, "enable") == 0)
1414 status = TPACPI_RFK_RADIO_ON;
1415 else if (strlencmp(cmd, "disable") == 0)
1416 status = TPACPI_RFK_RADIO_OFF;
1422 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1423 (status == TPACPI_RFK_RADIO_ON) ?
1424 "enable" : "disable",
1425 tpacpi_rfkill_names[id]);
1426 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1427 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1433 /*************************************************************************
1434 * thinkpad-acpi driver attributes
1437 /* interface_version --------------------------------------------------- */
1438 static ssize_t tpacpi_driver_interface_version_show(
1439 struct device_driver *drv,
1442 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1445 static DRIVER_ATTR(interface_version, S_IRUGO,
1446 tpacpi_driver_interface_version_show, NULL);
1448 /* debug_level --------------------------------------------------------- */
1449 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1452 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1455 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1456 const char *buf, size_t count)
1460 if (parse_strtoul(buf, 0xffff, &t))
1468 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1469 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1471 /* version ------------------------------------------------------------- */
1472 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1475 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1476 TPACPI_DESC, TPACPI_VERSION);
1479 static DRIVER_ATTR(version, S_IRUGO,
1480 tpacpi_driver_version_show, NULL);
1482 /* --------------------------------------------------------------------- */
1484 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1486 /* wlsw_emulstate ------------------------------------------------------ */
1487 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1490 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1493 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1494 const char *buf, size_t count)
1498 if (parse_strtoul(buf, 1, &t))
1501 if (tpacpi_wlsw_emulstate != !!t) {
1502 tpacpi_wlsw_emulstate = !!t;
1503 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1509 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1510 tpacpi_driver_wlsw_emulstate_show,
1511 tpacpi_driver_wlsw_emulstate_store);
1513 /* bluetooth_emulstate ------------------------------------------------- */
1514 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1515 struct device_driver *drv,
1518 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1521 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1522 struct device_driver *drv,
1523 const char *buf, size_t count)
1527 if (parse_strtoul(buf, 1, &t))
1530 tpacpi_bluetooth_emulstate = !!t;
1535 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1536 tpacpi_driver_bluetooth_emulstate_show,
1537 tpacpi_driver_bluetooth_emulstate_store);
1539 /* wwan_emulstate ------------------------------------------------- */
1540 static ssize_t tpacpi_driver_wwan_emulstate_show(
1541 struct device_driver *drv,
1544 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1547 static ssize_t tpacpi_driver_wwan_emulstate_store(
1548 struct device_driver *drv,
1549 const char *buf, size_t count)
1553 if (parse_strtoul(buf, 1, &t))
1556 tpacpi_wwan_emulstate = !!t;
1561 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1562 tpacpi_driver_wwan_emulstate_show,
1563 tpacpi_driver_wwan_emulstate_store);
1565 /* uwb_emulstate ------------------------------------------------- */
1566 static ssize_t tpacpi_driver_uwb_emulstate_show(
1567 struct device_driver *drv,
1570 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1573 static ssize_t tpacpi_driver_uwb_emulstate_store(
1574 struct device_driver *drv,
1575 const char *buf, size_t count)
1579 if (parse_strtoul(buf, 1, &t))
1582 tpacpi_uwb_emulstate = !!t;
1587 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1588 tpacpi_driver_uwb_emulstate_show,
1589 tpacpi_driver_uwb_emulstate_store);
1592 /* --------------------------------------------------------------------- */
1594 static struct driver_attribute *tpacpi_driver_attributes[] = {
1595 &driver_attr_debug_level, &driver_attr_version,
1596 &driver_attr_interface_version,
1599 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1605 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1606 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1610 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1611 if (!res && dbg_wlswemul)
1612 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1613 if (!res && dbg_bluetoothemul)
1614 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1615 if (!res && dbg_wwanemul)
1616 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1617 if (!res && dbg_uwbemul)
1618 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1624 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1628 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1629 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1631 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1632 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1633 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1634 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1635 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1639 /*************************************************************************
1644 * Table of recommended minimum BIOS versions
1646 * Reasons for listing:
1647 * 1. Stable BIOS, listed because the unknown amount of
1648 * bugs and bad ACPI behaviour on older versions
1650 * 2. BIOS or EC fw with known bugs that trigger on Linux
1652 * 3. BIOS with known reduced functionality in older versions
1654 * We recommend the latest BIOS and EC version.
1655 * We only support the latest BIOS and EC fw version as a rule.
1657 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1658 * Information from users in ThinkWiki
1660 * WARNING: we use this table also to detect that the machine is
1661 * a ThinkPad in some cases, so don't remove entries lightly.
1664 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1665 { .vendor = (__v), \
1666 .bios = TPID(__id1, __id2), \
1667 .ec = TPACPI_MATCH_ANY, \
1668 .quirks = TPACPI_MATCH_ANY << 16 \
1669 | (__bv1) << 8 | (__bv2) }
1671 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1672 __eid, __ev1, __ev2) \
1673 { .vendor = (__v), \
1674 .bios = TPID(__bid1, __bid2), \
1676 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1677 | (__bv1) << 8 | (__bv2) }
1679 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1680 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1682 /* Outdated IBM BIOSes often lack the EC id string */
1683 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1684 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1685 __bv1, __bv2, TPID(__id1, __id2), \
1687 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1688 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1691 /* Outdated IBM BIOSes often lack the EC id string */
1692 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1693 __eid1, __eid2, __ev1, __ev2) \
1694 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1695 __bv1, __bv2, TPID(__eid1, __eid2), \
1697 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1698 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1701 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1702 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1704 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1705 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1706 __bv1, __bv2, TPID(__id1, __id2), \
1709 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1710 __eid1, __eid2, __ev1, __ev2) \
1711 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1712 __bv1, __bv2, TPID(__eid1, __eid2), \
1715 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1716 /* Numeric models ------------------ */
1717 /* FW MODEL BIOS VERS */
1718 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1719 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1720 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1721 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1722 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1723 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1724 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1725 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1726 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1728 /* A-series ------------------------- */
1729 /* FW MODEL BIOS VERS EC VERS */
1730 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1731 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1732 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1733 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1734 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1735 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1736 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1737 TPV_QI0('1', '3', '2', '0'), /* A22m */
1738 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1739 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1740 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1742 /* G-series ------------------------- */
1743 /* FW MODEL BIOS VERS */
1744 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1745 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1747 /* R-series, T-series --------------- */
1748 /* FW MODEL BIOS VERS EC VERS */
1749 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1750 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1751 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1752 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1753 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1754 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1755 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1756 T40/p, T41/p, T42/p (1) */
1757 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1758 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1759 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1760 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1762 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1763 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1764 TPV_QI0('1', '6', '3', '2'), /* T22 */
1765 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1766 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1767 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1769 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1770 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1771 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1773 /* BIOS FW BIOS VERS EC FW EC VERS */
1774 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1775 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1777 /* X-series ------------------------- */
1778 /* FW MODEL BIOS VERS EC VERS */
1779 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1780 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1781 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1782 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1783 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1784 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1785 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1787 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1788 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1790 /* (0) - older versions lack DMI EC fw string and functionality */
1791 /* (1) - older versions known to lack functionality */
1802 static void __init tpacpi_check_outdated_fw(void)
1804 unsigned long fwvers;
1805 u16 ec_version, bios_version;
1807 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1808 ARRAY_SIZE(tpacpi_bios_version_qtable));
1813 bios_version = fwvers & 0xffffU;
1814 ec_version = (fwvers >> 16) & 0xffffU;
1816 /* note that unknown versions are set to 0x0000 and we use that */
1817 if ((bios_version > thinkpad_id.bios_release) ||
1818 (ec_version > thinkpad_id.ec_release &&
1819 ec_version != TPACPI_MATCH_ANY)) {
1821 * The changelogs would let us track down the exact
1822 * reason, but it is just too much of a pain to track
1823 * it. We only list BIOSes that are either really
1824 * broken, or really stable to begin with, so it is
1825 * best if the user upgrades the firmware anyway.
1828 "WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1830 "WARNING: This firmware may be missing critical bug "
1831 "fixes and/or important features\n");
1835 static bool __init tpacpi_is_fw_known(void)
1837 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1838 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1841 /****************************************************************************
1842 ****************************************************************************
1846 ****************************************************************************
1847 ****************************************************************************/
1849 /*************************************************************************
1850 * thinkpad-acpi metadata subdriver
1853 static int thinkpad_acpi_driver_read(struct seq_file *m)
1855 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1856 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1860 static struct ibm_struct thinkpad_acpi_driver_data = {
1862 .read = thinkpad_acpi_driver_read,
1865 /*************************************************************************
1870 * ThinkPad firmware event model
1872 * The ThinkPad firmware has two main event interfaces: normal ACPI
1873 * notifications (which follow the ACPI standard), and a private event
1876 * The private event interface also issues events for the hotkeys. As
1877 * the driver gained features, the event handling code ended up being
1878 * built around the hotkey subdriver. This will need to be refactored
1879 * to a more formal event API eventually.
1881 * Some "hotkeys" are actually supposed to be used as event reports,
1882 * such as "brightness has changed", "volume has changed", depending on
1883 * the ThinkPad model and how the firmware is operating.
1885 * Unlike other classes, hotkey-class events have mask/unmask control on
1886 * non-ancient firmware. However, how it behaves changes a lot with the
1887 * firmware model and version.
1890 enum { /* hot key scan codes (derived from ACPI DSDT) */
1891 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1892 TP_ACPI_HOTKEYSCAN_FNF2,
1893 TP_ACPI_HOTKEYSCAN_FNF3,
1894 TP_ACPI_HOTKEYSCAN_FNF4,
1895 TP_ACPI_HOTKEYSCAN_FNF5,
1896 TP_ACPI_HOTKEYSCAN_FNF6,
1897 TP_ACPI_HOTKEYSCAN_FNF7,
1898 TP_ACPI_HOTKEYSCAN_FNF8,
1899 TP_ACPI_HOTKEYSCAN_FNF9,
1900 TP_ACPI_HOTKEYSCAN_FNF10,
1901 TP_ACPI_HOTKEYSCAN_FNF11,
1902 TP_ACPI_HOTKEYSCAN_FNF12,
1903 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1904 TP_ACPI_HOTKEYSCAN_FNINSERT,
1905 TP_ACPI_HOTKEYSCAN_FNDELETE,
1906 TP_ACPI_HOTKEYSCAN_FNHOME,
1907 TP_ACPI_HOTKEYSCAN_FNEND,
1908 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1909 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1910 TP_ACPI_HOTKEYSCAN_FNSPACE,
1911 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1912 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1913 TP_ACPI_HOTKEYSCAN_MUTE,
1914 TP_ACPI_HOTKEYSCAN_THINKPAD,
1915 TP_ACPI_HOTKEYSCAN_UNK1,
1916 TP_ACPI_HOTKEYSCAN_UNK2,
1917 TP_ACPI_HOTKEYSCAN_UNK3,
1918 TP_ACPI_HOTKEYSCAN_UNK4,
1919 TP_ACPI_HOTKEYSCAN_UNK5,
1920 TP_ACPI_HOTKEYSCAN_UNK6,
1921 TP_ACPI_HOTKEYSCAN_UNK7,
1922 TP_ACPI_HOTKEYSCAN_UNK8,
1924 /* Hotkey keymap size */
1925 TPACPI_HOTKEY_MAP_LEN
1928 enum { /* Keys/events available through NVRAM polling */
1929 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1930 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1933 enum { /* Positions of some of the keys in hotkey masks */
1934 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1935 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1936 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1937 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1938 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1939 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1940 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1941 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1942 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1943 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1944 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1947 enum { /* NVRAM to ACPI HKEY group map */
1948 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1949 TP_ACPI_HKEY_ZOOM_MASK |
1950 TP_ACPI_HKEY_DISPSWTCH_MASK |
1951 TP_ACPI_HKEY_HIBERNATE_MASK,
1952 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1953 TP_ACPI_HKEY_BRGHTDWN_MASK,
1954 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1955 TP_ACPI_HKEY_VOLDWN_MASK |
1956 TP_ACPI_HKEY_MUTE_MASK,
1959 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1960 struct tp_nvram_state {
1961 u16 thinkpad_toggle:1;
1963 u16 display_toggle:1;
1964 u16 thinklight_toggle:1;
1965 u16 hibernate_toggle:1;
1966 u16 displayexp_toggle:1;
1967 u16 display_state:1;
1968 u16 brightness_toggle:1;
1969 u16 volume_toggle:1;
1972 u8 brightness_level;
1976 /* kthread for the hotkey poller */
1977 static struct task_struct *tpacpi_hotkey_task;
1979 /* Acquired while the poller kthread is running, use to sync start/stop */
1980 static struct mutex hotkey_thread_mutex;
1983 * Acquire mutex to write poller control variables as an
1986 * Increment hotkey_config_change when changing them if you
1987 * want the kthread to forget old state.
1989 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1991 static struct mutex hotkey_thread_data_mutex;
1992 static unsigned int hotkey_config_change;
1995 * hotkey poller control variables
1997 * Must be atomic or readers will also need to acquire mutex
1999 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2000 * should be used only when the changes need to be taken as
2001 * a block, OR when one needs to force the kthread to forget
2004 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2005 static unsigned int hotkey_poll_freq = 10; /* Hz */
2007 #define HOTKEY_CONFIG_CRITICAL_START \
2009 mutex_lock(&hotkey_thread_data_mutex); \
2010 hotkey_config_change++; \
2012 #define HOTKEY_CONFIG_CRITICAL_END \
2013 mutex_unlock(&hotkey_thread_data_mutex);
2015 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2017 #define hotkey_source_mask 0U
2018 #define HOTKEY_CONFIG_CRITICAL_START
2019 #define HOTKEY_CONFIG_CRITICAL_END
2021 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2023 static struct mutex hotkey_mutex;
2025 static enum { /* Reasons for waking up */
2026 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2027 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2028 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2029 } hotkey_wakeup_reason;
2031 static int hotkey_autosleep_ack;
2033 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2034 static u32 hotkey_all_mask; /* all events supported in fw */
2035 static u32 hotkey_reserved_mask; /* events better left disabled */
2036 static u32 hotkey_driver_mask; /* events needed by the driver */
2037 static u32 hotkey_user_mask; /* events visible to userspace */
2038 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2040 static unsigned int hotkey_report_mode;
2042 static u16 *hotkey_keycode_map;
2044 static struct attribute_set *hotkey_dev_attributes;
2046 static void tpacpi_driver_event(const unsigned int hkey_event);
2047 static void hotkey_driver_event(const unsigned int scancode);
2048 static void hotkey_poll_setup(const bool may_warn);
2050 /* HKEY.MHKG() return bits */
2051 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2053 static int hotkey_get_wlsw(void)
2057 if (!tp_features.hotkey_wlsw)
2060 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2062 return (tpacpi_wlsw_emulstate) ?
2063 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2066 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2069 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2072 static int hotkey_get_tablet_mode(int *status)
2076 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2079 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2084 * Reads current event mask from firmware, and updates
2085 * hotkey_acpi_mask accordingly. Also resets any bits
2086 * from hotkey_user_mask that are unavailable to be
2087 * delivered (shadow requirement of the userspace ABI).
2089 * Call with hotkey_mutex held
2091 static int hotkey_mask_get(void)
2093 if (tp_features.hotkey_mask) {
2096 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2099 hotkey_acpi_mask = m;
2101 /* no mask support doesn't mean no event support... */
2102 hotkey_acpi_mask = hotkey_all_mask;
2105 /* sync userspace-visible mask */
2106 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2111 void static hotkey_mask_warn_incomplete_mask(void)
2113 /* log only what the user can fix... */
2114 const u32 wantedmask = hotkey_driver_mask &
2115 ~(hotkey_acpi_mask | hotkey_source_mask) &
2116 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2119 printk(TPACPI_NOTICE
2120 "required events 0x%08x not enabled!\n",
2125 * Set the firmware mask when supported
2127 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2129 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2131 * Call with hotkey_mutex held
2133 static int hotkey_mask_set(u32 mask)
2138 const u32 fwmask = mask & ~hotkey_source_mask;
2140 if (tp_features.hotkey_mask) {
2141 for (i = 0; i < 32; i++) {
2142 if (!acpi_evalf(hkey_handle,
2143 NULL, "MHKM", "vdd", i + 1,
2144 !!(mask & (1 << i)))) {
2152 * We *must* make an inconditional call to hotkey_mask_get to
2153 * refresh hotkey_acpi_mask and update hotkey_user_mask
2155 * Take the opportunity to also log when we cannot _enable_
2158 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2159 printk(TPACPI_NOTICE
2160 "asked for hotkey mask 0x%08x, but "
2161 "firmware forced it to 0x%08x\n",
2162 fwmask, hotkey_acpi_mask);
2165 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2166 hotkey_mask_warn_incomplete_mask();
2172 * Sets hotkey_user_mask and tries to set the firmware mask
2174 * Call with hotkey_mutex held
2176 static int hotkey_user_mask_set(const u32 mask)
2180 /* Give people a chance to notice they are doing something that
2181 * is bound to go boom on their users sooner or later */
2182 if (!tp_warned.hotkey_mask_ff &&
2183 (mask == 0xffff || mask == 0xffffff ||
2184 mask == 0xffffffff)) {
2185 tp_warned.hotkey_mask_ff = 1;
2186 printk(TPACPI_NOTICE
2187 "setting the hotkey mask to 0x%08x is likely "
2188 "not the best way to go about it\n", mask);
2189 printk(TPACPI_NOTICE
2190 "please consider using the driver defaults, "
2191 "and refer to up-to-date thinkpad-acpi "
2195 /* Try to enable what the user asked for, plus whatever we need.
2196 * this syncs everything but won't enable bits in hotkey_user_mask */
2197 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2199 /* Enable the available bits in hotkey_user_mask */
2200 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2206 * Sets the driver hotkey mask.
2208 * Can be called even if the hotkey subdriver is inactive
2210 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2214 /* Do the right thing if hotkey_init has not been called yet */
2215 if (!tp_features.hotkey) {
2216 hotkey_driver_mask = mask;
2220 mutex_lock(&hotkey_mutex);
2222 HOTKEY_CONFIG_CRITICAL_START
2223 hotkey_driver_mask = mask;
2224 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2225 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2227 HOTKEY_CONFIG_CRITICAL_END
2229 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2230 ~hotkey_source_mask);
2231 hotkey_poll_setup(true);
2233 mutex_unlock(&hotkey_mutex);
2238 static int hotkey_status_get(int *status)
2240 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2246 static int hotkey_status_set(bool enable)
2248 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2254 static void tpacpi_input_send_tabletsw(void)
2258 if (tp_features.hotkey_tablet &&
2259 !hotkey_get_tablet_mode(&state)) {
2260 mutex_lock(&tpacpi_inputdev_send_mutex);
2262 input_report_switch(tpacpi_inputdev,
2263 SW_TABLET_MODE, !!state);
2264 input_sync(tpacpi_inputdev);
2266 mutex_unlock(&tpacpi_inputdev_send_mutex);
2270 /* Do NOT call without validating scancode first */
2271 static void tpacpi_input_send_key(const unsigned int scancode)
2273 const unsigned int keycode = hotkey_keycode_map[scancode];
2275 if (keycode != KEY_RESERVED) {
2276 mutex_lock(&tpacpi_inputdev_send_mutex);
2278 input_report_key(tpacpi_inputdev, keycode, 1);
2279 if (keycode == KEY_UNKNOWN)
2280 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2282 input_sync(tpacpi_inputdev);
2284 input_report_key(tpacpi_inputdev, keycode, 0);
2285 if (keycode == KEY_UNKNOWN)
2286 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2288 input_sync(tpacpi_inputdev);
2290 mutex_unlock(&tpacpi_inputdev_send_mutex);
2294 /* Do NOT call without validating scancode first */
2295 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2297 hotkey_driver_event(scancode);
2298 if (hotkey_user_mask & (1 << scancode))
2299 tpacpi_input_send_key(scancode);
2302 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2303 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2305 /* Do NOT call without validating scancode first */
2306 static void tpacpi_hotkey_send_key(unsigned int scancode)
2308 tpacpi_input_send_key_masked(scancode);
2309 if (hotkey_report_mode < 2) {
2310 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2311 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2315 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2319 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2320 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2321 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2322 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2323 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2324 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2326 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2327 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2328 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2330 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2331 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2332 n->displayexp_toggle =
2333 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2335 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2336 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2337 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2338 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2339 n->brightness_toggle =
2340 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2342 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2343 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2344 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2345 >> TP_NVRAM_POS_LEVEL_VOLUME;
2346 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2347 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2351 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2352 struct tp_nvram_state *newn,
2353 const u32 event_mask)
2356 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2358 if ((event_mask & (1 << __scancode)) && \
2359 oldn->__member != newn->__member) \
2360 tpacpi_hotkey_send_key(__scancode); \
2363 #define TPACPI_MAY_SEND_KEY(__scancode) \
2365 if (event_mask & (1 << __scancode)) \
2366 tpacpi_hotkey_send_key(__scancode); \
2369 void issue_volchange(const unsigned int oldvol,
2370 const unsigned int newvol)
2372 unsigned int i = oldvol;
2374 while (i > newvol) {
2375 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2378 while (i < newvol) {
2379 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2384 void issue_brightnesschange(const unsigned int oldbrt,
2385 const unsigned int newbrt)
2387 unsigned int i = oldbrt;
2389 while (i > newbrt) {
2390 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2393 while (i < newbrt) {
2394 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2399 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2400 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2401 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2402 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2404 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2406 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2411 * This code is supposed to duplicate the IBM firmware behaviour:
2412 * - Pressing MUTE issues mute hotkey message, even when already mute
2413 * - Pressing Volume up/down issues volume up/down hotkey messages,
2414 * even when already at maximum or minumum volume
2415 * - The act of unmuting issues volume up/down notification,
2416 * depending which key was used to unmute
2418 * We are constrained to what the NVRAM can tell us, which is not much
2419 * and certainly not enough if more than one volume hotkey was pressed
2420 * since the last poll cycle.
2422 * Just to make our life interesting, some newer Lenovo ThinkPads have
2423 * bugs in the BIOS and may fail to update volume_toggle properly.
2428 oldn->volume_toggle != newn->volume_toggle ||
2429 oldn->volume_level != newn->volume_level) {
2430 /* recently muted, or repeated mute keypress, or
2431 * multiple presses ending in mute */
2432 issue_volchange(oldn->volume_level, newn->volume_level);
2433 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2438 /* recently unmuted, issue 'unmute' keypress */
2439 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2441 if (oldn->volume_level != newn->volume_level) {
2442 issue_volchange(oldn->volume_level, newn->volume_level);
2443 } else if (oldn->volume_toggle != newn->volume_toggle) {
2444 /* repeated vol up/down keypress at end of scale ? */
2445 if (newn->volume_level == 0)
2446 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2447 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2448 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2452 /* handle brightness */
2453 if (oldn->brightness_level != newn->brightness_level) {
2454 issue_brightnesschange(oldn->brightness_level,
2455 newn->brightness_level);
2456 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2457 /* repeated key presses that didn't change state */
2458 if (newn->brightness_level == 0)
2459 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2460 else if (newn->brightness_level >= bright_maxlvl
2461 && !tp_features.bright_unkfw)
2462 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2465 #undef TPACPI_COMPARE_KEY
2466 #undef TPACPI_MAY_SEND_KEY
2472 * We track all events in hotkey_source_mask all the time, since
2473 * most of them are edge-based. We only issue those requested by
2474 * hotkey_user_mask or hotkey_driver_mask, though.
2476 static int hotkey_kthread(void *data)
2478 struct tp_nvram_state s[2];
2479 u32 poll_mask, event_mask;
2480 unsigned int si, so;
2482 unsigned int change_detector, must_reset;
2483 unsigned int poll_freq;
2485 mutex_lock(&hotkey_thread_mutex);
2487 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2496 /* Initial state for compares */
2497 mutex_lock(&hotkey_thread_data_mutex);
2498 change_detector = hotkey_config_change;
2499 poll_mask = hotkey_source_mask;
2500 event_mask = hotkey_source_mask &
2501 (hotkey_driver_mask | hotkey_user_mask);
2502 poll_freq = hotkey_poll_freq;
2503 mutex_unlock(&hotkey_thread_data_mutex);
2504 hotkey_read_nvram(&s[so], poll_mask);
2506 while (!kthread_should_stop()) {
2508 if (likely(poll_freq))
2511 t = 100; /* should never happen... */
2513 t = msleep_interruptible(t);
2514 if (unlikely(kthread_should_stop()))
2516 must_reset = try_to_freeze();
2517 if (t > 0 && !must_reset)
2520 mutex_lock(&hotkey_thread_data_mutex);
2521 if (must_reset || hotkey_config_change != change_detector) {
2522 /* forget old state on thaw or config change */
2525 change_detector = hotkey_config_change;
2527 poll_mask = hotkey_source_mask;
2528 event_mask = hotkey_source_mask &
2529 (hotkey_driver_mask | hotkey_user_mask);
2530 poll_freq = hotkey_poll_freq;
2531 mutex_unlock(&hotkey_thread_data_mutex);
2533 if (likely(poll_mask)) {
2534 hotkey_read_nvram(&s[si], poll_mask);
2535 if (likely(si != so)) {
2536 hotkey_compare_and_issue_event(&s[so], &s[si],
2546 mutex_unlock(&hotkey_thread_mutex);
2550 /* call with hotkey_mutex held */
2551 static void hotkey_poll_stop_sync(void)
2553 if (tpacpi_hotkey_task) {
2554 if (frozen(tpacpi_hotkey_task) ||
2555 freezing(tpacpi_hotkey_task))
2556 thaw_process(tpacpi_hotkey_task);
2558 kthread_stop(tpacpi_hotkey_task);
2559 tpacpi_hotkey_task = NULL;
2560 mutex_lock(&hotkey_thread_mutex);
2561 /* at this point, the thread did exit */
2562 mutex_unlock(&hotkey_thread_mutex);
2566 /* call with hotkey_mutex held */
2567 static void hotkey_poll_setup(const bool may_warn)
2569 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2570 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2572 if (hotkey_poll_freq > 0 &&
2573 (poll_driver_mask ||
2574 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2575 if (!tpacpi_hotkey_task) {
2576 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2577 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2578 if (IS_ERR(tpacpi_hotkey_task)) {
2579 tpacpi_hotkey_task = NULL;
2581 "could not create kernel thread "
2582 "for hotkey polling\n");
2586 hotkey_poll_stop_sync();
2587 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2588 hotkey_poll_freq == 0) {
2589 printk(TPACPI_NOTICE
2590 "hot keys 0x%08x and/or events 0x%08x "
2591 "require polling, which is currently "
2593 poll_user_mask, poll_driver_mask);
2598 static void hotkey_poll_setup_safe(const bool may_warn)
2600 mutex_lock(&hotkey_mutex);
2601 hotkey_poll_setup(may_warn);
2602 mutex_unlock(&hotkey_mutex);
2605 /* call with hotkey_mutex held */
2606 static void hotkey_poll_set_freq(unsigned int freq)
2609 hotkey_poll_stop_sync();
2611 hotkey_poll_freq = freq;
2614 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2616 static void hotkey_poll_setup(const bool __unused)
2620 static void hotkey_poll_setup_safe(const bool __unused)
2624 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2626 static int hotkey_inputdev_open(struct input_dev *dev)
2628 switch (tpacpi_lifecycle) {
2629 case TPACPI_LIFE_INIT:
2630 case TPACPI_LIFE_RUNNING:
2631 hotkey_poll_setup_safe(false);
2633 case TPACPI_LIFE_EXITING:
2637 /* Should only happen if tpacpi_lifecycle is corrupt */
2642 static void hotkey_inputdev_close(struct input_dev *dev)
2644 /* disable hotkey polling when possible */
2645 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2646 !(hotkey_source_mask & hotkey_driver_mask))
2647 hotkey_poll_setup_safe(false);
2650 /* sysfs hotkey enable ------------------------------------------------- */
2651 static ssize_t hotkey_enable_show(struct device *dev,
2652 struct device_attribute *attr,
2657 printk_deprecated_attribute("hotkey_enable",
2658 "Hotkey reporting is always enabled");
2660 res = hotkey_status_get(&status);
2664 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2667 static ssize_t hotkey_enable_store(struct device *dev,
2668 struct device_attribute *attr,
2669 const char *buf, size_t count)
2673 printk_deprecated_attribute("hotkey_enable",
2674 "Hotkeys can be disabled through hotkey_mask");
2676 if (parse_strtoul(buf, 1, &t))
2685 static struct device_attribute dev_attr_hotkey_enable =
2686 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2687 hotkey_enable_show, hotkey_enable_store);
2689 /* sysfs hotkey mask --------------------------------------------------- */
2690 static ssize_t hotkey_mask_show(struct device *dev,
2691 struct device_attribute *attr,
2694 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2697 static ssize_t hotkey_mask_store(struct device *dev,
2698 struct device_attribute *attr,
2699 const char *buf, size_t count)
2704 if (parse_strtoul(buf, 0xffffffffUL, &t))
2707 if (mutex_lock_killable(&hotkey_mutex))
2708 return -ERESTARTSYS;
2710 res = hotkey_user_mask_set(t);
2712 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2713 hotkey_poll_setup(true);
2716 mutex_unlock(&hotkey_mutex);
2718 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2720 return (res) ? res : count;
2723 static struct device_attribute dev_attr_hotkey_mask =
2724 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2725 hotkey_mask_show, hotkey_mask_store);
2727 /* sysfs hotkey bios_enabled ------------------------------------------- */
2728 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2729 struct device_attribute *attr,
2732 return sprintf(buf, "0\n");
2735 static struct device_attribute dev_attr_hotkey_bios_enabled =
2736 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2738 /* sysfs hotkey bios_mask ---------------------------------------------- */
2739 static ssize_t hotkey_bios_mask_show(struct device *dev,
2740 struct device_attribute *attr,
2743 printk_deprecated_attribute("hotkey_bios_mask",
2744 "This attribute is useless.");
2745 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2748 static struct device_attribute dev_attr_hotkey_bios_mask =
2749 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2751 /* sysfs hotkey all_mask ----------------------------------------------- */
2752 static ssize_t hotkey_all_mask_show(struct device *dev,
2753 struct device_attribute *attr,
2756 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2757 hotkey_all_mask | hotkey_source_mask);
2760 static struct device_attribute dev_attr_hotkey_all_mask =
2761 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2763 /* sysfs hotkey recommended_mask --------------------------------------- */
2764 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2765 struct device_attribute *attr,
2768 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2769 (hotkey_all_mask | hotkey_source_mask)
2770 & ~hotkey_reserved_mask);
2773 static struct device_attribute dev_attr_hotkey_recommended_mask =
2774 __ATTR(hotkey_recommended_mask, S_IRUGO,
2775 hotkey_recommended_mask_show, NULL);
2777 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2779 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2780 static ssize_t hotkey_source_mask_show(struct device *dev,
2781 struct device_attribute *attr,
2784 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2787 static ssize_t hotkey_source_mask_store(struct device *dev,
2788 struct device_attribute *attr,
2789 const char *buf, size_t count)
2795 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2796 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2799 if (mutex_lock_killable(&hotkey_mutex))
2800 return -ERESTARTSYS;
2802 HOTKEY_CONFIG_CRITICAL_START
2803 hotkey_source_mask = t;
2804 HOTKEY_CONFIG_CRITICAL_END
2806 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2807 ~hotkey_source_mask);
2808 hotkey_poll_setup(true);
2810 /* check if events needed by the driver got disabled */
2811 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2812 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2814 mutex_unlock(&hotkey_mutex);
2817 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2818 "firmware event mask!\n");
2821 printk(TPACPI_NOTICE "hotkey_source_mask: "
2822 "some important events were disabled: "
2825 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2827 return (rc < 0) ? rc : count;
2830 static struct device_attribute dev_attr_hotkey_source_mask =
2831 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2832 hotkey_source_mask_show, hotkey_source_mask_store);
2834 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2835 static ssize_t hotkey_poll_freq_show(struct device *dev,
2836 struct device_attribute *attr,
2839 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2842 static ssize_t hotkey_poll_freq_store(struct device *dev,
2843 struct device_attribute *attr,
2844 const char *buf, size_t count)
2848 if (parse_strtoul(buf, 25, &t))
2851 if (mutex_lock_killable(&hotkey_mutex))
2852 return -ERESTARTSYS;
2854 hotkey_poll_set_freq(t);
2855 hotkey_poll_setup(true);
2857 mutex_unlock(&hotkey_mutex);
2859 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2864 static struct device_attribute dev_attr_hotkey_poll_freq =
2865 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2866 hotkey_poll_freq_show, hotkey_poll_freq_store);
2868 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2870 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2871 static ssize_t hotkey_radio_sw_show(struct device *dev,
2872 struct device_attribute *attr,
2876 res = hotkey_get_wlsw();
2880 /* Opportunistic update */
2881 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2883 return snprintf(buf, PAGE_SIZE, "%d\n",
2884 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2887 static struct device_attribute dev_attr_hotkey_radio_sw =
2888 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2890 static void hotkey_radio_sw_notify_change(void)
2892 if (tp_features.hotkey_wlsw)
2893 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2897 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2898 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2899 struct device_attribute *attr,
2903 res = hotkey_get_tablet_mode(&s);
2907 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2910 static struct device_attribute dev_attr_hotkey_tablet_mode =
2911 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2913 static void hotkey_tablet_mode_notify_change(void)
2915 if (tp_features.hotkey_tablet)
2916 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2917 "hotkey_tablet_mode");
2920 /* sysfs hotkey report_mode -------------------------------------------- */
2921 static ssize_t hotkey_report_mode_show(struct device *dev,
2922 struct device_attribute *attr,
2925 return snprintf(buf, PAGE_SIZE, "%d\n",
2926 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2929 static struct device_attribute dev_attr_hotkey_report_mode =
2930 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2932 /* sysfs wakeup reason (pollable) -------------------------------------- */
2933 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2934 struct device_attribute *attr,
2937 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2940 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2941 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2943 static void hotkey_wakeup_reason_notify_change(void)
2945 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2949 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2950 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2951 struct device_attribute *attr,
2954 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2957 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2958 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2959 hotkey_wakeup_hotunplug_complete_show, NULL);
2961 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2963 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2964 "wakeup_hotunplug_complete");
2967 /* --------------------------------------------------------------------- */
2969 static struct attribute *hotkey_attributes[] __initdata = {
2970 &dev_attr_hotkey_enable.attr,
2971 &dev_attr_hotkey_bios_enabled.attr,
2972 &dev_attr_hotkey_bios_mask.attr,
2973 &dev_attr_hotkey_report_mode.attr,
2974 &dev_attr_hotkey_wakeup_reason.attr,
2975 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2976 &dev_attr_hotkey_mask.attr,
2977 &dev_attr_hotkey_all_mask.attr,
2978 &dev_attr_hotkey_recommended_mask.attr,
2979 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2980 &dev_attr_hotkey_source_mask.attr,
2981 &dev_attr_hotkey_poll_freq.attr,
2986 * Sync both the hw and sw blocking state of all switches
2988 static void tpacpi_send_radiosw_update(void)
2993 * We must sync all rfkill controllers *before* issuing any
2994 * rfkill input events, or we will race the rfkill core input
2997 * tpacpi_inputdev_send_mutex works as a syncronization point
3000 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3003 wlsw = hotkey_get_wlsw();
3005 /* Sync hw blocking state first if it is hw-blocked */
3006 if (wlsw == TPACPI_RFK_RADIO_OFF)
3007 tpacpi_rfk_update_hwblock_state(true);
3009 /* Sync sw blocking state */
3010 tpacpi_rfk_update_swstate_all();
3012 /* Sync hw blocking state last if it is hw-unblocked */
3013 if (wlsw == TPACPI_RFK_RADIO_ON)
3014 tpacpi_rfk_update_hwblock_state(false);
3016 /* Issue rfkill input event for WLSW switch */
3018 mutex_lock(&tpacpi_inputdev_send_mutex);
3020 input_report_switch(tpacpi_inputdev,
3021 SW_RFKILL_ALL, (wlsw > 0));
3022 input_sync(tpacpi_inputdev);
3024 mutex_unlock(&tpacpi_inputdev_send_mutex);
3028 * this can be unconditional, as we will poll state again
3029 * if userspace uses the notify to read data
3031 hotkey_radio_sw_notify_change();
3034 static void hotkey_exit(void)
3036 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3037 mutex_lock(&hotkey_mutex);
3038 hotkey_poll_stop_sync();
3039 mutex_unlock(&hotkey_mutex);
3042 if (hotkey_dev_attributes)
3043 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3045 kfree(hotkey_keycode_map);
3047 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3048 "restoring original HKEY status and mask\n");
3049 /* yes, there is a bitwise or below, we want the
3050 * functions to be called even if one of them fail */
3051 if (((tp_features.hotkey_mask &&
3052 hotkey_mask_set(hotkey_orig_mask)) |
3053 hotkey_status_set(false)) != 0)
3055 "failed to restore hot key mask "
3056 "to BIOS defaults\n");
3059 static void __init hotkey_unmap(const unsigned int scancode)
3061 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3062 clear_bit(hotkey_keycode_map[scancode],
3063 tpacpi_inputdev->keybit);
3064 hotkey_keycode_map[scancode] = KEY_RESERVED;
3070 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3073 #define TPACPI_HK_Q_INIMASK 0x0001
3075 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3076 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3077 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3078 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3079 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3080 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3081 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3082 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3083 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3084 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3085 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3086 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3087 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3088 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3089 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3090 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3091 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3092 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3093 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3094 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3097 typedef u16 tpacpi_keymap_entry_t;
3098 typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3100 static int __init hotkey_init(struct ibm_init_struct *iibm)
3102 /* Requirements for changing the default keymaps:
3104 * 1. Many of the keys are mapped to KEY_RESERVED for very
3105 * good reasons. Do not change them unless you have deep
3106 * knowledge on the IBM and Lenovo ThinkPad firmware for
3107 * the various ThinkPad models. The driver behaves
3108 * differently for KEY_RESERVED: such keys have their
3109 * hot key mask *unset* in mask_recommended, and also
3110 * in the initial hot key mask programmed into the
3111 * firmware at driver load time, which means the firm-
3112 * ware may react very differently if you change them to
3115 * 2. You must be subscribed to the linux-thinkpad and
3116 * ibm-acpi-devel mailing lists, and you should read the
3117 * list archives since 2007 if you want to change the
3118 * keymaps. This requirement exists so that you will
3119 * know the past history of problems with the thinkpad-
3120 * acpi driver keymaps, and also that you will be
3121 * listening to any bug reports;
3123 * 3. Do not send thinkpad-acpi specific patches directly to
3124 * for merging, *ever*. Send them to the linux-acpi
3125 * mailinglist for comments. Merging is to be done only
3126 * through acpi-test and the ACPI maintainer.
3128 * If the above is too much to ask, don't change the keymap.
3129 * Ask the thinkpad-acpi maintainer to do it, instead.
3133 TPACPI_KEYMAP_IBM_GENERIC = 0,
3134 TPACPI_KEYMAP_LENOVO_GENERIC,
3137 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3138 /* Generic keymap for IBM ThinkPads */
3139 [TPACPI_KEYMAP_IBM_GENERIC] = {
3140 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3141 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3142 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3143 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3145 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3146 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3147 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3148 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3150 /* brightness: firmware always reacts to them */
3151 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3152 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3154 /* Thinklight: firmware always react to it */
3155 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3157 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3158 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3160 /* Volume: firmware always react to it and reprograms
3161 * the built-in *extra* mixer. Never map it to control
3162 * another mixer by default. */
3163 KEY_RESERVED, /* 0x14: VOLUME UP */
3164 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3165 KEY_RESERVED, /* 0x16: MUTE */
3167 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3169 /* (assignments unknown, please report if found) */
3170 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3171 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3174 /* Generic keymap for Lenovo ThinkPads */
3175 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3176 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3177 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3178 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3179 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3181 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3182 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3183 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3184 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3186 /* These should be enabled --only-- when ACPI video
3187 * is disabled (i.e. in "vendor" mode), and are handled
3188 * in a special way by the init code */
3189 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3190 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3192 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3194 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3195 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3197 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3198 * react to it and reprograms the built-in *extra* mixer.
3199 * Never map it to control another mixer by default.
3201 * T60?, T61, R60?, R61: firmware and EC tries to send
3202 * these over the regular keyboard, so these are no-ops,
3203 * but there are still weird bugs re. MUTE, so do not
3204 * change unless you get test reports from all Lenovo
3205 * models. May cause the BIOS to interfere with the
3208 KEY_RESERVED, /* 0x14: VOLUME UP */
3209 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3210 KEY_RESERVED, /* 0x16: MUTE */
3212 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3214 /* (assignments unknown, please report if found) */
3215 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3216 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3220 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3221 /* Generic maps (fallback) */
3223 .vendor = PCI_VENDOR_ID_IBM,
3224 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3225 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3228 .vendor = PCI_VENDOR_ID_LENOVO,
3229 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3230 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3234 #define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3235 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3240 bool radiosw_state = false;
3241 bool tabletsw_state = false;
3243 unsigned long quirks;
3244 unsigned long keymap_id;
3246 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3247 "initializing hotkey subdriver\n");
3249 BUG_ON(!tpacpi_inputdev);
3250 BUG_ON(tpacpi_inputdev->open != NULL ||
3251 tpacpi_inputdev->close != NULL);
3253 TPACPI_ACPIHANDLE_INIT(hkey);
3254 mutex_init(&hotkey_mutex);
3256 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3257 mutex_init(&hotkey_thread_mutex);
3258 mutex_init(&hotkey_thread_data_mutex);
3261 /* hotkey not supported on 570 */
3262 tp_features.hotkey = hkey_handle != NULL;
3264 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3266 str_supported(tp_features.hotkey));
3268 if (!tp_features.hotkey)
3271 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3272 ARRAY_SIZE(tpacpi_hotkey_qtable));
3274 tpacpi_disable_brightness_delay();
3276 /* MUST have enough space for all attributes to be added to
3277 * hotkey_dev_attributes */
3278 hotkey_dev_attributes = create_attr_set(
3279 ARRAY_SIZE(hotkey_attributes) + 2,
3281 if (!hotkey_dev_attributes)
3283 res = add_many_to_attr_set(hotkey_dev_attributes,
3285 ARRAY_SIZE(hotkey_attributes));
3289 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3290 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3291 for HKEY interface version 0x100 */
3292 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3293 if ((hkeyv >> 8) != 1) {
3294 printk(TPACPI_ERR "unknown version of the "
3295 "HKEY interface: 0x%x\n", hkeyv);
3296 printk(TPACPI_ERR "please report this to %s\n",
3300 * MHKV 0x100 in A31, R40, R40e,
3301 * T4x, X31, and later
3303 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3304 "firmware HKEY interface version: 0x%x\n",
3307 /* Paranoia check AND init hotkey_all_mask */
3308 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3311 "missing MHKA handler, "
3312 "please report this to %s\n",
3314 /* Fallback: pre-init for FN+F3,F4,F12 */
3315 hotkey_all_mask = 0x080cU;
3317 tp_features.hotkey_mask = 1;
3322 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3323 "hotkey masks are %s\n",
3324 str_supported(tp_features.hotkey_mask));
3326 /* Init hotkey_all_mask if not initialized yet */
3327 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3328 (quirks & TPACPI_HK_Q_INIMASK))
3329 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3331 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3332 if (tp_features.hotkey_mask) {
3333 /* hotkey_source_mask *must* be zero for
3334 * the first hotkey_mask_get to return hotkey_orig_mask */
3335 res = hotkey_mask_get();
3339 hotkey_orig_mask = hotkey_acpi_mask;
3341 hotkey_orig_mask = hotkey_all_mask;
3342 hotkey_acpi_mask = hotkey_all_mask;
3345 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3347 tp_features.hotkey_wlsw = 1;
3348 radiosw_state = !!tpacpi_wlsw_emulstate;
3350 "radio switch emulation enabled\n");
3353 /* Not all thinkpads have a hardware radio switch */
3354 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3355 tp_features.hotkey_wlsw = 1;
3356 radiosw_state = !!status;
3358 "radio switch found; radios are %s\n",
3359 enabled(status, 0));
3361 if (tp_features.hotkey_wlsw)
3362 res = add_to_attr_set(hotkey_dev_attributes,
3363 &dev_attr_hotkey_radio_sw.attr);
3365 /* For X41t, X60t, X61t Tablets... */
3366 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3367 tp_features.hotkey_tablet = 1;
3368 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3370 "possible tablet mode switch found; "
3371 "ThinkPad in %s mode\n",
3372 (tabletsw_state) ? "tablet" : "laptop");
3373 res = add_to_attr_set(hotkey_dev_attributes,
3374 &dev_attr_hotkey_tablet_mode.attr);
3378 res = register_attr_set_with_sysfs(
3379 hotkey_dev_attributes,
3380 &tpacpi_pdev->dev.kobj);
3384 /* Set up key map */
3385 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3387 if (!hotkey_keycode_map) {
3389 "failed to allocate memory for key map\n");
3394 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3395 ARRAY_SIZE(tpacpi_keymap_qtable));
3396 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3397 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3398 "using keymap number %lu\n", keymap_id);
3400 memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3401 TPACPI_HOTKEY_MAP_SIZE);
3403 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3404 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3405 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3406 tpacpi_inputdev->keycode = hotkey_keycode_map;
3407 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3408 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3409 input_set_capability(tpacpi_inputdev, EV_KEY,
3410 hotkey_keycode_map[i]);
3412 if (i < sizeof(hotkey_reserved_mask)*8)
3413 hotkey_reserved_mask |= 1 << i;
3417 if (tp_features.hotkey_wlsw) {
3418 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3419 input_report_switch(tpacpi_inputdev,
3420 SW_RFKILL_ALL, radiosw_state);
3422 if (tp_features.hotkey_tablet) {
3423 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3424 input_report_switch(tpacpi_inputdev,
3425 SW_TABLET_MODE, tabletsw_state);
3428 /* Do not issue duplicate brightness change events to
3429 * userspace. tpacpi_detect_brightness_capabilities() must have
3430 * been called before this point */
3431 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3433 "This ThinkPad has standard ACPI backlight "
3434 "brightness control, supported by the ACPI "
3436 printk(TPACPI_NOTICE
3437 "Disabling thinkpad-acpi brightness events "
3440 /* Disable brightness up/down on Lenovo thinkpads when
3441 * ACPI is handling them, otherwise it is plain impossible
3442 * for userspace to do something even remotely sane */
3443 hotkey_reserved_mask |=
3444 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3445 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3446 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3447 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3450 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3451 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3453 & ~hotkey_reserved_mask;
3455 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3456 "hotkey source mask 0x%08x, polling freq %u\n",
3457 hotkey_source_mask, hotkey_poll_freq);
3460 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3461 "enabling firmware HKEY event interface...\n");
3462 res = hotkey_status_set(true);
3467 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3468 | hotkey_driver_mask)
3469 & ~hotkey_source_mask);
3470 if (res < 0 && res != -ENXIO) {
3474 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3475 & ~hotkey_reserved_mask;
3476 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3477 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3478 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3480 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3481 "legacy ibm/hotkey event reporting over procfs %s\n",
3482 (hotkey_report_mode < 2) ?
3483 "enabled" : "disabled");
3485 tpacpi_inputdev->open = &hotkey_inputdev_open;
3486 tpacpi_inputdev->close = &hotkey_inputdev_close;
3488 hotkey_poll_setup_safe(true);
3493 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3494 hotkey_dev_attributes = NULL;
3496 return (res < 0)? res : 1;
3499 static bool hotkey_notify_hotkey(const u32 hkey,
3501 bool *ignore_acpi_ev)
3503 /* 0x1000-0x1FFF: key presses */
3504 unsigned int scancode = hkey & 0xfff;
3505 *send_acpi_ev = true;
3506 *ignore_acpi_ev = false;
3508 /* HKEY event 0x1001 is scancode 0x00 */
3509 if (scancode > 0 && scancode <= TPACPI_HOTKEY_MAP_LEN) {
3511 if (!(hotkey_source_mask & (1 << scancode))) {
3512 tpacpi_input_send_key_masked(scancode);
3513 *send_acpi_ev = false;
3515 *ignore_acpi_ev = true;
3522 static bool hotkey_notify_wakeup(const u32 hkey,
3524 bool *ignore_acpi_ev)
3526 /* 0x2000-0x2FFF: Wakeup reason */
3527 *send_acpi_ev = true;
3528 *ignore_acpi_ev = false;
3531 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3532 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3533 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3534 *ignore_acpi_ev = true;
3537 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3538 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3539 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3540 *ignore_acpi_ev = true;
3543 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3544 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3546 "EMERGENCY WAKEUP: battery almost empty\n");
3547 /* how to auto-heal: */
3548 /* 2313: woke up from S3, go to S4/S5 */
3549 /* 2413: woke up from S4, go to S5 */
3556 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3558 "woke up due to a hot-unplug "
3560 hotkey_wakeup_reason_notify_change();
3565 static bool hotkey_notify_usrevent(const u32 hkey,
3567 bool *ignore_acpi_ev)
3569 /* 0x5000-0x5FFF: human interface helpers */
3570 *send_acpi_ev = true;
3571 *ignore_acpi_ev = false;
3574 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3575 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3578 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3579 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3580 tpacpi_input_send_tabletsw();
3581 hotkey_tablet_mode_notify_change();
3582 *send_acpi_ev = false;
3585 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3586 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3587 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3588 /* do not propagate these events */
3589 *ignore_acpi_ev = true;
3597 static void thermal_dump_all_sensors(void);
3599 static bool hotkey_notify_thermal(const u32 hkey,
3601 bool *ignore_acpi_ev)
3605 /* 0x6000-0x6FFF: thermal alarms */
3606 *send_acpi_ev = true;
3607 *ignore_acpi_ev = false;
3610 case TP_HKEY_EV_THM_TABLE_CHANGED:
3612 "EC reports that Thermal Table has changed\n");
3613 /* recommended action: do nothing, we don't have
3614 * Lenovo ATM information */
3616 case TP_HKEY_EV_ALARM_BAT_HOT:
3618 "THERMAL ALARM: battery is too hot!\n");
3619 /* recommended action: warn user through gui */
3621 case TP_HKEY_EV_ALARM_BAT_XHOT:
3623 "THERMAL EMERGENCY: battery is extremely hot!\n");
3624 /* recommended action: immediate sleep/hibernate */
3626 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3629 "a sensor reports something is too hot!\n");
3630 /* recommended action: warn user through gui, that */
3631 /* some internal component is too hot */
3633 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3635 "THERMAL EMERGENCY: "
3636 "a sensor reports something is extremely hot!\n");
3637 /* recommended action: immediate sleep/hibernate */
3641 "THERMAL ALERT: unknown thermal alarm received\n");
3645 thermal_dump_all_sensors();
3650 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3654 bool ignore_acpi_ev;
3657 if (event != 0x80) {
3659 "unknown HKEY notification event %d\n", event);
3660 /* forward it to userspace, maybe it knows how to handle it */
3661 acpi_bus_generate_netlink_event(
3662 ibm->acpi->device->pnp.device_class,
3663 dev_name(&ibm->acpi->device->dev),
3669 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3670 printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3679 send_acpi_ev = true;
3680 ignore_acpi_ev = false;
3682 switch (hkey >> 12) {
3684 /* 0x1000-0x1FFF: key presses */
3685 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3689 /* 0x2000-0x2FFF: Wakeup reason */
3690 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3694 /* 0x3000-0x3FFF: bay-related wakeups */
3696 case TP_HKEY_EV_BAYEJ_ACK:
3697 hotkey_autosleep_ack = 1;
3700 hotkey_wakeup_hotunplug_complete_notify_change();
3703 case TP_HKEY_EV_OPTDRV_EJ:
3704 /* FIXME: kick libata if SATA link offline */
3712 /* 0x4000-0x4FFF: dock-related wakeups */
3713 if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3714 hotkey_autosleep_ack = 1;
3717 hotkey_wakeup_hotunplug_complete_notify_change();
3724 /* 0x5000-0x5FFF: human interface helpers */
3725 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3729 /* 0x6000-0x6FFF: thermal alarms */
3730 known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3734 /* 0x7000-0x7FFF: misc */
3735 if (tp_features.hotkey_wlsw &&
3736 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3737 tpacpi_send_radiosw_update();
3742 /* fallthrough to default */
3747 printk(TPACPI_NOTICE
3748 "unhandled HKEY event 0x%04x\n", hkey);
3749 printk(TPACPI_NOTICE
3750 "please report the conditions when this "
3751 "event happened to %s\n", TPACPI_MAIL);
3755 if (!ignore_acpi_ev &&
3756 (send_acpi_ev || hotkey_report_mode < 2)) {
3757 acpi_bus_generate_proc_event(ibm->acpi->device,
3761 /* netlink events */
3762 if (!ignore_acpi_ev && send_acpi_ev) {
3763 acpi_bus_generate_netlink_event(
3764 ibm->acpi->device->pnp.device_class,
3765 dev_name(&ibm->acpi->device->dev),
3771 static void hotkey_suspend(pm_message_t state)
3773 /* Do these on suspend, we get the events on early resume! */
3774 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3775 hotkey_autosleep_ack = 0;
3778 static void hotkey_resume(void)
3780 tpacpi_disable_brightness_delay();
3782 if (hotkey_status_set(true) < 0 ||
3783 hotkey_mask_set(hotkey_acpi_mask) < 0)
3785 "error while attempting to reset the event "
3786 "firmware interface\n");
3788 tpacpi_send_radiosw_update();
3789 hotkey_tablet_mode_notify_change();
3790 hotkey_wakeup_reason_notify_change();
3791 hotkey_wakeup_hotunplug_complete_notify_change();
3792 hotkey_poll_setup_safe(false);
3795 /* procfs -------------------------------------------------------------- */
3796 static int hotkey_read(struct seq_file *m)
3800 if (!tp_features.hotkey) {
3801 seq_printf(m, "status:\t\tnot supported\n");
3805 if (mutex_lock_killable(&hotkey_mutex))
3806 return -ERESTARTSYS;
3807 res = hotkey_status_get(&status);
3809 res = hotkey_mask_get();
3810 mutex_unlock(&hotkey_mutex);
3814 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3815 if (hotkey_all_mask) {
3816 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3817 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3819 seq_printf(m, "mask:\t\tnot supported\n");
3820 seq_printf(m, "commands:\tenable, disable, reset\n");
3826 static void hotkey_enabledisable_warn(bool enable)
3828 tpacpi_log_usertask("procfs hotkey enable/disable");
3829 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3831 "hotkey enable/disable functionality has been "
3832 "removed from the driver. Hotkeys are always "
3835 "Please remove the hotkey=enable module "
3836 "parameter, it is deprecated. Hotkeys are always "
3840 static int hotkey_write(char *buf)
3846 if (!tp_features.hotkey)
3849 if (mutex_lock_killable(&hotkey_mutex))
3850 return -ERESTARTSYS;
3852 mask = hotkey_user_mask;
3855 while ((cmd = next_cmd(&buf))) {
3856 if (strlencmp(cmd, "enable") == 0) {
3857 hotkey_enabledisable_warn(1);
3858 } else if (strlencmp(cmd, "disable") == 0) {
3859 hotkey_enabledisable_warn(0);
3861 } else if (strlencmp(cmd, "reset") == 0) {
3862 mask = (hotkey_all_mask | hotkey_source_mask)
3863 & ~hotkey_reserved_mask;
3864 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3866 } else if (sscanf(cmd, "%x", &mask) == 1) {
3875 tpacpi_disclose_usertask("procfs hotkey",
3876 "set mask to 0x%08x\n", mask);
3877 res = hotkey_user_mask_set(mask);
3881 mutex_unlock(&hotkey_mutex);
3885 static const struct acpi_device_id ibm_htk_device_ids[] = {
3886 {TPACPI_ACPI_HKEY_HID, 0},
3890 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3891 .hid = ibm_htk_device_ids,
3892 .notify = hotkey_notify,
3893 .handle = &hkey_handle,
3894 .type = ACPI_DEVICE_NOTIFY,
3897 static struct ibm_struct hotkey_driver_data = {
3899 .read = hotkey_read,
3900 .write = hotkey_write,
3901 .exit = hotkey_exit,
3902 .resume = hotkey_resume,
3903 .suspend = hotkey_suspend,
3904 .acpi = &ibm_hotkey_acpidriver,
3907 /*************************************************************************
3908 * Bluetooth subdriver
3912 /* ACPI GBDC/SBDC bits */
3913 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3914 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3915 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3916 0 = disable, 1 = enable */
3920 /* ACPI \BLTH commands */
3921 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3922 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3923 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3924 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3925 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3928 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3930 static int bluetooth_get_status(void)
3934 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3935 if (dbg_bluetoothemul)
3936 return (tpacpi_bluetooth_emulstate) ?
3937 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3940 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3943 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3944 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3947 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3951 vdbg_printk(TPACPI_DBG_RFKILL,
3952 "will attempt to %s bluetooth\n",
3953 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3955 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3956 if (dbg_bluetoothemul) {
3957 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3962 if (state == TPACPI_RFK_RADIO_ON)
3963 status = TP_ACPI_BLUETOOTH_RADIOSSW
3964 | TP_ACPI_BLUETOOTH_RESUMECTRL;
3968 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3974 /* sysfs bluetooth enable ---------------------------------------------- */
3975 static ssize_t bluetooth_enable_show(struct device *dev,
3976 struct device_attribute *attr,
3979 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3983 static ssize_t bluetooth_enable_store(struct device *dev,
3984 struct device_attribute *attr,
3985 const char *buf, size_t count)
3987 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3991 static struct device_attribute dev_attr_bluetooth_enable =
3992 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3993 bluetooth_enable_show, bluetooth_enable_store);
3995 /* --------------------------------------------------------------------- */
3997 static struct attribute *bluetooth_attributes[] = {
3998 &dev_attr_bluetooth_enable.attr,
4002 static const struct attribute_group bluetooth_attr_group = {
4003 .attrs = bluetooth_attributes,
4006 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4007 .get_status = bluetooth_get_status,
4008 .set_status = bluetooth_set_status,
4011 static void bluetooth_shutdown(void)
4013 /* Order firmware to save current state to NVRAM */
4014 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4015 TP_ACPI_BLTH_SAVE_STATE))
4016 printk(TPACPI_NOTICE
4017 "failed to save bluetooth state to NVRAM\n");
4019 vdbg_printk(TPACPI_DBG_RFKILL,
4020 "bluestooth state saved to NVRAM\n");
4023 static void bluetooth_exit(void)
4025 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4026 &bluetooth_attr_group);
4028 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4030 bluetooth_shutdown();
4033 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4038 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4039 "initializing bluetooth subdriver\n");
4041 TPACPI_ACPIHANDLE_INIT(hkey);
4043 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4044 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4045 tp_features.bluetooth = hkey_handle &&
4046 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4048 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4049 "bluetooth is %s, status 0x%02x\n",
4050 str_supported(tp_features.bluetooth),
4053 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4054 if (dbg_bluetoothemul) {
4055 tp_features.bluetooth = 1;
4057 "bluetooth switch emulation enabled\n");
4060 if (tp_features.bluetooth &&
4061 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4062 /* no bluetooth hardware present in system */
4063 tp_features.bluetooth = 0;
4064 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4065 "bluetooth hardware not installed\n");
4068 if (!tp_features.bluetooth)
4071 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4072 &bluetooth_tprfk_ops,
4073 RFKILL_TYPE_BLUETOOTH,
4074 TPACPI_RFK_BLUETOOTH_SW_NAME,
4079 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4080 &bluetooth_attr_group);
4082 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4089 /* procfs -------------------------------------------------------------- */
4090 static int bluetooth_read(struct seq_file *m)
4092 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4095 static int bluetooth_write(char *buf)
4097 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4100 static struct ibm_struct bluetooth_driver_data = {
4101 .name = "bluetooth",
4102 .read = bluetooth_read,
4103 .write = bluetooth_write,
4104 .exit = bluetooth_exit,
4105 .shutdown = bluetooth_shutdown,
4108 /*************************************************************************
4113 /* ACPI GWAN/SWAN bits */
4114 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4115 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4116 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4117 0 = disable, 1 = enable */
4120 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4122 static int wan_get_status(void)
4126 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4128 return (tpacpi_wwan_emulstate) ?
4129 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4132 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4135 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4136 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4139 static int wan_set_status(enum tpacpi_rfkill_state state)
4143 vdbg_printk(TPACPI_DBG_RFKILL,
4144 "will attempt to %s wwan\n",
4145 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4147 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4149 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4154 if (state == TPACPI_RFK_RADIO_ON)
4155 status = TP_ACPI_WANCARD_RADIOSSW
4156 | TP_ACPI_WANCARD_RESUMECTRL;
4160 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4166 /* sysfs wan enable ---------------------------------------------------- */
4167 static ssize_t wan_enable_show(struct device *dev,
4168 struct device_attribute *attr,
4171 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4175 static ssize_t wan_enable_store(struct device *dev,
4176 struct device_attribute *attr,
4177 const char *buf, size_t count)
4179 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4183 static struct device_attribute dev_attr_wan_enable =
4184 __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4185 wan_enable_show, wan_enable_store);
4187 /* --------------------------------------------------------------------- */
4189 static struct attribute *wan_attributes[] = {
4190 &dev_attr_wan_enable.attr,
4194 static const struct attribute_group wan_attr_group = {
4195 .attrs = wan_attributes,
4198 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4199 .get_status = wan_get_status,
4200 .set_status = wan_set_status,
4203 static void wan_shutdown(void)
4205 /* Order firmware to save current state to NVRAM */
4206 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4207 TP_ACPI_WGSV_SAVE_STATE))
4208 printk(TPACPI_NOTICE
4209 "failed to save WWAN state to NVRAM\n");
4211 vdbg_printk(TPACPI_DBG_RFKILL,
4212 "WWAN state saved to NVRAM\n");
4215 static void wan_exit(void)
4217 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4220 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4225 static int __init wan_init(struct ibm_init_struct *iibm)
4230 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4231 "initializing wan subdriver\n");
4233 TPACPI_ACPIHANDLE_INIT(hkey);
4235 tp_features.wan = hkey_handle &&
4236 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4238 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4239 "wan is %s, status 0x%02x\n",
4240 str_supported(tp_features.wan),
4243 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4245 tp_features.wan = 1;
4247 "wwan switch emulation enabled\n");
4250 if (tp_features.wan &&
4251 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4252 /* no wan hardware present in system */
4253 tp_features.wan = 0;
4254 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4255 "wan hardware not installed\n");
4258 if (!tp_features.wan)
4261 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4264 TPACPI_RFK_WWAN_SW_NAME,
4269 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4273 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4280 /* procfs -------------------------------------------------------------- */
4281 static int wan_read(struct seq_file *m)
4283 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4286 static int wan_write(char *buf)
4288 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4291 static struct ibm_struct wan_driver_data = {
4296 .shutdown = wan_shutdown,
4299 /*************************************************************************
4304 /* ACPI GUWB/SUWB bits */
4305 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4306 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4309 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4311 static int uwb_get_status(void)
4315 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4317 return (tpacpi_uwb_emulstate) ?
4318 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4321 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4324 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4325 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4328 static int uwb_set_status(enum tpacpi_rfkill_state state)
4332 vdbg_printk(TPACPI_DBG_RFKILL,
4333 "will attempt to %s UWB\n",
4334 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4336 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4338 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4343 if (state == TPACPI_RFK_RADIO_ON)
4344 status = TP_ACPI_UWB_RADIOSSW;
4348 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4354 /* --------------------------------------------------------------------- */
4356 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4357 .get_status = uwb_get_status,
4358 .set_status = uwb_set_status,
4361 static void uwb_exit(void)
4363 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4366 static int __init uwb_init(struct ibm_init_struct *iibm)
4371 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4372 "initializing uwb subdriver\n");
4374 TPACPI_ACPIHANDLE_INIT(hkey);
4376 tp_features.uwb = hkey_handle &&
4377 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4379 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4380 "uwb is %s, status 0x%02x\n",
4381 str_supported(tp_features.uwb),
4384 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4386 tp_features.uwb = 1;
4388 "uwb switch emulation enabled\n");
4391 if (tp_features.uwb &&
4392 !(status & TP_ACPI_UWB_HWPRESENT)) {
4393 /* no uwb hardware present in system */
4394 tp_features.uwb = 0;
4395 dbg_printk(TPACPI_DBG_INIT,
4396 "uwb hardware not installed\n");
4399 if (!tp_features.uwb)
4402 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4405 TPACPI_RFK_UWB_SW_NAME,
4410 static struct ibm_struct uwb_driver_data = {
4413 .flags.experimental = 1,
4416 /*************************************************************************
4420 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4422 enum video_access_mode {
4423 TPACPI_VIDEO_NONE = 0,
4424 TPACPI_VIDEO_570, /* 570 */
4425 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4426 TPACPI_VIDEO_NEW, /* all others */
4429 enum { /* video status flags, based on VIDEO_570 */
4430 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4431 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4432 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4435 enum { /* TPACPI_VIDEO_570 constants */
4436 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4437 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4438 * video_status_flags */
4439 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4440 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4443 static enum video_access_mode video_supported;
4444 static int video_orig_autosw;
4446 static int video_autosw_get(void);
4447 static int video_autosw_set(int enable);
4449 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4451 static int __init video_init(struct ibm_init_struct *iibm)
4455 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4457 TPACPI_ACPIHANDLE_INIT(vid);
4458 if (tpacpi_is_ibm())
4459 TPACPI_ACPIHANDLE_INIT(vid2);
4461 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4462 /* G41, assume IVGA doesn't change */
4463 vid_handle = vid2_handle;
4466 /* video switching not supported on R30, R31 */
4467 video_supported = TPACPI_VIDEO_NONE;
4468 else if (tpacpi_is_ibm() &&
4469 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4471 video_supported = TPACPI_VIDEO_570;
4472 else if (tpacpi_is_ibm() &&
4473 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4474 /* 600e/x, 770e, 770x */
4475 video_supported = TPACPI_VIDEO_770;
4478 video_supported = TPACPI_VIDEO_NEW;
4480 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4481 str_supported(video_supported != TPACPI_VIDEO_NONE),
4484 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4487 static void video_exit(void)
4489 dbg_printk(TPACPI_DBG_EXIT,
4490 "restoring original video autoswitch mode\n");
4491 if (video_autosw_set(video_orig_autosw))
4492 printk(TPACPI_ERR "error while trying to restore original "
4493 "video autoswitch mode\n");
4496 static int video_outputsw_get(void)
4501 switch (video_supported) {
4502 case TPACPI_VIDEO_570:
4503 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4504 TP_ACPI_VIDEO_570_PHSCMD))
4506 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4508 case TPACPI_VIDEO_770:
4509 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4512 status |= TP_ACPI_VIDEO_S_LCD;
4513 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4516 status |= TP_ACPI_VIDEO_S_CRT;
4518 case TPACPI_VIDEO_NEW:
4519 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4520 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4523 status |= TP_ACPI_VIDEO_S_CRT;
4525 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4526 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4529 status |= TP_ACPI_VIDEO_S_LCD;
4530 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4533 status |= TP_ACPI_VIDEO_S_DVI;
4542 static int video_outputsw_set(int status)
4547 switch (video_supported) {
4548 case TPACPI_VIDEO_570:
4549 res = acpi_evalf(NULL, NULL,
4550 "\\_SB.PHS2", "vdd",
4551 TP_ACPI_VIDEO_570_PHS2CMD,
4552 status | TP_ACPI_VIDEO_570_PHS2SET);
4554 case TPACPI_VIDEO_770:
4555 autosw = video_autosw_get();
4559 res = video_autosw_set(1);
4562 res = acpi_evalf(vid_handle, NULL,
4563 "ASWT", "vdd", status * 0x100, 0);
4564 if (!autosw && video_autosw_set(autosw)) {
4566 "video auto-switch left enabled due to error\n");
4570 case TPACPI_VIDEO_NEW:
4571 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4572 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4578 return (res)? 0 : -EIO;
4581 static int video_autosw_get(void)
4585 switch (video_supported) {
4586 case TPACPI_VIDEO_570:
4587 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4590 case TPACPI_VIDEO_770:
4591 case TPACPI_VIDEO_NEW:
4592 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4602 static int video_autosw_set(int enable)
4604 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4609 static int video_outputsw_cycle(void)
4611 int autosw = video_autosw_get();
4617 switch (video_supported) {
4618 case TPACPI_VIDEO_570:
4619 res = video_autosw_set(1);
4622 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4624 case TPACPI_VIDEO_770:
4625 case TPACPI_VIDEO_NEW:
4626 res = video_autosw_set(1);
4629 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4634 if (!autosw && video_autosw_set(autosw)) {
4636 "video auto-switch left enabled due to error\n");
4640 return (res)? 0 : -EIO;
4643 static int video_expand_toggle(void)
4645 switch (video_supported) {
4646 case TPACPI_VIDEO_570:
4647 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4649 case TPACPI_VIDEO_770:
4650 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4652 case TPACPI_VIDEO_NEW:
4653 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4661 static int video_read(struct seq_file *m)
4665 if (video_supported == TPACPI_VIDEO_NONE) {
4666 seq_printf(m, "status:\t\tnot supported\n");
4670 /* Even reads can crash X.org, so... */
4671 if (!capable(CAP_SYS_ADMIN))
4674 status = video_outputsw_get();
4678 autosw = video_autosw_get();
4682 seq_printf(m, "status:\t\tsupported\n");
4683 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4684 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4685 if (video_supported == TPACPI_VIDEO_NEW)
4686 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4687 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4688 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4689 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4690 if (video_supported == TPACPI_VIDEO_NEW)
4691 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4692 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4693 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4698 static int video_write(char *buf)
4701 int enable, disable, status;
4704 if (video_supported == TPACPI_VIDEO_NONE)
4707 /* Even reads can crash X.org, let alone writes... */
4708 if (!capable(CAP_SYS_ADMIN))
4714 while ((cmd = next_cmd(&buf))) {
4715 if (strlencmp(cmd, "lcd_enable") == 0) {
4716 enable |= TP_ACPI_VIDEO_S_LCD;
4717 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4718 disable |= TP_ACPI_VIDEO_S_LCD;
4719 } else if (strlencmp(cmd, "crt_enable") == 0) {
4720 enable |= TP_ACPI_VIDEO_S_CRT;
4721 } else if (strlencmp(cmd, "crt_disable") == 0) {
4722 disable |= TP_ACPI_VIDEO_S_CRT;
4723 } else if (video_supported == TPACPI_VIDEO_NEW &&
4724 strlencmp(cmd, "dvi_enable") == 0) {
4725 enable |= TP_ACPI_VIDEO_S_DVI;
4726 } else if (video_supported == TPACPI_VIDEO_NEW &&
4727 strlencmp(cmd, "dvi_disable") == 0) {
4728 disable |= TP_ACPI_VIDEO_S_DVI;
4729 } else if (strlencmp(cmd, "auto_enable") == 0) {
4730 res = video_autosw_set(1);
4733 } else if (strlencmp(cmd, "auto_disable") == 0) {
4734 res = video_autosw_set(0);
4737 } else if (strlencmp(cmd, "video_switch") == 0) {
4738 res = video_outputsw_cycle();
4741 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4742 res = video_expand_toggle();
4749 if (enable || disable) {
4750 status = video_outputsw_get();
4753 res = video_outputsw_set((status & ~disable) | enable);
4761 static struct ibm_struct video_driver_data = {
4764 .write = video_write,
4768 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4770 /*************************************************************************
4771 * Light (thinklight) subdriver
4774 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4775 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4777 static int light_get_status(void)
4781 if (tp_features.light_status) {
4782 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4790 static int light_set_status(int status)
4794 if (tp_features.light) {
4796 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4798 TP_CMOS_THINKLIGHT_ON :
4799 TP_CMOS_THINKLIGHT_OFF);
4801 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4804 return (rc)? 0 : -EIO;
4810 static void light_set_status_worker(struct work_struct *work)
4812 struct tpacpi_led_classdev *data =
4813 container_of(work, struct tpacpi_led_classdev, work);
4815 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4816 light_set_status((data->new_state != TPACPI_LED_OFF));
4819 static void light_sysfs_set(struct led_classdev *led_cdev,
4820 enum led_brightness brightness)
4822 struct tpacpi_led_classdev *data =
4823 container_of(led_cdev,
4824 struct tpacpi_led_classdev,
4826 data->new_state = (brightness != LED_OFF) ?
4827 TPACPI_LED_ON : TPACPI_LED_OFF;
4828 queue_work(tpacpi_wq, &data->work);
4831 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4833 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4836 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4838 .name = "tpacpi::thinklight",
4839 .brightness_set = &light_sysfs_set,
4840 .brightness_get = &light_sysfs_get,
4844 static int __init light_init(struct ibm_init_struct *iibm)
4848 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4850 if (tpacpi_is_ibm()) {
4851 TPACPI_ACPIHANDLE_INIT(ledb);
4852 TPACPI_ACPIHANDLE_INIT(lght);
4854 TPACPI_ACPIHANDLE_INIT(cmos);
4855 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4857 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4858 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4860 if (tp_features.light)
4861 /* light status not supported on
4862 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4863 tp_features.light_status =
4864 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4866 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4867 str_supported(tp_features.light),
4868 str_supported(tp_features.light_status));
4870 if (!tp_features.light)
4873 rc = led_classdev_register(&tpacpi_pdev->dev,
4874 &tpacpi_led_thinklight.led_classdev);
4877 tp_features.light = 0;
4878 tp_features.light_status = 0;
4886 static void light_exit(void)
4888 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4889 if (work_pending(&tpacpi_led_thinklight.work))
4890 flush_workqueue(tpacpi_wq);
4893 static int light_read(struct seq_file *m)
4897 if (!tp_features.light) {
4898 seq_printf(m, "status:\t\tnot supported\n");
4899 } else if (!tp_features.light_status) {
4900 seq_printf(m, "status:\t\tunknown\n");
4901 seq_printf(m, "commands:\ton, off\n");
4903 status = light_get_status();
4906 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4907 seq_printf(m, "commands:\ton, off\n");
4913 static int light_write(char *buf)
4918 if (!tp_features.light)
4921 while ((cmd = next_cmd(&buf))) {
4922 if (strlencmp(cmd, "on") == 0) {
4924 } else if (strlencmp(cmd, "off") == 0) {
4930 return light_set_status(newstatus);
4933 static struct ibm_struct light_driver_data = {
4936 .write = light_write,
4940 /*************************************************************************
4944 /* sysfs cmos_command -------------------------------------------------- */
4945 static ssize_t cmos_command_store(struct device *dev,
4946 struct device_attribute *attr,
4947 const char *buf, size_t count)
4949 unsigned long cmos_cmd;
4952 if (parse_strtoul(buf, 21, &cmos_cmd))
4955 res = issue_thinkpad_cmos_command(cmos_cmd);
4956 return (res)? res : count;
4959 static struct device_attribute dev_attr_cmos_command =
4960 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4962 /* --------------------------------------------------------------------- */
4964 static int __init cmos_init(struct ibm_init_struct *iibm)
4968 vdbg_printk(TPACPI_DBG_INIT,
4969 "initializing cmos commands subdriver\n");
4971 TPACPI_ACPIHANDLE_INIT(cmos);
4973 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4974 str_supported(cmos_handle != NULL));
4976 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4980 return (cmos_handle)? 0 : 1;
4983 static void cmos_exit(void)
4985 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4988 static int cmos_read(struct seq_file *m)
4990 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4991 R30, R31, T20-22, X20-21 */
4993 seq_printf(m, "status:\t\tnot supported\n");
4995 seq_printf(m, "status:\t\tsupported\n");
4996 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5002 static int cmos_write(char *buf)
5007 while ((cmd = next_cmd(&buf))) {
5008 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5009 cmos_cmd >= 0 && cmos_cmd <= 21) {
5014 res = issue_thinkpad_cmos_command(cmos_cmd);
5022 static struct ibm_struct cmos_driver_data = {
5025 .write = cmos_write,
5029 /*************************************************************************
5033 enum led_access_mode {
5034 TPACPI_LED_NONE = 0,
5035 TPACPI_LED_570, /* 570 */
5036 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5037 TPACPI_LED_NEW, /* all others */
5040 enum { /* For TPACPI_LED_OLD */
5041 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5042 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5043 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5046 static enum led_access_mode led_supported;
5048 static acpi_handle led_handle;
5050 #define TPACPI_LED_NUMLEDS 16
5051 static struct tpacpi_led_classdev *tpacpi_leds;
5052 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5053 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5054 /* there's a limit of 19 chars + NULL before 2.6.26 */
5056 "tpacpi:orange:batt",
5057 "tpacpi:green:batt",
5058 "tpacpi::dock_active",
5059 "tpacpi::bay_active",
5060 "tpacpi::dock_batt",
5061 "tpacpi::unknown_led",
5063 "tpacpi::dock_status1",
5064 "tpacpi::dock_status2",
5065 "tpacpi::unknown_led2",
5066 "tpacpi::unknown_led3",
5067 "tpacpi::thinkvantage",
5069 #define TPACPI_SAFE_LEDS 0x1081U
5071 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5073 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5076 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5080 static int led_get_status(const unsigned int led)
5083 enum led_status_t led_s;
5085 switch (led_supported) {
5086 case TPACPI_LED_570:
5087 if (!acpi_evalf(ec_handle,
5088 &status, "GLED", "dd", 1 << led))
5090 led_s = (status == 0)?
5095 tpacpi_led_state_cache[led] = led_s;
5104 static int led_set_status(const unsigned int led,
5105 const enum led_status_t ledstatus)
5107 /* off, on, blink. Index is led_status_t */
5108 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5109 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5113 switch (led_supported) {
5114 case TPACPI_LED_570:
5116 if (unlikely(led > 7))
5118 if (unlikely(tpacpi_is_led_restricted(led)))
5120 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5121 (1 << led), led_sled_arg1[ledstatus]))
5124 case TPACPI_LED_OLD:
5125 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5126 if (unlikely(led > 7))
5128 if (unlikely(tpacpi_is_led_restricted(led)))
5130 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5132 rc = ec_write(TPACPI_LED_EC_HLBL,
5133 (ledstatus == TPACPI_LED_BLINK) << led);
5135 rc = ec_write(TPACPI_LED_EC_HLCL,
5136 (ledstatus != TPACPI_LED_OFF) << led);
5138 case TPACPI_LED_NEW:
5140 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5142 if (unlikely(tpacpi_is_led_restricted(led)))
5144 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5145 led, led_led_arg1[ledstatus]))
5153 tpacpi_led_state_cache[led] = ledstatus;
5158 static void led_set_status_worker(struct work_struct *work)
5160 struct tpacpi_led_classdev *data =
5161 container_of(work, struct tpacpi_led_classdev, work);
5163 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5164 led_set_status(data->led, data->new_state);
5167 static void led_sysfs_set(struct led_classdev *led_cdev,
5168 enum led_brightness brightness)
5170 struct tpacpi_led_classdev *data = container_of(led_cdev,
5171 struct tpacpi_led_classdev, led_classdev);
5173 if (brightness == LED_OFF)
5174 data->new_state = TPACPI_LED_OFF;
5175 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5176 data->new_state = TPACPI_LED_ON;
5178 data->new_state = TPACPI_LED_BLINK;
5180 queue_work(tpacpi_wq, &data->work);
5183 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5184 unsigned long *delay_on, unsigned long *delay_off)
5186 struct tpacpi_led_classdev *data = container_of(led_cdev,
5187 struct tpacpi_led_classdev, led_classdev);
5189 /* Can we choose the flash rate? */
5190 if (*delay_on == 0 && *delay_off == 0) {
5191 /* yes. set them to the hardware blink rate (1 Hz) */
5192 *delay_on = 500; /* ms */
5193 *delay_off = 500; /* ms */
5194 } else if ((*delay_on != 500) || (*delay_off != 500))
5197 data->new_state = TPACPI_LED_BLINK;
5198 queue_work(tpacpi_wq, &data->work);
5203 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5207 struct tpacpi_led_classdev *data = container_of(led_cdev,
5208 struct tpacpi_led_classdev, led_classdev);
5210 rc = led_get_status(data->led);
5212 if (rc == TPACPI_LED_OFF || rc < 0)
5213 rc = LED_OFF; /* no error handling in led class :( */
5220 static void led_exit(void)
5224 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5225 if (tpacpi_leds[i].led_classdev.name)
5226 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5232 static int __init tpacpi_init_led(unsigned int led)
5236 tpacpi_leds[led].led = led;
5238 /* LEDs with no name don't get registered */
5239 if (!tpacpi_led_names[led])
5242 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5243 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5244 if (led_supported == TPACPI_LED_570)
5245 tpacpi_leds[led].led_classdev.brightness_get =
5248 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5250 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5252 rc = led_classdev_register(&tpacpi_pdev->dev,
5253 &tpacpi_leds[led].led_classdev);
5255 tpacpi_leds[led].led_classdev.name = NULL;
5260 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5261 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5262 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5263 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5265 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5266 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5267 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5268 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5269 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5270 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5271 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5272 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5274 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5275 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5276 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5277 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5278 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5280 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5281 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5282 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5283 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5285 /* (1) - may have excess leds enabled on MSB */
5287 /* Defaults (order matters, keep last, don't reorder!) */
5289 .vendor = PCI_VENDOR_ID_LENOVO,
5290 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5293 { /* IBM ThinkPads with no EC version string */
5294 .vendor = PCI_VENDOR_ID_IBM,
5295 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5298 { /* IBM ThinkPads with EC version string */
5299 .vendor = PCI_VENDOR_ID_IBM,
5300 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5305 #undef TPACPI_LEDQ_IBM
5306 #undef TPACPI_LEDQ_LNV
5308 static enum led_access_mode __init led_init_detect_mode(void)
5312 if (tpacpi_is_ibm()) {
5314 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5315 if (ACPI_SUCCESS(status))
5316 return TPACPI_LED_570;
5318 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5319 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5320 if (ACPI_SUCCESS(status))
5321 return TPACPI_LED_OLD;
5325 status = acpi_get_handle(ec_handle, "LED", &led_handle);
5326 if (ACPI_SUCCESS(status))
5327 return TPACPI_LED_NEW;
5329 /* R30, R31, and unknown firmwares */
5331 return TPACPI_LED_NONE;
5334 static int __init led_init(struct ibm_init_struct *iibm)
5338 unsigned long useful_leds;
5340 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5342 led_supported = led_init_detect_mode();
5344 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5345 str_supported(led_supported), led_supported);
5347 if (led_supported == TPACPI_LED_NONE)
5350 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5353 printk(TPACPI_ERR "Out of memory for LED data\n");
5357 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5358 ARRAY_SIZE(led_useful_qtable));
5360 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5361 if (!tpacpi_is_led_restricted(i) &&
5362 test_bit(i, &useful_leds)) {
5363 rc = tpacpi_init_led(i);
5371 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5372 printk(TPACPI_NOTICE
5373 "warning: userspace override of important "
5374 "firmware LEDs is enabled\n");
5379 #define str_led_status(s) \
5380 ((s) == TPACPI_LED_OFF ? "off" : \
5381 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5383 static int led_read(struct seq_file *m)
5385 if (!led_supported) {
5386 seq_printf(m, "status:\t\tnot supported\n");
5389 seq_printf(m, "status:\t\tsupported\n");
5391 if (led_supported == TPACPI_LED_570) {
5394 for (i = 0; i < 8; i++) {
5395 status = led_get_status(i);
5398 seq_printf(m, "%d:\t\t%s\n",
5399 i, str_led_status(status));
5403 seq_printf(m, "commands:\t"
5404 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5409 static int led_write(char *buf)
5413 enum led_status_t s;
5418 while ((cmd = next_cmd(&buf))) {
5419 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5422 if (strstr(cmd, "off")) {
5424 } else if (strstr(cmd, "on")) {
5426 } else if (strstr(cmd, "blink")) {
5427 s = TPACPI_LED_BLINK;
5432 rc = led_set_status(led, s);
5440 static struct ibm_struct led_driver_data = {
5447 /*************************************************************************
5451 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5453 #define TPACPI_BEEP_Q1 0x0001
5455 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5456 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5457 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5460 static int __init beep_init(struct ibm_init_struct *iibm)
5462 unsigned long quirks;
5464 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5466 TPACPI_ACPIHANDLE_INIT(beep);
5468 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5469 str_supported(beep_handle != NULL));
5471 quirks = tpacpi_check_quirks(beep_quirk_table,
5472 ARRAY_SIZE(beep_quirk_table));
5474 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5476 return (beep_handle)? 0 : 1;
5479 static int beep_read(struct seq_file *m)
5482 seq_printf(m, "status:\t\tnot supported\n");
5484 seq_printf(m, "status:\t\tsupported\n");
5485 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5491 static int beep_write(char *buf)
5499 while ((cmd = next_cmd(&buf))) {
5500 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5501 beep_cmd >= 0 && beep_cmd <= 17) {
5505 if (tp_features.beep_needs_two_args) {
5506 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5510 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5519 static struct ibm_struct beep_driver_data = {
5522 .write = beep_write,
5525 /*************************************************************************
5529 enum thermal_access_mode {
5530 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5531 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5532 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5533 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5534 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5537 enum { /* TPACPI_THERMAL_TPEC_* */
5538 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5539 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5540 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5542 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5546 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5547 struct ibm_thermal_sensors_struct {
5548 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5551 static enum thermal_access_mode thermal_read_mode;
5553 /* idx is zero-based */
5554 static int thermal_get_sensor(int idx, s32 *value)
5560 t = TP_EC_THERMAL_TMP0;
5562 switch (thermal_read_mode) {
5563 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5564 case TPACPI_THERMAL_TPEC_16:
5565 if (idx >= 8 && idx <= 15) {
5566 t = TP_EC_THERMAL_TMP8;
5571 case TPACPI_THERMAL_TPEC_8:
5573 if (!acpi_ec_read(t + idx, &tmp))
5575 *value = tmp * 1000;
5580 case TPACPI_THERMAL_ACPI_UPDT:
5582 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5583 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5585 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5587 *value = (t - 2732) * 100;
5592 case TPACPI_THERMAL_ACPI_TMP07:
5594 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5595 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5597 if (t > 127 || t < -127)
5598 t = TP_EC_THERMAL_TMP_NA;
5604 case TPACPI_THERMAL_NONE:
5612 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5623 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5626 for (i = 0 ; i < n; i++) {
5627 res = thermal_get_sensor(i, &s->temp[i]);
5635 static void thermal_dump_all_sensors(void)
5638 struct ibm_thermal_sensors_struct t;
5640 n = thermal_get_sensors(&t);
5644 printk(TPACPI_NOTICE
5645 "temperatures (Celsius):");
5647 for (i = 0; i < n; i++) {
5648 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5649 printk(KERN_CONT " %d", (int)(t.temp[i] / 1000));
5651 printk(KERN_CONT " N/A");
5654 printk(KERN_CONT "\n");
5657 /* sysfs temp##_input -------------------------------------------------- */
5659 static ssize_t thermal_temp_input_show(struct device *dev,
5660 struct device_attribute *attr,
5663 struct sensor_device_attribute *sensor_attr =
5664 to_sensor_dev_attr(attr);
5665 int idx = sensor_attr->index;
5669 res = thermal_get_sensor(idx, &value);
5672 if (value == TPACPI_THERMAL_SENSOR_NA)
5675 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5678 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5679 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5680 thermal_temp_input_show, NULL, _idxB)
5682 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5683 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5684 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5685 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5686 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5687 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5688 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5689 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5690 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5691 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5692 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5693 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5694 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5695 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5696 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5697 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5698 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5701 #define THERMAL_ATTRS(X) \
5702 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5704 static struct attribute *thermal_temp_input_attr[] = {
5724 static const struct attribute_group thermal_temp_input16_group = {
5725 .attrs = thermal_temp_input_attr
5728 static const struct attribute_group thermal_temp_input8_group = {
5729 .attrs = &thermal_temp_input_attr[8]
5732 #undef THERMAL_SENSOR_ATTR_TEMP
5733 #undef THERMAL_ATTRS
5735 /* --------------------------------------------------------------------- */
5737 static int __init thermal_init(struct ibm_init_struct *iibm)
5744 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5746 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5748 if (thinkpad_id.ec_model) {
5750 * Direct EC access mode: sensors at registers
5751 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5752 * non-implemented, thermal sensors return 0x80 when
5757 for (i = 0; i < 8; i++) {
5758 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5764 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5772 /* This is sheer paranoia, but we handle it anyway */
5775 "ThinkPad ACPI EC access misbehaving, "
5776 "falling back to ACPI TMPx access "
5778 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5781 "ThinkPad ACPI EC access misbehaving, "
5782 "disabling thermal sensors access\n");
5783 thermal_read_mode = TPACPI_THERMAL_NONE;
5788 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5790 } else if (acpi_tmp7) {
5791 if (tpacpi_is_ibm() &&
5792 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5793 /* 600e/x, 770e, 770x */
5794 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5796 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5797 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5800 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5801 thermal_read_mode = TPACPI_THERMAL_NONE;
5804 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5805 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5808 switch (thermal_read_mode) {
5809 case TPACPI_THERMAL_TPEC_16:
5810 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5811 &thermal_temp_input16_group);
5815 case TPACPI_THERMAL_TPEC_8:
5816 case TPACPI_THERMAL_ACPI_TMP07:
5817 case TPACPI_THERMAL_ACPI_UPDT:
5818 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5819 &thermal_temp_input8_group);
5823 case TPACPI_THERMAL_NONE:
5831 static void thermal_exit(void)
5833 switch (thermal_read_mode) {
5834 case TPACPI_THERMAL_TPEC_16:
5835 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5836 &thermal_temp_input16_group);
5838 case TPACPI_THERMAL_TPEC_8:
5839 case TPACPI_THERMAL_ACPI_TMP07:
5840 case TPACPI_THERMAL_ACPI_UPDT:
5841 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5842 &thermal_temp_input8_group);
5844 case TPACPI_THERMAL_NONE:
5850 static int thermal_read(struct seq_file *m)
5853 struct ibm_thermal_sensors_struct t;
5855 n = thermal_get_sensors(&t);
5856 if (unlikely(n < 0))
5859 seq_printf(m, "temperatures:\t");
5862 for (i = 0; i < (n - 1); i++)
5863 seq_printf(m, "%d ", t.temp[i] / 1000);
5864 seq_printf(m, "%d\n", t.temp[i] / 1000);
5866 seq_printf(m, "not supported\n");
5871 static struct ibm_struct thermal_driver_data = {
5873 .read = thermal_read,
5874 .exit = thermal_exit,
5877 /*************************************************************************
5878 * Backlight/brightness subdriver
5881 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5884 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5885 * CMOS NVRAM byte 0x5E, bits 0-3.
5887 * EC HBRV (0x31) has the following layout
5888 * Bit 7: unknown function
5889 * Bit 6: unknown function
5890 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5891 * Bit 4: must be set to zero to avoid problems
5892 * Bit 3-0: backlight brightness level
5894 * brightness_get_raw returns status data in the HBRV layout
5896 * WARNING: The X61 has been verified to use HBRV for something else, so
5897 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5898 * testing on the very early *60 Lenovo models...
5902 TP_EC_BACKLIGHT = 0x31,
5904 /* TP_EC_BACKLIGHT bitmasks */
5905 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5906 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5907 TP_EC_BACKLIGHT_MAPSW = 0x20,
5910 enum tpacpi_brightness_access_mode {
5911 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5912 TPACPI_BRGHT_MODE_EC, /* EC control */
5913 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5914 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5915 TPACPI_BRGHT_MODE_MAX
5918 static struct backlight_device *ibm_backlight_device;
5920 static enum tpacpi_brightness_access_mode brightness_mode =
5921 TPACPI_BRGHT_MODE_MAX;
5923 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5925 static struct mutex brightness_mutex;
5927 /* NVRAM brightness access,
5928 * call with brightness_mutex held! */
5929 static unsigned int tpacpi_brightness_nvram_get(void)
5933 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5934 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5935 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5936 lnvram &= bright_maxlvl;
5941 static void tpacpi_brightness_checkpoint_nvram(void)
5946 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
5949 vdbg_printk(TPACPI_DBG_BRGHT,
5950 "trying to checkpoint backlight level to NVRAM...\n");
5952 if (mutex_lock_killable(&brightness_mutex) < 0)
5955 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5957 lec &= TP_EC_BACKLIGHT_LVLMSK;
5958 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
5960 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5961 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
5962 /* NVRAM needs update */
5963 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
5964 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
5966 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
5967 dbg_printk(TPACPI_DBG_BRGHT,
5968 "updated NVRAM backlight level to %u (0x%02x)\n",
5969 (unsigned int) lec, (unsigned int) b_nvram);
5971 vdbg_printk(TPACPI_DBG_BRGHT,
5972 "NVRAM backlight level already is %u (0x%02x)\n",
5973 (unsigned int) lec, (unsigned int) b_nvram);
5976 mutex_unlock(&brightness_mutex);
5980 /* call with brightness_mutex held! */
5981 static int tpacpi_brightness_get_raw(int *status)
5985 switch (brightness_mode) {
5986 case TPACPI_BRGHT_MODE_UCMS_STEP:
5987 *status = tpacpi_brightness_nvram_get();
5989 case TPACPI_BRGHT_MODE_EC:
5990 case TPACPI_BRGHT_MODE_ECNVRAM:
5991 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6000 /* call with brightness_mutex held! */
6001 /* do NOT call with illegal backlight level value */
6002 static int tpacpi_brightness_set_ec(unsigned int value)
6006 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6009 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6010 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6011 (value & TP_EC_BACKLIGHT_LVLMSK))))
6017 /* call with brightness_mutex held! */
6018 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6021 unsigned int current_value, i;
6023 current_value = tpacpi_brightness_nvram_get();
6025 if (value == current_value)
6028 cmos_cmd = (value > current_value) ?
6029 TP_CMOS_BRIGHTNESS_UP :
6030 TP_CMOS_BRIGHTNESS_DOWN;
6031 inc = (value > current_value) ? 1 : -1;
6033 for (i = current_value; i != value; i += inc)
6034 if (issue_thinkpad_cmos_command(cmos_cmd))
6040 /* May return EINTR which can always be mapped to ERESTARTSYS */
6041 static int brightness_set(unsigned int value)
6045 if (value > bright_maxlvl || value < 0)
6048 vdbg_printk(TPACPI_DBG_BRGHT,
6049 "set backlight level to %d\n", value);
6051 res = mutex_lock_killable(&brightness_mutex);
6055 switch (brightness_mode) {
6056 case TPACPI_BRGHT_MODE_EC:
6057 case TPACPI_BRGHT_MODE_ECNVRAM:
6058 res = tpacpi_brightness_set_ec(value);
6060 case TPACPI_BRGHT_MODE_UCMS_STEP:
6061 res = tpacpi_brightness_set_ucmsstep(value);
6067 mutex_unlock(&brightness_mutex);
6071 /* sysfs backlight class ----------------------------------------------- */
6073 static int brightness_update_status(struct backlight_device *bd)
6075 unsigned int level =
6076 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6077 bd->props.power == FB_BLANK_UNBLANK) ?
6078 bd->props.brightness : 0;
6080 dbg_printk(TPACPI_DBG_BRGHT,
6081 "backlight: attempt to set level to %d\n",
6084 /* it is the backlight class's job (caller) to handle
6085 * EINTR and other errors properly */
6086 return brightness_set(level);
6089 static int brightness_get(struct backlight_device *bd)
6093 res = mutex_lock_killable(&brightness_mutex);
6097 res = tpacpi_brightness_get_raw(&status);
6099 mutex_unlock(&brightness_mutex);
6104 return status & TP_EC_BACKLIGHT_LVLMSK;
6107 static void tpacpi_brightness_notify_change(void)
6109 backlight_force_update(ibm_backlight_device,
6110 BACKLIGHT_UPDATE_HOTKEY);
6113 static struct backlight_ops ibm_backlight_data = {
6114 .get_brightness = brightness_get,
6115 .update_status = brightness_update_status,
6118 /* --------------------------------------------------------------------- */
6121 * Call _BCL method of video device. On some ThinkPads this will
6122 * switch the firmware to the ACPI brightness control mode.
6125 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6127 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6128 union acpi_object *obj;
6131 if (ACPI_SUCCESS(acpi_evaluate_object(handle, "_BCL", NULL, &buffer))) {
6132 obj = (union acpi_object *)buffer.pointer;
6133 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6134 printk(TPACPI_ERR "Unknown _BCL data, "
6135 "please report this to %s\n", TPACPI_MAIL);
6138 rc = obj->package.count;
6144 kfree(buffer.pointer);
6150 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6152 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6154 acpi_handle video_device;
6157 tpacpi_acpi_handle_locate("video", ACPI_VIDEO_HID, &video_device);
6159 bcl_levels = tpacpi_query_bcl_levels(video_device);
6161 tp_features.bright_acpimode = (bcl_levels > 0);
6163 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6167 * These are only useful for models that have only one possibility
6168 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6171 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6172 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6173 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6175 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6176 /* Models with ATI GPUs known to require ECNVRAM mode */
6177 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6179 /* Models with ATI GPUs that can use ECNVRAM */
6180 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6181 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6182 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6183 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6185 /* Models with Intel Extreme Graphics 2 */
6186 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6187 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6188 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6190 /* Models with Intel GMA900 */
6191 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6192 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6193 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6197 * Returns < 0 for error, otherwise sets tp_features.bright_*
6198 * and bright_maxlvl.
6200 static void __init tpacpi_detect_brightness_capabilities(void)
6204 vdbg_printk(TPACPI_DBG_INIT,
6205 "detecting firmware brightness interface capabilities\n");
6207 /* we could run a quirks check here (same table used by
6208 * brightness_init) if needed */
6211 * We always attempt to detect acpi support, so as to switch
6212 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6213 * going to publish a backlight interface
6215 b = tpacpi_check_std_acpi_brightness_support();
6220 "detected a 16-level brightness capable ThinkPad\n");
6226 "detected a 8-level brightness capable ThinkPad\n");
6230 "Unsupported brightness interface, "
6231 "please contact %s\n", TPACPI_MAIL);
6232 tp_features.bright_unkfw = 1;
6233 bright_maxlvl = b - 1;
6237 static int __init brightness_init(struct ibm_init_struct *iibm)
6239 struct backlight_properties props;
6241 unsigned long quirks;
6243 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6245 mutex_init(&brightness_mutex);
6247 quirks = tpacpi_check_quirks(brightness_quirk_table,
6248 ARRAY_SIZE(brightness_quirk_table));
6250 /* tpacpi_detect_brightness_capabilities() must have run already */
6252 /* if it is unknown, we don't handle it: it wouldn't be safe */
6253 if (tp_features.bright_unkfw)
6256 if (!brightness_enable) {
6257 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6258 "brightness support disabled by "
6259 "module parameter\n");
6263 if (acpi_video_backlight_support()) {
6264 if (brightness_enable > 1) {
6266 "Standard ACPI backlight interface "
6267 "available, not loading native one.\n");
6269 } else if (brightness_enable == 1) {
6271 "Cannot enable backlight brightness support, "
6272 "ACPI is already handling it. Refer to the "
6273 "acpi_backlight kernel parameter\n");
6276 } else if (tp_features.bright_acpimode && brightness_enable > 1) {
6277 printk(TPACPI_NOTICE
6278 "Standard ACPI backlight interface not "
6279 "available, thinkpad_acpi native "
6280 "brightness control enabled\n");
6284 * Check for module parameter bogosity, note that we
6285 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6286 * able to detect "unspecified"
6288 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6291 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6292 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6293 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6294 if (quirks & TPACPI_BRGHT_Q_EC)
6295 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6297 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6299 dbg_printk(TPACPI_DBG_BRGHT,
6300 "driver auto-selected brightness_mode=%d\n",
6305 if (!tpacpi_is_ibm() &&
6306 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6307 brightness_mode == TPACPI_BRGHT_MODE_EC))
6310 if (tpacpi_brightness_get_raw(&b) < 0)
6313 memset(&props, 0, sizeof(struct backlight_properties));
6314 props.max_brightness = bright_maxlvl;
6315 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6316 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6318 &ibm_backlight_data,
6320 if (IS_ERR(ibm_backlight_device)) {
6321 int rc = PTR_ERR(ibm_backlight_device);
6322 ibm_backlight_device = NULL;
6323 printk(TPACPI_ERR "Could not register backlight device\n");
6326 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6327 "brightness is supported\n");
6329 if (quirks & TPACPI_BRGHT_Q_ASK) {
6330 printk(TPACPI_NOTICE
6331 "brightness: will use unverified default: "
6332 "brightness_mode=%d\n", brightness_mode);
6333 printk(TPACPI_NOTICE
6334 "brightness: please report to %s whether it works well "
6335 "or not on your ThinkPad\n", TPACPI_MAIL);
6338 /* Added by mistake in early 2007. Probably useless, but it could
6339 * be working around some unknown firmware problem where the value
6340 * read at startup doesn't match the real hardware state... so leave
6341 * it in place just in case */
6342 backlight_update_status(ibm_backlight_device);
6344 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6345 "brightness: registering brightness hotkeys "
6346 "as change notification\n");
6347 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6348 | TP_ACPI_HKEY_BRGHTUP_MASK
6349 | TP_ACPI_HKEY_BRGHTDWN_MASK);
6353 static void brightness_suspend(pm_message_t state)
6355 tpacpi_brightness_checkpoint_nvram();
6358 static void brightness_shutdown(void)
6360 tpacpi_brightness_checkpoint_nvram();
6363 static void brightness_exit(void)
6365 if (ibm_backlight_device) {
6366 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6367 "calling backlight_device_unregister()\n");
6368 backlight_device_unregister(ibm_backlight_device);
6371 tpacpi_brightness_checkpoint_nvram();
6374 static int brightness_read(struct seq_file *m)
6378 level = brightness_get(NULL);
6380 seq_printf(m, "level:\t\tunreadable\n");
6382 seq_printf(m, "level:\t\t%d\n", level);
6383 seq_printf(m, "commands:\tup, down\n");
6384 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6391 static int brightness_write(char *buf)
6397 level = brightness_get(NULL);
6401 while ((cmd = next_cmd(&buf))) {
6402 if (strlencmp(cmd, "up") == 0) {
6403 if (level < bright_maxlvl)
6405 } else if (strlencmp(cmd, "down") == 0) {
6408 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6409 level >= 0 && level <= bright_maxlvl) {
6415 tpacpi_disclose_usertask("procfs brightness",
6416 "set level to %d\n", level);
6419 * Now we know what the final level should be, so we try to set it.
6420 * Doing it this way makes the syscall restartable in case of EINTR
6422 rc = brightness_set(level);
6423 if (!rc && ibm_backlight_device)
6424 backlight_force_update(ibm_backlight_device,
6425 BACKLIGHT_UPDATE_SYSFS);
6426 return (rc == -EINTR)? -ERESTARTSYS : rc;
6429 static struct ibm_struct brightness_driver_data = {
6430 .name = "brightness",
6431 .read = brightness_read,
6432 .write = brightness_write,
6433 .exit = brightness_exit,
6434 .suspend = brightness_suspend,
6435 .shutdown = brightness_shutdown,
6438 /*************************************************************************
6443 * IBM ThinkPads have a simple volume controller with MUTE gating.
6444 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6446 * Since the *61 series (and probably also the later *60 series), Lenovo
6447 * ThinkPads only implement the MUTE gate.
6450 * Bit 6: MUTE (1 mutes sound)
6452 * Other bits should be zero as far as we know.
6454 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6455 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
6456 * such as bit 7 which is used to detect repeated presses of MUTE,
6457 * and we leave them unchanged.
6460 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6462 #define TPACPI_ALSA_DRVNAME "ThinkPad EC"
6463 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6464 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6466 static int alsa_index = ~((1 << (SNDRV_CARDS - 3)) - 1); /* last three slots */
6467 static char *alsa_id = "ThinkPadEC";
6468 static int alsa_enable = SNDRV_DEFAULT_ENABLE1;
6470 struct tpacpi_alsa_data {
6471 struct snd_card *card;
6472 struct snd_ctl_elem_id *ctl_mute_id;
6473 struct snd_ctl_elem_id *ctl_vol_id;
6476 static struct snd_card *alsa_card;
6481 /* TP_EC_AUDIO bits */
6482 TP_EC_AUDIO_MUTESW = 6,
6484 /* TP_EC_AUDIO bitmasks */
6485 TP_EC_AUDIO_LVL_MSK = 0x0F,
6486 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6488 /* Maximum volume */
6489 TP_EC_VOLUME_MAX = 14,
6492 enum tpacpi_volume_access_mode {
6493 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
6494 TPACPI_VOL_MODE_EC, /* Pure EC control */
6495 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
6496 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6500 enum tpacpi_volume_capabilities {
6501 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
6502 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
6503 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
6507 static enum tpacpi_volume_access_mode volume_mode =
6508 TPACPI_VOL_MODE_MAX;
6510 static enum tpacpi_volume_capabilities volume_capabilities;
6511 static int volume_control_allowed;
6514 * Used to syncronize writers to TP_EC_AUDIO and
6515 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6517 static struct mutex volume_mutex;
6519 static void tpacpi_volume_checkpoint_nvram(void)
6525 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6527 if (!volume_control_allowed)
6530 vdbg_printk(TPACPI_DBG_MIXER,
6531 "trying to checkpoint mixer state to NVRAM...\n");
6533 if (tp_features.mixer_no_level_control)
6534 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6536 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6538 if (mutex_lock_killable(&volume_mutex) < 0)
6541 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6544 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6546 if (lec != (b_nvram & ec_mask)) {
6547 /* NVRAM needs update */
6548 b_nvram &= ~ec_mask;
6550 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6551 dbg_printk(TPACPI_DBG_MIXER,
6552 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6553 (unsigned int) lec, (unsigned int) b_nvram);
6555 vdbg_printk(TPACPI_DBG_MIXER,
6556 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6557 (unsigned int) lec, (unsigned int) b_nvram);
6561 mutex_unlock(&volume_mutex);
6564 static int volume_get_status_ec(u8 *status)
6568 if (!acpi_ec_read(TP_EC_AUDIO, &s))
6573 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6578 static int volume_get_status(u8 *status)
6580 return volume_get_status_ec(status);
6583 static int volume_set_status_ec(const u8 status)
6585 if (!acpi_ec_write(TP_EC_AUDIO, status))
6588 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6593 static int volume_set_status(const u8 status)
6595 return volume_set_status_ec(status);
6598 /* returns < 0 on error, 0 on no change, 1 on change */
6599 static int __volume_set_mute_ec(const bool mute)
6604 if (mutex_lock_killable(&volume_mutex) < 0)
6607 rc = volume_get_status_ec(&s);
6611 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6612 s & ~TP_EC_AUDIO_MUTESW_MSK;
6615 rc = volume_set_status_ec(n);
6621 mutex_unlock(&volume_mutex);
6625 static int volume_alsa_set_mute(const bool mute)
6627 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6628 (mute) ? "" : "un");
6629 return __volume_set_mute_ec(mute);
6632 static int volume_set_mute(const bool mute)
6636 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6637 (mute) ? "" : "un");
6639 rc = __volume_set_mute_ec(mute);
6640 return (rc < 0) ? rc : 0;
6643 /* returns < 0 on error, 0 on no change, 1 on change */
6644 static int __volume_set_volume_ec(const u8 vol)
6649 if (vol > TP_EC_VOLUME_MAX)
6652 if (mutex_lock_killable(&volume_mutex) < 0)
6655 rc = volume_get_status_ec(&s);
6659 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6662 rc = volume_set_status_ec(n);
6668 mutex_unlock(&volume_mutex);
6672 static int volume_alsa_set_volume(const u8 vol)
6674 dbg_printk(TPACPI_DBG_MIXER,
6675 "ALSA: trying to set volume level to %hu\n", vol);
6676 return __volume_set_volume_ec(vol);
6679 static void volume_alsa_notify_change(void)
6681 struct tpacpi_alsa_data *d;
6683 if (alsa_card && alsa_card->private_data) {
6684 d = alsa_card->private_data;
6686 snd_ctl_notify(alsa_card,
6687 SNDRV_CTL_EVENT_MASK_VALUE,
6690 snd_ctl_notify(alsa_card,
6691 SNDRV_CTL_EVENT_MASK_VALUE,
6696 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6697 struct snd_ctl_elem_info *uinfo)
6699 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6701 uinfo->value.integer.min = 0;
6702 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6706 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6707 struct snd_ctl_elem_value *ucontrol)
6712 rc = volume_get_status(&s);
6716 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6720 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6721 struct snd_ctl_elem_value *ucontrol)
6723 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
6724 ucontrol->value.integer.value[0]);
6725 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6728 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
6730 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6731 struct snd_ctl_elem_value *ucontrol)
6736 rc = volume_get_status(&s);
6740 ucontrol->value.integer.value[0] =
6741 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6745 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6746 struct snd_ctl_elem_value *ucontrol)
6748 tpacpi_disclose_usertask("ALSA", "%smute\n",
6749 ucontrol->value.integer.value[0] ?
6751 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6754 static struct snd_kcontrol_new volume_alsa_control_vol __devinitdata = {
6755 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6756 .name = "Console Playback Volume",
6758 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6759 .info = volume_alsa_vol_info,
6760 .get = volume_alsa_vol_get,
6763 static struct snd_kcontrol_new volume_alsa_control_mute __devinitdata = {
6764 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6765 .name = "Console Playback Switch",
6767 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6768 .info = volume_alsa_mute_info,
6769 .get = volume_alsa_mute_get,
6772 static void volume_suspend(pm_message_t state)
6774 tpacpi_volume_checkpoint_nvram();
6777 static void volume_resume(void)
6779 volume_alsa_notify_change();
6782 static void volume_shutdown(void)
6784 tpacpi_volume_checkpoint_nvram();
6787 static void volume_exit(void)
6790 snd_card_free(alsa_card);
6794 tpacpi_volume_checkpoint_nvram();
6797 static int __init volume_create_alsa_mixer(void)
6799 struct snd_card *card;
6800 struct tpacpi_alsa_data *data;
6801 struct snd_kcontrol *ctl_vol;
6802 struct snd_kcontrol *ctl_mute;
6805 rc = snd_card_create(alsa_index, alsa_id, THIS_MODULE,
6806 sizeof(struct tpacpi_alsa_data), &card);
6807 if (rc < 0 || !card) {
6809 "Failed to create ALSA card structures: %d\n", rc);
6813 BUG_ON(!card->private_data);
6814 data = card->private_data;
6817 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6818 sizeof(card->driver));
6819 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6820 sizeof(card->shortname));
6821 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6822 (thinkpad_id.ec_version_str) ?
6823 thinkpad_id.ec_version_str : "(unknown)");
6824 snprintf(card->longname, sizeof(card->longname),
6825 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6826 (thinkpad_id.ec_version_str) ?
6827 thinkpad_id.ec_version_str : "unknown");
6829 if (volume_control_allowed) {
6830 volume_alsa_control_vol.put = volume_alsa_vol_put;
6831 volume_alsa_control_vol.access =
6832 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6834 volume_alsa_control_mute.put = volume_alsa_mute_put;
6835 volume_alsa_control_mute.access =
6836 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6839 if (!tp_features.mixer_no_level_control) {
6840 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6841 rc = snd_ctl_add(card, ctl_vol);
6844 "Failed to create ALSA volume control: %d\n",
6848 data->ctl_vol_id = &ctl_vol->id;
6851 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6852 rc = snd_ctl_add(card, ctl_mute);
6854 printk(TPACPI_ERR "Failed to create ALSA mute control: %d\n",
6858 data->ctl_mute_id = &ctl_mute->id;
6860 snd_card_set_dev(card, &tpacpi_pdev->dev);
6861 rc = snd_card_register(card);
6863 printk(TPACPI_ERR "Failed to register ALSA card: %d\n", rc);
6871 snd_card_free(card);
6875 #define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
6876 #define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
6878 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6879 /* Whitelist volume level on all IBM by default */
6880 { .vendor = PCI_VENDOR_ID_IBM,
6881 .bios = TPACPI_MATCH_ANY,
6882 .ec = TPACPI_MATCH_ANY,
6883 .quirks = TPACPI_VOL_Q_LEVEL },
6885 /* Lenovo models with volume control (needs confirmation) */
6886 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6887 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6888 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6889 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6890 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6891 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6892 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6894 /* Whitelist mute-only on all Lenovo by default */
6895 { .vendor = PCI_VENDOR_ID_LENOVO,
6896 .bios = TPACPI_MATCH_ANY,
6897 .ec = TPACPI_MATCH_ANY,
6898 .quirks = TPACPI_VOL_Q_MUTEONLY }
6901 static int __init volume_init(struct ibm_init_struct *iibm)
6903 unsigned long quirks;
6906 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
6908 mutex_init(&volume_mutex);
6911 * Check for module parameter bogosity, note that we
6912 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
6913 * able to detect "unspecified"
6915 if (volume_mode > TPACPI_VOL_MODE_MAX)
6918 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
6920 "UCMS step volume mode not implemented, "
6921 "please contact %s\n", TPACPI_MAIL);
6925 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
6929 * The ALSA mixer is our primary interface.
6930 * When disabled, don't install the subdriver at all
6933 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6934 "ALSA mixer disabled by parameter, "
6935 "not loading volume subdriver...\n");
6939 quirks = tpacpi_check_quirks(volume_quirk_table,
6940 ARRAY_SIZE(volume_quirk_table));
6942 switch (volume_capabilities) {
6943 case TPACPI_VOL_CAP_AUTO:
6944 if (quirks & TPACPI_VOL_Q_MUTEONLY)
6945 tp_features.mixer_no_level_control = 1;
6946 else if (quirks & TPACPI_VOL_Q_LEVEL)
6947 tp_features.mixer_no_level_control = 0;
6949 return 1; /* no mixer */
6951 case TPACPI_VOL_CAP_VOLMUTE:
6952 tp_features.mixer_no_level_control = 0;
6954 case TPACPI_VOL_CAP_MUTEONLY:
6955 tp_features.mixer_no_level_control = 1;
6961 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
6962 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6963 "using user-supplied volume_capabilities=%d\n",
6964 volume_capabilities);
6966 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
6967 volume_mode == TPACPI_VOL_MODE_MAX) {
6968 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
6970 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6971 "driver auto-selected volume_mode=%d\n",
6974 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6975 "using user-supplied volume_mode=%d\n",
6979 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6980 "mute is supported, volume control is %s\n",
6981 str_supported(!tp_features.mixer_no_level_control));
6983 rc = volume_create_alsa_mixer();
6986 "Could not create the ALSA mixer interface\n");
6991 "Console audio control enabled, mode: %s\n",
6992 (volume_control_allowed) ?
6993 "override (read/write)" :
6994 "monitor (read only)");
6996 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6997 "registering volume hotkeys as change notification\n");
6998 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6999 | TP_ACPI_HKEY_VOLUP_MASK
7000 | TP_ACPI_HKEY_VOLDWN_MASK
7001 | TP_ACPI_HKEY_MUTE_MASK);
7006 static int volume_read(struct seq_file *m)
7010 if (volume_get_status(&status) < 0) {
7011 seq_printf(m, "level:\t\tunreadable\n");
7013 if (tp_features.mixer_no_level_control)
7014 seq_printf(m, "level:\t\tunsupported\n");
7016 seq_printf(m, "level:\t\t%d\n",
7017 status & TP_EC_AUDIO_LVL_MSK);
7019 seq_printf(m, "mute:\t\t%s\n",
7020 onoff(status, TP_EC_AUDIO_MUTESW));
7022 if (volume_control_allowed) {
7023 seq_printf(m, "commands:\tunmute, mute\n");
7024 if (!tp_features.mixer_no_level_control) {
7026 "commands:\tup, down\n");
7028 "commands:\tlevel <level>"
7029 " (<level> is 0-%d)\n",
7038 static int volume_write(char *buf)
7041 u8 new_level, new_mute;
7047 * We do allow volume control at driver startup, so that the
7048 * user can set initial state through the volume=... parameter hack.
7050 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7051 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7052 tp_warned.volume_ctrl_forbidden = 1;
7053 printk(TPACPI_NOTICE
7054 "Console audio control in monitor mode, "
7055 "changes are not allowed.\n");
7056 printk(TPACPI_NOTICE
7057 "Use the volume_control=1 module parameter "
7058 "to enable volume control\n");
7063 rc = volume_get_status(&s);
7067 new_level = s & TP_EC_AUDIO_LVL_MSK;
7068 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7070 while ((cmd = next_cmd(&buf))) {
7071 if (!tp_features.mixer_no_level_control) {
7072 if (strlencmp(cmd, "up") == 0) {
7075 else if (new_level < TP_EC_VOLUME_MAX)
7078 } else if (strlencmp(cmd, "down") == 0) {
7081 else if (new_level > 0)
7084 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7085 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7090 if (strlencmp(cmd, "mute") == 0)
7091 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7092 else if (strlencmp(cmd, "unmute") == 0)
7098 if (tp_features.mixer_no_level_control) {
7099 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7100 new_mute ? "" : "un");
7101 rc = volume_set_mute(!!new_mute);
7103 tpacpi_disclose_usertask("procfs volume",
7104 "%smute and set level to %d\n",
7105 new_mute ? "" : "un", new_level);
7106 rc = volume_set_status(new_mute | new_level);
7108 volume_alsa_notify_change();
7110 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7113 static struct ibm_struct volume_driver_data = {
7115 .read = volume_read,
7116 .write = volume_write,
7117 .exit = volume_exit,
7118 .suspend = volume_suspend,
7119 .resume = volume_resume,
7120 .shutdown = volume_shutdown,
7123 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7125 #define alsa_card NULL
7127 static void inline volume_alsa_notify_change(void)
7131 static int __init volume_init(struct ibm_init_struct *iibm)
7134 "volume: disabled as there is no ALSA support in this kernel\n");
7139 static struct ibm_struct volume_driver_data = {
7143 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7145 /*************************************************************************
7152 * TPACPI_FAN_RD_ACPI_GFAN:
7153 * ACPI GFAN method: returns fan level
7155 * see TPACPI_FAN_WR_ACPI_SFAN
7156 * EC 0x2f (HFSP) not available if GFAN exists
7158 * TPACPI_FAN_WR_ACPI_SFAN:
7159 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7161 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7164 * TPACPI_FAN_WR_TPEC:
7165 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7166 * Supported on almost all ThinkPads
7168 * Fan speed changes of any sort (including those caused by the
7169 * disengaged mode) are usually done slowly by the firmware as the
7170 * maximum amount of fan duty cycle change per second seems to be
7173 * Reading is not available if GFAN exists.
7174 * Writing is not available if SFAN exists.
7177 * 7 automatic mode engaged;
7178 * (default operation mode of the ThinkPad)
7179 * fan level is ignored in this mode.
7180 * 6 full speed mode (takes precedence over bit 7);
7181 * not available on all thinkpads. May disable
7182 * the tachometer while the fan controller ramps up
7183 * the speed (which can take up to a few *minutes*).
7184 * Speeds up fan to 100% duty-cycle, which is far above
7185 * the standard RPM levels. It is not impossible that
7186 * it could cause hardware damage.
7187 * 5-3 unused in some models. Extra bits for fan level
7188 * in others, but still useless as all values above
7189 * 7 map to the same speed as level 7 in these models.
7190 * 2-0 fan level (0..7 usually)
7192 * 0x07 = max (set when temperatures critical)
7193 * Some ThinkPads may have other levels, see
7194 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7196 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7197 * boot. Apparently the EC does not intialize it, so unless ACPI DSDT
7198 * does so, its initial value is meaningless (0x07).
7200 * For firmware bugs, refer to:
7201 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7205 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7206 * Main fan tachometer reading (in RPM)
7208 * This register is present on all ThinkPads with a new-style EC, and
7209 * it is known not to be present on the A21m/e, and T22, as there is
7210 * something else in offset 0x84 according to the ACPI DSDT. Other
7211 * ThinkPads from this same time period (and earlier) probably lack the
7212 * tachometer as well.
7214 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7215 * was never fixed by IBM to report the EC firmware version string
7216 * probably support the tachometer (like the early X models), so
7217 * detecting it is quite hard. We need more data to know for sure.
7219 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7222 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7225 * For firmware bugs, refer to:
7226 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7230 * ThinkPad EC register 0x31 bit 0 (only on select models)
7232 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7233 * show the speed of the main fan. When bit 0 of EC register 0x31
7234 * is one, the tachometer registers show the speed of the auxiliary
7237 * Fan control seems to affect both fans, regardless of the state
7240 * So far, only the firmware for the X60/X61 non-tablet versions
7241 * seem to support this (firmware TP-7M).
7243 * TPACPI_FAN_WR_ACPI_FANS:
7244 * ThinkPad X31, X40, X41. Not available in the X60.
7246 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7247 * high speed. ACPI DSDT seems to map these three speeds to levels
7248 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7249 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7251 * The speeds are stored on handles
7252 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7254 * There are three default speed sets, accessible as handles:
7255 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7257 * ACPI DSDT switches which set is in use depending on various
7260 * TPACPI_FAN_WR_TPEC is also available and should be used to
7261 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7262 * but the ACPI tables just mention level 7.
7265 enum { /* Fan control constants */
7266 fan_status_offset = 0x2f, /* EC register 0x2f */
7267 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7268 * 0x84 must be read before 0x85 */
7269 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7270 bit 0 selects which fan is active */
7272 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
7273 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
7275 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
7278 enum fan_status_access_mode {
7279 TPACPI_FAN_NONE = 0, /* No fan status or control */
7280 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
7281 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7284 enum fan_control_access_mode {
7285 TPACPI_FAN_WR_NONE = 0, /* No fan control */
7286 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
7287 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
7288 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
7291 enum fan_control_commands {
7292 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
7293 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
7294 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
7295 * and also watchdog cmd */
7298 static int fan_control_allowed;
7300 static enum fan_status_access_mode fan_status_access_mode;
7301 static enum fan_control_access_mode fan_control_access_mode;
7302 static enum fan_control_commands fan_control_commands;
7304 static u8 fan_control_initial_status;
7305 static u8 fan_control_desired_level;
7306 static u8 fan_control_resume_level;
7307 static int fan_watchdog_maxinterval;
7309 static struct mutex fan_mutex;
7311 static void fan_watchdog_fire(struct work_struct *ignored);
7312 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7314 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
7315 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7316 "\\FSPD", /* 600e/x, 770e, 770x */
7318 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7319 "JFNS", /* 770x-JL */
7323 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7324 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7325 * be in auto mode (0x80).
7327 * This is corrected by any write to HFSP either by the driver, or
7330 * We assume 0x07 really means auto mode while this quirk is active,
7331 * as this is far more likely than the ThinkPad being in level 7,
7332 * which is only used by the firmware during thermal emergencies.
7334 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7335 * TP-70 (T43, R52), which are known to be buggy.
7338 static void fan_quirk1_setup(void)
7340 if (fan_control_initial_status == 0x07) {
7341 printk(TPACPI_NOTICE
7342 "fan_init: initial fan status is unknown, "
7343 "assuming it is in auto mode\n");
7344 tp_features.fan_ctrl_status_undef = 1;
7348 static void fan_quirk1_handle(u8 *fan_status)
7350 if (unlikely(tp_features.fan_ctrl_status_undef)) {
7351 if (*fan_status != fan_control_initial_status) {
7352 /* something changed the HFSP regisnter since
7353 * driver init time, so it is not undefined
7355 tp_features.fan_ctrl_status_undef = 0;
7357 /* Return most likely status. In fact, it
7358 * might be the only possible status */
7359 *fan_status = TP_EC_FAN_AUTO;
7364 /* Select main fan on X60/X61, NOOP on others */
7365 static bool fan_select_fan1(void)
7367 if (tp_features.second_fan) {
7370 if (ec_read(fan_select_offset, &val) < 0)
7373 if (ec_write(fan_select_offset, val) < 0)
7379 /* Select secondary fan on X60/X61 */
7380 static bool fan_select_fan2(void)
7384 if (!tp_features.second_fan)
7387 if (ec_read(fan_select_offset, &val) < 0)
7390 if (ec_write(fan_select_offset, val) < 0)
7397 * Call with fan_mutex held
7399 static void fan_update_desired_level(u8 status)
7402 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7404 fan_control_desired_level = 7;
7406 fan_control_desired_level = status;
7410 static int fan_get_status(u8 *status)
7415 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7417 switch (fan_status_access_mode) {
7418 case TPACPI_FAN_RD_ACPI_GFAN:
7419 /* 570, 600e/x, 770e, 770x */
7421 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
7429 case TPACPI_FAN_RD_TPEC:
7430 /* all except 570, 600e/x, 770e, 770x */
7431 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7434 if (likely(status)) {
7436 fan_quirk1_handle(status);
7448 static int fan_get_status_safe(u8 *status)
7453 if (mutex_lock_killable(&fan_mutex))
7454 return -ERESTARTSYS;
7455 rc = fan_get_status(&s);
7457 fan_update_desired_level(s);
7458 mutex_unlock(&fan_mutex);
7466 static int fan_get_speed(unsigned int *speed)
7470 switch (fan_status_access_mode) {
7471 case TPACPI_FAN_RD_TPEC:
7472 /* all except 570, 600e/x, 770e, 770x */
7473 if (unlikely(!fan_select_fan1()))
7475 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7476 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7480 *speed = (hi << 8) | lo;
7491 static int fan2_get_speed(unsigned int *speed)
7496 switch (fan_status_access_mode) {
7497 case TPACPI_FAN_RD_TPEC:
7498 /* all except 570, 600e/x, 770e, 770x */
7499 if (unlikely(!fan_select_fan2()))
7501 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7502 !acpi_ec_read(fan_rpm_offset + 1, &hi);
7503 fan_select_fan1(); /* play it safe */
7508 *speed = (hi << 8) | lo;
7519 static int fan_set_level(int level)
7521 if (!fan_control_allowed)
7524 switch (fan_control_access_mode) {
7525 case TPACPI_FAN_WR_ACPI_SFAN:
7526 if (level >= 0 && level <= 7) {
7527 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7533 case TPACPI_FAN_WR_ACPI_FANS:
7534 case TPACPI_FAN_WR_TPEC:
7535 if (!(level & TP_EC_FAN_AUTO) &&
7536 !(level & TP_EC_FAN_FULLSPEED) &&
7537 ((level < 0) || (level > 7)))
7540 /* safety net should the EC not support AUTO
7541 * or FULLSPEED mode bits and just ignore them */
7542 if (level & TP_EC_FAN_FULLSPEED)
7543 level |= 7; /* safety min speed 7 */
7544 else if (level & TP_EC_FAN_AUTO)
7545 level |= 4; /* safety min speed 4 */
7547 if (!acpi_ec_write(fan_status_offset, level))
7550 tp_features.fan_ctrl_status_undef = 0;
7557 vdbg_printk(TPACPI_DBG_FAN,
7558 "fan control: set fan control register to 0x%02x\n", level);
7562 static int fan_set_level_safe(int level)
7566 if (!fan_control_allowed)
7569 if (mutex_lock_killable(&fan_mutex))
7570 return -ERESTARTSYS;
7572 if (level == TPACPI_FAN_LAST_LEVEL)
7573 level = fan_control_desired_level;
7575 rc = fan_set_level(level);
7577 fan_update_desired_level(level);
7579 mutex_unlock(&fan_mutex);
7583 static int fan_set_enable(void)
7588 if (!fan_control_allowed)
7591 if (mutex_lock_killable(&fan_mutex))
7592 return -ERESTARTSYS;
7594 switch (fan_control_access_mode) {
7595 case TPACPI_FAN_WR_ACPI_FANS:
7596 case TPACPI_FAN_WR_TPEC:
7597 rc = fan_get_status(&s);
7601 /* Don't go out of emergency fan mode */
7604 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7607 if (!acpi_ec_write(fan_status_offset, s))
7610 tp_features.fan_ctrl_status_undef = 0;
7615 case TPACPI_FAN_WR_ACPI_SFAN:
7616 rc = fan_get_status(&s);
7622 /* Set fan to at least level 4 */
7625 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7635 mutex_unlock(&fan_mutex);
7638 vdbg_printk(TPACPI_DBG_FAN,
7639 "fan control: set fan control register to 0x%02x\n",
7644 static int fan_set_disable(void)
7648 if (!fan_control_allowed)
7651 if (mutex_lock_killable(&fan_mutex))
7652 return -ERESTARTSYS;
7655 switch (fan_control_access_mode) {
7656 case TPACPI_FAN_WR_ACPI_FANS:
7657 case TPACPI_FAN_WR_TPEC:
7658 if (!acpi_ec_write(fan_status_offset, 0x00))
7661 fan_control_desired_level = 0;
7662 tp_features.fan_ctrl_status_undef = 0;
7666 case TPACPI_FAN_WR_ACPI_SFAN:
7667 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7670 fan_control_desired_level = 0;
7678 vdbg_printk(TPACPI_DBG_FAN,
7679 "fan control: set fan control register to 0\n");
7681 mutex_unlock(&fan_mutex);
7685 static int fan_set_speed(int speed)
7689 if (!fan_control_allowed)
7692 if (mutex_lock_killable(&fan_mutex))
7693 return -ERESTARTSYS;
7696 switch (fan_control_access_mode) {
7697 case TPACPI_FAN_WR_ACPI_FANS:
7698 if (speed >= 0 && speed <= 65535) {
7699 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7700 speed, speed, speed))
7710 mutex_unlock(&fan_mutex);
7714 static void fan_watchdog_reset(void)
7716 static int fan_watchdog_active;
7718 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7721 if (fan_watchdog_active)
7722 cancel_delayed_work(&fan_watchdog_task);
7724 if (fan_watchdog_maxinterval > 0 &&
7725 tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7726 fan_watchdog_active = 1;
7727 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7728 msecs_to_jiffies(fan_watchdog_maxinterval
7731 "failed to queue the fan watchdog, "
7732 "watchdog will not trigger\n");
7735 fan_watchdog_active = 0;
7738 static void fan_watchdog_fire(struct work_struct *ignored)
7742 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7745 printk(TPACPI_NOTICE "fan watchdog: enabling fan\n");
7746 rc = fan_set_enable();
7748 printk(TPACPI_ERR "fan watchdog: error %d while enabling fan, "
7749 "will try again later...\n", -rc);
7750 /* reschedule for later */
7751 fan_watchdog_reset();
7756 * SYSFS fan layout: hwmon compatible (device)
7759 * 0: "disengaged" mode
7761 * 2: native EC "auto" mode (recommended, hardware default)
7763 * pwm*: set speed in manual mode, ignored otherwise.
7764 * 0 is level 0; 255 is level 7. Intermediate points done with linear
7767 * fan*_input: tachometer reading, RPM
7770 * SYSFS fan layout: extensions
7772 * fan_watchdog (driver):
7773 * fan watchdog interval in seconds, 0 disables (default), max 120
7776 /* sysfs fan pwm1_enable ----------------------------------------------- */
7777 static ssize_t fan_pwm1_enable_show(struct device *dev,
7778 struct device_attribute *attr,
7784 res = fan_get_status_safe(&status);
7788 if (status & TP_EC_FAN_FULLSPEED) {
7790 } else if (status & TP_EC_FAN_AUTO) {
7795 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7798 static ssize_t fan_pwm1_enable_store(struct device *dev,
7799 struct device_attribute *attr,
7800 const char *buf, size_t count)
7805 if (parse_strtoul(buf, 2, &t))
7808 tpacpi_disclose_usertask("hwmon pwm1_enable",
7809 "set fan mode to %lu\n", t);
7813 level = TP_EC_FAN_FULLSPEED;
7816 level = TPACPI_FAN_LAST_LEVEL;
7819 level = TP_EC_FAN_AUTO;
7822 /* reserved for software-controlled auto mode */
7828 res = fan_set_level_safe(level);
7834 fan_watchdog_reset();
7839 static struct device_attribute dev_attr_fan_pwm1_enable =
7840 __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7841 fan_pwm1_enable_show, fan_pwm1_enable_store);
7843 /* sysfs fan pwm1 ------------------------------------------------------ */
7844 static ssize_t fan_pwm1_show(struct device *dev,
7845 struct device_attribute *attr,
7851 res = fan_get_status_safe(&status);
7856 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7857 status = fan_control_desired_level;
7862 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7865 static ssize_t fan_pwm1_store(struct device *dev,
7866 struct device_attribute *attr,
7867 const char *buf, size_t count)
7871 u8 status, newlevel;
7873 if (parse_strtoul(buf, 255, &s))
7876 tpacpi_disclose_usertask("hwmon pwm1",
7877 "set fan speed to %lu\n", s);
7879 /* scale down from 0-255 to 0-7 */
7880 newlevel = (s >> 5) & 0x07;
7882 if (mutex_lock_killable(&fan_mutex))
7883 return -ERESTARTSYS;
7885 rc = fan_get_status(&status);
7886 if (!rc && (status &
7887 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7888 rc = fan_set_level(newlevel);
7892 fan_update_desired_level(newlevel);
7893 fan_watchdog_reset();
7897 mutex_unlock(&fan_mutex);
7898 return (rc)? rc : count;
7901 static struct device_attribute dev_attr_fan_pwm1 =
7902 __ATTR(pwm1, S_IWUSR | S_IRUGO,
7903 fan_pwm1_show, fan_pwm1_store);
7905 /* sysfs fan fan1_input ------------------------------------------------ */
7906 static ssize_t fan_fan1_input_show(struct device *dev,
7907 struct device_attribute *attr,
7913 res = fan_get_speed(&speed);
7917 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7920 static struct device_attribute dev_attr_fan_fan1_input =
7921 __ATTR(fan1_input, S_IRUGO,
7922 fan_fan1_input_show, NULL);
7924 /* sysfs fan fan2_input ------------------------------------------------ */
7925 static ssize_t fan_fan2_input_show(struct device *dev,
7926 struct device_attribute *attr,
7932 res = fan2_get_speed(&speed);
7936 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7939 static struct device_attribute dev_attr_fan_fan2_input =
7940 __ATTR(fan2_input, S_IRUGO,
7941 fan_fan2_input_show, NULL);
7943 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7944 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7947 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7950 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7951 const char *buf, size_t count)
7955 if (parse_strtoul(buf, 120, &t))
7958 if (!fan_control_allowed)
7961 fan_watchdog_maxinterval = t;
7962 fan_watchdog_reset();
7964 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7969 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7970 fan_fan_watchdog_show, fan_fan_watchdog_store);
7972 /* --------------------------------------------------------------------- */
7973 static struct attribute *fan_attributes[] = {
7974 &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7975 &dev_attr_fan_fan1_input.attr,
7976 NULL, /* for fan2_input */
7980 static const struct attribute_group fan_attr_group = {
7981 .attrs = fan_attributes,
7984 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
7985 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
7987 #define TPACPI_FAN_QI(__id1, __id2, __quirks) \
7988 { .vendor = PCI_VENDOR_ID_IBM, \
7989 .bios = TPACPI_MATCH_ANY, \
7990 .ec = TPID(__id1, __id2), \
7991 .quirks = __quirks }
7993 #define TPACPI_FAN_QL(__id1, __id2, __quirks) \
7994 { .vendor = PCI_VENDOR_ID_LENOVO, \
7995 .bios = TPACPI_MATCH_ANY, \
7996 .ec = TPID(__id1, __id2), \
7997 .quirks = __quirks }
7999 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8000 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
8001 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
8002 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
8003 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
8004 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
8007 #undef TPACPI_FAN_QL
8008 #undef TPACPI_FAN_QI
8010 static int __init fan_init(struct ibm_init_struct *iibm)
8013 unsigned long quirks;
8015 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8016 "initializing fan subdriver\n");
8018 mutex_init(&fan_mutex);
8019 fan_status_access_mode = TPACPI_FAN_NONE;
8020 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8021 fan_control_commands = 0;
8022 fan_watchdog_maxinterval = 0;
8023 tp_features.fan_ctrl_status_undef = 0;
8024 tp_features.second_fan = 0;
8025 fan_control_desired_level = 7;
8027 if (tpacpi_is_ibm()) {
8028 TPACPI_ACPIHANDLE_INIT(fans);
8029 TPACPI_ACPIHANDLE_INIT(gfan);
8030 TPACPI_ACPIHANDLE_INIT(sfan);
8033 quirks = tpacpi_check_quirks(fan_quirk_table,
8034 ARRAY_SIZE(fan_quirk_table));
8037 /* 570, 600e/x, 770e, 770x */
8038 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8040 /* all other ThinkPads: note that even old-style
8041 * ThinkPad ECs supports the fan control register */
8042 if (likely(acpi_ec_read(fan_status_offset,
8043 &fan_control_initial_status))) {
8044 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8045 if (quirks & TPACPI_FAN_Q1)
8047 if (quirks & TPACPI_FAN_2FAN) {
8048 tp_features.second_fan = 1;
8049 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8050 "secondary fan support enabled\n");
8054 "ThinkPad ACPI EC access misbehaving, "
8055 "fan status and control unavailable\n");
8062 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8063 fan_control_commands |=
8064 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8067 /* gfan without sfan means no fan control */
8068 /* all other models implement TP EC 0x2f control */
8072 fan_control_access_mode =
8073 TPACPI_FAN_WR_ACPI_FANS;
8074 fan_control_commands |=
8075 TPACPI_FAN_CMD_SPEED |
8076 TPACPI_FAN_CMD_LEVEL |
8077 TPACPI_FAN_CMD_ENABLE;
8079 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8080 fan_control_commands |=
8081 TPACPI_FAN_CMD_LEVEL |
8082 TPACPI_FAN_CMD_ENABLE;
8087 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8088 "fan is %s, modes %d, %d\n",
8089 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8090 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8091 fan_status_access_mode, fan_control_access_mode);
8093 /* fan control master switch */
8094 if (!fan_control_allowed) {
8095 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8096 fan_control_commands = 0;
8097 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8098 "fan control features disabled by parameter\n");
8101 /* update fan_control_desired_level */
8102 if (fan_status_access_mode != TPACPI_FAN_NONE)
8103 fan_get_status_safe(NULL);
8105 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8106 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8107 if (tp_features.second_fan) {
8108 /* attach second fan tachometer */
8109 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8110 &dev_attr_fan_fan2_input.attr;
8112 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8117 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8118 &driver_attr_fan_watchdog);
8120 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8129 static void fan_exit(void)
8131 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8132 "cancelling any pending fan watchdog tasks\n");
8134 /* FIXME: can we really do this unconditionally? */
8135 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8136 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8137 &driver_attr_fan_watchdog);
8139 cancel_delayed_work(&fan_watchdog_task);
8140 flush_workqueue(tpacpi_wq);
8143 static void fan_suspend(pm_message_t state)
8147 if (!fan_control_allowed)
8150 /* Store fan status in cache */
8151 fan_control_resume_level = 0;
8152 rc = fan_get_status_safe(&fan_control_resume_level);
8154 printk(TPACPI_NOTICE
8155 "failed to read fan level for later "
8156 "restore during resume: %d\n", rc);
8158 /* if it is undefined, don't attempt to restore it.
8160 if (tp_features.fan_ctrl_status_undef)
8161 fan_control_resume_level = 0;
8164 static void fan_resume(void)
8166 u8 current_level = 7;
8167 bool do_set = false;
8170 /* DSDT *always* updates status on resume */
8171 tp_features.fan_ctrl_status_undef = 0;
8173 if (!fan_control_allowed ||
8174 !fan_control_resume_level ||
8175 (fan_get_status_safe(¤t_level) < 0))
8178 switch (fan_control_access_mode) {
8179 case TPACPI_FAN_WR_ACPI_SFAN:
8180 /* never decrease fan level */
8181 do_set = (fan_control_resume_level > current_level);
8183 case TPACPI_FAN_WR_ACPI_FANS:
8184 case TPACPI_FAN_WR_TPEC:
8185 /* never decrease fan level, scale is:
8186 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8188 * We expect the firmware to set either 7 or AUTO, but we
8189 * handle FULLSPEED out of paranoia.
8191 * So, we can safely only restore FULLSPEED or 7, anything
8192 * else could slow the fan. Restoring AUTO is useless, at
8193 * best that's exactly what the DSDT already set (it is the
8196 * Always keep in mind that the DSDT *will* have set the
8197 * fans to what the vendor supposes is the best level. We
8198 * muck with it only to speed the fan up.
8200 if (fan_control_resume_level != 7 &&
8201 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8204 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8205 (current_level != fan_control_resume_level);
8211 printk(TPACPI_NOTICE
8212 "restoring fan level to 0x%02x\n",
8213 fan_control_resume_level);
8214 rc = fan_set_level_safe(fan_control_resume_level);
8216 printk(TPACPI_NOTICE
8217 "failed to restore fan level: %d\n", rc);
8221 static int fan_read(struct seq_file *m)
8225 unsigned int speed = 0;
8227 switch (fan_status_access_mode) {
8228 case TPACPI_FAN_RD_ACPI_GFAN:
8229 /* 570, 600e/x, 770e, 770x */
8230 rc = fan_get_status_safe(&status);
8234 seq_printf(m, "status:\t\t%s\n"
8236 (status != 0) ? "enabled" : "disabled", status);
8239 case TPACPI_FAN_RD_TPEC:
8240 /* all except 570, 600e/x, 770e, 770x */
8241 rc = fan_get_status_safe(&status);
8245 seq_printf(m, "status:\t\t%s\n",
8246 (status != 0) ? "enabled" : "disabled");
8248 rc = fan_get_speed(&speed);
8252 seq_printf(m, "speed:\t\t%d\n", speed);
8254 if (status & TP_EC_FAN_FULLSPEED)
8255 /* Disengaged mode takes precedence */
8256 seq_printf(m, "level:\t\tdisengaged\n");
8257 else if (status & TP_EC_FAN_AUTO)
8258 seq_printf(m, "level:\t\tauto\n");
8260 seq_printf(m, "level:\t\t%d\n", status);
8263 case TPACPI_FAN_NONE:
8265 seq_printf(m, "status:\t\tnot supported\n");
8268 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8269 seq_printf(m, "commands:\tlevel <level>");
8271 switch (fan_control_access_mode) {
8272 case TPACPI_FAN_WR_ACPI_SFAN:
8273 seq_printf(m, " (<level> is 0-7)\n");
8277 seq_printf(m, " (<level> is 0-7, "
8278 "auto, disengaged, full-speed)\n");
8283 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8284 seq_printf(m, "commands:\tenable, disable\n"
8285 "commands:\twatchdog <timeout> (<timeout> "
8286 "is 0 (off), 1-120 (seconds))\n");
8288 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8289 seq_printf(m, "commands:\tspeed <speed>"
8290 " (<speed> is 0-65535)\n");
8295 static int fan_write_cmd_level(const char *cmd, int *rc)
8299 if (strlencmp(cmd, "level auto") == 0)
8300 level = TP_EC_FAN_AUTO;
8301 else if ((strlencmp(cmd, "level disengaged") == 0) |
8302 (strlencmp(cmd, "level full-speed") == 0))
8303 level = TP_EC_FAN_FULLSPEED;
8304 else if (sscanf(cmd, "level %d", &level) != 1)
8307 *rc = fan_set_level_safe(level);
8309 printk(TPACPI_ERR "level command accepted for unsupported "
8310 "access mode %d", fan_control_access_mode);
8312 tpacpi_disclose_usertask("procfs fan",
8313 "set level to %d\n", level);
8318 static int fan_write_cmd_enable(const char *cmd, int *rc)
8320 if (strlencmp(cmd, "enable") != 0)
8323 *rc = fan_set_enable();
8325 printk(TPACPI_ERR "enable command accepted for unsupported "
8326 "access mode %d", fan_control_access_mode);
8328 tpacpi_disclose_usertask("procfs fan", "enable\n");
8333 static int fan_write_cmd_disable(const char *cmd, int *rc)
8335 if (strlencmp(cmd, "disable") != 0)
8338 *rc = fan_set_disable();
8340 printk(TPACPI_ERR "disable command accepted for unsupported "
8341 "access mode %d", fan_control_access_mode);
8343 tpacpi_disclose_usertask("procfs fan", "disable\n");
8348 static int fan_write_cmd_speed(const char *cmd, int *rc)
8353 * Support speed <low> <medium> <high> ? */
8355 if (sscanf(cmd, "speed %d", &speed) != 1)
8358 *rc = fan_set_speed(speed);
8360 printk(TPACPI_ERR "speed command accepted for unsupported "
8361 "access mode %d", fan_control_access_mode);
8363 tpacpi_disclose_usertask("procfs fan",
8364 "set speed to %d\n", speed);
8369 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8373 if (sscanf(cmd, "watchdog %d", &interval) != 1)
8376 if (interval < 0 || interval > 120)
8379 fan_watchdog_maxinterval = interval;
8380 tpacpi_disclose_usertask("procfs fan",
8381 "set watchdog timer to %d\n",
8388 static int fan_write(char *buf)
8393 while (!rc && (cmd = next_cmd(&buf))) {
8394 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8395 fan_write_cmd_level(cmd, &rc)) &&
8396 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8397 (fan_write_cmd_enable(cmd, &rc) ||
8398 fan_write_cmd_disable(cmd, &rc) ||
8399 fan_write_cmd_watchdog(cmd, &rc))) &&
8400 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8401 fan_write_cmd_speed(cmd, &rc))
8405 fan_watchdog_reset();
8411 static struct ibm_struct fan_driver_data = {
8416 .suspend = fan_suspend,
8417 .resume = fan_resume,
8420 /****************************************************************************
8421 ****************************************************************************
8425 ****************************************************************************
8426 ****************************************************************************/
8429 * HKEY event callout for other subdrivers go here
8430 * (yes, it is ugly, but it is quick, safe, and gets the job done
8432 static void tpacpi_driver_event(const unsigned int hkey_event)
8434 if (ibm_backlight_device) {
8435 switch (hkey_event) {
8436 case TP_HKEY_EV_BRGHT_UP:
8437 case TP_HKEY_EV_BRGHT_DOWN:
8438 tpacpi_brightness_notify_change();
8442 switch (hkey_event) {
8443 case TP_HKEY_EV_VOL_UP:
8444 case TP_HKEY_EV_VOL_DOWN:
8445 case TP_HKEY_EV_VOL_MUTE:
8446 volume_alsa_notify_change();
8451 static void hotkey_driver_event(const unsigned int scancode)
8453 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8456 /* sysfs name ---------------------------------------------------------- */
8457 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8458 struct device_attribute *attr,
8461 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8464 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8465 __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8467 /* --------------------------------------------------------------------- */
8470 static struct proc_dir_entry *proc_dir;
8473 * Module and infrastructure proble, init and exit handling
8476 static int force_load;
8478 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
8479 static const char * __init str_supported(int is_supported)
8481 static char text_unsupported[] __initdata = "not supported";
8483 return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8485 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8487 static void ibm_exit(struct ibm_struct *ibm)
8489 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8491 list_del_init(&ibm->all_drivers);
8493 if (ibm->flags.acpi_notify_installed) {
8494 dbg_printk(TPACPI_DBG_EXIT,
8495 "%s: acpi_remove_notify_handler\n", ibm->name);
8497 acpi_remove_notify_handler(*ibm->acpi->handle,
8499 dispatch_acpi_notify);
8500 ibm->flags.acpi_notify_installed = 0;
8503 if (ibm->flags.proc_created) {
8504 dbg_printk(TPACPI_DBG_EXIT,
8505 "%s: remove_proc_entry\n", ibm->name);
8506 remove_proc_entry(ibm->name, proc_dir);
8507 ibm->flags.proc_created = 0;
8510 if (ibm->flags.acpi_driver_registered) {
8511 dbg_printk(TPACPI_DBG_EXIT,
8512 "%s: acpi_bus_unregister_driver\n", ibm->name);
8514 acpi_bus_unregister_driver(ibm->acpi->driver);
8515 kfree(ibm->acpi->driver);
8516 ibm->acpi->driver = NULL;
8517 ibm->flags.acpi_driver_registered = 0;
8520 if (ibm->flags.init_called && ibm->exit) {
8522 ibm->flags.init_called = 0;
8525 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8528 static int __init ibm_init(struct ibm_init_struct *iibm)
8531 struct ibm_struct *ibm = iibm->data;
8532 struct proc_dir_entry *entry;
8534 BUG_ON(ibm == NULL);
8536 INIT_LIST_HEAD(&ibm->all_drivers);
8538 if (ibm->flags.experimental && !experimental)
8541 dbg_printk(TPACPI_DBG_INIT,
8542 "probing for %s\n", ibm->name);
8545 ret = iibm->init(iibm);
8547 return 0; /* probe failed */
8551 ibm->flags.init_called = 1;
8555 if (ibm->acpi->hid) {
8556 ret = register_tpacpi_subdriver(ibm);
8561 if (ibm->acpi->notify) {
8562 ret = setup_acpi_notify(ibm);
8563 if (ret == -ENODEV) {
8564 printk(TPACPI_NOTICE "disabling subdriver %s\n",
8574 dbg_printk(TPACPI_DBG_INIT,
8575 "%s installed\n", ibm->name);
8578 mode_t mode = iibm->base_procfs_mode;
8584 entry = proc_create_data(ibm->name, mode, proc_dir,
8585 &dispatch_proc_fops, ibm);
8587 printk(TPACPI_ERR "unable to create proc entry %s\n",
8592 ibm->flags.proc_created = 1;
8595 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8600 dbg_printk(TPACPI_DBG_INIT,
8601 "%s: at error exit path with result %d\n",
8605 return (ret < 0)? ret : 0;
8610 static bool __pure __init tpacpi_is_fw_digit(const char c)
8612 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8615 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8616 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8619 return s && strlen(s) >= 8 &&
8620 tpacpi_is_fw_digit(s[0]) &&
8621 tpacpi_is_fw_digit(s[1]) &&
8622 s[2] == t && s[3] == 'T' &&
8623 tpacpi_is_fw_digit(s[4]) &&
8624 tpacpi_is_fw_digit(s[5]) &&
8625 s[6] == 'W' && s[7] == 'W';
8628 /* returns 0 - probe ok, or < 0 - probe error.
8629 * Probe ok doesn't mean thinkpad found.
8630 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8631 static int __must_check __init get_thinkpad_model_data(
8632 struct thinkpad_id_data *tp)
8634 const struct dmi_device *dev = NULL;
8635 char ec_fw_string[18];
8641 memset(tp, 0, sizeof(*tp));
8643 if (dmi_name_in_vendors("IBM"))
8644 tp->vendor = PCI_VENDOR_ID_IBM;
8645 else if (dmi_name_in_vendors("LENOVO"))
8646 tp->vendor = PCI_VENDOR_ID_LENOVO;
8650 s = dmi_get_system_info(DMI_BIOS_VERSION);
8651 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8652 if (s && !tp->bios_version_str)
8655 /* Really ancient ThinkPad 240X will fail this, which is fine */
8656 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
8659 tp->bios_model = tp->bios_version_str[0]
8660 | (tp->bios_version_str[1] << 8);
8661 tp->bios_release = (tp->bios_version_str[4] << 8)
8662 | tp->bios_version_str[5];
8665 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8666 * X32 or newer, all Z series; Some models must have an
8667 * up-to-date BIOS or they will not be detected.
8669 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8671 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8672 if (sscanf(dev->name,
8673 "IBM ThinkPad Embedded Controller -[%17c",
8674 ec_fw_string) == 1) {
8675 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8676 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8678 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8679 if (!tp->ec_version_str)
8682 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8683 tp->ec_model = ec_fw_string[0]
8684 | (ec_fw_string[1] << 8);
8685 tp->ec_release = (ec_fw_string[4] << 8)
8688 printk(TPACPI_NOTICE
8689 "ThinkPad firmware release %s "
8690 "doesn't match the known patterns\n",
8692 printk(TPACPI_NOTICE
8693 "please report this to %s\n",
8700 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8701 if (s && !strnicmp(s, "ThinkPad", 8)) {
8702 tp->model_str = kstrdup(s, GFP_KERNEL);
8707 s = dmi_get_system_info(DMI_PRODUCT_NAME);
8708 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8709 if (s && !tp->nummodel_str)
8715 static int __init probe_for_thinkpad(void)
8722 /* It would be dangerous to run the driver in this case */
8723 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8727 * Non-ancient models have better DMI tagging, but very old models
8728 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
8730 is_thinkpad = (thinkpad_id.model_str != NULL) ||
8731 (thinkpad_id.ec_model != 0) ||
8732 tpacpi_is_fw_known();
8734 /* The EC handler is required */
8735 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
8739 "Not yet supported ThinkPad detected!\n");
8743 if (!is_thinkpad && !force_load)
8749 static void __init thinkpad_acpi_init_banner(void)
8751 printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
8752 printk(TPACPI_INFO "%s\n", TPACPI_URL);
8754 printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
8755 (thinkpad_id.bios_version_str) ?
8756 thinkpad_id.bios_version_str : "unknown",
8757 (thinkpad_id.ec_version_str) ?
8758 thinkpad_id.ec_version_str : "unknown");
8760 BUG_ON(!thinkpad_id.vendor);
8762 if (thinkpad_id.model_str)
8763 printk(TPACPI_INFO "%s %s, model %s\n",
8764 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
8765 "IBM" : ((thinkpad_id.vendor ==
8766 PCI_VENDOR_ID_LENOVO) ?
8767 "Lenovo" : "Unknown vendor"),
8768 thinkpad_id.model_str,
8769 (thinkpad_id.nummodel_str) ?
8770 thinkpad_id.nummodel_str : "unknown");
8773 /* Module init, exit, parameters */
8775 static struct ibm_init_struct ibms_init[] __initdata = {
8777 .data = &thinkpad_acpi_driver_data,
8780 .init = hotkey_init,
8781 .data = &hotkey_driver_data,
8784 .init = bluetooth_init,
8785 .data = &bluetooth_driver_data,
8789 .data = &wan_driver_data,
8793 .data = &uwb_driver_data,
8795 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8798 .base_procfs_mode = S_IRUSR,
8799 .data = &video_driver_data,
8804 .data = &light_driver_data,
8808 .data = &cmos_driver_data,
8812 .data = &led_driver_data,
8816 .data = &beep_driver_data,
8819 .init = thermal_init,
8820 .data = &thermal_driver_data,
8823 .init = brightness_init,
8824 .data = &brightness_driver_data,
8827 .init = volume_init,
8828 .data = &volume_driver_data,
8832 .data = &fan_driver_data,
8836 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8839 struct ibm_struct *ibm;
8841 if (!kp || !kp->name || !val)
8844 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8845 ibm = ibms_init[i].data;
8846 WARN_ON(ibm == NULL);
8848 if (!ibm || !ibm->name)
8851 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8852 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8854 strcpy(ibms_init[i].param, val);
8855 strcat(ibms_init[i].param, ",");
8863 module_param(experimental, int, 0444);
8864 MODULE_PARM_DESC(experimental,
8865 "Enables experimental features when non-zero");
8867 module_param_named(debug, dbg_level, uint, 0);
8868 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8870 module_param(force_load, bool, 0444);
8871 MODULE_PARM_DESC(force_load,
8872 "Attempts to load the driver even on a "
8873 "mis-identified ThinkPad when true");
8875 module_param_named(fan_control, fan_control_allowed, bool, 0444);
8876 MODULE_PARM_DESC(fan_control,
8877 "Enables setting fan parameters features when true");
8879 module_param_named(brightness_mode, brightness_mode, uint, 0444);
8880 MODULE_PARM_DESC(brightness_mode,
8881 "Selects brightness control strategy: "
8882 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8884 module_param(brightness_enable, uint, 0444);
8885 MODULE_PARM_DESC(brightness_enable,
8886 "Enables backlight control when 1, disables when 0");
8888 module_param(hotkey_report_mode, uint, 0444);
8889 MODULE_PARM_DESC(hotkey_report_mode,
8890 "used for backwards compatibility with userspace, "
8891 "see documentation");
8893 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8894 module_param_named(volume_mode, volume_mode, uint, 0444);
8895 MODULE_PARM_DESC(volume_mode,
8896 "Selects volume control strategy: "
8897 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8899 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8900 MODULE_PARM_DESC(volume_capabilities,
8901 "Selects the mixer capabilites: "
8902 "0=auto, 1=volume and mute, 2=mute only");
8904 module_param_named(volume_control, volume_control_allowed, bool, 0444);
8905 MODULE_PARM_DESC(volume_control,
8906 "Enables software override for the console audio "
8907 "control when true");
8909 /* ALSA module API parameters */
8910 module_param_named(index, alsa_index, int, 0444);
8911 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8912 module_param_named(id, alsa_id, charp, 0444);
8913 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8914 module_param_named(enable, alsa_enable, bool, 0444);
8915 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8916 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8918 #define TPACPI_PARAM(feature) \
8919 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8920 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8921 "at module load, see documentation")
8923 TPACPI_PARAM(hotkey);
8924 TPACPI_PARAM(bluetooth);
8925 TPACPI_PARAM(video);
8926 TPACPI_PARAM(light);
8930 TPACPI_PARAM(brightness);
8931 TPACPI_PARAM(volume);
8934 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8935 module_param(dbg_wlswemul, uint, 0444);
8936 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8937 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8938 MODULE_PARM_DESC(wlsw_state,
8939 "Initial state of the emulated WLSW switch");
8941 module_param(dbg_bluetoothemul, uint, 0444);
8942 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8943 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8944 MODULE_PARM_DESC(bluetooth_state,
8945 "Initial state of the emulated bluetooth switch");
8947 module_param(dbg_wwanemul, uint, 0444);
8948 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8949 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8950 MODULE_PARM_DESC(wwan_state,
8951 "Initial state of the emulated WWAN switch");
8953 module_param(dbg_uwbemul, uint, 0444);
8954 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8955 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8956 MODULE_PARM_DESC(uwb_state,
8957 "Initial state of the emulated UWB switch");
8960 static void thinkpad_acpi_module_exit(void)
8962 struct ibm_struct *ibm, *itmp;
8964 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8966 list_for_each_entry_safe_reverse(ibm, itmp,
8967 &tpacpi_all_drivers,
8972 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8974 if (tpacpi_inputdev) {
8975 if (tp_features.input_device_registered)
8976 input_unregister_device(tpacpi_inputdev);
8978 input_free_device(tpacpi_inputdev);
8982 hwmon_device_unregister(tpacpi_hwmon);
8984 if (tp_features.sensors_pdev_attrs_registered)
8985 device_remove_file(&tpacpi_sensors_pdev->dev,
8986 &dev_attr_thinkpad_acpi_pdev_name);
8987 if (tpacpi_sensors_pdev)
8988 platform_device_unregister(tpacpi_sensors_pdev);
8990 platform_device_unregister(tpacpi_pdev);
8992 if (tp_features.sensors_pdrv_attrs_registered)
8993 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8994 if (tp_features.platform_drv_attrs_registered)
8995 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8997 if (tp_features.sensors_pdrv_registered)
8998 platform_driver_unregister(&tpacpi_hwmon_pdriver);
9000 if (tp_features.platform_drv_registered)
9001 platform_driver_unregister(&tpacpi_pdriver);
9004 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
9007 destroy_workqueue(tpacpi_wq);
9009 kfree(thinkpad_id.bios_version_str);
9010 kfree(thinkpad_id.ec_version_str);
9011 kfree(thinkpad_id.model_str);
9015 static int __init thinkpad_acpi_module_init(void)
9019 tpacpi_lifecycle = TPACPI_LIFE_INIT;
9021 /* Parameter checking */
9022 if (hotkey_report_mode > 2)
9025 /* Driver-level probe */
9027 ret = get_thinkpad_model_data(&thinkpad_id);
9030 "unable to get DMI data: %d\n", ret);
9031 thinkpad_acpi_module_exit();
9034 ret = probe_for_thinkpad();
9036 thinkpad_acpi_module_exit();
9040 /* Driver initialization */
9042 thinkpad_acpi_init_banner();
9043 tpacpi_check_outdated_fw();
9045 TPACPI_ACPIHANDLE_INIT(ecrd);
9046 TPACPI_ACPIHANDLE_INIT(ecwr);
9048 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9050 thinkpad_acpi_module_exit();
9054 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9057 "unable to create proc dir " TPACPI_PROC_DIR);
9058 thinkpad_acpi_module_exit();
9062 ret = platform_driver_register(&tpacpi_pdriver);
9065 "unable to register main platform driver\n");
9066 thinkpad_acpi_module_exit();
9069 tp_features.platform_drv_registered = 1;
9071 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9074 "unable to register hwmon platform driver\n");
9075 thinkpad_acpi_module_exit();
9078 tp_features.sensors_pdrv_registered = 1;
9080 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9082 tp_features.platform_drv_attrs_registered = 1;
9083 ret = tpacpi_create_driver_attributes(
9084 &tpacpi_hwmon_pdriver.driver);
9088 "unable to create sysfs driver attributes\n");
9089 thinkpad_acpi_module_exit();
9092 tp_features.sensors_pdrv_attrs_registered = 1;
9095 /* Device initialization */
9096 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9098 if (IS_ERR(tpacpi_pdev)) {
9099 ret = PTR_ERR(tpacpi_pdev);
9101 printk(TPACPI_ERR "unable to register platform device\n");
9102 thinkpad_acpi_module_exit();
9105 tpacpi_sensors_pdev = platform_device_register_simple(
9106 TPACPI_HWMON_DRVR_NAME,
9108 if (IS_ERR(tpacpi_sensors_pdev)) {
9109 ret = PTR_ERR(tpacpi_sensors_pdev);
9110 tpacpi_sensors_pdev = NULL;
9112 "unable to register hwmon platform device\n");
9113 thinkpad_acpi_module_exit();
9116 ret = device_create_file(&tpacpi_sensors_pdev->dev,
9117 &dev_attr_thinkpad_acpi_pdev_name);
9120 "unable to create sysfs hwmon device attributes\n");
9121 thinkpad_acpi_module_exit();
9124 tp_features.sensors_pdev_attrs_registered = 1;
9125 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9126 if (IS_ERR(tpacpi_hwmon)) {
9127 ret = PTR_ERR(tpacpi_hwmon);
9128 tpacpi_hwmon = NULL;
9129 printk(TPACPI_ERR "unable to register hwmon device\n");
9130 thinkpad_acpi_module_exit();
9133 mutex_init(&tpacpi_inputdev_send_mutex);
9134 tpacpi_inputdev = input_allocate_device();
9135 if (!tpacpi_inputdev) {
9136 printk(TPACPI_ERR "unable to allocate input device\n");
9137 thinkpad_acpi_module_exit();
9140 /* Prepare input device, but don't register */
9141 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9142 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9143 tpacpi_inputdev->id.bustype = BUS_HOST;
9144 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9145 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9146 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9147 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9150 /* Init subdriver dependencies */
9151 tpacpi_detect_brightness_capabilities();
9153 /* Init subdrivers */
9154 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9155 ret = ibm_init(&ibms_init[i]);
9156 if (ret >= 0 && *ibms_init[i].param)
9157 ret = ibms_init[i].data->write(ibms_init[i].param);
9159 thinkpad_acpi_module_exit();
9164 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9166 ret = input_register_device(tpacpi_inputdev);
9168 printk(TPACPI_ERR "unable to register input device\n");
9169 thinkpad_acpi_module_exit();
9172 tp_features.input_device_registered = 1;
9178 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9181 * This will autoload the driver in almost every ThinkPad
9182 * in widespread use.
9184 * Only _VERY_ old models, like the 240, 240x and 570 lack
9185 * the HKEY event interface.
9187 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9190 * DMI matching for module autoloading
9192 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9193 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9195 * Only models listed in thinkwiki will be supported, so add yours
9196 * if it is not there yet.
9198 #define IBM_BIOS_MODULE_ALIAS(__type) \
9199 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9201 /* Ancient thinkpad BIOSes have to be identified by
9202 * BIOS type or model number, and there are far less
9203 * BIOS types than model numbers... */
9204 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
9206 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9207 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9208 MODULE_DESCRIPTION(TPACPI_DESC);
9209 MODULE_VERSION(TPACPI_VERSION);
9210 MODULE_LICENSE("GPL");
9212 module_init(thinkpad_acpi_module_init);
9213 module_exit(thinkpad_acpi_module_exit);