thinkpad-acpi: fix volume/mute hotkey poll handling
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / platform / x86 / thinkpad_acpi.c
blob1f27b350ae01197c226ea6660a20e333923c5f02
1 /*
2 * thinkpad_acpi.c - ThinkPad ACPI Extras
5 * Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6 * Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 * 02110-1301, USA.
24 #define TPACPI_VERSION "0.24"
25 #define TPACPI_SYSFS_VERSION 0x020700
28 * Changelog:
29 * 2007-10-20 changelog trimmed down
31 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
32 * drivers/misc.
34 * 2006-11-22 0.13 new maintainer
35 * changelog now lives in git commit history, and will
36 * not be updated further in-file.
38 * 2005-03-17 0.11 support for 600e, 770x
39 * thanks to Jamie Lentin <lentinj@dial.pipex.com>
41 * 2005-01-16 0.9 use MODULE_VERSION
42 * thanks to Henrik Brix Andersen <brix@gentoo.org>
43 * fix parameter passing on module loading
44 * thanks to Rusty Russell <rusty@rustcorp.com.au>
45 * thanks to Jim Radford <radford@blackbean.org>
46 * 2004-11-08 0.8 fix init error case, don't return from a macro
47 * thanks to Chris Wright <chrisw@osdl.org>
50 #include <linux/kernel.h>
51 #include <linux/module.h>
52 #include <linux/init.h>
53 #include <linux/types.h>
54 #include <linux/string.h>
55 #include <linux/list.h>
56 #include <linux/mutex.h>
57 #include <linux/sched.h>
58 #include <linux/kthread.h>
59 #include <linux/freezer.h>
60 #include <linux/delay.h>
61 #include <linux/slab.h>
63 #include <linux/nvram.h>
64 #include <linux/proc_fs.h>
65 #include <linux/seq_file.h>
66 #include <linux/sysfs.h>
67 #include <linux/backlight.h>
68 #include <linux/fb.h>
69 #include <linux/platform_device.h>
70 #include <linux/hwmon.h>
71 #include <linux/hwmon-sysfs.h>
72 #include <linux/input.h>
73 #include <linux/leds.h>
74 #include <linux/rfkill.h>
75 #include <asm/uaccess.h>
77 #include <linux/dmi.h>
78 #include <linux/jiffies.h>
79 #include <linux/workqueue.h>
81 #include <sound/core.h>
82 #include <sound/control.h>
83 #include <sound/initval.h>
85 #include <acpi/acpi_drivers.h>
87 #include <linux/pci_ids.h>
90 /* ThinkPad CMOS commands */
91 #define TP_CMOS_VOLUME_DOWN 0
92 #define TP_CMOS_VOLUME_UP 1
93 #define TP_CMOS_VOLUME_MUTE 2
94 #define TP_CMOS_BRIGHTNESS_UP 4
95 #define TP_CMOS_BRIGHTNESS_DOWN 5
96 #define TP_CMOS_THINKLIGHT_ON 12
97 #define TP_CMOS_THINKLIGHT_OFF 13
99 /* NVRAM Addresses */
100 enum tp_nvram_addr {
101 TP_NVRAM_ADDR_HK2 = 0x57,
102 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
103 TP_NVRAM_ADDR_VIDEO = 0x59,
104 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
105 TP_NVRAM_ADDR_MIXER = 0x60,
108 /* NVRAM bit masks */
109 enum {
110 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
111 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
112 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
113 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
114 TP_NVRAM_MASK_THINKLIGHT = 0x10,
115 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
116 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
117 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
118 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
119 TP_NVRAM_MASK_MUTE = 0x40,
120 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
121 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
122 TP_NVRAM_POS_LEVEL_VOLUME = 0,
125 /* Misc NVRAM-related */
126 enum {
127 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
130 /* ACPI HIDs */
131 #define TPACPI_ACPI_HKEY_HID "IBM0068"
133 /* Input IDs */
134 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
135 #define TPACPI_HKEY_INPUT_VERSION 0x4101
137 /* ACPI \WGSV commands */
138 enum {
139 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
140 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
141 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
142 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
145 /* TP_ACPI_WGSV_GET_STATE bits */
146 enum {
147 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
148 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
149 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
150 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
151 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
152 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
153 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
154 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
155 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
156 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
159 /* HKEY events */
160 enum tpacpi_hkey_event_t {
161 /* Hotkey-related */
162 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
163 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
164 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
165 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
166 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
167 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
169 /* Reasons for waking up from S3/S4 */
170 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
171 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
172 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
173 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
174 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
175 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
177 /* Auto-sleep after eject request */
178 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
179 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
181 /* Misc bay events */
182 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
184 /* User-interface events */
185 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
186 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
187 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
188 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
189 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
190 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
191 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
193 /* Thermal events */
194 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
195 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
196 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
197 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
198 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* thermal table changed */
200 /* Misc */
201 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
204 /****************************************************************************
205 * Main driver
208 #define TPACPI_NAME "thinkpad"
209 #define TPACPI_DESC "ThinkPad ACPI Extras"
210 #define TPACPI_FILE TPACPI_NAME "_acpi"
211 #define TPACPI_URL "http://ibm-acpi.sf.net/"
212 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
214 #define TPACPI_PROC_DIR "ibm"
215 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
216 #define TPACPI_DRVR_NAME TPACPI_FILE
217 #define TPACPI_DRVR_SHORTNAME "tpacpi"
218 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
220 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
221 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
223 #define TPACPI_MAX_ACPI_ARGS 3
225 /* printk headers */
226 #define TPACPI_LOG TPACPI_FILE ": "
227 #define TPACPI_EMERG KERN_EMERG TPACPI_LOG
228 #define TPACPI_ALERT KERN_ALERT TPACPI_LOG
229 #define TPACPI_CRIT KERN_CRIT TPACPI_LOG
230 #define TPACPI_ERR KERN_ERR TPACPI_LOG
231 #define TPACPI_WARN KERN_WARNING TPACPI_LOG
232 #define TPACPI_NOTICE KERN_NOTICE TPACPI_LOG
233 #define TPACPI_INFO KERN_INFO TPACPI_LOG
234 #define TPACPI_DEBUG KERN_DEBUG TPACPI_LOG
236 /* Debugging printk groups */
237 #define TPACPI_DBG_ALL 0xffff
238 #define TPACPI_DBG_DISCLOSETASK 0x8000
239 #define TPACPI_DBG_INIT 0x0001
240 #define TPACPI_DBG_EXIT 0x0002
241 #define TPACPI_DBG_RFKILL 0x0004
242 #define TPACPI_DBG_HKEY 0x0008
243 #define TPACPI_DBG_FAN 0x0010
244 #define TPACPI_DBG_BRGHT 0x0020
245 #define TPACPI_DBG_MIXER 0x0040
247 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
248 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
249 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
252 /****************************************************************************
253 * Driver-wide structs and misc. variables
256 struct ibm_struct;
258 struct tp_acpi_drv_struct {
259 const struct acpi_device_id *hid;
260 struct acpi_driver *driver;
262 void (*notify) (struct ibm_struct *, u32);
263 acpi_handle *handle;
264 u32 type;
265 struct acpi_device *device;
268 struct ibm_struct {
269 char *name;
271 int (*read) (struct seq_file *);
272 int (*write) (char *);
273 void (*exit) (void);
274 void (*resume) (void);
275 void (*suspend) (pm_message_t state);
276 void (*shutdown) (void);
278 struct list_head all_drivers;
280 struct tp_acpi_drv_struct *acpi;
282 struct {
283 u8 acpi_driver_registered:1;
284 u8 acpi_notify_installed:1;
285 u8 proc_created:1;
286 u8 init_called:1;
287 u8 experimental:1;
288 } flags;
291 struct ibm_init_struct {
292 char param[32];
294 int (*init) (struct ibm_init_struct *);
295 mode_t base_procfs_mode;
296 struct ibm_struct *data;
299 static struct {
300 u32 bluetooth:1;
301 u32 hotkey:1;
302 u32 hotkey_mask:1;
303 u32 hotkey_wlsw:1;
304 u32 hotkey_tablet:1;
305 u32 light:1;
306 u32 light_status:1;
307 u32 bright_16levels:1;
308 u32 bright_acpimode:1;
309 u32 wan:1;
310 u32 uwb:1;
311 u32 fan_ctrl_status_undef:1;
312 u32 second_fan:1;
313 u32 beep_needs_two_args:1;
314 u32 mixer_no_level_control:1;
315 u32 input_device_registered:1;
316 u32 platform_drv_registered:1;
317 u32 platform_drv_attrs_registered:1;
318 u32 sensors_pdrv_registered:1;
319 u32 sensors_pdrv_attrs_registered:1;
320 u32 sensors_pdev_attrs_registered:1;
321 u32 hotkey_poll_active:1;
322 } tp_features;
324 static struct {
325 u16 hotkey_mask_ff:1;
326 u16 volume_ctrl_forbidden:1;
327 } tp_warned;
329 struct thinkpad_id_data {
330 unsigned int vendor; /* ThinkPad vendor:
331 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
333 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
334 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
336 u16 bios_model; /* 1Y = 0x5931, 0 = unknown */
337 u16 ec_model;
338 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
339 u16 ec_release;
341 char *model_str; /* ThinkPad T43 */
342 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
344 static struct thinkpad_id_data thinkpad_id;
346 static enum {
347 TPACPI_LIFE_INIT = 0,
348 TPACPI_LIFE_RUNNING,
349 TPACPI_LIFE_EXITING,
350 } tpacpi_lifecycle;
352 static int experimental;
353 static u32 dbg_level;
355 static struct workqueue_struct *tpacpi_wq;
357 enum led_status_t {
358 TPACPI_LED_OFF = 0,
359 TPACPI_LED_ON,
360 TPACPI_LED_BLINK,
363 /* Special LED class that can defer work */
364 struct tpacpi_led_classdev {
365 struct led_classdev led_classdev;
366 struct work_struct work;
367 enum led_status_t new_state;
368 unsigned int led;
371 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
372 static int dbg_wlswemul;
373 static int tpacpi_wlsw_emulstate;
374 static int dbg_bluetoothemul;
375 static int tpacpi_bluetooth_emulstate;
376 static int dbg_wwanemul;
377 static int tpacpi_wwan_emulstate;
378 static int dbg_uwbemul;
379 static int tpacpi_uwb_emulstate;
380 #endif
383 /*************************************************************************
384 * Debugging helpers
387 #define dbg_printk(a_dbg_level, format, arg...) \
388 do { if (dbg_level & (a_dbg_level)) \
389 printk(TPACPI_DEBUG "%s: " format, __func__ , ## arg); \
390 } while (0)
392 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
393 #define vdbg_printk dbg_printk
394 static const char *str_supported(int is_supported);
395 #else
396 #define vdbg_printk(a_dbg_level, format, arg...) \
397 do { } while (0)
398 #endif
400 static void tpacpi_log_usertask(const char * const what)
402 printk(TPACPI_DEBUG "%s: access by process with PID %d\n",
403 what, task_tgid_vnr(current));
406 #define tpacpi_disclose_usertask(what, format, arg...) \
407 do { \
408 if (unlikely( \
409 (dbg_level & TPACPI_DBG_DISCLOSETASK) && \
410 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
411 printk(TPACPI_DEBUG "%s: PID %d: " format, \
412 what, task_tgid_vnr(current), ## arg); \
414 } while (0)
417 * Quirk handling helpers
419 * ThinkPad IDs and versions seen in the field so far
420 * are two-characters from the set [0-9A-Z], i.e. base 36.
422 * We use values well outside that range as specials.
425 #define TPACPI_MATCH_ANY 0xffffU
426 #define TPACPI_MATCH_UNKNOWN 0U
428 /* TPID('1', 'Y') == 0x5931 */
429 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
431 #define TPACPI_Q_IBM(__id1, __id2, __quirk) \
432 { .vendor = PCI_VENDOR_ID_IBM, \
433 .bios = TPID(__id1, __id2), \
434 .ec = TPACPI_MATCH_ANY, \
435 .quirks = (__quirk) }
437 #define TPACPI_Q_LNV(__id1, __id2, __quirk) \
438 { .vendor = PCI_VENDOR_ID_LENOVO, \
439 .bios = TPID(__id1, __id2), \
440 .ec = TPACPI_MATCH_ANY, \
441 .quirks = (__quirk) }
443 #define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
444 { .vendor = PCI_VENDOR_ID_LENOVO, \
445 .bios = TPACPI_MATCH_ANY, \
446 .ec = TPID(__id1, __id2), \
447 .quirks = (__quirk) }
449 struct tpacpi_quirk {
450 unsigned int vendor;
451 u16 bios;
452 u16 ec;
453 unsigned long quirks;
457 * tpacpi_check_quirks() - search BIOS/EC version on a list
458 * @qlist: array of &struct tpacpi_quirk
459 * @qlist_size: number of elements in @qlist
461 * Iterates over a quirks list until one is found that matches the
462 * ThinkPad's vendor, BIOS and EC model.
464 * Returns 0 if nothing matches, otherwise returns the quirks field of
465 * the matching &struct tpacpi_quirk entry.
467 * The match criteria is: vendor, ec and bios much match.
469 static unsigned long __init tpacpi_check_quirks(
470 const struct tpacpi_quirk *qlist,
471 unsigned int qlist_size)
473 while (qlist_size) {
474 if ((qlist->vendor == thinkpad_id.vendor ||
475 qlist->vendor == TPACPI_MATCH_ANY) &&
476 (qlist->bios == thinkpad_id.bios_model ||
477 qlist->bios == TPACPI_MATCH_ANY) &&
478 (qlist->ec == thinkpad_id.ec_model ||
479 qlist->ec == TPACPI_MATCH_ANY))
480 return qlist->quirks;
482 qlist_size--;
483 qlist++;
485 return 0;
488 static inline bool __pure __init tpacpi_is_lenovo(void)
490 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
493 static inline bool __pure __init tpacpi_is_ibm(void)
495 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
498 /****************************************************************************
499 ****************************************************************************
501 * ACPI Helpers and device model
503 ****************************************************************************
504 ****************************************************************************/
506 /*************************************************************************
507 * ACPI basic handles
510 static acpi_handle root_handle;
512 #define TPACPI_HANDLE(object, parent, paths...) \
513 static acpi_handle object##_handle; \
514 static acpi_handle *object##_parent = &parent##_handle; \
515 static char *object##_path; \
516 static char *object##_paths[] = { paths }
518 TPACPI_HANDLE(ec, root, "\\_SB.PCI0.ISA.EC0", /* 240, 240x */
519 "\\_SB.PCI.ISA.EC", /* 570 */
520 "\\_SB.PCI0.ISA0.EC0", /* 600e/x, 770e, 770x */
521 "\\_SB.PCI0.ISA.EC", /* A21e, A2xm/p, T20-22, X20-21 */
522 "\\_SB.PCI0.AD4S.EC0", /* i1400, R30 */
523 "\\_SB.PCI0.ICH3.EC0", /* R31 */
524 "\\_SB.PCI0.LPC0.EC", /* X100e and a few others */
525 "\\_SB.PCI0.LPC.EC", /* all others */
528 TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
529 TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
531 TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
532 /* T4x, X31, X40 */
533 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
534 "\\CMS", /* R40, R40e */
535 ); /* all others */
537 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
538 "^HKEY", /* R30, R31 */
539 "HKEY", /* all others */
540 ); /* 570 */
542 TPACPI_HANDLE(vid, root, "\\_SB.PCI.AGP.VGA", /* 570 */
543 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
544 "\\_SB.PCI0.VID0", /* 770e */
545 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
546 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
547 "\\_SB.PCI0.AGP.VID", /* all others */
548 ); /* R30, R31 */
551 /*************************************************************************
552 * ACPI helpers
555 static int acpi_evalf(acpi_handle handle,
556 void *res, char *method, char *fmt, ...)
558 char *fmt0 = fmt;
559 struct acpi_object_list params;
560 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
561 struct acpi_buffer result, *resultp;
562 union acpi_object out_obj;
563 acpi_status status;
564 va_list ap;
565 char res_type;
566 int success;
567 int quiet;
569 if (!*fmt) {
570 printk(TPACPI_ERR "acpi_evalf() called with empty format\n");
571 return 0;
574 if (*fmt == 'q') {
575 quiet = 1;
576 fmt++;
577 } else
578 quiet = 0;
580 res_type = *(fmt++);
582 params.count = 0;
583 params.pointer = &in_objs[0];
585 va_start(ap, fmt);
586 while (*fmt) {
587 char c = *(fmt++);
588 switch (c) {
589 case 'd': /* int */
590 in_objs[params.count].integer.value = va_arg(ap, int);
591 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
592 break;
593 /* add more types as needed */
594 default:
595 printk(TPACPI_ERR "acpi_evalf() called "
596 "with invalid format character '%c'\n", c);
597 return 0;
600 va_end(ap);
602 if (res_type != 'v') {
603 result.length = sizeof(out_obj);
604 result.pointer = &out_obj;
605 resultp = &result;
606 } else
607 resultp = NULL;
609 status = acpi_evaluate_object(handle, method, &params, resultp);
611 switch (res_type) {
612 case 'd': /* int */
613 if (res)
614 *(int *)res = out_obj.integer.value;
615 success = status == AE_OK && out_obj.type == ACPI_TYPE_INTEGER;
616 break;
617 case 'v': /* void */
618 success = status == AE_OK;
619 break;
620 /* add more types as needed */
621 default:
622 printk(TPACPI_ERR "acpi_evalf() called "
623 "with invalid format character '%c'\n", res_type);
624 return 0;
627 if (!success && !quiet)
628 printk(TPACPI_ERR "acpi_evalf(%s, %s, ...) failed: %d\n",
629 method, fmt0, status);
631 return success;
634 static int acpi_ec_read(int i, u8 *p)
636 int v;
638 if (ecrd_handle) {
639 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
640 return 0;
641 *p = v;
642 } else {
643 if (ec_read(i, p) < 0)
644 return 0;
647 return 1;
650 static int acpi_ec_write(int i, u8 v)
652 if (ecwr_handle) {
653 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
654 return 0;
655 } else {
656 if (ec_write(i, v) < 0)
657 return 0;
660 return 1;
663 static int issue_thinkpad_cmos_command(int cmos_cmd)
665 if (!cmos_handle)
666 return -ENXIO;
668 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
669 return -EIO;
671 return 0;
674 /*************************************************************************
675 * ACPI device model
678 #define TPACPI_ACPIHANDLE_INIT(object) \
679 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
680 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
682 static void drv_acpi_handle_init(char *name,
683 acpi_handle *handle, acpi_handle parent,
684 char **paths, int num_paths, char **path)
686 int i;
687 acpi_status status;
689 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
690 name);
692 for (i = 0; i < num_paths; i++) {
693 status = acpi_get_handle(parent, paths[i], handle);
694 if (ACPI_SUCCESS(status)) {
695 *path = paths[i];
696 dbg_printk(TPACPI_DBG_INIT,
697 "Found ACPI handle %s for %s\n",
698 *path, name);
699 return;
703 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
704 name);
705 *handle = NULL;
708 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
710 struct ibm_struct *ibm = data;
712 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
713 return;
715 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
716 return;
718 ibm->acpi->notify(ibm, event);
721 static int __init setup_acpi_notify(struct ibm_struct *ibm)
723 acpi_status status;
724 int rc;
726 BUG_ON(!ibm->acpi);
728 if (!*ibm->acpi->handle)
729 return 0;
731 vdbg_printk(TPACPI_DBG_INIT,
732 "setting up ACPI notify for %s\n", ibm->name);
734 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
735 if (rc < 0) {
736 printk(TPACPI_ERR "acpi_bus_get_device(%s) failed: %d\n",
737 ibm->name, rc);
738 return -ENODEV;
741 ibm->acpi->device->driver_data = ibm;
742 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
743 TPACPI_ACPI_EVENT_PREFIX,
744 ibm->name);
746 status = acpi_install_notify_handler(*ibm->acpi->handle,
747 ibm->acpi->type, dispatch_acpi_notify, ibm);
748 if (ACPI_FAILURE(status)) {
749 if (status == AE_ALREADY_EXISTS) {
750 printk(TPACPI_NOTICE
751 "another device driver is already "
752 "handling %s events\n", ibm->name);
753 } else {
754 printk(TPACPI_ERR
755 "acpi_install_notify_handler(%s) failed: %d\n",
756 ibm->name, status);
758 return -ENODEV;
760 ibm->flags.acpi_notify_installed = 1;
761 return 0;
764 static int __init tpacpi_device_add(struct acpi_device *device)
766 return 0;
769 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
771 int rc;
773 dbg_printk(TPACPI_DBG_INIT,
774 "registering %s as an ACPI driver\n", ibm->name);
776 BUG_ON(!ibm->acpi);
778 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
779 if (!ibm->acpi->driver) {
780 printk(TPACPI_ERR
781 "failed to allocate memory for ibm->acpi->driver\n");
782 return -ENOMEM;
785 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
786 ibm->acpi->driver->ids = ibm->acpi->hid;
788 ibm->acpi->driver->ops.add = &tpacpi_device_add;
790 rc = acpi_bus_register_driver(ibm->acpi->driver);
791 if (rc < 0) {
792 printk(TPACPI_ERR "acpi_bus_register_driver(%s) failed: %d\n",
793 ibm->name, rc);
794 kfree(ibm->acpi->driver);
795 ibm->acpi->driver = NULL;
796 } else if (!rc)
797 ibm->flags.acpi_driver_registered = 1;
799 return rc;
803 /****************************************************************************
804 ****************************************************************************
806 * Procfs Helpers
808 ****************************************************************************
809 ****************************************************************************/
811 static int dispatch_proc_show(struct seq_file *m, void *v)
813 struct ibm_struct *ibm = m->private;
815 if (!ibm || !ibm->read)
816 return -EINVAL;
817 return ibm->read(m);
820 static int dispatch_proc_open(struct inode *inode, struct file *file)
822 return single_open(file, dispatch_proc_show, PDE(inode)->data);
825 static ssize_t dispatch_proc_write(struct file *file,
826 const char __user *userbuf,
827 size_t count, loff_t *pos)
829 struct ibm_struct *ibm = PDE(file->f_path.dentry->d_inode)->data;
830 char *kernbuf;
831 int ret;
833 if (!ibm || !ibm->write)
834 return -EINVAL;
835 if (count > PAGE_SIZE - 2)
836 return -EINVAL;
838 kernbuf = kmalloc(count + 2, GFP_KERNEL);
839 if (!kernbuf)
840 return -ENOMEM;
842 if (copy_from_user(kernbuf, userbuf, count)) {
843 kfree(kernbuf);
844 return -EFAULT;
847 kernbuf[count] = 0;
848 strcat(kernbuf, ",");
849 ret = ibm->write(kernbuf);
850 if (ret == 0)
851 ret = count;
853 kfree(kernbuf);
855 return ret;
858 static const struct file_operations dispatch_proc_fops = {
859 .owner = THIS_MODULE,
860 .open = dispatch_proc_open,
861 .read = seq_read,
862 .llseek = seq_lseek,
863 .release = single_release,
864 .write = dispatch_proc_write,
867 static char *next_cmd(char **cmds)
869 char *start = *cmds;
870 char *end;
872 while ((end = strchr(start, ',')) && end == start)
873 start = end + 1;
875 if (!end)
876 return NULL;
878 *end = 0;
879 *cmds = end + 1;
880 return start;
884 /****************************************************************************
885 ****************************************************************************
887 * Device model: input, hwmon and platform
889 ****************************************************************************
890 ****************************************************************************/
892 static struct platform_device *tpacpi_pdev;
893 static struct platform_device *tpacpi_sensors_pdev;
894 static struct device *tpacpi_hwmon;
895 static struct input_dev *tpacpi_inputdev;
896 static struct mutex tpacpi_inputdev_send_mutex;
897 static LIST_HEAD(tpacpi_all_drivers);
899 static int tpacpi_suspend_handler(struct platform_device *pdev,
900 pm_message_t state)
902 struct ibm_struct *ibm, *itmp;
904 list_for_each_entry_safe(ibm, itmp,
905 &tpacpi_all_drivers,
906 all_drivers) {
907 if (ibm->suspend)
908 (ibm->suspend)(state);
911 return 0;
914 static int tpacpi_resume_handler(struct platform_device *pdev)
916 struct ibm_struct *ibm, *itmp;
918 list_for_each_entry_safe(ibm, itmp,
919 &tpacpi_all_drivers,
920 all_drivers) {
921 if (ibm->resume)
922 (ibm->resume)();
925 return 0;
928 static void tpacpi_shutdown_handler(struct platform_device *pdev)
930 struct ibm_struct *ibm, *itmp;
932 list_for_each_entry_safe(ibm, itmp,
933 &tpacpi_all_drivers,
934 all_drivers) {
935 if (ibm->shutdown)
936 (ibm->shutdown)();
940 static struct platform_driver tpacpi_pdriver = {
941 .driver = {
942 .name = TPACPI_DRVR_NAME,
943 .owner = THIS_MODULE,
945 .suspend = tpacpi_suspend_handler,
946 .resume = tpacpi_resume_handler,
947 .shutdown = tpacpi_shutdown_handler,
950 static struct platform_driver tpacpi_hwmon_pdriver = {
951 .driver = {
952 .name = TPACPI_HWMON_DRVR_NAME,
953 .owner = THIS_MODULE,
957 /*************************************************************************
958 * sysfs support helpers
961 struct attribute_set {
962 unsigned int members, max_members;
963 struct attribute_group group;
966 struct attribute_set_obj {
967 struct attribute_set s;
968 struct attribute *a;
969 } __attribute__((packed));
971 static struct attribute_set *create_attr_set(unsigned int max_members,
972 const char *name)
974 struct attribute_set_obj *sobj;
976 if (max_members == 0)
977 return NULL;
979 /* Allocates space for implicit NULL at the end too */
980 sobj = kzalloc(sizeof(struct attribute_set_obj) +
981 max_members * sizeof(struct attribute *),
982 GFP_KERNEL);
983 if (!sobj)
984 return NULL;
985 sobj->s.max_members = max_members;
986 sobj->s.group.attrs = &sobj->a;
987 sobj->s.group.name = name;
989 return &sobj->s;
992 #define destroy_attr_set(_set) \
993 kfree(_set);
995 /* not multi-threaded safe, use it in a single thread per set */
996 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
998 if (!s || !attr)
999 return -EINVAL;
1001 if (s->members >= s->max_members)
1002 return -ENOMEM;
1004 s->group.attrs[s->members] = attr;
1005 s->members++;
1007 return 0;
1010 static int add_many_to_attr_set(struct attribute_set *s,
1011 struct attribute **attr,
1012 unsigned int count)
1014 int i, res;
1016 for (i = 0; i < count; i++) {
1017 res = add_to_attr_set(s, attr[i]);
1018 if (res)
1019 return res;
1022 return 0;
1025 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1027 sysfs_remove_group(kobj, &s->group);
1028 destroy_attr_set(s);
1031 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1032 sysfs_create_group(_kobj, &_attr_set->group)
1034 static int parse_strtoul(const char *buf,
1035 unsigned long max, unsigned long *value)
1037 char *endp;
1039 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1040 endp = skip_spaces(endp);
1041 if (*endp || *value > max)
1042 return -EINVAL;
1044 return 0;
1047 static void tpacpi_disable_brightness_delay(void)
1049 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1050 printk(TPACPI_NOTICE
1051 "ACPI backlight control delay disabled\n");
1054 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
1056 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1057 union acpi_object *obj;
1058 int rc;
1060 if (ACPI_SUCCESS(acpi_evaluate_object(handle, NULL, NULL, &buffer))) {
1061 obj = (union acpi_object *)buffer.pointer;
1062 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
1063 printk(TPACPI_ERR "Unknown _BCL data, "
1064 "please report this to %s\n", TPACPI_MAIL);
1065 rc = 0;
1066 } else {
1067 rc = obj->package.count;
1069 } else {
1070 return 0;
1073 kfree(buffer.pointer);
1074 return rc;
1077 static acpi_status __init tpacpi_acpi_walk_find_bcl(acpi_handle handle,
1078 u32 lvl, void *context, void **rv)
1080 char name[ACPI_PATH_SEGMENT_LENGTH];
1081 struct acpi_buffer buffer = { sizeof(name), &name };
1083 if (ACPI_SUCCESS(acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer)) &&
1084 !strncmp("_BCL", name, sizeof(name) - 1)) {
1085 BUG_ON(!rv || !*rv);
1086 **(int **)rv = tpacpi_query_bcl_levels(handle);
1087 return AE_CTRL_TERMINATE;
1088 } else {
1089 return AE_OK;
1094 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
1096 static int __init tpacpi_check_std_acpi_brightness_support(void)
1098 int status;
1099 int bcl_levels = 0;
1100 void *bcl_ptr = &bcl_levels;
1102 if (!vid_handle) {
1103 TPACPI_ACPIHANDLE_INIT(vid);
1105 if (!vid_handle)
1106 return 0;
1109 * Search for a _BCL method, and execute it. This is safe on all
1110 * ThinkPads, and as a side-effect, _BCL will place a Lenovo Vista
1111 * BIOS in ACPI backlight control mode. We do NOT have to care
1112 * about calling the _BCL method in an enabled video device, any
1113 * will do for our purposes.
1116 status = acpi_walk_namespace(ACPI_TYPE_METHOD, vid_handle, 3,
1117 tpacpi_acpi_walk_find_bcl, NULL, NULL,
1118 &bcl_ptr);
1120 if (ACPI_SUCCESS(status) && bcl_levels > 2) {
1121 tp_features.bright_acpimode = 1;
1122 return (bcl_levels - 2);
1125 return 0;
1128 static void printk_deprecated_attribute(const char * const what,
1129 const char * const details)
1131 tpacpi_log_usertask("deprecated sysfs attribute");
1132 printk(TPACPI_WARN "WARNING: sysfs attribute %s is deprecated and "
1133 "will be removed. %s\n",
1134 what, details);
1137 /*************************************************************************
1138 * rfkill and radio control support helpers
1142 * ThinkPad-ACPI firmware handling model:
1144 * WLSW (master wireless switch) is event-driven, and is common to all
1145 * firmware-controlled radios. It cannot be controlled, just monitored,
1146 * as expected. It overrides all radio state in firmware
1148 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1149 * (TODO: verify how WLSW interacts with the returned radio state).
1151 * The only time there are shadow radio state changes, is when
1152 * masked-off hotkeys are used.
1156 * Internal driver API for radio state:
1158 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1159 * bool: true means radio blocked (off)
1161 enum tpacpi_rfkill_state {
1162 TPACPI_RFK_RADIO_OFF = 0,
1163 TPACPI_RFK_RADIO_ON
1166 /* rfkill switches */
1167 enum tpacpi_rfk_id {
1168 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1169 TPACPI_RFK_WWAN_SW_ID,
1170 TPACPI_RFK_UWB_SW_ID,
1171 TPACPI_RFK_SW_MAX
1174 static const char *tpacpi_rfkill_names[] = {
1175 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1176 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1177 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1178 [TPACPI_RFK_SW_MAX] = NULL
1181 /* ThinkPad-ACPI rfkill subdriver */
1182 struct tpacpi_rfk {
1183 struct rfkill *rfkill;
1184 enum tpacpi_rfk_id id;
1185 const struct tpacpi_rfk_ops *ops;
1188 struct tpacpi_rfk_ops {
1189 /* firmware interface */
1190 int (*get_status)(void);
1191 int (*set_status)(const enum tpacpi_rfkill_state);
1194 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1196 /* Query FW and update rfkill sw state for a given rfkill switch */
1197 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1199 int status;
1201 if (!tp_rfk)
1202 return -ENODEV;
1204 status = (tp_rfk->ops->get_status)();
1205 if (status < 0)
1206 return status;
1208 rfkill_set_sw_state(tp_rfk->rfkill,
1209 (status == TPACPI_RFK_RADIO_OFF));
1211 return status;
1214 /* Query FW and update rfkill sw state for all rfkill switches */
1215 static void tpacpi_rfk_update_swstate_all(void)
1217 unsigned int i;
1219 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1220 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1224 * Sync the HW-blocking state of all rfkill switches,
1225 * do notice it causes the rfkill core to schedule uevents
1227 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1229 unsigned int i;
1230 struct tpacpi_rfk *tp_rfk;
1232 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1233 tp_rfk = tpacpi_rfkill_switches[i];
1234 if (tp_rfk) {
1235 if (rfkill_set_hw_state(tp_rfk->rfkill,
1236 blocked)) {
1237 /* ignore -- we track sw block */
1243 /* Call to get the WLSW state from the firmware */
1244 static int hotkey_get_wlsw(void);
1246 /* Call to query WLSW state and update all rfkill switches */
1247 static bool tpacpi_rfk_check_hwblock_state(void)
1249 int res = hotkey_get_wlsw();
1250 int hw_blocked;
1252 /* When unknown or unsupported, we have to assume it is unblocked */
1253 if (res < 0)
1254 return false;
1256 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1257 tpacpi_rfk_update_hwblock_state(hw_blocked);
1259 return hw_blocked;
1262 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1264 struct tpacpi_rfk *tp_rfk = data;
1265 int res;
1267 dbg_printk(TPACPI_DBG_RFKILL,
1268 "request to change radio state to %s\n",
1269 blocked ? "blocked" : "unblocked");
1271 /* try to set radio state */
1272 res = (tp_rfk->ops->set_status)(blocked ?
1273 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1275 /* and update the rfkill core with whatever the FW really did */
1276 tpacpi_rfk_update_swstate(tp_rfk);
1278 return (res < 0) ? res : 0;
1281 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1282 .set_block = tpacpi_rfk_hook_set_block,
1285 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1286 const struct tpacpi_rfk_ops *tp_rfkops,
1287 const enum rfkill_type rfktype,
1288 const char *name,
1289 const bool set_default)
1291 struct tpacpi_rfk *atp_rfk;
1292 int res;
1293 bool sw_state = false;
1294 bool hw_state;
1295 int sw_status;
1297 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1299 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1300 if (atp_rfk)
1301 atp_rfk->rfkill = rfkill_alloc(name,
1302 &tpacpi_pdev->dev,
1303 rfktype,
1304 &tpacpi_rfk_rfkill_ops,
1305 atp_rfk);
1306 if (!atp_rfk || !atp_rfk->rfkill) {
1307 printk(TPACPI_ERR
1308 "failed to allocate memory for rfkill class\n");
1309 kfree(atp_rfk);
1310 return -ENOMEM;
1313 atp_rfk->id = id;
1314 atp_rfk->ops = tp_rfkops;
1316 sw_status = (tp_rfkops->get_status)();
1317 if (sw_status < 0) {
1318 printk(TPACPI_ERR
1319 "failed to read initial state for %s, error %d\n",
1320 name, sw_status);
1321 } else {
1322 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1323 if (set_default) {
1324 /* try to keep the initial state, since we ask the
1325 * firmware to preserve it across S5 in NVRAM */
1326 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1329 hw_state = tpacpi_rfk_check_hwblock_state();
1330 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1332 res = rfkill_register(atp_rfk->rfkill);
1333 if (res < 0) {
1334 printk(TPACPI_ERR
1335 "failed to register %s rfkill switch: %d\n",
1336 name, res);
1337 rfkill_destroy(atp_rfk->rfkill);
1338 kfree(atp_rfk);
1339 return res;
1342 tpacpi_rfkill_switches[id] = atp_rfk;
1344 printk(TPACPI_INFO "rfkill switch %s: radio is %sblocked\n",
1345 name, (sw_state || hw_state) ? "" : "un");
1346 return 0;
1349 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1351 struct tpacpi_rfk *tp_rfk;
1353 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1355 tp_rfk = tpacpi_rfkill_switches[id];
1356 if (tp_rfk) {
1357 rfkill_unregister(tp_rfk->rfkill);
1358 rfkill_destroy(tp_rfk->rfkill);
1359 tpacpi_rfkill_switches[id] = NULL;
1360 kfree(tp_rfk);
1364 static void printk_deprecated_rfkill_attribute(const char * const what)
1366 printk_deprecated_attribute(what,
1367 "Please switch to generic rfkill before year 2010");
1370 /* sysfs <radio> enable ------------------------------------------------ */
1371 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1372 struct device_attribute *attr,
1373 char *buf)
1375 int status;
1377 printk_deprecated_rfkill_attribute(attr->attr.name);
1379 /* This is in the ABI... */
1380 if (tpacpi_rfk_check_hwblock_state()) {
1381 status = TPACPI_RFK_RADIO_OFF;
1382 } else {
1383 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1384 if (status < 0)
1385 return status;
1388 return snprintf(buf, PAGE_SIZE, "%d\n",
1389 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1392 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1393 struct device_attribute *attr,
1394 const char *buf, size_t count)
1396 unsigned long t;
1397 int res;
1399 printk_deprecated_rfkill_attribute(attr->attr.name);
1401 if (parse_strtoul(buf, 1, &t))
1402 return -EINVAL;
1404 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1406 /* This is in the ABI... */
1407 if (tpacpi_rfk_check_hwblock_state() && !!t)
1408 return -EPERM;
1410 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1411 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1412 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1414 return (res < 0) ? res : count;
1417 /* procfs -------------------------------------------------------------- */
1418 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1420 if (id >= TPACPI_RFK_SW_MAX)
1421 seq_printf(m, "status:\t\tnot supported\n");
1422 else {
1423 int status;
1425 /* This is in the ABI... */
1426 if (tpacpi_rfk_check_hwblock_state()) {
1427 status = TPACPI_RFK_RADIO_OFF;
1428 } else {
1429 status = tpacpi_rfk_update_swstate(
1430 tpacpi_rfkill_switches[id]);
1431 if (status < 0)
1432 return status;
1435 seq_printf(m, "status:\t\t%s\n",
1436 (status == TPACPI_RFK_RADIO_ON) ?
1437 "enabled" : "disabled");
1438 seq_printf(m, "commands:\tenable, disable\n");
1441 return 0;
1444 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1446 char *cmd;
1447 int status = -1;
1448 int res = 0;
1450 if (id >= TPACPI_RFK_SW_MAX)
1451 return -ENODEV;
1453 while ((cmd = next_cmd(&buf))) {
1454 if (strlencmp(cmd, "enable") == 0)
1455 status = TPACPI_RFK_RADIO_ON;
1456 else if (strlencmp(cmd, "disable") == 0)
1457 status = TPACPI_RFK_RADIO_OFF;
1458 else
1459 return -EINVAL;
1462 if (status != -1) {
1463 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1464 (status == TPACPI_RFK_RADIO_ON) ?
1465 "enable" : "disable",
1466 tpacpi_rfkill_names[id]);
1467 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1468 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1471 return res;
1474 /*************************************************************************
1475 * thinkpad-acpi driver attributes
1478 /* interface_version --------------------------------------------------- */
1479 static ssize_t tpacpi_driver_interface_version_show(
1480 struct device_driver *drv,
1481 char *buf)
1483 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1486 static DRIVER_ATTR(interface_version, S_IRUGO,
1487 tpacpi_driver_interface_version_show, NULL);
1489 /* debug_level --------------------------------------------------------- */
1490 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1491 char *buf)
1493 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1496 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1497 const char *buf, size_t count)
1499 unsigned long t;
1501 if (parse_strtoul(buf, 0xffff, &t))
1502 return -EINVAL;
1504 dbg_level = t;
1506 return count;
1509 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1510 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1512 /* version ------------------------------------------------------------- */
1513 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1514 char *buf)
1516 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1517 TPACPI_DESC, TPACPI_VERSION);
1520 static DRIVER_ATTR(version, S_IRUGO,
1521 tpacpi_driver_version_show, NULL);
1523 /* --------------------------------------------------------------------- */
1525 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1527 /* wlsw_emulstate ------------------------------------------------------ */
1528 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1529 char *buf)
1531 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1534 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1535 const char *buf, size_t count)
1537 unsigned long t;
1539 if (parse_strtoul(buf, 1, &t))
1540 return -EINVAL;
1542 if (tpacpi_wlsw_emulstate != !!t) {
1543 tpacpi_wlsw_emulstate = !!t;
1544 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1547 return count;
1550 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1551 tpacpi_driver_wlsw_emulstate_show,
1552 tpacpi_driver_wlsw_emulstate_store);
1554 /* bluetooth_emulstate ------------------------------------------------- */
1555 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1556 struct device_driver *drv,
1557 char *buf)
1559 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1562 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1563 struct device_driver *drv,
1564 const char *buf, size_t count)
1566 unsigned long t;
1568 if (parse_strtoul(buf, 1, &t))
1569 return -EINVAL;
1571 tpacpi_bluetooth_emulstate = !!t;
1573 return count;
1576 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1577 tpacpi_driver_bluetooth_emulstate_show,
1578 tpacpi_driver_bluetooth_emulstate_store);
1580 /* wwan_emulstate ------------------------------------------------- */
1581 static ssize_t tpacpi_driver_wwan_emulstate_show(
1582 struct device_driver *drv,
1583 char *buf)
1585 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1588 static ssize_t tpacpi_driver_wwan_emulstate_store(
1589 struct device_driver *drv,
1590 const char *buf, size_t count)
1592 unsigned long t;
1594 if (parse_strtoul(buf, 1, &t))
1595 return -EINVAL;
1597 tpacpi_wwan_emulstate = !!t;
1599 return count;
1602 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1603 tpacpi_driver_wwan_emulstate_show,
1604 tpacpi_driver_wwan_emulstate_store);
1606 /* uwb_emulstate ------------------------------------------------- */
1607 static ssize_t tpacpi_driver_uwb_emulstate_show(
1608 struct device_driver *drv,
1609 char *buf)
1611 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1614 static ssize_t tpacpi_driver_uwb_emulstate_store(
1615 struct device_driver *drv,
1616 const char *buf, size_t count)
1618 unsigned long t;
1620 if (parse_strtoul(buf, 1, &t))
1621 return -EINVAL;
1623 tpacpi_uwb_emulstate = !!t;
1625 return count;
1628 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1629 tpacpi_driver_uwb_emulstate_show,
1630 tpacpi_driver_uwb_emulstate_store);
1631 #endif
1633 /* --------------------------------------------------------------------- */
1635 static struct driver_attribute *tpacpi_driver_attributes[] = {
1636 &driver_attr_debug_level, &driver_attr_version,
1637 &driver_attr_interface_version,
1640 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1642 int i, res;
1644 i = 0;
1645 res = 0;
1646 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1647 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1648 i++;
1651 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1652 if (!res && dbg_wlswemul)
1653 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1654 if (!res && dbg_bluetoothemul)
1655 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1656 if (!res && dbg_wwanemul)
1657 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1658 if (!res && dbg_uwbemul)
1659 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1660 #endif
1662 return res;
1665 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1667 int i;
1669 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1670 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1672 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1673 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1674 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1675 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1676 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1677 #endif
1680 /*************************************************************************
1681 * Firmware Data
1685 * Table of recommended minimum BIOS versions
1687 * Reasons for listing:
1688 * 1. Stable BIOS, listed because the unknown amount of
1689 * bugs and bad ACPI behaviour on older versions
1691 * 2. BIOS or EC fw with known bugs that trigger on Linux
1693 * 3. BIOS with known reduced functionality in older versions
1695 * We recommend the latest BIOS and EC version.
1696 * We only support the latest BIOS and EC fw version as a rule.
1698 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1699 * Information from users in ThinkWiki
1701 * WARNING: we use this table also to detect that the machine is
1702 * a ThinkPad in some cases, so don't remove entries lightly.
1705 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1706 { .vendor = (__v), \
1707 .bios = TPID(__id1, __id2), \
1708 .ec = TPACPI_MATCH_ANY, \
1709 .quirks = TPACPI_MATCH_ANY << 16 \
1710 | (__bv1) << 8 | (__bv2) }
1712 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1713 __eid, __ev1, __ev2) \
1714 { .vendor = (__v), \
1715 .bios = TPID(__bid1, __bid2), \
1716 .ec = __eid, \
1717 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1718 | (__bv1) << 8 | (__bv2) }
1720 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1721 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1723 /* Outdated IBM BIOSes often lack the EC id string */
1724 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1725 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1726 __bv1, __bv2, TPID(__id1, __id2), \
1727 __ev1, __ev2), \
1728 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1729 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1730 __ev1, __ev2)
1732 /* Outdated IBM BIOSes often lack the EC id string */
1733 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1734 __eid1, __eid2, __ev1, __ev2) \
1735 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1736 __bv1, __bv2, TPID(__eid1, __eid2), \
1737 __ev1, __ev2), \
1738 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1739 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1740 __ev1, __ev2)
1742 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1743 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1745 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1746 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1747 __bv1, __bv2, TPID(__id1, __id2), \
1748 __ev1, __ev2)
1750 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1751 __eid1, __eid2, __ev1, __ev2) \
1752 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1753 __bv1, __bv2, TPID(__eid1, __eid2), \
1754 __ev1, __ev2)
1756 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1757 /* Numeric models ------------------ */
1758 /* FW MODEL BIOS VERS */
1759 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1760 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1761 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1762 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1763 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1764 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1765 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1766 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1767 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1769 /* A-series ------------------------- */
1770 /* FW MODEL BIOS VERS EC VERS */
1771 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1772 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1773 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1774 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1775 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1776 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1777 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1778 TPV_QI0('1', '3', '2', '0'), /* A22m */
1779 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1780 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1781 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1783 /* G-series ------------------------- */
1784 /* FW MODEL BIOS VERS */
1785 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1786 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1788 /* R-series, T-series --------------- */
1789 /* FW MODEL BIOS VERS EC VERS */
1790 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1791 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1792 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1793 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1794 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1795 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1796 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1797 T40/p, T41/p, T42/p (1) */
1798 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1799 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1800 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1801 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1803 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1804 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1805 TPV_QI0('1', '6', '3', '2'), /* T22 */
1806 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1807 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1808 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1810 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1811 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1812 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1814 /* BIOS FW BIOS VERS EC FW EC VERS */
1815 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1816 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1818 /* X-series ------------------------- */
1819 /* FW MODEL BIOS VERS EC VERS */
1820 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1821 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1822 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1823 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1824 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1825 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1826 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1828 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1829 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1831 /* (0) - older versions lack DMI EC fw string and functionality */
1832 /* (1) - older versions known to lack functionality */
1835 #undef TPV_QL1
1836 #undef TPV_QL0
1837 #undef TPV_QI2
1838 #undef TPV_QI1
1839 #undef TPV_QI0
1840 #undef TPV_Q_X
1841 #undef TPV_Q
1843 static void __init tpacpi_check_outdated_fw(void)
1845 unsigned long fwvers;
1846 u16 ec_version, bios_version;
1848 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1849 ARRAY_SIZE(tpacpi_bios_version_qtable));
1851 if (!fwvers)
1852 return;
1854 bios_version = fwvers & 0xffffU;
1855 ec_version = (fwvers >> 16) & 0xffffU;
1857 /* note that unknown versions are set to 0x0000 and we use that */
1858 if ((bios_version > thinkpad_id.bios_release) ||
1859 (ec_version > thinkpad_id.ec_release &&
1860 ec_version != TPACPI_MATCH_ANY)) {
1862 * The changelogs would let us track down the exact
1863 * reason, but it is just too much of a pain to track
1864 * it. We only list BIOSes that are either really
1865 * broken, or really stable to begin with, so it is
1866 * best if the user upgrades the firmware anyway.
1868 printk(TPACPI_WARN
1869 "WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1870 printk(TPACPI_WARN
1871 "WARNING: This firmware may be missing critical bug "
1872 "fixes and/or important features\n");
1876 static bool __init tpacpi_is_fw_known(void)
1878 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1879 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1882 /****************************************************************************
1883 ****************************************************************************
1885 * Subdrivers
1887 ****************************************************************************
1888 ****************************************************************************/
1890 /*************************************************************************
1891 * thinkpad-acpi init subdriver
1894 static int __init thinkpad_acpi_driver_init(struct ibm_init_struct *iibm)
1896 printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
1897 printk(TPACPI_INFO "%s\n", TPACPI_URL);
1899 printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
1900 (thinkpad_id.bios_version_str) ?
1901 thinkpad_id.bios_version_str : "unknown",
1902 (thinkpad_id.ec_version_str) ?
1903 thinkpad_id.ec_version_str : "unknown");
1905 BUG_ON(!thinkpad_id.vendor);
1907 if (thinkpad_id.model_str)
1908 printk(TPACPI_INFO "%s %s, model %s\n",
1909 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
1910 "IBM" : ((thinkpad_id.vendor ==
1911 PCI_VENDOR_ID_LENOVO) ?
1912 "Lenovo" : "Unknown vendor"),
1913 thinkpad_id.model_str,
1914 (thinkpad_id.nummodel_str) ?
1915 thinkpad_id.nummodel_str : "unknown");
1917 tpacpi_check_outdated_fw();
1918 return 0;
1921 static int thinkpad_acpi_driver_read(struct seq_file *m)
1923 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1924 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1925 return 0;
1928 static struct ibm_struct thinkpad_acpi_driver_data = {
1929 .name = "driver",
1930 .read = thinkpad_acpi_driver_read,
1933 /*************************************************************************
1934 * Hotkey subdriver
1938 * ThinkPad firmware event model
1940 * The ThinkPad firmware has two main event interfaces: normal ACPI
1941 * notifications (which follow the ACPI standard), and a private event
1942 * interface.
1944 * The private event interface also issues events for the hotkeys. As
1945 * the driver gained features, the event handling code ended up being
1946 * built around the hotkey subdriver. This will need to be refactored
1947 * to a more formal event API eventually.
1949 * Some "hotkeys" are actually supposed to be used as event reports,
1950 * such as "brightness has changed", "volume has changed", depending on
1951 * the ThinkPad model and how the firmware is operating.
1953 * Unlike other classes, hotkey-class events have mask/unmask control on
1954 * non-ancient firmware. However, how it behaves changes a lot with the
1955 * firmware model and version.
1958 enum { /* hot key scan codes (derived from ACPI DSDT) */
1959 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1960 TP_ACPI_HOTKEYSCAN_FNF2,
1961 TP_ACPI_HOTKEYSCAN_FNF3,
1962 TP_ACPI_HOTKEYSCAN_FNF4,
1963 TP_ACPI_HOTKEYSCAN_FNF5,
1964 TP_ACPI_HOTKEYSCAN_FNF6,
1965 TP_ACPI_HOTKEYSCAN_FNF7,
1966 TP_ACPI_HOTKEYSCAN_FNF8,
1967 TP_ACPI_HOTKEYSCAN_FNF9,
1968 TP_ACPI_HOTKEYSCAN_FNF10,
1969 TP_ACPI_HOTKEYSCAN_FNF11,
1970 TP_ACPI_HOTKEYSCAN_FNF12,
1971 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1972 TP_ACPI_HOTKEYSCAN_FNINSERT,
1973 TP_ACPI_HOTKEYSCAN_FNDELETE,
1974 TP_ACPI_HOTKEYSCAN_FNHOME,
1975 TP_ACPI_HOTKEYSCAN_FNEND,
1976 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1977 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1978 TP_ACPI_HOTKEYSCAN_FNSPACE,
1979 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1980 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1981 TP_ACPI_HOTKEYSCAN_MUTE,
1982 TP_ACPI_HOTKEYSCAN_THINKPAD,
1985 enum { /* Keys/events available through NVRAM polling */
1986 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1987 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1990 enum { /* Positions of some of the keys in hotkey masks */
1991 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1992 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1993 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1994 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1995 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1996 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1997 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1998 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1999 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
2000 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
2001 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
2004 enum { /* NVRAM to ACPI HKEY group map */
2005 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
2006 TP_ACPI_HKEY_ZOOM_MASK |
2007 TP_ACPI_HKEY_DISPSWTCH_MASK |
2008 TP_ACPI_HKEY_HIBERNATE_MASK,
2009 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
2010 TP_ACPI_HKEY_BRGHTDWN_MASK,
2011 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
2012 TP_ACPI_HKEY_VOLDWN_MASK |
2013 TP_ACPI_HKEY_MUTE_MASK,
2016 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2017 struct tp_nvram_state {
2018 u16 thinkpad_toggle:1;
2019 u16 zoom_toggle:1;
2020 u16 display_toggle:1;
2021 u16 thinklight_toggle:1;
2022 u16 hibernate_toggle:1;
2023 u16 displayexp_toggle:1;
2024 u16 display_state:1;
2025 u16 brightness_toggle:1;
2026 u16 volume_toggle:1;
2027 u16 mute:1;
2029 u8 brightness_level;
2030 u8 volume_level;
2033 /* kthread for the hotkey poller */
2034 static struct task_struct *tpacpi_hotkey_task;
2036 /* Acquired while the poller kthread is running, use to sync start/stop */
2037 static struct mutex hotkey_thread_mutex;
2040 * Acquire mutex to write poller control variables as an
2041 * atomic block.
2043 * Increment hotkey_config_change when changing them if you
2044 * want the kthread to forget old state.
2046 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2048 static struct mutex hotkey_thread_data_mutex;
2049 static unsigned int hotkey_config_change;
2052 * hotkey poller control variables
2054 * Must be atomic or readers will also need to acquire mutex
2056 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2057 * should be used only when the changes need to be taken as
2058 * a block, OR when one needs to force the kthread to forget
2059 * old state.
2061 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2062 static unsigned int hotkey_poll_freq = 10; /* Hz */
2064 #define HOTKEY_CONFIG_CRITICAL_START \
2065 do { \
2066 mutex_lock(&hotkey_thread_data_mutex); \
2067 hotkey_config_change++; \
2068 } while (0);
2069 #define HOTKEY_CONFIG_CRITICAL_END \
2070 mutex_unlock(&hotkey_thread_data_mutex);
2072 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2074 #define hotkey_source_mask 0U
2075 #define HOTKEY_CONFIG_CRITICAL_START
2076 #define HOTKEY_CONFIG_CRITICAL_END
2078 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2080 static struct mutex hotkey_mutex;
2082 static enum { /* Reasons for waking up */
2083 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2084 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2085 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2086 } hotkey_wakeup_reason;
2088 static int hotkey_autosleep_ack;
2090 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2091 static u32 hotkey_all_mask; /* all events supported in fw */
2092 static u32 hotkey_reserved_mask; /* events better left disabled */
2093 static u32 hotkey_driver_mask; /* events needed by the driver */
2094 static u32 hotkey_user_mask; /* events visible to userspace */
2095 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2097 static unsigned int hotkey_report_mode;
2099 static u16 *hotkey_keycode_map;
2101 static struct attribute_set *hotkey_dev_attributes;
2103 static void tpacpi_driver_event(const unsigned int hkey_event);
2104 static void hotkey_driver_event(const unsigned int scancode);
2105 static void hotkey_poll_setup(const bool may_warn);
2107 /* HKEY.MHKG() return bits */
2108 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2110 static int hotkey_get_wlsw(void)
2112 int status;
2114 if (!tp_features.hotkey_wlsw)
2115 return -ENODEV;
2117 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2118 if (dbg_wlswemul)
2119 return (tpacpi_wlsw_emulstate) ?
2120 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2121 #endif
2123 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2124 return -EIO;
2126 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2129 static int hotkey_get_tablet_mode(int *status)
2131 int s;
2133 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2134 return -EIO;
2136 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2137 return 0;
2141 * Reads current event mask from firmware, and updates
2142 * hotkey_acpi_mask accordingly. Also resets any bits
2143 * from hotkey_user_mask that are unavailable to be
2144 * delivered (shadow requirement of the userspace ABI).
2146 * Call with hotkey_mutex held
2148 static int hotkey_mask_get(void)
2150 if (tp_features.hotkey_mask) {
2151 u32 m = 0;
2153 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2154 return -EIO;
2156 hotkey_acpi_mask = m;
2157 } else {
2158 /* no mask support doesn't mean no event support... */
2159 hotkey_acpi_mask = hotkey_all_mask;
2162 /* sync userspace-visible mask */
2163 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2165 return 0;
2168 void static hotkey_mask_warn_incomplete_mask(void)
2170 /* log only what the user can fix... */
2171 const u32 wantedmask = hotkey_driver_mask &
2172 ~(hotkey_acpi_mask | hotkey_source_mask) &
2173 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2175 if (wantedmask)
2176 printk(TPACPI_NOTICE
2177 "required events 0x%08x not enabled!\n",
2178 wantedmask);
2182 * Set the firmware mask when supported
2184 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2186 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2188 * Call with hotkey_mutex held
2190 static int hotkey_mask_set(u32 mask)
2192 int i;
2193 int rc = 0;
2195 const u32 fwmask = mask & ~hotkey_source_mask;
2197 if (tp_features.hotkey_mask) {
2198 for (i = 0; i < 32; i++) {
2199 if (!acpi_evalf(hkey_handle,
2200 NULL, "MHKM", "vdd", i + 1,
2201 !!(mask & (1 << i)))) {
2202 rc = -EIO;
2203 break;
2209 * We *must* make an inconditional call to hotkey_mask_get to
2210 * refresh hotkey_acpi_mask and update hotkey_user_mask
2212 * Take the opportunity to also log when we cannot _enable_
2213 * a given event.
2215 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2216 printk(TPACPI_NOTICE
2217 "asked for hotkey mask 0x%08x, but "
2218 "firmware forced it to 0x%08x\n",
2219 fwmask, hotkey_acpi_mask);
2222 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2223 hotkey_mask_warn_incomplete_mask();
2225 return rc;
2229 * Sets hotkey_user_mask and tries to set the firmware mask
2231 * Call with hotkey_mutex held
2233 static int hotkey_user_mask_set(const u32 mask)
2235 int rc;
2237 /* Give people a chance to notice they are doing something that
2238 * is bound to go boom on their users sooner or later */
2239 if (!tp_warned.hotkey_mask_ff &&
2240 (mask == 0xffff || mask == 0xffffff ||
2241 mask == 0xffffffff)) {
2242 tp_warned.hotkey_mask_ff = 1;
2243 printk(TPACPI_NOTICE
2244 "setting the hotkey mask to 0x%08x is likely "
2245 "not the best way to go about it\n", mask);
2246 printk(TPACPI_NOTICE
2247 "please consider using the driver defaults, "
2248 "and refer to up-to-date thinkpad-acpi "
2249 "documentation\n");
2252 /* Try to enable what the user asked for, plus whatever we need.
2253 * this syncs everything but won't enable bits in hotkey_user_mask */
2254 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2256 /* Enable the available bits in hotkey_user_mask */
2257 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2259 return rc;
2263 * Sets the driver hotkey mask.
2265 * Can be called even if the hotkey subdriver is inactive
2267 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2269 int rc;
2271 /* Do the right thing if hotkey_init has not been called yet */
2272 if (!tp_features.hotkey) {
2273 hotkey_driver_mask = mask;
2274 return 0;
2277 mutex_lock(&hotkey_mutex);
2279 HOTKEY_CONFIG_CRITICAL_START
2280 hotkey_driver_mask = mask;
2281 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2282 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2283 #endif
2284 HOTKEY_CONFIG_CRITICAL_END
2286 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2287 ~hotkey_source_mask);
2288 hotkey_poll_setup(true);
2290 mutex_unlock(&hotkey_mutex);
2292 return rc;
2295 static int hotkey_status_get(int *status)
2297 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2298 return -EIO;
2300 return 0;
2303 static int hotkey_status_set(bool enable)
2305 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2306 return -EIO;
2308 return 0;
2311 static void tpacpi_input_send_tabletsw(void)
2313 int state;
2315 if (tp_features.hotkey_tablet &&
2316 !hotkey_get_tablet_mode(&state)) {
2317 mutex_lock(&tpacpi_inputdev_send_mutex);
2319 input_report_switch(tpacpi_inputdev,
2320 SW_TABLET_MODE, !!state);
2321 input_sync(tpacpi_inputdev);
2323 mutex_unlock(&tpacpi_inputdev_send_mutex);
2327 /* Do NOT call without validating scancode first */
2328 static void tpacpi_input_send_key(const unsigned int scancode)
2330 const unsigned int keycode = hotkey_keycode_map[scancode];
2332 if (keycode != KEY_RESERVED) {
2333 mutex_lock(&tpacpi_inputdev_send_mutex);
2335 input_report_key(tpacpi_inputdev, keycode, 1);
2336 if (keycode == KEY_UNKNOWN)
2337 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2338 scancode);
2339 input_sync(tpacpi_inputdev);
2341 input_report_key(tpacpi_inputdev, keycode, 0);
2342 if (keycode == KEY_UNKNOWN)
2343 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2344 scancode);
2345 input_sync(tpacpi_inputdev);
2347 mutex_unlock(&tpacpi_inputdev_send_mutex);
2351 /* Do NOT call without validating scancode first */
2352 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2354 hotkey_driver_event(scancode);
2355 if (hotkey_user_mask & (1 << scancode))
2356 tpacpi_input_send_key(scancode);
2359 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2360 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2362 /* Do NOT call without validating scancode first */
2363 static void tpacpi_hotkey_send_key(unsigned int scancode)
2365 tpacpi_input_send_key_masked(scancode);
2366 if (hotkey_report_mode < 2) {
2367 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2368 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2372 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2374 u8 d;
2376 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2377 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2378 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2379 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2380 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2381 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2383 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2384 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2385 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2387 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2388 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2389 n->displayexp_toggle =
2390 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2392 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2393 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2394 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2395 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2396 n->brightness_toggle =
2397 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2399 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2400 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2401 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2402 >> TP_NVRAM_POS_LEVEL_VOLUME;
2403 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2404 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2408 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2409 struct tp_nvram_state *newn,
2410 const u32 event_mask)
2413 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2414 do { \
2415 if ((event_mask & (1 << __scancode)) && \
2416 oldn->__member != newn->__member) \
2417 tpacpi_hotkey_send_key(__scancode); \
2418 } while (0)
2420 #define TPACPI_MAY_SEND_KEY(__scancode) \
2421 do { \
2422 if (event_mask & (1 << __scancode)) \
2423 tpacpi_hotkey_send_key(__scancode); \
2424 } while (0)
2426 void issue_volchange(const unsigned int oldvol,
2427 const unsigned int newvol)
2429 unsigned int i = oldvol;
2431 while (i > newvol) {
2432 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2433 i--;
2435 while (i < newvol) {
2436 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2437 i++;
2441 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2442 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2443 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2444 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2446 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2448 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2451 * Handle volume
2453 * This code is supposed to duplicate the IBM firmware behaviour:
2454 * - Pressing MUTE issues mute hotkey message, even when already mute
2455 * - Pressing Volume up/down issues volume up/down hotkey messages,
2456 * even when already at maximum or minumum volume
2457 * - The act of unmuting issues volume up/down notification,
2458 * depending which key was used to unmute
2460 * We are constrained to what the NVRAM can tell us, which is not much
2461 * and certainly not enough if more than one volume hotkey was pressed
2462 * since the last poll cycle.
2464 * Just to make our life interesting, some newer Lenovo ThinkPads have
2465 * bugs in the BIOS and may fail to update volume_toggle properly.
2467 if (newn->mute) {
2468 /* muted */
2469 if (!oldn->mute ||
2470 oldn->volume_toggle != newn->volume_toggle ||
2471 oldn->volume_level != newn->volume_level) {
2472 /* recently muted, or repeated mute keypress, or
2473 * multiple presses ending in mute */
2474 issue_volchange(oldn->volume_level, newn->volume_level);
2475 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2477 } else {
2478 /* unmute */
2479 if (oldn->mute) {
2480 /* recently unmuted, issue 'unmute' keypress */
2481 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2483 if (oldn->volume_level != newn->volume_level) {
2484 issue_volchange(oldn->volume_level, newn->volume_level);
2485 } else if (oldn->volume_toggle != newn->volume_toggle) {
2486 /* repeated vol up/down keypress at end of scale ? */
2487 if (newn->volume_level == 0)
2488 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2489 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2490 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2494 /* handle brightness */
2495 if (oldn->brightness_toggle != newn->brightness_toggle) {
2496 if (oldn->brightness_level < newn->brightness_level) {
2497 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2498 } else if (oldn->brightness_level > newn->brightness_level) {
2499 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2500 } else {
2501 /* repeated key presses that didn't change state */
2502 if (newn->brightness_level != 0) {
2503 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2504 } else {
2505 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2510 #undef TPACPI_COMPARE_KEY
2511 #undef TPACPI_MAY_SEND_KEY
2515 * Polling driver
2517 * We track all events in hotkey_source_mask all the time, since
2518 * most of them are edge-based. We only issue those requested by
2519 * hotkey_user_mask or hotkey_driver_mask, though.
2521 static int hotkey_kthread(void *data)
2523 struct tp_nvram_state s[2];
2524 u32 poll_mask, event_mask;
2525 unsigned int si, so;
2526 unsigned long t;
2527 unsigned int change_detector, must_reset;
2528 unsigned int poll_freq;
2530 mutex_lock(&hotkey_thread_mutex);
2532 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2533 goto exit;
2535 set_freezable();
2537 so = 0;
2538 si = 1;
2539 t = 0;
2541 /* Initial state for compares */
2542 mutex_lock(&hotkey_thread_data_mutex);
2543 change_detector = hotkey_config_change;
2544 poll_mask = hotkey_source_mask;
2545 event_mask = hotkey_source_mask &
2546 (hotkey_driver_mask | hotkey_user_mask);
2547 poll_freq = hotkey_poll_freq;
2548 mutex_unlock(&hotkey_thread_data_mutex);
2549 hotkey_read_nvram(&s[so], poll_mask);
2551 while (!kthread_should_stop()) {
2552 if (t == 0) {
2553 if (likely(poll_freq))
2554 t = 1000/poll_freq;
2555 else
2556 t = 100; /* should never happen... */
2558 t = msleep_interruptible(t);
2559 if (unlikely(kthread_should_stop()))
2560 break;
2561 must_reset = try_to_freeze();
2562 if (t > 0 && !must_reset)
2563 continue;
2565 mutex_lock(&hotkey_thread_data_mutex);
2566 if (must_reset || hotkey_config_change != change_detector) {
2567 /* forget old state on thaw or config change */
2568 si = so;
2569 t = 0;
2570 change_detector = hotkey_config_change;
2572 poll_mask = hotkey_source_mask;
2573 event_mask = hotkey_source_mask &
2574 (hotkey_driver_mask | hotkey_user_mask);
2575 poll_freq = hotkey_poll_freq;
2576 mutex_unlock(&hotkey_thread_data_mutex);
2578 if (likely(poll_mask)) {
2579 hotkey_read_nvram(&s[si], poll_mask);
2580 if (likely(si != so)) {
2581 hotkey_compare_and_issue_event(&s[so], &s[si],
2582 event_mask);
2586 so = si;
2587 si ^= 1;
2590 exit:
2591 mutex_unlock(&hotkey_thread_mutex);
2592 return 0;
2595 /* call with hotkey_mutex held */
2596 static void hotkey_poll_stop_sync(void)
2598 if (tpacpi_hotkey_task) {
2599 if (frozen(tpacpi_hotkey_task) ||
2600 freezing(tpacpi_hotkey_task))
2601 thaw_process(tpacpi_hotkey_task);
2603 kthread_stop(tpacpi_hotkey_task);
2604 tpacpi_hotkey_task = NULL;
2605 mutex_lock(&hotkey_thread_mutex);
2606 /* at this point, the thread did exit */
2607 mutex_unlock(&hotkey_thread_mutex);
2611 /* call with hotkey_mutex held */
2612 static void hotkey_poll_setup(const bool may_warn)
2614 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2615 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2617 if (hotkey_poll_freq > 0 &&
2618 (poll_driver_mask ||
2619 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2620 if (!tpacpi_hotkey_task) {
2621 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2622 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2623 if (IS_ERR(tpacpi_hotkey_task)) {
2624 tpacpi_hotkey_task = NULL;
2625 printk(TPACPI_ERR
2626 "could not create kernel thread "
2627 "for hotkey polling\n");
2630 } else {
2631 hotkey_poll_stop_sync();
2632 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2633 hotkey_poll_freq == 0) {
2634 printk(TPACPI_NOTICE
2635 "hot keys 0x%08x and/or events 0x%08x "
2636 "require polling, which is currently "
2637 "disabled\n",
2638 poll_user_mask, poll_driver_mask);
2643 static void hotkey_poll_setup_safe(const bool may_warn)
2645 mutex_lock(&hotkey_mutex);
2646 hotkey_poll_setup(may_warn);
2647 mutex_unlock(&hotkey_mutex);
2650 /* call with hotkey_mutex held */
2651 static void hotkey_poll_set_freq(unsigned int freq)
2653 if (!freq)
2654 hotkey_poll_stop_sync();
2656 hotkey_poll_freq = freq;
2659 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2661 static void hotkey_poll_setup(const bool __unused)
2665 static void hotkey_poll_setup_safe(const bool __unused)
2669 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2671 static int hotkey_inputdev_open(struct input_dev *dev)
2673 switch (tpacpi_lifecycle) {
2674 case TPACPI_LIFE_INIT:
2675 case TPACPI_LIFE_RUNNING:
2676 hotkey_poll_setup_safe(false);
2677 return 0;
2678 case TPACPI_LIFE_EXITING:
2679 return -EBUSY;
2682 /* Should only happen if tpacpi_lifecycle is corrupt */
2683 BUG();
2684 return -EBUSY;
2687 static void hotkey_inputdev_close(struct input_dev *dev)
2689 /* disable hotkey polling when possible */
2690 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2691 !(hotkey_source_mask & hotkey_driver_mask))
2692 hotkey_poll_setup_safe(false);
2695 /* sysfs hotkey enable ------------------------------------------------- */
2696 static ssize_t hotkey_enable_show(struct device *dev,
2697 struct device_attribute *attr,
2698 char *buf)
2700 int res, status;
2702 printk_deprecated_attribute("hotkey_enable",
2703 "Hotkey reporting is always enabled");
2705 res = hotkey_status_get(&status);
2706 if (res)
2707 return res;
2709 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2712 static ssize_t hotkey_enable_store(struct device *dev,
2713 struct device_attribute *attr,
2714 const char *buf, size_t count)
2716 unsigned long t;
2718 printk_deprecated_attribute("hotkey_enable",
2719 "Hotkeys can be disabled through hotkey_mask");
2721 if (parse_strtoul(buf, 1, &t))
2722 return -EINVAL;
2724 if (t == 0)
2725 return -EPERM;
2727 return count;
2730 static struct device_attribute dev_attr_hotkey_enable =
2731 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2732 hotkey_enable_show, hotkey_enable_store);
2734 /* sysfs hotkey mask --------------------------------------------------- */
2735 static ssize_t hotkey_mask_show(struct device *dev,
2736 struct device_attribute *attr,
2737 char *buf)
2739 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2742 static ssize_t hotkey_mask_store(struct device *dev,
2743 struct device_attribute *attr,
2744 const char *buf, size_t count)
2746 unsigned long t;
2747 int res;
2749 if (parse_strtoul(buf, 0xffffffffUL, &t))
2750 return -EINVAL;
2752 if (mutex_lock_killable(&hotkey_mutex))
2753 return -ERESTARTSYS;
2755 res = hotkey_user_mask_set(t);
2757 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2758 hotkey_poll_setup(true);
2759 #endif
2761 mutex_unlock(&hotkey_mutex);
2763 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2765 return (res) ? res : count;
2768 static struct device_attribute dev_attr_hotkey_mask =
2769 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2770 hotkey_mask_show, hotkey_mask_store);
2772 /* sysfs hotkey bios_enabled ------------------------------------------- */
2773 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2774 struct device_attribute *attr,
2775 char *buf)
2777 return sprintf(buf, "0\n");
2780 static struct device_attribute dev_attr_hotkey_bios_enabled =
2781 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2783 /* sysfs hotkey bios_mask ---------------------------------------------- */
2784 static ssize_t hotkey_bios_mask_show(struct device *dev,
2785 struct device_attribute *attr,
2786 char *buf)
2788 printk_deprecated_attribute("hotkey_bios_mask",
2789 "This attribute is useless.");
2790 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2793 static struct device_attribute dev_attr_hotkey_bios_mask =
2794 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2796 /* sysfs hotkey all_mask ----------------------------------------------- */
2797 static ssize_t hotkey_all_mask_show(struct device *dev,
2798 struct device_attribute *attr,
2799 char *buf)
2801 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2802 hotkey_all_mask | hotkey_source_mask);
2805 static struct device_attribute dev_attr_hotkey_all_mask =
2806 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2808 /* sysfs hotkey recommended_mask --------------------------------------- */
2809 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2810 struct device_attribute *attr,
2811 char *buf)
2813 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2814 (hotkey_all_mask | hotkey_source_mask)
2815 & ~hotkey_reserved_mask);
2818 static struct device_attribute dev_attr_hotkey_recommended_mask =
2819 __ATTR(hotkey_recommended_mask, S_IRUGO,
2820 hotkey_recommended_mask_show, NULL);
2822 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2824 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2825 static ssize_t hotkey_source_mask_show(struct device *dev,
2826 struct device_attribute *attr,
2827 char *buf)
2829 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2832 static ssize_t hotkey_source_mask_store(struct device *dev,
2833 struct device_attribute *attr,
2834 const char *buf, size_t count)
2836 unsigned long t;
2837 u32 r_ev;
2838 int rc;
2840 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2841 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2842 return -EINVAL;
2844 if (mutex_lock_killable(&hotkey_mutex))
2845 return -ERESTARTSYS;
2847 HOTKEY_CONFIG_CRITICAL_START
2848 hotkey_source_mask = t;
2849 HOTKEY_CONFIG_CRITICAL_END
2851 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2852 ~hotkey_source_mask);
2853 hotkey_poll_setup(true);
2855 /* check if events needed by the driver got disabled */
2856 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2857 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2859 mutex_unlock(&hotkey_mutex);
2861 if (rc < 0)
2862 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2863 "firmware event mask!\n");
2865 if (r_ev)
2866 printk(TPACPI_NOTICE "hotkey_source_mask: "
2867 "some important events were disabled: "
2868 "0x%04x\n", r_ev);
2870 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2872 return (rc < 0) ? rc : count;
2875 static struct device_attribute dev_attr_hotkey_source_mask =
2876 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2877 hotkey_source_mask_show, hotkey_source_mask_store);
2879 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2880 static ssize_t hotkey_poll_freq_show(struct device *dev,
2881 struct device_attribute *attr,
2882 char *buf)
2884 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2887 static ssize_t hotkey_poll_freq_store(struct device *dev,
2888 struct device_attribute *attr,
2889 const char *buf, size_t count)
2891 unsigned long t;
2893 if (parse_strtoul(buf, 25, &t))
2894 return -EINVAL;
2896 if (mutex_lock_killable(&hotkey_mutex))
2897 return -ERESTARTSYS;
2899 hotkey_poll_set_freq(t);
2900 hotkey_poll_setup(true);
2902 mutex_unlock(&hotkey_mutex);
2904 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2906 return count;
2909 static struct device_attribute dev_attr_hotkey_poll_freq =
2910 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2911 hotkey_poll_freq_show, hotkey_poll_freq_store);
2913 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2915 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2916 static ssize_t hotkey_radio_sw_show(struct device *dev,
2917 struct device_attribute *attr,
2918 char *buf)
2920 int res;
2921 res = hotkey_get_wlsw();
2922 if (res < 0)
2923 return res;
2925 /* Opportunistic update */
2926 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2928 return snprintf(buf, PAGE_SIZE, "%d\n",
2929 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2932 static struct device_attribute dev_attr_hotkey_radio_sw =
2933 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2935 static void hotkey_radio_sw_notify_change(void)
2937 if (tp_features.hotkey_wlsw)
2938 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2939 "hotkey_radio_sw");
2942 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2943 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2944 struct device_attribute *attr,
2945 char *buf)
2947 int res, s;
2948 res = hotkey_get_tablet_mode(&s);
2949 if (res < 0)
2950 return res;
2952 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2955 static struct device_attribute dev_attr_hotkey_tablet_mode =
2956 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2958 static void hotkey_tablet_mode_notify_change(void)
2960 if (tp_features.hotkey_tablet)
2961 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2962 "hotkey_tablet_mode");
2965 /* sysfs hotkey report_mode -------------------------------------------- */
2966 static ssize_t hotkey_report_mode_show(struct device *dev,
2967 struct device_attribute *attr,
2968 char *buf)
2970 return snprintf(buf, PAGE_SIZE, "%d\n",
2971 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2974 static struct device_attribute dev_attr_hotkey_report_mode =
2975 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2977 /* sysfs wakeup reason (pollable) -------------------------------------- */
2978 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2979 struct device_attribute *attr,
2980 char *buf)
2982 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2985 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2986 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2988 static void hotkey_wakeup_reason_notify_change(void)
2990 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2991 "wakeup_reason");
2994 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2995 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2996 struct device_attribute *attr,
2997 char *buf)
2999 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
3002 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
3003 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
3004 hotkey_wakeup_hotunplug_complete_show, NULL);
3006 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
3008 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3009 "wakeup_hotunplug_complete");
3012 /* --------------------------------------------------------------------- */
3014 static struct attribute *hotkey_attributes[] __initdata = {
3015 &dev_attr_hotkey_enable.attr,
3016 &dev_attr_hotkey_bios_enabled.attr,
3017 &dev_attr_hotkey_bios_mask.attr,
3018 &dev_attr_hotkey_report_mode.attr,
3019 &dev_attr_hotkey_wakeup_reason.attr,
3020 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
3021 &dev_attr_hotkey_mask.attr,
3022 &dev_attr_hotkey_all_mask.attr,
3023 &dev_attr_hotkey_recommended_mask.attr,
3024 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3025 &dev_attr_hotkey_source_mask.attr,
3026 &dev_attr_hotkey_poll_freq.attr,
3027 #endif
3031 * Sync both the hw and sw blocking state of all switches
3033 static void tpacpi_send_radiosw_update(void)
3035 int wlsw;
3038 * We must sync all rfkill controllers *before* issuing any
3039 * rfkill input events, or we will race the rfkill core input
3040 * handler.
3042 * tpacpi_inputdev_send_mutex works as a syncronization point
3043 * for the above.
3045 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3048 wlsw = hotkey_get_wlsw();
3050 /* Sync hw blocking state first if it is hw-blocked */
3051 if (wlsw == TPACPI_RFK_RADIO_OFF)
3052 tpacpi_rfk_update_hwblock_state(true);
3054 /* Sync sw blocking state */
3055 tpacpi_rfk_update_swstate_all();
3057 /* Sync hw blocking state last if it is hw-unblocked */
3058 if (wlsw == TPACPI_RFK_RADIO_ON)
3059 tpacpi_rfk_update_hwblock_state(false);
3061 /* Issue rfkill input event for WLSW switch */
3062 if (!(wlsw < 0)) {
3063 mutex_lock(&tpacpi_inputdev_send_mutex);
3065 input_report_switch(tpacpi_inputdev,
3066 SW_RFKILL_ALL, (wlsw > 0));
3067 input_sync(tpacpi_inputdev);
3069 mutex_unlock(&tpacpi_inputdev_send_mutex);
3073 * this can be unconditional, as we will poll state again
3074 * if userspace uses the notify to read data
3076 hotkey_radio_sw_notify_change();
3079 static void hotkey_exit(void)
3081 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3082 mutex_lock(&hotkey_mutex);
3083 hotkey_poll_stop_sync();
3084 mutex_unlock(&hotkey_mutex);
3085 #endif
3087 if (hotkey_dev_attributes)
3088 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3090 kfree(hotkey_keycode_map);
3092 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3093 "restoring original HKEY status and mask\n");
3094 /* yes, there is a bitwise or below, we want the
3095 * functions to be called even if one of them fail */
3096 if (((tp_features.hotkey_mask &&
3097 hotkey_mask_set(hotkey_orig_mask)) |
3098 hotkey_status_set(false)) != 0)
3099 printk(TPACPI_ERR
3100 "failed to restore hot key mask "
3101 "to BIOS defaults\n");
3104 static void __init hotkey_unmap(const unsigned int scancode)
3106 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3107 clear_bit(hotkey_keycode_map[scancode],
3108 tpacpi_inputdev->keybit);
3109 hotkey_keycode_map[scancode] = KEY_RESERVED;
3114 * HKEY quirks:
3115 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3118 #define TPACPI_HK_Q_INIMASK 0x0001
3120 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3121 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3122 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3123 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3124 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3125 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3126 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3127 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3128 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3129 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3130 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3131 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3132 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3133 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3134 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3135 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3136 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3137 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3138 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3139 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3142 static int __init hotkey_init(struct ibm_init_struct *iibm)
3144 /* Requirements for changing the default keymaps:
3146 * 1. Many of the keys are mapped to KEY_RESERVED for very
3147 * good reasons. Do not change them unless you have deep
3148 * knowledge on the IBM and Lenovo ThinkPad firmware for
3149 * the various ThinkPad models. The driver behaves
3150 * differently for KEY_RESERVED: such keys have their
3151 * hot key mask *unset* in mask_recommended, and also
3152 * in the initial hot key mask programmed into the
3153 * firmware at driver load time, which means the firm-
3154 * ware may react very differently if you change them to
3155 * something else;
3157 * 2. You must be subscribed to the linux-thinkpad and
3158 * ibm-acpi-devel mailing lists, and you should read the
3159 * list archives since 2007 if you want to change the
3160 * keymaps. This requirement exists so that you will
3161 * know the past history of problems with the thinkpad-
3162 * acpi driver keymaps, and also that you will be
3163 * listening to any bug reports;
3165 * 3. Do not send thinkpad-acpi specific patches directly to
3166 * for merging, *ever*. Send them to the linux-acpi
3167 * mailinglist for comments. Merging is to be done only
3168 * through acpi-test and the ACPI maintainer.
3170 * If the above is too much to ask, don't change the keymap.
3171 * Ask the thinkpad-acpi maintainer to do it, instead.
3173 static u16 ibm_keycode_map[] __initdata = {
3174 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3175 KEY_FN_F1, KEY_FN_F2, KEY_COFFEE, KEY_SLEEP,
3176 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3177 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3179 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3180 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3181 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3182 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3184 /* brightness: firmware always reacts to them */
3185 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3186 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3188 /* Thinklight: firmware always react to it */
3189 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3191 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3192 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3194 /* Volume: firmware always react to it and reprograms
3195 * the built-in *extra* mixer. Never map it to control
3196 * another mixer by default. */
3197 KEY_RESERVED, /* 0x14: VOLUME UP */
3198 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3199 KEY_RESERVED, /* 0x16: MUTE */
3201 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3203 /* (assignments unknown, please report if found) */
3204 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3205 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3207 static u16 lenovo_keycode_map[] __initdata = {
3208 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3209 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3210 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3211 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3213 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3214 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3215 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3216 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3218 /* These should be enabled --only-- when ACPI video
3219 * is disabled (i.e. in "vendor" mode), and are handled
3220 * in a special way by the init code */
3221 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3222 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3224 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3226 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3227 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3229 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3230 * react to it and reprograms the built-in *extra* mixer.
3231 * Never map it to control another mixer by default.
3233 * T60?, T61, R60?, R61: firmware and EC tries to send
3234 * these over the regular keyboard, so these are no-ops,
3235 * but there are still weird bugs re. MUTE, so do not
3236 * change unless you get test reports from all Lenovo
3237 * models. May cause the BIOS to interfere with the
3238 * HDA mixer.
3240 KEY_RESERVED, /* 0x14: VOLUME UP */
3241 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3242 KEY_RESERVED, /* 0x16: MUTE */
3244 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3246 /* (assignments unknown, please report if found) */
3247 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3248 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3251 #define TPACPI_HOTKEY_MAP_LEN ARRAY_SIZE(ibm_keycode_map)
3252 #define TPACPI_HOTKEY_MAP_SIZE sizeof(ibm_keycode_map)
3253 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(ibm_keycode_map[0])
3255 int res, i;
3256 int status;
3257 int hkeyv;
3258 bool radiosw_state = false;
3259 bool tabletsw_state = false;
3261 unsigned long quirks;
3263 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3264 "initializing hotkey subdriver\n");
3266 BUG_ON(!tpacpi_inputdev);
3267 BUG_ON(tpacpi_inputdev->open != NULL ||
3268 tpacpi_inputdev->close != NULL);
3270 TPACPI_ACPIHANDLE_INIT(hkey);
3271 mutex_init(&hotkey_mutex);
3273 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3274 mutex_init(&hotkey_thread_mutex);
3275 mutex_init(&hotkey_thread_data_mutex);
3276 #endif
3278 /* hotkey not supported on 570 */
3279 tp_features.hotkey = hkey_handle != NULL;
3281 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3282 "hotkeys are %s\n",
3283 str_supported(tp_features.hotkey));
3285 if (!tp_features.hotkey)
3286 return 1;
3288 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3289 ARRAY_SIZE(tpacpi_hotkey_qtable));
3291 tpacpi_disable_brightness_delay();
3293 /* MUST have enough space for all attributes to be added to
3294 * hotkey_dev_attributes */
3295 hotkey_dev_attributes = create_attr_set(
3296 ARRAY_SIZE(hotkey_attributes) + 2,
3297 NULL);
3298 if (!hotkey_dev_attributes)
3299 return -ENOMEM;
3300 res = add_many_to_attr_set(hotkey_dev_attributes,
3301 hotkey_attributes,
3302 ARRAY_SIZE(hotkey_attributes));
3303 if (res)
3304 goto err_exit;
3306 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3307 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3308 for HKEY interface version 0x100 */
3309 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3310 if ((hkeyv >> 8) != 1) {
3311 printk(TPACPI_ERR "unknown version of the "
3312 "HKEY interface: 0x%x\n", hkeyv);
3313 printk(TPACPI_ERR "please report this to %s\n",
3314 TPACPI_MAIL);
3315 } else {
3317 * MHKV 0x100 in A31, R40, R40e,
3318 * T4x, X31, and later
3320 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3321 "firmware HKEY interface version: 0x%x\n",
3322 hkeyv);
3324 /* Paranoia check AND init hotkey_all_mask */
3325 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3326 "MHKA", "qd")) {
3327 printk(TPACPI_ERR
3328 "missing MHKA handler, "
3329 "please report this to %s\n",
3330 TPACPI_MAIL);
3331 /* Fallback: pre-init for FN+F3,F4,F12 */
3332 hotkey_all_mask = 0x080cU;
3333 } else {
3334 tp_features.hotkey_mask = 1;
3339 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3340 "hotkey masks are %s\n",
3341 str_supported(tp_features.hotkey_mask));
3343 /* Init hotkey_all_mask if not initialized yet */
3344 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3345 (quirks & TPACPI_HK_Q_INIMASK))
3346 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3348 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3349 if (tp_features.hotkey_mask) {
3350 /* hotkey_source_mask *must* be zero for
3351 * the first hotkey_mask_get to return hotkey_orig_mask */
3352 res = hotkey_mask_get();
3353 if (res)
3354 goto err_exit;
3356 hotkey_orig_mask = hotkey_acpi_mask;
3357 } else {
3358 hotkey_orig_mask = hotkey_all_mask;
3359 hotkey_acpi_mask = hotkey_all_mask;
3362 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3363 if (dbg_wlswemul) {
3364 tp_features.hotkey_wlsw = 1;
3365 radiosw_state = !!tpacpi_wlsw_emulstate;
3366 printk(TPACPI_INFO
3367 "radio switch emulation enabled\n");
3368 } else
3369 #endif
3370 /* Not all thinkpads have a hardware radio switch */
3371 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3372 tp_features.hotkey_wlsw = 1;
3373 radiosw_state = !!status;
3374 printk(TPACPI_INFO
3375 "radio switch found; radios are %s\n",
3376 enabled(status, 0));
3378 if (tp_features.hotkey_wlsw)
3379 res = add_to_attr_set(hotkey_dev_attributes,
3380 &dev_attr_hotkey_radio_sw.attr);
3382 /* For X41t, X60t, X61t Tablets... */
3383 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3384 tp_features.hotkey_tablet = 1;
3385 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3386 printk(TPACPI_INFO
3387 "possible tablet mode switch found; "
3388 "ThinkPad in %s mode\n",
3389 (tabletsw_state) ? "tablet" : "laptop");
3390 res = add_to_attr_set(hotkey_dev_attributes,
3391 &dev_attr_hotkey_tablet_mode.attr);
3394 if (!res)
3395 res = register_attr_set_with_sysfs(
3396 hotkey_dev_attributes,
3397 &tpacpi_pdev->dev.kobj);
3398 if (res)
3399 goto err_exit;
3401 /* Set up key map */
3403 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3404 GFP_KERNEL);
3405 if (!hotkey_keycode_map) {
3406 printk(TPACPI_ERR
3407 "failed to allocate memory for key map\n");
3408 res = -ENOMEM;
3409 goto err_exit;
3412 if (tpacpi_is_lenovo()) {
3413 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3414 "using Lenovo default hot key map\n");
3415 memcpy(hotkey_keycode_map, &lenovo_keycode_map,
3416 TPACPI_HOTKEY_MAP_SIZE);
3417 } else {
3418 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3419 "using IBM default hot key map\n");
3420 memcpy(hotkey_keycode_map, &ibm_keycode_map,
3421 TPACPI_HOTKEY_MAP_SIZE);
3424 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3425 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3426 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3427 tpacpi_inputdev->keycode = hotkey_keycode_map;
3428 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3429 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3430 input_set_capability(tpacpi_inputdev, EV_KEY,
3431 hotkey_keycode_map[i]);
3432 } else {
3433 if (i < sizeof(hotkey_reserved_mask)*8)
3434 hotkey_reserved_mask |= 1 << i;
3438 if (tp_features.hotkey_wlsw) {
3439 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3440 input_report_switch(tpacpi_inputdev,
3441 SW_RFKILL_ALL, radiosw_state);
3443 if (tp_features.hotkey_tablet) {
3444 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3445 input_report_switch(tpacpi_inputdev,
3446 SW_TABLET_MODE, tabletsw_state);
3449 /* Do not issue duplicate brightness change events to
3450 * userspace */
3451 if (!tp_features.bright_acpimode)
3452 /* update bright_acpimode... */
3453 tpacpi_check_std_acpi_brightness_support();
3455 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3456 printk(TPACPI_INFO
3457 "This ThinkPad has standard ACPI backlight "
3458 "brightness control, supported by the ACPI "
3459 "video driver\n");
3460 printk(TPACPI_NOTICE
3461 "Disabling thinkpad-acpi brightness events "
3462 "by default...\n");
3464 /* Disable brightness up/down on Lenovo thinkpads when
3465 * ACPI is handling them, otherwise it is plain impossible
3466 * for userspace to do something even remotely sane */
3467 hotkey_reserved_mask |=
3468 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3469 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3470 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3471 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3474 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3475 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3476 & ~hotkey_all_mask
3477 & ~hotkey_reserved_mask;
3479 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3480 "hotkey source mask 0x%08x, polling freq %u\n",
3481 hotkey_source_mask, hotkey_poll_freq);
3482 #endif
3484 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3485 "enabling firmware HKEY event interface...\n");
3486 res = hotkey_status_set(true);
3487 if (res) {
3488 hotkey_exit();
3489 return res;
3491 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3492 | hotkey_driver_mask)
3493 & ~hotkey_source_mask);
3494 if (res < 0 && res != -ENXIO) {
3495 hotkey_exit();
3496 return res;
3498 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3499 & ~hotkey_reserved_mask;
3500 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3501 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3502 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3504 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3505 "legacy ibm/hotkey event reporting over procfs %s\n",
3506 (hotkey_report_mode < 2) ?
3507 "enabled" : "disabled");
3509 tpacpi_inputdev->open = &hotkey_inputdev_open;
3510 tpacpi_inputdev->close = &hotkey_inputdev_close;
3512 hotkey_poll_setup_safe(true);
3514 return 0;
3516 err_exit:
3517 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3518 hotkey_dev_attributes = NULL;
3520 return (res < 0)? res : 1;
3523 static bool hotkey_notify_hotkey(const u32 hkey,
3524 bool *send_acpi_ev,
3525 bool *ignore_acpi_ev)
3527 /* 0x1000-0x1FFF: key presses */
3528 unsigned int scancode = hkey & 0xfff;
3529 *send_acpi_ev = true;
3530 *ignore_acpi_ev = false;
3532 if (scancode > 0 && scancode < 0x21) {
3533 scancode--;
3534 if (!(hotkey_source_mask & (1 << scancode))) {
3535 tpacpi_input_send_key_masked(scancode);
3536 *send_acpi_ev = false;
3537 } else {
3538 *ignore_acpi_ev = true;
3540 return true;
3542 return false;
3545 static bool hotkey_notify_wakeup(const u32 hkey,
3546 bool *send_acpi_ev,
3547 bool *ignore_acpi_ev)
3549 /* 0x2000-0x2FFF: Wakeup reason */
3550 *send_acpi_ev = true;
3551 *ignore_acpi_ev = false;
3553 switch (hkey) {
3554 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3555 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3556 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3557 *ignore_acpi_ev = true;
3558 break;
3560 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3561 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3562 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3563 *ignore_acpi_ev = true;
3564 break;
3566 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3567 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3568 printk(TPACPI_ALERT
3569 "EMERGENCY WAKEUP: battery almost empty\n");
3570 /* how to auto-heal: */
3571 /* 2313: woke up from S3, go to S4/S5 */
3572 /* 2413: woke up from S4, go to S5 */
3573 break;
3575 default:
3576 return false;
3579 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3580 printk(TPACPI_INFO
3581 "woke up due to a hot-unplug "
3582 "request...\n");
3583 hotkey_wakeup_reason_notify_change();
3585 return true;
3588 static bool hotkey_notify_usrevent(const u32 hkey,
3589 bool *send_acpi_ev,
3590 bool *ignore_acpi_ev)
3592 /* 0x5000-0x5FFF: human interface helpers */
3593 *send_acpi_ev = true;
3594 *ignore_acpi_ev = false;
3596 switch (hkey) {
3597 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3598 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3599 return true;
3601 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3602 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3603 tpacpi_input_send_tabletsw();
3604 hotkey_tablet_mode_notify_change();
3605 *send_acpi_ev = false;
3606 return true;
3608 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3609 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3610 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3611 /* do not propagate these events */
3612 *ignore_acpi_ev = true;
3613 return true;
3615 default:
3616 return false;
3620 static void thermal_dump_all_sensors(void);
3622 static bool hotkey_notify_thermal(const u32 hkey,
3623 bool *send_acpi_ev,
3624 bool *ignore_acpi_ev)
3626 bool known = true;
3628 /* 0x6000-0x6FFF: thermal alarms */
3629 *send_acpi_ev = true;
3630 *ignore_acpi_ev = false;
3632 switch (hkey) {
3633 case TP_HKEY_EV_THM_TABLE_CHANGED:
3634 printk(TPACPI_INFO
3635 "EC reports that Thermal Table has changed\n");
3636 /* recommended action: do nothing, we don't have
3637 * Lenovo ATM information */
3638 return true;
3639 case TP_HKEY_EV_ALARM_BAT_HOT:
3640 printk(TPACPI_CRIT
3641 "THERMAL ALARM: battery is too hot!\n");
3642 /* recommended action: warn user through gui */
3643 break;
3644 case TP_HKEY_EV_ALARM_BAT_XHOT:
3645 printk(TPACPI_ALERT
3646 "THERMAL EMERGENCY: battery is extremely hot!\n");
3647 /* recommended action: immediate sleep/hibernate */
3648 break;
3649 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3650 printk(TPACPI_CRIT
3651 "THERMAL ALARM: "
3652 "a sensor reports something is too hot!\n");
3653 /* recommended action: warn user through gui, that */
3654 /* some internal component is too hot */
3655 break;
3656 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3657 printk(TPACPI_ALERT
3658 "THERMAL EMERGENCY: "
3659 "a sensor reports something is extremely hot!\n");
3660 /* recommended action: immediate sleep/hibernate */
3661 break;
3662 default:
3663 printk(TPACPI_ALERT
3664 "THERMAL ALERT: unknown thermal alarm received\n");
3665 known = false;
3668 thermal_dump_all_sensors();
3670 return known;
3673 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3675 u32 hkey;
3676 bool send_acpi_ev;
3677 bool ignore_acpi_ev;
3678 bool known_ev;
3680 if (event != 0x80) {
3681 printk(TPACPI_ERR
3682 "unknown HKEY notification event %d\n", event);
3683 /* forward it to userspace, maybe it knows how to handle it */
3684 acpi_bus_generate_netlink_event(
3685 ibm->acpi->device->pnp.device_class,
3686 dev_name(&ibm->acpi->device->dev),
3687 event, 0);
3688 return;
3691 while (1) {
3692 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3693 printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3694 return;
3697 if (hkey == 0) {
3698 /* queue empty */
3699 return;
3702 send_acpi_ev = true;
3703 ignore_acpi_ev = false;
3705 switch (hkey >> 12) {
3706 case 1:
3707 /* 0x1000-0x1FFF: key presses */
3708 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3709 &ignore_acpi_ev);
3710 break;
3711 case 2:
3712 /* 0x2000-0x2FFF: Wakeup reason */
3713 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3714 &ignore_acpi_ev);
3715 break;
3716 case 3:
3717 /* 0x3000-0x3FFF: bay-related wakeups */
3718 switch (hkey) {
3719 case TP_HKEY_EV_BAYEJ_ACK:
3720 hotkey_autosleep_ack = 1;
3721 printk(TPACPI_INFO
3722 "bay ejected\n");
3723 hotkey_wakeup_hotunplug_complete_notify_change();
3724 known_ev = true;
3725 break;
3726 case TP_HKEY_EV_OPTDRV_EJ:
3727 /* FIXME: kick libata if SATA link offline */
3728 known_ev = true;
3729 break;
3730 default:
3731 known_ev = false;
3733 break;
3734 case 4:
3735 /* 0x4000-0x4FFF: dock-related wakeups */
3736 if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3737 hotkey_autosleep_ack = 1;
3738 printk(TPACPI_INFO
3739 "undocked\n");
3740 hotkey_wakeup_hotunplug_complete_notify_change();
3741 known_ev = true;
3742 } else {
3743 known_ev = false;
3745 break;
3746 case 5:
3747 /* 0x5000-0x5FFF: human interface helpers */
3748 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3749 &ignore_acpi_ev);
3750 break;
3751 case 6:
3752 /* 0x6000-0x6FFF: thermal alarms */
3753 known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3754 &ignore_acpi_ev);
3755 break;
3756 case 7:
3757 /* 0x7000-0x7FFF: misc */
3758 if (tp_features.hotkey_wlsw &&
3759 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3760 tpacpi_send_radiosw_update();
3761 send_acpi_ev = 0;
3762 known_ev = true;
3763 break;
3765 /* fallthrough to default */
3766 default:
3767 known_ev = false;
3769 if (!known_ev) {
3770 printk(TPACPI_NOTICE
3771 "unhandled HKEY event 0x%04x\n", hkey);
3772 printk(TPACPI_NOTICE
3773 "please report the conditions when this "
3774 "event happened to %s\n", TPACPI_MAIL);
3777 /* Legacy events */
3778 if (!ignore_acpi_ev &&
3779 (send_acpi_ev || hotkey_report_mode < 2)) {
3780 acpi_bus_generate_proc_event(ibm->acpi->device,
3781 event, hkey);
3784 /* netlink events */
3785 if (!ignore_acpi_ev && send_acpi_ev) {
3786 acpi_bus_generate_netlink_event(
3787 ibm->acpi->device->pnp.device_class,
3788 dev_name(&ibm->acpi->device->dev),
3789 event, hkey);
3794 static void hotkey_suspend(pm_message_t state)
3796 /* Do these on suspend, we get the events on early resume! */
3797 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3798 hotkey_autosleep_ack = 0;
3801 static void hotkey_resume(void)
3803 tpacpi_disable_brightness_delay();
3805 if (hotkey_status_set(true) < 0 ||
3806 hotkey_mask_set(hotkey_acpi_mask) < 0)
3807 printk(TPACPI_ERR
3808 "error while attempting to reset the event "
3809 "firmware interface\n");
3811 tpacpi_send_radiosw_update();
3812 hotkey_tablet_mode_notify_change();
3813 hotkey_wakeup_reason_notify_change();
3814 hotkey_wakeup_hotunplug_complete_notify_change();
3815 hotkey_poll_setup_safe(false);
3818 /* procfs -------------------------------------------------------------- */
3819 static int hotkey_read(struct seq_file *m)
3821 int res, status;
3823 if (!tp_features.hotkey) {
3824 seq_printf(m, "status:\t\tnot supported\n");
3825 return 0;
3828 if (mutex_lock_killable(&hotkey_mutex))
3829 return -ERESTARTSYS;
3830 res = hotkey_status_get(&status);
3831 if (!res)
3832 res = hotkey_mask_get();
3833 mutex_unlock(&hotkey_mutex);
3834 if (res)
3835 return res;
3837 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3838 if (hotkey_all_mask) {
3839 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3840 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3841 } else {
3842 seq_printf(m, "mask:\t\tnot supported\n");
3843 seq_printf(m, "commands:\tenable, disable, reset\n");
3846 return 0;
3849 static void hotkey_enabledisable_warn(bool enable)
3851 tpacpi_log_usertask("procfs hotkey enable/disable");
3852 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3853 TPACPI_WARN
3854 "hotkey enable/disable functionality has been "
3855 "removed from the driver. Hotkeys are always "
3856 "enabled\n"))
3857 printk(TPACPI_ERR
3858 "Please remove the hotkey=enable module "
3859 "parameter, it is deprecated. Hotkeys are always "
3860 "enabled\n");
3863 static int hotkey_write(char *buf)
3865 int res;
3866 u32 mask;
3867 char *cmd;
3869 if (!tp_features.hotkey)
3870 return -ENODEV;
3872 if (mutex_lock_killable(&hotkey_mutex))
3873 return -ERESTARTSYS;
3875 mask = hotkey_user_mask;
3877 res = 0;
3878 while ((cmd = next_cmd(&buf))) {
3879 if (strlencmp(cmd, "enable") == 0) {
3880 hotkey_enabledisable_warn(1);
3881 } else if (strlencmp(cmd, "disable") == 0) {
3882 hotkey_enabledisable_warn(0);
3883 res = -EPERM;
3884 } else if (strlencmp(cmd, "reset") == 0) {
3885 mask = (hotkey_all_mask | hotkey_source_mask)
3886 & ~hotkey_reserved_mask;
3887 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3888 /* mask set */
3889 } else if (sscanf(cmd, "%x", &mask) == 1) {
3890 /* mask set */
3891 } else {
3892 res = -EINVAL;
3893 goto errexit;
3897 if (!res) {
3898 tpacpi_disclose_usertask("procfs hotkey",
3899 "set mask to 0x%08x\n", mask);
3900 res = hotkey_user_mask_set(mask);
3903 errexit:
3904 mutex_unlock(&hotkey_mutex);
3905 return res;
3908 static const struct acpi_device_id ibm_htk_device_ids[] = {
3909 {TPACPI_ACPI_HKEY_HID, 0},
3910 {"", 0},
3913 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3914 .hid = ibm_htk_device_ids,
3915 .notify = hotkey_notify,
3916 .handle = &hkey_handle,
3917 .type = ACPI_DEVICE_NOTIFY,
3920 static struct ibm_struct hotkey_driver_data = {
3921 .name = "hotkey",
3922 .read = hotkey_read,
3923 .write = hotkey_write,
3924 .exit = hotkey_exit,
3925 .resume = hotkey_resume,
3926 .suspend = hotkey_suspend,
3927 .acpi = &ibm_hotkey_acpidriver,
3930 /*************************************************************************
3931 * Bluetooth subdriver
3934 enum {
3935 /* ACPI GBDC/SBDC bits */
3936 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3937 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3938 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3939 0 = disable, 1 = enable */
3942 enum {
3943 /* ACPI \BLTH commands */
3944 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3945 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3946 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3947 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3948 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3951 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3953 static int bluetooth_get_status(void)
3955 int status;
3957 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3958 if (dbg_bluetoothemul)
3959 return (tpacpi_bluetooth_emulstate) ?
3960 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3961 #endif
3963 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3964 return -EIO;
3966 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3967 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3970 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3972 int status;
3974 vdbg_printk(TPACPI_DBG_RFKILL,
3975 "will attempt to %s bluetooth\n",
3976 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3978 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3979 if (dbg_bluetoothemul) {
3980 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3981 return 0;
3983 #endif
3985 if (state == TPACPI_RFK_RADIO_ON)
3986 status = TP_ACPI_BLUETOOTH_RADIOSSW
3987 | TP_ACPI_BLUETOOTH_RESUMECTRL;
3988 else
3989 status = 0;
3991 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3992 return -EIO;
3994 return 0;
3997 /* sysfs bluetooth enable ---------------------------------------------- */
3998 static ssize_t bluetooth_enable_show(struct device *dev,
3999 struct device_attribute *attr,
4000 char *buf)
4002 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4003 attr, buf);
4006 static ssize_t bluetooth_enable_store(struct device *dev,
4007 struct device_attribute *attr,
4008 const char *buf, size_t count)
4010 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4011 attr, buf, count);
4014 static struct device_attribute dev_attr_bluetooth_enable =
4015 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
4016 bluetooth_enable_show, bluetooth_enable_store);
4018 /* --------------------------------------------------------------------- */
4020 static struct attribute *bluetooth_attributes[] = {
4021 &dev_attr_bluetooth_enable.attr,
4022 NULL
4025 static const struct attribute_group bluetooth_attr_group = {
4026 .attrs = bluetooth_attributes,
4029 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4030 .get_status = bluetooth_get_status,
4031 .set_status = bluetooth_set_status,
4034 static void bluetooth_shutdown(void)
4036 /* Order firmware to save current state to NVRAM */
4037 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4038 TP_ACPI_BLTH_SAVE_STATE))
4039 printk(TPACPI_NOTICE
4040 "failed to save bluetooth state to NVRAM\n");
4041 else
4042 vdbg_printk(TPACPI_DBG_RFKILL,
4043 "bluestooth state saved to NVRAM\n");
4046 static void bluetooth_exit(void)
4048 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4049 &bluetooth_attr_group);
4051 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4053 bluetooth_shutdown();
4056 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4058 int res;
4059 int status = 0;
4061 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4062 "initializing bluetooth subdriver\n");
4064 TPACPI_ACPIHANDLE_INIT(hkey);
4066 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4067 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4068 tp_features.bluetooth = hkey_handle &&
4069 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4071 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4072 "bluetooth is %s, status 0x%02x\n",
4073 str_supported(tp_features.bluetooth),
4074 status);
4076 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4077 if (dbg_bluetoothemul) {
4078 tp_features.bluetooth = 1;
4079 printk(TPACPI_INFO
4080 "bluetooth switch emulation enabled\n");
4081 } else
4082 #endif
4083 if (tp_features.bluetooth &&
4084 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4085 /* no bluetooth hardware present in system */
4086 tp_features.bluetooth = 0;
4087 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4088 "bluetooth hardware not installed\n");
4091 if (!tp_features.bluetooth)
4092 return 1;
4094 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4095 &bluetooth_tprfk_ops,
4096 RFKILL_TYPE_BLUETOOTH,
4097 TPACPI_RFK_BLUETOOTH_SW_NAME,
4098 true);
4099 if (res)
4100 return res;
4102 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4103 &bluetooth_attr_group);
4104 if (res) {
4105 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4106 return res;
4109 return 0;
4112 /* procfs -------------------------------------------------------------- */
4113 static int bluetooth_read(struct seq_file *m)
4115 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4118 static int bluetooth_write(char *buf)
4120 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4123 static struct ibm_struct bluetooth_driver_data = {
4124 .name = "bluetooth",
4125 .read = bluetooth_read,
4126 .write = bluetooth_write,
4127 .exit = bluetooth_exit,
4128 .shutdown = bluetooth_shutdown,
4131 /*************************************************************************
4132 * Wan subdriver
4135 enum {
4136 /* ACPI GWAN/SWAN bits */
4137 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4138 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4139 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4140 0 = disable, 1 = enable */
4143 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4145 static int wan_get_status(void)
4147 int status;
4149 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4150 if (dbg_wwanemul)
4151 return (tpacpi_wwan_emulstate) ?
4152 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4153 #endif
4155 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4156 return -EIO;
4158 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4159 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4162 static int wan_set_status(enum tpacpi_rfkill_state state)
4164 int status;
4166 vdbg_printk(TPACPI_DBG_RFKILL,
4167 "will attempt to %s wwan\n",
4168 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4170 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4171 if (dbg_wwanemul) {
4172 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4173 return 0;
4175 #endif
4177 if (state == TPACPI_RFK_RADIO_ON)
4178 status = TP_ACPI_WANCARD_RADIOSSW
4179 | TP_ACPI_WANCARD_RESUMECTRL;
4180 else
4181 status = 0;
4183 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4184 return -EIO;
4186 return 0;
4189 /* sysfs wan enable ---------------------------------------------------- */
4190 static ssize_t wan_enable_show(struct device *dev,
4191 struct device_attribute *attr,
4192 char *buf)
4194 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4195 attr, buf);
4198 static ssize_t wan_enable_store(struct device *dev,
4199 struct device_attribute *attr,
4200 const char *buf, size_t count)
4202 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4203 attr, buf, count);
4206 static struct device_attribute dev_attr_wan_enable =
4207 __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4208 wan_enable_show, wan_enable_store);
4210 /* --------------------------------------------------------------------- */
4212 static struct attribute *wan_attributes[] = {
4213 &dev_attr_wan_enable.attr,
4214 NULL
4217 static const struct attribute_group wan_attr_group = {
4218 .attrs = wan_attributes,
4221 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4222 .get_status = wan_get_status,
4223 .set_status = wan_set_status,
4226 static void wan_shutdown(void)
4228 /* Order firmware to save current state to NVRAM */
4229 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4230 TP_ACPI_WGSV_SAVE_STATE))
4231 printk(TPACPI_NOTICE
4232 "failed to save WWAN state to NVRAM\n");
4233 else
4234 vdbg_printk(TPACPI_DBG_RFKILL,
4235 "WWAN state saved to NVRAM\n");
4238 static void wan_exit(void)
4240 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4241 &wan_attr_group);
4243 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4245 wan_shutdown();
4248 static int __init wan_init(struct ibm_init_struct *iibm)
4250 int res;
4251 int status = 0;
4253 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4254 "initializing wan subdriver\n");
4256 TPACPI_ACPIHANDLE_INIT(hkey);
4258 tp_features.wan = hkey_handle &&
4259 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4261 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4262 "wan is %s, status 0x%02x\n",
4263 str_supported(tp_features.wan),
4264 status);
4266 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4267 if (dbg_wwanemul) {
4268 tp_features.wan = 1;
4269 printk(TPACPI_INFO
4270 "wwan switch emulation enabled\n");
4271 } else
4272 #endif
4273 if (tp_features.wan &&
4274 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4275 /* no wan hardware present in system */
4276 tp_features.wan = 0;
4277 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4278 "wan hardware not installed\n");
4281 if (!tp_features.wan)
4282 return 1;
4284 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4285 &wan_tprfk_ops,
4286 RFKILL_TYPE_WWAN,
4287 TPACPI_RFK_WWAN_SW_NAME,
4288 true);
4289 if (res)
4290 return res;
4292 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4293 &wan_attr_group);
4295 if (res) {
4296 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4297 return res;
4300 return 0;
4303 /* procfs -------------------------------------------------------------- */
4304 static int wan_read(struct seq_file *m)
4306 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4309 static int wan_write(char *buf)
4311 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4314 static struct ibm_struct wan_driver_data = {
4315 .name = "wan",
4316 .read = wan_read,
4317 .write = wan_write,
4318 .exit = wan_exit,
4319 .shutdown = wan_shutdown,
4322 /*************************************************************************
4323 * UWB subdriver
4326 enum {
4327 /* ACPI GUWB/SUWB bits */
4328 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4329 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4332 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4334 static int uwb_get_status(void)
4336 int status;
4338 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4339 if (dbg_uwbemul)
4340 return (tpacpi_uwb_emulstate) ?
4341 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4342 #endif
4344 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4345 return -EIO;
4347 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4348 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4351 static int uwb_set_status(enum tpacpi_rfkill_state state)
4353 int status;
4355 vdbg_printk(TPACPI_DBG_RFKILL,
4356 "will attempt to %s UWB\n",
4357 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4359 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4360 if (dbg_uwbemul) {
4361 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4362 return 0;
4364 #endif
4366 if (state == TPACPI_RFK_RADIO_ON)
4367 status = TP_ACPI_UWB_RADIOSSW;
4368 else
4369 status = 0;
4371 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4372 return -EIO;
4374 return 0;
4377 /* --------------------------------------------------------------------- */
4379 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4380 .get_status = uwb_get_status,
4381 .set_status = uwb_set_status,
4384 static void uwb_exit(void)
4386 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4389 static int __init uwb_init(struct ibm_init_struct *iibm)
4391 int res;
4392 int status = 0;
4394 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4395 "initializing uwb subdriver\n");
4397 TPACPI_ACPIHANDLE_INIT(hkey);
4399 tp_features.uwb = hkey_handle &&
4400 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4402 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4403 "uwb is %s, status 0x%02x\n",
4404 str_supported(tp_features.uwb),
4405 status);
4407 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4408 if (dbg_uwbemul) {
4409 tp_features.uwb = 1;
4410 printk(TPACPI_INFO
4411 "uwb switch emulation enabled\n");
4412 } else
4413 #endif
4414 if (tp_features.uwb &&
4415 !(status & TP_ACPI_UWB_HWPRESENT)) {
4416 /* no uwb hardware present in system */
4417 tp_features.uwb = 0;
4418 dbg_printk(TPACPI_DBG_INIT,
4419 "uwb hardware not installed\n");
4422 if (!tp_features.uwb)
4423 return 1;
4425 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4426 &uwb_tprfk_ops,
4427 RFKILL_TYPE_UWB,
4428 TPACPI_RFK_UWB_SW_NAME,
4429 false);
4430 return res;
4433 static struct ibm_struct uwb_driver_data = {
4434 .name = "uwb",
4435 .exit = uwb_exit,
4436 .flags.experimental = 1,
4439 /*************************************************************************
4440 * Video subdriver
4443 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4445 enum video_access_mode {
4446 TPACPI_VIDEO_NONE = 0,
4447 TPACPI_VIDEO_570, /* 570 */
4448 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4449 TPACPI_VIDEO_NEW, /* all others */
4452 enum { /* video status flags, based on VIDEO_570 */
4453 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4454 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4455 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4458 enum { /* TPACPI_VIDEO_570 constants */
4459 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4460 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4461 * video_status_flags */
4462 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4463 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4466 static enum video_access_mode video_supported;
4467 static int video_orig_autosw;
4469 static int video_autosw_get(void);
4470 static int video_autosw_set(int enable);
4472 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4474 static int __init video_init(struct ibm_init_struct *iibm)
4476 int ivga;
4478 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4480 TPACPI_ACPIHANDLE_INIT(vid);
4481 if (tpacpi_is_ibm())
4482 TPACPI_ACPIHANDLE_INIT(vid2);
4484 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4485 /* G41, assume IVGA doesn't change */
4486 vid_handle = vid2_handle;
4488 if (!vid_handle)
4489 /* video switching not supported on R30, R31 */
4490 video_supported = TPACPI_VIDEO_NONE;
4491 else if (tpacpi_is_ibm() &&
4492 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4493 /* 570 */
4494 video_supported = TPACPI_VIDEO_570;
4495 else if (tpacpi_is_ibm() &&
4496 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4497 /* 600e/x, 770e, 770x */
4498 video_supported = TPACPI_VIDEO_770;
4499 else
4500 /* all others */
4501 video_supported = TPACPI_VIDEO_NEW;
4503 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4504 str_supported(video_supported != TPACPI_VIDEO_NONE),
4505 video_supported);
4507 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4510 static void video_exit(void)
4512 dbg_printk(TPACPI_DBG_EXIT,
4513 "restoring original video autoswitch mode\n");
4514 if (video_autosw_set(video_orig_autosw))
4515 printk(TPACPI_ERR "error while trying to restore original "
4516 "video autoswitch mode\n");
4519 static int video_outputsw_get(void)
4521 int status = 0;
4522 int i;
4524 switch (video_supported) {
4525 case TPACPI_VIDEO_570:
4526 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4527 TP_ACPI_VIDEO_570_PHSCMD))
4528 return -EIO;
4529 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4530 break;
4531 case TPACPI_VIDEO_770:
4532 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4533 return -EIO;
4534 if (i)
4535 status |= TP_ACPI_VIDEO_S_LCD;
4536 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4537 return -EIO;
4538 if (i)
4539 status |= TP_ACPI_VIDEO_S_CRT;
4540 break;
4541 case TPACPI_VIDEO_NEW:
4542 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4543 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4544 return -EIO;
4545 if (i)
4546 status |= TP_ACPI_VIDEO_S_CRT;
4548 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4549 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4550 return -EIO;
4551 if (i)
4552 status |= TP_ACPI_VIDEO_S_LCD;
4553 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4554 return -EIO;
4555 if (i)
4556 status |= TP_ACPI_VIDEO_S_DVI;
4557 break;
4558 default:
4559 return -ENOSYS;
4562 return status;
4565 static int video_outputsw_set(int status)
4567 int autosw;
4568 int res = 0;
4570 switch (video_supported) {
4571 case TPACPI_VIDEO_570:
4572 res = acpi_evalf(NULL, NULL,
4573 "\\_SB.PHS2", "vdd",
4574 TP_ACPI_VIDEO_570_PHS2CMD,
4575 status | TP_ACPI_VIDEO_570_PHS2SET);
4576 break;
4577 case TPACPI_VIDEO_770:
4578 autosw = video_autosw_get();
4579 if (autosw < 0)
4580 return autosw;
4582 res = video_autosw_set(1);
4583 if (res)
4584 return res;
4585 res = acpi_evalf(vid_handle, NULL,
4586 "ASWT", "vdd", status * 0x100, 0);
4587 if (!autosw && video_autosw_set(autosw)) {
4588 printk(TPACPI_ERR
4589 "video auto-switch left enabled due to error\n");
4590 return -EIO;
4592 break;
4593 case TPACPI_VIDEO_NEW:
4594 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4595 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4596 break;
4597 default:
4598 return -ENOSYS;
4601 return (res)? 0 : -EIO;
4604 static int video_autosw_get(void)
4606 int autosw = 0;
4608 switch (video_supported) {
4609 case TPACPI_VIDEO_570:
4610 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4611 return -EIO;
4612 break;
4613 case TPACPI_VIDEO_770:
4614 case TPACPI_VIDEO_NEW:
4615 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4616 return -EIO;
4617 break;
4618 default:
4619 return -ENOSYS;
4622 return autosw & 1;
4625 static int video_autosw_set(int enable)
4627 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4628 return -EIO;
4629 return 0;
4632 static int video_outputsw_cycle(void)
4634 int autosw = video_autosw_get();
4635 int res;
4637 if (autosw < 0)
4638 return autosw;
4640 switch (video_supported) {
4641 case TPACPI_VIDEO_570:
4642 res = video_autosw_set(1);
4643 if (res)
4644 return res;
4645 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4646 break;
4647 case TPACPI_VIDEO_770:
4648 case TPACPI_VIDEO_NEW:
4649 res = video_autosw_set(1);
4650 if (res)
4651 return res;
4652 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4653 break;
4654 default:
4655 return -ENOSYS;
4657 if (!autosw && video_autosw_set(autosw)) {
4658 printk(TPACPI_ERR
4659 "video auto-switch left enabled due to error\n");
4660 return -EIO;
4663 return (res)? 0 : -EIO;
4666 static int video_expand_toggle(void)
4668 switch (video_supported) {
4669 case TPACPI_VIDEO_570:
4670 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4671 0 : -EIO;
4672 case TPACPI_VIDEO_770:
4673 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4674 0 : -EIO;
4675 case TPACPI_VIDEO_NEW:
4676 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4677 0 : -EIO;
4678 default:
4679 return -ENOSYS;
4681 /* not reached */
4684 static int video_read(struct seq_file *m)
4686 int status, autosw;
4688 if (video_supported == TPACPI_VIDEO_NONE) {
4689 seq_printf(m, "status:\t\tnot supported\n");
4690 return 0;
4693 /* Even reads can crash X.org, so... */
4694 if (!capable(CAP_SYS_ADMIN))
4695 return -EPERM;
4697 status = video_outputsw_get();
4698 if (status < 0)
4699 return status;
4701 autosw = video_autosw_get();
4702 if (autosw < 0)
4703 return autosw;
4705 seq_printf(m, "status:\t\tsupported\n");
4706 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4707 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4708 if (video_supported == TPACPI_VIDEO_NEW)
4709 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4710 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4711 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4712 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4713 if (video_supported == TPACPI_VIDEO_NEW)
4714 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4715 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4716 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4718 return 0;
4721 static int video_write(char *buf)
4723 char *cmd;
4724 int enable, disable, status;
4725 int res;
4727 if (video_supported == TPACPI_VIDEO_NONE)
4728 return -ENODEV;
4730 /* Even reads can crash X.org, let alone writes... */
4731 if (!capable(CAP_SYS_ADMIN))
4732 return -EPERM;
4734 enable = 0;
4735 disable = 0;
4737 while ((cmd = next_cmd(&buf))) {
4738 if (strlencmp(cmd, "lcd_enable") == 0) {
4739 enable |= TP_ACPI_VIDEO_S_LCD;
4740 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4741 disable |= TP_ACPI_VIDEO_S_LCD;
4742 } else if (strlencmp(cmd, "crt_enable") == 0) {
4743 enable |= TP_ACPI_VIDEO_S_CRT;
4744 } else if (strlencmp(cmd, "crt_disable") == 0) {
4745 disable |= TP_ACPI_VIDEO_S_CRT;
4746 } else if (video_supported == TPACPI_VIDEO_NEW &&
4747 strlencmp(cmd, "dvi_enable") == 0) {
4748 enable |= TP_ACPI_VIDEO_S_DVI;
4749 } else if (video_supported == TPACPI_VIDEO_NEW &&
4750 strlencmp(cmd, "dvi_disable") == 0) {
4751 disable |= TP_ACPI_VIDEO_S_DVI;
4752 } else if (strlencmp(cmd, "auto_enable") == 0) {
4753 res = video_autosw_set(1);
4754 if (res)
4755 return res;
4756 } else if (strlencmp(cmd, "auto_disable") == 0) {
4757 res = video_autosw_set(0);
4758 if (res)
4759 return res;
4760 } else if (strlencmp(cmd, "video_switch") == 0) {
4761 res = video_outputsw_cycle();
4762 if (res)
4763 return res;
4764 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4765 res = video_expand_toggle();
4766 if (res)
4767 return res;
4768 } else
4769 return -EINVAL;
4772 if (enable || disable) {
4773 status = video_outputsw_get();
4774 if (status < 0)
4775 return status;
4776 res = video_outputsw_set((status & ~disable) | enable);
4777 if (res)
4778 return res;
4781 return 0;
4784 static struct ibm_struct video_driver_data = {
4785 .name = "video",
4786 .read = video_read,
4787 .write = video_write,
4788 .exit = video_exit,
4791 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4793 /*************************************************************************
4794 * Light (thinklight) subdriver
4797 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4798 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4800 static int light_get_status(void)
4802 int status = 0;
4804 if (tp_features.light_status) {
4805 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4806 return -EIO;
4807 return (!!status);
4810 return -ENXIO;
4813 static int light_set_status(int status)
4815 int rc;
4817 if (tp_features.light) {
4818 if (cmos_handle) {
4819 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4820 (status)?
4821 TP_CMOS_THINKLIGHT_ON :
4822 TP_CMOS_THINKLIGHT_OFF);
4823 } else {
4824 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4825 (status)? 1 : 0);
4827 return (rc)? 0 : -EIO;
4830 return -ENXIO;
4833 static void light_set_status_worker(struct work_struct *work)
4835 struct tpacpi_led_classdev *data =
4836 container_of(work, struct tpacpi_led_classdev, work);
4838 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4839 light_set_status((data->new_state != TPACPI_LED_OFF));
4842 static void light_sysfs_set(struct led_classdev *led_cdev,
4843 enum led_brightness brightness)
4845 struct tpacpi_led_classdev *data =
4846 container_of(led_cdev,
4847 struct tpacpi_led_classdev,
4848 led_classdev);
4849 data->new_state = (brightness != LED_OFF) ?
4850 TPACPI_LED_ON : TPACPI_LED_OFF;
4851 queue_work(tpacpi_wq, &data->work);
4854 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4856 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4859 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4860 .led_classdev = {
4861 .name = "tpacpi::thinklight",
4862 .brightness_set = &light_sysfs_set,
4863 .brightness_get = &light_sysfs_get,
4867 static int __init light_init(struct ibm_init_struct *iibm)
4869 int rc;
4871 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4873 if (tpacpi_is_ibm()) {
4874 TPACPI_ACPIHANDLE_INIT(ledb);
4875 TPACPI_ACPIHANDLE_INIT(lght);
4877 TPACPI_ACPIHANDLE_INIT(cmos);
4878 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4880 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4881 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4883 if (tp_features.light)
4884 /* light status not supported on
4885 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4886 tp_features.light_status =
4887 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4889 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4890 str_supported(tp_features.light),
4891 str_supported(tp_features.light_status));
4893 if (!tp_features.light)
4894 return 1;
4896 rc = led_classdev_register(&tpacpi_pdev->dev,
4897 &tpacpi_led_thinklight.led_classdev);
4899 if (rc < 0) {
4900 tp_features.light = 0;
4901 tp_features.light_status = 0;
4902 } else {
4903 rc = 0;
4906 return rc;
4909 static void light_exit(void)
4911 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4912 if (work_pending(&tpacpi_led_thinklight.work))
4913 flush_workqueue(tpacpi_wq);
4916 static int light_read(struct seq_file *m)
4918 int status;
4920 if (!tp_features.light) {
4921 seq_printf(m, "status:\t\tnot supported\n");
4922 } else if (!tp_features.light_status) {
4923 seq_printf(m, "status:\t\tunknown\n");
4924 seq_printf(m, "commands:\ton, off\n");
4925 } else {
4926 status = light_get_status();
4927 if (status < 0)
4928 return status;
4929 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4930 seq_printf(m, "commands:\ton, off\n");
4933 return 0;
4936 static int light_write(char *buf)
4938 char *cmd;
4939 int newstatus = 0;
4941 if (!tp_features.light)
4942 return -ENODEV;
4944 while ((cmd = next_cmd(&buf))) {
4945 if (strlencmp(cmd, "on") == 0) {
4946 newstatus = 1;
4947 } else if (strlencmp(cmd, "off") == 0) {
4948 newstatus = 0;
4949 } else
4950 return -EINVAL;
4953 return light_set_status(newstatus);
4956 static struct ibm_struct light_driver_data = {
4957 .name = "light",
4958 .read = light_read,
4959 .write = light_write,
4960 .exit = light_exit,
4963 /*************************************************************************
4964 * CMOS subdriver
4967 /* sysfs cmos_command -------------------------------------------------- */
4968 static ssize_t cmos_command_store(struct device *dev,
4969 struct device_attribute *attr,
4970 const char *buf, size_t count)
4972 unsigned long cmos_cmd;
4973 int res;
4975 if (parse_strtoul(buf, 21, &cmos_cmd))
4976 return -EINVAL;
4978 res = issue_thinkpad_cmos_command(cmos_cmd);
4979 return (res)? res : count;
4982 static struct device_attribute dev_attr_cmos_command =
4983 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4985 /* --------------------------------------------------------------------- */
4987 static int __init cmos_init(struct ibm_init_struct *iibm)
4989 int res;
4991 vdbg_printk(TPACPI_DBG_INIT,
4992 "initializing cmos commands subdriver\n");
4994 TPACPI_ACPIHANDLE_INIT(cmos);
4996 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4997 str_supported(cmos_handle != NULL));
4999 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5000 if (res)
5001 return res;
5003 return (cmos_handle)? 0 : 1;
5006 static void cmos_exit(void)
5008 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5011 static int cmos_read(struct seq_file *m)
5013 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5014 R30, R31, T20-22, X20-21 */
5015 if (!cmos_handle)
5016 seq_printf(m, "status:\t\tnot supported\n");
5017 else {
5018 seq_printf(m, "status:\t\tsupported\n");
5019 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5022 return 0;
5025 static int cmos_write(char *buf)
5027 char *cmd;
5028 int cmos_cmd, res;
5030 while ((cmd = next_cmd(&buf))) {
5031 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5032 cmos_cmd >= 0 && cmos_cmd <= 21) {
5033 /* cmos_cmd set */
5034 } else
5035 return -EINVAL;
5037 res = issue_thinkpad_cmos_command(cmos_cmd);
5038 if (res)
5039 return res;
5042 return 0;
5045 static struct ibm_struct cmos_driver_data = {
5046 .name = "cmos",
5047 .read = cmos_read,
5048 .write = cmos_write,
5049 .exit = cmos_exit,
5052 /*************************************************************************
5053 * LED subdriver
5056 enum led_access_mode {
5057 TPACPI_LED_NONE = 0,
5058 TPACPI_LED_570, /* 570 */
5059 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5060 TPACPI_LED_NEW, /* all others */
5063 enum { /* For TPACPI_LED_OLD */
5064 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5065 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5066 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5069 static enum led_access_mode led_supported;
5071 TPACPI_HANDLE(led, ec, "SLED", /* 570 */
5072 "SYSL", /* 600e/x, 770e, 770x, A21e, A2xm/p, */
5073 /* T20-22, X20-21 */
5074 "LED", /* all others */
5075 ); /* R30, R31 */
5077 #define TPACPI_LED_NUMLEDS 16
5078 static struct tpacpi_led_classdev *tpacpi_leds;
5079 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5080 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5081 /* there's a limit of 19 chars + NULL before 2.6.26 */
5082 "tpacpi::power",
5083 "tpacpi:orange:batt",
5084 "tpacpi:green:batt",
5085 "tpacpi::dock_active",
5086 "tpacpi::bay_active",
5087 "tpacpi::dock_batt",
5088 "tpacpi::unknown_led",
5089 "tpacpi::standby",
5090 "tpacpi::dock_status1",
5091 "tpacpi::dock_status2",
5092 "tpacpi::unknown_led2",
5093 "tpacpi::unknown_led3",
5094 "tpacpi::thinkvantage",
5096 #define TPACPI_SAFE_LEDS 0x1081U
5098 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5100 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5101 return false;
5102 #else
5103 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5104 #endif
5107 static int led_get_status(const unsigned int led)
5109 int status;
5110 enum led_status_t led_s;
5112 switch (led_supported) {
5113 case TPACPI_LED_570:
5114 if (!acpi_evalf(ec_handle,
5115 &status, "GLED", "dd", 1 << led))
5116 return -EIO;
5117 led_s = (status == 0)?
5118 TPACPI_LED_OFF :
5119 ((status == 1)?
5120 TPACPI_LED_ON :
5121 TPACPI_LED_BLINK);
5122 tpacpi_led_state_cache[led] = led_s;
5123 return led_s;
5124 default:
5125 return -ENXIO;
5128 /* not reached */
5131 static int led_set_status(const unsigned int led,
5132 const enum led_status_t ledstatus)
5134 /* off, on, blink. Index is led_status_t */
5135 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5136 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5138 int rc = 0;
5140 switch (led_supported) {
5141 case TPACPI_LED_570:
5142 /* 570 */
5143 if (unlikely(led > 7))
5144 return -EINVAL;
5145 if (unlikely(tpacpi_is_led_restricted(led)))
5146 return -EPERM;
5147 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5148 (1 << led), led_sled_arg1[ledstatus]))
5149 rc = -EIO;
5150 break;
5151 case TPACPI_LED_OLD:
5152 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5153 if (unlikely(led > 7))
5154 return -EINVAL;
5155 if (unlikely(tpacpi_is_led_restricted(led)))
5156 return -EPERM;
5157 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5158 if (rc >= 0)
5159 rc = ec_write(TPACPI_LED_EC_HLBL,
5160 (ledstatus == TPACPI_LED_BLINK) << led);
5161 if (rc >= 0)
5162 rc = ec_write(TPACPI_LED_EC_HLCL,
5163 (ledstatus != TPACPI_LED_OFF) << led);
5164 break;
5165 case TPACPI_LED_NEW:
5166 /* all others */
5167 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5168 return -EINVAL;
5169 if (unlikely(tpacpi_is_led_restricted(led)))
5170 return -EPERM;
5171 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5172 led, led_led_arg1[ledstatus]))
5173 rc = -EIO;
5174 break;
5175 default:
5176 rc = -ENXIO;
5179 if (!rc)
5180 tpacpi_led_state_cache[led] = ledstatus;
5182 return rc;
5185 static void led_set_status_worker(struct work_struct *work)
5187 struct tpacpi_led_classdev *data =
5188 container_of(work, struct tpacpi_led_classdev, work);
5190 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5191 led_set_status(data->led, data->new_state);
5194 static void led_sysfs_set(struct led_classdev *led_cdev,
5195 enum led_brightness brightness)
5197 struct tpacpi_led_classdev *data = container_of(led_cdev,
5198 struct tpacpi_led_classdev, led_classdev);
5200 if (brightness == LED_OFF)
5201 data->new_state = TPACPI_LED_OFF;
5202 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5203 data->new_state = TPACPI_LED_ON;
5204 else
5205 data->new_state = TPACPI_LED_BLINK;
5207 queue_work(tpacpi_wq, &data->work);
5210 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5211 unsigned long *delay_on, unsigned long *delay_off)
5213 struct tpacpi_led_classdev *data = container_of(led_cdev,
5214 struct tpacpi_led_classdev, led_classdev);
5216 /* Can we choose the flash rate? */
5217 if (*delay_on == 0 && *delay_off == 0) {
5218 /* yes. set them to the hardware blink rate (1 Hz) */
5219 *delay_on = 500; /* ms */
5220 *delay_off = 500; /* ms */
5221 } else if ((*delay_on != 500) || (*delay_off != 500))
5222 return -EINVAL;
5224 data->new_state = TPACPI_LED_BLINK;
5225 queue_work(tpacpi_wq, &data->work);
5227 return 0;
5230 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5232 int rc;
5234 struct tpacpi_led_classdev *data = container_of(led_cdev,
5235 struct tpacpi_led_classdev, led_classdev);
5237 rc = led_get_status(data->led);
5239 if (rc == TPACPI_LED_OFF || rc < 0)
5240 rc = LED_OFF; /* no error handling in led class :( */
5241 else
5242 rc = LED_FULL;
5244 return rc;
5247 static void led_exit(void)
5249 unsigned int i;
5251 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5252 if (tpacpi_leds[i].led_classdev.name)
5253 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5256 kfree(tpacpi_leds);
5259 static int __init tpacpi_init_led(unsigned int led)
5261 int rc;
5263 tpacpi_leds[led].led = led;
5265 /* LEDs with no name don't get registered */
5266 if (!tpacpi_led_names[led])
5267 return 0;
5269 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5270 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5271 if (led_supported == TPACPI_LED_570)
5272 tpacpi_leds[led].led_classdev.brightness_get =
5273 &led_sysfs_get;
5275 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5277 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5279 rc = led_classdev_register(&tpacpi_pdev->dev,
5280 &tpacpi_leds[led].led_classdev);
5281 if (rc < 0)
5282 tpacpi_leds[led].led_classdev.name = NULL;
5284 return rc;
5287 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5288 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5289 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5290 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5292 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5293 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5294 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5295 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5296 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5297 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5298 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5299 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5301 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5302 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5303 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5304 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5305 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5307 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5308 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5309 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5310 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5312 /* (1) - may have excess leds enabled on MSB */
5314 /* Defaults (order matters, keep last, don't reorder!) */
5315 { /* Lenovo */
5316 .vendor = PCI_VENDOR_ID_LENOVO,
5317 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5318 .quirks = 0x1fffU,
5320 { /* IBM ThinkPads with no EC version string */
5321 .vendor = PCI_VENDOR_ID_IBM,
5322 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5323 .quirks = 0x00ffU,
5325 { /* IBM ThinkPads with EC version string */
5326 .vendor = PCI_VENDOR_ID_IBM,
5327 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5328 .quirks = 0x00bfU,
5332 #undef TPACPI_LEDQ_IBM
5333 #undef TPACPI_LEDQ_LNV
5335 static int __init led_init(struct ibm_init_struct *iibm)
5337 unsigned int i;
5338 int rc;
5339 unsigned long useful_leds;
5341 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5343 TPACPI_ACPIHANDLE_INIT(led);
5345 if (!led_handle)
5346 /* led not supported on R30, R31 */
5347 led_supported = TPACPI_LED_NONE;
5348 else if (tpacpi_is_ibm() && strlencmp(led_path, "SLED") == 0)
5349 /* 570 */
5350 led_supported = TPACPI_LED_570;
5351 else if (tpacpi_is_ibm() && strlencmp(led_path, "SYSL") == 0)
5352 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5353 led_supported = TPACPI_LED_OLD;
5354 else
5355 /* all others */
5356 led_supported = TPACPI_LED_NEW;
5358 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5359 str_supported(led_supported), led_supported);
5361 if (led_supported == TPACPI_LED_NONE)
5362 return 1;
5364 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5365 GFP_KERNEL);
5366 if (!tpacpi_leds) {
5367 printk(TPACPI_ERR "Out of memory for LED data\n");
5368 return -ENOMEM;
5371 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5372 ARRAY_SIZE(led_useful_qtable));
5374 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5375 if (!tpacpi_is_led_restricted(i) &&
5376 test_bit(i, &useful_leds)) {
5377 rc = tpacpi_init_led(i);
5378 if (rc < 0) {
5379 led_exit();
5380 return rc;
5385 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5386 printk(TPACPI_NOTICE
5387 "warning: userspace override of important "
5388 "firmware LEDs is enabled\n");
5389 #endif
5390 return 0;
5393 #define str_led_status(s) \
5394 ((s) == TPACPI_LED_OFF ? "off" : \
5395 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5397 static int led_read(struct seq_file *m)
5399 if (!led_supported) {
5400 seq_printf(m, "status:\t\tnot supported\n");
5401 return 0;
5403 seq_printf(m, "status:\t\tsupported\n");
5405 if (led_supported == TPACPI_LED_570) {
5406 /* 570 */
5407 int i, status;
5408 for (i = 0; i < 8; i++) {
5409 status = led_get_status(i);
5410 if (status < 0)
5411 return -EIO;
5412 seq_printf(m, "%d:\t\t%s\n",
5413 i, str_led_status(status));
5417 seq_printf(m, "commands:\t"
5418 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5420 return 0;
5423 static int led_write(char *buf)
5425 char *cmd;
5426 int led, rc;
5427 enum led_status_t s;
5429 if (!led_supported)
5430 return -ENODEV;
5432 while ((cmd = next_cmd(&buf))) {
5433 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5434 return -EINVAL;
5436 if (strstr(cmd, "off")) {
5437 s = TPACPI_LED_OFF;
5438 } else if (strstr(cmd, "on")) {
5439 s = TPACPI_LED_ON;
5440 } else if (strstr(cmd, "blink")) {
5441 s = TPACPI_LED_BLINK;
5442 } else {
5443 return -EINVAL;
5446 rc = led_set_status(led, s);
5447 if (rc < 0)
5448 return rc;
5451 return 0;
5454 static struct ibm_struct led_driver_data = {
5455 .name = "led",
5456 .read = led_read,
5457 .write = led_write,
5458 .exit = led_exit,
5461 /*************************************************************************
5462 * Beep subdriver
5465 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5467 #define TPACPI_BEEP_Q1 0x0001
5469 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5470 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5471 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5474 static int __init beep_init(struct ibm_init_struct *iibm)
5476 unsigned long quirks;
5478 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5480 TPACPI_ACPIHANDLE_INIT(beep);
5482 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5483 str_supported(beep_handle != NULL));
5485 quirks = tpacpi_check_quirks(beep_quirk_table,
5486 ARRAY_SIZE(beep_quirk_table));
5488 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5490 return (beep_handle)? 0 : 1;
5493 static int beep_read(struct seq_file *m)
5495 if (!beep_handle)
5496 seq_printf(m, "status:\t\tnot supported\n");
5497 else {
5498 seq_printf(m, "status:\t\tsupported\n");
5499 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5502 return 0;
5505 static int beep_write(char *buf)
5507 char *cmd;
5508 int beep_cmd;
5510 if (!beep_handle)
5511 return -ENODEV;
5513 while ((cmd = next_cmd(&buf))) {
5514 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5515 beep_cmd >= 0 && beep_cmd <= 17) {
5516 /* beep_cmd set */
5517 } else
5518 return -EINVAL;
5519 if (tp_features.beep_needs_two_args) {
5520 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5521 beep_cmd, 0))
5522 return -EIO;
5523 } else {
5524 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5525 beep_cmd))
5526 return -EIO;
5530 return 0;
5533 static struct ibm_struct beep_driver_data = {
5534 .name = "beep",
5535 .read = beep_read,
5536 .write = beep_write,
5539 /*************************************************************************
5540 * Thermal subdriver
5543 enum thermal_access_mode {
5544 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5545 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5546 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5547 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5548 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5551 enum { /* TPACPI_THERMAL_TPEC_* */
5552 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5553 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5554 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5556 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5560 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5561 struct ibm_thermal_sensors_struct {
5562 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5565 static enum thermal_access_mode thermal_read_mode;
5567 /* idx is zero-based */
5568 static int thermal_get_sensor(int idx, s32 *value)
5570 int t;
5571 s8 tmp;
5572 char tmpi[5];
5574 t = TP_EC_THERMAL_TMP0;
5576 switch (thermal_read_mode) {
5577 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5578 case TPACPI_THERMAL_TPEC_16:
5579 if (idx >= 8 && idx <= 15) {
5580 t = TP_EC_THERMAL_TMP8;
5581 idx -= 8;
5583 /* fallthrough */
5584 #endif
5585 case TPACPI_THERMAL_TPEC_8:
5586 if (idx <= 7) {
5587 if (!acpi_ec_read(t + idx, &tmp))
5588 return -EIO;
5589 *value = tmp * 1000;
5590 return 0;
5592 break;
5594 case TPACPI_THERMAL_ACPI_UPDT:
5595 if (idx <= 7) {
5596 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5597 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5598 return -EIO;
5599 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5600 return -EIO;
5601 *value = (t - 2732) * 100;
5602 return 0;
5604 break;
5606 case TPACPI_THERMAL_ACPI_TMP07:
5607 if (idx <= 7) {
5608 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5609 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5610 return -EIO;
5611 if (t > 127 || t < -127)
5612 t = TP_EC_THERMAL_TMP_NA;
5613 *value = t * 1000;
5614 return 0;
5616 break;
5618 case TPACPI_THERMAL_NONE:
5619 default:
5620 return -ENOSYS;
5623 return -EINVAL;
5626 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5628 int res, i;
5629 int n;
5631 n = 8;
5632 i = 0;
5634 if (!s)
5635 return -EINVAL;
5637 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5638 n = 16;
5640 for (i = 0 ; i < n; i++) {
5641 res = thermal_get_sensor(i, &s->temp[i]);
5642 if (res)
5643 return res;
5646 return n;
5649 static void thermal_dump_all_sensors(void)
5651 int n, i;
5652 struct ibm_thermal_sensors_struct t;
5654 n = thermal_get_sensors(&t);
5655 if (n <= 0)
5656 return;
5658 printk(TPACPI_NOTICE
5659 "temperatures (Celsius):");
5661 for (i = 0; i < n; i++) {
5662 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5663 printk(KERN_CONT " %d", (int)(t.temp[i] / 1000));
5664 else
5665 printk(KERN_CONT " N/A");
5668 printk(KERN_CONT "\n");
5671 /* sysfs temp##_input -------------------------------------------------- */
5673 static ssize_t thermal_temp_input_show(struct device *dev,
5674 struct device_attribute *attr,
5675 char *buf)
5677 struct sensor_device_attribute *sensor_attr =
5678 to_sensor_dev_attr(attr);
5679 int idx = sensor_attr->index;
5680 s32 value;
5681 int res;
5683 res = thermal_get_sensor(idx, &value);
5684 if (res)
5685 return res;
5686 if (value == TPACPI_THERMAL_SENSOR_NA)
5687 return -ENXIO;
5689 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5692 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5693 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5694 thermal_temp_input_show, NULL, _idxB)
5696 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5697 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5698 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5699 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5700 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5701 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5702 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5703 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5704 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5705 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5706 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5707 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5708 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5709 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5710 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5711 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5712 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5715 #define THERMAL_ATTRS(X) \
5716 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5718 static struct attribute *thermal_temp_input_attr[] = {
5719 THERMAL_ATTRS(8),
5720 THERMAL_ATTRS(9),
5721 THERMAL_ATTRS(10),
5722 THERMAL_ATTRS(11),
5723 THERMAL_ATTRS(12),
5724 THERMAL_ATTRS(13),
5725 THERMAL_ATTRS(14),
5726 THERMAL_ATTRS(15),
5727 THERMAL_ATTRS(0),
5728 THERMAL_ATTRS(1),
5729 THERMAL_ATTRS(2),
5730 THERMAL_ATTRS(3),
5731 THERMAL_ATTRS(4),
5732 THERMAL_ATTRS(5),
5733 THERMAL_ATTRS(6),
5734 THERMAL_ATTRS(7),
5735 NULL
5738 static const struct attribute_group thermal_temp_input16_group = {
5739 .attrs = thermal_temp_input_attr
5742 static const struct attribute_group thermal_temp_input8_group = {
5743 .attrs = &thermal_temp_input_attr[8]
5746 #undef THERMAL_SENSOR_ATTR_TEMP
5747 #undef THERMAL_ATTRS
5749 /* --------------------------------------------------------------------- */
5751 static int __init thermal_init(struct ibm_init_struct *iibm)
5753 u8 t, ta1, ta2;
5754 int i;
5755 int acpi_tmp7;
5756 int res;
5758 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5760 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5762 if (thinkpad_id.ec_model) {
5764 * Direct EC access mode: sensors at registers
5765 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5766 * non-implemented, thermal sensors return 0x80 when
5767 * not available
5770 ta1 = ta2 = 0;
5771 for (i = 0; i < 8; i++) {
5772 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5773 ta1 |= t;
5774 } else {
5775 ta1 = 0;
5776 break;
5778 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5779 ta2 |= t;
5780 } else {
5781 ta1 = 0;
5782 break;
5785 if (ta1 == 0) {
5786 /* This is sheer paranoia, but we handle it anyway */
5787 if (acpi_tmp7) {
5788 printk(TPACPI_ERR
5789 "ThinkPad ACPI EC access misbehaving, "
5790 "falling back to ACPI TMPx access "
5791 "mode\n");
5792 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5793 } else {
5794 printk(TPACPI_ERR
5795 "ThinkPad ACPI EC access misbehaving, "
5796 "disabling thermal sensors access\n");
5797 thermal_read_mode = TPACPI_THERMAL_NONE;
5799 } else {
5800 thermal_read_mode =
5801 (ta2 != 0) ?
5802 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5804 } else if (acpi_tmp7) {
5805 if (tpacpi_is_ibm() &&
5806 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5807 /* 600e/x, 770e, 770x */
5808 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5809 } else {
5810 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5811 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5813 } else {
5814 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5815 thermal_read_mode = TPACPI_THERMAL_NONE;
5818 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5819 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5820 thermal_read_mode);
5822 switch (thermal_read_mode) {
5823 case TPACPI_THERMAL_TPEC_16:
5824 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5825 &thermal_temp_input16_group);
5826 if (res)
5827 return res;
5828 break;
5829 case TPACPI_THERMAL_TPEC_8:
5830 case TPACPI_THERMAL_ACPI_TMP07:
5831 case TPACPI_THERMAL_ACPI_UPDT:
5832 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5833 &thermal_temp_input8_group);
5834 if (res)
5835 return res;
5836 break;
5837 case TPACPI_THERMAL_NONE:
5838 default:
5839 return 1;
5842 return 0;
5845 static void thermal_exit(void)
5847 switch (thermal_read_mode) {
5848 case TPACPI_THERMAL_TPEC_16:
5849 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5850 &thermal_temp_input16_group);
5851 break;
5852 case TPACPI_THERMAL_TPEC_8:
5853 case TPACPI_THERMAL_ACPI_TMP07:
5854 case TPACPI_THERMAL_ACPI_UPDT:
5855 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5856 &thermal_temp_input8_group);
5857 break;
5858 case TPACPI_THERMAL_NONE:
5859 default:
5860 break;
5864 static int thermal_read(struct seq_file *m)
5866 int n, i;
5867 struct ibm_thermal_sensors_struct t;
5869 n = thermal_get_sensors(&t);
5870 if (unlikely(n < 0))
5871 return n;
5873 seq_printf(m, "temperatures:\t");
5875 if (n > 0) {
5876 for (i = 0; i < (n - 1); i++)
5877 seq_printf(m, "%d ", t.temp[i] / 1000);
5878 seq_printf(m, "%d\n", t.temp[i] / 1000);
5879 } else
5880 seq_printf(m, "not supported\n");
5882 return 0;
5885 static struct ibm_struct thermal_driver_data = {
5886 .name = "thermal",
5887 .read = thermal_read,
5888 .exit = thermal_exit,
5891 /*************************************************************************
5892 * EC Dump subdriver
5895 static u8 ecdump_regs[256];
5897 static int ecdump_read(struct seq_file *m)
5899 int i, j;
5900 u8 v;
5902 seq_printf(m, "EC "
5903 " +00 +01 +02 +03 +04 +05 +06 +07"
5904 " +08 +09 +0a +0b +0c +0d +0e +0f\n");
5905 for (i = 0; i < 256; i += 16) {
5906 seq_printf(m, "EC 0x%02x:", i);
5907 for (j = 0; j < 16; j++) {
5908 if (!acpi_ec_read(i + j, &v))
5909 break;
5910 if (v != ecdump_regs[i + j])
5911 seq_printf(m, " *%02x", v);
5912 else
5913 seq_printf(m, " %02x", v);
5914 ecdump_regs[i + j] = v;
5916 seq_putc(m, '\n');
5917 if (j != 16)
5918 break;
5921 /* These are way too dangerous to advertise openly... */
5922 #if 0
5923 seq_printf(m, "commands:\t0x<offset> 0x<value>"
5924 " (<offset> is 00-ff, <value> is 00-ff)\n");
5925 seq_printf(m, "commands:\t0x<offset> <value> "
5926 " (<offset> is 00-ff, <value> is 0-255)\n");
5927 #endif
5928 return 0;
5931 static int ecdump_write(char *buf)
5933 char *cmd;
5934 int i, v;
5936 while ((cmd = next_cmd(&buf))) {
5937 if (sscanf(cmd, "0x%x 0x%x", &i, &v) == 2) {
5938 /* i and v set */
5939 } else if (sscanf(cmd, "0x%x %u", &i, &v) == 2) {
5940 /* i and v set */
5941 } else
5942 return -EINVAL;
5943 if (i >= 0 && i < 256 && v >= 0 && v < 256) {
5944 if (!acpi_ec_write(i, v))
5945 return -EIO;
5946 } else
5947 return -EINVAL;
5950 return 0;
5953 static struct ibm_struct ecdump_driver_data = {
5954 .name = "ecdump",
5955 .read = ecdump_read,
5956 .write = ecdump_write,
5957 .flags.experimental = 1,
5960 /*************************************************************************
5961 * Backlight/brightness subdriver
5964 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5967 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5968 * CMOS NVRAM byte 0x5E, bits 0-3.
5970 * EC HBRV (0x31) has the following layout
5971 * Bit 7: unknown function
5972 * Bit 6: unknown function
5973 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5974 * Bit 4: must be set to zero to avoid problems
5975 * Bit 3-0: backlight brightness level
5977 * brightness_get_raw returns status data in the HBRV layout
5979 * WARNING: The X61 has been verified to use HBRV for something else, so
5980 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5981 * testing on the very early *60 Lenovo models...
5984 enum {
5985 TP_EC_BACKLIGHT = 0x31,
5987 /* TP_EC_BACKLIGHT bitmasks */
5988 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5989 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5990 TP_EC_BACKLIGHT_MAPSW = 0x20,
5993 enum tpacpi_brightness_access_mode {
5994 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5995 TPACPI_BRGHT_MODE_EC, /* EC control */
5996 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5997 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5998 TPACPI_BRGHT_MODE_MAX
6001 static struct backlight_device *ibm_backlight_device;
6003 static enum tpacpi_brightness_access_mode brightness_mode =
6004 TPACPI_BRGHT_MODE_MAX;
6006 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6008 static struct mutex brightness_mutex;
6010 /* NVRAM brightness access,
6011 * call with brightness_mutex held! */
6012 static unsigned int tpacpi_brightness_nvram_get(void)
6014 u8 lnvram;
6016 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6017 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6018 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6019 lnvram &= (tp_features.bright_16levels) ? 0x0f : 0x07;
6021 return lnvram;
6024 static void tpacpi_brightness_checkpoint_nvram(void)
6026 u8 lec = 0;
6027 u8 b_nvram;
6029 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6030 return;
6032 vdbg_printk(TPACPI_DBG_BRGHT,
6033 "trying to checkpoint backlight level to NVRAM...\n");
6035 if (mutex_lock_killable(&brightness_mutex) < 0)
6036 return;
6038 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6039 goto unlock;
6040 lec &= TP_EC_BACKLIGHT_LVLMSK;
6041 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6043 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6044 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6045 /* NVRAM needs update */
6046 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6047 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6048 b_nvram |= lec;
6049 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6050 dbg_printk(TPACPI_DBG_BRGHT,
6051 "updated NVRAM backlight level to %u (0x%02x)\n",
6052 (unsigned int) lec, (unsigned int) b_nvram);
6053 } else
6054 vdbg_printk(TPACPI_DBG_BRGHT,
6055 "NVRAM backlight level already is %u (0x%02x)\n",
6056 (unsigned int) lec, (unsigned int) b_nvram);
6058 unlock:
6059 mutex_unlock(&brightness_mutex);
6063 /* call with brightness_mutex held! */
6064 static int tpacpi_brightness_get_raw(int *status)
6066 u8 lec = 0;
6068 switch (brightness_mode) {
6069 case TPACPI_BRGHT_MODE_UCMS_STEP:
6070 *status = tpacpi_brightness_nvram_get();
6071 return 0;
6072 case TPACPI_BRGHT_MODE_EC:
6073 case TPACPI_BRGHT_MODE_ECNVRAM:
6074 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6075 return -EIO;
6076 *status = lec;
6077 return 0;
6078 default:
6079 return -ENXIO;
6083 /* call with brightness_mutex held! */
6084 /* do NOT call with illegal backlight level value */
6085 static int tpacpi_brightness_set_ec(unsigned int value)
6087 u8 lec = 0;
6089 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6090 return -EIO;
6092 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6093 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6094 (value & TP_EC_BACKLIGHT_LVLMSK))))
6095 return -EIO;
6097 return 0;
6100 /* call with brightness_mutex held! */
6101 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6103 int cmos_cmd, inc;
6104 unsigned int current_value, i;
6106 current_value = tpacpi_brightness_nvram_get();
6108 if (value == current_value)
6109 return 0;
6111 cmos_cmd = (value > current_value) ?
6112 TP_CMOS_BRIGHTNESS_UP :
6113 TP_CMOS_BRIGHTNESS_DOWN;
6114 inc = (value > current_value) ? 1 : -1;
6116 for (i = current_value; i != value; i += inc)
6117 if (issue_thinkpad_cmos_command(cmos_cmd))
6118 return -EIO;
6120 return 0;
6123 /* May return EINTR which can always be mapped to ERESTARTSYS */
6124 static int brightness_set(unsigned int value)
6126 int res;
6128 if (value > ((tp_features.bright_16levels)? 15 : 7) ||
6129 value < 0)
6130 return -EINVAL;
6132 vdbg_printk(TPACPI_DBG_BRGHT,
6133 "set backlight level to %d\n", value);
6135 res = mutex_lock_killable(&brightness_mutex);
6136 if (res < 0)
6137 return res;
6139 switch (brightness_mode) {
6140 case TPACPI_BRGHT_MODE_EC:
6141 case TPACPI_BRGHT_MODE_ECNVRAM:
6142 res = tpacpi_brightness_set_ec(value);
6143 break;
6144 case TPACPI_BRGHT_MODE_UCMS_STEP:
6145 res = tpacpi_brightness_set_ucmsstep(value);
6146 break;
6147 default:
6148 res = -ENXIO;
6151 mutex_unlock(&brightness_mutex);
6152 return res;
6155 /* sysfs backlight class ----------------------------------------------- */
6157 static int brightness_update_status(struct backlight_device *bd)
6159 unsigned int level =
6160 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6161 bd->props.power == FB_BLANK_UNBLANK) ?
6162 bd->props.brightness : 0;
6164 dbg_printk(TPACPI_DBG_BRGHT,
6165 "backlight: attempt to set level to %d\n",
6166 level);
6168 /* it is the backlight class's job (caller) to handle
6169 * EINTR and other errors properly */
6170 return brightness_set(level);
6173 static int brightness_get(struct backlight_device *bd)
6175 int status, res;
6177 res = mutex_lock_killable(&brightness_mutex);
6178 if (res < 0)
6179 return 0;
6181 res = tpacpi_brightness_get_raw(&status);
6183 mutex_unlock(&brightness_mutex);
6185 if (res < 0)
6186 return 0;
6188 return status & TP_EC_BACKLIGHT_LVLMSK;
6191 static void tpacpi_brightness_notify_change(void)
6193 backlight_force_update(ibm_backlight_device,
6194 BACKLIGHT_UPDATE_HOTKEY);
6197 static struct backlight_ops ibm_backlight_data = {
6198 .get_brightness = brightness_get,
6199 .update_status = brightness_update_status,
6202 /* --------------------------------------------------------------------- */
6205 * These are only useful for models that have only one possibility
6206 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6207 * these quirks.
6209 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6210 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6211 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6213 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6214 /* Models with ATI GPUs known to require ECNVRAM mode */
6215 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6217 /* Models with ATI GPUs that can use ECNVRAM */
6218 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6219 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6220 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6221 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6223 /* Models with Intel Extreme Graphics 2 */
6224 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6225 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6226 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6228 /* Models with Intel GMA900 */
6229 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6230 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6231 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6234 static int __init brightness_init(struct ibm_init_struct *iibm)
6236 struct backlight_properties props;
6237 int b;
6238 unsigned long quirks;
6240 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6242 mutex_init(&brightness_mutex);
6244 quirks = tpacpi_check_quirks(brightness_quirk_table,
6245 ARRAY_SIZE(brightness_quirk_table));
6248 * We always attempt to detect acpi support, so as to switch
6249 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6250 * going to publish a backlight interface
6252 b = tpacpi_check_std_acpi_brightness_support();
6253 if (b > 0) {
6255 if (acpi_video_backlight_support()) {
6256 if (brightness_enable > 1) {
6257 printk(TPACPI_NOTICE
6258 "Standard ACPI backlight interface "
6259 "available, not loading native one.\n");
6260 return 1;
6261 } else if (brightness_enable == 1) {
6262 printk(TPACPI_NOTICE
6263 "Backlight control force enabled, even if standard "
6264 "ACPI backlight interface is available\n");
6266 } else {
6267 if (brightness_enable > 1) {
6268 printk(TPACPI_NOTICE
6269 "Standard ACPI backlight interface not "
6270 "available, thinkpad_acpi native "
6271 "brightness control enabled\n");
6276 if (!brightness_enable) {
6277 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6278 "brightness support disabled by "
6279 "module parameter\n");
6280 return 1;
6283 if (b > 16) {
6284 printk(TPACPI_ERR
6285 "Unsupported brightness interface, "
6286 "please contact %s\n", TPACPI_MAIL);
6287 return 1;
6289 if (b == 16)
6290 tp_features.bright_16levels = 1;
6293 * Check for module parameter bogosity, note that we
6294 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6295 * able to detect "unspecified"
6297 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6298 return -EINVAL;
6300 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6301 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6302 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6303 if (quirks & TPACPI_BRGHT_Q_EC)
6304 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6305 else
6306 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6308 dbg_printk(TPACPI_DBG_BRGHT,
6309 "driver auto-selected brightness_mode=%d\n",
6310 brightness_mode);
6313 /* Safety */
6314 if (!tpacpi_is_ibm() &&
6315 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6316 brightness_mode == TPACPI_BRGHT_MODE_EC))
6317 return -EINVAL;
6319 if (tpacpi_brightness_get_raw(&b) < 0)
6320 return 1;
6322 if (tp_features.bright_16levels)
6323 printk(TPACPI_INFO
6324 "detected a 16-level brightness capable ThinkPad\n");
6326 memset(&props, 0, sizeof(struct backlight_properties));
6327 props.max_brightness = (tp_features.bright_16levels) ? 15 : 7;
6328 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6329 NULL, NULL,
6330 &ibm_backlight_data,
6331 &props);
6332 if (IS_ERR(ibm_backlight_device)) {
6333 int rc = PTR_ERR(ibm_backlight_device);
6334 ibm_backlight_device = NULL;
6335 printk(TPACPI_ERR "Could not register backlight device\n");
6336 return rc;
6338 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6339 "brightness is supported\n");
6341 if (quirks & TPACPI_BRGHT_Q_ASK) {
6342 printk(TPACPI_NOTICE
6343 "brightness: will use unverified default: "
6344 "brightness_mode=%d\n", brightness_mode);
6345 printk(TPACPI_NOTICE
6346 "brightness: please report to %s whether it works well "
6347 "or not on your ThinkPad\n", TPACPI_MAIL);
6350 ibm_backlight_device->props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6351 backlight_update_status(ibm_backlight_device);
6353 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6354 "brightness: registering brightness hotkeys "
6355 "as change notification\n");
6356 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6357 | TP_ACPI_HKEY_BRGHTUP_MASK
6358 | TP_ACPI_HKEY_BRGHTDWN_MASK);;
6359 return 0;
6362 static void brightness_suspend(pm_message_t state)
6364 tpacpi_brightness_checkpoint_nvram();
6367 static void brightness_shutdown(void)
6369 tpacpi_brightness_checkpoint_nvram();
6372 static void brightness_exit(void)
6374 if (ibm_backlight_device) {
6375 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6376 "calling backlight_device_unregister()\n");
6377 backlight_device_unregister(ibm_backlight_device);
6380 tpacpi_brightness_checkpoint_nvram();
6383 static int brightness_read(struct seq_file *m)
6385 int level;
6387 level = brightness_get(NULL);
6388 if (level < 0) {
6389 seq_printf(m, "level:\t\tunreadable\n");
6390 } else {
6391 seq_printf(m, "level:\t\t%d\n", level);
6392 seq_printf(m, "commands:\tup, down\n");
6393 seq_printf(m, "commands:\tlevel <level>"
6394 " (<level> is 0-%d)\n",
6395 (tp_features.bright_16levels) ? 15 : 7);
6398 return 0;
6401 static int brightness_write(char *buf)
6403 int level;
6404 int rc;
6405 char *cmd;
6406 int max_level = (tp_features.bright_16levels) ? 15 : 7;
6408 level = brightness_get(NULL);
6409 if (level < 0)
6410 return level;
6412 while ((cmd = next_cmd(&buf))) {
6413 if (strlencmp(cmd, "up") == 0) {
6414 if (level < max_level)
6415 level++;
6416 } else if (strlencmp(cmd, "down") == 0) {
6417 if (level > 0)
6418 level--;
6419 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6420 level >= 0 && level <= max_level) {
6421 /* new level set */
6422 } else
6423 return -EINVAL;
6426 tpacpi_disclose_usertask("procfs brightness",
6427 "set level to %d\n", level);
6430 * Now we know what the final level should be, so we try to set it.
6431 * Doing it this way makes the syscall restartable in case of EINTR
6433 rc = brightness_set(level);
6434 if (!rc && ibm_backlight_device)
6435 backlight_force_update(ibm_backlight_device,
6436 BACKLIGHT_UPDATE_SYSFS);
6437 return (rc == -EINTR)? -ERESTARTSYS : rc;
6440 static struct ibm_struct brightness_driver_data = {
6441 .name = "brightness",
6442 .read = brightness_read,
6443 .write = brightness_write,
6444 .exit = brightness_exit,
6445 .suspend = brightness_suspend,
6446 .shutdown = brightness_shutdown,
6449 /*************************************************************************
6450 * Volume subdriver
6454 * IBM ThinkPads have a simple volume controller with MUTE gating.
6455 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6457 * Since the *61 series (and probably also the later *60 series), Lenovo
6458 * ThinkPads only implement the MUTE gate.
6460 * EC register 0x30
6461 * Bit 6: MUTE (1 mutes sound)
6462 * Bit 3-0: Volume
6463 * Other bits should be zero as far as we know.
6465 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6466 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
6467 * such as bit 7 which is used to detect repeated presses of MUTE,
6468 * and we leave them unchanged.
6471 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6473 #define TPACPI_ALSA_DRVNAME "ThinkPad EC"
6474 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6475 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6477 static int alsa_index = ~((1 << (SNDRV_CARDS - 3)) - 1); /* last three slots */
6478 static char *alsa_id = "ThinkPadEC";
6479 static int alsa_enable = SNDRV_DEFAULT_ENABLE1;
6481 struct tpacpi_alsa_data {
6482 struct snd_card *card;
6483 struct snd_ctl_elem_id *ctl_mute_id;
6484 struct snd_ctl_elem_id *ctl_vol_id;
6487 static struct snd_card *alsa_card;
6489 enum {
6490 TP_EC_AUDIO = 0x30,
6492 /* TP_EC_AUDIO bits */
6493 TP_EC_AUDIO_MUTESW = 6,
6495 /* TP_EC_AUDIO bitmasks */
6496 TP_EC_AUDIO_LVL_MSK = 0x0F,
6497 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6499 /* Maximum volume */
6500 TP_EC_VOLUME_MAX = 14,
6503 enum tpacpi_volume_access_mode {
6504 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
6505 TPACPI_VOL_MODE_EC, /* Pure EC control */
6506 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
6507 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6508 TPACPI_VOL_MODE_MAX
6511 enum tpacpi_volume_capabilities {
6512 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
6513 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
6514 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
6515 TPACPI_VOL_CAP_MAX
6518 static enum tpacpi_volume_access_mode volume_mode =
6519 TPACPI_VOL_MODE_MAX;
6521 static enum tpacpi_volume_capabilities volume_capabilities;
6522 static int volume_control_allowed;
6525 * Used to syncronize writers to TP_EC_AUDIO and
6526 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6528 static struct mutex volume_mutex;
6530 static void tpacpi_volume_checkpoint_nvram(void)
6532 u8 lec = 0;
6533 u8 b_nvram;
6534 u8 ec_mask;
6536 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6537 return;
6538 if (!volume_control_allowed)
6539 return;
6541 vdbg_printk(TPACPI_DBG_MIXER,
6542 "trying to checkpoint mixer state to NVRAM...\n");
6544 if (tp_features.mixer_no_level_control)
6545 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6546 else
6547 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6549 if (mutex_lock_killable(&volume_mutex) < 0)
6550 return;
6552 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6553 goto unlock;
6554 lec &= ec_mask;
6555 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6557 if (lec != (b_nvram & ec_mask)) {
6558 /* NVRAM needs update */
6559 b_nvram &= ~ec_mask;
6560 b_nvram |= lec;
6561 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6562 dbg_printk(TPACPI_DBG_MIXER,
6563 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6564 (unsigned int) lec, (unsigned int) b_nvram);
6565 } else {
6566 vdbg_printk(TPACPI_DBG_MIXER,
6567 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6568 (unsigned int) lec, (unsigned int) b_nvram);
6571 unlock:
6572 mutex_unlock(&volume_mutex);
6575 static int volume_get_status_ec(u8 *status)
6577 u8 s;
6579 if (!acpi_ec_read(TP_EC_AUDIO, &s))
6580 return -EIO;
6582 *status = s;
6584 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6586 return 0;
6589 static int volume_get_status(u8 *status)
6591 return volume_get_status_ec(status);
6594 static int volume_set_status_ec(const u8 status)
6596 if (!acpi_ec_write(TP_EC_AUDIO, status))
6597 return -EIO;
6599 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6601 return 0;
6604 static int volume_set_status(const u8 status)
6606 return volume_set_status_ec(status);
6609 /* returns < 0 on error, 0 on no change, 1 on change */
6610 static int __volume_set_mute_ec(const bool mute)
6612 int rc;
6613 u8 s, n;
6615 if (mutex_lock_killable(&volume_mutex) < 0)
6616 return -EINTR;
6618 rc = volume_get_status_ec(&s);
6619 if (rc)
6620 goto unlock;
6622 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6623 s & ~TP_EC_AUDIO_MUTESW_MSK;
6625 if (n != s) {
6626 rc = volume_set_status_ec(n);
6627 if (!rc)
6628 rc = 1;
6631 unlock:
6632 mutex_unlock(&volume_mutex);
6633 return rc;
6636 static int volume_alsa_set_mute(const bool mute)
6638 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6639 (mute) ? "" : "un");
6640 return __volume_set_mute_ec(mute);
6643 static int volume_set_mute(const bool mute)
6645 int rc;
6647 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6648 (mute) ? "" : "un");
6650 rc = __volume_set_mute_ec(mute);
6651 return (rc < 0) ? rc : 0;
6654 /* returns < 0 on error, 0 on no change, 1 on change */
6655 static int __volume_set_volume_ec(const u8 vol)
6657 int rc;
6658 u8 s, n;
6660 if (vol > TP_EC_VOLUME_MAX)
6661 return -EINVAL;
6663 if (mutex_lock_killable(&volume_mutex) < 0)
6664 return -EINTR;
6666 rc = volume_get_status_ec(&s);
6667 if (rc)
6668 goto unlock;
6670 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6672 if (n != s) {
6673 rc = volume_set_status_ec(n);
6674 if (!rc)
6675 rc = 1;
6678 unlock:
6679 mutex_unlock(&volume_mutex);
6680 return rc;
6683 static int volume_alsa_set_volume(const u8 vol)
6685 dbg_printk(TPACPI_DBG_MIXER,
6686 "ALSA: trying to set volume level to %hu\n", vol);
6687 return __volume_set_volume_ec(vol);
6690 static void volume_alsa_notify_change(void)
6692 struct tpacpi_alsa_data *d;
6694 if (alsa_card && alsa_card->private_data) {
6695 d = alsa_card->private_data;
6696 if (d->ctl_mute_id)
6697 snd_ctl_notify(alsa_card,
6698 SNDRV_CTL_EVENT_MASK_VALUE,
6699 d->ctl_mute_id);
6700 if (d->ctl_vol_id)
6701 snd_ctl_notify(alsa_card,
6702 SNDRV_CTL_EVENT_MASK_VALUE,
6703 d->ctl_vol_id);
6707 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6708 struct snd_ctl_elem_info *uinfo)
6710 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6711 uinfo->count = 1;
6712 uinfo->value.integer.min = 0;
6713 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6714 return 0;
6717 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6718 struct snd_ctl_elem_value *ucontrol)
6720 u8 s;
6721 int rc;
6723 rc = volume_get_status(&s);
6724 if (rc < 0)
6725 return rc;
6727 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6728 return 0;
6731 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6732 struct snd_ctl_elem_value *ucontrol)
6734 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6737 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
6739 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6740 struct snd_ctl_elem_value *ucontrol)
6742 u8 s;
6743 int rc;
6745 rc = volume_get_status(&s);
6746 if (rc < 0)
6747 return rc;
6749 ucontrol->value.integer.value[0] =
6750 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6751 return 0;
6754 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6755 struct snd_ctl_elem_value *ucontrol)
6757 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6760 static struct snd_kcontrol_new volume_alsa_control_vol __devinitdata = {
6761 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6762 .name = "Console Playback Volume",
6763 .index = 0,
6764 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6765 .info = volume_alsa_vol_info,
6766 .get = volume_alsa_vol_get,
6769 static struct snd_kcontrol_new volume_alsa_control_mute __devinitdata = {
6770 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6771 .name = "Console Playback Switch",
6772 .index = 0,
6773 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6774 .info = volume_alsa_mute_info,
6775 .get = volume_alsa_mute_get,
6778 static void volume_suspend(pm_message_t state)
6780 tpacpi_volume_checkpoint_nvram();
6783 static void volume_resume(void)
6785 volume_alsa_notify_change();
6788 static void volume_shutdown(void)
6790 tpacpi_volume_checkpoint_nvram();
6793 static void volume_exit(void)
6795 if (alsa_card) {
6796 snd_card_free(alsa_card);
6797 alsa_card = NULL;
6800 tpacpi_volume_checkpoint_nvram();
6803 static int __init volume_create_alsa_mixer(void)
6805 struct snd_card *card;
6806 struct tpacpi_alsa_data *data;
6807 struct snd_kcontrol *ctl_vol;
6808 struct snd_kcontrol *ctl_mute;
6809 int rc;
6811 rc = snd_card_create(alsa_index, alsa_id, THIS_MODULE,
6812 sizeof(struct tpacpi_alsa_data), &card);
6813 if (rc < 0 || !card) {
6814 printk(TPACPI_ERR
6815 "Failed to create ALSA card structures: %d\n", rc);
6816 return 1;
6819 BUG_ON(!card->private_data);
6820 data = card->private_data;
6821 data->card = card;
6823 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6824 sizeof(card->driver));
6825 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6826 sizeof(card->shortname));
6827 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6828 (thinkpad_id.ec_version_str) ?
6829 thinkpad_id.ec_version_str : "(unknown)");
6830 snprintf(card->longname, sizeof(card->longname),
6831 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6832 (thinkpad_id.ec_version_str) ?
6833 thinkpad_id.ec_version_str : "unknown");
6835 if (volume_control_allowed) {
6836 volume_alsa_control_vol.put = volume_alsa_vol_put;
6837 volume_alsa_control_vol.access =
6838 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6840 volume_alsa_control_mute.put = volume_alsa_mute_put;
6841 volume_alsa_control_mute.access =
6842 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6845 if (!tp_features.mixer_no_level_control) {
6846 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6847 rc = snd_ctl_add(card, ctl_vol);
6848 if (rc < 0) {
6849 printk(TPACPI_ERR
6850 "Failed to create ALSA volume control: %d\n",
6851 rc);
6852 goto err_exit;
6854 data->ctl_vol_id = &ctl_vol->id;
6857 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6858 rc = snd_ctl_add(card, ctl_mute);
6859 if (rc < 0) {
6860 printk(TPACPI_ERR "Failed to create ALSA mute control: %d\n",
6861 rc);
6862 goto err_exit;
6864 data->ctl_mute_id = &ctl_mute->id;
6866 snd_card_set_dev(card, &tpacpi_pdev->dev);
6867 rc = snd_card_register(card);
6868 if (rc < 0) {
6869 printk(TPACPI_ERR "Failed to register ALSA card: %d\n", rc);
6870 goto err_exit;
6873 alsa_card = card;
6874 return 0;
6876 err_exit:
6877 snd_card_free(card);
6878 return 1;
6881 #define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
6882 #define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
6884 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6885 /* Whitelist volume level on all IBM by default */
6886 { .vendor = PCI_VENDOR_ID_IBM,
6887 .bios = TPACPI_MATCH_ANY,
6888 .ec = TPACPI_MATCH_ANY,
6889 .quirks = TPACPI_VOL_Q_LEVEL },
6891 /* Lenovo models with volume control (needs confirmation) */
6892 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6893 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6894 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6895 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6896 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6897 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6898 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6900 /* Whitelist mute-only on all Lenovo by default */
6901 { .vendor = PCI_VENDOR_ID_LENOVO,
6902 .bios = TPACPI_MATCH_ANY,
6903 .ec = TPACPI_MATCH_ANY,
6904 .quirks = TPACPI_VOL_Q_MUTEONLY }
6907 static int __init volume_init(struct ibm_init_struct *iibm)
6909 unsigned long quirks;
6910 int rc;
6912 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
6914 mutex_init(&volume_mutex);
6917 * Check for module parameter bogosity, note that we
6918 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
6919 * able to detect "unspecified"
6921 if (volume_mode > TPACPI_VOL_MODE_MAX)
6922 return -EINVAL;
6924 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
6925 printk(TPACPI_ERR
6926 "UCMS step volume mode not implemented, "
6927 "please contact %s\n", TPACPI_MAIL);
6928 return 1;
6931 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
6932 return -EINVAL;
6935 * The ALSA mixer is our primary interface.
6936 * When disabled, don't install the subdriver at all
6938 if (!alsa_enable) {
6939 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6940 "ALSA mixer disabled by parameter, "
6941 "not loading volume subdriver...\n");
6942 return 1;
6945 quirks = tpacpi_check_quirks(volume_quirk_table,
6946 ARRAY_SIZE(volume_quirk_table));
6948 switch (volume_capabilities) {
6949 case TPACPI_VOL_CAP_AUTO:
6950 if (quirks & TPACPI_VOL_Q_MUTEONLY)
6951 tp_features.mixer_no_level_control = 1;
6952 else if (quirks & TPACPI_VOL_Q_LEVEL)
6953 tp_features.mixer_no_level_control = 0;
6954 else
6955 return 1; /* no mixer */
6956 break;
6957 case TPACPI_VOL_CAP_VOLMUTE:
6958 tp_features.mixer_no_level_control = 0;
6959 break;
6960 case TPACPI_VOL_CAP_MUTEONLY:
6961 tp_features.mixer_no_level_control = 1;
6962 break;
6963 default:
6964 return 1;
6967 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
6968 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6969 "using user-supplied volume_capabilities=%d\n",
6970 volume_capabilities);
6972 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
6973 volume_mode == TPACPI_VOL_MODE_MAX) {
6974 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
6976 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6977 "driver auto-selected volume_mode=%d\n",
6978 volume_mode);
6979 } else {
6980 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6981 "using user-supplied volume_mode=%d\n",
6982 volume_mode);
6985 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6986 "mute is supported, volume control is %s\n",
6987 str_supported(!tp_features.mixer_no_level_control));
6989 rc = volume_create_alsa_mixer();
6990 if (rc) {
6991 printk(TPACPI_ERR
6992 "Could not create the ALSA mixer interface\n");
6993 return rc;
6996 printk(TPACPI_INFO
6997 "Console audio control enabled, mode: %s\n",
6998 (volume_control_allowed) ?
6999 "override (read/write)" :
7000 "monitor (read only)");
7002 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7003 "registering volume hotkeys as change notification\n");
7004 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7005 | TP_ACPI_HKEY_VOLUP_MASK
7006 | TP_ACPI_HKEY_VOLDWN_MASK
7007 | TP_ACPI_HKEY_MUTE_MASK);
7009 return 0;
7012 static int volume_read(struct seq_file *m)
7014 u8 status;
7016 if (volume_get_status(&status) < 0) {
7017 seq_printf(m, "level:\t\tunreadable\n");
7018 } else {
7019 if (tp_features.mixer_no_level_control)
7020 seq_printf(m, "level:\t\tunsupported\n");
7021 else
7022 seq_printf(m, "level:\t\t%d\n",
7023 status & TP_EC_AUDIO_LVL_MSK);
7025 seq_printf(m, "mute:\t\t%s\n",
7026 onoff(status, TP_EC_AUDIO_MUTESW));
7028 if (volume_control_allowed) {
7029 seq_printf(m, "commands:\tunmute, mute\n");
7030 if (!tp_features.mixer_no_level_control) {
7031 seq_printf(m,
7032 "commands:\tup, down\n");
7033 seq_printf(m,
7034 "commands:\tlevel <level>"
7035 " (<level> is 0-%d)\n",
7036 TP_EC_VOLUME_MAX);
7041 return 0;
7044 static int volume_write(char *buf)
7046 u8 s;
7047 u8 new_level, new_mute;
7048 int l;
7049 char *cmd;
7050 int rc;
7053 * We do allow volume control at driver startup, so that the
7054 * user can set initial state through the volume=... parameter hack.
7056 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7057 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7058 tp_warned.volume_ctrl_forbidden = 1;
7059 printk(TPACPI_NOTICE
7060 "Console audio control in monitor mode, "
7061 "changes are not allowed.\n");
7062 printk(TPACPI_NOTICE
7063 "Use the volume_control=1 module parameter "
7064 "to enable volume control\n");
7066 return -EPERM;
7069 rc = volume_get_status(&s);
7070 if (rc < 0)
7071 return rc;
7073 new_level = s & TP_EC_AUDIO_LVL_MSK;
7074 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7076 while ((cmd = next_cmd(&buf))) {
7077 if (!tp_features.mixer_no_level_control) {
7078 if (strlencmp(cmd, "up") == 0) {
7079 if (new_mute)
7080 new_mute = 0;
7081 else if (new_level < TP_EC_VOLUME_MAX)
7082 new_level++;
7083 continue;
7084 } else if (strlencmp(cmd, "down") == 0) {
7085 if (new_mute)
7086 new_mute = 0;
7087 else if (new_level > 0)
7088 new_level--;
7089 continue;
7090 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7091 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7092 new_level = l;
7093 continue;
7096 if (strlencmp(cmd, "mute") == 0)
7097 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7098 else if (strlencmp(cmd, "unmute") == 0)
7099 new_mute = 0;
7100 else
7101 return -EINVAL;
7104 if (tp_features.mixer_no_level_control) {
7105 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7106 new_mute ? "" : "un");
7107 rc = volume_set_mute(!!new_mute);
7108 } else {
7109 tpacpi_disclose_usertask("procfs volume",
7110 "%smute and set level to %d\n",
7111 new_mute ? "" : "un", new_level);
7112 rc = volume_set_status(new_mute | new_level);
7114 volume_alsa_notify_change();
7116 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7119 static struct ibm_struct volume_driver_data = {
7120 .name = "volume",
7121 .read = volume_read,
7122 .write = volume_write,
7123 .exit = volume_exit,
7124 .suspend = volume_suspend,
7125 .resume = volume_resume,
7126 .shutdown = volume_shutdown,
7129 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7131 #define alsa_card NULL
7133 static void inline volume_alsa_notify_change(void)
7137 static int __init volume_init(struct ibm_init_struct *iibm)
7139 printk(TPACPI_INFO
7140 "volume: disabled as there is no ALSA support in this kernel\n");
7142 return 1;
7145 static struct ibm_struct volume_driver_data = {
7146 .name = "volume",
7149 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7151 /*************************************************************************
7152 * Fan subdriver
7156 * FAN ACCESS MODES
7158 * TPACPI_FAN_RD_ACPI_GFAN:
7159 * ACPI GFAN method: returns fan level
7161 * see TPACPI_FAN_WR_ACPI_SFAN
7162 * EC 0x2f (HFSP) not available if GFAN exists
7164 * TPACPI_FAN_WR_ACPI_SFAN:
7165 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7167 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7168 * it for writing.
7170 * TPACPI_FAN_WR_TPEC:
7171 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7172 * Supported on almost all ThinkPads
7174 * Fan speed changes of any sort (including those caused by the
7175 * disengaged mode) are usually done slowly by the firmware as the
7176 * maximum amount of fan duty cycle change per second seems to be
7177 * limited.
7179 * Reading is not available if GFAN exists.
7180 * Writing is not available if SFAN exists.
7182 * Bits
7183 * 7 automatic mode engaged;
7184 * (default operation mode of the ThinkPad)
7185 * fan level is ignored in this mode.
7186 * 6 full speed mode (takes precedence over bit 7);
7187 * not available on all thinkpads. May disable
7188 * the tachometer while the fan controller ramps up
7189 * the speed (which can take up to a few *minutes*).
7190 * Speeds up fan to 100% duty-cycle, which is far above
7191 * the standard RPM levels. It is not impossible that
7192 * it could cause hardware damage.
7193 * 5-3 unused in some models. Extra bits for fan level
7194 * in others, but still useless as all values above
7195 * 7 map to the same speed as level 7 in these models.
7196 * 2-0 fan level (0..7 usually)
7197 * 0x00 = stop
7198 * 0x07 = max (set when temperatures critical)
7199 * Some ThinkPads may have other levels, see
7200 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7202 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7203 * boot. Apparently the EC does not intialize it, so unless ACPI DSDT
7204 * does so, its initial value is meaningless (0x07).
7206 * For firmware bugs, refer to:
7207 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7209 * ----
7211 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7212 * Main fan tachometer reading (in RPM)
7214 * This register is present on all ThinkPads with a new-style EC, and
7215 * it is known not to be present on the A21m/e, and T22, as there is
7216 * something else in offset 0x84 according to the ACPI DSDT. Other
7217 * ThinkPads from this same time period (and earlier) probably lack the
7218 * tachometer as well.
7220 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7221 * was never fixed by IBM to report the EC firmware version string
7222 * probably support the tachometer (like the early X models), so
7223 * detecting it is quite hard. We need more data to know for sure.
7225 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7226 * might result.
7228 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7229 * mode.
7231 * For firmware bugs, refer to:
7232 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7234 * ----
7236 * ThinkPad EC register 0x31 bit 0 (only on select models)
7238 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7239 * show the speed of the main fan. When bit 0 of EC register 0x31
7240 * is one, the tachometer registers show the speed of the auxiliary
7241 * fan.
7243 * Fan control seems to affect both fans, regardless of the state
7244 * of this bit.
7246 * So far, only the firmware for the X60/X61 non-tablet versions
7247 * seem to support this (firmware TP-7M).
7249 * TPACPI_FAN_WR_ACPI_FANS:
7250 * ThinkPad X31, X40, X41. Not available in the X60.
7252 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7253 * high speed. ACPI DSDT seems to map these three speeds to levels
7254 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7255 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7257 * The speeds are stored on handles
7258 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7260 * There are three default speed sets, accessible as handles:
7261 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7263 * ACPI DSDT switches which set is in use depending on various
7264 * factors.
7266 * TPACPI_FAN_WR_TPEC is also available and should be used to
7267 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7268 * but the ACPI tables just mention level 7.
7271 enum { /* Fan control constants */
7272 fan_status_offset = 0x2f, /* EC register 0x2f */
7273 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7274 * 0x84 must be read before 0x85 */
7275 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7276 bit 0 selects which fan is active */
7278 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
7279 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
7281 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
7284 enum fan_status_access_mode {
7285 TPACPI_FAN_NONE = 0, /* No fan status or control */
7286 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
7287 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7290 enum fan_control_access_mode {
7291 TPACPI_FAN_WR_NONE = 0, /* No fan control */
7292 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
7293 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
7294 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
7297 enum fan_control_commands {
7298 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
7299 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
7300 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
7301 * and also watchdog cmd */
7304 static int fan_control_allowed;
7306 static enum fan_status_access_mode fan_status_access_mode;
7307 static enum fan_control_access_mode fan_control_access_mode;
7308 static enum fan_control_commands fan_control_commands;
7310 static u8 fan_control_initial_status;
7311 static u8 fan_control_desired_level;
7312 static u8 fan_control_resume_level;
7313 static int fan_watchdog_maxinterval;
7315 static struct mutex fan_mutex;
7317 static void fan_watchdog_fire(struct work_struct *ignored);
7318 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7320 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
7321 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7322 "\\FSPD", /* 600e/x, 770e, 770x */
7323 ); /* all others */
7324 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7325 "JFNS", /* 770x-JL */
7326 ); /* all others */
7329 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7330 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7331 * be in auto mode (0x80).
7333 * This is corrected by any write to HFSP either by the driver, or
7334 * by the firmware.
7336 * We assume 0x07 really means auto mode while this quirk is active,
7337 * as this is far more likely than the ThinkPad being in level 7,
7338 * which is only used by the firmware during thermal emergencies.
7340 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7341 * TP-70 (T43, R52), which are known to be buggy.
7344 static void fan_quirk1_setup(void)
7346 if (fan_control_initial_status == 0x07) {
7347 printk(TPACPI_NOTICE
7348 "fan_init: initial fan status is unknown, "
7349 "assuming it is in auto mode\n");
7350 tp_features.fan_ctrl_status_undef = 1;
7354 static void fan_quirk1_handle(u8 *fan_status)
7356 if (unlikely(tp_features.fan_ctrl_status_undef)) {
7357 if (*fan_status != fan_control_initial_status) {
7358 /* something changed the HFSP regisnter since
7359 * driver init time, so it is not undefined
7360 * anymore */
7361 tp_features.fan_ctrl_status_undef = 0;
7362 } else {
7363 /* Return most likely status. In fact, it
7364 * might be the only possible status */
7365 *fan_status = TP_EC_FAN_AUTO;
7370 /* Select main fan on X60/X61, NOOP on others */
7371 static bool fan_select_fan1(void)
7373 if (tp_features.second_fan) {
7374 u8 val;
7376 if (ec_read(fan_select_offset, &val) < 0)
7377 return false;
7378 val &= 0xFEU;
7379 if (ec_write(fan_select_offset, val) < 0)
7380 return false;
7382 return true;
7385 /* Select secondary fan on X60/X61 */
7386 static bool fan_select_fan2(void)
7388 u8 val;
7390 if (!tp_features.second_fan)
7391 return false;
7393 if (ec_read(fan_select_offset, &val) < 0)
7394 return false;
7395 val |= 0x01U;
7396 if (ec_write(fan_select_offset, val) < 0)
7397 return false;
7399 return true;
7403 * Call with fan_mutex held
7405 static void fan_update_desired_level(u8 status)
7407 if ((status &
7408 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7409 if (status > 7)
7410 fan_control_desired_level = 7;
7411 else
7412 fan_control_desired_level = status;
7416 static int fan_get_status(u8 *status)
7418 u8 s;
7420 /* TODO:
7421 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7423 switch (fan_status_access_mode) {
7424 case TPACPI_FAN_RD_ACPI_GFAN:
7425 /* 570, 600e/x, 770e, 770x */
7427 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
7428 return -EIO;
7430 if (likely(status))
7431 *status = s & 0x07;
7433 break;
7435 case TPACPI_FAN_RD_TPEC:
7436 /* all except 570, 600e/x, 770e, 770x */
7437 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7438 return -EIO;
7440 if (likely(status)) {
7441 *status = s;
7442 fan_quirk1_handle(status);
7445 break;
7447 default:
7448 return -ENXIO;
7451 return 0;
7454 static int fan_get_status_safe(u8 *status)
7456 int rc;
7457 u8 s;
7459 if (mutex_lock_killable(&fan_mutex))
7460 return -ERESTARTSYS;
7461 rc = fan_get_status(&s);
7462 if (!rc)
7463 fan_update_desired_level(s);
7464 mutex_unlock(&fan_mutex);
7466 if (status)
7467 *status = s;
7469 return rc;
7472 static int fan_get_speed(unsigned int *speed)
7474 u8 hi, lo;
7476 switch (fan_status_access_mode) {
7477 case TPACPI_FAN_RD_TPEC:
7478 /* all except 570, 600e/x, 770e, 770x */
7479 if (unlikely(!fan_select_fan1()))
7480 return -EIO;
7481 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7482 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7483 return -EIO;
7485 if (likely(speed))
7486 *speed = (hi << 8) | lo;
7488 break;
7490 default:
7491 return -ENXIO;
7494 return 0;
7497 static int fan2_get_speed(unsigned int *speed)
7499 u8 hi, lo;
7500 bool rc;
7502 switch (fan_status_access_mode) {
7503 case TPACPI_FAN_RD_TPEC:
7504 /* all except 570, 600e/x, 770e, 770x */
7505 if (unlikely(!fan_select_fan2()))
7506 return -EIO;
7507 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7508 !acpi_ec_read(fan_rpm_offset + 1, &hi);
7509 fan_select_fan1(); /* play it safe */
7510 if (rc)
7511 return -EIO;
7513 if (likely(speed))
7514 *speed = (hi << 8) | lo;
7516 break;
7518 default:
7519 return -ENXIO;
7522 return 0;
7525 static int fan_set_level(int level)
7527 if (!fan_control_allowed)
7528 return -EPERM;
7530 switch (fan_control_access_mode) {
7531 case TPACPI_FAN_WR_ACPI_SFAN:
7532 if (level >= 0 && level <= 7) {
7533 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7534 return -EIO;
7535 } else
7536 return -EINVAL;
7537 break;
7539 case TPACPI_FAN_WR_ACPI_FANS:
7540 case TPACPI_FAN_WR_TPEC:
7541 if (!(level & TP_EC_FAN_AUTO) &&
7542 !(level & TP_EC_FAN_FULLSPEED) &&
7543 ((level < 0) || (level > 7)))
7544 return -EINVAL;
7546 /* safety net should the EC not support AUTO
7547 * or FULLSPEED mode bits and just ignore them */
7548 if (level & TP_EC_FAN_FULLSPEED)
7549 level |= 7; /* safety min speed 7 */
7550 else if (level & TP_EC_FAN_AUTO)
7551 level |= 4; /* safety min speed 4 */
7553 if (!acpi_ec_write(fan_status_offset, level))
7554 return -EIO;
7555 else
7556 tp_features.fan_ctrl_status_undef = 0;
7557 break;
7559 default:
7560 return -ENXIO;
7563 vdbg_printk(TPACPI_DBG_FAN,
7564 "fan control: set fan control register to 0x%02x\n", level);
7565 return 0;
7568 static int fan_set_level_safe(int level)
7570 int rc;
7572 if (!fan_control_allowed)
7573 return -EPERM;
7575 if (mutex_lock_killable(&fan_mutex))
7576 return -ERESTARTSYS;
7578 if (level == TPACPI_FAN_LAST_LEVEL)
7579 level = fan_control_desired_level;
7581 rc = fan_set_level(level);
7582 if (!rc)
7583 fan_update_desired_level(level);
7585 mutex_unlock(&fan_mutex);
7586 return rc;
7589 static int fan_set_enable(void)
7591 u8 s;
7592 int rc;
7594 if (!fan_control_allowed)
7595 return -EPERM;
7597 if (mutex_lock_killable(&fan_mutex))
7598 return -ERESTARTSYS;
7600 switch (fan_control_access_mode) {
7601 case TPACPI_FAN_WR_ACPI_FANS:
7602 case TPACPI_FAN_WR_TPEC:
7603 rc = fan_get_status(&s);
7604 if (rc < 0)
7605 break;
7607 /* Don't go out of emergency fan mode */
7608 if (s != 7) {
7609 s &= 0x07;
7610 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7613 if (!acpi_ec_write(fan_status_offset, s))
7614 rc = -EIO;
7615 else {
7616 tp_features.fan_ctrl_status_undef = 0;
7617 rc = 0;
7619 break;
7621 case TPACPI_FAN_WR_ACPI_SFAN:
7622 rc = fan_get_status(&s);
7623 if (rc < 0)
7624 break;
7626 s &= 0x07;
7628 /* Set fan to at least level 4 */
7629 s |= 4;
7631 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7632 rc = -EIO;
7633 else
7634 rc = 0;
7635 break;
7637 default:
7638 rc = -ENXIO;
7641 mutex_unlock(&fan_mutex);
7643 if (!rc)
7644 vdbg_printk(TPACPI_DBG_FAN,
7645 "fan control: set fan control register to 0x%02x\n",
7647 return rc;
7650 static int fan_set_disable(void)
7652 int rc;
7654 if (!fan_control_allowed)
7655 return -EPERM;
7657 if (mutex_lock_killable(&fan_mutex))
7658 return -ERESTARTSYS;
7660 rc = 0;
7661 switch (fan_control_access_mode) {
7662 case TPACPI_FAN_WR_ACPI_FANS:
7663 case TPACPI_FAN_WR_TPEC:
7664 if (!acpi_ec_write(fan_status_offset, 0x00))
7665 rc = -EIO;
7666 else {
7667 fan_control_desired_level = 0;
7668 tp_features.fan_ctrl_status_undef = 0;
7670 break;
7672 case TPACPI_FAN_WR_ACPI_SFAN:
7673 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7674 rc = -EIO;
7675 else
7676 fan_control_desired_level = 0;
7677 break;
7679 default:
7680 rc = -ENXIO;
7683 if (!rc)
7684 vdbg_printk(TPACPI_DBG_FAN,
7685 "fan control: set fan control register to 0\n");
7687 mutex_unlock(&fan_mutex);
7688 return rc;
7691 static int fan_set_speed(int speed)
7693 int rc;
7695 if (!fan_control_allowed)
7696 return -EPERM;
7698 if (mutex_lock_killable(&fan_mutex))
7699 return -ERESTARTSYS;
7701 rc = 0;
7702 switch (fan_control_access_mode) {
7703 case TPACPI_FAN_WR_ACPI_FANS:
7704 if (speed >= 0 && speed <= 65535) {
7705 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7706 speed, speed, speed))
7707 rc = -EIO;
7708 } else
7709 rc = -EINVAL;
7710 break;
7712 default:
7713 rc = -ENXIO;
7716 mutex_unlock(&fan_mutex);
7717 return rc;
7720 static void fan_watchdog_reset(void)
7722 static int fan_watchdog_active;
7724 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7725 return;
7727 if (fan_watchdog_active)
7728 cancel_delayed_work(&fan_watchdog_task);
7730 if (fan_watchdog_maxinterval > 0 &&
7731 tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7732 fan_watchdog_active = 1;
7733 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7734 msecs_to_jiffies(fan_watchdog_maxinterval
7735 * 1000))) {
7736 printk(TPACPI_ERR
7737 "failed to queue the fan watchdog, "
7738 "watchdog will not trigger\n");
7740 } else
7741 fan_watchdog_active = 0;
7744 static void fan_watchdog_fire(struct work_struct *ignored)
7746 int rc;
7748 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7749 return;
7751 printk(TPACPI_NOTICE "fan watchdog: enabling fan\n");
7752 rc = fan_set_enable();
7753 if (rc < 0) {
7754 printk(TPACPI_ERR "fan watchdog: error %d while enabling fan, "
7755 "will try again later...\n", -rc);
7756 /* reschedule for later */
7757 fan_watchdog_reset();
7762 * SYSFS fan layout: hwmon compatible (device)
7764 * pwm*_enable:
7765 * 0: "disengaged" mode
7766 * 1: manual mode
7767 * 2: native EC "auto" mode (recommended, hardware default)
7769 * pwm*: set speed in manual mode, ignored otherwise.
7770 * 0 is level 0; 255 is level 7. Intermediate points done with linear
7771 * interpolation.
7773 * fan*_input: tachometer reading, RPM
7776 * SYSFS fan layout: extensions
7778 * fan_watchdog (driver):
7779 * fan watchdog interval in seconds, 0 disables (default), max 120
7782 /* sysfs fan pwm1_enable ----------------------------------------------- */
7783 static ssize_t fan_pwm1_enable_show(struct device *dev,
7784 struct device_attribute *attr,
7785 char *buf)
7787 int res, mode;
7788 u8 status;
7790 res = fan_get_status_safe(&status);
7791 if (res)
7792 return res;
7794 if (status & TP_EC_FAN_FULLSPEED) {
7795 mode = 0;
7796 } else if (status & TP_EC_FAN_AUTO) {
7797 mode = 2;
7798 } else
7799 mode = 1;
7801 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7804 static ssize_t fan_pwm1_enable_store(struct device *dev,
7805 struct device_attribute *attr,
7806 const char *buf, size_t count)
7808 unsigned long t;
7809 int res, level;
7811 if (parse_strtoul(buf, 2, &t))
7812 return -EINVAL;
7814 tpacpi_disclose_usertask("hwmon pwm1_enable",
7815 "set fan mode to %lu\n", t);
7817 switch (t) {
7818 case 0:
7819 level = TP_EC_FAN_FULLSPEED;
7820 break;
7821 case 1:
7822 level = TPACPI_FAN_LAST_LEVEL;
7823 break;
7824 case 2:
7825 level = TP_EC_FAN_AUTO;
7826 break;
7827 case 3:
7828 /* reserved for software-controlled auto mode */
7829 return -ENOSYS;
7830 default:
7831 return -EINVAL;
7834 res = fan_set_level_safe(level);
7835 if (res == -ENXIO)
7836 return -EINVAL;
7837 else if (res < 0)
7838 return res;
7840 fan_watchdog_reset();
7842 return count;
7845 static struct device_attribute dev_attr_fan_pwm1_enable =
7846 __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7847 fan_pwm1_enable_show, fan_pwm1_enable_store);
7849 /* sysfs fan pwm1 ------------------------------------------------------ */
7850 static ssize_t fan_pwm1_show(struct device *dev,
7851 struct device_attribute *attr,
7852 char *buf)
7854 int res;
7855 u8 status;
7857 res = fan_get_status_safe(&status);
7858 if (res)
7859 return res;
7861 if ((status &
7862 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7863 status = fan_control_desired_level;
7865 if (status > 7)
7866 status = 7;
7868 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7871 static ssize_t fan_pwm1_store(struct device *dev,
7872 struct device_attribute *attr,
7873 const char *buf, size_t count)
7875 unsigned long s;
7876 int rc;
7877 u8 status, newlevel;
7879 if (parse_strtoul(buf, 255, &s))
7880 return -EINVAL;
7882 tpacpi_disclose_usertask("hwmon pwm1",
7883 "set fan speed to %lu\n", s);
7885 /* scale down from 0-255 to 0-7 */
7886 newlevel = (s >> 5) & 0x07;
7888 if (mutex_lock_killable(&fan_mutex))
7889 return -ERESTARTSYS;
7891 rc = fan_get_status(&status);
7892 if (!rc && (status &
7893 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7894 rc = fan_set_level(newlevel);
7895 if (rc == -ENXIO)
7896 rc = -EINVAL;
7897 else if (!rc) {
7898 fan_update_desired_level(newlevel);
7899 fan_watchdog_reset();
7903 mutex_unlock(&fan_mutex);
7904 return (rc)? rc : count;
7907 static struct device_attribute dev_attr_fan_pwm1 =
7908 __ATTR(pwm1, S_IWUSR | S_IRUGO,
7909 fan_pwm1_show, fan_pwm1_store);
7911 /* sysfs fan fan1_input ------------------------------------------------ */
7912 static ssize_t fan_fan1_input_show(struct device *dev,
7913 struct device_attribute *attr,
7914 char *buf)
7916 int res;
7917 unsigned int speed;
7919 res = fan_get_speed(&speed);
7920 if (res < 0)
7921 return res;
7923 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7926 static struct device_attribute dev_attr_fan_fan1_input =
7927 __ATTR(fan1_input, S_IRUGO,
7928 fan_fan1_input_show, NULL);
7930 /* sysfs fan fan2_input ------------------------------------------------ */
7931 static ssize_t fan_fan2_input_show(struct device *dev,
7932 struct device_attribute *attr,
7933 char *buf)
7935 int res;
7936 unsigned int speed;
7938 res = fan2_get_speed(&speed);
7939 if (res < 0)
7940 return res;
7942 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7945 static struct device_attribute dev_attr_fan_fan2_input =
7946 __ATTR(fan2_input, S_IRUGO,
7947 fan_fan2_input_show, NULL);
7949 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7950 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7951 char *buf)
7953 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7956 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7957 const char *buf, size_t count)
7959 unsigned long t;
7961 if (parse_strtoul(buf, 120, &t))
7962 return -EINVAL;
7964 if (!fan_control_allowed)
7965 return -EPERM;
7967 fan_watchdog_maxinterval = t;
7968 fan_watchdog_reset();
7970 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7972 return count;
7975 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7976 fan_fan_watchdog_show, fan_fan_watchdog_store);
7978 /* --------------------------------------------------------------------- */
7979 static struct attribute *fan_attributes[] = {
7980 &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7981 &dev_attr_fan_fan1_input.attr,
7982 NULL, /* for fan2_input */
7983 NULL
7986 static const struct attribute_group fan_attr_group = {
7987 .attrs = fan_attributes,
7990 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
7991 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
7993 #define TPACPI_FAN_QI(__id1, __id2, __quirks) \
7994 { .vendor = PCI_VENDOR_ID_IBM, \
7995 .bios = TPACPI_MATCH_ANY, \
7996 .ec = TPID(__id1, __id2), \
7997 .quirks = __quirks }
7999 #define TPACPI_FAN_QL(__id1, __id2, __quirks) \
8000 { .vendor = PCI_VENDOR_ID_LENOVO, \
8001 .bios = TPACPI_MATCH_ANY, \
8002 .ec = TPID(__id1, __id2), \
8003 .quirks = __quirks }
8005 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8006 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
8007 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
8008 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
8009 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
8010 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
8013 #undef TPACPI_FAN_QL
8014 #undef TPACPI_FAN_QI
8016 static int __init fan_init(struct ibm_init_struct *iibm)
8018 int rc;
8019 unsigned long quirks;
8021 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8022 "initializing fan subdriver\n");
8024 mutex_init(&fan_mutex);
8025 fan_status_access_mode = TPACPI_FAN_NONE;
8026 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8027 fan_control_commands = 0;
8028 fan_watchdog_maxinterval = 0;
8029 tp_features.fan_ctrl_status_undef = 0;
8030 tp_features.second_fan = 0;
8031 fan_control_desired_level = 7;
8033 if (tpacpi_is_ibm()) {
8034 TPACPI_ACPIHANDLE_INIT(fans);
8035 TPACPI_ACPIHANDLE_INIT(gfan);
8036 TPACPI_ACPIHANDLE_INIT(sfan);
8039 quirks = tpacpi_check_quirks(fan_quirk_table,
8040 ARRAY_SIZE(fan_quirk_table));
8042 if (gfan_handle) {
8043 /* 570, 600e/x, 770e, 770x */
8044 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8045 } else {
8046 /* all other ThinkPads: note that even old-style
8047 * ThinkPad ECs supports the fan control register */
8048 if (likely(acpi_ec_read(fan_status_offset,
8049 &fan_control_initial_status))) {
8050 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8051 if (quirks & TPACPI_FAN_Q1)
8052 fan_quirk1_setup();
8053 if (quirks & TPACPI_FAN_2FAN) {
8054 tp_features.second_fan = 1;
8055 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8056 "secondary fan support enabled\n");
8058 } else {
8059 printk(TPACPI_ERR
8060 "ThinkPad ACPI EC access misbehaving, "
8061 "fan status and control unavailable\n");
8062 return 1;
8066 if (sfan_handle) {
8067 /* 570, 770x-JL */
8068 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8069 fan_control_commands |=
8070 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8071 } else {
8072 if (!gfan_handle) {
8073 /* gfan without sfan means no fan control */
8074 /* all other models implement TP EC 0x2f control */
8076 if (fans_handle) {
8077 /* X31, X40, X41 */
8078 fan_control_access_mode =
8079 TPACPI_FAN_WR_ACPI_FANS;
8080 fan_control_commands |=
8081 TPACPI_FAN_CMD_SPEED |
8082 TPACPI_FAN_CMD_LEVEL |
8083 TPACPI_FAN_CMD_ENABLE;
8084 } else {
8085 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8086 fan_control_commands |=
8087 TPACPI_FAN_CMD_LEVEL |
8088 TPACPI_FAN_CMD_ENABLE;
8093 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8094 "fan is %s, modes %d, %d\n",
8095 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8096 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8097 fan_status_access_mode, fan_control_access_mode);
8099 /* fan control master switch */
8100 if (!fan_control_allowed) {
8101 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8102 fan_control_commands = 0;
8103 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8104 "fan control features disabled by parameter\n");
8107 /* update fan_control_desired_level */
8108 if (fan_status_access_mode != TPACPI_FAN_NONE)
8109 fan_get_status_safe(NULL);
8111 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8112 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8113 if (tp_features.second_fan) {
8114 /* attach second fan tachometer */
8115 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8116 &dev_attr_fan_fan2_input.attr;
8118 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8119 &fan_attr_group);
8120 if (rc < 0)
8121 return rc;
8123 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8124 &driver_attr_fan_watchdog);
8125 if (rc < 0) {
8126 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8127 &fan_attr_group);
8128 return rc;
8130 return 0;
8131 } else
8132 return 1;
8135 static void fan_exit(void)
8137 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8138 "cancelling any pending fan watchdog tasks\n");
8140 /* FIXME: can we really do this unconditionally? */
8141 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8142 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8143 &driver_attr_fan_watchdog);
8145 cancel_delayed_work(&fan_watchdog_task);
8146 flush_workqueue(tpacpi_wq);
8149 static void fan_suspend(pm_message_t state)
8151 int rc;
8153 if (!fan_control_allowed)
8154 return;
8156 /* Store fan status in cache */
8157 fan_control_resume_level = 0;
8158 rc = fan_get_status_safe(&fan_control_resume_level);
8159 if (rc < 0)
8160 printk(TPACPI_NOTICE
8161 "failed to read fan level for later "
8162 "restore during resume: %d\n", rc);
8164 /* if it is undefined, don't attempt to restore it.
8165 * KEEP THIS LAST */
8166 if (tp_features.fan_ctrl_status_undef)
8167 fan_control_resume_level = 0;
8170 static void fan_resume(void)
8172 u8 current_level = 7;
8173 bool do_set = false;
8174 int rc;
8176 /* DSDT *always* updates status on resume */
8177 tp_features.fan_ctrl_status_undef = 0;
8179 if (!fan_control_allowed ||
8180 !fan_control_resume_level ||
8181 (fan_get_status_safe(&current_level) < 0))
8182 return;
8184 switch (fan_control_access_mode) {
8185 case TPACPI_FAN_WR_ACPI_SFAN:
8186 /* never decrease fan level */
8187 do_set = (fan_control_resume_level > current_level);
8188 break;
8189 case TPACPI_FAN_WR_ACPI_FANS:
8190 case TPACPI_FAN_WR_TPEC:
8191 /* never decrease fan level, scale is:
8192 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8194 * We expect the firmware to set either 7 or AUTO, but we
8195 * handle FULLSPEED out of paranoia.
8197 * So, we can safely only restore FULLSPEED or 7, anything
8198 * else could slow the fan. Restoring AUTO is useless, at
8199 * best that's exactly what the DSDT already set (it is the
8200 * slower it uses).
8202 * Always keep in mind that the DSDT *will* have set the
8203 * fans to what the vendor supposes is the best level. We
8204 * muck with it only to speed the fan up.
8206 if (fan_control_resume_level != 7 &&
8207 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8208 return;
8209 else
8210 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8211 (current_level != fan_control_resume_level);
8212 break;
8213 default:
8214 return;
8216 if (do_set) {
8217 printk(TPACPI_NOTICE
8218 "restoring fan level to 0x%02x\n",
8219 fan_control_resume_level);
8220 rc = fan_set_level_safe(fan_control_resume_level);
8221 if (rc < 0)
8222 printk(TPACPI_NOTICE
8223 "failed to restore fan level: %d\n", rc);
8227 static int fan_read(struct seq_file *m)
8229 int rc;
8230 u8 status;
8231 unsigned int speed = 0;
8233 switch (fan_status_access_mode) {
8234 case TPACPI_FAN_RD_ACPI_GFAN:
8235 /* 570, 600e/x, 770e, 770x */
8236 rc = fan_get_status_safe(&status);
8237 if (rc < 0)
8238 return rc;
8240 seq_printf(m, "status:\t\t%s\n"
8241 "level:\t\t%d\n",
8242 (status != 0) ? "enabled" : "disabled", status);
8243 break;
8245 case TPACPI_FAN_RD_TPEC:
8246 /* all except 570, 600e/x, 770e, 770x */
8247 rc = fan_get_status_safe(&status);
8248 if (rc < 0)
8249 return rc;
8251 seq_printf(m, "status:\t\t%s\n",
8252 (status != 0) ? "enabled" : "disabled");
8254 rc = fan_get_speed(&speed);
8255 if (rc < 0)
8256 return rc;
8258 seq_printf(m, "speed:\t\t%d\n", speed);
8260 if (status & TP_EC_FAN_FULLSPEED)
8261 /* Disengaged mode takes precedence */
8262 seq_printf(m, "level:\t\tdisengaged\n");
8263 else if (status & TP_EC_FAN_AUTO)
8264 seq_printf(m, "level:\t\tauto\n");
8265 else
8266 seq_printf(m, "level:\t\t%d\n", status);
8267 break;
8269 case TPACPI_FAN_NONE:
8270 default:
8271 seq_printf(m, "status:\t\tnot supported\n");
8274 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8275 seq_printf(m, "commands:\tlevel <level>");
8277 switch (fan_control_access_mode) {
8278 case TPACPI_FAN_WR_ACPI_SFAN:
8279 seq_printf(m, " (<level> is 0-7)\n");
8280 break;
8282 default:
8283 seq_printf(m, " (<level> is 0-7, "
8284 "auto, disengaged, full-speed)\n");
8285 break;
8289 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8290 seq_printf(m, "commands:\tenable, disable\n"
8291 "commands:\twatchdog <timeout> (<timeout> "
8292 "is 0 (off), 1-120 (seconds))\n");
8294 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8295 seq_printf(m, "commands:\tspeed <speed>"
8296 " (<speed> is 0-65535)\n");
8298 return 0;
8301 static int fan_write_cmd_level(const char *cmd, int *rc)
8303 int level;
8305 if (strlencmp(cmd, "level auto") == 0)
8306 level = TP_EC_FAN_AUTO;
8307 else if ((strlencmp(cmd, "level disengaged") == 0) |
8308 (strlencmp(cmd, "level full-speed") == 0))
8309 level = TP_EC_FAN_FULLSPEED;
8310 else if (sscanf(cmd, "level %d", &level) != 1)
8311 return 0;
8313 *rc = fan_set_level_safe(level);
8314 if (*rc == -ENXIO)
8315 printk(TPACPI_ERR "level command accepted for unsupported "
8316 "access mode %d", fan_control_access_mode);
8317 else if (!*rc)
8318 tpacpi_disclose_usertask("procfs fan",
8319 "set level to %d\n", level);
8321 return 1;
8324 static int fan_write_cmd_enable(const char *cmd, int *rc)
8326 if (strlencmp(cmd, "enable") != 0)
8327 return 0;
8329 *rc = fan_set_enable();
8330 if (*rc == -ENXIO)
8331 printk(TPACPI_ERR "enable command accepted for unsupported "
8332 "access mode %d", fan_control_access_mode);
8333 else if (!*rc)
8334 tpacpi_disclose_usertask("procfs fan", "enable\n");
8336 return 1;
8339 static int fan_write_cmd_disable(const char *cmd, int *rc)
8341 if (strlencmp(cmd, "disable") != 0)
8342 return 0;
8344 *rc = fan_set_disable();
8345 if (*rc == -ENXIO)
8346 printk(TPACPI_ERR "disable command accepted for unsupported "
8347 "access mode %d", fan_control_access_mode);
8348 else if (!*rc)
8349 tpacpi_disclose_usertask("procfs fan", "disable\n");
8351 return 1;
8354 static int fan_write_cmd_speed(const char *cmd, int *rc)
8356 int speed;
8358 /* TODO:
8359 * Support speed <low> <medium> <high> ? */
8361 if (sscanf(cmd, "speed %d", &speed) != 1)
8362 return 0;
8364 *rc = fan_set_speed(speed);
8365 if (*rc == -ENXIO)
8366 printk(TPACPI_ERR "speed command accepted for unsupported "
8367 "access mode %d", fan_control_access_mode);
8368 else if (!*rc)
8369 tpacpi_disclose_usertask("procfs fan",
8370 "set speed to %d\n", speed);
8372 return 1;
8375 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8377 int interval;
8379 if (sscanf(cmd, "watchdog %d", &interval) != 1)
8380 return 0;
8382 if (interval < 0 || interval > 120)
8383 *rc = -EINVAL;
8384 else {
8385 fan_watchdog_maxinterval = interval;
8386 tpacpi_disclose_usertask("procfs fan",
8387 "set watchdog timer to %d\n",
8388 interval);
8391 return 1;
8394 static int fan_write(char *buf)
8396 char *cmd;
8397 int rc = 0;
8399 while (!rc && (cmd = next_cmd(&buf))) {
8400 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8401 fan_write_cmd_level(cmd, &rc)) &&
8402 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8403 (fan_write_cmd_enable(cmd, &rc) ||
8404 fan_write_cmd_disable(cmd, &rc) ||
8405 fan_write_cmd_watchdog(cmd, &rc))) &&
8406 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8407 fan_write_cmd_speed(cmd, &rc))
8409 rc = -EINVAL;
8410 else if (!rc)
8411 fan_watchdog_reset();
8414 return rc;
8417 static struct ibm_struct fan_driver_data = {
8418 .name = "fan",
8419 .read = fan_read,
8420 .write = fan_write,
8421 .exit = fan_exit,
8422 .suspend = fan_suspend,
8423 .resume = fan_resume,
8426 /****************************************************************************
8427 ****************************************************************************
8429 * Infrastructure
8431 ****************************************************************************
8432 ****************************************************************************/
8435 * HKEY event callout for other subdrivers go here
8436 * (yes, it is ugly, but it is quick, safe, and gets the job done
8438 static void tpacpi_driver_event(const unsigned int hkey_event)
8440 if (ibm_backlight_device) {
8441 switch (hkey_event) {
8442 case TP_HKEY_EV_BRGHT_UP:
8443 case TP_HKEY_EV_BRGHT_DOWN:
8444 tpacpi_brightness_notify_change();
8447 if (alsa_card) {
8448 switch (hkey_event) {
8449 case TP_HKEY_EV_VOL_UP:
8450 case TP_HKEY_EV_VOL_DOWN:
8451 case TP_HKEY_EV_VOL_MUTE:
8452 volume_alsa_notify_change();
8457 static void hotkey_driver_event(const unsigned int scancode)
8459 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8462 /* sysfs name ---------------------------------------------------------- */
8463 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8464 struct device_attribute *attr,
8465 char *buf)
8467 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8470 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8471 __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8473 /* --------------------------------------------------------------------- */
8475 /* /proc support */
8476 static struct proc_dir_entry *proc_dir;
8479 * Module and infrastructure proble, init and exit handling
8482 static int force_load;
8484 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
8485 static const char * __init str_supported(int is_supported)
8487 static char text_unsupported[] __initdata = "not supported";
8489 return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8491 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8493 static void ibm_exit(struct ibm_struct *ibm)
8495 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8497 list_del_init(&ibm->all_drivers);
8499 if (ibm->flags.acpi_notify_installed) {
8500 dbg_printk(TPACPI_DBG_EXIT,
8501 "%s: acpi_remove_notify_handler\n", ibm->name);
8502 BUG_ON(!ibm->acpi);
8503 acpi_remove_notify_handler(*ibm->acpi->handle,
8504 ibm->acpi->type,
8505 dispatch_acpi_notify);
8506 ibm->flags.acpi_notify_installed = 0;
8507 ibm->flags.acpi_notify_installed = 0;
8510 if (ibm->flags.proc_created) {
8511 dbg_printk(TPACPI_DBG_EXIT,
8512 "%s: remove_proc_entry\n", ibm->name);
8513 remove_proc_entry(ibm->name, proc_dir);
8514 ibm->flags.proc_created = 0;
8517 if (ibm->flags.acpi_driver_registered) {
8518 dbg_printk(TPACPI_DBG_EXIT,
8519 "%s: acpi_bus_unregister_driver\n", ibm->name);
8520 BUG_ON(!ibm->acpi);
8521 acpi_bus_unregister_driver(ibm->acpi->driver);
8522 kfree(ibm->acpi->driver);
8523 ibm->acpi->driver = NULL;
8524 ibm->flags.acpi_driver_registered = 0;
8527 if (ibm->flags.init_called && ibm->exit) {
8528 ibm->exit();
8529 ibm->flags.init_called = 0;
8532 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8535 static int __init ibm_init(struct ibm_init_struct *iibm)
8537 int ret;
8538 struct ibm_struct *ibm = iibm->data;
8539 struct proc_dir_entry *entry;
8541 BUG_ON(ibm == NULL);
8543 INIT_LIST_HEAD(&ibm->all_drivers);
8545 if (ibm->flags.experimental && !experimental)
8546 return 0;
8548 dbg_printk(TPACPI_DBG_INIT,
8549 "probing for %s\n", ibm->name);
8551 if (iibm->init) {
8552 ret = iibm->init(iibm);
8553 if (ret > 0)
8554 return 0; /* probe failed */
8555 if (ret)
8556 return ret;
8558 ibm->flags.init_called = 1;
8561 if (ibm->acpi) {
8562 if (ibm->acpi->hid) {
8563 ret = register_tpacpi_subdriver(ibm);
8564 if (ret)
8565 goto err_out;
8568 if (ibm->acpi->notify) {
8569 ret = setup_acpi_notify(ibm);
8570 if (ret == -ENODEV) {
8571 printk(TPACPI_NOTICE "disabling subdriver %s\n",
8572 ibm->name);
8573 ret = 0;
8574 goto err_out;
8576 if (ret < 0)
8577 goto err_out;
8581 dbg_printk(TPACPI_DBG_INIT,
8582 "%s installed\n", ibm->name);
8584 if (ibm->read) {
8585 mode_t mode = iibm->base_procfs_mode;
8587 if (!mode)
8588 mode = S_IRUGO;
8589 if (ibm->write)
8590 mode |= S_IWUSR;
8591 entry = proc_create_data(ibm->name, mode, proc_dir,
8592 &dispatch_proc_fops, ibm);
8593 if (!entry) {
8594 printk(TPACPI_ERR "unable to create proc entry %s\n",
8595 ibm->name);
8596 ret = -ENODEV;
8597 goto err_out;
8599 ibm->flags.proc_created = 1;
8602 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8604 return 0;
8606 err_out:
8607 dbg_printk(TPACPI_DBG_INIT,
8608 "%s: at error exit path with result %d\n",
8609 ibm->name, ret);
8611 ibm_exit(ibm);
8612 return (ret < 0)? ret : 0;
8615 /* Probing */
8617 static bool __pure __init tpacpi_is_fw_digit(const char c)
8619 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8622 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8623 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8624 const char t)
8626 return s && strlen(s) >= 8 &&
8627 tpacpi_is_fw_digit(s[0]) &&
8628 tpacpi_is_fw_digit(s[1]) &&
8629 s[2] == t && s[3] == 'T' &&
8630 tpacpi_is_fw_digit(s[4]) &&
8631 tpacpi_is_fw_digit(s[5]) &&
8632 s[6] == 'W' && s[7] == 'W';
8635 /* returns 0 - probe ok, or < 0 - probe error.
8636 * Probe ok doesn't mean thinkpad found.
8637 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8638 static int __must_check __init get_thinkpad_model_data(
8639 struct thinkpad_id_data *tp)
8641 const struct dmi_device *dev = NULL;
8642 char ec_fw_string[18];
8643 char const *s;
8645 if (!tp)
8646 return -EINVAL;
8648 memset(tp, 0, sizeof(*tp));
8650 if (dmi_name_in_vendors("IBM"))
8651 tp->vendor = PCI_VENDOR_ID_IBM;
8652 else if (dmi_name_in_vendors("LENOVO"))
8653 tp->vendor = PCI_VENDOR_ID_LENOVO;
8654 else
8655 return 0;
8657 s = dmi_get_system_info(DMI_BIOS_VERSION);
8658 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8659 if (s && !tp->bios_version_str)
8660 return -ENOMEM;
8662 /* Really ancient ThinkPad 240X will fail this, which is fine */
8663 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
8664 return 0;
8666 tp->bios_model = tp->bios_version_str[0]
8667 | (tp->bios_version_str[1] << 8);
8668 tp->bios_release = (tp->bios_version_str[4] << 8)
8669 | tp->bios_version_str[5];
8672 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8673 * X32 or newer, all Z series; Some models must have an
8674 * up-to-date BIOS or they will not be detected.
8676 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8678 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8679 if (sscanf(dev->name,
8680 "IBM ThinkPad Embedded Controller -[%17c",
8681 ec_fw_string) == 1) {
8682 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8683 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8685 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8686 if (!tp->ec_version_str)
8687 return -ENOMEM;
8689 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8690 tp->ec_model = ec_fw_string[0]
8691 | (ec_fw_string[1] << 8);
8692 tp->ec_release = (ec_fw_string[4] << 8)
8693 | ec_fw_string[5];
8694 } else {
8695 printk(TPACPI_NOTICE
8696 "ThinkPad firmware release %s "
8697 "doesn't match the known patterns\n",
8698 ec_fw_string);
8699 printk(TPACPI_NOTICE
8700 "please report this to %s\n",
8701 TPACPI_MAIL);
8703 break;
8707 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8708 if (s && !strnicmp(s, "ThinkPad", 8)) {
8709 tp->model_str = kstrdup(s, GFP_KERNEL);
8710 if (!tp->model_str)
8711 return -ENOMEM;
8714 s = dmi_get_system_info(DMI_PRODUCT_NAME);
8715 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8716 if (s && !tp->nummodel_str)
8717 return -ENOMEM;
8719 return 0;
8722 static int __init probe_for_thinkpad(void)
8724 int is_thinkpad;
8726 if (acpi_disabled)
8727 return -ENODEV;
8729 /* It would be dangerous to run the driver in this case */
8730 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8731 return -ENODEV;
8734 * Non-ancient models have better DMI tagging, but very old models
8735 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
8737 is_thinkpad = (thinkpad_id.model_str != NULL) ||
8738 (thinkpad_id.ec_model != 0) ||
8739 tpacpi_is_fw_known();
8741 /* ec is required because many other handles are relative to it */
8742 TPACPI_ACPIHANDLE_INIT(ec);
8743 if (!ec_handle) {
8744 if (is_thinkpad)
8745 printk(TPACPI_ERR
8746 "Not yet supported ThinkPad detected!\n");
8747 return -ENODEV;
8750 if (!is_thinkpad && !force_load)
8751 return -ENODEV;
8753 return 0;
8757 /* Module init, exit, parameters */
8759 static struct ibm_init_struct ibms_init[] __initdata = {
8761 .init = thinkpad_acpi_driver_init,
8762 .data = &thinkpad_acpi_driver_data,
8765 .init = hotkey_init,
8766 .data = &hotkey_driver_data,
8769 .init = bluetooth_init,
8770 .data = &bluetooth_driver_data,
8773 .init = wan_init,
8774 .data = &wan_driver_data,
8777 .init = uwb_init,
8778 .data = &uwb_driver_data,
8780 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8782 .init = video_init,
8783 .base_procfs_mode = S_IRUSR,
8784 .data = &video_driver_data,
8786 #endif
8788 .init = light_init,
8789 .data = &light_driver_data,
8792 .init = cmos_init,
8793 .data = &cmos_driver_data,
8796 .init = led_init,
8797 .data = &led_driver_data,
8800 .init = beep_init,
8801 .data = &beep_driver_data,
8804 .init = thermal_init,
8805 .data = &thermal_driver_data,
8808 .data = &ecdump_driver_data,
8811 .init = brightness_init,
8812 .data = &brightness_driver_data,
8815 .init = volume_init,
8816 .data = &volume_driver_data,
8819 .init = fan_init,
8820 .data = &fan_driver_data,
8824 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8826 unsigned int i;
8827 struct ibm_struct *ibm;
8829 if (!kp || !kp->name || !val)
8830 return -EINVAL;
8832 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8833 ibm = ibms_init[i].data;
8834 WARN_ON(ibm == NULL);
8836 if (!ibm || !ibm->name)
8837 continue;
8839 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8840 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8841 return -ENOSPC;
8842 strcpy(ibms_init[i].param, val);
8843 strcat(ibms_init[i].param, ",");
8844 return 0;
8848 return -EINVAL;
8851 module_param(experimental, int, 0444);
8852 MODULE_PARM_DESC(experimental,
8853 "Enables experimental features when non-zero");
8855 module_param_named(debug, dbg_level, uint, 0);
8856 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8858 module_param(force_load, bool, 0444);
8859 MODULE_PARM_DESC(force_load,
8860 "Attempts to load the driver even on a "
8861 "mis-identified ThinkPad when true");
8863 module_param_named(fan_control, fan_control_allowed, bool, 0444);
8864 MODULE_PARM_DESC(fan_control,
8865 "Enables setting fan parameters features when true");
8867 module_param_named(brightness_mode, brightness_mode, uint, 0444);
8868 MODULE_PARM_DESC(brightness_mode,
8869 "Selects brightness control strategy: "
8870 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8872 module_param(brightness_enable, uint, 0444);
8873 MODULE_PARM_DESC(brightness_enable,
8874 "Enables backlight control when 1, disables when 0");
8876 module_param(hotkey_report_mode, uint, 0444);
8877 MODULE_PARM_DESC(hotkey_report_mode,
8878 "used for backwards compatibility with userspace, "
8879 "see documentation");
8881 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8882 module_param_named(volume_mode, volume_mode, uint, 0444);
8883 MODULE_PARM_DESC(volume_mode,
8884 "Selects volume control strategy: "
8885 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8887 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8888 MODULE_PARM_DESC(volume_capabilities,
8889 "Selects the mixer capabilites: "
8890 "0=auto, 1=volume and mute, 2=mute only");
8892 module_param_named(volume_control, volume_control_allowed, bool, 0444);
8893 MODULE_PARM_DESC(volume_control,
8894 "Enables software override for the console audio "
8895 "control when true");
8897 /* ALSA module API parameters */
8898 module_param_named(index, alsa_index, int, 0444);
8899 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8900 module_param_named(id, alsa_id, charp, 0444);
8901 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8902 module_param_named(enable, alsa_enable, bool, 0444);
8903 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8904 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8906 #define TPACPI_PARAM(feature) \
8907 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8908 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8909 "at module load, see documentation")
8911 TPACPI_PARAM(hotkey);
8912 TPACPI_PARAM(bluetooth);
8913 TPACPI_PARAM(video);
8914 TPACPI_PARAM(light);
8915 TPACPI_PARAM(cmos);
8916 TPACPI_PARAM(led);
8917 TPACPI_PARAM(beep);
8918 TPACPI_PARAM(ecdump);
8919 TPACPI_PARAM(brightness);
8920 TPACPI_PARAM(volume);
8921 TPACPI_PARAM(fan);
8923 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8924 module_param(dbg_wlswemul, uint, 0444);
8925 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8926 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8927 MODULE_PARM_DESC(wlsw_state,
8928 "Initial state of the emulated WLSW switch");
8930 module_param(dbg_bluetoothemul, uint, 0444);
8931 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8932 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8933 MODULE_PARM_DESC(bluetooth_state,
8934 "Initial state of the emulated bluetooth switch");
8936 module_param(dbg_wwanemul, uint, 0444);
8937 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8938 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8939 MODULE_PARM_DESC(wwan_state,
8940 "Initial state of the emulated WWAN switch");
8942 module_param(dbg_uwbemul, uint, 0444);
8943 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8944 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8945 MODULE_PARM_DESC(uwb_state,
8946 "Initial state of the emulated UWB switch");
8947 #endif
8949 static void thinkpad_acpi_module_exit(void)
8951 struct ibm_struct *ibm, *itmp;
8953 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8955 list_for_each_entry_safe_reverse(ibm, itmp,
8956 &tpacpi_all_drivers,
8957 all_drivers) {
8958 ibm_exit(ibm);
8961 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8963 if (tpacpi_inputdev) {
8964 if (tp_features.input_device_registered)
8965 input_unregister_device(tpacpi_inputdev);
8966 else
8967 input_free_device(tpacpi_inputdev);
8970 if (tpacpi_hwmon)
8971 hwmon_device_unregister(tpacpi_hwmon);
8973 if (tp_features.sensors_pdev_attrs_registered)
8974 device_remove_file(&tpacpi_sensors_pdev->dev,
8975 &dev_attr_thinkpad_acpi_pdev_name);
8976 if (tpacpi_sensors_pdev)
8977 platform_device_unregister(tpacpi_sensors_pdev);
8978 if (tpacpi_pdev)
8979 platform_device_unregister(tpacpi_pdev);
8981 if (tp_features.sensors_pdrv_attrs_registered)
8982 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8983 if (tp_features.platform_drv_attrs_registered)
8984 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8986 if (tp_features.sensors_pdrv_registered)
8987 platform_driver_unregister(&tpacpi_hwmon_pdriver);
8989 if (tp_features.platform_drv_registered)
8990 platform_driver_unregister(&tpacpi_pdriver);
8992 if (proc_dir)
8993 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
8995 if (tpacpi_wq)
8996 destroy_workqueue(tpacpi_wq);
8998 kfree(thinkpad_id.bios_version_str);
8999 kfree(thinkpad_id.ec_version_str);
9000 kfree(thinkpad_id.model_str);
9004 static int __init thinkpad_acpi_module_init(void)
9006 int ret, i;
9008 tpacpi_lifecycle = TPACPI_LIFE_INIT;
9010 /* Parameter checking */
9011 if (hotkey_report_mode > 2)
9012 return -EINVAL;
9014 /* Driver-level probe */
9016 ret = get_thinkpad_model_data(&thinkpad_id);
9017 if (ret) {
9018 printk(TPACPI_ERR
9019 "unable to get DMI data: %d\n", ret);
9020 thinkpad_acpi_module_exit();
9021 return ret;
9023 ret = probe_for_thinkpad();
9024 if (ret) {
9025 thinkpad_acpi_module_exit();
9026 return ret;
9029 /* Driver initialization */
9031 TPACPI_ACPIHANDLE_INIT(ecrd);
9032 TPACPI_ACPIHANDLE_INIT(ecwr);
9034 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9035 if (!tpacpi_wq) {
9036 thinkpad_acpi_module_exit();
9037 return -ENOMEM;
9040 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9041 if (!proc_dir) {
9042 printk(TPACPI_ERR
9043 "unable to create proc dir " TPACPI_PROC_DIR);
9044 thinkpad_acpi_module_exit();
9045 return -ENODEV;
9048 ret = platform_driver_register(&tpacpi_pdriver);
9049 if (ret) {
9050 printk(TPACPI_ERR
9051 "unable to register main platform driver\n");
9052 thinkpad_acpi_module_exit();
9053 return ret;
9055 tp_features.platform_drv_registered = 1;
9057 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9058 if (ret) {
9059 printk(TPACPI_ERR
9060 "unable to register hwmon platform driver\n");
9061 thinkpad_acpi_module_exit();
9062 return ret;
9064 tp_features.sensors_pdrv_registered = 1;
9066 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9067 if (!ret) {
9068 tp_features.platform_drv_attrs_registered = 1;
9069 ret = tpacpi_create_driver_attributes(
9070 &tpacpi_hwmon_pdriver.driver);
9072 if (ret) {
9073 printk(TPACPI_ERR
9074 "unable to create sysfs driver attributes\n");
9075 thinkpad_acpi_module_exit();
9076 return ret;
9078 tp_features.sensors_pdrv_attrs_registered = 1;
9081 /* Device initialization */
9082 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9083 NULL, 0);
9084 if (IS_ERR(tpacpi_pdev)) {
9085 ret = PTR_ERR(tpacpi_pdev);
9086 tpacpi_pdev = NULL;
9087 printk(TPACPI_ERR "unable to register platform device\n");
9088 thinkpad_acpi_module_exit();
9089 return ret;
9091 tpacpi_sensors_pdev = platform_device_register_simple(
9092 TPACPI_HWMON_DRVR_NAME,
9093 -1, NULL, 0);
9094 if (IS_ERR(tpacpi_sensors_pdev)) {
9095 ret = PTR_ERR(tpacpi_sensors_pdev);
9096 tpacpi_sensors_pdev = NULL;
9097 printk(TPACPI_ERR
9098 "unable to register hwmon platform device\n");
9099 thinkpad_acpi_module_exit();
9100 return ret;
9102 ret = device_create_file(&tpacpi_sensors_pdev->dev,
9103 &dev_attr_thinkpad_acpi_pdev_name);
9104 if (ret) {
9105 printk(TPACPI_ERR
9106 "unable to create sysfs hwmon device attributes\n");
9107 thinkpad_acpi_module_exit();
9108 return ret;
9110 tp_features.sensors_pdev_attrs_registered = 1;
9111 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9112 if (IS_ERR(tpacpi_hwmon)) {
9113 ret = PTR_ERR(tpacpi_hwmon);
9114 tpacpi_hwmon = NULL;
9115 printk(TPACPI_ERR "unable to register hwmon device\n");
9116 thinkpad_acpi_module_exit();
9117 return ret;
9119 mutex_init(&tpacpi_inputdev_send_mutex);
9120 tpacpi_inputdev = input_allocate_device();
9121 if (!tpacpi_inputdev) {
9122 printk(TPACPI_ERR "unable to allocate input device\n");
9123 thinkpad_acpi_module_exit();
9124 return -ENOMEM;
9125 } else {
9126 /* Prepare input device, but don't register */
9127 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9128 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9129 tpacpi_inputdev->id.bustype = BUS_HOST;
9130 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9131 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9132 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9133 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9135 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9136 ret = ibm_init(&ibms_init[i]);
9137 if (ret >= 0 && *ibms_init[i].param)
9138 ret = ibms_init[i].data->write(ibms_init[i].param);
9139 if (ret < 0) {
9140 thinkpad_acpi_module_exit();
9141 return ret;
9145 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9147 ret = input_register_device(tpacpi_inputdev);
9148 if (ret < 0) {
9149 printk(TPACPI_ERR "unable to register input device\n");
9150 thinkpad_acpi_module_exit();
9151 return ret;
9152 } else {
9153 tp_features.input_device_registered = 1;
9156 return 0;
9159 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9162 * This will autoload the driver in almost every ThinkPad
9163 * in widespread use.
9165 * Only _VERY_ old models, like the 240, 240x and 570 lack
9166 * the HKEY event interface.
9168 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9171 * DMI matching for module autoloading
9173 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9174 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9176 * Only models listed in thinkwiki will be supported, so add yours
9177 * if it is not there yet.
9179 #define IBM_BIOS_MODULE_ALIAS(__type) \
9180 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9182 /* Ancient thinkpad BIOSes have to be identified by
9183 * BIOS type or model number, and there are far less
9184 * BIOS types than model numbers... */
9185 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
9187 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9188 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9189 MODULE_DESCRIPTION(TPACPI_DESC);
9190 MODULE_VERSION(TPACPI_VERSION);
9191 MODULE_LICENSE("GPL");
9193 module_init(thinkpad_acpi_module_init);
9194 module_exit(thinkpad_acpi_module_exit);