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_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2279 input_report_key(tpacpi_inputdev, keycode, 1);
2280 input_sync(tpacpi_inputdev);
2282 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2283 input_report_key(tpacpi_inputdev, keycode, 0);
2284 input_sync(tpacpi_inputdev);
2286 mutex_unlock(&tpacpi_inputdev_send_mutex);
2290 /* Do NOT call without validating scancode first */
2291 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2293 hotkey_driver_event(scancode);
2294 if (hotkey_user_mask & (1 << scancode))
2295 tpacpi_input_send_key(scancode);
2298 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2299 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2301 /* Do NOT call without validating scancode first */
2302 static void tpacpi_hotkey_send_key(unsigned int scancode)
2304 tpacpi_input_send_key_masked(scancode);
2305 if (hotkey_report_mode < 2) {
2306 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2307 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2311 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2315 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2316 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2317 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2318 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2319 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2320 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2322 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2323 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2324 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2326 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2327 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2328 n->displayexp_toggle =
2329 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2331 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2332 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2333 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2334 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2335 n->brightness_toggle =
2336 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2338 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2339 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2340 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2341 >> TP_NVRAM_POS_LEVEL_VOLUME;
2342 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2343 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2347 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2348 struct tp_nvram_state *newn,
2349 const u32 event_mask)
2352 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2354 if ((event_mask & (1 << __scancode)) && \
2355 oldn->__member != newn->__member) \
2356 tpacpi_hotkey_send_key(__scancode); \
2359 #define TPACPI_MAY_SEND_KEY(__scancode) \
2361 if (event_mask & (1 << __scancode)) \
2362 tpacpi_hotkey_send_key(__scancode); \
2365 void issue_volchange(const unsigned int oldvol,
2366 const unsigned int newvol)
2368 unsigned int i = oldvol;
2370 while (i > newvol) {
2371 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2374 while (i < newvol) {
2375 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2380 void issue_brightnesschange(const unsigned int oldbrt,
2381 const unsigned int newbrt)
2383 unsigned int i = oldbrt;
2385 while (i > newbrt) {
2386 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2389 while (i < newbrt) {
2390 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2395 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2396 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2397 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2398 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2400 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2402 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2407 * This code is supposed to duplicate the IBM firmware behaviour:
2408 * - Pressing MUTE issues mute hotkey message, even when already mute
2409 * - Pressing Volume up/down issues volume up/down hotkey messages,
2410 * even when already at maximum or minimum volume
2411 * - The act of unmuting issues volume up/down notification,
2412 * depending which key was used to unmute
2414 * We are constrained to what the NVRAM can tell us, which is not much
2415 * and certainly not enough if more than one volume hotkey was pressed
2416 * since the last poll cycle.
2418 * Just to make our life interesting, some newer Lenovo ThinkPads have
2419 * bugs in the BIOS and may fail to update volume_toggle properly.
2424 oldn->volume_toggle != newn->volume_toggle ||
2425 oldn->volume_level != newn->volume_level) {
2426 /* recently muted, or repeated mute keypress, or
2427 * multiple presses ending in mute */
2428 issue_volchange(oldn->volume_level, newn->volume_level);
2429 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2434 /* recently unmuted, issue 'unmute' keypress */
2435 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2437 if (oldn->volume_level != newn->volume_level) {
2438 issue_volchange(oldn->volume_level, newn->volume_level);
2439 } else if (oldn->volume_toggle != newn->volume_toggle) {
2440 /* repeated vol up/down keypress at end of scale ? */
2441 if (newn->volume_level == 0)
2442 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2443 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2444 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2448 /* handle brightness */
2449 if (oldn->brightness_level != newn->brightness_level) {
2450 issue_brightnesschange(oldn->brightness_level,
2451 newn->brightness_level);
2452 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2453 /* repeated key presses that didn't change state */
2454 if (newn->brightness_level == 0)
2455 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2456 else if (newn->brightness_level >= bright_maxlvl
2457 && !tp_features.bright_unkfw)
2458 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2461 #undef TPACPI_COMPARE_KEY
2462 #undef TPACPI_MAY_SEND_KEY
2468 * We track all events in hotkey_source_mask all the time, since
2469 * most of them are edge-based. We only issue those requested by
2470 * hotkey_user_mask or hotkey_driver_mask, though.
2472 static int hotkey_kthread(void *data)
2474 struct tp_nvram_state s[2];
2475 u32 poll_mask, event_mask;
2476 unsigned int si, so;
2478 unsigned int change_detector, must_reset;
2479 unsigned int poll_freq;
2481 mutex_lock(&hotkey_thread_mutex);
2483 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2492 /* Initial state for compares */
2493 mutex_lock(&hotkey_thread_data_mutex);
2494 change_detector = hotkey_config_change;
2495 poll_mask = hotkey_source_mask;
2496 event_mask = hotkey_source_mask &
2497 (hotkey_driver_mask | hotkey_user_mask);
2498 poll_freq = hotkey_poll_freq;
2499 mutex_unlock(&hotkey_thread_data_mutex);
2500 hotkey_read_nvram(&s[so], poll_mask);
2502 while (!kthread_should_stop()) {
2504 if (likely(poll_freq))
2507 t = 100; /* should never happen... */
2509 t = msleep_interruptible(t);
2510 if (unlikely(kthread_should_stop()))
2512 must_reset = try_to_freeze();
2513 if (t > 0 && !must_reset)
2516 mutex_lock(&hotkey_thread_data_mutex);
2517 if (must_reset || hotkey_config_change != change_detector) {
2518 /* forget old state on thaw or config change */
2521 change_detector = hotkey_config_change;
2523 poll_mask = hotkey_source_mask;
2524 event_mask = hotkey_source_mask &
2525 (hotkey_driver_mask | hotkey_user_mask);
2526 poll_freq = hotkey_poll_freq;
2527 mutex_unlock(&hotkey_thread_data_mutex);
2529 if (likely(poll_mask)) {
2530 hotkey_read_nvram(&s[si], poll_mask);
2531 if (likely(si != so)) {
2532 hotkey_compare_and_issue_event(&s[so], &s[si],
2542 mutex_unlock(&hotkey_thread_mutex);
2546 /* call with hotkey_mutex held */
2547 static void hotkey_poll_stop_sync(void)
2549 if (tpacpi_hotkey_task) {
2550 if (frozen(tpacpi_hotkey_task) ||
2551 freezing(tpacpi_hotkey_task))
2552 thaw_process(tpacpi_hotkey_task);
2554 kthread_stop(tpacpi_hotkey_task);
2555 tpacpi_hotkey_task = NULL;
2556 mutex_lock(&hotkey_thread_mutex);
2557 /* at this point, the thread did exit */
2558 mutex_unlock(&hotkey_thread_mutex);
2562 /* call with hotkey_mutex held */
2563 static void hotkey_poll_setup(const bool may_warn)
2565 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2566 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2568 if (hotkey_poll_freq > 0 &&
2569 (poll_driver_mask ||
2570 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2571 if (!tpacpi_hotkey_task) {
2572 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2573 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2574 if (IS_ERR(tpacpi_hotkey_task)) {
2575 tpacpi_hotkey_task = NULL;
2577 "could not create kernel thread "
2578 "for hotkey polling\n");
2582 hotkey_poll_stop_sync();
2583 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2584 hotkey_poll_freq == 0) {
2585 printk(TPACPI_NOTICE
2586 "hot keys 0x%08x and/or events 0x%08x "
2587 "require polling, which is currently "
2589 poll_user_mask, poll_driver_mask);
2594 static void hotkey_poll_setup_safe(const bool may_warn)
2596 mutex_lock(&hotkey_mutex);
2597 hotkey_poll_setup(may_warn);
2598 mutex_unlock(&hotkey_mutex);
2601 /* call with hotkey_mutex held */
2602 static void hotkey_poll_set_freq(unsigned int freq)
2605 hotkey_poll_stop_sync();
2607 hotkey_poll_freq = freq;
2610 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2612 static void hotkey_poll_setup(const bool __unused)
2616 static void hotkey_poll_setup_safe(const bool __unused)
2620 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2622 static int hotkey_inputdev_open(struct input_dev *dev)
2624 switch (tpacpi_lifecycle) {
2625 case TPACPI_LIFE_INIT:
2626 case TPACPI_LIFE_RUNNING:
2627 hotkey_poll_setup_safe(false);
2629 case TPACPI_LIFE_EXITING:
2633 /* Should only happen if tpacpi_lifecycle is corrupt */
2638 static void hotkey_inputdev_close(struct input_dev *dev)
2640 /* disable hotkey polling when possible */
2641 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2642 !(hotkey_source_mask & hotkey_driver_mask))
2643 hotkey_poll_setup_safe(false);
2646 /* sysfs hotkey enable ------------------------------------------------- */
2647 static ssize_t hotkey_enable_show(struct device *dev,
2648 struct device_attribute *attr,
2653 printk_deprecated_attribute("hotkey_enable",
2654 "Hotkey reporting is always enabled");
2656 res = hotkey_status_get(&status);
2660 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2663 static ssize_t hotkey_enable_store(struct device *dev,
2664 struct device_attribute *attr,
2665 const char *buf, size_t count)
2669 printk_deprecated_attribute("hotkey_enable",
2670 "Hotkeys can be disabled through hotkey_mask");
2672 if (parse_strtoul(buf, 1, &t))
2681 static struct device_attribute dev_attr_hotkey_enable =
2682 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2683 hotkey_enable_show, hotkey_enable_store);
2685 /* sysfs hotkey mask --------------------------------------------------- */
2686 static ssize_t hotkey_mask_show(struct device *dev,
2687 struct device_attribute *attr,
2690 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2693 static ssize_t hotkey_mask_store(struct device *dev,
2694 struct device_attribute *attr,
2695 const char *buf, size_t count)
2700 if (parse_strtoul(buf, 0xffffffffUL, &t))
2703 if (mutex_lock_killable(&hotkey_mutex))
2704 return -ERESTARTSYS;
2706 res = hotkey_user_mask_set(t);
2708 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2709 hotkey_poll_setup(true);
2712 mutex_unlock(&hotkey_mutex);
2714 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2716 return (res) ? res : count;
2719 static struct device_attribute dev_attr_hotkey_mask =
2720 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2721 hotkey_mask_show, hotkey_mask_store);
2723 /* sysfs hotkey bios_enabled ------------------------------------------- */
2724 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2725 struct device_attribute *attr,
2728 return sprintf(buf, "0\n");
2731 static struct device_attribute dev_attr_hotkey_bios_enabled =
2732 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2734 /* sysfs hotkey bios_mask ---------------------------------------------- */
2735 static ssize_t hotkey_bios_mask_show(struct device *dev,
2736 struct device_attribute *attr,
2739 printk_deprecated_attribute("hotkey_bios_mask",
2740 "This attribute is useless.");
2741 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2744 static struct device_attribute dev_attr_hotkey_bios_mask =
2745 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2747 /* sysfs hotkey all_mask ----------------------------------------------- */
2748 static ssize_t hotkey_all_mask_show(struct device *dev,
2749 struct device_attribute *attr,
2752 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2753 hotkey_all_mask | hotkey_source_mask);
2756 static struct device_attribute dev_attr_hotkey_all_mask =
2757 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2759 /* sysfs hotkey recommended_mask --------------------------------------- */
2760 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2761 struct device_attribute *attr,
2764 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2765 (hotkey_all_mask | hotkey_source_mask)
2766 & ~hotkey_reserved_mask);
2769 static struct device_attribute dev_attr_hotkey_recommended_mask =
2770 __ATTR(hotkey_recommended_mask, S_IRUGO,
2771 hotkey_recommended_mask_show, NULL);
2773 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2775 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2776 static ssize_t hotkey_source_mask_show(struct device *dev,
2777 struct device_attribute *attr,
2780 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2783 static ssize_t hotkey_source_mask_store(struct device *dev,
2784 struct device_attribute *attr,
2785 const char *buf, size_t count)
2791 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2792 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2795 if (mutex_lock_killable(&hotkey_mutex))
2796 return -ERESTARTSYS;
2798 HOTKEY_CONFIG_CRITICAL_START
2799 hotkey_source_mask = t;
2800 HOTKEY_CONFIG_CRITICAL_END
2802 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2803 ~hotkey_source_mask);
2804 hotkey_poll_setup(true);
2806 /* check if events needed by the driver got disabled */
2807 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2808 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2810 mutex_unlock(&hotkey_mutex);
2813 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2814 "firmware event mask!\n");
2817 printk(TPACPI_NOTICE "hotkey_source_mask: "
2818 "some important events were disabled: "
2821 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2823 return (rc < 0) ? rc : count;
2826 static struct device_attribute dev_attr_hotkey_source_mask =
2827 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2828 hotkey_source_mask_show, hotkey_source_mask_store);
2830 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2831 static ssize_t hotkey_poll_freq_show(struct device *dev,
2832 struct device_attribute *attr,
2835 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2838 static ssize_t hotkey_poll_freq_store(struct device *dev,
2839 struct device_attribute *attr,
2840 const char *buf, size_t count)
2844 if (parse_strtoul(buf, 25, &t))
2847 if (mutex_lock_killable(&hotkey_mutex))
2848 return -ERESTARTSYS;
2850 hotkey_poll_set_freq(t);
2851 hotkey_poll_setup(true);
2853 mutex_unlock(&hotkey_mutex);
2855 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2860 static struct device_attribute dev_attr_hotkey_poll_freq =
2861 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2862 hotkey_poll_freq_show, hotkey_poll_freq_store);
2864 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2866 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2867 static ssize_t hotkey_radio_sw_show(struct device *dev,
2868 struct device_attribute *attr,
2872 res = hotkey_get_wlsw();
2876 /* Opportunistic update */
2877 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2879 return snprintf(buf, PAGE_SIZE, "%d\n",
2880 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2883 static struct device_attribute dev_attr_hotkey_radio_sw =
2884 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2886 static void hotkey_radio_sw_notify_change(void)
2888 if (tp_features.hotkey_wlsw)
2889 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2893 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2894 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2895 struct device_attribute *attr,
2899 res = hotkey_get_tablet_mode(&s);
2903 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2906 static struct device_attribute dev_attr_hotkey_tablet_mode =
2907 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2909 static void hotkey_tablet_mode_notify_change(void)
2911 if (tp_features.hotkey_tablet)
2912 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2913 "hotkey_tablet_mode");
2916 /* sysfs hotkey report_mode -------------------------------------------- */
2917 static ssize_t hotkey_report_mode_show(struct device *dev,
2918 struct device_attribute *attr,
2921 return snprintf(buf, PAGE_SIZE, "%d\n",
2922 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2925 static struct device_attribute dev_attr_hotkey_report_mode =
2926 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2928 /* sysfs wakeup reason (pollable) -------------------------------------- */
2929 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2930 struct device_attribute *attr,
2933 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2936 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2937 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2939 static void hotkey_wakeup_reason_notify_change(void)
2941 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2945 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2946 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2947 struct device_attribute *attr,
2950 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2953 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2954 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2955 hotkey_wakeup_hotunplug_complete_show, NULL);
2957 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2959 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2960 "wakeup_hotunplug_complete");
2963 /* --------------------------------------------------------------------- */
2965 static struct attribute *hotkey_attributes[] __initdata = {
2966 &dev_attr_hotkey_enable.attr,
2967 &dev_attr_hotkey_bios_enabled.attr,
2968 &dev_attr_hotkey_bios_mask.attr,
2969 &dev_attr_hotkey_report_mode.attr,
2970 &dev_attr_hotkey_wakeup_reason.attr,
2971 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2972 &dev_attr_hotkey_mask.attr,
2973 &dev_attr_hotkey_all_mask.attr,
2974 &dev_attr_hotkey_recommended_mask.attr,
2975 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2976 &dev_attr_hotkey_source_mask.attr,
2977 &dev_attr_hotkey_poll_freq.attr,
2982 * Sync both the hw and sw blocking state of all switches
2984 static void tpacpi_send_radiosw_update(void)
2989 * We must sync all rfkill controllers *before* issuing any
2990 * rfkill input events, or we will race the rfkill core input
2993 * tpacpi_inputdev_send_mutex works as a synchronization point
2996 * We optimize to avoid numerous calls to hotkey_get_wlsw.
2999 wlsw = hotkey_get_wlsw();
3001 /* Sync hw blocking state first if it is hw-blocked */
3002 if (wlsw == TPACPI_RFK_RADIO_OFF)
3003 tpacpi_rfk_update_hwblock_state(true);
3005 /* Sync sw blocking state */
3006 tpacpi_rfk_update_swstate_all();
3008 /* Sync hw blocking state last if it is hw-unblocked */
3009 if (wlsw == TPACPI_RFK_RADIO_ON)
3010 tpacpi_rfk_update_hwblock_state(false);
3012 /* Issue rfkill input event for WLSW switch */
3014 mutex_lock(&tpacpi_inputdev_send_mutex);
3016 input_report_switch(tpacpi_inputdev,
3017 SW_RFKILL_ALL, (wlsw > 0));
3018 input_sync(tpacpi_inputdev);
3020 mutex_unlock(&tpacpi_inputdev_send_mutex);
3024 * this can be unconditional, as we will poll state again
3025 * if userspace uses the notify to read data
3027 hotkey_radio_sw_notify_change();
3030 static void hotkey_exit(void)
3032 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3033 mutex_lock(&hotkey_mutex);
3034 hotkey_poll_stop_sync();
3035 mutex_unlock(&hotkey_mutex);
3038 if (hotkey_dev_attributes)
3039 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3041 kfree(hotkey_keycode_map);
3043 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3044 "restoring original HKEY status and mask\n");
3045 /* yes, there is a bitwise or below, we want the
3046 * functions to be called even if one of them fail */
3047 if (((tp_features.hotkey_mask &&
3048 hotkey_mask_set(hotkey_orig_mask)) |
3049 hotkey_status_set(false)) != 0)
3051 "failed to restore hot key mask "
3052 "to BIOS defaults\n");
3055 static void __init hotkey_unmap(const unsigned int scancode)
3057 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3058 clear_bit(hotkey_keycode_map[scancode],
3059 tpacpi_inputdev->keybit);
3060 hotkey_keycode_map[scancode] = KEY_RESERVED;
3066 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3069 #define TPACPI_HK_Q_INIMASK 0x0001
3071 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3072 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3073 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3074 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3075 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3076 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3077 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3078 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3079 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3080 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3081 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3082 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3083 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3084 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3085 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3086 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3087 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3088 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3089 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3090 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3093 typedef u16 tpacpi_keymap_entry_t;
3094 typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3096 static int __init hotkey_init(struct ibm_init_struct *iibm)
3098 /* Requirements for changing the default keymaps:
3100 * 1. Many of the keys are mapped to KEY_RESERVED for very
3101 * good reasons. Do not change them unless you have deep
3102 * knowledge on the IBM and Lenovo ThinkPad firmware for
3103 * the various ThinkPad models. The driver behaves
3104 * differently for KEY_RESERVED: such keys have their
3105 * hot key mask *unset* in mask_recommended, and also
3106 * in the initial hot key mask programmed into the
3107 * firmware at driver load time, which means the firm-
3108 * ware may react very differently if you change them to
3111 * 2. You must be subscribed to the linux-thinkpad and
3112 * ibm-acpi-devel mailing lists, and you should read the
3113 * list archives since 2007 if you want to change the
3114 * keymaps. This requirement exists so that you will
3115 * know the past history of problems with the thinkpad-
3116 * acpi driver keymaps, and also that you will be
3117 * listening to any bug reports;
3119 * 3. Do not send thinkpad-acpi specific patches directly to
3120 * for merging, *ever*. Send them to the linux-acpi
3121 * mailinglist for comments. Merging is to be done only
3122 * through acpi-test and the ACPI maintainer.
3124 * If the above is too much to ask, don't change the keymap.
3125 * Ask the thinkpad-acpi maintainer to do it, instead.
3129 TPACPI_KEYMAP_IBM_GENERIC = 0,
3130 TPACPI_KEYMAP_LENOVO_GENERIC,
3133 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3134 /* Generic keymap for IBM ThinkPads */
3135 [TPACPI_KEYMAP_IBM_GENERIC] = {
3136 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3137 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3138 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3139 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3141 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3142 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3143 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3144 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3146 /* brightness: firmware always reacts to them */
3147 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3148 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3150 /* Thinklight: firmware always react to it */
3151 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3153 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3154 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3156 /* Volume: firmware always react to it and reprograms
3157 * the built-in *extra* mixer. Never map it to control
3158 * another mixer by default. */
3159 KEY_RESERVED, /* 0x14: VOLUME UP */
3160 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3161 KEY_RESERVED, /* 0x16: MUTE */
3163 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3165 /* (assignments unknown, please report if found) */
3166 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3167 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3170 /* Generic keymap for Lenovo ThinkPads */
3171 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3172 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3173 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3174 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3175 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3177 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3178 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3179 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3180 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3182 /* These should be enabled --only-- when ACPI video
3183 * is disabled (i.e. in "vendor" mode), and are handled
3184 * in a special way by the init code */
3185 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3186 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3188 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3190 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3191 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3193 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3194 * react to it and reprograms the built-in *extra* mixer.
3195 * Never map it to control another mixer by default.
3197 * T60?, T61, R60?, R61: firmware and EC tries to send
3198 * these over the regular keyboard, so these are no-ops,
3199 * but there are still weird bugs re. MUTE, so do not
3200 * change unless you get test reports from all Lenovo
3201 * models. May cause the BIOS to interfere with the
3204 KEY_RESERVED, /* 0x14: VOLUME UP */
3205 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3206 KEY_RESERVED, /* 0x16: MUTE */
3208 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3210 /* (assignments unknown, please report if found) */
3211 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3212 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3216 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3217 /* Generic maps (fallback) */
3219 .vendor = PCI_VENDOR_ID_IBM,
3220 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3221 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3224 .vendor = PCI_VENDOR_ID_LENOVO,
3225 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3226 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3230 #define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3231 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3236 bool radiosw_state = false;
3237 bool tabletsw_state = false;
3239 unsigned long quirks;
3240 unsigned long keymap_id;
3242 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3243 "initializing hotkey subdriver\n");
3245 BUG_ON(!tpacpi_inputdev);
3246 BUG_ON(tpacpi_inputdev->open != NULL ||
3247 tpacpi_inputdev->close != NULL);
3249 TPACPI_ACPIHANDLE_INIT(hkey);
3250 mutex_init(&hotkey_mutex);
3252 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3253 mutex_init(&hotkey_thread_mutex);
3254 mutex_init(&hotkey_thread_data_mutex);
3257 /* hotkey not supported on 570 */
3258 tp_features.hotkey = hkey_handle != NULL;
3260 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3262 str_supported(tp_features.hotkey));
3264 if (!tp_features.hotkey)
3267 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3268 ARRAY_SIZE(tpacpi_hotkey_qtable));
3270 tpacpi_disable_brightness_delay();
3272 /* MUST have enough space for all attributes to be added to
3273 * hotkey_dev_attributes */
3274 hotkey_dev_attributes = create_attr_set(
3275 ARRAY_SIZE(hotkey_attributes) + 2,
3277 if (!hotkey_dev_attributes)
3279 res = add_many_to_attr_set(hotkey_dev_attributes,
3281 ARRAY_SIZE(hotkey_attributes));
3285 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3286 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3287 for HKEY interface version 0x100 */
3288 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3289 if ((hkeyv >> 8) != 1) {
3290 printk(TPACPI_ERR "unknown version of the "
3291 "HKEY interface: 0x%x\n", hkeyv);
3292 printk(TPACPI_ERR "please report this to %s\n",
3296 * MHKV 0x100 in A31, R40, R40e,
3297 * T4x, X31, and later
3299 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3300 "firmware HKEY interface version: 0x%x\n",
3303 /* Paranoia check AND init hotkey_all_mask */
3304 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3307 "missing MHKA handler, "
3308 "please report this to %s\n",
3310 /* Fallback: pre-init for FN+F3,F4,F12 */
3311 hotkey_all_mask = 0x080cU;
3313 tp_features.hotkey_mask = 1;
3318 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3319 "hotkey masks are %s\n",
3320 str_supported(tp_features.hotkey_mask));
3322 /* Init hotkey_all_mask if not initialized yet */
3323 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3324 (quirks & TPACPI_HK_Q_INIMASK))
3325 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3327 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3328 if (tp_features.hotkey_mask) {
3329 /* hotkey_source_mask *must* be zero for
3330 * the first hotkey_mask_get to return hotkey_orig_mask */
3331 res = hotkey_mask_get();
3335 hotkey_orig_mask = hotkey_acpi_mask;
3337 hotkey_orig_mask = hotkey_all_mask;
3338 hotkey_acpi_mask = hotkey_all_mask;
3341 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3343 tp_features.hotkey_wlsw = 1;
3344 radiosw_state = !!tpacpi_wlsw_emulstate;
3346 "radio switch emulation enabled\n");
3349 /* Not all thinkpads have a hardware radio switch */
3350 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3351 tp_features.hotkey_wlsw = 1;
3352 radiosw_state = !!status;
3354 "radio switch found; radios are %s\n",
3355 enabled(status, 0));
3357 if (tp_features.hotkey_wlsw)
3358 res = add_to_attr_set(hotkey_dev_attributes,
3359 &dev_attr_hotkey_radio_sw.attr);
3361 /* For X41t, X60t, X61t Tablets... */
3362 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3363 tp_features.hotkey_tablet = 1;
3364 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3366 "possible tablet mode switch found; "
3367 "ThinkPad in %s mode\n",
3368 (tabletsw_state) ? "tablet" : "laptop");
3369 res = add_to_attr_set(hotkey_dev_attributes,
3370 &dev_attr_hotkey_tablet_mode.attr);
3374 res = register_attr_set_with_sysfs(
3375 hotkey_dev_attributes,
3376 &tpacpi_pdev->dev.kobj);
3380 /* Set up key map */
3381 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3383 if (!hotkey_keycode_map) {
3385 "failed to allocate memory for key map\n");
3390 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3391 ARRAY_SIZE(tpacpi_keymap_qtable));
3392 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3393 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3394 "using keymap number %lu\n", keymap_id);
3396 memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3397 TPACPI_HOTKEY_MAP_SIZE);
3399 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3400 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3401 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3402 tpacpi_inputdev->keycode = hotkey_keycode_map;
3403 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3404 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3405 input_set_capability(tpacpi_inputdev, EV_KEY,
3406 hotkey_keycode_map[i]);
3408 if (i < sizeof(hotkey_reserved_mask)*8)
3409 hotkey_reserved_mask |= 1 << i;
3413 if (tp_features.hotkey_wlsw) {
3414 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3415 input_report_switch(tpacpi_inputdev,
3416 SW_RFKILL_ALL, radiosw_state);
3418 if (tp_features.hotkey_tablet) {
3419 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3420 input_report_switch(tpacpi_inputdev,
3421 SW_TABLET_MODE, tabletsw_state);
3424 /* Do not issue duplicate brightness change events to
3425 * userspace. tpacpi_detect_brightness_capabilities() must have
3426 * been called before this point */
3427 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3429 "This ThinkPad has standard ACPI backlight "
3430 "brightness control, supported by the ACPI "
3432 printk(TPACPI_NOTICE
3433 "Disabling thinkpad-acpi brightness events "
3436 /* Disable brightness up/down on Lenovo thinkpads when
3437 * ACPI is handling them, otherwise it is plain impossible
3438 * for userspace to do something even remotely sane */
3439 hotkey_reserved_mask |=
3440 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3441 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3442 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3443 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3446 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3447 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3449 & ~hotkey_reserved_mask;
3451 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3452 "hotkey source mask 0x%08x, polling freq %u\n",
3453 hotkey_source_mask, hotkey_poll_freq);
3456 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3457 "enabling firmware HKEY event interface...\n");
3458 res = hotkey_status_set(true);
3463 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3464 | hotkey_driver_mask)
3465 & ~hotkey_source_mask);
3466 if (res < 0 && res != -ENXIO) {
3470 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3471 & ~hotkey_reserved_mask;
3472 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3473 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3474 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3476 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3477 "legacy ibm/hotkey event reporting over procfs %s\n",
3478 (hotkey_report_mode < 2) ?
3479 "enabled" : "disabled");
3481 tpacpi_inputdev->open = &hotkey_inputdev_open;
3482 tpacpi_inputdev->close = &hotkey_inputdev_close;
3484 hotkey_poll_setup_safe(true);
3489 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3490 hotkey_dev_attributes = NULL;
3492 return (res < 0)? res : 1;
3495 static bool hotkey_notify_hotkey(const u32 hkey,
3497 bool *ignore_acpi_ev)
3499 /* 0x1000-0x1FFF: key presses */
3500 unsigned int scancode = hkey & 0xfff;
3501 *send_acpi_ev = true;
3502 *ignore_acpi_ev = false;
3504 /* HKEY event 0x1001 is scancode 0x00 */
3505 if (scancode > 0 && scancode <= TPACPI_HOTKEY_MAP_LEN) {
3507 if (!(hotkey_source_mask & (1 << scancode))) {
3508 tpacpi_input_send_key_masked(scancode);
3509 *send_acpi_ev = false;
3511 *ignore_acpi_ev = true;
3518 static bool hotkey_notify_wakeup(const u32 hkey,
3520 bool *ignore_acpi_ev)
3522 /* 0x2000-0x2FFF: Wakeup reason */
3523 *send_acpi_ev = true;
3524 *ignore_acpi_ev = false;
3527 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3528 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3529 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3530 *ignore_acpi_ev = true;
3533 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3534 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3535 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3536 *ignore_acpi_ev = true;
3539 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3540 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3542 "EMERGENCY WAKEUP: battery almost empty\n");
3543 /* how to auto-heal: */
3544 /* 2313: woke up from S3, go to S4/S5 */
3545 /* 2413: woke up from S4, go to S5 */
3552 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3554 "woke up due to a hot-unplug "
3556 hotkey_wakeup_reason_notify_change();
3561 static bool hotkey_notify_usrevent(const u32 hkey,
3563 bool *ignore_acpi_ev)
3565 /* 0x5000-0x5FFF: human interface helpers */
3566 *send_acpi_ev = true;
3567 *ignore_acpi_ev = false;
3570 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3571 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3574 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3575 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3576 tpacpi_input_send_tabletsw();
3577 hotkey_tablet_mode_notify_change();
3578 *send_acpi_ev = false;
3581 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3582 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3583 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3584 /* do not propagate these events */
3585 *ignore_acpi_ev = true;
3593 static void thermal_dump_all_sensors(void);
3595 static bool hotkey_notify_thermal(const u32 hkey,
3597 bool *ignore_acpi_ev)
3601 /* 0x6000-0x6FFF: thermal alarms */
3602 *send_acpi_ev = true;
3603 *ignore_acpi_ev = false;
3606 case TP_HKEY_EV_THM_TABLE_CHANGED:
3608 "EC reports that Thermal Table has changed\n");
3609 /* recommended action: do nothing, we don't have
3610 * Lenovo ATM information */
3612 case TP_HKEY_EV_ALARM_BAT_HOT:
3614 "THERMAL ALARM: battery is too hot!\n");
3615 /* recommended action: warn user through gui */
3617 case TP_HKEY_EV_ALARM_BAT_XHOT:
3619 "THERMAL EMERGENCY: battery is extremely hot!\n");
3620 /* recommended action: immediate sleep/hibernate */
3622 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3625 "a sensor reports something is too hot!\n");
3626 /* recommended action: warn user through gui, that */
3627 /* some internal component is too hot */
3629 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3631 "THERMAL EMERGENCY: "
3632 "a sensor reports something is extremely hot!\n");
3633 /* recommended action: immediate sleep/hibernate */
3637 "THERMAL ALERT: unknown thermal alarm received\n");
3641 thermal_dump_all_sensors();
3646 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3650 bool ignore_acpi_ev;
3653 if (event != 0x80) {
3655 "unknown HKEY notification event %d\n", event);
3656 /* forward it to userspace, maybe it knows how to handle it */
3657 acpi_bus_generate_netlink_event(
3658 ibm->acpi->device->pnp.device_class,
3659 dev_name(&ibm->acpi->device->dev),
3665 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3666 printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3675 send_acpi_ev = true;
3676 ignore_acpi_ev = false;
3678 switch (hkey >> 12) {
3680 /* 0x1000-0x1FFF: key presses */
3681 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3685 /* 0x2000-0x2FFF: Wakeup reason */
3686 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3690 /* 0x3000-0x3FFF: bay-related wakeups */
3692 case TP_HKEY_EV_BAYEJ_ACK:
3693 hotkey_autosleep_ack = 1;
3696 hotkey_wakeup_hotunplug_complete_notify_change();
3699 case TP_HKEY_EV_OPTDRV_EJ:
3700 /* FIXME: kick libata if SATA link offline */
3708 /* 0x4000-0x4FFF: dock-related wakeups */
3709 if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3710 hotkey_autosleep_ack = 1;
3713 hotkey_wakeup_hotunplug_complete_notify_change();
3720 /* 0x5000-0x5FFF: human interface helpers */
3721 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3725 /* 0x6000-0x6FFF: thermal alarms */
3726 known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3730 /* 0x7000-0x7FFF: misc */
3731 if (tp_features.hotkey_wlsw &&
3732 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3733 tpacpi_send_radiosw_update();
3738 /* fallthrough to default */
3743 printk(TPACPI_NOTICE
3744 "unhandled HKEY event 0x%04x\n", hkey);
3745 printk(TPACPI_NOTICE
3746 "please report the conditions when this "
3747 "event happened to %s\n", TPACPI_MAIL);
3751 if (!ignore_acpi_ev &&
3752 (send_acpi_ev || hotkey_report_mode < 2)) {
3753 acpi_bus_generate_proc_event(ibm->acpi->device,
3757 /* netlink events */
3758 if (!ignore_acpi_ev && send_acpi_ev) {
3759 acpi_bus_generate_netlink_event(
3760 ibm->acpi->device->pnp.device_class,
3761 dev_name(&ibm->acpi->device->dev),
3767 static void hotkey_suspend(pm_message_t state)
3769 /* Do these on suspend, we get the events on early resume! */
3770 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3771 hotkey_autosleep_ack = 0;
3774 static void hotkey_resume(void)
3776 tpacpi_disable_brightness_delay();
3778 if (hotkey_status_set(true) < 0 ||
3779 hotkey_mask_set(hotkey_acpi_mask) < 0)
3781 "error while attempting to reset the event "
3782 "firmware interface\n");
3784 tpacpi_send_radiosw_update();
3785 hotkey_tablet_mode_notify_change();
3786 hotkey_wakeup_reason_notify_change();
3787 hotkey_wakeup_hotunplug_complete_notify_change();
3788 hotkey_poll_setup_safe(false);
3791 /* procfs -------------------------------------------------------------- */
3792 static int hotkey_read(struct seq_file *m)
3796 if (!tp_features.hotkey) {
3797 seq_printf(m, "status:\t\tnot supported\n");
3801 if (mutex_lock_killable(&hotkey_mutex))
3802 return -ERESTARTSYS;
3803 res = hotkey_status_get(&status);
3805 res = hotkey_mask_get();
3806 mutex_unlock(&hotkey_mutex);
3810 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3811 if (hotkey_all_mask) {
3812 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3813 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3815 seq_printf(m, "mask:\t\tnot supported\n");
3816 seq_printf(m, "commands:\tenable, disable, reset\n");
3822 static void hotkey_enabledisable_warn(bool enable)
3824 tpacpi_log_usertask("procfs hotkey enable/disable");
3825 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3827 "hotkey enable/disable functionality has been "
3828 "removed from the driver. Hotkeys are always "
3831 "Please remove the hotkey=enable module "
3832 "parameter, it is deprecated. Hotkeys are always "
3836 static int hotkey_write(char *buf)
3842 if (!tp_features.hotkey)
3845 if (mutex_lock_killable(&hotkey_mutex))
3846 return -ERESTARTSYS;
3848 mask = hotkey_user_mask;
3851 while ((cmd = next_cmd(&buf))) {
3852 if (strlencmp(cmd, "enable") == 0) {
3853 hotkey_enabledisable_warn(1);
3854 } else if (strlencmp(cmd, "disable") == 0) {
3855 hotkey_enabledisable_warn(0);
3857 } else if (strlencmp(cmd, "reset") == 0) {
3858 mask = (hotkey_all_mask | hotkey_source_mask)
3859 & ~hotkey_reserved_mask;
3860 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3862 } else if (sscanf(cmd, "%x", &mask) == 1) {
3871 tpacpi_disclose_usertask("procfs hotkey",
3872 "set mask to 0x%08x\n", mask);
3873 res = hotkey_user_mask_set(mask);
3877 mutex_unlock(&hotkey_mutex);
3881 static const struct acpi_device_id ibm_htk_device_ids[] = {
3882 {TPACPI_ACPI_HKEY_HID, 0},
3886 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3887 .hid = ibm_htk_device_ids,
3888 .notify = hotkey_notify,
3889 .handle = &hkey_handle,
3890 .type = ACPI_DEVICE_NOTIFY,
3893 static struct ibm_struct hotkey_driver_data = {
3895 .read = hotkey_read,
3896 .write = hotkey_write,
3897 .exit = hotkey_exit,
3898 .resume = hotkey_resume,
3899 .suspend = hotkey_suspend,
3900 .acpi = &ibm_hotkey_acpidriver,
3903 /*************************************************************************
3904 * Bluetooth subdriver
3908 /* ACPI GBDC/SBDC bits */
3909 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3910 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3911 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3912 0 = disable, 1 = enable */
3916 /* ACPI \BLTH commands */
3917 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3918 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3919 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3920 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3921 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3924 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3926 static int bluetooth_get_status(void)
3930 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3931 if (dbg_bluetoothemul)
3932 return (tpacpi_bluetooth_emulstate) ?
3933 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3936 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3939 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3940 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3943 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3947 vdbg_printk(TPACPI_DBG_RFKILL,
3948 "will attempt to %s bluetooth\n",
3949 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3951 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3952 if (dbg_bluetoothemul) {
3953 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3958 if (state == TPACPI_RFK_RADIO_ON)
3959 status = TP_ACPI_BLUETOOTH_RADIOSSW
3960 | TP_ACPI_BLUETOOTH_RESUMECTRL;
3964 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3970 /* sysfs bluetooth enable ---------------------------------------------- */
3971 static ssize_t bluetooth_enable_show(struct device *dev,
3972 struct device_attribute *attr,
3975 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3979 static ssize_t bluetooth_enable_store(struct device *dev,
3980 struct device_attribute *attr,
3981 const char *buf, size_t count)
3983 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3987 static struct device_attribute dev_attr_bluetooth_enable =
3988 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3989 bluetooth_enable_show, bluetooth_enable_store);
3991 /* --------------------------------------------------------------------- */
3993 static struct attribute *bluetooth_attributes[] = {
3994 &dev_attr_bluetooth_enable.attr,
3998 static const struct attribute_group bluetooth_attr_group = {
3999 .attrs = bluetooth_attributes,
4002 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4003 .get_status = bluetooth_get_status,
4004 .set_status = bluetooth_set_status,
4007 static void bluetooth_shutdown(void)
4009 /* Order firmware to save current state to NVRAM */
4010 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4011 TP_ACPI_BLTH_SAVE_STATE))
4012 printk(TPACPI_NOTICE
4013 "failed to save bluetooth state to NVRAM\n");
4015 vdbg_printk(TPACPI_DBG_RFKILL,
4016 "bluestooth state saved to NVRAM\n");
4019 static void bluetooth_exit(void)
4021 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4022 &bluetooth_attr_group);
4024 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4026 bluetooth_shutdown();
4029 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4034 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4035 "initializing bluetooth subdriver\n");
4037 TPACPI_ACPIHANDLE_INIT(hkey);
4039 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4040 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4041 tp_features.bluetooth = hkey_handle &&
4042 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4044 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4045 "bluetooth is %s, status 0x%02x\n",
4046 str_supported(tp_features.bluetooth),
4049 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4050 if (dbg_bluetoothemul) {
4051 tp_features.bluetooth = 1;
4053 "bluetooth switch emulation enabled\n");
4056 if (tp_features.bluetooth &&
4057 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4058 /* no bluetooth hardware present in system */
4059 tp_features.bluetooth = 0;
4060 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4061 "bluetooth hardware not installed\n");
4064 if (!tp_features.bluetooth)
4067 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4068 &bluetooth_tprfk_ops,
4069 RFKILL_TYPE_BLUETOOTH,
4070 TPACPI_RFK_BLUETOOTH_SW_NAME,
4075 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4076 &bluetooth_attr_group);
4078 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4085 /* procfs -------------------------------------------------------------- */
4086 static int bluetooth_read(struct seq_file *m)
4088 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4091 static int bluetooth_write(char *buf)
4093 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4096 static struct ibm_struct bluetooth_driver_data = {
4097 .name = "bluetooth",
4098 .read = bluetooth_read,
4099 .write = bluetooth_write,
4100 .exit = bluetooth_exit,
4101 .shutdown = bluetooth_shutdown,
4104 /*************************************************************************
4109 /* ACPI GWAN/SWAN bits */
4110 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4111 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4112 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4113 0 = disable, 1 = enable */
4116 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4118 static int wan_get_status(void)
4122 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4124 return (tpacpi_wwan_emulstate) ?
4125 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4128 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4131 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4132 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4135 static int wan_set_status(enum tpacpi_rfkill_state state)
4139 vdbg_printk(TPACPI_DBG_RFKILL,
4140 "will attempt to %s wwan\n",
4141 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4143 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4145 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4150 if (state == TPACPI_RFK_RADIO_ON)
4151 status = TP_ACPI_WANCARD_RADIOSSW
4152 | TP_ACPI_WANCARD_RESUMECTRL;
4156 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4162 /* sysfs wan enable ---------------------------------------------------- */
4163 static ssize_t wan_enable_show(struct device *dev,
4164 struct device_attribute *attr,
4167 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4171 static ssize_t wan_enable_store(struct device *dev,
4172 struct device_attribute *attr,
4173 const char *buf, size_t count)
4175 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4179 static struct device_attribute dev_attr_wan_enable =
4180 __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4181 wan_enable_show, wan_enable_store);
4183 /* --------------------------------------------------------------------- */
4185 static struct attribute *wan_attributes[] = {
4186 &dev_attr_wan_enable.attr,
4190 static const struct attribute_group wan_attr_group = {
4191 .attrs = wan_attributes,
4194 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4195 .get_status = wan_get_status,
4196 .set_status = wan_set_status,
4199 static void wan_shutdown(void)
4201 /* Order firmware to save current state to NVRAM */
4202 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4203 TP_ACPI_WGSV_SAVE_STATE))
4204 printk(TPACPI_NOTICE
4205 "failed to save WWAN state to NVRAM\n");
4207 vdbg_printk(TPACPI_DBG_RFKILL,
4208 "WWAN state saved to NVRAM\n");
4211 static void wan_exit(void)
4213 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4216 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4221 static int __init wan_init(struct ibm_init_struct *iibm)
4226 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4227 "initializing wan subdriver\n");
4229 TPACPI_ACPIHANDLE_INIT(hkey);
4231 tp_features.wan = hkey_handle &&
4232 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4234 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4235 "wan is %s, status 0x%02x\n",
4236 str_supported(tp_features.wan),
4239 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4241 tp_features.wan = 1;
4243 "wwan switch emulation enabled\n");
4246 if (tp_features.wan &&
4247 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4248 /* no wan hardware present in system */
4249 tp_features.wan = 0;
4250 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4251 "wan hardware not installed\n");
4254 if (!tp_features.wan)
4257 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4260 TPACPI_RFK_WWAN_SW_NAME,
4265 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4269 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4276 /* procfs -------------------------------------------------------------- */
4277 static int wan_read(struct seq_file *m)
4279 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4282 static int wan_write(char *buf)
4284 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4287 static struct ibm_struct wan_driver_data = {
4292 .shutdown = wan_shutdown,
4295 /*************************************************************************
4300 /* ACPI GUWB/SUWB bits */
4301 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4302 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4305 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4307 static int uwb_get_status(void)
4311 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4313 return (tpacpi_uwb_emulstate) ?
4314 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4317 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4320 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4321 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4324 static int uwb_set_status(enum tpacpi_rfkill_state state)
4328 vdbg_printk(TPACPI_DBG_RFKILL,
4329 "will attempt to %s UWB\n",
4330 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4332 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4334 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4339 if (state == TPACPI_RFK_RADIO_ON)
4340 status = TP_ACPI_UWB_RADIOSSW;
4344 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4350 /* --------------------------------------------------------------------- */
4352 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4353 .get_status = uwb_get_status,
4354 .set_status = uwb_set_status,
4357 static void uwb_exit(void)
4359 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4362 static int __init uwb_init(struct ibm_init_struct *iibm)
4367 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4368 "initializing uwb subdriver\n");
4370 TPACPI_ACPIHANDLE_INIT(hkey);
4372 tp_features.uwb = hkey_handle &&
4373 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4375 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4376 "uwb is %s, status 0x%02x\n",
4377 str_supported(tp_features.uwb),
4380 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4382 tp_features.uwb = 1;
4384 "uwb switch emulation enabled\n");
4387 if (tp_features.uwb &&
4388 !(status & TP_ACPI_UWB_HWPRESENT)) {
4389 /* no uwb hardware present in system */
4390 tp_features.uwb = 0;
4391 dbg_printk(TPACPI_DBG_INIT,
4392 "uwb hardware not installed\n");
4395 if (!tp_features.uwb)
4398 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4401 TPACPI_RFK_UWB_SW_NAME,
4406 static struct ibm_struct uwb_driver_data = {
4409 .flags.experimental = 1,
4412 /*************************************************************************
4416 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4418 enum video_access_mode {
4419 TPACPI_VIDEO_NONE = 0,
4420 TPACPI_VIDEO_570, /* 570 */
4421 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4422 TPACPI_VIDEO_NEW, /* all others */
4425 enum { /* video status flags, based on VIDEO_570 */
4426 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4427 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4428 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4431 enum { /* TPACPI_VIDEO_570 constants */
4432 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4433 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4434 * video_status_flags */
4435 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4436 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4439 static enum video_access_mode video_supported;
4440 static int video_orig_autosw;
4442 static int video_autosw_get(void);
4443 static int video_autosw_set(int enable);
4445 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4447 static int __init video_init(struct ibm_init_struct *iibm)
4451 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4453 TPACPI_ACPIHANDLE_INIT(vid);
4454 if (tpacpi_is_ibm())
4455 TPACPI_ACPIHANDLE_INIT(vid2);
4457 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4458 /* G41, assume IVGA doesn't change */
4459 vid_handle = vid2_handle;
4462 /* video switching not supported on R30, R31 */
4463 video_supported = TPACPI_VIDEO_NONE;
4464 else if (tpacpi_is_ibm() &&
4465 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4467 video_supported = TPACPI_VIDEO_570;
4468 else if (tpacpi_is_ibm() &&
4469 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4470 /* 600e/x, 770e, 770x */
4471 video_supported = TPACPI_VIDEO_770;
4474 video_supported = TPACPI_VIDEO_NEW;
4476 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4477 str_supported(video_supported != TPACPI_VIDEO_NONE),
4480 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4483 static void video_exit(void)
4485 dbg_printk(TPACPI_DBG_EXIT,
4486 "restoring original video autoswitch mode\n");
4487 if (video_autosw_set(video_orig_autosw))
4488 printk(TPACPI_ERR "error while trying to restore original "
4489 "video autoswitch mode\n");
4492 static int video_outputsw_get(void)
4497 switch (video_supported) {
4498 case TPACPI_VIDEO_570:
4499 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4500 TP_ACPI_VIDEO_570_PHSCMD))
4502 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4504 case TPACPI_VIDEO_770:
4505 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4508 status |= TP_ACPI_VIDEO_S_LCD;
4509 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4512 status |= TP_ACPI_VIDEO_S_CRT;
4514 case TPACPI_VIDEO_NEW:
4515 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4516 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4519 status |= TP_ACPI_VIDEO_S_CRT;
4521 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4522 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4525 status |= TP_ACPI_VIDEO_S_LCD;
4526 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4529 status |= TP_ACPI_VIDEO_S_DVI;
4538 static int video_outputsw_set(int status)
4543 switch (video_supported) {
4544 case TPACPI_VIDEO_570:
4545 res = acpi_evalf(NULL, NULL,
4546 "\\_SB.PHS2", "vdd",
4547 TP_ACPI_VIDEO_570_PHS2CMD,
4548 status | TP_ACPI_VIDEO_570_PHS2SET);
4550 case TPACPI_VIDEO_770:
4551 autosw = video_autosw_get();
4555 res = video_autosw_set(1);
4558 res = acpi_evalf(vid_handle, NULL,
4559 "ASWT", "vdd", status * 0x100, 0);
4560 if (!autosw && video_autosw_set(autosw)) {
4562 "video auto-switch left enabled due to error\n");
4566 case TPACPI_VIDEO_NEW:
4567 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4568 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4574 return (res)? 0 : -EIO;
4577 static int video_autosw_get(void)
4581 switch (video_supported) {
4582 case TPACPI_VIDEO_570:
4583 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4586 case TPACPI_VIDEO_770:
4587 case TPACPI_VIDEO_NEW:
4588 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4598 static int video_autosw_set(int enable)
4600 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4605 static int video_outputsw_cycle(void)
4607 int autosw = video_autosw_get();
4613 switch (video_supported) {
4614 case TPACPI_VIDEO_570:
4615 res = video_autosw_set(1);
4618 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4620 case TPACPI_VIDEO_770:
4621 case TPACPI_VIDEO_NEW:
4622 res = video_autosw_set(1);
4625 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4630 if (!autosw && video_autosw_set(autosw)) {
4632 "video auto-switch left enabled due to error\n");
4636 return (res)? 0 : -EIO;
4639 static int video_expand_toggle(void)
4641 switch (video_supported) {
4642 case TPACPI_VIDEO_570:
4643 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4645 case TPACPI_VIDEO_770:
4646 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4648 case TPACPI_VIDEO_NEW:
4649 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4657 static int video_read(struct seq_file *m)
4661 if (video_supported == TPACPI_VIDEO_NONE) {
4662 seq_printf(m, "status:\t\tnot supported\n");
4666 /* Even reads can crash X.org, so... */
4667 if (!capable(CAP_SYS_ADMIN))
4670 status = video_outputsw_get();
4674 autosw = video_autosw_get();
4678 seq_printf(m, "status:\t\tsupported\n");
4679 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4680 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4681 if (video_supported == TPACPI_VIDEO_NEW)
4682 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4683 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4684 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4685 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4686 if (video_supported == TPACPI_VIDEO_NEW)
4687 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4688 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4689 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4694 static int video_write(char *buf)
4697 int enable, disable, status;
4700 if (video_supported == TPACPI_VIDEO_NONE)
4703 /* Even reads can crash X.org, let alone writes... */
4704 if (!capable(CAP_SYS_ADMIN))
4710 while ((cmd = next_cmd(&buf))) {
4711 if (strlencmp(cmd, "lcd_enable") == 0) {
4712 enable |= TP_ACPI_VIDEO_S_LCD;
4713 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4714 disable |= TP_ACPI_VIDEO_S_LCD;
4715 } else if (strlencmp(cmd, "crt_enable") == 0) {
4716 enable |= TP_ACPI_VIDEO_S_CRT;
4717 } else if (strlencmp(cmd, "crt_disable") == 0) {
4718 disable |= TP_ACPI_VIDEO_S_CRT;
4719 } else if (video_supported == TPACPI_VIDEO_NEW &&
4720 strlencmp(cmd, "dvi_enable") == 0) {
4721 enable |= TP_ACPI_VIDEO_S_DVI;
4722 } else if (video_supported == TPACPI_VIDEO_NEW &&
4723 strlencmp(cmd, "dvi_disable") == 0) {
4724 disable |= TP_ACPI_VIDEO_S_DVI;
4725 } else if (strlencmp(cmd, "auto_enable") == 0) {
4726 res = video_autosw_set(1);
4729 } else if (strlencmp(cmd, "auto_disable") == 0) {
4730 res = video_autosw_set(0);
4733 } else if (strlencmp(cmd, "video_switch") == 0) {
4734 res = video_outputsw_cycle();
4737 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4738 res = video_expand_toggle();
4745 if (enable || disable) {
4746 status = video_outputsw_get();
4749 res = video_outputsw_set((status & ~disable) | enable);
4757 static struct ibm_struct video_driver_data = {
4760 .write = video_write,
4764 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4766 /*************************************************************************
4767 * Light (thinklight) subdriver
4770 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4771 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4773 static int light_get_status(void)
4777 if (tp_features.light_status) {
4778 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4786 static int light_set_status(int status)
4790 if (tp_features.light) {
4792 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4794 TP_CMOS_THINKLIGHT_ON :
4795 TP_CMOS_THINKLIGHT_OFF);
4797 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4800 return (rc)? 0 : -EIO;
4806 static void light_set_status_worker(struct work_struct *work)
4808 struct tpacpi_led_classdev *data =
4809 container_of(work, struct tpacpi_led_classdev, work);
4811 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4812 light_set_status((data->new_state != TPACPI_LED_OFF));
4815 static void light_sysfs_set(struct led_classdev *led_cdev,
4816 enum led_brightness brightness)
4818 struct tpacpi_led_classdev *data =
4819 container_of(led_cdev,
4820 struct tpacpi_led_classdev,
4822 data->new_state = (brightness != LED_OFF) ?
4823 TPACPI_LED_ON : TPACPI_LED_OFF;
4824 queue_work(tpacpi_wq, &data->work);
4827 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4829 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4832 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4834 .name = "tpacpi::thinklight",
4835 .brightness_set = &light_sysfs_set,
4836 .brightness_get = &light_sysfs_get,
4840 static int __init light_init(struct ibm_init_struct *iibm)
4844 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4846 if (tpacpi_is_ibm()) {
4847 TPACPI_ACPIHANDLE_INIT(ledb);
4848 TPACPI_ACPIHANDLE_INIT(lght);
4850 TPACPI_ACPIHANDLE_INIT(cmos);
4851 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4853 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4854 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4856 if (tp_features.light)
4857 /* light status not supported on
4858 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4859 tp_features.light_status =
4860 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4862 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4863 str_supported(tp_features.light),
4864 str_supported(tp_features.light_status));
4866 if (!tp_features.light)
4869 rc = led_classdev_register(&tpacpi_pdev->dev,
4870 &tpacpi_led_thinklight.led_classdev);
4873 tp_features.light = 0;
4874 tp_features.light_status = 0;
4882 static void light_exit(void)
4884 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4885 if (work_pending(&tpacpi_led_thinklight.work))
4886 flush_workqueue(tpacpi_wq);
4889 static int light_read(struct seq_file *m)
4893 if (!tp_features.light) {
4894 seq_printf(m, "status:\t\tnot supported\n");
4895 } else if (!tp_features.light_status) {
4896 seq_printf(m, "status:\t\tunknown\n");
4897 seq_printf(m, "commands:\ton, off\n");
4899 status = light_get_status();
4902 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4903 seq_printf(m, "commands:\ton, off\n");
4909 static int light_write(char *buf)
4914 if (!tp_features.light)
4917 while ((cmd = next_cmd(&buf))) {
4918 if (strlencmp(cmd, "on") == 0) {
4920 } else if (strlencmp(cmd, "off") == 0) {
4926 return light_set_status(newstatus);
4929 static struct ibm_struct light_driver_data = {
4932 .write = light_write,
4936 /*************************************************************************
4940 /* sysfs cmos_command -------------------------------------------------- */
4941 static ssize_t cmos_command_store(struct device *dev,
4942 struct device_attribute *attr,
4943 const char *buf, size_t count)
4945 unsigned long cmos_cmd;
4948 if (parse_strtoul(buf, 21, &cmos_cmd))
4951 res = issue_thinkpad_cmos_command(cmos_cmd);
4952 return (res)? res : count;
4955 static struct device_attribute dev_attr_cmos_command =
4956 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4958 /* --------------------------------------------------------------------- */
4960 static int __init cmos_init(struct ibm_init_struct *iibm)
4964 vdbg_printk(TPACPI_DBG_INIT,
4965 "initializing cmos commands subdriver\n");
4967 TPACPI_ACPIHANDLE_INIT(cmos);
4969 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4970 str_supported(cmos_handle != NULL));
4972 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4976 return (cmos_handle)? 0 : 1;
4979 static void cmos_exit(void)
4981 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4984 static int cmos_read(struct seq_file *m)
4986 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4987 R30, R31, T20-22, X20-21 */
4989 seq_printf(m, "status:\t\tnot supported\n");
4991 seq_printf(m, "status:\t\tsupported\n");
4992 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
4998 static int cmos_write(char *buf)
5003 while ((cmd = next_cmd(&buf))) {
5004 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5005 cmos_cmd >= 0 && cmos_cmd <= 21) {
5010 res = issue_thinkpad_cmos_command(cmos_cmd);
5018 static struct ibm_struct cmos_driver_data = {
5021 .write = cmos_write,
5025 /*************************************************************************
5029 enum led_access_mode {
5030 TPACPI_LED_NONE = 0,
5031 TPACPI_LED_570, /* 570 */
5032 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5033 TPACPI_LED_NEW, /* all others */
5036 enum { /* For TPACPI_LED_OLD */
5037 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5038 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5039 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5042 static enum led_access_mode led_supported;
5044 static acpi_handle led_handle;
5046 #define TPACPI_LED_NUMLEDS 16
5047 static struct tpacpi_led_classdev *tpacpi_leds;
5048 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5049 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5050 /* there's a limit of 19 chars + NULL before 2.6.26 */
5052 "tpacpi:orange:batt",
5053 "tpacpi:green:batt",
5054 "tpacpi::dock_active",
5055 "tpacpi::bay_active",
5056 "tpacpi::dock_batt",
5057 "tpacpi::unknown_led",
5059 "tpacpi::dock_status1",
5060 "tpacpi::dock_status2",
5061 "tpacpi::unknown_led2",
5062 "tpacpi::unknown_led3",
5063 "tpacpi::thinkvantage",
5065 #define TPACPI_SAFE_LEDS 0x1081U
5067 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5069 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5072 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5076 static int led_get_status(const unsigned int led)
5079 enum led_status_t led_s;
5081 switch (led_supported) {
5082 case TPACPI_LED_570:
5083 if (!acpi_evalf(ec_handle,
5084 &status, "GLED", "dd", 1 << led))
5086 led_s = (status == 0)?
5091 tpacpi_led_state_cache[led] = led_s;
5100 static int led_set_status(const unsigned int led,
5101 const enum led_status_t ledstatus)
5103 /* off, on, blink. Index is led_status_t */
5104 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5105 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5109 switch (led_supported) {
5110 case TPACPI_LED_570:
5112 if (unlikely(led > 7))
5114 if (unlikely(tpacpi_is_led_restricted(led)))
5116 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5117 (1 << led), led_sled_arg1[ledstatus]))
5120 case TPACPI_LED_OLD:
5121 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5122 if (unlikely(led > 7))
5124 if (unlikely(tpacpi_is_led_restricted(led)))
5126 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5128 rc = ec_write(TPACPI_LED_EC_HLBL,
5129 (ledstatus == TPACPI_LED_BLINK) << led);
5131 rc = ec_write(TPACPI_LED_EC_HLCL,
5132 (ledstatus != TPACPI_LED_OFF) << led);
5134 case TPACPI_LED_NEW:
5136 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5138 if (unlikely(tpacpi_is_led_restricted(led)))
5140 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5141 led, led_led_arg1[ledstatus]))
5149 tpacpi_led_state_cache[led] = ledstatus;
5154 static void led_set_status_worker(struct work_struct *work)
5156 struct tpacpi_led_classdev *data =
5157 container_of(work, struct tpacpi_led_classdev, work);
5159 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5160 led_set_status(data->led, data->new_state);
5163 static void led_sysfs_set(struct led_classdev *led_cdev,
5164 enum led_brightness brightness)
5166 struct tpacpi_led_classdev *data = container_of(led_cdev,
5167 struct tpacpi_led_classdev, led_classdev);
5169 if (brightness == LED_OFF)
5170 data->new_state = TPACPI_LED_OFF;
5171 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5172 data->new_state = TPACPI_LED_ON;
5174 data->new_state = TPACPI_LED_BLINK;
5176 queue_work(tpacpi_wq, &data->work);
5179 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5180 unsigned long *delay_on, unsigned long *delay_off)
5182 struct tpacpi_led_classdev *data = container_of(led_cdev,
5183 struct tpacpi_led_classdev, led_classdev);
5185 /* Can we choose the flash rate? */
5186 if (*delay_on == 0 && *delay_off == 0) {
5187 /* yes. set them to the hardware blink rate (1 Hz) */
5188 *delay_on = 500; /* ms */
5189 *delay_off = 500; /* ms */
5190 } else if ((*delay_on != 500) || (*delay_off != 500))
5193 data->new_state = TPACPI_LED_BLINK;
5194 queue_work(tpacpi_wq, &data->work);
5199 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5203 struct tpacpi_led_classdev *data = container_of(led_cdev,
5204 struct tpacpi_led_classdev, led_classdev);
5206 rc = led_get_status(data->led);
5208 if (rc == TPACPI_LED_OFF || rc < 0)
5209 rc = LED_OFF; /* no error handling in led class :( */
5216 static void led_exit(void)
5220 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5221 if (tpacpi_leds[i].led_classdev.name)
5222 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5228 static int __init tpacpi_init_led(unsigned int led)
5232 tpacpi_leds[led].led = led;
5234 /* LEDs with no name don't get registered */
5235 if (!tpacpi_led_names[led])
5238 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5239 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5240 if (led_supported == TPACPI_LED_570)
5241 tpacpi_leds[led].led_classdev.brightness_get =
5244 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5246 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5248 rc = led_classdev_register(&tpacpi_pdev->dev,
5249 &tpacpi_leds[led].led_classdev);
5251 tpacpi_leds[led].led_classdev.name = NULL;
5256 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5257 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5258 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5259 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5261 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5262 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5263 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5264 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5265 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5266 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5267 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5268 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5270 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5271 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5272 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5273 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5274 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5276 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5277 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5278 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5279 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5281 /* (1) - may have excess leds enabled on MSB */
5283 /* Defaults (order matters, keep last, don't reorder!) */
5285 .vendor = PCI_VENDOR_ID_LENOVO,
5286 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5289 { /* IBM ThinkPads with no EC version string */
5290 .vendor = PCI_VENDOR_ID_IBM,
5291 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5294 { /* IBM ThinkPads with EC version string */
5295 .vendor = PCI_VENDOR_ID_IBM,
5296 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5301 #undef TPACPI_LEDQ_IBM
5302 #undef TPACPI_LEDQ_LNV
5304 static enum led_access_mode __init led_init_detect_mode(void)
5308 if (tpacpi_is_ibm()) {
5310 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5311 if (ACPI_SUCCESS(status))
5312 return TPACPI_LED_570;
5314 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5315 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5316 if (ACPI_SUCCESS(status))
5317 return TPACPI_LED_OLD;
5321 status = acpi_get_handle(ec_handle, "LED", &led_handle);
5322 if (ACPI_SUCCESS(status))
5323 return TPACPI_LED_NEW;
5325 /* R30, R31, and unknown firmwares */
5327 return TPACPI_LED_NONE;
5330 static int __init led_init(struct ibm_init_struct *iibm)
5334 unsigned long useful_leds;
5336 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5338 led_supported = led_init_detect_mode();
5340 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5341 str_supported(led_supported), led_supported);
5343 if (led_supported == TPACPI_LED_NONE)
5346 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5349 printk(TPACPI_ERR "Out of memory for LED data\n");
5353 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5354 ARRAY_SIZE(led_useful_qtable));
5356 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5357 if (!tpacpi_is_led_restricted(i) &&
5358 test_bit(i, &useful_leds)) {
5359 rc = tpacpi_init_led(i);
5367 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5368 printk(TPACPI_NOTICE
5369 "warning: userspace override of important "
5370 "firmware LEDs is enabled\n");
5375 #define str_led_status(s) \
5376 ((s) == TPACPI_LED_OFF ? "off" : \
5377 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5379 static int led_read(struct seq_file *m)
5381 if (!led_supported) {
5382 seq_printf(m, "status:\t\tnot supported\n");
5385 seq_printf(m, "status:\t\tsupported\n");
5387 if (led_supported == TPACPI_LED_570) {
5390 for (i = 0; i < 8; i++) {
5391 status = led_get_status(i);
5394 seq_printf(m, "%d:\t\t%s\n",
5395 i, str_led_status(status));
5399 seq_printf(m, "commands:\t"
5400 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5405 static int led_write(char *buf)
5409 enum led_status_t s;
5414 while ((cmd = next_cmd(&buf))) {
5415 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5418 if (strstr(cmd, "off")) {
5420 } else if (strstr(cmd, "on")) {
5422 } else if (strstr(cmd, "blink")) {
5423 s = TPACPI_LED_BLINK;
5428 rc = led_set_status(led, s);
5436 static struct ibm_struct led_driver_data = {
5443 /*************************************************************************
5447 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5449 #define TPACPI_BEEP_Q1 0x0001
5451 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5452 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5453 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5456 static int __init beep_init(struct ibm_init_struct *iibm)
5458 unsigned long quirks;
5460 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5462 TPACPI_ACPIHANDLE_INIT(beep);
5464 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5465 str_supported(beep_handle != NULL));
5467 quirks = tpacpi_check_quirks(beep_quirk_table,
5468 ARRAY_SIZE(beep_quirk_table));
5470 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5472 return (beep_handle)? 0 : 1;
5475 static int beep_read(struct seq_file *m)
5478 seq_printf(m, "status:\t\tnot supported\n");
5480 seq_printf(m, "status:\t\tsupported\n");
5481 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5487 static int beep_write(char *buf)
5495 while ((cmd = next_cmd(&buf))) {
5496 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5497 beep_cmd >= 0 && beep_cmd <= 17) {
5501 if (tp_features.beep_needs_two_args) {
5502 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5506 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5515 static struct ibm_struct beep_driver_data = {
5518 .write = beep_write,
5521 /*************************************************************************
5525 enum thermal_access_mode {
5526 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5527 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5528 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5529 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5530 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5533 enum { /* TPACPI_THERMAL_TPEC_* */
5534 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5535 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5536 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5538 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5542 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5543 struct ibm_thermal_sensors_struct {
5544 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5547 static enum thermal_access_mode thermal_read_mode;
5549 /* idx is zero-based */
5550 static int thermal_get_sensor(int idx, s32 *value)
5556 t = TP_EC_THERMAL_TMP0;
5558 switch (thermal_read_mode) {
5559 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5560 case TPACPI_THERMAL_TPEC_16:
5561 if (idx >= 8 && idx <= 15) {
5562 t = TP_EC_THERMAL_TMP8;
5567 case TPACPI_THERMAL_TPEC_8:
5569 if (!acpi_ec_read(t + idx, &tmp))
5571 *value = tmp * 1000;
5576 case TPACPI_THERMAL_ACPI_UPDT:
5578 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5579 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5581 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5583 *value = (t - 2732) * 100;
5588 case TPACPI_THERMAL_ACPI_TMP07:
5590 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5591 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5593 if (t > 127 || t < -127)
5594 t = TP_EC_THERMAL_TMP_NA;
5600 case TPACPI_THERMAL_NONE:
5608 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5619 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5622 for (i = 0 ; i < n; i++) {
5623 res = thermal_get_sensor(i, &s->temp[i]);
5631 static void thermal_dump_all_sensors(void)
5634 struct ibm_thermal_sensors_struct t;
5636 n = thermal_get_sensors(&t);
5640 printk(TPACPI_NOTICE
5641 "temperatures (Celsius):");
5643 for (i = 0; i < n; i++) {
5644 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5645 printk(KERN_CONT " %d", (int)(t.temp[i] / 1000));
5647 printk(KERN_CONT " N/A");
5650 printk(KERN_CONT "\n");
5653 /* sysfs temp##_input -------------------------------------------------- */
5655 static ssize_t thermal_temp_input_show(struct device *dev,
5656 struct device_attribute *attr,
5659 struct sensor_device_attribute *sensor_attr =
5660 to_sensor_dev_attr(attr);
5661 int idx = sensor_attr->index;
5665 res = thermal_get_sensor(idx, &value);
5668 if (value == TPACPI_THERMAL_SENSOR_NA)
5671 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5674 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5675 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5676 thermal_temp_input_show, NULL, _idxB)
5678 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5679 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5680 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5681 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5682 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5683 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5684 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5685 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5686 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5687 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5688 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5689 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5690 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5691 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5692 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5693 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5694 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5697 #define THERMAL_ATTRS(X) \
5698 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5700 static struct attribute *thermal_temp_input_attr[] = {
5720 static const struct attribute_group thermal_temp_input16_group = {
5721 .attrs = thermal_temp_input_attr
5724 static const struct attribute_group thermal_temp_input8_group = {
5725 .attrs = &thermal_temp_input_attr[8]
5728 #undef THERMAL_SENSOR_ATTR_TEMP
5729 #undef THERMAL_ATTRS
5731 /* --------------------------------------------------------------------- */
5733 static int __init thermal_init(struct ibm_init_struct *iibm)
5740 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5742 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5744 if (thinkpad_id.ec_model) {
5746 * Direct EC access mode: sensors at registers
5747 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5748 * non-implemented, thermal sensors return 0x80 when
5753 for (i = 0; i < 8; i++) {
5754 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5760 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5768 /* This is sheer paranoia, but we handle it anyway */
5771 "ThinkPad ACPI EC access misbehaving, "
5772 "falling back to ACPI TMPx access "
5774 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5777 "ThinkPad ACPI EC access misbehaving, "
5778 "disabling thermal sensors access\n");
5779 thermal_read_mode = TPACPI_THERMAL_NONE;
5784 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5786 } else if (acpi_tmp7) {
5787 if (tpacpi_is_ibm() &&
5788 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5789 /* 600e/x, 770e, 770x */
5790 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5792 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5793 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5796 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5797 thermal_read_mode = TPACPI_THERMAL_NONE;
5800 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5801 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5804 switch (thermal_read_mode) {
5805 case TPACPI_THERMAL_TPEC_16:
5806 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5807 &thermal_temp_input16_group);
5811 case TPACPI_THERMAL_TPEC_8:
5812 case TPACPI_THERMAL_ACPI_TMP07:
5813 case TPACPI_THERMAL_ACPI_UPDT:
5814 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5815 &thermal_temp_input8_group);
5819 case TPACPI_THERMAL_NONE:
5827 static void thermal_exit(void)
5829 switch (thermal_read_mode) {
5830 case TPACPI_THERMAL_TPEC_16:
5831 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5832 &thermal_temp_input16_group);
5834 case TPACPI_THERMAL_TPEC_8:
5835 case TPACPI_THERMAL_ACPI_TMP07:
5836 case TPACPI_THERMAL_ACPI_UPDT:
5837 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5838 &thermal_temp_input8_group);
5840 case TPACPI_THERMAL_NONE:
5846 static int thermal_read(struct seq_file *m)
5849 struct ibm_thermal_sensors_struct t;
5851 n = thermal_get_sensors(&t);
5852 if (unlikely(n < 0))
5855 seq_printf(m, "temperatures:\t");
5858 for (i = 0; i < (n - 1); i++)
5859 seq_printf(m, "%d ", t.temp[i] / 1000);
5860 seq_printf(m, "%d\n", t.temp[i] / 1000);
5862 seq_printf(m, "not supported\n");
5867 static struct ibm_struct thermal_driver_data = {
5869 .read = thermal_read,
5870 .exit = thermal_exit,
5873 /*************************************************************************
5874 * Backlight/brightness subdriver
5877 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5880 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5881 * CMOS NVRAM byte 0x5E, bits 0-3.
5883 * EC HBRV (0x31) has the following layout
5884 * Bit 7: unknown function
5885 * Bit 6: unknown function
5886 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5887 * Bit 4: must be set to zero to avoid problems
5888 * Bit 3-0: backlight brightness level
5890 * brightness_get_raw returns status data in the HBRV layout
5892 * WARNING: The X61 has been verified to use HBRV for something else, so
5893 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5894 * testing on the very early *60 Lenovo models...
5898 TP_EC_BACKLIGHT = 0x31,
5900 /* TP_EC_BACKLIGHT bitmasks */
5901 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5902 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5903 TP_EC_BACKLIGHT_MAPSW = 0x20,
5906 enum tpacpi_brightness_access_mode {
5907 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5908 TPACPI_BRGHT_MODE_EC, /* EC control */
5909 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5910 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5911 TPACPI_BRGHT_MODE_MAX
5914 static struct backlight_device *ibm_backlight_device;
5916 static enum tpacpi_brightness_access_mode brightness_mode =
5917 TPACPI_BRGHT_MODE_MAX;
5919 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5921 static struct mutex brightness_mutex;
5923 /* NVRAM brightness access,
5924 * call with brightness_mutex held! */
5925 static unsigned int tpacpi_brightness_nvram_get(void)
5929 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5930 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5931 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5932 lnvram &= bright_maxlvl;
5937 static void tpacpi_brightness_checkpoint_nvram(void)
5942 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
5945 vdbg_printk(TPACPI_DBG_BRGHT,
5946 "trying to checkpoint backlight level to NVRAM...\n");
5948 if (mutex_lock_killable(&brightness_mutex) < 0)
5951 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5953 lec &= TP_EC_BACKLIGHT_LVLMSK;
5954 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
5956 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5957 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
5958 /* NVRAM needs update */
5959 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
5960 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
5962 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
5963 dbg_printk(TPACPI_DBG_BRGHT,
5964 "updated NVRAM backlight level to %u (0x%02x)\n",
5965 (unsigned int) lec, (unsigned int) b_nvram);
5967 vdbg_printk(TPACPI_DBG_BRGHT,
5968 "NVRAM backlight level already is %u (0x%02x)\n",
5969 (unsigned int) lec, (unsigned int) b_nvram);
5972 mutex_unlock(&brightness_mutex);
5976 /* call with brightness_mutex held! */
5977 static int tpacpi_brightness_get_raw(int *status)
5981 switch (brightness_mode) {
5982 case TPACPI_BRGHT_MODE_UCMS_STEP:
5983 *status = tpacpi_brightness_nvram_get();
5985 case TPACPI_BRGHT_MODE_EC:
5986 case TPACPI_BRGHT_MODE_ECNVRAM:
5987 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5996 /* call with brightness_mutex held! */
5997 /* do NOT call with illegal backlight level value */
5998 static int tpacpi_brightness_set_ec(unsigned int value)
6002 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6005 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6006 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6007 (value & TP_EC_BACKLIGHT_LVLMSK))))
6013 /* call with brightness_mutex held! */
6014 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6017 unsigned int current_value, i;
6019 current_value = tpacpi_brightness_nvram_get();
6021 if (value == current_value)
6024 cmos_cmd = (value > current_value) ?
6025 TP_CMOS_BRIGHTNESS_UP :
6026 TP_CMOS_BRIGHTNESS_DOWN;
6027 inc = (value > current_value) ? 1 : -1;
6029 for (i = current_value; i != value; i += inc)
6030 if (issue_thinkpad_cmos_command(cmos_cmd))
6036 /* May return EINTR which can always be mapped to ERESTARTSYS */
6037 static int brightness_set(unsigned int value)
6041 if (value > bright_maxlvl || value < 0)
6044 vdbg_printk(TPACPI_DBG_BRGHT,
6045 "set backlight level to %d\n", value);
6047 res = mutex_lock_killable(&brightness_mutex);
6051 switch (brightness_mode) {
6052 case TPACPI_BRGHT_MODE_EC:
6053 case TPACPI_BRGHT_MODE_ECNVRAM:
6054 res = tpacpi_brightness_set_ec(value);
6056 case TPACPI_BRGHT_MODE_UCMS_STEP:
6057 res = tpacpi_brightness_set_ucmsstep(value);
6063 mutex_unlock(&brightness_mutex);
6067 /* sysfs backlight class ----------------------------------------------- */
6069 static int brightness_update_status(struct backlight_device *bd)
6071 unsigned int level =
6072 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6073 bd->props.power == FB_BLANK_UNBLANK) ?
6074 bd->props.brightness : 0;
6076 dbg_printk(TPACPI_DBG_BRGHT,
6077 "backlight: attempt to set level to %d\n",
6080 /* it is the backlight class's job (caller) to handle
6081 * EINTR and other errors properly */
6082 return brightness_set(level);
6085 static int brightness_get(struct backlight_device *bd)
6089 res = mutex_lock_killable(&brightness_mutex);
6093 res = tpacpi_brightness_get_raw(&status);
6095 mutex_unlock(&brightness_mutex);
6100 return status & TP_EC_BACKLIGHT_LVLMSK;
6103 static void tpacpi_brightness_notify_change(void)
6105 backlight_force_update(ibm_backlight_device,
6106 BACKLIGHT_UPDATE_HOTKEY);
6109 static const struct backlight_ops ibm_backlight_data = {
6110 .get_brightness = brightness_get,
6111 .update_status = brightness_update_status,
6114 /* --------------------------------------------------------------------- */
6117 * Call _BCL method of video device. On some ThinkPads this will
6118 * switch the firmware to the ACPI brightness control mode.
6121 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6123 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6124 union acpi_object *obj;
6127 if (ACPI_SUCCESS(acpi_evaluate_object(handle, "_BCL", NULL, &buffer))) {
6128 obj = (union acpi_object *)buffer.pointer;
6129 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6130 printk(TPACPI_ERR "Unknown _BCL data, "
6131 "please report this to %s\n", TPACPI_MAIL);
6134 rc = obj->package.count;
6140 kfree(buffer.pointer);
6146 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6148 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6150 acpi_handle video_device;
6153 tpacpi_acpi_handle_locate("video", ACPI_VIDEO_HID, &video_device);
6155 bcl_levels = tpacpi_query_bcl_levels(video_device);
6157 tp_features.bright_acpimode = (bcl_levels > 0);
6159 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6163 * These are only useful for models that have only one possibility
6164 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6167 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6168 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6169 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6171 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6172 /* Models with ATI GPUs known to require ECNVRAM mode */
6173 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6175 /* Models with ATI GPUs that can use ECNVRAM */
6176 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6177 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6178 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6179 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6181 /* Models with Intel Extreme Graphics 2 */
6182 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6183 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6184 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6186 /* Models with Intel GMA900 */
6187 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6188 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6189 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6193 * Returns < 0 for error, otherwise sets tp_features.bright_*
6194 * and bright_maxlvl.
6196 static void __init tpacpi_detect_brightness_capabilities(void)
6200 vdbg_printk(TPACPI_DBG_INIT,
6201 "detecting firmware brightness interface capabilities\n");
6203 /* we could run a quirks check here (same table used by
6204 * brightness_init) if needed */
6207 * We always attempt to detect acpi support, so as to switch
6208 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6209 * going to publish a backlight interface
6211 b = tpacpi_check_std_acpi_brightness_support();
6216 "detected a 16-level brightness capable ThinkPad\n");
6222 "detected a 8-level brightness capable ThinkPad\n");
6226 "Unsupported brightness interface, "
6227 "please contact %s\n", TPACPI_MAIL);
6228 tp_features.bright_unkfw = 1;
6229 bright_maxlvl = b - 1;
6233 static int __init brightness_init(struct ibm_init_struct *iibm)
6235 struct backlight_properties props;
6237 unsigned long quirks;
6239 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6241 mutex_init(&brightness_mutex);
6243 quirks = tpacpi_check_quirks(brightness_quirk_table,
6244 ARRAY_SIZE(brightness_quirk_table));
6246 /* tpacpi_detect_brightness_capabilities() must have run already */
6248 /* if it is unknown, we don't handle it: it wouldn't be safe */
6249 if (tp_features.bright_unkfw)
6252 if (!brightness_enable) {
6253 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6254 "brightness support disabled by "
6255 "module parameter\n");
6259 if (acpi_video_backlight_support()) {
6260 if (brightness_enable > 1) {
6262 "Standard ACPI backlight interface "
6263 "available, not loading native one.\n");
6265 } else if (brightness_enable == 1) {
6267 "Cannot enable backlight brightness support, "
6268 "ACPI is already handling it. Refer to the "
6269 "acpi_backlight kernel parameter\n");
6272 } else if (tp_features.bright_acpimode && brightness_enable > 1) {
6273 printk(TPACPI_NOTICE
6274 "Standard ACPI backlight interface not "
6275 "available, thinkpad_acpi native "
6276 "brightness control enabled\n");
6280 * Check for module parameter bogosity, note that we
6281 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6282 * able to detect "unspecified"
6284 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6287 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6288 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6289 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6290 if (quirks & TPACPI_BRGHT_Q_EC)
6291 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6293 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6295 dbg_printk(TPACPI_DBG_BRGHT,
6296 "driver auto-selected brightness_mode=%d\n",
6301 if (!tpacpi_is_ibm() &&
6302 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6303 brightness_mode == TPACPI_BRGHT_MODE_EC))
6306 if (tpacpi_brightness_get_raw(&b) < 0)
6309 memset(&props, 0, sizeof(struct backlight_properties));
6310 props.type = BACKLIGHT_PLATFORM;
6311 props.max_brightness = bright_maxlvl;
6312 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6313 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6315 &ibm_backlight_data,
6317 if (IS_ERR(ibm_backlight_device)) {
6318 int rc = PTR_ERR(ibm_backlight_device);
6319 ibm_backlight_device = NULL;
6320 printk(TPACPI_ERR "Could not register backlight device\n");
6323 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6324 "brightness is supported\n");
6326 if (quirks & TPACPI_BRGHT_Q_ASK) {
6327 printk(TPACPI_NOTICE
6328 "brightness: will use unverified default: "
6329 "brightness_mode=%d\n", brightness_mode);
6330 printk(TPACPI_NOTICE
6331 "brightness: please report to %s whether it works well "
6332 "or not on your ThinkPad\n", TPACPI_MAIL);
6335 /* Added by mistake in early 2007. Probably useless, but it could
6336 * be working around some unknown firmware problem where the value
6337 * read at startup doesn't match the real hardware state... so leave
6338 * it in place just in case */
6339 backlight_update_status(ibm_backlight_device);
6341 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6342 "brightness: registering brightness hotkeys "
6343 "as change notification\n");
6344 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6345 | TP_ACPI_HKEY_BRGHTUP_MASK
6346 | TP_ACPI_HKEY_BRGHTDWN_MASK);
6350 static void brightness_suspend(pm_message_t state)
6352 tpacpi_brightness_checkpoint_nvram();
6355 static void brightness_shutdown(void)
6357 tpacpi_brightness_checkpoint_nvram();
6360 static void brightness_exit(void)
6362 if (ibm_backlight_device) {
6363 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6364 "calling backlight_device_unregister()\n");
6365 backlight_device_unregister(ibm_backlight_device);
6368 tpacpi_brightness_checkpoint_nvram();
6371 static int brightness_read(struct seq_file *m)
6375 level = brightness_get(NULL);
6377 seq_printf(m, "level:\t\tunreadable\n");
6379 seq_printf(m, "level:\t\t%d\n", level);
6380 seq_printf(m, "commands:\tup, down\n");
6381 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6388 static int brightness_write(char *buf)
6394 level = brightness_get(NULL);
6398 while ((cmd = next_cmd(&buf))) {
6399 if (strlencmp(cmd, "up") == 0) {
6400 if (level < bright_maxlvl)
6402 } else if (strlencmp(cmd, "down") == 0) {
6405 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6406 level >= 0 && level <= bright_maxlvl) {
6412 tpacpi_disclose_usertask("procfs brightness",
6413 "set level to %d\n", level);
6416 * Now we know what the final level should be, so we try to set it.
6417 * Doing it this way makes the syscall restartable in case of EINTR
6419 rc = brightness_set(level);
6420 if (!rc && ibm_backlight_device)
6421 backlight_force_update(ibm_backlight_device,
6422 BACKLIGHT_UPDATE_SYSFS);
6423 return (rc == -EINTR)? -ERESTARTSYS : rc;
6426 static struct ibm_struct brightness_driver_data = {
6427 .name = "brightness",
6428 .read = brightness_read,
6429 .write = brightness_write,
6430 .exit = brightness_exit,
6431 .suspend = brightness_suspend,
6432 .shutdown = brightness_shutdown,
6435 /*************************************************************************
6440 * IBM ThinkPads have a simple volume controller with MUTE gating.
6441 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6443 * Since the *61 series (and probably also the later *60 series), Lenovo
6444 * ThinkPads only implement the MUTE gate.
6447 * Bit 6: MUTE (1 mutes sound)
6449 * Other bits should be zero as far as we know.
6451 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6452 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
6453 * such as bit 7 which is used to detect repeated presses of MUTE,
6454 * and we leave them unchanged.
6457 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6459 #define TPACPI_ALSA_DRVNAME "ThinkPad EC"
6460 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6461 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6463 static int alsa_index = ~((1 << (SNDRV_CARDS - 3)) - 1); /* last three slots */
6464 static char *alsa_id = "ThinkPadEC";
6465 static int alsa_enable = SNDRV_DEFAULT_ENABLE1;
6467 struct tpacpi_alsa_data {
6468 struct snd_card *card;
6469 struct snd_ctl_elem_id *ctl_mute_id;
6470 struct snd_ctl_elem_id *ctl_vol_id;
6473 static struct snd_card *alsa_card;
6478 /* TP_EC_AUDIO bits */
6479 TP_EC_AUDIO_MUTESW = 6,
6481 /* TP_EC_AUDIO bitmasks */
6482 TP_EC_AUDIO_LVL_MSK = 0x0F,
6483 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6485 /* Maximum volume */
6486 TP_EC_VOLUME_MAX = 14,
6489 enum tpacpi_volume_access_mode {
6490 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
6491 TPACPI_VOL_MODE_EC, /* Pure EC control */
6492 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
6493 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6497 enum tpacpi_volume_capabilities {
6498 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
6499 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
6500 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
6504 static enum tpacpi_volume_access_mode volume_mode =
6505 TPACPI_VOL_MODE_MAX;
6507 static enum tpacpi_volume_capabilities volume_capabilities;
6508 static int volume_control_allowed;
6511 * Used to syncronize writers to TP_EC_AUDIO and
6512 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6514 static struct mutex volume_mutex;
6516 static void tpacpi_volume_checkpoint_nvram(void)
6522 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6524 if (!volume_control_allowed)
6527 vdbg_printk(TPACPI_DBG_MIXER,
6528 "trying to checkpoint mixer state to NVRAM...\n");
6530 if (tp_features.mixer_no_level_control)
6531 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6533 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6535 if (mutex_lock_killable(&volume_mutex) < 0)
6538 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6541 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6543 if (lec != (b_nvram & ec_mask)) {
6544 /* NVRAM needs update */
6545 b_nvram &= ~ec_mask;
6547 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6548 dbg_printk(TPACPI_DBG_MIXER,
6549 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6550 (unsigned int) lec, (unsigned int) b_nvram);
6552 vdbg_printk(TPACPI_DBG_MIXER,
6553 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6554 (unsigned int) lec, (unsigned int) b_nvram);
6558 mutex_unlock(&volume_mutex);
6561 static int volume_get_status_ec(u8 *status)
6565 if (!acpi_ec_read(TP_EC_AUDIO, &s))
6570 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6575 static int volume_get_status(u8 *status)
6577 return volume_get_status_ec(status);
6580 static int volume_set_status_ec(const u8 status)
6582 if (!acpi_ec_write(TP_EC_AUDIO, status))
6585 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6590 static int volume_set_status(const u8 status)
6592 return volume_set_status_ec(status);
6595 /* returns < 0 on error, 0 on no change, 1 on change */
6596 static int __volume_set_mute_ec(const bool mute)
6601 if (mutex_lock_killable(&volume_mutex) < 0)
6604 rc = volume_get_status_ec(&s);
6608 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6609 s & ~TP_EC_AUDIO_MUTESW_MSK;
6612 rc = volume_set_status_ec(n);
6618 mutex_unlock(&volume_mutex);
6622 static int volume_alsa_set_mute(const bool mute)
6624 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6625 (mute) ? "" : "un");
6626 return __volume_set_mute_ec(mute);
6629 static int volume_set_mute(const bool mute)
6633 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6634 (mute) ? "" : "un");
6636 rc = __volume_set_mute_ec(mute);
6637 return (rc < 0) ? rc : 0;
6640 /* returns < 0 on error, 0 on no change, 1 on change */
6641 static int __volume_set_volume_ec(const u8 vol)
6646 if (vol > TP_EC_VOLUME_MAX)
6649 if (mutex_lock_killable(&volume_mutex) < 0)
6652 rc = volume_get_status_ec(&s);
6656 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6659 rc = volume_set_status_ec(n);
6665 mutex_unlock(&volume_mutex);
6669 static int volume_alsa_set_volume(const u8 vol)
6671 dbg_printk(TPACPI_DBG_MIXER,
6672 "ALSA: trying to set volume level to %hu\n", vol);
6673 return __volume_set_volume_ec(vol);
6676 static void volume_alsa_notify_change(void)
6678 struct tpacpi_alsa_data *d;
6680 if (alsa_card && alsa_card->private_data) {
6681 d = alsa_card->private_data;
6683 snd_ctl_notify(alsa_card,
6684 SNDRV_CTL_EVENT_MASK_VALUE,
6687 snd_ctl_notify(alsa_card,
6688 SNDRV_CTL_EVENT_MASK_VALUE,
6693 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6694 struct snd_ctl_elem_info *uinfo)
6696 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6698 uinfo->value.integer.min = 0;
6699 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6703 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6704 struct snd_ctl_elem_value *ucontrol)
6709 rc = volume_get_status(&s);
6713 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6717 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6718 struct snd_ctl_elem_value *ucontrol)
6720 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
6721 ucontrol->value.integer.value[0]);
6722 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6725 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
6727 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6728 struct snd_ctl_elem_value *ucontrol)
6733 rc = volume_get_status(&s);
6737 ucontrol->value.integer.value[0] =
6738 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6742 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6743 struct snd_ctl_elem_value *ucontrol)
6745 tpacpi_disclose_usertask("ALSA", "%smute\n",
6746 ucontrol->value.integer.value[0] ?
6748 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6751 static struct snd_kcontrol_new volume_alsa_control_vol __devinitdata = {
6752 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6753 .name = "Console Playback Volume",
6755 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6756 .info = volume_alsa_vol_info,
6757 .get = volume_alsa_vol_get,
6760 static struct snd_kcontrol_new volume_alsa_control_mute __devinitdata = {
6761 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6762 .name = "Console Playback Switch",
6764 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6765 .info = volume_alsa_mute_info,
6766 .get = volume_alsa_mute_get,
6769 static void volume_suspend(pm_message_t state)
6771 tpacpi_volume_checkpoint_nvram();
6774 static void volume_resume(void)
6776 volume_alsa_notify_change();
6779 static void volume_shutdown(void)
6781 tpacpi_volume_checkpoint_nvram();
6784 static void volume_exit(void)
6787 snd_card_free(alsa_card);
6791 tpacpi_volume_checkpoint_nvram();
6794 static int __init volume_create_alsa_mixer(void)
6796 struct snd_card *card;
6797 struct tpacpi_alsa_data *data;
6798 struct snd_kcontrol *ctl_vol;
6799 struct snd_kcontrol *ctl_mute;
6802 rc = snd_card_create(alsa_index, alsa_id, THIS_MODULE,
6803 sizeof(struct tpacpi_alsa_data), &card);
6804 if (rc < 0 || !card) {
6806 "Failed to create ALSA card structures: %d\n", rc);
6810 BUG_ON(!card->private_data);
6811 data = card->private_data;
6814 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6815 sizeof(card->driver));
6816 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6817 sizeof(card->shortname));
6818 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6819 (thinkpad_id.ec_version_str) ?
6820 thinkpad_id.ec_version_str : "(unknown)");
6821 snprintf(card->longname, sizeof(card->longname),
6822 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6823 (thinkpad_id.ec_version_str) ?
6824 thinkpad_id.ec_version_str : "unknown");
6826 if (volume_control_allowed) {
6827 volume_alsa_control_vol.put = volume_alsa_vol_put;
6828 volume_alsa_control_vol.access =
6829 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6831 volume_alsa_control_mute.put = volume_alsa_mute_put;
6832 volume_alsa_control_mute.access =
6833 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6836 if (!tp_features.mixer_no_level_control) {
6837 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6838 rc = snd_ctl_add(card, ctl_vol);
6841 "Failed to create ALSA volume control: %d\n",
6845 data->ctl_vol_id = &ctl_vol->id;
6848 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6849 rc = snd_ctl_add(card, ctl_mute);
6851 printk(TPACPI_ERR "Failed to create ALSA mute control: %d\n",
6855 data->ctl_mute_id = &ctl_mute->id;
6857 snd_card_set_dev(card, &tpacpi_pdev->dev);
6858 rc = snd_card_register(card);
6860 printk(TPACPI_ERR "Failed to register ALSA card: %d\n", rc);
6868 snd_card_free(card);
6872 #define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
6873 #define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
6875 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6876 /* Whitelist volume level on all IBM by default */
6877 { .vendor = PCI_VENDOR_ID_IBM,
6878 .bios = TPACPI_MATCH_ANY,
6879 .ec = TPACPI_MATCH_ANY,
6880 .quirks = TPACPI_VOL_Q_LEVEL },
6882 /* Lenovo models with volume control (needs confirmation) */
6883 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6884 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6885 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6886 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6887 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6888 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6889 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6891 /* Whitelist mute-only on all Lenovo by default */
6892 { .vendor = PCI_VENDOR_ID_LENOVO,
6893 .bios = TPACPI_MATCH_ANY,
6894 .ec = TPACPI_MATCH_ANY,
6895 .quirks = TPACPI_VOL_Q_MUTEONLY }
6898 static int __init volume_init(struct ibm_init_struct *iibm)
6900 unsigned long quirks;
6903 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
6905 mutex_init(&volume_mutex);
6908 * Check for module parameter bogosity, note that we
6909 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
6910 * able to detect "unspecified"
6912 if (volume_mode > TPACPI_VOL_MODE_MAX)
6915 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
6917 "UCMS step volume mode not implemented, "
6918 "please contact %s\n", TPACPI_MAIL);
6922 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
6926 * The ALSA mixer is our primary interface.
6927 * When disabled, don't install the subdriver at all
6930 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6931 "ALSA mixer disabled by parameter, "
6932 "not loading volume subdriver...\n");
6936 quirks = tpacpi_check_quirks(volume_quirk_table,
6937 ARRAY_SIZE(volume_quirk_table));
6939 switch (volume_capabilities) {
6940 case TPACPI_VOL_CAP_AUTO:
6941 if (quirks & TPACPI_VOL_Q_MUTEONLY)
6942 tp_features.mixer_no_level_control = 1;
6943 else if (quirks & TPACPI_VOL_Q_LEVEL)
6944 tp_features.mixer_no_level_control = 0;
6946 return 1; /* no mixer */
6948 case TPACPI_VOL_CAP_VOLMUTE:
6949 tp_features.mixer_no_level_control = 0;
6951 case TPACPI_VOL_CAP_MUTEONLY:
6952 tp_features.mixer_no_level_control = 1;
6958 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
6959 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6960 "using user-supplied volume_capabilities=%d\n",
6961 volume_capabilities);
6963 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
6964 volume_mode == TPACPI_VOL_MODE_MAX) {
6965 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
6967 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6968 "driver auto-selected volume_mode=%d\n",
6971 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6972 "using user-supplied volume_mode=%d\n",
6976 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6977 "mute is supported, volume control is %s\n",
6978 str_supported(!tp_features.mixer_no_level_control));
6980 rc = volume_create_alsa_mixer();
6983 "Could not create the ALSA mixer interface\n");
6988 "Console audio control enabled, mode: %s\n",
6989 (volume_control_allowed) ?
6990 "override (read/write)" :
6991 "monitor (read only)");
6993 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6994 "registering volume hotkeys as change notification\n");
6995 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6996 | TP_ACPI_HKEY_VOLUP_MASK
6997 | TP_ACPI_HKEY_VOLDWN_MASK
6998 | TP_ACPI_HKEY_MUTE_MASK);
7003 static int volume_read(struct seq_file *m)
7007 if (volume_get_status(&status) < 0) {
7008 seq_printf(m, "level:\t\tunreadable\n");
7010 if (tp_features.mixer_no_level_control)
7011 seq_printf(m, "level:\t\tunsupported\n");
7013 seq_printf(m, "level:\t\t%d\n",
7014 status & TP_EC_AUDIO_LVL_MSK);
7016 seq_printf(m, "mute:\t\t%s\n",
7017 onoff(status, TP_EC_AUDIO_MUTESW));
7019 if (volume_control_allowed) {
7020 seq_printf(m, "commands:\tunmute, mute\n");
7021 if (!tp_features.mixer_no_level_control) {
7023 "commands:\tup, down\n");
7025 "commands:\tlevel <level>"
7026 " (<level> is 0-%d)\n",
7035 static int volume_write(char *buf)
7038 u8 new_level, new_mute;
7044 * We do allow volume control at driver startup, so that the
7045 * user can set initial state through the volume=... parameter hack.
7047 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7048 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7049 tp_warned.volume_ctrl_forbidden = 1;
7050 printk(TPACPI_NOTICE
7051 "Console audio control in monitor mode, "
7052 "changes are not allowed.\n");
7053 printk(TPACPI_NOTICE
7054 "Use the volume_control=1 module parameter "
7055 "to enable volume control\n");
7060 rc = volume_get_status(&s);
7064 new_level = s & TP_EC_AUDIO_LVL_MSK;
7065 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7067 while ((cmd = next_cmd(&buf))) {
7068 if (!tp_features.mixer_no_level_control) {
7069 if (strlencmp(cmd, "up") == 0) {
7072 else if (new_level < TP_EC_VOLUME_MAX)
7075 } else if (strlencmp(cmd, "down") == 0) {
7078 else if (new_level > 0)
7081 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7082 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7087 if (strlencmp(cmd, "mute") == 0)
7088 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7089 else if (strlencmp(cmd, "unmute") == 0)
7095 if (tp_features.mixer_no_level_control) {
7096 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7097 new_mute ? "" : "un");
7098 rc = volume_set_mute(!!new_mute);
7100 tpacpi_disclose_usertask("procfs volume",
7101 "%smute and set level to %d\n",
7102 new_mute ? "" : "un", new_level);
7103 rc = volume_set_status(new_mute | new_level);
7105 volume_alsa_notify_change();
7107 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7110 static struct ibm_struct volume_driver_data = {
7112 .read = volume_read,
7113 .write = volume_write,
7114 .exit = volume_exit,
7115 .suspend = volume_suspend,
7116 .resume = volume_resume,
7117 .shutdown = volume_shutdown,
7120 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7122 #define alsa_card NULL
7124 static void inline volume_alsa_notify_change(void)
7128 static int __init volume_init(struct ibm_init_struct *iibm)
7131 "volume: disabled as there is no ALSA support in this kernel\n");
7136 static struct ibm_struct volume_driver_data = {
7140 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7142 /*************************************************************************
7149 * TPACPI_FAN_RD_ACPI_GFAN:
7150 * ACPI GFAN method: returns fan level
7152 * see TPACPI_FAN_WR_ACPI_SFAN
7153 * EC 0x2f (HFSP) not available if GFAN exists
7155 * TPACPI_FAN_WR_ACPI_SFAN:
7156 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7158 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7161 * TPACPI_FAN_WR_TPEC:
7162 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7163 * Supported on almost all ThinkPads
7165 * Fan speed changes of any sort (including those caused by the
7166 * disengaged mode) are usually done slowly by the firmware as the
7167 * maximum amount of fan duty cycle change per second seems to be
7170 * Reading is not available if GFAN exists.
7171 * Writing is not available if SFAN exists.
7174 * 7 automatic mode engaged;
7175 * (default operation mode of the ThinkPad)
7176 * fan level is ignored in this mode.
7177 * 6 full speed mode (takes precedence over bit 7);
7178 * not available on all thinkpads. May disable
7179 * the tachometer while the fan controller ramps up
7180 * the speed (which can take up to a few *minutes*).
7181 * Speeds up fan to 100% duty-cycle, which is far above
7182 * the standard RPM levels. It is not impossible that
7183 * it could cause hardware damage.
7184 * 5-3 unused in some models. Extra bits for fan level
7185 * in others, but still useless as all values above
7186 * 7 map to the same speed as level 7 in these models.
7187 * 2-0 fan level (0..7 usually)
7189 * 0x07 = max (set when temperatures critical)
7190 * Some ThinkPads may have other levels, see
7191 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7193 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7194 * boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7195 * does so, its initial value is meaningless (0x07).
7197 * For firmware bugs, refer to:
7198 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7202 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7203 * Main fan tachometer reading (in RPM)
7205 * This register is present on all ThinkPads with a new-style EC, and
7206 * it is known not to be present on the A21m/e, and T22, as there is
7207 * something else in offset 0x84 according to the ACPI DSDT. Other
7208 * ThinkPads from this same time period (and earlier) probably lack the
7209 * tachometer as well.
7211 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7212 * was never fixed by IBM to report the EC firmware version string
7213 * probably support the tachometer (like the early X models), so
7214 * detecting it is quite hard. We need more data to know for sure.
7216 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7219 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7222 * For firmware bugs, refer to:
7223 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7227 * ThinkPad EC register 0x31 bit 0 (only on select models)
7229 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7230 * show the speed of the main fan. When bit 0 of EC register 0x31
7231 * is one, the tachometer registers show the speed of the auxiliary
7234 * Fan control seems to affect both fans, regardless of the state
7237 * So far, only the firmware for the X60/X61 non-tablet versions
7238 * seem to support this (firmware TP-7M).
7240 * TPACPI_FAN_WR_ACPI_FANS:
7241 * ThinkPad X31, X40, X41. Not available in the X60.
7243 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7244 * high speed. ACPI DSDT seems to map these three speeds to levels
7245 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7246 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7248 * The speeds are stored on handles
7249 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7251 * There are three default speed sets, accessible as handles:
7252 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7254 * ACPI DSDT switches which set is in use depending on various
7257 * TPACPI_FAN_WR_TPEC is also available and should be used to
7258 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7259 * but the ACPI tables just mention level 7.
7262 enum { /* Fan control constants */
7263 fan_status_offset = 0x2f, /* EC register 0x2f */
7264 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7265 * 0x84 must be read before 0x85 */
7266 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7267 bit 0 selects which fan is active */
7269 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
7270 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
7272 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
7275 enum fan_status_access_mode {
7276 TPACPI_FAN_NONE = 0, /* No fan status or control */
7277 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
7278 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7281 enum fan_control_access_mode {
7282 TPACPI_FAN_WR_NONE = 0, /* No fan control */
7283 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
7284 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
7285 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
7288 enum fan_control_commands {
7289 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
7290 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
7291 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
7292 * and also watchdog cmd */
7295 static int fan_control_allowed;
7297 static enum fan_status_access_mode fan_status_access_mode;
7298 static enum fan_control_access_mode fan_control_access_mode;
7299 static enum fan_control_commands fan_control_commands;
7301 static u8 fan_control_initial_status;
7302 static u8 fan_control_desired_level;
7303 static u8 fan_control_resume_level;
7304 static int fan_watchdog_maxinterval;
7306 static struct mutex fan_mutex;
7308 static void fan_watchdog_fire(struct work_struct *ignored);
7309 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7311 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
7312 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7313 "\\FSPD", /* 600e/x, 770e, 770x */
7315 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7316 "JFNS", /* 770x-JL */
7320 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7321 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7322 * be in auto mode (0x80).
7324 * This is corrected by any write to HFSP either by the driver, or
7327 * We assume 0x07 really means auto mode while this quirk is active,
7328 * as this is far more likely than the ThinkPad being in level 7,
7329 * which is only used by the firmware during thermal emergencies.
7331 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7332 * TP-70 (T43, R52), which are known to be buggy.
7335 static void fan_quirk1_setup(void)
7337 if (fan_control_initial_status == 0x07) {
7338 printk(TPACPI_NOTICE
7339 "fan_init: initial fan status is unknown, "
7340 "assuming it is in auto mode\n");
7341 tp_features.fan_ctrl_status_undef = 1;
7345 static void fan_quirk1_handle(u8 *fan_status)
7347 if (unlikely(tp_features.fan_ctrl_status_undef)) {
7348 if (*fan_status != fan_control_initial_status) {
7349 /* something changed the HFSP regisnter since
7350 * driver init time, so it is not undefined
7352 tp_features.fan_ctrl_status_undef = 0;
7354 /* Return most likely status. In fact, it
7355 * might be the only possible status */
7356 *fan_status = TP_EC_FAN_AUTO;
7361 /* Select main fan on X60/X61, NOOP on others */
7362 static bool fan_select_fan1(void)
7364 if (tp_features.second_fan) {
7367 if (ec_read(fan_select_offset, &val) < 0)
7370 if (ec_write(fan_select_offset, val) < 0)
7376 /* Select secondary fan on X60/X61 */
7377 static bool fan_select_fan2(void)
7381 if (!tp_features.second_fan)
7384 if (ec_read(fan_select_offset, &val) < 0)
7387 if (ec_write(fan_select_offset, val) < 0)
7394 * Call with fan_mutex held
7396 static void fan_update_desired_level(u8 status)
7399 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7401 fan_control_desired_level = 7;
7403 fan_control_desired_level = status;
7407 static int fan_get_status(u8 *status)
7412 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7414 switch (fan_status_access_mode) {
7415 case TPACPI_FAN_RD_ACPI_GFAN:
7416 /* 570, 600e/x, 770e, 770x */
7418 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
7426 case TPACPI_FAN_RD_TPEC:
7427 /* all except 570, 600e/x, 770e, 770x */
7428 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7431 if (likely(status)) {
7433 fan_quirk1_handle(status);
7445 static int fan_get_status_safe(u8 *status)
7450 if (mutex_lock_killable(&fan_mutex))
7451 return -ERESTARTSYS;
7452 rc = fan_get_status(&s);
7454 fan_update_desired_level(s);
7455 mutex_unlock(&fan_mutex);
7463 static int fan_get_speed(unsigned int *speed)
7467 switch (fan_status_access_mode) {
7468 case TPACPI_FAN_RD_TPEC:
7469 /* all except 570, 600e/x, 770e, 770x */
7470 if (unlikely(!fan_select_fan1()))
7472 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7473 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7477 *speed = (hi << 8) | lo;
7488 static int fan2_get_speed(unsigned int *speed)
7493 switch (fan_status_access_mode) {
7494 case TPACPI_FAN_RD_TPEC:
7495 /* all except 570, 600e/x, 770e, 770x */
7496 if (unlikely(!fan_select_fan2()))
7498 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7499 !acpi_ec_read(fan_rpm_offset + 1, &hi);
7500 fan_select_fan1(); /* play it safe */
7505 *speed = (hi << 8) | lo;
7516 static int fan_set_level(int level)
7518 if (!fan_control_allowed)
7521 switch (fan_control_access_mode) {
7522 case TPACPI_FAN_WR_ACPI_SFAN:
7523 if (level >= 0 && level <= 7) {
7524 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7530 case TPACPI_FAN_WR_ACPI_FANS:
7531 case TPACPI_FAN_WR_TPEC:
7532 if (!(level & TP_EC_FAN_AUTO) &&
7533 !(level & TP_EC_FAN_FULLSPEED) &&
7534 ((level < 0) || (level > 7)))
7537 /* safety net should the EC not support AUTO
7538 * or FULLSPEED mode bits and just ignore them */
7539 if (level & TP_EC_FAN_FULLSPEED)
7540 level |= 7; /* safety min speed 7 */
7541 else if (level & TP_EC_FAN_AUTO)
7542 level |= 4; /* safety min speed 4 */
7544 if (!acpi_ec_write(fan_status_offset, level))
7547 tp_features.fan_ctrl_status_undef = 0;
7554 vdbg_printk(TPACPI_DBG_FAN,
7555 "fan control: set fan control register to 0x%02x\n", level);
7559 static int fan_set_level_safe(int level)
7563 if (!fan_control_allowed)
7566 if (mutex_lock_killable(&fan_mutex))
7567 return -ERESTARTSYS;
7569 if (level == TPACPI_FAN_LAST_LEVEL)
7570 level = fan_control_desired_level;
7572 rc = fan_set_level(level);
7574 fan_update_desired_level(level);
7576 mutex_unlock(&fan_mutex);
7580 static int fan_set_enable(void)
7585 if (!fan_control_allowed)
7588 if (mutex_lock_killable(&fan_mutex))
7589 return -ERESTARTSYS;
7591 switch (fan_control_access_mode) {
7592 case TPACPI_FAN_WR_ACPI_FANS:
7593 case TPACPI_FAN_WR_TPEC:
7594 rc = fan_get_status(&s);
7598 /* Don't go out of emergency fan mode */
7601 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7604 if (!acpi_ec_write(fan_status_offset, s))
7607 tp_features.fan_ctrl_status_undef = 0;
7612 case TPACPI_FAN_WR_ACPI_SFAN:
7613 rc = fan_get_status(&s);
7619 /* Set fan to at least level 4 */
7622 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7632 mutex_unlock(&fan_mutex);
7635 vdbg_printk(TPACPI_DBG_FAN,
7636 "fan control: set fan control register to 0x%02x\n",
7641 static int fan_set_disable(void)
7645 if (!fan_control_allowed)
7648 if (mutex_lock_killable(&fan_mutex))
7649 return -ERESTARTSYS;
7652 switch (fan_control_access_mode) {
7653 case TPACPI_FAN_WR_ACPI_FANS:
7654 case TPACPI_FAN_WR_TPEC:
7655 if (!acpi_ec_write(fan_status_offset, 0x00))
7658 fan_control_desired_level = 0;
7659 tp_features.fan_ctrl_status_undef = 0;
7663 case TPACPI_FAN_WR_ACPI_SFAN:
7664 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7667 fan_control_desired_level = 0;
7675 vdbg_printk(TPACPI_DBG_FAN,
7676 "fan control: set fan control register to 0\n");
7678 mutex_unlock(&fan_mutex);
7682 static int fan_set_speed(int speed)
7686 if (!fan_control_allowed)
7689 if (mutex_lock_killable(&fan_mutex))
7690 return -ERESTARTSYS;
7693 switch (fan_control_access_mode) {
7694 case TPACPI_FAN_WR_ACPI_FANS:
7695 if (speed >= 0 && speed <= 65535) {
7696 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7697 speed, speed, speed))
7707 mutex_unlock(&fan_mutex);
7711 static void fan_watchdog_reset(void)
7713 static int fan_watchdog_active;
7715 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7718 if (fan_watchdog_active)
7719 cancel_delayed_work(&fan_watchdog_task);
7721 if (fan_watchdog_maxinterval > 0 &&
7722 tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7723 fan_watchdog_active = 1;
7724 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7725 msecs_to_jiffies(fan_watchdog_maxinterval
7728 "failed to queue the fan watchdog, "
7729 "watchdog will not trigger\n");
7732 fan_watchdog_active = 0;
7735 static void fan_watchdog_fire(struct work_struct *ignored)
7739 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7742 printk(TPACPI_NOTICE "fan watchdog: enabling fan\n");
7743 rc = fan_set_enable();
7745 printk(TPACPI_ERR "fan watchdog: error %d while enabling fan, "
7746 "will try again later...\n", -rc);
7747 /* reschedule for later */
7748 fan_watchdog_reset();
7753 * SYSFS fan layout: hwmon compatible (device)
7756 * 0: "disengaged" mode
7758 * 2: native EC "auto" mode (recommended, hardware default)
7760 * pwm*: set speed in manual mode, ignored otherwise.
7761 * 0 is level 0; 255 is level 7. Intermediate points done with linear
7764 * fan*_input: tachometer reading, RPM
7767 * SYSFS fan layout: extensions
7769 * fan_watchdog (driver):
7770 * fan watchdog interval in seconds, 0 disables (default), max 120
7773 /* sysfs fan pwm1_enable ----------------------------------------------- */
7774 static ssize_t fan_pwm1_enable_show(struct device *dev,
7775 struct device_attribute *attr,
7781 res = fan_get_status_safe(&status);
7785 if (status & TP_EC_FAN_FULLSPEED) {
7787 } else if (status & TP_EC_FAN_AUTO) {
7792 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7795 static ssize_t fan_pwm1_enable_store(struct device *dev,
7796 struct device_attribute *attr,
7797 const char *buf, size_t count)
7802 if (parse_strtoul(buf, 2, &t))
7805 tpacpi_disclose_usertask("hwmon pwm1_enable",
7806 "set fan mode to %lu\n", t);
7810 level = TP_EC_FAN_FULLSPEED;
7813 level = TPACPI_FAN_LAST_LEVEL;
7816 level = TP_EC_FAN_AUTO;
7819 /* reserved for software-controlled auto mode */
7825 res = fan_set_level_safe(level);
7831 fan_watchdog_reset();
7836 static struct device_attribute dev_attr_fan_pwm1_enable =
7837 __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7838 fan_pwm1_enable_show, fan_pwm1_enable_store);
7840 /* sysfs fan pwm1 ------------------------------------------------------ */
7841 static ssize_t fan_pwm1_show(struct device *dev,
7842 struct device_attribute *attr,
7848 res = fan_get_status_safe(&status);
7853 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7854 status = fan_control_desired_level;
7859 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7862 static ssize_t fan_pwm1_store(struct device *dev,
7863 struct device_attribute *attr,
7864 const char *buf, size_t count)
7868 u8 status, newlevel;
7870 if (parse_strtoul(buf, 255, &s))
7873 tpacpi_disclose_usertask("hwmon pwm1",
7874 "set fan speed to %lu\n", s);
7876 /* scale down from 0-255 to 0-7 */
7877 newlevel = (s >> 5) & 0x07;
7879 if (mutex_lock_killable(&fan_mutex))
7880 return -ERESTARTSYS;
7882 rc = fan_get_status(&status);
7883 if (!rc && (status &
7884 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7885 rc = fan_set_level(newlevel);
7889 fan_update_desired_level(newlevel);
7890 fan_watchdog_reset();
7894 mutex_unlock(&fan_mutex);
7895 return (rc)? rc : count;
7898 static struct device_attribute dev_attr_fan_pwm1 =
7899 __ATTR(pwm1, S_IWUSR | S_IRUGO,
7900 fan_pwm1_show, fan_pwm1_store);
7902 /* sysfs fan fan1_input ------------------------------------------------ */
7903 static ssize_t fan_fan1_input_show(struct device *dev,
7904 struct device_attribute *attr,
7910 res = fan_get_speed(&speed);
7914 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7917 static struct device_attribute dev_attr_fan_fan1_input =
7918 __ATTR(fan1_input, S_IRUGO,
7919 fan_fan1_input_show, NULL);
7921 /* sysfs fan fan2_input ------------------------------------------------ */
7922 static ssize_t fan_fan2_input_show(struct device *dev,
7923 struct device_attribute *attr,
7929 res = fan2_get_speed(&speed);
7933 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7936 static struct device_attribute dev_attr_fan_fan2_input =
7937 __ATTR(fan2_input, S_IRUGO,
7938 fan_fan2_input_show, NULL);
7940 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7941 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7944 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7947 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7948 const char *buf, size_t count)
7952 if (parse_strtoul(buf, 120, &t))
7955 if (!fan_control_allowed)
7958 fan_watchdog_maxinterval = t;
7959 fan_watchdog_reset();
7961 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7966 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7967 fan_fan_watchdog_show, fan_fan_watchdog_store);
7969 /* --------------------------------------------------------------------- */
7970 static struct attribute *fan_attributes[] = {
7971 &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7972 &dev_attr_fan_fan1_input.attr,
7973 NULL, /* for fan2_input */
7977 static const struct attribute_group fan_attr_group = {
7978 .attrs = fan_attributes,
7981 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
7982 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
7984 #define TPACPI_FAN_QI(__id1, __id2, __quirks) \
7985 { .vendor = PCI_VENDOR_ID_IBM, \
7986 .bios = TPACPI_MATCH_ANY, \
7987 .ec = TPID(__id1, __id2), \
7988 .quirks = __quirks }
7990 #define TPACPI_FAN_QL(__id1, __id2, __quirks) \
7991 { .vendor = PCI_VENDOR_ID_LENOVO, \
7992 .bios = TPACPI_MATCH_ANY, \
7993 .ec = TPID(__id1, __id2), \
7994 .quirks = __quirks }
7996 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
7997 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
7998 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
7999 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
8000 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
8001 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
8004 #undef TPACPI_FAN_QL
8005 #undef TPACPI_FAN_QI
8007 static int __init fan_init(struct ibm_init_struct *iibm)
8010 unsigned long quirks;
8012 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8013 "initializing fan subdriver\n");
8015 mutex_init(&fan_mutex);
8016 fan_status_access_mode = TPACPI_FAN_NONE;
8017 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8018 fan_control_commands = 0;
8019 fan_watchdog_maxinterval = 0;
8020 tp_features.fan_ctrl_status_undef = 0;
8021 tp_features.second_fan = 0;
8022 fan_control_desired_level = 7;
8024 if (tpacpi_is_ibm()) {
8025 TPACPI_ACPIHANDLE_INIT(fans);
8026 TPACPI_ACPIHANDLE_INIT(gfan);
8027 TPACPI_ACPIHANDLE_INIT(sfan);
8030 quirks = tpacpi_check_quirks(fan_quirk_table,
8031 ARRAY_SIZE(fan_quirk_table));
8034 /* 570, 600e/x, 770e, 770x */
8035 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8037 /* all other ThinkPads: note that even old-style
8038 * ThinkPad ECs supports the fan control register */
8039 if (likely(acpi_ec_read(fan_status_offset,
8040 &fan_control_initial_status))) {
8041 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8042 if (quirks & TPACPI_FAN_Q1)
8044 if (quirks & TPACPI_FAN_2FAN) {
8045 tp_features.second_fan = 1;
8046 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8047 "secondary fan support enabled\n");
8051 "ThinkPad ACPI EC access misbehaving, "
8052 "fan status and control unavailable\n");
8059 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8060 fan_control_commands |=
8061 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8064 /* gfan without sfan means no fan control */
8065 /* all other models implement TP EC 0x2f control */
8069 fan_control_access_mode =
8070 TPACPI_FAN_WR_ACPI_FANS;
8071 fan_control_commands |=
8072 TPACPI_FAN_CMD_SPEED |
8073 TPACPI_FAN_CMD_LEVEL |
8074 TPACPI_FAN_CMD_ENABLE;
8076 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8077 fan_control_commands |=
8078 TPACPI_FAN_CMD_LEVEL |
8079 TPACPI_FAN_CMD_ENABLE;
8084 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8085 "fan is %s, modes %d, %d\n",
8086 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8087 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8088 fan_status_access_mode, fan_control_access_mode);
8090 /* fan control master switch */
8091 if (!fan_control_allowed) {
8092 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8093 fan_control_commands = 0;
8094 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8095 "fan control features disabled by parameter\n");
8098 /* update fan_control_desired_level */
8099 if (fan_status_access_mode != TPACPI_FAN_NONE)
8100 fan_get_status_safe(NULL);
8102 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8103 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8104 if (tp_features.second_fan) {
8105 /* attach second fan tachometer */
8106 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8107 &dev_attr_fan_fan2_input.attr;
8109 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8114 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8115 &driver_attr_fan_watchdog);
8117 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8126 static void fan_exit(void)
8128 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8129 "cancelling any pending fan watchdog tasks\n");
8131 /* FIXME: can we really do this unconditionally? */
8132 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8133 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8134 &driver_attr_fan_watchdog);
8136 cancel_delayed_work(&fan_watchdog_task);
8137 flush_workqueue(tpacpi_wq);
8140 static void fan_suspend(pm_message_t state)
8144 if (!fan_control_allowed)
8147 /* Store fan status in cache */
8148 fan_control_resume_level = 0;
8149 rc = fan_get_status_safe(&fan_control_resume_level);
8151 printk(TPACPI_NOTICE
8152 "failed to read fan level for later "
8153 "restore during resume: %d\n", rc);
8155 /* if it is undefined, don't attempt to restore it.
8157 if (tp_features.fan_ctrl_status_undef)
8158 fan_control_resume_level = 0;
8161 static void fan_resume(void)
8163 u8 current_level = 7;
8164 bool do_set = false;
8167 /* DSDT *always* updates status on resume */
8168 tp_features.fan_ctrl_status_undef = 0;
8170 if (!fan_control_allowed ||
8171 !fan_control_resume_level ||
8172 (fan_get_status_safe(¤t_level) < 0))
8175 switch (fan_control_access_mode) {
8176 case TPACPI_FAN_WR_ACPI_SFAN:
8177 /* never decrease fan level */
8178 do_set = (fan_control_resume_level > current_level);
8180 case TPACPI_FAN_WR_ACPI_FANS:
8181 case TPACPI_FAN_WR_TPEC:
8182 /* never decrease fan level, scale is:
8183 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8185 * We expect the firmware to set either 7 or AUTO, but we
8186 * handle FULLSPEED out of paranoia.
8188 * So, we can safely only restore FULLSPEED or 7, anything
8189 * else could slow the fan. Restoring AUTO is useless, at
8190 * best that's exactly what the DSDT already set (it is the
8193 * Always keep in mind that the DSDT *will* have set the
8194 * fans to what the vendor supposes is the best level. We
8195 * muck with it only to speed the fan up.
8197 if (fan_control_resume_level != 7 &&
8198 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8201 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8202 (current_level != fan_control_resume_level);
8208 printk(TPACPI_NOTICE
8209 "restoring fan level to 0x%02x\n",
8210 fan_control_resume_level);
8211 rc = fan_set_level_safe(fan_control_resume_level);
8213 printk(TPACPI_NOTICE
8214 "failed to restore fan level: %d\n", rc);
8218 static int fan_read(struct seq_file *m)
8222 unsigned int speed = 0;
8224 switch (fan_status_access_mode) {
8225 case TPACPI_FAN_RD_ACPI_GFAN:
8226 /* 570, 600e/x, 770e, 770x */
8227 rc = fan_get_status_safe(&status);
8231 seq_printf(m, "status:\t\t%s\n"
8233 (status != 0) ? "enabled" : "disabled", status);
8236 case TPACPI_FAN_RD_TPEC:
8237 /* all except 570, 600e/x, 770e, 770x */
8238 rc = fan_get_status_safe(&status);
8242 seq_printf(m, "status:\t\t%s\n",
8243 (status != 0) ? "enabled" : "disabled");
8245 rc = fan_get_speed(&speed);
8249 seq_printf(m, "speed:\t\t%d\n", speed);
8251 if (status & TP_EC_FAN_FULLSPEED)
8252 /* Disengaged mode takes precedence */
8253 seq_printf(m, "level:\t\tdisengaged\n");
8254 else if (status & TP_EC_FAN_AUTO)
8255 seq_printf(m, "level:\t\tauto\n");
8257 seq_printf(m, "level:\t\t%d\n", status);
8260 case TPACPI_FAN_NONE:
8262 seq_printf(m, "status:\t\tnot supported\n");
8265 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8266 seq_printf(m, "commands:\tlevel <level>");
8268 switch (fan_control_access_mode) {
8269 case TPACPI_FAN_WR_ACPI_SFAN:
8270 seq_printf(m, " (<level> is 0-7)\n");
8274 seq_printf(m, " (<level> is 0-7, "
8275 "auto, disengaged, full-speed)\n");
8280 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8281 seq_printf(m, "commands:\tenable, disable\n"
8282 "commands:\twatchdog <timeout> (<timeout> "
8283 "is 0 (off), 1-120 (seconds))\n");
8285 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8286 seq_printf(m, "commands:\tspeed <speed>"
8287 " (<speed> is 0-65535)\n");
8292 static int fan_write_cmd_level(const char *cmd, int *rc)
8296 if (strlencmp(cmd, "level auto") == 0)
8297 level = TP_EC_FAN_AUTO;
8298 else if ((strlencmp(cmd, "level disengaged") == 0) |
8299 (strlencmp(cmd, "level full-speed") == 0))
8300 level = TP_EC_FAN_FULLSPEED;
8301 else if (sscanf(cmd, "level %d", &level) != 1)
8304 *rc = fan_set_level_safe(level);
8306 printk(TPACPI_ERR "level command accepted for unsupported "
8307 "access mode %d", fan_control_access_mode);
8309 tpacpi_disclose_usertask("procfs fan",
8310 "set level to %d\n", level);
8315 static int fan_write_cmd_enable(const char *cmd, int *rc)
8317 if (strlencmp(cmd, "enable") != 0)
8320 *rc = fan_set_enable();
8322 printk(TPACPI_ERR "enable command accepted for unsupported "
8323 "access mode %d", fan_control_access_mode);
8325 tpacpi_disclose_usertask("procfs fan", "enable\n");
8330 static int fan_write_cmd_disable(const char *cmd, int *rc)
8332 if (strlencmp(cmd, "disable") != 0)
8335 *rc = fan_set_disable();
8337 printk(TPACPI_ERR "disable command accepted for unsupported "
8338 "access mode %d", fan_control_access_mode);
8340 tpacpi_disclose_usertask("procfs fan", "disable\n");
8345 static int fan_write_cmd_speed(const char *cmd, int *rc)
8350 * Support speed <low> <medium> <high> ? */
8352 if (sscanf(cmd, "speed %d", &speed) != 1)
8355 *rc = fan_set_speed(speed);
8357 printk(TPACPI_ERR "speed command accepted for unsupported "
8358 "access mode %d", fan_control_access_mode);
8360 tpacpi_disclose_usertask("procfs fan",
8361 "set speed to %d\n", speed);
8366 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8370 if (sscanf(cmd, "watchdog %d", &interval) != 1)
8373 if (interval < 0 || interval > 120)
8376 fan_watchdog_maxinterval = interval;
8377 tpacpi_disclose_usertask("procfs fan",
8378 "set watchdog timer to %d\n",
8385 static int fan_write(char *buf)
8390 while (!rc && (cmd = next_cmd(&buf))) {
8391 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8392 fan_write_cmd_level(cmd, &rc)) &&
8393 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8394 (fan_write_cmd_enable(cmd, &rc) ||
8395 fan_write_cmd_disable(cmd, &rc) ||
8396 fan_write_cmd_watchdog(cmd, &rc))) &&
8397 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8398 fan_write_cmd_speed(cmd, &rc))
8402 fan_watchdog_reset();
8408 static struct ibm_struct fan_driver_data = {
8413 .suspend = fan_suspend,
8414 .resume = fan_resume,
8417 /****************************************************************************
8418 ****************************************************************************
8422 ****************************************************************************
8423 ****************************************************************************/
8426 * HKEY event callout for other subdrivers go here
8427 * (yes, it is ugly, but it is quick, safe, and gets the job done
8429 static void tpacpi_driver_event(const unsigned int hkey_event)
8431 if (ibm_backlight_device) {
8432 switch (hkey_event) {
8433 case TP_HKEY_EV_BRGHT_UP:
8434 case TP_HKEY_EV_BRGHT_DOWN:
8435 tpacpi_brightness_notify_change();
8439 switch (hkey_event) {
8440 case TP_HKEY_EV_VOL_UP:
8441 case TP_HKEY_EV_VOL_DOWN:
8442 case TP_HKEY_EV_VOL_MUTE:
8443 volume_alsa_notify_change();
8448 static void hotkey_driver_event(const unsigned int scancode)
8450 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8453 /* sysfs name ---------------------------------------------------------- */
8454 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8455 struct device_attribute *attr,
8458 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8461 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8462 __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8464 /* --------------------------------------------------------------------- */
8467 static struct proc_dir_entry *proc_dir;
8470 * Module and infrastructure proble, init and exit handling
8473 static int force_load;
8475 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
8476 static const char * __init str_supported(int is_supported)
8478 static char text_unsupported[] __initdata = "not supported";
8480 return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8482 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8484 static void ibm_exit(struct ibm_struct *ibm)
8486 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8488 list_del_init(&ibm->all_drivers);
8490 if (ibm->flags.acpi_notify_installed) {
8491 dbg_printk(TPACPI_DBG_EXIT,
8492 "%s: acpi_remove_notify_handler\n", ibm->name);
8494 acpi_remove_notify_handler(*ibm->acpi->handle,
8496 dispatch_acpi_notify);
8497 ibm->flags.acpi_notify_installed = 0;
8500 if (ibm->flags.proc_created) {
8501 dbg_printk(TPACPI_DBG_EXIT,
8502 "%s: remove_proc_entry\n", ibm->name);
8503 remove_proc_entry(ibm->name, proc_dir);
8504 ibm->flags.proc_created = 0;
8507 if (ibm->flags.acpi_driver_registered) {
8508 dbg_printk(TPACPI_DBG_EXIT,
8509 "%s: acpi_bus_unregister_driver\n", ibm->name);
8511 acpi_bus_unregister_driver(ibm->acpi->driver);
8512 kfree(ibm->acpi->driver);
8513 ibm->acpi->driver = NULL;
8514 ibm->flags.acpi_driver_registered = 0;
8517 if (ibm->flags.init_called && ibm->exit) {
8519 ibm->flags.init_called = 0;
8522 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8525 static int __init ibm_init(struct ibm_init_struct *iibm)
8528 struct ibm_struct *ibm = iibm->data;
8529 struct proc_dir_entry *entry;
8531 BUG_ON(ibm == NULL);
8533 INIT_LIST_HEAD(&ibm->all_drivers);
8535 if (ibm->flags.experimental && !experimental)
8538 dbg_printk(TPACPI_DBG_INIT,
8539 "probing for %s\n", ibm->name);
8542 ret = iibm->init(iibm);
8544 return 0; /* probe failed */
8548 ibm->flags.init_called = 1;
8552 if (ibm->acpi->hid) {
8553 ret = register_tpacpi_subdriver(ibm);
8558 if (ibm->acpi->notify) {
8559 ret = setup_acpi_notify(ibm);
8560 if (ret == -ENODEV) {
8561 printk(TPACPI_NOTICE "disabling subdriver %s\n",
8571 dbg_printk(TPACPI_DBG_INIT,
8572 "%s installed\n", ibm->name);
8575 mode_t mode = iibm->base_procfs_mode;
8581 entry = proc_create_data(ibm->name, mode, proc_dir,
8582 &dispatch_proc_fops, ibm);
8584 printk(TPACPI_ERR "unable to create proc entry %s\n",
8589 ibm->flags.proc_created = 1;
8592 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8597 dbg_printk(TPACPI_DBG_INIT,
8598 "%s: at error exit path with result %d\n",
8602 return (ret < 0)? ret : 0;
8607 static bool __pure __init tpacpi_is_fw_digit(const char c)
8609 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8612 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8613 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8616 return s && strlen(s) >= 8 &&
8617 tpacpi_is_fw_digit(s[0]) &&
8618 tpacpi_is_fw_digit(s[1]) &&
8619 s[2] == t && s[3] == 'T' &&
8620 tpacpi_is_fw_digit(s[4]) &&
8621 tpacpi_is_fw_digit(s[5]);
8624 /* returns 0 - probe ok, or < 0 - probe error.
8625 * Probe ok doesn't mean thinkpad found.
8626 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8627 static int __must_check __init get_thinkpad_model_data(
8628 struct thinkpad_id_data *tp)
8630 const struct dmi_device *dev = NULL;
8631 char ec_fw_string[18];
8637 memset(tp, 0, sizeof(*tp));
8639 if (dmi_name_in_vendors("IBM"))
8640 tp->vendor = PCI_VENDOR_ID_IBM;
8641 else if (dmi_name_in_vendors("LENOVO"))
8642 tp->vendor = PCI_VENDOR_ID_LENOVO;
8646 s = dmi_get_system_info(DMI_BIOS_VERSION);
8647 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8648 if (s && !tp->bios_version_str)
8651 /* Really ancient ThinkPad 240X will fail this, which is fine */
8652 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
8655 tp->bios_model = tp->bios_version_str[0]
8656 | (tp->bios_version_str[1] << 8);
8657 tp->bios_release = (tp->bios_version_str[4] << 8)
8658 | tp->bios_version_str[5];
8661 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8662 * X32 or newer, all Z series; Some models must have an
8663 * up-to-date BIOS or they will not be detected.
8665 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8667 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8668 if (sscanf(dev->name,
8669 "IBM ThinkPad Embedded Controller -[%17c",
8670 ec_fw_string) == 1) {
8671 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8672 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8674 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8675 if (!tp->ec_version_str)
8678 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8679 tp->ec_model = ec_fw_string[0]
8680 | (ec_fw_string[1] << 8);
8681 tp->ec_release = (ec_fw_string[4] << 8)
8684 printk(TPACPI_NOTICE
8685 "ThinkPad firmware release %s "
8686 "doesn't match the known patterns\n",
8688 printk(TPACPI_NOTICE
8689 "please report this to %s\n",
8696 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8697 if (s && !strnicmp(s, "ThinkPad", 8)) {
8698 tp->model_str = kstrdup(s, GFP_KERNEL);
8703 s = dmi_get_system_info(DMI_PRODUCT_NAME);
8704 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8705 if (s && !tp->nummodel_str)
8711 static int __init probe_for_thinkpad(void)
8718 /* It would be dangerous to run the driver in this case */
8719 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8723 * Non-ancient models have better DMI tagging, but very old models
8724 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
8726 is_thinkpad = (thinkpad_id.model_str != NULL) ||
8727 (thinkpad_id.ec_model != 0) ||
8728 tpacpi_is_fw_known();
8730 /* The EC handler is required */
8731 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
8735 "Not yet supported ThinkPad detected!\n");
8739 if (!is_thinkpad && !force_load)
8745 static void __init thinkpad_acpi_init_banner(void)
8747 printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
8748 printk(TPACPI_INFO "%s\n", TPACPI_URL);
8750 printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
8751 (thinkpad_id.bios_version_str) ?
8752 thinkpad_id.bios_version_str : "unknown",
8753 (thinkpad_id.ec_version_str) ?
8754 thinkpad_id.ec_version_str : "unknown");
8756 BUG_ON(!thinkpad_id.vendor);
8758 if (thinkpad_id.model_str)
8759 printk(TPACPI_INFO "%s %s, model %s\n",
8760 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
8761 "IBM" : ((thinkpad_id.vendor ==
8762 PCI_VENDOR_ID_LENOVO) ?
8763 "Lenovo" : "Unknown vendor"),
8764 thinkpad_id.model_str,
8765 (thinkpad_id.nummodel_str) ?
8766 thinkpad_id.nummodel_str : "unknown");
8769 /* Module init, exit, parameters */
8771 static struct ibm_init_struct ibms_init[] __initdata = {
8773 .data = &thinkpad_acpi_driver_data,
8776 .init = hotkey_init,
8777 .data = &hotkey_driver_data,
8780 .init = bluetooth_init,
8781 .data = &bluetooth_driver_data,
8785 .data = &wan_driver_data,
8789 .data = &uwb_driver_data,
8791 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8794 .base_procfs_mode = S_IRUSR,
8795 .data = &video_driver_data,
8800 .data = &light_driver_data,
8804 .data = &cmos_driver_data,
8808 .data = &led_driver_data,
8812 .data = &beep_driver_data,
8815 .init = thermal_init,
8816 .data = &thermal_driver_data,
8819 .init = brightness_init,
8820 .data = &brightness_driver_data,
8823 .init = volume_init,
8824 .data = &volume_driver_data,
8828 .data = &fan_driver_data,
8832 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8835 struct ibm_struct *ibm;
8837 if (!kp || !kp->name || !val)
8840 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8841 ibm = ibms_init[i].data;
8842 WARN_ON(ibm == NULL);
8844 if (!ibm || !ibm->name)
8847 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8848 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8850 strcpy(ibms_init[i].param, val);
8851 strcat(ibms_init[i].param, ",");
8859 module_param(experimental, int, 0444);
8860 MODULE_PARM_DESC(experimental,
8861 "Enables experimental features when non-zero");
8863 module_param_named(debug, dbg_level, uint, 0);
8864 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8866 module_param(force_load, bool, 0444);
8867 MODULE_PARM_DESC(force_load,
8868 "Attempts to load the driver even on a "
8869 "mis-identified ThinkPad when true");
8871 module_param_named(fan_control, fan_control_allowed, bool, 0444);
8872 MODULE_PARM_DESC(fan_control,
8873 "Enables setting fan parameters features when true");
8875 module_param_named(brightness_mode, brightness_mode, uint, 0444);
8876 MODULE_PARM_DESC(brightness_mode,
8877 "Selects brightness control strategy: "
8878 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8880 module_param(brightness_enable, uint, 0444);
8881 MODULE_PARM_DESC(brightness_enable,
8882 "Enables backlight control when 1, disables when 0");
8884 module_param(hotkey_report_mode, uint, 0444);
8885 MODULE_PARM_DESC(hotkey_report_mode,
8886 "used for backwards compatibility with userspace, "
8887 "see documentation");
8889 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8890 module_param_named(volume_mode, volume_mode, uint, 0444);
8891 MODULE_PARM_DESC(volume_mode,
8892 "Selects volume control strategy: "
8893 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8895 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8896 MODULE_PARM_DESC(volume_capabilities,
8897 "Selects the mixer capabilites: "
8898 "0=auto, 1=volume and mute, 2=mute only");
8900 module_param_named(volume_control, volume_control_allowed, bool, 0444);
8901 MODULE_PARM_DESC(volume_control,
8902 "Enables software override for the console audio "
8903 "control when true");
8905 /* ALSA module API parameters */
8906 module_param_named(index, alsa_index, int, 0444);
8907 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8908 module_param_named(id, alsa_id, charp, 0444);
8909 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8910 module_param_named(enable, alsa_enable, bool, 0444);
8911 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8912 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8914 #define TPACPI_PARAM(feature) \
8915 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8916 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8917 "at module load, see documentation")
8919 TPACPI_PARAM(hotkey);
8920 TPACPI_PARAM(bluetooth);
8921 TPACPI_PARAM(video);
8922 TPACPI_PARAM(light);
8926 TPACPI_PARAM(brightness);
8927 TPACPI_PARAM(volume);
8930 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8931 module_param(dbg_wlswemul, uint, 0444);
8932 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8933 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8934 MODULE_PARM_DESC(wlsw_state,
8935 "Initial state of the emulated WLSW switch");
8937 module_param(dbg_bluetoothemul, uint, 0444);
8938 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8939 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8940 MODULE_PARM_DESC(bluetooth_state,
8941 "Initial state of the emulated bluetooth switch");
8943 module_param(dbg_wwanemul, uint, 0444);
8944 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8945 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8946 MODULE_PARM_DESC(wwan_state,
8947 "Initial state of the emulated WWAN switch");
8949 module_param(dbg_uwbemul, uint, 0444);
8950 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8951 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8952 MODULE_PARM_DESC(uwb_state,
8953 "Initial state of the emulated UWB switch");
8956 static void thinkpad_acpi_module_exit(void)
8958 struct ibm_struct *ibm, *itmp;
8960 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8962 list_for_each_entry_safe_reverse(ibm, itmp,
8963 &tpacpi_all_drivers,
8968 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8970 if (tpacpi_inputdev) {
8971 if (tp_features.input_device_registered)
8972 input_unregister_device(tpacpi_inputdev);
8974 input_free_device(tpacpi_inputdev);
8978 hwmon_device_unregister(tpacpi_hwmon);
8980 if (tp_features.sensors_pdev_attrs_registered)
8981 device_remove_file(&tpacpi_sensors_pdev->dev,
8982 &dev_attr_thinkpad_acpi_pdev_name);
8983 if (tpacpi_sensors_pdev)
8984 platform_device_unregister(tpacpi_sensors_pdev);
8986 platform_device_unregister(tpacpi_pdev);
8988 if (tp_features.sensors_pdrv_attrs_registered)
8989 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8990 if (tp_features.platform_drv_attrs_registered)
8991 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8993 if (tp_features.sensors_pdrv_registered)
8994 platform_driver_unregister(&tpacpi_hwmon_pdriver);
8996 if (tp_features.platform_drv_registered)
8997 platform_driver_unregister(&tpacpi_pdriver);
9000 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
9003 destroy_workqueue(tpacpi_wq);
9005 kfree(thinkpad_id.bios_version_str);
9006 kfree(thinkpad_id.ec_version_str);
9007 kfree(thinkpad_id.model_str);
9011 static int __init thinkpad_acpi_module_init(void)
9015 tpacpi_lifecycle = TPACPI_LIFE_INIT;
9017 /* Parameter checking */
9018 if (hotkey_report_mode > 2)
9021 /* Driver-level probe */
9023 ret = get_thinkpad_model_data(&thinkpad_id);
9026 "unable to get DMI data: %d\n", ret);
9027 thinkpad_acpi_module_exit();
9030 ret = probe_for_thinkpad();
9032 thinkpad_acpi_module_exit();
9036 /* Driver initialization */
9038 thinkpad_acpi_init_banner();
9039 tpacpi_check_outdated_fw();
9041 TPACPI_ACPIHANDLE_INIT(ecrd);
9042 TPACPI_ACPIHANDLE_INIT(ecwr);
9044 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9046 thinkpad_acpi_module_exit();
9050 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9053 "unable to create proc dir " TPACPI_PROC_DIR);
9054 thinkpad_acpi_module_exit();
9058 ret = platform_driver_register(&tpacpi_pdriver);
9061 "unable to register main platform driver\n");
9062 thinkpad_acpi_module_exit();
9065 tp_features.platform_drv_registered = 1;
9067 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9070 "unable to register hwmon platform driver\n");
9071 thinkpad_acpi_module_exit();
9074 tp_features.sensors_pdrv_registered = 1;
9076 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9078 tp_features.platform_drv_attrs_registered = 1;
9079 ret = tpacpi_create_driver_attributes(
9080 &tpacpi_hwmon_pdriver.driver);
9084 "unable to create sysfs driver attributes\n");
9085 thinkpad_acpi_module_exit();
9088 tp_features.sensors_pdrv_attrs_registered = 1;
9091 /* Device initialization */
9092 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9094 if (IS_ERR(tpacpi_pdev)) {
9095 ret = PTR_ERR(tpacpi_pdev);
9097 printk(TPACPI_ERR "unable to register platform device\n");
9098 thinkpad_acpi_module_exit();
9101 tpacpi_sensors_pdev = platform_device_register_simple(
9102 TPACPI_HWMON_DRVR_NAME,
9104 if (IS_ERR(tpacpi_sensors_pdev)) {
9105 ret = PTR_ERR(tpacpi_sensors_pdev);
9106 tpacpi_sensors_pdev = NULL;
9108 "unable to register hwmon platform device\n");
9109 thinkpad_acpi_module_exit();
9112 ret = device_create_file(&tpacpi_sensors_pdev->dev,
9113 &dev_attr_thinkpad_acpi_pdev_name);
9116 "unable to create sysfs hwmon device attributes\n");
9117 thinkpad_acpi_module_exit();
9120 tp_features.sensors_pdev_attrs_registered = 1;
9121 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9122 if (IS_ERR(tpacpi_hwmon)) {
9123 ret = PTR_ERR(tpacpi_hwmon);
9124 tpacpi_hwmon = NULL;
9125 printk(TPACPI_ERR "unable to register hwmon device\n");
9126 thinkpad_acpi_module_exit();
9129 mutex_init(&tpacpi_inputdev_send_mutex);
9130 tpacpi_inputdev = input_allocate_device();
9131 if (!tpacpi_inputdev) {
9132 printk(TPACPI_ERR "unable to allocate input device\n");
9133 thinkpad_acpi_module_exit();
9136 /* Prepare input device, but don't register */
9137 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9138 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9139 tpacpi_inputdev->id.bustype = BUS_HOST;
9140 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9141 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9142 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9143 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9146 /* Init subdriver dependencies */
9147 tpacpi_detect_brightness_capabilities();
9149 /* Init subdrivers */
9150 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9151 ret = ibm_init(&ibms_init[i]);
9152 if (ret >= 0 && *ibms_init[i].param)
9153 ret = ibms_init[i].data->write(ibms_init[i].param);
9155 thinkpad_acpi_module_exit();
9160 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9162 ret = input_register_device(tpacpi_inputdev);
9164 printk(TPACPI_ERR "unable to register input device\n");
9165 thinkpad_acpi_module_exit();
9168 tp_features.input_device_registered = 1;
9174 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9177 * This will autoload the driver in almost every ThinkPad
9178 * in widespread use.
9180 * Only _VERY_ old models, like the 240, 240x and 570 lack
9181 * the HKEY event interface.
9183 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9186 * DMI matching for module autoloading
9188 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9189 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9191 * Only models listed in thinkwiki will be supported, so add yours
9192 * if it is not there yet.
9194 #define IBM_BIOS_MODULE_ALIAS(__type) \
9195 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9197 /* Ancient thinkpad BIOSes have to be identified by
9198 * BIOS type or model number, and there are far less
9199 * BIOS types than model numbers... */
9200 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
9202 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9203 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9204 MODULE_DESCRIPTION(TPACPI_DESC);
9205 MODULE_VERSION(TPACPI_VERSION);
9206 MODULE_LICENSE("GPL");
9208 module_init(thinkpad_acpi_module_init);
9209 module_exit(thinkpad_acpi_module_exit);