drivers/platform/x86/thinkpad_acpi.c: delete double assignment
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / platform / x86 / thinkpad_acpi.c
blobe8c21994b36da2c1bb9eb71af883a597566f532c
1 /*
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
21 * 02110-1301, USA.
24 #define TPACPI_VERSION "0.24"
25 #define TPACPI_SYSFS_VERSION 0x020700
28 * Changelog:
29 * 2007-10-20 changelog trimmed down
31 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
32 * drivers/misc.
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>
68 #include <linux/fb.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
99 /* NVRAM Addresses */
100 enum tp_nvram_addr {
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 */
109 enum {
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 */
126 enum {
127 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
130 /* ACPI HIDs */
131 #define TPACPI_ACPI_HKEY_HID "IBM0068"
132 #define TPACPI_ACPI_EC_HID "PNP0C09"
134 /* Input IDs */
135 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
136 #define TPACPI_HKEY_INPUT_VERSION 0x4101
138 /* ACPI \WGSV commands */
139 enum {
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 */
147 enum {
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 */
160 /* HKEY events */
161 enum tpacpi_hkey_event_t {
162 /* Hotkey-related */
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 */
194 /* Thermal events */
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 */
201 /* Misc */
202 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
205 /****************************************************************************
206 * Main driver
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
226 /* printk headers */
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
257 struct ibm_struct;
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);
264 acpi_handle *handle;
265 u32 type;
266 struct acpi_device *device;
269 struct ibm_struct {
270 char *name;
272 int (*read) (struct seq_file *);
273 int (*write) (char *);
274 void (*exit) (void);
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;
283 struct {
284 u8 acpi_driver_registered:1;
285 u8 acpi_notify_installed:1;
286 u8 proc_created:1;
287 u8 init_called:1;
288 u8 experimental:1;
289 } flags;
292 struct ibm_init_struct {
293 char param[32];
295 int (*init) (struct ibm_init_struct *);
296 mode_t base_procfs_mode;
297 struct ibm_struct *data;
300 static struct {
301 u32 bluetooth:1;
302 u32 hotkey:1;
303 u32 hotkey_mask:1;
304 u32 hotkey_wlsw:1;
305 u32 hotkey_tablet:1;
306 u32 light:1;
307 u32 light_status:1;
308 u32 bright_acpimode:1;
309 u32 bright_unkfw:1;
310 u32 wan:1;
311 u32 uwb:1;
312 u32 fan_ctrl_status_undef:1;
313 u32 second_fan: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;
323 } tp_features;
325 static struct {
326 u16 hotkey_mask_ff:1;
327 u16 volume_ctrl_forbidden:1;
328 } tp_warned;
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 */
338 u16 ec_model;
339 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
340 u16 ec_release;
342 char *model_str; /* ThinkPad T43 */
343 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
345 static struct thinkpad_id_data thinkpad_id;
347 static enum {
348 TPACPI_LIFE_INIT = 0,
349 TPACPI_LIFE_RUNNING,
350 TPACPI_LIFE_EXITING,
351 } tpacpi_lifecycle;
353 static int experimental;
354 static u32 dbg_level;
356 static struct workqueue_struct *tpacpi_wq;
358 enum led_status_t {
359 TPACPI_LED_OFF = 0,
360 TPACPI_LED_ON,
361 TPACPI_LED_BLINK,
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;
369 unsigned int led;
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;
384 #endif
387 /*************************************************************************
388 * Debugging helpers
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); \
394 } while (0)
396 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
397 #define vdbg_printk dbg_printk
398 static const char *str_supported(int is_supported);
399 #else
400 #define vdbg_printk(a_dbg_level, format, arg...) \
401 do { } while (0)
402 #endif
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...) \
411 do { \
412 if (unlikely( \
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); \
418 } while (0)
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 {
454 unsigned int vendor;
455 u16 bios;
456 u16 ec;
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)
477 while (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;
486 qlist_size--;
487 qlist++;
489 return 0;
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 /*************************************************************************
511 * ACPI basic handles
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 = \
520 &parent##_handle; \
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, */
527 /* T4x, X31, X40 */
528 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
529 "\\CMS", /* R40, R40e */
530 ); /* all others */
532 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
533 "^HKEY", /* R30, R31 */
534 "HKEY", /* all others */
535 ); /* 570 */
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 */
543 ); /* R30, R31 */
546 /*************************************************************************
547 * ACPI helpers
550 static int acpi_evalf(acpi_handle handle,
551 void *res, char *method, char *fmt, ...)
553 char *fmt0 = 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;
558 acpi_status status;
559 va_list ap;
560 char res_type;
561 int success;
562 int quiet;
564 if (!*fmt) {
565 printk(TPACPI_ERR "acpi_evalf() called with empty format\n");
566 return 0;
569 if (*fmt == 'q') {
570 quiet = 1;
571 fmt++;
572 } else
573 quiet = 0;
575 res_type = *(fmt++);
577 params.count = 0;
578 params.pointer = &in_objs[0];
580 va_start(ap, fmt);
581 while (*fmt) {
582 char c = *(fmt++);
583 switch (c) {
584 case 'd': /* int */
585 in_objs[params.count].integer.value = va_arg(ap, int);
586 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
587 break;
588 /* add more types as needed */
589 default:
590 printk(TPACPI_ERR "acpi_evalf() called "
591 "with invalid format character '%c'\n", c);
592 return 0;
595 va_end(ap);
597 if (res_type != 'v') {
598 result.length = sizeof(out_obj);
599 result.pointer = &out_obj;
600 resultp = &result;
601 } else
602 resultp = NULL;
604 status = acpi_evaluate_object(handle, method, &params, resultp);
606 switch (res_type) {
607 case 'd': /* int */
608 success = (status == AE_OK &&
609 out_obj.type == ACPI_TYPE_INTEGER);
610 if (success && res)
611 *(int *)res = out_obj.integer.value;
612 break;
613 case 'v': /* void */
614 success = status == AE_OK;
615 break;
616 /* add more types as needed */
617 default:
618 printk(TPACPI_ERR "acpi_evalf() called "
619 "with invalid format character '%c'\n", res_type);
620 return 0;
623 if (!success && !quiet)
624 printk(TPACPI_ERR "acpi_evalf(%s, %s, ...) failed: %s\n",
625 method, fmt0, acpi_format_exception(status));
627 return success;
630 static int acpi_ec_read(int i, u8 *p)
632 int v;
634 if (ecrd_handle) {
635 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
636 return 0;
637 *p = v;
638 } else {
639 if (ec_read(i, p) < 0)
640 return 0;
643 return 1;
646 static int acpi_ec_write(int i, u8 v)
648 if (ecwr_handle) {
649 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
650 return 0;
651 } else {
652 if (ec_write(i, v) < 0)
653 return 0;
656 return 1;
659 static int issue_thinkpad_cmos_command(int cmos_cmd)
661 if (!cmos_handle)
662 return -ENXIO;
664 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
665 return -EIO;
667 return 0;
670 /*************************************************************************
671 * ACPI device model
674 #define TPACPI_ACPIHANDLE_INIT(object) \
675 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
676 object##_paths, ARRAY_SIZE(object##_paths))
678 static void __init drv_acpi_handle_init(const char *name,
679 acpi_handle *handle, const acpi_handle parent,
680 char **paths, const int num_paths)
682 int i;
683 acpi_status status;
685 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
686 name);
688 for (i = 0; i < num_paths; i++) {
689 status = acpi_get_handle(parent, paths[i], handle);
690 if (ACPI_SUCCESS(status)) {
691 dbg_printk(TPACPI_DBG_INIT,
692 "Found ACPI handle %s for %s\n",
693 paths[i], name);
694 return;
698 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
699 name);
700 *handle = NULL;
703 static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
704 u32 level, void *context, void **return_value)
706 *(acpi_handle *)return_value = handle;
708 return AE_CTRL_TERMINATE;
711 static void __init tpacpi_acpi_handle_locate(const char *name,
712 const char *hid,
713 acpi_handle *handle)
715 acpi_status status;
716 acpi_handle device_found;
718 BUG_ON(!name || !hid || !handle);
719 vdbg_printk(TPACPI_DBG_INIT,
720 "trying to locate ACPI handle for %s, using HID %s\n",
721 name, hid);
723 memset(&device_found, 0, sizeof(device_found));
724 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
725 (void *)name, &device_found);
727 *handle = NULL;
729 if (ACPI_SUCCESS(status)) {
730 *handle = device_found;
731 dbg_printk(TPACPI_DBG_INIT,
732 "Found ACPI handle for %s\n", name);
733 } else {
734 vdbg_printk(TPACPI_DBG_INIT,
735 "Could not locate an ACPI handle for %s: %s\n",
736 name, acpi_format_exception(status));
740 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
742 struct ibm_struct *ibm = data;
744 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
745 return;
747 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
748 return;
750 ibm->acpi->notify(ibm, event);
753 static int __init setup_acpi_notify(struct ibm_struct *ibm)
755 acpi_status status;
756 int rc;
758 BUG_ON(!ibm->acpi);
760 if (!*ibm->acpi->handle)
761 return 0;
763 vdbg_printk(TPACPI_DBG_INIT,
764 "setting up ACPI notify for %s\n", ibm->name);
766 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
767 if (rc < 0) {
768 printk(TPACPI_ERR "acpi_bus_get_device(%s) failed: %d\n",
769 ibm->name, rc);
770 return -ENODEV;
773 ibm->acpi->device->driver_data = ibm;
774 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
775 TPACPI_ACPI_EVENT_PREFIX,
776 ibm->name);
778 status = acpi_install_notify_handler(*ibm->acpi->handle,
779 ibm->acpi->type, dispatch_acpi_notify, ibm);
780 if (ACPI_FAILURE(status)) {
781 if (status == AE_ALREADY_EXISTS) {
782 printk(TPACPI_NOTICE
783 "another device driver is already "
784 "handling %s events\n", ibm->name);
785 } else {
786 printk(TPACPI_ERR
787 "acpi_install_notify_handler(%s) failed: %s\n",
788 ibm->name, acpi_format_exception(status));
790 return -ENODEV;
792 ibm->flags.acpi_notify_installed = 1;
793 return 0;
796 static int __init tpacpi_device_add(struct acpi_device *device)
798 return 0;
801 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
803 int rc;
805 dbg_printk(TPACPI_DBG_INIT,
806 "registering %s as an ACPI driver\n", ibm->name);
808 BUG_ON(!ibm->acpi);
810 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
811 if (!ibm->acpi->driver) {
812 printk(TPACPI_ERR
813 "failed to allocate memory for ibm->acpi->driver\n");
814 return -ENOMEM;
817 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
818 ibm->acpi->driver->ids = ibm->acpi->hid;
820 ibm->acpi->driver->ops.add = &tpacpi_device_add;
822 rc = acpi_bus_register_driver(ibm->acpi->driver);
823 if (rc < 0) {
824 printk(TPACPI_ERR "acpi_bus_register_driver(%s) failed: %d\n",
825 ibm->name, rc);
826 kfree(ibm->acpi->driver);
827 ibm->acpi->driver = NULL;
828 } else if (!rc)
829 ibm->flags.acpi_driver_registered = 1;
831 return rc;
835 /****************************************************************************
836 ****************************************************************************
838 * Procfs Helpers
840 ****************************************************************************
841 ****************************************************************************/
843 static int dispatch_proc_show(struct seq_file *m, void *v)
845 struct ibm_struct *ibm = m->private;
847 if (!ibm || !ibm->read)
848 return -EINVAL;
849 return ibm->read(m);
852 static int dispatch_proc_open(struct inode *inode, struct file *file)
854 return single_open(file, dispatch_proc_show, PDE(inode)->data);
857 static ssize_t dispatch_proc_write(struct file *file,
858 const char __user *userbuf,
859 size_t count, loff_t *pos)
861 struct ibm_struct *ibm = PDE(file->f_path.dentry->d_inode)->data;
862 char *kernbuf;
863 int ret;
865 if (!ibm || !ibm->write)
866 return -EINVAL;
867 if (count > PAGE_SIZE - 2)
868 return -EINVAL;
870 kernbuf = kmalloc(count + 2, GFP_KERNEL);
871 if (!kernbuf)
872 return -ENOMEM;
874 if (copy_from_user(kernbuf, userbuf, count)) {
875 kfree(kernbuf);
876 return -EFAULT;
879 kernbuf[count] = 0;
880 strcat(kernbuf, ",");
881 ret = ibm->write(kernbuf);
882 if (ret == 0)
883 ret = count;
885 kfree(kernbuf);
887 return ret;
890 static const struct file_operations dispatch_proc_fops = {
891 .owner = THIS_MODULE,
892 .open = dispatch_proc_open,
893 .read = seq_read,
894 .llseek = seq_lseek,
895 .release = single_release,
896 .write = dispatch_proc_write,
899 static char *next_cmd(char **cmds)
901 char *start = *cmds;
902 char *end;
904 while ((end = strchr(start, ',')) && end == start)
905 start = end + 1;
907 if (!end)
908 return NULL;
910 *end = 0;
911 *cmds = end + 1;
912 return start;
916 /****************************************************************************
917 ****************************************************************************
919 * Device model: input, hwmon and platform
921 ****************************************************************************
922 ****************************************************************************/
924 static struct platform_device *tpacpi_pdev;
925 static struct platform_device *tpacpi_sensors_pdev;
926 static struct device *tpacpi_hwmon;
927 static struct input_dev *tpacpi_inputdev;
928 static struct mutex tpacpi_inputdev_send_mutex;
929 static LIST_HEAD(tpacpi_all_drivers);
931 static int tpacpi_suspend_handler(struct platform_device *pdev,
932 pm_message_t state)
934 struct ibm_struct *ibm, *itmp;
936 list_for_each_entry_safe(ibm, itmp,
937 &tpacpi_all_drivers,
938 all_drivers) {
939 if (ibm->suspend)
940 (ibm->suspend)(state);
943 return 0;
946 static int tpacpi_resume_handler(struct platform_device *pdev)
948 struct ibm_struct *ibm, *itmp;
950 list_for_each_entry_safe(ibm, itmp,
951 &tpacpi_all_drivers,
952 all_drivers) {
953 if (ibm->resume)
954 (ibm->resume)();
957 return 0;
960 static void tpacpi_shutdown_handler(struct platform_device *pdev)
962 struct ibm_struct *ibm, *itmp;
964 list_for_each_entry_safe(ibm, itmp,
965 &tpacpi_all_drivers,
966 all_drivers) {
967 if (ibm->shutdown)
968 (ibm->shutdown)();
972 static struct platform_driver tpacpi_pdriver = {
973 .driver = {
974 .name = TPACPI_DRVR_NAME,
975 .owner = THIS_MODULE,
977 .suspend = tpacpi_suspend_handler,
978 .resume = tpacpi_resume_handler,
979 .shutdown = tpacpi_shutdown_handler,
982 static struct platform_driver tpacpi_hwmon_pdriver = {
983 .driver = {
984 .name = TPACPI_HWMON_DRVR_NAME,
985 .owner = THIS_MODULE,
989 /*************************************************************************
990 * sysfs support helpers
993 struct attribute_set {
994 unsigned int members, max_members;
995 struct attribute_group group;
998 struct attribute_set_obj {
999 struct attribute_set s;
1000 struct attribute *a;
1001 } __attribute__((packed));
1003 static struct attribute_set *create_attr_set(unsigned int max_members,
1004 const char *name)
1006 struct attribute_set_obj *sobj;
1008 if (max_members == 0)
1009 return NULL;
1011 /* Allocates space for implicit NULL at the end too */
1012 sobj = kzalloc(sizeof(struct attribute_set_obj) +
1013 max_members * sizeof(struct attribute *),
1014 GFP_KERNEL);
1015 if (!sobj)
1016 return NULL;
1017 sobj->s.max_members = max_members;
1018 sobj->s.group.attrs = &sobj->a;
1019 sobj->s.group.name = name;
1021 return &sobj->s;
1024 #define destroy_attr_set(_set) \
1025 kfree(_set);
1027 /* not multi-threaded safe, use it in a single thread per set */
1028 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1030 if (!s || !attr)
1031 return -EINVAL;
1033 if (s->members >= s->max_members)
1034 return -ENOMEM;
1036 s->group.attrs[s->members] = attr;
1037 s->members++;
1039 return 0;
1042 static int add_many_to_attr_set(struct attribute_set *s,
1043 struct attribute **attr,
1044 unsigned int count)
1046 int i, res;
1048 for (i = 0; i < count; i++) {
1049 res = add_to_attr_set(s, attr[i]);
1050 if (res)
1051 return res;
1054 return 0;
1057 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1059 sysfs_remove_group(kobj, &s->group);
1060 destroy_attr_set(s);
1063 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1064 sysfs_create_group(_kobj, &_attr_set->group)
1066 static int parse_strtoul(const char *buf,
1067 unsigned long max, unsigned long *value)
1069 char *endp;
1071 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1072 endp = skip_spaces(endp);
1073 if (*endp || *value > max)
1074 return -EINVAL;
1076 return 0;
1079 static void tpacpi_disable_brightness_delay(void)
1081 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1082 printk(TPACPI_NOTICE
1083 "ACPI backlight control delay disabled\n");
1086 static void printk_deprecated_attribute(const char * const what,
1087 const char * const details)
1089 tpacpi_log_usertask("deprecated sysfs attribute");
1090 printk(TPACPI_WARN "WARNING: sysfs attribute %s is deprecated and "
1091 "will be removed. %s\n",
1092 what, details);
1095 /*************************************************************************
1096 * rfkill and radio control support helpers
1100 * ThinkPad-ACPI firmware handling model:
1102 * WLSW (master wireless switch) is event-driven, and is common to all
1103 * firmware-controlled radios. It cannot be controlled, just monitored,
1104 * as expected. It overrides all radio state in firmware
1106 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1107 * (TODO: verify how WLSW interacts with the returned radio state).
1109 * The only time there are shadow radio state changes, is when
1110 * masked-off hotkeys are used.
1114 * Internal driver API for radio state:
1116 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1117 * bool: true means radio blocked (off)
1119 enum tpacpi_rfkill_state {
1120 TPACPI_RFK_RADIO_OFF = 0,
1121 TPACPI_RFK_RADIO_ON
1124 /* rfkill switches */
1125 enum tpacpi_rfk_id {
1126 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1127 TPACPI_RFK_WWAN_SW_ID,
1128 TPACPI_RFK_UWB_SW_ID,
1129 TPACPI_RFK_SW_MAX
1132 static const char *tpacpi_rfkill_names[] = {
1133 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1134 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1135 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1136 [TPACPI_RFK_SW_MAX] = NULL
1139 /* ThinkPad-ACPI rfkill subdriver */
1140 struct tpacpi_rfk {
1141 struct rfkill *rfkill;
1142 enum tpacpi_rfk_id id;
1143 const struct tpacpi_rfk_ops *ops;
1146 struct tpacpi_rfk_ops {
1147 /* firmware interface */
1148 int (*get_status)(void);
1149 int (*set_status)(const enum tpacpi_rfkill_state);
1152 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1154 /* Query FW and update rfkill sw state for a given rfkill switch */
1155 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1157 int status;
1159 if (!tp_rfk)
1160 return -ENODEV;
1162 status = (tp_rfk->ops->get_status)();
1163 if (status < 0)
1164 return status;
1166 rfkill_set_sw_state(tp_rfk->rfkill,
1167 (status == TPACPI_RFK_RADIO_OFF));
1169 return status;
1172 /* Query FW and update rfkill sw state for all rfkill switches */
1173 static void tpacpi_rfk_update_swstate_all(void)
1175 unsigned int i;
1177 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1178 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1182 * Sync the HW-blocking state of all rfkill switches,
1183 * do notice it causes the rfkill core to schedule uevents
1185 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1187 unsigned int i;
1188 struct tpacpi_rfk *tp_rfk;
1190 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1191 tp_rfk = tpacpi_rfkill_switches[i];
1192 if (tp_rfk) {
1193 if (rfkill_set_hw_state(tp_rfk->rfkill,
1194 blocked)) {
1195 /* ignore -- we track sw block */
1201 /* Call to get the WLSW state from the firmware */
1202 static int hotkey_get_wlsw(void);
1204 /* Call to query WLSW state and update all rfkill switches */
1205 static bool tpacpi_rfk_check_hwblock_state(void)
1207 int res = hotkey_get_wlsw();
1208 int hw_blocked;
1210 /* When unknown or unsupported, we have to assume it is unblocked */
1211 if (res < 0)
1212 return false;
1214 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1215 tpacpi_rfk_update_hwblock_state(hw_blocked);
1217 return hw_blocked;
1220 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1222 struct tpacpi_rfk *tp_rfk = data;
1223 int res;
1225 dbg_printk(TPACPI_DBG_RFKILL,
1226 "request to change radio state to %s\n",
1227 blocked ? "blocked" : "unblocked");
1229 /* try to set radio state */
1230 res = (tp_rfk->ops->set_status)(blocked ?
1231 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1233 /* and update the rfkill core with whatever the FW really did */
1234 tpacpi_rfk_update_swstate(tp_rfk);
1236 return (res < 0) ? res : 0;
1239 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1240 .set_block = tpacpi_rfk_hook_set_block,
1243 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1244 const struct tpacpi_rfk_ops *tp_rfkops,
1245 const enum rfkill_type rfktype,
1246 const char *name,
1247 const bool set_default)
1249 struct tpacpi_rfk *atp_rfk;
1250 int res;
1251 bool sw_state = false;
1252 bool hw_state;
1253 int sw_status;
1255 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1257 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1258 if (atp_rfk)
1259 atp_rfk->rfkill = rfkill_alloc(name,
1260 &tpacpi_pdev->dev,
1261 rfktype,
1262 &tpacpi_rfk_rfkill_ops,
1263 atp_rfk);
1264 if (!atp_rfk || !atp_rfk->rfkill) {
1265 printk(TPACPI_ERR
1266 "failed to allocate memory for rfkill class\n");
1267 kfree(atp_rfk);
1268 return -ENOMEM;
1271 atp_rfk->id = id;
1272 atp_rfk->ops = tp_rfkops;
1274 sw_status = (tp_rfkops->get_status)();
1275 if (sw_status < 0) {
1276 printk(TPACPI_ERR
1277 "failed to read initial state for %s, error %d\n",
1278 name, sw_status);
1279 } else {
1280 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1281 if (set_default) {
1282 /* try to keep the initial state, since we ask the
1283 * firmware to preserve it across S5 in NVRAM */
1284 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1287 hw_state = tpacpi_rfk_check_hwblock_state();
1288 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1290 res = rfkill_register(atp_rfk->rfkill);
1291 if (res < 0) {
1292 printk(TPACPI_ERR
1293 "failed to register %s rfkill switch: %d\n",
1294 name, res);
1295 rfkill_destroy(atp_rfk->rfkill);
1296 kfree(atp_rfk);
1297 return res;
1300 tpacpi_rfkill_switches[id] = atp_rfk;
1302 printk(TPACPI_INFO "rfkill switch %s: radio is %sblocked\n",
1303 name, (sw_state || hw_state) ? "" : "un");
1304 return 0;
1307 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1309 struct tpacpi_rfk *tp_rfk;
1311 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1313 tp_rfk = tpacpi_rfkill_switches[id];
1314 if (tp_rfk) {
1315 rfkill_unregister(tp_rfk->rfkill);
1316 rfkill_destroy(tp_rfk->rfkill);
1317 tpacpi_rfkill_switches[id] = NULL;
1318 kfree(tp_rfk);
1322 static void printk_deprecated_rfkill_attribute(const char * const what)
1324 printk_deprecated_attribute(what,
1325 "Please switch to generic rfkill before year 2010");
1328 /* sysfs <radio> enable ------------------------------------------------ */
1329 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1330 struct device_attribute *attr,
1331 char *buf)
1333 int status;
1335 printk_deprecated_rfkill_attribute(attr->attr.name);
1337 /* This is in the ABI... */
1338 if (tpacpi_rfk_check_hwblock_state()) {
1339 status = TPACPI_RFK_RADIO_OFF;
1340 } else {
1341 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1342 if (status < 0)
1343 return status;
1346 return snprintf(buf, PAGE_SIZE, "%d\n",
1347 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1350 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1351 struct device_attribute *attr,
1352 const char *buf, size_t count)
1354 unsigned long t;
1355 int res;
1357 printk_deprecated_rfkill_attribute(attr->attr.name);
1359 if (parse_strtoul(buf, 1, &t))
1360 return -EINVAL;
1362 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1364 /* This is in the ABI... */
1365 if (tpacpi_rfk_check_hwblock_state() && !!t)
1366 return -EPERM;
1368 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1369 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1370 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1372 return (res < 0) ? res : count;
1375 /* procfs -------------------------------------------------------------- */
1376 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1378 if (id >= TPACPI_RFK_SW_MAX)
1379 seq_printf(m, "status:\t\tnot supported\n");
1380 else {
1381 int status;
1383 /* This is in the ABI... */
1384 if (tpacpi_rfk_check_hwblock_state()) {
1385 status = TPACPI_RFK_RADIO_OFF;
1386 } else {
1387 status = tpacpi_rfk_update_swstate(
1388 tpacpi_rfkill_switches[id]);
1389 if (status < 0)
1390 return status;
1393 seq_printf(m, "status:\t\t%s\n",
1394 (status == TPACPI_RFK_RADIO_ON) ?
1395 "enabled" : "disabled");
1396 seq_printf(m, "commands:\tenable, disable\n");
1399 return 0;
1402 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1404 char *cmd;
1405 int status = -1;
1406 int res = 0;
1408 if (id >= TPACPI_RFK_SW_MAX)
1409 return -ENODEV;
1411 while ((cmd = next_cmd(&buf))) {
1412 if (strlencmp(cmd, "enable") == 0)
1413 status = TPACPI_RFK_RADIO_ON;
1414 else if (strlencmp(cmd, "disable") == 0)
1415 status = TPACPI_RFK_RADIO_OFF;
1416 else
1417 return -EINVAL;
1420 if (status != -1) {
1421 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1422 (status == TPACPI_RFK_RADIO_ON) ?
1423 "enable" : "disable",
1424 tpacpi_rfkill_names[id]);
1425 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1426 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1429 return res;
1432 /*************************************************************************
1433 * thinkpad-acpi driver attributes
1436 /* interface_version --------------------------------------------------- */
1437 static ssize_t tpacpi_driver_interface_version_show(
1438 struct device_driver *drv,
1439 char *buf)
1441 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1444 static DRIVER_ATTR(interface_version, S_IRUGO,
1445 tpacpi_driver_interface_version_show, NULL);
1447 /* debug_level --------------------------------------------------------- */
1448 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1449 char *buf)
1451 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1454 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1455 const char *buf, size_t count)
1457 unsigned long t;
1459 if (parse_strtoul(buf, 0xffff, &t))
1460 return -EINVAL;
1462 dbg_level = t;
1464 return count;
1467 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1468 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1470 /* version ------------------------------------------------------------- */
1471 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1472 char *buf)
1474 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1475 TPACPI_DESC, TPACPI_VERSION);
1478 static DRIVER_ATTR(version, S_IRUGO,
1479 tpacpi_driver_version_show, NULL);
1481 /* --------------------------------------------------------------------- */
1483 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1485 /* wlsw_emulstate ------------------------------------------------------ */
1486 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1487 char *buf)
1489 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1492 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1493 const char *buf, size_t count)
1495 unsigned long t;
1497 if (parse_strtoul(buf, 1, &t))
1498 return -EINVAL;
1500 if (tpacpi_wlsw_emulstate != !!t) {
1501 tpacpi_wlsw_emulstate = !!t;
1502 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1505 return count;
1508 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1509 tpacpi_driver_wlsw_emulstate_show,
1510 tpacpi_driver_wlsw_emulstate_store);
1512 /* bluetooth_emulstate ------------------------------------------------- */
1513 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1514 struct device_driver *drv,
1515 char *buf)
1517 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1520 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1521 struct device_driver *drv,
1522 const char *buf, size_t count)
1524 unsigned long t;
1526 if (parse_strtoul(buf, 1, &t))
1527 return -EINVAL;
1529 tpacpi_bluetooth_emulstate = !!t;
1531 return count;
1534 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1535 tpacpi_driver_bluetooth_emulstate_show,
1536 tpacpi_driver_bluetooth_emulstate_store);
1538 /* wwan_emulstate ------------------------------------------------- */
1539 static ssize_t tpacpi_driver_wwan_emulstate_show(
1540 struct device_driver *drv,
1541 char *buf)
1543 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1546 static ssize_t tpacpi_driver_wwan_emulstate_store(
1547 struct device_driver *drv,
1548 const char *buf, size_t count)
1550 unsigned long t;
1552 if (parse_strtoul(buf, 1, &t))
1553 return -EINVAL;
1555 tpacpi_wwan_emulstate = !!t;
1557 return count;
1560 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1561 tpacpi_driver_wwan_emulstate_show,
1562 tpacpi_driver_wwan_emulstate_store);
1564 /* uwb_emulstate ------------------------------------------------- */
1565 static ssize_t tpacpi_driver_uwb_emulstate_show(
1566 struct device_driver *drv,
1567 char *buf)
1569 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1572 static ssize_t tpacpi_driver_uwb_emulstate_store(
1573 struct device_driver *drv,
1574 const char *buf, size_t count)
1576 unsigned long t;
1578 if (parse_strtoul(buf, 1, &t))
1579 return -EINVAL;
1581 tpacpi_uwb_emulstate = !!t;
1583 return count;
1586 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1587 tpacpi_driver_uwb_emulstate_show,
1588 tpacpi_driver_uwb_emulstate_store);
1589 #endif
1591 /* --------------------------------------------------------------------- */
1593 static struct driver_attribute *tpacpi_driver_attributes[] = {
1594 &driver_attr_debug_level, &driver_attr_version,
1595 &driver_attr_interface_version,
1598 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1600 int i, res;
1602 i = 0;
1603 res = 0;
1604 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1605 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1606 i++;
1609 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1610 if (!res && dbg_wlswemul)
1611 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1612 if (!res && dbg_bluetoothemul)
1613 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1614 if (!res && dbg_wwanemul)
1615 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1616 if (!res && dbg_uwbemul)
1617 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1618 #endif
1620 return res;
1623 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1625 int i;
1627 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1628 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1630 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1631 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1632 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1633 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1634 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1635 #endif
1638 /*************************************************************************
1639 * Firmware Data
1643 * Table of recommended minimum BIOS versions
1645 * Reasons for listing:
1646 * 1. Stable BIOS, listed because the unknown amount of
1647 * bugs and bad ACPI behaviour on older versions
1649 * 2. BIOS or EC fw with known bugs that trigger on Linux
1651 * 3. BIOS with known reduced functionality in older versions
1653 * We recommend the latest BIOS and EC version.
1654 * We only support the latest BIOS and EC fw version as a rule.
1656 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1657 * Information from users in ThinkWiki
1659 * WARNING: we use this table also to detect that the machine is
1660 * a ThinkPad in some cases, so don't remove entries lightly.
1663 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1664 { .vendor = (__v), \
1665 .bios = TPID(__id1, __id2), \
1666 .ec = TPACPI_MATCH_ANY, \
1667 .quirks = TPACPI_MATCH_ANY << 16 \
1668 | (__bv1) << 8 | (__bv2) }
1670 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1671 __eid, __ev1, __ev2) \
1672 { .vendor = (__v), \
1673 .bios = TPID(__bid1, __bid2), \
1674 .ec = __eid, \
1675 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1676 | (__bv1) << 8 | (__bv2) }
1678 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1679 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1681 /* Outdated IBM BIOSes often lack the EC id string */
1682 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1683 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1684 __bv1, __bv2, TPID(__id1, __id2), \
1685 __ev1, __ev2), \
1686 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1687 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1688 __ev1, __ev2)
1690 /* Outdated IBM BIOSes often lack the EC id string */
1691 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1692 __eid1, __eid2, __ev1, __ev2) \
1693 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1694 __bv1, __bv2, TPID(__eid1, __eid2), \
1695 __ev1, __ev2), \
1696 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1697 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1698 __ev1, __ev2)
1700 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1701 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1703 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1704 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1705 __bv1, __bv2, TPID(__id1, __id2), \
1706 __ev1, __ev2)
1708 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1709 __eid1, __eid2, __ev1, __ev2) \
1710 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1711 __bv1, __bv2, TPID(__eid1, __eid2), \
1712 __ev1, __ev2)
1714 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1715 /* Numeric models ------------------ */
1716 /* FW MODEL BIOS VERS */
1717 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1718 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1719 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1720 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1721 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1722 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1723 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1724 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1725 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1727 /* A-series ------------------------- */
1728 /* FW MODEL BIOS VERS EC VERS */
1729 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1730 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1731 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1732 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1733 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1734 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1735 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1736 TPV_QI0('1', '3', '2', '0'), /* A22m */
1737 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1738 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1739 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1741 /* G-series ------------------------- */
1742 /* FW MODEL BIOS VERS */
1743 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1744 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1746 /* R-series, T-series --------------- */
1747 /* FW MODEL BIOS VERS EC VERS */
1748 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1749 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1750 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1751 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1752 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1753 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1754 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1755 T40/p, T41/p, T42/p (1) */
1756 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1757 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1758 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1759 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1761 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1762 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1763 TPV_QI0('1', '6', '3', '2'), /* T22 */
1764 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1765 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1766 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1768 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1769 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1770 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1772 /* BIOS FW BIOS VERS EC FW EC VERS */
1773 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1774 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1776 /* X-series ------------------------- */
1777 /* FW MODEL BIOS VERS EC VERS */
1778 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1779 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1780 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1781 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1782 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1783 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1784 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1786 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1787 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1789 /* (0) - older versions lack DMI EC fw string and functionality */
1790 /* (1) - older versions known to lack functionality */
1793 #undef TPV_QL1
1794 #undef TPV_QL0
1795 #undef TPV_QI2
1796 #undef TPV_QI1
1797 #undef TPV_QI0
1798 #undef TPV_Q_X
1799 #undef TPV_Q
1801 static void __init tpacpi_check_outdated_fw(void)
1803 unsigned long fwvers;
1804 u16 ec_version, bios_version;
1806 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1807 ARRAY_SIZE(tpacpi_bios_version_qtable));
1809 if (!fwvers)
1810 return;
1812 bios_version = fwvers & 0xffffU;
1813 ec_version = (fwvers >> 16) & 0xffffU;
1815 /* note that unknown versions are set to 0x0000 and we use that */
1816 if ((bios_version > thinkpad_id.bios_release) ||
1817 (ec_version > thinkpad_id.ec_release &&
1818 ec_version != TPACPI_MATCH_ANY)) {
1820 * The changelogs would let us track down the exact
1821 * reason, but it is just too much of a pain to track
1822 * it. We only list BIOSes that are either really
1823 * broken, or really stable to begin with, so it is
1824 * best if the user upgrades the firmware anyway.
1826 printk(TPACPI_WARN
1827 "WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1828 printk(TPACPI_WARN
1829 "WARNING: This firmware may be missing critical bug "
1830 "fixes and/or important features\n");
1834 static bool __init tpacpi_is_fw_known(void)
1836 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1837 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1840 /****************************************************************************
1841 ****************************************************************************
1843 * Subdrivers
1845 ****************************************************************************
1846 ****************************************************************************/
1848 /*************************************************************************
1849 * thinkpad-acpi metadata subdriver
1852 static int thinkpad_acpi_driver_read(struct seq_file *m)
1854 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1855 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1856 return 0;
1859 static struct ibm_struct thinkpad_acpi_driver_data = {
1860 .name = "driver",
1861 .read = thinkpad_acpi_driver_read,
1864 /*************************************************************************
1865 * Hotkey subdriver
1869 * ThinkPad firmware event model
1871 * The ThinkPad firmware has two main event interfaces: normal ACPI
1872 * notifications (which follow the ACPI standard), and a private event
1873 * interface.
1875 * The private event interface also issues events for the hotkeys. As
1876 * the driver gained features, the event handling code ended up being
1877 * built around the hotkey subdriver. This will need to be refactored
1878 * to a more formal event API eventually.
1880 * Some "hotkeys" are actually supposed to be used as event reports,
1881 * such as "brightness has changed", "volume has changed", depending on
1882 * the ThinkPad model and how the firmware is operating.
1884 * Unlike other classes, hotkey-class events have mask/unmask control on
1885 * non-ancient firmware. However, how it behaves changes a lot with the
1886 * firmware model and version.
1889 enum { /* hot key scan codes (derived from ACPI DSDT) */
1890 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1891 TP_ACPI_HOTKEYSCAN_FNF2,
1892 TP_ACPI_HOTKEYSCAN_FNF3,
1893 TP_ACPI_HOTKEYSCAN_FNF4,
1894 TP_ACPI_HOTKEYSCAN_FNF5,
1895 TP_ACPI_HOTKEYSCAN_FNF6,
1896 TP_ACPI_HOTKEYSCAN_FNF7,
1897 TP_ACPI_HOTKEYSCAN_FNF8,
1898 TP_ACPI_HOTKEYSCAN_FNF9,
1899 TP_ACPI_HOTKEYSCAN_FNF10,
1900 TP_ACPI_HOTKEYSCAN_FNF11,
1901 TP_ACPI_HOTKEYSCAN_FNF12,
1902 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1903 TP_ACPI_HOTKEYSCAN_FNINSERT,
1904 TP_ACPI_HOTKEYSCAN_FNDELETE,
1905 TP_ACPI_HOTKEYSCAN_FNHOME,
1906 TP_ACPI_HOTKEYSCAN_FNEND,
1907 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1908 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1909 TP_ACPI_HOTKEYSCAN_FNSPACE,
1910 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1911 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1912 TP_ACPI_HOTKEYSCAN_MUTE,
1913 TP_ACPI_HOTKEYSCAN_THINKPAD,
1914 TP_ACPI_HOTKEYSCAN_UNK1,
1915 TP_ACPI_HOTKEYSCAN_UNK2,
1916 TP_ACPI_HOTKEYSCAN_UNK3,
1917 TP_ACPI_HOTKEYSCAN_UNK4,
1918 TP_ACPI_HOTKEYSCAN_UNK5,
1919 TP_ACPI_HOTKEYSCAN_UNK6,
1920 TP_ACPI_HOTKEYSCAN_UNK7,
1921 TP_ACPI_HOTKEYSCAN_UNK8,
1923 /* Hotkey keymap size */
1924 TPACPI_HOTKEY_MAP_LEN
1927 enum { /* Keys/events available through NVRAM polling */
1928 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1929 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1932 enum { /* Positions of some of the keys in hotkey masks */
1933 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1934 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1935 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1936 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1937 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1938 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1939 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1940 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1941 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1942 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1943 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1946 enum { /* NVRAM to ACPI HKEY group map */
1947 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1948 TP_ACPI_HKEY_ZOOM_MASK |
1949 TP_ACPI_HKEY_DISPSWTCH_MASK |
1950 TP_ACPI_HKEY_HIBERNATE_MASK,
1951 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1952 TP_ACPI_HKEY_BRGHTDWN_MASK,
1953 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1954 TP_ACPI_HKEY_VOLDWN_MASK |
1955 TP_ACPI_HKEY_MUTE_MASK,
1958 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1959 struct tp_nvram_state {
1960 u16 thinkpad_toggle:1;
1961 u16 zoom_toggle:1;
1962 u16 display_toggle:1;
1963 u16 thinklight_toggle:1;
1964 u16 hibernate_toggle:1;
1965 u16 displayexp_toggle:1;
1966 u16 display_state:1;
1967 u16 brightness_toggle:1;
1968 u16 volume_toggle:1;
1969 u16 mute:1;
1971 u8 brightness_level;
1972 u8 volume_level;
1975 /* kthread for the hotkey poller */
1976 static struct task_struct *tpacpi_hotkey_task;
1978 /* Acquired while the poller kthread is running, use to sync start/stop */
1979 static struct mutex hotkey_thread_mutex;
1982 * Acquire mutex to write poller control variables as an
1983 * atomic block.
1985 * Increment hotkey_config_change when changing them if you
1986 * want the kthread to forget old state.
1988 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1990 static struct mutex hotkey_thread_data_mutex;
1991 static unsigned int hotkey_config_change;
1994 * hotkey poller control variables
1996 * Must be atomic or readers will also need to acquire mutex
1998 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1999 * should be used only when the changes need to be taken as
2000 * a block, OR when one needs to force the kthread to forget
2001 * old state.
2003 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2004 static unsigned int hotkey_poll_freq = 10; /* Hz */
2006 #define HOTKEY_CONFIG_CRITICAL_START \
2007 do { \
2008 mutex_lock(&hotkey_thread_data_mutex); \
2009 hotkey_config_change++; \
2010 } while (0);
2011 #define HOTKEY_CONFIG_CRITICAL_END \
2012 mutex_unlock(&hotkey_thread_data_mutex);
2014 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2016 #define hotkey_source_mask 0U
2017 #define HOTKEY_CONFIG_CRITICAL_START
2018 #define HOTKEY_CONFIG_CRITICAL_END
2020 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2022 static struct mutex hotkey_mutex;
2024 static enum { /* Reasons for waking up */
2025 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2026 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2027 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2028 } hotkey_wakeup_reason;
2030 static int hotkey_autosleep_ack;
2032 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2033 static u32 hotkey_all_mask; /* all events supported in fw */
2034 static u32 hotkey_reserved_mask; /* events better left disabled */
2035 static u32 hotkey_driver_mask; /* events needed by the driver */
2036 static u32 hotkey_user_mask; /* events visible to userspace */
2037 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2039 static unsigned int hotkey_report_mode;
2041 static u16 *hotkey_keycode_map;
2043 static struct attribute_set *hotkey_dev_attributes;
2045 static void tpacpi_driver_event(const unsigned int hkey_event);
2046 static void hotkey_driver_event(const unsigned int scancode);
2047 static void hotkey_poll_setup(const bool may_warn);
2049 /* HKEY.MHKG() return bits */
2050 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2052 static int hotkey_get_wlsw(void)
2054 int status;
2056 if (!tp_features.hotkey_wlsw)
2057 return -ENODEV;
2059 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2060 if (dbg_wlswemul)
2061 return (tpacpi_wlsw_emulstate) ?
2062 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2063 #endif
2065 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2066 return -EIO;
2068 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2071 static int hotkey_get_tablet_mode(int *status)
2073 int s;
2075 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2076 return -EIO;
2078 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2079 return 0;
2083 * Reads current event mask from firmware, and updates
2084 * hotkey_acpi_mask accordingly. Also resets any bits
2085 * from hotkey_user_mask that are unavailable to be
2086 * delivered (shadow requirement of the userspace ABI).
2088 * Call with hotkey_mutex held
2090 static int hotkey_mask_get(void)
2092 if (tp_features.hotkey_mask) {
2093 u32 m = 0;
2095 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2096 return -EIO;
2098 hotkey_acpi_mask = m;
2099 } else {
2100 /* no mask support doesn't mean no event support... */
2101 hotkey_acpi_mask = hotkey_all_mask;
2104 /* sync userspace-visible mask */
2105 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2107 return 0;
2110 void static hotkey_mask_warn_incomplete_mask(void)
2112 /* log only what the user can fix... */
2113 const u32 wantedmask = hotkey_driver_mask &
2114 ~(hotkey_acpi_mask | hotkey_source_mask) &
2115 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2117 if (wantedmask)
2118 printk(TPACPI_NOTICE
2119 "required events 0x%08x not enabled!\n",
2120 wantedmask);
2124 * Set the firmware mask when supported
2126 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2128 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2130 * Call with hotkey_mutex held
2132 static int hotkey_mask_set(u32 mask)
2134 int i;
2135 int rc = 0;
2137 const u32 fwmask = mask & ~hotkey_source_mask;
2139 if (tp_features.hotkey_mask) {
2140 for (i = 0; i < 32; i++) {
2141 if (!acpi_evalf(hkey_handle,
2142 NULL, "MHKM", "vdd", i + 1,
2143 !!(mask & (1 << i)))) {
2144 rc = -EIO;
2145 break;
2151 * We *must* make an inconditional call to hotkey_mask_get to
2152 * refresh hotkey_acpi_mask and update hotkey_user_mask
2154 * Take the opportunity to also log when we cannot _enable_
2155 * a given event.
2157 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2158 printk(TPACPI_NOTICE
2159 "asked for hotkey mask 0x%08x, but "
2160 "firmware forced it to 0x%08x\n",
2161 fwmask, hotkey_acpi_mask);
2164 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2165 hotkey_mask_warn_incomplete_mask();
2167 return rc;
2171 * Sets hotkey_user_mask and tries to set the firmware mask
2173 * Call with hotkey_mutex held
2175 static int hotkey_user_mask_set(const u32 mask)
2177 int rc;
2179 /* Give people a chance to notice they are doing something that
2180 * is bound to go boom on their users sooner or later */
2181 if (!tp_warned.hotkey_mask_ff &&
2182 (mask == 0xffff || mask == 0xffffff ||
2183 mask == 0xffffffff)) {
2184 tp_warned.hotkey_mask_ff = 1;
2185 printk(TPACPI_NOTICE
2186 "setting the hotkey mask to 0x%08x is likely "
2187 "not the best way to go about it\n", mask);
2188 printk(TPACPI_NOTICE
2189 "please consider using the driver defaults, "
2190 "and refer to up-to-date thinkpad-acpi "
2191 "documentation\n");
2194 /* Try to enable what the user asked for, plus whatever we need.
2195 * this syncs everything but won't enable bits in hotkey_user_mask */
2196 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2198 /* Enable the available bits in hotkey_user_mask */
2199 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2201 return rc;
2205 * Sets the driver hotkey mask.
2207 * Can be called even if the hotkey subdriver is inactive
2209 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2211 int rc;
2213 /* Do the right thing if hotkey_init has not been called yet */
2214 if (!tp_features.hotkey) {
2215 hotkey_driver_mask = mask;
2216 return 0;
2219 mutex_lock(&hotkey_mutex);
2221 HOTKEY_CONFIG_CRITICAL_START
2222 hotkey_driver_mask = mask;
2223 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2224 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2225 #endif
2226 HOTKEY_CONFIG_CRITICAL_END
2228 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2229 ~hotkey_source_mask);
2230 hotkey_poll_setup(true);
2232 mutex_unlock(&hotkey_mutex);
2234 return rc;
2237 static int hotkey_status_get(int *status)
2239 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2240 return -EIO;
2242 return 0;
2245 static int hotkey_status_set(bool enable)
2247 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2248 return -EIO;
2250 return 0;
2253 static void tpacpi_input_send_tabletsw(void)
2255 int state;
2257 if (tp_features.hotkey_tablet &&
2258 !hotkey_get_tablet_mode(&state)) {
2259 mutex_lock(&tpacpi_inputdev_send_mutex);
2261 input_report_switch(tpacpi_inputdev,
2262 SW_TABLET_MODE, !!state);
2263 input_sync(tpacpi_inputdev);
2265 mutex_unlock(&tpacpi_inputdev_send_mutex);
2269 /* Do NOT call without validating scancode first */
2270 static void tpacpi_input_send_key(const unsigned int scancode)
2272 const unsigned int keycode = hotkey_keycode_map[scancode];
2274 if (keycode != KEY_RESERVED) {
2275 mutex_lock(&tpacpi_inputdev_send_mutex);
2277 input_report_key(tpacpi_inputdev, keycode, 1);
2278 if (keycode == KEY_UNKNOWN)
2279 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2280 scancode);
2281 input_sync(tpacpi_inputdev);
2283 input_report_key(tpacpi_inputdev, keycode, 0);
2284 if (keycode == KEY_UNKNOWN)
2285 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2286 scancode);
2287 input_sync(tpacpi_inputdev);
2289 mutex_unlock(&tpacpi_inputdev_send_mutex);
2293 /* Do NOT call without validating scancode first */
2294 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2296 hotkey_driver_event(scancode);
2297 if (hotkey_user_mask & (1 << scancode))
2298 tpacpi_input_send_key(scancode);
2301 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2302 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2304 /* Do NOT call without validating scancode first */
2305 static void tpacpi_hotkey_send_key(unsigned int scancode)
2307 tpacpi_input_send_key_masked(scancode);
2308 if (hotkey_report_mode < 2) {
2309 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2310 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2314 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2316 u8 d;
2318 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2319 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2320 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2321 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2322 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2323 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2325 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2326 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2327 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2329 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2330 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2331 n->displayexp_toggle =
2332 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2334 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2335 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2336 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2337 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2338 n->brightness_toggle =
2339 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2341 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2342 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2343 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2344 >> TP_NVRAM_POS_LEVEL_VOLUME;
2345 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2346 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2350 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2351 struct tp_nvram_state *newn,
2352 const u32 event_mask)
2355 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2356 do { \
2357 if ((event_mask & (1 << __scancode)) && \
2358 oldn->__member != newn->__member) \
2359 tpacpi_hotkey_send_key(__scancode); \
2360 } while (0)
2362 #define TPACPI_MAY_SEND_KEY(__scancode) \
2363 do { \
2364 if (event_mask & (1 << __scancode)) \
2365 tpacpi_hotkey_send_key(__scancode); \
2366 } while (0)
2368 void issue_volchange(const unsigned int oldvol,
2369 const unsigned int newvol)
2371 unsigned int i = oldvol;
2373 while (i > newvol) {
2374 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2375 i--;
2377 while (i < newvol) {
2378 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2379 i++;
2383 void issue_brightnesschange(const unsigned int oldbrt,
2384 const unsigned int newbrt)
2386 unsigned int i = oldbrt;
2388 while (i > newbrt) {
2389 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2390 i--;
2392 while (i < newbrt) {
2393 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2394 i++;
2398 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2399 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2400 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2401 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2403 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2405 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2408 * Handle volume
2410 * This code is supposed to duplicate the IBM firmware behaviour:
2411 * - Pressing MUTE issues mute hotkey message, even when already mute
2412 * - Pressing Volume up/down issues volume up/down hotkey messages,
2413 * even when already at maximum or minumum volume
2414 * - The act of unmuting issues volume up/down notification,
2415 * depending which key was used to unmute
2417 * We are constrained to what the NVRAM can tell us, which is not much
2418 * and certainly not enough if more than one volume hotkey was pressed
2419 * since the last poll cycle.
2421 * Just to make our life interesting, some newer Lenovo ThinkPads have
2422 * bugs in the BIOS and may fail to update volume_toggle properly.
2424 if (newn->mute) {
2425 /* muted */
2426 if (!oldn->mute ||
2427 oldn->volume_toggle != newn->volume_toggle ||
2428 oldn->volume_level != newn->volume_level) {
2429 /* recently muted, or repeated mute keypress, or
2430 * multiple presses ending in mute */
2431 issue_volchange(oldn->volume_level, newn->volume_level);
2432 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2434 } else {
2435 /* unmute */
2436 if (oldn->mute) {
2437 /* recently unmuted, issue 'unmute' keypress */
2438 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2440 if (oldn->volume_level != newn->volume_level) {
2441 issue_volchange(oldn->volume_level, newn->volume_level);
2442 } else if (oldn->volume_toggle != newn->volume_toggle) {
2443 /* repeated vol up/down keypress at end of scale ? */
2444 if (newn->volume_level == 0)
2445 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2446 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2447 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2451 /* handle brightness */
2452 if (oldn->brightness_level != newn->brightness_level) {
2453 issue_brightnesschange(oldn->brightness_level,
2454 newn->brightness_level);
2455 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2456 /* repeated key presses that didn't change state */
2457 if (newn->brightness_level == 0)
2458 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2459 else if (newn->brightness_level >= bright_maxlvl
2460 && !tp_features.bright_unkfw)
2461 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2464 #undef TPACPI_COMPARE_KEY
2465 #undef TPACPI_MAY_SEND_KEY
2469 * Polling driver
2471 * We track all events in hotkey_source_mask all the time, since
2472 * most of them are edge-based. We only issue those requested by
2473 * hotkey_user_mask or hotkey_driver_mask, though.
2475 static int hotkey_kthread(void *data)
2477 struct tp_nvram_state s[2];
2478 u32 poll_mask, event_mask;
2479 unsigned int si, so;
2480 unsigned long t;
2481 unsigned int change_detector, must_reset;
2482 unsigned int poll_freq;
2484 mutex_lock(&hotkey_thread_mutex);
2486 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2487 goto exit;
2489 set_freezable();
2491 so = 0;
2492 si = 1;
2493 t = 0;
2495 /* Initial state for compares */
2496 mutex_lock(&hotkey_thread_data_mutex);
2497 change_detector = hotkey_config_change;
2498 poll_mask = hotkey_source_mask;
2499 event_mask = hotkey_source_mask &
2500 (hotkey_driver_mask | hotkey_user_mask);
2501 poll_freq = hotkey_poll_freq;
2502 mutex_unlock(&hotkey_thread_data_mutex);
2503 hotkey_read_nvram(&s[so], poll_mask);
2505 while (!kthread_should_stop()) {
2506 if (t == 0) {
2507 if (likely(poll_freq))
2508 t = 1000/poll_freq;
2509 else
2510 t = 100; /* should never happen... */
2512 t = msleep_interruptible(t);
2513 if (unlikely(kthread_should_stop()))
2514 break;
2515 must_reset = try_to_freeze();
2516 if (t > 0 && !must_reset)
2517 continue;
2519 mutex_lock(&hotkey_thread_data_mutex);
2520 if (must_reset || hotkey_config_change != change_detector) {
2521 /* forget old state on thaw or config change */
2522 si = so;
2523 t = 0;
2524 change_detector = hotkey_config_change;
2526 poll_mask = hotkey_source_mask;
2527 event_mask = hotkey_source_mask &
2528 (hotkey_driver_mask | hotkey_user_mask);
2529 poll_freq = hotkey_poll_freq;
2530 mutex_unlock(&hotkey_thread_data_mutex);
2532 if (likely(poll_mask)) {
2533 hotkey_read_nvram(&s[si], poll_mask);
2534 if (likely(si != so)) {
2535 hotkey_compare_and_issue_event(&s[so], &s[si],
2536 event_mask);
2540 so = si;
2541 si ^= 1;
2544 exit:
2545 mutex_unlock(&hotkey_thread_mutex);
2546 return 0;
2549 /* call with hotkey_mutex held */
2550 static void hotkey_poll_stop_sync(void)
2552 if (tpacpi_hotkey_task) {
2553 if (frozen(tpacpi_hotkey_task) ||
2554 freezing(tpacpi_hotkey_task))
2555 thaw_process(tpacpi_hotkey_task);
2557 kthread_stop(tpacpi_hotkey_task);
2558 tpacpi_hotkey_task = NULL;
2559 mutex_lock(&hotkey_thread_mutex);
2560 /* at this point, the thread did exit */
2561 mutex_unlock(&hotkey_thread_mutex);
2565 /* call with hotkey_mutex held */
2566 static void hotkey_poll_setup(const bool may_warn)
2568 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2569 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2571 if (hotkey_poll_freq > 0 &&
2572 (poll_driver_mask ||
2573 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2574 if (!tpacpi_hotkey_task) {
2575 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2576 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2577 if (IS_ERR(tpacpi_hotkey_task)) {
2578 tpacpi_hotkey_task = NULL;
2579 printk(TPACPI_ERR
2580 "could not create kernel thread "
2581 "for hotkey polling\n");
2584 } else {
2585 hotkey_poll_stop_sync();
2586 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2587 hotkey_poll_freq == 0) {
2588 printk(TPACPI_NOTICE
2589 "hot keys 0x%08x and/or events 0x%08x "
2590 "require polling, which is currently "
2591 "disabled\n",
2592 poll_user_mask, poll_driver_mask);
2597 static void hotkey_poll_setup_safe(const bool may_warn)
2599 mutex_lock(&hotkey_mutex);
2600 hotkey_poll_setup(may_warn);
2601 mutex_unlock(&hotkey_mutex);
2604 /* call with hotkey_mutex held */
2605 static void hotkey_poll_set_freq(unsigned int freq)
2607 if (!freq)
2608 hotkey_poll_stop_sync();
2610 hotkey_poll_freq = freq;
2613 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2615 static void hotkey_poll_setup(const bool __unused)
2619 static void hotkey_poll_setup_safe(const bool __unused)
2623 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2625 static int hotkey_inputdev_open(struct input_dev *dev)
2627 switch (tpacpi_lifecycle) {
2628 case TPACPI_LIFE_INIT:
2629 case TPACPI_LIFE_RUNNING:
2630 hotkey_poll_setup_safe(false);
2631 return 0;
2632 case TPACPI_LIFE_EXITING:
2633 return -EBUSY;
2636 /* Should only happen if tpacpi_lifecycle is corrupt */
2637 BUG();
2638 return -EBUSY;
2641 static void hotkey_inputdev_close(struct input_dev *dev)
2643 /* disable hotkey polling when possible */
2644 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2645 !(hotkey_source_mask & hotkey_driver_mask))
2646 hotkey_poll_setup_safe(false);
2649 /* sysfs hotkey enable ------------------------------------------------- */
2650 static ssize_t hotkey_enable_show(struct device *dev,
2651 struct device_attribute *attr,
2652 char *buf)
2654 int res, status;
2656 printk_deprecated_attribute("hotkey_enable",
2657 "Hotkey reporting is always enabled");
2659 res = hotkey_status_get(&status);
2660 if (res)
2661 return res;
2663 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2666 static ssize_t hotkey_enable_store(struct device *dev,
2667 struct device_attribute *attr,
2668 const char *buf, size_t count)
2670 unsigned long t;
2672 printk_deprecated_attribute("hotkey_enable",
2673 "Hotkeys can be disabled through hotkey_mask");
2675 if (parse_strtoul(buf, 1, &t))
2676 return -EINVAL;
2678 if (t == 0)
2679 return -EPERM;
2681 return count;
2684 static struct device_attribute dev_attr_hotkey_enable =
2685 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2686 hotkey_enable_show, hotkey_enable_store);
2688 /* sysfs hotkey mask --------------------------------------------------- */
2689 static ssize_t hotkey_mask_show(struct device *dev,
2690 struct device_attribute *attr,
2691 char *buf)
2693 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2696 static ssize_t hotkey_mask_store(struct device *dev,
2697 struct device_attribute *attr,
2698 const char *buf, size_t count)
2700 unsigned long t;
2701 int res;
2703 if (parse_strtoul(buf, 0xffffffffUL, &t))
2704 return -EINVAL;
2706 if (mutex_lock_killable(&hotkey_mutex))
2707 return -ERESTARTSYS;
2709 res = hotkey_user_mask_set(t);
2711 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2712 hotkey_poll_setup(true);
2713 #endif
2715 mutex_unlock(&hotkey_mutex);
2717 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2719 return (res) ? res : count;
2722 static struct device_attribute dev_attr_hotkey_mask =
2723 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2724 hotkey_mask_show, hotkey_mask_store);
2726 /* sysfs hotkey bios_enabled ------------------------------------------- */
2727 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2728 struct device_attribute *attr,
2729 char *buf)
2731 return sprintf(buf, "0\n");
2734 static struct device_attribute dev_attr_hotkey_bios_enabled =
2735 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2737 /* sysfs hotkey bios_mask ---------------------------------------------- */
2738 static ssize_t hotkey_bios_mask_show(struct device *dev,
2739 struct device_attribute *attr,
2740 char *buf)
2742 printk_deprecated_attribute("hotkey_bios_mask",
2743 "This attribute is useless.");
2744 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2747 static struct device_attribute dev_attr_hotkey_bios_mask =
2748 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2750 /* sysfs hotkey all_mask ----------------------------------------------- */
2751 static ssize_t hotkey_all_mask_show(struct device *dev,
2752 struct device_attribute *attr,
2753 char *buf)
2755 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2756 hotkey_all_mask | hotkey_source_mask);
2759 static struct device_attribute dev_attr_hotkey_all_mask =
2760 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2762 /* sysfs hotkey recommended_mask --------------------------------------- */
2763 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2764 struct device_attribute *attr,
2765 char *buf)
2767 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2768 (hotkey_all_mask | hotkey_source_mask)
2769 & ~hotkey_reserved_mask);
2772 static struct device_attribute dev_attr_hotkey_recommended_mask =
2773 __ATTR(hotkey_recommended_mask, S_IRUGO,
2774 hotkey_recommended_mask_show, NULL);
2776 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2778 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2779 static ssize_t hotkey_source_mask_show(struct device *dev,
2780 struct device_attribute *attr,
2781 char *buf)
2783 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2786 static ssize_t hotkey_source_mask_store(struct device *dev,
2787 struct device_attribute *attr,
2788 const char *buf, size_t count)
2790 unsigned long t;
2791 u32 r_ev;
2792 int rc;
2794 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2795 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2796 return -EINVAL;
2798 if (mutex_lock_killable(&hotkey_mutex))
2799 return -ERESTARTSYS;
2801 HOTKEY_CONFIG_CRITICAL_START
2802 hotkey_source_mask = t;
2803 HOTKEY_CONFIG_CRITICAL_END
2805 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2806 ~hotkey_source_mask);
2807 hotkey_poll_setup(true);
2809 /* check if events needed by the driver got disabled */
2810 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2811 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2813 mutex_unlock(&hotkey_mutex);
2815 if (rc < 0)
2816 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2817 "firmware event mask!\n");
2819 if (r_ev)
2820 printk(TPACPI_NOTICE "hotkey_source_mask: "
2821 "some important events were disabled: "
2822 "0x%04x\n", r_ev);
2824 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2826 return (rc < 0) ? rc : count;
2829 static struct device_attribute dev_attr_hotkey_source_mask =
2830 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2831 hotkey_source_mask_show, hotkey_source_mask_store);
2833 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2834 static ssize_t hotkey_poll_freq_show(struct device *dev,
2835 struct device_attribute *attr,
2836 char *buf)
2838 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2841 static ssize_t hotkey_poll_freq_store(struct device *dev,
2842 struct device_attribute *attr,
2843 const char *buf, size_t count)
2845 unsigned long t;
2847 if (parse_strtoul(buf, 25, &t))
2848 return -EINVAL;
2850 if (mutex_lock_killable(&hotkey_mutex))
2851 return -ERESTARTSYS;
2853 hotkey_poll_set_freq(t);
2854 hotkey_poll_setup(true);
2856 mutex_unlock(&hotkey_mutex);
2858 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2860 return count;
2863 static struct device_attribute dev_attr_hotkey_poll_freq =
2864 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2865 hotkey_poll_freq_show, hotkey_poll_freq_store);
2867 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2869 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2870 static ssize_t hotkey_radio_sw_show(struct device *dev,
2871 struct device_attribute *attr,
2872 char *buf)
2874 int res;
2875 res = hotkey_get_wlsw();
2876 if (res < 0)
2877 return res;
2879 /* Opportunistic update */
2880 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2882 return snprintf(buf, PAGE_SIZE, "%d\n",
2883 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2886 static struct device_attribute dev_attr_hotkey_radio_sw =
2887 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2889 static void hotkey_radio_sw_notify_change(void)
2891 if (tp_features.hotkey_wlsw)
2892 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2893 "hotkey_radio_sw");
2896 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2897 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2898 struct device_attribute *attr,
2899 char *buf)
2901 int res, s;
2902 res = hotkey_get_tablet_mode(&s);
2903 if (res < 0)
2904 return res;
2906 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2909 static struct device_attribute dev_attr_hotkey_tablet_mode =
2910 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2912 static void hotkey_tablet_mode_notify_change(void)
2914 if (tp_features.hotkey_tablet)
2915 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2916 "hotkey_tablet_mode");
2919 /* sysfs hotkey report_mode -------------------------------------------- */
2920 static ssize_t hotkey_report_mode_show(struct device *dev,
2921 struct device_attribute *attr,
2922 char *buf)
2924 return snprintf(buf, PAGE_SIZE, "%d\n",
2925 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2928 static struct device_attribute dev_attr_hotkey_report_mode =
2929 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2931 /* sysfs wakeup reason (pollable) -------------------------------------- */
2932 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2933 struct device_attribute *attr,
2934 char *buf)
2936 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2939 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2940 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2942 static void hotkey_wakeup_reason_notify_change(void)
2944 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2945 "wakeup_reason");
2948 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2949 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2950 struct device_attribute *attr,
2951 char *buf)
2953 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2956 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2957 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2958 hotkey_wakeup_hotunplug_complete_show, NULL);
2960 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2962 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2963 "wakeup_hotunplug_complete");
2966 /* --------------------------------------------------------------------- */
2968 static struct attribute *hotkey_attributes[] __initdata = {
2969 &dev_attr_hotkey_enable.attr,
2970 &dev_attr_hotkey_bios_enabled.attr,
2971 &dev_attr_hotkey_bios_mask.attr,
2972 &dev_attr_hotkey_report_mode.attr,
2973 &dev_attr_hotkey_wakeup_reason.attr,
2974 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2975 &dev_attr_hotkey_mask.attr,
2976 &dev_attr_hotkey_all_mask.attr,
2977 &dev_attr_hotkey_recommended_mask.attr,
2978 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2979 &dev_attr_hotkey_source_mask.attr,
2980 &dev_attr_hotkey_poll_freq.attr,
2981 #endif
2985 * Sync both the hw and sw blocking state of all switches
2987 static void tpacpi_send_radiosw_update(void)
2989 int wlsw;
2992 * We must sync all rfkill controllers *before* issuing any
2993 * rfkill input events, or we will race the rfkill core input
2994 * handler.
2996 * tpacpi_inputdev_send_mutex works as a syncronization point
2997 * for the above.
2999 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3002 wlsw = hotkey_get_wlsw();
3004 /* Sync hw blocking state first if it is hw-blocked */
3005 if (wlsw == TPACPI_RFK_RADIO_OFF)
3006 tpacpi_rfk_update_hwblock_state(true);
3008 /* Sync sw blocking state */
3009 tpacpi_rfk_update_swstate_all();
3011 /* Sync hw blocking state last if it is hw-unblocked */
3012 if (wlsw == TPACPI_RFK_RADIO_ON)
3013 tpacpi_rfk_update_hwblock_state(false);
3015 /* Issue rfkill input event for WLSW switch */
3016 if (!(wlsw < 0)) {
3017 mutex_lock(&tpacpi_inputdev_send_mutex);
3019 input_report_switch(tpacpi_inputdev,
3020 SW_RFKILL_ALL, (wlsw > 0));
3021 input_sync(tpacpi_inputdev);
3023 mutex_unlock(&tpacpi_inputdev_send_mutex);
3027 * this can be unconditional, as we will poll state again
3028 * if userspace uses the notify to read data
3030 hotkey_radio_sw_notify_change();
3033 static void hotkey_exit(void)
3035 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3036 mutex_lock(&hotkey_mutex);
3037 hotkey_poll_stop_sync();
3038 mutex_unlock(&hotkey_mutex);
3039 #endif
3041 if (hotkey_dev_attributes)
3042 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3044 kfree(hotkey_keycode_map);
3046 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3047 "restoring original HKEY status and mask\n");
3048 /* yes, there is a bitwise or below, we want the
3049 * functions to be called even if one of them fail */
3050 if (((tp_features.hotkey_mask &&
3051 hotkey_mask_set(hotkey_orig_mask)) |
3052 hotkey_status_set(false)) != 0)
3053 printk(TPACPI_ERR
3054 "failed to restore hot key mask "
3055 "to BIOS defaults\n");
3058 static void __init hotkey_unmap(const unsigned int scancode)
3060 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3061 clear_bit(hotkey_keycode_map[scancode],
3062 tpacpi_inputdev->keybit);
3063 hotkey_keycode_map[scancode] = KEY_RESERVED;
3068 * HKEY quirks:
3069 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3072 #define TPACPI_HK_Q_INIMASK 0x0001
3074 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3075 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3076 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3077 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3078 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3079 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3080 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3081 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3082 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3083 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3084 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3085 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3086 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3087 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3088 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3089 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3090 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3091 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3092 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3093 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3096 typedef u16 tpacpi_keymap_entry_t;
3097 typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3099 static int __init hotkey_init(struct ibm_init_struct *iibm)
3101 /* Requirements for changing the default keymaps:
3103 * 1. Many of the keys are mapped to KEY_RESERVED for very
3104 * good reasons. Do not change them unless you have deep
3105 * knowledge on the IBM and Lenovo ThinkPad firmware for
3106 * the various ThinkPad models. The driver behaves
3107 * differently for KEY_RESERVED: such keys have their
3108 * hot key mask *unset* in mask_recommended, and also
3109 * in the initial hot key mask programmed into the
3110 * firmware at driver load time, which means the firm-
3111 * ware may react very differently if you change them to
3112 * something else;
3114 * 2. You must be subscribed to the linux-thinkpad and
3115 * ibm-acpi-devel mailing lists, and you should read the
3116 * list archives since 2007 if you want to change the
3117 * keymaps. This requirement exists so that you will
3118 * know the past history of problems with the thinkpad-
3119 * acpi driver keymaps, and also that you will be
3120 * listening to any bug reports;
3122 * 3. Do not send thinkpad-acpi specific patches directly to
3123 * for merging, *ever*. Send them to the linux-acpi
3124 * mailinglist for comments. Merging is to be done only
3125 * through acpi-test and the ACPI maintainer.
3127 * If the above is too much to ask, don't change the keymap.
3128 * Ask the thinkpad-acpi maintainer to do it, instead.
3131 enum keymap_index {
3132 TPACPI_KEYMAP_IBM_GENERIC = 0,
3133 TPACPI_KEYMAP_LENOVO_GENERIC,
3136 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3137 /* Generic keymap for IBM ThinkPads */
3138 [TPACPI_KEYMAP_IBM_GENERIC] = {
3139 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3140 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3141 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3142 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3144 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3145 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3146 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3147 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3149 /* brightness: firmware always reacts to them */
3150 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3151 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3153 /* Thinklight: firmware always react to it */
3154 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3156 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3157 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3159 /* Volume: firmware always react to it and reprograms
3160 * the built-in *extra* mixer. Never map it to control
3161 * another mixer by default. */
3162 KEY_RESERVED, /* 0x14: VOLUME UP */
3163 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3164 KEY_RESERVED, /* 0x16: MUTE */
3166 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3168 /* (assignments unknown, please report if found) */
3169 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3170 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3173 /* Generic keymap for Lenovo ThinkPads */
3174 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3175 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3176 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3177 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3178 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3180 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3181 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3182 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3183 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3185 /* These should be enabled --only-- when ACPI video
3186 * is disabled (i.e. in "vendor" mode), and are handled
3187 * in a special way by the init code */
3188 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3189 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3191 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3193 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3194 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3196 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3197 * react to it and reprograms the built-in *extra* mixer.
3198 * Never map it to control another mixer by default.
3200 * T60?, T61, R60?, R61: firmware and EC tries to send
3201 * these over the regular keyboard, so these are no-ops,
3202 * but there are still weird bugs re. MUTE, so do not
3203 * change unless you get test reports from all Lenovo
3204 * models. May cause the BIOS to interfere with the
3205 * HDA mixer.
3207 KEY_RESERVED, /* 0x14: VOLUME UP */
3208 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3209 KEY_RESERVED, /* 0x16: MUTE */
3211 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3213 /* (assignments unknown, please report if found) */
3214 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3215 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3219 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3220 /* Generic maps (fallback) */
3222 .vendor = PCI_VENDOR_ID_IBM,
3223 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3224 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3227 .vendor = PCI_VENDOR_ID_LENOVO,
3228 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3229 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3233 #define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3234 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3236 int res, i;
3237 int status;
3238 int hkeyv;
3239 bool radiosw_state = false;
3240 bool tabletsw_state = false;
3242 unsigned long quirks;
3243 unsigned long keymap_id;
3245 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3246 "initializing hotkey subdriver\n");
3248 BUG_ON(!tpacpi_inputdev);
3249 BUG_ON(tpacpi_inputdev->open != NULL ||
3250 tpacpi_inputdev->close != NULL);
3252 TPACPI_ACPIHANDLE_INIT(hkey);
3253 mutex_init(&hotkey_mutex);
3255 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3256 mutex_init(&hotkey_thread_mutex);
3257 mutex_init(&hotkey_thread_data_mutex);
3258 #endif
3260 /* hotkey not supported on 570 */
3261 tp_features.hotkey = hkey_handle != NULL;
3263 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3264 "hotkeys are %s\n",
3265 str_supported(tp_features.hotkey));
3267 if (!tp_features.hotkey)
3268 return 1;
3270 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3271 ARRAY_SIZE(tpacpi_hotkey_qtable));
3273 tpacpi_disable_brightness_delay();
3275 /* MUST have enough space for all attributes to be added to
3276 * hotkey_dev_attributes */
3277 hotkey_dev_attributes = create_attr_set(
3278 ARRAY_SIZE(hotkey_attributes) + 2,
3279 NULL);
3280 if (!hotkey_dev_attributes)
3281 return -ENOMEM;
3282 res = add_many_to_attr_set(hotkey_dev_attributes,
3283 hotkey_attributes,
3284 ARRAY_SIZE(hotkey_attributes));
3285 if (res)
3286 goto err_exit;
3288 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3289 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3290 for HKEY interface version 0x100 */
3291 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3292 if ((hkeyv >> 8) != 1) {
3293 printk(TPACPI_ERR "unknown version of the "
3294 "HKEY interface: 0x%x\n", hkeyv);
3295 printk(TPACPI_ERR "please report this to %s\n",
3296 TPACPI_MAIL);
3297 } else {
3299 * MHKV 0x100 in A31, R40, R40e,
3300 * T4x, X31, and later
3302 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3303 "firmware HKEY interface version: 0x%x\n",
3304 hkeyv);
3306 /* Paranoia check AND init hotkey_all_mask */
3307 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3308 "MHKA", "qd")) {
3309 printk(TPACPI_ERR
3310 "missing MHKA handler, "
3311 "please report this to %s\n",
3312 TPACPI_MAIL);
3313 /* Fallback: pre-init for FN+F3,F4,F12 */
3314 hotkey_all_mask = 0x080cU;
3315 } else {
3316 tp_features.hotkey_mask = 1;
3321 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3322 "hotkey masks are %s\n",
3323 str_supported(tp_features.hotkey_mask));
3325 /* Init hotkey_all_mask if not initialized yet */
3326 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3327 (quirks & TPACPI_HK_Q_INIMASK))
3328 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3330 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3331 if (tp_features.hotkey_mask) {
3332 /* hotkey_source_mask *must* be zero for
3333 * the first hotkey_mask_get to return hotkey_orig_mask */
3334 res = hotkey_mask_get();
3335 if (res)
3336 goto err_exit;
3338 hotkey_orig_mask = hotkey_acpi_mask;
3339 } else {
3340 hotkey_orig_mask = hotkey_all_mask;
3341 hotkey_acpi_mask = hotkey_all_mask;
3344 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3345 if (dbg_wlswemul) {
3346 tp_features.hotkey_wlsw = 1;
3347 radiosw_state = !!tpacpi_wlsw_emulstate;
3348 printk(TPACPI_INFO
3349 "radio switch emulation enabled\n");
3350 } else
3351 #endif
3352 /* Not all thinkpads have a hardware radio switch */
3353 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3354 tp_features.hotkey_wlsw = 1;
3355 radiosw_state = !!status;
3356 printk(TPACPI_INFO
3357 "radio switch found; radios are %s\n",
3358 enabled(status, 0));
3360 if (tp_features.hotkey_wlsw)
3361 res = add_to_attr_set(hotkey_dev_attributes,
3362 &dev_attr_hotkey_radio_sw.attr);
3364 /* For X41t, X60t, X61t Tablets... */
3365 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3366 tp_features.hotkey_tablet = 1;
3367 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3368 printk(TPACPI_INFO
3369 "possible tablet mode switch found; "
3370 "ThinkPad in %s mode\n",
3371 (tabletsw_state) ? "tablet" : "laptop");
3372 res = add_to_attr_set(hotkey_dev_attributes,
3373 &dev_attr_hotkey_tablet_mode.attr);
3376 if (!res)
3377 res = register_attr_set_with_sysfs(
3378 hotkey_dev_attributes,
3379 &tpacpi_pdev->dev.kobj);
3380 if (res)
3381 goto err_exit;
3383 /* Set up key map */
3384 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3385 GFP_KERNEL);
3386 if (!hotkey_keycode_map) {
3387 printk(TPACPI_ERR
3388 "failed to allocate memory for key map\n");
3389 res = -ENOMEM;
3390 goto err_exit;
3393 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3394 ARRAY_SIZE(tpacpi_keymap_qtable));
3395 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3396 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3397 "using keymap number %lu\n", keymap_id);
3399 memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3400 TPACPI_HOTKEY_MAP_SIZE);
3402 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3403 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3404 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3405 tpacpi_inputdev->keycode = hotkey_keycode_map;
3406 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3407 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3408 input_set_capability(tpacpi_inputdev, EV_KEY,
3409 hotkey_keycode_map[i]);
3410 } else {
3411 if (i < sizeof(hotkey_reserved_mask)*8)
3412 hotkey_reserved_mask |= 1 << i;
3416 if (tp_features.hotkey_wlsw) {
3417 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3418 input_report_switch(tpacpi_inputdev,
3419 SW_RFKILL_ALL, radiosw_state);
3421 if (tp_features.hotkey_tablet) {
3422 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3423 input_report_switch(tpacpi_inputdev,
3424 SW_TABLET_MODE, tabletsw_state);
3427 /* Do not issue duplicate brightness change events to
3428 * userspace. tpacpi_detect_brightness_capabilities() must have
3429 * been called before this point */
3430 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3431 printk(TPACPI_INFO
3432 "This ThinkPad has standard ACPI backlight "
3433 "brightness control, supported by the ACPI "
3434 "video driver\n");
3435 printk(TPACPI_NOTICE
3436 "Disabling thinkpad-acpi brightness events "
3437 "by default...\n");
3439 /* Disable brightness up/down on Lenovo thinkpads when
3440 * ACPI is handling them, otherwise it is plain impossible
3441 * for userspace to do something even remotely sane */
3442 hotkey_reserved_mask |=
3443 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3444 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3445 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3446 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3449 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3450 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3451 & ~hotkey_all_mask
3452 & ~hotkey_reserved_mask;
3454 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3455 "hotkey source mask 0x%08x, polling freq %u\n",
3456 hotkey_source_mask, hotkey_poll_freq);
3457 #endif
3459 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3460 "enabling firmware HKEY event interface...\n");
3461 res = hotkey_status_set(true);
3462 if (res) {
3463 hotkey_exit();
3464 return res;
3466 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3467 | hotkey_driver_mask)
3468 & ~hotkey_source_mask);
3469 if (res < 0 && res != -ENXIO) {
3470 hotkey_exit();
3471 return res;
3473 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3474 & ~hotkey_reserved_mask;
3475 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3476 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3477 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3479 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3480 "legacy ibm/hotkey event reporting over procfs %s\n",
3481 (hotkey_report_mode < 2) ?
3482 "enabled" : "disabled");
3484 tpacpi_inputdev->open = &hotkey_inputdev_open;
3485 tpacpi_inputdev->close = &hotkey_inputdev_close;
3487 hotkey_poll_setup_safe(true);
3489 return 0;
3491 err_exit:
3492 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3493 hotkey_dev_attributes = NULL;
3495 return (res < 0)? res : 1;
3498 static bool hotkey_notify_hotkey(const u32 hkey,
3499 bool *send_acpi_ev,
3500 bool *ignore_acpi_ev)
3502 /* 0x1000-0x1FFF: key presses */
3503 unsigned int scancode = hkey & 0xfff;
3504 *send_acpi_ev = true;
3505 *ignore_acpi_ev = false;
3507 /* HKEY event 0x1001 is scancode 0x00 */
3508 if (scancode > 0 && scancode <= TPACPI_HOTKEY_MAP_LEN) {
3509 scancode--;
3510 if (!(hotkey_source_mask & (1 << scancode))) {
3511 tpacpi_input_send_key_masked(scancode);
3512 *send_acpi_ev = false;
3513 } else {
3514 *ignore_acpi_ev = true;
3516 return true;
3518 return false;
3521 static bool hotkey_notify_wakeup(const u32 hkey,
3522 bool *send_acpi_ev,
3523 bool *ignore_acpi_ev)
3525 /* 0x2000-0x2FFF: Wakeup reason */
3526 *send_acpi_ev = true;
3527 *ignore_acpi_ev = false;
3529 switch (hkey) {
3530 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3531 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3532 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3533 *ignore_acpi_ev = true;
3534 break;
3536 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3537 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3538 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3539 *ignore_acpi_ev = true;
3540 break;
3542 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3543 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3544 printk(TPACPI_ALERT
3545 "EMERGENCY WAKEUP: battery almost empty\n");
3546 /* how to auto-heal: */
3547 /* 2313: woke up from S3, go to S4/S5 */
3548 /* 2413: woke up from S4, go to S5 */
3549 break;
3551 default:
3552 return false;
3555 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3556 printk(TPACPI_INFO
3557 "woke up due to a hot-unplug "
3558 "request...\n");
3559 hotkey_wakeup_reason_notify_change();
3561 return true;
3564 static bool hotkey_notify_usrevent(const u32 hkey,
3565 bool *send_acpi_ev,
3566 bool *ignore_acpi_ev)
3568 /* 0x5000-0x5FFF: human interface helpers */
3569 *send_acpi_ev = true;
3570 *ignore_acpi_ev = false;
3572 switch (hkey) {
3573 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3574 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3575 return true;
3577 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3578 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3579 tpacpi_input_send_tabletsw();
3580 hotkey_tablet_mode_notify_change();
3581 *send_acpi_ev = false;
3582 return true;
3584 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3585 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3586 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3587 /* do not propagate these events */
3588 *ignore_acpi_ev = true;
3589 return true;
3591 default:
3592 return false;
3596 static void thermal_dump_all_sensors(void);
3598 static bool hotkey_notify_thermal(const u32 hkey,
3599 bool *send_acpi_ev,
3600 bool *ignore_acpi_ev)
3602 bool known = true;
3604 /* 0x6000-0x6FFF: thermal alarms */
3605 *send_acpi_ev = true;
3606 *ignore_acpi_ev = false;
3608 switch (hkey) {
3609 case TP_HKEY_EV_THM_TABLE_CHANGED:
3610 printk(TPACPI_INFO
3611 "EC reports that Thermal Table has changed\n");
3612 /* recommended action: do nothing, we don't have
3613 * Lenovo ATM information */
3614 return true;
3615 case TP_HKEY_EV_ALARM_BAT_HOT:
3616 printk(TPACPI_CRIT
3617 "THERMAL ALARM: battery is too hot!\n");
3618 /* recommended action: warn user through gui */
3619 break;
3620 case TP_HKEY_EV_ALARM_BAT_XHOT:
3621 printk(TPACPI_ALERT
3622 "THERMAL EMERGENCY: battery is extremely hot!\n");
3623 /* recommended action: immediate sleep/hibernate */
3624 break;
3625 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3626 printk(TPACPI_CRIT
3627 "THERMAL ALARM: "
3628 "a sensor reports something is too hot!\n");
3629 /* recommended action: warn user through gui, that */
3630 /* some internal component is too hot */
3631 break;
3632 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3633 printk(TPACPI_ALERT
3634 "THERMAL EMERGENCY: "
3635 "a sensor reports something is extremely hot!\n");
3636 /* recommended action: immediate sleep/hibernate */
3637 break;
3638 default:
3639 printk(TPACPI_ALERT
3640 "THERMAL ALERT: unknown thermal alarm received\n");
3641 known = false;
3644 thermal_dump_all_sensors();
3646 return known;
3649 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3651 u32 hkey;
3652 bool send_acpi_ev;
3653 bool ignore_acpi_ev;
3654 bool known_ev;
3656 if (event != 0x80) {
3657 printk(TPACPI_ERR
3658 "unknown HKEY notification event %d\n", event);
3659 /* forward it to userspace, maybe it knows how to handle it */
3660 acpi_bus_generate_netlink_event(
3661 ibm->acpi->device->pnp.device_class,
3662 dev_name(&ibm->acpi->device->dev),
3663 event, 0);
3664 return;
3667 while (1) {
3668 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3669 printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3670 return;
3673 if (hkey == 0) {
3674 /* queue empty */
3675 return;
3678 send_acpi_ev = true;
3679 ignore_acpi_ev = false;
3681 switch (hkey >> 12) {
3682 case 1:
3683 /* 0x1000-0x1FFF: key presses */
3684 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3685 &ignore_acpi_ev);
3686 break;
3687 case 2:
3688 /* 0x2000-0x2FFF: Wakeup reason */
3689 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3690 &ignore_acpi_ev);
3691 break;
3692 case 3:
3693 /* 0x3000-0x3FFF: bay-related wakeups */
3694 switch (hkey) {
3695 case TP_HKEY_EV_BAYEJ_ACK:
3696 hotkey_autosleep_ack = 1;
3697 printk(TPACPI_INFO
3698 "bay ejected\n");
3699 hotkey_wakeup_hotunplug_complete_notify_change();
3700 known_ev = true;
3701 break;
3702 case TP_HKEY_EV_OPTDRV_EJ:
3703 /* FIXME: kick libata if SATA link offline */
3704 known_ev = true;
3705 break;
3706 default:
3707 known_ev = false;
3709 break;
3710 case 4:
3711 /* 0x4000-0x4FFF: dock-related wakeups */
3712 if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3713 hotkey_autosleep_ack = 1;
3714 printk(TPACPI_INFO
3715 "undocked\n");
3716 hotkey_wakeup_hotunplug_complete_notify_change();
3717 known_ev = true;
3718 } else {
3719 known_ev = false;
3721 break;
3722 case 5:
3723 /* 0x5000-0x5FFF: human interface helpers */
3724 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3725 &ignore_acpi_ev);
3726 break;
3727 case 6:
3728 /* 0x6000-0x6FFF: thermal alarms */
3729 known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3730 &ignore_acpi_ev);
3731 break;
3732 case 7:
3733 /* 0x7000-0x7FFF: misc */
3734 if (tp_features.hotkey_wlsw &&
3735 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3736 tpacpi_send_radiosw_update();
3737 send_acpi_ev = 0;
3738 known_ev = true;
3739 break;
3741 /* fallthrough to default */
3742 default:
3743 known_ev = false;
3745 if (!known_ev) {
3746 printk(TPACPI_NOTICE
3747 "unhandled HKEY event 0x%04x\n", hkey);
3748 printk(TPACPI_NOTICE
3749 "please report the conditions when this "
3750 "event happened to %s\n", TPACPI_MAIL);
3753 /* Legacy events */
3754 if (!ignore_acpi_ev &&
3755 (send_acpi_ev || hotkey_report_mode < 2)) {
3756 acpi_bus_generate_proc_event(ibm->acpi->device,
3757 event, hkey);
3760 /* netlink events */
3761 if (!ignore_acpi_ev && send_acpi_ev) {
3762 acpi_bus_generate_netlink_event(
3763 ibm->acpi->device->pnp.device_class,
3764 dev_name(&ibm->acpi->device->dev),
3765 event, hkey);
3770 static void hotkey_suspend(pm_message_t state)
3772 /* Do these on suspend, we get the events on early resume! */
3773 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3774 hotkey_autosleep_ack = 0;
3777 static void hotkey_resume(void)
3779 tpacpi_disable_brightness_delay();
3781 if (hotkey_status_set(true) < 0 ||
3782 hotkey_mask_set(hotkey_acpi_mask) < 0)
3783 printk(TPACPI_ERR
3784 "error while attempting to reset the event "
3785 "firmware interface\n");
3787 tpacpi_send_radiosw_update();
3788 hotkey_tablet_mode_notify_change();
3789 hotkey_wakeup_reason_notify_change();
3790 hotkey_wakeup_hotunplug_complete_notify_change();
3791 hotkey_poll_setup_safe(false);
3794 /* procfs -------------------------------------------------------------- */
3795 static int hotkey_read(struct seq_file *m)
3797 int res, status;
3799 if (!tp_features.hotkey) {
3800 seq_printf(m, "status:\t\tnot supported\n");
3801 return 0;
3804 if (mutex_lock_killable(&hotkey_mutex))
3805 return -ERESTARTSYS;
3806 res = hotkey_status_get(&status);
3807 if (!res)
3808 res = hotkey_mask_get();
3809 mutex_unlock(&hotkey_mutex);
3810 if (res)
3811 return res;
3813 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3814 if (hotkey_all_mask) {
3815 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3816 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3817 } else {
3818 seq_printf(m, "mask:\t\tnot supported\n");
3819 seq_printf(m, "commands:\tenable, disable, reset\n");
3822 return 0;
3825 static void hotkey_enabledisable_warn(bool enable)
3827 tpacpi_log_usertask("procfs hotkey enable/disable");
3828 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3829 TPACPI_WARN
3830 "hotkey enable/disable functionality has been "
3831 "removed from the driver. Hotkeys are always "
3832 "enabled\n"))
3833 printk(TPACPI_ERR
3834 "Please remove the hotkey=enable module "
3835 "parameter, it is deprecated. Hotkeys are always "
3836 "enabled\n");
3839 static int hotkey_write(char *buf)
3841 int res;
3842 u32 mask;
3843 char *cmd;
3845 if (!tp_features.hotkey)
3846 return -ENODEV;
3848 if (mutex_lock_killable(&hotkey_mutex))
3849 return -ERESTARTSYS;
3851 mask = hotkey_user_mask;
3853 res = 0;
3854 while ((cmd = next_cmd(&buf))) {
3855 if (strlencmp(cmd, "enable") == 0) {
3856 hotkey_enabledisable_warn(1);
3857 } else if (strlencmp(cmd, "disable") == 0) {
3858 hotkey_enabledisable_warn(0);
3859 res = -EPERM;
3860 } else if (strlencmp(cmd, "reset") == 0) {
3861 mask = (hotkey_all_mask | hotkey_source_mask)
3862 & ~hotkey_reserved_mask;
3863 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3864 /* mask set */
3865 } else if (sscanf(cmd, "%x", &mask) == 1) {
3866 /* mask set */
3867 } else {
3868 res = -EINVAL;
3869 goto errexit;
3873 if (!res) {
3874 tpacpi_disclose_usertask("procfs hotkey",
3875 "set mask to 0x%08x\n", mask);
3876 res = hotkey_user_mask_set(mask);
3879 errexit:
3880 mutex_unlock(&hotkey_mutex);
3881 return res;
3884 static const struct acpi_device_id ibm_htk_device_ids[] = {
3885 {TPACPI_ACPI_HKEY_HID, 0},
3886 {"", 0},
3889 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3890 .hid = ibm_htk_device_ids,
3891 .notify = hotkey_notify,
3892 .handle = &hkey_handle,
3893 .type = ACPI_DEVICE_NOTIFY,
3896 static struct ibm_struct hotkey_driver_data = {
3897 .name = "hotkey",
3898 .read = hotkey_read,
3899 .write = hotkey_write,
3900 .exit = hotkey_exit,
3901 .resume = hotkey_resume,
3902 .suspend = hotkey_suspend,
3903 .acpi = &ibm_hotkey_acpidriver,
3906 /*************************************************************************
3907 * Bluetooth subdriver
3910 enum {
3911 /* ACPI GBDC/SBDC bits */
3912 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3913 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3914 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3915 0 = disable, 1 = enable */
3918 enum {
3919 /* ACPI \BLTH commands */
3920 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3921 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3922 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3923 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3924 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3927 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3929 static int bluetooth_get_status(void)
3931 int status;
3933 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3934 if (dbg_bluetoothemul)
3935 return (tpacpi_bluetooth_emulstate) ?
3936 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3937 #endif
3939 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3940 return -EIO;
3942 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3943 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3946 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3948 int status;
3950 vdbg_printk(TPACPI_DBG_RFKILL,
3951 "will attempt to %s bluetooth\n",
3952 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3954 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3955 if (dbg_bluetoothemul) {
3956 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3957 return 0;
3959 #endif
3961 if (state == TPACPI_RFK_RADIO_ON)
3962 status = TP_ACPI_BLUETOOTH_RADIOSSW
3963 | TP_ACPI_BLUETOOTH_RESUMECTRL;
3964 else
3965 status = 0;
3967 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3968 return -EIO;
3970 return 0;
3973 /* sysfs bluetooth enable ---------------------------------------------- */
3974 static ssize_t bluetooth_enable_show(struct device *dev,
3975 struct device_attribute *attr,
3976 char *buf)
3978 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3979 attr, buf);
3982 static ssize_t bluetooth_enable_store(struct device *dev,
3983 struct device_attribute *attr,
3984 const char *buf, size_t count)
3986 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3987 attr, buf, count);
3990 static struct device_attribute dev_attr_bluetooth_enable =
3991 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3992 bluetooth_enable_show, bluetooth_enable_store);
3994 /* --------------------------------------------------------------------- */
3996 static struct attribute *bluetooth_attributes[] = {
3997 &dev_attr_bluetooth_enable.attr,
3998 NULL
4001 static const struct attribute_group bluetooth_attr_group = {
4002 .attrs = bluetooth_attributes,
4005 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4006 .get_status = bluetooth_get_status,
4007 .set_status = bluetooth_set_status,
4010 static void bluetooth_shutdown(void)
4012 /* Order firmware to save current state to NVRAM */
4013 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4014 TP_ACPI_BLTH_SAVE_STATE))
4015 printk(TPACPI_NOTICE
4016 "failed to save bluetooth state to NVRAM\n");
4017 else
4018 vdbg_printk(TPACPI_DBG_RFKILL,
4019 "bluestooth state saved to NVRAM\n");
4022 static void bluetooth_exit(void)
4024 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4025 &bluetooth_attr_group);
4027 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4029 bluetooth_shutdown();
4032 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4034 int res;
4035 int status = 0;
4037 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4038 "initializing bluetooth subdriver\n");
4040 TPACPI_ACPIHANDLE_INIT(hkey);
4042 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4043 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4044 tp_features.bluetooth = hkey_handle &&
4045 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4047 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4048 "bluetooth is %s, status 0x%02x\n",
4049 str_supported(tp_features.bluetooth),
4050 status);
4052 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4053 if (dbg_bluetoothemul) {
4054 tp_features.bluetooth = 1;
4055 printk(TPACPI_INFO
4056 "bluetooth switch emulation enabled\n");
4057 } else
4058 #endif
4059 if (tp_features.bluetooth &&
4060 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4061 /* no bluetooth hardware present in system */
4062 tp_features.bluetooth = 0;
4063 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4064 "bluetooth hardware not installed\n");
4067 if (!tp_features.bluetooth)
4068 return 1;
4070 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4071 &bluetooth_tprfk_ops,
4072 RFKILL_TYPE_BLUETOOTH,
4073 TPACPI_RFK_BLUETOOTH_SW_NAME,
4074 true);
4075 if (res)
4076 return res;
4078 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4079 &bluetooth_attr_group);
4080 if (res) {
4081 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4082 return res;
4085 return 0;
4088 /* procfs -------------------------------------------------------------- */
4089 static int bluetooth_read(struct seq_file *m)
4091 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4094 static int bluetooth_write(char *buf)
4096 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4099 static struct ibm_struct bluetooth_driver_data = {
4100 .name = "bluetooth",
4101 .read = bluetooth_read,
4102 .write = bluetooth_write,
4103 .exit = bluetooth_exit,
4104 .shutdown = bluetooth_shutdown,
4107 /*************************************************************************
4108 * Wan subdriver
4111 enum {
4112 /* ACPI GWAN/SWAN bits */
4113 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4114 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4115 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4116 0 = disable, 1 = enable */
4119 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4121 static int wan_get_status(void)
4123 int status;
4125 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4126 if (dbg_wwanemul)
4127 return (tpacpi_wwan_emulstate) ?
4128 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4129 #endif
4131 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4132 return -EIO;
4134 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4135 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4138 static int wan_set_status(enum tpacpi_rfkill_state state)
4140 int status;
4142 vdbg_printk(TPACPI_DBG_RFKILL,
4143 "will attempt to %s wwan\n",
4144 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4146 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4147 if (dbg_wwanemul) {
4148 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4149 return 0;
4151 #endif
4153 if (state == TPACPI_RFK_RADIO_ON)
4154 status = TP_ACPI_WANCARD_RADIOSSW
4155 | TP_ACPI_WANCARD_RESUMECTRL;
4156 else
4157 status = 0;
4159 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4160 return -EIO;
4162 return 0;
4165 /* sysfs wan enable ---------------------------------------------------- */
4166 static ssize_t wan_enable_show(struct device *dev,
4167 struct device_attribute *attr,
4168 char *buf)
4170 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4171 attr, buf);
4174 static ssize_t wan_enable_store(struct device *dev,
4175 struct device_attribute *attr,
4176 const char *buf, size_t count)
4178 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4179 attr, buf, count);
4182 static struct device_attribute dev_attr_wan_enable =
4183 __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4184 wan_enable_show, wan_enable_store);
4186 /* --------------------------------------------------------------------- */
4188 static struct attribute *wan_attributes[] = {
4189 &dev_attr_wan_enable.attr,
4190 NULL
4193 static const struct attribute_group wan_attr_group = {
4194 .attrs = wan_attributes,
4197 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4198 .get_status = wan_get_status,
4199 .set_status = wan_set_status,
4202 static void wan_shutdown(void)
4204 /* Order firmware to save current state to NVRAM */
4205 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4206 TP_ACPI_WGSV_SAVE_STATE))
4207 printk(TPACPI_NOTICE
4208 "failed to save WWAN state to NVRAM\n");
4209 else
4210 vdbg_printk(TPACPI_DBG_RFKILL,
4211 "WWAN state saved to NVRAM\n");
4214 static void wan_exit(void)
4216 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4217 &wan_attr_group);
4219 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4221 wan_shutdown();
4224 static int __init wan_init(struct ibm_init_struct *iibm)
4226 int res;
4227 int status = 0;
4229 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4230 "initializing wan subdriver\n");
4232 TPACPI_ACPIHANDLE_INIT(hkey);
4234 tp_features.wan = hkey_handle &&
4235 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4237 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4238 "wan is %s, status 0x%02x\n",
4239 str_supported(tp_features.wan),
4240 status);
4242 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4243 if (dbg_wwanemul) {
4244 tp_features.wan = 1;
4245 printk(TPACPI_INFO
4246 "wwan switch emulation enabled\n");
4247 } else
4248 #endif
4249 if (tp_features.wan &&
4250 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4251 /* no wan hardware present in system */
4252 tp_features.wan = 0;
4253 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4254 "wan hardware not installed\n");
4257 if (!tp_features.wan)
4258 return 1;
4260 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4261 &wan_tprfk_ops,
4262 RFKILL_TYPE_WWAN,
4263 TPACPI_RFK_WWAN_SW_NAME,
4264 true);
4265 if (res)
4266 return res;
4268 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4269 &wan_attr_group);
4271 if (res) {
4272 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4273 return res;
4276 return 0;
4279 /* procfs -------------------------------------------------------------- */
4280 static int wan_read(struct seq_file *m)
4282 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4285 static int wan_write(char *buf)
4287 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4290 static struct ibm_struct wan_driver_data = {
4291 .name = "wan",
4292 .read = wan_read,
4293 .write = wan_write,
4294 .exit = wan_exit,
4295 .shutdown = wan_shutdown,
4298 /*************************************************************************
4299 * UWB subdriver
4302 enum {
4303 /* ACPI GUWB/SUWB bits */
4304 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4305 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4308 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4310 static int uwb_get_status(void)
4312 int status;
4314 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4315 if (dbg_uwbemul)
4316 return (tpacpi_uwb_emulstate) ?
4317 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4318 #endif
4320 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4321 return -EIO;
4323 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4324 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4327 static int uwb_set_status(enum tpacpi_rfkill_state state)
4329 int status;
4331 vdbg_printk(TPACPI_DBG_RFKILL,
4332 "will attempt to %s UWB\n",
4333 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4335 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4336 if (dbg_uwbemul) {
4337 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4338 return 0;
4340 #endif
4342 if (state == TPACPI_RFK_RADIO_ON)
4343 status = TP_ACPI_UWB_RADIOSSW;
4344 else
4345 status = 0;
4347 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4348 return -EIO;
4350 return 0;
4353 /* --------------------------------------------------------------------- */
4355 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4356 .get_status = uwb_get_status,
4357 .set_status = uwb_set_status,
4360 static void uwb_exit(void)
4362 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4365 static int __init uwb_init(struct ibm_init_struct *iibm)
4367 int res;
4368 int status = 0;
4370 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4371 "initializing uwb subdriver\n");
4373 TPACPI_ACPIHANDLE_INIT(hkey);
4375 tp_features.uwb = hkey_handle &&
4376 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4378 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4379 "uwb is %s, status 0x%02x\n",
4380 str_supported(tp_features.uwb),
4381 status);
4383 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4384 if (dbg_uwbemul) {
4385 tp_features.uwb = 1;
4386 printk(TPACPI_INFO
4387 "uwb switch emulation enabled\n");
4388 } else
4389 #endif
4390 if (tp_features.uwb &&
4391 !(status & TP_ACPI_UWB_HWPRESENT)) {
4392 /* no uwb hardware present in system */
4393 tp_features.uwb = 0;
4394 dbg_printk(TPACPI_DBG_INIT,
4395 "uwb hardware not installed\n");
4398 if (!tp_features.uwb)
4399 return 1;
4401 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4402 &uwb_tprfk_ops,
4403 RFKILL_TYPE_UWB,
4404 TPACPI_RFK_UWB_SW_NAME,
4405 false);
4406 return res;
4409 static struct ibm_struct uwb_driver_data = {
4410 .name = "uwb",
4411 .exit = uwb_exit,
4412 .flags.experimental = 1,
4415 /*************************************************************************
4416 * Video subdriver
4419 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4421 enum video_access_mode {
4422 TPACPI_VIDEO_NONE = 0,
4423 TPACPI_VIDEO_570, /* 570 */
4424 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4425 TPACPI_VIDEO_NEW, /* all others */
4428 enum { /* video status flags, based on VIDEO_570 */
4429 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4430 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4431 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4434 enum { /* TPACPI_VIDEO_570 constants */
4435 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4436 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4437 * video_status_flags */
4438 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4439 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4442 static enum video_access_mode video_supported;
4443 static int video_orig_autosw;
4445 static int video_autosw_get(void);
4446 static int video_autosw_set(int enable);
4448 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4450 static int __init video_init(struct ibm_init_struct *iibm)
4452 int ivga;
4454 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4456 TPACPI_ACPIHANDLE_INIT(vid);
4457 if (tpacpi_is_ibm())
4458 TPACPI_ACPIHANDLE_INIT(vid2);
4460 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4461 /* G41, assume IVGA doesn't change */
4462 vid_handle = vid2_handle;
4464 if (!vid_handle)
4465 /* video switching not supported on R30, R31 */
4466 video_supported = TPACPI_VIDEO_NONE;
4467 else if (tpacpi_is_ibm() &&
4468 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4469 /* 570 */
4470 video_supported = TPACPI_VIDEO_570;
4471 else if (tpacpi_is_ibm() &&
4472 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4473 /* 600e/x, 770e, 770x */
4474 video_supported = TPACPI_VIDEO_770;
4475 else
4476 /* all others */
4477 video_supported = TPACPI_VIDEO_NEW;
4479 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4480 str_supported(video_supported != TPACPI_VIDEO_NONE),
4481 video_supported);
4483 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4486 static void video_exit(void)
4488 dbg_printk(TPACPI_DBG_EXIT,
4489 "restoring original video autoswitch mode\n");
4490 if (video_autosw_set(video_orig_autosw))
4491 printk(TPACPI_ERR "error while trying to restore original "
4492 "video autoswitch mode\n");
4495 static int video_outputsw_get(void)
4497 int status = 0;
4498 int i;
4500 switch (video_supported) {
4501 case TPACPI_VIDEO_570:
4502 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4503 TP_ACPI_VIDEO_570_PHSCMD))
4504 return -EIO;
4505 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4506 break;
4507 case TPACPI_VIDEO_770:
4508 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4509 return -EIO;
4510 if (i)
4511 status |= TP_ACPI_VIDEO_S_LCD;
4512 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4513 return -EIO;
4514 if (i)
4515 status |= TP_ACPI_VIDEO_S_CRT;
4516 break;
4517 case TPACPI_VIDEO_NEW:
4518 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4519 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4520 return -EIO;
4521 if (i)
4522 status |= TP_ACPI_VIDEO_S_CRT;
4524 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4525 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4526 return -EIO;
4527 if (i)
4528 status |= TP_ACPI_VIDEO_S_LCD;
4529 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4530 return -EIO;
4531 if (i)
4532 status |= TP_ACPI_VIDEO_S_DVI;
4533 break;
4534 default:
4535 return -ENOSYS;
4538 return status;
4541 static int video_outputsw_set(int status)
4543 int autosw;
4544 int res = 0;
4546 switch (video_supported) {
4547 case TPACPI_VIDEO_570:
4548 res = acpi_evalf(NULL, NULL,
4549 "\\_SB.PHS2", "vdd",
4550 TP_ACPI_VIDEO_570_PHS2CMD,
4551 status | TP_ACPI_VIDEO_570_PHS2SET);
4552 break;
4553 case TPACPI_VIDEO_770:
4554 autosw = video_autosw_get();
4555 if (autosw < 0)
4556 return autosw;
4558 res = video_autosw_set(1);
4559 if (res)
4560 return res;
4561 res = acpi_evalf(vid_handle, NULL,
4562 "ASWT", "vdd", status * 0x100, 0);
4563 if (!autosw && video_autosw_set(autosw)) {
4564 printk(TPACPI_ERR
4565 "video auto-switch left enabled due to error\n");
4566 return -EIO;
4568 break;
4569 case TPACPI_VIDEO_NEW:
4570 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4571 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4572 break;
4573 default:
4574 return -ENOSYS;
4577 return (res)? 0 : -EIO;
4580 static int video_autosw_get(void)
4582 int autosw = 0;
4584 switch (video_supported) {
4585 case TPACPI_VIDEO_570:
4586 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4587 return -EIO;
4588 break;
4589 case TPACPI_VIDEO_770:
4590 case TPACPI_VIDEO_NEW:
4591 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4592 return -EIO;
4593 break;
4594 default:
4595 return -ENOSYS;
4598 return autosw & 1;
4601 static int video_autosw_set(int enable)
4603 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4604 return -EIO;
4605 return 0;
4608 static int video_outputsw_cycle(void)
4610 int autosw = video_autosw_get();
4611 int res;
4613 if (autosw < 0)
4614 return autosw;
4616 switch (video_supported) {
4617 case TPACPI_VIDEO_570:
4618 res = video_autosw_set(1);
4619 if (res)
4620 return res;
4621 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4622 break;
4623 case TPACPI_VIDEO_770:
4624 case TPACPI_VIDEO_NEW:
4625 res = video_autosw_set(1);
4626 if (res)
4627 return res;
4628 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4629 break;
4630 default:
4631 return -ENOSYS;
4633 if (!autosw && video_autosw_set(autosw)) {
4634 printk(TPACPI_ERR
4635 "video auto-switch left enabled due to error\n");
4636 return -EIO;
4639 return (res)? 0 : -EIO;
4642 static int video_expand_toggle(void)
4644 switch (video_supported) {
4645 case TPACPI_VIDEO_570:
4646 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4647 0 : -EIO;
4648 case TPACPI_VIDEO_770:
4649 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4650 0 : -EIO;
4651 case TPACPI_VIDEO_NEW:
4652 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4653 0 : -EIO;
4654 default:
4655 return -ENOSYS;
4657 /* not reached */
4660 static int video_read(struct seq_file *m)
4662 int status, autosw;
4664 if (video_supported == TPACPI_VIDEO_NONE) {
4665 seq_printf(m, "status:\t\tnot supported\n");
4666 return 0;
4669 /* Even reads can crash X.org, so... */
4670 if (!capable(CAP_SYS_ADMIN))
4671 return -EPERM;
4673 status = video_outputsw_get();
4674 if (status < 0)
4675 return status;
4677 autosw = video_autosw_get();
4678 if (autosw < 0)
4679 return autosw;
4681 seq_printf(m, "status:\t\tsupported\n");
4682 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4683 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4684 if (video_supported == TPACPI_VIDEO_NEW)
4685 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4686 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4687 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4688 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4689 if (video_supported == TPACPI_VIDEO_NEW)
4690 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4691 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4692 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4694 return 0;
4697 static int video_write(char *buf)
4699 char *cmd;
4700 int enable, disable, status;
4701 int res;
4703 if (video_supported == TPACPI_VIDEO_NONE)
4704 return -ENODEV;
4706 /* Even reads can crash X.org, let alone writes... */
4707 if (!capable(CAP_SYS_ADMIN))
4708 return -EPERM;
4710 enable = 0;
4711 disable = 0;
4713 while ((cmd = next_cmd(&buf))) {
4714 if (strlencmp(cmd, "lcd_enable") == 0) {
4715 enable |= TP_ACPI_VIDEO_S_LCD;
4716 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4717 disable |= TP_ACPI_VIDEO_S_LCD;
4718 } else if (strlencmp(cmd, "crt_enable") == 0) {
4719 enable |= TP_ACPI_VIDEO_S_CRT;
4720 } else if (strlencmp(cmd, "crt_disable") == 0) {
4721 disable |= TP_ACPI_VIDEO_S_CRT;
4722 } else if (video_supported == TPACPI_VIDEO_NEW &&
4723 strlencmp(cmd, "dvi_enable") == 0) {
4724 enable |= TP_ACPI_VIDEO_S_DVI;
4725 } else if (video_supported == TPACPI_VIDEO_NEW &&
4726 strlencmp(cmd, "dvi_disable") == 0) {
4727 disable |= TP_ACPI_VIDEO_S_DVI;
4728 } else if (strlencmp(cmd, "auto_enable") == 0) {
4729 res = video_autosw_set(1);
4730 if (res)
4731 return res;
4732 } else if (strlencmp(cmd, "auto_disable") == 0) {
4733 res = video_autosw_set(0);
4734 if (res)
4735 return res;
4736 } else if (strlencmp(cmd, "video_switch") == 0) {
4737 res = video_outputsw_cycle();
4738 if (res)
4739 return res;
4740 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4741 res = video_expand_toggle();
4742 if (res)
4743 return res;
4744 } else
4745 return -EINVAL;
4748 if (enable || disable) {
4749 status = video_outputsw_get();
4750 if (status < 0)
4751 return status;
4752 res = video_outputsw_set((status & ~disable) | enable);
4753 if (res)
4754 return res;
4757 return 0;
4760 static struct ibm_struct video_driver_data = {
4761 .name = "video",
4762 .read = video_read,
4763 .write = video_write,
4764 .exit = video_exit,
4767 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4769 /*************************************************************************
4770 * Light (thinklight) subdriver
4773 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4774 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4776 static int light_get_status(void)
4778 int status = 0;
4780 if (tp_features.light_status) {
4781 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4782 return -EIO;
4783 return (!!status);
4786 return -ENXIO;
4789 static int light_set_status(int status)
4791 int rc;
4793 if (tp_features.light) {
4794 if (cmos_handle) {
4795 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4796 (status)?
4797 TP_CMOS_THINKLIGHT_ON :
4798 TP_CMOS_THINKLIGHT_OFF);
4799 } else {
4800 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4801 (status)? 1 : 0);
4803 return (rc)? 0 : -EIO;
4806 return -ENXIO;
4809 static void light_set_status_worker(struct work_struct *work)
4811 struct tpacpi_led_classdev *data =
4812 container_of(work, struct tpacpi_led_classdev, work);
4814 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4815 light_set_status((data->new_state != TPACPI_LED_OFF));
4818 static void light_sysfs_set(struct led_classdev *led_cdev,
4819 enum led_brightness brightness)
4821 struct tpacpi_led_classdev *data =
4822 container_of(led_cdev,
4823 struct tpacpi_led_classdev,
4824 led_classdev);
4825 data->new_state = (brightness != LED_OFF) ?
4826 TPACPI_LED_ON : TPACPI_LED_OFF;
4827 queue_work(tpacpi_wq, &data->work);
4830 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4832 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4835 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4836 .led_classdev = {
4837 .name = "tpacpi::thinklight",
4838 .brightness_set = &light_sysfs_set,
4839 .brightness_get = &light_sysfs_get,
4843 static int __init light_init(struct ibm_init_struct *iibm)
4845 int rc;
4847 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4849 if (tpacpi_is_ibm()) {
4850 TPACPI_ACPIHANDLE_INIT(ledb);
4851 TPACPI_ACPIHANDLE_INIT(lght);
4853 TPACPI_ACPIHANDLE_INIT(cmos);
4854 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4856 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4857 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4859 if (tp_features.light)
4860 /* light status not supported on
4861 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4862 tp_features.light_status =
4863 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4865 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4866 str_supported(tp_features.light),
4867 str_supported(tp_features.light_status));
4869 if (!tp_features.light)
4870 return 1;
4872 rc = led_classdev_register(&tpacpi_pdev->dev,
4873 &tpacpi_led_thinklight.led_classdev);
4875 if (rc < 0) {
4876 tp_features.light = 0;
4877 tp_features.light_status = 0;
4878 } else {
4879 rc = 0;
4882 return rc;
4885 static void light_exit(void)
4887 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4888 if (work_pending(&tpacpi_led_thinklight.work))
4889 flush_workqueue(tpacpi_wq);
4892 static int light_read(struct seq_file *m)
4894 int status;
4896 if (!tp_features.light) {
4897 seq_printf(m, "status:\t\tnot supported\n");
4898 } else if (!tp_features.light_status) {
4899 seq_printf(m, "status:\t\tunknown\n");
4900 seq_printf(m, "commands:\ton, off\n");
4901 } else {
4902 status = light_get_status();
4903 if (status < 0)
4904 return status;
4905 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4906 seq_printf(m, "commands:\ton, off\n");
4909 return 0;
4912 static int light_write(char *buf)
4914 char *cmd;
4915 int newstatus = 0;
4917 if (!tp_features.light)
4918 return -ENODEV;
4920 while ((cmd = next_cmd(&buf))) {
4921 if (strlencmp(cmd, "on") == 0) {
4922 newstatus = 1;
4923 } else if (strlencmp(cmd, "off") == 0) {
4924 newstatus = 0;
4925 } else
4926 return -EINVAL;
4929 return light_set_status(newstatus);
4932 static struct ibm_struct light_driver_data = {
4933 .name = "light",
4934 .read = light_read,
4935 .write = light_write,
4936 .exit = light_exit,
4939 /*************************************************************************
4940 * CMOS subdriver
4943 /* sysfs cmos_command -------------------------------------------------- */
4944 static ssize_t cmos_command_store(struct device *dev,
4945 struct device_attribute *attr,
4946 const char *buf, size_t count)
4948 unsigned long cmos_cmd;
4949 int res;
4951 if (parse_strtoul(buf, 21, &cmos_cmd))
4952 return -EINVAL;
4954 res = issue_thinkpad_cmos_command(cmos_cmd);
4955 return (res)? res : count;
4958 static struct device_attribute dev_attr_cmos_command =
4959 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4961 /* --------------------------------------------------------------------- */
4963 static int __init cmos_init(struct ibm_init_struct *iibm)
4965 int res;
4967 vdbg_printk(TPACPI_DBG_INIT,
4968 "initializing cmos commands subdriver\n");
4970 TPACPI_ACPIHANDLE_INIT(cmos);
4972 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4973 str_supported(cmos_handle != NULL));
4975 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4976 if (res)
4977 return res;
4979 return (cmos_handle)? 0 : 1;
4982 static void cmos_exit(void)
4984 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4987 static int cmos_read(struct seq_file *m)
4989 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4990 R30, R31, T20-22, X20-21 */
4991 if (!cmos_handle)
4992 seq_printf(m, "status:\t\tnot supported\n");
4993 else {
4994 seq_printf(m, "status:\t\tsupported\n");
4995 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
4998 return 0;
5001 static int cmos_write(char *buf)
5003 char *cmd;
5004 int cmos_cmd, res;
5006 while ((cmd = next_cmd(&buf))) {
5007 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5008 cmos_cmd >= 0 && cmos_cmd <= 21) {
5009 /* cmos_cmd set */
5010 } else
5011 return -EINVAL;
5013 res = issue_thinkpad_cmos_command(cmos_cmd);
5014 if (res)
5015 return res;
5018 return 0;
5021 static struct ibm_struct cmos_driver_data = {
5022 .name = "cmos",
5023 .read = cmos_read,
5024 .write = cmos_write,
5025 .exit = cmos_exit,
5028 /*************************************************************************
5029 * LED subdriver
5032 enum led_access_mode {
5033 TPACPI_LED_NONE = 0,
5034 TPACPI_LED_570, /* 570 */
5035 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5036 TPACPI_LED_NEW, /* all others */
5039 enum { /* For TPACPI_LED_OLD */
5040 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5041 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5042 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5045 static enum led_access_mode led_supported;
5047 static acpi_handle led_handle;
5049 #define TPACPI_LED_NUMLEDS 16
5050 static struct tpacpi_led_classdev *tpacpi_leds;
5051 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5052 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5053 /* there's a limit of 19 chars + NULL before 2.6.26 */
5054 "tpacpi::power",
5055 "tpacpi:orange:batt",
5056 "tpacpi:green:batt",
5057 "tpacpi::dock_active",
5058 "tpacpi::bay_active",
5059 "tpacpi::dock_batt",
5060 "tpacpi::unknown_led",
5061 "tpacpi::standby",
5062 "tpacpi::dock_status1",
5063 "tpacpi::dock_status2",
5064 "tpacpi::unknown_led2",
5065 "tpacpi::unknown_led3",
5066 "tpacpi::thinkvantage",
5068 #define TPACPI_SAFE_LEDS 0x1081U
5070 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5072 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5073 return false;
5074 #else
5075 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5076 #endif
5079 static int led_get_status(const unsigned int led)
5081 int status;
5082 enum led_status_t led_s;
5084 switch (led_supported) {
5085 case TPACPI_LED_570:
5086 if (!acpi_evalf(ec_handle,
5087 &status, "GLED", "dd", 1 << led))
5088 return -EIO;
5089 led_s = (status == 0)?
5090 TPACPI_LED_OFF :
5091 ((status == 1)?
5092 TPACPI_LED_ON :
5093 TPACPI_LED_BLINK);
5094 tpacpi_led_state_cache[led] = led_s;
5095 return led_s;
5096 default:
5097 return -ENXIO;
5100 /* not reached */
5103 static int led_set_status(const unsigned int led,
5104 const enum led_status_t ledstatus)
5106 /* off, on, blink. Index is led_status_t */
5107 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5108 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5110 int rc = 0;
5112 switch (led_supported) {
5113 case TPACPI_LED_570:
5114 /* 570 */
5115 if (unlikely(led > 7))
5116 return -EINVAL;
5117 if (unlikely(tpacpi_is_led_restricted(led)))
5118 return -EPERM;
5119 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5120 (1 << led), led_sled_arg1[ledstatus]))
5121 rc = -EIO;
5122 break;
5123 case TPACPI_LED_OLD:
5124 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5125 if (unlikely(led > 7))
5126 return -EINVAL;
5127 if (unlikely(tpacpi_is_led_restricted(led)))
5128 return -EPERM;
5129 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5130 if (rc >= 0)
5131 rc = ec_write(TPACPI_LED_EC_HLBL,
5132 (ledstatus == TPACPI_LED_BLINK) << led);
5133 if (rc >= 0)
5134 rc = ec_write(TPACPI_LED_EC_HLCL,
5135 (ledstatus != TPACPI_LED_OFF) << led);
5136 break;
5137 case TPACPI_LED_NEW:
5138 /* all others */
5139 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5140 return -EINVAL;
5141 if (unlikely(tpacpi_is_led_restricted(led)))
5142 return -EPERM;
5143 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5144 led, led_led_arg1[ledstatus]))
5145 rc = -EIO;
5146 break;
5147 default:
5148 rc = -ENXIO;
5151 if (!rc)
5152 tpacpi_led_state_cache[led] = ledstatus;
5154 return rc;
5157 static void led_set_status_worker(struct work_struct *work)
5159 struct tpacpi_led_classdev *data =
5160 container_of(work, struct tpacpi_led_classdev, work);
5162 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5163 led_set_status(data->led, data->new_state);
5166 static void led_sysfs_set(struct led_classdev *led_cdev,
5167 enum led_brightness brightness)
5169 struct tpacpi_led_classdev *data = container_of(led_cdev,
5170 struct tpacpi_led_classdev, led_classdev);
5172 if (brightness == LED_OFF)
5173 data->new_state = TPACPI_LED_OFF;
5174 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5175 data->new_state = TPACPI_LED_ON;
5176 else
5177 data->new_state = TPACPI_LED_BLINK;
5179 queue_work(tpacpi_wq, &data->work);
5182 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5183 unsigned long *delay_on, unsigned long *delay_off)
5185 struct tpacpi_led_classdev *data = container_of(led_cdev,
5186 struct tpacpi_led_classdev, led_classdev);
5188 /* Can we choose the flash rate? */
5189 if (*delay_on == 0 && *delay_off == 0) {
5190 /* yes. set them to the hardware blink rate (1 Hz) */
5191 *delay_on = 500; /* ms */
5192 *delay_off = 500; /* ms */
5193 } else if ((*delay_on != 500) || (*delay_off != 500))
5194 return -EINVAL;
5196 data->new_state = TPACPI_LED_BLINK;
5197 queue_work(tpacpi_wq, &data->work);
5199 return 0;
5202 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5204 int rc;
5206 struct tpacpi_led_classdev *data = container_of(led_cdev,
5207 struct tpacpi_led_classdev, led_classdev);
5209 rc = led_get_status(data->led);
5211 if (rc == TPACPI_LED_OFF || rc < 0)
5212 rc = LED_OFF; /* no error handling in led class :( */
5213 else
5214 rc = LED_FULL;
5216 return rc;
5219 static void led_exit(void)
5221 unsigned int i;
5223 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5224 if (tpacpi_leds[i].led_classdev.name)
5225 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5228 kfree(tpacpi_leds);
5231 static int __init tpacpi_init_led(unsigned int led)
5233 int rc;
5235 tpacpi_leds[led].led = led;
5237 /* LEDs with no name don't get registered */
5238 if (!tpacpi_led_names[led])
5239 return 0;
5241 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5242 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5243 if (led_supported == TPACPI_LED_570)
5244 tpacpi_leds[led].led_classdev.brightness_get =
5245 &led_sysfs_get;
5247 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5249 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5251 rc = led_classdev_register(&tpacpi_pdev->dev,
5252 &tpacpi_leds[led].led_classdev);
5253 if (rc < 0)
5254 tpacpi_leds[led].led_classdev.name = NULL;
5256 return rc;
5259 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5260 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5261 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5262 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5264 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5265 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5266 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5267 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5268 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5269 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5270 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5271 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5273 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5274 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5275 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5276 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5277 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5279 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5280 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5281 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5282 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5284 /* (1) - may have excess leds enabled on MSB */
5286 /* Defaults (order matters, keep last, don't reorder!) */
5287 { /* Lenovo */
5288 .vendor = PCI_VENDOR_ID_LENOVO,
5289 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5290 .quirks = 0x1fffU,
5292 { /* IBM ThinkPads with no EC version string */
5293 .vendor = PCI_VENDOR_ID_IBM,
5294 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5295 .quirks = 0x00ffU,
5297 { /* IBM ThinkPads with EC version string */
5298 .vendor = PCI_VENDOR_ID_IBM,
5299 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5300 .quirks = 0x00bfU,
5304 #undef TPACPI_LEDQ_IBM
5305 #undef TPACPI_LEDQ_LNV
5307 static enum led_access_mode __init led_init_detect_mode(void)
5309 acpi_status status;
5311 if (tpacpi_is_ibm()) {
5312 /* 570 */
5313 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5314 if (ACPI_SUCCESS(status))
5315 return TPACPI_LED_570;
5317 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5318 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5319 if (ACPI_SUCCESS(status))
5320 return TPACPI_LED_OLD;
5323 /* most others */
5324 status = acpi_get_handle(ec_handle, "LED", &led_handle);
5325 if (ACPI_SUCCESS(status))
5326 return TPACPI_LED_NEW;
5328 /* R30, R31, and unknown firmwares */
5329 led_handle = NULL;
5330 return TPACPI_LED_NONE;
5333 static int __init led_init(struct ibm_init_struct *iibm)
5335 unsigned int i;
5336 int rc;
5337 unsigned long useful_leds;
5339 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5341 led_supported = led_init_detect_mode();
5343 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5344 str_supported(led_supported), led_supported);
5346 if (led_supported == TPACPI_LED_NONE)
5347 return 1;
5349 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5350 GFP_KERNEL);
5351 if (!tpacpi_leds) {
5352 printk(TPACPI_ERR "Out of memory for LED data\n");
5353 return -ENOMEM;
5356 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5357 ARRAY_SIZE(led_useful_qtable));
5359 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5360 if (!tpacpi_is_led_restricted(i) &&
5361 test_bit(i, &useful_leds)) {
5362 rc = tpacpi_init_led(i);
5363 if (rc < 0) {
5364 led_exit();
5365 return rc;
5370 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5371 printk(TPACPI_NOTICE
5372 "warning: userspace override of important "
5373 "firmware LEDs is enabled\n");
5374 #endif
5375 return 0;
5378 #define str_led_status(s) \
5379 ((s) == TPACPI_LED_OFF ? "off" : \
5380 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5382 static int led_read(struct seq_file *m)
5384 if (!led_supported) {
5385 seq_printf(m, "status:\t\tnot supported\n");
5386 return 0;
5388 seq_printf(m, "status:\t\tsupported\n");
5390 if (led_supported == TPACPI_LED_570) {
5391 /* 570 */
5392 int i, status;
5393 for (i = 0; i < 8; i++) {
5394 status = led_get_status(i);
5395 if (status < 0)
5396 return -EIO;
5397 seq_printf(m, "%d:\t\t%s\n",
5398 i, str_led_status(status));
5402 seq_printf(m, "commands:\t"
5403 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5405 return 0;
5408 static int led_write(char *buf)
5410 char *cmd;
5411 int led, rc;
5412 enum led_status_t s;
5414 if (!led_supported)
5415 return -ENODEV;
5417 while ((cmd = next_cmd(&buf))) {
5418 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5419 return -EINVAL;
5421 if (strstr(cmd, "off")) {
5422 s = TPACPI_LED_OFF;
5423 } else if (strstr(cmd, "on")) {
5424 s = TPACPI_LED_ON;
5425 } else if (strstr(cmd, "blink")) {
5426 s = TPACPI_LED_BLINK;
5427 } else {
5428 return -EINVAL;
5431 rc = led_set_status(led, s);
5432 if (rc < 0)
5433 return rc;
5436 return 0;
5439 static struct ibm_struct led_driver_data = {
5440 .name = "led",
5441 .read = led_read,
5442 .write = led_write,
5443 .exit = led_exit,
5446 /*************************************************************************
5447 * Beep subdriver
5450 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5452 #define TPACPI_BEEP_Q1 0x0001
5454 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5455 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5456 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5459 static int __init beep_init(struct ibm_init_struct *iibm)
5461 unsigned long quirks;
5463 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5465 TPACPI_ACPIHANDLE_INIT(beep);
5467 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5468 str_supported(beep_handle != NULL));
5470 quirks = tpacpi_check_quirks(beep_quirk_table,
5471 ARRAY_SIZE(beep_quirk_table));
5473 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5475 return (beep_handle)? 0 : 1;
5478 static int beep_read(struct seq_file *m)
5480 if (!beep_handle)
5481 seq_printf(m, "status:\t\tnot supported\n");
5482 else {
5483 seq_printf(m, "status:\t\tsupported\n");
5484 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5487 return 0;
5490 static int beep_write(char *buf)
5492 char *cmd;
5493 int beep_cmd;
5495 if (!beep_handle)
5496 return -ENODEV;
5498 while ((cmd = next_cmd(&buf))) {
5499 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5500 beep_cmd >= 0 && beep_cmd <= 17) {
5501 /* beep_cmd set */
5502 } else
5503 return -EINVAL;
5504 if (tp_features.beep_needs_two_args) {
5505 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5506 beep_cmd, 0))
5507 return -EIO;
5508 } else {
5509 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5510 beep_cmd))
5511 return -EIO;
5515 return 0;
5518 static struct ibm_struct beep_driver_data = {
5519 .name = "beep",
5520 .read = beep_read,
5521 .write = beep_write,
5524 /*************************************************************************
5525 * Thermal subdriver
5528 enum thermal_access_mode {
5529 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5530 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5531 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5532 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5533 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5536 enum { /* TPACPI_THERMAL_TPEC_* */
5537 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5538 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5539 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5541 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5545 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5546 struct ibm_thermal_sensors_struct {
5547 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5550 static enum thermal_access_mode thermal_read_mode;
5552 /* idx is zero-based */
5553 static int thermal_get_sensor(int idx, s32 *value)
5555 int t;
5556 s8 tmp;
5557 char tmpi[5];
5559 t = TP_EC_THERMAL_TMP0;
5561 switch (thermal_read_mode) {
5562 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5563 case TPACPI_THERMAL_TPEC_16:
5564 if (idx >= 8 && idx <= 15) {
5565 t = TP_EC_THERMAL_TMP8;
5566 idx -= 8;
5568 /* fallthrough */
5569 #endif
5570 case TPACPI_THERMAL_TPEC_8:
5571 if (idx <= 7) {
5572 if (!acpi_ec_read(t + idx, &tmp))
5573 return -EIO;
5574 *value = tmp * 1000;
5575 return 0;
5577 break;
5579 case TPACPI_THERMAL_ACPI_UPDT:
5580 if (idx <= 7) {
5581 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5582 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5583 return -EIO;
5584 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5585 return -EIO;
5586 *value = (t - 2732) * 100;
5587 return 0;
5589 break;
5591 case TPACPI_THERMAL_ACPI_TMP07:
5592 if (idx <= 7) {
5593 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5594 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5595 return -EIO;
5596 if (t > 127 || t < -127)
5597 t = TP_EC_THERMAL_TMP_NA;
5598 *value = t * 1000;
5599 return 0;
5601 break;
5603 case TPACPI_THERMAL_NONE:
5604 default:
5605 return -ENOSYS;
5608 return -EINVAL;
5611 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5613 int res, i;
5614 int n;
5616 n = 8;
5617 i = 0;
5619 if (!s)
5620 return -EINVAL;
5622 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5623 n = 16;
5625 for (i = 0 ; i < n; i++) {
5626 res = thermal_get_sensor(i, &s->temp[i]);
5627 if (res)
5628 return res;
5631 return n;
5634 static void thermal_dump_all_sensors(void)
5636 int n, i;
5637 struct ibm_thermal_sensors_struct t;
5639 n = thermal_get_sensors(&t);
5640 if (n <= 0)
5641 return;
5643 printk(TPACPI_NOTICE
5644 "temperatures (Celsius):");
5646 for (i = 0; i < n; i++) {
5647 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5648 printk(KERN_CONT " %d", (int)(t.temp[i] / 1000));
5649 else
5650 printk(KERN_CONT " N/A");
5653 printk(KERN_CONT "\n");
5656 /* sysfs temp##_input -------------------------------------------------- */
5658 static ssize_t thermal_temp_input_show(struct device *dev,
5659 struct device_attribute *attr,
5660 char *buf)
5662 struct sensor_device_attribute *sensor_attr =
5663 to_sensor_dev_attr(attr);
5664 int idx = sensor_attr->index;
5665 s32 value;
5666 int res;
5668 res = thermal_get_sensor(idx, &value);
5669 if (res)
5670 return res;
5671 if (value == TPACPI_THERMAL_SENSOR_NA)
5672 return -ENXIO;
5674 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5677 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5678 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5679 thermal_temp_input_show, NULL, _idxB)
5681 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5682 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5683 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5684 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5685 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5686 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5687 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5688 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5689 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5690 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5691 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5692 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5693 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5694 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5695 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5696 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5697 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5700 #define THERMAL_ATTRS(X) \
5701 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5703 static struct attribute *thermal_temp_input_attr[] = {
5704 THERMAL_ATTRS(8),
5705 THERMAL_ATTRS(9),
5706 THERMAL_ATTRS(10),
5707 THERMAL_ATTRS(11),
5708 THERMAL_ATTRS(12),
5709 THERMAL_ATTRS(13),
5710 THERMAL_ATTRS(14),
5711 THERMAL_ATTRS(15),
5712 THERMAL_ATTRS(0),
5713 THERMAL_ATTRS(1),
5714 THERMAL_ATTRS(2),
5715 THERMAL_ATTRS(3),
5716 THERMAL_ATTRS(4),
5717 THERMAL_ATTRS(5),
5718 THERMAL_ATTRS(6),
5719 THERMAL_ATTRS(7),
5720 NULL
5723 static const struct attribute_group thermal_temp_input16_group = {
5724 .attrs = thermal_temp_input_attr
5727 static const struct attribute_group thermal_temp_input8_group = {
5728 .attrs = &thermal_temp_input_attr[8]
5731 #undef THERMAL_SENSOR_ATTR_TEMP
5732 #undef THERMAL_ATTRS
5734 /* --------------------------------------------------------------------- */
5736 static int __init thermal_init(struct ibm_init_struct *iibm)
5738 u8 t, ta1, ta2;
5739 int i;
5740 int acpi_tmp7;
5741 int res;
5743 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5745 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5747 if (thinkpad_id.ec_model) {
5749 * Direct EC access mode: sensors at registers
5750 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5751 * non-implemented, thermal sensors return 0x80 when
5752 * not available
5755 ta1 = ta2 = 0;
5756 for (i = 0; i < 8; i++) {
5757 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5758 ta1 |= t;
5759 } else {
5760 ta1 = 0;
5761 break;
5763 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5764 ta2 |= t;
5765 } else {
5766 ta1 = 0;
5767 break;
5770 if (ta1 == 0) {
5771 /* This is sheer paranoia, but we handle it anyway */
5772 if (acpi_tmp7) {
5773 printk(TPACPI_ERR
5774 "ThinkPad ACPI EC access misbehaving, "
5775 "falling back to ACPI TMPx access "
5776 "mode\n");
5777 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5778 } else {
5779 printk(TPACPI_ERR
5780 "ThinkPad ACPI EC access misbehaving, "
5781 "disabling thermal sensors access\n");
5782 thermal_read_mode = TPACPI_THERMAL_NONE;
5784 } else {
5785 thermal_read_mode =
5786 (ta2 != 0) ?
5787 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5789 } else if (acpi_tmp7) {
5790 if (tpacpi_is_ibm() &&
5791 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5792 /* 600e/x, 770e, 770x */
5793 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5794 } else {
5795 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5796 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5798 } else {
5799 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5800 thermal_read_mode = TPACPI_THERMAL_NONE;
5803 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5804 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5805 thermal_read_mode);
5807 switch (thermal_read_mode) {
5808 case TPACPI_THERMAL_TPEC_16:
5809 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5810 &thermal_temp_input16_group);
5811 if (res)
5812 return res;
5813 break;
5814 case TPACPI_THERMAL_TPEC_8:
5815 case TPACPI_THERMAL_ACPI_TMP07:
5816 case TPACPI_THERMAL_ACPI_UPDT:
5817 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5818 &thermal_temp_input8_group);
5819 if (res)
5820 return res;
5821 break;
5822 case TPACPI_THERMAL_NONE:
5823 default:
5824 return 1;
5827 return 0;
5830 static void thermal_exit(void)
5832 switch (thermal_read_mode) {
5833 case TPACPI_THERMAL_TPEC_16:
5834 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5835 &thermal_temp_input16_group);
5836 break;
5837 case TPACPI_THERMAL_TPEC_8:
5838 case TPACPI_THERMAL_ACPI_TMP07:
5839 case TPACPI_THERMAL_ACPI_UPDT:
5840 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5841 &thermal_temp_input8_group);
5842 break;
5843 case TPACPI_THERMAL_NONE:
5844 default:
5845 break;
5849 static int thermal_read(struct seq_file *m)
5851 int n, i;
5852 struct ibm_thermal_sensors_struct t;
5854 n = thermal_get_sensors(&t);
5855 if (unlikely(n < 0))
5856 return n;
5858 seq_printf(m, "temperatures:\t");
5860 if (n > 0) {
5861 for (i = 0; i < (n - 1); i++)
5862 seq_printf(m, "%d ", t.temp[i] / 1000);
5863 seq_printf(m, "%d\n", t.temp[i] / 1000);
5864 } else
5865 seq_printf(m, "not supported\n");
5867 return 0;
5870 static struct ibm_struct thermal_driver_data = {
5871 .name = "thermal",
5872 .read = thermal_read,
5873 .exit = thermal_exit,
5876 /*************************************************************************
5877 * Backlight/brightness subdriver
5880 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5883 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5884 * CMOS NVRAM byte 0x5E, bits 0-3.
5886 * EC HBRV (0x31) has the following layout
5887 * Bit 7: unknown function
5888 * Bit 6: unknown function
5889 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5890 * Bit 4: must be set to zero to avoid problems
5891 * Bit 3-0: backlight brightness level
5893 * brightness_get_raw returns status data in the HBRV layout
5895 * WARNING: The X61 has been verified to use HBRV for something else, so
5896 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5897 * testing on the very early *60 Lenovo models...
5900 enum {
5901 TP_EC_BACKLIGHT = 0x31,
5903 /* TP_EC_BACKLIGHT bitmasks */
5904 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5905 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5906 TP_EC_BACKLIGHT_MAPSW = 0x20,
5909 enum tpacpi_brightness_access_mode {
5910 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5911 TPACPI_BRGHT_MODE_EC, /* EC control */
5912 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5913 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5914 TPACPI_BRGHT_MODE_MAX
5917 static struct backlight_device *ibm_backlight_device;
5919 static enum tpacpi_brightness_access_mode brightness_mode =
5920 TPACPI_BRGHT_MODE_MAX;
5922 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5924 static struct mutex brightness_mutex;
5926 /* NVRAM brightness access,
5927 * call with brightness_mutex held! */
5928 static unsigned int tpacpi_brightness_nvram_get(void)
5930 u8 lnvram;
5932 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5933 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5934 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5935 lnvram &= bright_maxlvl;
5937 return lnvram;
5940 static void tpacpi_brightness_checkpoint_nvram(void)
5942 u8 lec = 0;
5943 u8 b_nvram;
5945 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
5946 return;
5948 vdbg_printk(TPACPI_DBG_BRGHT,
5949 "trying to checkpoint backlight level to NVRAM...\n");
5951 if (mutex_lock_killable(&brightness_mutex) < 0)
5952 return;
5954 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5955 goto unlock;
5956 lec &= TP_EC_BACKLIGHT_LVLMSK;
5957 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
5959 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5960 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
5961 /* NVRAM needs update */
5962 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
5963 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
5964 b_nvram |= lec;
5965 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
5966 dbg_printk(TPACPI_DBG_BRGHT,
5967 "updated NVRAM backlight level to %u (0x%02x)\n",
5968 (unsigned int) lec, (unsigned int) b_nvram);
5969 } else
5970 vdbg_printk(TPACPI_DBG_BRGHT,
5971 "NVRAM backlight level already is %u (0x%02x)\n",
5972 (unsigned int) lec, (unsigned int) b_nvram);
5974 unlock:
5975 mutex_unlock(&brightness_mutex);
5979 /* call with brightness_mutex held! */
5980 static int tpacpi_brightness_get_raw(int *status)
5982 u8 lec = 0;
5984 switch (brightness_mode) {
5985 case TPACPI_BRGHT_MODE_UCMS_STEP:
5986 *status = tpacpi_brightness_nvram_get();
5987 return 0;
5988 case TPACPI_BRGHT_MODE_EC:
5989 case TPACPI_BRGHT_MODE_ECNVRAM:
5990 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5991 return -EIO;
5992 *status = lec;
5993 return 0;
5994 default:
5995 return -ENXIO;
5999 /* call with brightness_mutex held! */
6000 /* do NOT call with illegal backlight level value */
6001 static int tpacpi_brightness_set_ec(unsigned int value)
6003 u8 lec = 0;
6005 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6006 return -EIO;
6008 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6009 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6010 (value & TP_EC_BACKLIGHT_LVLMSK))))
6011 return -EIO;
6013 return 0;
6016 /* call with brightness_mutex held! */
6017 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6019 int cmos_cmd, inc;
6020 unsigned int current_value, i;
6022 current_value = tpacpi_brightness_nvram_get();
6024 if (value == current_value)
6025 return 0;
6027 cmos_cmd = (value > current_value) ?
6028 TP_CMOS_BRIGHTNESS_UP :
6029 TP_CMOS_BRIGHTNESS_DOWN;
6030 inc = (value > current_value) ? 1 : -1;
6032 for (i = current_value; i != value; i += inc)
6033 if (issue_thinkpad_cmos_command(cmos_cmd))
6034 return -EIO;
6036 return 0;
6039 /* May return EINTR which can always be mapped to ERESTARTSYS */
6040 static int brightness_set(unsigned int value)
6042 int res;
6044 if (value > bright_maxlvl || value < 0)
6045 return -EINVAL;
6047 vdbg_printk(TPACPI_DBG_BRGHT,
6048 "set backlight level to %d\n", value);
6050 res = mutex_lock_killable(&brightness_mutex);
6051 if (res < 0)
6052 return res;
6054 switch (brightness_mode) {
6055 case TPACPI_BRGHT_MODE_EC:
6056 case TPACPI_BRGHT_MODE_ECNVRAM:
6057 res = tpacpi_brightness_set_ec(value);
6058 break;
6059 case TPACPI_BRGHT_MODE_UCMS_STEP:
6060 res = tpacpi_brightness_set_ucmsstep(value);
6061 break;
6062 default:
6063 res = -ENXIO;
6066 mutex_unlock(&brightness_mutex);
6067 return res;
6070 /* sysfs backlight class ----------------------------------------------- */
6072 static int brightness_update_status(struct backlight_device *bd)
6074 unsigned int level =
6075 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6076 bd->props.power == FB_BLANK_UNBLANK) ?
6077 bd->props.brightness : 0;
6079 dbg_printk(TPACPI_DBG_BRGHT,
6080 "backlight: attempt to set level to %d\n",
6081 level);
6083 /* it is the backlight class's job (caller) to handle
6084 * EINTR and other errors properly */
6085 return brightness_set(level);
6088 static int brightness_get(struct backlight_device *bd)
6090 int status, res;
6092 res = mutex_lock_killable(&brightness_mutex);
6093 if (res < 0)
6094 return 0;
6096 res = tpacpi_brightness_get_raw(&status);
6098 mutex_unlock(&brightness_mutex);
6100 if (res < 0)
6101 return 0;
6103 return status & TP_EC_BACKLIGHT_LVLMSK;
6106 static void tpacpi_brightness_notify_change(void)
6108 backlight_force_update(ibm_backlight_device,
6109 BACKLIGHT_UPDATE_HOTKEY);
6112 static struct backlight_ops ibm_backlight_data = {
6113 .get_brightness = brightness_get,
6114 .update_status = brightness_update_status,
6117 /* --------------------------------------------------------------------- */
6120 * Call _BCL method of video device. On some ThinkPads this will
6121 * switch the firmware to the ACPI brightness control mode.
6124 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6126 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6127 union acpi_object *obj;
6128 int rc;
6130 if (ACPI_SUCCESS(acpi_evaluate_object(handle, "_BCL", NULL, &buffer))) {
6131 obj = (union acpi_object *)buffer.pointer;
6132 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6133 printk(TPACPI_ERR "Unknown _BCL data, "
6134 "please report this to %s\n", TPACPI_MAIL);
6135 rc = 0;
6136 } else {
6137 rc = obj->package.count;
6139 } else {
6140 return 0;
6143 kfree(buffer.pointer);
6144 return rc;
6149 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6151 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6153 acpi_handle video_device;
6154 int bcl_levels = 0;
6156 tpacpi_acpi_handle_locate("video", ACPI_VIDEO_HID, &video_device);
6157 if (video_device)
6158 bcl_levels = tpacpi_query_bcl_levels(video_device);
6160 tp_features.bright_acpimode = (bcl_levels > 0);
6162 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6166 * These are only useful for models that have only one possibility
6167 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6168 * these quirks.
6170 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6171 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6172 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6174 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6175 /* Models with ATI GPUs known to require ECNVRAM mode */
6176 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6178 /* Models with ATI GPUs that can use ECNVRAM */
6179 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6180 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6181 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6182 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6184 /* Models with Intel Extreme Graphics 2 */
6185 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6186 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6187 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6189 /* Models with Intel GMA900 */
6190 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6191 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6192 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6196 * Returns < 0 for error, otherwise sets tp_features.bright_*
6197 * and bright_maxlvl.
6199 static void __init tpacpi_detect_brightness_capabilities(void)
6201 unsigned int b;
6203 vdbg_printk(TPACPI_DBG_INIT,
6204 "detecting firmware brightness interface capabilities\n");
6206 /* we could run a quirks check here (same table used by
6207 * brightness_init) if needed */
6210 * We always attempt to detect acpi support, so as to switch
6211 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6212 * going to publish a backlight interface
6214 b = tpacpi_check_std_acpi_brightness_support();
6215 switch (b) {
6216 case 16:
6217 bright_maxlvl = 15;
6218 printk(TPACPI_INFO
6219 "detected a 16-level brightness capable ThinkPad\n");
6220 break;
6221 case 8:
6222 case 0:
6223 bright_maxlvl = 7;
6224 printk(TPACPI_INFO
6225 "detected a 8-level brightness capable ThinkPad\n");
6226 break;
6227 default:
6228 printk(TPACPI_ERR
6229 "Unsupported brightness interface, "
6230 "please contact %s\n", TPACPI_MAIL);
6231 tp_features.bright_unkfw = 1;
6232 bright_maxlvl = b - 1;
6236 static int __init brightness_init(struct ibm_init_struct *iibm)
6238 struct backlight_properties props;
6239 int b;
6240 unsigned long quirks;
6242 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6244 mutex_init(&brightness_mutex);
6246 quirks = tpacpi_check_quirks(brightness_quirk_table,
6247 ARRAY_SIZE(brightness_quirk_table));
6249 /* tpacpi_detect_brightness_capabilities() must have run already */
6251 /* if it is unknown, we don't handle it: it wouldn't be safe */
6252 if (tp_features.bright_unkfw)
6253 return 1;
6255 if (!brightness_enable) {
6256 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6257 "brightness support disabled by "
6258 "module parameter\n");
6259 return 1;
6262 if (acpi_video_backlight_support()) {
6263 if (brightness_enable > 1) {
6264 printk(TPACPI_INFO
6265 "Standard ACPI backlight interface "
6266 "available, not loading native one.\n");
6267 return 1;
6268 } else if (brightness_enable == 1) {
6269 printk(TPACPI_WARN
6270 "Cannot enable backlight brightness support, "
6271 "ACPI is already handling it. Refer to the "
6272 "acpi_backlight kernel parameter\n");
6273 return 1;
6275 } else if (tp_features.bright_acpimode && brightness_enable > 1) {
6276 printk(TPACPI_NOTICE
6277 "Standard ACPI backlight interface not "
6278 "available, thinkpad_acpi native "
6279 "brightness control enabled\n");
6283 * Check for module parameter bogosity, note that we
6284 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6285 * able to detect "unspecified"
6287 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6288 return -EINVAL;
6290 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6291 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6292 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6293 if (quirks & TPACPI_BRGHT_Q_EC)
6294 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6295 else
6296 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6298 dbg_printk(TPACPI_DBG_BRGHT,
6299 "driver auto-selected brightness_mode=%d\n",
6300 brightness_mode);
6303 /* Safety */
6304 if (!tpacpi_is_ibm() &&
6305 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6306 brightness_mode == TPACPI_BRGHT_MODE_EC))
6307 return -EINVAL;
6309 if (tpacpi_brightness_get_raw(&b) < 0)
6310 return 1;
6312 memset(&props, 0, sizeof(struct backlight_properties));
6313 props.max_brightness = bright_maxlvl;
6314 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6315 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6316 NULL, NULL,
6317 &ibm_backlight_data,
6318 &props);
6319 if (IS_ERR(ibm_backlight_device)) {
6320 int rc = PTR_ERR(ibm_backlight_device);
6321 ibm_backlight_device = NULL;
6322 printk(TPACPI_ERR "Could not register backlight device\n");
6323 return rc;
6325 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6326 "brightness is supported\n");
6328 if (quirks & TPACPI_BRGHT_Q_ASK) {
6329 printk(TPACPI_NOTICE
6330 "brightness: will use unverified default: "
6331 "brightness_mode=%d\n", brightness_mode);
6332 printk(TPACPI_NOTICE
6333 "brightness: please report to %s whether it works well "
6334 "or not on your ThinkPad\n", TPACPI_MAIL);
6337 /* Added by mistake in early 2007. Probably useless, but it could
6338 * be working around some unknown firmware problem where the value
6339 * read at startup doesn't match the real hardware state... so leave
6340 * it in place just in case */
6341 backlight_update_status(ibm_backlight_device);
6343 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6344 "brightness: registering brightness hotkeys "
6345 "as change notification\n");
6346 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6347 | TP_ACPI_HKEY_BRGHTUP_MASK
6348 | TP_ACPI_HKEY_BRGHTDWN_MASK);;
6349 return 0;
6352 static void brightness_suspend(pm_message_t state)
6354 tpacpi_brightness_checkpoint_nvram();
6357 static void brightness_shutdown(void)
6359 tpacpi_brightness_checkpoint_nvram();
6362 static void brightness_exit(void)
6364 if (ibm_backlight_device) {
6365 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6366 "calling backlight_device_unregister()\n");
6367 backlight_device_unregister(ibm_backlight_device);
6370 tpacpi_brightness_checkpoint_nvram();
6373 static int brightness_read(struct seq_file *m)
6375 int level;
6377 level = brightness_get(NULL);
6378 if (level < 0) {
6379 seq_printf(m, "level:\t\tunreadable\n");
6380 } else {
6381 seq_printf(m, "level:\t\t%d\n", level);
6382 seq_printf(m, "commands:\tup, down\n");
6383 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6384 bright_maxlvl);
6387 return 0;
6390 static int brightness_write(char *buf)
6392 int level;
6393 int rc;
6394 char *cmd;
6396 level = brightness_get(NULL);
6397 if (level < 0)
6398 return level;
6400 while ((cmd = next_cmd(&buf))) {
6401 if (strlencmp(cmd, "up") == 0) {
6402 if (level < bright_maxlvl)
6403 level++;
6404 } else if (strlencmp(cmd, "down") == 0) {
6405 if (level > 0)
6406 level--;
6407 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6408 level >= 0 && level <= bright_maxlvl) {
6409 /* new level set */
6410 } else
6411 return -EINVAL;
6414 tpacpi_disclose_usertask("procfs brightness",
6415 "set level to %d\n", level);
6418 * Now we know what the final level should be, so we try to set it.
6419 * Doing it this way makes the syscall restartable in case of EINTR
6421 rc = brightness_set(level);
6422 if (!rc && ibm_backlight_device)
6423 backlight_force_update(ibm_backlight_device,
6424 BACKLIGHT_UPDATE_SYSFS);
6425 return (rc == -EINTR)? -ERESTARTSYS : rc;
6428 static struct ibm_struct brightness_driver_data = {
6429 .name = "brightness",
6430 .read = brightness_read,
6431 .write = brightness_write,
6432 .exit = brightness_exit,
6433 .suspend = brightness_suspend,
6434 .shutdown = brightness_shutdown,
6437 /*************************************************************************
6438 * Volume subdriver
6442 * IBM ThinkPads have a simple volume controller with MUTE gating.
6443 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6445 * Since the *61 series (and probably also the later *60 series), Lenovo
6446 * ThinkPads only implement the MUTE gate.
6448 * EC register 0x30
6449 * Bit 6: MUTE (1 mutes sound)
6450 * Bit 3-0: Volume
6451 * Other bits should be zero as far as we know.
6453 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6454 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
6455 * such as bit 7 which is used to detect repeated presses of MUTE,
6456 * and we leave them unchanged.
6459 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6461 #define TPACPI_ALSA_DRVNAME "ThinkPad EC"
6462 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6463 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6465 static int alsa_index = ~((1 << (SNDRV_CARDS - 3)) - 1); /* last three slots */
6466 static char *alsa_id = "ThinkPadEC";
6467 static int alsa_enable = SNDRV_DEFAULT_ENABLE1;
6469 struct tpacpi_alsa_data {
6470 struct snd_card *card;
6471 struct snd_ctl_elem_id *ctl_mute_id;
6472 struct snd_ctl_elem_id *ctl_vol_id;
6475 static struct snd_card *alsa_card;
6477 enum {
6478 TP_EC_AUDIO = 0x30,
6480 /* TP_EC_AUDIO bits */
6481 TP_EC_AUDIO_MUTESW = 6,
6483 /* TP_EC_AUDIO bitmasks */
6484 TP_EC_AUDIO_LVL_MSK = 0x0F,
6485 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6487 /* Maximum volume */
6488 TP_EC_VOLUME_MAX = 14,
6491 enum tpacpi_volume_access_mode {
6492 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
6493 TPACPI_VOL_MODE_EC, /* Pure EC control */
6494 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
6495 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6496 TPACPI_VOL_MODE_MAX
6499 enum tpacpi_volume_capabilities {
6500 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
6501 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
6502 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
6503 TPACPI_VOL_CAP_MAX
6506 static enum tpacpi_volume_access_mode volume_mode =
6507 TPACPI_VOL_MODE_MAX;
6509 static enum tpacpi_volume_capabilities volume_capabilities;
6510 static int volume_control_allowed;
6513 * Used to syncronize writers to TP_EC_AUDIO and
6514 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6516 static struct mutex volume_mutex;
6518 static void tpacpi_volume_checkpoint_nvram(void)
6520 u8 lec = 0;
6521 u8 b_nvram;
6522 u8 ec_mask;
6524 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6525 return;
6526 if (!volume_control_allowed)
6527 return;
6529 vdbg_printk(TPACPI_DBG_MIXER,
6530 "trying to checkpoint mixer state to NVRAM...\n");
6532 if (tp_features.mixer_no_level_control)
6533 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6534 else
6535 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6537 if (mutex_lock_killable(&volume_mutex) < 0)
6538 return;
6540 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6541 goto unlock;
6542 lec &= ec_mask;
6543 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6545 if (lec != (b_nvram & ec_mask)) {
6546 /* NVRAM needs update */
6547 b_nvram &= ~ec_mask;
6548 b_nvram |= lec;
6549 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6550 dbg_printk(TPACPI_DBG_MIXER,
6551 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6552 (unsigned int) lec, (unsigned int) b_nvram);
6553 } else {
6554 vdbg_printk(TPACPI_DBG_MIXER,
6555 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6556 (unsigned int) lec, (unsigned int) b_nvram);
6559 unlock:
6560 mutex_unlock(&volume_mutex);
6563 static int volume_get_status_ec(u8 *status)
6565 u8 s;
6567 if (!acpi_ec_read(TP_EC_AUDIO, &s))
6568 return -EIO;
6570 *status = s;
6572 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6574 return 0;
6577 static int volume_get_status(u8 *status)
6579 return volume_get_status_ec(status);
6582 static int volume_set_status_ec(const u8 status)
6584 if (!acpi_ec_write(TP_EC_AUDIO, status))
6585 return -EIO;
6587 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6589 return 0;
6592 static int volume_set_status(const u8 status)
6594 return volume_set_status_ec(status);
6597 /* returns < 0 on error, 0 on no change, 1 on change */
6598 static int __volume_set_mute_ec(const bool mute)
6600 int rc;
6601 u8 s, n;
6603 if (mutex_lock_killable(&volume_mutex) < 0)
6604 return -EINTR;
6606 rc = volume_get_status_ec(&s);
6607 if (rc)
6608 goto unlock;
6610 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6611 s & ~TP_EC_AUDIO_MUTESW_MSK;
6613 if (n != s) {
6614 rc = volume_set_status_ec(n);
6615 if (!rc)
6616 rc = 1;
6619 unlock:
6620 mutex_unlock(&volume_mutex);
6621 return rc;
6624 static int volume_alsa_set_mute(const bool mute)
6626 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6627 (mute) ? "" : "un");
6628 return __volume_set_mute_ec(mute);
6631 static int volume_set_mute(const bool mute)
6633 int rc;
6635 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6636 (mute) ? "" : "un");
6638 rc = __volume_set_mute_ec(mute);
6639 return (rc < 0) ? rc : 0;
6642 /* returns < 0 on error, 0 on no change, 1 on change */
6643 static int __volume_set_volume_ec(const u8 vol)
6645 int rc;
6646 u8 s, n;
6648 if (vol > TP_EC_VOLUME_MAX)
6649 return -EINVAL;
6651 if (mutex_lock_killable(&volume_mutex) < 0)
6652 return -EINTR;
6654 rc = volume_get_status_ec(&s);
6655 if (rc)
6656 goto unlock;
6658 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6660 if (n != s) {
6661 rc = volume_set_status_ec(n);
6662 if (!rc)
6663 rc = 1;
6666 unlock:
6667 mutex_unlock(&volume_mutex);
6668 return rc;
6671 static int volume_alsa_set_volume(const u8 vol)
6673 dbg_printk(TPACPI_DBG_MIXER,
6674 "ALSA: trying to set volume level to %hu\n", vol);
6675 return __volume_set_volume_ec(vol);
6678 static void volume_alsa_notify_change(void)
6680 struct tpacpi_alsa_data *d;
6682 if (alsa_card && alsa_card->private_data) {
6683 d = alsa_card->private_data;
6684 if (d->ctl_mute_id)
6685 snd_ctl_notify(alsa_card,
6686 SNDRV_CTL_EVENT_MASK_VALUE,
6687 d->ctl_mute_id);
6688 if (d->ctl_vol_id)
6689 snd_ctl_notify(alsa_card,
6690 SNDRV_CTL_EVENT_MASK_VALUE,
6691 d->ctl_vol_id);
6695 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6696 struct snd_ctl_elem_info *uinfo)
6698 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6699 uinfo->count = 1;
6700 uinfo->value.integer.min = 0;
6701 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6702 return 0;
6705 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6706 struct snd_ctl_elem_value *ucontrol)
6708 u8 s;
6709 int rc;
6711 rc = volume_get_status(&s);
6712 if (rc < 0)
6713 return rc;
6715 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6716 return 0;
6719 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6720 struct snd_ctl_elem_value *ucontrol)
6722 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
6723 ucontrol->value.integer.value[0]);
6724 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6727 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
6729 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6730 struct snd_ctl_elem_value *ucontrol)
6732 u8 s;
6733 int rc;
6735 rc = volume_get_status(&s);
6736 if (rc < 0)
6737 return rc;
6739 ucontrol->value.integer.value[0] =
6740 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6741 return 0;
6744 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6745 struct snd_ctl_elem_value *ucontrol)
6747 tpacpi_disclose_usertask("ALSA", "%smute\n",
6748 ucontrol->value.integer.value[0] ?
6749 "un" : "");
6750 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6753 static struct snd_kcontrol_new volume_alsa_control_vol __devinitdata = {
6754 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6755 .name = "Console Playback Volume",
6756 .index = 0,
6757 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6758 .info = volume_alsa_vol_info,
6759 .get = volume_alsa_vol_get,
6762 static struct snd_kcontrol_new volume_alsa_control_mute __devinitdata = {
6763 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6764 .name = "Console Playback Switch",
6765 .index = 0,
6766 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6767 .info = volume_alsa_mute_info,
6768 .get = volume_alsa_mute_get,
6771 static void volume_suspend(pm_message_t state)
6773 tpacpi_volume_checkpoint_nvram();
6776 static void volume_resume(void)
6778 volume_alsa_notify_change();
6781 static void volume_shutdown(void)
6783 tpacpi_volume_checkpoint_nvram();
6786 static void volume_exit(void)
6788 if (alsa_card) {
6789 snd_card_free(alsa_card);
6790 alsa_card = NULL;
6793 tpacpi_volume_checkpoint_nvram();
6796 static int __init volume_create_alsa_mixer(void)
6798 struct snd_card *card;
6799 struct tpacpi_alsa_data *data;
6800 struct snd_kcontrol *ctl_vol;
6801 struct snd_kcontrol *ctl_mute;
6802 int rc;
6804 rc = snd_card_create(alsa_index, alsa_id, THIS_MODULE,
6805 sizeof(struct tpacpi_alsa_data), &card);
6806 if (rc < 0 || !card) {
6807 printk(TPACPI_ERR
6808 "Failed to create ALSA card structures: %d\n", rc);
6809 return 1;
6812 BUG_ON(!card->private_data);
6813 data = card->private_data;
6814 data->card = card;
6816 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6817 sizeof(card->driver));
6818 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6819 sizeof(card->shortname));
6820 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6821 (thinkpad_id.ec_version_str) ?
6822 thinkpad_id.ec_version_str : "(unknown)");
6823 snprintf(card->longname, sizeof(card->longname),
6824 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6825 (thinkpad_id.ec_version_str) ?
6826 thinkpad_id.ec_version_str : "unknown");
6828 if (volume_control_allowed) {
6829 volume_alsa_control_vol.put = volume_alsa_vol_put;
6830 volume_alsa_control_vol.access =
6831 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6833 volume_alsa_control_mute.put = volume_alsa_mute_put;
6834 volume_alsa_control_mute.access =
6835 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6838 if (!tp_features.mixer_no_level_control) {
6839 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6840 rc = snd_ctl_add(card, ctl_vol);
6841 if (rc < 0) {
6842 printk(TPACPI_ERR
6843 "Failed to create ALSA volume control: %d\n",
6844 rc);
6845 goto err_exit;
6847 data->ctl_vol_id = &ctl_vol->id;
6850 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6851 rc = snd_ctl_add(card, ctl_mute);
6852 if (rc < 0) {
6853 printk(TPACPI_ERR "Failed to create ALSA mute control: %d\n",
6854 rc);
6855 goto err_exit;
6857 data->ctl_mute_id = &ctl_mute->id;
6859 snd_card_set_dev(card, &tpacpi_pdev->dev);
6860 rc = snd_card_register(card);
6861 if (rc < 0) {
6862 printk(TPACPI_ERR "Failed to register ALSA card: %d\n", rc);
6863 goto err_exit;
6866 alsa_card = card;
6867 return 0;
6869 err_exit:
6870 snd_card_free(card);
6871 return 1;
6874 #define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
6875 #define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
6877 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6878 /* Whitelist volume level on all IBM by default */
6879 { .vendor = PCI_VENDOR_ID_IBM,
6880 .bios = TPACPI_MATCH_ANY,
6881 .ec = TPACPI_MATCH_ANY,
6882 .quirks = TPACPI_VOL_Q_LEVEL },
6884 /* Lenovo models with volume control (needs confirmation) */
6885 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6886 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6887 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6888 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6889 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6890 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6891 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6893 /* Whitelist mute-only on all Lenovo by default */
6894 { .vendor = PCI_VENDOR_ID_LENOVO,
6895 .bios = TPACPI_MATCH_ANY,
6896 .ec = TPACPI_MATCH_ANY,
6897 .quirks = TPACPI_VOL_Q_MUTEONLY }
6900 static int __init volume_init(struct ibm_init_struct *iibm)
6902 unsigned long quirks;
6903 int rc;
6905 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
6907 mutex_init(&volume_mutex);
6910 * Check for module parameter bogosity, note that we
6911 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
6912 * able to detect "unspecified"
6914 if (volume_mode > TPACPI_VOL_MODE_MAX)
6915 return -EINVAL;
6917 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
6918 printk(TPACPI_ERR
6919 "UCMS step volume mode not implemented, "
6920 "please contact %s\n", TPACPI_MAIL);
6921 return 1;
6924 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
6925 return -EINVAL;
6928 * The ALSA mixer is our primary interface.
6929 * When disabled, don't install the subdriver at all
6931 if (!alsa_enable) {
6932 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6933 "ALSA mixer disabled by parameter, "
6934 "not loading volume subdriver...\n");
6935 return 1;
6938 quirks = tpacpi_check_quirks(volume_quirk_table,
6939 ARRAY_SIZE(volume_quirk_table));
6941 switch (volume_capabilities) {
6942 case TPACPI_VOL_CAP_AUTO:
6943 if (quirks & TPACPI_VOL_Q_MUTEONLY)
6944 tp_features.mixer_no_level_control = 1;
6945 else if (quirks & TPACPI_VOL_Q_LEVEL)
6946 tp_features.mixer_no_level_control = 0;
6947 else
6948 return 1; /* no mixer */
6949 break;
6950 case TPACPI_VOL_CAP_VOLMUTE:
6951 tp_features.mixer_no_level_control = 0;
6952 break;
6953 case TPACPI_VOL_CAP_MUTEONLY:
6954 tp_features.mixer_no_level_control = 1;
6955 break;
6956 default:
6957 return 1;
6960 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
6961 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6962 "using user-supplied volume_capabilities=%d\n",
6963 volume_capabilities);
6965 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
6966 volume_mode == TPACPI_VOL_MODE_MAX) {
6967 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
6969 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6970 "driver auto-selected volume_mode=%d\n",
6971 volume_mode);
6972 } else {
6973 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6974 "using user-supplied volume_mode=%d\n",
6975 volume_mode);
6978 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6979 "mute is supported, volume control is %s\n",
6980 str_supported(!tp_features.mixer_no_level_control));
6982 rc = volume_create_alsa_mixer();
6983 if (rc) {
6984 printk(TPACPI_ERR
6985 "Could not create the ALSA mixer interface\n");
6986 return rc;
6989 printk(TPACPI_INFO
6990 "Console audio control enabled, mode: %s\n",
6991 (volume_control_allowed) ?
6992 "override (read/write)" :
6993 "monitor (read only)");
6995 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6996 "registering volume hotkeys as change notification\n");
6997 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6998 | TP_ACPI_HKEY_VOLUP_MASK
6999 | TP_ACPI_HKEY_VOLDWN_MASK
7000 | TP_ACPI_HKEY_MUTE_MASK);
7002 return 0;
7005 static int volume_read(struct seq_file *m)
7007 u8 status;
7009 if (volume_get_status(&status) < 0) {
7010 seq_printf(m, "level:\t\tunreadable\n");
7011 } else {
7012 if (tp_features.mixer_no_level_control)
7013 seq_printf(m, "level:\t\tunsupported\n");
7014 else
7015 seq_printf(m, "level:\t\t%d\n",
7016 status & TP_EC_AUDIO_LVL_MSK);
7018 seq_printf(m, "mute:\t\t%s\n",
7019 onoff(status, TP_EC_AUDIO_MUTESW));
7021 if (volume_control_allowed) {
7022 seq_printf(m, "commands:\tunmute, mute\n");
7023 if (!tp_features.mixer_no_level_control) {
7024 seq_printf(m,
7025 "commands:\tup, down\n");
7026 seq_printf(m,
7027 "commands:\tlevel <level>"
7028 " (<level> is 0-%d)\n",
7029 TP_EC_VOLUME_MAX);
7034 return 0;
7037 static int volume_write(char *buf)
7039 u8 s;
7040 u8 new_level, new_mute;
7041 int l;
7042 char *cmd;
7043 int rc;
7046 * We do allow volume control at driver startup, so that the
7047 * user can set initial state through the volume=... parameter hack.
7049 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7050 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7051 tp_warned.volume_ctrl_forbidden = 1;
7052 printk(TPACPI_NOTICE
7053 "Console audio control in monitor mode, "
7054 "changes are not allowed.\n");
7055 printk(TPACPI_NOTICE
7056 "Use the volume_control=1 module parameter "
7057 "to enable volume control\n");
7059 return -EPERM;
7062 rc = volume_get_status(&s);
7063 if (rc < 0)
7064 return rc;
7066 new_level = s & TP_EC_AUDIO_LVL_MSK;
7067 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7069 while ((cmd = next_cmd(&buf))) {
7070 if (!tp_features.mixer_no_level_control) {
7071 if (strlencmp(cmd, "up") == 0) {
7072 if (new_mute)
7073 new_mute = 0;
7074 else if (new_level < TP_EC_VOLUME_MAX)
7075 new_level++;
7076 continue;
7077 } else if (strlencmp(cmd, "down") == 0) {
7078 if (new_mute)
7079 new_mute = 0;
7080 else if (new_level > 0)
7081 new_level--;
7082 continue;
7083 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7084 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7085 new_level = l;
7086 continue;
7089 if (strlencmp(cmd, "mute") == 0)
7090 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7091 else if (strlencmp(cmd, "unmute") == 0)
7092 new_mute = 0;
7093 else
7094 return -EINVAL;
7097 if (tp_features.mixer_no_level_control) {
7098 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7099 new_mute ? "" : "un");
7100 rc = volume_set_mute(!!new_mute);
7101 } else {
7102 tpacpi_disclose_usertask("procfs volume",
7103 "%smute and set level to %d\n",
7104 new_mute ? "" : "un", new_level);
7105 rc = volume_set_status(new_mute | new_level);
7107 volume_alsa_notify_change();
7109 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7112 static struct ibm_struct volume_driver_data = {
7113 .name = "volume",
7114 .read = volume_read,
7115 .write = volume_write,
7116 .exit = volume_exit,
7117 .suspend = volume_suspend,
7118 .resume = volume_resume,
7119 .shutdown = volume_shutdown,
7122 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7124 #define alsa_card NULL
7126 static void inline volume_alsa_notify_change(void)
7130 static int __init volume_init(struct ibm_init_struct *iibm)
7132 printk(TPACPI_INFO
7133 "volume: disabled as there is no ALSA support in this kernel\n");
7135 return 1;
7138 static struct ibm_struct volume_driver_data = {
7139 .name = "volume",
7142 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7144 /*************************************************************************
7145 * Fan subdriver
7149 * FAN ACCESS MODES
7151 * TPACPI_FAN_RD_ACPI_GFAN:
7152 * ACPI GFAN method: returns fan level
7154 * see TPACPI_FAN_WR_ACPI_SFAN
7155 * EC 0x2f (HFSP) not available if GFAN exists
7157 * TPACPI_FAN_WR_ACPI_SFAN:
7158 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7160 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7161 * it for writing.
7163 * TPACPI_FAN_WR_TPEC:
7164 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7165 * Supported on almost all ThinkPads
7167 * Fan speed changes of any sort (including those caused by the
7168 * disengaged mode) are usually done slowly by the firmware as the
7169 * maximum amount of fan duty cycle change per second seems to be
7170 * limited.
7172 * Reading is not available if GFAN exists.
7173 * Writing is not available if SFAN exists.
7175 * Bits
7176 * 7 automatic mode engaged;
7177 * (default operation mode of the ThinkPad)
7178 * fan level is ignored in this mode.
7179 * 6 full speed mode (takes precedence over bit 7);
7180 * not available on all thinkpads. May disable
7181 * the tachometer while the fan controller ramps up
7182 * the speed (which can take up to a few *minutes*).
7183 * Speeds up fan to 100% duty-cycle, which is far above
7184 * the standard RPM levels. It is not impossible that
7185 * it could cause hardware damage.
7186 * 5-3 unused in some models. Extra bits for fan level
7187 * in others, but still useless as all values above
7188 * 7 map to the same speed as level 7 in these models.
7189 * 2-0 fan level (0..7 usually)
7190 * 0x00 = stop
7191 * 0x07 = max (set when temperatures critical)
7192 * Some ThinkPads may have other levels, see
7193 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7195 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7196 * boot. Apparently the EC does not intialize it, so unless ACPI DSDT
7197 * does so, its initial value is meaningless (0x07).
7199 * For firmware bugs, refer to:
7200 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7202 * ----
7204 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7205 * Main fan tachometer reading (in RPM)
7207 * This register is present on all ThinkPads with a new-style EC, and
7208 * it is known not to be present on the A21m/e, and T22, as there is
7209 * something else in offset 0x84 according to the ACPI DSDT. Other
7210 * ThinkPads from this same time period (and earlier) probably lack the
7211 * tachometer as well.
7213 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7214 * was never fixed by IBM to report the EC firmware version string
7215 * probably support the tachometer (like the early X models), so
7216 * detecting it is quite hard. We need more data to know for sure.
7218 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7219 * might result.
7221 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7222 * mode.
7224 * For firmware bugs, refer to:
7225 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7227 * ----
7229 * ThinkPad EC register 0x31 bit 0 (only on select models)
7231 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7232 * show the speed of the main fan. When bit 0 of EC register 0x31
7233 * is one, the tachometer registers show the speed of the auxiliary
7234 * fan.
7236 * Fan control seems to affect both fans, regardless of the state
7237 * of this bit.
7239 * So far, only the firmware for the X60/X61 non-tablet versions
7240 * seem to support this (firmware TP-7M).
7242 * TPACPI_FAN_WR_ACPI_FANS:
7243 * ThinkPad X31, X40, X41. Not available in the X60.
7245 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7246 * high speed. ACPI DSDT seems to map these three speeds to levels
7247 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7248 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7250 * The speeds are stored on handles
7251 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7253 * There are three default speed sets, accessible as handles:
7254 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7256 * ACPI DSDT switches which set is in use depending on various
7257 * factors.
7259 * TPACPI_FAN_WR_TPEC is also available and should be used to
7260 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7261 * but the ACPI tables just mention level 7.
7264 enum { /* Fan control constants */
7265 fan_status_offset = 0x2f, /* EC register 0x2f */
7266 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7267 * 0x84 must be read before 0x85 */
7268 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7269 bit 0 selects which fan is active */
7271 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
7272 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
7274 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
7277 enum fan_status_access_mode {
7278 TPACPI_FAN_NONE = 0, /* No fan status or control */
7279 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
7280 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7283 enum fan_control_access_mode {
7284 TPACPI_FAN_WR_NONE = 0, /* No fan control */
7285 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
7286 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
7287 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
7290 enum fan_control_commands {
7291 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
7292 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
7293 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
7294 * and also watchdog cmd */
7297 static int fan_control_allowed;
7299 static enum fan_status_access_mode fan_status_access_mode;
7300 static enum fan_control_access_mode fan_control_access_mode;
7301 static enum fan_control_commands fan_control_commands;
7303 static u8 fan_control_initial_status;
7304 static u8 fan_control_desired_level;
7305 static u8 fan_control_resume_level;
7306 static int fan_watchdog_maxinterval;
7308 static struct mutex fan_mutex;
7310 static void fan_watchdog_fire(struct work_struct *ignored);
7311 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7313 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
7314 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7315 "\\FSPD", /* 600e/x, 770e, 770x */
7316 ); /* all others */
7317 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7318 "JFNS", /* 770x-JL */
7319 ); /* all others */
7322 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7323 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7324 * be in auto mode (0x80).
7326 * This is corrected by any write to HFSP either by the driver, or
7327 * by the firmware.
7329 * We assume 0x07 really means auto mode while this quirk is active,
7330 * as this is far more likely than the ThinkPad being in level 7,
7331 * which is only used by the firmware during thermal emergencies.
7333 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7334 * TP-70 (T43, R52), which are known to be buggy.
7337 static void fan_quirk1_setup(void)
7339 if (fan_control_initial_status == 0x07) {
7340 printk(TPACPI_NOTICE
7341 "fan_init: initial fan status is unknown, "
7342 "assuming it is in auto mode\n");
7343 tp_features.fan_ctrl_status_undef = 1;
7347 static void fan_quirk1_handle(u8 *fan_status)
7349 if (unlikely(tp_features.fan_ctrl_status_undef)) {
7350 if (*fan_status != fan_control_initial_status) {
7351 /* something changed the HFSP regisnter since
7352 * driver init time, so it is not undefined
7353 * anymore */
7354 tp_features.fan_ctrl_status_undef = 0;
7355 } else {
7356 /* Return most likely status. In fact, it
7357 * might be the only possible status */
7358 *fan_status = TP_EC_FAN_AUTO;
7363 /* Select main fan on X60/X61, NOOP on others */
7364 static bool fan_select_fan1(void)
7366 if (tp_features.second_fan) {
7367 u8 val;
7369 if (ec_read(fan_select_offset, &val) < 0)
7370 return false;
7371 val &= 0xFEU;
7372 if (ec_write(fan_select_offset, val) < 0)
7373 return false;
7375 return true;
7378 /* Select secondary fan on X60/X61 */
7379 static bool fan_select_fan2(void)
7381 u8 val;
7383 if (!tp_features.second_fan)
7384 return false;
7386 if (ec_read(fan_select_offset, &val) < 0)
7387 return false;
7388 val |= 0x01U;
7389 if (ec_write(fan_select_offset, val) < 0)
7390 return false;
7392 return true;
7396 * Call with fan_mutex held
7398 static void fan_update_desired_level(u8 status)
7400 if ((status &
7401 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7402 if (status > 7)
7403 fan_control_desired_level = 7;
7404 else
7405 fan_control_desired_level = status;
7409 static int fan_get_status(u8 *status)
7411 u8 s;
7413 /* TODO:
7414 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7416 switch (fan_status_access_mode) {
7417 case TPACPI_FAN_RD_ACPI_GFAN:
7418 /* 570, 600e/x, 770e, 770x */
7420 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
7421 return -EIO;
7423 if (likely(status))
7424 *status = s & 0x07;
7426 break;
7428 case TPACPI_FAN_RD_TPEC:
7429 /* all except 570, 600e/x, 770e, 770x */
7430 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7431 return -EIO;
7433 if (likely(status)) {
7434 *status = s;
7435 fan_quirk1_handle(status);
7438 break;
7440 default:
7441 return -ENXIO;
7444 return 0;
7447 static int fan_get_status_safe(u8 *status)
7449 int rc;
7450 u8 s;
7452 if (mutex_lock_killable(&fan_mutex))
7453 return -ERESTARTSYS;
7454 rc = fan_get_status(&s);
7455 if (!rc)
7456 fan_update_desired_level(s);
7457 mutex_unlock(&fan_mutex);
7459 if (status)
7460 *status = s;
7462 return rc;
7465 static int fan_get_speed(unsigned int *speed)
7467 u8 hi, lo;
7469 switch (fan_status_access_mode) {
7470 case TPACPI_FAN_RD_TPEC:
7471 /* all except 570, 600e/x, 770e, 770x */
7472 if (unlikely(!fan_select_fan1()))
7473 return -EIO;
7474 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7475 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7476 return -EIO;
7478 if (likely(speed))
7479 *speed = (hi << 8) | lo;
7481 break;
7483 default:
7484 return -ENXIO;
7487 return 0;
7490 static int fan2_get_speed(unsigned int *speed)
7492 u8 hi, lo;
7493 bool rc;
7495 switch (fan_status_access_mode) {
7496 case TPACPI_FAN_RD_TPEC:
7497 /* all except 570, 600e/x, 770e, 770x */
7498 if (unlikely(!fan_select_fan2()))
7499 return -EIO;
7500 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7501 !acpi_ec_read(fan_rpm_offset + 1, &hi);
7502 fan_select_fan1(); /* play it safe */
7503 if (rc)
7504 return -EIO;
7506 if (likely(speed))
7507 *speed = (hi << 8) | lo;
7509 break;
7511 default:
7512 return -ENXIO;
7515 return 0;
7518 static int fan_set_level(int level)
7520 if (!fan_control_allowed)
7521 return -EPERM;
7523 switch (fan_control_access_mode) {
7524 case TPACPI_FAN_WR_ACPI_SFAN:
7525 if (level >= 0 && level <= 7) {
7526 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7527 return -EIO;
7528 } else
7529 return -EINVAL;
7530 break;
7532 case TPACPI_FAN_WR_ACPI_FANS:
7533 case TPACPI_FAN_WR_TPEC:
7534 if (!(level & TP_EC_FAN_AUTO) &&
7535 !(level & TP_EC_FAN_FULLSPEED) &&
7536 ((level < 0) || (level > 7)))
7537 return -EINVAL;
7539 /* safety net should the EC not support AUTO
7540 * or FULLSPEED mode bits and just ignore them */
7541 if (level & TP_EC_FAN_FULLSPEED)
7542 level |= 7; /* safety min speed 7 */
7543 else if (level & TP_EC_FAN_AUTO)
7544 level |= 4; /* safety min speed 4 */
7546 if (!acpi_ec_write(fan_status_offset, level))
7547 return -EIO;
7548 else
7549 tp_features.fan_ctrl_status_undef = 0;
7550 break;
7552 default:
7553 return -ENXIO;
7556 vdbg_printk(TPACPI_DBG_FAN,
7557 "fan control: set fan control register to 0x%02x\n", level);
7558 return 0;
7561 static int fan_set_level_safe(int level)
7563 int rc;
7565 if (!fan_control_allowed)
7566 return -EPERM;
7568 if (mutex_lock_killable(&fan_mutex))
7569 return -ERESTARTSYS;
7571 if (level == TPACPI_FAN_LAST_LEVEL)
7572 level = fan_control_desired_level;
7574 rc = fan_set_level(level);
7575 if (!rc)
7576 fan_update_desired_level(level);
7578 mutex_unlock(&fan_mutex);
7579 return rc;
7582 static int fan_set_enable(void)
7584 u8 s;
7585 int rc;
7587 if (!fan_control_allowed)
7588 return -EPERM;
7590 if (mutex_lock_killable(&fan_mutex))
7591 return -ERESTARTSYS;
7593 switch (fan_control_access_mode) {
7594 case TPACPI_FAN_WR_ACPI_FANS:
7595 case TPACPI_FAN_WR_TPEC:
7596 rc = fan_get_status(&s);
7597 if (rc < 0)
7598 break;
7600 /* Don't go out of emergency fan mode */
7601 if (s != 7) {
7602 s &= 0x07;
7603 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7606 if (!acpi_ec_write(fan_status_offset, s))
7607 rc = -EIO;
7608 else {
7609 tp_features.fan_ctrl_status_undef = 0;
7610 rc = 0;
7612 break;
7614 case TPACPI_FAN_WR_ACPI_SFAN:
7615 rc = fan_get_status(&s);
7616 if (rc < 0)
7617 break;
7619 s &= 0x07;
7621 /* Set fan to at least level 4 */
7622 s |= 4;
7624 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7625 rc = -EIO;
7626 else
7627 rc = 0;
7628 break;
7630 default:
7631 rc = -ENXIO;
7634 mutex_unlock(&fan_mutex);
7636 if (!rc)
7637 vdbg_printk(TPACPI_DBG_FAN,
7638 "fan control: set fan control register to 0x%02x\n",
7640 return rc;
7643 static int fan_set_disable(void)
7645 int rc;
7647 if (!fan_control_allowed)
7648 return -EPERM;
7650 if (mutex_lock_killable(&fan_mutex))
7651 return -ERESTARTSYS;
7653 rc = 0;
7654 switch (fan_control_access_mode) {
7655 case TPACPI_FAN_WR_ACPI_FANS:
7656 case TPACPI_FAN_WR_TPEC:
7657 if (!acpi_ec_write(fan_status_offset, 0x00))
7658 rc = -EIO;
7659 else {
7660 fan_control_desired_level = 0;
7661 tp_features.fan_ctrl_status_undef = 0;
7663 break;
7665 case TPACPI_FAN_WR_ACPI_SFAN:
7666 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7667 rc = -EIO;
7668 else
7669 fan_control_desired_level = 0;
7670 break;
7672 default:
7673 rc = -ENXIO;
7676 if (!rc)
7677 vdbg_printk(TPACPI_DBG_FAN,
7678 "fan control: set fan control register to 0\n");
7680 mutex_unlock(&fan_mutex);
7681 return rc;
7684 static int fan_set_speed(int speed)
7686 int rc;
7688 if (!fan_control_allowed)
7689 return -EPERM;
7691 if (mutex_lock_killable(&fan_mutex))
7692 return -ERESTARTSYS;
7694 rc = 0;
7695 switch (fan_control_access_mode) {
7696 case TPACPI_FAN_WR_ACPI_FANS:
7697 if (speed >= 0 && speed <= 65535) {
7698 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7699 speed, speed, speed))
7700 rc = -EIO;
7701 } else
7702 rc = -EINVAL;
7703 break;
7705 default:
7706 rc = -ENXIO;
7709 mutex_unlock(&fan_mutex);
7710 return rc;
7713 static void fan_watchdog_reset(void)
7715 static int fan_watchdog_active;
7717 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7718 return;
7720 if (fan_watchdog_active)
7721 cancel_delayed_work(&fan_watchdog_task);
7723 if (fan_watchdog_maxinterval > 0 &&
7724 tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7725 fan_watchdog_active = 1;
7726 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7727 msecs_to_jiffies(fan_watchdog_maxinterval
7728 * 1000))) {
7729 printk(TPACPI_ERR
7730 "failed to queue the fan watchdog, "
7731 "watchdog will not trigger\n");
7733 } else
7734 fan_watchdog_active = 0;
7737 static void fan_watchdog_fire(struct work_struct *ignored)
7739 int rc;
7741 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7742 return;
7744 printk(TPACPI_NOTICE "fan watchdog: enabling fan\n");
7745 rc = fan_set_enable();
7746 if (rc < 0) {
7747 printk(TPACPI_ERR "fan watchdog: error %d while enabling fan, "
7748 "will try again later...\n", -rc);
7749 /* reschedule for later */
7750 fan_watchdog_reset();
7755 * SYSFS fan layout: hwmon compatible (device)
7757 * pwm*_enable:
7758 * 0: "disengaged" mode
7759 * 1: manual mode
7760 * 2: native EC "auto" mode (recommended, hardware default)
7762 * pwm*: set speed in manual mode, ignored otherwise.
7763 * 0 is level 0; 255 is level 7. Intermediate points done with linear
7764 * interpolation.
7766 * fan*_input: tachometer reading, RPM
7769 * SYSFS fan layout: extensions
7771 * fan_watchdog (driver):
7772 * fan watchdog interval in seconds, 0 disables (default), max 120
7775 /* sysfs fan pwm1_enable ----------------------------------------------- */
7776 static ssize_t fan_pwm1_enable_show(struct device *dev,
7777 struct device_attribute *attr,
7778 char *buf)
7780 int res, mode;
7781 u8 status;
7783 res = fan_get_status_safe(&status);
7784 if (res)
7785 return res;
7787 if (status & TP_EC_FAN_FULLSPEED) {
7788 mode = 0;
7789 } else if (status & TP_EC_FAN_AUTO) {
7790 mode = 2;
7791 } else
7792 mode = 1;
7794 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7797 static ssize_t fan_pwm1_enable_store(struct device *dev,
7798 struct device_attribute *attr,
7799 const char *buf, size_t count)
7801 unsigned long t;
7802 int res, level;
7804 if (parse_strtoul(buf, 2, &t))
7805 return -EINVAL;
7807 tpacpi_disclose_usertask("hwmon pwm1_enable",
7808 "set fan mode to %lu\n", t);
7810 switch (t) {
7811 case 0:
7812 level = TP_EC_FAN_FULLSPEED;
7813 break;
7814 case 1:
7815 level = TPACPI_FAN_LAST_LEVEL;
7816 break;
7817 case 2:
7818 level = TP_EC_FAN_AUTO;
7819 break;
7820 case 3:
7821 /* reserved for software-controlled auto mode */
7822 return -ENOSYS;
7823 default:
7824 return -EINVAL;
7827 res = fan_set_level_safe(level);
7828 if (res == -ENXIO)
7829 return -EINVAL;
7830 else if (res < 0)
7831 return res;
7833 fan_watchdog_reset();
7835 return count;
7838 static struct device_attribute dev_attr_fan_pwm1_enable =
7839 __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7840 fan_pwm1_enable_show, fan_pwm1_enable_store);
7842 /* sysfs fan pwm1 ------------------------------------------------------ */
7843 static ssize_t fan_pwm1_show(struct device *dev,
7844 struct device_attribute *attr,
7845 char *buf)
7847 int res;
7848 u8 status;
7850 res = fan_get_status_safe(&status);
7851 if (res)
7852 return res;
7854 if ((status &
7855 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7856 status = fan_control_desired_level;
7858 if (status > 7)
7859 status = 7;
7861 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7864 static ssize_t fan_pwm1_store(struct device *dev,
7865 struct device_attribute *attr,
7866 const char *buf, size_t count)
7868 unsigned long s;
7869 int rc;
7870 u8 status, newlevel;
7872 if (parse_strtoul(buf, 255, &s))
7873 return -EINVAL;
7875 tpacpi_disclose_usertask("hwmon pwm1",
7876 "set fan speed to %lu\n", s);
7878 /* scale down from 0-255 to 0-7 */
7879 newlevel = (s >> 5) & 0x07;
7881 if (mutex_lock_killable(&fan_mutex))
7882 return -ERESTARTSYS;
7884 rc = fan_get_status(&status);
7885 if (!rc && (status &
7886 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7887 rc = fan_set_level(newlevel);
7888 if (rc == -ENXIO)
7889 rc = -EINVAL;
7890 else if (!rc) {
7891 fan_update_desired_level(newlevel);
7892 fan_watchdog_reset();
7896 mutex_unlock(&fan_mutex);
7897 return (rc)? rc : count;
7900 static struct device_attribute dev_attr_fan_pwm1 =
7901 __ATTR(pwm1, S_IWUSR | S_IRUGO,
7902 fan_pwm1_show, fan_pwm1_store);
7904 /* sysfs fan fan1_input ------------------------------------------------ */
7905 static ssize_t fan_fan1_input_show(struct device *dev,
7906 struct device_attribute *attr,
7907 char *buf)
7909 int res;
7910 unsigned int speed;
7912 res = fan_get_speed(&speed);
7913 if (res < 0)
7914 return res;
7916 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7919 static struct device_attribute dev_attr_fan_fan1_input =
7920 __ATTR(fan1_input, S_IRUGO,
7921 fan_fan1_input_show, NULL);
7923 /* sysfs fan fan2_input ------------------------------------------------ */
7924 static ssize_t fan_fan2_input_show(struct device *dev,
7925 struct device_attribute *attr,
7926 char *buf)
7928 int res;
7929 unsigned int speed;
7931 res = fan2_get_speed(&speed);
7932 if (res < 0)
7933 return res;
7935 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7938 static struct device_attribute dev_attr_fan_fan2_input =
7939 __ATTR(fan2_input, S_IRUGO,
7940 fan_fan2_input_show, NULL);
7942 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7943 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7944 char *buf)
7946 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7949 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7950 const char *buf, size_t count)
7952 unsigned long t;
7954 if (parse_strtoul(buf, 120, &t))
7955 return -EINVAL;
7957 if (!fan_control_allowed)
7958 return -EPERM;
7960 fan_watchdog_maxinterval = t;
7961 fan_watchdog_reset();
7963 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7965 return count;
7968 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7969 fan_fan_watchdog_show, fan_fan_watchdog_store);
7971 /* --------------------------------------------------------------------- */
7972 static struct attribute *fan_attributes[] = {
7973 &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7974 &dev_attr_fan_fan1_input.attr,
7975 NULL, /* for fan2_input */
7976 NULL
7979 static const struct attribute_group fan_attr_group = {
7980 .attrs = fan_attributes,
7983 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
7984 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
7986 #define TPACPI_FAN_QI(__id1, __id2, __quirks) \
7987 { .vendor = PCI_VENDOR_ID_IBM, \
7988 .bios = TPACPI_MATCH_ANY, \
7989 .ec = TPID(__id1, __id2), \
7990 .quirks = __quirks }
7992 #define TPACPI_FAN_QL(__id1, __id2, __quirks) \
7993 { .vendor = PCI_VENDOR_ID_LENOVO, \
7994 .bios = TPACPI_MATCH_ANY, \
7995 .ec = TPID(__id1, __id2), \
7996 .quirks = __quirks }
7998 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
7999 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
8000 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
8001 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
8002 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
8003 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
8006 #undef TPACPI_FAN_QL
8007 #undef TPACPI_FAN_QI
8009 static int __init fan_init(struct ibm_init_struct *iibm)
8011 int rc;
8012 unsigned long quirks;
8014 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8015 "initializing fan subdriver\n");
8017 mutex_init(&fan_mutex);
8018 fan_status_access_mode = TPACPI_FAN_NONE;
8019 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8020 fan_control_commands = 0;
8021 fan_watchdog_maxinterval = 0;
8022 tp_features.fan_ctrl_status_undef = 0;
8023 tp_features.second_fan = 0;
8024 fan_control_desired_level = 7;
8026 if (tpacpi_is_ibm()) {
8027 TPACPI_ACPIHANDLE_INIT(fans);
8028 TPACPI_ACPIHANDLE_INIT(gfan);
8029 TPACPI_ACPIHANDLE_INIT(sfan);
8032 quirks = tpacpi_check_quirks(fan_quirk_table,
8033 ARRAY_SIZE(fan_quirk_table));
8035 if (gfan_handle) {
8036 /* 570, 600e/x, 770e, 770x */
8037 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8038 } else {
8039 /* all other ThinkPads: note that even old-style
8040 * ThinkPad ECs supports the fan control register */
8041 if (likely(acpi_ec_read(fan_status_offset,
8042 &fan_control_initial_status))) {
8043 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8044 if (quirks & TPACPI_FAN_Q1)
8045 fan_quirk1_setup();
8046 if (quirks & TPACPI_FAN_2FAN) {
8047 tp_features.second_fan = 1;
8048 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8049 "secondary fan support enabled\n");
8051 } else {
8052 printk(TPACPI_ERR
8053 "ThinkPad ACPI EC access misbehaving, "
8054 "fan status and control unavailable\n");
8055 return 1;
8059 if (sfan_handle) {
8060 /* 570, 770x-JL */
8061 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8062 fan_control_commands |=
8063 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8064 } else {
8065 if (!gfan_handle) {
8066 /* gfan without sfan means no fan control */
8067 /* all other models implement TP EC 0x2f control */
8069 if (fans_handle) {
8070 /* X31, X40, X41 */
8071 fan_control_access_mode =
8072 TPACPI_FAN_WR_ACPI_FANS;
8073 fan_control_commands |=
8074 TPACPI_FAN_CMD_SPEED |
8075 TPACPI_FAN_CMD_LEVEL |
8076 TPACPI_FAN_CMD_ENABLE;
8077 } else {
8078 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8079 fan_control_commands |=
8080 TPACPI_FAN_CMD_LEVEL |
8081 TPACPI_FAN_CMD_ENABLE;
8086 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8087 "fan is %s, modes %d, %d\n",
8088 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8089 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8090 fan_status_access_mode, fan_control_access_mode);
8092 /* fan control master switch */
8093 if (!fan_control_allowed) {
8094 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8095 fan_control_commands = 0;
8096 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8097 "fan control features disabled by parameter\n");
8100 /* update fan_control_desired_level */
8101 if (fan_status_access_mode != TPACPI_FAN_NONE)
8102 fan_get_status_safe(NULL);
8104 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8105 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8106 if (tp_features.second_fan) {
8107 /* attach second fan tachometer */
8108 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8109 &dev_attr_fan_fan2_input.attr;
8111 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8112 &fan_attr_group);
8113 if (rc < 0)
8114 return rc;
8116 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8117 &driver_attr_fan_watchdog);
8118 if (rc < 0) {
8119 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8120 &fan_attr_group);
8121 return rc;
8123 return 0;
8124 } else
8125 return 1;
8128 static void fan_exit(void)
8130 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8131 "cancelling any pending fan watchdog tasks\n");
8133 /* FIXME: can we really do this unconditionally? */
8134 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8135 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8136 &driver_attr_fan_watchdog);
8138 cancel_delayed_work(&fan_watchdog_task);
8139 flush_workqueue(tpacpi_wq);
8142 static void fan_suspend(pm_message_t state)
8144 int rc;
8146 if (!fan_control_allowed)
8147 return;
8149 /* Store fan status in cache */
8150 fan_control_resume_level = 0;
8151 rc = fan_get_status_safe(&fan_control_resume_level);
8152 if (rc < 0)
8153 printk(TPACPI_NOTICE
8154 "failed to read fan level for later "
8155 "restore during resume: %d\n", rc);
8157 /* if it is undefined, don't attempt to restore it.
8158 * KEEP THIS LAST */
8159 if (tp_features.fan_ctrl_status_undef)
8160 fan_control_resume_level = 0;
8163 static void fan_resume(void)
8165 u8 current_level = 7;
8166 bool do_set = false;
8167 int rc;
8169 /* DSDT *always* updates status on resume */
8170 tp_features.fan_ctrl_status_undef = 0;
8172 if (!fan_control_allowed ||
8173 !fan_control_resume_level ||
8174 (fan_get_status_safe(&current_level) < 0))
8175 return;
8177 switch (fan_control_access_mode) {
8178 case TPACPI_FAN_WR_ACPI_SFAN:
8179 /* never decrease fan level */
8180 do_set = (fan_control_resume_level > current_level);
8181 break;
8182 case TPACPI_FAN_WR_ACPI_FANS:
8183 case TPACPI_FAN_WR_TPEC:
8184 /* never decrease fan level, scale is:
8185 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8187 * We expect the firmware to set either 7 or AUTO, but we
8188 * handle FULLSPEED out of paranoia.
8190 * So, we can safely only restore FULLSPEED or 7, anything
8191 * else could slow the fan. Restoring AUTO is useless, at
8192 * best that's exactly what the DSDT already set (it is the
8193 * slower it uses).
8195 * Always keep in mind that the DSDT *will* have set the
8196 * fans to what the vendor supposes is the best level. We
8197 * muck with it only to speed the fan up.
8199 if (fan_control_resume_level != 7 &&
8200 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8201 return;
8202 else
8203 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8204 (current_level != fan_control_resume_level);
8205 break;
8206 default:
8207 return;
8209 if (do_set) {
8210 printk(TPACPI_NOTICE
8211 "restoring fan level to 0x%02x\n",
8212 fan_control_resume_level);
8213 rc = fan_set_level_safe(fan_control_resume_level);
8214 if (rc < 0)
8215 printk(TPACPI_NOTICE
8216 "failed to restore fan level: %d\n", rc);
8220 static int fan_read(struct seq_file *m)
8222 int rc;
8223 u8 status;
8224 unsigned int speed = 0;
8226 switch (fan_status_access_mode) {
8227 case TPACPI_FAN_RD_ACPI_GFAN:
8228 /* 570, 600e/x, 770e, 770x */
8229 rc = fan_get_status_safe(&status);
8230 if (rc < 0)
8231 return rc;
8233 seq_printf(m, "status:\t\t%s\n"
8234 "level:\t\t%d\n",
8235 (status != 0) ? "enabled" : "disabled", status);
8236 break;
8238 case TPACPI_FAN_RD_TPEC:
8239 /* all except 570, 600e/x, 770e, 770x */
8240 rc = fan_get_status_safe(&status);
8241 if (rc < 0)
8242 return rc;
8244 seq_printf(m, "status:\t\t%s\n",
8245 (status != 0) ? "enabled" : "disabled");
8247 rc = fan_get_speed(&speed);
8248 if (rc < 0)
8249 return rc;
8251 seq_printf(m, "speed:\t\t%d\n", speed);
8253 if (status & TP_EC_FAN_FULLSPEED)
8254 /* Disengaged mode takes precedence */
8255 seq_printf(m, "level:\t\tdisengaged\n");
8256 else if (status & TP_EC_FAN_AUTO)
8257 seq_printf(m, "level:\t\tauto\n");
8258 else
8259 seq_printf(m, "level:\t\t%d\n", status);
8260 break;
8262 case TPACPI_FAN_NONE:
8263 default:
8264 seq_printf(m, "status:\t\tnot supported\n");
8267 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8268 seq_printf(m, "commands:\tlevel <level>");
8270 switch (fan_control_access_mode) {
8271 case TPACPI_FAN_WR_ACPI_SFAN:
8272 seq_printf(m, " (<level> is 0-7)\n");
8273 break;
8275 default:
8276 seq_printf(m, " (<level> is 0-7, "
8277 "auto, disengaged, full-speed)\n");
8278 break;
8282 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8283 seq_printf(m, "commands:\tenable, disable\n"
8284 "commands:\twatchdog <timeout> (<timeout> "
8285 "is 0 (off), 1-120 (seconds))\n");
8287 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8288 seq_printf(m, "commands:\tspeed <speed>"
8289 " (<speed> is 0-65535)\n");
8291 return 0;
8294 static int fan_write_cmd_level(const char *cmd, int *rc)
8296 int level;
8298 if (strlencmp(cmd, "level auto") == 0)
8299 level = TP_EC_FAN_AUTO;
8300 else if ((strlencmp(cmd, "level disengaged") == 0) |
8301 (strlencmp(cmd, "level full-speed") == 0))
8302 level = TP_EC_FAN_FULLSPEED;
8303 else if (sscanf(cmd, "level %d", &level) != 1)
8304 return 0;
8306 *rc = fan_set_level_safe(level);
8307 if (*rc == -ENXIO)
8308 printk(TPACPI_ERR "level command accepted for unsupported "
8309 "access mode %d", fan_control_access_mode);
8310 else if (!*rc)
8311 tpacpi_disclose_usertask("procfs fan",
8312 "set level to %d\n", level);
8314 return 1;
8317 static int fan_write_cmd_enable(const char *cmd, int *rc)
8319 if (strlencmp(cmd, "enable") != 0)
8320 return 0;
8322 *rc = fan_set_enable();
8323 if (*rc == -ENXIO)
8324 printk(TPACPI_ERR "enable command accepted for unsupported "
8325 "access mode %d", fan_control_access_mode);
8326 else if (!*rc)
8327 tpacpi_disclose_usertask("procfs fan", "enable\n");
8329 return 1;
8332 static int fan_write_cmd_disable(const char *cmd, int *rc)
8334 if (strlencmp(cmd, "disable") != 0)
8335 return 0;
8337 *rc = fan_set_disable();
8338 if (*rc == -ENXIO)
8339 printk(TPACPI_ERR "disable command accepted for unsupported "
8340 "access mode %d", fan_control_access_mode);
8341 else if (!*rc)
8342 tpacpi_disclose_usertask("procfs fan", "disable\n");
8344 return 1;
8347 static int fan_write_cmd_speed(const char *cmd, int *rc)
8349 int speed;
8351 /* TODO:
8352 * Support speed <low> <medium> <high> ? */
8354 if (sscanf(cmd, "speed %d", &speed) != 1)
8355 return 0;
8357 *rc = fan_set_speed(speed);
8358 if (*rc == -ENXIO)
8359 printk(TPACPI_ERR "speed command accepted for unsupported "
8360 "access mode %d", fan_control_access_mode);
8361 else if (!*rc)
8362 tpacpi_disclose_usertask("procfs fan",
8363 "set speed to %d\n", speed);
8365 return 1;
8368 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8370 int interval;
8372 if (sscanf(cmd, "watchdog %d", &interval) != 1)
8373 return 0;
8375 if (interval < 0 || interval > 120)
8376 *rc = -EINVAL;
8377 else {
8378 fan_watchdog_maxinterval = interval;
8379 tpacpi_disclose_usertask("procfs fan",
8380 "set watchdog timer to %d\n",
8381 interval);
8384 return 1;
8387 static int fan_write(char *buf)
8389 char *cmd;
8390 int rc = 0;
8392 while (!rc && (cmd = next_cmd(&buf))) {
8393 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8394 fan_write_cmd_level(cmd, &rc)) &&
8395 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8396 (fan_write_cmd_enable(cmd, &rc) ||
8397 fan_write_cmd_disable(cmd, &rc) ||
8398 fan_write_cmd_watchdog(cmd, &rc))) &&
8399 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8400 fan_write_cmd_speed(cmd, &rc))
8402 rc = -EINVAL;
8403 else if (!rc)
8404 fan_watchdog_reset();
8407 return rc;
8410 static struct ibm_struct fan_driver_data = {
8411 .name = "fan",
8412 .read = fan_read,
8413 .write = fan_write,
8414 .exit = fan_exit,
8415 .suspend = fan_suspend,
8416 .resume = fan_resume,
8419 /****************************************************************************
8420 ****************************************************************************
8422 * Infrastructure
8424 ****************************************************************************
8425 ****************************************************************************/
8428 * HKEY event callout for other subdrivers go here
8429 * (yes, it is ugly, but it is quick, safe, and gets the job done
8431 static void tpacpi_driver_event(const unsigned int hkey_event)
8433 if (ibm_backlight_device) {
8434 switch (hkey_event) {
8435 case TP_HKEY_EV_BRGHT_UP:
8436 case TP_HKEY_EV_BRGHT_DOWN:
8437 tpacpi_brightness_notify_change();
8440 if (alsa_card) {
8441 switch (hkey_event) {
8442 case TP_HKEY_EV_VOL_UP:
8443 case TP_HKEY_EV_VOL_DOWN:
8444 case TP_HKEY_EV_VOL_MUTE:
8445 volume_alsa_notify_change();
8450 static void hotkey_driver_event(const unsigned int scancode)
8452 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8455 /* sysfs name ---------------------------------------------------------- */
8456 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8457 struct device_attribute *attr,
8458 char *buf)
8460 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8463 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8464 __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8466 /* --------------------------------------------------------------------- */
8468 /* /proc support */
8469 static struct proc_dir_entry *proc_dir;
8472 * Module and infrastructure proble, init and exit handling
8475 static int force_load;
8477 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
8478 static const char * __init str_supported(int is_supported)
8480 static char text_unsupported[] __initdata = "not supported";
8482 return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8484 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8486 static void ibm_exit(struct ibm_struct *ibm)
8488 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8490 list_del_init(&ibm->all_drivers);
8492 if (ibm->flags.acpi_notify_installed) {
8493 dbg_printk(TPACPI_DBG_EXIT,
8494 "%s: acpi_remove_notify_handler\n", ibm->name);
8495 BUG_ON(!ibm->acpi);
8496 acpi_remove_notify_handler(*ibm->acpi->handle,
8497 ibm->acpi->type,
8498 dispatch_acpi_notify);
8499 ibm->flags.acpi_notify_installed = 0;
8502 if (ibm->flags.proc_created) {
8503 dbg_printk(TPACPI_DBG_EXIT,
8504 "%s: remove_proc_entry\n", ibm->name);
8505 remove_proc_entry(ibm->name, proc_dir);
8506 ibm->flags.proc_created = 0;
8509 if (ibm->flags.acpi_driver_registered) {
8510 dbg_printk(TPACPI_DBG_EXIT,
8511 "%s: acpi_bus_unregister_driver\n", ibm->name);
8512 BUG_ON(!ibm->acpi);
8513 acpi_bus_unregister_driver(ibm->acpi->driver);
8514 kfree(ibm->acpi->driver);
8515 ibm->acpi->driver = NULL;
8516 ibm->flags.acpi_driver_registered = 0;
8519 if (ibm->flags.init_called && ibm->exit) {
8520 ibm->exit();
8521 ibm->flags.init_called = 0;
8524 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8527 static int __init ibm_init(struct ibm_init_struct *iibm)
8529 int ret;
8530 struct ibm_struct *ibm = iibm->data;
8531 struct proc_dir_entry *entry;
8533 BUG_ON(ibm == NULL);
8535 INIT_LIST_HEAD(&ibm->all_drivers);
8537 if (ibm->flags.experimental && !experimental)
8538 return 0;
8540 dbg_printk(TPACPI_DBG_INIT,
8541 "probing for %s\n", ibm->name);
8543 if (iibm->init) {
8544 ret = iibm->init(iibm);
8545 if (ret > 0)
8546 return 0; /* probe failed */
8547 if (ret)
8548 return ret;
8550 ibm->flags.init_called = 1;
8553 if (ibm->acpi) {
8554 if (ibm->acpi->hid) {
8555 ret = register_tpacpi_subdriver(ibm);
8556 if (ret)
8557 goto err_out;
8560 if (ibm->acpi->notify) {
8561 ret = setup_acpi_notify(ibm);
8562 if (ret == -ENODEV) {
8563 printk(TPACPI_NOTICE "disabling subdriver %s\n",
8564 ibm->name);
8565 ret = 0;
8566 goto err_out;
8568 if (ret < 0)
8569 goto err_out;
8573 dbg_printk(TPACPI_DBG_INIT,
8574 "%s installed\n", ibm->name);
8576 if (ibm->read) {
8577 mode_t mode = iibm->base_procfs_mode;
8579 if (!mode)
8580 mode = S_IRUGO;
8581 if (ibm->write)
8582 mode |= S_IWUSR;
8583 entry = proc_create_data(ibm->name, mode, proc_dir,
8584 &dispatch_proc_fops, ibm);
8585 if (!entry) {
8586 printk(TPACPI_ERR "unable to create proc entry %s\n",
8587 ibm->name);
8588 ret = -ENODEV;
8589 goto err_out;
8591 ibm->flags.proc_created = 1;
8594 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8596 return 0;
8598 err_out:
8599 dbg_printk(TPACPI_DBG_INIT,
8600 "%s: at error exit path with result %d\n",
8601 ibm->name, ret);
8603 ibm_exit(ibm);
8604 return (ret < 0)? ret : 0;
8607 /* Probing */
8609 static bool __pure __init tpacpi_is_fw_digit(const char c)
8611 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8614 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8615 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8616 const char t)
8618 return s && strlen(s) >= 8 &&
8619 tpacpi_is_fw_digit(s[0]) &&
8620 tpacpi_is_fw_digit(s[1]) &&
8621 s[2] == t && s[3] == 'T' &&
8622 tpacpi_is_fw_digit(s[4]) &&
8623 tpacpi_is_fw_digit(s[5]) &&
8624 s[6] == 'W' && s[7] == 'W';
8627 /* returns 0 - probe ok, or < 0 - probe error.
8628 * Probe ok doesn't mean thinkpad found.
8629 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8630 static int __must_check __init get_thinkpad_model_data(
8631 struct thinkpad_id_data *tp)
8633 const struct dmi_device *dev = NULL;
8634 char ec_fw_string[18];
8635 char const *s;
8637 if (!tp)
8638 return -EINVAL;
8640 memset(tp, 0, sizeof(*tp));
8642 if (dmi_name_in_vendors("IBM"))
8643 tp->vendor = PCI_VENDOR_ID_IBM;
8644 else if (dmi_name_in_vendors("LENOVO"))
8645 tp->vendor = PCI_VENDOR_ID_LENOVO;
8646 else
8647 return 0;
8649 s = dmi_get_system_info(DMI_BIOS_VERSION);
8650 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8651 if (s && !tp->bios_version_str)
8652 return -ENOMEM;
8654 /* Really ancient ThinkPad 240X will fail this, which is fine */
8655 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
8656 return 0;
8658 tp->bios_model = tp->bios_version_str[0]
8659 | (tp->bios_version_str[1] << 8);
8660 tp->bios_release = (tp->bios_version_str[4] << 8)
8661 | tp->bios_version_str[5];
8664 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8665 * X32 or newer, all Z series; Some models must have an
8666 * up-to-date BIOS or they will not be detected.
8668 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8670 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8671 if (sscanf(dev->name,
8672 "IBM ThinkPad Embedded Controller -[%17c",
8673 ec_fw_string) == 1) {
8674 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8675 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8677 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8678 if (!tp->ec_version_str)
8679 return -ENOMEM;
8681 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8682 tp->ec_model = ec_fw_string[0]
8683 | (ec_fw_string[1] << 8);
8684 tp->ec_release = (ec_fw_string[4] << 8)
8685 | ec_fw_string[5];
8686 } else {
8687 printk(TPACPI_NOTICE
8688 "ThinkPad firmware release %s "
8689 "doesn't match the known patterns\n",
8690 ec_fw_string);
8691 printk(TPACPI_NOTICE
8692 "please report this to %s\n",
8693 TPACPI_MAIL);
8695 break;
8699 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8700 if (s && !strnicmp(s, "ThinkPad", 8)) {
8701 tp->model_str = kstrdup(s, GFP_KERNEL);
8702 if (!tp->model_str)
8703 return -ENOMEM;
8706 s = dmi_get_system_info(DMI_PRODUCT_NAME);
8707 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8708 if (s && !tp->nummodel_str)
8709 return -ENOMEM;
8711 return 0;
8714 static int __init probe_for_thinkpad(void)
8716 int is_thinkpad;
8718 if (acpi_disabled)
8719 return -ENODEV;
8721 /* It would be dangerous to run the driver in this case */
8722 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8723 return -ENODEV;
8726 * Non-ancient models have better DMI tagging, but very old models
8727 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
8729 is_thinkpad = (thinkpad_id.model_str != NULL) ||
8730 (thinkpad_id.ec_model != 0) ||
8731 tpacpi_is_fw_known();
8733 /* The EC handler is required */
8734 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
8735 if (!ec_handle) {
8736 if (is_thinkpad)
8737 printk(TPACPI_ERR
8738 "Not yet supported ThinkPad detected!\n");
8739 return -ENODEV;
8742 if (!is_thinkpad && !force_load)
8743 return -ENODEV;
8745 return 0;
8748 static void __init thinkpad_acpi_init_banner(void)
8750 printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
8751 printk(TPACPI_INFO "%s\n", TPACPI_URL);
8753 printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
8754 (thinkpad_id.bios_version_str) ?
8755 thinkpad_id.bios_version_str : "unknown",
8756 (thinkpad_id.ec_version_str) ?
8757 thinkpad_id.ec_version_str : "unknown");
8759 BUG_ON(!thinkpad_id.vendor);
8761 if (thinkpad_id.model_str)
8762 printk(TPACPI_INFO "%s %s, model %s\n",
8763 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
8764 "IBM" : ((thinkpad_id.vendor ==
8765 PCI_VENDOR_ID_LENOVO) ?
8766 "Lenovo" : "Unknown vendor"),
8767 thinkpad_id.model_str,
8768 (thinkpad_id.nummodel_str) ?
8769 thinkpad_id.nummodel_str : "unknown");
8772 /* Module init, exit, parameters */
8774 static struct ibm_init_struct ibms_init[] __initdata = {
8776 .data = &thinkpad_acpi_driver_data,
8779 .init = hotkey_init,
8780 .data = &hotkey_driver_data,
8783 .init = bluetooth_init,
8784 .data = &bluetooth_driver_data,
8787 .init = wan_init,
8788 .data = &wan_driver_data,
8791 .init = uwb_init,
8792 .data = &uwb_driver_data,
8794 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8796 .init = video_init,
8797 .base_procfs_mode = S_IRUSR,
8798 .data = &video_driver_data,
8800 #endif
8802 .init = light_init,
8803 .data = &light_driver_data,
8806 .init = cmos_init,
8807 .data = &cmos_driver_data,
8810 .init = led_init,
8811 .data = &led_driver_data,
8814 .init = beep_init,
8815 .data = &beep_driver_data,
8818 .init = thermal_init,
8819 .data = &thermal_driver_data,
8822 .init = brightness_init,
8823 .data = &brightness_driver_data,
8826 .init = volume_init,
8827 .data = &volume_driver_data,
8830 .init = fan_init,
8831 .data = &fan_driver_data,
8835 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8837 unsigned int i;
8838 struct ibm_struct *ibm;
8840 if (!kp || !kp->name || !val)
8841 return -EINVAL;
8843 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8844 ibm = ibms_init[i].data;
8845 WARN_ON(ibm == NULL);
8847 if (!ibm || !ibm->name)
8848 continue;
8850 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8851 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8852 return -ENOSPC;
8853 strcpy(ibms_init[i].param, val);
8854 strcat(ibms_init[i].param, ",");
8855 return 0;
8859 return -EINVAL;
8862 module_param(experimental, int, 0444);
8863 MODULE_PARM_DESC(experimental,
8864 "Enables experimental features when non-zero");
8866 module_param_named(debug, dbg_level, uint, 0);
8867 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8869 module_param(force_load, bool, 0444);
8870 MODULE_PARM_DESC(force_load,
8871 "Attempts to load the driver even on a "
8872 "mis-identified ThinkPad when true");
8874 module_param_named(fan_control, fan_control_allowed, bool, 0444);
8875 MODULE_PARM_DESC(fan_control,
8876 "Enables setting fan parameters features when true");
8878 module_param_named(brightness_mode, brightness_mode, uint, 0444);
8879 MODULE_PARM_DESC(brightness_mode,
8880 "Selects brightness control strategy: "
8881 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8883 module_param(brightness_enable, uint, 0444);
8884 MODULE_PARM_DESC(brightness_enable,
8885 "Enables backlight control when 1, disables when 0");
8887 module_param(hotkey_report_mode, uint, 0444);
8888 MODULE_PARM_DESC(hotkey_report_mode,
8889 "used for backwards compatibility with userspace, "
8890 "see documentation");
8892 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8893 module_param_named(volume_mode, volume_mode, uint, 0444);
8894 MODULE_PARM_DESC(volume_mode,
8895 "Selects volume control strategy: "
8896 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8898 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8899 MODULE_PARM_DESC(volume_capabilities,
8900 "Selects the mixer capabilites: "
8901 "0=auto, 1=volume and mute, 2=mute only");
8903 module_param_named(volume_control, volume_control_allowed, bool, 0444);
8904 MODULE_PARM_DESC(volume_control,
8905 "Enables software override for the console audio "
8906 "control when true");
8908 /* ALSA module API parameters */
8909 module_param_named(index, alsa_index, int, 0444);
8910 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8911 module_param_named(id, alsa_id, charp, 0444);
8912 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8913 module_param_named(enable, alsa_enable, bool, 0444);
8914 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8915 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8917 #define TPACPI_PARAM(feature) \
8918 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8919 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8920 "at module load, see documentation")
8922 TPACPI_PARAM(hotkey);
8923 TPACPI_PARAM(bluetooth);
8924 TPACPI_PARAM(video);
8925 TPACPI_PARAM(light);
8926 TPACPI_PARAM(cmos);
8927 TPACPI_PARAM(led);
8928 TPACPI_PARAM(beep);
8929 TPACPI_PARAM(brightness);
8930 TPACPI_PARAM(volume);
8931 TPACPI_PARAM(fan);
8933 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8934 module_param(dbg_wlswemul, uint, 0444);
8935 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8936 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8937 MODULE_PARM_DESC(wlsw_state,
8938 "Initial state of the emulated WLSW switch");
8940 module_param(dbg_bluetoothemul, uint, 0444);
8941 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8942 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8943 MODULE_PARM_DESC(bluetooth_state,
8944 "Initial state of the emulated bluetooth switch");
8946 module_param(dbg_wwanemul, uint, 0444);
8947 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8948 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8949 MODULE_PARM_DESC(wwan_state,
8950 "Initial state of the emulated WWAN switch");
8952 module_param(dbg_uwbemul, uint, 0444);
8953 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8954 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8955 MODULE_PARM_DESC(uwb_state,
8956 "Initial state of the emulated UWB switch");
8957 #endif
8959 static void thinkpad_acpi_module_exit(void)
8961 struct ibm_struct *ibm, *itmp;
8963 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8965 list_for_each_entry_safe_reverse(ibm, itmp,
8966 &tpacpi_all_drivers,
8967 all_drivers) {
8968 ibm_exit(ibm);
8971 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8973 if (tpacpi_inputdev) {
8974 if (tp_features.input_device_registered)
8975 input_unregister_device(tpacpi_inputdev);
8976 else
8977 input_free_device(tpacpi_inputdev);
8980 if (tpacpi_hwmon)
8981 hwmon_device_unregister(tpacpi_hwmon);
8983 if (tp_features.sensors_pdev_attrs_registered)
8984 device_remove_file(&tpacpi_sensors_pdev->dev,
8985 &dev_attr_thinkpad_acpi_pdev_name);
8986 if (tpacpi_sensors_pdev)
8987 platform_device_unregister(tpacpi_sensors_pdev);
8988 if (tpacpi_pdev)
8989 platform_device_unregister(tpacpi_pdev);
8991 if (tp_features.sensors_pdrv_attrs_registered)
8992 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8993 if (tp_features.platform_drv_attrs_registered)
8994 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8996 if (tp_features.sensors_pdrv_registered)
8997 platform_driver_unregister(&tpacpi_hwmon_pdriver);
8999 if (tp_features.platform_drv_registered)
9000 platform_driver_unregister(&tpacpi_pdriver);
9002 if (proc_dir)
9003 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
9005 if (tpacpi_wq)
9006 destroy_workqueue(tpacpi_wq);
9008 kfree(thinkpad_id.bios_version_str);
9009 kfree(thinkpad_id.ec_version_str);
9010 kfree(thinkpad_id.model_str);
9014 static int __init thinkpad_acpi_module_init(void)
9016 int ret, i;
9018 tpacpi_lifecycle = TPACPI_LIFE_INIT;
9020 /* Parameter checking */
9021 if (hotkey_report_mode > 2)
9022 return -EINVAL;
9024 /* Driver-level probe */
9026 ret = get_thinkpad_model_data(&thinkpad_id);
9027 if (ret) {
9028 printk(TPACPI_ERR
9029 "unable to get DMI data: %d\n", ret);
9030 thinkpad_acpi_module_exit();
9031 return ret;
9033 ret = probe_for_thinkpad();
9034 if (ret) {
9035 thinkpad_acpi_module_exit();
9036 return ret;
9039 /* Driver initialization */
9041 thinkpad_acpi_init_banner();
9042 tpacpi_check_outdated_fw();
9044 TPACPI_ACPIHANDLE_INIT(ecrd);
9045 TPACPI_ACPIHANDLE_INIT(ecwr);
9047 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9048 if (!tpacpi_wq) {
9049 thinkpad_acpi_module_exit();
9050 return -ENOMEM;
9053 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9054 if (!proc_dir) {
9055 printk(TPACPI_ERR
9056 "unable to create proc dir " TPACPI_PROC_DIR);
9057 thinkpad_acpi_module_exit();
9058 return -ENODEV;
9061 ret = platform_driver_register(&tpacpi_pdriver);
9062 if (ret) {
9063 printk(TPACPI_ERR
9064 "unable to register main platform driver\n");
9065 thinkpad_acpi_module_exit();
9066 return ret;
9068 tp_features.platform_drv_registered = 1;
9070 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9071 if (ret) {
9072 printk(TPACPI_ERR
9073 "unable to register hwmon platform driver\n");
9074 thinkpad_acpi_module_exit();
9075 return ret;
9077 tp_features.sensors_pdrv_registered = 1;
9079 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9080 if (!ret) {
9081 tp_features.platform_drv_attrs_registered = 1;
9082 ret = tpacpi_create_driver_attributes(
9083 &tpacpi_hwmon_pdriver.driver);
9085 if (ret) {
9086 printk(TPACPI_ERR
9087 "unable to create sysfs driver attributes\n");
9088 thinkpad_acpi_module_exit();
9089 return ret;
9091 tp_features.sensors_pdrv_attrs_registered = 1;
9094 /* Device initialization */
9095 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9096 NULL, 0);
9097 if (IS_ERR(tpacpi_pdev)) {
9098 ret = PTR_ERR(tpacpi_pdev);
9099 tpacpi_pdev = NULL;
9100 printk(TPACPI_ERR "unable to register platform device\n");
9101 thinkpad_acpi_module_exit();
9102 return ret;
9104 tpacpi_sensors_pdev = platform_device_register_simple(
9105 TPACPI_HWMON_DRVR_NAME,
9106 -1, NULL, 0);
9107 if (IS_ERR(tpacpi_sensors_pdev)) {
9108 ret = PTR_ERR(tpacpi_sensors_pdev);
9109 tpacpi_sensors_pdev = NULL;
9110 printk(TPACPI_ERR
9111 "unable to register hwmon platform device\n");
9112 thinkpad_acpi_module_exit();
9113 return ret;
9115 ret = device_create_file(&tpacpi_sensors_pdev->dev,
9116 &dev_attr_thinkpad_acpi_pdev_name);
9117 if (ret) {
9118 printk(TPACPI_ERR
9119 "unable to create sysfs hwmon device attributes\n");
9120 thinkpad_acpi_module_exit();
9121 return ret;
9123 tp_features.sensors_pdev_attrs_registered = 1;
9124 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9125 if (IS_ERR(tpacpi_hwmon)) {
9126 ret = PTR_ERR(tpacpi_hwmon);
9127 tpacpi_hwmon = NULL;
9128 printk(TPACPI_ERR "unable to register hwmon device\n");
9129 thinkpad_acpi_module_exit();
9130 return ret;
9132 mutex_init(&tpacpi_inputdev_send_mutex);
9133 tpacpi_inputdev = input_allocate_device();
9134 if (!tpacpi_inputdev) {
9135 printk(TPACPI_ERR "unable to allocate input device\n");
9136 thinkpad_acpi_module_exit();
9137 return -ENOMEM;
9138 } else {
9139 /* Prepare input device, but don't register */
9140 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9141 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9142 tpacpi_inputdev->id.bustype = BUS_HOST;
9143 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9144 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9145 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9146 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9149 /* Init subdriver dependencies */
9150 tpacpi_detect_brightness_capabilities();
9152 /* Init subdrivers */
9153 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9154 ret = ibm_init(&ibms_init[i]);
9155 if (ret >= 0 && *ibms_init[i].param)
9156 ret = ibms_init[i].data->write(ibms_init[i].param);
9157 if (ret < 0) {
9158 thinkpad_acpi_module_exit();
9159 return ret;
9163 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9165 ret = input_register_device(tpacpi_inputdev);
9166 if (ret < 0) {
9167 printk(TPACPI_ERR "unable to register input device\n");
9168 thinkpad_acpi_module_exit();
9169 return ret;
9170 } else {
9171 tp_features.input_device_registered = 1;
9174 return 0;
9177 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9180 * This will autoload the driver in almost every ThinkPad
9181 * in widespread use.
9183 * Only _VERY_ old models, like the 240, 240x and 570 lack
9184 * the HKEY event interface.
9186 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9189 * DMI matching for module autoloading
9191 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9192 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9194 * Only models listed in thinkwiki will be supported, so add yours
9195 * if it is not there yet.
9197 #define IBM_BIOS_MODULE_ALIAS(__type) \
9198 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9200 /* Ancient thinkpad BIOSes have to be identified by
9201 * BIOS type or model number, and there are far less
9202 * BIOS types than model numbers... */
9203 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
9205 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9206 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9207 MODULE_DESCRIPTION(TPACPI_DESC);
9208 MODULE_VERSION(TPACPI_VERSION);
9209 MODULE_LICENSE("GPL");
9211 module_init(thinkpad_acpi_module_init);
9212 module_exit(thinkpad_acpi_module_exit);