thinkpad-acpi: adopt input device
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / platform / x86 / thinkpad_acpi.c
blob5fdd4f550b6e4a68743a44e4c01571328d4bd9d5
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.23"
25 #define TPACPI_SYSFS_VERSION 0x020600
28 * Changelog:
29 * 2007-10-20 changelog trimmed down
31 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
32 * drivers/misc.
34 * 2006-11-22 0.13 new maintainer
35 * changelog now lives in git commit history, and will
36 * not be updated further in-file.
38 * 2005-03-17 0.11 support for 600e, 770x
39 * thanks to Jamie Lentin <lentinj@dial.pipex.com>
41 * 2005-01-16 0.9 use MODULE_VERSION
42 * thanks to Henrik Brix Andersen <brix@gentoo.org>
43 * fix parameter passing on module loading
44 * thanks to Rusty Russell <rusty@rustcorp.com.au>
45 * thanks to Jim Radford <radford@blackbean.org>
46 * 2004-11-08 0.8 fix init error case, don't return from a macro
47 * thanks to Chris Wright <chrisw@osdl.org>
50 #include <linux/kernel.h>
51 #include <linux/module.h>
52 #include <linux/init.h>
53 #include <linux/types.h>
54 #include <linux/string.h>
55 #include <linux/list.h>
56 #include <linux/mutex.h>
57 #include <linux/sched.h>
58 #include <linux/kthread.h>
59 #include <linux/freezer.h>
60 #include <linux/delay.h>
62 #include <linux/nvram.h>
63 #include <linux/proc_fs.h>
64 #include <linux/sysfs.h>
65 #include <linux/backlight.h>
66 #include <linux/fb.h>
67 #include <linux/platform_device.h>
68 #include <linux/hwmon.h>
69 #include <linux/hwmon-sysfs.h>
70 #include <linux/input.h>
71 #include <linux/leds.h>
72 #include <linux/rfkill.h>
73 #include <asm/uaccess.h>
75 #include <linux/dmi.h>
76 #include <linux/jiffies.h>
77 #include <linux/workqueue.h>
79 #include <acpi/acpi_drivers.h>
81 #include <linux/pci_ids.h>
84 /* ThinkPad CMOS commands */
85 #define TP_CMOS_VOLUME_DOWN 0
86 #define TP_CMOS_VOLUME_UP 1
87 #define TP_CMOS_VOLUME_MUTE 2
88 #define TP_CMOS_BRIGHTNESS_UP 4
89 #define TP_CMOS_BRIGHTNESS_DOWN 5
90 #define TP_CMOS_THINKLIGHT_ON 12
91 #define TP_CMOS_THINKLIGHT_OFF 13
93 /* NVRAM Addresses */
94 enum tp_nvram_addr {
95 TP_NVRAM_ADDR_HK2 = 0x57,
96 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
97 TP_NVRAM_ADDR_VIDEO = 0x59,
98 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
99 TP_NVRAM_ADDR_MIXER = 0x60,
102 /* NVRAM bit masks */
103 enum {
104 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
105 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
106 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
107 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
108 TP_NVRAM_MASK_THINKLIGHT = 0x10,
109 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
110 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
111 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
112 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
113 TP_NVRAM_MASK_MUTE = 0x40,
114 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
115 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
116 TP_NVRAM_POS_LEVEL_VOLUME = 0,
119 /* ACPI HIDs */
120 #define TPACPI_ACPI_HKEY_HID "IBM0068"
122 /* Input IDs */
123 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
124 #define TPACPI_HKEY_INPUT_VERSION 0x4101
126 /* ACPI \WGSV commands */
127 enum {
128 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
129 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
130 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
131 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
134 /* TP_ACPI_WGSV_GET_STATE bits */
135 enum {
136 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
137 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
138 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
139 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
140 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
141 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
142 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
143 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
144 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
145 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
148 /* HKEY events */
149 enum tpacpi_hkey_event_t {
150 /* Hotkey-related */
151 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
152 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
153 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
154 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
155 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
156 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
158 /* Reasons for waking up from S3/S4 */
159 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
160 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
161 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
162 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
163 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
164 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
166 /* Auto-sleep after eject request */
167 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
168 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
170 /* Misc bay events */
171 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
173 /* User-interface events */
174 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
175 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
176 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
177 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
178 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
179 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
180 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
182 /* Thermal events */
183 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
184 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
185 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
186 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
187 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* thermal table changed */
189 /* Misc */
190 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
193 /****************************************************************************
194 * Main driver
197 #define TPACPI_NAME "thinkpad"
198 #define TPACPI_DESC "ThinkPad ACPI Extras"
199 #define TPACPI_FILE TPACPI_NAME "_acpi"
200 #define TPACPI_URL "http://ibm-acpi.sf.net/"
201 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
203 #define TPACPI_PROC_DIR "ibm"
204 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
205 #define TPACPI_DRVR_NAME TPACPI_FILE
206 #define TPACPI_DRVR_SHORTNAME "tpacpi"
207 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
209 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
210 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
212 #define TPACPI_MAX_ACPI_ARGS 3
214 /* printk headers */
215 #define TPACPI_LOG TPACPI_FILE ": "
216 #define TPACPI_EMERG KERN_EMERG TPACPI_LOG
217 #define TPACPI_ALERT KERN_ALERT TPACPI_LOG
218 #define TPACPI_CRIT KERN_CRIT TPACPI_LOG
219 #define TPACPI_ERR KERN_ERR TPACPI_LOG
220 #define TPACPI_WARN KERN_WARNING TPACPI_LOG
221 #define TPACPI_NOTICE KERN_NOTICE TPACPI_LOG
222 #define TPACPI_INFO KERN_INFO TPACPI_LOG
223 #define TPACPI_DEBUG KERN_DEBUG TPACPI_LOG
225 /* Debugging printk groups */
226 #define TPACPI_DBG_ALL 0xffff
227 #define TPACPI_DBG_DISCLOSETASK 0x8000
228 #define TPACPI_DBG_INIT 0x0001
229 #define TPACPI_DBG_EXIT 0x0002
230 #define TPACPI_DBG_RFKILL 0x0004
231 #define TPACPI_DBG_HKEY 0x0008
232 #define TPACPI_DBG_FAN 0x0010
233 #define TPACPI_DBG_BRGHT 0x0020
235 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
236 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
237 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
240 /****************************************************************************
241 * Driver-wide structs and misc. variables
244 struct ibm_struct;
246 struct tp_acpi_drv_struct {
247 const struct acpi_device_id *hid;
248 struct acpi_driver *driver;
250 void (*notify) (struct ibm_struct *, u32);
251 acpi_handle *handle;
252 u32 type;
253 struct acpi_device *device;
256 struct ibm_struct {
257 char *name;
259 int (*read) (char *);
260 int (*write) (char *);
261 void (*exit) (void);
262 void (*resume) (void);
263 void (*suspend) (pm_message_t state);
264 void (*shutdown) (void);
266 struct list_head all_drivers;
268 struct tp_acpi_drv_struct *acpi;
270 struct {
271 u8 acpi_driver_registered:1;
272 u8 acpi_notify_installed:1;
273 u8 proc_created:1;
274 u8 init_called:1;
275 u8 experimental:1;
276 } flags;
279 struct ibm_init_struct {
280 char param[32];
282 int (*init) (struct ibm_init_struct *);
283 struct ibm_struct *data;
286 static struct {
287 u32 bluetooth:1;
288 u32 hotkey:1;
289 u32 hotkey_mask:1;
290 u32 hotkey_wlsw:1;
291 u32 hotkey_tablet:1;
292 u32 light:1;
293 u32 light_status:1;
294 u32 bright_16levels:1;
295 u32 bright_acpimode:1;
296 u32 wan:1;
297 u32 uwb:1;
298 u32 fan_ctrl_status_undef:1;
299 u32 second_fan:1;
300 u32 beep_needs_two_args:1;
301 u32 input_device_registered:1;
302 u32 platform_drv_registered:1;
303 u32 platform_drv_attrs_registered:1;
304 u32 sensors_pdrv_registered:1;
305 u32 sensors_pdrv_attrs_registered:1;
306 u32 sensors_pdev_attrs_registered:1;
307 u32 hotkey_poll_active:1;
308 } tp_features;
310 static struct {
311 u16 hotkey_mask_ff:1;
312 } tp_warned;
314 struct thinkpad_id_data {
315 unsigned int vendor; /* ThinkPad vendor:
316 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
318 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
319 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
321 u16 bios_model; /* 1Y = 0x5931, 0 = unknown */
322 u16 ec_model;
323 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
324 u16 ec_release;
326 char *model_str; /* ThinkPad T43 */
327 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
329 static struct thinkpad_id_data thinkpad_id;
331 static enum {
332 TPACPI_LIFE_INIT = 0,
333 TPACPI_LIFE_RUNNING,
334 TPACPI_LIFE_EXITING,
335 } tpacpi_lifecycle;
337 static int experimental;
338 static u32 dbg_level;
340 static struct workqueue_struct *tpacpi_wq;
342 enum led_status_t {
343 TPACPI_LED_OFF = 0,
344 TPACPI_LED_ON,
345 TPACPI_LED_BLINK,
348 /* Special LED class that can defer work */
349 struct tpacpi_led_classdev {
350 struct led_classdev led_classdev;
351 struct work_struct work;
352 enum led_status_t new_state;
353 unsigned int led;
356 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
357 static int dbg_wlswemul;
358 static int tpacpi_wlsw_emulstate;
359 static int dbg_bluetoothemul;
360 static int tpacpi_bluetooth_emulstate;
361 static int dbg_wwanemul;
362 static int tpacpi_wwan_emulstate;
363 static int dbg_uwbemul;
364 static int tpacpi_uwb_emulstate;
365 #endif
368 /*************************************************************************
369 * Debugging helpers
372 #define dbg_printk(a_dbg_level, format, arg...) \
373 do { if (dbg_level & (a_dbg_level)) \
374 printk(TPACPI_DEBUG "%s: " format, __func__ , ## arg); \
375 } while (0)
377 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
378 #define vdbg_printk dbg_printk
379 static const char *str_supported(int is_supported);
380 #else
381 #define vdbg_printk(a_dbg_level, format, arg...) \
382 do { } while (0)
383 #endif
385 static void tpacpi_log_usertask(const char * const what)
387 printk(TPACPI_DEBUG "%s: access by process with PID %d\n",
388 what, task_tgid_vnr(current));
391 #define tpacpi_disclose_usertask(what, format, arg...) \
392 do { \
393 if (unlikely( \
394 (dbg_level & TPACPI_DBG_DISCLOSETASK) && \
395 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
396 printk(TPACPI_DEBUG "%s: PID %d: " format, \
397 what, task_tgid_vnr(current), ## arg); \
399 } while (0)
402 * Quirk handling helpers
404 * ThinkPad IDs and versions seen in the field so far
405 * are two-characters from the set [0-9A-Z], i.e. base 36.
407 * We use values well outside that range as specials.
410 #define TPACPI_MATCH_ANY 0xffffU
411 #define TPACPI_MATCH_UNKNOWN 0U
413 /* TPID('1', 'Y') == 0x5931 */
414 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
416 #define TPACPI_Q_IBM(__id1, __id2, __quirk) \
417 { .vendor = PCI_VENDOR_ID_IBM, \
418 .bios = TPID(__id1, __id2), \
419 .ec = TPACPI_MATCH_ANY, \
420 .quirks = (__quirk) }
422 #define TPACPI_Q_LNV(__id1, __id2, __quirk) \
423 { .vendor = PCI_VENDOR_ID_LENOVO, \
424 .bios = TPID(__id1, __id2), \
425 .ec = TPACPI_MATCH_ANY, \
426 .quirks = (__quirk) }
428 struct tpacpi_quirk {
429 unsigned int vendor;
430 u16 bios;
431 u16 ec;
432 unsigned long quirks;
436 * tpacpi_check_quirks() - search BIOS/EC version on a list
437 * @qlist: array of &struct tpacpi_quirk
438 * @qlist_size: number of elements in @qlist
440 * Iterates over a quirks list until one is found that matches the
441 * ThinkPad's vendor, BIOS and EC model.
443 * Returns 0 if nothing matches, otherwise returns the quirks field of
444 * the matching &struct tpacpi_quirk entry.
446 * The match criteria is: vendor, ec and bios much match.
448 static unsigned long __init tpacpi_check_quirks(
449 const struct tpacpi_quirk *qlist,
450 unsigned int qlist_size)
452 while (qlist_size) {
453 if ((qlist->vendor == thinkpad_id.vendor ||
454 qlist->vendor == TPACPI_MATCH_ANY) &&
455 (qlist->bios == thinkpad_id.bios_model ||
456 qlist->bios == TPACPI_MATCH_ANY) &&
457 (qlist->ec == thinkpad_id.ec_model ||
458 qlist->ec == TPACPI_MATCH_ANY))
459 return qlist->quirks;
461 qlist_size--;
462 qlist++;
464 return 0;
468 /****************************************************************************
469 ****************************************************************************
471 * ACPI Helpers and device model
473 ****************************************************************************
474 ****************************************************************************/
476 /*************************************************************************
477 * ACPI basic handles
480 static acpi_handle root_handle;
482 #define TPACPI_HANDLE(object, parent, paths...) \
483 static acpi_handle object##_handle; \
484 static acpi_handle *object##_parent = &parent##_handle; \
485 static char *object##_path; \
486 static char *object##_paths[] = { paths }
488 TPACPI_HANDLE(ec, root, "\\_SB.PCI0.ISA.EC0", /* 240, 240x */
489 "\\_SB.PCI.ISA.EC", /* 570 */
490 "\\_SB.PCI0.ISA0.EC0", /* 600e/x, 770e, 770x */
491 "\\_SB.PCI0.ISA.EC", /* A21e, A2xm/p, T20-22, X20-21 */
492 "\\_SB.PCI0.AD4S.EC0", /* i1400, R30 */
493 "\\_SB.PCI0.ICH3.EC0", /* R31 */
494 "\\_SB.PCI0.LPC.EC", /* all others */
497 TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
498 TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
500 TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
501 /* T4x, X31, X40 */
502 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
503 "\\CMS", /* R40, R40e */
504 ); /* all others */
506 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
507 "^HKEY", /* R30, R31 */
508 "HKEY", /* all others */
509 ); /* 570 */
511 TPACPI_HANDLE(vid, root, "\\_SB.PCI.AGP.VGA", /* 570 */
512 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
513 "\\_SB.PCI0.VID0", /* 770e */
514 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
515 "\\_SB.PCI0.AGP.VID", /* all others */
516 ); /* R30, R31 */
519 /*************************************************************************
520 * ACPI helpers
523 static int acpi_evalf(acpi_handle handle,
524 void *res, char *method, char *fmt, ...)
526 char *fmt0 = fmt;
527 struct acpi_object_list params;
528 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
529 struct acpi_buffer result, *resultp;
530 union acpi_object out_obj;
531 acpi_status status;
532 va_list ap;
533 char res_type;
534 int success;
535 int quiet;
537 if (!*fmt) {
538 printk(TPACPI_ERR "acpi_evalf() called with empty format\n");
539 return 0;
542 if (*fmt == 'q') {
543 quiet = 1;
544 fmt++;
545 } else
546 quiet = 0;
548 res_type = *(fmt++);
550 params.count = 0;
551 params.pointer = &in_objs[0];
553 va_start(ap, fmt);
554 while (*fmt) {
555 char c = *(fmt++);
556 switch (c) {
557 case 'd': /* int */
558 in_objs[params.count].integer.value = va_arg(ap, int);
559 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
560 break;
561 /* add more types as needed */
562 default:
563 printk(TPACPI_ERR "acpi_evalf() called "
564 "with invalid format character '%c'\n", c);
565 return 0;
568 va_end(ap);
570 if (res_type != 'v') {
571 result.length = sizeof(out_obj);
572 result.pointer = &out_obj;
573 resultp = &result;
574 } else
575 resultp = NULL;
577 status = acpi_evaluate_object(handle, method, &params, resultp);
579 switch (res_type) {
580 case 'd': /* int */
581 if (res)
582 *(int *)res = out_obj.integer.value;
583 success = status == AE_OK && out_obj.type == ACPI_TYPE_INTEGER;
584 break;
585 case 'v': /* void */
586 success = status == AE_OK;
587 break;
588 /* add more types as needed */
589 default:
590 printk(TPACPI_ERR "acpi_evalf() called "
591 "with invalid format character '%c'\n", res_type);
592 return 0;
595 if (!success && !quiet)
596 printk(TPACPI_ERR "acpi_evalf(%s, %s, ...) failed: %d\n",
597 method, fmt0, status);
599 return success;
602 static int acpi_ec_read(int i, u8 *p)
604 int v;
606 if (ecrd_handle) {
607 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
608 return 0;
609 *p = v;
610 } else {
611 if (ec_read(i, p) < 0)
612 return 0;
615 return 1;
618 static int acpi_ec_write(int i, u8 v)
620 if (ecwr_handle) {
621 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
622 return 0;
623 } else {
624 if (ec_write(i, v) < 0)
625 return 0;
628 return 1;
631 static int issue_thinkpad_cmos_command(int cmos_cmd)
633 if (!cmos_handle)
634 return -ENXIO;
636 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
637 return -EIO;
639 return 0;
642 /*************************************************************************
643 * ACPI device model
646 #define TPACPI_ACPIHANDLE_INIT(object) \
647 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
648 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
650 static void drv_acpi_handle_init(char *name,
651 acpi_handle *handle, acpi_handle parent,
652 char **paths, int num_paths, char **path)
654 int i;
655 acpi_status status;
657 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
658 name);
660 for (i = 0; i < num_paths; i++) {
661 status = acpi_get_handle(parent, paths[i], handle);
662 if (ACPI_SUCCESS(status)) {
663 *path = paths[i];
664 dbg_printk(TPACPI_DBG_INIT,
665 "Found ACPI handle %s for %s\n",
666 *path, name);
667 return;
671 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
672 name);
673 *handle = NULL;
676 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
678 struct ibm_struct *ibm = data;
680 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
681 return;
683 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
684 return;
686 ibm->acpi->notify(ibm, event);
689 static int __init setup_acpi_notify(struct ibm_struct *ibm)
691 acpi_status status;
692 int rc;
694 BUG_ON(!ibm->acpi);
696 if (!*ibm->acpi->handle)
697 return 0;
699 vdbg_printk(TPACPI_DBG_INIT,
700 "setting up ACPI notify for %s\n", ibm->name);
702 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
703 if (rc < 0) {
704 printk(TPACPI_ERR "acpi_bus_get_device(%s) failed: %d\n",
705 ibm->name, rc);
706 return -ENODEV;
709 ibm->acpi->device->driver_data = ibm;
710 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
711 TPACPI_ACPI_EVENT_PREFIX,
712 ibm->name);
714 status = acpi_install_notify_handler(*ibm->acpi->handle,
715 ibm->acpi->type, dispatch_acpi_notify, ibm);
716 if (ACPI_FAILURE(status)) {
717 if (status == AE_ALREADY_EXISTS) {
718 printk(TPACPI_NOTICE
719 "another device driver is already "
720 "handling %s events\n", ibm->name);
721 } else {
722 printk(TPACPI_ERR
723 "acpi_install_notify_handler(%s) failed: %d\n",
724 ibm->name, status);
726 return -ENODEV;
728 ibm->flags.acpi_notify_installed = 1;
729 return 0;
732 static int __init tpacpi_device_add(struct acpi_device *device)
734 return 0;
737 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
739 int rc;
741 dbg_printk(TPACPI_DBG_INIT,
742 "registering %s as an ACPI driver\n", ibm->name);
744 BUG_ON(!ibm->acpi);
746 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
747 if (!ibm->acpi->driver) {
748 printk(TPACPI_ERR
749 "failed to allocate memory for ibm->acpi->driver\n");
750 return -ENOMEM;
753 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
754 ibm->acpi->driver->ids = ibm->acpi->hid;
756 ibm->acpi->driver->ops.add = &tpacpi_device_add;
758 rc = acpi_bus_register_driver(ibm->acpi->driver);
759 if (rc < 0) {
760 printk(TPACPI_ERR "acpi_bus_register_driver(%s) failed: %d\n",
761 ibm->name, rc);
762 kfree(ibm->acpi->driver);
763 ibm->acpi->driver = NULL;
764 } else if (!rc)
765 ibm->flags.acpi_driver_registered = 1;
767 return rc;
771 /****************************************************************************
772 ****************************************************************************
774 * Procfs Helpers
776 ****************************************************************************
777 ****************************************************************************/
779 static int dispatch_procfs_read(char *page, char **start, off_t off,
780 int count, int *eof, void *data)
782 struct ibm_struct *ibm = data;
783 int len;
785 if (!ibm || !ibm->read)
786 return -EINVAL;
788 len = ibm->read(page);
789 if (len < 0)
790 return len;
792 if (len <= off + count)
793 *eof = 1;
794 *start = page + off;
795 len -= off;
796 if (len > count)
797 len = count;
798 if (len < 0)
799 len = 0;
801 return len;
804 static int dispatch_procfs_write(struct file *file,
805 const char __user *userbuf,
806 unsigned long count, void *data)
808 struct ibm_struct *ibm = data;
809 char *kernbuf;
810 int ret;
812 if (!ibm || !ibm->write)
813 return -EINVAL;
814 if (count > PAGE_SIZE - 2)
815 return -EINVAL;
817 kernbuf = kmalloc(count + 2, GFP_KERNEL);
818 if (!kernbuf)
819 return -ENOMEM;
821 if (copy_from_user(kernbuf, userbuf, count)) {
822 kfree(kernbuf);
823 return -EFAULT;
826 kernbuf[count] = 0;
827 strcat(kernbuf, ",");
828 ret = ibm->write(kernbuf);
829 if (ret == 0)
830 ret = count;
832 kfree(kernbuf);
834 return ret;
837 static char *next_cmd(char **cmds)
839 char *start = *cmds;
840 char *end;
842 while ((end = strchr(start, ',')) && end == start)
843 start = end + 1;
845 if (!end)
846 return NULL;
848 *end = 0;
849 *cmds = end + 1;
850 return start;
854 /****************************************************************************
855 ****************************************************************************
857 * Device model: input, hwmon and platform
859 ****************************************************************************
860 ****************************************************************************/
862 static struct platform_device *tpacpi_pdev;
863 static struct platform_device *tpacpi_sensors_pdev;
864 static struct device *tpacpi_hwmon;
865 static struct input_dev *tpacpi_inputdev;
866 static struct mutex tpacpi_inputdev_send_mutex;
867 static LIST_HEAD(tpacpi_all_drivers);
869 static int tpacpi_suspend_handler(struct platform_device *pdev,
870 pm_message_t state)
872 struct ibm_struct *ibm, *itmp;
874 list_for_each_entry_safe(ibm, itmp,
875 &tpacpi_all_drivers,
876 all_drivers) {
877 if (ibm->suspend)
878 (ibm->suspend)(state);
881 return 0;
884 static int tpacpi_resume_handler(struct platform_device *pdev)
886 struct ibm_struct *ibm, *itmp;
888 list_for_each_entry_safe(ibm, itmp,
889 &tpacpi_all_drivers,
890 all_drivers) {
891 if (ibm->resume)
892 (ibm->resume)();
895 return 0;
898 static void tpacpi_shutdown_handler(struct platform_device *pdev)
900 struct ibm_struct *ibm, *itmp;
902 list_for_each_entry_safe(ibm, itmp,
903 &tpacpi_all_drivers,
904 all_drivers) {
905 if (ibm->shutdown)
906 (ibm->shutdown)();
910 static struct platform_driver tpacpi_pdriver = {
911 .driver = {
912 .name = TPACPI_DRVR_NAME,
913 .owner = THIS_MODULE,
915 .suspend = tpacpi_suspend_handler,
916 .resume = tpacpi_resume_handler,
917 .shutdown = tpacpi_shutdown_handler,
920 static struct platform_driver tpacpi_hwmon_pdriver = {
921 .driver = {
922 .name = TPACPI_HWMON_DRVR_NAME,
923 .owner = THIS_MODULE,
927 /*************************************************************************
928 * sysfs support helpers
931 struct attribute_set {
932 unsigned int members, max_members;
933 struct attribute_group group;
936 struct attribute_set_obj {
937 struct attribute_set s;
938 struct attribute *a;
939 } __attribute__((packed));
941 static struct attribute_set *create_attr_set(unsigned int max_members,
942 const char *name)
944 struct attribute_set_obj *sobj;
946 if (max_members == 0)
947 return NULL;
949 /* Allocates space for implicit NULL at the end too */
950 sobj = kzalloc(sizeof(struct attribute_set_obj) +
951 max_members * sizeof(struct attribute *),
952 GFP_KERNEL);
953 if (!sobj)
954 return NULL;
955 sobj->s.max_members = max_members;
956 sobj->s.group.attrs = &sobj->a;
957 sobj->s.group.name = name;
959 return &sobj->s;
962 #define destroy_attr_set(_set) \
963 kfree(_set);
965 /* not multi-threaded safe, use it in a single thread per set */
966 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
968 if (!s || !attr)
969 return -EINVAL;
971 if (s->members >= s->max_members)
972 return -ENOMEM;
974 s->group.attrs[s->members] = attr;
975 s->members++;
977 return 0;
980 static int add_many_to_attr_set(struct attribute_set *s,
981 struct attribute **attr,
982 unsigned int count)
984 int i, res;
986 for (i = 0; i < count; i++) {
987 res = add_to_attr_set(s, attr[i]);
988 if (res)
989 return res;
992 return 0;
995 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
997 sysfs_remove_group(kobj, &s->group);
998 destroy_attr_set(s);
1001 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1002 sysfs_create_group(_kobj, &_attr_set->group)
1004 static int parse_strtoul(const char *buf,
1005 unsigned long max, unsigned long *value)
1007 char *endp;
1009 while (*buf && isspace(*buf))
1010 buf++;
1011 *value = simple_strtoul(buf, &endp, 0);
1012 while (*endp && isspace(*endp))
1013 endp++;
1014 if (*endp || *value > max)
1015 return -EINVAL;
1017 return 0;
1020 static void tpacpi_disable_brightness_delay(void)
1022 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1023 printk(TPACPI_NOTICE
1024 "ACPI backlight control delay disabled\n");
1027 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
1029 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1030 union acpi_object *obj;
1031 int rc;
1033 if (ACPI_SUCCESS(acpi_evaluate_object(handle, NULL, NULL, &buffer))) {
1034 obj = (union acpi_object *)buffer.pointer;
1035 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
1036 printk(TPACPI_ERR "Unknown _BCL data, "
1037 "please report this to %s\n", TPACPI_MAIL);
1038 rc = 0;
1039 } else {
1040 rc = obj->package.count;
1042 } else {
1043 return 0;
1046 kfree(buffer.pointer);
1047 return rc;
1050 static acpi_status __init tpacpi_acpi_walk_find_bcl(acpi_handle handle,
1051 u32 lvl, void *context, void **rv)
1053 char name[ACPI_PATH_SEGMENT_LENGTH];
1054 struct acpi_buffer buffer = { sizeof(name), &name };
1056 if (ACPI_SUCCESS(acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer)) &&
1057 !strncmp("_BCL", name, sizeof(name) - 1)) {
1058 BUG_ON(!rv || !*rv);
1059 **(int **)rv = tpacpi_query_bcl_levels(handle);
1060 return AE_CTRL_TERMINATE;
1061 } else {
1062 return AE_OK;
1067 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
1069 static int __init tpacpi_check_std_acpi_brightness_support(void)
1071 int status;
1072 int bcl_levels = 0;
1073 void *bcl_ptr = &bcl_levels;
1075 if (!vid_handle) {
1076 TPACPI_ACPIHANDLE_INIT(vid);
1078 if (!vid_handle)
1079 return 0;
1082 * Search for a _BCL method, and execute it. This is safe on all
1083 * ThinkPads, and as a side-effect, _BCL will place a Lenovo Vista
1084 * BIOS in ACPI backlight control mode. We do NOT have to care
1085 * about calling the _BCL method in an enabled video device, any
1086 * will do for our purposes.
1089 status = acpi_walk_namespace(ACPI_TYPE_METHOD, vid_handle, 3,
1090 tpacpi_acpi_walk_find_bcl, NULL,
1091 &bcl_ptr);
1093 if (ACPI_SUCCESS(status) && bcl_levels > 2) {
1094 tp_features.bright_acpimode = 1;
1095 return (bcl_levels - 2);
1098 return 0;
1101 static void printk_deprecated_attribute(const char * const what,
1102 const char * const details)
1104 tpacpi_log_usertask("deprecated sysfs attribute");
1105 printk(TPACPI_WARN "WARNING: sysfs attribute %s is deprecated and "
1106 "will be removed. %s\n",
1107 what, details);
1110 /*************************************************************************
1111 * rfkill and radio control support helpers
1115 * ThinkPad-ACPI firmware handling model:
1117 * WLSW (master wireless switch) is event-driven, and is common to all
1118 * firmware-controlled radios. It cannot be controlled, just monitored,
1119 * as expected. It overrides all radio state in firmware
1121 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1122 * (TODO: verify how WLSW interacts with the returned radio state).
1124 * The only time there are shadow radio state changes, is when
1125 * masked-off hotkeys are used.
1129 * Internal driver API for radio state:
1131 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1132 * bool: true means radio blocked (off)
1134 enum tpacpi_rfkill_state {
1135 TPACPI_RFK_RADIO_OFF = 0,
1136 TPACPI_RFK_RADIO_ON
1139 /* rfkill switches */
1140 enum tpacpi_rfk_id {
1141 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1142 TPACPI_RFK_WWAN_SW_ID,
1143 TPACPI_RFK_UWB_SW_ID,
1144 TPACPI_RFK_SW_MAX
1147 static const char *tpacpi_rfkill_names[] = {
1148 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1149 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1150 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1151 [TPACPI_RFK_SW_MAX] = NULL
1154 /* ThinkPad-ACPI rfkill subdriver */
1155 struct tpacpi_rfk {
1156 struct rfkill *rfkill;
1157 enum tpacpi_rfk_id id;
1158 const struct tpacpi_rfk_ops *ops;
1161 struct tpacpi_rfk_ops {
1162 /* firmware interface */
1163 int (*get_status)(void);
1164 int (*set_status)(const enum tpacpi_rfkill_state);
1167 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1169 /* Query FW and update rfkill sw state for a given rfkill switch */
1170 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1172 int status;
1174 if (!tp_rfk)
1175 return -ENODEV;
1177 status = (tp_rfk->ops->get_status)();
1178 if (status < 0)
1179 return status;
1181 rfkill_set_sw_state(tp_rfk->rfkill,
1182 (status == TPACPI_RFK_RADIO_OFF));
1184 return status;
1187 /* Query FW and update rfkill sw state for all rfkill switches */
1188 static void tpacpi_rfk_update_swstate_all(void)
1190 unsigned int i;
1192 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1193 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1197 * Sync the HW-blocking state of all rfkill switches,
1198 * do notice it causes the rfkill core to schedule uevents
1200 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1202 unsigned int i;
1203 struct tpacpi_rfk *tp_rfk;
1205 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1206 tp_rfk = tpacpi_rfkill_switches[i];
1207 if (tp_rfk) {
1208 if (rfkill_set_hw_state(tp_rfk->rfkill,
1209 blocked)) {
1210 /* ignore -- we track sw block */
1216 /* Call to get the WLSW state from the firmware */
1217 static int hotkey_get_wlsw(void);
1219 /* Call to query WLSW state and update all rfkill switches */
1220 static bool tpacpi_rfk_check_hwblock_state(void)
1222 int res = hotkey_get_wlsw();
1223 int hw_blocked;
1225 /* When unknown or unsupported, we have to assume it is unblocked */
1226 if (res < 0)
1227 return false;
1229 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1230 tpacpi_rfk_update_hwblock_state(hw_blocked);
1232 return hw_blocked;
1235 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1237 struct tpacpi_rfk *tp_rfk = data;
1238 int res;
1240 dbg_printk(TPACPI_DBG_RFKILL,
1241 "request to change radio state to %s\n",
1242 blocked ? "blocked" : "unblocked");
1244 /* try to set radio state */
1245 res = (tp_rfk->ops->set_status)(blocked ?
1246 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1248 /* and update the rfkill core with whatever the FW really did */
1249 tpacpi_rfk_update_swstate(tp_rfk);
1251 return (res < 0) ? res : 0;
1254 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1255 .set_block = tpacpi_rfk_hook_set_block,
1258 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1259 const struct tpacpi_rfk_ops *tp_rfkops,
1260 const enum rfkill_type rfktype,
1261 const char *name,
1262 const bool set_default)
1264 struct tpacpi_rfk *atp_rfk;
1265 int res;
1266 bool sw_state = false;
1267 int sw_status;
1269 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1271 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1272 if (atp_rfk)
1273 atp_rfk->rfkill = rfkill_alloc(name,
1274 &tpacpi_pdev->dev,
1275 rfktype,
1276 &tpacpi_rfk_rfkill_ops,
1277 atp_rfk);
1278 if (!atp_rfk || !atp_rfk->rfkill) {
1279 printk(TPACPI_ERR
1280 "failed to allocate memory for rfkill class\n");
1281 kfree(atp_rfk);
1282 return -ENOMEM;
1285 atp_rfk->id = id;
1286 atp_rfk->ops = tp_rfkops;
1288 sw_status = (tp_rfkops->get_status)();
1289 if (sw_status < 0) {
1290 printk(TPACPI_ERR
1291 "failed to read initial state for %s, error %d\n",
1292 name, sw_status);
1293 } else {
1294 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1295 if (set_default) {
1296 /* try to keep the initial state, since we ask the
1297 * firmware to preserve it across S5 in NVRAM */
1298 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1301 rfkill_set_hw_state(atp_rfk->rfkill, tpacpi_rfk_check_hwblock_state());
1303 res = rfkill_register(atp_rfk->rfkill);
1304 if (res < 0) {
1305 printk(TPACPI_ERR
1306 "failed to register %s rfkill switch: %d\n",
1307 name, res);
1308 rfkill_destroy(atp_rfk->rfkill);
1309 kfree(atp_rfk);
1310 return res;
1313 tpacpi_rfkill_switches[id] = atp_rfk;
1314 return 0;
1317 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1319 struct tpacpi_rfk *tp_rfk;
1321 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1323 tp_rfk = tpacpi_rfkill_switches[id];
1324 if (tp_rfk) {
1325 rfkill_unregister(tp_rfk->rfkill);
1326 rfkill_destroy(tp_rfk->rfkill);
1327 tpacpi_rfkill_switches[id] = NULL;
1328 kfree(tp_rfk);
1332 static void printk_deprecated_rfkill_attribute(const char * const what)
1334 printk_deprecated_attribute(what,
1335 "Please switch to generic rfkill before year 2010");
1338 /* sysfs <radio> enable ------------------------------------------------ */
1339 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1340 struct device_attribute *attr,
1341 char *buf)
1343 int status;
1345 printk_deprecated_rfkill_attribute(attr->attr.name);
1347 /* This is in the ABI... */
1348 if (tpacpi_rfk_check_hwblock_state()) {
1349 status = TPACPI_RFK_RADIO_OFF;
1350 } else {
1351 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1352 if (status < 0)
1353 return status;
1356 return snprintf(buf, PAGE_SIZE, "%d\n",
1357 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1360 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1361 struct device_attribute *attr,
1362 const char *buf, size_t count)
1364 unsigned long t;
1365 int res;
1367 printk_deprecated_rfkill_attribute(attr->attr.name);
1369 if (parse_strtoul(buf, 1, &t))
1370 return -EINVAL;
1372 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1374 /* This is in the ABI... */
1375 if (tpacpi_rfk_check_hwblock_state() && !!t)
1376 return -EPERM;
1378 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1379 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1380 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1382 return (res < 0) ? res : count;
1385 /* procfs -------------------------------------------------------------- */
1386 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, char *p)
1388 int len = 0;
1390 if (id >= TPACPI_RFK_SW_MAX)
1391 len += sprintf(p + len, "status:\t\tnot supported\n");
1392 else {
1393 int status;
1395 /* This is in the ABI... */
1396 if (tpacpi_rfk_check_hwblock_state()) {
1397 status = TPACPI_RFK_RADIO_OFF;
1398 } else {
1399 status = tpacpi_rfk_update_swstate(
1400 tpacpi_rfkill_switches[id]);
1401 if (status < 0)
1402 return status;
1405 len += sprintf(p + len, "status:\t\t%s\n",
1406 (status == TPACPI_RFK_RADIO_ON) ?
1407 "enabled" : "disabled");
1408 len += sprintf(p + len, "commands:\tenable, disable\n");
1411 return len;
1414 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1416 char *cmd;
1417 int status = -1;
1418 int res = 0;
1420 if (id >= TPACPI_RFK_SW_MAX)
1421 return -ENODEV;
1423 while ((cmd = next_cmd(&buf))) {
1424 if (strlencmp(cmd, "enable") == 0)
1425 status = TPACPI_RFK_RADIO_ON;
1426 else if (strlencmp(cmd, "disable") == 0)
1427 status = TPACPI_RFK_RADIO_OFF;
1428 else
1429 return -EINVAL;
1432 if (status != -1) {
1433 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1434 (status == TPACPI_RFK_RADIO_ON) ?
1435 "enable" : "disable",
1436 tpacpi_rfkill_names[id]);
1437 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1438 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1441 return res;
1444 /*************************************************************************
1445 * thinkpad-acpi driver attributes
1448 /* interface_version --------------------------------------------------- */
1449 static ssize_t tpacpi_driver_interface_version_show(
1450 struct device_driver *drv,
1451 char *buf)
1453 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1456 static DRIVER_ATTR(interface_version, S_IRUGO,
1457 tpacpi_driver_interface_version_show, NULL);
1459 /* debug_level --------------------------------------------------------- */
1460 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1461 char *buf)
1463 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1466 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1467 const char *buf, size_t count)
1469 unsigned long t;
1471 if (parse_strtoul(buf, 0xffff, &t))
1472 return -EINVAL;
1474 dbg_level = t;
1476 return count;
1479 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1480 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1482 /* version ------------------------------------------------------------- */
1483 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1484 char *buf)
1486 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1487 TPACPI_DESC, TPACPI_VERSION);
1490 static DRIVER_ATTR(version, S_IRUGO,
1491 tpacpi_driver_version_show, NULL);
1493 /* --------------------------------------------------------------------- */
1495 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1497 /* wlsw_emulstate ------------------------------------------------------ */
1498 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1499 char *buf)
1501 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1504 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1505 const char *buf, size_t count)
1507 unsigned long t;
1509 if (parse_strtoul(buf, 1, &t))
1510 return -EINVAL;
1512 if (tpacpi_wlsw_emulstate != !!t) {
1513 tpacpi_wlsw_emulstate = !!t;
1514 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1517 return count;
1520 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1521 tpacpi_driver_wlsw_emulstate_show,
1522 tpacpi_driver_wlsw_emulstate_store);
1524 /* bluetooth_emulstate ------------------------------------------------- */
1525 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1526 struct device_driver *drv,
1527 char *buf)
1529 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1532 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1533 struct device_driver *drv,
1534 const char *buf, size_t count)
1536 unsigned long t;
1538 if (parse_strtoul(buf, 1, &t))
1539 return -EINVAL;
1541 tpacpi_bluetooth_emulstate = !!t;
1543 return count;
1546 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1547 tpacpi_driver_bluetooth_emulstate_show,
1548 tpacpi_driver_bluetooth_emulstate_store);
1550 /* wwan_emulstate ------------------------------------------------- */
1551 static ssize_t tpacpi_driver_wwan_emulstate_show(
1552 struct device_driver *drv,
1553 char *buf)
1555 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1558 static ssize_t tpacpi_driver_wwan_emulstate_store(
1559 struct device_driver *drv,
1560 const char *buf, size_t count)
1562 unsigned long t;
1564 if (parse_strtoul(buf, 1, &t))
1565 return -EINVAL;
1567 tpacpi_wwan_emulstate = !!t;
1569 return count;
1572 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1573 tpacpi_driver_wwan_emulstate_show,
1574 tpacpi_driver_wwan_emulstate_store);
1576 /* uwb_emulstate ------------------------------------------------- */
1577 static ssize_t tpacpi_driver_uwb_emulstate_show(
1578 struct device_driver *drv,
1579 char *buf)
1581 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1584 static ssize_t tpacpi_driver_uwb_emulstate_store(
1585 struct device_driver *drv,
1586 const char *buf, size_t count)
1588 unsigned long t;
1590 if (parse_strtoul(buf, 1, &t))
1591 return -EINVAL;
1593 tpacpi_uwb_emulstate = !!t;
1595 return count;
1598 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1599 tpacpi_driver_uwb_emulstate_show,
1600 tpacpi_driver_uwb_emulstate_store);
1601 #endif
1603 /* --------------------------------------------------------------------- */
1605 static struct driver_attribute *tpacpi_driver_attributes[] = {
1606 &driver_attr_debug_level, &driver_attr_version,
1607 &driver_attr_interface_version,
1610 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1612 int i, res;
1614 i = 0;
1615 res = 0;
1616 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1617 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1618 i++;
1621 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1622 if (!res && dbg_wlswemul)
1623 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1624 if (!res && dbg_bluetoothemul)
1625 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1626 if (!res && dbg_wwanemul)
1627 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1628 if (!res && dbg_uwbemul)
1629 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1630 #endif
1632 return res;
1635 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1637 int i;
1639 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1640 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1642 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1643 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1644 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1645 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1646 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1647 #endif
1650 /*************************************************************************
1651 * Firmware Data
1655 * Table of recommended minimum BIOS versions
1657 * Reasons for listing:
1658 * 1. Stable BIOS, listed because the unknown ammount of
1659 * bugs and bad ACPI behaviour on older versions
1661 * 2. BIOS or EC fw with known bugs that trigger on Linux
1663 * 3. BIOS with known reduced functionality in older versions
1665 * We recommend the latest BIOS and EC version.
1666 * We only support the latest BIOS and EC fw version as a rule.
1668 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1669 * Information from users in ThinkWiki
1671 * WARNING: we use this table also to detect that the machine is
1672 * a ThinkPad in some cases, so don't remove entries lightly.
1675 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1676 { .vendor = (__v), \
1677 .bios = TPID(__id1, __id2), \
1678 .ec = TPACPI_MATCH_ANY, \
1679 .quirks = TPACPI_MATCH_ANY << 16 \
1680 | (__bv1) << 8 | (__bv2) }
1682 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1683 __eid, __ev1, __ev2) \
1684 { .vendor = (__v), \
1685 .bios = TPID(__bid1, __bid2), \
1686 .ec = __eid, \
1687 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1688 | (__bv1) << 8 | (__bv2) }
1690 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1691 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1693 /* Outdated IBM BIOSes often lack the EC id string */
1694 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1695 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1696 __bv1, __bv2, TPID(__id1, __id2), \
1697 __ev1, __ev2), \
1698 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1699 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1700 __ev1, __ev2)
1702 /* Outdated IBM BIOSes often lack the EC id string */
1703 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1704 __eid1, __eid2, __ev1, __ev2) \
1705 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1706 __bv1, __bv2, TPID(__eid1, __eid2), \
1707 __ev1, __ev2), \
1708 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1709 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1710 __ev1, __ev2)
1712 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1713 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1715 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1716 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1717 __bv1, __bv2, TPID(__id1, __id2), \
1718 __ev1, __ev2)
1720 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1721 __eid1, __eid2, __ev1, __ev2) \
1722 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1723 __bv1, __bv2, TPID(__eid1, __eid2), \
1724 __ev1, __ev2)
1726 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1727 /* Numeric models ------------------ */
1728 /* FW MODEL BIOS VERS */
1729 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1730 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1731 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1732 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1733 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1734 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1735 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1736 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1737 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1739 /* A-series ------------------------- */
1740 /* FW MODEL BIOS VERS EC VERS */
1741 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1742 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1743 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1744 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1745 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1746 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1747 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1748 TPV_QI0('1', '3', '2', '0'), /* A22m */
1749 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1750 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1751 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1753 /* G-series ------------------------- */
1754 /* FW MODEL BIOS VERS */
1755 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1756 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1758 /* R-series, T-series --------------- */
1759 /* FW MODEL BIOS VERS EC VERS */
1760 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1761 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1762 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1763 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1764 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1765 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1766 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1767 T40/p, T41/p, T42/p (1) */
1768 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1769 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1770 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1771 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1773 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1774 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1775 TPV_QI0('1', '6', '3', '2'), /* T22 */
1776 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1777 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1778 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1780 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1781 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1782 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1784 /* BIOS FW BIOS VERS EC FW EC VERS */
1785 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1786 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1788 /* X-series ------------------------- */
1789 /* FW MODEL BIOS VERS EC VERS */
1790 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1791 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1792 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1793 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1794 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1795 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1796 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1798 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1799 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1801 /* (0) - older versions lack DMI EC fw string and functionality */
1802 /* (1) - older versions known to lack functionality */
1805 #undef TPV_QL1
1806 #undef TPV_QL0
1807 #undef TPV_QI2
1808 #undef TPV_QI1
1809 #undef TPV_QI0
1810 #undef TPV_Q_X
1811 #undef TPV_Q
1813 static void __init tpacpi_check_outdated_fw(void)
1815 unsigned long fwvers;
1816 u16 ec_version, bios_version;
1818 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1819 ARRAY_SIZE(tpacpi_bios_version_qtable));
1821 if (!fwvers)
1822 return;
1824 bios_version = fwvers & 0xffffU;
1825 ec_version = (fwvers >> 16) & 0xffffU;
1827 /* note that unknown versions are set to 0x0000 and we use that */
1828 if ((bios_version > thinkpad_id.bios_release) ||
1829 (ec_version > thinkpad_id.ec_release &&
1830 ec_version != TPACPI_MATCH_ANY)) {
1832 * The changelogs would let us track down the exact
1833 * reason, but it is just too much of a pain to track
1834 * it. We only list BIOSes that are either really
1835 * broken, or really stable to begin with, so it is
1836 * best if the user upgrades the firmware anyway.
1838 printk(TPACPI_WARN
1839 "WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1840 printk(TPACPI_WARN
1841 "WARNING: This firmware may be missing critical bug "
1842 "fixes and/or important features\n");
1846 static bool __init tpacpi_is_fw_known(void)
1848 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1849 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1852 /****************************************************************************
1853 ****************************************************************************
1855 * Subdrivers
1857 ****************************************************************************
1858 ****************************************************************************/
1860 /*************************************************************************
1861 * thinkpad-acpi init subdriver
1864 static int __init thinkpad_acpi_driver_init(struct ibm_init_struct *iibm)
1866 printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
1867 printk(TPACPI_INFO "%s\n", TPACPI_URL);
1869 printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
1870 (thinkpad_id.bios_version_str) ?
1871 thinkpad_id.bios_version_str : "unknown",
1872 (thinkpad_id.ec_version_str) ?
1873 thinkpad_id.ec_version_str : "unknown");
1875 if (thinkpad_id.vendor && thinkpad_id.model_str)
1876 printk(TPACPI_INFO "%s %s, model %s\n",
1877 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
1878 "IBM" : ((thinkpad_id.vendor ==
1879 PCI_VENDOR_ID_LENOVO) ?
1880 "Lenovo" : "Unknown vendor"),
1881 thinkpad_id.model_str,
1882 (thinkpad_id.nummodel_str) ?
1883 thinkpad_id.nummodel_str : "unknown");
1885 tpacpi_check_outdated_fw();
1886 return 0;
1889 static int thinkpad_acpi_driver_read(char *p)
1891 int len = 0;
1893 len += sprintf(p + len, "driver:\t\t%s\n", TPACPI_DESC);
1894 len += sprintf(p + len, "version:\t%s\n", TPACPI_VERSION);
1896 return len;
1899 static struct ibm_struct thinkpad_acpi_driver_data = {
1900 .name = "driver",
1901 .read = thinkpad_acpi_driver_read,
1904 /*************************************************************************
1905 * Hotkey subdriver
1909 * ThinkPad firmware event model
1911 * The ThinkPad firmware has two main event interfaces: normal ACPI
1912 * notifications (which follow the ACPI standard), and a private event
1913 * interface.
1915 * The private event interface also issues events for the hotkeys. As
1916 * the driver gained features, the event handling code ended up being
1917 * built around the hotkey subdriver. This will need to be refactored
1918 * to a more formal event API eventually.
1920 * Some "hotkeys" are actually supposed to be used as event reports,
1921 * such as "brightness has changed", "volume has changed", depending on
1922 * the ThinkPad model and how the firmware is operating.
1924 * Unlike other classes, hotkey-class events have mask/unmask control on
1925 * non-ancient firmware. However, how it behaves changes a lot with the
1926 * firmware model and version.
1929 enum { /* hot key scan codes (derived from ACPI DSDT) */
1930 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1931 TP_ACPI_HOTKEYSCAN_FNF2,
1932 TP_ACPI_HOTKEYSCAN_FNF3,
1933 TP_ACPI_HOTKEYSCAN_FNF4,
1934 TP_ACPI_HOTKEYSCAN_FNF5,
1935 TP_ACPI_HOTKEYSCAN_FNF6,
1936 TP_ACPI_HOTKEYSCAN_FNF7,
1937 TP_ACPI_HOTKEYSCAN_FNF8,
1938 TP_ACPI_HOTKEYSCAN_FNF9,
1939 TP_ACPI_HOTKEYSCAN_FNF10,
1940 TP_ACPI_HOTKEYSCAN_FNF11,
1941 TP_ACPI_HOTKEYSCAN_FNF12,
1942 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1943 TP_ACPI_HOTKEYSCAN_FNINSERT,
1944 TP_ACPI_HOTKEYSCAN_FNDELETE,
1945 TP_ACPI_HOTKEYSCAN_FNHOME,
1946 TP_ACPI_HOTKEYSCAN_FNEND,
1947 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1948 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1949 TP_ACPI_HOTKEYSCAN_FNSPACE,
1950 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1951 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1952 TP_ACPI_HOTKEYSCAN_MUTE,
1953 TP_ACPI_HOTKEYSCAN_THINKPAD,
1956 enum { /* Keys/events available through NVRAM polling */
1957 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1958 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1961 enum { /* Positions of some of the keys in hotkey masks */
1962 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1963 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1964 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1965 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1966 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1967 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1968 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1969 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1970 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1971 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1972 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1975 enum { /* NVRAM to ACPI HKEY group map */
1976 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1977 TP_ACPI_HKEY_ZOOM_MASK |
1978 TP_ACPI_HKEY_DISPSWTCH_MASK |
1979 TP_ACPI_HKEY_HIBERNATE_MASK,
1980 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1981 TP_ACPI_HKEY_BRGHTDWN_MASK,
1982 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1983 TP_ACPI_HKEY_VOLDWN_MASK |
1984 TP_ACPI_HKEY_MUTE_MASK,
1987 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1988 struct tp_nvram_state {
1989 u16 thinkpad_toggle:1;
1990 u16 zoom_toggle:1;
1991 u16 display_toggle:1;
1992 u16 thinklight_toggle:1;
1993 u16 hibernate_toggle:1;
1994 u16 displayexp_toggle:1;
1995 u16 display_state:1;
1996 u16 brightness_toggle:1;
1997 u16 volume_toggle:1;
1998 u16 mute:1;
2000 u8 brightness_level;
2001 u8 volume_level;
2004 /* kthread for the hotkey poller */
2005 static struct task_struct *tpacpi_hotkey_task;
2007 /* Acquired while the poller kthread is running, use to sync start/stop */
2008 static struct mutex hotkey_thread_mutex;
2011 * Acquire mutex to write poller control variables as an
2012 * atomic block.
2014 * Increment hotkey_config_change when changing them if you
2015 * want the kthread to forget old state.
2017 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2019 static struct mutex hotkey_thread_data_mutex;
2020 static unsigned int hotkey_config_change;
2023 * hotkey poller control variables
2025 * Must be atomic or readers will also need to acquire mutex
2027 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2028 * should be used only when the changes need to be taken as
2029 * a block, OR when one needs to force the kthread to forget
2030 * old state.
2032 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2033 static unsigned int hotkey_poll_freq = 10; /* Hz */
2035 #define HOTKEY_CONFIG_CRITICAL_START \
2036 do { \
2037 mutex_lock(&hotkey_thread_data_mutex); \
2038 hotkey_config_change++; \
2039 } while (0);
2040 #define HOTKEY_CONFIG_CRITICAL_END \
2041 mutex_unlock(&hotkey_thread_data_mutex);
2043 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2045 #define hotkey_source_mask 0U
2046 #define HOTKEY_CONFIG_CRITICAL_START
2047 #define HOTKEY_CONFIG_CRITICAL_END
2049 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2051 static struct mutex hotkey_mutex;
2053 static enum { /* Reasons for waking up */
2054 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2055 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2056 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2057 } hotkey_wakeup_reason;
2059 static int hotkey_autosleep_ack;
2061 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2062 static u32 hotkey_all_mask; /* all events supported in fw */
2063 static u32 hotkey_reserved_mask; /* events better left disabled */
2064 static u32 hotkey_driver_mask; /* events needed by the driver */
2065 static u32 hotkey_user_mask; /* events visible to userspace */
2066 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2068 static unsigned int hotkey_report_mode;
2070 static u16 *hotkey_keycode_map;
2072 static struct attribute_set *hotkey_dev_attributes;
2074 static void tpacpi_driver_event(const unsigned int hkey_event);
2075 static void hotkey_driver_event(const unsigned int scancode);
2077 /* HKEY.MHKG() return bits */
2078 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2080 static int hotkey_get_wlsw(void)
2082 int status;
2084 if (!tp_features.hotkey_wlsw)
2085 return -ENODEV;
2087 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2088 if (dbg_wlswemul)
2089 return (tpacpi_wlsw_emulstate) ?
2090 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2091 #endif
2093 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2094 return -EIO;
2096 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2099 static int hotkey_get_tablet_mode(int *status)
2101 int s;
2103 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2104 return -EIO;
2106 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2107 return 0;
2111 * Reads current event mask from firmware, and updates
2112 * hotkey_acpi_mask accordingly. Also resets any bits
2113 * from hotkey_user_mask that are unavailable to be
2114 * delivered (shadow requirement of the userspace ABI).
2116 * Call with hotkey_mutex held
2118 static int hotkey_mask_get(void)
2120 if (tp_features.hotkey_mask) {
2121 u32 m = 0;
2123 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2124 return -EIO;
2126 hotkey_acpi_mask = m;
2127 } else {
2128 /* no mask support doesn't mean no event support... */
2129 hotkey_acpi_mask = hotkey_all_mask;
2132 /* sync userspace-visible mask */
2133 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2135 return 0;
2138 void static hotkey_mask_warn_incomplete_mask(void)
2140 /* log only what the user can fix... */
2141 const u32 wantedmask = hotkey_driver_mask &
2142 ~(hotkey_acpi_mask | hotkey_source_mask) &
2143 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2145 if (wantedmask)
2146 printk(TPACPI_NOTICE
2147 "required events 0x%08x not enabled!\n",
2148 wantedmask);
2152 * Set the firmware mask when supported
2154 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2156 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2158 * Call with hotkey_mutex held
2160 static int hotkey_mask_set(u32 mask)
2162 int i;
2163 int rc = 0;
2165 const u32 fwmask = mask & ~hotkey_source_mask;
2167 if (tp_features.hotkey_mask) {
2168 for (i = 0; i < 32; i++) {
2169 if (!acpi_evalf(hkey_handle,
2170 NULL, "MHKM", "vdd", i + 1,
2171 !!(mask & (1 << i)))) {
2172 rc = -EIO;
2173 break;
2179 * We *must* make an inconditional call to hotkey_mask_get to
2180 * refresh hotkey_acpi_mask and update hotkey_user_mask
2182 * Take the opportunity to also log when we cannot _enable_
2183 * a given event.
2185 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2186 printk(TPACPI_NOTICE
2187 "asked for hotkey mask 0x%08x, but "
2188 "firmware forced it to 0x%08x\n",
2189 fwmask, hotkey_acpi_mask);
2192 hotkey_mask_warn_incomplete_mask();
2194 return rc;
2198 * Sets hotkey_user_mask and tries to set the firmware mask
2200 * Call with hotkey_mutex held
2202 static int hotkey_user_mask_set(const u32 mask)
2204 int rc;
2206 /* Give people a chance to notice they are doing something that
2207 * is bound to go boom on their users sooner or later */
2208 if (!tp_warned.hotkey_mask_ff &&
2209 (mask == 0xffff || mask == 0xffffff ||
2210 mask == 0xffffffff)) {
2211 tp_warned.hotkey_mask_ff = 1;
2212 printk(TPACPI_NOTICE
2213 "setting the hotkey mask to 0x%08x is likely "
2214 "not the best way to go about it\n", mask);
2215 printk(TPACPI_NOTICE
2216 "please consider using the driver defaults, "
2217 "and refer to up-to-date thinkpad-acpi "
2218 "documentation\n");
2221 /* Try to enable what the user asked for, plus whatever we need.
2222 * this syncs everything but won't enable bits in hotkey_user_mask */
2223 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2225 /* Enable the available bits in hotkey_user_mask */
2226 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2228 return rc;
2232 * Sets the driver hotkey mask.
2234 * Can be called even if the hotkey subdriver is inactive
2236 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2238 int rc;
2240 /* Do the right thing if hotkey_init has not been called yet */
2241 if (!tp_features.hotkey) {
2242 hotkey_driver_mask = mask;
2243 return 0;
2246 mutex_lock(&hotkey_mutex);
2248 HOTKEY_CONFIG_CRITICAL_START
2249 hotkey_driver_mask = mask;
2250 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2251 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2252 #endif
2253 HOTKEY_CONFIG_CRITICAL_END
2255 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2256 ~hotkey_source_mask);
2257 mutex_unlock(&hotkey_mutex);
2259 return rc;
2262 static int hotkey_status_get(int *status)
2264 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2265 return -EIO;
2267 return 0;
2270 static int hotkey_status_set(bool enable)
2272 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2273 return -EIO;
2275 return 0;
2278 static void tpacpi_input_send_tabletsw(void)
2280 int state;
2282 if (tp_features.hotkey_tablet &&
2283 !hotkey_get_tablet_mode(&state)) {
2284 mutex_lock(&tpacpi_inputdev_send_mutex);
2286 input_report_switch(tpacpi_inputdev,
2287 SW_TABLET_MODE, !!state);
2288 input_sync(tpacpi_inputdev);
2290 mutex_unlock(&tpacpi_inputdev_send_mutex);
2294 /* Do NOT call without validating scancode first */
2295 static void tpacpi_input_send_key(const unsigned int scancode)
2297 const unsigned int keycode = hotkey_keycode_map[scancode];
2299 if (keycode != KEY_RESERVED) {
2300 mutex_lock(&tpacpi_inputdev_send_mutex);
2302 input_report_key(tpacpi_inputdev, keycode, 1);
2303 if (keycode == KEY_UNKNOWN)
2304 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2305 scancode);
2306 input_sync(tpacpi_inputdev);
2308 input_report_key(tpacpi_inputdev, keycode, 0);
2309 if (keycode == KEY_UNKNOWN)
2310 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2311 scancode);
2312 input_sync(tpacpi_inputdev);
2314 mutex_unlock(&tpacpi_inputdev_send_mutex);
2318 /* Do NOT call without validating scancode first */
2319 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2321 hotkey_driver_event(scancode);
2322 if (hotkey_user_mask & (1 << scancode))
2323 tpacpi_input_send_key(scancode);
2326 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2327 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2329 /* Do NOT call without validating scancode first */
2330 static void tpacpi_hotkey_send_key(unsigned int scancode)
2332 tpacpi_input_send_key_masked(scancode);
2333 if (hotkey_report_mode < 2) {
2334 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2335 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2339 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2341 u8 d;
2343 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2344 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2345 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2346 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2347 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2348 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2350 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2351 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2352 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2354 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2355 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2356 n->displayexp_toggle =
2357 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2359 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2360 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2361 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2362 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2363 n->brightness_toggle =
2364 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2366 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2367 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2368 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2369 >> TP_NVRAM_POS_LEVEL_VOLUME;
2370 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2371 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2375 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2376 struct tp_nvram_state *newn,
2377 const u32 event_mask)
2380 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2381 do { \
2382 if ((event_mask & (1 << __scancode)) && \
2383 oldn->__member != newn->__member) \
2384 tpacpi_hotkey_send_key(__scancode); \
2385 } while (0)
2387 #define TPACPI_MAY_SEND_KEY(__scancode) \
2388 do { \
2389 if (event_mask & (1 << __scancode)) \
2390 tpacpi_hotkey_send_key(__scancode); \
2391 } while (0)
2393 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2394 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2395 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2396 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2398 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2400 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2402 /* handle volume */
2403 if (oldn->volume_toggle != newn->volume_toggle) {
2404 if (oldn->mute != newn->mute) {
2405 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2407 if (oldn->volume_level > newn->volume_level) {
2408 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2409 } else if (oldn->volume_level < newn->volume_level) {
2410 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2411 } else if (oldn->mute == newn->mute) {
2412 /* repeated key presses that didn't change state */
2413 if (newn->mute) {
2414 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2415 } else if (newn->volume_level != 0) {
2416 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2417 } else {
2418 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2423 /* handle brightness */
2424 if (oldn->brightness_toggle != newn->brightness_toggle) {
2425 if (oldn->brightness_level < newn->brightness_level) {
2426 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2427 } else if (oldn->brightness_level > newn->brightness_level) {
2428 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2429 } else {
2430 /* repeated key presses that didn't change state */
2431 if (newn->brightness_level != 0) {
2432 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2433 } else {
2434 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2439 #undef TPACPI_COMPARE_KEY
2440 #undef TPACPI_MAY_SEND_KEY
2444 * Polling driver
2446 * We track all events in hotkey_source_mask all the time, since
2447 * most of them are edge-based. We only issue those requested by
2448 * hotkey_user_mask or hotkey_driver_mask, though.
2450 static int hotkey_kthread(void *data)
2452 struct tp_nvram_state s[2];
2453 u32 poll_mask, event_mask;
2454 unsigned int si, so;
2455 unsigned long t;
2456 unsigned int change_detector, must_reset;
2457 unsigned int poll_freq;
2459 mutex_lock(&hotkey_thread_mutex);
2461 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2462 goto exit;
2464 set_freezable();
2466 so = 0;
2467 si = 1;
2468 t = 0;
2470 /* Initial state for compares */
2471 mutex_lock(&hotkey_thread_data_mutex);
2472 change_detector = hotkey_config_change;
2473 poll_mask = hotkey_source_mask;
2474 event_mask = hotkey_source_mask &
2475 (hotkey_driver_mask | hotkey_user_mask);
2476 poll_freq = hotkey_poll_freq;
2477 mutex_unlock(&hotkey_thread_data_mutex);
2478 hotkey_read_nvram(&s[so], poll_mask);
2480 while (!kthread_should_stop()) {
2481 if (t == 0) {
2482 if (likely(poll_freq))
2483 t = 1000/poll_freq;
2484 else
2485 t = 100; /* should never happen... */
2487 t = msleep_interruptible(t);
2488 if (unlikely(kthread_should_stop()))
2489 break;
2490 must_reset = try_to_freeze();
2491 if (t > 0 && !must_reset)
2492 continue;
2494 mutex_lock(&hotkey_thread_data_mutex);
2495 if (must_reset || hotkey_config_change != change_detector) {
2496 /* forget old state on thaw or config change */
2497 si = so;
2498 t = 0;
2499 change_detector = hotkey_config_change;
2501 poll_mask = hotkey_source_mask;
2502 event_mask = hotkey_source_mask &
2503 (hotkey_driver_mask | hotkey_user_mask);
2504 poll_freq = hotkey_poll_freq;
2505 mutex_unlock(&hotkey_thread_data_mutex);
2507 if (likely(poll_mask)) {
2508 hotkey_read_nvram(&s[si], poll_mask);
2509 if (likely(si != so)) {
2510 hotkey_compare_and_issue_event(&s[so], &s[si],
2511 event_mask);
2515 so = si;
2516 si ^= 1;
2519 exit:
2520 mutex_unlock(&hotkey_thread_mutex);
2521 return 0;
2524 /* call with hotkey_mutex held */
2525 static void hotkey_poll_stop_sync(void)
2527 if (tpacpi_hotkey_task) {
2528 if (frozen(tpacpi_hotkey_task) ||
2529 freezing(tpacpi_hotkey_task))
2530 thaw_process(tpacpi_hotkey_task);
2532 kthread_stop(tpacpi_hotkey_task);
2533 tpacpi_hotkey_task = NULL;
2534 mutex_lock(&hotkey_thread_mutex);
2535 /* at this point, the thread did exit */
2536 mutex_unlock(&hotkey_thread_mutex);
2540 /* call with hotkey_mutex held */
2541 static void hotkey_poll_setup(bool may_warn)
2543 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2544 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2546 if (hotkey_poll_freq > 0 &&
2547 (poll_driver_mask ||
2548 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2549 if (!tpacpi_hotkey_task) {
2550 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2551 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2552 if (IS_ERR(tpacpi_hotkey_task)) {
2553 tpacpi_hotkey_task = NULL;
2554 printk(TPACPI_ERR
2555 "could not create kernel thread "
2556 "for hotkey polling\n");
2559 } else {
2560 hotkey_poll_stop_sync();
2561 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2562 hotkey_poll_freq == 0) {
2563 printk(TPACPI_NOTICE
2564 "hot keys 0x%08x and/or events 0x%08x "
2565 "require polling, which is currently "
2566 "disabled\n",
2567 poll_user_mask, poll_driver_mask);
2572 static void hotkey_poll_setup_safe(bool may_warn)
2574 mutex_lock(&hotkey_mutex);
2575 hotkey_poll_setup(may_warn);
2576 mutex_unlock(&hotkey_mutex);
2579 /* call with hotkey_mutex held */
2580 static void hotkey_poll_set_freq(unsigned int freq)
2582 if (!freq)
2583 hotkey_poll_stop_sync();
2585 hotkey_poll_freq = freq;
2588 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2590 static void hotkey_poll_setup_safe(bool __unused)
2594 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2596 static int hotkey_inputdev_open(struct input_dev *dev)
2598 switch (tpacpi_lifecycle) {
2599 case TPACPI_LIFE_INIT:
2601 * hotkey_init will call hotkey_poll_setup_safe
2602 * at the appropriate moment
2604 return 0;
2605 case TPACPI_LIFE_EXITING:
2606 return -EBUSY;
2607 case TPACPI_LIFE_RUNNING:
2608 hotkey_poll_setup_safe(false);
2609 return 0;
2612 /* Should only happen if tpacpi_lifecycle is corrupt */
2613 BUG();
2614 return -EBUSY;
2617 static void hotkey_inputdev_close(struct input_dev *dev)
2619 /* disable hotkey polling when possible */
2620 if (tpacpi_lifecycle == TPACPI_LIFE_RUNNING &&
2621 !(hotkey_source_mask & hotkey_driver_mask))
2622 hotkey_poll_setup_safe(false);
2625 /* sysfs hotkey enable ------------------------------------------------- */
2626 static ssize_t hotkey_enable_show(struct device *dev,
2627 struct device_attribute *attr,
2628 char *buf)
2630 int res, status;
2632 printk_deprecated_attribute("hotkey_enable",
2633 "Hotkey reporting is always enabled");
2635 res = hotkey_status_get(&status);
2636 if (res)
2637 return res;
2639 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2642 static ssize_t hotkey_enable_store(struct device *dev,
2643 struct device_attribute *attr,
2644 const char *buf, size_t count)
2646 unsigned long t;
2648 printk_deprecated_attribute("hotkey_enable",
2649 "Hotkeys can be disabled through hotkey_mask");
2651 if (parse_strtoul(buf, 1, &t))
2652 return -EINVAL;
2654 if (t == 0)
2655 return -EPERM;
2657 return count;
2660 static struct device_attribute dev_attr_hotkey_enable =
2661 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2662 hotkey_enable_show, hotkey_enable_store);
2664 /* sysfs hotkey mask --------------------------------------------------- */
2665 static ssize_t hotkey_mask_show(struct device *dev,
2666 struct device_attribute *attr,
2667 char *buf)
2669 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2672 static ssize_t hotkey_mask_store(struct device *dev,
2673 struct device_attribute *attr,
2674 const char *buf, size_t count)
2676 unsigned long t;
2677 int res;
2679 if (parse_strtoul(buf, 0xffffffffUL, &t))
2680 return -EINVAL;
2682 if (mutex_lock_killable(&hotkey_mutex))
2683 return -ERESTARTSYS;
2685 res = hotkey_user_mask_set(t);
2687 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2688 hotkey_poll_setup(true);
2689 #endif
2691 mutex_unlock(&hotkey_mutex);
2693 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2695 return (res) ? res : count;
2698 static struct device_attribute dev_attr_hotkey_mask =
2699 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2700 hotkey_mask_show, hotkey_mask_store);
2702 /* sysfs hotkey bios_enabled ------------------------------------------- */
2703 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2704 struct device_attribute *attr,
2705 char *buf)
2707 return sprintf(buf, "0\n");
2710 static struct device_attribute dev_attr_hotkey_bios_enabled =
2711 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2713 /* sysfs hotkey bios_mask ---------------------------------------------- */
2714 static ssize_t hotkey_bios_mask_show(struct device *dev,
2715 struct device_attribute *attr,
2716 char *buf)
2718 printk_deprecated_attribute("hotkey_bios_mask",
2719 "This attribute is useless.");
2720 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2723 static struct device_attribute dev_attr_hotkey_bios_mask =
2724 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2726 /* sysfs hotkey all_mask ----------------------------------------------- */
2727 static ssize_t hotkey_all_mask_show(struct device *dev,
2728 struct device_attribute *attr,
2729 char *buf)
2731 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2732 hotkey_all_mask | hotkey_source_mask);
2735 static struct device_attribute dev_attr_hotkey_all_mask =
2736 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2738 /* sysfs hotkey recommended_mask --------------------------------------- */
2739 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2740 struct device_attribute *attr,
2741 char *buf)
2743 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2744 (hotkey_all_mask | hotkey_source_mask)
2745 & ~hotkey_reserved_mask);
2748 static struct device_attribute dev_attr_hotkey_recommended_mask =
2749 __ATTR(hotkey_recommended_mask, S_IRUGO,
2750 hotkey_recommended_mask_show, NULL);
2752 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2754 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2755 static ssize_t hotkey_source_mask_show(struct device *dev,
2756 struct device_attribute *attr,
2757 char *buf)
2759 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2762 static ssize_t hotkey_source_mask_store(struct device *dev,
2763 struct device_attribute *attr,
2764 const char *buf, size_t count)
2766 unsigned long t;
2767 u32 r_ev;
2768 int rc;
2770 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2771 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2772 return -EINVAL;
2774 if (mutex_lock_killable(&hotkey_mutex))
2775 return -ERESTARTSYS;
2777 HOTKEY_CONFIG_CRITICAL_START
2778 hotkey_source_mask = t;
2779 HOTKEY_CONFIG_CRITICAL_END
2781 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2782 ~hotkey_source_mask);
2783 hotkey_poll_setup(true);
2785 /* check if events needed by the driver got disabled */
2786 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2787 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2789 mutex_unlock(&hotkey_mutex);
2791 if (rc < 0)
2792 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2793 "firmware event mask!\n");
2795 if (r_ev)
2796 printk(TPACPI_NOTICE "hotkey_source_mask: "
2797 "some important events were disabled: "
2798 "0x%04x\n", r_ev);
2800 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2802 return (rc < 0) ? rc : count;
2805 static struct device_attribute dev_attr_hotkey_source_mask =
2806 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2807 hotkey_source_mask_show, hotkey_source_mask_store);
2809 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2810 static ssize_t hotkey_poll_freq_show(struct device *dev,
2811 struct device_attribute *attr,
2812 char *buf)
2814 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2817 static ssize_t hotkey_poll_freq_store(struct device *dev,
2818 struct device_attribute *attr,
2819 const char *buf, size_t count)
2821 unsigned long t;
2823 if (parse_strtoul(buf, 25, &t))
2824 return -EINVAL;
2826 if (mutex_lock_killable(&hotkey_mutex))
2827 return -ERESTARTSYS;
2829 hotkey_poll_set_freq(t);
2830 hotkey_poll_setup(true);
2832 mutex_unlock(&hotkey_mutex);
2834 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2836 return count;
2839 static struct device_attribute dev_attr_hotkey_poll_freq =
2840 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2841 hotkey_poll_freq_show, hotkey_poll_freq_store);
2843 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2845 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2846 static ssize_t hotkey_radio_sw_show(struct device *dev,
2847 struct device_attribute *attr,
2848 char *buf)
2850 int res;
2851 res = hotkey_get_wlsw();
2852 if (res < 0)
2853 return res;
2855 /* Opportunistic update */
2856 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2858 return snprintf(buf, PAGE_SIZE, "%d\n",
2859 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2862 static struct device_attribute dev_attr_hotkey_radio_sw =
2863 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2865 static void hotkey_radio_sw_notify_change(void)
2867 if (tp_features.hotkey_wlsw)
2868 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2869 "hotkey_radio_sw");
2872 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2873 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2874 struct device_attribute *attr,
2875 char *buf)
2877 int res, s;
2878 res = hotkey_get_tablet_mode(&s);
2879 if (res < 0)
2880 return res;
2882 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2885 static struct device_attribute dev_attr_hotkey_tablet_mode =
2886 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2888 static void hotkey_tablet_mode_notify_change(void)
2890 if (tp_features.hotkey_tablet)
2891 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2892 "hotkey_tablet_mode");
2895 /* sysfs hotkey report_mode -------------------------------------------- */
2896 static ssize_t hotkey_report_mode_show(struct device *dev,
2897 struct device_attribute *attr,
2898 char *buf)
2900 return snprintf(buf, PAGE_SIZE, "%d\n",
2901 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2904 static struct device_attribute dev_attr_hotkey_report_mode =
2905 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2907 /* sysfs wakeup reason (pollable) -------------------------------------- */
2908 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2909 struct device_attribute *attr,
2910 char *buf)
2912 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2915 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2916 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2918 static void hotkey_wakeup_reason_notify_change(void)
2920 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2921 "wakeup_reason");
2924 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2925 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2926 struct device_attribute *attr,
2927 char *buf)
2929 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2932 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2933 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2934 hotkey_wakeup_hotunplug_complete_show, NULL);
2936 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2938 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2939 "wakeup_hotunplug_complete");
2942 /* --------------------------------------------------------------------- */
2944 static struct attribute *hotkey_attributes[] __initdata = {
2945 &dev_attr_hotkey_enable.attr,
2946 &dev_attr_hotkey_bios_enabled.attr,
2947 &dev_attr_hotkey_bios_mask.attr,
2948 &dev_attr_hotkey_report_mode.attr,
2949 &dev_attr_hotkey_wakeup_reason.attr,
2950 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2951 &dev_attr_hotkey_mask.attr,
2952 &dev_attr_hotkey_all_mask.attr,
2953 &dev_attr_hotkey_recommended_mask.attr,
2954 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2955 &dev_attr_hotkey_source_mask.attr,
2956 &dev_attr_hotkey_poll_freq.attr,
2957 #endif
2961 * Sync both the hw and sw blocking state of all switches
2963 static void tpacpi_send_radiosw_update(void)
2965 int wlsw;
2968 * We must sync all rfkill controllers *before* issuing any
2969 * rfkill input events, or we will race the rfkill core input
2970 * handler.
2972 * tpacpi_inputdev_send_mutex works as a syncronization point
2973 * for the above.
2975 * We optimize to avoid numerous calls to hotkey_get_wlsw.
2978 wlsw = hotkey_get_wlsw();
2980 /* Sync hw blocking state first if it is hw-blocked */
2981 if (wlsw == TPACPI_RFK_RADIO_OFF)
2982 tpacpi_rfk_update_hwblock_state(true);
2984 /* Sync sw blocking state */
2985 tpacpi_rfk_update_swstate_all();
2987 /* Sync hw blocking state last if it is hw-unblocked */
2988 if (wlsw == TPACPI_RFK_RADIO_ON)
2989 tpacpi_rfk_update_hwblock_state(false);
2991 /* Issue rfkill input event for WLSW switch */
2992 if (!(wlsw < 0)) {
2993 mutex_lock(&tpacpi_inputdev_send_mutex);
2995 input_report_switch(tpacpi_inputdev,
2996 SW_RFKILL_ALL, (wlsw > 0));
2997 input_sync(tpacpi_inputdev);
2999 mutex_unlock(&tpacpi_inputdev_send_mutex);
3003 * this can be unconditional, as we will poll state again
3004 * if userspace uses the notify to read data
3006 hotkey_radio_sw_notify_change();
3009 static void hotkey_exit(void)
3011 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3012 mutex_lock(&hotkey_mutex);
3013 hotkey_poll_stop_sync();
3014 mutex_unlock(&hotkey_mutex);
3015 #endif
3017 if (hotkey_dev_attributes)
3018 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3020 kfree(hotkey_keycode_map);
3022 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3023 "restoring original HKEY status and mask\n");
3024 /* yes, there is a bitwise or below, we want the
3025 * functions to be called even if one of them fail */
3026 if (((tp_features.hotkey_mask &&
3027 hotkey_mask_set(hotkey_orig_mask)) |
3028 hotkey_status_set(false)) != 0)
3029 printk(TPACPI_ERR
3030 "failed to restore hot key mask "
3031 "to BIOS defaults\n");
3034 static void __init hotkey_unmap(const unsigned int scancode)
3036 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3037 clear_bit(hotkey_keycode_map[scancode],
3038 tpacpi_inputdev->keybit);
3039 hotkey_keycode_map[scancode] = KEY_RESERVED;
3044 * HKEY quirks:
3045 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3048 #define TPACPI_HK_Q_INIMASK 0x0001
3050 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3051 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3052 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3053 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3054 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3055 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3056 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3057 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3058 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3059 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3060 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3061 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3062 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3063 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3064 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3065 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3066 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3067 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3068 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3069 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3072 static int __init hotkey_init(struct ibm_init_struct *iibm)
3074 /* Requirements for changing the default keymaps:
3076 * 1. Many of the keys are mapped to KEY_RESERVED for very
3077 * good reasons. Do not change them unless you have deep
3078 * knowledge on the IBM and Lenovo ThinkPad firmware for
3079 * the various ThinkPad models. The driver behaves
3080 * differently for KEY_RESERVED: such keys have their
3081 * hot key mask *unset* in mask_recommended, and also
3082 * in the initial hot key mask programmed into the
3083 * firmware at driver load time, which means the firm-
3084 * ware may react very differently if you change them to
3085 * something else;
3087 * 2. You must be subscribed to the linux-thinkpad and
3088 * ibm-acpi-devel mailing lists, and you should read the
3089 * list archives since 2007 if you want to change the
3090 * keymaps. This requirement exists so that you will
3091 * know the past history of problems with the thinkpad-
3092 * acpi driver keymaps, and also that you will be
3093 * listening to any bug reports;
3095 * 3. Do not send thinkpad-acpi specific patches directly to
3096 * for merging, *ever*. Send them to the linux-acpi
3097 * mailinglist for comments. Merging is to be done only
3098 * through acpi-test and the ACPI maintainer.
3100 * If the above is too much to ask, don't change the keymap.
3101 * Ask the thinkpad-acpi maintainer to do it, instead.
3103 static u16 ibm_keycode_map[] __initdata = {
3104 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3105 KEY_FN_F1, KEY_FN_F2, KEY_COFFEE, KEY_SLEEP,
3106 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3107 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3109 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3110 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3111 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3112 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3114 /* brightness: firmware always reacts to them */
3115 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3116 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3118 /* Thinklight: firmware always react to it */
3119 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3121 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3122 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3124 /* Volume: firmware always react to it and reprograms
3125 * the built-in *extra* mixer. Never map it to control
3126 * another mixer by default. */
3127 KEY_RESERVED, /* 0x14: VOLUME UP */
3128 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3129 KEY_RESERVED, /* 0x16: MUTE */
3131 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3133 /* (assignments unknown, please report if found) */
3134 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3135 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3137 static u16 lenovo_keycode_map[] __initdata = {
3138 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3139 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3140 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3141 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3143 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3144 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3145 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3146 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3148 /* These should be enabled --only-- when ACPI video
3149 * is disabled (i.e. in "vendor" mode), and are handled
3150 * in a special way by the init code */
3151 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3152 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3154 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3156 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3157 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3159 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3160 * react to it and reprograms the built-in *extra* mixer.
3161 * Never map it to control another mixer by default.
3163 * T60?, T61, R60?, R61: firmware and EC tries to send
3164 * these over the regular keyboard, so these are no-ops,
3165 * but there are still weird bugs re. MUTE, so do not
3166 * change unless you get test reports from all Lenovo
3167 * models. May cause the BIOS to interfere with the
3168 * HDA mixer.
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,
3181 #define TPACPI_HOTKEY_MAP_LEN ARRAY_SIZE(ibm_keycode_map)
3182 #define TPACPI_HOTKEY_MAP_SIZE sizeof(ibm_keycode_map)
3183 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(ibm_keycode_map[0])
3185 int res, i;
3186 int status;
3187 int hkeyv;
3189 unsigned long quirks;
3191 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3192 "initializing hotkey subdriver\n");
3194 BUG_ON(!tpacpi_inputdev);
3195 BUG_ON(tpacpi_inputdev->open != NULL ||
3196 tpacpi_inputdev->close != NULL);
3198 TPACPI_ACPIHANDLE_INIT(hkey);
3199 mutex_init(&hotkey_mutex);
3201 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3202 mutex_init(&hotkey_thread_mutex);
3203 mutex_init(&hotkey_thread_data_mutex);
3204 #endif
3206 /* hotkey not supported on 570 */
3207 tp_features.hotkey = hkey_handle != NULL;
3209 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3210 "hotkeys are %s\n",
3211 str_supported(tp_features.hotkey));
3213 if (!tp_features.hotkey)
3214 return 1;
3216 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3217 ARRAY_SIZE(tpacpi_hotkey_qtable));
3219 tpacpi_disable_brightness_delay();
3221 /* MUST have enough space for all attributes to be added to
3222 * hotkey_dev_attributes */
3223 hotkey_dev_attributes = create_attr_set(
3224 ARRAY_SIZE(hotkey_attributes) + 2,
3225 NULL);
3226 if (!hotkey_dev_attributes)
3227 return -ENOMEM;
3228 res = add_many_to_attr_set(hotkey_dev_attributes,
3229 hotkey_attributes,
3230 ARRAY_SIZE(hotkey_attributes));
3231 if (res)
3232 goto err_exit;
3234 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3235 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3236 for HKEY interface version 0x100 */
3237 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3238 if ((hkeyv >> 8) != 1) {
3239 printk(TPACPI_ERR "unknown version of the "
3240 "HKEY interface: 0x%x\n", hkeyv);
3241 printk(TPACPI_ERR "please report this to %s\n",
3242 TPACPI_MAIL);
3243 } else {
3245 * MHKV 0x100 in A31, R40, R40e,
3246 * T4x, X31, and later
3248 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3249 "firmware HKEY interface version: 0x%x\n",
3250 hkeyv);
3252 /* Paranoia check AND init hotkey_all_mask */
3253 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3254 "MHKA", "qd")) {
3255 printk(TPACPI_ERR
3256 "missing MHKA handler, "
3257 "please report this to %s\n",
3258 TPACPI_MAIL);
3259 /* Fallback: pre-init for FN+F3,F4,F12 */
3260 hotkey_all_mask = 0x080cU;
3261 } else {
3262 tp_features.hotkey_mask = 1;
3267 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3268 "hotkey masks are %s\n",
3269 str_supported(tp_features.hotkey_mask));
3271 /* Init hotkey_all_mask if not initialized yet */
3272 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3273 (quirks & TPACPI_HK_Q_INIMASK))
3274 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3276 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3277 if (tp_features.hotkey_mask) {
3278 /* hotkey_source_mask *must* be zero for
3279 * the first hotkey_mask_get to return hotkey_orig_mask */
3280 res = hotkey_mask_get();
3281 if (res)
3282 goto err_exit;
3284 hotkey_orig_mask = hotkey_acpi_mask;
3285 } else {
3286 hotkey_orig_mask = hotkey_all_mask;
3287 hotkey_acpi_mask = hotkey_all_mask;
3290 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3291 if (dbg_wlswemul) {
3292 tp_features.hotkey_wlsw = 1;
3293 printk(TPACPI_INFO
3294 "radio switch emulation enabled\n");
3295 } else
3296 #endif
3297 /* Not all thinkpads have a hardware radio switch */
3298 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3299 tp_features.hotkey_wlsw = 1;
3300 printk(TPACPI_INFO
3301 "radio switch found; radios are %s\n",
3302 enabled(status, 0));
3304 if (tp_features.hotkey_wlsw)
3305 res = add_to_attr_set(hotkey_dev_attributes,
3306 &dev_attr_hotkey_radio_sw.attr);
3308 /* For X41t, X60t, X61t Tablets... */
3309 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3310 tp_features.hotkey_tablet = 1;
3311 printk(TPACPI_INFO
3312 "possible tablet mode switch found; "
3313 "ThinkPad in %s mode\n",
3314 (status & TP_HOTKEY_TABLET_MASK)?
3315 "tablet" : "laptop");
3316 res = add_to_attr_set(hotkey_dev_attributes,
3317 &dev_attr_hotkey_tablet_mode.attr);
3320 if (!res)
3321 res = register_attr_set_with_sysfs(
3322 hotkey_dev_attributes,
3323 &tpacpi_pdev->dev.kobj);
3324 if (res)
3325 goto err_exit;
3327 /* Set up key map */
3329 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3330 GFP_KERNEL);
3331 if (!hotkey_keycode_map) {
3332 printk(TPACPI_ERR
3333 "failed to allocate memory for key map\n");
3334 res = -ENOMEM;
3335 goto err_exit;
3338 if (thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO) {
3339 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3340 "using Lenovo default hot key map\n");
3341 memcpy(hotkey_keycode_map, &lenovo_keycode_map,
3342 TPACPI_HOTKEY_MAP_SIZE);
3343 } else {
3344 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3345 "using IBM default hot key map\n");
3346 memcpy(hotkey_keycode_map, &ibm_keycode_map,
3347 TPACPI_HOTKEY_MAP_SIZE);
3350 set_bit(EV_KEY, tpacpi_inputdev->evbit);
3351 set_bit(EV_MSC, tpacpi_inputdev->evbit);
3352 set_bit(MSC_SCAN, tpacpi_inputdev->mscbit);
3353 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3354 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3355 tpacpi_inputdev->keycode = hotkey_keycode_map;
3356 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3357 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3358 set_bit(hotkey_keycode_map[i],
3359 tpacpi_inputdev->keybit);
3360 } else {
3361 if (i < sizeof(hotkey_reserved_mask)*8)
3362 hotkey_reserved_mask |= 1 << i;
3366 if (tp_features.hotkey_wlsw) {
3367 set_bit(EV_SW, tpacpi_inputdev->evbit);
3368 set_bit(SW_RFKILL_ALL, tpacpi_inputdev->swbit);
3370 if (tp_features.hotkey_tablet) {
3371 set_bit(EV_SW, tpacpi_inputdev->evbit);
3372 set_bit(SW_TABLET_MODE, tpacpi_inputdev->swbit);
3375 /* Do not issue duplicate brightness change events to
3376 * userspace */
3377 if (!tp_features.bright_acpimode)
3378 /* update bright_acpimode... */
3379 tpacpi_check_std_acpi_brightness_support();
3381 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3382 printk(TPACPI_INFO
3383 "This ThinkPad has standard ACPI backlight "
3384 "brightness control, supported by the ACPI "
3385 "video driver\n");
3386 printk(TPACPI_NOTICE
3387 "Disabling thinkpad-acpi brightness events "
3388 "by default...\n");
3390 /* Disable brightness up/down on Lenovo thinkpads when
3391 * ACPI is handling them, otherwise it is plain impossible
3392 * for userspace to do something even remotely sane */
3393 hotkey_reserved_mask |=
3394 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3395 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3396 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3397 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3400 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3401 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3402 & ~hotkey_all_mask
3403 & ~hotkey_reserved_mask;
3405 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3406 "hotkey source mask 0x%08x, polling freq %u\n",
3407 hotkey_source_mask, hotkey_poll_freq);
3408 #endif
3410 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3411 "enabling firmware HKEY event interface...\n");
3412 res = hotkey_status_set(true);
3413 if (res) {
3414 hotkey_exit();
3415 return res;
3417 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3418 | hotkey_driver_mask)
3419 & ~hotkey_source_mask);
3420 if (res < 0 && res != -ENXIO) {
3421 hotkey_exit();
3422 return res;
3424 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3425 & ~hotkey_reserved_mask;
3426 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3427 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3428 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3430 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3431 "legacy ibm/hotkey event reporting over procfs %s\n",
3432 (hotkey_report_mode < 2) ?
3433 "enabled" : "disabled");
3435 tpacpi_inputdev->open = &hotkey_inputdev_open;
3436 tpacpi_inputdev->close = &hotkey_inputdev_close;
3438 hotkey_poll_setup_safe(true);
3439 tpacpi_send_radiosw_update();
3440 tpacpi_input_send_tabletsw();
3442 return 0;
3444 err_exit:
3445 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3446 hotkey_dev_attributes = NULL;
3448 return (res < 0)? res : 1;
3451 static bool hotkey_notify_hotkey(const u32 hkey,
3452 bool *send_acpi_ev,
3453 bool *ignore_acpi_ev)
3455 /* 0x1000-0x1FFF: key presses */
3456 unsigned int scancode = hkey & 0xfff;
3457 *send_acpi_ev = true;
3458 *ignore_acpi_ev = false;
3460 if (scancode > 0 && scancode < 0x21) {
3461 scancode--;
3462 if (!(hotkey_source_mask & (1 << scancode))) {
3463 tpacpi_input_send_key_masked(scancode);
3464 *send_acpi_ev = false;
3465 } else {
3466 *ignore_acpi_ev = true;
3468 return true;
3470 return false;
3473 static bool hotkey_notify_wakeup(const u32 hkey,
3474 bool *send_acpi_ev,
3475 bool *ignore_acpi_ev)
3477 /* 0x2000-0x2FFF: Wakeup reason */
3478 *send_acpi_ev = true;
3479 *ignore_acpi_ev = false;
3481 switch (hkey) {
3482 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3483 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3484 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3485 *ignore_acpi_ev = true;
3486 break;
3488 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3489 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3490 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3491 *ignore_acpi_ev = true;
3492 break;
3494 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3495 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3496 printk(TPACPI_ALERT
3497 "EMERGENCY WAKEUP: battery almost empty\n");
3498 /* how to auto-heal: */
3499 /* 2313: woke up from S3, go to S4/S5 */
3500 /* 2413: woke up from S4, go to S5 */
3501 break;
3503 default:
3504 return false;
3507 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3508 printk(TPACPI_INFO
3509 "woke up due to a hot-unplug "
3510 "request...\n");
3511 hotkey_wakeup_reason_notify_change();
3513 return true;
3516 static bool hotkey_notify_usrevent(const u32 hkey,
3517 bool *send_acpi_ev,
3518 bool *ignore_acpi_ev)
3520 /* 0x5000-0x5FFF: human interface helpers */
3521 *send_acpi_ev = true;
3522 *ignore_acpi_ev = false;
3524 switch (hkey) {
3525 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3526 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3527 return true;
3529 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3530 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3531 tpacpi_input_send_tabletsw();
3532 hotkey_tablet_mode_notify_change();
3533 *send_acpi_ev = false;
3534 return true;
3536 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3537 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3538 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3539 /* do not propagate these events */
3540 *ignore_acpi_ev = true;
3541 return true;
3543 default:
3544 return false;
3548 static bool hotkey_notify_thermal(const u32 hkey,
3549 bool *send_acpi_ev,
3550 bool *ignore_acpi_ev)
3552 /* 0x6000-0x6FFF: thermal alarms */
3553 *send_acpi_ev = true;
3554 *ignore_acpi_ev = false;
3556 switch (hkey) {
3557 case TP_HKEY_EV_ALARM_BAT_HOT:
3558 printk(TPACPI_CRIT
3559 "THERMAL ALARM: battery is too hot!\n");
3560 /* recommended action: warn user through gui */
3561 return true;
3562 case TP_HKEY_EV_ALARM_BAT_XHOT:
3563 printk(TPACPI_ALERT
3564 "THERMAL EMERGENCY: battery is extremely hot!\n");
3565 /* recommended action: immediate sleep/hibernate */
3566 return true;
3567 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3568 printk(TPACPI_CRIT
3569 "THERMAL ALARM: "
3570 "a sensor reports something is too hot!\n");
3571 /* recommended action: warn user through gui, that */
3572 /* some internal component is too hot */
3573 return true;
3574 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3575 printk(TPACPI_ALERT
3576 "THERMAL EMERGENCY: "
3577 "a sensor reports something is extremely hot!\n");
3578 /* recommended action: immediate sleep/hibernate */
3579 return true;
3580 case TP_HKEY_EV_THM_TABLE_CHANGED:
3581 printk(TPACPI_INFO
3582 "EC reports that Thermal Table has changed\n");
3583 /* recommended action: do nothing, we don't have
3584 * Lenovo ATM information */
3585 return true;
3586 default:
3587 printk(TPACPI_ALERT
3588 "THERMAL ALERT: unknown thermal alarm received\n");
3589 return false;
3593 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3595 u32 hkey;
3596 bool send_acpi_ev;
3597 bool ignore_acpi_ev;
3598 bool known_ev;
3600 if (event != 0x80) {
3601 printk(TPACPI_ERR
3602 "unknown HKEY notification event %d\n", event);
3603 /* forward it to userspace, maybe it knows how to handle it */
3604 acpi_bus_generate_netlink_event(
3605 ibm->acpi->device->pnp.device_class,
3606 dev_name(&ibm->acpi->device->dev),
3607 event, 0);
3608 return;
3611 while (1) {
3612 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3613 printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3614 return;
3617 if (hkey == 0) {
3618 /* queue empty */
3619 return;
3622 send_acpi_ev = true;
3623 ignore_acpi_ev = false;
3625 switch (hkey >> 12) {
3626 case 1:
3627 /* 0x1000-0x1FFF: key presses */
3628 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3629 &ignore_acpi_ev);
3630 break;
3631 case 2:
3632 /* 0x2000-0x2FFF: Wakeup reason */
3633 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3634 &ignore_acpi_ev);
3635 break;
3636 case 3:
3637 /* 0x3000-0x3FFF: bay-related wakeups */
3638 if (hkey == TP_HKEY_EV_BAYEJ_ACK) {
3639 hotkey_autosleep_ack = 1;
3640 printk(TPACPI_INFO
3641 "bay ejected\n");
3642 hotkey_wakeup_hotunplug_complete_notify_change();
3643 known_ev = true;
3644 } else {
3645 known_ev = false;
3647 break;
3648 case 4:
3649 /* 0x4000-0x4FFF: dock-related wakeups */
3650 if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3651 hotkey_autosleep_ack = 1;
3652 printk(TPACPI_INFO
3653 "undocked\n");
3654 hotkey_wakeup_hotunplug_complete_notify_change();
3655 known_ev = true;
3656 } else {
3657 known_ev = false;
3659 break;
3660 case 5:
3661 /* 0x5000-0x5FFF: human interface helpers */
3662 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3663 &ignore_acpi_ev);
3664 break;
3665 case 6:
3666 /* 0x6000-0x6FFF: thermal alarms */
3667 known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3668 &ignore_acpi_ev);
3669 break;
3670 case 7:
3671 /* 0x7000-0x7FFF: misc */
3672 if (tp_features.hotkey_wlsw &&
3673 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3674 tpacpi_send_radiosw_update();
3675 send_acpi_ev = 0;
3676 known_ev = true;
3677 break;
3679 /* fallthrough to default */
3680 default:
3681 known_ev = false;
3683 if (!known_ev) {
3684 printk(TPACPI_NOTICE
3685 "unhandled HKEY event 0x%04x\n", hkey);
3686 printk(TPACPI_NOTICE
3687 "please report the conditions when this "
3688 "event happened to %s\n", TPACPI_MAIL);
3691 /* Legacy events */
3692 if (!ignore_acpi_ev &&
3693 (send_acpi_ev || hotkey_report_mode < 2)) {
3694 acpi_bus_generate_proc_event(ibm->acpi->device,
3695 event, hkey);
3698 /* netlink events */
3699 if (!ignore_acpi_ev && send_acpi_ev) {
3700 acpi_bus_generate_netlink_event(
3701 ibm->acpi->device->pnp.device_class,
3702 dev_name(&ibm->acpi->device->dev),
3703 event, hkey);
3708 static void hotkey_suspend(pm_message_t state)
3710 /* Do these on suspend, we get the events on early resume! */
3711 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3712 hotkey_autosleep_ack = 0;
3715 static void hotkey_resume(void)
3717 tpacpi_disable_brightness_delay();
3719 if (hotkey_status_set(true) < 0 ||
3720 hotkey_mask_set(hotkey_acpi_mask) < 0)
3721 printk(TPACPI_ERR
3722 "error while attempting to reset the event "
3723 "firmware interface\n");
3725 tpacpi_send_radiosw_update();
3726 hotkey_tablet_mode_notify_change();
3727 hotkey_wakeup_reason_notify_change();
3728 hotkey_wakeup_hotunplug_complete_notify_change();
3729 hotkey_poll_setup_safe(false);
3732 /* procfs -------------------------------------------------------------- */
3733 static int hotkey_read(char *p)
3735 int res, status;
3736 int len = 0;
3738 if (!tp_features.hotkey) {
3739 len += sprintf(p + len, "status:\t\tnot supported\n");
3740 return len;
3743 if (mutex_lock_killable(&hotkey_mutex))
3744 return -ERESTARTSYS;
3745 res = hotkey_status_get(&status);
3746 if (!res)
3747 res = hotkey_mask_get();
3748 mutex_unlock(&hotkey_mutex);
3749 if (res)
3750 return res;
3752 len += sprintf(p + len, "status:\t\t%s\n", enabled(status, 0));
3753 if (hotkey_all_mask) {
3754 len += sprintf(p + len, "mask:\t\t0x%08x\n", hotkey_user_mask);
3755 len += sprintf(p + len,
3756 "commands:\tenable, disable, reset, <mask>\n");
3757 } else {
3758 len += sprintf(p + len, "mask:\t\tnot supported\n");
3759 len += sprintf(p + len, "commands:\tenable, disable, reset\n");
3762 return len;
3765 static void hotkey_enabledisable_warn(bool enable)
3767 tpacpi_log_usertask("procfs hotkey enable/disable");
3768 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3769 TPACPI_WARN
3770 "hotkey enable/disable functionality has been "
3771 "removed from the driver. Hotkeys are always "
3772 "enabled\n"))
3773 printk(TPACPI_ERR
3774 "Please remove the hotkey=enable module "
3775 "parameter, it is deprecated. Hotkeys are always "
3776 "enabled\n");
3779 static int hotkey_write(char *buf)
3781 int res;
3782 u32 mask;
3783 char *cmd;
3785 if (!tp_features.hotkey)
3786 return -ENODEV;
3788 if (mutex_lock_killable(&hotkey_mutex))
3789 return -ERESTARTSYS;
3791 mask = hotkey_user_mask;
3793 res = 0;
3794 while ((cmd = next_cmd(&buf))) {
3795 if (strlencmp(cmd, "enable") == 0) {
3796 hotkey_enabledisable_warn(1);
3797 } else if (strlencmp(cmd, "disable") == 0) {
3798 hotkey_enabledisable_warn(0);
3799 res = -EPERM;
3800 } else if (strlencmp(cmd, "reset") == 0) {
3801 mask = (hotkey_all_mask | hotkey_source_mask)
3802 & ~hotkey_reserved_mask;
3803 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3804 /* mask set */
3805 } else if (sscanf(cmd, "%x", &mask) == 1) {
3806 /* mask set */
3807 } else {
3808 res = -EINVAL;
3809 goto errexit;
3813 if (!res) {
3814 tpacpi_disclose_usertask("procfs hotkey",
3815 "set mask to 0x%08x\n", mask);
3816 res = hotkey_user_mask_set(mask);
3819 errexit:
3820 mutex_unlock(&hotkey_mutex);
3821 return res;
3824 static const struct acpi_device_id ibm_htk_device_ids[] = {
3825 {TPACPI_ACPI_HKEY_HID, 0},
3826 {"", 0},
3829 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3830 .hid = ibm_htk_device_ids,
3831 .notify = hotkey_notify,
3832 .handle = &hkey_handle,
3833 .type = ACPI_DEVICE_NOTIFY,
3836 static struct ibm_struct hotkey_driver_data = {
3837 .name = "hotkey",
3838 .read = hotkey_read,
3839 .write = hotkey_write,
3840 .exit = hotkey_exit,
3841 .resume = hotkey_resume,
3842 .suspend = hotkey_suspend,
3843 .acpi = &ibm_hotkey_acpidriver,
3846 /*************************************************************************
3847 * Bluetooth subdriver
3850 enum {
3851 /* ACPI GBDC/SBDC bits */
3852 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3853 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3854 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3855 off / last state */
3858 enum {
3859 /* ACPI \BLTH commands */
3860 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3861 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3862 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3863 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3864 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3867 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3869 static int bluetooth_get_status(void)
3871 int status;
3873 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3874 if (dbg_bluetoothemul)
3875 return (tpacpi_bluetooth_emulstate) ?
3876 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3877 #endif
3879 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3880 return -EIO;
3882 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3883 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3886 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3888 int status;
3890 vdbg_printk(TPACPI_DBG_RFKILL,
3891 "will attempt to %s bluetooth\n",
3892 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3894 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3895 if (dbg_bluetoothemul) {
3896 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3897 return 0;
3899 #endif
3901 /* We make sure to keep TP_ACPI_BLUETOOTH_RESUMECTRL off */
3902 status = TP_ACPI_BLUETOOTH_RESUMECTRL;
3903 if (state == TPACPI_RFK_RADIO_ON)
3904 status |= TP_ACPI_BLUETOOTH_RADIOSSW;
3906 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3907 return -EIO;
3909 return 0;
3912 /* sysfs bluetooth enable ---------------------------------------------- */
3913 static ssize_t bluetooth_enable_show(struct device *dev,
3914 struct device_attribute *attr,
3915 char *buf)
3917 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3918 attr, buf);
3921 static ssize_t bluetooth_enable_store(struct device *dev,
3922 struct device_attribute *attr,
3923 const char *buf, size_t count)
3925 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3926 attr, buf, count);
3929 static struct device_attribute dev_attr_bluetooth_enable =
3930 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3931 bluetooth_enable_show, bluetooth_enable_store);
3933 /* --------------------------------------------------------------------- */
3935 static struct attribute *bluetooth_attributes[] = {
3936 &dev_attr_bluetooth_enable.attr,
3937 NULL
3940 static const struct attribute_group bluetooth_attr_group = {
3941 .attrs = bluetooth_attributes,
3944 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
3945 .get_status = bluetooth_get_status,
3946 .set_status = bluetooth_set_status,
3949 static void bluetooth_shutdown(void)
3951 /* Order firmware to save current state to NVRAM */
3952 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
3953 TP_ACPI_BLTH_SAVE_STATE))
3954 printk(TPACPI_NOTICE
3955 "failed to save bluetooth state to NVRAM\n");
3956 else
3957 vdbg_printk(TPACPI_DBG_RFKILL,
3958 "bluestooth state saved to NVRAM\n");
3961 static void bluetooth_exit(void)
3963 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3964 &bluetooth_attr_group);
3966 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
3968 bluetooth_shutdown();
3971 static int __init bluetooth_init(struct ibm_init_struct *iibm)
3973 int res;
3974 int status = 0;
3976 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
3977 "initializing bluetooth subdriver\n");
3979 TPACPI_ACPIHANDLE_INIT(hkey);
3981 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
3982 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
3983 tp_features.bluetooth = hkey_handle &&
3984 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
3986 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
3987 "bluetooth is %s, status 0x%02x\n",
3988 str_supported(tp_features.bluetooth),
3989 status);
3991 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3992 if (dbg_bluetoothemul) {
3993 tp_features.bluetooth = 1;
3994 printk(TPACPI_INFO
3995 "bluetooth switch emulation enabled\n");
3996 } else
3997 #endif
3998 if (tp_features.bluetooth &&
3999 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4000 /* no bluetooth hardware present in system */
4001 tp_features.bluetooth = 0;
4002 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4003 "bluetooth hardware not installed\n");
4006 if (!tp_features.bluetooth)
4007 return 1;
4009 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4010 &bluetooth_tprfk_ops,
4011 RFKILL_TYPE_BLUETOOTH,
4012 TPACPI_RFK_BLUETOOTH_SW_NAME,
4013 true);
4014 if (res)
4015 return res;
4017 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4018 &bluetooth_attr_group);
4019 if (res) {
4020 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4021 return res;
4024 return 0;
4027 /* procfs -------------------------------------------------------------- */
4028 static int bluetooth_read(char *p)
4030 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, p);
4033 static int bluetooth_write(char *buf)
4035 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4038 static struct ibm_struct bluetooth_driver_data = {
4039 .name = "bluetooth",
4040 .read = bluetooth_read,
4041 .write = bluetooth_write,
4042 .exit = bluetooth_exit,
4043 .shutdown = bluetooth_shutdown,
4046 /*************************************************************************
4047 * Wan subdriver
4050 enum {
4051 /* ACPI GWAN/SWAN bits */
4052 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4053 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4054 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4055 off / last state */
4058 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4060 static int wan_get_status(void)
4062 int status;
4064 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4065 if (dbg_wwanemul)
4066 return (tpacpi_wwan_emulstate) ?
4067 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4068 #endif
4070 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4071 return -EIO;
4073 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4074 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4077 static int wan_set_status(enum tpacpi_rfkill_state state)
4079 int status;
4081 vdbg_printk(TPACPI_DBG_RFKILL,
4082 "will attempt to %s wwan\n",
4083 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4085 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4086 if (dbg_wwanemul) {
4087 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4088 return 0;
4090 #endif
4092 /* We make sure to set TP_ACPI_WANCARD_RESUMECTRL */
4093 status = TP_ACPI_WANCARD_RESUMECTRL;
4094 if (state == TPACPI_RFK_RADIO_ON)
4095 status |= TP_ACPI_WANCARD_RADIOSSW;
4097 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4098 return -EIO;
4100 return 0;
4103 /* sysfs wan enable ---------------------------------------------------- */
4104 static ssize_t wan_enable_show(struct device *dev,
4105 struct device_attribute *attr,
4106 char *buf)
4108 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4109 attr, buf);
4112 static ssize_t wan_enable_store(struct device *dev,
4113 struct device_attribute *attr,
4114 const char *buf, size_t count)
4116 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4117 attr, buf, count);
4120 static struct device_attribute dev_attr_wan_enable =
4121 __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4122 wan_enable_show, wan_enable_store);
4124 /* --------------------------------------------------------------------- */
4126 static struct attribute *wan_attributes[] = {
4127 &dev_attr_wan_enable.attr,
4128 NULL
4131 static const struct attribute_group wan_attr_group = {
4132 .attrs = wan_attributes,
4135 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4136 .get_status = wan_get_status,
4137 .set_status = wan_set_status,
4140 static void wan_shutdown(void)
4142 /* Order firmware to save current state to NVRAM */
4143 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4144 TP_ACPI_WGSV_SAVE_STATE))
4145 printk(TPACPI_NOTICE
4146 "failed to save WWAN state to NVRAM\n");
4147 else
4148 vdbg_printk(TPACPI_DBG_RFKILL,
4149 "WWAN state saved to NVRAM\n");
4152 static void wan_exit(void)
4154 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4155 &wan_attr_group);
4157 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4159 wan_shutdown();
4162 static int __init wan_init(struct ibm_init_struct *iibm)
4164 int res;
4165 int status = 0;
4167 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4168 "initializing wan subdriver\n");
4170 TPACPI_ACPIHANDLE_INIT(hkey);
4172 tp_features.wan = hkey_handle &&
4173 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4175 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4176 "wan is %s, status 0x%02x\n",
4177 str_supported(tp_features.wan),
4178 status);
4180 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4181 if (dbg_wwanemul) {
4182 tp_features.wan = 1;
4183 printk(TPACPI_INFO
4184 "wwan switch emulation enabled\n");
4185 } else
4186 #endif
4187 if (tp_features.wan &&
4188 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4189 /* no wan hardware present in system */
4190 tp_features.wan = 0;
4191 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4192 "wan hardware not installed\n");
4195 if (!tp_features.wan)
4196 return 1;
4198 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4199 &wan_tprfk_ops,
4200 RFKILL_TYPE_WWAN,
4201 TPACPI_RFK_WWAN_SW_NAME,
4202 true);
4203 if (res)
4204 return res;
4206 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4207 &wan_attr_group);
4209 if (res) {
4210 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4211 return res;
4214 return 0;
4217 /* procfs -------------------------------------------------------------- */
4218 static int wan_read(char *p)
4220 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, p);
4223 static int wan_write(char *buf)
4225 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4228 static struct ibm_struct wan_driver_data = {
4229 .name = "wan",
4230 .read = wan_read,
4231 .write = wan_write,
4232 .exit = wan_exit,
4233 .shutdown = wan_shutdown,
4236 /*************************************************************************
4237 * UWB subdriver
4240 enum {
4241 /* ACPI GUWB/SUWB bits */
4242 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4243 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4246 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4248 static int uwb_get_status(void)
4250 int status;
4252 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4253 if (dbg_uwbemul)
4254 return (tpacpi_uwb_emulstate) ?
4255 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4256 #endif
4258 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4259 return -EIO;
4261 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4262 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4265 static int uwb_set_status(enum tpacpi_rfkill_state state)
4267 int status;
4269 vdbg_printk(TPACPI_DBG_RFKILL,
4270 "will attempt to %s UWB\n",
4271 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4273 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4274 if (dbg_uwbemul) {
4275 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4276 return 0;
4278 #endif
4280 if (state == TPACPI_RFK_RADIO_ON)
4281 status = TP_ACPI_UWB_RADIOSSW;
4282 else
4283 status = 0;
4285 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4286 return -EIO;
4288 return 0;
4291 /* --------------------------------------------------------------------- */
4293 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4294 .get_status = uwb_get_status,
4295 .set_status = uwb_set_status,
4298 static void uwb_exit(void)
4300 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4303 static int __init uwb_init(struct ibm_init_struct *iibm)
4305 int res;
4306 int status = 0;
4308 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4309 "initializing uwb subdriver\n");
4311 TPACPI_ACPIHANDLE_INIT(hkey);
4313 tp_features.uwb = hkey_handle &&
4314 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4316 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4317 "uwb is %s, status 0x%02x\n",
4318 str_supported(tp_features.uwb),
4319 status);
4321 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4322 if (dbg_uwbemul) {
4323 tp_features.uwb = 1;
4324 printk(TPACPI_INFO
4325 "uwb switch emulation enabled\n");
4326 } else
4327 #endif
4328 if (tp_features.uwb &&
4329 !(status & TP_ACPI_UWB_HWPRESENT)) {
4330 /* no uwb hardware present in system */
4331 tp_features.uwb = 0;
4332 dbg_printk(TPACPI_DBG_INIT,
4333 "uwb hardware not installed\n");
4336 if (!tp_features.uwb)
4337 return 1;
4339 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4340 &uwb_tprfk_ops,
4341 RFKILL_TYPE_UWB,
4342 TPACPI_RFK_UWB_SW_NAME,
4343 false);
4344 return res;
4347 static struct ibm_struct uwb_driver_data = {
4348 .name = "uwb",
4349 .exit = uwb_exit,
4350 .flags.experimental = 1,
4353 /*************************************************************************
4354 * Video subdriver
4357 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4359 enum video_access_mode {
4360 TPACPI_VIDEO_NONE = 0,
4361 TPACPI_VIDEO_570, /* 570 */
4362 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4363 TPACPI_VIDEO_NEW, /* all others */
4366 enum { /* video status flags, based on VIDEO_570 */
4367 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4368 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4369 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4372 enum { /* TPACPI_VIDEO_570 constants */
4373 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4374 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4375 * video_status_flags */
4376 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4377 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4380 static enum video_access_mode video_supported;
4381 static int video_orig_autosw;
4383 static int video_autosw_get(void);
4384 static int video_autosw_set(int enable);
4386 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4388 static int __init video_init(struct ibm_init_struct *iibm)
4390 int ivga;
4392 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4394 TPACPI_ACPIHANDLE_INIT(vid);
4395 TPACPI_ACPIHANDLE_INIT(vid2);
4397 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4398 /* G41, assume IVGA doesn't change */
4399 vid_handle = vid2_handle;
4401 if (!vid_handle)
4402 /* video switching not supported on R30, R31 */
4403 video_supported = TPACPI_VIDEO_NONE;
4404 else if (acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4405 /* 570 */
4406 video_supported = TPACPI_VIDEO_570;
4407 else if (acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4408 /* 600e/x, 770e, 770x */
4409 video_supported = TPACPI_VIDEO_770;
4410 else
4411 /* all others */
4412 video_supported = TPACPI_VIDEO_NEW;
4414 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4415 str_supported(video_supported != TPACPI_VIDEO_NONE),
4416 video_supported);
4418 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4421 static void video_exit(void)
4423 dbg_printk(TPACPI_DBG_EXIT,
4424 "restoring original video autoswitch mode\n");
4425 if (video_autosw_set(video_orig_autosw))
4426 printk(TPACPI_ERR "error while trying to restore original "
4427 "video autoswitch mode\n");
4430 static int video_outputsw_get(void)
4432 int status = 0;
4433 int i;
4435 switch (video_supported) {
4436 case TPACPI_VIDEO_570:
4437 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4438 TP_ACPI_VIDEO_570_PHSCMD))
4439 return -EIO;
4440 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4441 break;
4442 case TPACPI_VIDEO_770:
4443 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4444 return -EIO;
4445 if (i)
4446 status |= TP_ACPI_VIDEO_S_LCD;
4447 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4448 return -EIO;
4449 if (i)
4450 status |= TP_ACPI_VIDEO_S_CRT;
4451 break;
4452 case TPACPI_VIDEO_NEW:
4453 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4454 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4455 return -EIO;
4456 if (i)
4457 status |= TP_ACPI_VIDEO_S_CRT;
4459 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4460 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4461 return -EIO;
4462 if (i)
4463 status |= TP_ACPI_VIDEO_S_LCD;
4464 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4465 return -EIO;
4466 if (i)
4467 status |= TP_ACPI_VIDEO_S_DVI;
4468 break;
4469 default:
4470 return -ENOSYS;
4473 return status;
4476 static int video_outputsw_set(int status)
4478 int autosw;
4479 int res = 0;
4481 switch (video_supported) {
4482 case TPACPI_VIDEO_570:
4483 res = acpi_evalf(NULL, NULL,
4484 "\\_SB.PHS2", "vdd",
4485 TP_ACPI_VIDEO_570_PHS2CMD,
4486 status | TP_ACPI_VIDEO_570_PHS2SET);
4487 break;
4488 case TPACPI_VIDEO_770:
4489 autosw = video_autosw_get();
4490 if (autosw < 0)
4491 return autosw;
4493 res = video_autosw_set(1);
4494 if (res)
4495 return res;
4496 res = acpi_evalf(vid_handle, NULL,
4497 "ASWT", "vdd", status * 0x100, 0);
4498 if (!autosw && video_autosw_set(autosw)) {
4499 printk(TPACPI_ERR
4500 "video auto-switch left enabled due to error\n");
4501 return -EIO;
4503 break;
4504 case TPACPI_VIDEO_NEW:
4505 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4506 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4507 break;
4508 default:
4509 return -ENOSYS;
4512 return (res)? 0 : -EIO;
4515 static int video_autosw_get(void)
4517 int autosw = 0;
4519 switch (video_supported) {
4520 case TPACPI_VIDEO_570:
4521 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4522 return -EIO;
4523 break;
4524 case TPACPI_VIDEO_770:
4525 case TPACPI_VIDEO_NEW:
4526 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4527 return -EIO;
4528 break;
4529 default:
4530 return -ENOSYS;
4533 return autosw & 1;
4536 static int video_autosw_set(int enable)
4538 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4539 return -EIO;
4540 return 0;
4543 static int video_outputsw_cycle(void)
4545 int autosw = video_autosw_get();
4546 int res;
4548 if (autosw < 0)
4549 return autosw;
4551 switch (video_supported) {
4552 case TPACPI_VIDEO_570:
4553 res = video_autosw_set(1);
4554 if (res)
4555 return res;
4556 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4557 break;
4558 case TPACPI_VIDEO_770:
4559 case TPACPI_VIDEO_NEW:
4560 res = video_autosw_set(1);
4561 if (res)
4562 return res;
4563 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4564 break;
4565 default:
4566 return -ENOSYS;
4568 if (!autosw && video_autosw_set(autosw)) {
4569 printk(TPACPI_ERR
4570 "video auto-switch left enabled due to error\n");
4571 return -EIO;
4574 return (res)? 0 : -EIO;
4577 static int video_expand_toggle(void)
4579 switch (video_supported) {
4580 case TPACPI_VIDEO_570:
4581 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4582 0 : -EIO;
4583 case TPACPI_VIDEO_770:
4584 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4585 0 : -EIO;
4586 case TPACPI_VIDEO_NEW:
4587 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4588 0 : -EIO;
4589 default:
4590 return -ENOSYS;
4592 /* not reached */
4595 static int video_read(char *p)
4597 int status, autosw;
4598 int len = 0;
4600 if (video_supported == TPACPI_VIDEO_NONE) {
4601 len += sprintf(p + len, "status:\t\tnot supported\n");
4602 return len;
4605 status = video_outputsw_get();
4606 if (status < 0)
4607 return status;
4609 autosw = video_autosw_get();
4610 if (autosw < 0)
4611 return autosw;
4613 len += sprintf(p + len, "status:\t\tsupported\n");
4614 len += sprintf(p + len, "lcd:\t\t%s\n", enabled(status, 0));
4615 len += sprintf(p + len, "crt:\t\t%s\n", enabled(status, 1));
4616 if (video_supported == TPACPI_VIDEO_NEW)
4617 len += sprintf(p + len, "dvi:\t\t%s\n", enabled(status, 3));
4618 len += sprintf(p + len, "auto:\t\t%s\n", enabled(autosw, 0));
4619 len += sprintf(p + len, "commands:\tlcd_enable, lcd_disable\n");
4620 len += sprintf(p + len, "commands:\tcrt_enable, crt_disable\n");
4621 if (video_supported == TPACPI_VIDEO_NEW)
4622 len += sprintf(p + len, "commands:\tdvi_enable, dvi_disable\n");
4623 len += sprintf(p + len, "commands:\tauto_enable, auto_disable\n");
4624 len += sprintf(p + len, "commands:\tvideo_switch, expand_toggle\n");
4626 return len;
4629 static int video_write(char *buf)
4631 char *cmd;
4632 int enable, disable, status;
4633 int res;
4635 if (video_supported == TPACPI_VIDEO_NONE)
4636 return -ENODEV;
4638 enable = 0;
4639 disable = 0;
4641 while ((cmd = next_cmd(&buf))) {
4642 if (strlencmp(cmd, "lcd_enable") == 0) {
4643 enable |= TP_ACPI_VIDEO_S_LCD;
4644 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4645 disable |= TP_ACPI_VIDEO_S_LCD;
4646 } else if (strlencmp(cmd, "crt_enable") == 0) {
4647 enable |= TP_ACPI_VIDEO_S_CRT;
4648 } else if (strlencmp(cmd, "crt_disable") == 0) {
4649 disable |= TP_ACPI_VIDEO_S_CRT;
4650 } else if (video_supported == TPACPI_VIDEO_NEW &&
4651 strlencmp(cmd, "dvi_enable") == 0) {
4652 enable |= TP_ACPI_VIDEO_S_DVI;
4653 } else if (video_supported == TPACPI_VIDEO_NEW &&
4654 strlencmp(cmd, "dvi_disable") == 0) {
4655 disable |= TP_ACPI_VIDEO_S_DVI;
4656 } else if (strlencmp(cmd, "auto_enable") == 0) {
4657 res = video_autosw_set(1);
4658 if (res)
4659 return res;
4660 } else if (strlencmp(cmd, "auto_disable") == 0) {
4661 res = video_autosw_set(0);
4662 if (res)
4663 return res;
4664 } else if (strlencmp(cmd, "video_switch") == 0) {
4665 res = video_outputsw_cycle();
4666 if (res)
4667 return res;
4668 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4669 res = video_expand_toggle();
4670 if (res)
4671 return res;
4672 } else
4673 return -EINVAL;
4676 if (enable || disable) {
4677 status = video_outputsw_get();
4678 if (status < 0)
4679 return status;
4680 res = video_outputsw_set((status & ~disable) | enable);
4681 if (res)
4682 return res;
4685 return 0;
4688 static struct ibm_struct video_driver_data = {
4689 .name = "video",
4690 .read = video_read,
4691 .write = video_write,
4692 .exit = video_exit,
4695 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4697 /*************************************************************************
4698 * Light (thinklight) subdriver
4701 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4702 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4704 static int light_get_status(void)
4706 int status = 0;
4708 if (tp_features.light_status) {
4709 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4710 return -EIO;
4711 return (!!status);
4714 return -ENXIO;
4717 static int light_set_status(int status)
4719 int rc;
4721 if (tp_features.light) {
4722 if (cmos_handle) {
4723 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4724 (status)?
4725 TP_CMOS_THINKLIGHT_ON :
4726 TP_CMOS_THINKLIGHT_OFF);
4727 } else {
4728 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4729 (status)? 1 : 0);
4731 return (rc)? 0 : -EIO;
4734 return -ENXIO;
4737 static void light_set_status_worker(struct work_struct *work)
4739 struct tpacpi_led_classdev *data =
4740 container_of(work, struct tpacpi_led_classdev, work);
4742 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4743 light_set_status((data->new_state != TPACPI_LED_OFF));
4746 static void light_sysfs_set(struct led_classdev *led_cdev,
4747 enum led_brightness brightness)
4749 struct tpacpi_led_classdev *data =
4750 container_of(led_cdev,
4751 struct tpacpi_led_classdev,
4752 led_classdev);
4753 data->new_state = (brightness != LED_OFF) ?
4754 TPACPI_LED_ON : TPACPI_LED_OFF;
4755 queue_work(tpacpi_wq, &data->work);
4758 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4760 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4763 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4764 .led_classdev = {
4765 .name = "tpacpi::thinklight",
4766 .brightness_set = &light_sysfs_set,
4767 .brightness_get = &light_sysfs_get,
4771 static int __init light_init(struct ibm_init_struct *iibm)
4773 int rc;
4775 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4777 TPACPI_ACPIHANDLE_INIT(ledb);
4778 TPACPI_ACPIHANDLE_INIT(lght);
4779 TPACPI_ACPIHANDLE_INIT(cmos);
4780 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4782 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4783 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4785 if (tp_features.light)
4786 /* light status not supported on
4787 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4788 tp_features.light_status =
4789 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4791 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4792 str_supported(tp_features.light),
4793 str_supported(tp_features.light_status));
4795 if (!tp_features.light)
4796 return 1;
4798 rc = led_classdev_register(&tpacpi_pdev->dev,
4799 &tpacpi_led_thinklight.led_classdev);
4801 if (rc < 0) {
4802 tp_features.light = 0;
4803 tp_features.light_status = 0;
4804 } else {
4805 rc = 0;
4808 return rc;
4811 static void light_exit(void)
4813 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4814 if (work_pending(&tpacpi_led_thinklight.work))
4815 flush_workqueue(tpacpi_wq);
4818 static int light_read(char *p)
4820 int len = 0;
4821 int status;
4823 if (!tp_features.light) {
4824 len += sprintf(p + len, "status:\t\tnot supported\n");
4825 } else if (!tp_features.light_status) {
4826 len += sprintf(p + len, "status:\t\tunknown\n");
4827 len += sprintf(p + len, "commands:\ton, off\n");
4828 } else {
4829 status = light_get_status();
4830 if (status < 0)
4831 return status;
4832 len += sprintf(p + len, "status:\t\t%s\n", onoff(status, 0));
4833 len += sprintf(p + len, "commands:\ton, off\n");
4836 return len;
4839 static int light_write(char *buf)
4841 char *cmd;
4842 int newstatus = 0;
4844 if (!tp_features.light)
4845 return -ENODEV;
4847 while ((cmd = next_cmd(&buf))) {
4848 if (strlencmp(cmd, "on") == 0) {
4849 newstatus = 1;
4850 } else if (strlencmp(cmd, "off") == 0) {
4851 newstatus = 0;
4852 } else
4853 return -EINVAL;
4856 return light_set_status(newstatus);
4859 static struct ibm_struct light_driver_data = {
4860 .name = "light",
4861 .read = light_read,
4862 .write = light_write,
4863 .exit = light_exit,
4866 /*************************************************************************
4867 * CMOS subdriver
4870 /* sysfs cmos_command -------------------------------------------------- */
4871 static ssize_t cmos_command_store(struct device *dev,
4872 struct device_attribute *attr,
4873 const char *buf, size_t count)
4875 unsigned long cmos_cmd;
4876 int res;
4878 if (parse_strtoul(buf, 21, &cmos_cmd))
4879 return -EINVAL;
4881 res = issue_thinkpad_cmos_command(cmos_cmd);
4882 return (res)? res : count;
4885 static struct device_attribute dev_attr_cmos_command =
4886 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4888 /* --------------------------------------------------------------------- */
4890 static int __init cmos_init(struct ibm_init_struct *iibm)
4892 int res;
4894 vdbg_printk(TPACPI_DBG_INIT,
4895 "initializing cmos commands subdriver\n");
4897 TPACPI_ACPIHANDLE_INIT(cmos);
4899 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4900 str_supported(cmos_handle != NULL));
4902 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4903 if (res)
4904 return res;
4906 return (cmos_handle)? 0 : 1;
4909 static void cmos_exit(void)
4911 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4914 static int cmos_read(char *p)
4916 int len = 0;
4918 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4919 R30, R31, T20-22, X20-21 */
4920 if (!cmos_handle)
4921 len += sprintf(p + len, "status:\t\tnot supported\n");
4922 else {
4923 len += sprintf(p + len, "status:\t\tsupported\n");
4924 len += sprintf(p + len, "commands:\t<cmd> (<cmd> is 0-21)\n");
4927 return len;
4930 static int cmos_write(char *buf)
4932 char *cmd;
4933 int cmos_cmd, res;
4935 while ((cmd = next_cmd(&buf))) {
4936 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
4937 cmos_cmd >= 0 && cmos_cmd <= 21) {
4938 /* cmos_cmd set */
4939 } else
4940 return -EINVAL;
4942 res = issue_thinkpad_cmos_command(cmos_cmd);
4943 if (res)
4944 return res;
4947 return 0;
4950 static struct ibm_struct cmos_driver_data = {
4951 .name = "cmos",
4952 .read = cmos_read,
4953 .write = cmos_write,
4954 .exit = cmos_exit,
4957 /*************************************************************************
4958 * LED subdriver
4961 enum led_access_mode {
4962 TPACPI_LED_NONE = 0,
4963 TPACPI_LED_570, /* 570 */
4964 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
4965 TPACPI_LED_NEW, /* all others */
4968 enum { /* For TPACPI_LED_OLD */
4969 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
4970 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
4971 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
4974 static enum led_access_mode led_supported;
4976 TPACPI_HANDLE(led, ec, "SLED", /* 570 */
4977 "SYSL", /* 600e/x, 770e, 770x, A21e, A2xm/p, */
4978 /* T20-22, X20-21 */
4979 "LED", /* all others */
4980 ); /* R30, R31 */
4982 #define TPACPI_LED_NUMLEDS 16
4983 static struct tpacpi_led_classdev *tpacpi_leds;
4984 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
4985 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
4986 /* there's a limit of 19 chars + NULL before 2.6.26 */
4987 "tpacpi::power",
4988 "tpacpi:orange:batt",
4989 "tpacpi:green:batt",
4990 "tpacpi::dock_active",
4991 "tpacpi::bay_active",
4992 "tpacpi::dock_batt",
4993 "tpacpi::unknown_led",
4994 "tpacpi::standby",
4995 "tpacpi::dock_status1",
4996 "tpacpi::dock_status2",
4997 "tpacpi::unknown_led2",
4998 "tpacpi::unknown_led3",
4999 "tpacpi::thinkvantage",
5001 #define TPACPI_SAFE_LEDS 0x1081U
5003 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5005 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5006 return false;
5007 #else
5008 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5009 #endif
5012 static int led_get_status(const unsigned int led)
5014 int status;
5015 enum led_status_t led_s;
5017 switch (led_supported) {
5018 case TPACPI_LED_570:
5019 if (!acpi_evalf(ec_handle,
5020 &status, "GLED", "dd", 1 << led))
5021 return -EIO;
5022 led_s = (status == 0)?
5023 TPACPI_LED_OFF :
5024 ((status == 1)?
5025 TPACPI_LED_ON :
5026 TPACPI_LED_BLINK);
5027 tpacpi_led_state_cache[led] = led_s;
5028 return led_s;
5029 default:
5030 return -ENXIO;
5033 /* not reached */
5036 static int led_set_status(const unsigned int led,
5037 const enum led_status_t ledstatus)
5039 /* off, on, blink. Index is led_status_t */
5040 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5041 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5043 int rc = 0;
5045 switch (led_supported) {
5046 case TPACPI_LED_570:
5047 /* 570 */
5048 if (unlikely(led > 7))
5049 return -EINVAL;
5050 if (unlikely(tpacpi_is_led_restricted(led)))
5051 return -EPERM;
5052 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5053 (1 << led), led_sled_arg1[ledstatus]))
5054 rc = -EIO;
5055 break;
5056 case TPACPI_LED_OLD:
5057 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5058 if (unlikely(led > 7))
5059 return -EINVAL;
5060 if (unlikely(tpacpi_is_led_restricted(led)))
5061 return -EPERM;
5062 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5063 if (rc >= 0)
5064 rc = ec_write(TPACPI_LED_EC_HLBL,
5065 (ledstatus == TPACPI_LED_BLINK) << led);
5066 if (rc >= 0)
5067 rc = ec_write(TPACPI_LED_EC_HLCL,
5068 (ledstatus != TPACPI_LED_OFF) << led);
5069 break;
5070 case TPACPI_LED_NEW:
5071 /* all others */
5072 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5073 return -EINVAL;
5074 if (unlikely(tpacpi_is_led_restricted(led)))
5075 return -EPERM;
5076 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5077 led, led_led_arg1[ledstatus]))
5078 rc = -EIO;
5079 break;
5080 default:
5081 rc = -ENXIO;
5084 if (!rc)
5085 tpacpi_led_state_cache[led] = ledstatus;
5087 return rc;
5090 static void led_set_status_worker(struct work_struct *work)
5092 struct tpacpi_led_classdev *data =
5093 container_of(work, struct tpacpi_led_classdev, work);
5095 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5096 led_set_status(data->led, data->new_state);
5099 static void led_sysfs_set(struct led_classdev *led_cdev,
5100 enum led_brightness brightness)
5102 struct tpacpi_led_classdev *data = container_of(led_cdev,
5103 struct tpacpi_led_classdev, led_classdev);
5105 if (brightness == LED_OFF)
5106 data->new_state = TPACPI_LED_OFF;
5107 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5108 data->new_state = TPACPI_LED_ON;
5109 else
5110 data->new_state = TPACPI_LED_BLINK;
5112 queue_work(tpacpi_wq, &data->work);
5115 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5116 unsigned long *delay_on, unsigned long *delay_off)
5118 struct tpacpi_led_classdev *data = container_of(led_cdev,
5119 struct tpacpi_led_classdev, led_classdev);
5121 /* Can we choose the flash rate? */
5122 if (*delay_on == 0 && *delay_off == 0) {
5123 /* yes. set them to the hardware blink rate (1 Hz) */
5124 *delay_on = 500; /* ms */
5125 *delay_off = 500; /* ms */
5126 } else if ((*delay_on != 500) || (*delay_off != 500))
5127 return -EINVAL;
5129 data->new_state = TPACPI_LED_BLINK;
5130 queue_work(tpacpi_wq, &data->work);
5132 return 0;
5135 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5137 int rc;
5139 struct tpacpi_led_classdev *data = container_of(led_cdev,
5140 struct tpacpi_led_classdev, led_classdev);
5142 rc = led_get_status(data->led);
5144 if (rc == TPACPI_LED_OFF || rc < 0)
5145 rc = LED_OFF; /* no error handling in led class :( */
5146 else
5147 rc = LED_FULL;
5149 return rc;
5152 static void led_exit(void)
5154 unsigned int i;
5156 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5157 if (tpacpi_leds[i].led_classdev.name)
5158 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5161 kfree(tpacpi_leds);
5164 static int __init tpacpi_init_led(unsigned int led)
5166 int rc;
5168 tpacpi_leds[led].led = led;
5170 /* LEDs with no name don't get registered */
5171 if (!tpacpi_led_names[led])
5172 return 0;
5174 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5175 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5176 if (led_supported == TPACPI_LED_570)
5177 tpacpi_leds[led].led_classdev.brightness_get =
5178 &led_sysfs_get;
5180 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5182 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5184 rc = led_classdev_register(&tpacpi_pdev->dev,
5185 &tpacpi_leds[led].led_classdev);
5186 if (rc < 0)
5187 tpacpi_leds[led].led_classdev.name = NULL;
5189 return rc;
5192 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5193 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5194 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5195 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5197 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5198 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5199 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5200 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5201 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5202 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5203 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5204 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5206 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5207 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5208 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5209 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5210 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5212 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5213 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5214 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5215 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5217 /* (1) - may have excess leds enabled on MSB */
5219 /* Defaults (order matters, keep last, don't reorder!) */
5220 { /* Lenovo */
5221 .vendor = PCI_VENDOR_ID_LENOVO,
5222 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5223 .quirks = 0x1fffU,
5225 { /* IBM ThinkPads with no EC version string */
5226 .vendor = PCI_VENDOR_ID_IBM,
5227 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5228 .quirks = 0x00ffU,
5230 { /* IBM ThinkPads with EC version string */
5231 .vendor = PCI_VENDOR_ID_IBM,
5232 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5233 .quirks = 0x00bfU,
5237 #undef TPACPI_LEDQ_IBM
5238 #undef TPACPI_LEDQ_LNV
5240 static int __init led_init(struct ibm_init_struct *iibm)
5242 unsigned int i;
5243 int rc;
5244 unsigned long useful_leds;
5246 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5248 TPACPI_ACPIHANDLE_INIT(led);
5250 if (!led_handle)
5251 /* led not supported on R30, R31 */
5252 led_supported = TPACPI_LED_NONE;
5253 else if (strlencmp(led_path, "SLED") == 0)
5254 /* 570 */
5255 led_supported = TPACPI_LED_570;
5256 else if (strlencmp(led_path, "SYSL") == 0)
5257 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5258 led_supported = TPACPI_LED_OLD;
5259 else
5260 /* all others */
5261 led_supported = TPACPI_LED_NEW;
5263 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5264 str_supported(led_supported), led_supported);
5266 if (led_supported == TPACPI_LED_NONE)
5267 return 1;
5269 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5270 GFP_KERNEL);
5271 if (!tpacpi_leds) {
5272 printk(TPACPI_ERR "Out of memory for LED data\n");
5273 return -ENOMEM;
5276 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5277 ARRAY_SIZE(led_useful_qtable));
5279 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5280 if (!tpacpi_is_led_restricted(i) &&
5281 test_bit(i, &useful_leds)) {
5282 rc = tpacpi_init_led(i);
5283 if (rc < 0) {
5284 led_exit();
5285 return rc;
5290 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5291 printk(TPACPI_NOTICE
5292 "warning: userspace override of important "
5293 "firmware LEDs is enabled\n");
5294 #endif
5295 return 0;
5298 #define str_led_status(s) \
5299 ((s) == TPACPI_LED_OFF ? "off" : \
5300 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5302 static int led_read(char *p)
5304 int len = 0;
5306 if (!led_supported) {
5307 len += sprintf(p + len, "status:\t\tnot supported\n");
5308 return len;
5310 len += sprintf(p + len, "status:\t\tsupported\n");
5312 if (led_supported == TPACPI_LED_570) {
5313 /* 570 */
5314 int i, status;
5315 for (i = 0; i < 8; i++) {
5316 status = led_get_status(i);
5317 if (status < 0)
5318 return -EIO;
5319 len += sprintf(p + len, "%d:\t\t%s\n",
5320 i, str_led_status(status));
5324 len += sprintf(p + len, "commands:\t"
5325 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5327 return len;
5330 static int led_write(char *buf)
5332 char *cmd;
5333 int led, rc;
5334 enum led_status_t s;
5336 if (!led_supported)
5337 return -ENODEV;
5339 while ((cmd = next_cmd(&buf))) {
5340 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5341 return -EINVAL;
5343 if (strstr(cmd, "off")) {
5344 s = TPACPI_LED_OFF;
5345 } else if (strstr(cmd, "on")) {
5346 s = TPACPI_LED_ON;
5347 } else if (strstr(cmd, "blink")) {
5348 s = TPACPI_LED_BLINK;
5349 } else {
5350 return -EINVAL;
5353 rc = led_set_status(led, s);
5354 if (rc < 0)
5355 return rc;
5358 return 0;
5361 static struct ibm_struct led_driver_data = {
5362 .name = "led",
5363 .read = led_read,
5364 .write = led_write,
5365 .exit = led_exit,
5368 /*************************************************************************
5369 * Beep subdriver
5372 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5374 #define TPACPI_BEEP_Q1 0x0001
5376 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5377 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5378 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5381 static int __init beep_init(struct ibm_init_struct *iibm)
5383 unsigned long quirks;
5385 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5387 TPACPI_ACPIHANDLE_INIT(beep);
5389 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5390 str_supported(beep_handle != NULL));
5392 quirks = tpacpi_check_quirks(beep_quirk_table,
5393 ARRAY_SIZE(beep_quirk_table));
5395 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5397 return (beep_handle)? 0 : 1;
5400 static int beep_read(char *p)
5402 int len = 0;
5404 if (!beep_handle)
5405 len += sprintf(p + len, "status:\t\tnot supported\n");
5406 else {
5407 len += sprintf(p + len, "status:\t\tsupported\n");
5408 len += sprintf(p + len, "commands:\t<cmd> (<cmd> is 0-17)\n");
5411 return len;
5414 static int beep_write(char *buf)
5416 char *cmd;
5417 int beep_cmd;
5419 if (!beep_handle)
5420 return -ENODEV;
5422 while ((cmd = next_cmd(&buf))) {
5423 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5424 beep_cmd >= 0 && beep_cmd <= 17) {
5425 /* beep_cmd set */
5426 } else
5427 return -EINVAL;
5428 if (tp_features.beep_needs_two_args) {
5429 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5430 beep_cmd, 0))
5431 return -EIO;
5432 } else {
5433 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5434 beep_cmd))
5435 return -EIO;
5439 return 0;
5442 static struct ibm_struct beep_driver_data = {
5443 .name = "beep",
5444 .read = beep_read,
5445 .write = beep_write,
5448 /*************************************************************************
5449 * Thermal subdriver
5452 enum thermal_access_mode {
5453 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5454 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5455 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5456 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5457 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5460 enum { /* TPACPI_THERMAL_TPEC_* */
5461 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5462 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5463 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5466 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5467 struct ibm_thermal_sensors_struct {
5468 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5471 static enum thermal_access_mode thermal_read_mode;
5473 /* idx is zero-based */
5474 static int thermal_get_sensor(int idx, s32 *value)
5476 int t;
5477 s8 tmp;
5478 char tmpi[5];
5480 t = TP_EC_THERMAL_TMP0;
5482 switch (thermal_read_mode) {
5483 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5484 case TPACPI_THERMAL_TPEC_16:
5485 if (idx >= 8 && idx <= 15) {
5486 t = TP_EC_THERMAL_TMP8;
5487 idx -= 8;
5489 /* fallthrough */
5490 #endif
5491 case TPACPI_THERMAL_TPEC_8:
5492 if (idx <= 7) {
5493 if (!acpi_ec_read(t + idx, &tmp))
5494 return -EIO;
5495 *value = tmp * 1000;
5496 return 0;
5498 break;
5500 case TPACPI_THERMAL_ACPI_UPDT:
5501 if (idx <= 7) {
5502 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5503 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5504 return -EIO;
5505 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5506 return -EIO;
5507 *value = (t - 2732) * 100;
5508 return 0;
5510 break;
5512 case TPACPI_THERMAL_ACPI_TMP07:
5513 if (idx <= 7) {
5514 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5515 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5516 return -EIO;
5517 if (t > 127 || t < -127)
5518 t = TP_EC_THERMAL_TMP_NA;
5519 *value = t * 1000;
5520 return 0;
5522 break;
5524 case TPACPI_THERMAL_NONE:
5525 default:
5526 return -ENOSYS;
5529 return -EINVAL;
5532 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5534 int res, i;
5535 int n;
5537 n = 8;
5538 i = 0;
5540 if (!s)
5541 return -EINVAL;
5543 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5544 n = 16;
5546 for (i = 0 ; i < n; i++) {
5547 res = thermal_get_sensor(i, &s->temp[i]);
5548 if (res)
5549 return res;
5552 return n;
5555 /* sysfs temp##_input -------------------------------------------------- */
5557 static ssize_t thermal_temp_input_show(struct device *dev,
5558 struct device_attribute *attr,
5559 char *buf)
5561 struct sensor_device_attribute *sensor_attr =
5562 to_sensor_dev_attr(attr);
5563 int idx = sensor_attr->index;
5564 s32 value;
5565 int res;
5567 res = thermal_get_sensor(idx, &value);
5568 if (res)
5569 return res;
5570 if (value == TP_EC_THERMAL_TMP_NA * 1000)
5571 return -ENXIO;
5573 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5576 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5577 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5578 thermal_temp_input_show, NULL, _idxB)
5580 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5581 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5582 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5583 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5584 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5585 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5586 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5587 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5588 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5589 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5590 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5591 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5592 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5593 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5594 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5595 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5596 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5599 #define THERMAL_ATTRS(X) \
5600 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5602 static struct attribute *thermal_temp_input_attr[] = {
5603 THERMAL_ATTRS(8),
5604 THERMAL_ATTRS(9),
5605 THERMAL_ATTRS(10),
5606 THERMAL_ATTRS(11),
5607 THERMAL_ATTRS(12),
5608 THERMAL_ATTRS(13),
5609 THERMAL_ATTRS(14),
5610 THERMAL_ATTRS(15),
5611 THERMAL_ATTRS(0),
5612 THERMAL_ATTRS(1),
5613 THERMAL_ATTRS(2),
5614 THERMAL_ATTRS(3),
5615 THERMAL_ATTRS(4),
5616 THERMAL_ATTRS(5),
5617 THERMAL_ATTRS(6),
5618 THERMAL_ATTRS(7),
5619 NULL
5622 static const struct attribute_group thermal_temp_input16_group = {
5623 .attrs = thermal_temp_input_attr
5626 static const struct attribute_group thermal_temp_input8_group = {
5627 .attrs = &thermal_temp_input_attr[8]
5630 #undef THERMAL_SENSOR_ATTR_TEMP
5631 #undef THERMAL_ATTRS
5633 /* --------------------------------------------------------------------- */
5635 static int __init thermal_init(struct ibm_init_struct *iibm)
5637 u8 t, ta1, ta2;
5638 int i;
5639 int acpi_tmp7;
5640 int res;
5642 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5644 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5646 if (thinkpad_id.ec_model) {
5648 * Direct EC access mode: sensors at registers
5649 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5650 * non-implemented, thermal sensors return 0x80 when
5651 * not available
5654 ta1 = ta2 = 0;
5655 for (i = 0; i < 8; i++) {
5656 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5657 ta1 |= t;
5658 } else {
5659 ta1 = 0;
5660 break;
5662 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5663 ta2 |= t;
5664 } else {
5665 ta1 = 0;
5666 break;
5669 if (ta1 == 0) {
5670 /* This is sheer paranoia, but we handle it anyway */
5671 if (acpi_tmp7) {
5672 printk(TPACPI_ERR
5673 "ThinkPad ACPI EC access misbehaving, "
5674 "falling back to ACPI TMPx access "
5675 "mode\n");
5676 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5677 } else {
5678 printk(TPACPI_ERR
5679 "ThinkPad ACPI EC access misbehaving, "
5680 "disabling thermal sensors access\n");
5681 thermal_read_mode = TPACPI_THERMAL_NONE;
5683 } else {
5684 thermal_read_mode =
5685 (ta2 != 0) ?
5686 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5688 } else if (acpi_tmp7) {
5689 if (acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5690 /* 600e/x, 770e, 770x */
5691 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5692 } else {
5693 /* Standard ACPI TMPx access, max 8 sensors */
5694 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5696 } else {
5697 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5698 thermal_read_mode = TPACPI_THERMAL_NONE;
5701 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5702 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5703 thermal_read_mode);
5705 switch (thermal_read_mode) {
5706 case TPACPI_THERMAL_TPEC_16:
5707 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5708 &thermal_temp_input16_group);
5709 if (res)
5710 return res;
5711 break;
5712 case TPACPI_THERMAL_TPEC_8:
5713 case TPACPI_THERMAL_ACPI_TMP07:
5714 case TPACPI_THERMAL_ACPI_UPDT:
5715 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5716 &thermal_temp_input8_group);
5717 if (res)
5718 return res;
5719 break;
5720 case TPACPI_THERMAL_NONE:
5721 default:
5722 return 1;
5725 return 0;
5728 static void thermal_exit(void)
5730 switch (thermal_read_mode) {
5731 case TPACPI_THERMAL_TPEC_16:
5732 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5733 &thermal_temp_input16_group);
5734 break;
5735 case TPACPI_THERMAL_TPEC_8:
5736 case TPACPI_THERMAL_ACPI_TMP07:
5737 case TPACPI_THERMAL_ACPI_UPDT:
5738 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5739 &thermal_temp_input16_group);
5740 break;
5741 case TPACPI_THERMAL_NONE:
5742 default:
5743 break;
5747 static int thermal_read(char *p)
5749 int len = 0;
5750 int n, i;
5751 struct ibm_thermal_sensors_struct t;
5753 n = thermal_get_sensors(&t);
5754 if (unlikely(n < 0))
5755 return n;
5757 len += sprintf(p + len, "temperatures:\t");
5759 if (n > 0) {
5760 for (i = 0; i < (n - 1); i++)
5761 len += sprintf(p + len, "%d ", t.temp[i] / 1000);
5762 len += sprintf(p + len, "%d\n", t.temp[i] / 1000);
5763 } else
5764 len += sprintf(p + len, "not supported\n");
5766 return len;
5769 static struct ibm_struct thermal_driver_data = {
5770 .name = "thermal",
5771 .read = thermal_read,
5772 .exit = thermal_exit,
5775 /*************************************************************************
5776 * EC Dump subdriver
5779 static u8 ecdump_regs[256];
5781 static int ecdump_read(char *p)
5783 int len = 0;
5784 int i, j;
5785 u8 v;
5787 len += sprintf(p + len, "EC "
5788 " +00 +01 +02 +03 +04 +05 +06 +07"
5789 " +08 +09 +0a +0b +0c +0d +0e +0f\n");
5790 for (i = 0; i < 256; i += 16) {
5791 len += sprintf(p + len, "EC 0x%02x:", i);
5792 for (j = 0; j < 16; j++) {
5793 if (!acpi_ec_read(i + j, &v))
5794 break;
5795 if (v != ecdump_regs[i + j])
5796 len += sprintf(p + len, " *%02x", v);
5797 else
5798 len += sprintf(p + len, " %02x", v);
5799 ecdump_regs[i + j] = v;
5801 len += sprintf(p + len, "\n");
5802 if (j != 16)
5803 break;
5806 /* These are way too dangerous to advertise openly... */
5807 #if 0
5808 len += sprintf(p + len, "commands:\t0x<offset> 0x<value>"
5809 " (<offset> is 00-ff, <value> is 00-ff)\n");
5810 len += sprintf(p + len, "commands:\t0x<offset> <value> "
5811 " (<offset> is 00-ff, <value> is 0-255)\n");
5812 #endif
5813 return len;
5816 static int ecdump_write(char *buf)
5818 char *cmd;
5819 int i, v;
5821 while ((cmd = next_cmd(&buf))) {
5822 if (sscanf(cmd, "0x%x 0x%x", &i, &v) == 2) {
5823 /* i and v set */
5824 } else if (sscanf(cmd, "0x%x %u", &i, &v) == 2) {
5825 /* i and v set */
5826 } else
5827 return -EINVAL;
5828 if (i >= 0 && i < 256 && v >= 0 && v < 256) {
5829 if (!acpi_ec_write(i, v))
5830 return -EIO;
5831 } else
5832 return -EINVAL;
5835 return 0;
5838 static struct ibm_struct ecdump_driver_data = {
5839 .name = "ecdump",
5840 .read = ecdump_read,
5841 .write = ecdump_write,
5842 .flags.experimental = 1,
5845 /*************************************************************************
5846 * Backlight/brightness subdriver
5849 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5852 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5853 * CMOS NVRAM byte 0x5E, bits 0-3.
5855 * EC HBRV (0x31) has the following layout
5856 * Bit 7: unknown function
5857 * Bit 6: unknown function
5858 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5859 * Bit 4: must be set to zero to avoid problems
5860 * Bit 3-0: backlight brightness level
5862 * brightness_get_raw returns status data in the HBRV layout
5864 * WARNING: The X61 has been verified to use HBRV for something else, so
5865 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5866 * testing on the very early *60 Lenovo models...
5869 enum {
5870 TP_EC_BACKLIGHT = 0x31,
5872 /* TP_EC_BACKLIGHT bitmasks */
5873 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5874 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5875 TP_EC_BACKLIGHT_MAPSW = 0x20,
5878 enum tpacpi_brightness_access_mode {
5879 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5880 TPACPI_BRGHT_MODE_EC, /* EC control */
5881 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5882 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5883 TPACPI_BRGHT_MODE_MAX
5886 static struct backlight_device *ibm_backlight_device;
5888 static enum tpacpi_brightness_access_mode brightness_mode =
5889 TPACPI_BRGHT_MODE_MAX;
5891 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5893 static struct mutex brightness_mutex;
5895 /* NVRAM brightness access,
5896 * call with brightness_mutex held! */
5897 static unsigned int tpacpi_brightness_nvram_get(void)
5899 u8 lnvram;
5901 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5902 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5903 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5904 lnvram &= (tp_features.bright_16levels) ? 0x0f : 0x07;
5906 return lnvram;
5909 static void tpacpi_brightness_checkpoint_nvram(void)
5911 u8 lec = 0;
5912 u8 b_nvram;
5914 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
5915 return;
5917 vdbg_printk(TPACPI_DBG_BRGHT,
5918 "trying to checkpoint backlight level to NVRAM...\n");
5920 if (mutex_lock_killable(&brightness_mutex) < 0)
5921 return;
5923 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5924 goto unlock;
5925 lec &= TP_EC_BACKLIGHT_LVLMSK;
5926 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
5928 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5929 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
5930 /* NVRAM needs update */
5931 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
5932 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
5933 b_nvram |= lec;
5934 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
5935 dbg_printk(TPACPI_DBG_BRGHT,
5936 "updated NVRAM backlight level to %u (0x%02x)\n",
5937 (unsigned int) lec, (unsigned int) b_nvram);
5938 } else
5939 vdbg_printk(TPACPI_DBG_BRGHT,
5940 "NVRAM backlight level already is %u (0x%02x)\n",
5941 (unsigned int) lec, (unsigned int) b_nvram);
5943 unlock:
5944 mutex_unlock(&brightness_mutex);
5948 /* call with brightness_mutex held! */
5949 static int tpacpi_brightness_get_raw(int *status)
5951 u8 lec = 0;
5953 switch (brightness_mode) {
5954 case TPACPI_BRGHT_MODE_UCMS_STEP:
5955 *status = tpacpi_brightness_nvram_get();
5956 return 0;
5957 case TPACPI_BRGHT_MODE_EC:
5958 case TPACPI_BRGHT_MODE_ECNVRAM:
5959 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5960 return -EIO;
5961 *status = lec;
5962 return 0;
5963 default:
5964 return -ENXIO;
5968 /* call with brightness_mutex held! */
5969 /* do NOT call with illegal backlight level value */
5970 static int tpacpi_brightness_set_ec(unsigned int value)
5972 u8 lec = 0;
5974 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5975 return -EIO;
5977 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
5978 (lec & TP_EC_BACKLIGHT_CMDMSK) |
5979 (value & TP_EC_BACKLIGHT_LVLMSK))))
5980 return -EIO;
5982 return 0;
5985 /* call with brightness_mutex held! */
5986 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
5988 int cmos_cmd, inc;
5989 unsigned int current_value, i;
5991 current_value = tpacpi_brightness_nvram_get();
5993 if (value == current_value)
5994 return 0;
5996 cmos_cmd = (value > current_value) ?
5997 TP_CMOS_BRIGHTNESS_UP :
5998 TP_CMOS_BRIGHTNESS_DOWN;
5999 inc = (value > current_value) ? 1 : -1;
6001 for (i = current_value; i != value; i += inc)
6002 if (issue_thinkpad_cmos_command(cmos_cmd))
6003 return -EIO;
6005 return 0;
6008 /* May return EINTR which can always be mapped to ERESTARTSYS */
6009 static int brightness_set(unsigned int value)
6011 int res;
6013 if (value > ((tp_features.bright_16levels)? 15 : 7) ||
6014 value < 0)
6015 return -EINVAL;
6017 vdbg_printk(TPACPI_DBG_BRGHT,
6018 "set backlight level to %d\n", value);
6020 res = mutex_lock_killable(&brightness_mutex);
6021 if (res < 0)
6022 return res;
6024 switch (brightness_mode) {
6025 case TPACPI_BRGHT_MODE_EC:
6026 case TPACPI_BRGHT_MODE_ECNVRAM:
6027 res = tpacpi_brightness_set_ec(value);
6028 break;
6029 case TPACPI_BRGHT_MODE_UCMS_STEP:
6030 res = tpacpi_brightness_set_ucmsstep(value);
6031 break;
6032 default:
6033 res = -ENXIO;
6036 mutex_unlock(&brightness_mutex);
6037 return res;
6040 /* sysfs backlight class ----------------------------------------------- */
6042 static int brightness_update_status(struct backlight_device *bd)
6044 unsigned int level =
6045 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6046 bd->props.power == FB_BLANK_UNBLANK) ?
6047 bd->props.brightness : 0;
6049 dbg_printk(TPACPI_DBG_BRGHT,
6050 "backlight: attempt to set level to %d\n",
6051 level);
6053 /* it is the backlight class's job (caller) to handle
6054 * EINTR and other errors properly */
6055 return brightness_set(level);
6058 static int brightness_get(struct backlight_device *bd)
6060 int status, res;
6062 res = mutex_lock_killable(&brightness_mutex);
6063 if (res < 0)
6064 return 0;
6066 res = tpacpi_brightness_get_raw(&status);
6068 mutex_unlock(&brightness_mutex);
6070 if (res < 0)
6071 return 0;
6073 return status & TP_EC_BACKLIGHT_LVLMSK;
6076 static void tpacpi_brightness_notify_change(void)
6078 backlight_force_update(ibm_backlight_device,
6079 BACKLIGHT_UPDATE_HOTKEY);
6082 static struct backlight_ops ibm_backlight_data = {
6083 .get_brightness = brightness_get,
6084 .update_status = brightness_update_status,
6087 /* --------------------------------------------------------------------- */
6090 * These are only useful for models that have only one possibility
6091 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6092 * these quirks.
6094 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6095 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6096 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6098 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6099 /* Models with ATI GPUs known to require ECNVRAM mode */
6100 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6102 /* Models with ATI GPUs that can use ECNVRAM */
6103 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC),
6104 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6105 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6106 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6108 /* Models with Intel Extreme Graphics 2 */
6109 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC),
6110 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6111 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6113 /* Models with Intel GMA900 */
6114 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6115 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6116 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6119 static int __init brightness_init(struct ibm_init_struct *iibm)
6121 int b;
6122 unsigned long quirks;
6124 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6126 mutex_init(&brightness_mutex);
6128 quirks = tpacpi_check_quirks(brightness_quirk_table,
6129 ARRAY_SIZE(brightness_quirk_table));
6132 * We always attempt to detect acpi support, so as to switch
6133 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6134 * going to publish a backlight interface
6136 b = tpacpi_check_std_acpi_brightness_support();
6137 if (b > 0) {
6139 if (acpi_video_backlight_support()) {
6140 if (brightness_enable > 1) {
6141 printk(TPACPI_NOTICE
6142 "Standard ACPI backlight interface "
6143 "available, not loading native one.\n");
6144 return 1;
6145 } else if (brightness_enable == 1) {
6146 printk(TPACPI_NOTICE
6147 "Backlight control force enabled, even if standard "
6148 "ACPI backlight interface is available\n");
6150 } else {
6151 if (brightness_enable > 1) {
6152 printk(TPACPI_NOTICE
6153 "Standard ACPI backlight interface not "
6154 "available, thinkpad_acpi native "
6155 "brightness control enabled\n");
6160 if (!brightness_enable) {
6161 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6162 "brightness support disabled by "
6163 "module parameter\n");
6164 return 1;
6167 if (b > 16) {
6168 printk(TPACPI_ERR
6169 "Unsupported brightness interface, "
6170 "please contact %s\n", TPACPI_MAIL);
6171 return 1;
6173 if (b == 16)
6174 tp_features.bright_16levels = 1;
6177 * Check for module parameter bogosity, note that we
6178 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6179 * able to detect "unspecified"
6181 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6182 return -EINVAL;
6184 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6185 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6186 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6187 if (quirks & TPACPI_BRGHT_Q_EC)
6188 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6189 else
6190 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6192 dbg_printk(TPACPI_DBG_BRGHT,
6193 "driver auto-selected brightness_mode=%d\n",
6194 brightness_mode);
6197 /* Safety */
6198 if (thinkpad_id.vendor != PCI_VENDOR_ID_IBM &&
6199 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6200 brightness_mode == TPACPI_BRGHT_MODE_EC))
6201 return -EINVAL;
6203 if (tpacpi_brightness_get_raw(&b) < 0)
6204 return 1;
6206 if (tp_features.bright_16levels)
6207 printk(TPACPI_INFO
6208 "detected a 16-level brightness capable ThinkPad\n");
6210 ibm_backlight_device = backlight_device_register(
6211 TPACPI_BACKLIGHT_DEV_NAME, NULL, NULL,
6212 &ibm_backlight_data);
6213 if (IS_ERR(ibm_backlight_device)) {
6214 int rc = PTR_ERR(ibm_backlight_device);
6215 ibm_backlight_device = NULL;
6216 printk(TPACPI_ERR "Could not register backlight device\n");
6217 return rc;
6219 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6220 "brightness is supported\n");
6222 if (quirks & TPACPI_BRGHT_Q_ASK) {
6223 printk(TPACPI_NOTICE
6224 "brightness: will use unverified default: "
6225 "brightness_mode=%d\n", brightness_mode);
6226 printk(TPACPI_NOTICE
6227 "brightness: please report to %s whether it works well "
6228 "or not on your ThinkPad\n", TPACPI_MAIL);
6231 ibm_backlight_device->props.max_brightness =
6232 (tp_features.bright_16levels)? 15 : 7;
6233 ibm_backlight_device->props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6234 backlight_update_status(ibm_backlight_device);
6236 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6237 "brightness: registering brightness hotkeys "
6238 "as change notification\n");
6239 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6240 | TP_ACPI_HKEY_BRGHTUP_MASK
6241 | TP_ACPI_HKEY_BRGHTDWN_MASK);;
6242 return 0;
6245 static void brightness_suspend(pm_message_t state)
6247 tpacpi_brightness_checkpoint_nvram();
6250 static void brightness_shutdown(void)
6252 tpacpi_brightness_checkpoint_nvram();
6255 static void brightness_exit(void)
6257 if (ibm_backlight_device) {
6258 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6259 "calling backlight_device_unregister()\n");
6260 backlight_device_unregister(ibm_backlight_device);
6263 tpacpi_brightness_checkpoint_nvram();
6266 static int brightness_read(char *p)
6268 int len = 0;
6269 int level;
6271 level = brightness_get(NULL);
6272 if (level < 0) {
6273 len += sprintf(p + len, "level:\t\tunreadable\n");
6274 } else {
6275 len += sprintf(p + len, "level:\t\t%d\n", level);
6276 len += sprintf(p + len, "commands:\tup, down\n");
6277 len += sprintf(p + len, "commands:\tlevel <level>"
6278 " (<level> is 0-%d)\n",
6279 (tp_features.bright_16levels) ? 15 : 7);
6282 return len;
6285 static int brightness_write(char *buf)
6287 int level;
6288 int rc;
6289 char *cmd;
6290 int max_level = (tp_features.bright_16levels) ? 15 : 7;
6292 level = brightness_get(NULL);
6293 if (level < 0)
6294 return level;
6296 while ((cmd = next_cmd(&buf))) {
6297 if (strlencmp(cmd, "up") == 0) {
6298 if (level < max_level)
6299 level++;
6300 } else if (strlencmp(cmd, "down") == 0) {
6301 if (level > 0)
6302 level--;
6303 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6304 level >= 0 && level <= max_level) {
6305 /* new level set */
6306 } else
6307 return -EINVAL;
6310 tpacpi_disclose_usertask("procfs brightness",
6311 "set level to %d\n", level);
6314 * Now we know what the final level should be, so we try to set it.
6315 * Doing it this way makes the syscall restartable in case of EINTR
6317 rc = brightness_set(level);
6318 if (!rc && ibm_backlight_device)
6319 backlight_force_update(ibm_backlight_device,
6320 BACKLIGHT_UPDATE_SYSFS);
6321 return (rc == -EINTR)? -ERESTARTSYS : rc;
6324 static struct ibm_struct brightness_driver_data = {
6325 .name = "brightness",
6326 .read = brightness_read,
6327 .write = brightness_write,
6328 .exit = brightness_exit,
6329 .suspend = brightness_suspend,
6330 .shutdown = brightness_shutdown,
6333 /*************************************************************************
6334 * Volume subdriver
6337 static int volume_offset = 0x30;
6339 static int volume_read(char *p)
6341 int len = 0;
6342 u8 level;
6344 if (!acpi_ec_read(volume_offset, &level)) {
6345 len += sprintf(p + len, "level:\t\tunreadable\n");
6346 } else {
6347 len += sprintf(p + len, "level:\t\t%d\n", level & 0xf);
6348 len += sprintf(p + len, "mute:\t\t%s\n", onoff(level, 6));
6349 len += sprintf(p + len, "commands:\tup, down, mute\n");
6350 len += sprintf(p + len, "commands:\tlevel <level>"
6351 " (<level> is 0-15)\n");
6354 return len;
6357 static int volume_write(char *buf)
6359 int cmos_cmd, inc, i;
6360 u8 level, mute;
6361 int new_level, new_mute;
6362 char *cmd;
6364 while ((cmd = next_cmd(&buf))) {
6365 if (!acpi_ec_read(volume_offset, &level))
6366 return -EIO;
6367 new_mute = mute = level & 0x40;
6368 new_level = level = level & 0xf;
6370 if (strlencmp(cmd, "up") == 0) {
6371 if (mute)
6372 new_mute = 0;
6373 else
6374 new_level = level == 15 ? 15 : level + 1;
6375 } else if (strlencmp(cmd, "down") == 0) {
6376 if (mute)
6377 new_mute = 0;
6378 else
6379 new_level = level == 0 ? 0 : level - 1;
6380 } else if (sscanf(cmd, "level %d", &new_level) == 1 &&
6381 new_level >= 0 && new_level <= 15) {
6382 /* new_level set */
6383 } else if (strlencmp(cmd, "mute") == 0) {
6384 new_mute = 0x40;
6385 } else
6386 return -EINVAL;
6388 if (new_level != level) {
6389 /* mute doesn't change */
6391 cmos_cmd = (new_level > level) ?
6392 TP_CMOS_VOLUME_UP : TP_CMOS_VOLUME_DOWN;
6393 inc = new_level > level ? 1 : -1;
6395 if (mute && (issue_thinkpad_cmos_command(cmos_cmd) ||
6396 !acpi_ec_write(volume_offset, level)))
6397 return -EIO;
6399 for (i = level; i != new_level; i += inc)
6400 if (issue_thinkpad_cmos_command(cmos_cmd) ||
6401 !acpi_ec_write(volume_offset, i + inc))
6402 return -EIO;
6404 if (mute &&
6405 (issue_thinkpad_cmos_command(TP_CMOS_VOLUME_MUTE) ||
6406 !acpi_ec_write(volume_offset, new_level + mute))) {
6407 return -EIO;
6411 if (new_mute != mute) {
6412 /* level doesn't change */
6414 cmos_cmd = (new_mute) ?
6415 TP_CMOS_VOLUME_MUTE : TP_CMOS_VOLUME_UP;
6417 if (issue_thinkpad_cmos_command(cmos_cmd) ||
6418 !acpi_ec_write(volume_offset, level + new_mute))
6419 return -EIO;
6423 return 0;
6426 static struct ibm_struct volume_driver_data = {
6427 .name = "volume",
6428 .read = volume_read,
6429 .write = volume_write,
6432 /*************************************************************************
6433 * Fan subdriver
6437 * FAN ACCESS MODES
6439 * TPACPI_FAN_RD_ACPI_GFAN:
6440 * ACPI GFAN method: returns fan level
6442 * see TPACPI_FAN_WR_ACPI_SFAN
6443 * EC 0x2f (HFSP) not available if GFAN exists
6445 * TPACPI_FAN_WR_ACPI_SFAN:
6446 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
6448 * EC 0x2f (HFSP) might be available *for reading*, but do not use
6449 * it for writing.
6451 * TPACPI_FAN_WR_TPEC:
6452 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
6453 * Supported on almost all ThinkPads
6455 * Fan speed changes of any sort (including those caused by the
6456 * disengaged mode) are usually done slowly by the firmware as the
6457 * maximum ammount of fan duty cycle change per second seems to be
6458 * limited.
6460 * Reading is not available if GFAN exists.
6461 * Writing is not available if SFAN exists.
6463 * Bits
6464 * 7 automatic mode engaged;
6465 * (default operation mode of the ThinkPad)
6466 * fan level is ignored in this mode.
6467 * 6 full speed mode (takes precedence over bit 7);
6468 * not available on all thinkpads. May disable
6469 * the tachometer while the fan controller ramps up
6470 * the speed (which can take up to a few *minutes*).
6471 * Speeds up fan to 100% duty-cycle, which is far above
6472 * the standard RPM levels. It is not impossible that
6473 * it could cause hardware damage.
6474 * 5-3 unused in some models. Extra bits for fan level
6475 * in others, but still useless as all values above
6476 * 7 map to the same speed as level 7 in these models.
6477 * 2-0 fan level (0..7 usually)
6478 * 0x00 = stop
6479 * 0x07 = max (set when temperatures critical)
6480 * Some ThinkPads may have other levels, see
6481 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
6483 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
6484 * boot. Apparently the EC does not intialize it, so unless ACPI DSDT
6485 * does so, its initial value is meaningless (0x07).
6487 * For firmware bugs, refer to:
6488 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
6490 * ----
6492 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
6493 * Main fan tachometer reading (in RPM)
6495 * This register is present on all ThinkPads with a new-style EC, and
6496 * it is known not to be present on the A21m/e, and T22, as there is
6497 * something else in offset 0x84 according to the ACPI DSDT. Other
6498 * ThinkPads from this same time period (and earlier) probably lack the
6499 * tachometer as well.
6501 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
6502 * was never fixed by IBM to report the EC firmware version string
6503 * probably support the tachometer (like the early X models), so
6504 * detecting it is quite hard. We need more data to know for sure.
6506 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
6507 * might result.
6509 * FIRMWARE BUG: may go stale while the EC is switching to full speed
6510 * mode.
6512 * For firmware bugs, refer to:
6513 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
6515 * ----
6517 * ThinkPad EC register 0x31 bit 0 (only on select models)
6519 * When bit 0 of EC register 0x31 is zero, the tachometer registers
6520 * show the speed of the main fan. When bit 0 of EC register 0x31
6521 * is one, the tachometer registers show the speed of the auxiliary
6522 * fan.
6524 * Fan control seems to affect both fans, regardless of the state
6525 * of this bit.
6527 * So far, only the firmware for the X60/X61 non-tablet versions
6528 * seem to support this (firmware TP-7M).
6530 * TPACPI_FAN_WR_ACPI_FANS:
6531 * ThinkPad X31, X40, X41. Not available in the X60.
6533 * FANS ACPI handle: takes three arguments: low speed, medium speed,
6534 * high speed. ACPI DSDT seems to map these three speeds to levels
6535 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
6536 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
6538 * The speeds are stored on handles
6539 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
6541 * There are three default speed sets, acessible as handles:
6542 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
6544 * ACPI DSDT switches which set is in use depending on various
6545 * factors.
6547 * TPACPI_FAN_WR_TPEC is also available and should be used to
6548 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
6549 * but the ACPI tables just mention level 7.
6552 enum { /* Fan control constants */
6553 fan_status_offset = 0x2f, /* EC register 0x2f */
6554 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
6555 * 0x84 must be read before 0x85 */
6556 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
6557 bit 0 selects which fan is active */
6559 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
6560 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
6562 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
6565 enum fan_status_access_mode {
6566 TPACPI_FAN_NONE = 0, /* No fan status or control */
6567 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
6568 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
6571 enum fan_control_access_mode {
6572 TPACPI_FAN_WR_NONE = 0, /* No fan control */
6573 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
6574 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
6575 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
6578 enum fan_control_commands {
6579 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
6580 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
6581 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
6582 * and also watchdog cmd */
6585 static int fan_control_allowed;
6587 static enum fan_status_access_mode fan_status_access_mode;
6588 static enum fan_control_access_mode fan_control_access_mode;
6589 static enum fan_control_commands fan_control_commands;
6591 static u8 fan_control_initial_status;
6592 static u8 fan_control_desired_level;
6593 static u8 fan_control_resume_level;
6594 static int fan_watchdog_maxinterval;
6596 static struct mutex fan_mutex;
6598 static void fan_watchdog_fire(struct work_struct *ignored);
6599 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
6601 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
6602 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
6603 "\\FSPD", /* 600e/x, 770e, 770x */
6604 ); /* all others */
6605 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
6606 "JFNS", /* 770x-JL */
6607 ); /* all others */
6610 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
6611 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
6612 * be in auto mode (0x80).
6614 * This is corrected by any write to HFSP either by the driver, or
6615 * by the firmware.
6617 * We assume 0x07 really means auto mode while this quirk is active,
6618 * as this is far more likely than the ThinkPad being in level 7,
6619 * which is only used by the firmware during thermal emergencies.
6621 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
6622 * TP-70 (T43, R52), which are known to be buggy.
6625 static void fan_quirk1_setup(void)
6627 if (fan_control_initial_status == 0x07) {
6628 printk(TPACPI_NOTICE
6629 "fan_init: initial fan status is unknown, "
6630 "assuming it is in auto mode\n");
6631 tp_features.fan_ctrl_status_undef = 1;
6635 static void fan_quirk1_handle(u8 *fan_status)
6637 if (unlikely(tp_features.fan_ctrl_status_undef)) {
6638 if (*fan_status != fan_control_initial_status) {
6639 /* something changed the HFSP regisnter since
6640 * driver init time, so it is not undefined
6641 * anymore */
6642 tp_features.fan_ctrl_status_undef = 0;
6643 } else {
6644 /* Return most likely status. In fact, it
6645 * might be the only possible status */
6646 *fan_status = TP_EC_FAN_AUTO;
6651 /* Select main fan on X60/X61, NOOP on others */
6652 static bool fan_select_fan1(void)
6654 if (tp_features.second_fan) {
6655 u8 val;
6657 if (ec_read(fan_select_offset, &val) < 0)
6658 return false;
6659 val &= 0xFEU;
6660 if (ec_write(fan_select_offset, val) < 0)
6661 return false;
6663 return true;
6666 /* Select secondary fan on X60/X61 */
6667 static bool fan_select_fan2(void)
6669 u8 val;
6671 if (!tp_features.second_fan)
6672 return false;
6674 if (ec_read(fan_select_offset, &val) < 0)
6675 return false;
6676 val |= 0x01U;
6677 if (ec_write(fan_select_offset, val) < 0)
6678 return false;
6680 return true;
6684 * Call with fan_mutex held
6686 static void fan_update_desired_level(u8 status)
6688 if ((status &
6689 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
6690 if (status > 7)
6691 fan_control_desired_level = 7;
6692 else
6693 fan_control_desired_level = status;
6697 static int fan_get_status(u8 *status)
6699 u8 s;
6701 /* TODO:
6702 * Add TPACPI_FAN_RD_ACPI_FANS ? */
6704 switch (fan_status_access_mode) {
6705 case TPACPI_FAN_RD_ACPI_GFAN:
6706 /* 570, 600e/x, 770e, 770x */
6708 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
6709 return -EIO;
6711 if (likely(status))
6712 *status = s & 0x07;
6714 break;
6716 case TPACPI_FAN_RD_TPEC:
6717 /* all except 570, 600e/x, 770e, 770x */
6718 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
6719 return -EIO;
6721 if (likely(status)) {
6722 *status = s;
6723 fan_quirk1_handle(status);
6726 break;
6728 default:
6729 return -ENXIO;
6732 return 0;
6735 static int fan_get_status_safe(u8 *status)
6737 int rc;
6738 u8 s;
6740 if (mutex_lock_killable(&fan_mutex))
6741 return -ERESTARTSYS;
6742 rc = fan_get_status(&s);
6743 if (!rc)
6744 fan_update_desired_level(s);
6745 mutex_unlock(&fan_mutex);
6747 if (status)
6748 *status = s;
6750 return rc;
6753 static int fan_get_speed(unsigned int *speed)
6755 u8 hi, lo;
6757 switch (fan_status_access_mode) {
6758 case TPACPI_FAN_RD_TPEC:
6759 /* all except 570, 600e/x, 770e, 770x */
6760 if (unlikely(!fan_select_fan1()))
6761 return -EIO;
6762 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
6763 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
6764 return -EIO;
6766 if (likely(speed))
6767 *speed = (hi << 8) | lo;
6769 break;
6771 default:
6772 return -ENXIO;
6775 return 0;
6778 static int fan2_get_speed(unsigned int *speed)
6780 u8 hi, lo;
6781 bool rc;
6783 switch (fan_status_access_mode) {
6784 case TPACPI_FAN_RD_TPEC:
6785 /* all except 570, 600e/x, 770e, 770x */
6786 if (unlikely(!fan_select_fan2()))
6787 return -EIO;
6788 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
6789 !acpi_ec_read(fan_rpm_offset + 1, &hi);
6790 fan_select_fan1(); /* play it safe */
6791 if (rc)
6792 return -EIO;
6794 if (likely(speed))
6795 *speed = (hi << 8) | lo;
6797 break;
6799 default:
6800 return -ENXIO;
6803 return 0;
6806 static int fan_set_level(int level)
6808 if (!fan_control_allowed)
6809 return -EPERM;
6811 switch (fan_control_access_mode) {
6812 case TPACPI_FAN_WR_ACPI_SFAN:
6813 if (level >= 0 && level <= 7) {
6814 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
6815 return -EIO;
6816 } else
6817 return -EINVAL;
6818 break;
6820 case TPACPI_FAN_WR_ACPI_FANS:
6821 case TPACPI_FAN_WR_TPEC:
6822 if (!(level & TP_EC_FAN_AUTO) &&
6823 !(level & TP_EC_FAN_FULLSPEED) &&
6824 ((level < 0) || (level > 7)))
6825 return -EINVAL;
6827 /* safety net should the EC not support AUTO
6828 * or FULLSPEED mode bits and just ignore them */
6829 if (level & TP_EC_FAN_FULLSPEED)
6830 level |= 7; /* safety min speed 7 */
6831 else if (level & TP_EC_FAN_AUTO)
6832 level |= 4; /* safety min speed 4 */
6834 if (!acpi_ec_write(fan_status_offset, level))
6835 return -EIO;
6836 else
6837 tp_features.fan_ctrl_status_undef = 0;
6838 break;
6840 default:
6841 return -ENXIO;
6844 vdbg_printk(TPACPI_DBG_FAN,
6845 "fan control: set fan control register to 0x%02x\n", level);
6846 return 0;
6849 static int fan_set_level_safe(int level)
6851 int rc;
6853 if (!fan_control_allowed)
6854 return -EPERM;
6856 if (mutex_lock_killable(&fan_mutex))
6857 return -ERESTARTSYS;
6859 if (level == TPACPI_FAN_LAST_LEVEL)
6860 level = fan_control_desired_level;
6862 rc = fan_set_level(level);
6863 if (!rc)
6864 fan_update_desired_level(level);
6866 mutex_unlock(&fan_mutex);
6867 return rc;
6870 static int fan_set_enable(void)
6872 u8 s;
6873 int rc;
6875 if (!fan_control_allowed)
6876 return -EPERM;
6878 if (mutex_lock_killable(&fan_mutex))
6879 return -ERESTARTSYS;
6881 switch (fan_control_access_mode) {
6882 case TPACPI_FAN_WR_ACPI_FANS:
6883 case TPACPI_FAN_WR_TPEC:
6884 rc = fan_get_status(&s);
6885 if (rc < 0)
6886 break;
6888 /* Don't go out of emergency fan mode */
6889 if (s != 7) {
6890 s &= 0x07;
6891 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
6894 if (!acpi_ec_write(fan_status_offset, s))
6895 rc = -EIO;
6896 else {
6897 tp_features.fan_ctrl_status_undef = 0;
6898 rc = 0;
6900 break;
6902 case TPACPI_FAN_WR_ACPI_SFAN:
6903 rc = fan_get_status(&s);
6904 if (rc < 0)
6905 break;
6907 s &= 0x07;
6909 /* Set fan to at least level 4 */
6910 s |= 4;
6912 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
6913 rc = -EIO;
6914 else
6915 rc = 0;
6916 break;
6918 default:
6919 rc = -ENXIO;
6922 mutex_unlock(&fan_mutex);
6924 if (!rc)
6925 vdbg_printk(TPACPI_DBG_FAN,
6926 "fan control: set fan control register to 0x%02x\n",
6928 return rc;
6931 static int fan_set_disable(void)
6933 int rc;
6935 if (!fan_control_allowed)
6936 return -EPERM;
6938 if (mutex_lock_killable(&fan_mutex))
6939 return -ERESTARTSYS;
6941 rc = 0;
6942 switch (fan_control_access_mode) {
6943 case TPACPI_FAN_WR_ACPI_FANS:
6944 case TPACPI_FAN_WR_TPEC:
6945 if (!acpi_ec_write(fan_status_offset, 0x00))
6946 rc = -EIO;
6947 else {
6948 fan_control_desired_level = 0;
6949 tp_features.fan_ctrl_status_undef = 0;
6951 break;
6953 case TPACPI_FAN_WR_ACPI_SFAN:
6954 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
6955 rc = -EIO;
6956 else
6957 fan_control_desired_level = 0;
6958 break;
6960 default:
6961 rc = -ENXIO;
6964 if (!rc)
6965 vdbg_printk(TPACPI_DBG_FAN,
6966 "fan control: set fan control register to 0\n");
6968 mutex_unlock(&fan_mutex);
6969 return rc;
6972 static int fan_set_speed(int speed)
6974 int rc;
6976 if (!fan_control_allowed)
6977 return -EPERM;
6979 if (mutex_lock_killable(&fan_mutex))
6980 return -ERESTARTSYS;
6982 rc = 0;
6983 switch (fan_control_access_mode) {
6984 case TPACPI_FAN_WR_ACPI_FANS:
6985 if (speed >= 0 && speed <= 65535) {
6986 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
6987 speed, speed, speed))
6988 rc = -EIO;
6989 } else
6990 rc = -EINVAL;
6991 break;
6993 default:
6994 rc = -ENXIO;
6997 mutex_unlock(&fan_mutex);
6998 return rc;
7001 static void fan_watchdog_reset(void)
7003 static int fan_watchdog_active;
7005 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7006 return;
7008 if (fan_watchdog_active)
7009 cancel_delayed_work(&fan_watchdog_task);
7011 if (fan_watchdog_maxinterval > 0 &&
7012 tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7013 fan_watchdog_active = 1;
7014 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7015 msecs_to_jiffies(fan_watchdog_maxinterval
7016 * 1000))) {
7017 printk(TPACPI_ERR
7018 "failed to queue the fan watchdog, "
7019 "watchdog will not trigger\n");
7021 } else
7022 fan_watchdog_active = 0;
7025 static void fan_watchdog_fire(struct work_struct *ignored)
7027 int rc;
7029 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7030 return;
7032 printk(TPACPI_NOTICE "fan watchdog: enabling fan\n");
7033 rc = fan_set_enable();
7034 if (rc < 0) {
7035 printk(TPACPI_ERR "fan watchdog: error %d while enabling fan, "
7036 "will try again later...\n", -rc);
7037 /* reschedule for later */
7038 fan_watchdog_reset();
7043 * SYSFS fan layout: hwmon compatible (device)
7045 * pwm*_enable:
7046 * 0: "disengaged" mode
7047 * 1: manual mode
7048 * 2: native EC "auto" mode (recommended, hardware default)
7050 * pwm*: set speed in manual mode, ignored otherwise.
7051 * 0 is level 0; 255 is level 7. Intermediate points done with linear
7052 * interpolation.
7054 * fan*_input: tachometer reading, RPM
7057 * SYSFS fan layout: extensions
7059 * fan_watchdog (driver):
7060 * fan watchdog interval in seconds, 0 disables (default), max 120
7063 /* sysfs fan pwm1_enable ----------------------------------------------- */
7064 static ssize_t fan_pwm1_enable_show(struct device *dev,
7065 struct device_attribute *attr,
7066 char *buf)
7068 int res, mode;
7069 u8 status;
7071 res = fan_get_status_safe(&status);
7072 if (res)
7073 return res;
7075 if (status & TP_EC_FAN_FULLSPEED) {
7076 mode = 0;
7077 } else if (status & TP_EC_FAN_AUTO) {
7078 mode = 2;
7079 } else
7080 mode = 1;
7082 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7085 static ssize_t fan_pwm1_enable_store(struct device *dev,
7086 struct device_attribute *attr,
7087 const char *buf, size_t count)
7089 unsigned long t;
7090 int res, level;
7092 if (parse_strtoul(buf, 2, &t))
7093 return -EINVAL;
7095 tpacpi_disclose_usertask("hwmon pwm1_enable",
7096 "set fan mode to %lu\n", t);
7098 switch (t) {
7099 case 0:
7100 level = TP_EC_FAN_FULLSPEED;
7101 break;
7102 case 1:
7103 level = TPACPI_FAN_LAST_LEVEL;
7104 break;
7105 case 2:
7106 level = TP_EC_FAN_AUTO;
7107 break;
7108 case 3:
7109 /* reserved for software-controlled auto mode */
7110 return -ENOSYS;
7111 default:
7112 return -EINVAL;
7115 res = fan_set_level_safe(level);
7116 if (res == -ENXIO)
7117 return -EINVAL;
7118 else if (res < 0)
7119 return res;
7121 fan_watchdog_reset();
7123 return count;
7126 static struct device_attribute dev_attr_fan_pwm1_enable =
7127 __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7128 fan_pwm1_enable_show, fan_pwm1_enable_store);
7130 /* sysfs fan pwm1 ------------------------------------------------------ */
7131 static ssize_t fan_pwm1_show(struct device *dev,
7132 struct device_attribute *attr,
7133 char *buf)
7135 int res;
7136 u8 status;
7138 res = fan_get_status_safe(&status);
7139 if (res)
7140 return res;
7142 if ((status &
7143 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7144 status = fan_control_desired_level;
7146 if (status > 7)
7147 status = 7;
7149 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7152 static ssize_t fan_pwm1_store(struct device *dev,
7153 struct device_attribute *attr,
7154 const char *buf, size_t count)
7156 unsigned long s;
7157 int rc;
7158 u8 status, newlevel;
7160 if (parse_strtoul(buf, 255, &s))
7161 return -EINVAL;
7163 tpacpi_disclose_usertask("hwmon pwm1",
7164 "set fan speed to %lu\n", s);
7166 /* scale down from 0-255 to 0-7 */
7167 newlevel = (s >> 5) & 0x07;
7169 if (mutex_lock_killable(&fan_mutex))
7170 return -ERESTARTSYS;
7172 rc = fan_get_status(&status);
7173 if (!rc && (status &
7174 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7175 rc = fan_set_level(newlevel);
7176 if (rc == -ENXIO)
7177 rc = -EINVAL;
7178 else if (!rc) {
7179 fan_update_desired_level(newlevel);
7180 fan_watchdog_reset();
7184 mutex_unlock(&fan_mutex);
7185 return (rc)? rc : count;
7188 static struct device_attribute dev_attr_fan_pwm1 =
7189 __ATTR(pwm1, S_IWUSR | S_IRUGO,
7190 fan_pwm1_show, fan_pwm1_store);
7192 /* sysfs fan fan1_input ------------------------------------------------ */
7193 static ssize_t fan_fan1_input_show(struct device *dev,
7194 struct device_attribute *attr,
7195 char *buf)
7197 int res;
7198 unsigned int speed;
7200 res = fan_get_speed(&speed);
7201 if (res < 0)
7202 return res;
7204 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7207 static struct device_attribute dev_attr_fan_fan1_input =
7208 __ATTR(fan1_input, S_IRUGO,
7209 fan_fan1_input_show, NULL);
7211 /* sysfs fan fan2_input ------------------------------------------------ */
7212 static ssize_t fan_fan2_input_show(struct device *dev,
7213 struct device_attribute *attr,
7214 char *buf)
7216 int res;
7217 unsigned int speed;
7219 res = fan2_get_speed(&speed);
7220 if (res < 0)
7221 return res;
7223 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7226 static struct device_attribute dev_attr_fan_fan2_input =
7227 __ATTR(fan2_input, S_IRUGO,
7228 fan_fan2_input_show, NULL);
7230 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7231 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7232 char *buf)
7234 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7237 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7238 const char *buf, size_t count)
7240 unsigned long t;
7242 if (parse_strtoul(buf, 120, &t))
7243 return -EINVAL;
7245 if (!fan_control_allowed)
7246 return -EPERM;
7248 fan_watchdog_maxinterval = t;
7249 fan_watchdog_reset();
7251 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7253 return count;
7256 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7257 fan_fan_watchdog_show, fan_fan_watchdog_store);
7259 /* --------------------------------------------------------------------- */
7260 static struct attribute *fan_attributes[] = {
7261 &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7262 &dev_attr_fan_fan1_input.attr,
7263 NULL, /* for fan2_input */
7264 NULL
7267 static const struct attribute_group fan_attr_group = {
7268 .attrs = fan_attributes,
7271 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
7272 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
7274 #define TPACPI_FAN_QI(__id1, __id2, __quirks) \
7275 { .vendor = PCI_VENDOR_ID_IBM, \
7276 .bios = TPACPI_MATCH_ANY, \
7277 .ec = TPID(__id1, __id2), \
7278 .quirks = __quirks }
7280 #define TPACPI_FAN_QL(__id1, __id2, __quirks) \
7281 { .vendor = PCI_VENDOR_ID_LENOVO, \
7282 .bios = TPACPI_MATCH_ANY, \
7283 .ec = TPID(__id1, __id2), \
7284 .quirks = __quirks }
7286 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
7287 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
7288 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
7289 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
7290 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
7291 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
7294 #undef TPACPI_FAN_QL
7295 #undef TPACPI_FAN_QI
7297 static int __init fan_init(struct ibm_init_struct *iibm)
7299 int rc;
7300 unsigned long quirks;
7302 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7303 "initializing fan subdriver\n");
7305 mutex_init(&fan_mutex);
7306 fan_status_access_mode = TPACPI_FAN_NONE;
7307 fan_control_access_mode = TPACPI_FAN_WR_NONE;
7308 fan_control_commands = 0;
7309 fan_watchdog_maxinterval = 0;
7310 tp_features.fan_ctrl_status_undef = 0;
7311 tp_features.second_fan = 0;
7312 fan_control_desired_level = 7;
7314 TPACPI_ACPIHANDLE_INIT(fans);
7315 TPACPI_ACPIHANDLE_INIT(gfan);
7316 TPACPI_ACPIHANDLE_INIT(sfan);
7318 quirks = tpacpi_check_quirks(fan_quirk_table,
7319 ARRAY_SIZE(fan_quirk_table));
7321 if (gfan_handle) {
7322 /* 570, 600e/x, 770e, 770x */
7323 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
7324 } else {
7325 /* all other ThinkPads: note that even old-style
7326 * ThinkPad ECs supports the fan control register */
7327 if (likely(acpi_ec_read(fan_status_offset,
7328 &fan_control_initial_status))) {
7329 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
7330 if (quirks & TPACPI_FAN_Q1)
7331 fan_quirk1_setup();
7332 if (quirks & TPACPI_FAN_2FAN) {
7333 tp_features.second_fan = 1;
7334 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7335 "secondary fan support enabled\n");
7337 } else {
7338 printk(TPACPI_ERR
7339 "ThinkPad ACPI EC access misbehaving, "
7340 "fan status and control unavailable\n");
7341 return 1;
7345 if (sfan_handle) {
7346 /* 570, 770x-JL */
7347 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
7348 fan_control_commands |=
7349 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
7350 } else {
7351 if (!gfan_handle) {
7352 /* gfan without sfan means no fan control */
7353 /* all other models implement TP EC 0x2f control */
7355 if (fans_handle) {
7356 /* X31, X40, X41 */
7357 fan_control_access_mode =
7358 TPACPI_FAN_WR_ACPI_FANS;
7359 fan_control_commands |=
7360 TPACPI_FAN_CMD_SPEED |
7361 TPACPI_FAN_CMD_LEVEL |
7362 TPACPI_FAN_CMD_ENABLE;
7363 } else {
7364 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
7365 fan_control_commands |=
7366 TPACPI_FAN_CMD_LEVEL |
7367 TPACPI_FAN_CMD_ENABLE;
7372 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7373 "fan is %s, modes %d, %d\n",
7374 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
7375 fan_control_access_mode != TPACPI_FAN_WR_NONE),
7376 fan_status_access_mode, fan_control_access_mode);
7378 /* fan control master switch */
7379 if (!fan_control_allowed) {
7380 fan_control_access_mode = TPACPI_FAN_WR_NONE;
7381 fan_control_commands = 0;
7382 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7383 "fan control features disabled by parameter\n");
7386 /* update fan_control_desired_level */
7387 if (fan_status_access_mode != TPACPI_FAN_NONE)
7388 fan_get_status_safe(NULL);
7390 if (fan_status_access_mode != TPACPI_FAN_NONE ||
7391 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
7392 if (tp_features.second_fan) {
7393 /* attach second fan tachometer */
7394 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
7395 &dev_attr_fan_fan2_input.attr;
7397 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
7398 &fan_attr_group);
7399 if (rc < 0)
7400 return rc;
7402 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
7403 &driver_attr_fan_watchdog);
7404 if (rc < 0) {
7405 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
7406 &fan_attr_group);
7407 return rc;
7409 return 0;
7410 } else
7411 return 1;
7414 static void fan_exit(void)
7416 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
7417 "cancelling any pending fan watchdog tasks\n");
7419 /* FIXME: can we really do this unconditionally? */
7420 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
7421 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
7422 &driver_attr_fan_watchdog);
7424 cancel_delayed_work(&fan_watchdog_task);
7425 flush_workqueue(tpacpi_wq);
7428 static void fan_suspend(pm_message_t state)
7430 int rc;
7432 if (!fan_control_allowed)
7433 return;
7435 /* Store fan status in cache */
7436 fan_control_resume_level = 0;
7437 rc = fan_get_status_safe(&fan_control_resume_level);
7438 if (rc < 0)
7439 printk(TPACPI_NOTICE
7440 "failed to read fan level for later "
7441 "restore during resume: %d\n", rc);
7443 /* if it is undefined, don't attempt to restore it.
7444 * KEEP THIS LAST */
7445 if (tp_features.fan_ctrl_status_undef)
7446 fan_control_resume_level = 0;
7449 static void fan_resume(void)
7451 u8 current_level = 7;
7452 bool do_set = false;
7453 int rc;
7455 /* DSDT *always* updates status on resume */
7456 tp_features.fan_ctrl_status_undef = 0;
7458 if (!fan_control_allowed ||
7459 !fan_control_resume_level ||
7460 (fan_get_status_safe(&current_level) < 0))
7461 return;
7463 switch (fan_control_access_mode) {
7464 case TPACPI_FAN_WR_ACPI_SFAN:
7465 /* never decrease fan level */
7466 do_set = (fan_control_resume_level > current_level);
7467 break;
7468 case TPACPI_FAN_WR_ACPI_FANS:
7469 case TPACPI_FAN_WR_TPEC:
7470 /* never decrease fan level, scale is:
7471 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
7473 * We expect the firmware to set either 7 or AUTO, but we
7474 * handle FULLSPEED out of paranoia.
7476 * So, we can safely only restore FULLSPEED or 7, anything
7477 * else could slow the fan. Restoring AUTO is useless, at
7478 * best that's exactly what the DSDT already set (it is the
7479 * slower it uses).
7481 * Always keep in mind that the DSDT *will* have set the
7482 * fans to what the vendor supposes is the best level. We
7483 * muck with it only to speed the fan up.
7485 if (fan_control_resume_level != 7 &&
7486 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
7487 return;
7488 else
7489 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
7490 (current_level != fan_control_resume_level);
7491 break;
7492 default:
7493 return;
7495 if (do_set) {
7496 printk(TPACPI_NOTICE
7497 "restoring fan level to 0x%02x\n",
7498 fan_control_resume_level);
7499 rc = fan_set_level_safe(fan_control_resume_level);
7500 if (rc < 0)
7501 printk(TPACPI_NOTICE
7502 "failed to restore fan level: %d\n", rc);
7506 static int fan_read(char *p)
7508 int len = 0;
7509 int rc;
7510 u8 status;
7511 unsigned int speed = 0;
7513 switch (fan_status_access_mode) {
7514 case TPACPI_FAN_RD_ACPI_GFAN:
7515 /* 570, 600e/x, 770e, 770x */
7516 rc = fan_get_status_safe(&status);
7517 if (rc < 0)
7518 return rc;
7520 len += sprintf(p + len, "status:\t\t%s\n"
7521 "level:\t\t%d\n",
7522 (status != 0) ? "enabled" : "disabled", status);
7523 break;
7525 case TPACPI_FAN_RD_TPEC:
7526 /* all except 570, 600e/x, 770e, 770x */
7527 rc = fan_get_status_safe(&status);
7528 if (rc < 0)
7529 return rc;
7531 len += sprintf(p + len, "status:\t\t%s\n",
7532 (status != 0) ? "enabled" : "disabled");
7534 rc = fan_get_speed(&speed);
7535 if (rc < 0)
7536 return rc;
7538 len += sprintf(p + len, "speed:\t\t%d\n", speed);
7540 if (status & TP_EC_FAN_FULLSPEED)
7541 /* Disengaged mode takes precedence */
7542 len += sprintf(p + len, "level:\t\tdisengaged\n");
7543 else if (status & TP_EC_FAN_AUTO)
7544 len += sprintf(p + len, "level:\t\tauto\n");
7545 else
7546 len += sprintf(p + len, "level:\t\t%d\n", status);
7547 break;
7549 case TPACPI_FAN_NONE:
7550 default:
7551 len += sprintf(p + len, "status:\t\tnot supported\n");
7554 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
7555 len += sprintf(p + len, "commands:\tlevel <level>");
7557 switch (fan_control_access_mode) {
7558 case TPACPI_FAN_WR_ACPI_SFAN:
7559 len += sprintf(p + len, " (<level> is 0-7)\n");
7560 break;
7562 default:
7563 len += sprintf(p + len, " (<level> is 0-7, "
7564 "auto, disengaged, full-speed)\n");
7565 break;
7569 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
7570 len += sprintf(p + len, "commands:\tenable, disable\n"
7571 "commands:\twatchdog <timeout> (<timeout> "
7572 "is 0 (off), 1-120 (seconds))\n");
7574 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
7575 len += sprintf(p + len, "commands:\tspeed <speed>"
7576 " (<speed> is 0-65535)\n");
7578 return len;
7581 static int fan_write_cmd_level(const char *cmd, int *rc)
7583 int level;
7585 if (strlencmp(cmd, "level auto") == 0)
7586 level = TP_EC_FAN_AUTO;
7587 else if ((strlencmp(cmd, "level disengaged") == 0) |
7588 (strlencmp(cmd, "level full-speed") == 0))
7589 level = TP_EC_FAN_FULLSPEED;
7590 else if (sscanf(cmd, "level %d", &level) != 1)
7591 return 0;
7593 *rc = fan_set_level_safe(level);
7594 if (*rc == -ENXIO)
7595 printk(TPACPI_ERR "level command accepted for unsupported "
7596 "access mode %d", fan_control_access_mode);
7597 else if (!*rc)
7598 tpacpi_disclose_usertask("procfs fan",
7599 "set level to %d\n", level);
7601 return 1;
7604 static int fan_write_cmd_enable(const char *cmd, int *rc)
7606 if (strlencmp(cmd, "enable") != 0)
7607 return 0;
7609 *rc = fan_set_enable();
7610 if (*rc == -ENXIO)
7611 printk(TPACPI_ERR "enable command accepted for unsupported "
7612 "access mode %d", fan_control_access_mode);
7613 else if (!*rc)
7614 tpacpi_disclose_usertask("procfs fan", "enable\n");
7616 return 1;
7619 static int fan_write_cmd_disable(const char *cmd, int *rc)
7621 if (strlencmp(cmd, "disable") != 0)
7622 return 0;
7624 *rc = fan_set_disable();
7625 if (*rc == -ENXIO)
7626 printk(TPACPI_ERR "disable command accepted for unsupported "
7627 "access mode %d", fan_control_access_mode);
7628 else if (!*rc)
7629 tpacpi_disclose_usertask("procfs fan", "disable\n");
7631 return 1;
7634 static int fan_write_cmd_speed(const char *cmd, int *rc)
7636 int speed;
7638 /* TODO:
7639 * Support speed <low> <medium> <high> ? */
7641 if (sscanf(cmd, "speed %d", &speed) != 1)
7642 return 0;
7644 *rc = fan_set_speed(speed);
7645 if (*rc == -ENXIO)
7646 printk(TPACPI_ERR "speed command accepted for unsupported "
7647 "access mode %d", fan_control_access_mode);
7648 else if (!*rc)
7649 tpacpi_disclose_usertask("procfs fan",
7650 "set speed to %d\n", speed);
7652 return 1;
7655 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
7657 int interval;
7659 if (sscanf(cmd, "watchdog %d", &interval) != 1)
7660 return 0;
7662 if (interval < 0 || interval > 120)
7663 *rc = -EINVAL;
7664 else {
7665 fan_watchdog_maxinterval = interval;
7666 tpacpi_disclose_usertask("procfs fan",
7667 "set watchdog timer to %d\n",
7668 interval);
7671 return 1;
7674 static int fan_write(char *buf)
7676 char *cmd;
7677 int rc = 0;
7679 while (!rc && (cmd = next_cmd(&buf))) {
7680 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
7681 fan_write_cmd_level(cmd, &rc)) &&
7682 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
7683 (fan_write_cmd_enable(cmd, &rc) ||
7684 fan_write_cmd_disable(cmd, &rc) ||
7685 fan_write_cmd_watchdog(cmd, &rc))) &&
7686 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
7687 fan_write_cmd_speed(cmd, &rc))
7689 rc = -EINVAL;
7690 else if (!rc)
7691 fan_watchdog_reset();
7694 return rc;
7697 static struct ibm_struct fan_driver_data = {
7698 .name = "fan",
7699 .read = fan_read,
7700 .write = fan_write,
7701 .exit = fan_exit,
7702 .suspend = fan_suspend,
7703 .resume = fan_resume,
7706 /****************************************************************************
7707 ****************************************************************************
7709 * Infrastructure
7711 ****************************************************************************
7712 ****************************************************************************/
7715 * HKEY event callout for other subdrivers go here
7716 * (yes, it is ugly, but it is quick, safe, and gets the job done
7718 static void tpacpi_driver_event(const unsigned int hkey_event)
7720 if (ibm_backlight_device) {
7721 switch (hkey_event) {
7722 case TP_HKEY_EV_BRGHT_UP:
7723 case TP_HKEY_EV_BRGHT_DOWN:
7724 tpacpi_brightness_notify_change();
7731 static void hotkey_driver_event(const unsigned int scancode)
7733 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
7736 /* sysfs name ---------------------------------------------------------- */
7737 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
7738 struct device_attribute *attr,
7739 char *buf)
7741 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
7744 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
7745 __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
7747 /* --------------------------------------------------------------------- */
7749 /* /proc support */
7750 static struct proc_dir_entry *proc_dir;
7753 * Module and infrastructure proble, init and exit handling
7756 static int force_load;
7758 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
7759 static const char * __init str_supported(int is_supported)
7761 static char text_unsupported[] __initdata = "not supported";
7763 return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
7765 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
7767 static void ibm_exit(struct ibm_struct *ibm)
7769 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
7771 list_del_init(&ibm->all_drivers);
7773 if (ibm->flags.acpi_notify_installed) {
7774 dbg_printk(TPACPI_DBG_EXIT,
7775 "%s: acpi_remove_notify_handler\n", ibm->name);
7776 BUG_ON(!ibm->acpi);
7777 acpi_remove_notify_handler(*ibm->acpi->handle,
7778 ibm->acpi->type,
7779 dispatch_acpi_notify);
7780 ibm->flags.acpi_notify_installed = 0;
7781 ibm->flags.acpi_notify_installed = 0;
7784 if (ibm->flags.proc_created) {
7785 dbg_printk(TPACPI_DBG_EXIT,
7786 "%s: remove_proc_entry\n", ibm->name);
7787 remove_proc_entry(ibm->name, proc_dir);
7788 ibm->flags.proc_created = 0;
7791 if (ibm->flags.acpi_driver_registered) {
7792 dbg_printk(TPACPI_DBG_EXIT,
7793 "%s: acpi_bus_unregister_driver\n", ibm->name);
7794 BUG_ON(!ibm->acpi);
7795 acpi_bus_unregister_driver(ibm->acpi->driver);
7796 kfree(ibm->acpi->driver);
7797 ibm->acpi->driver = NULL;
7798 ibm->flags.acpi_driver_registered = 0;
7801 if (ibm->flags.init_called && ibm->exit) {
7802 ibm->exit();
7803 ibm->flags.init_called = 0;
7806 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
7809 static int __init ibm_init(struct ibm_init_struct *iibm)
7811 int ret;
7812 struct ibm_struct *ibm = iibm->data;
7813 struct proc_dir_entry *entry;
7815 BUG_ON(ibm == NULL);
7817 INIT_LIST_HEAD(&ibm->all_drivers);
7819 if (ibm->flags.experimental && !experimental)
7820 return 0;
7822 dbg_printk(TPACPI_DBG_INIT,
7823 "probing for %s\n", ibm->name);
7825 if (iibm->init) {
7826 ret = iibm->init(iibm);
7827 if (ret > 0)
7828 return 0; /* probe failed */
7829 if (ret)
7830 return ret;
7832 ibm->flags.init_called = 1;
7835 if (ibm->acpi) {
7836 if (ibm->acpi->hid) {
7837 ret = register_tpacpi_subdriver(ibm);
7838 if (ret)
7839 goto err_out;
7842 if (ibm->acpi->notify) {
7843 ret = setup_acpi_notify(ibm);
7844 if (ret == -ENODEV) {
7845 printk(TPACPI_NOTICE "disabling subdriver %s\n",
7846 ibm->name);
7847 ret = 0;
7848 goto err_out;
7850 if (ret < 0)
7851 goto err_out;
7855 dbg_printk(TPACPI_DBG_INIT,
7856 "%s installed\n", ibm->name);
7858 if (ibm->read) {
7859 entry = create_proc_entry(ibm->name,
7860 S_IFREG | S_IRUGO | S_IWUSR,
7861 proc_dir);
7862 if (!entry) {
7863 printk(TPACPI_ERR "unable to create proc entry %s\n",
7864 ibm->name);
7865 ret = -ENODEV;
7866 goto err_out;
7868 entry->data = ibm;
7869 entry->read_proc = &dispatch_procfs_read;
7870 if (ibm->write)
7871 entry->write_proc = &dispatch_procfs_write;
7872 ibm->flags.proc_created = 1;
7875 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
7877 return 0;
7879 err_out:
7880 dbg_printk(TPACPI_DBG_INIT,
7881 "%s: at error exit path with result %d\n",
7882 ibm->name, ret);
7884 ibm_exit(ibm);
7885 return (ret < 0)? ret : 0;
7888 /* Probing */
7890 static bool __pure __init tpacpi_is_fw_digit(const char c)
7892 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
7895 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
7896 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
7897 const char t)
7899 return s && strlen(s) >= 8 &&
7900 tpacpi_is_fw_digit(s[0]) &&
7901 tpacpi_is_fw_digit(s[1]) &&
7902 s[2] == t && s[3] == 'T' &&
7903 tpacpi_is_fw_digit(s[4]) &&
7904 tpacpi_is_fw_digit(s[5]) &&
7905 s[6] == 'W' && s[7] == 'W';
7908 /* returns 0 - probe ok, or < 0 - probe error.
7909 * Probe ok doesn't mean thinkpad found.
7910 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
7911 static int __must_check __init get_thinkpad_model_data(
7912 struct thinkpad_id_data *tp)
7914 const struct dmi_device *dev = NULL;
7915 char ec_fw_string[18];
7916 char const *s;
7918 if (!tp)
7919 return -EINVAL;
7921 memset(tp, 0, sizeof(*tp));
7923 if (dmi_name_in_vendors("IBM"))
7924 tp->vendor = PCI_VENDOR_ID_IBM;
7925 else if (dmi_name_in_vendors("LENOVO"))
7926 tp->vendor = PCI_VENDOR_ID_LENOVO;
7927 else
7928 return 0;
7930 s = dmi_get_system_info(DMI_BIOS_VERSION);
7931 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
7932 if (s && !tp->bios_version_str)
7933 return -ENOMEM;
7935 /* Really ancient ThinkPad 240X will fail this, which is fine */
7936 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
7937 return 0;
7939 tp->bios_model = tp->bios_version_str[0]
7940 | (tp->bios_version_str[1] << 8);
7941 tp->bios_release = (tp->bios_version_str[4] << 8)
7942 | tp->bios_version_str[5];
7945 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
7946 * X32 or newer, all Z series; Some models must have an
7947 * up-to-date BIOS or they will not be detected.
7949 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
7951 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
7952 if (sscanf(dev->name,
7953 "IBM ThinkPad Embedded Controller -[%17c",
7954 ec_fw_string) == 1) {
7955 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
7956 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
7958 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
7959 if (!tp->ec_version_str)
7960 return -ENOMEM;
7962 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
7963 tp->ec_model = ec_fw_string[0]
7964 | (ec_fw_string[1] << 8);
7965 tp->ec_release = (ec_fw_string[4] << 8)
7966 | ec_fw_string[5];
7967 } else {
7968 printk(TPACPI_NOTICE
7969 "ThinkPad firmware release %s "
7970 "doesn't match the known patterns\n",
7971 ec_fw_string);
7972 printk(TPACPI_NOTICE
7973 "please report this to %s\n",
7974 TPACPI_MAIL);
7976 break;
7980 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
7981 if (s && !strnicmp(s, "ThinkPad", 8)) {
7982 tp->model_str = kstrdup(s, GFP_KERNEL);
7983 if (!tp->model_str)
7984 return -ENOMEM;
7987 s = dmi_get_system_info(DMI_PRODUCT_NAME);
7988 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
7989 if (s && !tp->nummodel_str)
7990 return -ENOMEM;
7992 return 0;
7995 static int __init probe_for_thinkpad(void)
7997 int is_thinkpad;
7999 if (acpi_disabled)
8000 return -ENODEV;
8003 * Non-ancient models have better DMI tagging, but very old models
8004 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
8006 is_thinkpad = (thinkpad_id.model_str != NULL) ||
8007 (thinkpad_id.ec_model != 0) ||
8008 tpacpi_is_fw_known();
8010 /* ec is required because many other handles are relative to it */
8011 TPACPI_ACPIHANDLE_INIT(ec);
8012 if (!ec_handle) {
8013 if (is_thinkpad)
8014 printk(TPACPI_ERR
8015 "Not yet supported ThinkPad detected!\n");
8016 return -ENODEV;
8019 if (!is_thinkpad && !force_load)
8020 return -ENODEV;
8022 return 0;
8026 /* Module init, exit, parameters */
8028 static struct ibm_init_struct ibms_init[] __initdata = {
8030 .init = thinkpad_acpi_driver_init,
8031 .data = &thinkpad_acpi_driver_data,
8034 .init = hotkey_init,
8035 .data = &hotkey_driver_data,
8038 .init = bluetooth_init,
8039 .data = &bluetooth_driver_data,
8042 .init = wan_init,
8043 .data = &wan_driver_data,
8046 .init = uwb_init,
8047 .data = &uwb_driver_data,
8049 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8051 .init = video_init,
8052 .data = &video_driver_data,
8054 #endif
8056 .init = light_init,
8057 .data = &light_driver_data,
8060 .init = cmos_init,
8061 .data = &cmos_driver_data,
8064 .init = led_init,
8065 .data = &led_driver_data,
8068 .init = beep_init,
8069 .data = &beep_driver_data,
8072 .init = thermal_init,
8073 .data = &thermal_driver_data,
8076 .data = &ecdump_driver_data,
8079 .init = brightness_init,
8080 .data = &brightness_driver_data,
8083 .data = &volume_driver_data,
8086 .init = fan_init,
8087 .data = &fan_driver_data,
8091 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8093 unsigned int i;
8094 struct ibm_struct *ibm;
8096 if (!kp || !kp->name || !val)
8097 return -EINVAL;
8099 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8100 ibm = ibms_init[i].data;
8101 WARN_ON(ibm == NULL);
8103 if (!ibm || !ibm->name)
8104 continue;
8106 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8107 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8108 return -ENOSPC;
8109 strcpy(ibms_init[i].param, val);
8110 strcat(ibms_init[i].param, ",");
8111 return 0;
8115 return -EINVAL;
8118 module_param(experimental, int, 0);
8119 MODULE_PARM_DESC(experimental,
8120 "Enables experimental features when non-zero");
8122 module_param_named(debug, dbg_level, uint, 0);
8123 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8125 module_param(force_load, bool, 0);
8126 MODULE_PARM_DESC(force_load,
8127 "Attempts to load the driver even on a "
8128 "mis-identified ThinkPad when true");
8130 module_param_named(fan_control, fan_control_allowed, bool, 0);
8131 MODULE_PARM_DESC(fan_control,
8132 "Enables setting fan parameters features when true");
8134 module_param_named(brightness_mode, brightness_mode, uint, 0);
8135 MODULE_PARM_DESC(brightness_mode,
8136 "Selects brightness control strategy: "
8137 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8139 module_param(brightness_enable, uint, 0);
8140 MODULE_PARM_DESC(brightness_enable,
8141 "Enables backlight control when 1, disables when 0");
8143 module_param(hotkey_report_mode, uint, 0);
8144 MODULE_PARM_DESC(hotkey_report_mode,
8145 "used for backwards compatibility with userspace, "
8146 "see documentation");
8148 #define TPACPI_PARAM(feature) \
8149 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8150 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8151 "at module load, see documentation")
8153 TPACPI_PARAM(hotkey);
8154 TPACPI_PARAM(bluetooth);
8155 TPACPI_PARAM(video);
8156 TPACPI_PARAM(light);
8157 TPACPI_PARAM(cmos);
8158 TPACPI_PARAM(led);
8159 TPACPI_PARAM(beep);
8160 TPACPI_PARAM(ecdump);
8161 TPACPI_PARAM(brightness);
8162 TPACPI_PARAM(volume);
8163 TPACPI_PARAM(fan);
8165 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8166 module_param(dbg_wlswemul, uint, 0);
8167 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8168 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8169 MODULE_PARM_DESC(wlsw_state,
8170 "Initial state of the emulated WLSW switch");
8172 module_param(dbg_bluetoothemul, uint, 0);
8173 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8174 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8175 MODULE_PARM_DESC(bluetooth_state,
8176 "Initial state of the emulated bluetooth switch");
8178 module_param(dbg_wwanemul, uint, 0);
8179 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8180 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8181 MODULE_PARM_DESC(wwan_state,
8182 "Initial state of the emulated WWAN switch");
8184 module_param(dbg_uwbemul, uint, 0);
8185 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8186 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8187 MODULE_PARM_DESC(uwb_state,
8188 "Initial state of the emulated UWB switch");
8189 #endif
8191 static void thinkpad_acpi_module_exit(void)
8193 struct ibm_struct *ibm, *itmp;
8195 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8197 list_for_each_entry_safe_reverse(ibm, itmp,
8198 &tpacpi_all_drivers,
8199 all_drivers) {
8200 ibm_exit(ibm);
8203 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8205 if (tpacpi_inputdev) {
8206 if (tp_features.input_device_registered)
8207 input_unregister_device(tpacpi_inputdev);
8208 else
8209 input_free_device(tpacpi_inputdev);
8212 if (tpacpi_hwmon)
8213 hwmon_device_unregister(tpacpi_hwmon);
8215 if (tp_features.sensors_pdev_attrs_registered)
8216 device_remove_file(&tpacpi_sensors_pdev->dev,
8217 &dev_attr_thinkpad_acpi_pdev_name);
8218 if (tpacpi_sensors_pdev)
8219 platform_device_unregister(tpacpi_sensors_pdev);
8220 if (tpacpi_pdev)
8221 platform_device_unregister(tpacpi_pdev);
8223 if (tp_features.sensors_pdrv_attrs_registered)
8224 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8225 if (tp_features.platform_drv_attrs_registered)
8226 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8228 if (tp_features.sensors_pdrv_registered)
8229 platform_driver_unregister(&tpacpi_hwmon_pdriver);
8231 if (tp_features.platform_drv_registered)
8232 platform_driver_unregister(&tpacpi_pdriver);
8234 if (proc_dir)
8235 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
8237 if (tpacpi_wq)
8238 destroy_workqueue(tpacpi_wq);
8240 kfree(thinkpad_id.bios_version_str);
8241 kfree(thinkpad_id.ec_version_str);
8242 kfree(thinkpad_id.model_str);
8246 static int __init thinkpad_acpi_module_init(void)
8248 int ret, i;
8250 tpacpi_lifecycle = TPACPI_LIFE_INIT;
8252 /* Parameter checking */
8253 if (hotkey_report_mode > 2)
8254 return -EINVAL;
8256 /* Driver-level probe */
8258 ret = get_thinkpad_model_data(&thinkpad_id);
8259 if (ret) {
8260 printk(TPACPI_ERR
8261 "unable to get DMI data: %d\n", ret);
8262 thinkpad_acpi_module_exit();
8263 return ret;
8265 ret = probe_for_thinkpad();
8266 if (ret) {
8267 thinkpad_acpi_module_exit();
8268 return ret;
8271 /* Driver initialization */
8273 TPACPI_ACPIHANDLE_INIT(ecrd);
8274 TPACPI_ACPIHANDLE_INIT(ecwr);
8276 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
8277 if (!tpacpi_wq) {
8278 thinkpad_acpi_module_exit();
8279 return -ENOMEM;
8282 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
8283 if (!proc_dir) {
8284 printk(TPACPI_ERR
8285 "unable to create proc dir " TPACPI_PROC_DIR);
8286 thinkpad_acpi_module_exit();
8287 return -ENODEV;
8290 ret = platform_driver_register(&tpacpi_pdriver);
8291 if (ret) {
8292 printk(TPACPI_ERR
8293 "unable to register main platform driver\n");
8294 thinkpad_acpi_module_exit();
8295 return ret;
8297 tp_features.platform_drv_registered = 1;
8299 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
8300 if (ret) {
8301 printk(TPACPI_ERR
8302 "unable to register hwmon platform driver\n");
8303 thinkpad_acpi_module_exit();
8304 return ret;
8306 tp_features.sensors_pdrv_registered = 1;
8308 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
8309 if (!ret) {
8310 tp_features.platform_drv_attrs_registered = 1;
8311 ret = tpacpi_create_driver_attributes(
8312 &tpacpi_hwmon_pdriver.driver);
8314 if (ret) {
8315 printk(TPACPI_ERR
8316 "unable to create sysfs driver attributes\n");
8317 thinkpad_acpi_module_exit();
8318 return ret;
8320 tp_features.sensors_pdrv_attrs_registered = 1;
8323 /* Device initialization */
8324 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
8325 NULL, 0);
8326 if (IS_ERR(tpacpi_pdev)) {
8327 ret = PTR_ERR(tpacpi_pdev);
8328 tpacpi_pdev = NULL;
8329 printk(TPACPI_ERR "unable to register platform device\n");
8330 thinkpad_acpi_module_exit();
8331 return ret;
8333 tpacpi_sensors_pdev = platform_device_register_simple(
8334 TPACPI_HWMON_DRVR_NAME,
8335 -1, NULL, 0);
8336 if (IS_ERR(tpacpi_sensors_pdev)) {
8337 ret = PTR_ERR(tpacpi_sensors_pdev);
8338 tpacpi_sensors_pdev = NULL;
8339 printk(TPACPI_ERR
8340 "unable to register hwmon platform device\n");
8341 thinkpad_acpi_module_exit();
8342 return ret;
8344 ret = device_create_file(&tpacpi_sensors_pdev->dev,
8345 &dev_attr_thinkpad_acpi_pdev_name);
8346 if (ret) {
8347 printk(TPACPI_ERR
8348 "unable to create sysfs hwmon device attributes\n");
8349 thinkpad_acpi_module_exit();
8350 return ret;
8352 tp_features.sensors_pdev_attrs_registered = 1;
8353 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
8354 if (IS_ERR(tpacpi_hwmon)) {
8355 ret = PTR_ERR(tpacpi_hwmon);
8356 tpacpi_hwmon = NULL;
8357 printk(TPACPI_ERR "unable to register hwmon device\n");
8358 thinkpad_acpi_module_exit();
8359 return ret;
8361 mutex_init(&tpacpi_inputdev_send_mutex);
8362 tpacpi_inputdev = input_allocate_device();
8363 if (!tpacpi_inputdev) {
8364 printk(TPACPI_ERR "unable to allocate input device\n");
8365 thinkpad_acpi_module_exit();
8366 return -ENOMEM;
8367 } else {
8368 /* Prepare input device, but don't register */
8369 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
8370 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
8371 tpacpi_inputdev->id.bustype = BUS_HOST;
8372 tpacpi_inputdev->id.vendor = (thinkpad_id.vendor) ?
8373 thinkpad_id.vendor :
8374 PCI_VENDOR_ID_IBM;
8375 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
8376 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
8377 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
8379 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8380 ret = ibm_init(&ibms_init[i]);
8381 if (ret >= 0 && *ibms_init[i].param)
8382 ret = ibms_init[i].data->write(ibms_init[i].param);
8383 if (ret < 0) {
8384 thinkpad_acpi_module_exit();
8385 return ret;
8388 ret = input_register_device(tpacpi_inputdev);
8389 if (ret < 0) {
8390 printk(TPACPI_ERR "unable to register input device\n");
8391 thinkpad_acpi_module_exit();
8392 return ret;
8393 } else {
8394 tp_features.input_device_registered = 1;
8397 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
8398 return 0;
8401 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
8404 * This will autoload the driver in almost every ThinkPad
8405 * in widespread use.
8407 * Only _VERY_ old models, like the 240, 240x and 570 lack
8408 * the HKEY event interface.
8410 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
8413 * DMI matching for module autoloading
8415 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8416 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
8418 * Only models listed in thinkwiki will be supported, so add yours
8419 * if it is not there yet.
8421 #define IBM_BIOS_MODULE_ALIAS(__type) \
8422 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
8424 /* Ancient thinkpad BIOSes have to be identified by
8425 * BIOS type or model number, and there are far less
8426 * BIOS types than model numbers... */
8427 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
8429 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
8430 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
8431 MODULE_DESCRIPTION(TPACPI_DESC);
8432 MODULE_VERSION(TPACPI_VERSION);
8433 MODULE_LICENSE("GPL");
8435 module_init(thinkpad_acpi_module_init);
8436 module_exit(thinkpad_acpi_module_exit);