thinkpad-acpi: move greeting messages out of the first subdriver (v2)
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / platform / x86 / thinkpad_acpi.c
bloba768a69d58d2145a8992cc6e8cc22f613f004002
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 metadata subdriver
1894 static int thinkpad_acpi_driver_read(struct seq_file *m)
1896 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1897 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1898 return 0;
1901 static struct ibm_struct thinkpad_acpi_driver_data = {
1902 .name = "driver",
1903 .read = thinkpad_acpi_driver_read,
1906 /*************************************************************************
1907 * Hotkey subdriver
1911 * ThinkPad firmware event model
1913 * The ThinkPad firmware has two main event interfaces: normal ACPI
1914 * notifications (which follow the ACPI standard), and a private event
1915 * interface.
1917 * The private event interface also issues events for the hotkeys. As
1918 * the driver gained features, the event handling code ended up being
1919 * built around the hotkey subdriver. This will need to be refactored
1920 * to a more formal event API eventually.
1922 * Some "hotkeys" are actually supposed to be used as event reports,
1923 * such as "brightness has changed", "volume has changed", depending on
1924 * the ThinkPad model and how the firmware is operating.
1926 * Unlike other classes, hotkey-class events have mask/unmask control on
1927 * non-ancient firmware. However, how it behaves changes a lot with the
1928 * firmware model and version.
1931 enum { /* hot key scan codes (derived from ACPI DSDT) */
1932 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1933 TP_ACPI_HOTKEYSCAN_FNF2,
1934 TP_ACPI_HOTKEYSCAN_FNF3,
1935 TP_ACPI_HOTKEYSCAN_FNF4,
1936 TP_ACPI_HOTKEYSCAN_FNF5,
1937 TP_ACPI_HOTKEYSCAN_FNF6,
1938 TP_ACPI_HOTKEYSCAN_FNF7,
1939 TP_ACPI_HOTKEYSCAN_FNF8,
1940 TP_ACPI_HOTKEYSCAN_FNF9,
1941 TP_ACPI_HOTKEYSCAN_FNF10,
1942 TP_ACPI_HOTKEYSCAN_FNF11,
1943 TP_ACPI_HOTKEYSCAN_FNF12,
1944 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1945 TP_ACPI_HOTKEYSCAN_FNINSERT,
1946 TP_ACPI_HOTKEYSCAN_FNDELETE,
1947 TP_ACPI_HOTKEYSCAN_FNHOME,
1948 TP_ACPI_HOTKEYSCAN_FNEND,
1949 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1950 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1951 TP_ACPI_HOTKEYSCAN_FNSPACE,
1952 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1953 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1954 TP_ACPI_HOTKEYSCAN_MUTE,
1955 TP_ACPI_HOTKEYSCAN_THINKPAD,
1958 enum { /* Keys/events available through NVRAM polling */
1959 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1960 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1963 enum { /* Positions of some of the keys in hotkey masks */
1964 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1965 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1966 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1967 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1968 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1969 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1970 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1971 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1972 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1973 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1974 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1977 enum { /* NVRAM to ACPI HKEY group map */
1978 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1979 TP_ACPI_HKEY_ZOOM_MASK |
1980 TP_ACPI_HKEY_DISPSWTCH_MASK |
1981 TP_ACPI_HKEY_HIBERNATE_MASK,
1982 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1983 TP_ACPI_HKEY_BRGHTDWN_MASK,
1984 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1985 TP_ACPI_HKEY_VOLDWN_MASK |
1986 TP_ACPI_HKEY_MUTE_MASK,
1989 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1990 struct tp_nvram_state {
1991 u16 thinkpad_toggle:1;
1992 u16 zoom_toggle:1;
1993 u16 display_toggle:1;
1994 u16 thinklight_toggle:1;
1995 u16 hibernate_toggle:1;
1996 u16 displayexp_toggle:1;
1997 u16 display_state:1;
1998 u16 brightness_toggle:1;
1999 u16 volume_toggle:1;
2000 u16 mute:1;
2002 u8 brightness_level;
2003 u8 volume_level;
2006 /* kthread for the hotkey poller */
2007 static struct task_struct *tpacpi_hotkey_task;
2009 /* Acquired while the poller kthread is running, use to sync start/stop */
2010 static struct mutex hotkey_thread_mutex;
2013 * Acquire mutex to write poller control variables as an
2014 * atomic block.
2016 * Increment hotkey_config_change when changing them if you
2017 * want the kthread to forget old state.
2019 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2021 static struct mutex hotkey_thread_data_mutex;
2022 static unsigned int hotkey_config_change;
2025 * hotkey poller control variables
2027 * Must be atomic or readers will also need to acquire mutex
2029 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2030 * should be used only when the changes need to be taken as
2031 * a block, OR when one needs to force the kthread to forget
2032 * old state.
2034 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2035 static unsigned int hotkey_poll_freq = 10; /* Hz */
2037 #define HOTKEY_CONFIG_CRITICAL_START \
2038 do { \
2039 mutex_lock(&hotkey_thread_data_mutex); \
2040 hotkey_config_change++; \
2041 } while (0);
2042 #define HOTKEY_CONFIG_CRITICAL_END \
2043 mutex_unlock(&hotkey_thread_data_mutex);
2045 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2047 #define hotkey_source_mask 0U
2048 #define HOTKEY_CONFIG_CRITICAL_START
2049 #define HOTKEY_CONFIG_CRITICAL_END
2051 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2053 static struct mutex hotkey_mutex;
2055 static enum { /* Reasons for waking up */
2056 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2057 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2058 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2059 } hotkey_wakeup_reason;
2061 static int hotkey_autosleep_ack;
2063 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2064 static u32 hotkey_all_mask; /* all events supported in fw */
2065 static u32 hotkey_reserved_mask; /* events better left disabled */
2066 static u32 hotkey_driver_mask; /* events needed by the driver */
2067 static u32 hotkey_user_mask; /* events visible to userspace */
2068 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2070 static unsigned int hotkey_report_mode;
2072 static u16 *hotkey_keycode_map;
2074 static struct attribute_set *hotkey_dev_attributes;
2076 static void tpacpi_driver_event(const unsigned int hkey_event);
2077 static void hotkey_driver_event(const unsigned int scancode);
2078 static void hotkey_poll_setup(const bool may_warn);
2080 /* HKEY.MHKG() return bits */
2081 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2083 static int hotkey_get_wlsw(void)
2085 int status;
2087 if (!tp_features.hotkey_wlsw)
2088 return -ENODEV;
2090 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2091 if (dbg_wlswemul)
2092 return (tpacpi_wlsw_emulstate) ?
2093 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2094 #endif
2096 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2097 return -EIO;
2099 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2102 static int hotkey_get_tablet_mode(int *status)
2104 int s;
2106 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2107 return -EIO;
2109 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2110 return 0;
2114 * Reads current event mask from firmware, and updates
2115 * hotkey_acpi_mask accordingly. Also resets any bits
2116 * from hotkey_user_mask that are unavailable to be
2117 * delivered (shadow requirement of the userspace ABI).
2119 * Call with hotkey_mutex held
2121 static int hotkey_mask_get(void)
2123 if (tp_features.hotkey_mask) {
2124 u32 m = 0;
2126 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2127 return -EIO;
2129 hotkey_acpi_mask = m;
2130 } else {
2131 /* no mask support doesn't mean no event support... */
2132 hotkey_acpi_mask = hotkey_all_mask;
2135 /* sync userspace-visible mask */
2136 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2138 return 0;
2141 void static hotkey_mask_warn_incomplete_mask(void)
2143 /* log only what the user can fix... */
2144 const u32 wantedmask = hotkey_driver_mask &
2145 ~(hotkey_acpi_mask | hotkey_source_mask) &
2146 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2148 if (wantedmask)
2149 printk(TPACPI_NOTICE
2150 "required events 0x%08x not enabled!\n",
2151 wantedmask);
2155 * Set the firmware mask when supported
2157 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2159 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2161 * Call with hotkey_mutex held
2163 static int hotkey_mask_set(u32 mask)
2165 int i;
2166 int rc = 0;
2168 const u32 fwmask = mask & ~hotkey_source_mask;
2170 if (tp_features.hotkey_mask) {
2171 for (i = 0; i < 32; i++) {
2172 if (!acpi_evalf(hkey_handle,
2173 NULL, "MHKM", "vdd", i + 1,
2174 !!(mask & (1 << i)))) {
2175 rc = -EIO;
2176 break;
2182 * We *must* make an inconditional call to hotkey_mask_get to
2183 * refresh hotkey_acpi_mask and update hotkey_user_mask
2185 * Take the opportunity to also log when we cannot _enable_
2186 * a given event.
2188 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2189 printk(TPACPI_NOTICE
2190 "asked for hotkey mask 0x%08x, but "
2191 "firmware forced it to 0x%08x\n",
2192 fwmask, hotkey_acpi_mask);
2195 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2196 hotkey_mask_warn_incomplete_mask();
2198 return rc;
2202 * Sets hotkey_user_mask and tries to set the firmware mask
2204 * Call with hotkey_mutex held
2206 static int hotkey_user_mask_set(const u32 mask)
2208 int rc;
2210 /* Give people a chance to notice they are doing something that
2211 * is bound to go boom on their users sooner or later */
2212 if (!tp_warned.hotkey_mask_ff &&
2213 (mask == 0xffff || mask == 0xffffff ||
2214 mask == 0xffffffff)) {
2215 tp_warned.hotkey_mask_ff = 1;
2216 printk(TPACPI_NOTICE
2217 "setting the hotkey mask to 0x%08x is likely "
2218 "not the best way to go about it\n", mask);
2219 printk(TPACPI_NOTICE
2220 "please consider using the driver defaults, "
2221 "and refer to up-to-date thinkpad-acpi "
2222 "documentation\n");
2225 /* Try to enable what the user asked for, plus whatever we need.
2226 * this syncs everything but won't enable bits in hotkey_user_mask */
2227 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2229 /* Enable the available bits in hotkey_user_mask */
2230 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2232 return rc;
2236 * Sets the driver hotkey mask.
2238 * Can be called even if the hotkey subdriver is inactive
2240 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2242 int rc;
2244 /* Do the right thing if hotkey_init has not been called yet */
2245 if (!tp_features.hotkey) {
2246 hotkey_driver_mask = mask;
2247 return 0;
2250 mutex_lock(&hotkey_mutex);
2252 HOTKEY_CONFIG_CRITICAL_START
2253 hotkey_driver_mask = mask;
2254 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2255 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2256 #endif
2257 HOTKEY_CONFIG_CRITICAL_END
2259 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2260 ~hotkey_source_mask);
2261 hotkey_poll_setup(true);
2263 mutex_unlock(&hotkey_mutex);
2265 return rc;
2268 static int hotkey_status_get(int *status)
2270 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2271 return -EIO;
2273 return 0;
2276 static int hotkey_status_set(bool enable)
2278 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2279 return -EIO;
2281 return 0;
2284 static void tpacpi_input_send_tabletsw(void)
2286 int state;
2288 if (tp_features.hotkey_tablet &&
2289 !hotkey_get_tablet_mode(&state)) {
2290 mutex_lock(&tpacpi_inputdev_send_mutex);
2292 input_report_switch(tpacpi_inputdev,
2293 SW_TABLET_MODE, !!state);
2294 input_sync(tpacpi_inputdev);
2296 mutex_unlock(&tpacpi_inputdev_send_mutex);
2300 /* Do NOT call without validating scancode first */
2301 static void tpacpi_input_send_key(const unsigned int scancode)
2303 const unsigned int keycode = hotkey_keycode_map[scancode];
2305 if (keycode != KEY_RESERVED) {
2306 mutex_lock(&tpacpi_inputdev_send_mutex);
2308 input_report_key(tpacpi_inputdev, keycode, 1);
2309 if (keycode == KEY_UNKNOWN)
2310 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2311 scancode);
2312 input_sync(tpacpi_inputdev);
2314 input_report_key(tpacpi_inputdev, keycode, 0);
2315 if (keycode == KEY_UNKNOWN)
2316 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2317 scancode);
2318 input_sync(tpacpi_inputdev);
2320 mutex_unlock(&tpacpi_inputdev_send_mutex);
2324 /* Do NOT call without validating scancode first */
2325 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2327 hotkey_driver_event(scancode);
2328 if (hotkey_user_mask & (1 << scancode))
2329 tpacpi_input_send_key(scancode);
2332 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2333 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2335 /* Do NOT call without validating scancode first */
2336 static void tpacpi_hotkey_send_key(unsigned int scancode)
2338 tpacpi_input_send_key_masked(scancode);
2339 if (hotkey_report_mode < 2) {
2340 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2341 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2345 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2347 u8 d;
2349 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2350 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2351 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2352 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2353 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2354 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2356 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2357 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2358 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2360 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2361 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2362 n->displayexp_toggle =
2363 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2365 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2366 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2367 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2368 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2369 n->brightness_toggle =
2370 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2372 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2373 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2374 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2375 >> TP_NVRAM_POS_LEVEL_VOLUME;
2376 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2377 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2381 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2382 struct tp_nvram_state *newn,
2383 const u32 event_mask)
2386 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2387 do { \
2388 if ((event_mask & (1 << __scancode)) && \
2389 oldn->__member != newn->__member) \
2390 tpacpi_hotkey_send_key(__scancode); \
2391 } while (0)
2393 #define TPACPI_MAY_SEND_KEY(__scancode) \
2394 do { \
2395 if (event_mask & (1 << __scancode)) \
2396 tpacpi_hotkey_send_key(__scancode); \
2397 } while (0)
2399 void issue_volchange(const unsigned int oldvol,
2400 const unsigned int newvol)
2402 unsigned int i = oldvol;
2404 while (i > newvol) {
2405 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2406 i--;
2408 while (i < newvol) {
2409 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2410 i++;
2414 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2415 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2416 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2417 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2419 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2421 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2424 * Handle volume
2426 * This code is supposed to duplicate the IBM firmware behaviour:
2427 * - Pressing MUTE issues mute hotkey message, even when already mute
2428 * - Pressing Volume up/down issues volume up/down hotkey messages,
2429 * even when already at maximum or minumum volume
2430 * - The act of unmuting issues volume up/down notification,
2431 * depending which key was used to unmute
2433 * We are constrained to what the NVRAM can tell us, which is not much
2434 * and certainly not enough if more than one volume hotkey was pressed
2435 * since the last poll cycle.
2437 * Just to make our life interesting, some newer Lenovo ThinkPads have
2438 * bugs in the BIOS and may fail to update volume_toggle properly.
2440 if (newn->mute) {
2441 /* muted */
2442 if (!oldn->mute ||
2443 oldn->volume_toggle != newn->volume_toggle ||
2444 oldn->volume_level != newn->volume_level) {
2445 /* recently muted, or repeated mute keypress, or
2446 * multiple presses ending in mute */
2447 issue_volchange(oldn->volume_level, newn->volume_level);
2448 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2450 } else {
2451 /* unmute */
2452 if (oldn->mute) {
2453 /* recently unmuted, issue 'unmute' keypress */
2454 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2456 if (oldn->volume_level != newn->volume_level) {
2457 issue_volchange(oldn->volume_level, newn->volume_level);
2458 } else if (oldn->volume_toggle != newn->volume_toggle) {
2459 /* repeated vol up/down keypress at end of scale ? */
2460 if (newn->volume_level == 0)
2461 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2462 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2463 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2467 /* handle brightness */
2468 if (oldn->brightness_toggle != newn->brightness_toggle) {
2469 if (oldn->brightness_level < newn->brightness_level) {
2470 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2471 } else if (oldn->brightness_level > newn->brightness_level) {
2472 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2473 } else {
2474 /* repeated key presses that didn't change state */
2475 if (newn->brightness_level != 0) {
2476 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2477 } else {
2478 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2483 #undef TPACPI_COMPARE_KEY
2484 #undef TPACPI_MAY_SEND_KEY
2488 * Polling driver
2490 * We track all events in hotkey_source_mask all the time, since
2491 * most of them are edge-based. We only issue those requested by
2492 * hotkey_user_mask or hotkey_driver_mask, though.
2494 static int hotkey_kthread(void *data)
2496 struct tp_nvram_state s[2];
2497 u32 poll_mask, event_mask;
2498 unsigned int si, so;
2499 unsigned long t;
2500 unsigned int change_detector, must_reset;
2501 unsigned int poll_freq;
2503 mutex_lock(&hotkey_thread_mutex);
2505 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2506 goto exit;
2508 set_freezable();
2510 so = 0;
2511 si = 1;
2512 t = 0;
2514 /* Initial state for compares */
2515 mutex_lock(&hotkey_thread_data_mutex);
2516 change_detector = hotkey_config_change;
2517 poll_mask = hotkey_source_mask;
2518 event_mask = hotkey_source_mask &
2519 (hotkey_driver_mask | hotkey_user_mask);
2520 poll_freq = hotkey_poll_freq;
2521 mutex_unlock(&hotkey_thread_data_mutex);
2522 hotkey_read_nvram(&s[so], poll_mask);
2524 while (!kthread_should_stop()) {
2525 if (t == 0) {
2526 if (likely(poll_freq))
2527 t = 1000/poll_freq;
2528 else
2529 t = 100; /* should never happen... */
2531 t = msleep_interruptible(t);
2532 if (unlikely(kthread_should_stop()))
2533 break;
2534 must_reset = try_to_freeze();
2535 if (t > 0 && !must_reset)
2536 continue;
2538 mutex_lock(&hotkey_thread_data_mutex);
2539 if (must_reset || hotkey_config_change != change_detector) {
2540 /* forget old state on thaw or config change */
2541 si = so;
2542 t = 0;
2543 change_detector = hotkey_config_change;
2545 poll_mask = hotkey_source_mask;
2546 event_mask = hotkey_source_mask &
2547 (hotkey_driver_mask | hotkey_user_mask);
2548 poll_freq = hotkey_poll_freq;
2549 mutex_unlock(&hotkey_thread_data_mutex);
2551 if (likely(poll_mask)) {
2552 hotkey_read_nvram(&s[si], poll_mask);
2553 if (likely(si != so)) {
2554 hotkey_compare_and_issue_event(&s[so], &s[si],
2555 event_mask);
2559 so = si;
2560 si ^= 1;
2563 exit:
2564 mutex_unlock(&hotkey_thread_mutex);
2565 return 0;
2568 /* call with hotkey_mutex held */
2569 static void hotkey_poll_stop_sync(void)
2571 if (tpacpi_hotkey_task) {
2572 if (frozen(tpacpi_hotkey_task) ||
2573 freezing(tpacpi_hotkey_task))
2574 thaw_process(tpacpi_hotkey_task);
2576 kthread_stop(tpacpi_hotkey_task);
2577 tpacpi_hotkey_task = NULL;
2578 mutex_lock(&hotkey_thread_mutex);
2579 /* at this point, the thread did exit */
2580 mutex_unlock(&hotkey_thread_mutex);
2584 /* call with hotkey_mutex held */
2585 static void hotkey_poll_setup(const bool may_warn)
2587 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2588 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2590 if (hotkey_poll_freq > 0 &&
2591 (poll_driver_mask ||
2592 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2593 if (!tpacpi_hotkey_task) {
2594 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2595 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2596 if (IS_ERR(tpacpi_hotkey_task)) {
2597 tpacpi_hotkey_task = NULL;
2598 printk(TPACPI_ERR
2599 "could not create kernel thread "
2600 "for hotkey polling\n");
2603 } else {
2604 hotkey_poll_stop_sync();
2605 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2606 hotkey_poll_freq == 0) {
2607 printk(TPACPI_NOTICE
2608 "hot keys 0x%08x and/or events 0x%08x "
2609 "require polling, which is currently "
2610 "disabled\n",
2611 poll_user_mask, poll_driver_mask);
2616 static void hotkey_poll_setup_safe(const bool may_warn)
2618 mutex_lock(&hotkey_mutex);
2619 hotkey_poll_setup(may_warn);
2620 mutex_unlock(&hotkey_mutex);
2623 /* call with hotkey_mutex held */
2624 static void hotkey_poll_set_freq(unsigned int freq)
2626 if (!freq)
2627 hotkey_poll_stop_sync();
2629 hotkey_poll_freq = freq;
2632 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2634 static void hotkey_poll_setup(const bool __unused)
2638 static void hotkey_poll_setup_safe(const bool __unused)
2642 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2644 static int hotkey_inputdev_open(struct input_dev *dev)
2646 switch (tpacpi_lifecycle) {
2647 case TPACPI_LIFE_INIT:
2648 case TPACPI_LIFE_RUNNING:
2649 hotkey_poll_setup_safe(false);
2650 return 0;
2651 case TPACPI_LIFE_EXITING:
2652 return -EBUSY;
2655 /* Should only happen if tpacpi_lifecycle is corrupt */
2656 BUG();
2657 return -EBUSY;
2660 static void hotkey_inputdev_close(struct input_dev *dev)
2662 /* disable hotkey polling when possible */
2663 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2664 !(hotkey_source_mask & hotkey_driver_mask))
2665 hotkey_poll_setup_safe(false);
2668 /* sysfs hotkey enable ------------------------------------------------- */
2669 static ssize_t hotkey_enable_show(struct device *dev,
2670 struct device_attribute *attr,
2671 char *buf)
2673 int res, status;
2675 printk_deprecated_attribute("hotkey_enable",
2676 "Hotkey reporting is always enabled");
2678 res = hotkey_status_get(&status);
2679 if (res)
2680 return res;
2682 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2685 static ssize_t hotkey_enable_store(struct device *dev,
2686 struct device_attribute *attr,
2687 const char *buf, size_t count)
2689 unsigned long t;
2691 printk_deprecated_attribute("hotkey_enable",
2692 "Hotkeys can be disabled through hotkey_mask");
2694 if (parse_strtoul(buf, 1, &t))
2695 return -EINVAL;
2697 if (t == 0)
2698 return -EPERM;
2700 return count;
2703 static struct device_attribute dev_attr_hotkey_enable =
2704 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2705 hotkey_enable_show, hotkey_enable_store);
2707 /* sysfs hotkey mask --------------------------------------------------- */
2708 static ssize_t hotkey_mask_show(struct device *dev,
2709 struct device_attribute *attr,
2710 char *buf)
2712 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2715 static ssize_t hotkey_mask_store(struct device *dev,
2716 struct device_attribute *attr,
2717 const char *buf, size_t count)
2719 unsigned long t;
2720 int res;
2722 if (parse_strtoul(buf, 0xffffffffUL, &t))
2723 return -EINVAL;
2725 if (mutex_lock_killable(&hotkey_mutex))
2726 return -ERESTARTSYS;
2728 res = hotkey_user_mask_set(t);
2730 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2731 hotkey_poll_setup(true);
2732 #endif
2734 mutex_unlock(&hotkey_mutex);
2736 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2738 return (res) ? res : count;
2741 static struct device_attribute dev_attr_hotkey_mask =
2742 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2743 hotkey_mask_show, hotkey_mask_store);
2745 /* sysfs hotkey bios_enabled ------------------------------------------- */
2746 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2747 struct device_attribute *attr,
2748 char *buf)
2750 return sprintf(buf, "0\n");
2753 static struct device_attribute dev_attr_hotkey_bios_enabled =
2754 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2756 /* sysfs hotkey bios_mask ---------------------------------------------- */
2757 static ssize_t hotkey_bios_mask_show(struct device *dev,
2758 struct device_attribute *attr,
2759 char *buf)
2761 printk_deprecated_attribute("hotkey_bios_mask",
2762 "This attribute is useless.");
2763 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2766 static struct device_attribute dev_attr_hotkey_bios_mask =
2767 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2769 /* sysfs hotkey all_mask ----------------------------------------------- */
2770 static ssize_t hotkey_all_mask_show(struct device *dev,
2771 struct device_attribute *attr,
2772 char *buf)
2774 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2775 hotkey_all_mask | hotkey_source_mask);
2778 static struct device_attribute dev_attr_hotkey_all_mask =
2779 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2781 /* sysfs hotkey recommended_mask --------------------------------------- */
2782 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2783 struct device_attribute *attr,
2784 char *buf)
2786 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2787 (hotkey_all_mask | hotkey_source_mask)
2788 & ~hotkey_reserved_mask);
2791 static struct device_attribute dev_attr_hotkey_recommended_mask =
2792 __ATTR(hotkey_recommended_mask, S_IRUGO,
2793 hotkey_recommended_mask_show, NULL);
2795 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2797 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2798 static ssize_t hotkey_source_mask_show(struct device *dev,
2799 struct device_attribute *attr,
2800 char *buf)
2802 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2805 static ssize_t hotkey_source_mask_store(struct device *dev,
2806 struct device_attribute *attr,
2807 const char *buf, size_t count)
2809 unsigned long t;
2810 u32 r_ev;
2811 int rc;
2813 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2814 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2815 return -EINVAL;
2817 if (mutex_lock_killable(&hotkey_mutex))
2818 return -ERESTARTSYS;
2820 HOTKEY_CONFIG_CRITICAL_START
2821 hotkey_source_mask = t;
2822 HOTKEY_CONFIG_CRITICAL_END
2824 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2825 ~hotkey_source_mask);
2826 hotkey_poll_setup(true);
2828 /* check if events needed by the driver got disabled */
2829 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2830 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2832 mutex_unlock(&hotkey_mutex);
2834 if (rc < 0)
2835 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2836 "firmware event mask!\n");
2838 if (r_ev)
2839 printk(TPACPI_NOTICE "hotkey_source_mask: "
2840 "some important events were disabled: "
2841 "0x%04x\n", r_ev);
2843 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2845 return (rc < 0) ? rc : count;
2848 static struct device_attribute dev_attr_hotkey_source_mask =
2849 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2850 hotkey_source_mask_show, hotkey_source_mask_store);
2852 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2853 static ssize_t hotkey_poll_freq_show(struct device *dev,
2854 struct device_attribute *attr,
2855 char *buf)
2857 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2860 static ssize_t hotkey_poll_freq_store(struct device *dev,
2861 struct device_attribute *attr,
2862 const char *buf, size_t count)
2864 unsigned long t;
2866 if (parse_strtoul(buf, 25, &t))
2867 return -EINVAL;
2869 if (mutex_lock_killable(&hotkey_mutex))
2870 return -ERESTARTSYS;
2872 hotkey_poll_set_freq(t);
2873 hotkey_poll_setup(true);
2875 mutex_unlock(&hotkey_mutex);
2877 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2879 return count;
2882 static struct device_attribute dev_attr_hotkey_poll_freq =
2883 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2884 hotkey_poll_freq_show, hotkey_poll_freq_store);
2886 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2888 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2889 static ssize_t hotkey_radio_sw_show(struct device *dev,
2890 struct device_attribute *attr,
2891 char *buf)
2893 int res;
2894 res = hotkey_get_wlsw();
2895 if (res < 0)
2896 return res;
2898 /* Opportunistic update */
2899 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2901 return snprintf(buf, PAGE_SIZE, "%d\n",
2902 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2905 static struct device_attribute dev_attr_hotkey_radio_sw =
2906 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2908 static void hotkey_radio_sw_notify_change(void)
2910 if (tp_features.hotkey_wlsw)
2911 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2912 "hotkey_radio_sw");
2915 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2916 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2917 struct device_attribute *attr,
2918 char *buf)
2920 int res, s;
2921 res = hotkey_get_tablet_mode(&s);
2922 if (res < 0)
2923 return res;
2925 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2928 static struct device_attribute dev_attr_hotkey_tablet_mode =
2929 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2931 static void hotkey_tablet_mode_notify_change(void)
2933 if (tp_features.hotkey_tablet)
2934 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2935 "hotkey_tablet_mode");
2938 /* sysfs hotkey report_mode -------------------------------------------- */
2939 static ssize_t hotkey_report_mode_show(struct device *dev,
2940 struct device_attribute *attr,
2941 char *buf)
2943 return snprintf(buf, PAGE_SIZE, "%d\n",
2944 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2947 static struct device_attribute dev_attr_hotkey_report_mode =
2948 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2950 /* sysfs wakeup reason (pollable) -------------------------------------- */
2951 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2952 struct device_attribute *attr,
2953 char *buf)
2955 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2958 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2959 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2961 static void hotkey_wakeup_reason_notify_change(void)
2963 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2964 "wakeup_reason");
2967 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2968 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2969 struct device_attribute *attr,
2970 char *buf)
2972 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2975 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2976 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2977 hotkey_wakeup_hotunplug_complete_show, NULL);
2979 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2981 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2982 "wakeup_hotunplug_complete");
2985 /* --------------------------------------------------------------------- */
2987 static struct attribute *hotkey_attributes[] __initdata = {
2988 &dev_attr_hotkey_enable.attr,
2989 &dev_attr_hotkey_bios_enabled.attr,
2990 &dev_attr_hotkey_bios_mask.attr,
2991 &dev_attr_hotkey_report_mode.attr,
2992 &dev_attr_hotkey_wakeup_reason.attr,
2993 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2994 &dev_attr_hotkey_mask.attr,
2995 &dev_attr_hotkey_all_mask.attr,
2996 &dev_attr_hotkey_recommended_mask.attr,
2997 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2998 &dev_attr_hotkey_source_mask.attr,
2999 &dev_attr_hotkey_poll_freq.attr,
3000 #endif
3004 * Sync both the hw and sw blocking state of all switches
3006 static void tpacpi_send_radiosw_update(void)
3008 int wlsw;
3011 * We must sync all rfkill controllers *before* issuing any
3012 * rfkill input events, or we will race the rfkill core input
3013 * handler.
3015 * tpacpi_inputdev_send_mutex works as a syncronization point
3016 * for the above.
3018 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3021 wlsw = hotkey_get_wlsw();
3023 /* Sync hw blocking state first if it is hw-blocked */
3024 if (wlsw == TPACPI_RFK_RADIO_OFF)
3025 tpacpi_rfk_update_hwblock_state(true);
3027 /* Sync sw blocking state */
3028 tpacpi_rfk_update_swstate_all();
3030 /* Sync hw blocking state last if it is hw-unblocked */
3031 if (wlsw == TPACPI_RFK_RADIO_ON)
3032 tpacpi_rfk_update_hwblock_state(false);
3034 /* Issue rfkill input event for WLSW switch */
3035 if (!(wlsw < 0)) {
3036 mutex_lock(&tpacpi_inputdev_send_mutex);
3038 input_report_switch(tpacpi_inputdev,
3039 SW_RFKILL_ALL, (wlsw > 0));
3040 input_sync(tpacpi_inputdev);
3042 mutex_unlock(&tpacpi_inputdev_send_mutex);
3046 * this can be unconditional, as we will poll state again
3047 * if userspace uses the notify to read data
3049 hotkey_radio_sw_notify_change();
3052 static void hotkey_exit(void)
3054 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3055 mutex_lock(&hotkey_mutex);
3056 hotkey_poll_stop_sync();
3057 mutex_unlock(&hotkey_mutex);
3058 #endif
3060 if (hotkey_dev_attributes)
3061 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3063 kfree(hotkey_keycode_map);
3065 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3066 "restoring original HKEY status and mask\n");
3067 /* yes, there is a bitwise or below, we want the
3068 * functions to be called even if one of them fail */
3069 if (((tp_features.hotkey_mask &&
3070 hotkey_mask_set(hotkey_orig_mask)) |
3071 hotkey_status_set(false)) != 0)
3072 printk(TPACPI_ERR
3073 "failed to restore hot key mask "
3074 "to BIOS defaults\n");
3077 static void __init hotkey_unmap(const unsigned int scancode)
3079 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3080 clear_bit(hotkey_keycode_map[scancode],
3081 tpacpi_inputdev->keybit);
3082 hotkey_keycode_map[scancode] = KEY_RESERVED;
3087 * HKEY quirks:
3088 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3091 #define TPACPI_HK_Q_INIMASK 0x0001
3093 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3094 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3095 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3096 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3097 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3098 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3099 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3100 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3101 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3102 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3103 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3104 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3105 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3106 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3107 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3108 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3109 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3110 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3111 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3112 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3115 static int __init hotkey_init(struct ibm_init_struct *iibm)
3117 /* Requirements for changing the default keymaps:
3119 * 1. Many of the keys are mapped to KEY_RESERVED for very
3120 * good reasons. Do not change them unless you have deep
3121 * knowledge on the IBM and Lenovo ThinkPad firmware for
3122 * the various ThinkPad models. The driver behaves
3123 * differently for KEY_RESERVED: such keys have their
3124 * hot key mask *unset* in mask_recommended, and also
3125 * in the initial hot key mask programmed into the
3126 * firmware at driver load time, which means the firm-
3127 * ware may react very differently if you change them to
3128 * something else;
3130 * 2. You must be subscribed to the linux-thinkpad and
3131 * ibm-acpi-devel mailing lists, and you should read the
3132 * list archives since 2007 if you want to change the
3133 * keymaps. This requirement exists so that you will
3134 * know the past history of problems with the thinkpad-
3135 * acpi driver keymaps, and also that you will be
3136 * listening to any bug reports;
3138 * 3. Do not send thinkpad-acpi specific patches directly to
3139 * for merging, *ever*. Send them to the linux-acpi
3140 * mailinglist for comments. Merging is to be done only
3141 * through acpi-test and the ACPI maintainer.
3143 * If the above is too much to ask, don't change the keymap.
3144 * Ask the thinkpad-acpi maintainer to do it, instead.
3146 static u16 ibm_keycode_map[] __initdata = {
3147 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3148 KEY_FN_F1, KEY_FN_F2, KEY_COFFEE, KEY_SLEEP,
3149 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3150 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3152 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3153 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3154 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3155 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3157 /* brightness: firmware always reacts to them */
3158 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3159 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3161 /* Thinklight: firmware always react to it */
3162 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3164 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3165 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3167 /* Volume: firmware always react to it and reprograms
3168 * the built-in *extra* mixer. Never map it to control
3169 * another mixer by default. */
3170 KEY_RESERVED, /* 0x14: VOLUME UP */
3171 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3172 KEY_RESERVED, /* 0x16: MUTE */
3174 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3176 /* (assignments unknown, please report if found) */
3177 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3178 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3180 static u16 lenovo_keycode_map[] __initdata = {
3181 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3182 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3183 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3184 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3186 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3187 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3188 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3189 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3191 /* These should be enabled --only-- when ACPI video
3192 * is disabled (i.e. in "vendor" mode), and are handled
3193 * in a special way by the init code */
3194 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3195 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3197 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3199 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3200 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3202 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3203 * react to it and reprograms the built-in *extra* mixer.
3204 * Never map it to control another mixer by default.
3206 * T60?, T61, R60?, R61: firmware and EC tries to send
3207 * these over the regular keyboard, so these are no-ops,
3208 * but there are still weird bugs re. MUTE, so do not
3209 * change unless you get test reports from all Lenovo
3210 * models. May cause the BIOS to interfere with the
3211 * HDA mixer.
3213 KEY_RESERVED, /* 0x14: VOLUME UP */
3214 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3215 KEY_RESERVED, /* 0x16: MUTE */
3217 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3219 /* (assignments unknown, please report if found) */
3220 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3221 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3224 #define TPACPI_HOTKEY_MAP_LEN ARRAY_SIZE(ibm_keycode_map)
3225 #define TPACPI_HOTKEY_MAP_SIZE sizeof(ibm_keycode_map)
3226 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(ibm_keycode_map[0])
3228 int res, i;
3229 int status;
3230 int hkeyv;
3231 bool radiosw_state = false;
3232 bool tabletsw_state = false;
3234 unsigned long quirks;
3236 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3237 "initializing hotkey subdriver\n");
3239 BUG_ON(!tpacpi_inputdev);
3240 BUG_ON(tpacpi_inputdev->open != NULL ||
3241 tpacpi_inputdev->close != NULL);
3243 TPACPI_ACPIHANDLE_INIT(hkey);
3244 mutex_init(&hotkey_mutex);
3246 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3247 mutex_init(&hotkey_thread_mutex);
3248 mutex_init(&hotkey_thread_data_mutex);
3249 #endif
3251 /* hotkey not supported on 570 */
3252 tp_features.hotkey = hkey_handle != NULL;
3254 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3255 "hotkeys are %s\n",
3256 str_supported(tp_features.hotkey));
3258 if (!tp_features.hotkey)
3259 return 1;
3261 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3262 ARRAY_SIZE(tpacpi_hotkey_qtable));
3264 tpacpi_disable_brightness_delay();
3266 /* MUST have enough space for all attributes to be added to
3267 * hotkey_dev_attributes */
3268 hotkey_dev_attributes = create_attr_set(
3269 ARRAY_SIZE(hotkey_attributes) + 2,
3270 NULL);
3271 if (!hotkey_dev_attributes)
3272 return -ENOMEM;
3273 res = add_many_to_attr_set(hotkey_dev_attributes,
3274 hotkey_attributes,
3275 ARRAY_SIZE(hotkey_attributes));
3276 if (res)
3277 goto err_exit;
3279 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3280 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3281 for HKEY interface version 0x100 */
3282 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3283 if ((hkeyv >> 8) != 1) {
3284 printk(TPACPI_ERR "unknown version of the "
3285 "HKEY interface: 0x%x\n", hkeyv);
3286 printk(TPACPI_ERR "please report this to %s\n",
3287 TPACPI_MAIL);
3288 } else {
3290 * MHKV 0x100 in A31, R40, R40e,
3291 * T4x, X31, and later
3293 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3294 "firmware HKEY interface version: 0x%x\n",
3295 hkeyv);
3297 /* Paranoia check AND init hotkey_all_mask */
3298 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3299 "MHKA", "qd")) {
3300 printk(TPACPI_ERR
3301 "missing MHKA handler, "
3302 "please report this to %s\n",
3303 TPACPI_MAIL);
3304 /* Fallback: pre-init for FN+F3,F4,F12 */
3305 hotkey_all_mask = 0x080cU;
3306 } else {
3307 tp_features.hotkey_mask = 1;
3312 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3313 "hotkey masks are %s\n",
3314 str_supported(tp_features.hotkey_mask));
3316 /* Init hotkey_all_mask if not initialized yet */
3317 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3318 (quirks & TPACPI_HK_Q_INIMASK))
3319 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3321 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3322 if (tp_features.hotkey_mask) {
3323 /* hotkey_source_mask *must* be zero for
3324 * the first hotkey_mask_get to return hotkey_orig_mask */
3325 res = hotkey_mask_get();
3326 if (res)
3327 goto err_exit;
3329 hotkey_orig_mask = hotkey_acpi_mask;
3330 } else {
3331 hotkey_orig_mask = hotkey_all_mask;
3332 hotkey_acpi_mask = hotkey_all_mask;
3335 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3336 if (dbg_wlswemul) {
3337 tp_features.hotkey_wlsw = 1;
3338 radiosw_state = !!tpacpi_wlsw_emulstate;
3339 printk(TPACPI_INFO
3340 "radio switch emulation enabled\n");
3341 } else
3342 #endif
3343 /* Not all thinkpads have a hardware radio switch */
3344 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3345 tp_features.hotkey_wlsw = 1;
3346 radiosw_state = !!status;
3347 printk(TPACPI_INFO
3348 "radio switch found; radios are %s\n",
3349 enabled(status, 0));
3351 if (tp_features.hotkey_wlsw)
3352 res = add_to_attr_set(hotkey_dev_attributes,
3353 &dev_attr_hotkey_radio_sw.attr);
3355 /* For X41t, X60t, X61t Tablets... */
3356 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3357 tp_features.hotkey_tablet = 1;
3358 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3359 printk(TPACPI_INFO
3360 "possible tablet mode switch found; "
3361 "ThinkPad in %s mode\n",
3362 (tabletsw_state) ? "tablet" : "laptop");
3363 res = add_to_attr_set(hotkey_dev_attributes,
3364 &dev_attr_hotkey_tablet_mode.attr);
3367 if (!res)
3368 res = register_attr_set_with_sysfs(
3369 hotkey_dev_attributes,
3370 &tpacpi_pdev->dev.kobj);
3371 if (res)
3372 goto err_exit;
3374 /* Set up key map */
3376 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3377 GFP_KERNEL);
3378 if (!hotkey_keycode_map) {
3379 printk(TPACPI_ERR
3380 "failed to allocate memory for key map\n");
3381 res = -ENOMEM;
3382 goto err_exit;
3385 if (tpacpi_is_lenovo()) {
3386 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3387 "using Lenovo default hot key map\n");
3388 memcpy(hotkey_keycode_map, &lenovo_keycode_map,
3389 TPACPI_HOTKEY_MAP_SIZE);
3390 } else {
3391 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3392 "using IBM default hot key map\n");
3393 memcpy(hotkey_keycode_map, &ibm_keycode_map,
3394 TPACPI_HOTKEY_MAP_SIZE);
3397 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3398 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3399 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3400 tpacpi_inputdev->keycode = hotkey_keycode_map;
3401 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3402 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3403 input_set_capability(tpacpi_inputdev, EV_KEY,
3404 hotkey_keycode_map[i]);
3405 } else {
3406 if (i < sizeof(hotkey_reserved_mask)*8)
3407 hotkey_reserved_mask |= 1 << i;
3411 if (tp_features.hotkey_wlsw) {
3412 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3413 input_report_switch(tpacpi_inputdev,
3414 SW_RFKILL_ALL, radiosw_state);
3416 if (tp_features.hotkey_tablet) {
3417 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3418 input_report_switch(tpacpi_inputdev,
3419 SW_TABLET_MODE, tabletsw_state);
3422 /* Do not issue duplicate brightness change events to
3423 * userspace */
3424 if (!tp_features.bright_acpimode)
3425 /* update bright_acpimode... */
3426 tpacpi_check_std_acpi_brightness_support();
3428 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3429 printk(TPACPI_INFO
3430 "This ThinkPad has standard ACPI backlight "
3431 "brightness control, supported by the ACPI "
3432 "video driver\n");
3433 printk(TPACPI_NOTICE
3434 "Disabling thinkpad-acpi brightness events "
3435 "by default...\n");
3437 /* Disable brightness up/down on Lenovo thinkpads when
3438 * ACPI is handling them, otherwise it is plain impossible
3439 * for userspace to do something even remotely sane */
3440 hotkey_reserved_mask |=
3441 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3442 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3443 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3444 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3447 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3448 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3449 & ~hotkey_all_mask
3450 & ~hotkey_reserved_mask;
3452 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3453 "hotkey source mask 0x%08x, polling freq %u\n",
3454 hotkey_source_mask, hotkey_poll_freq);
3455 #endif
3457 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3458 "enabling firmware HKEY event interface...\n");
3459 res = hotkey_status_set(true);
3460 if (res) {
3461 hotkey_exit();
3462 return res;
3464 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3465 | hotkey_driver_mask)
3466 & ~hotkey_source_mask);
3467 if (res < 0 && res != -ENXIO) {
3468 hotkey_exit();
3469 return res;
3471 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3472 & ~hotkey_reserved_mask;
3473 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3474 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3475 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3477 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3478 "legacy ibm/hotkey event reporting over procfs %s\n",
3479 (hotkey_report_mode < 2) ?
3480 "enabled" : "disabled");
3482 tpacpi_inputdev->open = &hotkey_inputdev_open;
3483 tpacpi_inputdev->close = &hotkey_inputdev_close;
3485 hotkey_poll_setup_safe(true);
3487 return 0;
3489 err_exit:
3490 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3491 hotkey_dev_attributes = NULL;
3493 return (res < 0)? res : 1;
3496 static bool hotkey_notify_hotkey(const u32 hkey,
3497 bool *send_acpi_ev,
3498 bool *ignore_acpi_ev)
3500 /* 0x1000-0x1FFF: key presses */
3501 unsigned int scancode = hkey & 0xfff;
3502 *send_acpi_ev = true;
3503 *ignore_acpi_ev = false;
3505 if (scancode > 0 && scancode < 0x21) {
3506 scancode--;
3507 if (!(hotkey_source_mask & (1 << scancode))) {
3508 tpacpi_input_send_key_masked(scancode);
3509 *send_acpi_ev = false;
3510 } else {
3511 *ignore_acpi_ev = true;
3513 return true;
3515 return false;
3518 static bool hotkey_notify_wakeup(const u32 hkey,
3519 bool *send_acpi_ev,
3520 bool *ignore_acpi_ev)
3522 /* 0x2000-0x2FFF: Wakeup reason */
3523 *send_acpi_ev = true;
3524 *ignore_acpi_ev = false;
3526 switch (hkey) {
3527 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3528 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3529 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3530 *ignore_acpi_ev = true;
3531 break;
3533 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3534 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3535 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3536 *ignore_acpi_ev = true;
3537 break;
3539 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3540 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3541 printk(TPACPI_ALERT
3542 "EMERGENCY WAKEUP: battery almost empty\n");
3543 /* how to auto-heal: */
3544 /* 2313: woke up from S3, go to S4/S5 */
3545 /* 2413: woke up from S4, go to S5 */
3546 break;
3548 default:
3549 return false;
3552 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3553 printk(TPACPI_INFO
3554 "woke up due to a hot-unplug "
3555 "request...\n");
3556 hotkey_wakeup_reason_notify_change();
3558 return true;
3561 static bool hotkey_notify_usrevent(const u32 hkey,
3562 bool *send_acpi_ev,
3563 bool *ignore_acpi_ev)
3565 /* 0x5000-0x5FFF: human interface helpers */
3566 *send_acpi_ev = true;
3567 *ignore_acpi_ev = false;
3569 switch (hkey) {
3570 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3571 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3572 return true;
3574 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3575 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3576 tpacpi_input_send_tabletsw();
3577 hotkey_tablet_mode_notify_change();
3578 *send_acpi_ev = false;
3579 return true;
3581 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3582 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3583 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3584 /* do not propagate these events */
3585 *ignore_acpi_ev = true;
3586 return true;
3588 default:
3589 return false;
3593 static void thermal_dump_all_sensors(void);
3595 static bool hotkey_notify_thermal(const u32 hkey,
3596 bool *send_acpi_ev,
3597 bool *ignore_acpi_ev)
3599 bool known = true;
3601 /* 0x6000-0x6FFF: thermal alarms */
3602 *send_acpi_ev = true;
3603 *ignore_acpi_ev = false;
3605 switch (hkey) {
3606 case TP_HKEY_EV_THM_TABLE_CHANGED:
3607 printk(TPACPI_INFO
3608 "EC reports that Thermal Table has changed\n");
3609 /* recommended action: do nothing, we don't have
3610 * Lenovo ATM information */
3611 return true;
3612 case TP_HKEY_EV_ALARM_BAT_HOT:
3613 printk(TPACPI_CRIT
3614 "THERMAL ALARM: battery is too hot!\n");
3615 /* recommended action: warn user through gui */
3616 break;
3617 case TP_HKEY_EV_ALARM_BAT_XHOT:
3618 printk(TPACPI_ALERT
3619 "THERMAL EMERGENCY: battery is extremely hot!\n");
3620 /* recommended action: immediate sleep/hibernate */
3621 break;
3622 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3623 printk(TPACPI_CRIT
3624 "THERMAL ALARM: "
3625 "a sensor reports something is too hot!\n");
3626 /* recommended action: warn user through gui, that */
3627 /* some internal component is too hot */
3628 break;
3629 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3630 printk(TPACPI_ALERT
3631 "THERMAL EMERGENCY: "
3632 "a sensor reports something is extremely hot!\n");
3633 /* recommended action: immediate sleep/hibernate */
3634 break;
3635 default:
3636 printk(TPACPI_ALERT
3637 "THERMAL ALERT: unknown thermal alarm received\n");
3638 known = false;
3641 thermal_dump_all_sensors();
3643 return known;
3646 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3648 u32 hkey;
3649 bool send_acpi_ev;
3650 bool ignore_acpi_ev;
3651 bool known_ev;
3653 if (event != 0x80) {
3654 printk(TPACPI_ERR
3655 "unknown HKEY notification event %d\n", event);
3656 /* forward it to userspace, maybe it knows how to handle it */
3657 acpi_bus_generate_netlink_event(
3658 ibm->acpi->device->pnp.device_class,
3659 dev_name(&ibm->acpi->device->dev),
3660 event, 0);
3661 return;
3664 while (1) {
3665 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3666 printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3667 return;
3670 if (hkey == 0) {
3671 /* queue empty */
3672 return;
3675 send_acpi_ev = true;
3676 ignore_acpi_ev = false;
3678 switch (hkey >> 12) {
3679 case 1:
3680 /* 0x1000-0x1FFF: key presses */
3681 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3682 &ignore_acpi_ev);
3683 break;
3684 case 2:
3685 /* 0x2000-0x2FFF: Wakeup reason */
3686 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3687 &ignore_acpi_ev);
3688 break;
3689 case 3:
3690 /* 0x3000-0x3FFF: bay-related wakeups */
3691 switch (hkey) {
3692 case TP_HKEY_EV_BAYEJ_ACK:
3693 hotkey_autosleep_ack = 1;
3694 printk(TPACPI_INFO
3695 "bay ejected\n");
3696 hotkey_wakeup_hotunplug_complete_notify_change();
3697 known_ev = true;
3698 break;
3699 case TP_HKEY_EV_OPTDRV_EJ:
3700 /* FIXME: kick libata if SATA link offline */
3701 known_ev = true;
3702 break;
3703 default:
3704 known_ev = false;
3706 break;
3707 case 4:
3708 /* 0x4000-0x4FFF: dock-related wakeups */
3709 if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3710 hotkey_autosleep_ack = 1;
3711 printk(TPACPI_INFO
3712 "undocked\n");
3713 hotkey_wakeup_hotunplug_complete_notify_change();
3714 known_ev = true;
3715 } else {
3716 known_ev = false;
3718 break;
3719 case 5:
3720 /* 0x5000-0x5FFF: human interface helpers */
3721 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3722 &ignore_acpi_ev);
3723 break;
3724 case 6:
3725 /* 0x6000-0x6FFF: thermal alarms */
3726 known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3727 &ignore_acpi_ev);
3728 break;
3729 case 7:
3730 /* 0x7000-0x7FFF: misc */
3731 if (tp_features.hotkey_wlsw &&
3732 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3733 tpacpi_send_radiosw_update();
3734 send_acpi_ev = 0;
3735 known_ev = true;
3736 break;
3738 /* fallthrough to default */
3739 default:
3740 known_ev = false;
3742 if (!known_ev) {
3743 printk(TPACPI_NOTICE
3744 "unhandled HKEY event 0x%04x\n", hkey);
3745 printk(TPACPI_NOTICE
3746 "please report the conditions when this "
3747 "event happened to %s\n", TPACPI_MAIL);
3750 /* Legacy events */
3751 if (!ignore_acpi_ev &&
3752 (send_acpi_ev || hotkey_report_mode < 2)) {
3753 acpi_bus_generate_proc_event(ibm->acpi->device,
3754 event, hkey);
3757 /* netlink events */
3758 if (!ignore_acpi_ev && send_acpi_ev) {
3759 acpi_bus_generate_netlink_event(
3760 ibm->acpi->device->pnp.device_class,
3761 dev_name(&ibm->acpi->device->dev),
3762 event, hkey);
3767 static void hotkey_suspend(pm_message_t state)
3769 /* Do these on suspend, we get the events on early resume! */
3770 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3771 hotkey_autosleep_ack = 0;
3774 static void hotkey_resume(void)
3776 tpacpi_disable_brightness_delay();
3778 if (hotkey_status_set(true) < 0 ||
3779 hotkey_mask_set(hotkey_acpi_mask) < 0)
3780 printk(TPACPI_ERR
3781 "error while attempting to reset the event "
3782 "firmware interface\n");
3784 tpacpi_send_radiosw_update();
3785 hotkey_tablet_mode_notify_change();
3786 hotkey_wakeup_reason_notify_change();
3787 hotkey_wakeup_hotunplug_complete_notify_change();
3788 hotkey_poll_setup_safe(false);
3791 /* procfs -------------------------------------------------------------- */
3792 static int hotkey_read(struct seq_file *m)
3794 int res, status;
3796 if (!tp_features.hotkey) {
3797 seq_printf(m, "status:\t\tnot supported\n");
3798 return 0;
3801 if (mutex_lock_killable(&hotkey_mutex))
3802 return -ERESTARTSYS;
3803 res = hotkey_status_get(&status);
3804 if (!res)
3805 res = hotkey_mask_get();
3806 mutex_unlock(&hotkey_mutex);
3807 if (res)
3808 return res;
3810 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3811 if (hotkey_all_mask) {
3812 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3813 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3814 } else {
3815 seq_printf(m, "mask:\t\tnot supported\n");
3816 seq_printf(m, "commands:\tenable, disable, reset\n");
3819 return 0;
3822 static void hotkey_enabledisable_warn(bool enable)
3824 tpacpi_log_usertask("procfs hotkey enable/disable");
3825 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3826 TPACPI_WARN
3827 "hotkey enable/disable functionality has been "
3828 "removed from the driver. Hotkeys are always "
3829 "enabled\n"))
3830 printk(TPACPI_ERR
3831 "Please remove the hotkey=enable module "
3832 "parameter, it is deprecated. Hotkeys are always "
3833 "enabled\n");
3836 static int hotkey_write(char *buf)
3838 int res;
3839 u32 mask;
3840 char *cmd;
3842 if (!tp_features.hotkey)
3843 return -ENODEV;
3845 if (mutex_lock_killable(&hotkey_mutex))
3846 return -ERESTARTSYS;
3848 mask = hotkey_user_mask;
3850 res = 0;
3851 while ((cmd = next_cmd(&buf))) {
3852 if (strlencmp(cmd, "enable") == 0) {
3853 hotkey_enabledisable_warn(1);
3854 } else if (strlencmp(cmd, "disable") == 0) {
3855 hotkey_enabledisable_warn(0);
3856 res = -EPERM;
3857 } else if (strlencmp(cmd, "reset") == 0) {
3858 mask = (hotkey_all_mask | hotkey_source_mask)
3859 & ~hotkey_reserved_mask;
3860 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3861 /* mask set */
3862 } else if (sscanf(cmd, "%x", &mask) == 1) {
3863 /* mask set */
3864 } else {
3865 res = -EINVAL;
3866 goto errexit;
3870 if (!res) {
3871 tpacpi_disclose_usertask("procfs hotkey",
3872 "set mask to 0x%08x\n", mask);
3873 res = hotkey_user_mask_set(mask);
3876 errexit:
3877 mutex_unlock(&hotkey_mutex);
3878 return res;
3881 static const struct acpi_device_id ibm_htk_device_ids[] = {
3882 {TPACPI_ACPI_HKEY_HID, 0},
3883 {"", 0},
3886 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3887 .hid = ibm_htk_device_ids,
3888 .notify = hotkey_notify,
3889 .handle = &hkey_handle,
3890 .type = ACPI_DEVICE_NOTIFY,
3893 static struct ibm_struct hotkey_driver_data = {
3894 .name = "hotkey",
3895 .read = hotkey_read,
3896 .write = hotkey_write,
3897 .exit = hotkey_exit,
3898 .resume = hotkey_resume,
3899 .suspend = hotkey_suspend,
3900 .acpi = &ibm_hotkey_acpidriver,
3903 /*************************************************************************
3904 * Bluetooth subdriver
3907 enum {
3908 /* ACPI GBDC/SBDC bits */
3909 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3910 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3911 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3912 0 = disable, 1 = enable */
3915 enum {
3916 /* ACPI \BLTH commands */
3917 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3918 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3919 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3920 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3921 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3924 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3926 static int bluetooth_get_status(void)
3928 int status;
3930 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3931 if (dbg_bluetoothemul)
3932 return (tpacpi_bluetooth_emulstate) ?
3933 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3934 #endif
3936 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3937 return -EIO;
3939 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3940 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3943 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3945 int status;
3947 vdbg_printk(TPACPI_DBG_RFKILL,
3948 "will attempt to %s bluetooth\n",
3949 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3951 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3952 if (dbg_bluetoothemul) {
3953 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3954 return 0;
3956 #endif
3958 if (state == TPACPI_RFK_RADIO_ON)
3959 status = TP_ACPI_BLUETOOTH_RADIOSSW
3960 | TP_ACPI_BLUETOOTH_RESUMECTRL;
3961 else
3962 status = 0;
3964 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3965 return -EIO;
3967 return 0;
3970 /* sysfs bluetooth enable ---------------------------------------------- */
3971 static ssize_t bluetooth_enable_show(struct device *dev,
3972 struct device_attribute *attr,
3973 char *buf)
3975 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3976 attr, buf);
3979 static ssize_t bluetooth_enable_store(struct device *dev,
3980 struct device_attribute *attr,
3981 const char *buf, size_t count)
3983 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3984 attr, buf, count);
3987 static struct device_attribute dev_attr_bluetooth_enable =
3988 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3989 bluetooth_enable_show, bluetooth_enable_store);
3991 /* --------------------------------------------------------------------- */
3993 static struct attribute *bluetooth_attributes[] = {
3994 &dev_attr_bluetooth_enable.attr,
3995 NULL
3998 static const struct attribute_group bluetooth_attr_group = {
3999 .attrs = bluetooth_attributes,
4002 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4003 .get_status = bluetooth_get_status,
4004 .set_status = bluetooth_set_status,
4007 static void bluetooth_shutdown(void)
4009 /* Order firmware to save current state to NVRAM */
4010 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4011 TP_ACPI_BLTH_SAVE_STATE))
4012 printk(TPACPI_NOTICE
4013 "failed to save bluetooth state to NVRAM\n");
4014 else
4015 vdbg_printk(TPACPI_DBG_RFKILL,
4016 "bluestooth state saved to NVRAM\n");
4019 static void bluetooth_exit(void)
4021 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4022 &bluetooth_attr_group);
4024 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4026 bluetooth_shutdown();
4029 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4031 int res;
4032 int status = 0;
4034 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4035 "initializing bluetooth subdriver\n");
4037 TPACPI_ACPIHANDLE_INIT(hkey);
4039 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4040 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4041 tp_features.bluetooth = hkey_handle &&
4042 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4044 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4045 "bluetooth is %s, status 0x%02x\n",
4046 str_supported(tp_features.bluetooth),
4047 status);
4049 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4050 if (dbg_bluetoothemul) {
4051 tp_features.bluetooth = 1;
4052 printk(TPACPI_INFO
4053 "bluetooth switch emulation enabled\n");
4054 } else
4055 #endif
4056 if (tp_features.bluetooth &&
4057 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4058 /* no bluetooth hardware present in system */
4059 tp_features.bluetooth = 0;
4060 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4061 "bluetooth hardware not installed\n");
4064 if (!tp_features.bluetooth)
4065 return 1;
4067 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4068 &bluetooth_tprfk_ops,
4069 RFKILL_TYPE_BLUETOOTH,
4070 TPACPI_RFK_BLUETOOTH_SW_NAME,
4071 true);
4072 if (res)
4073 return res;
4075 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4076 &bluetooth_attr_group);
4077 if (res) {
4078 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4079 return res;
4082 return 0;
4085 /* procfs -------------------------------------------------------------- */
4086 static int bluetooth_read(struct seq_file *m)
4088 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4091 static int bluetooth_write(char *buf)
4093 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4096 static struct ibm_struct bluetooth_driver_data = {
4097 .name = "bluetooth",
4098 .read = bluetooth_read,
4099 .write = bluetooth_write,
4100 .exit = bluetooth_exit,
4101 .shutdown = bluetooth_shutdown,
4104 /*************************************************************************
4105 * Wan subdriver
4108 enum {
4109 /* ACPI GWAN/SWAN bits */
4110 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4111 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4112 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4113 0 = disable, 1 = enable */
4116 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4118 static int wan_get_status(void)
4120 int status;
4122 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4123 if (dbg_wwanemul)
4124 return (tpacpi_wwan_emulstate) ?
4125 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4126 #endif
4128 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4129 return -EIO;
4131 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4132 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4135 static int wan_set_status(enum tpacpi_rfkill_state state)
4137 int status;
4139 vdbg_printk(TPACPI_DBG_RFKILL,
4140 "will attempt to %s wwan\n",
4141 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4143 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4144 if (dbg_wwanemul) {
4145 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4146 return 0;
4148 #endif
4150 if (state == TPACPI_RFK_RADIO_ON)
4151 status = TP_ACPI_WANCARD_RADIOSSW
4152 | TP_ACPI_WANCARD_RESUMECTRL;
4153 else
4154 status = 0;
4156 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4157 return -EIO;
4159 return 0;
4162 /* sysfs wan enable ---------------------------------------------------- */
4163 static ssize_t wan_enable_show(struct device *dev,
4164 struct device_attribute *attr,
4165 char *buf)
4167 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4168 attr, buf);
4171 static ssize_t wan_enable_store(struct device *dev,
4172 struct device_attribute *attr,
4173 const char *buf, size_t count)
4175 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4176 attr, buf, count);
4179 static struct device_attribute dev_attr_wan_enable =
4180 __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4181 wan_enable_show, wan_enable_store);
4183 /* --------------------------------------------------------------------- */
4185 static struct attribute *wan_attributes[] = {
4186 &dev_attr_wan_enable.attr,
4187 NULL
4190 static const struct attribute_group wan_attr_group = {
4191 .attrs = wan_attributes,
4194 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4195 .get_status = wan_get_status,
4196 .set_status = wan_set_status,
4199 static void wan_shutdown(void)
4201 /* Order firmware to save current state to NVRAM */
4202 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4203 TP_ACPI_WGSV_SAVE_STATE))
4204 printk(TPACPI_NOTICE
4205 "failed to save WWAN state to NVRAM\n");
4206 else
4207 vdbg_printk(TPACPI_DBG_RFKILL,
4208 "WWAN state saved to NVRAM\n");
4211 static void wan_exit(void)
4213 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4214 &wan_attr_group);
4216 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4218 wan_shutdown();
4221 static int __init wan_init(struct ibm_init_struct *iibm)
4223 int res;
4224 int status = 0;
4226 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4227 "initializing wan subdriver\n");
4229 TPACPI_ACPIHANDLE_INIT(hkey);
4231 tp_features.wan = hkey_handle &&
4232 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4234 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4235 "wan is %s, status 0x%02x\n",
4236 str_supported(tp_features.wan),
4237 status);
4239 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4240 if (dbg_wwanemul) {
4241 tp_features.wan = 1;
4242 printk(TPACPI_INFO
4243 "wwan switch emulation enabled\n");
4244 } else
4245 #endif
4246 if (tp_features.wan &&
4247 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4248 /* no wan hardware present in system */
4249 tp_features.wan = 0;
4250 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4251 "wan hardware not installed\n");
4254 if (!tp_features.wan)
4255 return 1;
4257 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4258 &wan_tprfk_ops,
4259 RFKILL_TYPE_WWAN,
4260 TPACPI_RFK_WWAN_SW_NAME,
4261 true);
4262 if (res)
4263 return res;
4265 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4266 &wan_attr_group);
4268 if (res) {
4269 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4270 return res;
4273 return 0;
4276 /* procfs -------------------------------------------------------------- */
4277 static int wan_read(struct seq_file *m)
4279 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4282 static int wan_write(char *buf)
4284 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4287 static struct ibm_struct wan_driver_data = {
4288 .name = "wan",
4289 .read = wan_read,
4290 .write = wan_write,
4291 .exit = wan_exit,
4292 .shutdown = wan_shutdown,
4295 /*************************************************************************
4296 * UWB subdriver
4299 enum {
4300 /* ACPI GUWB/SUWB bits */
4301 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4302 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4305 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4307 static int uwb_get_status(void)
4309 int status;
4311 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4312 if (dbg_uwbemul)
4313 return (tpacpi_uwb_emulstate) ?
4314 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4315 #endif
4317 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4318 return -EIO;
4320 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4321 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4324 static int uwb_set_status(enum tpacpi_rfkill_state state)
4326 int status;
4328 vdbg_printk(TPACPI_DBG_RFKILL,
4329 "will attempt to %s UWB\n",
4330 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4332 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4333 if (dbg_uwbemul) {
4334 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4335 return 0;
4337 #endif
4339 if (state == TPACPI_RFK_RADIO_ON)
4340 status = TP_ACPI_UWB_RADIOSSW;
4341 else
4342 status = 0;
4344 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4345 return -EIO;
4347 return 0;
4350 /* --------------------------------------------------------------------- */
4352 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4353 .get_status = uwb_get_status,
4354 .set_status = uwb_set_status,
4357 static void uwb_exit(void)
4359 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4362 static int __init uwb_init(struct ibm_init_struct *iibm)
4364 int res;
4365 int status = 0;
4367 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4368 "initializing uwb subdriver\n");
4370 TPACPI_ACPIHANDLE_INIT(hkey);
4372 tp_features.uwb = hkey_handle &&
4373 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4375 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4376 "uwb is %s, status 0x%02x\n",
4377 str_supported(tp_features.uwb),
4378 status);
4380 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4381 if (dbg_uwbemul) {
4382 tp_features.uwb = 1;
4383 printk(TPACPI_INFO
4384 "uwb switch emulation enabled\n");
4385 } else
4386 #endif
4387 if (tp_features.uwb &&
4388 !(status & TP_ACPI_UWB_HWPRESENT)) {
4389 /* no uwb hardware present in system */
4390 tp_features.uwb = 0;
4391 dbg_printk(TPACPI_DBG_INIT,
4392 "uwb hardware not installed\n");
4395 if (!tp_features.uwb)
4396 return 1;
4398 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4399 &uwb_tprfk_ops,
4400 RFKILL_TYPE_UWB,
4401 TPACPI_RFK_UWB_SW_NAME,
4402 false);
4403 return res;
4406 static struct ibm_struct uwb_driver_data = {
4407 .name = "uwb",
4408 .exit = uwb_exit,
4409 .flags.experimental = 1,
4412 /*************************************************************************
4413 * Video subdriver
4416 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4418 enum video_access_mode {
4419 TPACPI_VIDEO_NONE = 0,
4420 TPACPI_VIDEO_570, /* 570 */
4421 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4422 TPACPI_VIDEO_NEW, /* all others */
4425 enum { /* video status flags, based on VIDEO_570 */
4426 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4427 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4428 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4431 enum { /* TPACPI_VIDEO_570 constants */
4432 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4433 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4434 * video_status_flags */
4435 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4436 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4439 static enum video_access_mode video_supported;
4440 static int video_orig_autosw;
4442 static int video_autosw_get(void);
4443 static int video_autosw_set(int enable);
4445 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4447 static int __init video_init(struct ibm_init_struct *iibm)
4449 int ivga;
4451 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4453 TPACPI_ACPIHANDLE_INIT(vid);
4454 if (tpacpi_is_ibm())
4455 TPACPI_ACPIHANDLE_INIT(vid2);
4457 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4458 /* G41, assume IVGA doesn't change */
4459 vid_handle = vid2_handle;
4461 if (!vid_handle)
4462 /* video switching not supported on R30, R31 */
4463 video_supported = TPACPI_VIDEO_NONE;
4464 else if (tpacpi_is_ibm() &&
4465 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4466 /* 570 */
4467 video_supported = TPACPI_VIDEO_570;
4468 else if (tpacpi_is_ibm() &&
4469 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4470 /* 600e/x, 770e, 770x */
4471 video_supported = TPACPI_VIDEO_770;
4472 else
4473 /* all others */
4474 video_supported = TPACPI_VIDEO_NEW;
4476 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4477 str_supported(video_supported != TPACPI_VIDEO_NONE),
4478 video_supported);
4480 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4483 static void video_exit(void)
4485 dbg_printk(TPACPI_DBG_EXIT,
4486 "restoring original video autoswitch mode\n");
4487 if (video_autosw_set(video_orig_autosw))
4488 printk(TPACPI_ERR "error while trying to restore original "
4489 "video autoswitch mode\n");
4492 static int video_outputsw_get(void)
4494 int status = 0;
4495 int i;
4497 switch (video_supported) {
4498 case TPACPI_VIDEO_570:
4499 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4500 TP_ACPI_VIDEO_570_PHSCMD))
4501 return -EIO;
4502 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4503 break;
4504 case TPACPI_VIDEO_770:
4505 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4506 return -EIO;
4507 if (i)
4508 status |= TP_ACPI_VIDEO_S_LCD;
4509 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4510 return -EIO;
4511 if (i)
4512 status |= TP_ACPI_VIDEO_S_CRT;
4513 break;
4514 case TPACPI_VIDEO_NEW:
4515 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4516 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4517 return -EIO;
4518 if (i)
4519 status |= TP_ACPI_VIDEO_S_CRT;
4521 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4522 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4523 return -EIO;
4524 if (i)
4525 status |= TP_ACPI_VIDEO_S_LCD;
4526 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4527 return -EIO;
4528 if (i)
4529 status |= TP_ACPI_VIDEO_S_DVI;
4530 break;
4531 default:
4532 return -ENOSYS;
4535 return status;
4538 static int video_outputsw_set(int status)
4540 int autosw;
4541 int res = 0;
4543 switch (video_supported) {
4544 case TPACPI_VIDEO_570:
4545 res = acpi_evalf(NULL, NULL,
4546 "\\_SB.PHS2", "vdd",
4547 TP_ACPI_VIDEO_570_PHS2CMD,
4548 status | TP_ACPI_VIDEO_570_PHS2SET);
4549 break;
4550 case TPACPI_VIDEO_770:
4551 autosw = video_autosw_get();
4552 if (autosw < 0)
4553 return autosw;
4555 res = video_autosw_set(1);
4556 if (res)
4557 return res;
4558 res = acpi_evalf(vid_handle, NULL,
4559 "ASWT", "vdd", status * 0x100, 0);
4560 if (!autosw && video_autosw_set(autosw)) {
4561 printk(TPACPI_ERR
4562 "video auto-switch left enabled due to error\n");
4563 return -EIO;
4565 break;
4566 case TPACPI_VIDEO_NEW:
4567 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4568 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4569 break;
4570 default:
4571 return -ENOSYS;
4574 return (res)? 0 : -EIO;
4577 static int video_autosw_get(void)
4579 int autosw = 0;
4581 switch (video_supported) {
4582 case TPACPI_VIDEO_570:
4583 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4584 return -EIO;
4585 break;
4586 case TPACPI_VIDEO_770:
4587 case TPACPI_VIDEO_NEW:
4588 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4589 return -EIO;
4590 break;
4591 default:
4592 return -ENOSYS;
4595 return autosw & 1;
4598 static int video_autosw_set(int enable)
4600 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4601 return -EIO;
4602 return 0;
4605 static int video_outputsw_cycle(void)
4607 int autosw = video_autosw_get();
4608 int res;
4610 if (autosw < 0)
4611 return autosw;
4613 switch (video_supported) {
4614 case TPACPI_VIDEO_570:
4615 res = video_autosw_set(1);
4616 if (res)
4617 return res;
4618 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4619 break;
4620 case TPACPI_VIDEO_770:
4621 case TPACPI_VIDEO_NEW:
4622 res = video_autosw_set(1);
4623 if (res)
4624 return res;
4625 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4626 break;
4627 default:
4628 return -ENOSYS;
4630 if (!autosw && video_autosw_set(autosw)) {
4631 printk(TPACPI_ERR
4632 "video auto-switch left enabled due to error\n");
4633 return -EIO;
4636 return (res)? 0 : -EIO;
4639 static int video_expand_toggle(void)
4641 switch (video_supported) {
4642 case TPACPI_VIDEO_570:
4643 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4644 0 : -EIO;
4645 case TPACPI_VIDEO_770:
4646 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4647 0 : -EIO;
4648 case TPACPI_VIDEO_NEW:
4649 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4650 0 : -EIO;
4651 default:
4652 return -ENOSYS;
4654 /* not reached */
4657 static int video_read(struct seq_file *m)
4659 int status, autosw;
4661 if (video_supported == TPACPI_VIDEO_NONE) {
4662 seq_printf(m, "status:\t\tnot supported\n");
4663 return 0;
4666 /* Even reads can crash X.org, so... */
4667 if (!capable(CAP_SYS_ADMIN))
4668 return -EPERM;
4670 status = video_outputsw_get();
4671 if (status < 0)
4672 return status;
4674 autosw = video_autosw_get();
4675 if (autosw < 0)
4676 return autosw;
4678 seq_printf(m, "status:\t\tsupported\n");
4679 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4680 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4681 if (video_supported == TPACPI_VIDEO_NEW)
4682 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4683 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4684 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4685 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4686 if (video_supported == TPACPI_VIDEO_NEW)
4687 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4688 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4689 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4691 return 0;
4694 static int video_write(char *buf)
4696 char *cmd;
4697 int enable, disable, status;
4698 int res;
4700 if (video_supported == TPACPI_VIDEO_NONE)
4701 return -ENODEV;
4703 /* Even reads can crash X.org, let alone writes... */
4704 if (!capable(CAP_SYS_ADMIN))
4705 return -EPERM;
4707 enable = 0;
4708 disable = 0;
4710 while ((cmd = next_cmd(&buf))) {
4711 if (strlencmp(cmd, "lcd_enable") == 0) {
4712 enable |= TP_ACPI_VIDEO_S_LCD;
4713 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4714 disable |= TP_ACPI_VIDEO_S_LCD;
4715 } else if (strlencmp(cmd, "crt_enable") == 0) {
4716 enable |= TP_ACPI_VIDEO_S_CRT;
4717 } else if (strlencmp(cmd, "crt_disable") == 0) {
4718 disable |= TP_ACPI_VIDEO_S_CRT;
4719 } else if (video_supported == TPACPI_VIDEO_NEW &&
4720 strlencmp(cmd, "dvi_enable") == 0) {
4721 enable |= TP_ACPI_VIDEO_S_DVI;
4722 } else if (video_supported == TPACPI_VIDEO_NEW &&
4723 strlencmp(cmd, "dvi_disable") == 0) {
4724 disable |= TP_ACPI_VIDEO_S_DVI;
4725 } else if (strlencmp(cmd, "auto_enable") == 0) {
4726 res = video_autosw_set(1);
4727 if (res)
4728 return res;
4729 } else if (strlencmp(cmd, "auto_disable") == 0) {
4730 res = video_autosw_set(0);
4731 if (res)
4732 return res;
4733 } else if (strlencmp(cmd, "video_switch") == 0) {
4734 res = video_outputsw_cycle();
4735 if (res)
4736 return res;
4737 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4738 res = video_expand_toggle();
4739 if (res)
4740 return res;
4741 } else
4742 return -EINVAL;
4745 if (enable || disable) {
4746 status = video_outputsw_get();
4747 if (status < 0)
4748 return status;
4749 res = video_outputsw_set((status & ~disable) | enable);
4750 if (res)
4751 return res;
4754 return 0;
4757 static struct ibm_struct video_driver_data = {
4758 .name = "video",
4759 .read = video_read,
4760 .write = video_write,
4761 .exit = video_exit,
4764 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4766 /*************************************************************************
4767 * Light (thinklight) subdriver
4770 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4771 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4773 static int light_get_status(void)
4775 int status = 0;
4777 if (tp_features.light_status) {
4778 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4779 return -EIO;
4780 return (!!status);
4783 return -ENXIO;
4786 static int light_set_status(int status)
4788 int rc;
4790 if (tp_features.light) {
4791 if (cmos_handle) {
4792 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4793 (status)?
4794 TP_CMOS_THINKLIGHT_ON :
4795 TP_CMOS_THINKLIGHT_OFF);
4796 } else {
4797 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4798 (status)? 1 : 0);
4800 return (rc)? 0 : -EIO;
4803 return -ENXIO;
4806 static void light_set_status_worker(struct work_struct *work)
4808 struct tpacpi_led_classdev *data =
4809 container_of(work, struct tpacpi_led_classdev, work);
4811 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4812 light_set_status((data->new_state != TPACPI_LED_OFF));
4815 static void light_sysfs_set(struct led_classdev *led_cdev,
4816 enum led_brightness brightness)
4818 struct tpacpi_led_classdev *data =
4819 container_of(led_cdev,
4820 struct tpacpi_led_classdev,
4821 led_classdev);
4822 data->new_state = (brightness != LED_OFF) ?
4823 TPACPI_LED_ON : TPACPI_LED_OFF;
4824 queue_work(tpacpi_wq, &data->work);
4827 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4829 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4832 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4833 .led_classdev = {
4834 .name = "tpacpi::thinklight",
4835 .brightness_set = &light_sysfs_set,
4836 .brightness_get = &light_sysfs_get,
4840 static int __init light_init(struct ibm_init_struct *iibm)
4842 int rc;
4844 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4846 if (tpacpi_is_ibm()) {
4847 TPACPI_ACPIHANDLE_INIT(ledb);
4848 TPACPI_ACPIHANDLE_INIT(lght);
4850 TPACPI_ACPIHANDLE_INIT(cmos);
4851 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4853 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4854 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4856 if (tp_features.light)
4857 /* light status not supported on
4858 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4859 tp_features.light_status =
4860 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4862 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4863 str_supported(tp_features.light),
4864 str_supported(tp_features.light_status));
4866 if (!tp_features.light)
4867 return 1;
4869 rc = led_classdev_register(&tpacpi_pdev->dev,
4870 &tpacpi_led_thinklight.led_classdev);
4872 if (rc < 0) {
4873 tp_features.light = 0;
4874 tp_features.light_status = 0;
4875 } else {
4876 rc = 0;
4879 return rc;
4882 static void light_exit(void)
4884 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4885 if (work_pending(&tpacpi_led_thinklight.work))
4886 flush_workqueue(tpacpi_wq);
4889 static int light_read(struct seq_file *m)
4891 int status;
4893 if (!tp_features.light) {
4894 seq_printf(m, "status:\t\tnot supported\n");
4895 } else if (!tp_features.light_status) {
4896 seq_printf(m, "status:\t\tunknown\n");
4897 seq_printf(m, "commands:\ton, off\n");
4898 } else {
4899 status = light_get_status();
4900 if (status < 0)
4901 return status;
4902 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4903 seq_printf(m, "commands:\ton, off\n");
4906 return 0;
4909 static int light_write(char *buf)
4911 char *cmd;
4912 int newstatus = 0;
4914 if (!tp_features.light)
4915 return -ENODEV;
4917 while ((cmd = next_cmd(&buf))) {
4918 if (strlencmp(cmd, "on") == 0) {
4919 newstatus = 1;
4920 } else if (strlencmp(cmd, "off") == 0) {
4921 newstatus = 0;
4922 } else
4923 return -EINVAL;
4926 return light_set_status(newstatus);
4929 static struct ibm_struct light_driver_data = {
4930 .name = "light",
4931 .read = light_read,
4932 .write = light_write,
4933 .exit = light_exit,
4936 /*************************************************************************
4937 * CMOS subdriver
4940 /* sysfs cmos_command -------------------------------------------------- */
4941 static ssize_t cmos_command_store(struct device *dev,
4942 struct device_attribute *attr,
4943 const char *buf, size_t count)
4945 unsigned long cmos_cmd;
4946 int res;
4948 if (parse_strtoul(buf, 21, &cmos_cmd))
4949 return -EINVAL;
4951 res = issue_thinkpad_cmos_command(cmos_cmd);
4952 return (res)? res : count;
4955 static struct device_attribute dev_attr_cmos_command =
4956 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4958 /* --------------------------------------------------------------------- */
4960 static int __init cmos_init(struct ibm_init_struct *iibm)
4962 int res;
4964 vdbg_printk(TPACPI_DBG_INIT,
4965 "initializing cmos commands subdriver\n");
4967 TPACPI_ACPIHANDLE_INIT(cmos);
4969 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4970 str_supported(cmos_handle != NULL));
4972 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4973 if (res)
4974 return res;
4976 return (cmos_handle)? 0 : 1;
4979 static void cmos_exit(void)
4981 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4984 static int cmos_read(struct seq_file *m)
4986 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4987 R30, R31, T20-22, X20-21 */
4988 if (!cmos_handle)
4989 seq_printf(m, "status:\t\tnot supported\n");
4990 else {
4991 seq_printf(m, "status:\t\tsupported\n");
4992 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
4995 return 0;
4998 static int cmos_write(char *buf)
5000 char *cmd;
5001 int cmos_cmd, res;
5003 while ((cmd = next_cmd(&buf))) {
5004 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5005 cmos_cmd >= 0 && cmos_cmd <= 21) {
5006 /* cmos_cmd set */
5007 } else
5008 return -EINVAL;
5010 res = issue_thinkpad_cmos_command(cmos_cmd);
5011 if (res)
5012 return res;
5015 return 0;
5018 static struct ibm_struct cmos_driver_data = {
5019 .name = "cmos",
5020 .read = cmos_read,
5021 .write = cmos_write,
5022 .exit = cmos_exit,
5025 /*************************************************************************
5026 * LED subdriver
5029 enum led_access_mode {
5030 TPACPI_LED_NONE = 0,
5031 TPACPI_LED_570, /* 570 */
5032 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5033 TPACPI_LED_NEW, /* all others */
5036 enum { /* For TPACPI_LED_OLD */
5037 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5038 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5039 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5042 static enum led_access_mode led_supported;
5044 TPACPI_HANDLE(led, ec, "SLED", /* 570 */
5045 "SYSL", /* 600e/x, 770e, 770x, A21e, A2xm/p, */
5046 /* T20-22, X20-21 */
5047 "LED", /* all others */
5048 ); /* R30, R31 */
5050 #define TPACPI_LED_NUMLEDS 16
5051 static struct tpacpi_led_classdev *tpacpi_leds;
5052 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5053 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5054 /* there's a limit of 19 chars + NULL before 2.6.26 */
5055 "tpacpi::power",
5056 "tpacpi:orange:batt",
5057 "tpacpi:green:batt",
5058 "tpacpi::dock_active",
5059 "tpacpi::bay_active",
5060 "tpacpi::dock_batt",
5061 "tpacpi::unknown_led",
5062 "tpacpi::standby",
5063 "tpacpi::dock_status1",
5064 "tpacpi::dock_status2",
5065 "tpacpi::unknown_led2",
5066 "tpacpi::unknown_led3",
5067 "tpacpi::thinkvantage",
5069 #define TPACPI_SAFE_LEDS 0x1081U
5071 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5073 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5074 return false;
5075 #else
5076 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5077 #endif
5080 static int led_get_status(const unsigned int led)
5082 int status;
5083 enum led_status_t led_s;
5085 switch (led_supported) {
5086 case TPACPI_LED_570:
5087 if (!acpi_evalf(ec_handle,
5088 &status, "GLED", "dd", 1 << led))
5089 return -EIO;
5090 led_s = (status == 0)?
5091 TPACPI_LED_OFF :
5092 ((status == 1)?
5093 TPACPI_LED_ON :
5094 TPACPI_LED_BLINK);
5095 tpacpi_led_state_cache[led] = led_s;
5096 return led_s;
5097 default:
5098 return -ENXIO;
5101 /* not reached */
5104 static int led_set_status(const unsigned int led,
5105 const enum led_status_t ledstatus)
5107 /* off, on, blink. Index is led_status_t */
5108 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5109 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5111 int rc = 0;
5113 switch (led_supported) {
5114 case TPACPI_LED_570:
5115 /* 570 */
5116 if (unlikely(led > 7))
5117 return -EINVAL;
5118 if (unlikely(tpacpi_is_led_restricted(led)))
5119 return -EPERM;
5120 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5121 (1 << led), led_sled_arg1[ledstatus]))
5122 rc = -EIO;
5123 break;
5124 case TPACPI_LED_OLD:
5125 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5126 if (unlikely(led > 7))
5127 return -EINVAL;
5128 if (unlikely(tpacpi_is_led_restricted(led)))
5129 return -EPERM;
5130 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5131 if (rc >= 0)
5132 rc = ec_write(TPACPI_LED_EC_HLBL,
5133 (ledstatus == TPACPI_LED_BLINK) << led);
5134 if (rc >= 0)
5135 rc = ec_write(TPACPI_LED_EC_HLCL,
5136 (ledstatus != TPACPI_LED_OFF) << led);
5137 break;
5138 case TPACPI_LED_NEW:
5139 /* all others */
5140 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5141 return -EINVAL;
5142 if (unlikely(tpacpi_is_led_restricted(led)))
5143 return -EPERM;
5144 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5145 led, led_led_arg1[ledstatus]))
5146 rc = -EIO;
5147 break;
5148 default:
5149 rc = -ENXIO;
5152 if (!rc)
5153 tpacpi_led_state_cache[led] = ledstatus;
5155 return rc;
5158 static void led_set_status_worker(struct work_struct *work)
5160 struct tpacpi_led_classdev *data =
5161 container_of(work, struct tpacpi_led_classdev, work);
5163 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5164 led_set_status(data->led, data->new_state);
5167 static void led_sysfs_set(struct led_classdev *led_cdev,
5168 enum led_brightness brightness)
5170 struct tpacpi_led_classdev *data = container_of(led_cdev,
5171 struct tpacpi_led_classdev, led_classdev);
5173 if (brightness == LED_OFF)
5174 data->new_state = TPACPI_LED_OFF;
5175 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5176 data->new_state = TPACPI_LED_ON;
5177 else
5178 data->new_state = TPACPI_LED_BLINK;
5180 queue_work(tpacpi_wq, &data->work);
5183 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5184 unsigned long *delay_on, unsigned long *delay_off)
5186 struct tpacpi_led_classdev *data = container_of(led_cdev,
5187 struct tpacpi_led_classdev, led_classdev);
5189 /* Can we choose the flash rate? */
5190 if (*delay_on == 0 && *delay_off == 0) {
5191 /* yes. set them to the hardware blink rate (1 Hz) */
5192 *delay_on = 500; /* ms */
5193 *delay_off = 500; /* ms */
5194 } else if ((*delay_on != 500) || (*delay_off != 500))
5195 return -EINVAL;
5197 data->new_state = TPACPI_LED_BLINK;
5198 queue_work(tpacpi_wq, &data->work);
5200 return 0;
5203 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5205 int rc;
5207 struct tpacpi_led_classdev *data = container_of(led_cdev,
5208 struct tpacpi_led_classdev, led_classdev);
5210 rc = led_get_status(data->led);
5212 if (rc == TPACPI_LED_OFF || rc < 0)
5213 rc = LED_OFF; /* no error handling in led class :( */
5214 else
5215 rc = LED_FULL;
5217 return rc;
5220 static void led_exit(void)
5222 unsigned int i;
5224 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5225 if (tpacpi_leds[i].led_classdev.name)
5226 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5229 kfree(tpacpi_leds);
5232 static int __init tpacpi_init_led(unsigned int led)
5234 int rc;
5236 tpacpi_leds[led].led = led;
5238 /* LEDs with no name don't get registered */
5239 if (!tpacpi_led_names[led])
5240 return 0;
5242 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5243 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5244 if (led_supported == TPACPI_LED_570)
5245 tpacpi_leds[led].led_classdev.brightness_get =
5246 &led_sysfs_get;
5248 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5250 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5252 rc = led_classdev_register(&tpacpi_pdev->dev,
5253 &tpacpi_leds[led].led_classdev);
5254 if (rc < 0)
5255 tpacpi_leds[led].led_classdev.name = NULL;
5257 return rc;
5260 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5261 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5262 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5263 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5265 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5266 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5267 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5268 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5269 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5270 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5271 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5272 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5274 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5275 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5276 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5277 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5278 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5280 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5281 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5282 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5283 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5285 /* (1) - may have excess leds enabled on MSB */
5287 /* Defaults (order matters, keep last, don't reorder!) */
5288 { /* Lenovo */
5289 .vendor = PCI_VENDOR_ID_LENOVO,
5290 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5291 .quirks = 0x1fffU,
5293 { /* IBM ThinkPads with no EC version string */
5294 .vendor = PCI_VENDOR_ID_IBM,
5295 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5296 .quirks = 0x00ffU,
5298 { /* IBM ThinkPads with EC version string */
5299 .vendor = PCI_VENDOR_ID_IBM,
5300 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5301 .quirks = 0x00bfU,
5305 #undef TPACPI_LEDQ_IBM
5306 #undef TPACPI_LEDQ_LNV
5308 static int __init led_init(struct ibm_init_struct *iibm)
5310 unsigned int i;
5311 int rc;
5312 unsigned long useful_leds;
5314 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5316 TPACPI_ACPIHANDLE_INIT(led);
5318 if (!led_handle)
5319 /* led not supported on R30, R31 */
5320 led_supported = TPACPI_LED_NONE;
5321 else if (tpacpi_is_ibm() && strlencmp(led_path, "SLED") == 0)
5322 /* 570 */
5323 led_supported = TPACPI_LED_570;
5324 else if (tpacpi_is_ibm() && strlencmp(led_path, "SYSL") == 0)
5325 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5326 led_supported = TPACPI_LED_OLD;
5327 else
5328 /* all others */
5329 led_supported = TPACPI_LED_NEW;
5331 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5332 str_supported(led_supported), led_supported);
5334 if (led_supported == TPACPI_LED_NONE)
5335 return 1;
5337 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5338 GFP_KERNEL);
5339 if (!tpacpi_leds) {
5340 printk(TPACPI_ERR "Out of memory for LED data\n");
5341 return -ENOMEM;
5344 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5345 ARRAY_SIZE(led_useful_qtable));
5347 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5348 if (!tpacpi_is_led_restricted(i) &&
5349 test_bit(i, &useful_leds)) {
5350 rc = tpacpi_init_led(i);
5351 if (rc < 0) {
5352 led_exit();
5353 return rc;
5358 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5359 printk(TPACPI_NOTICE
5360 "warning: userspace override of important "
5361 "firmware LEDs is enabled\n");
5362 #endif
5363 return 0;
5366 #define str_led_status(s) \
5367 ((s) == TPACPI_LED_OFF ? "off" : \
5368 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5370 static int led_read(struct seq_file *m)
5372 if (!led_supported) {
5373 seq_printf(m, "status:\t\tnot supported\n");
5374 return 0;
5376 seq_printf(m, "status:\t\tsupported\n");
5378 if (led_supported == TPACPI_LED_570) {
5379 /* 570 */
5380 int i, status;
5381 for (i = 0; i < 8; i++) {
5382 status = led_get_status(i);
5383 if (status < 0)
5384 return -EIO;
5385 seq_printf(m, "%d:\t\t%s\n",
5386 i, str_led_status(status));
5390 seq_printf(m, "commands:\t"
5391 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5393 return 0;
5396 static int led_write(char *buf)
5398 char *cmd;
5399 int led, rc;
5400 enum led_status_t s;
5402 if (!led_supported)
5403 return -ENODEV;
5405 while ((cmd = next_cmd(&buf))) {
5406 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5407 return -EINVAL;
5409 if (strstr(cmd, "off")) {
5410 s = TPACPI_LED_OFF;
5411 } else if (strstr(cmd, "on")) {
5412 s = TPACPI_LED_ON;
5413 } else if (strstr(cmd, "blink")) {
5414 s = TPACPI_LED_BLINK;
5415 } else {
5416 return -EINVAL;
5419 rc = led_set_status(led, s);
5420 if (rc < 0)
5421 return rc;
5424 return 0;
5427 static struct ibm_struct led_driver_data = {
5428 .name = "led",
5429 .read = led_read,
5430 .write = led_write,
5431 .exit = led_exit,
5434 /*************************************************************************
5435 * Beep subdriver
5438 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5440 #define TPACPI_BEEP_Q1 0x0001
5442 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5443 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5444 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5447 static int __init beep_init(struct ibm_init_struct *iibm)
5449 unsigned long quirks;
5451 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5453 TPACPI_ACPIHANDLE_INIT(beep);
5455 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5456 str_supported(beep_handle != NULL));
5458 quirks = tpacpi_check_quirks(beep_quirk_table,
5459 ARRAY_SIZE(beep_quirk_table));
5461 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5463 return (beep_handle)? 0 : 1;
5466 static int beep_read(struct seq_file *m)
5468 if (!beep_handle)
5469 seq_printf(m, "status:\t\tnot supported\n");
5470 else {
5471 seq_printf(m, "status:\t\tsupported\n");
5472 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5475 return 0;
5478 static int beep_write(char *buf)
5480 char *cmd;
5481 int beep_cmd;
5483 if (!beep_handle)
5484 return -ENODEV;
5486 while ((cmd = next_cmd(&buf))) {
5487 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5488 beep_cmd >= 0 && beep_cmd <= 17) {
5489 /* beep_cmd set */
5490 } else
5491 return -EINVAL;
5492 if (tp_features.beep_needs_two_args) {
5493 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5494 beep_cmd, 0))
5495 return -EIO;
5496 } else {
5497 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5498 beep_cmd))
5499 return -EIO;
5503 return 0;
5506 static struct ibm_struct beep_driver_data = {
5507 .name = "beep",
5508 .read = beep_read,
5509 .write = beep_write,
5512 /*************************************************************************
5513 * Thermal subdriver
5516 enum thermal_access_mode {
5517 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5518 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5519 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5520 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5521 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5524 enum { /* TPACPI_THERMAL_TPEC_* */
5525 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5526 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5527 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5529 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5533 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5534 struct ibm_thermal_sensors_struct {
5535 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5538 static enum thermal_access_mode thermal_read_mode;
5540 /* idx is zero-based */
5541 static int thermal_get_sensor(int idx, s32 *value)
5543 int t;
5544 s8 tmp;
5545 char tmpi[5];
5547 t = TP_EC_THERMAL_TMP0;
5549 switch (thermal_read_mode) {
5550 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5551 case TPACPI_THERMAL_TPEC_16:
5552 if (idx >= 8 && idx <= 15) {
5553 t = TP_EC_THERMAL_TMP8;
5554 idx -= 8;
5556 /* fallthrough */
5557 #endif
5558 case TPACPI_THERMAL_TPEC_8:
5559 if (idx <= 7) {
5560 if (!acpi_ec_read(t + idx, &tmp))
5561 return -EIO;
5562 *value = tmp * 1000;
5563 return 0;
5565 break;
5567 case TPACPI_THERMAL_ACPI_UPDT:
5568 if (idx <= 7) {
5569 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5570 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5571 return -EIO;
5572 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5573 return -EIO;
5574 *value = (t - 2732) * 100;
5575 return 0;
5577 break;
5579 case TPACPI_THERMAL_ACPI_TMP07:
5580 if (idx <= 7) {
5581 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5582 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5583 return -EIO;
5584 if (t > 127 || t < -127)
5585 t = TP_EC_THERMAL_TMP_NA;
5586 *value = t * 1000;
5587 return 0;
5589 break;
5591 case TPACPI_THERMAL_NONE:
5592 default:
5593 return -ENOSYS;
5596 return -EINVAL;
5599 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5601 int res, i;
5602 int n;
5604 n = 8;
5605 i = 0;
5607 if (!s)
5608 return -EINVAL;
5610 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5611 n = 16;
5613 for (i = 0 ; i < n; i++) {
5614 res = thermal_get_sensor(i, &s->temp[i]);
5615 if (res)
5616 return res;
5619 return n;
5622 static void thermal_dump_all_sensors(void)
5624 int n, i;
5625 struct ibm_thermal_sensors_struct t;
5627 n = thermal_get_sensors(&t);
5628 if (n <= 0)
5629 return;
5631 printk(TPACPI_NOTICE
5632 "temperatures (Celsius):");
5634 for (i = 0; i < n; i++) {
5635 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5636 printk(KERN_CONT " %d", (int)(t.temp[i] / 1000));
5637 else
5638 printk(KERN_CONT " N/A");
5641 printk(KERN_CONT "\n");
5644 /* sysfs temp##_input -------------------------------------------------- */
5646 static ssize_t thermal_temp_input_show(struct device *dev,
5647 struct device_attribute *attr,
5648 char *buf)
5650 struct sensor_device_attribute *sensor_attr =
5651 to_sensor_dev_attr(attr);
5652 int idx = sensor_attr->index;
5653 s32 value;
5654 int res;
5656 res = thermal_get_sensor(idx, &value);
5657 if (res)
5658 return res;
5659 if (value == TPACPI_THERMAL_SENSOR_NA)
5660 return -ENXIO;
5662 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5665 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5666 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5667 thermal_temp_input_show, NULL, _idxB)
5669 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5670 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5671 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5672 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5673 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5674 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5675 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5676 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5677 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5678 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5679 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5680 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5681 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5682 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5683 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5684 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5685 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5688 #define THERMAL_ATTRS(X) \
5689 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5691 static struct attribute *thermal_temp_input_attr[] = {
5692 THERMAL_ATTRS(8),
5693 THERMAL_ATTRS(9),
5694 THERMAL_ATTRS(10),
5695 THERMAL_ATTRS(11),
5696 THERMAL_ATTRS(12),
5697 THERMAL_ATTRS(13),
5698 THERMAL_ATTRS(14),
5699 THERMAL_ATTRS(15),
5700 THERMAL_ATTRS(0),
5701 THERMAL_ATTRS(1),
5702 THERMAL_ATTRS(2),
5703 THERMAL_ATTRS(3),
5704 THERMAL_ATTRS(4),
5705 THERMAL_ATTRS(5),
5706 THERMAL_ATTRS(6),
5707 THERMAL_ATTRS(7),
5708 NULL
5711 static const struct attribute_group thermal_temp_input16_group = {
5712 .attrs = thermal_temp_input_attr
5715 static const struct attribute_group thermal_temp_input8_group = {
5716 .attrs = &thermal_temp_input_attr[8]
5719 #undef THERMAL_SENSOR_ATTR_TEMP
5720 #undef THERMAL_ATTRS
5722 /* --------------------------------------------------------------------- */
5724 static int __init thermal_init(struct ibm_init_struct *iibm)
5726 u8 t, ta1, ta2;
5727 int i;
5728 int acpi_tmp7;
5729 int res;
5731 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5733 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5735 if (thinkpad_id.ec_model) {
5737 * Direct EC access mode: sensors at registers
5738 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5739 * non-implemented, thermal sensors return 0x80 when
5740 * not available
5743 ta1 = ta2 = 0;
5744 for (i = 0; i < 8; i++) {
5745 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5746 ta1 |= t;
5747 } else {
5748 ta1 = 0;
5749 break;
5751 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5752 ta2 |= t;
5753 } else {
5754 ta1 = 0;
5755 break;
5758 if (ta1 == 0) {
5759 /* This is sheer paranoia, but we handle it anyway */
5760 if (acpi_tmp7) {
5761 printk(TPACPI_ERR
5762 "ThinkPad ACPI EC access misbehaving, "
5763 "falling back to ACPI TMPx access "
5764 "mode\n");
5765 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5766 } else {
5767 printk(TPACPI_ERR
5768 "ThinkPad ACPI EC access misbehaving, "
5769 "disabling thermal sensors access\n");
5770 thermal_read_mode = TPACPI_THERMAL_NONE;
5772 } else {
5773 thermal_read_mode =
5774 (ta2 != 0) ?
5775 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5777 } else if (acpi_tmp7) {
5778 if (tpacpi_is_ibm() &&
5779 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5780 /* 600e/x, 770e, 770x */
5781 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5782 } else {
5783 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5784 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5786 } else {
5787 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5788 thermal_read_mode = TPACPI_THERMAL_NONE;
5791 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5792 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5793 thermal_read_mode);
5795 switch (thermal_read_mode) {
5796 case TPACPI_THERMAL_TPEC_16:
5797 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5798 &thermal_temp_input16_group);
5799 if (res)
5800 return res;
5801 break;
5802 case TPACPI_THERMAL_TPEC_8:
5803 case TPACPI_THERMAL_ACPI_TMP07:
5804 case TPACPI_THERMAL_ACPI_UPDT:
5805 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5806 &thermal_temp_input8_group);
5807 if (res)
5808 return res;
5809 break;
5810 case TPACPI_THERMAL_NONE:
5811 default:
5812 return 1;
5815 return 0;
5818 static void thermal_exit(void)
5820 switch (thermal_read_mode) {
5821 case TPACPI_THERMAL_TPEC_16:
5822 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5823 &thermal_temp_input16_group);
5824 break;
5825 case TPACPI_THERMAL_TPEC_8:
5826 case TPACPI_THERMAL_ACPI_TMP07:
5827 case TPACPI_THERMAL_ACPI_UPDT:
5828 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5829 &thermal_temp_input8_group);
5830 break;
5831 case TPACPI_THERMAL_NONE:
5832 default:
5833 break;
5837 static int thermal_read(struct seq_file *m)
5839 int n, i;
5840 struct ibm_thermal_sensors_struct t;
5842 n = thermal_get_sensors(&t);
5843 if (unlikely(n < 0))
5844 return n;
5846 seq_printf(m, "temperatures:\t");
5848 if (n > 0) {
5849 for (i = 0; i < (n - 1); i++)
5850 seq_printf(m, "%d ", t.temp[i] / 1000);
5851 seq_printf(m, "%d\n", t.temp[i] / 1000);
5852 } else
5853 seq_printf(m, "not supported\n");
5855 return 0;
5858 static struct ibm_struct thermal_driver_data = {
5859 .name = "thermal",
5860 .read = thermal_read,
5861 .exit = thermal_exit,
5864 /*************************************************************************
5865 * EC Dump subdriver
5868 static u8 ecdump_regs[256];
5870 static int ecdump_read(struct seq_file *m)
5872 int i, j;
5873 u8 v;
5875 seq_printf(m, "EC "
5876 " +00 +01 +02 +03 +04 +05 +06 +07"
5877 " +08 +09 +0a +0b +0c +0d +0e +0f\n");
5878 for (i = 0; i < 256; i += 16) {
5879 seq_printf(m, "EC 0x%02x:", i);
5880 for (j = 0; j < 16; j++) {
5881 if (!acpi_ec_read(i + j, &v))
5882 break;
5883 if (v != ecdump_regs[i + j])
5884 seq_printf(m, " *%02x", v);
5885 else
5886 seq_printf(m, " %02x", v);
5887 ecdump_regs[i + j] = v;
5889 seq_putc(m, '\n');
5890 if (j != 16)
5891 break;
5894 /* These are way too dangerous to advertise openly... */
5895 #if 0
5896 seq_printf(m, "commands:\t0x<offset> 0x<value>"
5897 " (<offset> is 00-ff, <value> is 00-ff)\n");
5898 seq_printf(m, "commands:\t0x<offset> <value> "
5899 " (<offset> is 00-ff, <value> is 0-255)\n");
5900 #endif
5901 return 0;
5904 static int ecdump_write(char *buf)
5906 char *cmd;
5907 int i, v;
5909 while ((cmd = next_cmd(&buf))) {
5910 if (sscanf(cmd, "0x%x 0x%x", &i, &v) == 2) {
5911 /* i and v set */
5912 } else if (sscanf(cmd, "0x%x %u", &i, &v) == 2) {
5913 /* i and v set */
5914 } else
5915 return -EINVAL;
5916 if (i >= 0 && i < 256 && v >= 0 && v < 256) {
5917 if (!acpi_ec_write(i, v))
5918 return -EIO;
5919 } else
5920 return -EINVAL;
5923 return 0;
5926 static struct ibm_struct ecdump_driver_data = {
5927 .name = "ecdump",
5928 .read = ecdump_read,
5929 .write = ecdump_write,
5930 .flags.experimental = 1,
5933 /*************************************************************************
5934 * Backlight/brightness subdriver
5937 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5940 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5941 * CMOS NVRAM byte 0x5E, bits 0-3.
5943 * EC HBRV (0x31) has the following layout
5944 * Bit 7: unknown function
5945 * Bit 6: unknown function
5946 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5947 * Bit 4: must be set to zero to avoid problems
5948 * Bit 3-0: backlight brightness level
5950 * brightness_get_raw returns status data in the HBRV layout
5952 * WARNING: The X61 has been verified to use HBRV for something else, so
5953 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5954 * testing on the very early *60 Lenovo models...
5957 enum {
5958 TP_EC_BACKLIGHT = 0x31,
5960 /* TP_EC_BACKLIGHT bitmasks */
5961 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5962 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5963 TP_EC_BACKLIGHT_MAPSW = 0x20,
5966 enum tpacpi_brightness_access_mode {
5967 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5968 TPACPI_BRGHT_MODE_EC, /* EC control */
5969 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5970 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5971 TPACPI_BRGHT_MODE_MAX
5974 static struct backlight_device *ibm_backlight_device;
5976 static enum tpacpi_brightness_access_mode brightness_mode =
5977 TPACPI_BRGHT_MODE_MAX;
5979 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5981 static struct mutex brightness_mutex;
5983 /* NVRAM brightness access,
5984 * call with brightness_mutex held! */
5985 static unsigned int tpacpi_brightness_nvram_get(void)
5987 u8 lnvram;
5989 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5990 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5991 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5992 lnvram &= (tp_features.bright_16levels) ? 0x0f : 0x07;
5994 return lnvram;
5997 static void tpacpi_brightness_checkpoint_nvram(void)
5999 u8 lec = 0;
6000 u8 b_nvram;
6002 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6003 return;
6005 vdbg_printk(TPACPI_DBG_BRGHT,
6006 "trying to checkpoint backlight level to NVRAM...\n");
6008 if (mutex_lock_killable(&brightness_mutex) < 0)
6009 return;
6011 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6012 goto unlock;
6013 lec &= TP_EC_BACKLIGHT_LVLMSK;
6014 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6016 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6017 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6018 /* NVRAM needs update */
6019 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6020 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6021 b_nvram |= lec;
6022 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6023 dbg_printk(TPACPI_DBG_BRGHT,
6024 "updated NVRAM backlight level to %u (0x%02x)\n",
6025 (unsigned int) lec, (unsigned int) b_nvram);
6026 } else
6027 vdbg_printk(TPACPI_DBG_BRGHT,
6028 "NVRAM backlight level already is %u (0x%02x)\n",
6029 (unsigned int) lec, (unsigned int) b_nvram);
6031 unlock:
6032 mutex_unlock(&brightness_mutex);
6036 /* call with brightness_mutex held! */
6037 static int tpacpi_brightness_get_raw(int *status)
6039 u8 lec = 0;
6041 switch (brightness_mode) {
6042 case TPACPI_BRGHT_MODE_UCMS_STEP:
6043 *status = tpacpi_brightness_nvram_get();
6044 return 0;
6045 case TPACPI_BRGHT_MODE_EC:
6046 case TPACPI_BRGHT_MODE_ECNVRAM:
6047 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6048 return -EIO;
6049 *status = lec;
6050 return 0;
6051 default:
6052 return -ENXIO;
6056 /* call with brightness_mutex held! */
6057 /* do NOT call with illegal backlight level value */
6058 static int tpacpi_brightness_set_ec(unsigned int value)
6060 u8 lec = 0;
6062 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6063 return -EIO;
6065 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6066 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6067 (value & TP_EC_BACKLIGHT_LVLMSK))))
6068 return -EIO;
6070 return 0;
6073 /* call with brightness_mutex held! */
6074 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6076 int cmos_cmd, inc;
6077 unsigned int current_value, i;
6079 current_value = tpacpi_brightness_nvram_get();
6081 if (value == current_value)
6082 return 0;
6084 cmos_cmd = (value > current_value) ?
6085 TP_CMOS_BRIGHTNESS_UP :
6086 TP_CMOS_BRIGHTNESS_DOWN;
6087 inc = (value > current_value) ? 1 : -1;
6089 for (i = current_value; i != value; i += inc)
6090 if (issue_thinkpad_cmos_command(cmos_cmd))
6091 return -EIO;
6093 return 0;
6096 /* May return EINTR which can always be mapped to ERESTARTSYS */
6097 static int brightness_set(unsigned int value)
6099 int res;
6101 if (value > ((tp_features.bright_16levels)? 15 : 7) ||
6102 value < 0)
6103 return -EINVAL;
6105 vdbg_printk(TPACPI_DBG_BRGHT,
6106 "set backlight level to %d\n", value);
6108 res = mutex_lock_killable(&brightness_mutex);
6109 if (res < 0)
6110 return res;
6112 switch (brightness_mode) {
6113 case TPACPI_BRGHT_MODE_EC:
6114 case TPACPI_BRGHT_MODE_ECNVRAM:
6115 res = tpacpi_brightness_set_ec(value);
6116 break;
6117 case TPACPI_BRGHT_MODE_UCMS_STEP:
6118 res = tpacpi_brightness_set_ucmsstep(value);
6119 break;
6120 default:
6121 res = -ENXIO;
6124 mutex_unlock(&brightness_mutex);
6125 return res;
6128 /* sysfs backlight class ----------------------------------------------- */
6130 static int brightness_update_status(struct backlight_device *bd)
6132 unsigned int level =
6133 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6134 bd->props.power == FB_BLANK_UNBLANK) ?
6135 bd->props.brightness : 0;
6137 dbg_printk(TPACPI_DBG_BRGHT,
6138 "backlight: attempt to set level to %d\n",
6139 level);
6141 /* it is the backlight class's job (caller) to handle
6142 * EINTR and other errors properly */
6143 return brightness_set(level);
6146 static int brightness_get(struct backlight_device *bd)
6148 int status, res;
6150 res = mutex_lock_killable(&brightness_mutex);
6151 if (res < 0)
6152 return 0;
6154 res = tpacpi_brightness_get_raw(&status);
6156 mutex_unlock(&brightness_mutex);
6158 if (res < 0)
6159 return 0;
6161 return status & TP_EC_BACKLIGHT_LVLMSK;
6164 static void tpacpi_brightness_notify_change(void)
6166 backlight_force_update(ibm_backlight_device,
6167 BACKLIGHT_UPDATE_HOTKEY);
6170 static struct backlight_ops ibm_backlight_data = {
6171 .get_brightness = brightness_get,
6172 .update_status = brightness_update_status,
6175 /* --------------------------------------------------------------------- */
6178 * These are only useful for models that have only one possibility
6179 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6180 * these quirks.
6182 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6183 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6184 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6186 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6187 /* Models with ATI GPUs known to require ECNVRAM mode */
6188 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6190 /* Models with ATI GPUs that can use ECNVRAM */
6191 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6192 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6193 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6194 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6196 /* Models with Intel Extreme Graphics 2 */
6197 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6198 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6199 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6201 /* Models with Intel GMA900 */
6202 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6203 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6204 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6207 static int __init brightness_init(struct ibm_init_struct *iibm)
6209 struct backlight_properties props;
6210 int b;
6211 unsigned long quirks;
6213 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6215 mutex_init(&brightness_mutex);
6217 quirks = tpacpi_check_quirks(brightness_quirk_table,
6218 ARRAY_SIZE(brightness_quirk_table));
6221 * We always attempt to detect acpi support, so as to switch
6222 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6223 * going to publish a backlight interface
6225 b = tpacpi_check_std_acpi_brightness_support();
6226 if (b > 0) {
6228 if (acpi_video_backlight_support()) {
6229 if (brightness_enable > 1) {
6230 printk(TPACPI_NOTICE
6231 "Standard ACPI backlight interface "
6232 "available, not loading native one.\n");
6233 return 1;
6234 } else if (brightness_enable == 1) {
6235 printk(TPACPI_NOTICE
6236 "Backlight control force enabled, even if standard "
6237 "ACPI backlight interface is available\n");
6239 } else {
6240 if (brightness_enable > 1) {
6241 printk(TPACPI_NOTICE
6242 "Standard ACPI backlight interface not "
6243 "available, thinkpad_acpi native "
6244 "brightness control enabled\n");
6249 if (!brightness_enable) {
6250 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6251 "brightness support disabled by "
6252 "module parameter\n");
6253 return 1;
6256 if (b > 16) {
6257 printk(TPACPI_ERR
6258 "Unsupported brightness interface, "
6259 "please contact %s\n", TPACPI_MAIL);
6260 return 1;
6262 if (b == 16)
6263 tp_features.bright_16levels = 1;
6266 * Check for module parameter bogosity, note that we
6267 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6268 * able to detect "unspecified"
6270 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6271 return -EINVAL;
6273 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6274 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6275 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6276 if (quirks & TPACPI_BRGHT_Q_EC)
6277 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6278 else
6279 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6281 dbg_printk(TPACPI_DBG_BRGHT,
6282 "driver auto-selected brightness_mode=%d\n",
6283 brightness_mode);
6286 /* Safety */
6287 if (!tpacpi_is_ibm() &&
6288 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6289 brightness_mode == TPACPI_BRGHT_MODE_EC))
6290 return -EINVAL;
6292 if (tpacpi_brightness_get_raw(&b) < 0)
6293 return 1;
6295 if (tp_features.bright_16levels)
6296 printk(TPACPI_INFO
6297 "detected a 16-level brightness capable ThinkPad\n");
6299 memset(&props, 0, sizeof(struct backlight_properties));
6300 props.max_brightness = (tp_features.bright_16levels) ? 15 : 7;
6301 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6302 NULL, NULL,
6303 &ibm_backlight_data,
6304 &props);
6305 if (IS_ERR(ibm_backlight_device)) {
6306 int rc = PTR_ERR(ibm_backlight_device);
6307 ibm_backlight_device = NULL;
6308 printk(TPACPI_ERR "Could not register backlight device\n");
6309 return rc;
6311 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6312 "brightness is supported\n");
6314 if (quirks & TPACPI_BRGHT_Q_ASK) {
6315 printk(TPACPI_NOTICE
6316 "brightness: will use unverified default: "
6317 "brightness_mode=%d\n", brightness_mode);
6318 printk(TPACPI_NOTICE
6319 "brightness: please report to %s whether it works well "
6320 "or not on your ThinkPad\n", TPACPI_MAIL);
6323 ibm_backlight_device->props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6324 backlight_update_status(ibm_backlight_device);
6326 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6327 "brightness: registering brightness hotkeys "
6328 "as change notification\n");
6329 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6330 | TP_ACPI_HKEY_BRGHTUP_MASK
6331 | TP_ACPI_HKEY_BRGHTDWN_MASK);;
6332 return 0;
6335 static void brightness_suspend(pm_message_t state)
6337 tpacpi_brightness_checkpoint_nvram();
6340 static void brightness_shutdown(void)
6342 tpacpi_brightness_checkpoint_nvram();
6345 static void brightness_exit(void)
6347 if (ibm_backlight_device) {
6348 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6349 "calling backlight_device_unregister()\n");
6350 backlight_device_unregister(ibm_backlight_device);
6353 tpacpi_brightness_checkpoint_nvram();
6356 static int brightness_read(struct seq_file *m)
6358 int level;
6360 level = brightness_get(NULL);
6361 if (level < 0) {
6362 seq_printf(m, "level:\t\tunreadable\n");
6363 } else {
6364 seq_printf(m, "level:\t\t%d\n", level);
6365 seq_printf(m, "commands:\tup, down\n");
6366 seq_printf(m, "commands:\tlevel <level>"
6367 " (<level> is 0-%d)\n",
6368 (tp_features.bright_16levels) ? 15 : 7);
6371 return 0;
6374 static int brightness_write(char *buf)
6376 int level;
6377 int rc;
6378 char *cmd;
6379 int max_level = (tp_features.bright_16levels) ? 15 : 7;
6381 level = brightness_get(NULL);
6382 if (level < 0)
6383 return level;
6385 while ((cmd = next_cmd(&buf))) {
6386 if (strlencmp(cmd, "up") == 0) {
6387 if (level < max_level)
6388 level++;
6389 } else if (strlencmp(cmd, "down") == 0) {
6390 if (level > 0)
6391 level--;
6392 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6393 level >= 0 && level <= max_level) {
6394 /* new level set */
6395 } else
6396 return -EINVAL;
6399 tpacpi_disclose_usertask("procfs brightness",
6400 "set level to %d\n", level);
6403 * Now we know what the final level should be, so we try to set it.
6404 * Doing it this way makes the syscall restartable in case of EINTR
6406 rc = brightness_set(level);
6407 if (!rc && ibm_backlight_device)
6408 backlight_force_update(ibm_backlight_device,
6409 BACKLIGHT_UPDATE_SYSFS);
6410 return (rc == -EINTR)? -ERESTARTSYS : rc;
6413 static struct ibm_struct brightness_driver_data = {
6414 .name = "brightness",
6415 .read = brightness_read,
6416 .write = brightness_write,
6417 .exit = brightness_exit,
6418 .suspend = brightness_suspend,
6419 .shutdown = brightness_shutdown,
6422 /*************************************************************************
6423 * Volume subdriver
6427 * IBM ThinkPads have a simple volume controller with MUTE gating.
6428 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6430 * Since the *61 series (and probably also the later *60 series), Lenovo
6431 * ThinkPads only implement the MUTE gate.
6433 * EC register 0x30
6434 * Bit 6: MUTE (1 mutes sound)
6435 * Bit 3-0: Volume
6436 * Other bits should be zero as far as we know.
6438 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6439 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
6440 * such as bit 7 which is used to detect repeated presses of MUTE,
6441 * and we leave them unchanged.
6444 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6446 #define TPACPI_ALSA_DRVNAME "ThinkPad EC"
6447 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6448 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6450 static int alsa_index = ~((1 << (SNDRV_CARDS - 3)) - 1); /* last three slots */
6451 static char *alsa_id = "ThinkPadEC";
6452 static int alsa_enable = SNDRV_DEFAULT_ENABLE1;
6454 struct tpacpi_alsa_data {
6455 struct snd_card *card;
6456 struct snd_ctl_elem_id *ctl_mute_id;
6457 struct snd_ctl_elem_id *ctl_vol_id;
6460 static struct snd_card *alsa_card;
6462 enum {
6463 TP_EC_AUDIO = 0x30,
6465 /* TP_EC_AUDIO bits */
6466 TP_EC_AUDIO_MUTESW = 6,
6468 /* TP_EC_AUDIO bitmasks */
6469 TP_EC_AUDIO_LVL_MSK = 0x0F,
6470 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6472 /* Maximum volume */
6473 TP_EC_VOLUME_MAX = 14,
6476 enum tpacpi_volume_access_mode {
6477 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
6478 TPACPI_VOL_MODE_EC, /* Pure EC control */
6479 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
6480 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6481 TPACPI_VOL_MODE_MAX
6484 enum tpacpi_volume_capabilities {
6485 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
6486 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
6487 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
6488 TPACPI_VOL_CAP_MAX
6491 static enum tpacpi_volume_access_mode volume_mode =
6492 TPACPI_VOL_MODE_MAX;
6494 static enum tpacpi_volume_capabilities volume_capabilities;
6495 static int volume_control_allowed;
6498 * Used to syncronize writers to TP_EC_AUDIO and
6499 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6501 static struct mutex volume_mutex;
6503 static void tpacpi_volume_checkpoint_nvram(void)
6505 u8 lec = 0;
6506 u8 b_nvram;
6507 u8 ec_mask;
6509 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6510 return;
6511 if (!volume_control_allowed)
6512 return;
6514 vdbg_printk(TPACPI_DBG_MIXER,
6515 "trying to checkpoint mixer state to NVRAM...\n");
6517 if (tp_features.mixer_no_level_control)
6518 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6519 else
6520 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6522 if (mutex_lock_killable(&volume_mutex) < 0)
6523 return;
6525 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6526 goto unlock;
6527 lec &= ec_mask;
6528 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6530 if (lec != (b_nvram & ec_mask)) {
6531 /* NVRAM needs update */
6532 b_nvram &= ~ec_mask;
6533 b_nvram |= lec;
6534 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6535 dbg_printk(TPACPI_DBG_MIXER,
6536 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6537 (unsigned int) lec, (unsigned int) b_nvram);
6538 } else {
6539 vdbg_printk(TPACPI_DBG_MIXER,
6540 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6541 (unsigned int) lec, (unsigned int) b_nvram);
6544 unlock:
6545 mutex_unlock(&volume_mutex);
6548 static int volume_get_status_ec(u8 *status)
6550 u8 s;
6552 if (!acpi_ec_read(TP_EC_AUDIO, &s))
6553 return -EIO;
6555 *status = s;
6557 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6559 return 0;
6562 static int volume_get_status(u8 *status)
6564 return volume_get_status_ec(status);
6567 static int volume_set_status_ec(const u8 status)
6569 if (!acpi_ec_write(TP_EC_AUDIO, status))
6570 return -EIO;
6572 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6574 return 0;
6577 static int volume_set_status(const u8 status)
6579 return volume_set_status_ec(status);
6582 /* returns < 0 on error, 0 on no change, 1 on change */
6583 static int __volume_set_mute_ec(const bool mute)
6585 int rc;
6586 u8 s, n;
6588 if (mutex_lock_killable(&volume_mutex) < 0)
6589 return -EINTR;
6591 rc = volume_get_status_ec(&s);
6592 if (rc)
6593 goto unlock;
6595 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6596 s & ~TP_EC_AUDIO_MUTESW_MSK;
6598 if (n != s) {
6599 rc = volume_set_status_ec(n);
6600 if (!rc)
6601 rc = 1;
6604 unlock:
6605 mutex_unlock(&volume_mutex);
6606 return rc;
6609 static int volume_alsa_set_mute(const bool mute)
6611 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6612 (mute) ? "" : "un");
6613 return __volume_set_mute_ec(mute);
6616 static int volume_set_mute(const bool mute)
6618 int rc;
6620 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6621 (mute) ? "" : "un");
6623 rc = __volume_set_mute_ec(mute);
6624 return (rc < 0) ? rc : 0;
6627 /* returns < 0 on error, 0 on no change, 1 on change */
6628 static int __volume_set_volume_ec(const u8 vol)
6630 int rc;
6631 u8 s, n;
6633 if (vol > TP_EC_VOLUME_MAX)
6634 return -EINVAL;
6636 if (mutex_lock_killable(&volume_mutex) < 0)
6637 return -EINTR;
6639 rc = volume_get_status_ec(&s);
6640 if (rc)
6641 goto unlock;
6643 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6645 if (n != s) {
6646 rc = volume_set_status_ec(n);
6647 if (!rc)
6648 rc = 1;
6651 unlock:
6652 mutex_unlock(&volume_mutex);
6653 return rc;
6656 static int volume_alsa_set_volume(const u8 vol)
6658 dbg_printk(TPACPI_DBG_MIXER,
6659 "ALSA: trying to set volume level to %hu\n", vol);
6660 return __volume_set_volume_ec(vol);
6663 static void volume_alsa_notify_change(void)
6665 struct tpacpi_alsa_data *d;
6667 if (alsa_card && alsa_card->private_data) {
6668 d = alsa_card->private_data;
6669 if (d->ctl_mute_id)
6670 snd_ctl_notify(alsa_card,
6671 SNDRV_CTL_EVENT_MASK_VALUE,
6672 d->ctl_mute_id);
6673 if (d->ctl_vol_id)
6674 snd_ctl_notify(alsa_card,
6675 SNDRV_CTL_EVENT_MASK_VALUE,
6676 d->ctl_vol_id);
6680 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6681 struct snd_ctl_elem_info *uinfo)
6683 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6684 uinfo->count = 1;
6685 uinfo->value.integer.min = 0;
6686 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6687 return 0;
6690 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6691 struct snd_ctl_elem_value *ucontrol)
6693 u8 s;
6694 int rc;
6696 rc = volume_get_status(&s);
6697 if (rc < 0)
6698 return rc;
6700 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6701 return 0;
6704 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6705 struct snd_ctl_elem_value *ucontrol)
6707 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6710 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
6712 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6713 struct snd_ctl_elem_value *ucontrol)
6715 u8 s;
6716 int rc;
6718 rc = volume_get_status(&s);
6719 if (rc < 0)
6720 return rc;
6722 ucontrol->value.integer.value[0] =
6723 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6724 return 0;
6727 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6728 struct snd_ctl_elem_value *ucontrol)
6730 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6733 static struct snd_kcontrol_new volume_alsa_control_vol __devinitdata = {
6734 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6735 .name = "Console Playback Volume",
6736 .index = 0,
6737 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6738 .info = volume_alsa_vol_info,
6739 .get = volume_alsa_vol_get,
6742 static struct snd_kcontrol_new volume_alsa_control_mute __devinitdata = {
6743 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6744 .name = "Console Playback Switch",
6745 .index = 0,
6746 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6747 .info = volume_alsa_mute_info,
6748 .get = volume_alsa_mute_get,
6751 static void volume_suspend(pm_message_t state)
6753 tpacpi_volume_checkpoint_nvram();
6756 static void volume_resume(void)
6758 volume_alsa_notify_change();
6761 static void volume_shutdown(void)
6763 tpacpi_volume_checkpoint_nvram();
6766 static void volume_exit(void)
6768 if (alsa_card) {
6769 snd_card_free(alsa_card);
6770 alsa_card = NULL;
6773 tpacpi_volume_checkpoint_nvram();
6776 static int __init volume_create_alsa_mixer(void)
6778 struct snd_card *card;
6779 struct tpacpi_alsa_data *data;
6780 struct snd_kcontrol *ctl_vol;
6781 struct snd_kcontrol *ctl_mute;
6782 int rc;
6784 rc = snd_card_create(alsa_index, alsa_id, THIS_MODULE,
6785 sizeof(struct tpacpi_alsa_data), &card);
6786 if (rc < 0 || !card) {
6787 printk(TPACPI_ERR
6788 "Failed to create ALSA card structures: %d\n", rc);
6789 return 1;
6792 BUG_ON(!card->private_data);
6793 data = card->private_data;
6794 data->card = card;
6796 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6797 sizeof(card->driver));
6798 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6799 sizeof(card->shortname));
6800 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6801 (thinkpad_id.ec_version_str) ?
6802 thinkpad_id.ec_version_str : "(unknown)");
6803 snprintf(card->longname, sizeof(card->longname),
6804 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6805 (thinkpad_id.ec_version_str) ?
6806 thinkpad_id.ec_version_str : "unknown");
6808 if (volume_control_allowed) {
6809 volume_alsa_control_vol.put = volume_alsa_vol_put;
6810 volume_alsa_control_vol.access =
6811 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6813 volume_alsa_control_mute.put = volume_alsa_mute_put;
6814 volume_alsa_control_mute.access =
6815 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6818 if (!tp_features.mixer_no_level_control) {
6819 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6820 rc = snd_ctl_add(card, ctl_vol);
6821 if (rc < 0) {
6822 printk(TPACPI_ERR
6823 "Failed to create ALSA volume control: %d\n",
6824 rc);
6825 goto err_exit;
6827 data->ctl_vol_id = &ctl_vol->id;
6830 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6831 rc = snd_ctl_add(card, ctl_mute);
6832 if (rc < 0) {
6833 printk(TPACPI_ERR "Failed to create ALSA mute control: %d\n",
6834 rc);
6835 goto err_exit;
6837 data->ctl_mute_id = &ctl_mute->id;
6839 snd_card_set_dev(card, &tpacpi_pdev->dev);
6840 rc = snd_card_register(card);
6841 if (rc < 0) {
6842 printk(TPACPI_ERR "Failed to register ALSA card: %d\n", rc);
6843 goto err_exit;
6846 alsa_card = card;
6847 return 0;
6849 err_exit:
6850 snd_card_free(card);
6851 return 1;
6854 #define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
6855 #define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
6857 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6858 /* Whitelist volume level on all IBM by default */
6859 { .vendor = PCI_VENDOR_ID_IBM,
6860 .bios = TPACPI_MATCH_ANY,
6861 .ec = TPACPI_MATCH_ANY,
6862 .quirks = TPACPI_VOL_Q_LEVEL },
6864 /* Lenovo models with volume control (needs confirmation) */
6865 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6866 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6867 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6868 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6869 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6870 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6871 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6873 /* Whitelist mute-only on all Lenovo by default */
6874 { .vendor = PCI_VENDOR_ID_LENOVO,
6875 .bios = TPACPI_MATCH_ANY,
6876 .ec = TPACPI_MATCH_ANY,
6877 .quirks = TPACPI_VOL_Q_MUTEONLY }
6880 static int __init volume_init(struct ibm_init_struct *iibm)
6882 unsigned long quirks;
6883 int rc;
6885 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
6887 mutex_init(&volume_mutex);
6890 * Check for module parameter bogosity, note that we
6891 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
6892 * able to detect "unspecified"
6894 if (volume_mode > TPACPI_VOL_MODE_MAX)
6895 return -EINVAL;
6897 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
6898 printk(TPACPI_ERR
6899 "UCMS step volume mode not implemented, "
6900 "please contact %s\n", TPACPI_MAIL);
6901 return 1;
6904 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
6905 return -EINVAL;
6908 * The ALSA mixer is our primary interface.
6909 * When disabled, don't install the subdriver at all
6911 if (!alsa_enable) {
6912 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6913 "ALSA mixer disabled by parameter, "
6914 "not loading volume subdriver...\n");
6915 return 1;
6918 quirks = tpacpi_check_quirks(volume_quirk_table,
6919 ARRAY_SIZE(volume_quirk_table));
6921 switch (volume_capabilities) {
6922 case TPACPI_VOL_CAP_AUTO:
6923 if (quirks & TPACPI_VOL_Q_MUTEONLY)
6924 tp_features.mixer_no_level_control = 1;
6925 else if (quirks & TPACPI_VOL_Q_LEVEL)
6926 tp_features.mixer_no_level_control = 0;
6927 else
6928 return 1; /* no mixer */
6929 break;
6930 case TPACPI_VOL_CAP_VOLMUTE:
6931 tp_features.mixer_no_level_control = 0;
6932 break;
6933 case TPACPI_VOL_CAP_MUTEONLY:
6934 tp_features.mixer_no_level_control = 1;
6935 break;
6936 default:
6937 return 1;
6940 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
6941 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6942 "using user-supplied volume_capabilities=%d\n",
6943 volume_capabilities);
6945 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
6946 volume_mode == TPACPI_VOL_MODE_MAX) {
6947 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
6949 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6950 "driver auto-selected volume_mode=%d\n",
6951 volume_mode);
6952 } else {
6953 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6954 "using user-supplied volume_mode=%d\n",
6955 volume_mode);
6958 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6959 "mute is supported, volume control is %s\n",
6960 str_supported(!tp_features.mixer_no_level_control));
6962 rc = volume_create_alsa_mixer();
6963 if (rc) {
6964 printk(TPACPI_ERR
6965 "Could not create the ALSA mixer interface\n");
6966 return rc;
6969 printk(TPACPI_INFO
6970 "Console audio control enabled, mode: %s\n",
6971 (volume_control_allowed) ?
6972 "override (read/write)" :
6973 "monitor (read only)");
6975 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6976 "registering volume hotkeys as change notification\n");
6977 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6978 | TP_ACPI_HKEY_VOLUP_MASK
6979 | TP_ACPI_HKEY_VOLDWN_MASK
6980 | TP_ACPI_HKEY_MUTE_MASK);
6982 return 0;
6985 static int volume_read(struct seq_file *m)
6987 u8 status;
6989 if (volume_get_status(&status) < 0) {
6990 seq_printf(m, "level:\t\tunreadable\n");
6991 } else {
6992 if (tp_features.mixer_no_level_control)
6993 seq_printf(m, "level:\t\tunsupported\n");
6994 else
6995 seq_printf(m, "level:\t\t%d\n",
6996 status & TP_EC_AUDIO_LVL_MSK);
6998 seq_printf(m, "mute:\t\t%s\n",
6999 onoff(status, TP_EC_AUDIO_MUTESW));
7001 if (volume_control_allowed) {
7002 seq_printf(m, "commands:\tunmute, mute\n");
7003 if (!tp_features.mixer_no_level_control) {
7004 seq_printf(m,
7005 "commands:\tup, down\n");
7006 seq_printf(m,
7007 "commands:\tlevel <level>"
7008 " (<level> is 0-%d)\n",
7009 TP_EC_VOLUME_MAX);
7014 return 0;
7017 static int volume_write(char *buf)
7019 u8 s;
7020 u8 new_level, new_mute;
7021 int l;
7022 char *cmd;
7023 int rc;
7026 * We do allow volume control at driver startup, so that the
7027 * user can set initial state through the volume=... parameter hack.
7029 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7030 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7031 tp_warned.volume_ctrl_forbidden = 1;
7032 printk(TPACPI_NOTICE
7033 "Console audio control in monitor mode, "
7034 "changes are not allowed.\n");
7035 printk(TPACPI_NOTICE
7036 "Use the volume_control=1 module parameter "
7037 "to enable volume control\n");
7039 return -EPERM;
7042 rc = volume_get_status(&s);
7043 if (rc < 0)
7044 return rc;
7046 new_level = s & TP_EC_AUDIO_LVL_MSK;
7047 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7049 while ((cmd = next_cmd(&buf))) {
7050 if (!tp_features.mixer_no_level_control) {
7051 if (strlencmp(cmd, "up") == 0) {
7052 if (new_mute)
7053 new_mute = 0;
7054 else if (new_level < TP_EC_VOLUME_MAX)
7055 new_level++;
7056 continue;
7057 } else if (strlencmp(cmd, "down") == 0) {
7058 if (new_mute)
7059 new_mute = 0;
7060 else if (new_level > 0)
7061 new_level--;
7062 continue;
7063 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7064 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7065 new_level = l;
7066 continue;
7069 if (strlencmp(cmd, "mute") == 0)
7070 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7071 else if (strlencmp(cmd, "unmute") == 0)
7072 new_mute = 0;
7073 else
7074 return -EINVAL;
7077 if (tp_features.mixer_no_level_control) {
7078 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7079 new_mute ? "" : "un");
7080 rc = volume_set_mute(!!new_mute);
7081 } else {
7082 tpacpi_disclose_usertask("procfs volume",
7083 "%smute and set level to %d\n",
7084 new_mute ? "" : "un", new_level);
7085 rc = volume_set_status(new_mute | new_level);
7087 volume_alsa_notify_change();
7089 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7092 static struct ibm_struct volume_driver_data = {
7093 .name = "volume",
7094 .read = volume_read,
7095 .write = volume_write,
7096 .exit = volume_exit,
7097 .suspend = volume_suspend,
7098 .resume = volume_resume,
7099 .shutdown = volume_shutdown,
7102 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7104 #define alsa_card NULL
7106 static void inline volume_alsa_notify_change(void)
7110 static int __init volume_init(struct ibm_init_struct *iibm)
7112 printk(TPACPI_INFO
7113 "volume: disabled as there is no ALSA support in this kernel\n");
7115 return 1;
7118 static struct ibm_struct volume_driver_data = {
7119 .name = "volume",
7122 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7124 /*************************************************************************
7125 * Fan subdriver
7129 * FAN ACCESS MODES
7131 * TPACPI_FAN_RD_ACPI_GFAN:
7132 * ACPI GFAN method: returns fan level
7134 * see TPACPI_FAN_WR_ACPI_SFAN
7135 * EC 0x2f (HFSP) not available if GFAN exists
7137 * TPACPI_FAN_WR_ACPI_SFAN:
7138 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7140 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7141 * it for writing.
7143 * TPACPI_FAN_WR_TPEC:
7144 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7145 * Supported on almost all ThinkPads
7147 * Fan speed changes of any sort (including those caused by the
7148 * disengaged mode) are usually done slowly by the firmware as the
7149 * maximum amount of fan duty cycle change per second seems to be
7150 * limited.
7152 * Reading is not available if GFAN exists.
7153 * Writing is not available if SFAN exists.
7155 * Bits
7156 * 7 automatic mode engaged;
7157 * (default operation mode of the ThinkPad)
7158 * fan level is ignored in this mode.
7159 * 6 full speed mode (takes precedence over bit 7);
7160 * not available on all thinkpads. May disable
7161 * the tachometer while the fan controller ramps up
7162 * the speed (which can take up to a few *minutes*).
7163 * Speeds up fan to 100% duty-cycle, which is far above
7164 * the standard RPM levels. It is not impossible that
7165 * it could cause hardware damage.
7166 * 5-3 unused in some models. Extra bits for fan level
7167 * in others, but still useless as all values above
7168 * 7 map to the same speed as level 7 in these models.
7169 * 2-0 fan level (0..7 usually)
7170 * 0x00 = stop
7171 * 0x07 = max (set when temperatures critical)
7172 * Some ThinkPads may have other levels, see
7173 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7175 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7176 * boot. Apparently the EC does not intialize it, so unless ACPI DSDT
7177 * does so, its initial value is meaningless (0x07).
7179 * For firmware bugs, refer to:
7180 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7182 * ----
7184 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7185 * Main fan tachometer reading (in RPM)
7187 * This register is present on all ThinkPads with a new-style EC, and
7188 * it is known not to be present on the A21m/e, and T22, as there is
7189 * something else in offset 0x84 according to the ACPI DSDT. Other
7190 * ThinkPads from this same time period (and earlier) probably lack the
7191 * tachometer as well.
7193 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7194 * was never fixed by IBM to report the EC firmware version string
7195 * probably support the tachometer (like the early X models), so
7196 * detecting it is quite hard. We need more data to know for sure.
7198 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7199 * might result.
7201 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7202 * mode.
7204 * For firmware bugs, refer to:
7205 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7207 * ----
7209 * ThinkPad EC register 0x31 bit 0 (only on select models)
7211 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7212 * show the speed of the main fan. When bit 0 of EC register 0x31
7213 * is one, the tachometer registers show the speed of the auxiliary
7214 * fan.
7216 * Fan control seems to affect both fans, regardless of the state
7217 * of this bit.
7219 * So far, only the firmware for the X60/X61 non-tablet versions
7220 * seem to support this (firmware TP-7M).
7222 * TPACPI_FAN_WR_ACPI_FANS:
7223 * ThinkPad X31, X40, X41. Not available in the X60.
7225 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7226 * high speed. ACPI DSDT seems to map these three speeds to levels
7227 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7228 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7230 * The speeds are stored on handles
7231 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7233 * There are three default speed sets, accessible as handles:
7234 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7236 * ACPI DSDT switches which set is in use depending on various
7237 * factors.
7239 * TPACPI_FAN_WR_TPEC is also available and should be used to
7240 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7241 * but the ACPI tables just mention level 7.
7244 enum { /* Fan control constants */
7245 fan_status_offset = 0x2f, /* EC register 0x2f */
7246 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7247 * 0x84 must be read before 0x85 */
7248 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7249 bit 0 selects which fan is active */
7251 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
7252 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
7254 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
7257 enum fan_status_access_mode {
7258 TPACPI_FAN_NONE = 0, /* No fan status or control */
7259 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
7260 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7263 enum fan_control_access_mode {
7264 TPACPI_FAN_WR_NONE = 0, /* No fan control */
7265 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
7266 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
7267 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
7270 enum fan_control_commands {
7271 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
7272 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
7273 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
7274 * and also watchdog cmd */
7277 static int fan_control_allowed;
7279 static enum fan_status_access_mode fan_status_access_mode;
7280 static enum fan_control_access_mode fan_control_access_mode;
7281 static enum fan_control_commands fan_control_commands;
7283 static u8 fan_control_initial_status;
7284 static u8 fan_control_desired_level;
7285 static u8 fan_control_resume_level;
7286 static int fan_watchdog_maxinterval;
7288 static struct mutex fan_mutex;
7290 static void fan_watchdog_fire(struct work_struct *ignored);
7291 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7293 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
7294 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7295 "\\FSPD", /* 600e/x, 770e, 770x */
7296 ); /* all others */
7297 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7298 "JFNS", /* 770x-JL */
7299 ); /* all others */
7302 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7303 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7304 * be in auto mode (0x80).
7306 * This is corrected by any write to HFSP either by the driver, or
7307 * by the firmware.
7309 * We assume 0x07 really means auto mode while this quirk is active,
7310 * as this is far more likely than the ThinkPad being in level 7,
7311 * which is only used by the firmware during thermal emergencies.
7313 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7314 * TP-70 (T43, R52), which are known to be buggy.
7317 static void fan_quirk1_setup(void)
7319 if (fan_control_initial_status == 0x07) {
7320 printk(TPACPI_NOTICE
7321 "fan_init: initial fan status is unknown, "
7322 "assuming it is in auto mode\n");
7323 tp_features.fan_ctrl_status_undef = 1;
7327 static void fan_quirk1_handle(u8 *fan_status)
7329 if (unlikely(tp_features.fan_ctrl_status_undef)) {
7330 if (*fan_status != fan_control_initial_status) {
7331 /* something changed the HFSP regisnter since
7332 * driver init time, so it is not undefined
7333 * anymore */
7334 tp_features.fan_ctrl_status_undef = 0;
7335 } else {
7336 /* Return most likely status. In fact, it
7337 * might be the only possible status */
7338 *fan_status = TP_EC_FAN_AUTO;
7343 /* Select main fan on X60/X61, NOOP on others */
7344 static bool fan_select_fan1(void)
7346 if (tp_features.second_fan) {
7347 u8 val;
7349 if (ec_read(fan_select_offset, &val) < 0)
7350 return false;
7351 val &= 0xFEU;
7352 if (ec_write(fan_select_offset, val) < 0)
7353 return false;
7355 return true;
7358 /* Select secondary fan on X60/X61 */
7359 static bool fan_select_fan2(void)
7361 u8 val;
7363 if (!tp_features.second_fan)
7364 return false;
7366 if (ec_read(fan_select_offset, &val) < 0)
7367 return false;
7368 val |= 0x01U;
7369 if (ec_write(fan_select_offset, val) < 0)
7370 return false;
7372 return true;
7376 * Call with fan_mutex held
7378 static void fan_update_desired_level(u8 status)
7380 if ((status &
7381 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7382 if (status > 7)
7383 fan_control_desired_level = 7;
7384 else
7385 fan_control_desired_level = status;
7389 static int fan_get_status(u8 *status)
7391 u8 s;
7393 /* TODO:
7394 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7396 switch (fan_status_access_mode) {
7397 case TPACPI_FAN_RD_ACPI_GFAN:
7398 /* 570, 600e/x, 770e, 770x */
7400 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
7401 return -EIO;
7403 if (likely(status))
7404 *status = s & 0x07;
7406 break;
7408 case TPACPI_FAN_RD_TPEC:
7409 /* all except 570, 600e/x, 770e, 770x */
7410 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7411 return -EIO;
7413 if (likely(status)) {
7414 *status = s;
7415 fan_quirk1_handle(status);
7418 break;
7420 default:
7421 return -ENXIO;
7424 return 0;
7427 static int fan_get_status_safe(u8 *status)
7429 int rc;
7430 u8 s;
7432 if (mutex_lock_killable(&fan_mutex))
7433 return -ERESTARTSYS;
7434 rc = fan_get_status(&s);
7435 if (!rc)
7436 fan_update_desired_level(s);
7437 mutex_unlock(&fan_mutex);
7439 if (status)
7440 *status = s;
7442 return rc;
7445 static int fan_get_speed(unsigned int *speed)
7447 u8 hi, lo;
7449 switch (fan_status_access_mode) {
7450 case TPACPI_FAN_RD_TPEC:
7451 /* all except 570, 600e/x, 770e, 770x */
7452 if (unlikely(!fan_select_fan1()))
7453 return -EIO;
7454 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7455 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7456 return -EIO;
7458 if (likely(speed))
7459 *speed = (hi << 8) | lo;
7461 break;
7463 default:
7464 return -ENXIO;
7467 return 0;
7470 static int fan2_get_speed(unsigned int *speed)
7472 u8 hi, lo;
7473 bool rc;
7475 switch (fan_status_access_mode) {
7476 case TPACPI_FAN_RD_TPEC:
7477 /* all except 570, 600e/x, 770e, 770x */
7478 if (unlikely(!fan_select_fan2()))
7479 return -EIO;
7480 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7481 !acpi_ec_read(fan_rpm_offset + 1, &hi);
7482 fan_select_fan1(); /* play it safe */
7483 if (rc)
7484 return -EIO;
7486 if (likely(speed))
7487 *speed = (hi << 8) | lo;
7489 break;
7491 default:
7492 return -ENXIO;
7495 return 0;
7498 static int fan_set_level(int level)
7500 if (!fan_control_allowed)
7501 return -EPERM;
7503 switch (fan_control_access_mode) {
7504 case TPACPI_FAN_WR_ACPI_SFAN:
7505 if (level >= 0 && level <= 7) {
7506 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7507 return -EIO;
7508 } else
7509 return -EINVAL;
7510 break;
7512 case TPACPI_FAN_WR_ACPI_FANS:
7513 case TPACPI_FAN_WR_TPEC:
7514 if (!(level & TP_EC_FAN_AUTO) &&
7515 !(level & TP_EC_FAN_FULLSPEED) &&
7516 ((level < 0) || (level > 7)))
7517 return -EINVAL;
7519 /* safety net should the EC not support AUTO
7520 * or FULLSPEED mode bits and just ignore them */
7521 if (level & TP_EC_FAN_FULLSPEED)
7522 level |= 7; /* safety min speed 7 */
7523 else if (level & TP_EC_FAN_AUTO)
7524 level |= 4; /* safety min speed 4 */
7526 if (!acpi_ec_write(fan_status_offset, level))
7527 return -EIO;
7528 else
7529 tp_features.fan_ctrl_status_undef = 0;
7530 break;
7532 default:
7533 return -ENXIO;
7536 vdbg_printk(TPACPI_DBG_FAN,
7537 "fan control: set fan control register to 0x%02x\n", level);
7538 return 0;
7541 static int fan_set_level_safe(int level)
7543 int rc;
7545 if (!fan_control_allowed)
7546 return -EPERM;
7548 if (mutex_lock_killable(&fan_mutex))
7549 return -ERESTARTSYS;
7551 if (level == TPACPI_FAN_LAST_LEVEL)
7552 level = fan_control_desired_level;
7554 rc = fan_set_level(level);
7555 if (!rc)
7556 fan_update_desired_level(level);
7558 mutex_unlock(&fan_mutex);
7559 return rc;
7562 static int fan_set_enable(void)
7564 u8 s;
7565 int rc;
7567 if (!fan_control_allowed)
7568 return -EPERM;
7570 if (mutex_lock_killable(&fan_mutex))
7571 return -ERESTARTSYS;
7573 switch (fan_control_access_mode) {
7574 case TPACPI_FAN_WR_ACPI_FANS:
7575 case TPACPI_FAN_WR_TPEC:
7576 rc = fan_get_status(&s);
7577 if (rc < 0)
7578 break;
7580 /* Don't go out of emergency fan mode */
7581 if (s != 7) {
7582 s &= 0x07;
7583 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7586 if (!acpi_ec_write(fan_status_offset, s))
7587 rc = -EIO;
7588 else {
7589 tp_features.fan_ctrl_status_undef = 0;
7590 rc = 0;
7592 break;
7594 case TPACPI_FAN_WR_ACPI_SFAN:
7595 rc = fan_get_status(&s);
7596 if (rc < 0)
7597 break;
7599 s &= 0x07;
7601 /* Set fan to at least level 4 */
7602 s |= 4;
7604 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7605 rc = -EIO;
7606 else
7607 rc = 0;
7608 break;
7610 default:
7611 rc = -ENXIO;
7614 mutex_unlock(&fan_mutex);
7616 if (!rc)
7617 vdbg_printk(TPACPI_DBG_FAN,
7618 "fan control: set fan control register to 0x%02x\n",
7620 return rc;
7623 static int fan_set_disable(void)
7625 int rc;
7627 if (!fan_control_allowed)
7628 return -EPERM;
7630 if (mutex_lock_killable(&fan_mutex))
7631 return -ERESTARTSYS;
7633 rc = 0;
7634 switch (fan_control_access_mode) {
7635 case TPACPI_FAN_WR_ACPI_FANS:
7636 case TPACPI_FAN_WR_TPEC:
7637 if (!acpi_ec_write(fan_status_offset, 0x00))
7638 rc = -EIO;
7639 else {
7640 fan_control_desired_level = 0;
7641 tp_features.fan_ctrl_status_undef = 0;
7643 break;
7645 case TPACPI_FAN_WR_ACPI_SFAN:
7646 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7647 rc = -EIO;
7648 else
7649 fan_control_desired_level = 0;
7650 break;
7652 default:
7653 rc = -ENXIO;
7656 if (!rc)
7657 vdbg_printk(TPACPI_DBG_FAN,
7658 "fan control: set fan control register to 0\n");
7660 mutex_unlock(&fan_mutex);
7661 return rc;
7664 static int fan_set_speed(int speed)
7666 int rc;
7668 if (!fan_control_allowed)
7669 return -EPERM;
7671 if (mutex_lock_killable(&fan_mutex))
7672 return -ERESTARTSYS;
7674 rc = 0;
7675 switch (fan_control_access_mode) {
7676 case TPACPI_FAN_WR_ACPI_FANS:
7677 if (speed >= 0 && speed <= 65535) {
7678 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7679 speed, speed, speed))
7680 rc = -EIO;
7681 } else
7682 rc = -EINVAL;
7683 break;
7685 default:
7686 rc = -ENXIO;
7689 mutex_unlock(&fan_mutex);
7690 return rc;
7693 static void fan_watchdog_reset(void)
7695 static int fan_watchdog_active;
7697 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7698 return;
7700 if (fan_watchdog_active)
7701 cancel_delayed_work(&fan_watchdog_task);
7703 if (fan_watchdog_maxinterval > 0 &&
7704 tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7705 fan_watchdog_active = 1;
7706 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7707 msecs_to_jiffies(fan_watchdog_maxinterval
7708 * 1000))) {
7709 printk(TPACPI_ERR
7710 "failed to queue the fan watchdog, "
7711 "watchdog will not trigger\n");
7713 } else
7714 fan_watchdog_active = 0;
7717 static void fan_watchdog_fire(struct work_struct *ignored)
7719 int rc;
7721 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7722 return;
7724 printk(TPACPI_NOTICE "fan watchdog: enabling fan\n");
7725 rc = fan_set_enable();
7726 if (rc < 0) {
7727 printk(TPACPI_ERR "fan watchdog: error %d while enabling fan, "
7728 "will try again later...\n", -rc);
7729 /* reschedule for later */
7730 fan_watchdog_reset();
7735 * SYSFS fan layout: hwmon compatible (device)
7737 * pwm*_enable:
7738 * 0: "disengaged" mode
7739 * 1: manual mode
7740 * 2: native EC "auto" mode (recommended, hardware default)
7742 * pwm*: set speed in manual mode, ignored otherwise.
7743 * 0 is level 0; 255 is level 7. Intermediate points done with linear
7744 * interpolation.
7746 * fan*_input: tachometer reading, RPM
7749 * SYSFS fan layout: extensions
7751 * fan_watchdog (driver):
7752 * fan watchdog interval in seconds, 0 disables (default), max 120
7755 /* sysfs fan pwm1_enable ----------------------------------------------- */
7756 static ssize_t fan_pwm1_enable_show(struct device *dev,
7757 struct device_attribute *attr,
7758 char *buf)
7760 int res, mode;
7761 u8 status;
7763 res = fan_get_status_safe(&status);
7764 if (res)
7765 return res;
7767 if (status & TP_EC_FAN_FULLSPEED) {
7768 mode = 0;
7769 } else if (status & TP_EC_FAN_AUTO) {
7770 mode = 2;
7771 } else
7772 mode = 1;
7774 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7777 static ssize_t fan_pwm1_enable_store(struct device *dev,
7778 struct device_attribute *attr,
7779 const char *buf, size_t count)
7781 unsigned long t;
7782 int res, level;
7784 if (parse_strtoul(buf, 2, &t))
7785 return -EINVAL;
7787 tpacpi_disclose_usertask("hwmon pwm1_enable",
7788 "set fan mode to %lu\n", t);
7790 switch (t) {
7791 case 0:
7792 level = TP_EC_FAN_FULLSPEED;
7793 break;
7794 case 1:
7795 level = TPACPI_FAN_LAST_LEVEL;
7796 break;
7797 case 2:
7798 level = TP_EC_FAN_AUTO;
7799 break;
7800 case 3:
7801 /* reserved for software-controlled auto mode */
7802 return -ENOSYS;
7803 default:
7804 return -EINVAL;
7807 res = fan_set_level_safe(level);
7808 if (res == -ENXIO)
7809 return -EINVAL;
7810 else if (res < 0)
7811 return res;
7813 fan_watchdog_reset();
7815 return count;
7818 static struct device_attribute dev_attr_fan_pwm1_enable =
7819 __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7820 fan_pwm1_enable_show, fan_pwm1_enable_store);
7822 /* sysfs fan pwm1 ------------------------------------------------------ */
7823 static ssize_t fan_pwm1_show(struct device *dev,
7824 struct device_attribute *attr,
7825 char *buf)
7827 int res;
7828 u8 status;
7830 res = fan_get_status_safe(&status);
7831 if (res)
7832 return res;
7834 if ((status &
7835 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7836 status = fan_control_desired_level;
7838 if (status > 7)
7839 status = 7;
7841 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7844 static ssize_t fan_pwm1_store(struct device *dev,
7845 struct device_attribute *attr,
7846 const char *buf, size_t count)
7848 unsigned long s;
7849 int rc;
7850 u8 status, newlevel;
7852 if (parse_strtoul(buf, 255, &s))
7853 return -EINVAL;
7855 tpacpi_disclose_usertask("hwmon pwm1",
7856 "set fan speed to %lu\n", s);
7858 /* scale down from 0-255 to 0-7 */
7859 newlevel = (s >> 5) & 0x07;
7861 if (mutex_lock_killable(&fan_mutex))
7862 return -ERESTARTSYS;
7864 rc = fan_get_status(&status);
7865 if (!rc && (status &
7866 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7867 rc = fan_set_level(newlevel);
7868 if (rc == -ENXIO)
7869 rc = -EINVAL;
7870 else if (!rc) {
7871 fan_update_desired_level(newlevel);
7872 fan_watchdog_reset();
7876 mutex_unlock(&fan_mutex);
7877 return (rc)? rc : count;
7880 static struct device_attribute dev_attr_fan_pwm1 =
7881 __ATTR(pwm1, S_IWUSR | S_IRUGO,
7882 fan_pwm1_show, fan_pwm1_store);
7884 /* sysfs fan fan1_input ------------------------------------------------ */
7885 static ssize_t fan_fan1_input_show(struct device *dev,
7886 struct device_attribute *attr,
7887 char *buf)
7889 int res;
7890 unsigned int speed;
7892 res = fan_get_speed(&speed);
7893 if (res < 0)
7894 return res;
7896 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7899 static struct device_attribute dev_attr_fan_fan1_input =
7900 __ATTR(fan1_input, S_IRUGO,
7901 fan_fan1_input_show, NULL);
7903 /* sysfs fan fan2_input ------------------------------------------------ */
7904 static ssize_t fan_fan2_input_show(struct device *dev,
7905 struct device_attribute *attr,
7906 char *buf)
7908 int res;
7909 unsigned int speed;
7911 res = fan2_get_speed(&speed);
7912 if (res < 0)
7913 return res;
7915 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7918 static struct device_attribute dev_attr_fan_fan2_input =
7919 __ATTR(fan2_input, S_IRUGO,
7920 fan_fan2_input_show, NULL);
7922 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7923 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7924 char *buf)
7926 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7929 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7930 const char *buf, size_t count)
7932 unsigned long t;
7934 if (parse_strtoul(buf, 120, &t))
7935 return -EINVAL;
7937 if (!fan_control_allowed)
7938 return -EPERM;
7940 fan_watchdog_maxinterval = t;
7941 fan_watchdog_reset();
7943 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7945 return count;
7948 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7949 fan_fan_watchdog_show, fan_fan_watchdog_store);
7951 /* --------------------------------------------------------------------- */
7952 static struct attribute *fan_attributes[] = {
7953 &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7954 &dev_attr_fan_fan1_input.attr,
7955 NULL, /* for fan2_input */
7956 NULL
7959 static const struct attribute_group fan_attr_group = {
7960 .attrs = fan_attributes,
7963 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
7964 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
7966 #define TPACPI_FAN_QI(__id1, __id2, __quirks) \
7967 { .vendor = PCI_VENDOR_ID_IBM, \
7968 .bios = TPACPI_MATCH_ANY, \
7969 .ec = TPID(__id1, __id2), \
7970 .quirks = __quirks }
7972 #define TPACPI_FAN_QL(__id1, __id2, __quirks) \
7973 { .vendor = PCI_VENDOR_ID_LENOVO, \
7974 .bios = TPACPI_MATCH_ANY, \
7975 .ec = TPID(__id1, __id2), \
7976 .quirks = __quirks }
7978 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
7979 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
7980 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
7981 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
7982 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
7983 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
7986 #undef TPACPI_FAN_QL
7987 #undef TPACPI_FAN_QI
7989 static int __init fan_init(struct ibm_init_struct *iibm)
7991 int rc;
7992 unsigned long quirks;
7994 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7995 "initializing fan subdriver\n");
7997 mutex_init(&fan_mutex);
7998 fan_status_access_mode = TPACPI_FAN_NONE;
7999 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8000 fan_control_commands = 0;
8001 fan_watchdog_maxinterval = 0;
8002 tp_features.fan_ctrl_status_undef = 0;
8003 tp_features.second_fan = 0;
8004 fan_control_desired_level = 7;
8006 if (tpacpi_is_ibm()) {
8007 TPACPI_ACPIHANDLE_INIT(fans);
8008 TPACPI_ACPIHANDLE_INIT(gfan);
8009 TPACPI_ACPIHANDLE_INIT(sfan);
8012 quirks = tpacpi_check_quirks(fan_quirk_table,
8013 ARRAY_SIZE(fan_quirk_table));
8015 if (gfan_handle) {
8016 /* 570, 600e/x, 770e, 770x */
8017 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8018 } else {
8019 /* all other ThinkPads: note that even old-style
8020 * ThinkPad ECs supports the fan control register */
8021 if (likely(acpi_ec_read(fan_status_offset,
8022 &fan_control_initial_status))) {
8023 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8024 if (quirks & TPACPI_FAN_Q1)
8025 fan_quirk1_setup();
8026 if (quirks & TPACPI_FAN_2FAN) {
8027 tp_features.second_fan = 1;
8028 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8029 "secondary fan support enabled\n");
8031 } else {
8032 printk(TPACPI_ERR
8033 "ThinkPad ACPI EC access misbehaving, "
8034 "fan status and control unavailable\n");
8035 return 1;
8039 if (sfan_handle) {
8040 /* 570, 770x-JL */
8041 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8042 fan_control_commands |=
8043 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8044 } else {
8045 if (!gfan_handle) {
8046 /* gfan without sfan means no fan control */
8047 /* all other models implement TP EC 0x2f control */
8049 if (fans_handle) {
8050 /* X31, X40, X41 */
8051 fan_control_access_mode =
8052 TPACPI_FAN_WR_ACPI_FANS;
8053 fan_control_commands |=
8054 TPACPI_FAN_CMD_SPEED |
8055 TPACPI_FAN_CMD_LEVEL |
8056 TPACPI_FAN_CMD_ENABLE;
8057 } else {
8058 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8059 fan_control_commands |=
8060 TPACPI_FAN_CMD_LEVEL |
8061 TPACPI_FAN_CMD_ENABLE;
8066 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8067 "fan is %s, modes %d, %d\n",
8068 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8069 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8070 fan_status_access_mode, fan_control_access_mode);
8072 /* fan control master switch */
8073 if (!fan_control_allowed) {
8074 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8075 fan_control_commands = 0;
8076 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8077 "fan control features disabled by parameter\n");
8080 /* update fan_control_desired_level */
8081 if (fan_status_access_mode != TPACPI_FAN_NONE)
8082 fan_get_status_safe(NULL);
8084 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8085 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8086 if (tp_features.second_fan) {
8087 /* attach second fan tachometer */
8088 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8089 &dev_attr_fan_fan2_input.attr;
8091 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8092 &fan_attr_group);
8093 if (rc < 0)
8094 return rc;
8096 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8097 &driver_attr_fan_watchdog);
8098 if (rc < 0) {
8099 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8100 &fan_attr_group);
8101 return rc;
8103 return 0;
8104 } else
8105 return 1;
8108 static void fan_exit(void)
8110 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8111 "cancelling any pending fan watchdog tasks\n");
8113 /* FIXME: can we really do this unconditionally? */
8114 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8115 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8116 &driver_attr_fan_watchdog);
8118 cancel_delayed_work(&fan_watchdog_task);
8119 flush_workqueue(tpacpi_wq);
8122 static void fan_suspend(pm_message_t state)
8124 int rc;
8126 if (!fan_control_allowed)
8127 return;
8129 /* Store fan status in cache */
8130 fan_control_resume_level = 0;
8131 rc = fan_get_status_safe(&fan_control_resume_level);
8132 if (rc < 0)
8133 printk(TPACPI_NOTICE
8134 "failed to read fan level for later "
8135 "restore during resume: %d\n", rc);
8137 /* if it is undefined, don't attempt to restore it.
8138 * KEEP THIS LAST */
8139 if (tp_features.fan_ctrl_status_undef)
8140 fan_control_resume_level = 0;
8143 static void fan_resume(void)
8145 u8 current_level = 7;
8146 bool do_set = false;
8147 int rc;
8149 /* DSDT *always* updates status on resume */
8150 tp_features.fan_ctrl_status_undef = 0;
8152 if (!fan_control_allowed ||
8153 !fan_control_resume_level ||
8154 (fan_get_status_safe(&current_level) < 0))
8155 return;
8157 switch (fan_control_access_mode) {
8158 case TPACPI_FAN_WR_ACPI_SFAN:
8159 /* never decrease fan level */
8160 do_set = (fan_control_resume_level > current_level);
8161 break;
8162 case TPACPI_FAN_WR_ACPI_FANS:
8163 case TPACPI_FAN_WR_TPEC:
8164 /* never decrease fan level, scale is:
8165 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8167 * We expect the firmware to set either 7 or AUTO, but we
8168 * handle FULLSPEED out of paranoia.
8170 * So, we can safely only restore FULLSPEED or 7, anything
8171 * else could slow the fan. Restoring AUTO is useless, at
8172 * best that's exactly what the DSDT already set (it is the
8173 * slower it uses).
8175 * Always keep in mind that the DSDT *will* have set the
8176 * fans to what the vendor supposes is the best level. We
8177 * muck with it only to speed the fan up.
8179 if (fan_control_resume_level != 7 &&
8180 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8181 return;
8182 else
8183 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8184 (current_level != fan_control_resume_level);
8185 break;
8186 default:
8187 return;
8189 if (do_set) {
8190 printk(TPACPI_NOTICE
8191 "restoring fan level to 0x%02x\n",
8192 fan_control_resume_level);
8193 rc = fan_set_level_safe(fan_control_resume_level);
8194 if (rc < 0)
8195 printk(TPACPI_NOTICE
8196 "failed to restore fan level: %d\n", rc);
8200 static int fan_read(struct seq_file *m)
8202 int rc;
8203 u8 status;
8204 unsigned int speed = 0;
8206 switch (fan_status_access_mode) {
8207 case TPACPI_FAN_RD_ACPI_GFAN:
8208 /* 570, 600e/x, 770e, 770x */
8209 rc = fan_get_status_safe(&status);
8210 if (rc < 0)
8211 return rc;
8213 seq_printf(m, "status:\t\t%s\n"
8214 "level:\t\t%d\n",
8215 (status != 0) ? "enabled" : "disabled", status);
8216 break;
8218 case TPACPI_FAN_RD_TPEC:
8219 /* all except 570, 600e/x, 770e, 770x */
8220 rc = fan_get_status_safe(&status);
8221 if (rc < 0)
8222 return rc;
8224 seq_printf(m, "status:\t\t%s\n",
8225 (status != 0) ? "enabled" : "disabled");
8227 rc = fan_get_speed(&speed);
8228 if (rc < 0)
8229 return rc;
8231 seq_printf(m, "speed:\t\t%d\n", speed);
8233 if (status & TP_EC_FAN_FULLSPEED)
8234 /* Disengaged mode takes precedence */
8235 seq_printf(m, "level:\t\tdisengaged\n");
8236 else if (status & TP_EC_FAN_AUTO)
8237 seq_printf(m, "level:\t\tauto\n");
8238 else
8239 seq_printf(m, "level:\t\t%d\n", status);
8240 break;
8242 case TPACPI_FAN_NONE:
8243 default:
8244 seq_printf(m, "status:\t\tnot supported\n");
8247 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8248 seq_printf(m, "commands:\tlevel <level>");
8250 switch (fan_control_access_mode) {
8251 case TPACPI_FAN_WR_ACPI_SFAN:
8252 seq_printf(m, " (<level> is 0-7)\n");
8253 break;
8255 default:
8256 seq_printf(m, " (<level> is 0-7, "
8257 "auto, disengaged, full-speed)\n");
8258 break;
8262 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8263 seq_printf(m, "commands:\tenable, disable\n"
8264 "commands:\twatchdog <timeout> (<timeout> "
8265 "is 0 (off), 1-120 (seconds))\n");
8267 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8268 seq_printf(m, "commands:\tspeed <speed>"
8269 " (<speed> is 0-65535)\n");
8271 return 0;
8274 static int fan_write_cmd_level(const char *cmd, int *rc)
8276 int level;
8278 if (strlencmp(cmd, "level auto") == 0)
8279 level = TP_EC_FAN_AUTO;
8280 else if ((strlencmp(cmd, "level disengaged") == 0) |
8281 (strlencmp(cmd, "level full-speed") == 0))
8282 level = TP_EC_FAN_FULLSPEED;
8283 else if (sscanf(cmd, "level %d", &level) != 1)
8284 return 0;
8286 *rc = fan_set_level_safe(level);
8287 if (*rc == -ENXIO)
8288 printk(TPACPI_ERR "level command accepted for unsupported "
8289 "access mode %d", fan_control_access_mode);
8290 else if (!*rc)
8291 tpacpi_disclose_usertask("procfs fan",
8292 "set level to %d\n", level);
8294 return 1;
8297 static int fan_write_cmd_enable(const char *cmd, int *rc)
8299 if (strlencmp(cmd, "enable") != 0)
8300 return 0;
8302 *rc = fan_set_enable();
8303 if (*rc == -ENXIO)
8304 printk(TPACPI_ERR "enable command accepted for unsupported "
8305 "access mode %d", fan_control_access_mode);
8306 else if (!*rc)
8307 tpacpi_disclose_usertask("procfs fan", "enable\n");
8309 return 1;
8312 static int fan_write_cmd_disable(const char *cmd, int *rc)
8314 if (strlencmp(cmd, "disable") != 0)
8315 return 0;
8317 *rc = fan_set_disable();
8318 if (*rc == -ENXIO)
8319 printk(TPACPI_ERR "disable command accepted for unsupported "
8320 "access mode %d", fan_control_access_mode);
8321 else if (!*rc)
8322 tpacpi_disclose_usertask("procfs fan", "disable\n");
8324 return 1;
8327 static int fan_write_cmd_speed(const char *cmd, int *rc)
8329 int speed;
8331 /* TODO:
8332 * Support speed <low> <medium> <high> ? */
8334 if (sscanf(cmd, "speed %d", &speed) != 1)
8335 return 0;
8337 *rc = fan_set_speed(speed);
8338 if (*rc == -ENXIO)
8339 printk(TPACPI_ERR "speed command accepted for unsupported "
8340 "access mode %d", fan_control_access_mode);
8341 else if (!*rc)
8342 tpacpi_disclose_usertask("procfs fan",
8343 "set speed to %d\n", speed);
8345 return 1;
8348 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8350 int interval;
8352 if (sscanf(cmd, "watchdog %d", &interval) != 1)
8353 return 0;
8355 if (interval < 0 || interval > 120)
8356 *rc = -EINVAL;
8357 else {
8358 fan_watchdog_maxinterval = interval;
8359 tpacpi_disclose_usertask("procfs fan",
8360 "set watchdog timer to %d\n",
8361 interval);
8364 return 1;
8367 static int fan_write(char *buf)
8369 char *cmd;
8370 int rc = 0;
8372 while (!rc && (cmd = next_cmd(&buf))) {
8373 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8374 fan_write_cmd_level(cmd, &rc)) &&
8375 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8376 (fan_write_cmd_enable(cmd, &rc) ||
8377 fan_write_cmd_disable(cmd, &rc) ||
8378 fan_write_cmd_watchdog(cmd, &rc))) &&
8379 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8380 fan_write_cmd_speed(cmd, &rc))
8382 rc = -EINVAL;
8383 else if (!rc)
8384 fan_watchdog_reset();
8387 return rc;
8390 static struct ibm_struct fan_driver_data = {
8391 .name = "fan",
8392 .read = fan_read,
8393 .write = fan_write,
8394 .exit = fan_exit,
8395 .suspend = fan_suspend,
8396 .resume = fan_resume,
8399 /****************************************************************************
8400 ****************************************************************************
8402 * Infrastructure
8404 ****************************************************************************
8405 ****************************************************************************/
8408 * HKEY event callout for other subdrivers go here
8409 * (yes, it is ugly, but it is quick, safe, and gets the job done
8411 static void tpacpi_driver_event(const unsigned int hkey_event)
8413 if (ibm_backlight_device) {
8414 switch (hkey_event) {
8415 case TP_HKEY_EV_BRGHT_UP:
8416 case TP_HKEY_EV_BRGHT_DOWN:
8417 tpacpi_brightness_notify_change();
8420 if (alsa_card) {
8421 switch (hkey_event) {
8422 case TP_HKEY_EV_VOL_UP:
8423 case TP_HKEY_EV_VOL_DOWN:
8424 case TP_HKEY_EV_VOL_MUTE:
8425 volume_alsa_notify_change();
8430 static void hotkey_driver_event(const unsigned int scancode)
8432 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8435 /* sysfs name ---------------------------------------------------------- */
8436 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8437 struct device_attribute *attr,
8438 char *buf)
8440 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8443 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8444 __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8446 /* --------------------------------------------------------------------- */
8448 /* /proc support */
8449 static struct proc_dir_entry *proc_dir;
8452 * Module and infrastructure proble, init and exit handling
8455 static int force_load;
8457 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
8458 static const char * __init str_supported(int is_supported)
8460 static char text_unsupported[] __initdata = "not supported";
8462 return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8464 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8466 static void ibm_exit(struct ibm_struct *ibm)
8468 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8470 list_del_init(&ibm->all_drivers);
8472 if (ibm->flags.acpi_notify_installed) {
8473 dbg_printk(TPACPI_DBG_EXIT,
8474 "%s: acpi_remove_notify_handler\n", ibm->name);
8475 BUG_ON(!ibm->acpi);
8476 acpi_remove_notify_handler(*ibm->acpi->handle,
8477 ibm->acpi->type,
8478 dispatch_acpi_notify);
8479 ibm->flags.acpi_notify_installed = 0;
8480 ibm->flags.acpi_notify_installed = 0;
8483 if (ibm->flags.proc_created) {
8484 dbg_printk(TPACPI_DBG_EXIT,
8485 "%s: remove_proc_entry\n", ibm->name);
8486 remove_proc_entry(ibm->name, proc_dir);
8487 ibm->flags.proc_created = 0;
8490 if (ibm->flags.acpi_driver_registered) {
8491 dbg_printk(TPACPI_DBG_EXIT,
8492 "%s: acpi_bus_unregister_driver\n", ibm->name);
8493 BUG_ON(!ibm->acpi);
8494 acpi_bus_unregister_driver(ibm->acpi->driver);
8495 kfree(ibm->acpi->driver);
8496 ibm->acpi->driver = NULL;
8497 ibm->flags.acpi_driver_registered = 0;
8500 if (ibm->flags.init_called && ibm->exit) {
8501 ibm->exit();
8502 ibm->flags.init_called = 0;
8505 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8508 static int __init ibm_init(struct ibm_init_struct *iibm)
8510 int ret;
8511 struct ibm_struct *ibm = iibm->data;
8512 struct proc_dir_entry *entry;
8514 BUG_ON(ibm == NULL);
8516 INIT_LIST_HEAD(&ibm->all_drivers);
8518 if (ibm->flags.experimental && !experimental)
8519 return 0;
8521 dbg_printk(TPACPI_DBG_INIT,
8522 "probing for %s\n", ibm->name);
8524 if (iibm->init) {
8525 ret = iibm->init(iibm);
8526 if (ret > 0)
8527 return 0; /* probe failed */
8528 if (ret)
8529 return ret;
8531 ibm->flags.init_called = 1;
8534 if (ibm->acpi) {
8535 if (ibm->acpi->hid) {
8536 ret = register_tpacpi_subdriver(ibm);
8537 if (ret)
8538 goto err_out;
8541 if (ibm->acpi->notify) {
8542 ret = setup_acpi_notify(ibm);
8543 if (ret == -ENODEV) {
8544 printk(TPACPI_NOTICE "disabling subdriver %s\n",
8545 ibm->name);
8546 ret = 0;
8547 goto err_out;
8549 if (ret < 0)
8550 goto err_out;
8554 dbg_printk(TPACPI_DBG_INIT,
8555 "%s installed\n", ibm->name);
8557 if (ibm->read) {
8558 mode_t mode = iibm->base_procfs_mode;
8560 if (!mode)
8561 mode = S_IRUGO;
8562 if (ibm->write)
8563 mode |= S_IWUSR;
8564 entry = proc_create_data(ibm->name, mode, proc_dir,
8565 &dispatch_proc_fops, ibm);
8566 if (!entry) {
8567 printk(TPACPI_ERR "unable to create proc entry %s\n",
8568 ibm->name);
8569 ret = -ENODEV;
8570 goto err_out;
8572 ibm->flags.proc_created = 1;
8575 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8577 return 0;
8579 err_out:
8580 dbg_printk(TPACPI_DBG_INIT,
8581 "%s: at error exit path with result %d\n",
8582 ibm->name, ret);
8584 ibm_exit(ibm);
8585 return (ret < 0)? ret : 0;
8588 /* Probing */
8590 static bool __pure __init tpacpi_is_fw_digit(const char c)
8592 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8595 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8596 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8597 const char t)
8599 return s && strlen(s) >= 8 &&
8600 tpacpi_is_fw_digit(s[0]) &&
8601 tpacpi_is_fw_digit(s[1]) &&
8602 s[2] == t && s[3] == 'T' &&
8603 tpacpi_is_fw_digit(s[4]) &&
8604 tpacpi_is_fw_digit(s[5]) &&
8605 s[6] == 'W' && s[7] == 'W';
8608 /* returns 0 - probe ok, or < 0 - probe error.
8609 * Probe ok doesn't mean thinkpad found.
8610 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8611 static int __must_check __init get_thinkpad_model_data(
8612 struct thinkpad_id_data *tp)
8614 const struct dmi_device *dev = NULL;
8615 char ec_fw_string[18];
8616 char const *s;
8618 if (!tp)
8619 return -EINVAL;
8621 memset(tp, 0, sizeof(*tp));
8623 if (dmi_name_in_vendors("IBM"))
8624 tp->vendor = PCI_VENDOR_ID_IBM;
8625 else if (dmi_name_in_vendors("LENOVO"))
8626 tp->vendor = PCI_VENDOR_ID_LENOVO;
8627 else
8628 return 0;
8630 s = dmi_get_system_info(DMI_BIOS_VERSION);
8631 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8632 if (s && !tp->bios_version_str)
8633 return -ENOMEM;
8635 /* Really ancient ThinkPad 240X will fail this, which is fine */
8636 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
8637 return 0;
8639 tp->bios_model = tp->bios_version_str[0]
8640 | (tp->bios_version_str[1] << 8);
8641 tp->bios_release = (tp->bios_version_str[4] << 8)
8642 | tp->bios_version_str[5];
8645 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8646 * X32 or newer, all Z series; Some models must have an
8647 * up-to-date BIOS or they will not be detected.
8649 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8651 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8652 if (sscanf(dev->name,
8653 "IBM ThinkPad Embedded Controller -[%17c",
8654 ec_fw_string) == 1) {
8655 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8656 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8658 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8659 if (!tp->ec_version_str)
8660 return -ENOMEM;
8662 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8663 tp->ec_model = ec_fw_string[0]
8664 | (ec_fw_string[1] << 8);
8665 tp->ec_release = (ec_fw_string[4] << 8)
8666 | ec_fw_string[5];
8667 } else {
8668 printk(TPACPI_NOTICE
8669 "ThinkPad firmware release %s "
8670 "doesn't match the known patterns\n",
8671 ec_fw_string);
8672 printk(TPACPI_NOTICE
8673 "please report this to %s\n",
8674 TPACPI_MAIL);
8676 break;
8680 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8681 if (s && !strnicmp(s, "ThinkPad", 8)) {
8682 tp->model_str = kstrdup(s, GFP_KERNEL);
8683 if (!tp->model_str)
8684 return -ENOMEM;
8687 s = dmi_get_system_info(DMI_PRODUCT_NAME);
8688 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8689 if (s && !tp->nummodel_str)
8690 return -ENOMEM;
8692 return 0;
8695 static int __init probe_for_thinkpad(void)
8697 int is_thinkpad;
8699 if (acpi_disabled)
8700 return -ENODEV;
8702 /* It would be dangerous to run the driver in this case */
8703 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8704 return -ENODEV;
8707 * Non-ancient models have better DMI tagging, but very old models
8708 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
8710 is_thinkpad = (thinkpad_id.model_str != NULL) ||
8711 (thinkpad_id.ec_model != 0) ||
8712 tpacpi_is_fw_known();
8714 /* ec is required because many other handles are relative to it */
8715 TPACPI_ACPIHANDLE_INIT(ec);
8716 if (!ec_handle) {
8717 if (is_thinkpad)
8718 printk(TPACPI_ERR
8719 "Not yet supported ThinkPad detected!\n");
8720 return -ENODEV;
8723 if (!is_thinkpad && !force_load)
8724 return -ENODEV;
8726 return 0;
8729 static void __init thinkpad_acpi_init_banner(void)
8731 printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
8732 printk(TPACPI_INFO "%s\n", TPACPI_URL);
8734 printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
8735 (thinkpad_id.bios_version_str) ?
8736 thinkpad_id.bios_version_str : "unknown",
8737 (thinkpad_id.ec_version_str) ?
8738 thinkpad_id.ec_version_str : "unknown");
8740 BUG_ON(!thinkpad_id.vendor);
8742 if (thinkpad_id.model_str)
8743 printk(TPACPI_INFO "%s %s, model %s\n",
8744 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
8745 "IBM" : ((thinkpad_id.vendor ==
8746 PCI_VENDOR_ID_LENOVO) ?
8747 "Lenovo" : "Unknown vendor"),
8748 thinkpad_id.model_str,
8749 (thinkpad_id.nummodel_str) ?
8750 thinkpad_id.nummodel_str : "unknown");
8753 /* Module init, exit, parameters */
8755 static struct ibm_init_struct ibms_init[] __initdata = {
8757 .data = &thinkpad_acpi_driver_data,
8760 .init = hotkey_init,
8761 .data = &hotkey_driver_data,
8764 .init = bluetooth_init,
8765 .data = &bluetooth_driver_data,
8768 .init = wan_init,
8769 .data = &wan_driver_data,
8772 .init = uwb_init,
8773 .data = &uwb_driver_data,
8775 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8777 .init = video_init,
8778 .base_procfs_mode = S_IRUSR,
8779 .data = &video_driver_data,
8781 #endif
8783 .init = light_init,
8784 .data = &light_driver_data,
8787 .init = cmos_init,
8788 .data = &cmos_driver_data,
8791 .init = led_init,
8792 .data = &led_driver_data,
8795 .init = beep_init,
8796 .data = &beep_driver_data,
8799 .init = thermal_init,
8800 .data = &thermal_driver_data,
8803 .data = &ecdump_driver_data,
8806 .init = brightness_init,
8807 .data = &brightness_driver_data,
8810 .init = volume_init,
8811 .data = &volume_driver_data,
8814 .init = fan_init,
8815 .data = &fan_driver_data,
8819 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8821 unsigned int i;
8822 struct ibm_struct *ibm;
8824 if (!kp || !kp->name || !val)
8825 return -EINVAL;
8827 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8828 ibm = ibms_init[i].data;
8829 WARN_ON(ibm == NULL);
8831 if (!ibm || !ibm->name)
8832 continue;
8834 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8835 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8836 return -ENOSPC;
8837 strcpy(ibms_init[i].param, val);
8838 strcat(ibms_init[i].param, ",");
8839 return 0;
8843 return -EINVAL;
8846 module_param(experimental, int, 0444);
8847 MODULE_PARM_DESC(experimental,
8848 "Enables experimental features when non-zero");
8850 module_param_named(debug, dbg_level, uint, 0);
8851 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8853 module_param(force_load, bool, 0444);
8854 MODULE_PARM_DESC(force_load,
8855 "Attempts to load the driver even on a "
8856 "mis-identified ThinkPad when true");
8858 module_param_named(fan_control, fan_control_allowed, bool, 0444);
8859 MODULE_PARM_DESC(fan_control,
8860 "Enables setting fan parameters features when true");
8862 module_param_named(brightness_mode, brightness_mode, uint, 0444);
8863 MODULE_PARM_DESC(brightness_mode,
8864 "Selects brightness control strategy: "
8865 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8867 module_param(brightness_enable, uint, 0444);
8868 MODULE_PARM_DESC(brightness_enable,
8869 "Enables backlight control when 1, disables when 0");
8871 module_param(hotkey_report_mode, uint, 0444);
8872 MODULE_PARM_DESC(hotkey_report_mode,
8873 "used for backwards compatibility with userspace, "
8874 "see documentation");
8876 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8877 module_param_named(volume_mode, volume_mode, uint, 0444);
8878 MODULE_PARM_DESC(volume_mode,
8879 "Selects volume control strategy: "
8880 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8882 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8883 MODULE_PARM_DESC(volume_capabilities,
8884 "Selects the mixer capabilites: "
8885 "0=auto, 1=volume and mute, 2=mute only");
8887 module_param_named(volume_control, volume_control_allowed, bool, 0444);
8888 MODULE_PARM_DESC(volume_control,
8889 "Enables software override for the console audio "
8890 "control when true");
8892 /* ALSA module API parameters */
8893 module_param_named(index, alsa_index, int, 0444);
8894 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8895 module_param_named(id, alsa_id, charp, 0444);
8896 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8897 module_param_named(enable, alsa_enable, bool, 0444);
8898 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8899 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8901 #define TPACPI_PARAM(feature) \
8902 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8903 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8904 "at module load, see documentation")
8906 TPACPI_PARAM(hotkey);
8907 TPACPI_PARAM(bluetooth);
8908 TPACPI_PARAM(video);
8909 TPACPI_PARAM(light);
8910 TPACPI_PARAM(cmos);
8911 TPACPI_PARAM(led);
8912 TPACPI_PARAM(beep);
8913 TPACPI_PARAM(ecdump);
8914 TPACPI_PARAM(brightness);
8915 TPACPI_PARAM(volume);
8916 TPACPI_PARAM(fan);
8918 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8919 module_param(dbg_wlswemul, uint, 0444);
8920 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8921 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8922 MODULE_PARM_DESC(wlsw_state,
8923 "Initial state of the emulated WLSW switch");
8925 module_param(dbg_bluetoothemul, uint, 0444);
8926 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8927 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8928 MODULE_PARM_DESC(bluetooth_state,
8929 "Initial state of the emulated bluetooth switch");
8931 module_param(dbg_wwanemul, uint, 0444);
8932 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8933 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8934 MODULE_PARM_DESC(wwan_state,
8935 "Initial state of the emulated WWAN switch");
8937 module_param(dbg_uwbemul, uint, 0444);
8938 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8939 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8940 MODULE_PARM_DESC(uwb_state,
8941 "Initial state of the emulated UWB switch");
8942 #endif
8944 static void thinkpad_acpi_module_exit(void)
8946 struct ibm_struct *ibm, *itmp;
8948 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8950 list_for_each_entry_safe_reverse(ibm, itmp,
8951 &tpacpi_all_drivers,
8952 all_drivers) {
8953 ibm_exit(ibm);
8956 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8958 if (tpacpi_inputdev) {
8959 if (tp_features.input_device_registered)
8960 input_unregister_device(tpacpi_inputdev);
8961 else
8962 input_free_device(tpacpi_inputdev);
8965 if (tpacpi_hwmon)
8966 hwmon_device_unregister(tpacpi_hwmon);
8968 if (tp_features.sensors_pdev_attrs_registered)
8969 device_remove_file(&tpacpi_sensors_pdev->dev,
8970 &dev_attr_thinkpad_acpi_pdev_name);
8971 if (tpacpi_sensors_pdev)
8972 platform_device_unregister(tpacpi_sensors_pdev);
8973 if (tpacpi_pdev)
8974 platform_device_unregister(tpacpi_pdev);
8976 if (tp_features.sensors_pdrv_attrs_registered)
8977 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8978 if (tp_features.platform_drv_attrs_registered)
8979 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8981 if (tp_features.sensors_pdrv_registered)
8982 platform_driver_unregister(&tpacpi_hwmon_pdriver);
8984 if (tp_features.platform_drv_registered)
8985 platform_driver_unregister(&tpacpi_pdriver);
8987 if (proc_dir)
8988 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
8990 if (tpacpi_wq)
8991 destroy_workqueue(tpacpi_wq);
8993 kfree(thinkpad_id.bios_version_str);
8994 kfree(thinkpad_id.ec_version_str);
8995 kfree(thinkpad_id.model_str);
8999 static int __init thinkpad_acpi_module_init(void)
9001 int ret, i;
9003 tpacpi_lifecycle = TPACPI_LIFE_INIT;
9005 /* Parameter checking */
9006 if (hotkey_report_mode > 2)
9007 return -EINVAL;
9009 /* Driver-level probe */
9011 ret = get_thinkpad_model_data(&thinkpad_id);
9012 if (ret) {
9013 printk(TPACPI_ERR
9014 "unable to get DMI data: %d\n", ret);
9015 thinkpad_acpi_module_exit();
9016 return ret;
9018 ret = probe_for_thinkpad();
9019 if (ret) {
9020 thinkpad_acpi_module_exit();
9021 return ret;
9024 /* Driver initialization */
9026 thinkpad_acpi_init_banner();
9027 tpacpi_check_outdated_fw();
9029 TPACPI_ACPIHANDLE_INIT(ecrd);
9030 TPACPI_ACPIHANDLE_INIT(ecwr);
9032 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9033 if (!tpacpi_wq) {
9034 thinkpad_acpi_module_exit();
9035 return -ENOMEM;
9038 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9039 if (!proc_dir) {
9040 printk(TPACPI_ERR
9041 "unable to create proc dir " TPACPI_PROC_DIR);
9042 thinkpad_acpi_module_exit();
9043 return -ENODEV;
9046 ret = platform_driver_register(&tpacpi_pdriver);
9047 if (ret) {
9048 printk(TPACPI_ERR
9049 "unable to register main platform driver\n");
9050 thinkpad_acpi_module_exit();
9051 return ret;
9053 tp_features.platform_drv_registered = 1;
9055 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9056 if (ret) {
9057 printk(TPACPI_ERR
9058 "unable to register hwmon platform driver\n");
9059 thinkpad_acpi_module_exit();
9060 return ret;
9062 tp_features.sensors_pdrv_registered = 1;
9064 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9065 if (!ret) {
9066 tp_features.platform_drv_attrs_registered = 1;
9067 ret = tpacpi_create_driver_attributes(
9068 &tpacpi_hwmon_pdriver.driver);
9070 if (ret) {
9071 printk(TPACPI_ERR
9072 "unable to create sysfs driver attributes\n");
9073 thinkpad_acpi_module_exit();
9074 return ret;
9076 tp_features.sensors_pdrv_attrs_registered = 1;
9079 /* Device initialization */
9080 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9081 NULL, 0);
9082 if (IS_ERR(tpacpi_pdev)) {
9083 ret = PTR_ERR(tpacpi_pdev);
9084 tpacpi_pdev = NULL;
9085 printk(TPACPI_ERR "unable to register platform device\n");
9086 thinkpad_acpi_module_exit();
9087 return ret;
9089 tpacpi_sensors_pdev = platform_device_register_simple(
9090 TPACPI_HWMON_DRVR_NAME,
9091 -1, NULL, 0);
9092 if (IS_ERR(tpacpi_sensors_pdev)) {
9093 ret = PTR_ERR(tpacpi_sensors_pdev);
9094 tpacpi_sensors_pdev = NULL;
9095 printk(TPACPI_ERR
9096 "unable to register hwmon platform device\n");
9097 thinkpad_acpi_module_exit();
9098 return ret;
9100 ret = device_create_file(&tpacpi_sensors_pdev->dev,
9101 &dev_attr_thinkpad_acpi_pdev_name);
9102 if (ret) {
9103 printk(TPACPI_ERR
9104 "unable to create sysfs hwmon device attributes\n");
9105 thinkpad_acpi_module_exit();
9106 return ret;
9108 tp_features.sensors_pdev_attrs_registered = 1;
9109 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9110 if (IS_ERR(tpacpi_hwmon)) {
9111 ret = PTR_ERR(tpacpi_hwmon);
9112 tpacpi_hwmon = NULL;
9113 printk(TPACPI_ERR "unable to register hwmon device\n");
9114 thinkpad_acpi_module_exit();
9115 return ret;
9117 mutex_init(&tpacpi_inputdev_send_mutex);
9118 tpacpi_inputdev = input_allocate_device();
9119 if (!tpacpi_inputdev) {
9120 printk(TPACPI_ERR "unable to allocate input device\n");
9121 thinkpad_acpi_module_exit();
9122 return -ENOMEM;
9123 } else {
9124 /* Prepare input device, but don't register */
9125 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9126 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9127 tpacpi_inputdev->id.bustype = BUS_HOST;
9128 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9129 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9130 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9131 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9133 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9134 ret = ibm_init(&ibms_init[i]);
9135 if (ret >= 0 && *ibms_init[i].param)
9136 ret = ibms_init[i].data->write(ibms_init[i].param);
9137 if (ret < 0) {
9138 thinkpad_acpi_module_exit();
9139 return ret;
9143 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9145 ret = input_register_device(tpacpi_inputdev);
9146 if (ret < 0) {
9147 printk(TPACPI_ERR "unable to register input device\n");
9148 thinkpad_acpi_module_exit();
9149 return ret;
9150 } else {
9151 tp_features.input_device_registered = 1;
9154 return 0;
9157 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9160 * This will autoload the driver in almost every ThinkPad
9161 * in widespread use.
9163 * Only _VERY_ old models, like the 240, 240x and 570 lack
9164 * the HKEY event interface.
9166 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9169 * DMI matching for module autoloading
9171 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9172 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9174 * Only models listed in thinkwiki will be supported, so add yours
9175 * if it is not there yet.
9177 #define IBM_BIOS_MODULE_ALIAS(__type) \
9178 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9180 /* Ancient thinkpad BIOSes have to be identified by
9181 * BIOS type or model number, and there are far less
9182 * BIOS types than model numbers... */
9183 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
9185 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9186 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9187 MODULE_DESCRIPTION(TPACPI_DESC);
9188 MODULE_VERSION(TPACPI_VERSION);
9189 MODULE_LICENSE("GPL");
9191 module_init(thinkpad_acpi_module_init);
9192 module_exit(thinkpad_acpi_module_exit);