ACPI: thinkpad-acpi: add development version tag
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / platform / x86 / thinkpad_acpi.c
blob6c682b3739edf641e16c85c00878786376b8a73e
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-20100516"
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,
1916 enum { /* Keys/events available through NVRAM polling */
1917 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1918 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1921 enum { /* Positions of some of the keys in hotkey masks */
1922 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1923 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1924 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1925 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1926 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1927 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1928 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1929 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1930 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1931 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1932 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1935 enum { /* NVRAM to ACPI HKEY group map */
1936 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1937 TP_ACPI_HKEY_ZOOM_MASK |
1938 TP_ACPI_HKEY_DISPSWTCH_MASK |
1939 TP_ACPI_HKEY_HIBERNATE_MASK,
1940 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1941 TP_ACPI_HKEY_BRGHTDWN_MASK,
1942 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1943 TP_ACPI_HKEY_VOLDWN_MASK |
1944 TP_ACPI_HKEY_MUTE_MASK,
1947 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1948 struct tp_nvram_state {
1949 u16 thinkpad_toggle:1;
1950 u16 zoom_toggle:1;
1951 u16 display_toggle:1;
1952 u16 thinklight_toggle:1;
1953 u16 hibernate_toggle:1;
1954 u16 displayexp_toggle:1;
1955 u16 display_state:1;
1956 u16 brightness_toggle:1;
1957 u16 volume_toggle:1;
1958 u16 mute:1;
1960 u8 brightness_level;
1961 u8 volume_level;
1964 /* kthread for the hotkey poller */
1965 static struct task_struct *tpacpi_hotkey_task;
1967 /* Acquired while the poller kthread is running, use to sync start/stop */
1968 static struct mutex hotkey_thread_mutex;
1971 * Acquire mutex to write poller control variables as an
1972 * atomic block.
1974 * Increment hotkey_config_change when changing them if you
1975 * want the kthread to forget old state.
1977 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1979 static struct mutex hotkey_thread_data_mutex;
1980 static unsigned int hotkey_config_change;
1983 * hotkey poller control variables
1985 * Must be atomic or readers will also need to acquire mutex
1987 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1988 * should be used only when the changes need to be taken as
1989 * a block, OR when one needs to force the kthread to forget
1990 * old state.
1992 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
1993 static unsigned int hotkey_poll_freq = 10; /* Hz */
1995 #define HOTKEY_CONFIG_CRITICAL_START \
1996 do { \
1997 mutex_lock(&hotkey_thread_data_mutex); \
1998 hotkey_config_change++; \
1999 } while (0);
2000 #define HOTKEY_CONFIG_CRITICAL_END \
2001 mutex_unlock(&hotkey_thread_data_mutex);
2003 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2005 #define hotkey_source_mask 0U
2006 #define HOTKEY_CONFIG_CRITICAL_START
2007 #define HOTKEY_CONFIG_CRITICAL_END
2009 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2011 static struct mutex hotkey_mutex;
2013 static enum { /* Reasons for waking up */
2014 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2015 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2016 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2017 } hotkey_wakeup_reason;
2019 static int hotkey_autosleep_ack;
2021 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2022 static u32 hotkey_all_mask; /* all events supported in fw */
2023 static u32 hotkey_reserved_mask; /* events better left disabled */
2024 static u32 hotkey_driver_mask; /* events needed by the driver */
2025 static u32 hotkey_user_mask; /* events visible to userspace */
2026 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2028 static unsigned int hotkey_report_mode;
2030 static u16 *hotkey_keycode_map;
2032 static struct attribute_set *hotkey_dev_attributes;
2034 static void tpacpi_driver_event(const unsigned int hkey_event);
2035 static void hotkey_driver_event(const unsigned int scancode);
2036 static void hotkey_poll_setup(const bool may_warn);
2038 /* HKEY.MHKG() return bits */
2039 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2041 static int hotkey_get_wlsw(void)
2043 int status;
2045 if (!tp_features.hotkey_wlsw)
2046 return -ENODEV;
2048 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2049 if (dbg_wlswemul)
2050 return (tpacpi_wlsw_emulstate) ?
2051 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2052 #endif
2054 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2055 return -EIO;
2057 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2060 static int hotkey_get_tablet_mode(int *status)
2062 int s;
2064 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2065 return -EIO;
2067 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2068 return 0;
2072 * Reads current event mask from firmware, and updates
2073 * hotkey_acpi_mask accordingly. Also resets any bits
2074 * from hotkey_user_mask that are unavailable to be
2075 * delivered (shadow requirement of the userspace ABI).
2077 * Call with hotkey_mutex held
2079 static int hotkey_mask_get(void)
2081 if (tp_features.hotkey_mask) {
2082 u32 m = 0;
2084 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2085 return -EIO;
2087 hotkey_acpi_mask = m;
2088 } else {
2089 /* no mask support doesn't mean no event support... */
2090 hotkey_acpi_mask = hotkey_all_mask;
2093 /* sync userspace-visible mask */
2094 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2096 return 0;
2099 void static hotkey_mask_warn_incomplete_mask(void)
2101 /* log only what the user can fix... */
2102 const u32 wantedmask = hotkey_driver_mask &
2103 ~(hotkey_acpi_mask | hotkey_source_mask) &
2104 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2106 if (wantedmask)
2107 printk(TPACPI_NOTICE
2108 "required events 0x%08x not enabled!\n",
2109 wantedmask);
2113 * Set the firmware mask when supported
2115 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2117 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2119 * Call with hotkey_mutex held
2121 static int hotkey_mask_set(u32 mask)
2123 int i;
2124 int rc = 0;
2126 const u32 fwmask = mask & ~hotkey_source_mask;
2128 if (tp_features.hotkey_mask) {
2129 for (i = 0; i < 32; i++) {
2130 if (!acpi_evalf(hkey_handle,
2131 NULL, "MHKM", "vdd", i + 1,
2132 !!(mask & (1 << i)))) {
2133 rc = -EIO;
2134 break;
2140 * We *must* make an inconditional call to hotkey_mask_get to
2141 * refresh hotkey_acpi_mask and update hotkey_user_mask
2143 * Take the opportunity to also log when we cannot _enable_
2144 * a given event.
2146 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2147 printk(TPACPI_NOTICE
2148 "asked for hotkey mask 0x%08x, but "
2149 "firmware forced it to 0x%08x\n",
2150 fwmask, hotkey_acpi_mask);
2153 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2154 hotkey_mask_warn_incomplete_mask();
2156 return rc;
2160 * Sets hotkey_user_mask and tries to set the firmware mask
2162 * Call with hotkey_mutex held
2164 static int hotkey_user_mask_set(const u32 mask)
2166 int rc;
2168 /* Give people a chance to notice they are doing something that
2169 * is bound to go boom on their users sooner or later */
2170 if (!tp_warned.hotkey_mask_ff &&
2171 (mask == 0xffff || mask == 0xffffff ||
2172 mask == 0xffffffff)) {
2173 tp_warned.hotkey_mask_ff = 1;
2174 printk(TPACPI_NOTICE
2175 "setting the hotkey mask to 0x%08x is likely "
2176 "not the best way to go about it\n", mask);
2177 printk(TPACPI_NOTICE
2178 "please consider using the driver defaults, "
2179 "and refer to up-to-date thinkpad-acpi "
2180 "documentation\n");
2183 /* Try to enable what the user asked for, plus whatever we need.
2184 * this syncs everything but won't enable bits in hotkey_user_mask */
2185 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2187 /* Enable the available bits in hotkey_user_mask */
2188 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2190 return rc;
2194 * Sets the driver hotkey mask.
2196 * Can be called even if the hotkey subdriver is inactive
2198 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2200 int rc;
2202 /* Do the right thing if hotkey_init has not been called yet */
2203 if (!tp_features.hotkey) {
2204 hotkey_driver_mask = mask;
2205 return 0;
2208 mutex_lock(&hotkey_mutex);
2210 HOTKEY_CONFIG_CRITICAL_START
2211 hotkey_driver_mask = mask;
2212 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2213 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2214 #endif
2215 HOTKEY_CONFIG_CRITICAL_END
2217 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2218 ~hotkey_source_mask);
2219 hotkey_poll_setup(true);
2221 mutex_unlock(&hotkey_mutex);
2223 return rc;
2226 static int hotkey_status_get(int *status)
2228 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2229 return -EIO;
2231 return 0;
2234 static int hotkey_status_set(bool enable)
2236 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2237 return -EIO;
2239 return 0;
2242 static void tpacpi_input_send_tabletsw(void)
2244 int state;
2246 if (tp_features.hotkey_tablet &&
2247 !hotkey_get_tablet_mode(&state)) {
2248 mutex_lock(&tpacpi_inputdev_send_mutex);
2250 input_report_switch(tpacpi_inputdev,
2251 SW_TABLET_MODE, !!state);
2252 input_sync(tpacpi_inputdev);
2254 mutex_unlock(&tpacpi_inputdev_send_mutex);
2258 /* Do NOT call without validating scancode first */
2259 static void tpacpi_input_send_key(const unsigned int scancode)
2261 const unsigned int keycode = hotkey_keycode_map[scancode];
2263 if (keycode != KEY_RESERVED) {
2264 mutex_lock(&tpacpi_inputdev_send_mutex);
2266 input_report_key(tpacpi_inputdev, keycode, 1);
2267 if (keycode == KEY_UNKNOWN)
2268 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2269 scancode);
2270 input_sync(tpacpi_inputdev);
2272 input_report_key(tpacpi_inputdev, keycode, 0);
2273 if (keycode == KEY_UNKNOWN)
2274 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2275 scancode);
2276 input_sync(tpacpi_inputdev);
2278 mutex_unlock(&tpacpi_inputdev_send_mutex);
2282 /* Do NOT call without validating scancode first */
2283 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2285 hotkey_driver_event(scancode);
2286 if (hotkey_user_mask & (1 << scancode))
2287 tpacpi_input_send_key(scancode);
2290 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2291 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2293 /* Do NOT call without validating scancode first */
2294 static void tpacpi_hotkey_send_key(unsigned int scancode)
2296 tpacpi_input_send_key_masked(scancode);
2297 if (hotkey_report_mode < 2) {
2298 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2299 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2303 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2305 u8 d;
2307 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2308 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2309 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2310 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2311 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2312 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2314 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2315 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2316 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2318 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2319 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2320 n->displayexp_toggle =
2321 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2323 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2324 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2325 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2326 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2327 n->brightness_toggle =
2328 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2330 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2331 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2332 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2333 >> TP_NVRAM_POS_LEVEL_VOLUME;
2334 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2335 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2339 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2340 struct tp_nvram_state *newn,
2341 const u32 event_mask)
2344 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2345 do { \
2346 if ((event_mask & (1 << __scancode)) && \
2347 oldn->__member != newn->__member) \
2348 tpacpi_hotkey_send_key(__scancode); \
2349 } while (0)
2351 #define TPACPI_MAY_SEND_KEY(__scancode) \
2352 do { \
2353 if (event_mask & (1 << __scancode)) \
2354 tpacpi_hotkey_send_key(__scancode); \
2355 } while (0)
2357 void issue_volchange(const unsigned int oldvol,
2358 const unsigned int newvol)
2360 unsigned int i = oldvol;
2362 while (i > newvol) {
2363 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2364 i--;
2366 while (i < newvol) {
2367 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2368 i++;
2372 void issue_brightnesschange(const unsigned int oldbrt,
2373 const unsigned int newbrt)
2375 unsigned int i = oldbrt;
2377 while (i > newbrt) {
2378 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2379 i--;
2381 while (i < newbrt) {
2382 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2383 i++;
2387 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2388 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2389 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2390 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2392 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2394 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2397 * Handle volume
2399 * This code is supposed to duplicate the IBM firmware behaviour:
2400 * - Pressing MUTE issues mute hotkey message, even when already mute
2401 * - Pressing Volume up/down issues volume up/down hotkey messages,
2402 * even when already at maximum or minumum volume
2403 * - The act of unmuting issues volume up/down notification,
2404 * depending which key was used to unmute
2406 * We are constrained to what the NVRAM can tell us, which is not much
2407 * and certainly not enough if more than one volume hotkey was pressed
2408 * since the last poll cycle.
2410 * Just to make our life interesting, some newer Lenovo ThinkPads have
2411 * bugs in the BIOS and may fail to update volume_toggle properly.
2413 if (newn->mute) {
2414 /* muted */
2415 if (!oldn->mute ||
2416 oldn->volume_toggle != newn->volume_toggle ||
2417 oldn->volume_level != newn->volume_level) {
2418 /* recently muted, or repeated mute keypress, or
2419 * multiple presses ending in mute */
2420 issue_volchange(oldn->volume_level, newn->volume_level);
2421 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2423 } else {
2424 /* unmute */
2425 if (oldn->mute) {
2426 /* recently unmuted, issue 'unmute' keypress */
2427 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2429 if (oldn->volume_level != newn->volume_level) {
2430 issue_volchange(oldn->volume_level, newn->volume_level);
2431 } else if (oldn->volume_toggle != newn->volume_toggle) {
2432 /* repeated vol up/down keypress at end of scale ? */
2433 if (newn->volume_level == 0)
2434 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2435 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2436 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2440 /* handle brightness */
2441 if (oldn->brightness_level != newn->brightness_level) {
2442 issue_brightnesschange(oldn->brightness_level,
2443 newn->brightness_level);
2444 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2445 /* repeated key presses that didn't change state */
2446 if (newn->brightness_level == 0)
2447 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2448 else if (newn->brightness_level >= bright_maxlvl
2449 && !tp_features.bright_unkfw)
2450 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2453 #undef TPACPI_COMPARE_KEY
2454 #undef TPACPI_MAY_SEND_KEY
2458 * Polling driver
2460 * We track all events in hotkey_source_mask all the time, since
2461 * most of them are edge-based. We only issue those requested by
2462 * hotkey_user_mask or hotkey_driver_mask, though.
2464 static int hotkey_kthread(void *data)
2466 struct tp_nvram_state s[2];
2467 u32 poll_mask, event_mask;
2468 unsigned int si, so;
2469 unsigned long t;
2470 unsigned int change_detector, must_reset;
2471 unsigned int poll_freq;
2473 mutex_lock(&hotkey_thread_mutex);
2475 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2476 goto exit;
2478 set_freezable();
2480 so = 0;
2481 si = 1;
2482 t = 0;
2484 /* Initial state for compares */
2485 mutex_lock(&hotkey_thread_data_mutex);
2486 change_detector = hotkey_config_change;
2487 poll_mask = hotkey_source_mask;
2488 event_mask = hotkey_source_mask &
2489 (hotkey_driver_mask | hotkey_user_mask);
2490 poll_freq = hotkey_poll_freq;
2491 mutex_unlock(&hotkey_thread_data_mutex);
2492 hotkey_read_nvram(&s[so], poll_mask);
2494 while (!kthread_should_stop()) {
2495 if (t == 0) {
2496 if (likely(poll_freq))
2497 t = 1000/poll_freq;
2498 else
2499 t = 100; /* should never happen... */
2501 t = msleep_interruptible(t);
2502 if (unlikely(kthread_should_stop()))
2503 break;
2504 must_reset = try_to_freeze();
2505 if (t > 0 && !must_reset)
2506 continue;
2508 mutex_lock(&hotkey_thread_data_mutex);
2509 if (must_reset || hotkey_config_change != change_detector) {
2510 /* forget old state on thaw or config change */
2511 si = so;
2512 t = 0;
2513 change_detector = hotkey_config_change;
2515 poll_mask = hotkey_source_mask;
2516 event_mask = hotkey_source_mask &
2517 (hotkey_driver_mask | hotkey_user_mask);
2518 poll_freq = hotkey_poll_freq;
2519 mutex_unlock(&hotkey_thread_data_mutex);
2521 if (likely(poll_mask)) {
2522 hotkey_read_nvram(&s[si], poll_mask);
2523 if (likely(si != so)) {
2524 hotkey_compare_and_issue_event(&s[so], &s[si],
2525 event_mask);
2529 so = si;
2530 si ^= 1;
2533 exit:
2534 mutex_unlock(&hotkey_thread_mutex);
2535 return 0;
2538 /* call with hotkey_mutex held */
2539 static void hotkey_poll_stop_sync(void)
2541 if (tpacpi_hotkey_task) {
2542 if (frozen(tpacpi_hotkey_task) ||
2543 freezing(tpacpi_hotkey_task))
2544 thaw_process(tpacpi_hotkey_task);
2546 kthread_stop(tpacpi_hotkey_task);
2547 tpacpi_hotkey_task = NULL;
2548 mutex_lock(&hotkey_thread_mutex);
2549 /* at this point, the thread did exit */
2550 mutex_unlock(&hotkey_thread_mutex);
2554 /* call with hotkey_mutex held */
2555 static void hotkey_poll_setup(const bool may_warn)
2557 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2558 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2560 if (hotkey_poll_freq > 0 &&
2561 (poll_driver_mask ||
2562 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2563 if (!tpacpi_hotkey_task) {
2564 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2565 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2566 if (IS_ERR(tpacpi_hotkey_task)) {
2567 tpacpi_hotkey_task = NULL;
2568 printk(TPACPI_ERR
2569 "could not create kernel thread "
2570 "for hotkey polling\n");
2573 } else {
2574 hotkey_poll_stop_sync();
2575 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2576 hotkey_poll_freq == 0) {
2577 printk(TPACPI_NOTICE
2578 "hot keys 0x%08x and/or events 0x%08x "
2579 "require polling, which is currently "
2580 "disabled\n",
2581 poll_user_mask, poll_driver_mask);
2586 static void hotkey_poll_setup_safe(const bool may_warn)
2588 mutex_lock(&hotkey_mutex);
2589 hotkey_poll_setup(may_warn);
2590 mutex_unlock(&hotkey_mutex);
2593 /* call with hotkey_mutex held */
2594 static void hotkey_poll_set_freq(unsigned int freq)
2596 if (!freq)
2597 hotkey_poll_stop_sync();
2599 hotkey_poll_freq = freq;
2602 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2604 static void hotkey_poll_setup(const bool __unused)
2608 static void hotkey_poll_setup_safe(const bool __unused)
2612 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2614 static int hotkey_inputdev_open(struct input_dev *dev)
2616 switch (tpacpi_lifecycle) {
2617 case TPACPI_LIFE_INIT:
2618 case TPACPI_LIFE_RUNNING:
2619 hotkey_poll_setup_safe(false);
2620 return 0;
2621 case TPACPI_LIFE_EXITING:
2622 return -EBUSY;
2625 /* Should only happen if tpacpi_lifecycle is corrupt */
2626 BUG();
2627 return -EBUSY;
2630 static void hotkey_inputdev_close(struct input_dev *dev)
2632 /* disable hotkey polling when possible */
2633 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2634 !(hotkey_source_mask & hotkey_driver_mask))
2635 hotkey_poll_setup_safe(false);
2638 /* sysfs hotkey enable ------------------------------------------------- */
2639 static ssize_t hotkey_enable_show(struct device *dev,
2640 struct device_attribute *attr,
2641 char *buf)
2643 int res, status;
2645 printk_deprecated_attribute("hotkey_enable",
2646 "Hotkey reporting is always enabled");
2648 res = hotkey_status_get(&status);
2649 if (res)
2650 return res;
2652 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2655 static ssize_t hotkey_enable_store(struct device *dev,
2656 struct device_attribute *attr,
2657 const char *buf, size_t count)
2659 unsigned long t;
2661 printk_deprecated_attribute("hotkey_enable",
2662 "Hotkeys can be disabled through hotkey_mask");
2664 if (parse_strtoul(buf, 1, &t))
2665 return -EINVAL;
2667 if (t == 0)
2668 return -EPERM;
2670 return count;
2673 static struct device_attribute dev_attr_hotkey_enable =
2674 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2675 hotkey_enable_show, hotkey_enable_store);
2677 /* sysfs hotkey mask --------------------------------------------------- */
2678 static ssize_t hotkey_mask_show(struct device *dev,
2679 struct device_attribute *attr,
2680 char *buf)
2682 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2685 static ssize_t hotkey_mask_store(struct device *dev,
2686 struct device_attribute *attr,
2687 const char *buf, size_t count)
2689 unsigned long t;
2690 int res;
2692 if (parse_strtoul(buf, 0xffffffffUL, &t))
2693 return -EINVAL;
2695 if (mutex_lock_killable(&hotkey_mutex))
2696 return -ERESTARTSYS;
2698 res = hotkey_user_mask_set(t);
2700 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2701 hotkey_poll_setup(true);
2702 #endif
2704 mutex_unlock(&hotkey_mutex);
2706 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2708 return (res) ? res : count;
2711 static struct device_attribute dev_attr_hotkey_mask =
2712 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2713 hotkey_mask_show, hotkey_mask_store);
2715 /* sysfs hotkey bios_enabled ------------------------------------------- */
2716 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2717 struct device_attribute *attr,
2718 char *buf)
2720 return sprintf(buf, "0\n");
2723 static struct device_attribute dev_attr_hotkey_bios_enabled =
2724 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2726 /* sysfs hotkey bios_mask ---------------------------------------------- */
2727 static ssize_t hotkey_bios_mask_show(struct device *dev,
2728 struct device_attribute *attr,
2729 char *buf)
2731 printk_deprecated_attribute("hotkey_bios_mask",
2732 "This attribute is useless.");
2733 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2736 static struct device_attribute dev_attr_hotkey_bios_mask =
2737 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2739 /* sysfs hotkey all_mask ----------------------------------------------- */
2740 static ssize_t hotkey_all_mask_show(struct device *dev,
2741 struct device_attribute *attr,
2742 char *buf)
2744 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2745 hotkey_all_mask | hotkey_source_mask);
2748 static struct device_attribute dev_attr_hotkey_all_mask =
2749 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2751 /* sysfs hotkey recommended_mask --------------------------------------- */
2752 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2753 struct device_attribute *attr,
2754 char *buf)
2756 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2757 (hotkey_all_mask | hotkey_source_mask)
2758 & ~hotkey_reserved_mask);
2761 static struct device_attribute dev_attr_hotkey_recommended_mask =
2762 __ATTR(hotkey_recommended_mask, S_IRUGO,
2763 hotkey_recommended_mask_show, NULL);
2765 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2767 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2768 static ssize_t hotkey_source_mask_show(struct device *dev,
2769 struct device_attribute *attr,
2770 char *buf)
2772 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2775 static ssize_t hotkey_source_mask_store(struct device *dev,
2776 struct device_attribute *attr,
2777 const char *buf, size_t count)
2779 unsigned long t;
2780 u32 r_ev;
2781 int rc;
2783 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2784 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2785 return -EINVAL;
2787 if (mutex_lock_killable(&hotkey_mutex))
2788 return -ERESTARTSYS;
2790 HOTKEY_CONFIG_CRITICAL_START
2791 hotkey_source_mask = t;
2792 HOTKEY_CONFIG_CRITICAL_END
2794 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2795 ~hotkey_source_mask);
2796 hotkey_poll_setup(true);
2798 /* check if events needed by the driver got disabled */
2799 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2800 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2802 mutex_unlock(&hotkey_mutex);
2804 if (rc < 0)
2805 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2806 "firmware event mask!\n");
2808 if (r_ev)
2809 printk(TPACPI_NOTICE "hotkey_source_mask: "
2810 "some important events were disabled: "
2811 "0x%04x\n", r_ev);
2813 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2815 return (rc < 0) ? rc : count;
2818 static struct device_attribute dev_attr_hotkey_source_mask =
2819 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2820 hotkey_source_mask_show, hotkey_source_mask_store);
2822 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2823 static ssize_t hotkey_poll_freq_show(struct device *dev,
2824 struct device_attribute *attr,
2825 char *buf)
2827 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2830 static ssize_t hotkey_poll_freq_store(struct device *dev,
2831 struct device_attribute *attr,
2832 const char *buf, size_t count)
2834 unsigned long t;
2836 if (parse_strtoul(buf, 25, &t))
2837 return -EINVAL;
2839 if (mutex_lock_killable(&hotkey_mutex))
2840 return -ERESTARTSYS;
2842 hotkey_poll_set_freq(t);
2843 hotkey_poll_setup(true);
2845 mutex_unlock(&hotkey_mutex);
2847 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2849 return count;
2852 static struct device_attribute dev_attr_hotkey_poll_freq =
2853 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2854 hotkey_poll_freq_show, hotkey_poll_freq_store);
2856 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2858 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2859 static ssize_t hotkey_radio_sw_show(struct device *dev,
2860 struct device_attribute *attr,
2861 char *buf)
2863 int res;
2864 res = hotkey_get_wlsw();
2865 if (res < 0)
2866 return res;
2868 /* Opportunistic update */
2869 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2871 return snprintf(buf, PAGE_SIZE, "%d\n",
2872 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2875 static struct device_attribute dev_attr_hotkey_radio_sw =
2876 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2878 static void hotkey_radio_sw_notify_change(void)
2880 if (tp_features.hotkey_wlsw)
2881 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2882 "hotkey_radio_sw");
2885 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2886 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2887 struct device_attribute *attr,
2888 char *buf)
2890 int res, s;
2891 res = hotkey_get_tablet_mode(&s);
2892 if (res < 0)
2893 return res;
2895 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2898 static struct device_attribute dev_attr_hotkey_tablet_mode =
2899 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2901 static void hotkey_tablet_mode_notify_change(void)
2903 if (tp_features.hotkey_tablet)
2904 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2905 "hotkey_tablet_mode");
2908 /* sysfs hotkey report_mode -------------------------------------------- */
2909 static ssize_t hotkey_report_mode_show(struct device *dev,
2910 struct device_attribute *attr,
2911 char *buf)
2913 return snprintf(buf, PAGE_SIZE, "%d\n",
2914 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2917 static struct device_attribute dev_attr_hotkey_report_mode =
2918 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2920 /* sysfs wakeup reason (pollable) -------------------------------------- */
2921 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2922 struct device_attribute *attr,
2923 char *buf)
2925 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2928 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2929 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2931 static void hotkey_wakeup_reason_notify_change(void)
2933 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2934 "wakeup_reason");
2937 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2938 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2939 struct device_attribute *attr,
2940 char *buf)
2942 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2945 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2946 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2947 hotkey_wakeup_hotunplug_complete_show, NULL);
2949 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2951 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2952 "wakeup_hotunplug_complete");
2955 /* --------------------------------------------------------------------- */
2957 static struct attribute *hotkey_attributes[] __initdata = {
2958 &dev_attr_hotkey_enable.attr,
2959 &dev_attr_hotkey_bios_enabled.attr,
2960 &dev_attr_hotkey_bios_mask.attr,
2961 &dev_attr_hotkey_report_mode.attr,
2962 &dev_attr_hotkey_wakeup_reason.attr,
2963 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2964 &dev_attr_hotkey_mask.attr,
2965 &dev_attr_hotkey_all_mask.attr,
2966 &dev_attr_hotkey_recommended_mask.attr,
2967 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2968 &dev_attr_hotkey_source_mask.attr,
2969 &dev_attr_hotkey_poll_freq.attr,
2970 #endif
2974 * Sync both the hw and sw blocking state of all switches
2976 static void tpacpi_send_radiosw_update(void)
2978 int wlsw;
2981 * We must sync all rfkill controllers *before* issuing any
2982 * rfkill input events, or we will race the rfkill core input
2983 * handler.
2985 * tpacpi_inputdev_send_mutex works as a syncronization point
2986 * for the above.
2988 * We optimize to avoid numerous calls to hotkey_get_wlsw.
2991 wlsw = hotkey_get_wlsw();
2993 /* Sync hw blocking state first if it is hw-blocked */
2994 if (wlsw == TPACPI_RFK_RADIO_OFF)
2995 tpacpi_rfk_update_hwblock_state(true);
2997 /* Sync sw blocking state */
2998 tpacpi_rfk_update_swstate_all();
3000 /* Sync hw blocking state last if it is hw-unblocked */
3001 if (wlsw == TPACPI_RFK_RADIO_ON)
3002 tpacpi_rfk_update_hwblock_state(false);
3004 /* Issue rfkill input event for WLSW switch */
3005 if (!(wlsw < 0)) {
3006 mutex_lock(&tpacpi_inputdev_send_mutex);
3008 input_report_switch(tpacpi_inputdev,
3009 SW_RFKILL_ALL, (wlsw > 0));
3010 input_sync(tpacpi_inputdev);
3012 mutex_unlock(&tpacpi_inputdev_send_mutex);
3016 * this can be unconditional, as we will poll state again
3017 * if userspace uses the notify to read data
3019 hotkey_radio_sw_notify_change();
3022 static void hotkey_exit(void)
3024 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3025 mutex_lock(&hotkey_mutex);
3026 hotkey_poll_stop_sync();
3027 mutex_unlock(&hotkey_mutex);
3028 #endif
3030 if (hotkey_dev_attributes)
3031 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3033 kfree(hotkey_keycode_map);
3035 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3036 "restoring original HKEY status and mask\n");
3037 /* yes, there is a bitwise or below, we want the
3038 * functions to be called even if one of them fail */
3039 if (((tp_features.hotkey_mask &&
3040 hotkey_mask_set(hotkey_orig_mask)) |
3041 hotkey_status_set(false)) != 0)
3042 printk(TPACPI_ERR
3043 "failed to restore hot key mask "
3044 "to BIOS defaults\n");
3047 static void __init hotkey_unmap(const unsigned int scancode)
3049 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3050 clear_bit(hotkey_keycode_map[scancode],
3051 tpacpi_inputdev->keybit);
3052 hotkey_keycode_map[scancode] = KEY_RESERVED;
3057 * HKEY quirks:
3058 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3061 #define TPACPI_HK_Q_INIMASK 0x0001
3063 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3064 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3065 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3066 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3067 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3068 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3069 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3070 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3071 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3072 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3073 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3074 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3075 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3076 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3077 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3078 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3079 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3080 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3081 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3082 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3085 static int __init hotkey_init(struct ibm_init_struct *iibm)
3087 /* Requirements for changing the default keymaps:
3089 * 1. Many of the keys are mapped to KEY_RESERVED for very
3090 * good reasons. Do not change them unless you have deep
3091 * knowledge on the IBM and Lenovo ThinkPad firmware for
3092 * the various ThinkPad models. The driver behaves
3093 * differently for KEY_RESERVED: such keys have their
3094 * hot key mask *unset* in mask_recommended, and also
3095 * in the initial hot key mask programmed into the
3096 * firmware at driver load time, which means the firm-
3097 * ware may react very differently if you change them to
3098 * something else;
3100 * 2. You must be subscribed to the linux-thinkpad and
3101 * ibm-acpi-devel mailing lists, and you should read the
3102 * list archives since 2007 if you want to change the
3103 * keymaps. This requirement exists so that you will
3104 * know the past history of problems with the thinkpad-
3105 * acpi driver keymaps, and also that you will be
3106 * listening to any bug reports;
3108 * 3. Do not send thinkpad-acpi specific patches directly to
3109 * for merging, *ever*. Send them to the linux-acpi
3110 * mailinglist for comments. Merging is to be done only
3111 * through acpi-test and the ACPI maintainer.
3113 * If the above is too much to ask, don't change the keymap.
3114 * Ask the thinkpad-acpi maintainer to do it, instead.
3116 static u16 ibm_keycode_map[] __initdata = {
3117 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3118 KEY_FN_F1, KEY_FN_F2, KEY_COFFEE, KEY_SLEEP,
3119 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3120 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3122 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3123 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3124 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3125 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3127 /* brightness: firmware always reacts to them */
3128 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3129 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3131 /* Thinklight: firmware always react to it */
3132 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3134 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3135 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3137 /* Volume: firmware always react to it and reprograms
3138 * the built-in *extra* mixer. Never map it to control
3139 * another mixer by default. */
3140 KEY_RESERVED, /* 0x14: VOLUME UP */
3141 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3142 KEY_RESERVED, /* 0x16: MUTE */
3144 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3146 /* (assignments unknown, please report if found) */
3147 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3148 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3150 static u16 lenovo_keycode_map[] __initdata = {
3151 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3152 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3153 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3154 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3156 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3157 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3158 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3159 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3161 /* These should be enabled --only-- when ACPI video
3162 * is disabled (i.e. in "vendor" mode), and are handled
3163 * in a special way by the init code */
3164 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3165 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3167 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3169 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3170 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3172 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3173 * react to it and reprograms the built-in *extra* mixer.
3174 * Never map it to control another mixer by default.
3176 * T60?, T61, R60?, R61: firmware and EC tries to send
3177 * these over the regular keyboard, so these are no-ops,
3178 * but there are still weird bugs re. MUTE, so do not
3179 * change unless you get test reports from all Lenovo
3180 * models. May cause the BIOS to interfere with the
3181 * HDA mixer.
3183 KEY_RESERVED, /* 0x14: VOLUME UP */
3184 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3185 KEY_RESERVED, /* 0x16: MUTE */
3187 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3189 /* (assignments unknown, please report if found) */
3190 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3191 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3194 #define TPACPI_HOTKEY_MAP_LEN ARRAY_SIZE(ibm_keycode_map)
3195 #define TPACPI_HOTKEY_MAP_SIZE sizeof(ibm_keycode_map)
3196 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(ibm_keycode_map[0])
3198 int res, i;
3199 int status;
3200 int hkeyv;
3201 bool radiosw_state = false;
3202 bool tabletsw_state = false;
3204 unsigned long quirks;
3206 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3207 "initializing hotkey subdriver\n");
3209 BUG_ON(!tpacpi_inputdev);
3210 BUG_ON(tpacpi_inputdev->open != NULL ||
3211 tpacpi_inputdev->close != NULL);
3213 TPACPI_ACPIHANDLE_INIT(hkey);
3214 mutex_init(&hotkey_mutex);
3216 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3217 mutex_init(&hotkey_thread_mutex);
3218 mutex_init(&hotkey_thread_data_mutex);
3219 #endif
3221 /* hotkey not supported on 570 */
3222 tp_features.hotkey = hkey_handle != NULL;
3224 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3225 "hotkeys are %s\n",
3226 str_supported(tp_features.hotkey));
3228 if (!tp_features.hotkey)
3229 return 1;
3231 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3232 ARRAY_SIZE(tpacpi_hotkey_qtable));
3234 tpacpi_disable_brightness_delay();
3236 /* MUST have enough space for all attributes to be added to
3237 * hotkey_dev_attributes */
3238 hotkey_dev_attributes = create_attr_set(
3239 ARRAY_SIZE(hotkey_attributes) + 2,
3240 NULL);
3241 if (!hotkey_dev_attributes)
3242 return -ENOMEM;
3243 res = add_many_to_attr_set(hotkey_dev_attributes,
3244 hotkey_attributes,
3245 ARRAY_SIZE(hotkey_attributes));
3246 if (res)
3247 goto err_exit;
3249 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3250 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3251 for HKEY interface version 0x100 */
3252 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3253 if ((hkeyv >> 8) != 1) {
3254 printk(TPACPI_ERR "unknown version of the "
3255 "HKEY interface: 0x%x\n", hkeyv);
3256 printk(TPACPI_ERR "please report this to %s\n",
3257 TPACPI_MAIL);
3258 } else {
3260 * MHKV 0x100 in A31, R40, R40e,
3261 * T4x, X31, and later
3263 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3264 "firmware HKEY interface version: 0x%x\n",
3265 hkeyv);
3267 /* Paranoia check AND init hotkey_all_mask */
3268 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3269 "MHKA", "qd")) {
3270 printk(TPACPI_ERR
3271 "missing MHKA handler, "
3272 "please report this to %s\n",
3273 TPACPI_MAIL);
3274 /* Fallback: pre-init for FN+F3,F4,F12 */
3275 hotkey_all_mask = 0x080cU;
3276 } else {
3277 tp_features.hotkey_mask = 1;
3282 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3283 "hotkey masks are %s\n",
3284 str_supported(tp_features.hotkey_mask));
3286 /* Init hotkey_all_mask if not initialized yet */
3287 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3288 (quirks & TPACPI_HK_Q_INIMASK))
3289 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3291 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3292 if (tp_features.hotkey_mask) {
3293 /* hotkey_source_mask *must* be zero for
3294 * the first hotkey_mask_get to return hotkey_orig_mask */
3295 res = hotkey_mask_get();
3296 if (res)
3297 goto err_exit;
3299 hotkey_orig_mask = hotkey_acpi_mask;
3300 } else {
3301 hotkey_orig_mask = hotkey_all_mask;
3302 hotkey_acpi_mask = hotkey_all_mask;
3305 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3306 if (dbg_wlswemul) {
3307 tp_features.hotkey_wlsw = 1;
3308 radiosw_state = !!tpacpi_wlsw_emulstate;
3309 printk(TPACPI_INFO
3310 "radio switch emulation enabled\n");
3311 } else
3312 #endif
3313 /* Not all thinkpads have a hardware radio switch */
3314 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3315 tp_features.hotkey_wlsw = 1;
3316 radiosw_state = !!status;
3317 printk(TPACPI_INFO
3318 "radio switch found; radios are %s\n",
3319 enabled(status, 0));
3321 if (tp_features.hotkey_wlsw)
3322 res = add_to_attr_set(hotkey_dev_attributes,
3323 &dev_attr_hotkey_radio_sw.attr);
3325 /* For X41t, X60t, X61t Tablets... */
3326 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3327 tp_features.hotkey_tablet = 1;
3328 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3329 printk(TPACPI_INFO
3330 "possible tablet mode switch found; "
3331 "ThinkPad in %s mode\n",
3332 (tabletsw_state) ? "tablet" : "laptop");
3333 res = add_to_attr_set(hotkey_dev_attributes,
3334 &dev_attr_hotkey_tablet_mode.attr);
3337 if (!res)
3338 res = register_attr_set_with_sysfs(
3339 hotkey_dev_attributes,
3340 &tpacpi_pdev->dev.kobj);
3341 if (res)
3342 goto err_exit;
3344 /* Set up key map */
3346 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3347 GFP_KERNEL);
3348 if (!hotkey_keycode_map) {
3349 printk(TPACPI_ERR
3350 "failed to allocate memory for key map\n");
3351 res = -ENOMEM;
3352 goto err_exit;
3355 if (tpacpi_is_lenovo()) {
3356 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3357 "using Lenovo default hot key map\n");
3358 memcpy(hotkey_keycode_map, &lenovo_keycode_map,
3359 TPACPI_HOTKEY_MAP_SIZE);
3360 } else {
3361 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3362 "using IBM default hot key map\n");
3363 memcpy(hotkey_keycode_map, &ibm_keycode_map,
3364 TPACPI_HOTKEY_MAP_SIZE);
3367 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3368 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3369 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3370 tpacpi_inputdev->keycode = hotkey_keycode_map;
3371 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3372 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3373 input_set_capability(tpacpi_inputdev, EV_KEY,
3374 hotkey_keycode_map[i]);
3375 } else {
3376 if (i < sizeof(hotkey_reserved_mask)*8)
3377 hotkey_reserved_mask |= 1 << i;
3381 if (tp_features.hotkey_wlsw) {
3382 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3383 input_report_switch(tpacpi_inputdev,
3384 SW_RFKILL_ALL, radiosw_state);
3386 if (tp_features.hotkey_tablet) {
3387 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3388 input_report_switch(tpacpi_inputdev,
3389 SW_TABLET_MODE, tabletsw_state);
3392 /* Do not issue duplicate brightness change events to
3393 * userspace. tpacpi_detect_brightness_capabilities() must have
3394 * been called before this point */
3395 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3396 printk(TPACPI_INFO
3397 "This ThinkPad has standard ACPI backlight "
3398 "brightness control, supported by the ACPI "
3399 "video driver\n");
3400 printk(TPACPI_NOTICE
3401 "Disabling thinkpad-acpi brightness events "
3402 "by default...\n");
3404 /* Disable brightness up/down on Lenovo thinkpads when
3405 * ACPI is handling them, otherwise it is plain impossible
3406 * for userspace to do something even remotely sane */
3407 hotkey_reserved_mask |=
3408 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3409 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3410 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3411 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3414 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3415 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3416 & ~hotkey_all_mask
3417 & ~hotkey_reserved_mask;
3419 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3420 "hotkey source mask 0x%08x, polling freq %u\n",
3421 hotkey_source_mask, hotkey_poll_freq);
3422 #endif
3424 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3425 "enabling firmware HKEY event interface...\n");
3426 res = hotkey_status_set(true);
3427 if (res) {
3428 hotkey_exit();
3429 return res;
3431 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3432 | hotkey_driver_mask)
3433 & ~hotkey_source_mask);
3434 if (res < 0 && res != -ENXIO) {
3435 hotkey_exit();
3436 return res;
3438 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3439 & ~hotkey_reserved_mask;
3440 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3441 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3442 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3444 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3445 "legacy ibm/hotkey event reporting over procfs %s\n",
3446 (hotkey_report_mode < 2) ?
3447 "enabled" : "disabled");
3449 tpacpi_inputdev->open = &hotkey_inputdev_open;
3450 tpacpi_inputdev->close = &hotkey_inputdev_close;
3452 hotkey_poll_setup_safe(true);
3454 return 0;
3456 err_exit:
3457 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3458 hotkey_dev_attributes = NULL;
3460 return (res < 0)? res : 1;
3463 static bool hotkey_notify_hotkey(const u32 hkey,
3464 bool *send_acpi_ev,
3465 bool *ignore_acpi_ev)
3467 /* 0x1000-0x1FFF: key presses */
3468 unsigned int scancode = hkey & 0xfff;
3469 *send_acpi_ev = true;
3470 *ignore_acpi_ev = false;
3472 if (scancode > 0 && scancode < 0x21) {
3473 scancode--;
3474 if (!(hotkey_source_mask & (1 << scancode))) {
3475 tpacpi_input_send_key_masked(scancode);
3476 *send_acpi_ev = false;
3477 } else {
3478 *ignore_acpi_ev = true;
3480 return true;
3482 return false;
3485 static bool hotkey_notify_wakeup(const u32 hkey,
3486 bool *send_acpi_ev,
3487 bool *ignore_acpi_ev)
3489 /* 0x2000-0x2FFF: Wakeup reason */
3490 *send_acpi_ev = true;
3491 *ignore_acpi_ev = false;
3493 switch (hkey) {
3494 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3495 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3496 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3497 *ignore_acpi_ev = true;
3498 break;
3500 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3501 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3502 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3503 *ignore_acpi_ev = true;
3504 break;
3506 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3507 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3508 printk(TPACPI_ALERT
3509 "EMERGENCY WAKEUP: battery almost empty\n");
3510 /* how to auto-heal: */
3511 /* 2313: woke up from S3, go to S4/S5 */
3512 /* 2413: woke up from S4, go to S5 */
3513 break;
3515 default:
3516 return false;
3519 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3520 printk(TPACPI_INFO
3521 "woke up due to a hot-unplug "
3522 "request...\n");
3523 hotkey_wakeup_reason_notify_change();
3525 return true;
3528 static bool hotkey_notify_usrevent(const u32 hkey,
3529 bool *send_acpi_ev,
3530 bool *ignore_acpi_ev)
3532 /* 0x5000-0x5FFF: human interface helpers */
3533 *send_acpi_ev = true;
3534 *ignore_acpi_ev = false;
3536 switch (hkey) {
3537 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3538 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3539 return true;
3541 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3542 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3543 tpacpi_input_send_tabletsw();
3544 hotkey_tablet_mode_notify_change();
3545 *send_acpi_ev = false;
3546 return true;
3548 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3549 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3550 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3551 /* do not propagate these events */
3552 *ignore_acpi_ev = true;
3553 return true;
3555 default:
3556 return false;
3560 static void thermal_dump_all_sensors(void);
3562 static bool hotkey_notify_thermal(const u32 hkey,
3563 bool *send_acpi_ev,
3564 bool *ignore_acpi_ev)
3566 bool known = true;
3568 /* 0x6000-0x6FFF: thermal alarms */
3569 *send_acpi_ev = true;
3570 *ignore_acpi_ev = false;
3572 switch (hkey) {
3573 case TP_HKEY_EV_THM_TABLE_CHANGED:
3574 printk(TPACPI_INFO
3575 "EC reports that Thermal Table has changed\n");
3576 /* recommended action: do nothing, we don't have
3577 * Lenovo ATM information */
3578 return true;
3579 case TP_HKEY_EV_ALARM_BAT_HOT:
3580 printk(TPACPI_CRIT
3581 "THERMAL ALARM: battery is too hot!\n");
3582 /* recommended action: warn user through gui */
3583 break;
3584 case TP_HKEY_EV_ALARM_BAT_XHOT:
3585 printk(TPACPI_ALERT
3586 "THERMAL EMERGENCY: battery is extremely hot!\n");
3587 /* recommended action: immediate sleep/hibernate */
3588 break;
3589 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3590 printk(TPACPI_CRIT
3591 "THERMAL ALARM: "
3592 "a sensor reports something is too hot!\n");
3593 /* recommended action: warn user through gui, that */
3594 /* some internal component is too hot */
3595 break;
3596 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3597 printk(TPACPI_ALERT
3598 "THERMAL EMERGENCY: "
3599 "a sensor reports something is extremely hot!\n");
3600 /* recommended action: immediate sleep/hibernate */
3601 break;
3602 default:
3603 printk(TPACPI_ALERT
3604 "THERMAL ALERT: unknown thermal alarm received\n");
3605 known = false;
3608 thermal_dump_all_sensors();
3610 return known;
3613 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3615 u32 hkey;
3616 bool send_acpi_ev;
3617 bool ignore_acpi_ev;
3618 bool known_ev;
3620 if (event != 0x80) {
3621 printk(TPACPI_ERR
3622 "unknown HKEY notification event %d\n", event);
3623 /* forward it to userspace, maybe it knows how to handle it */
3624 acpi_bus_generate_netlink_event(
3625 ibm->acpi->device->pnp.device_class,
3626 dev_name(&ibm->acpi->device->dev),
3627 event, 0);
3628 return;
3631 while (1) {
3632 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3633 printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3634 return;
3637 if (hkey == 0) {
3638 /* queue empty */
3639 return;
3642 send_acpi_ev = true;
3643 ignore_acpi_ev = false;
3645 switch (hkey >> 12) {
3646 case 1:
3647 /* 0x1000-0x1FFF: key presses */
3648 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3649 &ignore_acpi_ev);
3650 break;
3651 case 2:
3652 /* 0x2000-0x2FFF: Wakeup reason */
3653 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3654 &ignore_acpi_ev);
3655 break;
3656 case 3:
3657 /* 0x3000-0x3FFF: bay-related wakeups */
3658 switch (hkey) {
3659 case TP_HKEY_EV_BAYEJ_ACK:
3660 hotkey_autosleep_ack = 1;
3661 printk(TPACPI_INFO
3662 "bay ejected\n");
3663 hotkey_wakeup_hotunplug_complete_notify_change();
3664 known_ev = true;
3665 break;
3666 case TP_HKEY_EV_OPTDRV_EJ:
3667 /* FIXME: kick libata if SATA link offline */
3668 known_ev = true;
3669 break;
3670 default:
3671 known_ev = false;
3673 break;
3674 case 4:
3675 /* 0x4000-0x4FFF: dock-related wakeups */
3676 if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3677 hotkey_autosleep_ack = 1;
3678 printk(TPACPI_INFO
3679 "undocked\n");
3680 hotkey_wakeup_hotunplug_complete_notify_change();
3681 known_ev = true;
3682 } else {
3683 known_ev = false;
3685 break;
3686 case 5:
3687 /* 0x5000-0x5FFF: human interface helpers */
3688 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3689 &ignore_acpi_ev);
3690 break;
3691 case 6:
3692 /* 0x6000-0x6FFF: thermal alarms */
3693 known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3694 &ignore_acpi_ev);
3695 break;
3696 case 7:
3697 /* 0x7000-0x7FFF: misc */
3698 if (tp_features.hotkey_wlsw &&
3699 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3700 tpacpi_send_radiosw_update();
3701 send_acpi_ev = 0;
3702 known_ev = true;
3703 break;
3705 /* fallthrough to default */
3706 default:
3707 known_ev = false;
3709 if (!known_ev) {
3710 printk(TPACPI_NOTICE
3711 "unhandled HKEY event 0x%04x\n", hkey);
3712 printk(TPACPI_NOTICE
3713 "please report the conditions when this "
3714 "event happened to %s\n", TPACPI_MAIL);
3717 /* Legacy events */
3718 if (!ignore_acpi_ev &&
3719 (send_acpi_ev || hotkey_report_mode < 2)) {
3720 acpi_bus_generate_proc_event(ibm->acpi->device,
3721 event, hkey);
3724 /* netlink events */
3725 if (!ignore_acpi_ev && send_acpi_ev) {
3726 acpi_bus_generate_netlink_event(
3727 ibm->acpi->device->pnp.device_class,
3728 dev_name(&ibm->acpi->device->dev),
3729 event, hkey);
3734 static void hotkey_suspend(pm_message_t state)
3736 /* Do these on suspend, we get the events on early resume! */
3737 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3738 hotkey_autosleep_ack = 0;
3741 static void hotkey_resume(void)
3743 tpacpi_disable_brightness_delay();
3745 if (hotkey_status_set(true) < 0 ||
3746 hotkey_mask_set(hotkey_acpi_mask) < 0)
3747 printk(TPACPI_ERR
3748 "error while attempting to reset the event "
3749 "firmware interface\n");
3751 tpacpi_send_radiosw_update();
3752 hotkey_tablet_mode_notify_change();
3753 hotkey_wakeup_reason_notify_change();
3754 hotkey_wakeup_hotunplug_complete_notify_change();
3755 hotkey_poll_setup_safe(false);
3758 /* procfs -------------------------------------------------------------- */
3759 static int hotkey_read(struct seq_file *m)
3761 int res, status;
3763 if (!tp_features.hotkey) {
3764 seq_printf(m, "status:\t\tnot supported\n");
3765 return 0;
3768 if (mutex_lock_killable(&hotkey_mutex))
3769 return -ERESTARTSYS;
3770 res = hotkey_status_get(&status);
3771 if (!res)
3772 res = hotkey_mask_get();
3773 mutex_unlock(&hotkey_mutex);
3774 if (res)
3775 return res;
3777 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3778 if (hotkey_all_mask) {
3779 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3780 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3781 } else {
3782 seq_printf(m, "mask:\t\tnot supported\n");
3783 seq_printf(m, "commands:\tenable, disable, reset\n");
3786 return 0;
3789 static void hotkey_enabledisable_warn(bool enable)
3791 tpacpi_log_usertask("procfs hotkey enable/disable");
3792 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3793 TPACPI_WARN
3794 "hotkey enable/disable functionality has been "
3795 "removed from the driver. Hotkeys are always "
3796 "enabled\n"))
3797 printk(TPACPI_ERR
3798 "Please remove the hotkey=enable module "
3799 "parameter, it is deprecated. Hotkeys are always "
3800 "enabled\n");
3803 static int hotkey_write(char *buf)
3805 int res;
3806 u32 mask;
3807 char *cmd;
3809 if (!tp_features.hotkey)
3810 return -ENODEV;
3812 if (mutex_lock_killable(&hotkey_mutex))
3813 return -ERESTARTSYS;
3815 mask = hotkey_user_mask;
3817 res = 0;
3818 while ((cmd = next_cmd(&buf))) {
3819 if (strlencmp(cmd, "enable") == 0) {
3820 hotkey_enabledisable_warn(1);
3821 } else if (strlencmp(cmd, "disable") == 0) {
3822 hotkey_enabledisable_warn(0);
3823 res = -EPERM;
3824 } else if (strlencmp(cmd, "reset") == 0) {
3825 mask = (hotkey_all_mask | hotkey_source_mask)
3826 & ~hotkey_reserved_mask;
3827 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3828 /* mask set */
3829 } else if (sscanf(cmd, "%x", &mask) == 1) {
3830 /* mask set */
3831 } else {
3832 res = -EINVAL;
3833 goto errexit;
3837 if (!res) {
3838 tpacpi_disclose_usertask("procfs hotkey",
3839 "set mask to 0x%08x\n", mask);
3840 res = hotkey_user_mask_set(mask);
3843 errexit:
3844 mutex_unlock(&hotkey_mutex);
3845 return res;
3848 static const struct acpi_device_id ibm_htk_device_ids[] = {
3849 {TPACPI_ACPI_HKEY_HID, 0},
3850 {"", 0},
3853 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3854 .hid = ibm_htk_device_ids,
3855 .notify = hotkey_notify,
3856 .handle = &hkey_handle,
3857 .type = ACPI_DEVICE_NOTIFY,
3860 static struct ibm_struct hotkey_driver_data = {
3861 .name = "hotkey",
3862 .read = hotkey_read,
3863 .write = hotkey_write,
3864 .exit = hotkey_exit,
3865 .resume = hotkey_resume,
3866 .suspend = hotkey_suspend,
3867 .acpi = &ibm_hotkey_acpidriver,
3870 /*************************************************************************
3871 * Bluetooth subdriver
3874 enum {
3875 /* ACPI GBDC/SBDC bits */
3876 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3877 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3878 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3879 0 = disable, 1 = enable */
3882 enum {
3883 /* ACPI \BLTH commands */
3884 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3885 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3886 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3887 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3888 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3891 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3893 static int bluetooth_get_status(void)
3895 int status;
3897 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3898 if (dbg_bluetoothemul)
3899 return (tpacpi_bluetooth_emulstate) ?
3900 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3901 #endif
3903 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3904 return -EIO;
3906 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3907 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3910 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3912 int status;
3914 vdbg_printk(TPACPI_DBG_RFKILL,
3915 "will attempt to %s bluetooth\n",
3916 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3918 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3919 if (dbg_bluetoothemul) {
3920 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3921 return 0;
3923 #endif
3925 if (state == TPACPI_RFK_RADIO_ON)
3926 status = TP_ACPI_BLUETOOTH_RADIOSSW
3927 | TP_ACPI_BLUETOOTH_RESUMECTRL;
3928 else
3929 status = 0;
3931 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3932 return -EIO;
3934 return 0;
3937 /* sysfs bluetooth enable ---------------------------------------------- */
3938 static ssize_t bluetooth_enable_show(struct device *dev,
3939 struct device_attribute *attr,
3940 char *buf)
3942 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3943 attr, buf);
3946 static ssize_t bluetooth_enable_store(struct device *dev,
3947 struct device_attribute *attr,
3948 const char *buf, size_t count)
3950 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3951 attr, buf, count);
3954 static struct device_attribute dev_attr_bluetooth_enable =
3955 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3956 bluetooth_enable_show, bluetooth_enable_store);
3958 /* --------------------------------------------------------------------- */
3960 static struct attribute *bluetooth_attributes[] = {
3961 &dev_attr_bluetooth_enable.attr,
3962 NULL
3965 static const struct attribute_group bluetooth_attr_group = {
3966 .attrs = bluetooth_attributes,
3969 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
3970 .get_status = bluetooth_get_status,
3971 .set_status = bluetooth_set_status,
3974 static void bluetooth_shutdown(void)
3976 /* Order firmware to save current state to NVRAM */
3977 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
3978 TP_ACPI_BLTH_SAVE_STATE))
3979 printk(TPACPI_NOTICE
3980 "failed to save bluetooth state to NVRAM\n");
3981 else
3982 vdbg_printk(TPACPI_DBG_RFKILL,
3983 "bluestooth state saved to NVRAM\n");
3986 static void bluetooth_exit(void)
3988 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3989 &bluetooth_attr_group);
3991 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
3993 bluetooth_shutdown();
3996 static int __init bluetooth_init(struct ibm_init_struct *iibm)
3998 int res;
3999 int status = 0;
4001 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4002 "initializing bluetooth subdriver\n");
4004 TPACPI_ACPIHANDLE_INIT(hkey);
4006 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4007 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4008 tp_features.bluetooth = hkey_handle &&
4009 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4011 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4012 "bluetooth is %s, status 0x%02x\n",
4013 str_supported(tp_features.bluetooth),
4014 status);
4016 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4017 if (dbg_bluetoothemul) {
4018 tp_features.bluetooth = 1;
4019 printk(TPACPI_INFO
4020 "bluetooth switch emulation enabled\n");
4021 } else
4022 #endif
4023 if (tp_features.bluetooth &&
4024 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4025 /* no bluetooth hardware present in system */
4026 tp_features.bluetooth = 0;
4027 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4028 "bluetooth hardware not installed\n");
4031 if (!tp_features.bluetooth)
4032 return 1;
4034 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4035 &bluetooth_tprfk_ops,
4036 RFKILL_TYPE_BLUETOOTH,
4037 TPACPI_RFK_BLUETOOTH_SW_NAME,
4038 true);
4039 if (res)
4040 return res;
4042 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4043 &bluetooth_attr_group);
4044 if (res) {
4045 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4046 return res;
4049 return 0;
4052 /* procfs -------------------------------------------------------------- */
4053 static int bluetooth_read(struct seq_file *m)
4055 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4058 static int bluetooth_write(char *buf)
4060 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4063 static struct ibm_struct bluetooth_driver_data = {
4064 .name = "bluetooth",
4065 .read = bluetooth_read,
4066 .write = bluetooth_write,
4067 .exit = bluetooth_exit,
4068 .shutdown = bluetooth_shutdown,
4071 /*************************************************************************
4072 * Wan subdriver
4075 enum {
4076 /* ACPI GWAN/SWAN bits */
4077 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4078 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4079 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4080 0 = disable, 1 = enable */
4083 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4085 static int wan_get_status(void)
4087 int status;
4089 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4090 if (dbg_wwanemul)
4091 return (tpacpi_wwan_emulstate) ?
4092 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4093 #endif
4095 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4096 return -EIO;
4098 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4099 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4102 static int wan_set_status(enum tpacpi_rfkill_state state)
4104 int status;
4106 vdbg_printk(TPACPI_DBG_RFKILL,
4107 "will attempt to %s wwan\n",
4108 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4110 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4111 if (dbg_wwanemul) {
4112 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4113 return 0;
4115 #endif
4117 if (state == TPACPI_RFK_RADIO_ON)
4118 status = TP_ACPI_WANCARD_RADIOSSW
4119 | TP_ACPI_WANCARD_RESUMECTRL;
4120 else
4121 status = 0;
4123 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4124 return -EIO;
4126 return 0;
4129 /* sysfs wan enable ---------------------------------------------------- */
4130 static ssize_t wan_enable_show(struct device *dev,
4131 struct device_attribute *attr,
4132 char *buf)
4134 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4135 attr, buf);
4138 static ssize_t wan_enable_store(struct device *dev,
4139 struct device_attribute *attr,
4140 const char *buf, size_t count)
4142 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4143 attr, buf, count);
4146 static struct device_attribute dev_attr_wan_enable =
4147 __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4148 wan_enable_show, wan_enable_store);
4150 /* --------------------------------------------------------------------- */
4152 static struct attribute *wan_attributes[] = {
4153 &dev_attr_wan_enable.attr,
4154 NULL
4157 static const struct attribute_group wan_attr_group = {
4158 .attrs = wan_attributes,
4161 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4162 .get_status = wan_get_status,
4163 .set_status = wan_set_status,
4166 static void wan_shutdown(void)
4168 /* Order firmware to save current state to NVRAM */
4169 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4170 TP_ACPI_WGSV_SAVE_STATE))
4171 printk(TPACPI_NOTICE
4172 "failed to save WWAN state to NVRAM\n");
4173 else
4174 vdbg_printk(TPACPI_DBG_RFKILL,
4175 "WWAN state saved to NVRAM\n");
4178 static void wan_exit(void)
4180 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4181 &wan_attr_group);
4183 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4185 wan_shutdown();
4188 static int __init wan_init(struct ibm_init_struct *iibm)
4190 int res;
4191 int status = 0;
4193 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4194 "initializing wan subdriver\n");
4196 TPACPI_ACPIHANDLE_INIT(hkey);
4198 tp_features.wan = hkey_handle &&
4199 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4201 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4202 "wan is %s, status 0x%02x\n",
4203 str_supported(tp_features.wan),
4204 status);
4206 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4207 if (dbg_wwanemul) {
4208 tp_features.wan = 1;
4209 printk(TPACPI_INFO
4210 "wwan switch emulation enabled\n");
4211 } else
4212 #endif
4213 if (tp_features.wan &&
4214 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4215 /* no wan hardware present in system */
4216 tp_features.wan = 0;
4217 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4218 "wan hardware not installed\n");
4221 if (!tp_features.wan)
4222 return 1;
4224 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4225 &wan_tprfk_ops,
4226 RFKILL_TYPE_WWAN,
4227 TPACPI_RFK_WWAN_SW_NAME,
4228 true);
4229 if (res)
4230 return res;
4232 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4233 &wan_attr_group);
4235 if (res) {
4236 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4237 return res;
4240 return 0;
4243 /* procfs -------------------------------------------------------------- */
4244 static int wan_read(struct seq_file *m)
4246 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4249 static int wan_write(char *buf)
4251 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4254 static struct ibm_struct wan_driver_data = {
4255 .name = "wan",
4256 .read = wan_read,
4257 .write = wan_write,
4258 .exit = wan_exit,
4259 .shutdown = wan_shutdown,
4262 /*************************************************************************
4263 * UWB subdriver
4266 enum {
4267 /* ACPI GUWB/SUWB bits */
4268 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4269 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4272 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4274 static int uwb_get_status(void)
4276 int status;
4278 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4279 if (dbg_uwbemul)
4280 return (tpacpi_uwb_emulstate) ?
4281 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4282 #endif
4284 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4285 return -EIO;
4287 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4288 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4291 static int uwb_set_status(enum tpacpi_rfkill_state state)
4293 int status;
4295 vdbg_printk(TPACPI_DBG_RFKILL,
4296 "will attempt to %s UWB\n",
4297 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4299 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4300 if (dbg_uwbemul) {
4301 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4302 return 0;
4304 #endif
4306 if (state == TPACPI_RFK_RADIO_ON)
4307 status = TP_ACPI_UWB_RADIOSSW;
4308 else
4309 status = 0;
4311 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4312 return -EIO;
4314 return 0;
4317 /* --------------------------------------------------------------------- */
4319 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4320 .get_status = uwb_get_status,
4321 .set_status = uwb_set_status,
4324 static void uwb_exit(void)
4326 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4329 static int __init uwb_init(struct ibm_init_struct *iibm)
4331 int res;
4332 int status = 0;
4334 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4335 "initializing uwb subdriver\n");
4337 TPACPI_ACPIHANDLE_INIT(hkey);
4339 tp_features.uwb = hkey_handle &&
4340 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4342 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4343 "uwb is %s, status 0x%02x\n",
4344 str_supported(tp_features.uwb),
4345 status);
4347 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4348 if (dbg_uwbemul) {
4349 tp_features.uwb = 1;
4350 printk(TPACPI_INFO
4351 "uwb switch emulation enabled\n");
4352 } else
4353 #endif
4354 if (tp_features.uwb &&
4355 !(status & TP_ACPI_UWB_HWPRESENT)) {
4356 /* no uwb hardware present in system */
4357 tp_features.uwb = 0;
4358 dbg_printk(TPACPI_DBG_INIT,
4359 "uwb hardware not installed\n");
4362 if (!tp_features.uwb)
4363 return 1;
4365 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4366 &uwb_tprfk_ops,
4367 RFKILL_TYPE_UWB,
4368 TPACPI_RFK_UWB_SW_NAME,
4369 false);
4370 return res;
4373 static struct ibm_struct uwb_driver_data = {
4374 .name = "uwb",
4375 .exit = uwb_exit,
4376 .flags.experimental = 1,
4379 /*************************************************************************
4380 * Video subdriver
4383 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4385 enum video_access_mode {
4386 TPACPI_VIDEO_NONE = 0,
4387 TPACPI_VIDEO_570, /* 570 */
4388 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4389 TPACPI_VIDEO_NEW, /* all others */
4392 enum { /* video status flags, based on VIDEO_570 */
4393 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4394 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4395 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4398 enum { /* TPACPI_VIDEO_570 constants */
4399 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4400 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4401 * video_status_flags */
4402 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4403 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4406 static enum video_access_mode video_supported;
4407 static int video_orig_autosw;
4409 static int video_autosw_get(void);
4410 static int video_autosw_set(int enable);
4412 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4414 static int __init video_init(struct ibm_init_struct *iibm)
4416 int ivga;
4418 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4420 TPACPI_ACPIHANDLE_INIT(vid);
4421 if (tpacpi_is_ibm())
4422 TPACPI_ACPIHANDLE_INIT(vid2);
4424 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4425 /* G41, assume IVGA doesn't change */
4426 vid_handle = vid2_handle;
4428 if (!vid_handle)
4429 /* video switching not supported on R30, R31 */
4430 video_supported = TPACPI_VIDEO_NONE;
4431 else if (tpacpi_is_ibm() &&
4432 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4433 /* 570 */
4434 video_supported = TPACPI_VIDEO_570;
4435 else if (tpacpi_is_ibm() &&
4436 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4437 /* 600e/x, 770e, 770x */
4438 video_supported = TPACPI_VIDEO_770;
4439 else
4440 /* all others */
4441 video_supported = TPACPI_VIDEO_NEW;
4443 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4444 str_supported(video_supported != TPACPI_VIDEO_NONE),
4445 video_supported);
4447 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4450 static void video_exit(void)
4452 dbg_printk(TPACPI_DBG_EXIT,
4453 "restoring original video autoswitch mode\n");
4454 if (video_autosw_set(video_orig_autosw))
4455 printk(TPACPI_ERR "error while trying to restore original "
4456 "video autoswitch mode\n");
4459 static int video_outputsw_get(void)
4461 int status = 0;
4462 int i;
4464 switch (video_supported) {
4465 case TPACPI_VIDEO_570:
4466 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4467 TP_ACPI_VIDEO_570_PHSCMD))
4468 return -EIO;
4469 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4470 break;
4471 case TPACPI_VIDEO_770:
4472 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4473 return -EIO;
4474 if (i)
4475 status |= TP_ACPI_VIDEO_S_LCD;
4476 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4477 return -EIO;
4478 if (i)
4479 status |= TP_ACPI_VIDEO_S_CRT;
4480 break;
4481 case TPACPI_VIDEO_NEW:
4482 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4483 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4484 return -EIO;
4485 if (i)
4486 status |= TP_ACPI_VIDEO_S_CRT;
4488 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4489 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4490 return -EIO;
4491 if (i)
4492 status |= TP_ACPI_VIDEO_S_LCD;
4493 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4494 return -EIO;
4495 if (i)
4496 status |= TP_ACPI_VIDEO_S_DVI;
4497 break;
4498 default:
4499 return -ENOSYS;
4502 return status;
4505 static int video_outputsw_set(int status)
4507 int autosw;
4508 int res = 0;
4510 switch (video_supported) {
4511 case TPACPI_VIDEO_570:
4512 res = acpi_evalf(NULL, NULL,
4513 "\\_SB.PHS2", "vdd",
4514 TP_ACPI_VIDEO_570_PHS2CMD,
4515 status | TP_ACPI_VIDEO_570_PHS2SET);
4516 break;
4517 case TPACPI_VIDEO_770:
4518 autosw = video_autosw_get();
4519 if (autosw < 0)
4520 return autosw;
4522 res = video_autosw_set(1);
4523 if (res)
4524 return res;
4525 res = acpi_evalf(vid_handle, NULL,
4526 "ASWT", "vdd", status * 0x100, 0);
4527 if (!autosw && video_autosw_set(autosw)) {
4528 printk(TPACPI_ERR
4529 "video auto-switch left enabled due to error\n");
4530 return -EIO;
4532 break;
4533 case TPACPI_VIDEO_NEW:
4534 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4535 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4536 break;
4537 default:
4538 return -ENOSYS;
4541 return (res)? 0 : -EIO;
4544 static int video_autosw_get(void)
4546 int autosw = 0;
4548 switch (video_supported) {
4549 case TPACPI_VIDEO_570:
4550 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4551 return -EIO;
4552 break;
4553 case TPACPI_VIDEO_770:
4554 case TPACPI_VIDEO_NEW:
4555 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4556 return -EIO;
4557 break;
4558 default:
4559 return -ENOSYS;
4562 return autosw & 1;
4565 static int video_autosw_set(int enable)
4567 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4568 return -EIO;
4569 return 0;
4572 static int video_outputsw_cycle(void)
4574 int autosw = video_autosw_get();
4575 int res;
4577 if (autosw < 0)
4578 return autosw;
4580 switch (video_supported) {
4581 case TPACPI_VIDEO_570:
4582 res = video_autosw_set(1);
4583 if (res)
4584 return res;
4585 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4586 break;
4587 case TPACPI_VIDEO_770:
4588 case TPACPI_VIDEO_NEW:
4589 res = video_autosw_set(1);
4590 if (res)
4591 return res;
4592 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4593 break;
4594 default:
4595 return -ENOSYS;
4597 if (!autosw && video_autosw_set(autosw)) {
4598 printk(TPACPI_ERR
4599 "video auto-switch left enabled due to error\n");
4600 return -EIO;
4603 return (res)? 0 : -EIO;
4606 static int video_expand_toggle(void)
4608 switch (video_supported) {
4609 case TPACPI_VIDEO_570:
4610 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4611 0 : -EIO;
4612 case TPACPI_VIDEO_770:
4613 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4614 0 : -EIO;
4615 case TPACPI_VIDEO_NEW:
4616 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4617 0 : -EIO;
4618 default:
4619 return -ENOSYS;
4621 /* not reached */
4624 static int video_read(struct seq_file *m)
4626 int status, autosw;
4628 if (video_supported == TPACPI_VIDEO_NONE) {
4629 seq_printf(m, "status:\t\tnot supported\n");
4630 return 0;
4633 /* Even reads can crash X.org, so... */
4634 if (!capable(CAP_SYS_ADMIN))
4635 return -EPERM;
4637 status = video_outputsw_get();
4638 if (status < 0)
4639 return status;
4641 autosw = video_autosw_get();
4642 if (autosw < 0)
4643 return autosw;
4645 seq_printf(m, "status:\t\tsupported\n");
4646 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4647 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4648 if (video_supported == TPACPI_VIDEO_NEW)
4649 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4650 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4651 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4652 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4653 if (video_supported == TPACPI_VIDEO_NEW)
4654 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4655 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4656 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4658 return 0;
4661 static int video_write(char *buf)
4663 char *cmd;
4664 int enable, disable, status;
4665 int res;
4667 if (video_supported == TPACPI_VIDEO_NONE)
4668 return -ENODEV;
4670 /* Even reads can crash X.org, let alone writes... */
4671 if (!capable(CAP_SYS_ADMIN))
4672 return -EPERM;
4674 enable = 0;
4675 disable = 0;
4677 while ((cmd = next_cmd(&buf))) {
4678 if (strlencmp(cmd, "lcd_enable") == 0) {
4679 enable |= TP_ACPI_VIDEO_S_LCD;
4680 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4681 disable |= TP_ACPI_VIDEO_S_LCD;
4682 } else if (strlencmp(cmd, "crt_enable") == 0) {
4683 enable |= TP_ACPI_VIDEO_S_CRT;
4684 } else if (strlencmp(cmd, "crt_disable") == 0) {
4685 disable |= TP_ACPI_VIDEO_S_CRT;
4686 } else if (video_supported == TPACPI_VIDEO_NEW &&
4687 strlencmp(cmd, "dvi_enable") == 0) {
4688 enable |= TP_ACPI_VIDEO_S_DVI;
4689 } else if (video_supported == TPACPI_VIDEO_NEW &&
4690 strlencmp(cmd, "dvi_disable") == 0) {
4691 disable |= TP_ACPI_VIDEO_S_DVI;
4692 } else if (strlencmp(cmd, "auto_enable") == 0) {
4693 res = video_autosw_set(1);
4694 if (res)
4695 return res;
4696 } else if (strlencmp(cmd, "auto_disable") == 0) {
4697 res = video_autosw_set(0);
4698 if (res)
4699 return res;
4700 } else if (strlencmp(cmd, "video_switch") == 0) {
4701 res = video_outputsw_cycle();
4702 if (res)
4703 return res;
4704 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4705 res = video_expand_toggle();
4706 if (res)
4707 return res;
4708 } else
4709 return -EINVAL;
4712 if (enable || disable) {
4713 status = video_outputsw_get();
4714 if (status < 0)
4715 return status;
4716 res = video_outputsw_set((status & ~disable) | enable);
4717 if (res)
4718 return res;
4721 return 0;
4724 static struct ibm_struct video_driver_data = {
4725 .name = "video",
4726 .read = video_read,
4727 .write = video_write,
4728 .exit = video_exit,
4731 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4733 /*************************************************************************
4734 * Light (thinklight) subdriver
4737 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4738 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4740 static int light_get_status(void)
4742 int status = 0;
4744 if (tp_features.light_status) {
4745 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4746 return -EIO;
4747 return (!!status);
4750 return -ENXIO;
4753 static int light_set_status(int status)
4755 int rc;
4757 if (tp_features.light) {
4758 if (cmos_handle) {
4759 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4760 (status)?
4761 TP_CMOS_THINKLIGHT_ON :
4762 TP_CMOS_THINKLIGHT_OFF);
4763 } else {
4764 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4765 (status)? 1 : 0);
4767 return (rc)? 0 : -EIO;
4770 return -ENXIO;
4773 static void light_set_status_worker(struct work_struct *work)
4775 struct tpacpi_led_classdev *data =
4776 container_of(work, struct tpacpi_led_classdev, work);
4778 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4779 light_set_status((data->new_state != TPACPI_LED_OFF));
4782 static void light_sysfs_set(struct led_classdev *led_cdev,
4783 enum led_brightness brightness)
4785 struct tpacpi_led_classdev *data =
4786 container_of(led_cdev,
4787 struct tpacpi_led_classdev,
4788 led_classdev);
4789 data->new_state = (brightness != LED_OFF) ?
4790 TPACPI_LED_ON : TPACPI_LED_OFF;
4791 queue_work(tpacpi_wq, &data->work);
4794 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4796 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4799 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4800 .led_classdev = {
4801 .name = "tpacpi::thinklight",
4802 .brightness_set = &light_sysfs_set,
4803 .brightness_get = &light_sysfs_get,
4807 static int __init light_init(struct ibm_init_struct *iibm)
4809 int rc;
4811 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4813 if (tpacpi_is_ibm()) {
4814 TPACPI_ACPIHANDLE_INIT(ledb);
4815 TPACPI_ACPIHANDLE_INIT(lght);
4817 TPACPI_ACPIHANDLE_INIT(cmos);
4818 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4820 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4821 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4823 if (tp_features.light)
4824 /* light status not supported on
4825 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4826 tp_features.light_status =
4827 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4829 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4830 str_supported(tp_features.light),
4831 str_supported(tp_features.light_status));
4833 if (!tp_features.light)
4834 return 1;
4836 rc = led_classdev_register(&tpacpi_pdev->dev,
4837 &tpacpi_led_thinklight.led_classdev);
4839 if (rc < 0) {
4840 tp_features.light = 0;
4841 tp_features.light_status = 0;
4842 } else {
4843 rc = 0;
4846 return rc;
4849 static void light_exit(void)
4851 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4852 if (work_pending(&tpacpi_led_thinklight.work))
4853 flush_workqueue(tpacpi_wq);
4856 static int light_read(struct seq_file *m)
4858 int status;
4860 if (!tp_features.light) {
4861 seq_printf(m, "status:\t\tnot supported\n");
4862 } else if (!tp_features.light_status) {
4863 seq_printf(m, "status:\t\tunknown\n");
4864 seq_printf(m, "commands:\ton, off\n");
4865 } else {
4866 status = light_get_status();
4867 if (status < 0)
4868 return status;
4869 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4870 seq_printf(m, "commands:\ton, off\n");
4873 return 0;
4876 static int light_write(char *buf)
4878 char *cmd;
4879 int newstatus = 0;
4881 if (!tp_features.light)
4882 return -ENODEV;
4884 while ((cmd = next_cmd(&buf))) {
4885 if (strlencmp(cmd, "on") == 0) {
4886 newstatus = 1;
4887 } else if (strlencmp(cmd, "off") == 0) {
4888 newstatus = 0;
4889 } else
4890 return -EINVAL;
4893 return light_set_status(newstatus);
4896 static struct ibm_struct light_driver_data = {
4897 .name = "light",
4898 .read = light_read,
4899 .write = light_write,
4900 .exit = light_exit,
4903 /*************************************************************************
4904 * CMOS subdriver
4907 /* sysfs cmos_command -------------------------------------------------- */
4908 static ssize_t cmos_command_store(struct device *dev,
4909 struct device_attribute *attr,
4910 const char *buf, size_t count)
4912 unsigned long cmos_cmd;
4913 int res;
4915 if (parse_strtoul(buf, 21, &cmos_cmd))
4916 return -EINVAL;
4918 res = issue_thinkpad_cmos_command(cmos_cmd);
4919 return (res)? res : count;
4922 static struct device_attribute dev_attr_cmos_command =
4923 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4925 /* --------------------------------------------------------------------- */
4927 static int __init cmos_init(struct ibm_init_struct *iibm)
4929 int res;
4931 vdbg_printk(TPACPI_DBG_INIT,
4932 "initializing cmos commands subdriver\n");
4934 TPACPI_ACPIHANDLE_INIT(cmos);
4936 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4937 str_supported(cmos_handle != NULL));
4939 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4940 if (res)
4941 return res;
4943 return (cmos_handle)? 0 : 1;
4946 static void cmos_exit(void)
4948 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4951 static int cmos_read(struct seq_file *m)
4953 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4954 R30, R31, T20-22, X20-21 */
4955 if (!cmos_handle)
4956 seq_printf(m, "status:\t\tnot supported\n");
4957 else {
4958 seq_printf(m, "status:\t\tsupported\n");
4959 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
4962 return 0;
4965 static int cmos_write(char *buf)
4967 char *cmd;
4968 int cmos_cmd, res;
4970 while ((cmd = next_cmd(&buf))) {
4971 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
4972 cmos_cmd >= 0 && cmos_cmd <= 21) {
4973 /* cmos_cmd set */
4974 } else
4975 return -EINVAL;
4977 res = issue_thinkpad_cmos_command(cmos_cmd);
4978 if (res)
4979 return res;
4982 return 0;
4985 static struct ibm_struct cmos_driver_data = {
4986 .name = "cmos",
4987 .read = cmos_read,
4988 .write = cmos_write,
4989 .exit = cmos_exit,
4992 /*************************************************************************
4993 * LED subdriver
4996 enum led_access_mode {
4997 TPACPI_LED_NONE = 0,
4998 TPACPI_LED_570, /* 570 */
4999 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5000 TPACPI_LED_NEW, /* all others */
5003 enum { /* For TPACPI_LED_OLD */
5004 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5005 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5006 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5009 static enum led_access_mode led_supported;
5011 static acpi_handle led_handle;
5013 #define TPACPI_LED_NUMLEDS 16
5014 static struct tpacpi_led_classdev *tpacpi_leds;
5015 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5016 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5017 /* there's a limit of 19 chars + NULL before 2.6.26 */
5018 "tpacpi::power",
5019 "tpacpi:orange:batt",
5020 "tpacpi:green:batt",
5021 "tpacpi::dock_active",
5022 "tpacpi::bay_active",
5023 "tpacpi::dock_batt",
5024 "tpacpi::unknown_led",
5025 "tpacpi::standby",
5026 "tpacpi::dock_status1",
5027 "tpacpi::dock_status2",
5028 "tpacpi::unknown_led2",
5029 "tpacpi::unknown_led3",
5030 "tpacpi::thinkvantage",
5032 #define TPACPI_SAFE_LEDS 0x1081U
5034 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5036 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5037 return false;
5038 #else
5039 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5040 #endif
5043 static int led_get_status(const unsigned int led)
5045 int status;
5046 enum led_status_t led_s;
5048 switch (led_supported) {
5049 case TPACPI_LED_570:
5050 if (!acpi_evalf(ec_handle,
5051 &status, "GLED", "dd", 1 << led))
5052 return -EIO;
5053 led_s = (status == 0)?
5054 TPACPI_LED_OFF :
5055 ((status == 1)?
5056 TPACPI_LED_ON :
5057 TPACPI_LED_BLINK);
5058 tpacpi_led_state_cache[led] = led_s;
5059 return led_s;
5060 default:
5061 return -ENXIO;
5064 /* not reached */
5067 static int led_set_status(const unsigned int led,
5068 const enum led_status_t ledstatus)
5070 /* off, on, blink. Index is led_status_t */
5071 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5072 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5074 int rc = 0;
5076 switch (led_supported) {
5077 case TPACPI_LED_570:
5078 /* 570 */
5079 if (unlikely(led > 7))
5080 return -EINVAL;
5081 if (unlikely(tpacpi_is_led_restricted(led)))
5082 return -EPERM;
5083 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5084 (1 << led), led_sled_arg1[ledstatus]))
5085 rc = -EIO;
5086 break;
5087 case TPACPI_LED_OLD:
5088 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5089 if (unlikely(led > 7))
5090 return -EINVAL;
5091 if (unlikely(tpacpi_is_led_restricted(led)))
5092 return -EPERM;
5093 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5094 if (rc >= 0)
5095 rc = ec_write(TPACPI_LED_EC_HLBL,
5096 (ledstatus == TPACPI_LED_BLINK) << led);
5097 if (rc >= 0)
5098 rc = ec_write(TPACPI_LED_EC_HLCL,
5099 (ledstatus != TPACPI_LED_OFF) << led);
5100 break;
5101 case TPACPI_LED_NEW:
5102 /* all others */
5103 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5104 return -EINVAL;
5105 if (unlikely(tpacpi_is_led_restricted(led)))
5106 return -EPERM;
5107 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5108 led, led_led_arg1[ledstatus]))
5109 rc = -EIO;
5110 break;
5111 default:
5112 rc = -ENXIO;
5115 if (!rc)
5116 tpacpi_led_state_cache[led] = ledstatus;
5118 return rc;
5121 static void led_set_status_worker(struct work_struct *work)
5123 struct tpacpi_led_classdev *data =
5124 container_of(work, struct tpacpi_led_classdev, work);
5126 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5127 led_set_status(data->led, data->new_state);
5130 static void led_sysfs_set(struct led_classdev *led_cdev,
5131 enum led_brightness brightness)
5133 struct tpacpi_led_classdev *data = container_of(led_cdev,
5134 struct tpacpi_led_classdev, led_classdev);
5136 if (brightness == LED_OFF)
5137 data->new_state = TPACPI_LED_OFF;
5138 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5139 data->new_state = TPACPI_LED_ON;
5140 else
5141 data->new_state = TPACPI_LED_BLINK;
5143 queue_work(tpacpi_wq, &data->work);
5146 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5147 unsigned long *delay_on, unsigned long *delay_off)
5149 struct tpacpi_led_classdev *data = container_of(led_cdev,
5150 struct tpacpi_led_classdev, led_classdev);
5152 /* Can we choose the flash rate? */
5153 if (*delay_on == 0 && *delay_off == 0) {
5154 /* yes. set them to the hardware blink rate (1 Hz) */
5155 *delay_on = 500; /* ms */
5156 *delay_off = 500; /* ms */
5157 } else if ((*delay_on != 500) || (*delay_off != 500))
5158 return -EINVAL;
5160 data->new_state = TPACPI_LED_BLINK;
5161 queue_work(tpacpi_wq, &data->work);
5163 return 0;
5166 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5168 int rc;
5170 struct tpacpi_led_classdev *data = container_of(led_cdev,
5171 struct tpacpi_led_classdev, led_classdev);
5173 rc = led_get_status(data->led);
5175 if (rc == TPACPI_LED_OFF || rc < 0)
5176 rc = LED_OFF; /* no error handling in led class :( */
5177 else
5178 rc = LED_FULL;
5180 return rc;
5183 static void led_exit(void)
5185 unsigned int i;
5187 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5188 if (tpacpi_leds[i].led_classdev.name)
5189 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5192 kfree(tpacpi_leds);
5195 static int __init tpacpi_init_led(unsigned int led)
5197 int rc;
5199 tpacpi_leds[led].led = led;
5201 /* LEDs with no name don't get registered */
5202 if (!tpacpi_led_names[led])
5203 return 0;
5205 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5206 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5207 if (led_supported == TPACPI_LED_570)
5208 tpacpi_leds[led].led_classdev.brightness_get =
5209 &led_sysfs_get;
5211 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5213 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5215 rc = led_classdev_register(&tpacpi_pdev->dev,
5216 &tpacpi_leds[led].led_classdev);
5217 if (rc < 0)
5218 tpacpi_leds[led].led_classdev.name = NULL;
5220 return rc;
5223 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5224 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5225 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5226 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5228 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5229 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5230 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5231 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5232 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5233 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5234 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5235 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5237 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5238 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5239 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5240 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5241 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5243 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5244 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5245 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5246 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5248 /* (1) - may have excess leds enabled on MSB */
5250 /* Defaults (order matters, keep last, don't reorder!) */
5251 { /* Lenovo */
5252 .vendor = PCI_VENDOR_ID_LENOVO,
5253 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5254 .quirks = 0x1fffU,
5256 { /* IBM ThinkPads with no EC version string */
5257 .vendor = PCI_VENDOR_ID_IBM,
5258 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5259 .quirks = 0x00ffU,
5261 { /* IBM ThinkPads with EC version string */
5262 .vendor = PCI_VENDOR_ID_IBM,
5263 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5264 .quirks = 0x00bfU,
5268 #undef TPACPI_LEDQ_IBM
5269 #undef TPACPI_LEDQ_LNV
5271 static enum led_access_mode __init led_init_detect_mode(void)
5273 acpi_status status;
5275 if (tpacpi_is_ibm()) {
5276 /* 570 */
5277 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5278 if (ACPI_SUCCESS(status))
5279 return TPACPI_LED_570;
5281 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5282 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5283 if (ACPI_SUCCESS(status))
5284 return TPACPI_LED_OLD;
5287 /* most others */
5288 status = acpi_get_handle(ec_handle, "LED", &led_handle);
5289 if (ACPI_SUCCESS(status))
5290 return TPACPI_LED_NEW;
5292 /* R30, R31, and unknown firmwares */
5293 led_handle = NULL;
5294 return TPACPI_LED_NONE;
5297 static int __init led_init(struct ibm_init_struct *iibm)
5299 unsigned int i;
5300 int rc;
5301 unsigned long useful_leds;
5303 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5305 led_supported = led_init_detect_mode();
5307 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5308 str_supported(led_supported), led_supported);
5310 if (led_supported == TPACPI_LED_NONE)
5311 return 1;
5313 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5314 GFP_KERNEL);
5315 if (!tpacpi_leds) {
5316 printk(TPACPI_ERR "Out of memory for LED data\n");
5317 return -ENOMEM;
5320 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5321 ARRAY_SIZE(led_useful_qtable));
5323 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5324 if (!tpacpi_is_led_restricted(i) &&
5325 test_bit(i, &useful_leds)) {
5326 rc = tpacpi_init_led(i);
5327 if (rc < 0) {
5328 led_exit();
5329 return rc;
5334 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5335 printk(TPACPI_NOTICE
5336 "warning: userspace override of important "
5337 "firmware LEDs is enabled\n");
5338 #endif
5339 return 0;
5342 #define str_led_status(s) \
5343 ((s) == TPACPI_LED_OFF ? "off" : \
5344 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5346 static int led_read(struct seq_file *m)
5348 if (!led_supported) {
5349 seq_printf(m, "status:\t\tnot supported\n");
5350 return 0;
5352 seq_printf(m, "status:\t\tsupported\n");
5354 if (led_supported == TPACPI_LED_570) {
5355 /* 570 */
5356 int i, status;
5357 for (i = 0; i < 8; i++) {
5358 status = led_get_status(i);
5359 if (status < 0)
5360 return -EIO;
5361 seq_printf(m, "%d:\t\t%s\n",
5362 i, str_led_status(status));
5366 seq_printf(m, "commands:\t"
5367 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5369 return 0;
5372 static int led_write(char *buf)
5374 char *cmd;
5375 int led, rc;
5376 enum led_status_t s;
5378 if (!led_supported)
5379 return -ENODEV;
5381 while ((cmd = next_cmd(&buf))) {
5382 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5383 return -EINVAL;
5385 if (strstr(cmd, "off")) {
5386 s = TPACPI_LED_OFF;
5387 } else if (strstr(cmd, "on")) {
5388 s = TPACPI_LED_ON;
5389 } else if (strstr(cmd, "blink")) {
5390 s = TPACPI_LED_BLINK;
5391 } else {
5392 return -EINVAL;
5395 rc = led_set_status(led, s);
5396 if (rc < 0)
5397 return rc;
5400 return 0;
5403 static struct ibm_struct led_driver_data = {
5404 .name = "led",
5405 .read = led_read,
5406 .write = led_write,
5407 .exit = led_exit,
5410 /*************************************************************************
5411 * Beep subdriver
5414 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5416 #define TPACPI_BEEP_Q1 0x0001
5418 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5419 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5420 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5423 static int __init beep_init(struct ibm_init_struct *iibm)
5425 unsigned long quirks;
5427 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5429 TPACPI_ACPIHANDLE_INIT(beep);
5431 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5432 str_supported(beep_handle != NULL));
5434 quirks = tpacpi_check_quirks(beep_quirk_table,
5435 ARRAY_SIZE(beep_quirk_table));
5437 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5439 return (beep_handle)? 0 : 1;
5442 static int beep_read(struct seq_file *m)
5444 if (!beep_handle)
5445 seq_printf(m, "status:\t\tnot supported\n");
5446 else {
5447 seq_printf(m, "status:\t\tsupported\n");
5448 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5451 return 0;
5454 static int beep_write(char *buf)
5456 char *cmd;
5457 int beep_cmd;
5459 if (!beep_handle)
5460 return -ENODEV;
5462 while ((cmd = next_cmd(&buf))) {
5463 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5464 beep_cmd >= 0 && beep_cmd <= 17) {
5465 /* beep_cmd set */
5466 } else
5467 return -EINVAL;
5468 if (tp_features.beep_needs_two_args) {
5469 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5470 beep_cmd, 0))
5471 return -EIO;
5472 } else {
5473 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5474 beep_cmd))
5475 return -EIO;
5479 return 0;
5482 static struct ibm_struct beep_driver_data = {
5483 .name = "beep",
5484 .read = beep_read,
5485 .write = beep_write,
5488 /*************************************************************************
5489 * Thermal subdriver
5492 enum thermal_access_mode {
5493 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5494 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5495 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5496 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5497 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5500 enum { /* TPACPI_THERMAL_TPEC_* */
5501 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5502 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5503 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5505 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5509 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5510 struct ibm_thermal_sensors_struct {
5511 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5514 static enum thermal_access_mode thermal_read_mode;
5516 /* idx is zero-based */
5517 static int thermal_get_sensor(int idx, s32 *value)
5519 int t;
5520 s8 tmp;
5521 char tmpi[5];
5523 t = TP_EC_THERMAL_TMP0;
5525 switch (thermal_read_mode) {
5526 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5527 case TPACPI_THERMAL_TPEC_16:
5528 if (idx >= 8 && idx <= 15) {
5529 t = TP_EC_THERMAL_TMP8;
5530 idx -= 8;
5532 /* fallthrough */
5533 #endif
5534 case TPACPI_THERMAL_TPEC_8:
5535 if (idx <= 7) {
5536 if (!acpi_ec_read(t + idx, &tmp))
5537 return -EIO;
5538 *value = tmp * 1000;
5539 return 0;
5541 break;
5543 case TPACPI_THERMAL_ACPI_UPDT:
5544 if (idx <= 7) {
5545 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5546 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5547 return -EIO;
5548 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5549 return -EIO;
5550 *value = (t - 2732) * 100;
5551 return 0;
5553 break;
5555 case TPACPI_THERMAL_ACPI_TMP07:
5556 if (idx <= 7) {
5557 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5558 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5559 return -EIO;
5560 if (t > 127 || t < -127)
5561 t = TP_EC_THERMAL_TMP_NA;
5562 *value = t * 1000;
5563 return 0;
5565 break;
5567 case TPACPI_THERMAL_NONE:
5568 default:
5569 return -ENOSYS;
5572 return -EINVAL;
5575 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5577 int res, i;
5578 int n;
5580 n = 8;
5581 i = 0;
5583 if (!s)
5584 return -EINVAL;
5586 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5587 n = 16;
5589 for (i = 0 ; i < n; i++) {
5590 res = thermal_get_sensor(i, &s->temp[i]);
5591 if (res)
5592 return res;
5595 return n;
5598 static void thermal_dump_all_sensors(void)
5600 int n, i;
5601 struct ibm_thermal_sensors_struct t;
5603 n = thermal_get_sensors(&t);
5604 if (n <= 0)
5605 return;
5607 printk(TPACPI_NOTICE
5608 "temperatures (Celsius):");
5610 for (i = 0; i < n; i++) {
5611 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5612 printk(KERN_CONT " %d", (int)(t.temp[i] / 1000));
5613 else
5614 printk(KERN_CONT " N/A");
5617 printk(KERN_CONT "\n");
5620 /* sysfs temp##_input -------------------------------------------------- */
5622 static ssize_t thermal_temp_input_show(struct device *dev,
5623 struct device_attribute *attr,
5624 char *buf)
5626 struct sensor_device_attribute *sensor_attr =
5627 to_sensor_dev_attr(attr);
5628 int idx = sensor_attr->index;
5629 s32 value;
5630 int res;
5632 res = thermal_get_sensor(idx, &value);
5633 if (res)
5634 return res;
5635 if (value == TPACPI_THERMAL_SENSOR_NA)
5636 return -ENXIO;
5638 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5641 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5642 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5643 thermal_temp_input_show, NULL, _idxB)
5645 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5646 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5647 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5648 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5649 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5650 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5651 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5652 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5653 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5654 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5655 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5656 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5657 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5658 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5659 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5660 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5661 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5664 #define THERMAL_ATTRS(X) \
5665 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5667 static struct attribute *thermal_temp_input_attr[] = {
5668 THERMAL_ATTRS(8),
5669 THERMAL_ATTRS(9),
5670 THERMAL_ATTRS(10),
5671 THERMAL_ATTRS(11),
5672 THERMAL_ATTRS(12),
5673 THERMAL_ATTRS(13),
5674 THERMAL_ATTRS(14),
5675 THERMAL_ATTRS(15),
5676 THERMAL_ATTRS(0),
5677 THERMAL_ATTRS(1),
5678 THERMAL_ATTRS(2),
5679 THERMAL_ATTRS(3),
5680 THERMAL_ATTRS(4),
5681 THERMAL_ATTRS(5),
5682 THERMAL_ATTRS(6),
5683 THERMAL_ATTRS(7),
5684 NULL
5687 static const struct attribute_group thermal_temp_input16_group = {
5688 .attrs = thermal_temp_input_attr
5691 static const struct attribute_group thermal_temp_input8_group = {
5692 .attrs = &thermal_temp_input_attr[8]
5695 #undef THERMAL_SENSOR_ATTR_TEMP
5696 #undef THERMAL_ATTRS
5698 /* --------------------------------------------------------------------- */
5700 static int __init thermal_init(struct ibm_init_struct *iibm)
5702 u8 t, ta1, ta2;
5703 int i;
5704 int acpi_tmp7;
5705 int res;
5707 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5709 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5711 if (thinkpad_id.ec_model) {
5713 * Direct EC access mode: sensors at registers
5714 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5715 * non-implemented, thermal sensors return 0x80 when
5716 * not available
5719 ta1 = ta2 = 0;
5720 for (i = 0; i < 8; i++) {
5721 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5722 ta1 |= t;
5723 } else {
5724 ta1 = 0;
5725 break;
5727 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5728 ta2 |= t;
5729 } else {
5730 ta1 = 0;
5731 break;
5734 if (ta1 == 0) {
5735 /* This is sheer paranoia, but we handle it anyway */
5736 if (acpi_tmp7) {
5737 printk(TPACPI_ERR
5738 "ThinkPad ACPI EC access misbehaving, "
5739 "falling back to ACPI TMPx access "
5740 "mode\n");
5741 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5742 } else {
5743 printk(TPACPI_ERR
5744 "ThinkPad ACPI EC access misbehaving, "
5745 "disabling thermal sensors access\n");
5746 thermal_read_mode = TPACPI_THERMAL_NONE;
5748 } else {
5749 thermal_read_mode =
5750 (ta2 != 0) ?
5751 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5753 } else if (acpi_tmp7) {
5754 if (tpacpi_is_ibm() &&
5755 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5756 /* 600e/x, 770e, 770x */
5757 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5758 } else {
5759 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5760 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5762 } else {
5763 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5764 thermal_read_mode = TPACPI_THERMAL_NONE;
5767 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5768 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5769 thermal_read_mode);
5771 switch (thermal_read_mode) {
5772 case TPACPI_THERMAL_TPEC_16:
5773 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5774 &thermal_temp_input16_group);
5775 if (res)
5776 return res;
5777 break;
5778 case TPACPI_THERMAL_TPEC_8:
5779 case TPACPI_THERMAL_ACPI_TMP07:
5780 case TPACPI_THERMAL_ACPI_UPDT:
5781 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5782 &thermal_temp_input8_group);
5783 if (res)
5784 return res;
5785 break;
5786 case TPACPI_THERMAL_NONE:
5787 default:
5788 return 1;
5791 return 0;
5794 static void thermal_exit(void)
5796 switch (thermal_read_mode) {
5797 case TPACPI_THERMAL_TPEC_16:
5798 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5799 &thermal_temp_input16_group);
5800 break;
5801 case TPACPI_THERMAL_TPEC_8:
5802 case TPACPI_THERMAL_ACPI_TMP07:
5803 case TPACPI_THERMAL_ACPI_UPDT:
5804 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5805 &thermal_temp_input8_group);
5806 break;
5807 case TPACPI_THERMAL_NONE:
5808 default:
5809 break;
5813 static int thermal_read(struct seq_file *m)
5815 int n, i;
5816 struct ibm_thermal_sensors_struct t;
5818 n = thermal_get_sensors(&t);
5819 if (unlikely(n < 0))
5820 return n;
5822 seq_printf(m, "temperatures:\t");
5824 if (n > 0) {
5825 for (i = 0; i < (n - 1); i++)
5826 seq_printf(m, "%d ", t.temp[i] / 1000);
5827 seq_printf(m, "%d\n", t.temp[i] / 1000);
5828 } else
5829 seq_printf(m, "not supported\n");
5831 return 0;
5834 static struct ibm_struct thermal_driver_data = {
5835 .name = "thermal",
5836 .read = thermal_read,
5837 .exit = thermal_exit,
5840 /*************************************************************************
5841 * EC Dump subdriver
5844 static u8 ecdump_regs[256];
5846 static int ecdump_read(struct seq_file *m)
5848 int i, j;
5849 u8 v;
5851 seq_printf(m, "EC "
5852 " +00 +01 +02 +03 +04 +05 +06 +07"
5853 " +08 +09 +0a +0b +0c +0d +0e +0f\n");
5854 for (i = 0; i < 256; i += 16) {
5855 seq_printf(m, "EC 0x%02x:", i);
5856 for (j = 0; j < 16; j++) {
5857 if (!acpi_ec_read(i + j, &v))
5858 break;
5859 if (v != ecdump_regs[i + j])
5860 seq_printf(m, " *%02x", v);
5861 else
5862 seq_printf(m, " %02x", v);
5863 ecdump_regs[i + j] = v;
5865 seq_putc(m, '\n');
5866 if (j != 16)
5867 break;
5870 /* These are way too dangerous to advertise openly... */
5871 #if 0
5872 seq_printf(m, "commands:\t0x<offset> 0x<value>"
5873 " (<offset> is 00-ff, <value> is 00-ff)\n");
5874 seq_printf(m, "commands:\t0x<offset> <value> "
5875 " (<offset> is 00-ff, <value> is 0-255)\n");
5876 #endif
5877 return 0;
5880 static int ecdump_write(char *buf)
5882 char *cmd;
5883 int i, v;
5885 while ((cmd = next_cmd(&buf))) {
5886 if (sscanf(cmd, "0x%x 0x%x", &i, &v) == 2) {
5887 /* i and v set */
5888 } else if (sscanf(cmd, "0x%x %u", &i, &v) == 2) {
5889 /* i and v set */
5890 } else
5891 return -EINVAL;
5892 if (i >= 0 && i < 256 && v >= 0 && v < 256) {
5893 if (!acpi_ec_write(i, v))
5894 return -EIO;
5895 } else
5896 return -EINVAL;
5899 return 0;
5902 static struct ibm_struct ecdump_driver_data = {
5903 .name = "ecdump",
5904 .read = ecdump_read,
5905 .write = ecdump_write,
5906 .flags.experimental = 1,
5909 /*************************************************************************
5910 * Backlight/brightness subdriver
5913 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5916 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5917 * CMOS NVRAM byte 0x5E, bits 0-3.
5919 * EC HBRV (0x31) has the following layout
5920 * Bit 7: unknown function
5921 * Bit 6: unknown function
5922 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5923 * Bit 4: must be set to zero to avoid problems
5924 * Bit 3-0: backlight brightness level
5926 * brightness_get_raw returns status data in the HBRV layout
5928 * WARNING: The X61 has been verified to use HBRV for something else, so
5929 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5930 * testing on the very early *60 Lenovo models...
5933 enum {
5934 TP_EC_BACKLIGHT = 0x31,
5936 /* TP_EC_BACKLIGHT bitmasks */
5937 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5938 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5939 TP_EC_BACKLIGHT_MAPSW = 0x20,
5942 enum tpacpi_brightness_access_mode {
5943 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5944 TPACPI_BRGHT_MODE_EC, /* EC control */
5945 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5946 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5947 TPACPI_BRGHT_MODE_MAX
5950 static struct backlight_device *ibm_backlight_device;
5952 static enum tpacpi_brightness_access_mode brightness_mode =
5953 TPACPI_BRGHT_MODE_MAX;
5955 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5957 static struct mutex brightness_mutex;
5959 /* NVRAM brightness access,
5960 * call with brightness_mutex held! */
5961 static unsigned int tpacpi_brightness_nvram_get(void)
5963 u8 lnvram;
5965 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5966 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5967 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5968 lnvram &= bright_maxlvl;
5970 return lnvram;
5973 static void tpacpi_brightness_checkpoint_nvram(void)
5975 u8 lec = 0;
5976 u8 b_nvram;
5978 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
5979 return;
5981 vdbg_printk(TPACPI_DBG_BRGHT,
5982 "trying to checkpoint backlight level to NVRAM...\n");
5984 if (mutex_lock_killable(&brightness_mutex) < 0)
5985 return;
5987 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5988 goto unlock;
5989 lec &= TP_EC_BACKLIGHT_LVLMSK;
5990 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
5992 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5993 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
5994 /* NVRAM needs update */
5995 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
5996 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
5997 b_nvram |= lec;
5998 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
5999 dbg_printk(TPACPI_DBG_BRGHT,
6000 "updated NVRAM backlight level to %u (0x%02x)\n",
6001 (unsigned int) lec, (unsigned int) b_nvram);
6002 } else
6003 vdbg_printk(TPACPI_DBG_BRGHT,
6004 "NVRAM backlight level already is %u (0x%02x)\n",
6005 (unsigned int) lec, (unsigned int) b_nvram);
6007 unlock:
6008 mutex_unlock(&brightness_mutex);
6012 /* call with brightness_mutex held! */
6013 static int tpacpi_brightness_get_raw(int *status)
6015 u8 lec = 0;
6017 switch (brightness_mode) {
6018 case TPACPI_BRGHT_MODE_UCMS_STEP:
6019 *status = tpacpi_brightness_nvram_get();
6020 return 0;
6021 case TPACPI_BRGHT_MODE_EC:
6022 case TPACPI_BRGHT_MODE_ECNVRAM:
6023 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6024 return -EIO;
6025 *status = lec;
6026 return 0;
6027 default:
6028 return -ENXIO;
6032 /* call with brightness_mutex held! */
6033 /* do NOT call with illegal backlight level value */
6034 static int tpacpi_brightness_set_ec(unsigned int value)
6036 u8 lec = 0;
6038 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6039 return -EIO;
6041 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6042 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6043 (value & TP_EC_BACKLIGHT_LVLMSK))))
6044 return -EIO;
6046 return 0;
6049 /* call with brightness_mutex held! */
6050 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6052 int cmos_cmd, inc;
6053 unsigned int current_value, i;
6055 current_value = tpacpi_brightness_nvram_get();
6057 if (value == current_value)
6058 return 0;
6060 cmos_cmd = (value > current_value) ?
6061 TP_CMOS_BRIGHTNESS_UP :
6062 TP_CMOS_BRIGHTNESS_DOWN;
6063 inc = (value > current_value) ? 1 : -1;
6065 for (i = current_value; i != value; i += inc)
6066 if (issue_thinkpad_cmos_command(cmos_cmd))
6067 return -EIO;
6069 return 0;
6072 /* May return EINTR which can always be mapped to ERESTARTSYS */
6073 static int brightness_set(unsigned int value)
6075 int res;
6077 if (value > bright_maxlvl || value < 0)
6078 return -EINVAL;
6080 vdbg_printk(TPACPI_DBG_BRGHT,
6081 "set backlight level to %d\n", value);
6083 res = mutex_lock_killable(&brightness_mutex);
6084 if (res < 0)
6085 return res;
6087 switch (brightness_mode) {
6088 case TPACPI_BRGHT_MODE_EC:
6089 case TPACPI_BRGHT_MODE_ECNVRAM:
6090 res = tpacpi_brightness_set_ec(value);
6091 break;
6092 case TPACPI_BRGHT_MODE_UCMS_STEP:
6093 res = tpacpi_brightness_set_ucmsstep(value);
6094 break;
6095 default:
6096 res = -ENXIO;
6099 mutex_unlock(&brightness_mutex);
6100 return res;
6103 /* sysfs backlight class ----------------------------------------------- */
6105 static int brightness_update_status(struct backlight_device *bd)
6107 unsigned int level =
6108 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6109 bd->props.power == FB_BLANK_UNBLANK) ?
6110 bd->props.brightness : 0;
6112 dbg_printk(TPACPI_DBG_BRGHT,
6113 "backlight: attempt to set level to %d\n",
6114 level);
6116 /* it is the backlight class's job (caller) to handle
6117 * EINTR and other errors properly */
6118 return brightness_set(level);
6121 static int brightness_get(struct backlight_device *bd)
6123 int status, res;
6125 res = mutex_lock_killable(&brightness_mutex);
6126 if (res < 0)
6127 return 0;
6129 res = tpacpi_brightness_get_raw(&status);
6131 mutex_unlock(&brightness_mutex);
6133 if (res < 0)
6134 return 0;
6136 return status & TP_EC_BACKLIGHT_LVLMSK;
6139 static void tpacpi_brightness_notify_change(void)
6141 backlight_force_update(ibm_backlight_device,
6142 BACKLIGHT_UPDATE_HOTKEY);
6145 static struct backlight_ops ibm_backlight_data = {
6146 .get_brightness = brightness_get,
6147 .update_status = brightness_update_status,
6150 /* --------------------------------------------------------------------- */
6152 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6154 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6155 union acpi_object *obj;
6156 int rc;
6158 if (ACPI_SUCCESS(acpi_evaluate_object(handle, NULL, NULL, &buffer))) {
6159 obj = (union acpi_object *)buffer.pointer;
6160 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6161 printk(TPACPI_ERR "Unknown _BCL data, "
6162 "please report this to %s\n", TPACPI_MAIL);
6163 rc = 0;
6164 } else {
6165 rc = obj->package.count;
6167 } else {
6168 return 0;
6171 kfree(buffer.pointer);
6172 return rc;
6175 static acpi_status __init tpacpi_acpi_walk_find_bcl(acpi_handle handle,
6176 u32 lvl, void *context, void **rv)
6178 char name[ACPI_PATH_SEGMENT_LENGTH];
6179 struct acpi_buffer buffer = { sizeof(name), &name };
6181 if (ACPI_SUCCESS(acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer)) &&
6182 !strncmp("_BCL", name, sizeof(name) - 1)) {
6183 BUG_ON(!rv || !*rv);
6184 **(int **)rv = tpacpi_query_bcl_levels(handle);
6185 return AE_CTRL_TERMINATE;
6186 } else {
6187 return AE_OK;
6192 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6194 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6196 int status;
6197 int bcl_levels = 0;
6198 void *bcl_ptr = &bcl_levels;
6200 if (!vid_handle)
6201 TPACPI_ACPIHANDLE_INIT(vid);
6203 if (!vid_handle)
6204 return 0;
6207 * Search for a _BCL method, and execute it. This is safe on all
6208 * ThinkPads, and as a side-effect, _BCL will place a Lenovo Vista
6209 * BIOS in ACPI backlight control mode. We do NOT have to care
6210 * about calling the _BCL method in an enabled video device, any
6211 * will do for our purposes.
6214 status = acpi_walk_namespace(ACPI_TYPE_METHOD, vid_handle, 3,
6215 tpacpi_acpi_walk_find_bcl, NULL, NULL,
6216 &bcl_ptr);
6218 if (ACPI_SUCCESS(status) && bcl_levels > 2) {
6219 tp_features.bright_acpimode = 1;
6220 return bcl_levels - 2;
6223 return 0;
6227 * These are only useful for models that have only one possibility
6228 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6229 * these quirks.
6231 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6232 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6233 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6235 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6236 /* Models with ATI GPUs known to require ECNVRAM mode */
6237 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6239 /* Models with ATI GPUs that can use ECNVRAM */
6240 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6241 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6242 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6243 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6245 /* Models with Intel Extreme Graphics 2 */
6246 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6247 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6248 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6250 /* Models with Intel GMA900 */
6251 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6252 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6253 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6257 * Returns < 0 for error, otherwise sets tp_features.bright_*
6258 * and bright_maxlvl.
6260 static void __init tpacpi_detect_brightness_capabilities(void)
6262 unsigned int b;
6264 vdbg_printk(TPACPI_DBG_INIT,
6265 "detecting firmware brightness interface capabilities\n");
6267 /* we could run a quirks check here (same table used by
6268 * brightness_init) if needed */
6271 * We always attempt to detect acpi support, so as to switch
6272 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6273 * going to publish a backlight interface
6275 b = tpacpi_check_std_acpi_brightness_support();
6276 switch (b) {
6277 case 16:
6278 bright_maxlvl = 15;
6279 printk(TPACPI_INFO
6280 "detected a 16-level brightness capable ThinkPad\n");
6281 break;
6282 case 8:
6283 case 0:
6284 bright_maxlvl = 7;
6285 printk(TPACPI_INFO
6286 "detected a 8-level brightness capable ThinkPad\n");
6287 break;
6288 default:
6289 printk(TPACPI_ERR
6290 "Unsupported brightness interface, "
6291 "please contact %s\n", TPACPI_MAIL);
6292 tp_features.bright_unkfw = 1;
6293 bright_maxlvl = b - 1;
6297 static int __init brightness_init(struct ibm_init_struct *iibm)
6299 struct backlight_properties props;
6300 int b;
6301 unsigned long quirks;
6303 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6305 mutex_init(&brightness_mutex);
6307 quirks = tpacpi_check_quirks(brightness_quirk_table,
6308 ARRAY_SIZE(brightness_quirk_table));
6310 /* tpacpi_detect_brightness_capabilities() must have run already */
6312 /* if it is unknown, we don't handle it: it wouldn't be safe */
6313 if (tp_features.bright_unkfw)
6314 return 1;
6316 if (tp_features.bright_acpimode) {
6317 if (acpi_video_backlight_support()) {
6318 if (brightness_enable > 1) {
6319 printk(TPACPI_NOTICE
6320 "Standard ACPI backlight interface "
6321 "available, not loading native one.\n");
6322 return 1;
6323 } else if (brightness_enable == 1) {
6324 printk(TPACPI_NOTICE
6325 "Backlight control force enabled, even if standard "
6326 "ACPI backlight interface is available\n");
6328 } else {
6329 if (brightness_enable > 1) {
6330 printk(TPACPI_NOTICE
6331 "Standard ACPI backlight interface not "
6332 "available, thinkpad_acpi native "
6333 "brightness control enabled\n");
6338 if (!brightness_enable) {
6339 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6340 "brightness support disabled by "
6341 "module parameter\n");
6342 return 1;
6346 * Check for module parameter bogosity, note that we
6347 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6348 * able to detect "unspecified"
6350 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6351 return -EINVAL;
6353 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6354 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6355 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6356 if (quirks & TPACPI_BRGHT_Q_EC)
6357 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6358 else
6359 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6361 dbg_printk(TPACPI_DBG_BRGHT,
6362 "driver auto-selected brightness_mode=%d\n",
6363 brightness_mode);
6366 /* Safety */
6367 if (!tpacpi_is_ibm() &&
6368 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6369 brightness_mode == TPACPI_BRGHT_MODE_EC))
6370 return -EINVAL;
6372 if (tpacpi_brightness_get_raw(&b) < 0)
6373 return 1;
6375 memset(&props, 0, sizeof(struct backlight_properties));
6376 props.max_brightness = bright_maxlvl;
6377 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6378 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6379 NULL, NULL,
6380 &ibm_backlight_data,
6381 &props);
6382 if (IS_ERR(ibm_backlight_device)) {
6383 int rc = PTR_ERR(ibm_backlight_device);
6384 ibm_backlight_device = NULL;
6385 printk(TPACPI_ERR "Could not register backlight device\n");
6386 return rc;
6388 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6389 "brightness is supported\n");
6391 if (quirks & TPACPI_BRGHT_Q_ASK) {
6392 printk(TPACPI_NOTICE
6393 "brightness: will use unverified default: "
6394 "brightness_mode=%d\n", brightness_mode);
6395 printk(TPACPI_NOTICE
6396 "brightness: please report to %s whether it works well "
6397 "or not on your ThinkPad\n", TPACPI_MAIL);
6400 /* Added by mistake in early 2007. Probably useless, but it could
6401 * be working around some unknown firmware problem where the value
6402 * read at startup doesn't match the real hardware state... so leave
6403 * it in place just in case */
6404 backlight_update_status(ibm_backlight_device);
6406 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6407 "brightness: registering brightness hotkeys "
6408 "as change notification\n");
6409 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6410 | TP_ACPI_HKEY_BRGHTUP_MASK
6411 | TP_ACPI_HKEY_BRGHTDWN_MASK);;
6412 return 0;
6415 static void brightness_suspend(pm_message_t state)
6417 tpacpi_brightness_checkpoint_nvram();
6420 static void brightness_shutdown(void)
6422 tpacpi_brightness_checkpoint_nvram();
6425 static void brightness_exit(void)
6427 if (ibm_backlight_device) {
6428 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6429 "calling backlight_device_unregister()\n");
6430 backlight_device_unregister(ibm_backlight_device);
6433 tpacpi_brightness_checkpoint_nvram();
6436 static int brightness_read(struct seq_file *m)
6438 int level;
6440 level = brightness_get(NULL);
6441 if (level < 0) {
6442 seq_printf(m, "level:\t\tunreadable\n");
6443 } else {
6444 seq_printf(m, "level:\t\t%d\n", level);
6445 seq_printf(m, "commands:\tup, down\n");
6446 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6447 bright_maxlvl);
6450 return 0;
6453 static int brightness_write(char *buf)
6455 int level;
6456 int rc;
6457 char *cmd;
6459 level = brightness_get(NULL);
6460 if (level < 0)
6461 return level;
6463 while ((cmd = next_cmd(&buf))) {
6464 if (strlencmp(cmd, "up") == 0) {
6465 if (level < bright_maxlvl)
6466 level++;
6467 } else if (strlencmp(cmd, "down") == 0) {
6468 if (level > 0)
6469 level--;
6470 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6471 level >= 0 && level <= bright_maxlvl) {
6472 /* new level set */
6473 } else
6474 return -EINVAL;
6477 tpacpi_disclose_usertask("procfs brightness",
6478 "set level to %d\n", level);
6481 * Now we know what the final level should be, so we try to set it.
6482 * Doing it this way makes the syscall restartable in case of EINTR
6484 rc = brightness_set(level);
6485 if (!rc && ibm_backlight_device)
6486 backlight_force_update(ibm_backlight_device,
6487 BACKLIGHT_UPDATE_SYSFS);
6488 return (rc == -EINTR)? -ERESTARTSYS : rc;
6491 static struct ibm_struct brightness_driver_data = {
6492 .name = "brightness",
6493 .read = brightness_read,
6494 .write = brightness_write,
6495 .exit = brightness_exit,
6496 .suspend = brightness_suspend,
6497 .shutdown = brightness_shutdown,
6500 /*************************************************************************
6501 * Volume subdriver
6505 * IBM ThinkPads have a simple volume controller with MUTE gating.
6506 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6508 * Since the *61 series (and probably also the later *60 series), Lenovo
6509 * ThinkPads only implement the MUTE gate.
6511 * EC register 0x30
6512 * Bit 6: MUTE (1 mutes sound)
6513 * Bit 3-0: Volume
6514 * Other bits should be zero as far as we know.
6516 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6517 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
6518 * such as bit 7 which is used to detect repeated presses of MUTE,
6519 * and we leave them unchanged.
6522 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6524 #define TPACPI_ALSA_DRVNAME "ThinkPad EC"
6525 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6526 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6528 static int alsa_index = ~((1 << (SNDRV_CARDS - 3)) - 1); /* last three slots */
6529 static char *alsa_id = "ThinkPadEC";
6530 static int alsa_enable = SNDRV_DEFAULT_ENABLE1;
6532 struct tpacpi_alsa_data {
6533 struct snd_card *card;
6534 struct snd_ctl_elem_id *ctl_mute_id;
6535 struct snd_ctl_elem_id *ctl_vol_id;
6538 static struct snd_card *alsa_card;
6540 enum {
6541 TP_EC_AUDIO = 0x30,
6543 /* TP_EC_AUDIO bits */
6544 TP_EC_AUDIO_MUTESW = 6,
6546 /* TP_EC_AUDIO bitmasks */
6547 TP_EC_AUDIO_LVL_MSK = 0x0F,
6548 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6550 /* Maximum volume */
6551 TP_EC_VOLUME_MAX = 14,
6554 enum tpacpi_volume_access_mode {
6555 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
6556 TPACPI_VOL_MODE_EC, /* Pure EC control */
6557 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
6558 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6559 TPACPI_VOL_MODE_MAX
6562 enum tpacpi_volume_capabilities {
6563 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
6564 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
6565 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
6566 TPACPI_VOL_CAP_MAX
6569 static enum tpacpi_volume_access_mode volume_mode =
6570 TPACPI_VOL_MODE_MAX;
6572 static enum tpacpi_volume_capabilities volume_capabilities;
6573 static int volume_control_allowed;
6576 * Used to syncronize writers to TP_EC_AUDIO and
6577 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6579 static struct mutex volume_mutex;
6581 static void tpacpi_volume_checkpoint_nvram(void)
6583 u8 lec = 0;
6584 u8 b_nvram;
6585 u8 ec_mask;
6587 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6588 return;
6589 if (!volume_control_allowed)
6590 return;
6592 vdbg_printk(TPACPI_DBG_MIXER,
6593 "trying to checkpoint mixer state to NVRAM...\n");
6595 if (tp_features.mixer_no_level_control)
6596 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6597 else
6598 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6600 if (mutex_lock_killable(&volume_mutex) < 0)
6601 return;
6603 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6604 goto unlock;
6605 lec &= ec_mask;
6606 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6608 if (lec != (b_nvram & ec_mask)) {
6609 /* NVRAM needs update */
6610 b_nvram &= ~ec_mask;
6611 b_nvram |= lec;
6612 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6613 dbg_printk(TPACPI_DBG_MIXER,
6614 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6615 (unsigned int) lec, (unsigned int) b_nvram);
6616 } else {
6617 vdbg_printk(TPACPI_DBG_MIXER,
6618 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6619 (unsigned int) lec, (unsigned int) b_nvram);
6622 unlock:
6623 mutex_unlock(&volume_mutex);
6626 static int volume_get_status_ec(u8 *status)
6628 u8 s;
6630 if (!acpi_ec_read(TP_EC_AUDIO, &s))
6631 return -EIO;
6633 *status = s;
6635 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6637 return 0;
6640 static int volume_get_status(u8 *status)
6642 return volume_get_status_ec(status);
6645 static int volume_set_status_ec(const u8 status)
6647 if (!acpi_ec_write(TP_EC_AUDIO, status))
6648 return -EIO;
6650 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6652 return 0;
6655 static int volume_set_status(const u8 status)
6657 return volume_set_status_ec(status);
6660 /* returns < 0 on error, 0 on no change, 1 on change */
6661 static int __volume_set_mute_ec(const bool mute)
6663 int rc;
6664 u8 s, n;
6666 if (mutex_lock_killable(&volume_mutex) < 0)
6667 return -EINTR;
6669 rc = volume_get_status_ec(&s);
6670 if (rc)
6671 goto unlock;
6673 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6674 s & ~TP_EC_AUDIO_MUTESW_MSK;
6676 if (n != s) {
6677 rc = volume_set_status_ec(n);
6678 if (!rc)
6679 rc = 1;
6682 unlock:
6683 mutex_unlock(&volume_mutex);
6684 return rc;
6687 static int volume_alsa_set_mute(const bool mute)
6689 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6690 (mute) ? "" : "un");
6691 return __volume_set_mute_ec(mute);
6694 static int volume_set_mute(const bool mute)
6696 int rc;
6698 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6699 (mute) ? "" : "un");
6701 rc = __volume_set_mute_ec(mute);
6702 return (rc < 0) ? rc : 0;
6705 /* returns < 0 on error, 0 on no change, 1 on change */
6706 static int __volume_set_volume_ec(const u8 vol)
6708 int rc;
6709 u8 s, n;
6711 if (vol > TP_EC_VOLUME_MAX)
6712 return -EINVAL;
6714 if (mutex_lock_killable(&volume_mutex) < 0)
6715 return -EINTR;
6717 rc = volume_get_status_ec(&s);
6718 if (rc)
6719 goto unlock;
6721 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6723 if (n != s) {
6724 rc = volume_set_status_ec(n);
6725 if (!rc)
6726 rc = 1;
6729 unlock:
6730 mutex_unlock(&volume_mutex);
6731 return rc;
6734 static int volume_alsa_set_volume(const u8 vol)
6736 dbg_printk(TPACPI_DBG_MIXER,
6737 "ALSA: trying to set volume level to %hu\n", vol);
6738 return __volume_set_volume_ec(vol);
6741 static void volume_alsa_notify_change(void)
6743 struct tpacpi_alsa_data *d;
6745 if (alsa_card && alsa_card->private_data) {
6746 d = alsa_card->private_data;
6747 if (d->ctl_mute_id)
6748 snd_ctl_notify(alsa_card,
6749 SNDRV_CTL_EVENT_MASK_VALUE,
6750 d->ctl_mute_id);
6751 if (d->ctl_vol_id)
6752 snd_ctl_notify(alsa_card,
6753 SNDRV_CTL_EVENT_MASK_VALUE,
6754 d->ctl_vol_id);
6758 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6759 struct snd_ctl_elem_info *uinfo)
6761 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6762 uinfo->count = 1;
6763 uinfo->value.integer.min = 0;
6764 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6765 return 0;
6768 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6769 struct snd_ctl_elem_value *ucontrol)
6771 u8 s;
6772 int rc;
6774 rc = volume_get_status(&s);
6775 if (rc < 0)
6776 return rc;
6778 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6779 return 0;
6782 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6783 struct snd_ctl_elem_value *ucontrol)
6785 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
6786 ucontrol->value.integer.value[0]);
6787 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6790 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
6792 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6793 struct snd_ctl_elem_value *ucontrol)
6795 u8 s;
6796 int rc;
6798 rc = volume_get_status(&s);
6799 if (rc < 0)
6800 return rc;
6802 ucontrol->value.integer.value[0] =
6803 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6804 return 0;
6807 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6808 struct snd_ctl_elem_value *ucontrol)
6810 tpacpi_disclose_usertask("ALSA", "%smute\n",
6811 ucontrol->value.integer.value[0] ?
6812 "un" : "");
6813 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6816 static struct snd_kcontrol_new volume_alsa_control_vol __devinitdata = {
6817 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6818 .name = "Console Playback Volume",
6819 .index = 0,
6820 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6821 .info = volume_alsa_vol_info,
6822 .get = volume_alsa_vol_get,
6825 static struct snd_kcontrol_new volume_alsa_control_mute __devinitdata = {
6826 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6827 .name = "Console Playback Switch",
6828 .index = 0,
6829 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6830 .info = volume_alsa_mute_info,
6831 .get = volume_alsa_mute_get,
6834 static void volume_suspend(pm_message_t state)
6836 tpacpi_volume_checkpoint_nvram();
6839 static void volume_resume(void)
6841 volume_alsa_notify_change();
6844 static void volume_shutdown(void)
6846 tpacpi_volume_checkpoint_nvram();
6849 static void volume_exit(void)
6851 if (alsa_card) {
6852 snd_card_free(alsa_card);
6853 alsa_card = NULL;
6856 tpacpi_volume_checkpoint_nvram();
6859 static int __init volume_create_alsa_mixer(void)
6861 struct snd_card *card;
6862 struct tpacpi_alsa_data *data;
6863 struct snd_kcontrol *ctl_vol;
6864 struct snd_kcontrol *ctl_mute;
6865 int rc;
6867 rc = snd_card_create(alsa_index, alsa_id, THIS_MODULE,
6868 sizeof(struct tpacpi_alsa_data), &card);
6869 if (rc < 0 || !card) {
6870 printk(TPACPI_ERR
6871 "Failed to create ALSA card structures: %d\n", rc);
6872 return 1;
6875 BUG_ON(!card->private_data);
6876 data = card->private_data;
6877 data->card = card;
6879 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6880 sizeof(card->driver));
6881 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6882 sizeof(card->shortname));
6883 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6884 (thinkpad_id.ec_version_str) ?
6885 thinkpad_id.ec_version_str : "(unknown)");
6886 snprintf(card->longname, sizeof(card->longname),
6887 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6888 (thinkpad_id.ec_version_str) ?
6889 thinkpad_id.ec_version_str : "unknown");
6891 if (volume_control_allowed) {
6892 volume_alsa_control_vol.put = volume_alsa_vol_put;
6893 volume_alsa_control_vol.access =
6894 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6896 volume_alsa_control_mute.put = volume_alsa_mute_put;
6897 volume_alsa_control_mute.access =
6898 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6901 if (!tp_features.mixer_no_level_control) {
6902 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6903 rc = snd_ctl_add(card, ctl_vol);
6904 if (rc < 0) {
6905 printk(TPACPI_ERR
6906 "Failed to create ALSA volume control: %d\n",
6907 rc);
6908 goto err_exit;
6910 data->ctl_vol_id = &ctl_vol->id;
6913 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6914 rc = snd_ctl_add(card, ctl_mute);
6915 if (rc < 0) {
6916 printk(TPACPI_ERR "Failed to create ALSA mute control: %d\n",
6917 rc);
6918 goto err_exit;
6920 data->ctl_mute_id = &ctl_mute->id;
6922 snd_card_set_dev(card, &tpacpi_pdev->dev);
6923 rc = snd_card_register(card);
6924 if (rc < 0) {
6925 printk(TPACPI_ERR "Failed to register ALSA card: %d\n", rc);
6926 goto err_exit;
6929 alsa_card = card;
6930 return 0;
6932 err_exit:
6933 snd_card_free(card);
6934 return 1;
6937 #define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
6938 #define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
6940 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6941 /* Whitelist volume level on all IBM by default */
6942 { .vendor = PCI_VENDOR_ID_IBM,
6943 .bios = TPACPI_MATCH_ANY,
6944 .ec = TPACPI_MATCH_ANY,
6945 .quirks = TPACPI_VOL_Q_LEVEL },
6947 /* Lenovo models with volume control (needs confirmation) */
6948 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6949 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6950 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6951 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6952 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6953 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6954 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6956 /* Whitelist mute-only on all Lenovo by default */
6957 { .vendor = PCI_VENDOR_ID_LENOVO,
6958 .bios = TPACPI_MATCH_ANY,
6959 .ec = TPACPI_MATCH_ANY,
6960 .quirks = TPACPI_VOL_Q_MUTEONLY }
6963 static int __init volume_init(struct ibm_init_struct *iibm)
6965 unsigned long quirks;
6966 int rc;
6968 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
6970 mutex_init(&volume_mutex);
6973 * Check for module parameter bogosity, note that we
6974 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
6975 * able to detect "unspecified"
6977 if (volume_mode > TPACPI_VOL_MODE_MAX)
6978 return -EINVAL;
6980 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
6981 printk(TPACPI_ERR
6982 "UCMS step volume mode not implemented, "
6983 "please contact %s\n", TPACPI_MAIL);
6984 return 1;
6987 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
6988 return -EINVAL;
6991 * The ALSA mixer is our primary interface.
6992 * When disabled, don't install the subdriver at all
6994 if (!alsa_enable) {
6995 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6996 "ALSA mixer disabled by parameter, "
6997 "not loading volume subdriver...\n");
6998 return 1;
7001 quirks = tpacpi_check_quirks(volume_quirk_table,
7002 ARRAY_SIZE(volume_quirk_table));
7004 switch (volume_capabilities) {
7005 case TPACPI_VOL_CAP_AUTO:
7006 if (quirks & TPACPI_VOL_Q_MUTEONLY)
7007 tp_features.mixer_no_level_control = 1;
7008 else if (quirks & TPACPI_VOL_Q_LEVEL)
7009 tp_features.mixer_no_level_control = 0;
7010 else
7011 return 1; /* no mixer */
7012 break;
7013 case TPACPI_VOL_CAP_VOLMUTE:
7014 tp_features.mixer_no_level_control = 0;
7015 break;
7016 case TPACPI_VOL_CAP_MUTEONLY:
7017 tp_features.mixer_no_level_control = 1;
7018 break;
7019 default:
7020 return 1;
7023 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7024 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7025 "using user-supplied volume_capabilities=%d\n",
7026 volume_capabilities);
7028 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7029 volume_mode == TPACPI_VOL_MODE_MAX) {
7030 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7032 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7033 "driver auto-selected volume_mode=%d\n",
7034 volume_mode);
7035 } else {
7036 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7037 "using user-supplied volume_mode=%d\n",
7038 volume_mode);
7041 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7042 "mute is supported, volume control is %s\n",
7043 str_supported(!tp_features.mixer_no_level_control));
7045 rc = volume_create_alsa_mixer();
7046 if (rc) {
7047 printk(TPACPI_ERR
7048 "Could not create the ALSA mixer interface\n");
7049 return rc;
7052 printk(TPACPI_INFO
7053 "Console audio control enabled, mode: %s\n",
7054 (volume_control_allowed) ?
7055 "override (read/write)" :
7056 "monitor (read only)");
7058 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7059 "registering volume hotkeys as change notification\n");
7060 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7061 | TP_ACPI_HKEY_VOLUP_MASK
7062 | TP_ACPI_HKEY_VOLDWN_MASK
7063 | TP_ACPI_HKEY_MUTE_MASK);
7065 return 0;
7068 static int volume_read(struct seq_file *m)
7070 u8 status;
7072 if (volume_get_status(&status) < 0) {
7073 seq_printf(m, "level:\t\tunreadable\n");
7074 } else {
7075 if (tp_features.mixer_no_level_control)
7076 seq_printf(m, "level:\t\tunsupported\n");
7077 else
7078 seq_printf(m, "level:\t\t%d\n",
7079 status & TP_EC_AUDIO_LVL_MSK);
7081 seq_printf(m, "mute:\t\t%s\n",
7082 onoff(status, TP_EC_AUDIO_MUTESW));
7084 if (volume_control_allowed) {
7085 seq_printf(m, "commands:\tunmute, mute\n");
7086 if (!tp_features.mixer_no_level_control) {
7087 seq_printf(m,
7088 "commands:\tup, down\n");
7089 seq_printf(m,
7090 "commands:\tlevel <level>"
7091 " (<level> is 0-%d)\n",
7092 TP_EC_VOLUME_MAX);
7097 return 0;
7100 static int volume_write(char *buf)
7102 u8 s;
7103 u8 new_level, new_mute;
7104 int l;
7105 char *cmd;
7106 int rc;
7109 * We do allow volume control at driver startup, so that the
7110 * user can set initial state through the volume=... parameter hack.
7112 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7113 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7114 tp_warned.volume_ctrl_forbidden = 1;
7115 printk(TPACPI_NOTICE
7116 "Console audio control in monitor mode, "
7117 "changes are not allowed.\n");
7118 printk(TPACPI_NOTICE
7119 "Use the volume_control=1 module parameter "
7120 "to enable volume control\n");
7122 return -EPERM;
7125 rc = volume_get_status(&s);
7126 if (rc < 0)
7127 return rc;
7129 new_level = s & TP_EC_AUDIO_LVL_MSK;
7130 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7132 while ((cmd = next_cmd(&buf))) {
7133 if (!tp_features.mixer_no_level_control) {
7134 if (strlencmp(cmd, "up") == 0) {
7135 if (new_mute)
7136 new_mute = 0;
7137 else if (new_level < TP_EC_VOLUME_MAX)
7138 new_level++;
7139 continue;
7140 } else if (strlencmp(cmd, "down") == 0) {
7141 if (new_mute)
7142 new_mute = 0;
7143 else if (new_level > 0)
7144 new_level--;
7145 continue;
7146 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7147 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7148 new_level = l;
7149 continue;
7152 if (strlencmp(cmd, "mute") == 0)
7153 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7154 else if (strlencmp(cmd, "unmute") == 0)
7155 new_mute = 0;
7156 else
7157 return -EINVAL;
7160 if (tp_features.mixer_no_level_control) {
7161 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7162 new_mute ? "" : "un");
7163 rc = volume_set_mute(!!new_mute);
7164 } else {
7165 tpacpi_disclose_usertask("procfs volume",
7166 "%smute and set level to %d\n",
7167 new_mute ? "" : "un", new_level);
7168 rc = volume_set_status(new_mute | new_level);
7170 volume_alsa_notify_change();
7172 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7175 static struct ibm_struct volume_driver_data = {
7176 .name = "volume",
7177 .read = volume_read,
7178 .write = volume_write,
7179 .exit = volume_exit,
7180 .suspend = volume_suspend,
7181 .resume = volume_resume,
7182 .shutdown = volume_shutdown,
7185 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7187 #define alsa_card NULL
7189 static void inline volume_alsa_notify_change(void)
7193 static int __init volume_init(struct ibm_init_struct *iibm)
7195 printk(TPACPI_INFO
7196 "volume: disabled as there is no ALSA support in this kernel\n");
7198 return 1;
7201 static struct ibm_struct volume_driver_data = {
7202 .name = "volume",
7205 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7207 /*************************************************************************
7208 * Fan subdriver
7212 * FAN ACCESS MODES
7214 * TPACPI_FAN_RD_ACPI_GFAN:
7215 * ACPI GFAN method: returns fan level
7217 * see TPACPI_FAN_WR_ACPI_SFAN
7218 * EC 0x2f (HFSP) not available if GFAN exists
7220 * TPACPI_FAN_WR_ACPI_SFAN:
7221 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7223 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7224 * it for writing.
7226 * TPACPI_FAN_WR_TPEC:
7227 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7228 * Supported on almost all ThinkPads
7230 * Fan speed changes of any sort (including those caused by the
7231 * disengaged mode) are usually done slowly by the firmware as the
7232 * maximum amount of fan duty cycle change per second seems to be
7233 * limited.
7235 * Reading is not available if GFAN exists.
7236 * Writing is not available if SFAN exists.
7238 * Bits
7239 * 7 automatic mode engaged;
7240 * (default operation mode of the ThinkPad)
7241 * fan level is ignored in this mode.
7242 * 6 full speed mode (takes precedence over bit 7);
7243 * not available on all thinkpads. May disable
7244 * the tachometer while the fan controller ramps up
7245 * the speed (which can take up to a few *minutes*).
7246 * Speeds up fan to 100% duty-cycle, which is far above
7247 * the standard RPM levels. It is not impossible that
7248 * it could cause hardware damage.
7249 * 5-3 unused in some models. Extra bits for fan level
7250 * in others, but still useless as all values above
7251 * 7 map to the same speed as level 7 in these models.
7252 * 2-0 fan level (0..7 usually)
7253 * 0x00 = stop
7254 * 0x07 = max (set when temperatures critical)
7255 * Some ThinkPads may have other levels, see
7256 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7258 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7259 * boot. Apparently the EC does not intialize it, so unless ACPI DSDT
7260 * does so, its initial value is meaningless (0x07).
7262 * For firmware bugs, refer to:
7263 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7265 * ----
7267 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7268 * Main fan tachometer reading (in RPM)
7270 * This register is present on all ThinkPads with a new-style EC, and
7271 * it is known not to be present on the A21m/e, and T22, as there is
7272 * something else in offset 0x84 according to the ACPI DSDT. Other
7273 * ThinkPads from this same time period (and earlier) probably lack the
7274 * tachometer as well.
7276 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7277 * was never fixed by IBM to report the EC firmware version string
7278 * probably support the tachometer (like the early X models), so
7279 * detecting it is quite hard. We need more data to know for sure.
7281 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7282 * might result.
7284 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7285 * mode.
7287 * For firmware bugs, refer to:
7288 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7290 * ----
7292 * ThinkPad EC register 0x31 bit 0 (only on select models)
7294 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7295 * show the speed of the main fan. When bit 0 of EC register 0x31
7296 * is one, the tachometer registers show the speed of the auxiliary
7297 * fan.
7299 * Fan control seems to affect both fans, regardless of the state
7300 * of this bit.
7302 * So far, only the firmware for the X60/X61 non-tablet versions
7303 * seem to support this (firmware TP-7M).
7305 * TPACPI_FAN_WR_ACPI_FANS:
7306 * ThinkPad X31, X40, X41. Not available in the X60.
7308 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7309 * high speed. ACPI DSDT seems to map these three speeds to levels
7310 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7311 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7313 * The speeds are stored on handles
7314 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7316 * There are three default speed sets, accessible as handles:
7317 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7319 * ACPI DSDT switches which set is in use depending on various
7320 * factors.
7322 * TPACPI_FAN_WR_TPEC is also available and should be used to
7323 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7324 * but the ACPI tables just mention level 7.
7327 enum { /* Fan control constants */
7328 fan_status_offset = 0x2f, /* EC register 0x2f */
7329 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7330 * 0x84 must be read before 0x85 */
7331 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7332 bit 0 selects which fan is active */
7334 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
7335 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
7337 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
7340 enum fan_status_access_mode {
7341 TPACPI_FAN_NONE = 0, /* No fan status or control */
7342 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
7343 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7346 enum fan_control_access_mode {
7347 TPACPI_FAN_WR_NONE = 0, /* No fan control */
7348 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
7349 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
7350 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
7353 enum fan_control_commands {
7354 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
7355 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
7356 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
7357 * and also watchdog cmd */
7360 static int fan_control_allowed;
7362 static enum fan_status_access_mode fan_status_access_mode;
7363 static enum fan_control_access_mode fan_control_access_mode;
7364 static enum fan_control_commands fan_control_commands;
7366 static u8 fan_control_initial_status;
7367 static u8 fan_control_desired_level;
7368 static u8 fan_control_resume_level;
7369 static int fan_watchdog_maxinterval;
7371 static struct mutex fan_mutex;
7373 static void fan_watchdog_fire(struct work_struct *ignored);
7374 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7376 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
7377 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7378 "\\FSPD", /* 600e/x, 770e, 770x */
7379 ); /* all others */
7380 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7381 "JFNS", /* 770x-JL */
7382 ); /* all others */
7385 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7386 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7387 * be in auto mode (0x80).
7389 * This is corrected by any write to HFSP either by the driver, or
7390 * by the firmware.
7392 * We assume 0x07 really means auto mode while this quirk is active,
7393 * as this is far more likely than the ThinkPad being in level 7,
7394 * which is only used by the firmware during thermal emergencies.
7396 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7397 * TP-70 (T43, R52), which are known to be buggy.
7400 static void fan_quirk1_setup(void)
7402 if (fan_control_initial_status == 0x07) {
7403 printk(TPACPI_NOTICE
7404 "fan_init: initial fan status is unknown, "
7405 "assuming it is in auto mode\n");
7406 tp_features.fan_ctrl_status_undef = 1;
7410 static void fan_quirk1_handle(u8 *fan_status)
7412 if (unlikely(tp_features.fan_ctrl_status_undef)) {
7413 if (*fan_status != fan_control_initial_status) {
7414 /* something changed the HFSP regisnter since
7415 * driver init time, so it is not undefined
7416 * anymore */
7417 tp_features.fan_ctrl_status_undef = 0;
7418 } else {
7419 /* Return most likely status. In fact, it
7420 * might be the only possible status */
7421 *fan_status = TP_EC_FAN_AUTO;
7426 /* Select main fan on X60/X61, NOOP on others */
7427 static bool fan_select_fan1(void)
7429 if (tp_features.second_fan) {
7430 u8 val;
7432 if (ec_read(fan_select_offset, &val) < 0)
7433 return false;
7434 val &= 0xFEU;
7435 if (ec_write(fan_select_offset, val) < 0)
7436 return false;
7438 return true;
7441 /* Select secondary fan on X60/X61 */
7442 static bool fan_select_fan2(void)
7444 u8 val;
7446 if (!tp_features.second_fan)
7447 return false;
7449 if (ec_read(fan_select_offset, &val) < 0)
7450 return false;
7451 val |= 0x01U;
7452 if (ec_write(fan_select_offset, val) < 0)
7453 return false;
7455 return true;
7459 * Call with fan_mutex held
7461 static void fan_update_desired_level(u8 status)
7463 if ((status &
7464 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7465 if (status > 7)
7466 fan_control_desired_level = 7;
7467 else
7468 fan_control_desired_level = status;
7472 static int fan_get_status(u8 *status)
7474 u8 s;
7476 /* TODO:
7477 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7479 switch (fan_status_access_mode) {
7480 case TPACPI_FAN_RD_ACPI_GFAN:
7481 /* 570, 600e/x, 770e, 770x */
7483 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
7484 return -EIO;
7486 if (likely(status))
7487 *status = s & 0x07;
7489 break;
7491 case TPACPI_FAN_RD_TPEC:
7492 /* all except 570, 600e/x, 770e, 770x */
7493 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7494 return -EIO;
7496 if (likely(status)) {
7497 *status = s;
7498 fan_quirk1_handle(status);
7501 break;
7503 default:
7504 return -ENXIO;
7507 return 0;
7510 static int fan_get_status_safe(u8 *status)
7512 int rc;
7513 u8 s;
7515 if (mutex_lock_killable(&fan_mutex))
7516 return -ERESTARTSYS;
7517 rc = fan_get_status(&s);
7518 if (!rc)
7519 fan_update_desired_level(s);
7520 mutex_unlock(&fan_mutex);
7522 if (status)
7523 *status = s;
7525 return rc;
7528 static int fan_get_speed(unsigned int *speed)
7530 u8 hi, lo;
7532 switch (fan_status_access_mode) {
7533 case TPACPI_FAN_RD_TPEC:
7534 /* all except 570, 600e/x, 770e, 770x */
7535 if (unlikely(!fan_select_fan1()))
7536 return -EIO;
7537 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7538 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7539 return -EIO;
7541 if (likely(speed))
7542 *speed = (hi << 8) | lo;
7544 break;
7546 default:
7547 return -ENXIO;
7550 return 0;
7553 static int fan2_get_speed(unsigned int *speed)
7555 u8 hi, lo;
7556 bool rc;
7558 switch (fan_status_access_mode) {
7559 case TPACPI_FAN_RD_TPEC:
7560 /* all except 570, 600e/x, 770e, 770x */
7561 if (unlikely(!fan_select_fan2()))
7562 return -EIO;
7563 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7564 !acpi_ec_read(fan_rpm_offset + 1, &hi);
7565 fan_select_fan1(); /* play it safe */
7566 if (rc)
7567 return -EIO;
7569 if (likely(speed))
7570 *speed = (hi << 8) | lo;
7572 break;
7574 default:
7575 return -ENXIO;
7578 return 0;
7581 static int fan_set_level(int level)
7583 if (!fan_control_allowed)
7584 return -EPERM;
7586 switch (fan_control_access_mode) {
7587 case TPACPI_FAN_WR_ACPI_SFAN:
7588 if (level >= 0 && level <= 7) {
7589 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7590 return -EIO;
7591 } else
7592 return -EINVAL;
7593 break;
7595 case TPACPI_FAN_WR_ACPI_FANS:
7596 case TPACPI_FAN_WR_TPEC:
7597 if (!(level & TP_EC_FAN_AUTO) &&
7598 !(level & TP_EC_FAN_FULLSPEED) &&
7599 ((level < 0) || (level > 7)))
7600 return -EINVAL;
7602 /* safety net should the EC not support AUTO
7603 * or FULLSPEED mode bits and just ignore them */
7604 if (level & TP_EC_FAN_FULLSPEED)
7605 level |= 7; /* safety min speed 7 */
7606 else if (level & TP_EC_FAN_AUTO)
7607 level |= 4; /* safety min speed 4 */
7609 if (!acpi_ec_write(fan_status_offset, level))
7610 return -EIO;
7611 else
7612 tp_features.fan_ctrl_status_undef = 0;
7613 break;
7615 default:
7616 return -ENXIO;
7619 vdbg_printk(TPACPI_DBG_FAN,
7620 "fan control: set fan control register to 0x%02x\n", level);
7621 return 0;
7624 static int fan_set_level_safe(int level)
7626 int rc;
7628 if (!fan_control_allowed)
7629 return -EPERM;
7631 if (mutex_lock_killable(&fan_mutex))
7632 return -ERESTARTSYS;
7634 if (level == TPACPI_FAN_LAST_LEVEL)
7635 level = fan_control_desired_level;
7637 rc = fan_set_level(level);
7638 if (!rc)
7639 fan_update_desired_level(level);
7641 mutex_unlock(&fan_mutex);
7642 return rc;
7645 static int fan_set_enable(void)
7647 u8 s;
7648 int rc;
7650 if (!fan_control_allowed)
7651 return -EPERM;
7653 if (mutex_lock_killable(&fan_mutex))
7654 return -ERESTARTSYS;
7656 switch (fan_control_access_mode) {
7657 case TPACPI_FAN_WR_ACPI_FANS:
7658 case TPACPI_FAN_WR_TPEC:
7659 rc = fan_get_status(&s);
7660 if (rc < 0)
7661 break;
7663 /* Don't go out of emergency fan mode */
7664 if (s != 7) {
7665 s &= 0x07;
7666 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7669 if (!acpi_ec_write(fan_status_offset, s))
7670 rc = -EIO;
7671 else {
7672 tp_features.fan_ctrl_status_undef = 0;
7673 rc = 0;
7675 break;
7677 case TPACPI_FAN_WR_ACPI_SFAN:
7678 rc = fan_get_status(&s);
7679 if (rc < 0)
7680 break;
7682 s &= 0x07;
7684 /* Set fan to at least level 4 */
7685 s |= 4;
7687 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7688 rc = -EIO;
7689 else
7690 rc = 0;
7691 break;
7693 default:
7694 rc = -ENXIO;
7697 mutex_unlock(&fan_mutex);
7699 if (!rc)
7700 vdbg_printk(TPACPI_DBG_FAN,
7701 "fan control: set fan control register to 0x%02x\n",
7703 return rc;
7706 static int fan_set_disable(void)
7708 int rc;
7710 if (!fan_control_allowed)
7711 return -EPERM;
7713 if (mutex_lock_killable(&fan_mutex))
7714 return -ERESTARTSYS;
7716 rc = 0;
7717 switch (fan_control_access_mode) {
7718 case TPACPI_FAN_WR_ACPI_FANS:
7719 case TPACPI_FAN_WR_TPEC:
7720 if (!acpi_ec_write(fan_status_offset, 0x00))
7721 rc = -EIO;
7722 else {
7723 fan_control_desired_level = 0;
7724 tp_features.fan_ctrl_status_undef = 0;
7726 break;
7728 case TPACPI_FAN_WR_ACPI_SFAN:
7729 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7730 rc = -EIO;
7731 else
7732 fan_control_desired_level = 0;
7733 break;
7735 default:
7736 rc = -ENXIO;
7739 if (!rc)
7740 vdbg_printk(TPACPI_DBG_FAN,
7741 "fan control: set fan control register to 0\n");
7743 mutex_unlock(&fan_mutex);
7744 return rc;
7747 static int fan_set_speed(int speed)
7749 int rc;
7751 if (!fan_control_allowed)
7752 return -EPERM;
7754 if (mutex_lock_killable(&fan_mutex))
7755 return -ERESTARTSYS;
7757 rc = 0;
7758 switch (fan_control_access_mode) {
7759 case TPACPI_FAN_WR_ACPI_FANS:
7760 if (speed >= 0 && speed <= 65535) {
7761 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7762 speed, speed, speed))
7763 rc = -EIO;
7764 } else
7765 rc = -EINVAL;
7766 break;
7768 default:
7769 rc = -ENXIO;
7772 mutex_unlock(&fan_mutex);
7773 return rc;
7776 static void fan_watchdog_reset(void)
7778 static int fan_watchdog_active;
7780 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7781 return;
7783 if (fan_watchdog_active)
7784 cancel_delayed_work(&fan_watchdog_task);
7786 if (fan_watchdog_maxinterval > 0 &&
7787 tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7788 fan_watchdog_active = 1;
7789 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7790 msecs_to_jiffies(fan_watchdog_maxinterval
7791 * 1000))) {
7792 printk(TPACPI_ERR
7793 "failed to queue the fan watchdog, "
7794 "watchdog will not trigger\n");
7796 } else
7797 fan_watchdog_active = 0;
7800 static void fan_watchdog_fire(struct work_struct *ignored)
7802 int rc;
7804 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7805 return;
7807 printk(TPACPI_NOTICE "fan watchdog: enabling fan\n");
7808 rc = fan_set_enable();
7809 if (rc < 0) {
7810 printk(TPACPI_ERR "fan watchdog: error %d while enabling fan, "
7811 "will try again later...\n", -rc);
7812 /* reschedule for later */
7813 fan_watchdog_reset();
7818 * SYSFS fan layout: hwmon compatible (device)
7820 * pwm*_enable:
7821 * 0: "disengaged" mode
7822 * 1: manual mode
7823 * 2: native EC "auto" mode (recommended, hardware default)
7825 * pwm*: set speed in manual mode, ignored otherwise.
7826 * 0 is level 0; 255 is level 7. Intermediate points done with linear
7827 * interpolation.
7829 * fan*_input: tachometer reading, RPM
7832 * SYSFS fan layout: extensions
7834 * fan_watchdog (driver):
7835 * fan watchdog interval in seconds, 0 disables (default), max 120
7838 /* sysfs fan pwm1_enable ----------------------------------------------- */
7839 static ssize_t fan_pwm1_enable_show(struct device *dev,
7840 struct device_attribute *attr,
7841 char *buf)
7843 int res, mode;
7844 u8 status;
7846 res = fan_get_status_safe(&status);
7847 if (res)
7848 return res;
7850 if (status & TP_EC_FAN_FULLSPEED) {
7851 mode = 0;
7852 } else if (status & TP_EC_FAN_AUTO) {
7853 mode = 2;
7854 } else
7855 mode = 1;
7857 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7860 static ssize_t fan_pwm1_enable_store(struct device *dev,
7861 struct device_attribute *attr,
7862 const char *buf, size_t count)
7864 unsigned long t;
7865 int res, level;
7867 if (parse_strtoul(buf, 2, &t))
7868 return -EINVAL;
7870 tpacpi_disclose_usertask("hwmon pwm1_enable",
7871 "set fan mode to %lu\n", t);
7873 switch (t) {
7874 case 0:
7875 level = TP_EC_FAN_FULLSPEED;
7876 break;
7877 case 1:
7878 level = TPACPI_FAN_LAST_LEVEL;
7879 break;
7880 case 2:
7881 level = TP_EC_FAN_AUTO;
7882 break;
7883 case 3:
7884 /* reserved for software-controlled auto mode */
7885 return -ENOSYS;
7886 default:
7887 return -EINVAL;
7890 res = fan_set_level_safe(level);
7891 if (res == -ENXIO)
7892 return -EINVAL;
7893 else if (res < 0)
7894 return res;
7896 fan_watchdog_reset();
7898 return count;
7901 static struct device_attribute dev_attr_fan_pwm1_enable =
7902 __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7903 fan_pwm1_enable_show, fan_pwm1_enable_store);
7905 /* sysfs fan pwm1 ------------------------------------------------------ */
7906 static ssize_t fan_pwm1_show(struct device *dev,
7907 struct device_attribute *attr,
7908 char *buf)
7910 int res;
7911 u8 status;
7913 res = fan_get_status_safe(&status);
7914 if (res)
7915 return res;
7917 if ((status &
7918 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7919 status = fan_control_desired_level;
7921 if (status > 7)
7922 status = 7;
7924 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7927 static ssize_t fan_pwm1_store(struct device *dev,
7928 struct device_attribute *attr,
7929 const char *buf, size_t count)
7931 unsigned long s;
7932 int rc;
7933 u8 status, newlevel;
7935 if (parse_strtoul(buf, 255, &s))
7936 return -EINVAL;
7938 tpacpi_disclose_usertask("hwmon pwm1",
7939 "set fan speed to %lu\n", s);
7941 /* scale down from 0-255 to 0-7 */
7942 newlevel = (s >> 5) & 0x07;
7944 if (mutex_lock_killable(&fan_mutex))
7945 return -ERESTARTSYS;
7947 rc = fan_get_status(&status);
7948 if (!rc && (status &
7949 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7950 rc = fan_set_level(newlevel);
7951 if (rc == -ENXIO)
7952 rc = -EINVAL;
7953 else if (!rc) {
7954 fan_update_desired_level(newlevel);
7955 fan_watchdog_reset();
7959 mutex_unlock(&fan_mutex);
7960 return (rc)? rc : count;
7963 static struct device_attribute dev_attr_fan_pwm1 =
7964 __ATTR(pwm1, S_IWUSR | S_IRUGO,
7965 fan_pwm1_show, fan_pwm1_store);
7967 /* sysfs fan fan1_input ------------------------------------------------ */
7968 static ssize_t fan_fan1_input_show(struct device *dev,
7969 struct device_attribute *attr,
7970 char *buf)
7972 int res;
7973 unsigned int speed;
7975 res = fan_get_speed(&speed);
7976 if (res < 0)
7977 return res;
7979 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7982 static struct device_attribute dev_attr_fan_fan1_input =
7983 __ATTR(fan1_input, S_IRUGO,
7984 fan_fan1_input_show, NULL);
7986 /* sysfs fan fan2_input ------------------------------------------------ */
7987 static ssize_t fan_fan2_input_show(struct device *dev,
7988 struct device_attribute *attr,
7989 char *buf)
7991 int res;
7992 unsigned int speed;
7994 res = fan2_get_speed(&speed);
7995 if (res < 0)
7996 return res;
7998 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8001 static struct device_attribute dev_attr_fan_fan2_input =
8002 __ATTR(fan2_input, S_IRUGO,
8003 fan_fan2_input_show, NULL);
8005 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8006 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
8007 char *buf)
8009 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
8012 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
8013 const char *buf, size_t count)
8015 unsigned long t;
8017 if (parse_strtoul(buf, 120, &t))
8018 return -EINVAL;
8020 if (!fan_control_allowed)
8021 return -EPERM;
8023 fan_watchdog_maxinterval = t;
8024 fan_watchdog_reset();
8026 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8028 return count;
8031 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
8032 fan_fan_watchdog_show, fan_fan_watchdog_store);
8034 /* --------------------------------------------------------------------- */
8035 static struct attribute *fan_attributes[] = {
8036 &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
8037 &dev_attr_fan_fan1_input.attr,
8038 NULL, /* for fan2_input */
8039 NULL
8042 static const struct attribute_group fan_attr_group = {
8043 .attrs = fan_attributes,
8046 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
8047 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
8049 #define TPACPI_FAN_QI(__id1, __id2, __quirks) \
8050 { .vendor = PCI_VENDOR_ID_IBM, \
8051 .bios = TPACPI_MATCH_ANY, \
8052 .ec = TPID(__id1, __id2), \
8053 .quirks = __quirks }
8055 #define TPACPI_FAN_QL(__id1, __id2, __quirks) \
8056 { .vendor = PCI_VENDOR_ID_LENOVO, \
8057 .bios = TPACPI_MATCH_ANY, \
8058 .ec = TPID(__id1, __id2), \
8059 .quirks = __quirks }
8061 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8062 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
8063 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
8064 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
8065 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
8066 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
8069 #undef TPACPI_FAN_QL
8070 #undef TPACPI_FAN_QI
8072 static int __init fan_init(struct ibm_init_struct *iibm)
8074 int rc;
8075 unsigned long quirks;
8077 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8078 "initializing fan subdriver\n");
8080 mutex_init(&fan_mutex);
8081 fan_status_access_mode = TPACPI_FAN_NONE;
8082 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8083 fan_control_commands = 0;
8084 fan_watchdog_maxinterval = 0;
8085 tp_features.fan_ctrl_status_undef = 0;
8086 tp_features.second_fan = 0;
8087 fan_control_desired_level = 7;
8089 if (tpacpi_is_ibm()) {
8090 TPACPI_ACPIHANDLE_INIT(fans);
8091 TPACPI_ACPIHANDLE_INIT(gfan);
8092 TPACPI_ACPIHANDLE_INIT(sfan);
8095 quirks = tpacpi_check_quirks(fan_quirk_table,
8096 ARRAY_SIZE(fan_quirk_table));
8098 if (gfan_handle) {
8099 /* 570, 600e/x, 770e, 770x */
8100 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8101 } else {
8102 /* all other ThinkPads: note that even old-style
8103 * ThinkPad ECs supports the fan control register */
8104 if (likely(acpi_ec_read(fan_status_offset,
8105 &fan_control_initial_status))) {
8106 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8107 if (quirks & TPACPI_FAN_Q1)
8108 fan_quirk1_setup();
8109 if (quirks & TPACPI_FAN_2FAN) {
8110 tp_features.second_fan = 1;
8111 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8112 "secondary fan support enabled\n");
8114 } else {
8115 printk(TPACPI_ERR
8116 "ThinkPad ACPI EC access misbehaving, "
8117 "fan status and control unavailable\n");
8118 return 1;
8122 if (sfan_handle) {
8123 /* 570, 770x-JL */
8124 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8125 fan_control_commands |=
8126 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8127 } else {
8128 if (!gfan_handle) {
8129 /* gfan without sfan means no fan control */
8130 /* all other models implement TP EC 0x2f control */
8132 if (fans_handle) {
8133 /* X31, X40, X41 */
8134 fan_control_access_mode =
8135 TPACPI_FAN_WR_ACPI_FANS;
8136 fan_control_commands |=
8137 TPACPI_FAN_CMD_SPEED |
8138 TPACPI_FAN_CMD_LEVEL |
8139 TPACPI_FAN_CMD_ENABLE;
8140 } else {
8141 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8142 fan_control_commands |=
8143 TPACPI_FAN_CMD_LEVEL |
8144 TPACPI_FAN_CMD_ENABLE;
8149 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8150 "fan is %s, modes %d, %d\n",
8151 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8152 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8153 fan_status_access_mode, fan_control_access_mode);
8155 /* fan control master switch */
8156 if (!fan_control_allowed) {
8157 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8158 fan_control_commands = 0;
8159 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8160 "fan control features disabled by parameter\n");
8163 /* update fan_control_desired_level */
8164 if (fan_status_access_mode != TPACPI_FAN_NONE)
8165 fan_get_status_safe(NULL);
8167 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8168 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8169 if (tp_features.second_fan) {
8170 /* attach second fan tachometer */
8171 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8172 &dev_attr_fan_fan2_input.attr;
8174 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8175 &fan_attr_group);
8176 if (rc < 0)
8177 return rc;
8179 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8180 &driver_attr_fan_watchdog);
8181 if (rc < 0) {
8182 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8183 &fan_attr_group);
8184 return rc;
8186 return 0;
8187 } else
8188 return 1;
8191 static void fan_exit(void)
8193 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8194 "cancelling any pending fan watchdog tasks\n");
8196 /* FIXME: can we really do this unconditionally? */
8197 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8198 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8199 &driver_attr_fan_watchdog);
8201 cancel_delayed_work(&fan_watchdog_task);
8202 flush_workqueue(tpacpi_wq);
8205 static void fan_suspend(pm_message_t state)
8207 int rc;
8209 if (!fan_control_allowed)
8210 return;
8212 /* Store fan status in cache */
8213 fan_control_resume_level = 0;
8214 rc = fan_get_status_safe(&fan_control_resume_level);
8215 if (rc < 0)
8216 printk(TPACPI_NOTICE
8217 "failed to read fan level for later "
8218 "restore during resume: %d\n", rc);
8220 /* if it is undefined, don't attempt to restore it.
8221 * KEEP THIS LAST */
8222 if (tp_features.fan_ctrl_status_undef)
8223 fan_control_resume_level = 0;
8226 static void fan_resume(void)
8228 u8 current_level = 7;
8229 bool do_set = false;
8230 int rc;
8232 /* DSDT *always* updates status on resume */
8233 tp_features.fan_ctrl_status_undef = 0;
8235 if (!fan_control_allowed ||
8236 !fan_control_resume_level ||
8237 (fan_get_status_safe(&current_level) < 0))
8238 return;
8240 switch (fan_control_access_mode) {
8241 case TPACPI_FAN_WR_ACPI_SFAN:
8242 /* never decrease fan level */
8243 do_set = (fan_control_resume_level > current_level);
8244 break;
8245 case TPACPI_FAN_WR_ACPI_FANS:
8246 case TPACPI_FAN_WR_TPEC:
8247 /* never decrease fan level, scale is:
8248 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8250 * We expect the firmware to set either 7 or AUTO, but we
8251 * handle FULLSPEED out of paranoia.
8253 * So, we can safely only restore FULLSPEED or 7, anything
8254 * else could slow the fan. Restoring AUTO is useless, at
8255 * best that's exactly what the DSDT already set (it is the
8256 * slower it uses).
8258 * Always keep in mind that the DSDT *will* have set the
8259 * fans to what the vendor supposes is the best level. We
8260 * muck with it only to speed the fan up.
8262 if (fan_control_resume_level != 7 &&
8263 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8264 return;
8265 else
8266 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8267 (current_level != fan_control_resume_level);
8268 break;
8269 default:
8270 return;
8272 if (do_set) {
8273 printk(TPACPI_NOTICE
8274 "restoring fan level to 0x%02x\n",
8275 fan_control_resume_level);
8276 rc = fan_set_level_safe(fan_control_resume_level);
8277 if (rc < 0)
8278 printk(TPACPI_NOTICE
8279 "failed to restore fan level: %d\n", rc);
8283 static int fan_read(struct seq_file *m)
8285 int rc;
8286 u8 status;
8287 unsigned int speed = 0;
8289 switch (fan_status_access_mode) {
8290 case TPACPI_FAN_RD_ACPI_GFAN:
8291 /* 570, 600e/x, 770e, 770x */
8292 rc = fan_get_status_safe(&status);
8293 if (rc < 0)
8294 return rc;
8296 seq_printf(m, "status:\t\t%s\n"
8297 "level:\t\t%d\n",
8298 (status != 0) ? "enabled" : "disabled", status);
8299 break;
8301 case TPACPI_FAN_RD_TPEC:
8302 /* all except 570, 600e/x, 770e, 770x */
8303 rc = fan_get_status_safe(&status);
8304 if (rc < 0)
8305 return rc;
8307 seq_printf(m, "status:\t\t%s\n",
8308 (status != 0) ? "enabled" : "disabled");
8310 rc = fan_get_speed(&speed);
8311 if (rc < 0)
8312 return rc;
8314 seq_printf(m, "speed:\t\t%d\n", speed);
8316 if (status & TP_EC_FAN_FULLSPEED)
8317 /* Disengaged mode takes precedence */
8318 seq_printf(m, "level:\t\tdisengaged\n");
8319 else if (status & TP_EC_FAN_AUTO)
8320 seq_printf(m, "level:\t\tauto\n");
8321 else
8322 seq_printf(m, "level:\t\t%d\n", status);
8323 break;
8325 case TPACPI_FAN_NONE:
8326 default:
8327 seq_printf(m, "status:\t\tnot supported\n");
8330 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8331 seq_printf(m, "commands:\tlevel <level>");
8333 switch (fan_control_access_mode) {
8334 case TPACPI_FAN_WR_ACPI_SFAN:
8335 seq_printf(m, " (<level> is 0-7)\n");
8336 break;
8338 default:
8339 seq_printf(m, " (<level> is 0-7, "
8340 "auto, disengaged, full-speed)\n");
8341 break;
8345 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8346 seq_printf(m, "commands:\tenable, disable\n"
8347 "commands:\twatchdog <timeout> (<timeout> "
8348 "is 0 (off), 1-120 (seconds))\n");
8350 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8351 seq_printf(m, "commands:\tspeed <speed>"
8352 " (<speed> is 0-65535)\n");
8354 return 0;
8357 static int fan_write_cmd_level(const char *cmd, int *rc)
8359 int level;
8361 if (strlencmp(cmd, "level auto") == 0)
8362 level = TP_EC_FAN_AUTO;
8363 else if ((strlencmp(cmd, "level disengaged") == 0) |
8364 (strlencmp(cmd, "level full-speed") == 0))
8365 level = TP_EC_FAN_FULLSPEED;
8366 else if (sscanf(cmd, "level %d", &level) != 1)
8367 return 0;
8369 *rc = fan_set_level_safe(level);
8370 if (*rc == -ENXIO)
8371 printk(TPACPI_ERR "level command accepted for unsupported "
8372 "access mode %d", fan_control_access_mode);
8373 else if (!*rc)
8374 tpacpi_disclose_usertask("procfs fan",
8375 "set level to %d\n", level);
8377 return 1;
8380 static int fan_write_cmd_enable(const char *cmd, int *rc)
8382 if (strlencmp(cmd, "enable") != 0)
8383 return 0;
8385 *rc = fan_set_enable();
8386 if (*rc == -ENXIO)
8387 printk(TPACPI_ERR "enable command accepted for unsupported "
8388 "access mode %d", fan_control_access_mode);
8389 else if (!*rc)
8390 tpacpi_disclose_usertask("procfs fan", "enable\n");
8392 return 1;
8395 static int fan_write_cmd_disable(const char *cmd, int *rc)
8397 if (strlencmp(cmd, "disable") != 0)
8398 return 0;
8400 *rc = fan_set_disable();
8401 if (*rc == -ENXIO)
8402 printk(TPACPI_ERR "disable command accepted for unsupported "
8403 "access mode %d", fan_control_access_mode);
8404 else if (!*rc)
8405 tpacpi_disclose_usertask("procfs fan", "disable\n");
8407 return 1;
8410 static int fan_write_cmd_speed(const char *cmd, int *rc)
8412 int speed;
8414 /* TODO:
8415 * Support speed <low> <medium> <high> ? */
8417 if (sscanf(cmd, "speed %d", &speed) != 1)
8418 return 0;
8420 *rc = fan_set_speed(speed);
8421 if (*rc == -ENXIO)
8422 printk(TPACPI_ERR "speed command accepted for unsupported "
8423 "access mode %d", fan_control_access_mode);
8424 else if (!*rc)
8425 tpacpi_disclose_usertask("procfs fan",
8426 "set speed to %d\n", speed);
8428 return 1;
8431 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8433 int interval;
8435 if (sscanf(cmd, "watchdog %d", &interval) != 1)
8436 return 0;
8438 if (interval < 0 || interval > 120)
8439 *rc = -EINVAL;
8440 else {
8441 fan_watchdog_maxinterval = interval;
8442 tpacpi_disclose_usertask("procfs fan",
8443 "set watchdog timer to %d\n",
8444 interval);
8447 return 1;
8450 static int fan_write(char *buf)
8452 char *cmd;
8453 int rc = 0;
8455 while (!rc && (cmd = next_cmd(&buf))) {
8456 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8457 fan_write_cmd_level(cmd, &rc)) &&
8458 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8459 (fan_write_cmd_enable(cmd, &rc) ||
8460 fan_write_cmd_disable(cmd, &rc) ||
8461 fan_write_cmd_watchdog(cmd, &rc))) &&
8462 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8463 fan_write_cmd_speed(cmd, &rc))
8465 rc = -EINVAL;
8466 else if (!rc)
8467 fan_watchdog_reset();
8470 return rc;
8473 static struct ibm_struct fan_driver_data = {
8474 .name = "fan",
8475 .read = fan_read,
8476 .write = fan_write,
8477 .exit = fan_exit,
8478 .suspend = fan_suspend,
8479 .resume = fan_resume,
8482 /****************************************************************************
8483 ****************************************************************************
8485 * Infrastructure
8487 ****************************************************************************
8488 ****************************************************************************/
8491 * HKEY event callout for other subdrivers go here
8492 * (yes, it is ugly, but it is quick, safe, and gets the job done
8494 static void tpacpi_driver_event(const unsigned int hkey_event)
8496 if (ibm_backlight_device) {
8497 switch (hkey_event) {
8498 case TP_HKEY_EV_BRGHT_UP:
8499 case TP_HKEY_EV_BRGHT_DOWN:
8500 tpacpi_brightness_notify_change();
8503 if (alsa_card) {
8504 switch (hkey_event) {
8505 case TP_HKEY_EV_VOL_UP:
8506 case TP_HKEY_EV_VOL_DOWN:
8507 case TP_HKEY_EV_VOL_MUTE:
8508 volume_alsa_notify_change();
8513 static void hotkey_driver_event(const unsigned int scancode)
8515 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8518 /* sysfs name ---------------------------------------------------------- */
8519 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8520 struct device_attribute *attr,
8521 char *buf)
8523 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8526 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8527 __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8529 /* --------------------------------------------------------------------- */
8531 /* /proc support */
8532 static struct proc_dir_entry *proc_dir;
8535 * Module and infrastructure proble, init and exit handling
8538 static int force_load;
8540 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
8541 static const char * __init str_supported(int is_supported)
8543 static char text_unsupported[] __initdata = "not supported";
8545 return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8547 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8549 static void ibm_exit(struct ibm_struct *ibm)
8551 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8553 list_del_init(&ibm->all_drivers);
8555 if (ibm->flags.acpi_notify_installed) {
8556 dbg_printk(TPACPI_DBG_EXIT,
8557 "%s: acpi_remove_notify_handler\n", ibm->name);
8558 BUG_ON(!ibm->acpi);
8559 acpi_remove_notify_handler(*ibm->acpi->handle,
8560 ibm->acpi->type,
8561 dispatch_acpi_notify);
8562 ibm->flags.acpi_notify_installed = 0;
8563 ibm->flags.acpi_notify_installed = 0;
8566 if (ibm->flags.proc_created) {
8567 dbg_printk(TPACPI_DBG_EXIT,
8568 "%s: remove_proc_entry\n", ibm->name);
8569 remove_proc_entry(ibm->name, proc_dir);
8570 ibm->flags.proc_created = 0;
8573 if (ibm->flags.acpi_driver_registered) {
8574 dbg_printk(TPACPI_DBG_EXIT,
8575 "%s: acpi_bus_unregister_driver\n", ibm->name);
8576 BUG_ON(!ibm->acpi);
8577 acpi_bus_unregister_driver(ibm->acpi->driver);
8578 kfree(ibm->acpi->driver);
8579 ibm->acpi->driver = NULL;
8580 ibm->flags.acpi_driver_registered = 0;
8583 if (ibm->flags.init_called && ibm->exit) {
8584 ibm->exit();
8585 ibm->flags.init_called = 0;
8588 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8591 static int __init ibm_init(struct ibm_init_struct *iibm)
8593 int ret;
8594 struct ibm_struct *ibm = iibm->data;
8595 struct proc_dir_entry *entry;
8597 BUG_ON(ibm == NULL);
8599 INIT_LIST_HEAD(&ibm->all_drivers);
8601 if (ibm->flags.experimental && !experimental)
8602 return 0;
8604 dbg_printk(TPACPI_DBG_INIT,
8605 "probing for %s\n", ibm->name);
8607 if (iibm->init) {
8608 ret = iibm->init(iibm);
8609 if (ret > 0)
8610 return 0; /* probe failed */
8611 if (ret)
8612 return ret;
8614 ibm->flags.init_called = 1;
8617 if (ibm->acpi) {
8618 if (ibm->acpi->hid) {
8619 ret = register_tpacpi_subdriver(ibm);
8620 if (ret)
8621 goto err_out;
8624 if (ibm->acpi->notify) {
8625 ret = setup_acpi_notify(ibm);
8626 if (ret == -ENODEV) {
8627 printk(TPACPI_NOTICE "disabling subdriver %s\n",
8628 ibm->name);
8629 ret = 0;
8630 goto err_out;
8632 if (ret < 0)
8633 goto err_out;
8637 dbg_printk(TPACPI_DBG_INIT,
8638 "%s installed\n", ibm->name);
8640 if (ibm->read) {
8641 mode_t mode = iibm->base_procfs_mode;
8643 if (!mode)
8644 mode = S_IRUGO;
8645 if (ibm->write)
8646 mode |= S_IWUSR;
8647 entry = proc_create_data(ibm->name, mode, proc_dir,
8648 &dispatch_proc_fops, ibm);
8649 if (!entry) {
8650 printk(TPACPI_ERR "unable to create proc entry %s\n",
8651 ibm->name);
8652 ret = -ENODEV;
8653 goto err_out;
8655 ibm->flags.proc_created = 1;
8658 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8660 return 0;
8662 err_out:
8663 dbg_printk(TPACPI_DBG_INIT,
8664 "%s: at error exit path with result %d\n",
8665 ibm->name, ret);
8667 ibm_exit(ibm);
8668 return (ret < 0)? ret : 0;
8671 /* Probing */
8673 static bool __pure __init tpacpi_is_fw_digit(const char c)
8675 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8678 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8679 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8680 const char t)
8682 return s && strlen(s) >= 8 &&
8683 tpacpi_is_fw_digit(s[0]) &&
8684 tpacpi_is_fw_digit(s[1]) &&
8685 s[2] == t && s[3] == 'T' &&
8686 tpacpi_is_fw_digit(s[4]) &&
8687 tpacpi_is_fw_digit(s[5]) &&
8688 s[6] == 'W' && s[7] == 'W';
8691 /* returns 0 - probe ok, or < 0 - probe error.
8692 * Probe ok doesn't mean thinkpad found.
8693 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8694 static int __must_check __init get_thinkpad_model_data(
8695 struct thinkpad_id_data *tp)
8697 const struct dmi_device *dev = NULL;
8698 char ec_fw_string[18];
8699 char const *s;
8701 if (!tp)
8702 return -EINVAL;
8704 memset(tp, 0, sizeof(*tp));
8706 if (dmi_name_in_vendors("IBM"))
8707 tp->vendor = PCI_VENDOR_ID_IBM;
8708 else if (dmi_name_in_vendors("LENOVO"))
8709 tp->vendor = PCI_VENDOR_ID_LENOVO;
8710 else
8711 return 0;
8713 s = dmi_get_system_info(DMI_BIOS_VERSION);
8714 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8715 if (s && !tp->bios_version_str)
8716 return -ENOMEM;
8718 /* Really ancient ThinkPad 240X will fail this, which is fine */
8719 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
8720 return 0;
8722 tp->bios_model = tp->bios_version_str[0]
8723 | (tp->bios_version_str[1] << 8);
8724 tp->bios_release = (tp->bios_version_str[4] << 8)
8725 | tp->bios_version_str[5];
8728 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8729 * X32 or newer, all Z series; Some models must have an
8730 * up-to-date BIOS or they will not be detected.
8732 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8734 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8735 if (sscanf(dev->name,
8736 "IBM ThinkPad Embedded Controller -[%17c",
8737 ec_fw_string) == 1) {
8738 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8739 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8741 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8742 if (!tp->ec_version_str)
8743 return -ENOMEM;
8745 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8746 tp->ec_model = ec_fw_string[0]
8747 | (ec_fw_string[1] << 8);
8748 tp->ec_release = (ec_fw_string[4] << 8)
8749 | ec_fw_string[5];
8750 } else {
8751 printk(TPACPI_NOTICE
8752 "ThinkPad firmware release %s "
8753 "doesn't match the known patterns\n",
8754 ec_fw_string);
8755 printk(TPACPI_NOTICE
8756 "please report this to %s\n",
8757 TPACPI_MAIL);
8759 break;
8763 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8764 if (s && !strnicmp(s, "ThinkPad", 8)) {
8765 tp->model_str = kstrdup(s, GFP_KERNEL);
8766 if (!tp->model_str)
8767 return -ENOMEM;
8770 s = dmi_get_system_info(DMI_PRODUCT_NAME);
8771 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8772 if (s && !tp->nummodel_str)
8773 return -ENOMEM;
8775 return 0;
8778 static int __init probe_for_thinkpad(void)
8780 int is_thinkpad;
8782 if (acpi_disabled)
8783 return -ENODEV;
8785 /* It would be dangerous to run the driver in this case */
8786 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8787 return -ENODEV;
8790 * Non-ancient models have better DMI tagging, but very old models
8791 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
8793 is_thinkpad = (thinkpad_id.model_str != NULL) ||
8794 (thinkpad_id.ec_model != 0) ||
8795 tpacpi_is_fw_known();
8797 /* The EC handler is required */
8798 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
8799 if (!ec_handle) {
8800 if (is_thinkpad)
8801 printk(TPACPI_ERR
8802 "Not yet supported ThinkPad detected!\n");
8803 return -ENODEV;
8806 if (!is_thinkpad && !force_load)
8807 return -ENODEV;
8809 return 0;
8812 static void __init thinkpad_acpi_init_banner(void)
8814 printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
8815 printk(TPACPI_INFO "%s\n", TPACPI_URL);
8817 printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
8818 (thinkpad_id.bios_version_str) ?
8819 thinkpad_id.bios_version_str : "unknown",
8820 (thinkpad_id.ec_version_str) ?
8821 thinkpad_id.ec_version_str : "unknown");
8823 BUG_ON(!thinkpad_id.vendor);
8825 if (thinkpad_id.model_str)
8826 printk(TPACPI_INFO "%s %s, model %s\n",
8827 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
8828 "IBM" : ((thinkpad_id.vendor ==
8829 PCI_VENDOR_ID_LENOVO) ?
8830 "Lenovo" : "Unknown vendor"),
8831 thinkpad_id.model_str,
8832 (thinkpad_id.nummodel_str) ?
8833 thinkpad_id.nummodel_str : "unknown");
8836 /* Module init, exit, parameters */
8838 static struct ibm_init_struct ibms_init[] __initdata = {
8840 .data = &thinkpad_acpi_driver_data,
8843 .init = hotkey_init,
8844 .data = &hotkey_driver_data,
8847 .init = bluetooth_init,
8848 .data = &bluetooth_driver_data,
8851 .init = wan_init,
8852 .data = &wan_driver_data,
8855 .init = uwb_init,
8856 .data = &uwb_driver_data,
8858 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8860 .init = video_init,
8861 .base_procfs_mode = S_IRUSR,
8862 .data = &video_driver_data,
8864 #endif
8866 .init = light_init,
8867 .data = &light_driver_data,
8870 .init = cmos_init,
8871 .data = &cmos_driver_data,
8874 .init = led_init,
8875 .data = &led_driver_data,
8878 .init = beep_init,
8879 .data = &beep_driver_data,
8882 .init = thermal_init,
8883 .data = &thermal_driver_data,
8886 .data = &ecdump_driver_data,
8889 .init = brightness_init,
8890 .data = &brightness_driver_data,
8893 .init = volume_init,
8894 .data = &volume_driver_data,
8897 .init = fan_init,
8898 .data = &fan_driver_data,
8902 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8904 unsigned int i;
8905 struct ibm_struct *ibm;
8907 if (!kp || !kp->name || !val)
8908 return -EINVAL;
8910 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8911 ibm = ibms_init[i].data;
8912 WARN_ON(ibm == NULL);
8914 if (!ibm || !ibm->name)
8915 continue;
8917 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8918 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8919 return -ENOSPC;
8920 strcpy(ibms_init[i].param, val);
8921 strcat(ibms_init[i].param, ",");
8922 return 0;
8926 return -EINVAL;
8929 module_param(experimental, int, 0444);
8930 MODULE_PARM_DESC(experimental,
8931 "Enables experimental features when non-zero");
8933 module_param_named(debug, dbg_level, uint, 0);
8934 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8936 module_param(force_load, bool, 0444);
8937 MODULE_PARM_DESC(force_load,
8938 "Attempts to load the driver even on a "
8939 "mis-identified ThinkPad when true");
8941 module_param_named(fan_control, fan_control_allowed, bool, 0444);
8942 MODULE_PARM_DESC(fan_control,
8943 "Enables setting fan parameters features when true");
8945 module_param_named(brightness_mode, brightness_mode, uint, 0444);
8946 MODULE_PARM_DESC(brightness_mode,
8947 "Selects brightness control strategy: "
8948 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8950 module_param(brightness_enable, uint, 0444);
8951 MODULE_PARM_DESC(brightness_enable,
8952 "Enables backlight control when 1, disables when 0");
8954 module_param(hotkey_report_mode, uint, 0444);
8955 MODULE_PARM_DESC(hotkey_report_mode,
8956 "used for backwards compatibility with userspace, "
8957 "see documentation");
8959 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8960 module_param_named(volume_mode, volume_mode, uint, 0444);
8961 MODULE_PARM_DESC(volume_mode,
8962 "Selects volume control strategy: "
8963 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8965 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8966 MODULE_PARM_DESC(volume_capabilities,
8967 "Selects the mixer capabilites: "
8968 "0=auto, 1=volume and mute, 2=mute only");
8970 module_param_named(volume_control, volume_control_allowed, bool, 0444);
8971 MODULE_PARM_DESC(volume_control,
8972 "Enables software override for the console audio "
8973 "control when true");
8975 /* ALSA module API parameters */
8976 module_param_named(index, alsa_index, int, 0444);
8977 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8978 module_param_named(id, alsa_id, charp, 0444);
8979 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8980 module_param_named(enable, alsa_enable, bool, 0444);
8981 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8982 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8984 #define TPACPI_PARAM(feature) \
8985 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8986 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8987 "at module load, see documentation")
8989 TPACPI_PARAM(hotkey);
8990 TPACPI_PARAM(bluetooth);
8991 TPACPI_PARAM(video);
8992 TPACPI_PARAM(light);
8993 TPACPI_PARAM(cmos);
8994 TPACPI_PARAM(led);
8995 TPACPI_PARAM(beep);
8996 TPACPI_PARAM(ecdump);
8997 TPACPI_PARAM(brightness);
8998 TPACPI_PARAM(volume);
8999 TPACPI_PARAM(fan);
9001 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
9002 module_param(dbg_wlswemul, uint, 0444);
9003 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
9004 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
9005 MODULE_PARM_DESC(wlsw_state,
9006 "Initial state of the emulated WLSW switch");
9008 module_param(dbg_bluetoothemul, uint, 0444);
9009 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
9010 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
9011 MODULE_PARM_DESC(bluetooth_state,
9012 "Initial state of the emulated bluetooth switch");
9014 module_param(dbg_wwanemul, uint, 0444);
9015 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
9016 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
9017 MODULE_PARM_DESC(wwan_state,
9018 "Initial state of the emulated WWAN switch");
9020 module_param(dbg_uwbemul, uint, 0444);
9021 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
9022 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
9023 MODULE_PARM_DESC(uwb_state,
9024 "Initial state of the emulated UWB switch");
9025 #endif
9027 static void thinkpad_acpi_module_exit(void)
9029 struct ibm_struct *ibm, *itmp;
9031 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
9033 list_for_each_entry_safe_reverse(ibm, itmp,
9034 &tpacpi_all_drivers,
9035 all_drivers) {
9036 ibm_exit(ibm);
9039 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
9041 if (tpacpi_inputdev) {
9042 if (tp_features.input_device_registered)
9043 input_unregister_device(tpacpi_inputdev);
9044 else
9045 input_free_device(tpacpi_inputdev);
9048 if (tpacpi_hwmon)
9049 hwmon_device_unregister(tpacpi_hwmon);
9051 if (tp_features.sensors_pdev_attrs_registered)
9052 device_remove_file(&tpacpi_sensors_pdev->dev,
9053 &dev_attr_thinkpad_acpi_pdev_name);
9054 if (tpacpi_sensors_pdev)
9055 platform_device_unregister(tpacpi_sensors_pdev);
9056 if (tpacpi_pdev)
9057 platform_device_unregister(tpacpi_pdev);
9059 if (tp_features.sensors_pdrv_attrs_registered)
9060 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
9061 if (tp_features.platform_drv_attrs_registered)
9062 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
9064 if (tp_features.sensors_pdrv_registered)
9065 platform_driver_unregister(&tpacpi_hwmon_pdriver);
9067 if (tp_features.platform_drv_registered)
9068 platform_driver_unregister(&tpacpi_pdriver);
9070 if (proc_dir)
9071 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
9073 if (tpacpi_wq)
9074 destroy_workqueue(tpacpi_wq);
9076 kfree(thinkpad_id.bios_version_str);
9077 kfree(thinkpad_id.ec_version_str);
9078 kfree(thinkpad_id.model_str);
9082 static int __init thinkpad_acpi_module_init(void)
9084 int ret, i;
9086 tpacpi_lifecycle = TPACPI_LIFE_INIT;
9088 /* Parameter checking */
9089 if (hotkey_report_mode > 2)
9090 return -EINVAL;
9092 /* Driver-level probe */
9094 ret = get_thinkpad_model_data(&thinkpad_id);
9095 if (ret) {
9096 printk(TPACPI_ERR
9097 "unable to get DMI data: %d\n", ret);
9098 thinkpad_acpi_module_exit();
9099 return ret;
9101 ret = probe_for_thinkpad();
9102 if (ret) {
9103 thinkpad_acpi_module_exit();
9104 return ret;
9107 /* Driver initialization */
9109 thinkpad_acpi_init_banner();
9110 tpacpi_check_outdated_fw();
9112 TPACPI_ACPIHANDLE_INIT(ecrd);
9113 TPACPI_ACPIHANDLE_INIT(ecwr);
9115 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9116 if (!tpacpi_wq) {
9117 thinkpad_acpi_module_exit();
9118 return -ENOMEM;
9121 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9122 if (!proc_dir) {
9123 printk(TPACPI_ERR
9124 "unable to create proc dir " TPACPI_PROC_DIR);
9125 thinkpad_acpi_module_exit();
9126 return -ENODEV;
9129 ret = platform_driver_register(&tpacpi_pdriver);
9130 if (ret) {
9131 printk(TPACPI_ERR
9132 "unable to register main platform driver\n");
9133 thinkpad_acpi_module_exit();
9134 return ret;
9136 tp_features.platform_drv_registered = 1;
9138 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9139 if (ret) {
9140 printk(TPACPI_ERR
9141 "unable to register hwmon platform driver\n");
9142 thinkpad_acpi_module_exit();
9143 return ret;
9145 tp_features.sensors_pdrv_registered = 1;
9147 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9148 if (!ret) {
9149 tp_features.platform_drv_attrs_registered = 1;
9150 ret = tpacpi_create_driver_attributes(
9151 &tpacpi_hwmon_pdriver.driver);
9153 if (ret) {
9154 printk(TPACPI_ERR
9155 "unable to create sysfs driver attributes\n");
9156 thinkpad_acpi_module_exit();
9157 return ret;
9159 tp_features.sensors_pdrv_attrs_registered = 1;
9162 /* Device initialization */
9163 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9164 NULL, 0);
9165 if (IS_ERR(tpacpi_pdev)) {
9166 ret = PTR_ERR(tpacpi_pdev);
9167 tpacpi_pdev = NULL;
9168 printk(TPACPI_ERR "unable to register platform device\n");
9169 thinkpad_acpi_module_exit();
9170 return ret;
9172 tpacpi_sensors_pdev = platform_device_register_simple(
9173 TPACPI_HWMON_DRVR_NAME,
9174 -1, NULL, 0);
9175 if (IS_ERR(tpacpi_sensors_pdev)) {
9176 ret = PTR_ERR(tpacpi_sensors_pdev);
9177 tpacpi_sensors_pdev = NULL;
9178 printk(TPACPI_ERR
9179 "unable to register hwmon platform device\n");
9180 thinkpad_acpi_module_exit();
9181 return ret;
9183 ret = device_create_file(&tpacpi_sensors_pdev->dev,
9184 &dev_attr_thinkpad_acpi_pdev_name);
9185 if (ret) {
9186 printk(TPACPI_ERR
9187 "unable to create sysfs hwmon device attributes\n");
9188 thinkpad_acpi_module_exit();
9189 return ret;
9191 tp_features.sensors_pdev_attrs_registered = 1;
9192 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9193 if (IS_ERR(tpacpi_hwmon)) {
9194 ret = PTR_ERR(tpacpi_hwmon);
9195 tpacpi_hwmon = NULL;
9196 printk(TPACPI_ERR "unable to register hwmon device\n");
9197 thinkpad_acpi_module_exit();
9198 return ret;
9200 mutex_init(&tpacpi_inputdev_send_mutex);
9201 tpacpi_inputdev = input_allocate_device();
9202 if (!tpacpi_inputdev) {
9203 printk(TPACPI_ERR "unable to allocate input device\n");
9204 thinkpad_acpi_module_exit();
9205 return -ENOMEM;
9206 } else {
9207 /* Prepare input device, but don't register */
9208 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9209 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9210 tpacpi_inputdev->id.bustype = BUS_HOST;
9211 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9212 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9213 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9214 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9217 /* Init subdriver dependencies */
9218 tpacpi_detect_brightness_capabilities();
9220 /* Init subdrivers */
9221 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9222 ret = ibm_init(&ibms_init[i]);
9223 if (ret >= 0 && *ibms_init[i].param)
9224 ret = ibms_init[i].data->write(ibms_init[i].param);
9225 if (ret < 0) {
9226 thinkpad_acpi_module_exit();
9227 return ret;
9231 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9233 ret = input_register_device(tpacpi_inputdev);
9234 if (ret < 0) {
9235 printk(TPACPI_ERR "unable to register input device\n");
9236 thinkpad_acpi_module_exit();
9237 return ret;
9238 } else {
9239 tp_features.input_device_registered = 1;
9242 return 0;
9245 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9248 * This will autoload the driver in almost every ThinkPad
9249 * in widespread use.
9251 * Only _VERY_ old models, like the 240, 240x and 570 lack
9252 * the HKEY event interface.
9254 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9257 * DMI matching for module autoloading
9259 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9260 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9262 * Only models listed in thinkwiki will be supported, so add yours
9263 * if it is not there yet.
9265 #define IBM_BIOS_MODULE_ALIAS(__type) \
9266 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9268 /* Ancient thinkpad BIOSes have to be identified by
9269 * BIOS type or model number, and there are far less
9270 * BIOS types than model numbers... */
9271 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
9273 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9274 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9275 MODULE_DESCRIPTION(TPACPI_DESC);
9276 MODULE_VERSION(TPACPI_VERSION);
9277 MODULE_LICENSE("GPL");
9279 module_init(thinkpad_acpi_module_init);
9280 module_exit(thinkpad_acpi_module_exit);