thinkpad-acpi: make driver events work in NVRAM poll mode
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / platform / x86 / thinkpad_acpi.c
blob20b0345933f13afcfa3570d50f575ee0e276eefe
1 /*
2 * thinkpad_acpi.c - ThinkPad ACPI Extras
5 * Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6 * Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 * 02110-1301, USA.
24 #define TPACPI_VERSION "0.24"
25 #define TPACPI_SYSFS_VERSION 0x020700
28 * Changelog:
29 * 2007-10-20 changelog trimmed down
31 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
32 * drivers/misc.
34 * 2006-11-22 0.13 new maintainer
35 * changelog now lives in git commit history, and will
36 * not be updated further in-file.
38 * 2005-03-17 0.11 support for 600e, 770x
39 * thanks to Jamie Lentin <lentinj@dial.pipex.com>
41 * 2005-01-16 0.9 use MODULE_VERSION
42 * thanks to Henrik Brix Andersen <brix@gentoo.org>
43 * fix parameter passing on module loading
44 * thanks to Rusty Russell <rusty@rustcorp.com.au>
45 * thanks to Jim Radford <radford@blackbean.org>
46 * 2004-11-08 0.8 fix init error case, don't return from a macro
47 * thanks to Chris Wright <chrisw@osdl.org>
50 #include <linux/kernel.h>
51 #include <linux/module.h>
52 #include <linux/init.h>
53 #include <linux/types.h>
54 #include <linux/string.h>
55 #include <linux/list.h>
56 #include <linux/mutex.h>
57 #include <linux/sched.h>
58 #include <linux/kthread.h>
59 #include <linux/freezer.h>
60 #include <linux/delay.h>
62 #include <linux/nvram.h>
63 #include <linux/proc_fs.h>
64 #include <linux/seq_file.h>
65 #include <linux/sysfs.h>
66 #include <linux/backlight.h>
67 #include <linux/fb.h>
68 #include <linux/platform_device.h>
69 #include <linux/hwmon.h>
70 #include <linux/hwmon-sysfs.h>
71 #include <linux/input.h>
72 #include <linux/leds.h>
73 #include <linux/rfkill.h>
74 #include <asm/uaccess.h>
76 #include <linux/dmi.h>
77 #include <linux/jiffies.h>
78 #include <linux/workqueue.h>
80 #include <sound/core.h>
81 #include <sound/control.h>
82 #include <sound/initval.h>
84 #include <acpi/acpi_drivers.h>
86 #include <linux/pci_ids.h>
89 /* ThinkPad CMOS commands */
90 #define TP_CMOS_VOLUME_DOWN 0
91 #define TP_CMOS_VOLUME_UP 1
92 #define TP_CMOS_VOLUME_MUTE 2
93 #define TP_CMOS_BRIGHTNESS_UP 4
94 #define TP_CMOS_BRIGHTNESS_DOWN 5
95 #define TP_CMOS_THINKLIGHT_ON 12
96 #define TP_CMOS_THINKLIGHT_OFF 13
98 /* NVRAM Addresses */
99 enum tp_nvram_addr {
100 TP_NVRAM_ADDR_HK2 = 0x57,
101 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
102 TP_NVRAM_ADDR_VIDEO = 0x59,
103 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
104 TP_NVRAM_ADDR_MIXER = 0x60,
107 /* NVRAM bit masks */
108 enum {
109 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
110 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
111 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
112 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
113 TP_NVRAM_MASK_THINKLIGHT = 0x10,
114 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
115 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
116 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
117 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
118 TP_NVRAM_MASK_MUTE = 0x40,
119 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
120 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
121 TP_NVRAM_POS_LEVEL_VOLUME = 0,
124 /* ACPI HIDs */
125 #define TPACPI_ACPI_HKEY_HID "IBM0068"
127 /* Input IDs */
128 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
129 #define TPACPI_HKEY_INPUT_VERSION 0x4101
131 /* ACPI \WGSV commands */
132 enum {
133 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
134 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
135 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
136 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
139 /* TP_ACPI_WGSV_GET_STATE bits */
140 enum {
141 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
142 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
143 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
144 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
145 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
146 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
147 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
148 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
149 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
150 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
153 /* HKEY events */
154 enum tpacpi_hkey_event_t {
155 /* Hotkey-related */
156 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
157 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
158 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
159 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
160 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
161 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
163 /* Reasons for waking up from S3/S4 */
164 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
165 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
166 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
167 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
168 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
169 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
171 /* Auto-sleep after eject request */
172 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
173 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
175 /* Misc bay events */
176 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
178 /* User-interface events */
179 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
180 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
181 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
182 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
183 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
184 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
185 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
187 /* Thermal events */
188 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
189 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
190 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
191 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
192 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* thermal table changed */
194 /* Misc */
195 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
198 /****************************************************************************
199 * Main driver
202 #define TPACPI_NAME "thinkpad"
203 #define TPACPI_DESC "ThinkPad ACPI Extras"
204 #define TPACPI_FILE TPACPI_NAME "_acpi"
205 #define TPACPI_URL "http://ibm-acpi.sf.net/"
206 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
208 #define TPACPI_PROC_DIR "ibm"
209 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
210 #define TPACPI_DRVR_NAME TPACPI_FILE
211 #define TPACPI_DRVR_SHORTNAME "tpacpi"
212 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
214 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
215 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
217 #define TPACPI_MAX_ACPI_ARGS 3
219 /* printk headers */
220 #define TPACPI_LOG TPACPI_FILE ": "
221 #define TPACPI_EMERG KERN_EMERG TPACPI_LOG
222 #define TPACPI_ALERT KERN_ALERT TPACPI_LOG
223 #define TPACPI_CRIT KERN_CRIT TPACPI_LOG
224 #define TPACPI_ERR KERN_ERR TPACPI_LOG
225 #define TPACPI_WARN KERN_WARNING TPACPI_LOG
226 #define TPACPI_NOTICE KERN_NOTICE TPACPI_LOG
227 #define TPACPI_INFO KERN_INFO TPACPI_LOG
228 #define TPACPI_DEBUG KERN_DEBUG TPACPI_LOG
230 /* Debugging printk groups */
231 #define TPACPI_DBG_ALL 0xffff
232 #define TPACPI_DBG_DISCLOSETASK 0x8000
233 #define TPACPI_DBG_INIT 0x0001
234 #define TPACPI_DBG_EXIT 0x0002
235 #define TPACPI_DBG_RFKILL 0x0004
236 #define TPACPI_DBG_HKEY 0x0008
237 #define TPACPI_DBG_FAN 0x0010
238 #define TPACPI_DBG_BRGHT 0x0020
239 #define TPACPI_DBG_MIXER 0x0040
241 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
242 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
243 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
246 /****************************************************************************
247 * Driver-wide structs and misc. variables
250 struct ibm_struct;
252 struct tp_acpi_drv_struct {
253 const struct acpi_device_id *hid;
254 struct acpi_driver *driver;
256 void (*notify) (struct ibm_struct *, u32);
257 acpi_handle *handle;
258 u32 type;
259 struct acpi_device *device;
262 struct ibm_struct {
263 char *name;
265 int (*read) (struct seq_file *);
266 int (*write) (char *);
267 void (*exit) (void);
268 void (*resume) (void);
269 void (*suspend) (pm_message_t state);
270 void (*shutdown) (void);
272 struct list_head all_drivers;
274 struct tp_acpi_drv_struct *acpi;
276 struct {
277 u8 acpi_driver_registered:1;
278 u8 acpi_notify_installed:1;
279 u8 proc_created:1;
280 u8 init_called:1;
281 u8 experimental:1;
282 } flags;
285 struct ibm_init_struct {
286 char param[32];
288 int (*init) (struct ibm_init_struct *);
289 struct ibm_struct *data;
292 static struct {
293 u32 bluetooth:1;
294 u32 hotkey:1;
295 u32 hotkey_mask:1;
296 u32 hotkey_wlsw:1;
297 u32 hotkey_tablet:1;
298 u32 light:1;
299 u32 light_status:1;
300 u32 bright_16levels:1;
301 u32 bright_acpimode:1;
302 u32 wan:1;
303 u32 uwb:1;
304 u32 fan_ctrl_status_undef:1;
305 u32 second_fan:1;
306 u32 beep_needs_two_args:1;
307 u32 mixer_no_level_control:1;
308 u32 input_device_registered:1;
309 u32 platform_drv_registered:1;
310 u32 platform_drv_attrs_registered:1;
311 u32 sensors_pdrv_registered:1;
312 u32 sensors_pdrv_attrs_registered:1;
313 u32 sensors_pdev_attrs_registered:1;
314 u32 hotkey_poll_active:1;
315 } tp_features;
317 static struct {
318 u16 hotkey_mask_ff:1;
319 u16 volume_ctrl_forbidden:1;
320 } tp_warned;
322 struct thinkpad_id_data {
323 unsigned int vendor; /* ThinkPad vendor:
324 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
326 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
327 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
329 u16 bios_model; /* 1Y = 0x5931, 0 = unknown */
330 u16 ec_model;
331 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
332 u16 ec_release;
334 char *model_str; /* ThinkPad T43 */
335 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
337 static struct thinkpad_id_data thinkpad_id;
339 static enum {
340 TPACPI_LIFE_INIT = 0,
341 TPACPI_LIFE_RUNNING,
342 TPACPI_LIFE_EXITING,
343 } tpacpi_lifecycle;
345 static int experimental;
346 static u32 dbg_level;
348 static struct workqueue_struct *tpacpi_wq;
350 enum led_status_t {
351 TPACPI_LED_OFF = 0,
352 TPACPI_LED_ON,
353 TPACPI_LED_BLINK,
356 /* Special LED class that can defer work */
357 struct tpacpi_led_classdev {
358 struct led_classdev led_classdev;
359 struct work_struct work;
360 enum led_status_t new_state;
361 unsigned int led;
364 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
365 static int dbg_wlswemul;
366 static int tpacpi_wlsw_emulstate;
367 static int dbg_bluetoothemul;
368 static int tpacpi_bluetooth_emulstate;
369 static int dbg_wwanemul;
370 static int tpacpi_wwan_emulstate;
371 static int dbg_uwbemul;
372 static int tpacpi_uwb_emulstate;
373 #endif
376 /*************************************************************************
377 * Debugging helpers
380 #define dbg_printk(a_dbg_level, format, arg...) \
381 do { if (dbg_level & (a_dbg_level)) \
382 printk(TPACPI_DEBUG "%s: " format, __func__ , ## arg); \
383 } while (0)
385 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
386 #define vdbg_printk dbg_printk
387 static const char *str_supported(int is_supported);
388 #else
389 #define vdbg_printk(a_dbg_level, format, arg...) \
390 do { } while (0)
391 #endif
393 static void tpacpi_log_usertask(const char * const what)
395 printk(TPACPI_DEBUG "%s: access by process with PID %d\n",
396 what, task_tgid_vnr(current));
399 #define tpacpi_disclose_usertask(what, format, arg...) \
400 do { \
401 if (unlikely( \
402 (dbg_level & TPACPI_DBG_DISCLOSETASK) && \
403 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
404 printk(TPACPI_DEBUG "%s: PID %d: " format, \
405 what, task_tgid_vnr(current), ## arg); \
407 } while (0)
410 * Quirk handling helpers
412 * ThinkPad IDs and versions seen in the field so far
413 * are two-characters from the set [0-9A-Z], i.e. base 36.
415 * We use values well outside that range as specials.
418 #define TPACPI_MATCH_ANY 0xffffU
419 #define TPACPI_MATCH_UNKNOWN 0U
421 /* TPID('1', 'Y') == 0x5931 */
422 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
424 #define TPACPI_Q_IBM(__id1, __id2, __quirk) \
425 { .vendor = PCI_VENDOR_ID_IBM, \
426 .bios = TPID(__id1, __id2), \
427 .ec = TPACPI_MATCH_ANY, \
428 .quirks = (__quirk) }
430 #define TPACPI_Q_LNV(__id1, __id2, __quirk) \
431 { .vendor = PCI_VENDOR_ID_LENOVO, \
432 .bios = TPID(__id1, __id2), \
433 .ec = TPACPI_MATCH_ANY, \
434 .quirks = (__quirk) }
436 #define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
437 { .vendor = PCI_VENDOR_ID_LENOVO, \
438 .bios = TPACPI_MATCH_ANY, \
439 .ec = TPID(__id1, __id2), \
440 .quirks = (__quirk) }
442 struct tpacpi_quirk {
443 unsigned int vendor;
444 u16 bios;
445 u16 ec;
446 unsigned long quirks;
450 * tpacpi_check_quirks() - search BIOS/EC version on a list
451 * @qlist: array of &struct tpacpi_quirk
452 * @qlist_size: number of elements in @qlist
454 * Iterates over a quirks list until one is found that matches the
455 * ThinkPad's vendor, BIOS and EC model.
457 * Returns 0 if nothing matches, otherwise returns the quirks field of
458 * the matching &struct tpacpi_quirk entry.
460 * The match criteria is: vendor, ec and bios much match.
462 static unsigned long __init tpacpi_check_quirks(
463 const struct tpacpi_quirk *qlist,
464 unsigned int qlist_size)
466 while (qlist_size) {
467 if ((qlist->vendor == thinkpad_id.vendor ||
468 qlist->vendor == TPACPI_MATCH_ANY) &&
469 (qlist->bios == thinkpad_id.bios_model ||
470 qlist->bios == TPACPI_MATCH_ANY) &&
471 (qlist->ec == thinkpad_id.ec_model ||
472 qlist->ec == TPACPI_MATCH_ANY))
473 return qlist->quirks;
475 qlist_size--;
476 qlist++;
478 return 0;
482 /****************************************************************************
483 ****************************************************************************
485 * ACPI Helpers and device model
487 ****************************************************************************
488 ****************************************************************************/
490 /*************************************************************************
491 * ACPI basic handles
494 static acpi_handle root_handle;
496 #define TPACPI_HANDLE(object, parent, paths...) \
497 static acpi_handle object##_handle; \
498 static acpi_handle *object##_parent = &parent##_handle; \
499 static char *object##_path; \
500 static char *object##_paths[] = { paths }
502 TPACPI_HANDLE(ec, root, "\\_SB.PCI0.ISA.EC0", /* 240, 240x */
503 "\\_SB.PCI.ISA.EC", /* 570 */
504 "\\_SB.PCI0.ISA0.EC0", /* 600e/x, 770e, 770x */
505 "\\_SB.PCI0.ISA.EC", /* A21e, A2xm/p, T20-22, X20-21 */
506 "\\_SB.PCI0.AD4S.EC0", /* i1400, R30 */
507 "\\_SB.PCI0.ICH3.EC0", /* R31 */
508 "\\_SB.PCI0.LPC.EC", /* all others */
511 TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
512 TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
514 TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
515 /* T4x, X31, X40 */
516 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
517 "\\CMS", /* R40, R40e */
518 ); /* all others */
520 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
521 "^HKEY", /* R30, R31 */
522 "HKEY", /* all others */
523 ); /* 570 */
525 TPACPI_HANDLE(vid, root, "\\_SB.PCI.AGP.VGA", /* 570 */
526 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
527 "\\_SB.PCI0.VID0", /* 770e */
528 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
529 "\\_SB.PCI0.AGP.VID", /* all others */
530 ); /* R30, R31 */
533 /*************************************************************************
534 * ACPI helpers
537 static int acpi_evalf(acpi_handle handle,
538 void *res, char *method, char *fmt, ...)
540 char *fmt0 = fmt;
541 struct acpi_object_list params;
542 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
543 struct acpi_buffer result, *resultp;
544 union acpi_object out_obj;
545 acpi_status status;
546 va_list ap;
547 char res_type;
548 int success;
549 int quiet;
551 if (!*fmt) {
552 printk(TPACPI_ERR "acpi_evalf() called with empty format\n");
553 return 0;
556 if (*fmt == 'q') {
557 quiet = 1;
558 fmt++;
559 } else
560 quiet = 0;
562 res_type = *(fmt++);
564 params.count = 0;
565 params.pointer = &in_objs[0];
567 va_start(ap, fmt);
568 while (*fmt) {
569 char c = *(fmt++);
570 switch (c) {
571 case 'd': /* int */
572 in_objs[params.count].integer.value = va_arg(ap, int);
573 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
574 break;
575 /* add more types as needed */
576 default:
577 printk(TPACPI_ERR "acpi_evalf() called "
578 "with invalid format character '%c'\n", c);
579 return 0;
582 va_end(ap);
584 if (res_type != 'v') {
585 result.length = sizeof(out_obj);
586 result.pointer = &out_obj;
587 resultp = &result;
588 } else
589 resultp = NULL;
591 status = acpi_evaluate_object(handle, method, &params, resultp);
593 switch (res_type) {
594 case 'd': /* int */
595 if (res)
596 *(int *)res = out_obj.integer.value;
597 success = status == AE_OK && out_obj.type == ACPI_TYPE_INTEGER;
598 break;
599 case 'v': /* void */
600 success = status == AE_OK;
601 break;
602 /* add more types as needed */
603 default:
604 printk(TPACPI_ERR "acpi_evalf() called "
605 "with invalid format character '%c'\n", res_type);
606 return 0;
609 if (!success && !quiet)
610 printk(TPACPI_ERR "acpi_evalf(%s, %s, ...) failed: %d\n",
611 method, fmt0, status);
613 return success;
616 static int acpi_ec_read(int i, u8 *p)
618 int v;
620 if (ecrd_handle) {
621 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
622 return 0;
623 *p = v;
624 } else {
625 if (ec_read(i, p) < 0)
626 return 0;
629 return 1;
632 static int acpi_ec_write(int i, u8 v)
634 if (ecwr_handle) {
635 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
636 return 0;
637 } else {
638 if (ec_write(i, v) < 0)
639 return 0;
642 return 1;
645 static int issue_thinkpad_cmos_command(int cmos_cmd)
647 if (!cmos_handle)
648 return -ENXIO;
650 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
651 return -EIO;
653 return 0;
656 /*************************************************************************
657 * ACPI device model
660 #define TPACPI_ACPIHANDLE_INIT(object) \
661 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
662 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
664 static void drv_acpi_handle_init(char *name,
665 acpi_handle *handle, acpi_handle parent,
666 char **paths, int num_paths, char **path)
668 int i;
669 acpi_status status;
671 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
672 name);
674 for (i = 0; i < num_paths; i++) {
675 status = acpi_get_handle(parent, paths[i], handle);
676 if (ACPI_SUCCESS(status)) {
677 *path = paths[i];
678 dbg_printk(TPACPI_DBG_INIT,
679 "Found ACPI handle %s for %s\n",
680 *path, name);
681 return;
685 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
686 name);
687 *handle = NULL;
690 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
692 struct ibm_struct *ibm = data;
694 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
695 return;
697 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
698 return;
700 ibm->acpi->notify(ibm, event);
703 static int __init setup_acpi_notify(struct ibm_struct *ibm)
705 acpi_status status;
706 int rc;
708 BUG_ON(!ibm->acpi);
710 if (!*ibm->acpi->handle)
711 return 0;
713 vdbg_printk(TPACPI_DBG_INIT,
714 "setting up ACPI notify for %s\n", ibm->name);
716 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
717 if (rc < 0) {
718 printk(TPACPI_ERR "acpi_bus_get_device(%s) failed: %d\n",
719 ibm->name, rc);
720 return -ENODEV;
723 ibm->acpi->device->driver_data = ibm;
724 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
725 TPACPI_ACPI_EVENT_PREFIX,
726 ibm->name);
728 status = acpi_install_notify_handler(*ibm->acpi->handle,
729 ibm->acpi->type, dispatch_acpi_notify, ibm);
730 if (ACPI_FAILURE(status)) {
731 if (status == AE_ALREADY_EXISTS) {
732 printk(TPACPI_NOTICE
733 "another device driver is already "
734 "handling %s events\n", ibm->name);
735 } else {
736 printk(TPACPI_ERR
737 "acpi_install_notify_handler(%s) failed: %d\n",
738 ibm->name, status);
740 return -ENODEV;
742 ibm->flags.acpi_notify_installed = 1;
743 return 0;
746 static int __init tpacpi_device_add(struct acpi_device *device)
748 return 0;
751 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
753 int rc;
755 dbg_printk(TPACPI_DBG_INIT,
756 "registering %s as an ACPI driver\n", ibm->name);
758 BUG_ON(!ibm->acpi);
760 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
761 if (!ibm->acpi->driver) {
762 printk(TPACPI_ERR
763 "failed to allocate memory for ibm->acpi->driver\n");
764 return -ENOMEM;
767 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
768 ibm->acpi->driver->ids = ibm->acpi->hid;
770 ibm->acpi->driver->ops.add = &tpacpi_device_add;
772 rc = acpi_bus_register_driver(ibm->acpi->driver);
773 if (rc < 0) {
774 printk(TPACPI_ERR "acpi_bus_register_driver(%s) failed: %d\n",
775 ibm->name, rc);
776 kfree(ibm->acpi->driver);
777 ibm->acpi->driver = NULL;
778 } else if (!rc)
779 ibm->flags.acpi_driver_registered = 1;
781 return rc;
785 /****************************************************************************
786 ****************************************************************************
788 * Procfs Helpers
790 ****************************************************************************
791 ****************************************************************************/
793 static int dispatch_proc_show(struct seq_file *m, void *v)
795 struct ibm_struct *ibm = m->private;
797 if (!ibm || !ibm->read)
798 return -EINVAL;
799 return ibm->read(m);
802 static int dispatch_proc_open(struct inode *inode, struct file *file)
804 return single_open(file, dispatch_proc_show, PDE(inode)->data);
807 static ssize_t dispatch_proc_write(struct file *file,
808 const char __user *userbuf,
809 size_t count, loff_t *pos)
811 struct ibm_struct *ibm = PDE(file->f_path.dentry->d_inode)->data;
812 char *kernbuf;
813 int ret;
815 if (!ibm || !ibm->write)
816 return -EINVAL;
817 if (count > PAGE_SIZE - 2)
818 return -EINVAL;
820 kernbuf = kmalloc(count + 2, GFP_KERNEL);
821 if (!kernbuf)
822 return -ENOMEM;
824 if (copy_from_user(kernbuf, userbuf, count)) {
825 kfree(kernbuf);
826 return -EFAULT;
829 kernbuf[count] = 0;
830 strcat(kernbuf, ",");
831 ret = ibm->write(kernbuf);
832 if (ret == 0)
833 ret = count;
835 kfree(kernbuf);
837 return ret;
840 static const struct file_operations dispatch_proc_fops = {
841 .owner = THIS_MODULE,
842 .open = dispatch_proc_open,
843 .read = seq_read,
844 .llseek = seq_lseek,
845 .release = single_release,
846 .write = dispatch_proc_write,
849 static char *next_cmd(char **cmds)
851 char *start = *cmds;
852 char *end;
854 while ((end = strchr(start, ',')) && end == start)
855 start = end + 1;
857 if (!end)
858 return NULL;
860 *end = 0;
861 *cmds = end + 1;
862 return start;
866 /****************************************************************************
867 ****************************************************************************
869 * Device model: input, hwmon and platform
871 ****************************************************************************
872 ****************************************************************************/
874 static struct platform_device *tpacpi_pdev;
875 static struct platform_device *tpacpi_sensors_pdev;
876 static struct device *tpacpi_hwmon;
877 static struct input_dev *tpacpi_inputdev;
878 static struct mutex tpacpi_inputdev_send_mutex;
879 static LIST_HEAD(tpacpi_all_drivers);
881 static int tpacpi_suspend_handler(struct platform_device *pdev,
882 pm_message_t state)
884 struct ibm_struct *ibm, *itmp;
886 list_for_each_entry_safe(ibm, itmp,
887 &tpacpi_all_drivers,
888 all_drivers) {
889 if (ibm->suspend)
890 (ibm->suspend)(state);
893 return 0;
896 static int tpacpi_resume_handler(struct platform_device *pdev)
898 struct ibm_struct *ibm, *itmp;
900 list_for_each_entry_safe(ibm, itmp,
901 &tpacpi_all_drivers,
902 all_drivers) {
903 if (ibm->resume)
904 (ibm->resume)();
907 return 0;
910 static void tpacpi_shutdown_handler(struct platform_device *pdev)
912 struct ibm_struct *ibm, *itmp;
914 list_for_each_entry_safe(ibm, itmp,
915 &tpacpi_all_drivers,
916 all_drivers) {
917 if (ibm->shutdown)
918 (ibm->shutdown)();
922 static struct platform_driver tpacpi_pdriver = {
923 .driver = {
924 .name = TPACPI_DRVR_NAME,
925 .owner = THIS_MODULE,
927 .suspend = tpacpi_suspend_handler,
928 .resume = tpacpi_resume_handler,
929 .shutdown = tpacpi_shutdown_handler,
932 static struct platform_driver tpacpi_hwmon_pdriver = {
933 .driver = {
934 .name = TPACPI_HWMON_DRVR_NAME,
935 .owner = THIS_MODULE,
939 /*************************************************************************
940 * sysfs support helpers
943 struct attribute_set {
944 unsigned int members, max_members;
945 struct attribute_group group;
948 struct attribute_set_obj {
949 struct attribute_set s;
950 struct attribute *a;
951 } __attribute__((packed));
953 static struct attribute_set *create_attr_set(unsigned int max_members,
954 const char *name)
956 struct attribute_set_obj *sobj;
958 if (max_members == 0)
959 return NULL;
961 /* Allocates space for implicit NULL at the end too */
962 sobj = kzalloc(sizeof(struct attribute_set_obj) +
963 max_members * sizeof(struct attribute *),
964 GFP_KERNEL);
965 if (!sobj)
966 return NULL;
967 sobj->s.max_members = max_members;
968 sobj->s.group.attrs = &sobj->a;
969 sobj->s.group.name = name;
971 return &sobj->s;
974 #define destroy_attr_set(_set) \
975 kfree(_set);
977 /* not multi-threaded safe, use it in a single thread per set */
978 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
980 if (!s || !attr)
981 return -EINVAL;
983 if (s->members >= s->max_members)
984 return -ENOMEM;
986 s->group.attrs[s->members] = attr;
987 s->members++;
989 return 0;
992 static int add_many_to_attr_set(struct attribute_set *s,
993 struct attribute **attr,
994 unsigned int count)
996 int i, res;
998 for (i = 0; i < count; i++) {
999 res = add_to_attr_set(s, attr[i]);
1000 if (res)
1001 return res;
1004 return 0;
1007 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1009 sysfs_remove_group(kobj, &s->group);
1010 destroy_attr_set(s);
1013 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1014 sysfs_create_group(_kobj, &_attr_set->group)
1016 static int parse_strtoul(const char *buf,
1017 unsigned long max, unsigned long *value)
1019 char *endp;
1021 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1022 endp = skip_spaces(endp);
1023 if (*endp || *value > max)
1024 return -EINVAL;
1026 return 0;
1029 static void tpacpi_disable_brightness_delay(void)
1031 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1032 printk(TPACPI_NOTICE
1033 "ACPI backlight control delay disabled\n");
1036 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
1038 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1039 union acpi_object *obj;
1040 int rc;
1042 if (ACPI_SUCCESS(acpi_evaluate_object(handle, NULL, NULL, &buffer))) {
1043 obj = (union acpi_object *)buffer.pointer;
1044 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
1045 printk(TPACPI_ERR "Unknown _BCL data, "
1046 "please report this to %s\n", TPACPI_MAIL);
1047 rc = 0;
1048 } else {
1049 rc = obj->package.count;
1051 } else {
1052 return 0;
1055 kfree(buffer.pointer);
1056 return rc;
1059 static acpi_status __init tpacpi_acpi_walk_find_bcl(acpi_handle handle,
1060 u32 lvl, void *context, void **rv)
1062 char name[ACPI_PATH_SEGMENT_LENGTH];
1063 struct acpi_buffer buffer = { sizeof(name), &name };
1065 if (ACPI_SUCCESS(acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer)) &&
1066 !strncmp("_BCL", name, sizeof(name) - 1)) {
1067 BUG_ON(!rv || !*rv);
1068 **(int **)rv = tpacpi_query_bcl_levels(handle);
1069 return AE_CTRL_TERMINATE;
1070 } else {
1071 return AE_OK;
1076 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
1078 static int __init tpacpi_check_std_acpi_brightness_support(void)
1080 int status;
1081 int bcl_levels = 0;
1082 void *bcl_ptr = &bcl_levels;
1084 if (!vid_handle) {
1085 TPACPI_ACPIHANDLE_INIT(vid);
1087 if (!vid_handle)
1088 return 0;
1091 * Search for a _BCL method, and execute it. This is safe on all
1092 * ThinkPads, and as a side-effect, _BCL will place a Lenovo Vista
1093 * BIOS in ACPI backlight control mode. We do NOT have to care
1094 * about calling the _BCL method in an enabled video device, any
1095 * will do for our purposes.
1098 status = acpi_walk_namespace(ACPI_TYPE_METHOD, vid_handle, 3,
1099 tpacpi_acpi_walk_find_bcl, NULL, NULL,
1100 &bcl_ptr);
1102 if (ACPI_SUCCESS(status) && bcl_levels > 2) {
1103 tp_features.bright_acpimode = 1;
1104 return (bcl_levels - 2);
1107 return 0;
1110 static void printk_deprecated_attribute(const char * const what,
1111 const char * const details)
1113 tpacpi_log_usertask("deprecated sysfs attribute");
1114 printk(TPACPI_WARN "WARNING: sysfs attribute %s is deprecated and "
1115 "will be removed. %s\n",
1116 what, details);
1119 /*************************************************************************
1120 * rfkill and radio control support helpers
1124 * ThinkPad-ACPI firmware handling model:
1126 * WLSW (master wireless switch) is event-driven, and is common to all
1127 * firmware-controlled radios. It cannot be controlled, just monitored,
1128 * as expected. It overrides all radio state in firmware
1130 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1131 * (TODO: verify how WLSW interacts with the returned radio state).
1133 * The only time there are shadow radio state changes, is when
1134 * masked-off hotkeys are used.
1138 * Internal driver API for radio state:
1140 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1141 * bool: true means radio blocked (off)
1143 enum tpacpi_rfkill_state {
1144 TPACPI_RFK_RADIO_OFF = 0,
1145 TPACPI_RFK_RADIO_ON
1148 /* rfkill switches */
1149 enum tpacpi_rfk_id {
1150 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1151 TPACPI_RFK_WWAN_SW_ID,
1152 TPACPI_RFK_UWB_SW_ID,
1153 TPACPI_RFK_SW_MAX
1156 static const char *tpacpi_rfkill_names[] = {
1157 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1158 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1159 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1160 [TPACPI_RFK_SW_MAX] = NULL
1163 /* ThinkPad-ACPI rfkill subdriver */
1164 struct tpacpi_rfk {
1165 struct rfkill *rfkill;
1166 enum tpacpi_rfk_id id;
1167 const struct tpacpi_rfk_ops *ops;
1170 struct tpacpi_rfk_ops {
1171 /* firmware interface */
1172 int (*get_status)(void);
1173 int (*set_status)(const enum tpacpi_rfkill_state);
1176 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1178 /* Query FW and update rfkill sw state for a given rfkill switch */
1179 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1181 int status;
1183 if (!tp_rfk)
1184 return -ENODEV;
1186 status = (tp_rfk->ops->get_status)();
1187 if (status < 0)
1188 return status;
1190 rfkill_set_sw_state(tp_rfk->rfkill,
1191 (status == TPACPI_RFK_RADIO_OFF));
1193 return status;
1196 /* Query FW and update rfkill sw state for all rfkill switches */
1197 static void tpacpi_rfk_update_swstate_all(void)
1199 unsigned int i;
1201 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1202 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1206 * Sync the HW-blocking state of all rfkill switches,
1207 * do notice it causes the rfkill core to schedule uevents
1209 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1211 unsigned int i;
1212 struct tpacpi_rfk *tp_rfk;
1214 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1215 tp_rfk = tpacpi_rfkill_switches[i];
1216 if (tp_rfk) {
1217 if (rfkill_set_hw_state(tp_rfk->rfkill,
1218 blocked)) {
1219 /* ignore -- we track sw block */
1225 /* Call to get the WLSW state from the firmware */
1226 static int hotkey_get_wlsw(void);
1228 /* Call to query WLSW state and update all rfkill switches */
1229 static bool tpacpi_rfk_check_hwblock_state(void)
1231 int res = hotkey_get_wlsw();
1232 int hw_blocked;
1234 /* When unknown or unsupported, we have to assume it is unblocked */
1235 if (res < 0)
1236 return false;
1238 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1239 tpacpi_rfk_update_hwblock_state(hw_blocked);
1241 return hw_blocked;
1244 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1246 struct tpacpi_rfk *tp_rfk = data;
1247 int res;
1249 dbg_printk(TPACPI_DBG_RFKILL,
1250 "request to change radio state to %s\n",
1251 blocked ? "blocked" : "unblocked");
1253 /* try to set radio state */
1254 res = (tp_rfk->ops->set_status)(blocked ?
1255 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1257 /* and update the rfkill core with whatever the FW really did */
1258 tpacpi_rfk_update_swstate(tp_rfk);
1260 return (res < 0) ? res : 0;
1263 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1264 .set_block = tpacpi_rfk_hook_set_block,
1267 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1268 const struct tpacpi_rfk_ops *tp_rfkops,
1269 const enum rfkill_type rfktype,
1270 const char *name,
1271 const bool set_default)
1273 struct tpacpi_rfk *atp_rfk;
1274 int res;
1275 bool sw_state = false;
1276 bool hw_state;
1277 int sw_status;
1279 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1281 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1282 if (atp_rfk)
1283 atp_rfk->rfkill = rfkill_alloc(name,
1284 &tpacpi_pdev->dev,
1285 rfktype,
1286 &tpacpi_rfk_rfkill_ops,
1287 atp_rfk);
1288 if (!atp_rfk || !atp_rfk->rfkill) {
1289 printk(TPACPI_ERR
1290 "failed to allocate memory for rfkill class\n");
1291 kfree(atp_rfk);
1292 return -ENOMEM;
1295 atp_rfk->id = id;
1296 atp_rfk->ops = tp_rfkops;
1298 sw_status = (tp_rfkops->get_status)();
1299 if (sw_status < 0) {
1300 printk(TPACPI_ERR
1301 "failed to read initial state for %s, error %d\n",
1302 name, sw_status);
1303 } else {
1304 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1305 if (set_default) {
1306 /* try to keep the initial state, since we ask the
1307 * firmware to preserve it across S5 in NVRAM */
1308 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1311 hw_state = tpacpi_rfk_check_hwblock_state();
1312 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1314 res = rfkill_register(atp_rfk->rfkill);
1315 if (res < 0) {
1316 printk(TPACPI_ERR
1317 "failed to register %s rfkill switch: %d\n",
1318 name, res);
1319 rfkill_destroy(atp_rfk->rfkill);
1320 kfree(atp_rfk);
1321 return res;
1324 tpacpi_rfkill_switches[id] = atp_rfk;
1326 printk(TPACPI_INFO "rfkill switch %s: radio is %sblocked\n",
1327 name, (sw_state || hw_state) ? "" : "un");
1328 return 0;
1331 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1333 struct tpacpi_rfk *tp_rfk;
1335 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1337 tp_rfk = tpacpi_rfkill_switches[id];
1338 if (tp_rfk) {
1339 rfkill_unregister(tp_rfk->rfkill);
1340 rfkill_destroy(tp_rfk->rfkill);
1341 tpacpi_rfkill_switches[id] = NULL;
1342 kfree(tp_rfk);
1346 static void printk_deprecated_rfkill_attribute(const char * const what)
1348 printk_deprecated_attribute(what,
1349 "Please switch to generic rfkill before year 2010");
1352 /* sysfs <radio> enable ------------------------------------------------ */
1353 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1354 struct device_attribute *attr,
1355 char *buf)
1357 int status;
1359 printk_deprecated_rfkill_attribute(attr->attr.name);
1361 /* This is in the ABI... */
1362 if (tpacpi_rfk_check_hwblock_state()) {
1363 status = TPACPI_RFK_RADIO_OFF;
1364 } else {
1365 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1366 if (status < 0)
1367 return status;
1370 return snprintf(buf, PAGE_SIZE, "%d\n",
1371 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1374 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1375 struct device_attribute *attr,
1376 const char *buf, size_t count)
1378 unsigned long t;
1379 int res;
1381 printk_deprecated_rfkill_attribute(attr->attr.name);
1383 if (parse_strtoul(buf, 1, &t))
1384 return -EINVAL;
1386 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1388 /* This is in the ABI... */
1389 if (tpacpi_rfk_check_hwblock_state() && !!t)
1390 return -EPERM;
1392 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1393 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1394 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1396 return (res < 0) ? res : count;
1399 /* procfs -------------------------------------------------------------- */
1400 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1402 if (id >= TPACPI_RFK_SW_MAX)
1403 seq_printf(m, "status:\t\tnot supported\n");
1404 else {
1405 int status;
1407 /* This is in the ABI... */
1408 if (tpacpi_rfk_check_hwblock_state()) {
1409 status = TPACPI_RFK_RADIO_OFF;
1410 } else {
1411 status = tpacpi_rfk_update_swstate(
1412 tpacpi_rfkill_switches[id]);
1413 if (status < 0)
1414 return status;
1417 seq_printf(m, "status:\t\t%s\n",
1418 (status == TPACPI_RFK_RADIO_ON) ?
1419 "enabled" : "disabled");
1420 seq_printf(m, "commands:\tenable, disable\n");
1423 return 0;
1426 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1428 char *cmd;
1429 int status = -1;
1430 int res = 0;
1432 if (id >= TPACPI_RFK_SW_MAX)
1433 return -ENODEV;
1435 while ((cmd = next_cmd(&buf))) {
1436 if (strlencmp(cmd, "enable") == 0)
1437 status = TPACPI_RFK_RADIO_ON;
1438 else if (strlencmp(cmd, "disable") == 0)
1439 status = TPACPI_RFK_RADIO_OFF;
1440 else
1441 return -EINVAL;
1444 if (status != -1) {
1445 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1446 (status == TPACPI_RFK_RADIO_ON) ?
1447 "enable" : "disable",
1448 tpacpi_rfkill_names[id]);
1449 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1450 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1453 return res;
1456 /*************************************************************************
1457 * thinkpad-acpi driver attributes
1460 /* interface_version --------------------------------------------------- */
1461 static ssize_t tpacpi_driver_interface_version_show(
1462 struct device_driver *drv,
1463 char *buf)
1465 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1468 static DRIVER_ATTR(interface_version, S_IRUGO,
1469 tpacpi_driver_interface_version_show, NULL);
1471 /* debug_level --------------------------------------------------------- */
1472 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1473 char *buf)
1475 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1478 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1479 const char *buf, size_t count)
1481 unsigned long t;
1483 if (parse_strtoul(buf, 0xffff, &t))
1484 return -EINVAL;
1486 dbg_level = t;
1488 return count;
1491 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1492 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1494 /* version ------------------------------------------------------------- */
1495 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1496 char *buf)
1498 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1499 TPACPI_DESC, TPACPI_VERSION);
1502 static DRIVER_ATTR(version, S_IRUGO,
1503 tpacpi_driver_version_show, NULL);
1505 /* --------------------------------------------------------------------- */
1507 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1509 /* wlsw_emulstate ------------------------------------------------------ */
1510 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1511 char *buf)
1513 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1516 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1517 const char *buf, size_t count)
1519 unsigned long t;
1521 if (parse_strtoul(buf, 1, &t))
1522 return -EINVAL;
1524 if (tpacpi_wlsw_emulstate != !!t) {
1525 tpacpi_wlsw_emulstate = !!t;
1526 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1529 return count;
1532 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1533 tpacpi_driver_wlsw_emulstate_show,
1534 tpacpi_driver_wlsw_emulstate_store);
1536 /* bluetooth_emulstate ------------------------------------------------- */
1537 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1538 struct device_driver *drv,
1539 char *buf)
1541 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1544 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1545 struct device_driver *drv,
1546 const char *buf, size_t count)
1548 unsigned long t;
1550 if (parse_strtoul(buf, 1, &t))
1551 return -EINVAL;
1553 tpacpi_bluetooth_emulstate = !!t;
1555 return count;
1558 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1559 tpacpi_driver_bluetooth_emulstate_show,
1560 tpacpi_driver_bluetooth_emulstate_store);
1562 /* wwan_emulstate ------------------------------------------------- */
1563 static ssize_t tpacpi_driver_wwan_emulstate_show(
1564 struct device_driver *drv,
1565 char *buf)
1567 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1570 static ssize_t tpacpi_driver_wwan_emulstate_store(
1571 struct device_driver *drv,
1572 const char *buf, size_t count)
1574 unsigned long t;
1576 if (parse_strtoul(buf, 1, &t))
1577 return -EINVAL;
1579 tpacpi_wwan_emulstate = !!t;
1581 return count;
1584 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1585 tpacpi_driver_wwan_emulstate_show,
1586 tpacpi_driver_wwan_emulstate_store);
1588 /* uwb_emulstate ------------------------------------------------- */
1589 static ssize_t tpacpi_driver_uwb_emulstate_show(
1590 struct device_driver *drv,
1591 char *buf)
1593 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1596 static ssize_t tpacpi_driver_uwb_emulstate_store(
1597 struct device_driver *drv,
1598 const char *buf, size_t count)
1600 unsigned long t;
1602 if (parse_strtoul(buf, 1, &t))
1603 return -EINVAL;
1605 tpacpi_uwb_emulstate = !!t;
1607 return count;
1610 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1611 tpacpi_driver_uwb_emulstate_show,
1612 tpacpi_driver_uwb_emulstate_store);
1613 #endif
1615 /* --------------------------------------------------------------------- */
1617 static struct driver_attribute *tpacpi_driver_attributes[] = {
1618 &driver_attr_debug_level, &driver_attr_version,
1619 &driver_attr_interface_version,
1622 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1624 int i, res;
1626 i = 0;
1627 res = 0;
1628 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1629 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1630 i++;
1633 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1634 if (!res && dbg_wlswemul)
1635 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1636 if (!res && dbg_bluetoothemul)
1637 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1638 if (!res && dbg_wwanemul)
1639 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1640 if (!res && dbg_uwbemul)
1641 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1642 #endif
1644 return res;
1647 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1649 int i;
1651 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1652 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1654 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1655 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1656 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1657 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1658 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1659 #endif
1662 /*************************************************************************
1663 * Firmware Data
1667 * Table of recommended minimum BIOS versions
1669 * Reasons for listing:
1670 * 1. Stable BIOS, listed because the unknown ammount of
1671 * bugs and bad ACPI behaviour on older versions
1673 * 2. BIOS or EC fw with known bugs that trigger on Linux
1675 * 3. BIOS with known reduced functionality in older versions
1677 * We recommend the latest BIOS and EC version.
1678 * We only support the latest BIOS and EC fw version as a rule.
1680 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1681 * Information from users in ThinkWiki
1683 * WARNING: we use this table also to detect that the machine is
1684 * a ThinkPad in some cases, so don't remove entries lightly.
1687 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1688 { .vendor = (__v), \
1689 .bios = TPID(__id1, __id2), \
1690 .ec = TPACPI_MATCH_ANY, \
1691 .quirks = TPACPI_MATCH_ANY << 16 \
1692 | (__bv1) << 8 | (__bv2) }
1694 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1695 __eid, __ev1, __ev2) \
1696 { .vendor = (__v), \
1697 .bios = TPID(__bid1, __bid2), \
1698 .ec = __eid, \
1699 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1700 | (__bv1) << 8 | (__bv2) }
1702 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1703 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1705 /* Outdated IBM BIOSes often lack the EC id string */
1706 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1707 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1708 __bv1, __bv2, TPID(__id1, __id2), \
1709 __ev1, __ev2), \
1710 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1711 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1712 __ev1, __ev2)
1714 /* Outdated IBM BIOSes often lack the EC id string */
1715 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1716 __eid1, __eid2, __ev1, __ev2) \
1717 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1718 __bv1, __bv2, TPID(__eid1, __eid2), \
1719 __ev1, __ev2), \
1720 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1721 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1722 __ev1, __ev2)
1724 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1725 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1727 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1728 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1729 __bv1, __bv2, TPID(__id1, __id2), \
1730 __ev1, __ev2)
1732 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1733 __eid1, __eid2, __ev1, __ev2) \
1734 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1735 __bv1, __bv2, TPID(__eid1, __eid2), \
1736 __ev1, __ev2)
1738 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1739 /* Numeric models ------------------ */
1740 /* FW MODEL BIOS VERS */
1741 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1742 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1743 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1744 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1745 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1746 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1747 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1748 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1749 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1751 /* A-series ------------------------- */
1752 /* FW MODEL BIOS VERS EC VERS */
1753 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1754 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1755 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1756 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1757 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1758 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1759 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1760 TPV_QI0('1', '3', '2', '0'), /* A22m */
1761 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1762 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1763 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1765 /* G-series ------------------------- */
1766 /* FW MODEL BIOS VERS */
1767 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1768 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1770 /* R-series, T-series --------------- */
1771 /* FW MODEL BIOS VERS EC VERS */
1772 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1773 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1774 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1775 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1776 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1777 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1778 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1779 T40/p, T41/p, T42/p (1) */
1780 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1781 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1782 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1783 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1785 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1786 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1787 TPV_QI0('1', '6', '3', '2'), /* T22 */
1788 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1789 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1790 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1792 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1793 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1794 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1796 /* BIOS FW BIOS VERS EC FW EC VERS */
1797 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1798 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1800 /* X-series ------------------------- */
1801 /* FW MODEL BIOS VERS EC VERS */
1802 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1803 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1804 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1805 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1806 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1807 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1808 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1810 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1811 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1813 /* (0) - older versions lack DMI EC fw string and functionality */
1814 /* (1) - older versions known to lack functionality */
1817 #undef TPV_QL1
1818 #undef TPV_QL0
1819 #undef TPV_QI2
1820 #undef TPV_QI1
1821 #undef TPV_QI0
1822 #undef TPV_Q_X
1823 #undef TPV_Q
1825 static void __init tpacpi_check_outdated_fw(void)
1827 unsigned long fwvers;
1828 u16 ec_version, bios_version;
1830 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1831 ARRAY_SIZE(tpacpi_bios_version_qtable));
1833 if (!fwvers)
1834 return;
1836 bios_version = fwvers & 0xffffU;
1837 ec_version = (fwvers >> 16) & 0xffffU;
1839 /* note that unknown versions are set to 0x0000 and we use that */
1840 if ((bios_version > thinkpad_id.bios_release) ||
1841 (ec_version > thinkpad_id.ec_release &&
1842 ec_version != TPACPI_MATCH_ANY)) {
1844 * The changelogs would let us track down the exact
1845 * reason, but it is just too much of a pain to track
1846 * it. We only list BIOSes that are either really
1847 * broken, or really stable to begin with, so it is
1848 * best if the user upgrades the firmware anyway.
1850 printk(TPACPI_WARN
1851 "WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1852 printk(TPACPI_WARN
1853 "WARNING: This firmware may be missing critical bug "
1854 "fixes and/or important features\n");
1858 static bool __init tpacpi_is_fw_known(void)
1860 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1861 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1864 /****************************************************************************
1865 ****************************************************************************
1867 * Subdrivers
1869 ****************************************************************************
1870 ****************************************************************************/
1872 /*************************************************************************
1873 * thinkpad-acpi init subdriver
1876 static int __init thinkpad_acpi_driver_init(struct ibm_init_struct *iibm)
1878 printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
1879 printk(TPACPI_INFO "%s\n", TPACPI_URL);
1881 printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
1882 (thinkpad_id.bios_version_str) ?
1883 thinkpad_id.bios_version_str : "unknown",
1884 (thinkpad_id.ec_version_str) ?
1885 thinkpad_id.ec_version_str : "unknown");
1887 if (thinkpad_id.vendor && thinkpad_id.model_str)
1888 printk(TPACPI_INFO "%s %s, model %s\n",
1889 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
1890 "IBM" : ((thinkpad_id.vendor ==
1891 PCI_VENDOR_ID_LENOVO) ?
1892 "Lenovo" : "Unknown vendor"),
1893 thinkpad_id.model_str,
1894 (thinkpad_id.nummodel_str) ?
1895 thinkpad_id.nummodel_str : "unknown");
1897 tpacpi_check_outdated_fw();
1898 return 0;
1901 static int thinkpad_acpi_driver_read(struct seq_file *m)
1903 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1904 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1905 return 0;
1908 static struct ibm_struct thinkpad_acpi_driver_data = {
1909 .name = "driver",
1910 .read = thinkpad_acpi_driver_read,
1913 /*************************************************************************
1914 * Hotkey subdriver
1918 * ThinkPad firmware event model
1920 * The ThinkPad firmware has two main event interfaces: normal ACPI
1921 * notifications (which follow the ACPI standard), and a private event
1922 * interface.
1924 * The private event interface also issues events for the hotkeys. As
1925 * the driver gained features, the event handling code ended up being
1926 * built around the hotkey subdriver. This will need to be refactored
1927 * to a more formal event API eventually.
1929 * Some "hotkeys" are actually supposed to be used as event reports,
1930 * such as "brightness has changed", "volume has changed", depending on
1931 * the ThinkPad model and how the firmware is operating.
1933 * Unlike other classes, hotkey-class events have mask/unmask control on
1934 * non-ancient firmware. However, how it behaves changes a lot with the
1935 * firmware model and version.
1938 enum { /* hot key scan codes (derived from ACPI DSDT) */
1939 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1940 TP_ACPI_HOTKEYSCAN_FNF2,
1941 TP_ACPI_HOTKEYSCAN_FNF3,
1942 TP_ACPI_HOTKEYSCAN_FNF4,
1943 TP_ACPI_HOTKEYSCAN_FNF5,
1944 TP_ACPI_HOTKEYSCAN_FNF6,
1945 TP_ACPI_HOTKEYSCAN_FNF7,
1946 TP_ACPI_HOTKEYSCAN_FNF8,
1947 TP_ACPI_HOTKEYSCAN_FNF9,
1948 TP_ACPI_HOTKEYSCAN_FNF10,
1949 TP_ACPI_HOTKEYSCAN_FNF11,
1950 TP_ACPI_HOTKEYSCAN_FNF12,
1951 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1952 TP_ACPI_HOTKEYSCAN_FNINSERT,
1953 TP_ACPI_HOTKEYSCAN_FNDELETE,
1954 TP_ACPI_HOTKEYSCAN_FNHOME,
1955 TP_ACPI_HOTKEYSCAN_FNEND,
1956 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1957 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1958 TP_ACPI_HOTKEYSCAN_FNSPACE,
1959 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1960 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1961 TP_ACPI_HOTKEYSCAN_MUTE,
1962 TP_ACPI_HOTKEYSCAN_THINKPAD,
1965 enum { /* Keys/events available through NVRAM polling */
1966 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1967 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1970 enum { /* Positions of some of the keys in hotkey masks */
1971 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1972 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1973 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1974 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1975 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1976 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1977 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1978 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1979 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1980 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1981 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1984 enum { /* NVRAM to ACPI HKEY group map */
1985 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1986 TP_ACPI_HKEY_ZOOM_MASK |
1987 TP_ACPI_HKEY_DISPSWTCH_MASK |
1988 TP_ACPI_HKEY_HIBERNATE_MASK,
1989 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1990 TP_ACPI_HKEY_BRGHTDWN_MASK,
1991 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1992 TP_ACPI_HKEY_VOLDWN_MASK |
1993 TP_ACPI_HKEY_MUTE_MASK,
1996 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1997 struct tp_nvram_state {
1998 u16 thinkpad_toggle:1;
1999 u16 zoom_toggle:1;
2000 u16 display_toggle:1;
2001 u16 thinklight_toggle:1;
2002 u16 hibernate_toggle:1;
2003 u16 displayexp_toggle:1;
2004 u16 display_state:1;
2005 u16 brightness_toggle:1;
2006 u16 volume_toggle:1;
2007 u16 mute:1;
2009 u8 brightness_level;
2010 u8 volume_level;
2013 /* kthread for the hotkey poller */
2014 static struct task_struct *tpacpi_hotkey_task;
2016 /* Acquired while the poller kthread is running, use to sync start/stop */
2017 static struct mutex hotkey_thread_mutex;
2020 * Acquire mutex to write poller control variables as an
2021 * atomic block.
2023 * Increment hotkey_config_change when changing them if you
2024 * want the kthread to forget old state.
2026 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2028 static struct mutex hotkey_thread_data_mutex;
2029 static unsigned int hotkey_config_change;
2032 * hotkey poller control variables
2034 * Must be atomic or readers will also need to acquire mutex
2036 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2037 * should be used only when the changes need to be taken as
2038 * a block, OR when one needs to force the kthread to forget
2039 * old state.
2041 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2042 static unsigned int hotkey_poll_freq = 10; /* Hz */
2044 #define HOTKEY_CONFIG_CRITICAL_START \
2045 do { \
2046 mutex_lock(&hotkey_thread_data_mutex); \
2047 hotkey_config_change++; \
2048 } while (0);
2049 #define HOTKEY_CONFIG_CRITICAL_END \
2050 mutex_unlock(&hotkey_thread_data_mutex);
2052 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2054 #define hotkey_source_mask 0U
2055 #define HOTKEY_CONFIG_CRITICAL_START
2056 #define HOTKEY_CONFIG_CRITICAL_END
2058 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2060 static struct mutex hotkey_mutex;
2062 static enum { /* Reasons for waking up */
2063 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2064 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2065 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2066 } hotkey_wakeup_reason;
2068 static int hotkey_autosleep_ack;
2070 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2071 static u32 hotkey_all_mask; /* all events supported in fw */
2072 static u32 hotkey_reserved_mask; /* events better left disabled */
2073 static u32 hotkey_driver_mask; /* events needed by the driver */
2074 static u32 hotkey_user_mask; /* events visible to userspace */
2075 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2077 static unsigned int hotkey_report_mode;
2079 static u16 *hotkey_keycode_map;
2081 static struct attribute_set *hotkey_dev_attributes;
2083 static void tpacpi_driver_event(const unsigned int hkey_event);
2084 static void hotkey_driver_event(const unsigned int scancode);
2085 static void hotkey_poll_setup(const bool may_warn);
2087 /* HKEY.MHKG() return bits */
2088 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2090 static int hotkey_get_wlsw(void)
2092 int status;
2094 if (!tp_features.hotkey_wlsw)
2095 return -ENODEV;
2097 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2098 if (dbg_wlswemul)
2099 return (tpacpi_wlsw_emulstate) ?
2100 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2101 #endif
2103 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2104 return -EIO;
2106 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2109 static int hotkey_get_tablet_mode(int *status)
2111 int s;
2113 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2114 return -EIO;
2116 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2117 return 0;
2121 * Reads current event mask from firmware, and updates
2122 * hotkey_acpi_mask accordingly. Also resets any bits
2123 * from hotkey_user_mask that are unavailable to be
2124 * delivered (shadow requirement of the userspace ABI).
2126 * Call with hotkey_mutex held
2128 static int hotkey_mask_get(void)
2130 if (tp_features.hotkey_mask) {
2131 u32 m = 0;
2133 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2134 return -EIO;
2136 hotkey_acpi_mask = m;
2137 } else {
2138 /* no mask support doesn't mean no event support... */
2139 hotkey_acpi_mask = hotkey_all_mask;
2142 /* sync userspace-visible mask */
2143 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2145 return 0;
2148 void static hotkey_mask_warn_incomplete_mask(void)
2150 /* log only what the user can fix... */
2151 const u32 wantedmask = hotkey_driver_mask &
2152 ~(hotkey_acpi_mask | hotkey_source_mask) &
2153 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2155 if (wantedmask)
2156 printk(TPACPI_NOTICE
2157 "required events 0x%08x not enabled!\n",
2158 wantedmask);
2162 * Set the firmware mask when supported
2164 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2166 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2168 * Call with hotkey_mutex held
2170 static int hotkey_mask_set(u32 mask)
2172 int i;
2173 int rc = 0;
2175 const u32 fwmask = mask & ~hotkey_source_mask;
2177 if (tp_features.hotkey_mask) {
2178 for (i = 0; i < 32; i++) {
2179 if (!acpi_evalf(hkey_handle,
2180 NULL, "MHKM", "vdd", i + 1,
2181 !!(mask & (1 << i)))) {
2182 rc = -EIO;
2183 break;
2189 * We *must* make an inconditional call to hotkey_mask_get to
2190 * refresh hotkey_acpi_mask and update hotkey_user_mask
2192 * Take the opportunity to also log when we cannot _enable_
2193 * a given event.
2195 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2196 printk(TPACPI_NOTICE
2197 "asked for hotkey mask 0x%08x, but "
2198 "firmware forced it to 0x%08x\n",
2199 fwmask, hotkey_acpi_mask);
2202 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2203 hotkey_mask_warn_incomplete_mask();
2205 return rc;
2209 * Sets hotkey_user_mask and tries to set the firmware mask
2211 * Call with hotkey_mutex held
2213 static int hotkey_user_mask_set(const u32 mask)
2215 int rc;
2217 /* Give people a chance to notice they are doing something that
2218 * is bound to go boom on their users sooner or later */
2219 if (!tp_warned.hotkey_mask_ff &&
2220 (mask == 0xffff || mask == 0xffffff ||
2221 mask == 0xffffffff)) {
2222 tp_warned.hotkey_mask_ff = 1;
2223 printk(TPACPI_NOTICE
2224 "setting the hotkey mask to 0x%08x is likely "
2225 "not the best way to go about it\n", mask);
2226 printk(TPACPI_NOTICE
2227 "please consider using the driver defaults, "
2228 "and refer to up-to-date thinkpad-acpi "
2229 "documentation\n");
2232 /* Try to enable what the user asked for, plus whatever we need.
2233 * this syncs everything but won't enable bits in hotkey_user_mask */
2234 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2236 /* Enable the available bits in hotkey_user_mask */
2237 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2239 return rc;
2243 * Sets the driver hotkey mask.
2245 * Can be called even if the hotkey subdriver is inactive
2247 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2249 int rc;
2251 /* Do the right thing if hotkey_init has not been called yet */
2252 if (!tp_features.hotkey) {
2253 hotkey_driver_mask = mask;
2254 return 0;
2257 mutex_lock(&hotkey_mutex);
2259 HOTKEY_CONFIG_CRITICAL_START
2260 hotkey_driver_mask = mask;
2261 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2262 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2263 #endif
2264 HOTKEY_CONFIG_CRITICAL_END
2266 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2267 ~hotkey_source_mask);
2268 hotkey_poll_setup(true);
2270 mutex_unlock(&hotkey_mutex);
2272 return rc;
2275 static int hotkey_status_get(int *status)
2277 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2278 return -EIO;
2280 return 0;
2283 static int hotkey_status_set(bool enable)
2285 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2286 return -EIO;
2288 return 0;
2291 static void tpacpi_input_send_tabletsw(void)
2293 int state;
2295 if (tp_features.hotkey_tablet &&
2296 !hotkey_get_tablet_mode(&state)) {
2297 mutex_lock(&tpacpi_inputdev_send_mutex);
2299 input_report_switch(tpacpi_inputdev,
2300 SW_TABLET_MODE, !!state);
2301 input_sync(tpacpi_inputdev);
2303 mutex_unlock(&tpacpi_inputdev_send_mutex);
2307 /* Do NOT call without validating scancode first */
2308 static void tpacpi_input_send_key(const unsigned int scancode)
2310 const unsigned int keycode = hotkey_keycode_map[scancode];
2312 if (keycode != KEY_RESERVED) {
2313 mutex_lock(&tpacpi_inputdev_send_mutex);
2315 input_report_key(tpacpi_inputdev, keycode, 1);
2316 if (keycode == KEY_UNKNOWN)
2317 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2318 scancode);
2319 input_sync(tpacpi_inputdev);
2321 input_report_key(tpacpi_inputdev, keycode, 0);
2322 if (keycode == KEY_UNKNOWN)
2323 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2324 scancode);
2325 input_sync(tpacpi_inputdev);
2327 mutex_unlock(&tpacpi_inputdev_send_mutex);
2331 /* Do NOT call without validating scancode first */
2332 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2334 hotkey_driver_event(scancode);
2335 if (hotkey_user_mask & (1 << scancode))
2336 tpacpi_input_send_key(scancode);
2339 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2340 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2342 /* Do NOT call without validating scancode first */
2343 static void tpacpi_hotkey_send_key(unsigned int scancode)
2345 tpacpi_input_send_key_masked(scancode);
2346 if (hotkey_report_mode < 2) {
2347 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2348 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2352 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2354 u8 d;
2356 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2357 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2358 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2359 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2360 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2361 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2363 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2364 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2365 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2367 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2368 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2369 n->displayexp_toggle =
2370 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2372 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2373 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2374 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2375 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2376 n->brightness_toggle =
2377 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2379 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2380 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2381 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2382 >> TP_NVRAM_POS_LEVEL_VOLUME;
2383 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2384 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2388 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2389 struct tp_nvram_state *newn,
2390 const u32 event_mask)
2393 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2394 do { \
2395 if ((event_mask & (1 << __scancode)) && \
2396 oldn->__member != newn->__member) \
2397 tpacpi_hotkey_send_key(__scancode); \
2398 } while (0)
2400 #define TPACPI_MAY_SEND_KEY(__scancode) \
2401 do { \
2402 if (event_mask & (1 << __scancode)) \
2403 tpacpi_hotkey_send_key(__scancode); \
2404 } while (0)
2406 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2407 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2408 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2409 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2411 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2413 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2415 /* handle volume */
2416 if (oldn->volume_toggle != newn->volume_toggle) {
2417 if (oldn->mute != newn->mute) {
2418 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2420 if (oldn->volume_level > newn->volume_level) {
2421 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2422 } else if (oldn->volume_level < newn->volume_level) {
2423 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2424 } else if (oldn->mute == newn->mute) {
2425 /* repeated key presses that didn't change state */
2426 if (newn->mute) {
2427 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2428 } else if (newn->volume_level != 0) {
2429 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2430 } else {
2431 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2436 /* handle brightness */
2437 if (oldn->brightness_toggle != newn->brightness_toggle) {
2438 if (oldn->brightness_level < newn->brightness_level) {
2439 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2440 } else if (oldn->brightness_level > newn->brightness_level) {
2441 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2442 } else {
2443 /* repeated key presses that didn't change state */
2444 if (newn->brightness_level != 0) {
2445 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2446 } else {
2447 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2452 #undef TPACPI_COMPARE_KEY
2453 #undef TPACPI_MAY_SEND_KEY
2457 * Polling driver
2459 * We track all events in hotkey_source_mask all the time, since
2460 * most of them are edge-based. We only issue those requested by
2461 * hotkey_user_mask or hotkey_driver_mask, though.
2463 static int hotkey_kthread(void *data)
2465 struct tp_nvram_state s[2];
2466 u32 poll_mask, event_mask;
2467 unsigned int si, so;
2468 unsigned long t;
2469 unsigned int change_detector, must_reset;
2470 unsigned int poll_freq;
2472 mutex_lock(&hotkey_thread_mutex);
2474 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2475 goto exit;
2477 set_freezable();
2479 so = 0;
2480 si = 1;
2481 t = 0;
2483 /* Initial state for compares */
2484 mutex_lock(&hotkey_thread_data_mutex);
2485 change_detector = hotkey_config_change;
2486 poll_mask = hotkey_source_mask;
2487 event_mask = hotkey_source_mask &
2488 (hotkey_driver_mask | hotkey_user_mask);
2489 poll_freq = hotkey_poll_freq;
2490 mutex_unlock(&hotkey_thread_data_mutex);
2491 hotkey_read_nvram(&s[so], poll_mask);
2493 while (!kthread_should_stop()) {
2494 if (t == 0) {
2495 if (likely(poll_freq))
2496 t = 1000/poll_freq;
2497 else
2498 t = 100; /* should never happen... */
2500 t = msleep_interruptible(t);
2501 if (unlikely(kthread_should_stop()))
2502 break;
2503 must_reset = try_to_freeze();
2504 if (t > 0 && !must_reset)
2505 continue;
2507 mutex_lock(&hotkey_thread_data_mutex);
2508 if (must_reset || hotkey_config_change != change_detector) {
2509 /* forget old state on thaw or config change */
2510 si = so;
2511 t = 0;
2512 change_detector = hotkey_config_change;
2514 poll_mask = hotkey_source_mask;
2515 event_mask = hotkey_source_mask &
2516 (hotkey_driver_mask | hotkey_user_mask);
2517 poll_freq = hotkey_poll_freq;
2518 mutex_unlock(&hotkey_thread_data_mutex);
2520 if (likely(poll_mask)) {
2521 hotkey_read_nvram(&s[si], poll_mask);
2522 if (likely(si != so)) {
2523 hotkey_compare_and_issue_event(&s[so], &s[si],
2524 event_mask);
2528 so = si;
2529 si ^= 1;
2532 exit:
2533 mutex_unlock(&hotkey_thread_mutex);
2534 return 0;
2537 /* call with hotkey_mutex held */
2538 static void hotkey_poll_stop_sync(void)
2540 if (tpacpi_hotkey_task) {
2541 if (frozen(tpacpi_hotkey_task) ||
2542 freezing(tpacpi_hotkey_task))
2543 thaw_process(tpacpi_hotkey_task);
2545 kthread_stop(tpacpi_hotkey_task);
2546 tpacpi_hotkey_task = NULL;
2547 mutex_lock(&hotkey_thread_mutex);
2548 /* at this point, the thread did exit */
2549 mutex_unlock(&hotkey_thread_mutex);
2553 /* call with hotkey_mutex held */
2554 static void hotkey_poll_setup(const bool may_warn)
2556 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2557 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2559 if (hotkey_poll_freq > 0 &&
2560 (poll_driver_mask ||
2561 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2562 if (!tpacpi_hotkey_task) {
2563 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2564 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2565 if (IS_ERR(tpacpi_hotkey_task)) {
2566 tpacpi_hotkey_task = NULL;
2567 printk(TPACPI_ERR
2568 "could not create kernel thread "
2569 "for hotkey polling\n");
2572 } else {
2573 hotkey_poll_stop_sync();
2574 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2575 hotkey_poll_freq == 0) {
2576 printk(TPACPI_NOTICE
2577 "hot keys 0x%08x and/or events 0x%08x "
2578 "require polling, which is currently "
2579 "disabled\n",
2580 poll_user_mask, poll_driver_mask);
2585 static void hotkey_poll_setup_safe(const bool may_warn)
2587 mutex_lock(&hotkey_mutex);
2588 hotkey_poll_setup(may_warn);
2589 mutex_unlock(&hotkey_mutex);
2592 /* call with hotkey_mutex held */
2593 static void hotkey_poll_set_freq(unsigned int freq)
2595 if (!freq)
2596 hotkey_poll_stop_sync();
2598 hotkey_poll_freq = freq;
2601 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2603 static void hotkey_poll_setup(const bool __unused)
2607 static void hotkey_poll_setup_safe(const bool __unused)
2611 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2613 static int hotkey_inputdev_open(struct input_dev *dev)
2615 switch (tpacpi_lifecycle) {
2616 case TPACPI_LIFE_INIT:
2617 case TPACPI_LIFE_RUNNING:
2618 hotkey_poll_setup_safe(false);
2619 return 0;
2620 case TPACPI_LIFE_EXITING:
2621 return -EBUSY;
2624 /* Should only happen if tpacpi_lifecycle is corrupt */
2625 BUG();
2626 return -EBUSY;
2629 static void hotkey_inputdev_close(struct input_dev *dev)
2631 /* disable hotkey polling when possible */
2632 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2633 !(hotkey_source_mask & hotkey_driver_mask))
2634 hotkey_poll_setup_safe(false);
2637 /* sysfs hotkey enable ------------------------------------------------- */
2638 static ssize_t hotkey_enable_show(struct device *dev,
2639 struct device_attribute *attr,
2640 char *buf)
2642 int res, status;
2644 printk_deprecated_attribute("hotkey_enable",
2645 "Hotkey reporting is always enabled");
2647 res = hotkey_status_get(&status);
2648 if (res)
2649 return res;
2651 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2654 static ssize_t hotkey_enable_store(struct device *dev,
2655 struct device_attribute *attr,
2656 const char *buf, size_t count)
2658 unsigned long t;
2660 printk_deprecated_attribute("hotkey_enable",
2661 "Hotkeys can be disabled through hotkey_mask");
2663 if (parse_strtoul(buf, 1, &t))
2664 return -EINVAL;
2666 if (t == 0)
2667 return -EPERM;
2669 return count;
2672 static struct device_attribute dev_attr_hotkey_enable =
2673 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2674 hotkey_enable_show, hotkey_enable_store);
2676 /* sysfs hotkey mask --------------------------------------------------- */
2677 static ssize_t hotkey_mask_show(struct device *dev,
2678 struct device_attribute *attr,
2679 char *buf)
2681 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2684 static ssize_t hotkey_mask_store(struct device *dev,
2685 struct device_attribute *attr,
2686 const char *buf, size_t count)
2688 unsigned long t;
2689 int res;
2691 if (parse_strtoul(buf, 0xffffffffUL, &t))
2692 return -EINVAL;
2694 if (mutex_lock_killable(&hotkey_mutex))
2695 return -ERESTARTSYS;
2697 res = hotkey_user_mask_set(t);
2699 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2700 hotkey_poll_setup(true);
2701 #endif
2703 mutex_unlock(&hotkey_mutex);
2705 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2707 return (res) ? res : count;
2710 static struct device_attribute dev_attr_hotkey_mask =
2711 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2712 hotkey_mask_show, hotkey_mask_store);
2714 /* sysfs hotkey bios_enabled ------------------------------------------- */
2715 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2716 struct device_attribute *attr,
2717 char *buf)
2719 return sprintf(buf, "0\n");
2722 static struct device_attribute dev_attr_hotkey_bios_enabled =
2723 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2725 /* sysfs hotkey bios_mask ---------------------------------------------- */
2726 static ssize_t hotkey_bios_mask_show(struct device *dev,
2727 struct device_attribute *attr,
2728 char *buf)
2730 printk_deprecated_attribute("hotkey_bios_mask",
2731 "This attribute is useless.");
2732 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2735 static struct device_attribute dev_attr_hotkey_bios_mask =
2736 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2738 /* sysfs hotkey all_mask ----------------------------------------------- */
2739 static ssize_t hotkey_all_mask_show(struct device *dev,
2740 struct device_attribute *attr,
2741 char *buf)
2743 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2744 hotkey_all_mask | hotkey_source_mask);
2747 static struct device_attribute dev_attr_hotkey_all_mask =
2748 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2750 /* sysfs hotkey recommended_mask --------------------------------------- */
2751 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2752 struct device_attribute *attr,
2753 char *buf)
2755 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2756 (hotkey_all_mask | hotkey_source_mask)
2757 & ~hotkey_reserved_mask);
2760 static struct device_attribute dev_attr_hotkey_recommended_mask =
2761 __ATTR(hotkey_recommended_mask, S_IRUGO,
2762 hotkey_recommended_mask_show, NULL);
2764 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2766 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2767 static ssize_t hotkey_source_mask_show(struct device *dev,
2768 struct device_attribute *attr,
2769 char *buf)
2771 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2774 static ssize_t hotkey_source_mask_store(struct device *dev,
2775 struct device_attribute *attr,
2776 const char *buf, size_t count)
2778 unsigned long t;
2779 u32 r_ev;
2780 int rc;
2782 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2783 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2784 return -EINVAL;
2786 if (mutex_lock_killable(&hotkey_mutex))
2787 return -ERESTARTSYS;
2789 HOTKEY_CONFIG_CRITICAL_START
2790 hotkey_source_mask = t;
2791 HOTKEY_CONFIG_CRITICAL_END
2793 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2794 ~hotkey_source_mask);
2795 hotkey_poll_setup(true);
2797 /* check if events needed by the driver got disabled */
2798 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2799 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2801 mutex_unlock(&hotkey_mutex);
2803 if (rc < 0)
2804 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2805 "firmware event mask!\n");
2807 if (r_ev)
2808 printk(TPACPI_NOTICE "hotkey_source_mask: "
2809 "some important events were disabled: "
2810 "0x%04x\n", r_ev);
2812 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2814 return (rc < 0) ? rc : count;
2817 static struct device_attribute dev_attr_hotkey_source_mask =
2818 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2819 hotkey_source_mask_show, hotkey_source_mask_store);
2821 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2822 static ssize_t hotkey_poll_freq_show(struct device *dev,
2823 struct device_attribute *attr,
2824 char *buf)
2826 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2829 static ssize_t hotkey_poll_freq_store(struct device *dev,
2830 struct device_attribute *attr,
2831 const char *buf, size_t count)
2833 unsigned long t;
2835 if (parse_strtoul(buf, 25, &t))
2836 return -EINVAL;
2838 if (mutex_lock_killable(&hotkey_mutex))
2839 return -ERESTARTSYS;
2841 hotkey_poll_set_freq(t);
2842 hotkey_poll_setup(true);
2844 mutex_unlock(&hotkey_mutex);
2846 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2848 return count;
2851 static struct device_attribute dev_attr_hotkey_poll_freq =
2852 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2853 hotkey_poll_freq_show, hotkey_poll_freq_store);
2855 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2857 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2858 static ssize_t hotkey_radio_sw_show(struct device *dev,
2859 struct device_attribute *attr,
2860 char *buf)
2862 int res;
2863 res = hotkey_get_wlsw();
2864 if (res < 0)
2865 return res;
2867 /* Opportunistic update */
2868 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2870 return snprintf(buf, PAGE_SIZE, "%d\n",
2871 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2874 static struct device_attribute dev_attr_hotkey_radio_sw =
2875 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2877 static void hotkey_radio_sw_notify_change(void)
2879 if (tp_features.hotkey_wlsw)
2880 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2881 "hotkey_radio_sw");
2884 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2885 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2886 struct device_attribute *attr,
2887 char *buf)
2889 int res, s;
2890 res = hotkey_get_tablet_mode(&s);
2891 if (res < 0)
2892 return res;
2894 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2897 static struct device_attribute dev_attr_hotkey_tablet_mode =
2898 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2900 static void hotkey_tablet_mode_notify_change(void)
2902 if (tp_features.hotkey_tablet)
2903 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2904 "hotkey_tablet_mode");
2907 /* sysfs hotkey report_mode -------------------------------------------- */
2908 static ssize_t hotkey_report_mode_show(struct device *dev,
2909 struct device_attribute *attr,
2910 char *buf)
2912 return snprintf(buf, PAGE_SIZE, "%d\n",
2913 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2916 static struct device_attribute dev_attr_hotkey_report_mode =
2917 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2919 /* sysfs wakeup reason (pollable) -------------------------------------- */
2920 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2921 struct device_attribute *attr,
2922 char *buf)
2924 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2927 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2928 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2930 static void hotkey_wakeup_reason_notify_change(void)
2932 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2933 "wakeup_reason");
2936 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2937 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2938 struct device_attribute *attr,
2939 char *buf)
2941 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2944 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2945 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2946 hotkey_wakeup_hotunplug_complete_show, NULL);
2948 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2950 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2951 "wakeup_hotunplug_complete");
2954 /* --------------------------------------------------------------------- */
2956 static struct attribute *hotkey_attributes[] __initdata = {
2957 &dev_attr_hotkey_enable.attr,
2958 &dev_attr_hotkey_bios_enabled.attr,
2959 &dev_attr_hotkey_bios_mask.attr,
2960 &dev_attr_hotkey_report_mode.attr,
2961 &dev_attr_hotkey_wakeup_reason.attr,
2962 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2963 &dev_attr_hotkey_mask.attr,
2964 &dev_attr_hotkey_all_mask.attr,
2965 &dev_attr_hotkey_recommended_mask.attr,
2966 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2967 &dev_attr_hotkey_source_mask.attr,
2968 &dev_attr_hotkey_poll_freq.attr,
2969 #endif
2973 * Sync both the hw and sw blocking state of all switches
2975 static void tpacpi_send_radiosw_update(void)
2977 int wlsw;
2980 * We must sync all rfkill controllers *before* issuing any
2981 * rfkill input events, or we will race the rfkill core input
2982 * handler.
2984 * tpacpi_inputdev_send_mutex works as a syncronization point
2985 * for the above.
2987 * We optimize to avoid numerous calls to hotkey_get_wlsw.
2990 wlsw = hotkey_get_wlsw();
2992 /* Sync hw blocking state first if it is hw-blocked */
2993 if (wlsw == TPACPI_RFK_RADIO_OFF)
2994 tpacpi_rfk_update_hwblock_state(true);
2996 /* Sync sw blocking state */
2997 tpacpi_rfk_update_swstate_all();
2999 /* Sync hw blocking state last if it is hw-unblocked */
3000 if (wlsw == TPACPI_RFK_RADIO_ON)
3001 tpacpi_rfk_update_hwblock_state(false);
3003 /* Issue rfkill input event for WLSW switch */
3004 if (!(wlsw < 0)) {
3005 mutex_lock(&tpacpi_inputdev_send_mutex);
3007 input_report_switch(tpacpi_inputdev,
3008 SW_RFKILL_ALL, (wlsw > 0));
3009 input_sync(tpacpi_inputdev);
3011 mutex_unlock(&tpacpi_inputdev_send_mutex);
3015 * this can be unconditional, as we will poll state again
3016 * if userspace uses the notify to read data
3018 hotkey_radio_sw_notify_change();
3021 static void hotkey_exit(void)
3023 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3024 mutex_lock(&hotkey_mutex);
3025 hotkey_poll_stop_sync();
3026 mutex_unlock(&hotkey_mutex);
3027 #endif
3029 if (hotkey_dev_attributes)
3030 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3032 kfree(hotkey_keycode_map);
3034 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3035 "restoring original HKEY status and mask\n");
3036 /* yes, there is a bitwise or below, we want the
3037 * functions to be called even if one of them fail */
3038 if (((tp_features.hotkey_mask &&
3039 hotkey_mask_set(hotkey_orig_mask)) |
3040 hotkey_status_set(false)) != 0)
3041 printk(TPACPI_ERR
3042 "failed to restore hot key mask "
3043 "to BIOS defaults\n");
3046 static void __init hotkey_unmap(const unsigned int scancode)
3048 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3049 clear_bit(hotkey_keycode_map[scancode],
3050 tpacpi_inputdev->keybit);
3051 hotkey_keycode_map[scancode] = KEY_RESERVED;
3056 * HKEY quirks:
3057 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3060 #define TPACPI_HK_Q_INIMASK 0x0001
3062 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3063 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3064 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3065 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3066 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3067 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3068 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3069 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3070 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3071 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3072 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3073 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3074 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3075 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3076 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3077 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3078 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3079 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3080 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3081 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3084 static int __init hotkey_init(struct ibm_init_struct *iibm)
3086 /* Requirements for changing the default keymaps:
3088 * 1. Many of the keys are mapped to KEY_RESERVED for very
3089 * good reasons. Do not change them unless you have deep
3090 * knowledge on the IBM and Lenovo ThinkPad firmware for
3091 * the various ThinkPad models. The driver behaves
3092 * differently for KEY_RESERVED: such keys have their
3093 * hot key mask *unset* in mask_recommended, and also
3094 * in the initial hot key mask programmed into the
3095 * firmware at driver load time, which means the firm-
3096 * ware may react very differently if you change them to
3097 * something else;
3099 * 2. You must be subscribed to the linux-thinkpad and
3100 * ibm-acpi-devel mailing lists, and you should read the
3101 * list archives since 2007 if you want to change the
3102 * keymaps. This requirement exists so that you will
3103 * know the past history of problems with the thinkpad-
3104 * acpi driver keymaps, and also that you will be
3105 * listening to any bug reports;
3107 * 3. Do not send thinkpad-acpi specific patches directly to
3108 * for merging, *ever*. Send them to the linux-acpi
3109 * mailinglist for comments. Merging is to be done only
3110 * through acpi-test and the ACPI maintainer.
3112 * If the above is too much to ask, don't change the keymap.
3113 * Ask the thinkpad-acpi maintainer to do it, instead.
3115 static u16 ibm_keycode_map[] __initdata = {
3116 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3117 KEY_FN_F1, KEY_FN_F2, KEY_COFFEE, KEY_SLEEP,
3118 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3119 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3121 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3122 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3123 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3124 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3126 /* brightness: firmware always reacts to them */
3127 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3128 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3130 /* Thinklight: firmware always react to it */
3131 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3133 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3134 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3136 /* Volume: firmware always react to it and reprograms
3137 * the built-in *extra* mixer. Never map it to control
3138 * another mixer by default. */
3139 KEY_RESERVED, /* 0x14: VOLUME UP */
3140 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3141 KEY_RESERVED, /* 0x16: MUTE */
3143 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3145 /* (assignments unknown, please report if found) */
3146 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3147 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3149 static u16 lenovo_keycode_map[] __initdata = {
3150 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3151 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3152 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3153 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3155 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3156 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3157 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3158 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3160 /* These should be enabled --only-- when ACPI video
3161 * is disabled (i.e. in "vendor" mode), and are handled
3162 * in a special way by the init code */
3163 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3164 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3166 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3168 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3169 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3171 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3172 * react to it and reprograms the built-in *extra* mixer.
3173 * Never map it to control another mixer by default.
3175 * T60?, T61, R60?, R61: firmware and EC tries to send
3176 * these over the regular keyboard, so these are no-ops,
3177 * but there are still weird bugs re. MUTE, so do not
3178 * change unless you get test reports from all Lenovo
3179 * models. May cause the BIOS to interfere with the
3180 * HDA mixer.
3182 KEY_RESERVED, /* 0x14: VOLUME UP */
3183 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3184 KEY_RESERVED, /* 0x16: MUTE */
3186 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3188 /* (assignments unknown, please report if found) */
3189 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3190 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3193 #define TPACPI_HOTKEY_MAP_LEN ARRAY_SIZE(ibm_keycode_map)
3194 #define TPACPI_HOTKEY_MAP_SIZE sizeof(ibm_keycode_map)
3195 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(ibm_keycode_map[0])
3197 int res, i;
3198 int status;
3199 int hkeyv;
3200 bool radiosw_state = false;
3201 bool tabletsw_state = false;
3203 unsigned long quirks;
3205 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3206 "initializing hotkey subdriver\n");
3208 BUG_ON(!tpacpi_inputdev);
3209 BUG_ON(tpacpi_inputdev->open != NULL ||
3210 tpacpi_inputdev->close != NULL);
3212 TPACPI_ACPIHANDLE_INIT(hkey);
3213 mutex_init(&hotkey_mutex);
3215 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3216 mutex_init(&hotkey_thread_mutex);
3217 mutex_init(&hotkey_thread_data_mutex);
3218 #endif
3220 /* hotkey not supported on 570 */
3221 tp_features.hotkey = hkey_handle != NULL;
3223 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3224 "hotkeys are %s\n",
3225 str_supported(tp_features.hotkey));
3227 if (!tp_features.hotkey)
3228 return 1;
3230 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3231 ARRAY_SIZE(tpacpi_hotkey_qtable));
3233 tpacpi_disable_brightness_delay();
3235 /* MUST have enough space for all attributes to be added to
3236 * hotkey_dev_attributes */
3237 hotkey_dev_attributes = create_attr_set(
3238 ARRAY_SIZE(hotkey_attributes) + 2,
3239 NULL);
3240 if (!hotkey_dev_attributes)
3241 return -ENOMEM;
3242 res = add_many_to_attr_set(hotkey_dev_attributes,
3243 hotkey_attributes,
3244 ARRAY_SIZE(hotkey_attributes));
3245 if (res)
3246 goto err_exit;
3248 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3249 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3250 for HKEY interface version 0x100 */
3251 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3252 if ((hkeyv >> 8) != 1) {
3253 printk(TPACPI_ERR "unknown version of the "
3254 "HKEY interface: 0x%x\n", hkeyv);
3255 printk(TPACPI_ERR "please report this to %s\n",
3256 TPACPI_MAIL);
3257 } else {
3259 * MHKV 0x100 in A31, R40, R40e,
3260 * T4x, X31, and later
3262 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3263 "firmware HKEY interface version: 0x%x\n",
3264 hkeyv);
3266 /* Paranoia check AND init hotkey_all_mask */
3267 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3268 "MHKA", "qd")) {
3269 printk(TPACPI_ERR
3270 "missing MHKA handler, "
3271 "please report this to %s\n",
3272 TPACPI_MAIL);
3273 /* Fallback: pre-init for FN+F3,F4,F12 */
3274 hotkey_all_mask = 0x080cU;
3275 } else {
3276 tp_features.hotkey_mask = 1;
3281 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3282 "hotkey masks are %s\n",
3283 str_supported(tp_features.hotkey_mask));
3285 /* Init hotkey_all_mask if not initialized yet */
3286 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3287 (quirks & TPACPI_HK_Q_INIMASK))
3288 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3290 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3291 if (tp_features.hotkey_mask) {
3292 /* hotkey_source_mask *must* be zero for
3293 * the first hotkey_mask_get to return hotkey_orig_mask */
3294 res = hotkey_mask_get();
3295 if (res)
3296 goto err_exit;
3298 hotkey_orig_mask = hotkey_acpi_mask;
3299 } else {
3300 hotkey_orig_mask = hotkey_all_mask;
3301 hotkey_acpi_mask = hotkey_all_mask;
3304 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3305 if (dbg_wlswemul) {
3306 tp_features.hotkey_wlsw = 1;
3307 radiosw_state = !!tpacpi_wlsw_emulstate;
3308 printk(TPACPI_INFO
3309 "radio switch emulation enabled\n");
3310 } else
3311 #endif
3312 /* Not all thinkpads have a hardware radio switch */
3313 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3314 tp_features.hotkey_wlsw = 1;
3315 radiosw_state = !!status;
3316 printk(TPACPI_INFO
3317 "radio switch found; radios are %s\n",
3318 enabled(status, 0));
3320 if (tp_features.hotkey_wlsw)
3321 res = add_to_attr_set(hotkey_dev_attributes,
3322 &dev_attr_hotkey_radio_sw.attr);
3324 /* For X41t, X60t, X61t Tablets... */
3325 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3326 tp_features.hotkey_tablet = 1;
3327 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3328 printk(TPACPI_INFO
3329 "possible tablet mode switch found; "
3330 "ThinkPad in %s mode\n",
3331 (tabletsw_state) ? "tablet" : "laptop");
3332 res = add_to_attr_set(hotkey_dev_attributes,
3333 &dev_attr_hotkey_tablet_mode.attr);
3336 if (!res)
3337 res = register_attr_set_with_sysfs(
3338 hotkey_dev_attributes,
3339 &tpacpi_pdev->dev.kobj);
3340 if (res)
3341 goto err_exit;
3343 /* Set up key map */
3345 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3346 GFP_KERNEL);
3347 if (!hotkey_keycode_map) {
3348 printk(TPACPI_ERR
3349 "failed to allocate memory for key map\n");
3350 res = -ENOMEM;
3351 goto err_exit;
3354 if (thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO) {
3355 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3356 "using Lenovo default hot key map\n");
3357 memcpy(hotkey_keycode_map, &lenovo_keycode_map,
3358 TPACPI_HOTKEY_MAP_SIZE);
3359 } else {
3360 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3361 "using IBM default hot key map\n");
3362 memcpy(hotkey_keycode_map, &ibm_keycode_map,
3363 TPACPI_HOTKEY_MAP_SIZE);
3366 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3367 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3368 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3369 tpacpi_inputdev->keycode = hotkey_keycode_map;
3370 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3371 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3372 input_set_capability(tpacpi_inputdev, EV_KEY,
3373 hotkey_keycode_map[i]);
3374 } else {
3375 if (i < sizeof(hotkey_reserved_mask)*8)
3376 hotkey_reserved_mask |= 1 << i;
3380 if (tp_features.hotkey_wlsw) {
3381 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3382 input_report_switch(tpacpi_inputdev,
3383 SW_RFKILL_ALL, radiosw_state);
3385 if (tp_features.hotkey_tablet) {
3386 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3387 input_report_switch(tpacpi_inputdev,
3388 SW_TABLET_MODE, tabletsw_state);
3391 /* Do not issue duplicate brightness change events to
3392 * userspace */
3393 if (!tp_features.bright_acpimode)
3394 /* update bright_acpimode... */
3395 tpacpi_check_std_acpi_brightness_support();
3397 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3398 printk(TPACPI_INFO
3399 "This ThinkPad has standard ACPI backlight "
3400 "brightness control, supported by the ACPI "
3401 "video driver\n");
3402 printk(TPACPI_NOTICE
3403 "Disabling thinkpad-acpi brightness events "
3404 "by default...\n");
3406 /* Disable brightness up/down on Lenovo thinkpads when
3407 * ACPI is handling them, otherwise it is plain impossible
3408 * for userspace to do something even remotely sane */
3409 hotkey_reserved_mask |=
3410 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3411 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3412 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3413 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3416 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3417 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3418 & ~hotkey_all_mask
3419 & ~hotkey_reserved_mask;
3421 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3422 "hotkey source mask 0x%08x, polling freq %u\n",
3423 hotkey_source_mask, hotkey_poll_freq);
3424 #endif
3426 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3427 "enabling firmware HKEY event interface...\n");
3428 res = hotkey_status_set(true);
3429 if (res) {
3430 hotkey_exit();
3431 return res;
3433 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3434 | hotkey_driver_mask)
3435 & ~hotkey_source_mask);
3436 if (res < 0 && res != -ENXIO) {
3437 hotkey_exit();
3438 return res;
3440 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3441 & ~hotkey_reserved_mask;
3442 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3443 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3444 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3446 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3447 "legacy ibm/hotkey event reporting over procfs %s\n",
3448 (hotkey_report_mode < 2) ?
3449 "enabled" : "disabled");
3451 tpacpi_inputdev->open = &hotkey_inputdev_open;
3452 tpacpi_inputdev->close = &hotkey_inputdev_close;
3454 hotkey_poll_setup_safe(true);
3456 return 0;
3458 err_exit:
3459 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3460 hotkey_dev_attributes = NULL;
3462 return (res < 0)? res : 1;
3465 static bool hotkey_notify_hotkey(const u32 hkey,
3466 bool *send_acpi_ev,
3467 bool *ignore_acpi_ev)
3469 /* 0x1000-0x1FFF: key presses */
3470 unsigned int scancode = hkey & 0xfff;
3471 *send_acpi_ev = true;
3472 *ignore_acpi_ev = false;
3474 if (scancode > 0 && scancode < 0x21) {
3475 scancode--;
3476 if (!(hotkey_source_mask & (1 << scancode))) {
3477 tpacpi_input_send_key_masked(scancode);
3478 *send_acpi_ev = false;
3479 } else {
3480 *ignore_acpi_ev = true;
3482 return true;
3484 return false;
3487 static bool hotkey_notify_wakeup(const u32 hkey,
3488 bool *send_acpi_ev,
3489 bool *ignore_acpi_ev)
3491 /* 0x2000-0x2FFF: Wakeup reason */
3492 *send_acpi_ev = true;
3493 *ignore_acpi_ev = false;
3495 switch (hkey) {
3496 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3497 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3498 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3499 *ignore_acpi_ev = true;
3500 break;
3502 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3503 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3504 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3505 *ignore_acpi_ev = true;
3506 break;
3508 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3509 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3510 printk(TPACPI_ALERT
3511 "EMERGENCY WAKEUP: battery almost empty\n");
3512 /* how to auto-heal: */
3513 /* 2313: woke up from S3, go to S4/S5 */
3514 /* 2413: woke up from S4, go to S5 */
3515 break;
3517 default:
3518 return false;
3521 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3522 printk(TPACPI_INFO
3523 "woke up due to a hot-unplug "
3524 "request...\n");
3525 hotkey_wakeup_reason_notify_change();
3527 return true;
3530 static bool hotkey_notify_usrevent(const u32 hkey,
3531 bool *send_acpi_ev,
3532 bool *ignore_acpi_ev)
3534 /* 0x5000-0x5FFF: human interface helpers */
3535 *send_acpi_ev = true;
3536 *ignore_acpi_ev = false;
3538 switch (hkey) {
3539 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3540 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3541 return true;
3543 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3544 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3545 tpacpi_input_send_tabletsw();
3546 hotkey_tablet_mode_notify_change();
3547 *send_acpi_ev = false;
3548 return true;
3550 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3551 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3552 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3553 /* do not propagate these events */
3554 *ignore_acpi_ev = true;
3555 return true;
3557 default:
3558 return false;
3562 static void thermal_dump_all_sensors(void);
3564 static bool hotkey_notify_thermal(const u32 hkey,
3565 bool *send_acpi_ev,
3566 bool *ignore_acpi_ev)
3568 bool known = true;
3570 /* 0x6000-0x6FFF: thermal alarms */
3571 *send_acpi_ev = true;
3572 *ignore_acpi_ev = false;
3574 switch (hkey) {
3575 case TP_HKEY_EV_THM_TABLE_CHANGED:
3576 printk(TPACPI_INFO
3577 "EC reports that Thermal Table has changed\n");
3578 /* recommended action: do nothing, we don't have
3579 * Lenovo ATM information */
3580 return true;
3581 case TP_HKEY_EV_ALARM_BAT_HOT:
3582 printk(TPACPI_CRIT
3583 "THERMAL ALARM: battery is too hot!\n");
3584 /* recommended action: warn user through gui */
3585 break;
3586 case TP_HKEY_EV_ALARM_BAT_XHOT:
3587 printk(TPACPI_ALERT
3588 "THERMAL EMERGENCY: battery is extremely hot!\n");
3589 /* recommended action: immediate sleep/hibernate */
3590 break;
3591 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3592 printk(TPACPI_CRIT
3593 "THERMAL ALARM: "
3594 "a sensor reports something is too hot!\n");
3595 /* recommended action: warn user through gui, that */
3596 /* some internal component is too hot */
3597 break;
3598 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3599 printk(TPACPI_ALERT
3600 "THERMAL EMERGENCY: "
3601 "a sensor reports something is extremely hot!\n");
3602 /* recommended action: immediate sleep/hibernate */
3603 break;
3604 default:
3605 printk(TPACPI_ALERT
3606 "THERMAL ALERT: unknown thermal alarm received\n");
3607 known = false;
3610 thermal_dump_all_sensors();
3612 return known;
3615 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3617 u32 hkey;
3618 bool send_acpi_ev;
3619 bool ignore_acpi_ev;
3620 bool known_ev;
3622 if (event != 0x80) {
3623 printk(TPACPI_ERR
3624 "unknown HKEY notification event %d\n", event);
3625 /* forward it to userspace, maybe it knows how to handle it */
3626 acpi_bus_generate_netlink_event(
3627 ibm->acpi->device->pnp.device_class,
3628 dev_name(&ibm->acpi->device->dev),
3629 event, 0);
3630 return;
3633 while (1) {
3634 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3635 printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3636 return;
3639 if (hkey == 0) {
3640 /* queue empty */
3641 return;
3644 send_acpi_ev = true;
3645 ignore_acpi_ev = false;
3647 switch (hkey >> 12) {
3648 case 1:
3649 /* 0x1000-0x1FFF: key presses */
3650 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3651 &ignore_acpi_ev);
3652 break;
3653 case 2:
3654 /* 0x2000-0x2FFF: Wakeup reason */
3655 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3656 &ignore_acpi_ev);
3657 break;
3658 case 3:
3659 /* 0x3000-0x3FFF: bay-related wakeups */
3660 switch (hkey) {
3661 case TP_HKEY_EV_BAYEJ_ACK:
3662 hotkey_autosleep_ack = 1;
3663 printk(TPACPI_INFO
3664 "bay ejected\n");
3665 hotkey_wakeup_hotunplug_complete_notify_change();
3666 known_ev = true;
3667 break;
3668 case TP_HKEY_EV_OPTDRV_EJ:
3669 /* FIXME: kick libata if SATA link offline */
3670 known_ev = true;
3671 break;
3672 default:
3673 known_ev = false;
3675 break;
3676 case 4:
3677 /* 0x4000-0x4FFF: dock-related wakeups */
3678 if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3679 hotkey_autosleep_ack = 1;
3680 printk(TPACPI_INFO
3681 "undocked\n");
3682 hotkey_wakeup_hotunplug_complete_notify_change();
3683 known_ev = true;
3684 } else {
3685 known_ev = false;
3687 break;
3688 case 5:
3689 /* 0x5000-0x5FFF: human interface helpers */
3690 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3691 &ignore_acpi_ev);
3692 break;
3693 case 6:
3694 /* 0x6000-0x6FFF: thermal alarms */
3695 known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3696 &ignore_acpi_ev);
3697 break;
3698 case 7:
3699 /* 0x7000-0x7FFF: misc */
3700 if (tp_features.hotkey_wlsw &&
3701 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3702 tpacpi_send_radiosw_update();
3703 send_acpi_ev = 0;
3704 known_ev = true;
3705 break;
3707 /* fallthrough to default */
3708 default:
3709 known_ev = false;
3711 if (!known_ev) {
3712 printk(TPACPI_NOTICE
3713 "unhandled HKEY event 0x%04x\n", hkey);
3714 printk(TPACPI_NOTICE
3715 "please report the conditions when this "
3716 "event happened to %s\n", TPACPI_MAIL);
3719 /* Legacy events */
3720 if (!ignore_acpi_ev &&
3721 (send_acpi_ev || hotkey_report_mode < 2)) {
3722 acpi_bus_generate_proc_event(ibm->acpi->device,
3723 event, hkey);
3726 /* netlink events */
3727 if (!ignore_acpi_ev && send_acpi_ev) {
3728 acpi_bus_generate_netlink_event(
3729 ibm->acpi->device->pnp.device_class,
3730 dev_name(&ibm->acpi->device->dev),
3731 event, hkey);
3736 static void hotkey_suspend(pm_message_t state)
3738 /* Do these on suspend, we get the events on early resume! */
3739 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3740 hotkey_autosleep_ack = 0;
3743 static void hotkey_resume(void)
3745 tpacpi_disable_brightness_delay();
3747 if (hotkey_status_set(true) < 0 ||
3748 hotkey_mask_set(hotkey_acpi_mask) < 0)
3749 printk(TPACPI_ERR
3750 "error while attempting to reset the event "
3751 "firmware interface\n");
3753 tpacpi_send_radiosw_update();
3754 hotkey_tablet_mode_notify_change();
3755 hotkey_wakeup_reason_notify_change();
3756 hotkey_wakeup_hotunplug_complete_notify_change();
3757 hotkey_poll_setup_safe(false);
3760 /* procfs -------------------------------------------------------------- */
3761 static int hotkey_read(struct seq_file *m)
3763 int res, status;
3765 if (!tp_features.hotkey) {
3766 seq_printf(m, "status:\t\tnot supported\n");
3767 return 0;
3770 if (mutex_lock_killable(&hotkey_mutex))
3771 return -ERESTARTSYS;
3772 res = hotkey_status_get(&status);
3773 if (!res)
3774 res = hotkey_mask_get();
3775 mutex_unlock(&hotkey_mutex);
3776 if (res)
3777 return res;
3779 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3780 if (hotkey_all_mask) {
3781 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3782 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3783 } else {
3784 seq_printf(m, "mask:\t\tnot supported\n");
3785 seq_printf(m, "commands:\tenable, disable, reset\n");
3788 return 0;
3791 static void hotkey_enabledisable_warn(bool enable)
3793 tpacpi_log_usertask("procfs hotkey enable/disable");
3794 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3795 TPACPI_WARN
3796 "hotkey enable/disable functionality has been "
3797 "removed from the driver. Hotkeys are always "
3798 "enabled\n"))
3799 printk(TPACPI_ERR
3800 "Please remove the hotkey=enable module "
3801 "parameter, it is deprecated. Hotkeys are always "
3802 "enabled\n");
3805 static int hotkey_write(char *buf)
3807 int res;
3808 u32 mask;
3809 char *cmd;
3811 if (!tp_features.hotkey)
3812 return -ENODEV;
3814 if (mutex_lock_killable(&hotkey_mutex))
3815 return -ERESTARTSYS;
3817 mask = hotkey_user_mask;
3819 res = 0;
3820 while ((cmd = next_cmd(&buf))) {
3821 if (strlencmp(cmd, "enable") == 0) {
3822 hotkey_enabledisable_warn(1);
3823 } else if (strlencmp(cmd, "disable") == 0) {
3824 hotkey_enabledisable_warn(0);
3825 res = -EPERM;
3826 } else if (strlencmp(cmd, "reset") == 0) {
3827 mask = (hotkey_all_mask | hotkey_source_mask)
3828 & ~hotkey_reserved_mask;
3829 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3830 /* mask set */
3831 } else if (sscanf(cmd, "%x", &mask) == 1) {
3832 /* mask set */
3833 } else {
3834 res = -EINVAL;
3835 goto errexit;
3839 if (!res) {
3840 tpacpi_disclose_usertask("procfs hotkey",
3841 "set mask to 0x%08x\n", mask);
3842 res = hotkey_user_mask_set(mask);
3845 errexit:
3846 mutex_unlock(&hotkey_mutex);
3847 return res;
3850 static const struct acpi_device_id ibm_htk_device_ids[] = {
3851 {TPACPI_ACPI_HKEY_HID, 0},
3852 {"", 0},
3855 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3856 .hid = ibm_htk_device_ids,
3857 .notify = hotkey_notify,
3858 .handle = &hkey_handle,
3859 .type = ACPI_DEVICE_NOTIFY,
3862 static struct ibm_struct hotkey_driver_data = {
3863 .name = "hotkey",
3864 .read = hotkey_read,
3865 .write = hotkey_write,
3866 .exit = hotkey_exit,
3867 .resume = hotkey_resume,
3868 .suspend = hotkey_suspend,
3869 .acpi = &ibm_hotkey_acpidriver,
3872 /*************************************************************************
3873 * Bluetooth subdriver
3876 enum {
3877 /* ACPI GBDC/SBDC bits */
3878 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3879 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3880 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3881 off / last state */
3884 enum {
3885 /* ACPI \BLTH commands */
3886 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3887 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3888 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3889 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3890 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3893 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3895 static int bluetooth_get_status(void)
3897 int status;
3899 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3900 if (dbg_bluetoothemul)
3901 return (tpacpi_bluetooth_emulstate) ?
3902 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3903 #endif
3905 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3906 return -EIO;
3908 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3909 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3912 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3914 int status;
3916 vdbg_printk(TPACPI_DBG_RFKILL,
3917 "will attempt to %s bluetooth\n",
3918 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3920 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3921 if (dbg_bluetoothemul) {
3922 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3923 return 0;
3925 #endif
3927 /* We make sure to keep TP_ACPI_BLUETOOTH_RESUMECTRL off */
3928 status = TP_ACPI_BLUETOOTH_RESUMECTRL;
3929 if (state == TPACPI_RFK_RADIO_ON)
3930 status |= TP_ACPI_BLUETOOTH_RADIOSSW;
3932 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3933 return -EIO;
3935 return 0;
3938 /* sysfs bluetooth enable ---------------------------------------------- */
3939 static ssize_t bluetooth_enable_show(struct device *dev,
3940 struct device_attribute *attr,
3941 char *buf)
3943 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3944 attr, buf);
3947 static ssize_t bluetooth_enable_store(struct device *dev,
3948 struct device_attribute *attr,
3949 const char *buf, size_t count)
3951 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3952 attr, buf, count);
3955 static struct device_attribute dev_attr_bluetooth_enable =
3956 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3957 bluetooth_enable_show, bluetooth_enable_store);
3959 /* --------------------------------------------------------------------- */
3961 static struct attribute *bluetooth_attributes[] = {
3962 &dev_attr_bluetooth_enable.attr,
3963 NULL
3966 static const struct attribute_group bluetooth_attr_group = {
3967 .attrs = bluetooth_attributes,
3970 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
3971 .get_status = bluetooth_get_status,
3972 .set_status = bluetooth_set_status,
3975 static void bluetooth_shutdown(void)
3977 /* Order firmware to save current state to NVRAM */
3978 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
3979 TP_ACPI_BLTH_SAVE_STATE))
3980 printk(TPACPI_NOTICE
3981 "failed to save bluetooth state to NVRAM\n");
3982 else
3983 vdbg_printk(TPACPI_DBG_RFKILL,
3984 "bluestooth state saved to NVRAM\n");
3987 static void bluetooth_exit(void)
3989 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3990 &bluetooth_attr_group);
3992 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
3994 bluetooth_shutdown();
3997 static int __init bluetooth_init(struct ibm_init_struct *iibm)
3999 int res;
4000 int status = 0;
4002 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4003 "initializing bluetooth subdriver\n");
4005 TPACPI_ACPIHANDLE_INIT(hkey);
4007 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4008 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4009 tp_features.bluetooth = hkey_handle &&
4010 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4012 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4013 "bluetooth is %s, status 0x%02x\n",
4014 str_supported(tp_features.bluetooth),
4015 status);
4017 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4018 if (dbg_bluetoothemul) {
4019 tp_features.bluetooth = 1;
4020 printk(TPACPI_INFO
4021 "bluetooth switch emulation enabled\n");
4022 } else
4023 #endif
4024 if (tp_features.bluetooth &&
4025 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4026 /* no bluetooth hardware present in system */
4027 tp_features.bluetooth = 0;
4028 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4029 "bluetooth hardware not installed\n");
4032 if (!tp_features.bluetooth)
4033 return 1;
4035 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4036 &bluetooth_tprfk_ops,
4037 RFKILL_TYPE_BLUETOOTH,
4038 TPACPI_RFK_BLUETOOTH_SW_NAME,
4039 true);
4040 if (res)
4041 return res;
4043 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4044 &bluetooth_attr_group);
4045 if (res) {
4046 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4047 return res;
4050 return 0;
4053 /* procfs -------------------------------------------------------------- */
4054 static int bluetooth_read(struct seq_file *m)
4056 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4059 static int bluetooth_write(char *buf)
4061 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4064 static struct ibm_struct bluetooth_driver_data = {
4065 .name = "bluetooth",
4066 .read = bluetooth_read,
4067 .write = bluetooth_write,
4068 .exit = bluetooth_exit,
4069 .shutdown = bluetooth_shutdown,
4072 /*************************************************************************
4073 * Wan subdriver
4076 enum {
4077 /* ACPI GWAN/SWAN bits */
4078 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4079 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4080 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4081 off / last state */
4084 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4086 static int wan_get_status(void)
4088 int status;
4090 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4091 if (dbg_wwanemul)
4092 return (tpacpi_wwan_emulstate) ?
4093 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4094 #endif
4096 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4097 return -EIO;
4099 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4100 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4103 static int wan_set_status(enum tpacpi_rfkill_state state)
4105 int status;
4107 vdbg_printk(TPACPI_DBG_RFKILL,
4108 "will attempt to %s wwan\n",
4109 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4111 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4112 if (dbg_wwanemul) {
4113 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4114 return 0;
4116 #endif
4118 /* We make sure to set TP_ACPI_WANCARD_RESUMECTRL */
4119 status = TP_ACPI_WANCARD_RESUMECTRL;
4120 if (state == TPACPI_RFK_RADIO_ON)
4121 status |= TP_ACPI_WANCARD_RADIOSSW;
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 TPACPI_ACPIHANDLE_INIT(vid2);
4423 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4424 /* G41, assume IVGA doesn't change */
4425 vid_handle = vid2_handle;
4427 if (!vid_handle)
4428 /* video switching not supported on R30, R31 */
4429 video_supported = TPACPI_VIDEO_NONE;
4430 else if (acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4431 /* 570 */
4432 video_supported = TPACPI_VIDEO_570;
4433 else if (acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4434 /* 600e/x, 770e, 770x */
4435 video_supported = TPACPI_VIDEO_770;
4436 else
4437 /* all others */
4438 video_supported = TPACPI_VIDEO_NEW;
4440 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4441 str_supported(video_supported != TPACPI_VIDEO_NONE),
4442 video_supported);
4444 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4447 static void video_exit(void)
4449 dbg_printk(TPACPI_DBG_EXIT,
4450 "restoring original video autoswitch mode\n");
4451 if (video_autosw_set(video_orig_autosw))
4452 printk(TPACPI_ERR "error while trying to restore original "
4453 "video autoswitch mode\n");
4456 static int video_outputsw_get(void)
4458 int status = 0;
4459 int i;
4461 switch (video_supported) {
4462 case TPACPI_VIDEO_570:
4463 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4464 TP_ACPI_VIDEO_570_PHSCMD))
4465 return -EIO;
4466 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4467 break;
4468 case TPACPI_VIDEO_770:
4469 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4470 return -EIO;
4471 if (i)
4472 status |= TP_ACPI_VIDEO_S_LCD;
4473 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4474 return -EIO;
4475 if (i)
4476 status |= TP_ACPI_VIDEO_S_CRT;
4477 break;
4478 case TPACPI_VIDEO_NEW:
4479 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4480 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4481 return -EIO;
4482 if (i)
4483 status |= TP_ACPI_VIDEO_S_CRT;
4485 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4486 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4487 return -EIO;
4488 if (i)
4489 status |= TP_ACPI_VIDEO_S_LCD;
4490 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4491 return -EIO;
4492 if (i)
4493 status |= TP_ACPI_VIDEO_S_DVI;
4494 break;
4495 default:
4496 return -ENOSYS;
4499 return status;
4502 static int video_outputsw_set(int status)
4504 int autosw;
4505 int res = 0;
4507 switch (video_supported) {
4508 case TPACPI_VIDEO_570:
4509 res = acpi_evalf(NULL, NULL,
4510 "\\_SB.PHS2", "vdd",
4511 TP_ACPI_VIDEO_570_PHS2CMD,
4512 status | TP_ACPI_VIDEO_570_PHS2SET);
4513 break;
4514 case TPACPI_VIDEO_770:
4515 autosw = video_autosw_get();
4516 if (autosw < 0)
4517 return autosw;
4519 res = video_autosw_set(1);
4520 if (res)
4521 return res;
4522 res = acpi_evalf(vid_handle, NULL,
4523 "ASWT", "vdd", status * 0x100, 0);
4524 if (!autosw && video_autosw_set(autosw)) {
4525 printk(TPACPI_ERR
4526 "video auto-switch left enabled due to error\n");
4527 return -EIO;
4529 break;
4530 case TPACPI_VIDEO_NEW:
4531 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4532 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4533 break;
4534 default:
4535 return -ENOSYS;
4538 return (res)? 0 : -EIO;
4541 static int video_autosw_get(void)
4543 int autosw = 0;
4545 switch (video_supported) {
4546 case TPACPI_VIDEO_570:
4547 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4548 return -EIO;
4549 break;
4550 case TPACPI_VIDEO_770:
4551 case TPACPI_VIDEO_NEW:
4552 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4553 return -EIO;
4554 break;
4555 default:
4556 return -ENOSYS;
4559 return autosw & 1;
4562 static int video_autosw_set(int enable)
4564 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4565 return -EIO;
4566 return 0;
4569 static int video_outputsw_cycle(void)
4571 int autosw = video_autosw_get();
4572 int res;
4574 if (autosw < 0)
4575 return autosw;
4577 switch (video_supported) {
4578 case TPACPI_VIDEO_570:
4579 res = video_autosw_set(1);
4580 if (res)
4581 return res;
4582 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4583 break;
4584 case TPACPI_VIDEO_770:
4585 case TPACPI_VIDEO_NEW:
4586 res = video_autosw_set(1);
4587 if (res)
4588 return res;
4589 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4590 break;
4591 default:
4592 return -ENOSYS;
4594 if (!autosw && video_autosw_set(autosw)) {
4595 printk(TPACPI_ERR
4596 "video auto-switch left enabled due to error\n");
4597 return -EIO;
4600 return (res)? 0 : -EIO;
4603 static int video_expand_toggle(void)
4605 switch (video_supported) {
4606 case TPACPI_VIDEO_570:
4607 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4608 0 : -EIO;
4609 case TPACPI_VIDEO_770:
4610 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4611 0 : -EIO;
4612 case TPACPI_VIDEO_NEW:
4613 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4614 0 : -EIO;
4615 default:
4616 return -ENOSYS;
4618 /* not reached */
4621 static int video_read(struct seq_file *m)
4623 int status, autosw;
4625 if (video_supported == TPACPI_VIDEO_NONE) {
4626 seq_printf(m, "status:\t\tnot supported\n");
4627 return 0;
4630 status = video_outputsw_get();
4631 if (status < 0)
4632 return status;
4634 autosw = video_autosw_get();
4635 if (autosw < 0)
4636 return autosw;
4638 seq_printf(m, "status:\t\tsupported\n");
4639 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4640 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4641 if (video_supported == TPACPI_VIDEO_NEW)
4642 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4643 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4644 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4645 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4646 if (video_supported == TPACPI_VIDEO_NEW)
4647 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4648 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4649 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4651 return 0;
4654 static int video_write(char *buf)
4656 char *cmd;
4657 int enable, disable, status;
4658 int res;
4660 if (video_supported == TPACPI_VIDEO_NONE)
4661 return -ENODEV;
4663 enable = 0;
4664 disable = 0;
4666 while ((cmd = next_cmd(&buf))) {
4667 if (strlencmp(cmd, "lcd_enable") == 0) {
4668 enable |= TP_ACPI_VIDEO_S_LCD;
4669 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4670 disable |= TP_ACPI_VIDEO_S_LCD;
4671 } else if (strlencmp(cmd, "crt_enable") == 0) {
4672 enable |= TP_ACPI_VIDEO_S_CRT;
4673 } else if (strlencmp(cmd, "crt_disable") == 0) {
4674 disable |= TP_ACPI_VIDEO_S_CRT;
4675 } else if (video_supported == TPACPI_VIDEO_NEW &&
4676 strlencmp(cmd, "dvi_enable") == 0) {
4677 enable |= TP_ACPI_VIDEO_S_DVI;
4678 } else if (video_supported == TPACPI_VIDEO_NEW &&
4679 strlencmp(cmd, "dvi_disable") == 0) {
4680 disable |= TP_ACPI_VIDEO_S_DVI;
4681 } else if (strlencmp(cmd, "auto_enable") == 0) {
4682 res = video_autosw_set(1);
4683 if (res)
4684 return res;
4685 } else if (strlencmp(cmd, "auto_disable") == 0) {
4686 res = video_autosw_set(0);
4687 if (res)
4688 return res;
4689 } else if (strlencmp(cmd, "video_switch") == 0) {
4690 res = video_outputsw_cycle();
4691 if (res)
4692 return res;
4693 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4694 res = video_expand_toggle();
4695 if (res)
4696 return res;
4697 } else
4698 return -EINVAL;
4701 if (enable || disable) {
4702 status = video_outputsw_get();
4703 if (status < 0)
4704 return status;
4705 res = video_outputsw_set((status & ~disable) | enable);
4706 if (res)
4707 return res;
4710 return 0;
4713 static struct ibm_struct video_driver_data = {
4714 .name = "video",
4715 .read = video_read,
4716 .write = video_write,
4717 .exit = video_exit,
4720 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4722 /*************************************************************************
4723 * Light (thinklight) subdriver
4726 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4727 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4729 static int light_get_status(void)
4731 int status = 0;
4733 if (tp_features.light_status) {
4734 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4735 return -EIO;
4736 return (!!status);
4739 return -ENXIO;
4742 static int light_set_status(int status)
4744 int rc;
4746 if (tp_features.light) {
4747 if (cmos_handle) {
4748 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4749 (status)?
4750 TP_CMOS_THINKLIGHT_ON :
4751 TP_CMOS_THINKLIGHT_OFF);
4752 } else {
4753 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4754 (status)? 1 : 0);
4756 return (rc)? 0 : -EIO;
4759 return -ENXIO;
4762 static void light_set_status_worker(struct work_struct *work)
4764 struct tpacpi_led_classdev *data =
4765 container_of(work, struct tpacpi_led_classdev, work);
4767 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4768 light_set_status((data->new_state != TPACPI_LED_OFF));
4771 static void light_sysfs_set(struct led_classdev *led_cdev,
4772 enum led_brightness brightness)
4774 struct tpacpi_led_classdev *data =
4775 container_of(led_cdev,
4776 struct tpacpi_led_classdev,
4777 led_classdev);
4778 data->new_state = (brightness != LED_OFF) ?
4779 TPACPI_LED_ON : TPACPI_LED_OFF;
4780 queue_work(tpacpi_wq, &data->work);
4783 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4785 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4788 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4789 .led_classdev = {
4790 .name = "tpacpi::thinklight",
4791 .brightness_set = &light_sysfs_set,
4792 .brightness_get = &light_sysfs_get,
4796 static int __init light_init(struct ibm_init_struct *iibm)
4798 int rc;
4800 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4802 TPACPI_ACPIHANDLE_INIT(ledb);
4803 TPACPI_ACPIHANDLE_INIT(lght);
4804 TPACPI_ACPIHANDLE_INIT(cmos);
4805 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4807 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4808 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4810 if (tp_features.light)
4811 /* light status not supported on
4812 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4813 tp_features.light_status =
4814 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4816 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4817 str_supported(tp_features.light),
4818 str_supported(tp_features.light_status));
4820 if (!tp_features.light)
4821 return 1;
4823 rc = led_classdev_register(&tpacpi_pdev->dev,
4824 &tpacpi_led_thinklight.led_classdev);
4826 if (rc < 0) {
4827 tp_features.light = 0;
4828 tp_features.light_status = 0;
4829 } else {
4830 rc = 0;
4833 return rc;
4836 static void light_exit(void)
4838 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4839 if (work_pending(&tpacpi_led_thinklight.work))
4840 flush_workqueue(tpacpi_wq);
4843 static int light_read(struct seq_file *m)
4845 int status;
4847 if (!tp_features.light) {
4848 seq_printf(m, "status:\t\tnot supported\n");
4849 } else if (!tp_features.light_status) {
4850 seq_printf(m, "status:\t\tunknown\n");
4851 seq_printf(m, "commands:\ton, off\n");
4852 } else {
4853 status = light_get_status();
4854 if (status < 0)
4855 return status;
4856 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4857 seq_printf(m, "commands:\ton, off\n");
4860 return 0;
4863 static int light_write(char *buf)
4865 char *cmd;
4866 int newstatus = 0;
4868 if (!tp_features.light)
4869 return -ENODEV;
4871 while ((cmd = next_cmd(&buf))) {
4872 if (strlencmp(cmd, "on") == 0) {
4873 newstatus = 1;
4874 } else if (strlencmp(cmd, "off") == 0) {
4875 newstatus = 0;
4876 } else
4877 return -EINVAL;
4880 return light_set_status(newstatus);
4883 static struct ibm_struct light_driver_data = {
4884 .name = "light",
4885 .read = light_read,
4886 .write = light_write,
4887 .exit = light_exit,
4890 /*************************************************************************
4891 * CMOS subdriver
4894 /* sysfs cmos_command -------------------------------------------------- */
4895 static ssize_t cmos_command_store(struct device *dev,
4896 struct device_attribute *attr,
4897 const char *buf, size_t count)
4899 unsigned long cmos_cmd;
4900 int res;
4902 if (parse_strtoul(buf, 21, &cmos_cmd))
4903 return -EINVAL;
4905 res = issue_thinkpad_cmos_command(cmos_cmd);
4906 return (res)? res : count;
4909 static struct device_attribute dev_attr_cmos_command =
4910 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4912 /* --------------------------------------------------------------------- */
4914 static int __init cmos_init(struct ibm_init_struct *iibm)
4916 int res;
4918 vdbg_printk(TPACPI_DBG_INIT,
4919 "initializing cmos commands subdriver\n");
4921 TPACPI_ACPIHANDLE_INIT(cmos);
4923 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4924 str_supported(cmos_handle != NULL));
4926 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4927 if (res)
4928 return res;
4930 return (cmos_handle)? 0 : 1;
4933 static void cmos_exit(void)
4935 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4938 static int cmos_read(struct seq_file *m)
4940 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4941 R30, R31, T20-22, X20-21 */
4942 if (!cmos_handle)
4943 seq_printf(m, "status:\t\tnot supported\n");
4944 else {
4945 seq_printf(m, "status:\t\tsupported\n");
4946 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
4949 return 0;
4952 static int cmos_write(char *buf)
4954 char *cmd;
4955 int cmos_cmd, res;
4957 while ((cmd = next_cmd(&buf))) {
4958 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
4959 cmos_cmd >= 0 && cmos_cmd <= 21) {
4960 /* cmos_cmd set */
4961 } else
4962 return -EINVAL;
4964 res = issue_thinkpad_cmos_command(cmos_cmd);
4965 if (res)
4966 return res;
4969 return 0;
4972 static struct ibm_struct cmos_driver_data = {
4973 .name = "cmos",
4974 .read = cmos_read,
4975 .write = cmos_write,
4976 .exit = cmos_exit,
4979 /*************************************************************************
4980 * LED subdriver
4983 enum led_access_mode {
4984 TPACPI_LED_NONE = 0,
4985 TPACPI_LED_570, /* 570 */
4986 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
4987 TPACPI_LED_NEW, /* all others */
4990 enum { /* For TPACPI_LED_OLD */
4991 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
4992 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
4993 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
4996 static enum led_access_mode led_supported;
4998 TPACPI_HANDLE(led, ec, "SLED", /* 570 */
4999 "SYSL", /* 600e/x, 770e, 770x, A21e, A2xm/p, */
5000 /* T20-22, X20-21 */
5001 "LED", /* all others */
5002 ); /* R30, R31 */
5004 #define TPACPI_LED_NUMLEDS 16
5005 static struct tpacpi_led_classdev *tpacpi_leds;
5006 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5007 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5008 /* there's a limit of 19 chars + NULL before 2.6.26 */
5009 "tpacpi::power",
5010 "tpacpi:orange:batt",
5011 "tpacpi:green:batt",
5012 "tpacpi::dock_active",
5013 "tpacpi::bay_active",
5014 "tpacpi::dock_batt",
5015 "tpacpi::unknown_led",
5016 "tpacpi::standby",
5017 "tpacpi::dock_status1",
5018 "tpacpi::dock_status2",
5019 "tpacpi::unknown_led2",
5020 "tpacpi::unknown_led3",
5021 "tpacpi::thinkvantage",
5023 #define TPACPI_SAFE_LEDS 0x1081U
5025 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5027 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5028 return false;
5029 #else
5030 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5031 #endif
5034 static int led_get_status(const unsigned int led)
5036 int status;
5037 enum led_status_t led_s;
5039 switch (led_supported) {
5040 case TPACPI_LED_570:
5041 if (!acpi_evalf(ec_handle,
5042 &status, "GLED", "dd", 1 << led))
5043 return -EIO;
5044 led_s = (status == 0)?
5045 TPACPI_LED_OFF :
5046 ((status == 1)?
5047 TPACPI_LED_ON :
5048 TPACPI_LED_BLINK);
5049 tpacpi_led_state_cache[led] = led_s;
5050 return led_s;
5051 default:
5052 return -ENXIO;
5055 /* not reached */
5058 static int led_set_status(const unsigned int led,
5059 const enum led_status_t ledstatus)
5061 /* off, on, blink. Index is led_status_t */
5062 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5063 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5065 int rc = 0;
5067 switch (led_supported) {
5068 case TPACPI_LED_570:
5069 /* 570 */
5070 if (unlikely(led > 7))
5071 return -EINVAL;
5072 if (unlikely(tpacpi_is_led_restricted(led)))
5073 return -EPERM;
5074 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5075 (1 << led), led_sled_arg1[ledstatus]))
5076 rc = -EIO;
5077 break;
5078 case TPACPI_LED_OLD:
5079 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5080 if (unlikely(led > 7))
5081 return -EINVAL;
5082 if (unlikely(tpacpi_is_led_restricted(led)))
5083 return -EPERM;
5084 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5085 if (rc >= 0)
5086 rc = ec_write(TPACPI_LED_EC_HLBL,
5087 (ledstatus == TPACPI_LED_BLINK) << led);
5088 if (rc >= 0)
5089 rc = ec_write(TPACPI_LED_EC_HLCL,
5090 (ledstatus != TPACPI_LED_OFF) << led);
5091 break;
5092 case TPACPI_LED_NEW:
5093 /* all others */
5094 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5095 return -EINVAL;
5096 if (unlikely(tpacpi_is_led_restricted(led)))
5097 return -EPERM;
5098 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5099 led, led_led_arg1[ledstatus]))
5100 rc = -EIO;
5101 break;
5102 default:
5103 rc = -ENXIO;
5106 if (!rc)
5107 tpacpi_led_state_cache[led] = ledstatus;
5109 return rc;
5112 static void led_set_status_worker(struct work_struct *work)
5114 struct tpacpi_led_classdev *data =
5115 container_of(work, struct tpacpi_led_classdev, work);
5117 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5118 led_set_status(data->led, data->new_state);
5121 static void led_sysfs_set(struct led_classdev *led_cdev,
5122 enum led_brightness brightness)
5124 struct tpacpi_led_classdev *data = container_of(led_cdev,
5125 struct tpacpi_led_classdev, led_classdev);
5127 if (brightness == LED_OFF)
5128 data->new_state = TPACPI_LED_OFF;
5129 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5130 data->new_state = TPACPI_LED_ON;
5131 else
5132 data->new_state = TPACPI_LED_BLINK;
5134 queue_work(tpacpi_wq, &data->work);
5137 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5138 unsigned long *delay_on, unsigned long *delay_off)
5140 struct tpacpi_led_classdev *data = container_of(led_cdev,
5141 struct tpacpi_led_classdev, led_classdev);
5143 /* Can we choose the flash rate? */
5144 if (*delay_on == 0 && *delay_off == 0) {
5145 /* yes. set them to the hardware blink rate (1 Hz) */
5146 *delay_on = 500; /* ms */
5147 *delay_off = 500; /* ms */
5148 } else if ((*delay_on != 500) || (*delay_off != 500))
5149 return -EINVAL;
5151 data->new_state = TPACPI_LED_BLINK;
5152 queue_work(tpacpi_wq, &data->work);
5154 return 0;
5157 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5159 int rc;
5161 struct tpacpi_led_classdev *data = container_of(led_cdev,
5162 struct tpacpi_led_classdev, led_classdev);
5164 rc = led_get_status(data->led);
5166 if (rc == TPACPI_LED_OFF || rc < 0)
5167 rc = LED_OFF; /* no error handling in led class :( */
5168 else
5169 rc = LED_FULL;
5171 return rc;
5174 static void led_exit(void)
5176 unsigned int i;
5178 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5179 if (tpacpi_leds[i].led_classdev.name)
5180 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5183 kfree(tpacpi_leds);
5186 static int __init tpacpi_init_led(unsigned int led)
5188 int rc;
5190 tpacpi_leds[led].led = led;
5192 /* LEDs with no name don't get registered */
5193 if (!tpacpi_led_names[led])
5194 return 0;
5196 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5197 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5198 if (led_supported == TPACPI_LED_570)
5199 tpacpi_leds[led].led_classdev.brightness_get =
5200 &led_sysfs_get;
5202 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5204 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5206 rc = led_classdev_register(&tpacpi_pdev->dev,
5207 &tpacpi_leds[led].led_classdev);
5208 if (rc < 0)
5209 tpacpi_leds[led].led_classdev.name = NULL;
5211 return rc;
5214 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5215 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5216 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5217 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5219 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5220 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5221 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5222 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5223 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5224 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5225 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5226 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5228 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5229 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5230 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5231 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5232 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5234 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5235 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5236 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5237 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5239 /* (1) - may have excess leds enabled on MSB */
5241 /* Defaults (order matters, keep last, don't reorder!) */
5242 { /* Lenovo */
5243 .vendor = PCI_VENDOR_ID_LENOVO,
5244 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5245 .quirks = 0x1fffU,
5247 { /* IBM ThinkPads with no EC version string */
5248 .vendor = PCI_VENDOR_ID_IBM,
5249 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5250 .quirks = 0x00ffU,
5252 { /* IBM ThinkPads with EC version string */
5253 .vendor = PCI_VENDOR_ID_IBM,
5254 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5255 .quirks = 0x00bfU,
5259 #undef TPACPI_LEDQ_IBM
5260 #undef TPACPI_LEDQ_LNV
5262 static int __init led_init(struct ibm_init_struct *iibm)
5264 unsigned int i;
5265 int rc;
5266 unsigned long useful_leds;
5268 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5270 TPACPI_ACPIHANDLE_INIT(led);
5272 if (!led_handle)
5273 /* led not supported on R30, R31 */
5274 led_supported = TPACPI_LED_NONE;
5275 else if (strlencmp(led_path, "SLED") == 0)
5276 /* 570 */
5277 led_supported = TPACPI_LED_570;
5278 else if (strlencmp(led_path, "SYSL") == 0)
5279 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5280 led_supported = TPACPI_LED_OLD;
5281 else
5282 /* all others */
5283 led_supported = TPACPI_LED_NEW;
5285 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5286 str_supported(led_supported), led_supported);
5288 if (led_supported == TPACPI_LED_NONE)
5289 return 1;
5291 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5292 GFP_KERNEL);
5293 if (!tpacpi_leds) {
5294 printk(TPACPI_ERR "Out of memory for LED data\n");
5295 return -ENOMEM;
5298 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5299 ARRAY_SIZE(led_useful_qtable));
5301 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5302 if (!tpacpi_is_led_restricted(i) &&
5303 test_bit(i, &useful_leds)) {
5304 rc = tpacpi_init_led(i);
5305 if (rc < 0) {
5306 led_exit();
5307 return rc;
5312 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5313 printk(TPACPI_NOTICE
5314 "warning: userspace override of important "
5315 "firmware LEDs is enabled\n");
5316 #endif
5317 return 0;
5320 #define str_led_status(s) \
5321 ((s) == TPACPI_LED_OFF ? "off" : \
5322 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5324 static int led_read(struct seq_file *m)
5326 if (!led_supported) {
5327 seq_printf(m, "status:\t\tnot supported\n");
5328 return 0;
5330 seq_printf(m, "status:\t\tsupported\n");
5332 if (led_supported == TPACPI_LED_570) {
5333 /* 570 */
5334 int i, status;
5335 for (i = 0; i < 8; i++) {
5336 status = led_get_status(i);
5337 if (status < 0)
5338 return -EIO;
5339 seq_printf(m, "%d:\t\t%s\n",
5340 i, str_led_status(status));
5344 seq_printf(m, "commands:\t"
5345 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5347 return 0;
5350 static int led_write(char *buf)
5352 char *cmd;
5353 int led, rc;
5354 enum led_status_t s;
5356 if (!led_supported)
5357 return -ENODEV;
5359 while ((cmd = next_cmd(&buf))) {
5360 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5361 return -EINVAL;
5363 if (strstr(cmd, "off")) {
5364 s = TPACPI_LED_OFF;
5365 } else if (strstr(cmd, "on")) {
5366 s = TPACPI_LED_ON;
5367 } else if (strstr(cmd, "blink")) {
5368 s = TPACPI_LED_BLINK;
5369 } else {
5370 return -EINVAL;
5373 rc = led_set_status(led, s);
5374 if (rc < 0)
5375 return rc;
5378 return 0;
5381 static struct ibm_struct led_driver_data = {
5382 .name = "led",
5383 .read = led_read,
5384 .write = led_write,
5385 .exit = led_exit,
5388 /*************************************************************************
5389 * Beep subdriver
5392 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5394 #define TPACPI_BEEP_Q1 0x0001
5396 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5397 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5398 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5401 static int __init beep_init(struct ibm_init_struct *iibm)
5403 unsigned long quirks;
5405 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5407 TPACPI_ACPIHANDLE_INIT(beep);
5409 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5410 str_supported(beep_handle != NULL));
5412 quirks = tpacpi_check_quirks(beep_quirk_table,
5413 ARRAY_SIZE(beep_quirk_table));
5415 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5417 return (beep_handle)? 0 : 1;
5420 static int beep_read(struct seq_file *m)
5422 if (!beep_handle)
5423 seq_printf(m, "status:\t\tnot supported\n");
5424 else {
5425 seq_printf(m, "status:\t\tsupported\n");
5426 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5429 return 0;
5432 static int beep_write(char *buf)
5434 char *cmd;
5435 int beep_cmd;
5437 if (!beep_handle)
5438 return -ENODEV;
5440 while ((cmd = next_cmd(&buf))) {
5441 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5442 beep_cmd >= 0 && beep_cmd <= 17) {
5443 /* beep_cmd set */
5444 } else
5445 return -EINVAL;
5446 if (tp_features.beep_needs_two_args) {
5447 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5448 beep_cmd, 0))
5449 return -EIO;
5450 } else {
5451 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5452 beep_cmd))
5453 return -EIO;
5457 return 0;
5460 static struct ibm_struct beep_driver_data = {
5461 .name = "beep",
5462 .read = beep_read,
5463 .write = beep_write,
5466 /*************************************************************************
5467 * Thermal subdriver
5470 enum thermal_access_mode {
5471 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5472 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5473 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5474 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5475 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5478 enum { /* TPACPI_THERMAL_TPEC_* */
5479 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5480 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5481 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5483 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5487 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5488 struct ibm_thermal_sensors_struct {
5489 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5492 static enum thermal_access_mode thermal_read_mode;
5494 /* idx is zero-based */
5495 static int thermal_get_sensor(int idx, s32 *value)
5497 int t;
5498 s8 tmp;
5499 char tmpi[5];
5501 t = TP_EC_THERMAL_TMP0;
5503 switch (thermal_read_mode) {
5504 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5505 case TPACPI_THERMAL_TPEC_16:
5506 if (idx >= 8 && idx <= 15) {
5507 t = TP_EC_THERMAL_TMP8;
5508 idx -= 8;
5510 /* fallthrough */
5511 #endif
5512 case TPACPI_THERMAL_TPEC_8:
5513 if (idx <= 7) {
5514 if (!acpi_ec_read(t + idx, &tmp))
5515 return -EIO;
5516 *value = tmp * 1000;
5517 return 0;
5519 break;
5521 case TPACPI_THERMAL_ACPI_UPDT:
5522 if (idx <= 7) {
5523 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5524 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5525 return -EIO;
5526 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5527 return -EIO;
5528 *value = (t - 2732) * 100;
5529 return 0;
5531 break;
5533 case TPACPI_THERMAL_ACPI_TMP07:
5534 if (idx <= 7) {
5535 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5536 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5537 return -EIO;
5538 if (t > 127 || t < -127)
5539 t = TP_EC_THERMAL_TMP_NA;
5540 *value = t * 1000;
5541 return 0;
5543 break;
5545 case TPACPI_THERMAL_NONE:
5546 default:
5547 return -ENOSYS;
5550 return -EINVAL;
5553 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5555 int res, i;
5556 int n;
5558 n = 8;
5559 i = 0;
5561 if (!s)
5562 return -EINVAL;
5564 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5565 n = 16;
5567 for (i = 0 ; i < n; i++) {
5568 res = thermal_get_sensor(i, &s->temp[i]);
5569 if (res)
5570 return res;
5573 return n;
5576 static void thermal_dump_all_sensors(void)
5578 int n, i;
5579 struct ibm_thermal_sensors_struct t;
5581 n = thermal_get_sensors(&t);
5582 if (n <= 0)
5583 return;
5585 printk(TPACPI_NOTICE
5586 "temperatures (Celsius):");
5588 for (i = 0; i < n; i++) {
5589 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5590 printk(KERN_CONT " %d", (int)(t.temp[i] / 1000));
5591 else
5592 printk(KERN_CONT " N/A");
5595 printk(KERN_CONT "\n");
5598 /* sysfs temp##_input -------------------------------------------------- */
5600 static ssize_t thermal_temp_input_show(struct device *dev,
5601 struct device_attribute *attr,
5602 char *buf)
5604 struct sensor_device_attribute *sensor_attr =
5605 to_sensor_dev_attr(attr);
5606 int idx = sensor_attr->index;
5607 s32 value;
5608 int res;
5610 res = thermal_get_sensor(idx, &value);
5611 if (res)
5612 return res;
5613 if (value == TPACPI_THERMAL_SENSOR_NA)
5614 return -ENXIO;
5616 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5619 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5620 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5621 thermal_temp_input_show, NULL, _idxB)
5623 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5624 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5625 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5626 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5627 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5628 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5629 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5630 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5631 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5632 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5633 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5634 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5635 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5636 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5637 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5638 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5639 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5642 #define THERMAL_ATTRS(X) \
5643 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5645 static struct attribute *thermal_temp_input_attr[] = {
5646 THERMAL_ATTRS(8),
5647 THERMAL_ATTRS(9),
5648 THERMAL_ATTRS(10),
5649 THERMAL_ATTRS(11),
5650 THERMAL_ATTRS(12),
5651 THERMAL_ATTRS(13),
5652 THERMAL_ATTRS(14),
5653 THERMAL_ATTRS(15),
5654 THERMAL_ATTRS(0),
5655 THERMAL_ATTRS(1),
5656 THERMAL_ATTRS(2),
5657 THERMAL_ATTRS(3),
5658 THERMAL_ATTRS(4),
5659 THERMAL_ATTRS(5),
5660 THERMAL_ATTRS(6),
5661 THERMAL_ATTRS(7),
5662 NULL
5665 static const struct attribute_group thermal_temp_input16_group = {
5666 .attrs = thermal_temp_input_attr
5669 static const struct attribute_group thermal_temp_input8_group = {
5670 .attrs = &thermal_temp_input_attr[8]
5673 #undef THERMAL_SENSOR_ATTR_TEMP
5674 #undef THERMAL_ATTRS
5676 /* --------------------------------------------------------------------- */
5678 static int __init thermal_init(struct ibm_init_struct *iibm)
5680 u8 t, ta1, ta2;
5681 int i;
5682 int acpi_tmp7;
5683 int res;
5685 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5687 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5689 if (thinkpad_id.ec_model) {
5691 * Direct EC access mode: sensors at registers
5692 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5693 * non-implemented, thermal sensors return 0x80 when
5694 * not available
5697 ta1 = ta2 = 0;
5698 for (i = 0; i < 8; i++) {
5699 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5700 ta1 |= t;
5701 } else {
5702 ta1 = 0;
5703 break;
5705 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5706 ta2 |= t;
5707 } else {
5708 ta1 = 0;
5709 break;
5712 if (ta1 == 0) {
5713 /* This is sheer paranoia, but we handle it anyway */
5714 if (acpi_tmp7) {
5715 printk(TPACPI_ERR
5716 "ThinkPad ACPI EC access misbehaving, "
5717 "falling back to ACPI TMPx access "
5718 "mode\n");
5719 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5720 } else {
5721 printk(TPACPI_ERR
5722 "ThinkPad ACPI EC access misbehaving, "
5723 "disabling thermal sensors access\n");
5724 thermal_read_mode = TPACPI_THERMAL_NONE;
5726 } else {
5727 thermal_read_mode =
5728 (ta2 != 0) ?
5729 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5731 } else if (acpi_tmp7) {
5732 if (acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5733 /* 600e/x, 770e, 770x */
5734 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5735 } else {
5736 /* Standard ACPI TMPx access, max 8 sensors */
5737 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5739 } else {
5740 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5741 thermal_read_mode = TPACPI_THERMAL_NONE;
5744 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5745 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5746 thermal_read_mode);
5748 switch (thermal_read_mode) {
5749 case TPACPI_THERMAL_TPEC_16:
5750 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5751 &thermal_temp_input16_group);
5752 if (res)
5753 return res;
5754 break;
5755 case TPACPI_THERMAL_TPEC_8:
5756 case TPACPI_THERMAL_ACPI_TMP07:
5757 case TPACPI_THERMAL_ACPI_UPDT:
5758 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5759 &thermal_temp_input8_group);
5760 if (res)
5761 return res;
5762 break;
5763 case TPACPI_THERMAL_NONE:
5764 default:
5765 return 1;
5768 return 0;
5771 static void thermal_exit(void)
5773 switch (thermal_read_mode) {
5774 case TPACPI_THERMAL_TPEC_16:
5775 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5776 &thermal_temp_input16_group);
5777 break;
5778 case TPACPI_THERMAL_TPEC_8:
5779 case TPACPI_THERMAL_ACPI_TMP07:
5780 case TPACPI_THERMAL_ACPI_UPDT:
5781 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5782 &thermal_temp_input8_group);
5783 break;
5784 case TPACPI_THERMAL_NONE:
5785 default:
5786 break;
5790 static int thermal_read(struct seq_file *m)
5792 int n, i;
5793 struct ibm_thermal_sensors_struct t;
5795 n = thermal_get_sensors(&t);
5796 if (unlikely(n < 0))
5797 return n;
5799 seq_printf(m, "temperatures:\t");
5801 if (n > 0) {
5802 for (i = 0; i < (n - 1); i++)
5803 seq_printf(m, "%d ", t.temp[i] / 1000);
5804 seq_printf(m, "%d\n", t.temp[i] / 1000);
5805 } else
5806 seq_printf(m, "not supported\n");
5808 return 0;
5811 static struct ibm_struct thermal_driver_data = {
5812 .name = "thermal",
5813 .read = thermal_read,
5814 .exit = thermal_exit,
5817 /*************************************************************************
5818 * EC Dump subdriver
5821 static u8 ecdump_regs[256];
5823 static int ecdump_read(struct seq_file *m)
5825 int i, j;
5826 u8 v;
5828 seq_printf(m, "EC "
5829 " +00 +01 +02 +03 +04 +05 +06 +07"
5830 " +08 +09 +0a +0b +0c +0d +0e +0f\n");
5831 for (i = 0; i < 256; i += 16) {
5832 seq_printf(m, "EC 0x%02x:", i);
5833 for (j = 0; j < 16; j++) {
5834 if (!acpi_ec_read(i + j, &v))
5835 break;
5836 if (v != ecdump_regs[i + j])
5837 seq_printf(m, " *%02x", v);
5838 else
5839 seq_printf(m, " %02x", v);
5840 ecdump_regs[i + j] = v;
5842 seq_putc(m, '\n');
5843 if (j != 16)
5844 break;
5847 /* These are way too dangerous to advertise openly... */
5848 #if 0
5849 seq_printf(m, "commands:\t0x<offset> 0x<value>"
5850 " (<offset> is 00-ff, <value> is 00-ff)\n");
5851 seq_printf(m, "commands:\t0x<offset> <value> "
5852 " (<offset> is 00-ff, <value> is 0-255)\n");
5853 #endif
5854 return 0;
5857 static int ecdump_write(char *buf)
5859 char *cmd;
5860 int i, v;
5862 while ((cmd = next_cmd(&buf))) {
5863 if (sscanf(cmd, "0x%x 0x%x", &i, &v) == 2) {
5864 /* i and v set */
5865 } else if (sscanf(cmd, "0x%x %u", &i, &v) == 2) {
5866 /* i and v set */
5867 } else
5868 return -EINVAL;
5869 if (i >= 0 && i < 256 && v >= 0 && v < 256) {
5870 if (!acpi_ec_write(i, v))
5871 return -EIO;
5872 } else
5873 return -EINVAL;
5876 return 0;
5879 static struct ibm_struct ecdump_driver_data = {
5880 .name = "ecdump",
5881 .read = ecdump_read,
5882 .write = ecdump_write,
5883 .flags.experimental = 1,
5886 /*************************************************************************
5887 * Backlight/brightness subdriver
5890 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5893 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5894 * CMOS NVRAM byte 0x5E, bits 0-3.
5896 * EC HBRV (0x31) has the following layout
5897 * Bit 7: unknown function
5898 * Bit 6: unknown function
5899 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5900 * Bit 4: must be set to zero to avoid problems
5901 * Bit 3-0: backlight brightness level
5903 * brightness_get_raw returns status data in the HBRV layout
5905 * WARNING: The X61 has been verified to use HBRV for something else, so
5906 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5907 * testing on the very early *60 Lenovo models...
5910 enum {
5911 TP_EC_BACKLIGHT = 0x31,
5913 /* TP_EC_BACKLIGHT bitmasks */
5914 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5915 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5916 TP_EC_BACKLIGHT_MAPSW = 0x20,
5919 enum tpacpi_brightness_access_mode {
5920 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5921 TPACPI_BRGHT_MODE_EC, /* EC control */
5922 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5923 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5924 TPACPI_BRGHT_MODE_MAX
5927 static struct backlight_device *ibm_backlight_device;
5929 static enum tpacpi_brightness_access_mode brightness_mode =
5930 TPACPI_BRGHT_MODE_MAX;
5932 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5934 static struct mutex brightness_mutex;
5936 /* NVRAM brightness access,
5937 * call with brightness_mutex held! */
5938 static unsigned int tpacpi_brightness_nvram_get(void)
5940 u8 lnvram;
5942 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5943 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5944 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5945 lnvram &= (tp_features.bright_16levels) ? 0x0f : 0x07;
5947 return lnvram;
5950 static void tpacpi_brightness_checkpoint_nvram(void)
5952 u8 lec = 0;
5953 u8 b_nvram;
5955 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
5956 return;
5958 vdbg_printk(TPACPI_DBG_BRGHT,
5959 "trying to checkpoint backlight level to NVRAM...\n");
5961 if (mutex_lock_killable(&brightness_mutex) < 0)
5962 return;
5964 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5965 goto unlock;
5966 lec &= TP_EC_BACKLIGHT_LVLMSK;
5967 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
5969 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5970 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
5971 /* NVRAM needs update */
5972 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
5973 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
5974 b_nvram |= lec;
5975 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
5976 dbg_printk(TPACPI_DBG_BRGHT,
5977 "updated NVRAM backlight level to %u (0x%02x)\n",
5978 (unsigned int) lec, (unsigned int) b_nvram);
5979 } else
5980 vdbg_printk(TPACPI_DBG_BRGHT,
5981 "NVRAM backlight level already is %u (0x%02x)\n",
5982 (unsigned int) lec, (unsigned int) b_nvram);
5984 unlock:
5985 mutex_unlock(&brightness_mutex);
5989 /* call with brightness_mutex held! */
5990 static int tpacpi_brightness_get_raw(int *status)
5992 u8 lec = 0;
5994 switch (brightness_mode) {
5995 case TPACPI_BRGHT_MODE_UCMS_STEP:
5996 *status = tpacpi_brightness_nvram_get();
5997 return 0;
5998 case TPACPI_BRGHT_MODE_EC:
5999 case TPACPI_BRGHT_MODE_ECNVRAM:
6000 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6001 return -EIO;
6002 *status = lec;
6003 return 0;
6004 default:
6005 return -ENXIO;
6009 /* call with brightness_mutex held! */
6010 /* do NOT call with illegal backlight level value */
6011 static int tpacpi_brightness_set_ec(unsigned int value)
6013 u8 lec = 0;
6015 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6016 return -EIO;
6018 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6019 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6020 (value & TP_EC_BACKLIGHT_LVLMSK))))
6021 return -EIO;
6023 return 0;
6026 /* call with brightness_mutex held! */
6027 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6029 int cmos_cmd, inc;
6030 unsigned int current_value, i;
6032 current_value = tpacpi_brightness_nvram_get();
6034 if (value == current_value)
6035 return 0;
6037 cmos_cmd = (value > current_value) ?
6038 TP_CMOS_BRIGHTNESS_UP :
6039 TP_CMOS_BRIGHTNESS_DOWN;
6040 inc = (value > current_value) ? 1 : -1;
6042 for (i = current_value; i != value; i += inc)
6043 if (issue_thinkpad_cmos_command(cmos_cmd))
6044 return -EIO;
6046 return 0;
6049 /* May return EINTR which can always be mapped to ERESTARTSYS */
6050 static int brightness_set(unsigned int value)
6052 int res;
6054 if (value > ((tp_features.bright_16levels)? 15 : 7) ||
6055 value < 0)
6056 return -EINVAL;
6058 vdbg_printk(TPACPI_DBG_BRGHT,
6059 "set backlight level to %d\n", value);
6061 res = mutex_lock_killable(&brightness_mutex);
6062 if (res < 0)
6063 return res;
6065 switch (brightness_mode) {
6066 case TPACPI_BRGHT_MODE_EC:
6067 case TPACPI_BRGHT_MODE_ECNVRAM:
6068 res = tpacpi_brightness_set_ec(value);
6069 break;
6070 case TPACPI_BRGHT_MODE_UCMS_STEP:
6071 res = tpacpi_brightness_set_ucmsstep(value);
6072 break;
6073 default:
6074 res = -ENXIO;
6077 mutex_unlock(&brightness_mutex);
6078 return res;
6081 /* sysfs backlight class ----------------------------------------------- */
6083 static int brightness_update_status(struct backlight_device *bd)
6085 unsigned int level =
6086 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6087 bd->props.power == FB_BLANK_UNBLANK) ?
6088 bd->props.brightness : 0;
6090 dbg_printk(TPACPI_DBG_BRGHT,
6091 "backlight: attempt to set level to %d\n",
6092 level);
6094 /* it is the backlight class's job (caller) to handle
6095 * EINTR and other errors properly */
6096 return brightness_set(level);
6099 static int brightness_get(struct backlight_device *bd)
6101 int status, res;
6103 res = mutex_lock_killable(&brightness_mutex);
6104 if (res < 0)
6105 return 0;
6107 res = tpacpi_brightness_get_raw(&status);
6109 mutex_unlock(&brightness_mutex);
6111 if (res < 0)
6112 return 0;
6114 return status & TP_EC_BACKLIGHT_LVLMSK;
6117 static void tpacpi_brightness_notify_change(void)
6119 backlight_force_update(ibm_backlight_device,
6120 BACKLIGHT_UPDATE_HOTKEY);
6123 static struct backlight_ops ibm_backlight_data = {
6124 .get_brightness = brightness_get,
6125 .update_status = brightness_update_status,
6128 /* --------------------------------------------------------------------- */
6131 * These are only useful for models that have only one possibility
6132 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6133 * these quirks.
6135 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6136 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6137 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6139 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6140 /* Models with ATI GPUs known to require ECNVRAM mode */
6141 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6143 /* Models with ATI GPUs that can use ECNVRAM */
6144 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6145 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6146 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6147 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6149 /* Models with Intel Extreme Graphics 2 */
6150 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6151 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6152 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6154 /* Models with Intel GMA900 */
6155 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6156 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6157 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6160 static int __init brightness_init(struct ibm_init_struct *iibm)
6162 int b;
6163 unsigned long quirks;
6165 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6167 mutex_init(&brightness_mutex);
6169 quirks = tpacpi_check_quirks(brightness_quirk_table,
6170 ARRAY_SIZE(brightness_quirk_table));
6173 * We always attempt to detect acpi support, so as to switch
6174 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6175 * going to publish a backlight interface
6177 b = tpacpi_check_std_acpi_brightness_support();
6178 if (b > 0) {
6180 if (acpi_video_backlight_support()) {
6181 if (brightness_enable > 1) {
6182 printk(TPACPI_NOTICE
6183 "Standard ACPI backlight interface "
6184 "available, not loading native one.\n");
6185 return 1;
6186 } else if (brightness_enable == 1) {
6187 printk(TPACPI_NOTICE
6188 "Backlight control force enabled, even if standard "
6189 "ACPI backlight interface is available\n");
6191 } else {
6192 if (brightness_enable > 1) {
6193 printk(TPACPI_NOTICE
6194 "Standard ACPI backlight interface not "
6195 "available, thinkpad_acpi native "
6196 "brightness control enabled\n");
6201 if (!brightness_enable) {
6202 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6203 "brightness support disabled by "
6204 "module parameter\n");
6205 return 1;
6208 if (b > 16) {
6209 printk(TPACPI_ERR
6210 "Unsupported brightness interface, "
6211 "please contact %s\n", TPACPI_MAIL);
6212 return 1;
6214 if (b == 16)
6215 tp_features.bright_16levels = 1;
6218 * Check for module parameter bogosity, note that we
6219 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6220 * able to detect "unspecified"
6222 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6223 return -EINVAL;
6225 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6226 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6227 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6228 if (quirks & TPACPI_BRGHT_Q_EC)
6229 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6230 else
6231 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6233 dbg_printk(TPACPI_DBG_BRGHT,
6234 "driver auto-selected brightness_mode=%d\n",
6235 brightness_mode);
6238 /* Safety */
6239 if (thinkpad_id.vendor != PCI_VENDOR_ID_IBM &&
6240 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6241 brightness_mode == TPACPI_BRGHT_MODE_EC))
6242 return -EINVAL;
6244 if (tpacpi_brightness_get_raw(&b) < 0)
6245 return 1;
6247 if (tp_features.bright_16levels)
6248 printk(TPACPI_INFO
6249 "detected a 16-level brightness capable ThinkPad\n");
6251 ibm_backlight_device = backlight_device_register(
6252 TPACPI_BACKLIGHT_DEV_NAME, NULL, NULL,
6253 &ibm_backlight_data);
6254 if (IS_ERR(ibm_backlight_device)) {
6255 int rc = PTR_ERR(ibm_backlight_device);
6256 ibm_backlight_device = NULL;
6257 printk(TPACPI_ERR "Could not register backlight device\n");
6258 return rc;
6260 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6261 "brightness is supported\n");
6263 if (quirks & TPACPI_BRGHT_Q_ASK) {
6264 printk(TPACPI_NOTICE
6265 "brightness: will use unverified default: "
6266 "brightness_mode=%d\n", brightness_mode);
6267 printk(TPACPI_NOTICE
6268 "brightness: please report to %s whether it works well "
6269 "or not on your ThinkPad\n", TPACPI_MAIL);
6272 ibm_backlight_device->props.max_brightness =
6273 (tp_features.bright_16levels)? 15 : 7;
6274 ibm_backlight_device->props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6275 backlight_update_status(ibm_backlight_device);
6277 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6278 "brightness: registering brightness hotkeys "
6279 "as change notification\n");
6280 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6281 | TP_ACPI_HKEY_BRGHTUP_MASK
6282 | TP_ACPI_HKEY_BRGHTDWN_MASK);;
6283 return 0;
6286 static void brightness_suspend(pm_message_t state)
6288 tpacpi_brightness_checkpoint_nvram();
6291 static void brightness_shutdown(void)
6293 tpacpi_brightness_checkpoint_nvram();
6296 static void brightness_exit(void)
6298 if (ibm_backlight_device) {
6299 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6300 "calling backlight_device_unregister()\n");
6301 backlight_device_unregister(ibm_backlight_device);
6304 tpacpi_brightness_checkpoint_nvram();
6307 static int brightness_read(struct seq_file *m)
6309 int level;
6311 level = brightness_get(NULL);
6312 if (level < 0) {
6313 seq_printf(m, "level:\t\tunreadable\n");
6314 } else {
6315 seq_printf(m, "level:\t\t%d\n", level);
6316 seq_printf(m, "commands:\tup, down\n");
6317 seq_printf(m, "commands:\tlevel <level>"
6318 " (<level> is 0-%d)\n",
6319 (tp_features.bright_16levels) ? 15 : 7);
6322 return 0;
6325 static int brightness_write(char *buf)
6327 int level;
6328 int rc;
6329 char *cmd;
6330 int max_level = (tp_features.bright_16levels) ? 15 : 7;
6332 level = brightness_get(NULL);
6333 if (level < 0)
6334 return level;
6336 while ((cmd = next_cmd(&buf))) {
6337 if (strlencmp(cmd, "up") == 0) {
6338 if (level < max_level)
6339 level++;
6340 } else if (strlencmp(cmd, "down") == 0) {
6341 if (level > 0)
6342 level--;
6343 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6344 level >= 0 && level <= max_level) {
6345 /* new level set */
6346 } else
6347 return -EINVAL;
6350 tpacpi_disclose_usertask("procfs brightness",
6351 "set level to %d\n", level);
6354 * Now we know what the final level should be, so we try to set it.
6355 * Doing it this way makes the syscall restartable in case of EINTR
6357 rc = brightness_set(level);
6358 if (!rc && ibm_backlight_device)
6359 backlight_force_update(ibm_backlight_device,
6360 BACKLIGHT_UPDATE_SYSFS);
6361 return (rc == -EINTR)? -ERESTARTSYS : rc;
6364 static struct ibm_struct brightness_driver_data = {
6365 .name = "brightness",
6366 .read = brightness_read,
6367 .write = brightness_write,
6368 .exit = brightness_exit,
6369 .suspend = brightness_suspend,
6370 .shutdown = brightness_shutdown,
6373 /*************************************************************************
6374 * Volume subdriver
6378 * IBM ThinkPads have a simple volume controller with MUTE gating.
6379 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6381 * Since the *61 series (and probably also the later *60 series), Lenovo
6382 * ThinkPads only implement the MUTE gate.
6384 * EC register 0x30
6385 * Bit 6: MUTE (1 mutes sound)
6386 * Bit 3-0: Volume
6387 * Other bits should be zero as far as we know.
6389 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6390 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
6391 * such as bit 7 which is used to detect repeated presses of MUTE,
6392 * and we leave them unchanged.
6395 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6397 #define TPACPI_ALSA_DRVNAME "ThinkPad EC"
6398 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6399 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6401 static int alsa_index = ~((1 << (SNDRV_CARDS - 3)) - 1); /* last three slots */
6402 static char *alsa_id = "ThinkPadEC";
6403 static int alsa_enable = SNDRV_DEFAULT_ENABLE1;
6405 struct tpacpi_alsa_data {
6406 struct snd_card *card;
6407 struct snd_ctl_elem_id *ctl_mute_id;
6408 struct snd_ctl_elem_id *ctl_vol_id;
6411 static struct snd_card *alsa_card;
6413 enum {
6414 TP_EC_AUDIO = 0x30,
6416 /* TP_EC_AUDIO bits */
6417 TP_EC_AUDIO_MUTESW = 6,
6419 /* TP_EC_AUDIO bitmasks */
6420 TP_EC_AUDIO_LVL_MSK = 0x0F,
6421 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6423 /* Maximum volume */
6424 TP_EC_VOLUME_MAX = 14,
6427 enum tpacpi_volume_access_mode {
6428 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
6429 TPACPI_VOL_MODE_EC, /* Pure EC control */
6430 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
6431 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6432 TPACPI_VOL_MODE_MAX
6435 enum tpacpi_volume_capabilities {
6436 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
6437 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
6438 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
6439 TPACPI_VOL_CAP_MAX
6442 static enum tpacpi_volume_access_mode volume_mode =
6443 TPACPI_VOL_MODE_MAX;
6445 static enum tpacpi_volume_capabilities volume_capabilities;
6446 static int volume_control_allowed;
6449 * Used to syncronize writers to TP_EC_AUDIO and
6450 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6452 static struct mutex volume_mutex;
6454 static void tpacpi_volume_checkpoint_nvram(void)
6456 u8 lec = 0;
6457 u8 b_nvram;
6458 u8 ec_mask;
6460 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6461 return;
6462 if (!volume_control_allowed)
6463 return;
6465 vdbg_printk(TPACPI_DBG_MIXER,
6466 "trying to checkpoint mixer state to NVRAM...\n");
6468 if (tp_features.mixer_no_level_control)
6469 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6470 else
6471 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6473 if (mutex_lock_killable(&volume_mutex) < 0)
6474 return;
6476 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6477 goto unlock;
6478 lec &= ec_mask;
6479 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6481 if (lec != (b_nvram & ec_mask)) {
6482 /* NVRAM needs update */
6483 b_nvram &= ~ec_mask;
6484 b_nvram |= lec;
6485 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6486 dbg_printk(TPACPI_DBG_MIXER,
6487 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6488 (unsigned int) lec, (unsigned int) b_nvram);
6489 } else {
6490 vdbg_printk(TPACPI_DBG_MIXER,
6491 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6492 (unsigned int) lec, (unsigned int) b_nvram);
6495 unlock:
6496 mutex_unlock(&volume_mutex);
6499 static int volume_get_status_ec(u8 *status)
6501 u8 s;
6503 if (!acpi_ec_read(TP_EC_AUDIO, &s))
6504 return -EIO;
6506 *status = s;
6508 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6510 return 0;
6513 static int volume_get_status(u8 *status)
6515 return volume_get_status_ec(status);
6518 static int volume_set_status_ec(const u8 status)
6520 if (!acpi_ec_write(TP_EC_AUDIO, status))
6521 return -EIO;
6523 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6525 return 0;
6528 static int volume_set_status(const u8 status)
6530 return volume_set_status_ec(status);
6533 /* returns < 0 on error, 0 on no change, 1 on change */
6534 static int __volume_set_mute_ec(const bool mute)
6536 int rc;
6537 u8 s, n;
6539 if (mutex_lock_killable(&volume_mutex) < 0)
6540 return -EINTR;
6542 rc = volume_get_status_ec(&s);
6543 if (rc)
6544 goto unlock;
6546 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6547 s & ~TP_EC_AUDIO_MUTESW_MSK;
6549 if (n != s) {
6550 rc = volume_set_status_ec(n);
6551 if (!rc)
6552 rc = 1;
6555 unlock:
6556 mutex_unlock(&volume_mutex);
6557 return rc;
6560 static int volume_alsa_set_mute(const bool mute)
6562 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6563 (mute) ? "" : "un");
6564 return __volume_set_mute_ec(mute);
6567 static int volume_set_mute(const bool mute)
6569 int rc;
6571 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6572 (mute) ? "" : "un");
6574 rc = __volume_set_mute_ec(mute);
6575 return (rc < 0) ? rc : 0;
6578 /* returns < 0 on error, 0 on no change, 1 on change */
6579 static int __volume_set_volume_ec(const u8 vol)
6581 int rc;
6582 u8 s, n;
6584 if (vol > TP_EC_VOLUME_MAX)
6585 return -EINVAL;
6587 if (mutex_lock_killable(&volume_mutex) < 0)
6588 return -EINTR;
6590 rc = volume_get_status_ec(&s);
6591 if (rc)
6592 goto unlock;
6594 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6596 if (n != s) {
6597 rc = volume_set_status_ec(n);
6598 if (!rc)
6599 rc = 1;
6602 unlock:
6603 mutex_unlock(&volume_mutex);
6604 return rc;
6607 static int volume_alsa_set_volume(const u8 vol)
6609 dbg_printk(TPACPI_DBG_MIXER,
6610 "ALSA: trying to set volume level to %hu\n", vol);
6611 return __volume_set_volume_ec(vol);
6614 static void volume_alsa_notify_change(void)
6616 struct tpacpi_alsa_data *d;
6618 if (alsa_card && alsa_card->private_data) {
6619 d = alsa_card->private_data;
6620 if (d->ctl_mute_id)
6621 snd_ctl_notify(alsa_card,
6622 SNDRV_CTL_EVENT_MASK_VALUE,
6623 d->ctl_mute_id);
6624 if (d->ctl_vol_id)
6625 snd_ctl_notify(alsa_card,
6626 SNDRV_CTL_EVENT_MASK_VALUE,
6627 d->ctl_vol_id);
6631 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6632 struct snd_ctl_elem_info *uinfo)
6634 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6635 uinfo->count = 1;
6636 uinfo->value.integer.min = 0;
6637 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6638 return 0;
6641 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6642 struct snd_ctl_elem_value *ucontrol)
6644 u8 s;
6645 int rc;
6647 rc = volume_get_status(&s);
6648 if (rc < 0)
6649 return rc;
6651 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6652 return 0;
6655 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6656 struct snd_ctl_elem_value *ucontrol)
6658 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6661 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
6663 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6664 struct snd_ctl_elem_value *ucontrol)
6666 u8 s;
6667 int rc;
6669 rc = volume_get_status(&s);
6670 if (rc < 0)
6671 return rc;
6673 ucontrol->value.integer.value[0] =
6674 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6675 return 0;
6678 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6679 struct snd_ctl_elem_value *ucontrol)
6681 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6684 static struct snd_kcontrol_new volume_alsa_control_vol __devinitdata = {
6685 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6686 .name = "Console Playback Volume",
6687 .index = 0,
6688 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6689 .info = volume_alsa_vol_info,
6690 .get = volume_alsa_vol_get,
6693 static struct snd_kcontrol_new volume_alsa_control_mute __devinitdata = {
6694 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6695 .name = "Console Playback Switch",
6696 .index = 0,
6697 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6698 .info = volume_alsa_mute_info,
6699 .get = volume_alsa_mute_get,
6702 static void volume_suspend(pm_message_t state)
6704 tpacpi_volume_checkpoint_nvram();
6707 static void volume_resume(void)
6709 volume_alsa_notify_change();
6712 static void volume_shutdown(void)
6714 tpacpi_volume_checkpoint_nvram();
6717 static void volume_exit(void)
6719 if (alsa_card) {
6720 snd_card_free(alsa_card);
6721 alsa_card = NULL;
6724 tpacpi_volume_checkpoint_nvram();
6727 static int __init volume_create_alsa_mixer(void)
6729 struct snd_card *card;
6730 struct tpacpi_alsa_data *data;
6731 struct snd_kcontrol *ctl_vol;
6732 struct snd_kcontrol *ctl_mute;
6733 int rc;
6735 rc = snd_card_create(alsa_index, alsa_id, THIS_MODULE,
6736 sizeof(struct tpacpi_alsa_data), &card);
6737 if (rc < 0 || !card) {
6738 printk(TPACPI_ERR
6739 "Failed to create ALSA card structures: %d\n", rc);
6740 return 1;
6743 BUG_ON(!card->private_data);
6744 data = card->private_data;
6745 data->card = card;
6747 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6748 sizeof(card->driver));
6749 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6750 sizeof(card->shortname));
6751 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6752 (thinkpad_id.ec_version_str) ?
6753 thinkpad_id.ec_version_str : "(unknown)");
6754 snprintf(card->longname, sizeof(card->longname),
6755 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6756 (thinkpad_id.ec_version_str) ?
6757 thinkpad_id.ec_version_str : "unknown");
6759 if (volume_control_allowed) {
6760 volume_alsa_control_vol.put = volume_alsa_vol_put;
6761 volume_alsa_control_vol.access =
6762 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6764 volume_alsa_control_mute.put = volume_alsa_mute_put;
6765 volume_alsa_control_mute.access =
6766 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6769 if (!tp_features.mixer_no_level_control) {
6770 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6771 rc = snd_ctl_add(card, ctl_vol);
6772 if (rc < 0) {
6773 printk(TPACPI_ERR
6774 "Failed to create ALSA volume control: %d\n",
6775 rc);
6776 goto err_exit;
6778 data->ctl_vol_id = &ctl_vol->id;
6781 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6782 rc = snd_ctl_add(card, ctl_mute);
6783 if (rc < 0) {
6784 printk(TPACPI_ERR "Failed to create ALSA mute control: %d\n",
6785 rc);
6786 goto err_exit;
6788 data->ctl_mute_id = &ctl_mute->id;
6790 snd_card_set_dev(card, &tpacpi_pdev->dev);
6791 rc = snd_card_register(card);
6792 if (rc < 0) {
6793 printk(TPACPI_ERR "Failed to register ALSA card: %d\n", rc);
6794 goto err_exit;
6797 alsa_card = card;
6798 return 0;
6800 err_exit:
6801 snd_card_free(card);
6802 return 1;
6805 #define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
6806 #define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
6808 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6809 /* Whitelist volume level on all IBM by default */
6810 { .vendor = PCI_VENDOR_ID_IBM,
6811 .bios = TPACPI_MATCH_ANY,
6812 .ec = TPACPI_MATCH_ANY,
6813 .quirks = TPACPI_VOL_Q_LEVEL },
6815 /* Lenovo models with volume control (needs confirmation) */
6816 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6817 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6818 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6819 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6820 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6821 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6822 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6824 /* Whitelist mute-only on all Lenovo by default */
6825 { .vendor = PCI_VENDOR_ID_LENOVO,
6826 .bios = TPACPI_MATCH_ANY,
6827 .ec = TPACPI_MATCH_ANY,
6828 .quirks = TPACPI_VOL_Q_MUTEONLY }
6831 static int __init volume_init(struct ibm_init_struct *iibm)
6833 unsigned long quirks;
6834 int rc;
6836 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
6838 mutex_init(&volume_mutex);
6841 * Check for module parameter bogosity, note that we
6842 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
6843 * able to detect "unspecified"
6845 if (volume_mode > TPACPI_VOL_MODE_MAX)
6846 return -EINVAL;
6848 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
6849 printk(TPACPI_ERR
6850 "UCMS step volume mode not implemented, "
6851 "please contact %s\n", TPACPI_MAIL);
6852 return 1;
6855 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
6856 return -EINVAL;
6859 * The ALSA mixer is our primary interface.
6860 * When disabled, don't install the subdriver at all
6862 if (!alsa_enable) {
6863 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6864 "ALSA mixer disabled by parameter, "
6865 "not loading volume subdriver...\n");
6866 return 1;
6869 quirks = tpacpi_check_quirks(volume_quirk_table,
6870 ARRAY_SIZE(volume_quirk_table));
6872 switch (volume_capabilities) {
6873 case TPACPI_VOL_CAP_AUTO:
6874 if (quirks & TPACPI_VOL_Q_MUTEONLY)
6875 tp_features.mixer_no_level_control = 1;
6876 else if (quirks & TPACPI_VOL_Q_LEVEL)
6877 tp_features.mixer_no_level_control = 0;
6878 else
6879 return 1; /* no mixer */
6880 break;
6881 case TPACPI_VOL_CAP_VOLMUTE:
6882 tp_features.mixer_no_level_control = 0;
6883 break;
6884 case TPACPI_VOL_CAP_MUTEONLY:
6885 tp_features.mixer_no_level_control = 1;
6886 break;
6887 default:
6888 return 1;
6891 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
6892 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6893 "using user-supplied volume_capabilities=%d\n",
6894 volume_capabilities);
6896 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
6897 volume_mode == TPACPI_VOL_MODE_MAX) {
6898 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
6900 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6901 "driver auto-selected volume_mode=%d\n",
6902 volume_mode);
6903 } else {
6904 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6905 "using user-supplied volume_mode=%d\n",
6906 volume_mode);
6909 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6910 "mute is supported, volume control is %s\n",
6911 str_supported(!tp_features.mixer_no_level_control));
6913 rc = volume_create_alsa_mixer();
6914 if (rc) {
6915 printk(TPACPI_ERR
6916 "Could not create the ALSA mixer interface\n");
6917 return rc;
6920 printk(TPACPI_INFO
6921 "Console audio control enabled, mode: %s\n",
6922 (volume_control_allowed) ?
6923 "override (read/write)" :
6924 "monitor (read only)");
6926 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6927 "registering volume hotkeys as change notification\n");
6928 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6929 | TP_ACPI_HKEY_VOLUP_MASK
6930 | TP_ACPI_HKEY_VOLDWN_MASK
6931 | TP_ACPI_HKEY_MUTE_MASK);
6933 return 0;
6936 static int volume_read(struct seq_file *m)
6938 u8 status;
6940 if (volume_get_status(&status) < 0) {
6941 seq_printf(m, "level:\t\tunreadable\n");
6942 } else {
6943 if (tp_features.mixer_no_level_control)
6944 seq_printf(m, "level:\t\tunsupported\n");
6945 else
6946 seq_printf(m, "level:\t\t%d\n",
6947 status & TP_EC_AUDIO_LVL_MSK);
6949 seq_printf(m, "mute:\t\t%s\n",
6950 onoff(status, TP_EC_AUDIO_MUTESW));
6952 if (volume_control_allowed) {
6953 seq_printf(m, "commands:\tunmute, mute\n");
6954 if (!tp_features.mixer_no_level_control) {
6955 seq_printf(m,
6956 "commands:\tup, down\n");
6957 seq_printf(m,
6958 "commands:\tlevel <level>"
6959 " (<level> is 0-%d)\n",
6960 TP_EC_VOLUME_MAX);
6965 return 0;
6968 static int volume_write(char *buf)
6970 u8 s;
6971 u8 new_level, new_mute;
6972 int l;
6973 char *cmd;
6974 int rc;
6977 * We do allow volume control at driver startup, so that the
6978 * user can set initial state through the volume=... parameter hack.
6980 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
6981 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
6982 tp_warned.volume_ctrl_forbidden = 1;
6983 printk(TPACPI_NOTICE
6984 "Console audio control in monitor mode, "
6985 "changes are not allowed.\n");
6986 printk(TPACPI_NOTICE
6987 "Use the volume_control=1 module parameter "
6988 "to enable volume control\n");
6990 return -EPERM;
6993 rc = volume_get_status(&s);
6994 if (rc < 0)
6995 return rc;
6997 new_level = s & TP_EC_AUDIO_LVL_MSK;
6998 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7000 while ((cmd = next_cmd(&buf))) {
7001 if (!tp_features.mixer_no_level_control) {
7002 if (strlencmp(cmd, "up") == 0) {
7003 if (new_mute)
7004 new_mute = 0;
7005 else if (new_level < TP_EC_VOLUME_MAX)
7006 new_level++;
7007 continue;
7008 } else if (strlencmp(cmd, "down") == 0) {
7009 if (new_mute)
7010 new_mute = 0;
7011 else if (new_level > 0)
7012 new_level--;
7013 continue;
7014 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7015 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7016 new_level = l;
7017 continue;
7020 if (strlencmp(cmd, "mute") == 0)
7021 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7022 else if (strlencmp(cmd, "unmute") == 0)
7023 new_mute = 0;
7024 else
7025 return -EINVAL;
7028 if (tp_features.mixer_no_level_control) {
7029 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7030 new_mute ? "" : "un");
7031 rc = volume_set_mute(!!new_mute);
7032 } else {
7033 tpacpi_disclose_usertask("procfs volume",
7034 "%smute and set level to %d\n",
7035 new_mute ? "" : "un", new_level);
7036 rc = volume_set_status(new_mute | new_level);
7038 volume_alsa_notify_change();
7040 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7043 static struct ibm_struct volume_driver_data = {
7044 .name = "volume",
7045 .read = volume_read,
7046 .write = volume_write,
7047 .exit = volume_exit,
7048 .suspend = volume_suspend,
7049 .resume = volume_resume,
7050 .shutdown = volume_shutdown,
7053 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7055 #define alsa_card NULL
7057 static void inline volume_alsa_notify_change(void)
7061 static int __init volume_init(struct ibm_init_struct *iibm)
7063 printk(TPACPI_INFO
7064 "volume: disabled as there is no ALSA support in this kernel\n");
7066 return 1;
7069 static struct ibm_struct volume_driver_data = {
7070 .name = "volume",
7073 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7075 /*************************************************************************
7076 * Fan subdriver
7080 * FAN ACCESS MODES
7082 * TPACPI_FAN_RD_ACPI_GFAN:
7083 * ACPI GFAN method: returns fan level
7085 * see TPACPI_FAN_WR_ACPI_SFAN
7086 * EC 0x2f (HFSP) not available if GFAN exists
7088 * TPACPI_FAN_WR_ACPI_SFAN:
7089 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7091 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7092 * it for writing.
7094 * TPACPI_FAN_WR_TPEC:
7095 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7096 * Supported on almost all ThinkPads
7098 * Fan speed changes of any sort (including those caused by the
7099 * disengaged mode) are usually done slowly by the firmware as the
7100 * maximum ammount of fan duty cycle change per second seems to be
7101 * limited.
7103 * Reading is not available if GFAN exists.
7104 * Writing is not available if SFAN exists.
7106 * Bits
7107 * 7 automatic mode engaged;
7108 * (default operation mode of the ThinkPad)
7109 * fan level is ignored in this mode.
7110 * 6 full speed mode (takes precedence over bit 7);
7111 * not available on all thinkpads. May disable
7112 * the tachometer while the fan controller ramps up
7113 * the speed (which can take up to a few *minutes*).
7114 * Speeds up fan to 100% duty-cycle, which is far above
7115 * the standard RPM levels. It is not impossible that
7116 * it could cause hardware damage.
7117 * 5-3 unused in some models. Extra bits for fan level
7118 * in others, but still useless as all values above
7119 * 7 map to the same speed as level 7 in these models.
7120 * 2-0 fan level (0..7 usually)
7121 * 0x00 = stop
7122 * 0x07 = max (set when temperatures critical)
7123 * Some ThinkPads may have other levels, see
7124 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7126 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7127 * boot. Apparently the EC does not intialize it, so unless ACPI DSDT
7128 * does so, its initial value is meaningless (0x07).
7130 * For firmware bugs, refer to:
7131 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7133 * ----
7135 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7136 * Main fan tachometer reading (in RPM)
7138 * This register is present on all ThinkPads with a new-style EC, and
7139 * it is known not to be present on the A21m/e, and T22, as there is
7140 * something else in offset 0x84 according to the ACPI DSDT. Other
7141 * ThinkPads from this same time period (and earlier) probably lack the
7142 * tachometer as well.
7144 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7145 * was never fixed by IBM to report the EC firmware version string
7146 * probably support the tachometer (like the early X models), so
7147 * detecting it is quite hard. We need more data to know for sure.
7149 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7150 * might result.
7152 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7153 * mode.
7155 * For firmware bugs, refer to:
7156 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7158 * ----
7160 * ThinkPad EC register 0x31 bit 0 (only on select models)
7162 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7163 * show the speed of the main fan. When bit 0 of EC register 0x31
7164 * is one, the tachometer registers show the speed of the auxiliary
7165 * fan.
7167 * Fan control seems to affect both fans, regardless of the state
7168 * of this bit.
7170 * So far, only the firmware for the X60/X61 non-tablet versions
7171 * seem to support this (firmware TP-7M).
7173 * TPACPI_FAN_WR_ACPI_FANS:
7174 * ThinkPad X31, X40, X41. Not available in the X60.
7176 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7177 * high speed. ACPI DSDT seems to map these three speeds to levels
7178 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7179 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7181 * The speeds are stored on handles
7182 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7184 * There are three default speed sets, accessible as handles:
7185 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7187 * ACPI DSDT switches which set is in use depending on various
7188 * factors.
7190 * TPACPI_FAN_WR_TPEC is also available and should be used to
7191 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7192 * but the ACPI tables just mention level 7.
7195 enum { /* Fan control constants */
7196 fan_status_offset = 0x2f, /* EC register 0x2f */
7197 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7198 * 0x84 must be read before 0x85 */
7199 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7200 bit 0 selects which fan is active */
7202 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
7203 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
7205 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
7208 enum fan_status_access_mode {
7209 TPACPI_FAN_NONE = 0, /* No fan status or control */
7210 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
7211 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7214 enum fan_control_access_mode {
7215 TPACPI_FAN_WR_NONE = 0, /* No fan control */
7216 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
7217 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
7218 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
7221 enum fan_control_commands {
7222 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
7223 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
7224 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
7225 * and also watchdog cmd */
7228 static int fan_control_allowed;
7230 static enum fan_status_access_mode fan_status_access_mode;
7231 static enum fan_control_access_mode fan_control_access_mode;
7232 static enum fan_control_commands fan_control_commands;
7234 static u8 fan_control_initial_status;
7235 static u8 fan_control_desired_level;
7236 static u8 fan_control_resume_level;
7237 static int fan_watchdog_maxinterval;
7239 static struct mutex fan_mutex;
7241 static void fan_watchdog_fire(struct work_struct *ignored);
7242 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7244 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
7245 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7246 "\\FSPD", /* 600e/x, 770e, 770x */
7247 ); /* all others */
7248 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7249 "JFNS", /* 770x-JL */
7250 ); /* all others */
7253 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7254 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7255 * be in auto mode (0x80).
7257 * This is corrected by any write to HFSP either by the driver, or
7258 * by the firmware.
7260 * We assume 0x07 really means auto mode while this quirk is active,
7261 * as this is far more likely than the ThinkPad being in level 7,
7262 * which is only used by the firmware during thermal emergencies.
7264 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7265 * TP-70 (T43, R52), which are known to be buggy.
7268 static void fan_quirk1_setup(void)
7270 if (fan_control_initial_status == 0x07) {
7271 printk(TPACPI_NOTICE
7272 "fan_init: initial fan status is unknown, "
7273 "assuming it is in auto mode\n");
7274 tp_features.fan_ctrl_status_undef = 1;
7278 static void fan_quirk1_handle(u8 *fan_status)
7280 if (unlikely(tp_features.fan_ctrl_status_undef)) {
7281 if (*fan_status != fan_control_initial_status) {
7282 /* something changed the HFSP regisnter since
7283 * driver init time, so it is not undefined
7284 * anymore */
7285 tp_features.fan_ctrl_status_undef = 0;
7286 } else {
7287 /* Return most likely status. In fact, it
7288 * might be the only possible status */
7289 *fan_status = TP_EC_FAN_AUTO;
7294 /* Select main fan on X60/X61, NOOP on others */
7295 static bool fan_select_fan1(void)
7297 if (tp_features.second_fan) {
7298 u8 val;
7300 if (ec_read(fan_select_offset, &val) < 0)
7301 return false;
7302 val &= 0xFEU;
7303 if (ec_write(fan_select_offset, val) < 0)
7304 return false;
7306 return true;
7309 /* Select secondary fan on X60/X61 */
7310 static bool fan_select_fan2(void)
7312 u8 val;
7314 if (!tp_features.second_fan)
7315 return false;
7317 if (ec_read(fan_select_offset, &val) < 0)
7318 return false;
7319 val |= 0x01U;
7320 if (ec_write(fan_select_offset, val) < 0)
7321 return false;
7323 return true;
7327 * Call with fan_mutex held
7329 static void fan_update_desired_level(u8 status)
7331 if ((status &
7332 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7333 if (status > 7)
7334 fan_control_desired_level = 7;
7335 else
7336 fan_control_desired_level = status;
7340 static int fan_get_status(u8 *status)
7342 u8 s;
7344 /* TODO:
7345 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7347 switch (fan_status_access_mode) {
7348 case TPACPI_FAN_RD_ACPI_GFAN:
7349 /* 570, 600e/x, 770e, 770x */
7351 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
7352 return -EIO;
7354 if (likely(status))
7355 *status = s & 0x07;
7357 break;
7359 case TPACPI_FAN_RD_TPEC:
7360 /* all except 570, 600e/x, 770e, 770x */
7361 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7362 return -EIO;
7364 if (likely(status)) {
7365 *status = s;
7366 fan_quirk1_handle(status);
7369 break;
7371 default:
7372 return -ENXIO;
7375 return 0;
7378 static int fan_get_status_safe(u8 *status)
7380 int rc;
7381 u8 s;
7383 if (mutex_lock_killable(&fan_mutex))
7384 return -ERESTARTSYS;
7385 rc = fan_get_status(&s);
7386 if (!rc)
7387 fan_update_desired_level(s);
7388 mutex_unlock(&fan_mutex);
7390 if (status)
7391 *status = s;
7393 return rc;
7396 static int fan_get_speed(unsigned int *speed)
7398 u8 hi, lo;
7400 switch (fan_status_access_mode) {
7401 case TPACPI_FAN_RD_TPEC:
7402 /* all except 570, 600e/x, 770e, 770x */
7403 if (unlikely(!fan_select_fan1()))
7404 return -EIO;
7405 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7406 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7407 return -EIO;
7409 if (likely(speed))
7410 *speed = (hi << 8) | lo;
7412 break;
7414 default:
7415 return -ENXIO;
7418 return 0;
7421 static int fan2_get_speed(unsigned int *speed)
7423 u8 hi, lo;
7424 bool rc;
7426 switch (fan_status_access_mode) {
7427 case TPACPI_FAN_RD_TPEC:
7428 /* all except 570, 600e/x, 770e, 770x */
7429 if (unlikely(!fan_select_fan2()))
7430 return -EIO;
7431 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7432 !acpi_ec_read(fan_rpm_offset + 1, &hi);
7433 fan_select_fan1(); /* play it safe */
7434 if (rc)
7435 return -EIO;
7437 if (likely(speed))
7438 *speed = (hi << 8) | lo;
7440 break;
7442 default:
7443 return -ENXIO;
7446 return 0;
7449 static int fan_set_level(int level)
7451 if (!fan_control_allowed)
7452 return -EPERM;
7454 switch (fan_control_access_mode) {
7455 case TPACPI_FAN_WR_ACPI_SFAN:
7456 if (level >= 0 && level <= 7) {
7457 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7458 return -EIO;
7459 } else
7460 return -EINVAL;
7461 break;
7463 case TPACPI_FAN_WR_ACPI_FANS:
7464 case TPACPI_FAN_WR_TPEC:
7465 if (!(level & TP_EC_FAN_AUTO) &&
7466 !(level & TP_EC_FAN_FULLSPEED) &&
7467 ((level < 0) || (level > 7)))
7468 return -EINVAL;
7470 /* safety net should the EC not support AUTO
7471 * or FULLSPEED mode bits and just ignore them */
7472 if (level & TP_EC_FAN_FULLSPEED)
7473 level |= 7; /* safety min speed 7 */
7474 else if (level & TP_EC_FAN_AUTO)
7475 level |= 4; /* safety min speed 4 */
7477 if (!acpi_ec_write(fan_status_offset, level))
7478 return -EIO;
7479 else
7480 tp_features.fan_ctrl_status_undef = 0;
7481 break;
7483 default:
7484 return -ENXIO;
7487 vdbg_printk(TPACPI_DBG_FAN,
7488 "fan control: set fan control register to 0x%02x\n", level);
7489 return 0;
7492 static int fan_set_level_safe(int level)
7494 int rc;
7496 if (!fan_control_allowed)
7497 return -EPERM;
7499 if (mutex_lock_killable(&fan_mutex))
7500 return -ERESTARTSYS;
7502 if (level == TPACPI_FAN_LAST_LEVEL)
7503 level = fan_control_desired_level;
7505 rc = fan_set_level(level);
7506 if (!rc)
7507 fan_update_desired_level(level);
7509 mutex_unlock(&fan_mutex);
7510 return rc;
7513 static int fan_set_enable(void)
7515 u8 s;
7516 int rc;
7518 if (!fan_control_allowed)
7519 return -EPERM;
7521 if (mutex_lock_killable(&fan_mutex))
7522 return -ERESTARTSYS;
7524 switch (fan_control_access_mode) {
7525 case TPACPI_FAN_WR_ACPI_FANS:
7526 case TPACPI_FAN_WR_TPEC:
7527 rc = fan_get_status(&s);
7528 if (rc < 0)
7529 break;
7531 /* Don't go out of emergency fan mode */
7532 if (s != 7) {
7533 s &= 0x07;
7534 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7537 if (!acpi_ec_write(fan_status_offset, s))
7538 rc = -EIO;
7539 else {
7540 tp_features.fan_ctrl_status_undef = 0;
7541 rc = 0;
7543 break;
7545 case TPACPI_FAN_WR_ACPI_SFAN:
7546 rc = fan_get_status(&s);
7547 if (rc < 0)
7548 break;
7550 s &= 0x07;
7552 /* Set fan to at least level 4 */
7553 s |= 4;
7555 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7556 rc = -EIO;
7557 else
7558 rc = 0;
7559 break;
7561 default:
7562 rc = -ENXIO;
7565 mutex_unlock(&fan_mutex);
7567 if (!rc)
7568 vdbg_printk(TPACPI_DBG_FAN,
7569 "fan control: set fan control register to 0x%02x\n",
7571 return rc;
7574 static int fan_set_disable(void)
7576 int rc;
7578 if (!fan_control_allowed)
7579 return -EPERM;
7581 if (mutex_lock_killable(&fan_mutex))
7582 return -ERESTARTSYS;
7584 rc = 0;
7585 switch (fan_control_access_mode) {
7586 case TPACPI_FAN_WR_ACPI_FANS:
7587 case TPACPI_FAN_WR_TPEC:
7588 if (!acpi_ec_write(fan_status_offset, 0x00))
7589 rc = -EIO;
7590 else {
7591 fan_control_desired_level = 0;
7592 tp_features.fan_ctrl_status_undef = 0;
7594 break;
7596 case TPACPI_FAN_WR_ACPI_SFAN:
7597 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7598 rc = -EIO;
7599 else
7600 fan_control_desired_level = 0;
7601 break;
7603 default:
7604 rc = -ENXIO;
7607 if (!rc)
7608 vdbg_printk(TPACPI_DBG_FAN,
7609 "fan control: set fan control register to 0\n");
7611 mutex_unlock(&fan_mutex);
7612 return rc;
7615 static int fan_set_speed(int speed)
7617 int rc;
7619 if (!fan_control_allowed)
7620 return -EPERM;
7622 if (mutex_lock_killable(&fan_mutex))
7623 return -ERESTARTSYS;
7625 rc = 0;
7626 switch (fan_control_access_mode) {
7627 case TPACPI_FAN_WR_ACPI_FANS:
7628 if (speed >= 0 && speed <= 65535) {
7629 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7630 speed, speed, speed))
7631 rc = -EIO;
7632 } else
7633 rc = -EINVAL;
7634 break;
7636 default:
7637 rc = -ENXIO;
7640 mutex_unlock(&fan_mutex);
7641 return rc;
7644 static void fan_watchdog_reset(void)
7646 static int fan_watchdog_active;
7648 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7649 return;
7651 if (fan_watchdog_active)
7652 cancel_delayed_work(&fan_watchdog_task);
7654 if (fan_watchdog_maxinterval > 0 &&
7655 tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7656 fan_watchdog_active = 1;
7657 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7658 msecs_to_jiffies(fan_watchdog_maxinterval
7659 * 1000))) {
7660 printk(TPACPI_ERR
7661 "failed to queue the fan watchdog, "
7662 "watchdog will not trigger\n");
7664 } else
7665 fan_watchdog_active = 0;
7668 static void fan_watchdog_fire(struct work_struct *ignored)
7670 int rc;
7672 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7673 return;
7675 printk(TPACPI_NOTICE "fan watchdog: enabling fan\n");
7676 rc = fan_set_enable();
7677 if (rc < 0) {
7678 printk(TPACPI_ERR "fan watchdog: error %d while enabling fan, "
7679 "will try again later...\n", -rc);
7680 /* reschedule for later */
7681 fan_watchdog_reset();
7686 * SYSFS fan layout: hwmon compatible (device)
7688 * pwm*_enable:
7689 * 0: "disengaged" mode
7690 * 1: manual mode
7691 * 2: native EC "auto" mode (recommended, hardware default)
7693 * pwm*: set speed in manual mode, ignored otherwise.
7694 * 0 is level 0; 255 is level 7. Intermediate points done with linear
7695 * interpolation.
7697 * fan*_input: tachometer reading, RPM
7700 * SYSFS fan layout: extensions
7702 * fan_watchdog (driver):
7703 * fan watchdog interval in seconds, 0 disables (default), max 120
7706 /* sysfs fan pwm1_enable ----------------------------------------------- */
7707 static ssize_t fan_pwm1_enable_show(struct device *dev,
7708 struct device_attribute *attr,
7709 char *buf)
7711 int res, mode;
7712 u8 status;
7714 res = fan_get_status_safe(&status);
7715 if (res)
7716 return res;
7718 if (status & TP_EC_FAN_FULLSPEED) {
7719 mode = 0;
7720 } else if (status & TP_EC_FAN_AUTO) {
7721 mode = 2;
7722 } else
7723 mode = 1;
7725 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7728 static ssize_t fan_pwm1_enable_store(struct device *dev,
7729 struct device_attribute *attr,
7730 const char *buf, size_t count)
7732 unsigned long t;
7733 int res, level;
7735 if (parse_strtoul(buf, 2, &t))
7736 return -EINVAL;
7738 tpacpi_disclose_usertask("hwmon pwm1_enable",
7739 "set fan mode to %lu\n", t);
7741 switch (t) {
7742 case 0:
7743 level = TP_EC_FAN_FULLSPEED;
7744 break;
7745 case 1:
7746 level = TPACPI_FAN_LAST_LEVEL;
7747 break;
7748 case 2:
7749 level = TP_EC_FAN_AUTO;
7750 break;
7751 case 3:
7752 /* reserved for software-controlled auto mode */
7753 return -ENOSYS;
7754 default:
7755 return -EINVAL;
7758 res = fan_set_level_safe(level);
7759 if (res == -ENXIO)
7760 return -EINVAL;
7761 else if (res < 0)
7762 return res;
7764 fan_watchdog_reset();
7766 return count;
7769 static struct device_attribute dev_attr_fan_pwm1_enable =
7770 __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7771 fan_pwm1_enable_show, fan_pwm1_enable_store);
7773 /* sysfs fan pwm1 ------------------------------------------------------ */
7774 static ssize_t fan_pwm1_show(struct device *dev,
7775 struct device_attribute *attr,
7776 char *buf)
7778 int res;
7779 u8 status;
7781 res = fan_get_status_safe(&status);
7782 if (res)
7783 return res;
7785 if ((status &
7786 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7787 status = fan_control_desired_level;
7789 if (status > 7)
7790 status = 7;
7792 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7795 static ssize_t fan_pwm1_store(struct device *dev,
7796 struct device_attribute *attr,
7797 const char *buf, size_t count)
7799 unsigned long s;
7800 int rc;
7801 u8 status, newlevel;
7803 if (parse_strtoul(buf, 255, &s))
7804 return -EINVAL;
7806 tpacpi_disclose_usertask("hwmon pwm1",
7807 "set fan speed to %lu\n", s);
7809 /* scale down from 0-255 to 0-7 */
7810 newlevel = (s >> 5) & 0x07;
7812 if (mutex_lock_killable(&fan_mutex))
7813 return -ERESTARTSYS;
7815 rc = fan_get_status(&status);
7816 if (!rc && (status &
7817 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7818 rc = fan_set_level(newlevel);
7819 if (rc == -ENXIO)
7820 rc = -EINVAL;
7821 else if (!rc) {
7822 fan_update_desired_level(newlevel);
7823 fan_watchdog_reset();
7827 mutex_unlock(&fan_mutex);
7828 return (rc)? rc : count;
7831 static struct device_attribute dev_attr_fan_pwm1 =
7832 __ATTR(pwm1, S_IWUSR | S_IRUGO,
7833 fan_pwm1_show, fan_pwm1_store);
7835 /* sysfs fan fan1_input ------------------------------------------------ */
7836 static ssize_t fan_fan1_input_show(struct device *dev,
7837 struct device_attribute *attr,
7838 char *buf)
7840 int res;
7841 unsigned int speed;
7843 res = fan_get_speed(&speed);
7844 if (res < 0)
7845 return res;
7847 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7850 static struct device_attribute dev_attr_fan_fan1_input =
7851 __ATTR(fan1_input, S_IRUGO,
7852 fan_fan1_input_show, NULL);
7854 /* sysfs fan fan2_input ------------------------------------------------ */
7855 static ssize_t fan_fan2_input_show(struct device *dev,
7856 struct device_attribute *attr,
7857 char *buf)
7859 int res;
7860 unsigned int speed;
7862 res = fan2_get_speed(&speed);
7863 if (res < 0)
7864 return res;
7866 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7869 static struct device_attribute dev_attr_fan_fan2_input =
7870 __ATTR(fan2_input, S_IRUGO,
7871 fan_fan2_input_show, NULL);
7873 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7874 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7875 char *buf)
7877 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7880 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7881 const char *buf, size_t count)
7883 unsigned long t;
7885 if (parse_strtoul(buf, 120, &t))
7886 return -EINVAL;
7888 if (!fan_control_allowed)
7889 return -EPERM;
7891 fan_watchdog_maxinterval = t;
7892 fan_watchdog_reset();
7894 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7896 return count;
7899 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7900 fan_fan_watchdog_show, fan_fan_watchdog_store);
7902 /* --------------------------------------------------------------------- */
7903 static struct attribute *fan_attributes[] = {
7904 &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7905 &dev_attr_fan_fan1_input.attr,
7906 NULL, /* for fan2_input */
7907 NULL
7910 static const struct attribute_group fan_attr_group = {
7911 .attrs = fan_attributes,
7914 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
7915 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
7917 #define TPACPI_FAN_QI(__id1, __id2, __quirks) \
7918 { .vendor = PCI_VENDOR_ID_IBM, \
7919 .bios = TPACPI_MATCH_ANY, \
7920 .ec = TPID(__id1, __id2), \
7921 .quirks = __quirks }
7923 #define TPACPI_FAN_QL(__id1, __id2, __quirks) \
7924 { .vendor = PCI_VENDOR_ID_LENOVO, \
7925 .bios = TPACPI_MATCH_ANY, \
7926 .ec = TPID(__id1, __id2), \
7927 .quirks = __quirks }
7929 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
7930 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
7931 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
7932 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
7933 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
7934 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
7937 #undef TPACPI_FAN_QL
7938 #undef TPACPI_FAN_QI
7940 static int __init fan_init(struct ibm_init_struct *iibm)
7942 int rc;
7943 unsigned long quirks;
7945 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7946 "initializing fan subdriver\n");
7948 mutex_init(&fan_mutex);
7949 fan_status_access_mode = TPACPI_FAN_NONE;
7950 fan_control_access_mode = TPACPI_FAN_WR_NONE;
7951 fan_control_commands = 0;
7952 fan_watchdog_maxinterval = 0;
7953 tp_features.fan_ctrl_status_undef = 0;
7954 tp_features.second_fan = 0;
7955 fan_control_desired_level = 7;
7957 TPACPI_ACPIHANDLE_INIT(fans);
7958 TPACPI_ACPIHANDLE_INIT(gfan);
7959 TPACPI_ACPIHANDLE_INIT(sfan);
7961 quirks = tpacpi_check_quirks(fan_quirk_table,
7962 ARRAY_SIZE(fan_quirk_table));
7964 if (gfan_handle) {
7965 /* 570, 600e/x, 770e, 770x */
7966 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
7967 } else {
7968 /* all other ThinkPads: note that even old-style
7969 * ThinkPad ECs supports the fan control register */
7970 if (likely(acpi_ec_read(fan_status_offset,
7971 &fan_control_initial_status))) {
7972 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
7973 if (quirks & TPACPI_FAN_Q1)
7974 fan_quirk1_setup();
7975 if (quirks & TPACPI_FAN_2FAN) {
7976 tp_features.second_fan = 1;
7977 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7978 "secondary fan support enabled\n");
7980 } else {
7981 printk(TPACPI_ERR
7982 "ThinkPad ACPI EC access misbehaving, "
7983 "fan status and control unavailable\n");
7984 return 1;
7988 if (sfan_handle) {
7989 /* 570, 770x-JL */
7990 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
7991 fan_control_commands |=
7992 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
7993 } else {
7994 if (!gfan_handle) {
7995 /* gfan without sfan means no fan control */
7996 /* all other models implement TP EC 0x2f control */
7998 if (fans_handle) {
7999 /* X31, X40, X41 */
8000 fan_control_access_mode =
8001 TPACPI_FAN_WR_ACPI_FANS;
8002 fan_control_commands |=
8003 TPACPI_FAN_CMD_SPEED |
8004 TPACPI_FAN_CMD_LEVEL |
8005 TPACPI_FAN_CMD_ENABLE;
8006 } else {
8007 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8008 fan_control_commands |=
8009 TPACPI_FAN_CMD_LEVEL |
8010 TPACPI_FAN_CMD_ENABLE;
8015 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8016 "fan is %s, modes %d, %d\n",
8017 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8018 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8019 fan_status_access_mode, fan_control_access_mode);
8021 /* fan control master switch */
8022 if (!fan_control_allowed) {
8023 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8024 fan_control_commands = 0;
8025 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8026 "fan control features disabled by parameter\n");
8029 /* update fan_control_desired_level */
8030 if (fan_status_access_mode != TPACPI_FAN_NONE)
8031 fan_get_status_safe(NULL);
8033 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8034 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8035 if (tp_features.second_fan) {
8036 /* attach second fan tachometer */
8037 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8038 &dev_attr_fan_fan2_input.attr;
8040 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8041 &fan_attr_group);
8042 if (rc < 0)
8043 return rc;
8045 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8046 &driver_attr_fan_watchdog);
8047 if (rc < 0) {
8048 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8049 &fan_attr_group);
8050 return rc;
8052 return 0;
8053 } else
8054 return 1;
8057 static void fan_exit(void)
8059 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8060 "cancelling any pending fan watchdog tasks\n");
8062 /* FIXME: can we really do this unconditionally? */
8063 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8064 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8065 &driver_attr_fan_watchdog);
8067 cancel_delayed_work(&fan_watchdog_task);
8068 flush_workqueue(tpacpi_wq);
8071 static void fan_suspend(pm_message_t state)
8073 int rc;
8075 if (!fan_control_allowed)
8076 return;
8078 /* Store fan status in cache */
8079 fan_control_resume_level = 0;
8080 rc = fan_get_status_safe(&fan_control_resume_level);
8081 if (rc < 0)
8082 printk(TPACPI_NOTICE
8083 "failed to read fan level for later "
8084 "restore during resume: %d\n", rc);
8086 /* if it is undefined, don't attempt to restore it.
8087 * KEEP THIS LAST */
8088 if (tp_features.fan_ctrl_status_undef)
8089 fan_control_resume_level = 0;
8092 static void fan_resume(void)
8094 u8 current_level = 7;
8095 bool do_set = false;
8096 int rc;
8098 /* DSDT *always* updates status on resume */
8099 tp_features.fan_ctrl_status_undef = 0;
8101 if (!fan_control_allowed ||
8102 !fan_control_resume_level ||
8103 (fan_get_status_safe(&current_level) < 0))
8104 return;
8106 switch (fan_control_access_mode) {
8107 case TPACPI_FAN_WR_ACPI_SFAN:
8108 /* never decrease fan level */
8109 do_set = (fan_control_resume_level > current_level);
8110 break;
8111 case TPACPI_FAN_WR_ACPI_FANS:
8112 case TPACPI_FAN_WR_TPEC:
8113 /* never decrease fan level, scale is:
8114 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8116 * We expect the firmware to set either 7 or AUTO, but we
8117 * handle FULLSPEED out of paranoia.
8119 * So, we can safely only restore FULLSPEED or 7, anything
8120 * else could slow the fan. Restoring AUTO is useless, at
8121 * best that's exactly what the DSDT already set (it is the
8122 * slower it uses).
8124 * Always keep in mind that the DSDT *will* have set the
8125 * fans to what the vendor supposes is the best level. We
8126 * muck with it only to speed the fan up.
8128 if (fan_control_resume_level != 7 &&
8129 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8130 return;
8131 else
8132 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8133 (current_level != fan_control_resume_level);
8134 break;
8135 default:
8136 return;
8138 if (do_set) {
8139 printk(TPACPI_NOTICE
8140 "restoring fan level to 0x%02x\n",
8141 fan_control_resume_level);
8142 rc = fan_set_level_safe(fan_control_resume_level);
8143 if (rc < 0)
8144 printk(TPACPI_NOTICE
8145 "failed to restore fan level: %d\n", rc);
8149 static int fan_read(struct seq_file *m)
8151 int rc;
8152 u8 status;
8153 unsigned int speed = 0;
8155 switch (fan_status_access_mode) {
8156 case TPACPI_FAN_RD_ACPI_GFAN:
8157 /* 570, 600e/x, 770e, 770x */
8158 rc = fan_get_status_safe(&status);
8159 if (rc < 0)
8160 return rc;
8162 seq_printf(m, "status:\t\t%s\n"
8163 "level:\t\t%d\n",
8164 (status != 0) ? "enabled" : "disabled", status);
8165 break;
8167 case TPACPI_FAN_RD_TPEC:
8168 /* all except 570, 600e/x, 770e, 770x */
8169 rc = fan_get_status_safe(&status);
8170 if (rc < 0)
8171 return rc;
8173 seq_printf(m, "status:\t\t%s\n",
8174 (status != 0) ? "enabled" : "disabled");
8176 rc = fan_get_speed(&speed);
8177 if (rc < 0)
8178 return rc;
8180 seq_printf(m, "speed:\t\t%d\n", speed);
8182 if (status & TP_EC_FAN_FULLSPEED)
8183 /* Disengaged mode takes precedence */
8184 seq_printf(m, "level:\t\tdisengaged\n");
8185 else if (status & TP_EC_FAN_AUTO)
8186 seq_printf(m, "level:\t\tauto\n");
8187 else
8188 seq_printf(m, "level:\t\t%d\n", status);
8189 break;
8191 case TPACPI_FAN_NONE:
8192 default:
8193 seq_printf(m, "status:\t\tnot supported\n");
8196 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8197 seq_printf(m, "commands:\tlevel <level>");
8199 switch (fan_control_access_mode) {
8200 case TPACPI_FAN_WR_ACPI_SFAN:
8201 seq_printf(m, " (<level> is 0-7)\n");
8202 break;
8204 default:
8205 seq_printf(m, " (<level> is 0-7, "
8206 "auto, disengaged, full-speed)\n");
8207 break;
8211 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8212 seq_printf(m, "commands:\tenable, disable\n"
8213 "commands:\twatchdog <timeout> (<timeout> "
8214 "is 0 (off), 1-120 (seconds))\n");
8216 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8217 seq_printf(m, "commands:\tspeed <speed>"
8218 " (<speed> is 0-65535)\n");
8220 return 0;
8223 static int fan_write_cmd_level(const char *cmd, int *rc)
8225 int level;
8227 if (strlencmp(cmd, "level auto") == 0)
8228 level = TP_EC_FAN_AUTO;
8229 else if ((strlencmp(cmd, "level disengaged") == 0) |
8230 (strlencmp(cmd, "level full-speed") == 0))
8231 level = TP_EC_FAN_FULLSPEED;
8232 else if (sscanf(cmd, "level %d", &level) != 1)
8233 return 0;
8235 *rc = fan_set_level_safe(level);
8236 if (*rc == -ENXIO)
8237 printk(TPACPI_ERR "level command accepted for unsupported "
8238 "access mode %d", fan_control_access_mode);
8239 else if (!*rc)
8240 tpacpi_disclose_usertask("procfs fan",
8241 "set level to %d\n", level);
8243 return 1;
8246 static int fan_write_cmd_enable(const char *cmd, int *rc)
8248 if (strlencmp(cmd, "enable") != 0)
8249 return 0;
8251 *rc = fan_set_enable();
8252 if (*rc == -ENXIO)
8253 printk(TPACPI_ERR "enable command accepted for unsupported "
8254 "access mode %d", fan_control_access_mode);
8255 else if (!*rc)
8256 tpacpi_disclose_usertask("procfs fan", "enable\n");
8258 return 1;
8261 static int fan_write_cmd_disable(const char *cmd, int *rc)
8263 if (strlencmp(cmd, "disable") != 0)
8264 return 0;
8266 *rc = fan_set_disable();
8267 if (*rc == -ENXIO)
8268 printk(TPACPI_ERR "disable command accepted for unsupported "
8269 "access mode %d", fan_control_access_mode);
8270 else if (!*rc)
8271 tpacpi_disclose_usertask("procfs fan", "disable\n");
8273 return 1;
8276 static int fan_write_cmd_speed(const char *cmd, int *rc)
8278 int speed;
8280 /* TODO:
8281 * Support speed <low> <medium> <high> ? */
8283 if (sscanf(cmd, "speed %d", &speed) != 1)
8284 return 0;
8286 *rc = fan_set_speed(speed);
8287 if (*rc == -ENXIO)
8288 printk(TPACPI_ERR "speed command accepted for unsupported "
8289 "access mode %d", fan_control_access_mode);
8290 else if (!*rc)
8291 tpacpi_disclose_usertask("procfs fan",
8292 "set speed to %d\n", speed);
8294 return 1;
8297 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8299 int interval;
8301 if (sscanf(cmd, "watchdog %d", &interval) != 1)
8302 return 0;
8304 if (interval < 0 || interval > 120)
8305 *rc = -EINVAL;
8306 else {
8307 fan_watchdog_maxinterval = interval;
8308 tpacpi_disclose_usertask("procfs fan",
8309 "set watchdog timer to %d\n",
8310 interval);
8313 return 1;
8316 static int fan_write(char *buf)
8318 char *cmd;
8319 int rc = 0;
8321 while (!rc && (cmd = next_cmd(&buf))) {
8322 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8323 fan_write_cmd_level(cmd, &rc)) &&
8324 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8325 (fan_write_cmd_enable(cmd, &rc) ||
8326 fan_write_cmd_disable(cmd, &rc) ||
8327 fan_write_cmd_watchdog(cmd, &rc))) &&
8328 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8329 fan_write_cmd_speed(cmd, &rc))
8331 rc = -EINVAL;
8332 else if (!rc)
8333 fan_watchdog_reset();
8336 return rc;
8339 static struct ibm_struct fan_driver_data = {
8340 .name = "fan",
8341 .read = fan_read,
8342 .write = fan_write,
8343 .exit = fan_exit,
8344 .suspend = fan_suspend,
8345 .resume = fan_resume,
8348 /****************************************************************************
8349 ****************************************************************************
8351 * Infrastructure
8353 ****************************************************************************
8354 ****************************************************************************/
8357 * HKEY event callout for other subdrivers go here
8358 * (yes, it is ugly, but it is quick, safe, and gets the job done
8360 static void tpacpi_driver_event(const unsigned int hkey_event)
8362 if (ibm_backlight_device) {
8363 switch (hkey_event) {
8364 case TP_HKEY_EV_BRGHT_UP:
8365 case TP_HKEY_EV_BRGHT_DOWN:
8366 tpacpi_brightness_notify_change();
8369 if (alsa_card) {
8370 switch (hkey_event) {
8371 case TP_HKEY_EV_VOL_UP:
8372 case TP_HKEY_EV_VOL_DOWN:
8373 case TP_HKEY_EV_VOL_MUTE:
8374 volume_alsa_notify_change();
8379 static void hotkey_driver_event(const unsigned int scancode)
8381 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8384 /* sysfs name ---------------------------------------------------------- */
8385 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8386 struct device_attribute *attr,
8387 char *buf)
8389 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8392 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8393 __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8395 /* --------------------------------------------------------------------- */
8397 /* /proc support */
8398 static struct proc_dir_entry *proc_dir;
8401 * Module and infrastructure proble, init and exit handling
8404 static int force_load;
8406 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
8407 static const char * __init str_supported(int is_supported)
8409 static char text_unsupported[] __initdata = "not supported";
8411 return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8413 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8415 static void ibm_exit(struct ibm_struct *ibm)
8417 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8419 list_del_init(&ibm->all_drivers);
8421 if (ibm->flags.acpi_notify_installed) {
8422 dbg_printk(TPACPI_DBG_EXIT,
8423 "%s: acpi_remove_notify_handler\n", ibm->name);
8424 BUG_ON(!ibm->acpi);
8425 acpi_remove_notify_handler(*ibm->acpi->handle,
8426 ibm->acpi->type,
8427 dispatch_acpi_notify);
8428 ibm->flags.acpi_notify_installed = 0;
8429 ibm->flags.acpi_notify_installed = 0;
8432 if (ibm->flags.proc_created) {
8433 dbg_printk(TPACPI_DBG_EXIT,
8434 "%s: remove_proc_entry\n", ibm->name);
8435 remove_proc_entry(ibm->name, proc_dir);
8436 ibm->flags.proc_created = 0;
8439 if (ibm->flags.acpi_driver_registered) {
8440 dbg_printk(TPACPI_DBG_EXIT,
8441 "%s: acpi_bus_unregister_driver\n", ibm->name);
8442 BUG_ON(!ibm->acpi);
8443 acpi_bus_unregister_driver(ibm->acpi->driver);
8444 kfree(ibm->acpi->driver);
8445 ibm->acpi->driver = NULL;
8446 ibm->flags.acpi_driver_registered = 0;
8449 if (ibm->flags.init_called && ibm->exit) {
8450 ibm->exit();
8451 ibm->flags.init_called = 0;
8454 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8457 static int __init ibm_init(struct ibm_init_struct *iibm)
8459 int ret;
8460 struct ibm_struct *ibm = iibm->data;
8461 struct proc_dir_entry *entry;
8463 BUG_ON(ibm == NULL);
8465 INIT_LIST_HEAD(&ibm->all_drivers);
8467 if (ibm->flags.experimental && !experimental)
8468 return 0;
8470 dbg_printk(TPACPI_DBG_INIT,
8471 "probing for %s\n", ibm->name);
8473 if (iibm->init) {
8474 ret = iibm->init(iibm);
8475 if (ret > 0)
8476 return 0; /* probe failed */
8477 if (ret)
8478 return ret;
8480 ibm->flags.init_called = 1;
8483 if (ibm->acpi) {
8484 if (ibm->acpi->hid) {
8485 ret = register_tpacpi_subdriver(ibm);
8486 if (ret)
8487 goto err_out;
8490 if (ibm->acpi->notify) {
8491 ret = setup_acpi_notify(ibm);
8492 if (ret == -ENODEV) {
8493 printk(TPACPI_NOTICE "disabling subdriver %s\n",
8494 ibm->name);
8495 ret = 0;
8496 goto err_out;
8498 if (ret < 0)
8499 goto err_out;
8503 dbg_printk(TPACPI_DBG_INIT,
8504 "%s installed\n", ibm->name);
8506 if (ibm->read) {
8507 mode_t mode;
8509 mode = S_IRUGO;
8510 if (ibm->write)
8511 mode |= S_IWUSR;
8512 entry = proc_create_data(ibm->name, mode, proc_dir,
8513 &dispatch_proc_fops, ibm);
8514 if (!entry) {
8515 printk(TPACPI_ERR "unable to create proc entry %s\n",
8516 ibm->name);
8517 ret = -ENODEV;
8518 goto err_out;
8520 ibm->flags.proc_created = 1;
8523 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8525 return 0;
8527 err_out:
8528 dbg_printk(TPACPI_DBG_INIT,
8529 "%s: at error exit path with result %d\n",
8530 ibm->name, ret);
8532 ibm_exit(ibm);
8533 return (ret < 0)? ret : 0;
8536 /* Probing */
8538 static bool __pure __init tpacpi_is_fw_digit(const char c)
8540 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8543 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8544 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8545 const char t)
8547 return s && strlen(s) >= 8 &&
8548 tpacpi_is_fw_digit(s[0]) &&
8549 tpacpi_is_fw_digit(s[1]) &&
8550 s[2] == t && s[3] == 'T' &&
8551 tpacpi_is_fw_digit(s[4]) &&
8552 tpacpi_is_fw_digit(s[5]) &&
8553 s[6] == 'W' && s[7] == 'W';
8556 /* returns 0 - probe ok, or < 0 - probe error.
8557 * Probe ok doesn't mean thinkpad found.
8558 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8559 static int __must_check __init get_thinkpad_model_data(
8560 struct thinkpad_id_data *tp)
8562 const struct dmi_device *dev = NULL;
8563 char ec_fw_string[18];
8564 char const *s;
8566 if (!tp)
8567 return -EINVAL;
8569 memset(tp, 0, sizeof(*tp));
8571 if (dmi_name_in_vendors("IBM"))
8572 tp->vendor = PCI_VENDOR_ID_IBM;
8573 else if (dmi_name_in_vendors("LENOVO"))
8574 tp->vendor = PCI_VENDOR_ID_LENOVO;
8575 else
8576 return 0;
8578 s = dmi_get_system_info(DMI_BIOS_VERSION);
8579 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8580 if (s && !tp->bios_version_str)
8581 return -ENOMEM;
8583 /* Really ancient ThinkPad 240X will fail this, which is fine */
8584 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
8585 return 0;
8587 tp->bios_model = tp->bios_version_str[0]
8588 | (tp->bios_version_str[1] << 8);
8589 tp->bios_release = (tp->bios_version_str[4] << 8)
8590 | tp->bios_version_str[5];
8593 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8594 * X32 or newer, all Z series; Some models must have an
8595 * up-to-date BIOS or they will not be detected.
8597 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8599 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8600 if (sscanf(dev->name,
8601 "IBM ThinkPad Embedded Controller -[%17c",
8602 ec_fw_string) == 1) {
8603 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8604 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8606 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8607 if (!tp->ec_version_str)
8608 return -ENOMEM;
8610 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8611 tp->ec_model = ec_fw_string[0]
8612 | (ec_fw_string[1] << 8);
8613 tp->ec_release = (ec_fw_string[4] << 8)
8614 | ec_fw_string[5];
8615 } else {
8616 printk(TPACPI_NOTICE
8617 "ThinkPad firmware release %s "
8618 "doesn't match the known patterns\n",
8619 ec_fw_string);
8620 printk(TPACPI_NOTICE
8621 "please report this to %s\n",
8622 TPACPI_MAIL);
8624 break;
8628 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8629 if (s && !strnicmp(s, "ThinkPad", 8)) {
8630 tp->model_str = kstrdup(s, GFP_KERNEL);
8631 if (!tp->model_str)
8632 return -ENOMEM;
8635 s = dmi_get_system_info(DMI_PRODUCT_NAME);
8636 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8637 if (s && !tp->nummodel_str)
8638 return -ENOMEM;
8640 return 0;
8643 static int __init probe_for_thinkpad(void)
8645 int is_thinkpad;
8647 if (acpi_disabled)
8648 return -ENODEV;
8651 * Non-ancient models have better DMI tagging, but very old models
8652 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
8654 is_thinkpad = (thinkpad_id.model_str != NULL) ||
8655 (thinkpad_id.ec_model != 0) ||
8656 tpacpi_is_fw_known();
8658 /* ec is required because many other handles are relative to it */
8659 TPACPI_ACPIHANDLE_INIT(ec);
8660 if (!ec_handle) {
8661 if (is_thinkpad)
8662 printk(TPACPI_ERR
8663 "Not yet supported ThinkPad detected!\n");
8664 return -ENODEV;
8667 if (!is_thinkpad && !force_load)
8668 return -ENODEV;
8670 return 0;
8674 /* Module init, exit, parameters */
8676 static struct ibm_init_struct ibms_init[] __initdata = {
8678 .init = thinkpad_acpi_driver_init,
8679 .data = &thinkpad_acpi_driver_data,
8682 .init = hotkey_init,
8683 .data = &hotkey_driver_data,
8686 .init = bluetooth_init,
8687 .data = &bluetooth_driver_data,
8690 .init = wan_init,
8691 .data = &wan_driver_data,
8694 .init = uwb_init,
8695 .data = &uwb_driver_data,
8697 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8699 .init = video_init,
8700 .data = &video_driver_data,
8702 #endif
8704 .init = light_init,
8705 .data = &light_driver_data,
8708 .init = cmos_init,
8709 .data = &cmos_driver_data,
8712 .init = led_init,
8713 .data = &led_driver_data,
8716 .init = beep_init,
8717 .data = &beep_driver_data,
8720 .init = thermal_init,
8721 .data = &thermal_driver_data,
8724 .data = &ecdump_driver_data,
8727 .init = brightness_init,
8728 .data = &brightness_driver_data,
8731 .init = volume_init,
8732 .data = &volume_driver_data,
8735 .init = fan_init,
8736 .data = &fan_driver_data,
8740 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8742 unsigned int i;
8743 struct ibm_struct *ibm;
8745 if (!kp || !kp->name || !val)
8746 return -EINVAL;
8748 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8749 ibm = ibms_init[i].data;
8750 WARN_ON(ibm == NULL);
8752 if (!ibm || !ibm->name)
8753 continue;
8755 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8756 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8757 return -ENOSPC;
8758 strcpy(ibms_init[i].param, val);
8759 strcat(ibms_init[i].param, ",");
8760 return 0;
8764 return -EINVAL;
8767 module_param(experimental, int, 0444);
8768 MODULE_PARM_DESC(experimental,
8769 "Enables experimental features when non-zero");
8771 module_param_named(debug, dbg_level, uint, 0);
8772 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8774 module_param(force_load, bool, 0444);
8775 MODULE_PARM_DESC(force_load,
8776 "Attempts to load the driver even on a "
8777 "mis-identified ThinkPad when true");
8779 module_param_named(fan_control, fan_control_allowed, bool, 0444);
8780 MODULE_PARM_DESC(fan_control,
8781 "Enables setting fan parameters features when true");
8783 module_param_named(brightness_mode, brightness_mode, uint, 0444);
8784 MODULE_PARM_DESC(brightness_mode,
8785 "Selects brightness control strategy: "
8786 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8788 module_param(brightness_enable, uint, 0444);
8789 MODULE_PARM_DESC(brightness_enable,
8790 "Enables backlight control when 1, disables when 0");
8792 module_param(hotkey_report_mode, uint, 0444);
8793 MODULE_PARM_DESC(hotkey_report_mode,
8794 "used for backwards compatibility with userspace, "
8795 "see documentation");
8797 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8798 module_param_named(volume_mode, volume_mode, uint, 0444);
8799 MODULE_PARM_DESC(volume_mode,
8800 "Selects volume control strategy: "
8801 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8803 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8804 MODULE_PARM_DESC(volume_capabilities,
8805 "Selects the mixer capabilites: "
8806 "0=auto, 1=volume and mute, 2=mute only");
8808 module_param_named(volume_control, volume_control_allowed, bool, 0444);
8809 MODULE_PARM_DESC(volume_control,
8810 "Enables software override for the console audio "
8811 "control when true");
8813 /* ALSA module API parameters */
8814 module_param_named(index, alsa_index, int, 0444);
8815 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8816 module_param_named(id, alsa_id, charp, 0444);
8817 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8818 module_param_named(enable, alsa_enable, bool, 0444);
8819 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8820 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8822 #define TPACPI_PARAM(feature) \
8823 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8824 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8825 "at module load, see documentation")
8827 TPACPI_PARAM(hotkey);
8828 TPACPI_PARAM(bluetooth);
8829 TPACPI_PARAM(video);
8830 TPACPI_PARAM(light);
8831 TPACPI_PARAM(cmos);
8832 TPACPI_PARAM(led);
8833 TPACPI_PARAM(beep);
8834 TPACPI_PARAM(ecdump);
8835 TPACPI_PARAM(brightness);
8836 TPACPI_PARAM(volume);
8837 TPACPI_PARAM(fan);
8839 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8840 module_param(dbg_wlswemul, uint, 0444);
8841 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8842 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8843 MODULE_PARM_DESC(wlsw_state,
8844 "Initial state of the emulated WLSW switch");
8846 module_param(dbg_bluetoothemul, uint, 0444);
8847 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8848 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8849 MODULE_PARM_DESC(bluetooth_state,
8850 "Initial state of the emulated bluetooth switch");
8852 module_param(dbg_wwanemul, uint, 0444);
8853 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8854 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8855 MODULE_PARM_DESC(wwan_state,
8856 "Initial state of the emulated WWAN switch");
8858 module_param(dbg_uwbemul, uint, 0444);
8859 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8860 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8861 MODULE_PARM_DESC(uwb_state,
8862 "Initial state of the emulated UWB switch");
8863 #endif
8865 static void thinkpad_acpi_module_exit(void)
8867 struct ibm_struct *ibm, *itmp;
8869 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8871 list_for_each_entry_safe_reverse(ibm, itmp,
8872 &tpacpi_all_drivers,
8873 all_drivers) {
8874 ibm_exit(ibm);
8877 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8879 if (tpacpi_inputdev) {
8880 if (tp_features.input_device_registered)
8881 input_unregister_device(tpacpi_inputdev);
8882 else
8883 input_free_device(tpacpi_inputdev);
8886 if (tpacpi_hwmon)
8887 hwmon_device_unregister(tpacpi_hwmon);
8889 if (tp_features.sensors_pdev_attrs_registered)
8890 device_remove_file(&tpacpi_sensors_pdev->dev,
8891 &dev_attr_thinkpad_acpi_pdev_name);
8892 if (tpacpi_sensors_pdev)
8893 platform_device_unregister(tpacpi_sensors_pdev);
8894 if (tpacpi_pdev)
8895 platform_device_unregister(tpacpi_pdev);
8897 if (tp_features.sensors_pdrv_attrs_registered)
8898 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8899 if (tp_features.platform_drv_attrs_registered)
8900 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8902 if (tp_features.sensors_pdrv_registered)
8903 platform_driver_unregister(&tpacpi_hwmon_pdriver);
8905 if (tp_features.platform_drv_registered)
8906 platform_driver_unregister(&tpacpi_pdriver);
8908 if (proc_dir)
8909 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
8911 if (tpacpi_wq)
8912 destroy_workqueue(tpacpi_wq);
8914 kfree(thinkpad_id.bios_version_str);
8915 kfree(thinkpad_id.ec_version_str);
8916 kfree(thinkpad_id.model_str);
8920 static int __init thinkpad_acpi_module_init(void)
8922 int ret, i;
8924 tpacpi_lifecycle = TPACPI_LIFE_INIT;
8926 /* Parameter checking */
8927 if (hotkey_report_mode > 2)
8928 return -EINVAL;
8930 /* Driver-level probe */
8932 ret = get_thinkpad_model_data(&thinkpad_id);
8933 if (ret) {
8934 printk(TPACPI_ERR
8935 "unable to get DMI data: %d\n", ret);
8936 thinkpad_acpi_module_exit();
8937 return ret;
8939 ret = probe_for_thinkpad();
8940 if (ret) {
8941 thinkpad_acpi_module_exit();
8942 return ret;
8945 /* Driver initialization */
8947 TPACPI_ACPIHANDLE_INIT(ecrd);
8948 TPACPI_ACPIHANDLE_INIT(ecwr);
8950 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
8951 if (!tpacpi_wq) {
8952 thinkpad_acpi_module_exit();
8953 return -ENOMEM;
8956 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
8957 if (!proc_dir) {
8958 printk(TPACPI_ERR
8959 "unable to create proc dir " TPACPI_PROC_DIR);
8960 thinkpad_acpi_module_exit();
8961 return -ENODEV;
8964 ret = platform_driver_register(&tpacpi_pdriver);
8965 if (ret) {
8966 printk(TPACPI_ERR
8967 "unable to register main platform driver\n");
8968 thinkpad_acpi_module_exit();
8969 return ret;
8971 tp_features.platform_drv_registered = 1;
8973 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
8974 if (ret) {
8975 printk(TPACPI_ERR
8976 "unable to register hwmon platform driver\n");
8977 thinkpad_acpi_module_exit();
8978 return ret;
8980 tp_features.sensors_pdrv_registered = 1;
8982 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
8983 if (!ret) {
8984 tp_features.platform_drv_attrs_registered = 1;
8985 ret = tpacpi_create_driver_attributes(
8986 &tpacpi_hwmon_pdriver.driver);
8988 if (ret) {
8989 printk(TPACPI_ERR
8990 "unable to create sysfs driver attributes\n");
8991 thinkpad_acpi_module_exit();
8992 return ret;
8994 tp_features.sensors_pdrv_attrs_registered = 1;
8997 /* Device initialization */
8998 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
8999 NULL, 0);
9000 if (IS_ERR(tpacpi_pdev)) {
9001 ret = PTR_ERR(tpacpi_pdev);
9002 tpacpi_pdev = NULL;
9003 printk(TPACPI_ERR "unable to register platform device\n");
9004 thinkpad_acpi_module_exit();
9005 return ret;
9007 tpacpi_sensors_pdev = platform_device_register_simple(
9008 TPACPI_HWMON_DRVR_NAME,
9009 -1, NULL, 0);
9010 if (IS_ERR(tpacpi_sensors_pdev)) {
9011 ret = PTR_ERR(tpacpi_sensors_pdev);
9012 tpacpi_sensors_pdev = NULL;
9013 printk(TPACPI_ERR
9014 "unable to register hwmon platform device\n");
9015 thinkpad_acpi_module_exit();
9016 return ret;
9018 ret = device_create_file(&tpacpi_sensors_pdev->dev,
9019 &dev_attr_thinkpad_acpi_pdev_name);
9020 if (ret) {
9021 printk(TPACPI_ERR
9022 "unable to create sysfs hwmon device attributes\n");
9023 thinkpad_acpi_module_exit();
9024 return ret;
9026 tp_features.sensors_pdev_attrs_registered = 1;
9027 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9028 if (IS_ERR(tpacpi_hwmon)) {
9029 ret = PTR_ERR(tpacpi_hwmon);
9030 tpacpi_hwmon = NULL;
9031 printk(TPACPI_ERR "unable to register hwmon device\n");
9032 thinkpad_acpi_module_exit();
9033 return ret;
9035 mutex_init(&tpacpi_inputdev_send_mutex);
9036 tpacpi_inputdev = input_allocate_device();
9037 if (!tpacpi_inputdev) {
9038 printk(TPACPI_ERR "unable to allocate input device\n");
9039 thinkpad_acpi_module_exit();
9040 return -ENOMEM;
9041 } else {
9042 /* Prepare input device, but don't register */
9043 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9044 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9045 tpacpi_inputdev->id.bustype = BUS_HOST;
9046 tpacpi_inputdev->id.vendor = (thinkpad_id.vendor) ?
9047 thinkpad_id.vendor :
9048 PCI_VENDOR_ID_IBM;
9049 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9050 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9051 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9053 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9054 ret = ibm_init(&ibms_init[i]);
9055 if (ret >= 0 && *ibms_init[i].param)
9056 ret = ibms_init[i].data->write(ibms_init[i].param);
9057 if (ret < 0) {
9058 thinkpad_acpi_module_exit();
9059 return ret;
9063 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9065 ret = input_register_device(tpacpi_inputdev);
9066 if (ret < 0) {
9067 printk(TPACPI_ERR "unable to register input device\n");
9068 thinkpad_acpi_module_exit();
9069 return ret;
9070 } else {
9071 tp_features.input_device_registered = 1;
9074 return 0;
9077 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9080 * This will autoload the driver in almost every ThinkPad
9081 * in widespread use.
9083 * Only _VERY_ old models, like the 240, 240x and 570 lack
9084 * the HKEY event interface.
9086 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9089 * DMI matching for module autoloading
9091 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9092 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9094 * Only models listed in thinkwiki will be supported, so add yours
9095 * if it is not there yet.
9097 #define IBM_BIOS_MODULE_ALIAS(__type) \
9098 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9100 /* Ancient thinkpad BIOSes have to be identified by
9101 * BIOS type or model number, and there are far less
9102 * BIOS types than model numbers... */
9103 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
9105 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9106 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9107 MODULE_DESCRIPTION(TPACPI_DESC);
9108 MODULE_VERSION(TPACPI_VERSION);
9109 MODULE_LICENSE("GPL");
9111 module_init(thinkpad_acpi_module_init);
9112 module_exit(thinkpad_acpi_module_exit);