thinkpad-acpi: fix detection of old ThinkPads
[daniel-s-linux-stuff:linux-kernel.git] / drivers / platform / x86 / thinkpad_acpi.c
1 /*
2  *  thinkpad_acpi.c - ThinkPad ACPI Extras
3  *
4  *
5  *  Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6  *  Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
7  *
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.
12  *
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.
17  *
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.
22  */
23
24 #define TPACPI_VERSION "0.23"
25 #define TPACPI_SYSFS_VERSION 0x020500
26
27 /*
28  *  Changelog:
29  *  2007-10-20          changelog trimmed down
30  *
31  *  2007-03-27  0.14    renamed to thinkpad_acpi and moved to
32  *                      drivers/misc.
33  *
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.
37  *
38  *  2005-03-17  0.11    support for 600e, 770x
39  *                          thanks to Jamie Lentin <lentinj@dial.pipex.com>
40  *
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>
48  */
49
50 #include <linux/kernel.h>
51 #include <linux/module.h>
52 #include <linux/init.h>
53 #include <linux/types.h>
54 #include <linux/string.h>
55 #include <linux/list.h>
56 #include <linux/mutex.h>
57 #include <linux/sched.h>
58 #include <linux/kthread.h>
59 #include <linux/freezer.h>
60 #include <linux/delay.h>
61
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>
74
75 #include <linux/dmi.h>
76 #include <linux/jiffies.h>
77 #include <linux/workqueue.h>
78
79 #include <acpi/acpi_drivers.h>
80
81 #include <linux/pci_ids.h>
82
83
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
92
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,
100 };
101
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,
117 };
118
119 /* ACPI HIDs */
120 #define TPACPI_ACPI_HKEY_HID            "IBM0068"
121
122 /* Input IDs */
123 #define TPACPI_HKEY_INPUT_PRODUCT       0x5054 /* "TP" */
124 #define TPACPI_HKEY_INPUT_VERSION       0x4101
125
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 */
132 };
133
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 */
146 };
147
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 */
157
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 */
165
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 */
169
170         /* Misc bay events */
171         TP_HKEY_EV_OPTDRV_EJ            = 0x3006, /* opt. drive tray ejected */
172
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 */
181
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 */
188
189         /* Misc */
190         TP_HKEY_EV_RFKILL_CHANGED       = 0x7000, /* rfkill switch changed */
191 };
192
193 /****************************************************************************
194  * Main driver
195  */
196
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"
202
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"
208
209 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
210 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
211
212 #define TPACPI_MAX_ACPI_ARGS 3
213
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
224
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
234
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)))
238
239
240 /****************************************************************************
241  * Driver-wide structs and misc. variables
242  */
243
244 struct ibm_struct;
245
246 struct tp_acpi_drv_struct {
247         const struct acpi_device_id *hid;
248         struct acpi_driver *driver;
249
250         void (*notify) (struct ibm_struct *, u32);
251         acpi_handle *handle;
252         u32 type;
253         struct acpi_device *device;
254 };
255
256 struct ibm_struct {
257         char *name;
258
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);
265
266         struct list_head all_drivers;
267
268         struct tp_acpi_drv_struct *acpi;
269
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;
277 };
278
279 struct ibm_init_struct {
280         char param[32];
281
282         int (*init) (struct ibm_init_struct *);
283         struct ibm_struct *data;
284 };
285
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;
309
310 static struct {
311         u16 hotkey_mask_ff:1;
312 } tp_warned;
313
314 struct thinkpad_id_data {
315         unsigned int vendor;    /* ThinkPad vendor:
316                                  * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
317
318         char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
319         char *ec_version_str;   /* Something like 1ZHT51WW-1.04a */
320
321         u16 bios_model;         /* 1Y = 0x5931, 0 = unknown */
322         u16 ec_model;
323         u16 bios_release;       /* 1ZETK1WW = 0x314b, 0 = unknown */
324         u16 ec_release;
325
326         char *model_str;        /* ThinkPad T43 */
327         char *nummodel_str;     /* 9384A9C for a 9384-A9C model */
328 };
329 static struct thinkpad_id_data thinkpad_id;
330
331 static enum {
332         TPACPI_LIFE_INIT = 0,
333         TPACPI_LIFE_RUNNING,
334         TPACPI_LIFE_EXITING,
335 } tpacpi_lifecycle;
336
337 static int experimental;
338 static u32 dbg_level;
339
340 static struct workqueue_struct *tpacpi_wq;
341
342 enum led_status_t {
343         TPACPI_LED_OFF = 0,
344         TPACPI_LED_ON,
345         TPACPI_LED_BLINK,
346 };
347
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;
354 };
355
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
366
367
368 /*************************************************************************
369  *  Debugging helpers
370  */
371
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)
376
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
384
385 static void tpacpi_log_usertask(const char * const what)
386 {
387         printk(TPACPI_DEBUG "%s: access by process with PID %d\n",
388                 what, task_tgid_vnr(current));
389 }
390
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); \
398                 } \
399         } while (0)
400
401 /*
402  * Quirk handling helpers
403  *
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.
406  *
407  * We use values well outside that range as specials.
408  */
409
410 #define TPACPI_MATCH_ANY                0xffffU
411 #define TPACPI_MATCH_UNKNOWN            0U
412
413 /* TPID('1', 'Y') == 0x5931 */
414 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
415
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) }
421
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) }
427
428 struct tpacpi_quirk {
429         unsigned int vendor;
430         u16 bios;
431         u16 ec;
432         unsigned long quirks;
433 };
434
435 /**
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
439  *
440  * Iterates over a quirks list until one is found that matches the
441  * ThinkPad's vendor, BIOS and EC model.
442  *
443  * Returns 0 if nothing matches, otherwise returns the quirks field of
444  * the matching &struct tpacpi_quirk entry.
445  *
446  * The match criteria is: vendor, ec and bios much match.
447  */
448 static unsigned long __init tpacpi_check_quirks(
449                         const struct tpacpi_quirk *qlist,
450                         unsigned int qlist_size)
451 {
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;
460
461                 qlist_size--;
462                 qlist++;
463         }
464         return 0;
465 }
466
467
468 /****************************************************************************
469  ****************************************************************************
470  *
471  * ACPI Helpers and device model
472  *
473  ****************************************************************************
474  ****************************************************************************/
475
476 /*************************************************************************
477  * ACPI basic handles
478  */
479
480 static acpi_handle root_handle;
481
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 }
487
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 */
495            );
496
497 TPACPI_HANDLE(ecrd, ec, "ECRD");        /* 570 */
498 TPACPI_HANDLE(ecwr, ec, "ECWR");        /* 570 */
499
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 */
505
506 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY",   /* 600e/x, 770e, 770x */
507            "^HKEY",             /* R30, R31 */
508            "HKEY",              /* all others */
509            );                   /* 570 */
510
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 */
517
518
519 /*************************************************************************
520  * ACPI helpers
521  */
522
523 static int acpi_evalf(acpi_handle handle,
524                       void *res, char *method, char *fmt, ...)
525 {
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;
536
537         if (!*fmt) {
538                 printk(TPACPI_ERR "acpi_evalf() called with empty format\n");
539                 return 0;
540         }
541
542         if (*fmt == 'q') {
543                 quiet = 1;
544                 fmt++;
545         } else
546                 quiet = 0;
547
548         res_type = *(fmt++);
549
550         params.count = 0;
551         params.pointer = &in_objs[0];
552
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;
566                 }
567         }
568         va_end(ap);
569
570         if (res_type != 'v') {
571                 result.length = sizeof(out_obj);
572                 result.pointer = &out_obj;
573                 resultp = &result;
574         } else
575                 resultp = NULL;
576
577         status = acpi_evaluate_object(handle, method, &params, resultp);
578
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;
593         }
594
595         if (!success && !quiet)
596                 printk(TPACPI_ERR "acpi_evalf(%s, %s, ...) failed: %d\n",
597                        method, fmt0, status);
598
599         return success;
600 }
601
602 static int acpi_ec_read(int i, u8 *p)
603 {
604         int v;
605
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;
613         }
614
615         return 1;
616 }
617
618 static int acpi_ec_write(int i, u8 v)
619 {
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;
626         }
627
628         return 1;
629 }
630
631 static int issue_thinkpad_cmos_command(int cmos_cmd)
632 {
633         if (!cmos_handle)
634                 return -ENXIO;
635
636         if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
637                 return -EIO;
638
639         return 0;
640 }
641
642 /*************************************************************************
643  * ACPI device model
644  */
645
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)
649
650 static void drv_acpi_handle_init(char *name,
651                            acpi_handle *handle, acpi_handle parent,
652                            char **paths, int num_paths, char **path)
653 {
654         int i;
655         acpi_status status;
656
657         vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
658                 name);
659
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;
668                 }
669         }
670
671         vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
672                     name);
673         *handle = NULL;
674 }
675
676 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
677 {
678         struct ibm_struct *ibm = data;
679
680         if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
681                 return;
682
683         if (!ibm || !ibm->acpi || !ibm->acpi->notify)
684                 return;
685
686         ibm->acpi->notify(ibm, event);
687 }
688
689 static int __init setup_acpi_notify(struct ibm_struct *ibm)
690 {
691         acpi_status status;
692         int rc;
693
694         BUG_ON(!ibm->acpi);
695
696         if (!*ibm->acpi->handle)
697                 return 0;
698
699         vdbg_printk(TPACPI_DBG_INIT,
700                 "setting up ACPI notify for %s\n", ibm->name);
701
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;
707         }
708
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);
713
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);
725                 }
726                 return -ENODEV;
727         }
728         ibm->flags.acpi_notify_installed = 1;
729         return 0;
730 }
731
732 static int __init tpacpi_device_add(struct acpi_device *device)
733 {
734         return 0;
735 }
736
737 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
738 {
739         int rc;
740
741         dbg_printk(TPACPI_DBG_INIT,
742                 "registering %s as an ACPI driver\n", ibm->name);
743
744         BUG_ON(!ibm->acpi);
745
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;
751         }
752
753         sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
754         ibm->acpi->driver->ids = ibm->acpi->hid;
755
756         ibm->acpi->driver->ops.add = &tpacpi_device_add;
757
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;
766
767         return rc;
768 }
769
770
771 /****************************************************************************
772  ****************************************************************************
773  *
774  * Procfs Helpers
775  *
776  ****************************************************************************
777  ****************************************************************************/
778
779 static int dispatch_procfs_read(char *page, char **start, off_t off,
780                         int count, int *eof, void *data)
781 {
782         struct ibm_struct *ibm = data;
783         int len;
784
785         if (!ibm || !ibm->read)
786                 return -EINVAL;
787
788         len = ibm->read(page);
789         if (len < 0)
790                 return len;
791
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;
800
801         return len;
802 }
803
804 static int dispatch_procfs_write(struct file *file,
805                         const char __user *userbuf,
806                         unsigned long count, void *data)
807 {
808         struct ibm_struct *ibm = data;
809         char *kernbuf;
810         int ret;
811
812         if (!ibm || !ibm->write)
813                 return -EINVAL;
814         if (count > PAGE_SIZE - 2)
815                 return -EINVAL;
816
817         kernbuf = kmalloc(count + 2, GFP_KERNEL);
818         if (!kernbuf)
819                 return -ENOMEM;
820
821         if (copy_from_user(kernbuf, userbuf, count)) {
822                 kfree(kernbuf);
823                 return -EFAULT;
824         }
825
826         kernbuf[count] = 0;
827         strcat(kernbuf, ",");
828         ret = ibm->write(kernbuf);
829         if (ret == 0)
830                 ret = count;
831
832         kfree(kernbuf);
833
834         return ret;
835 }
836
837 static char *next_cmd(char **cmds)
838 {
839         char *start = *cmds;
840         char *end;
841
842         while ((end = strchr(start, ',')) && end == start)
843                 start = end + 1;
844
845         if (!end)
846                 return NULL;
847
848         *end = 0;
849         *cmds = end + 1;
850         return start;
851 }
852
853
854 /****************************************************************************
855  ****************************************************************************
856  *
857  * Device model: input, hwmon and platform
858  *
859  ****************************************************************************
860  ****************************************************************************/
861
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);
868
869 static int tpacpi_suspend_handler(struct platform_device *pdev,
870                                   pm_message_t state)
871 {
872         struct ibm_struct *ibm, *itmp;
873
874         list_for_each_entry_safe(ibm, itmp,
875                                  &tpacpi_all_drivers,
876                                  all_drivers) {
877                 if (ibm->suspend)
878                         (ibm->suspend)(state);
879         }
880
881         return 0;
882 }
883
884 static int tpacpi_resume_handler(struct platform_device *pdev)
885 {
886         struct ibm_struct *ibm, *itmp;
887
888         list_for_each_entry_safe(ibm, itmp,
889                                  &tpacpi_all_drivers,
890                                  all_drivers) {
891                 if (ibm->resume)
892                         (ibm->resume)();
893         }
894
895         return 0;
896 }
897
898 static void tpacpi_shutdown_handler(struct platform_device *pdev)
899 {
900         struct ibm_struct *ibm, *itmp;
901
902         list_for_each_entry_safe(ibm, itmp,
903                                  &tpacpi_all_drivers,
904                                  all_drivers) {
905                 if (ibm->shutdown)
906                         (ibm->shutdown)();
907         }
908 }
909
910 static struct platform_driver tpacpi_pdriver = {
911         .driver = {
912                 .name = TPACPI_DRVR_NAME,
913                 .owner = THIS_MODULE,
914         },
915         .suspend = tpacpi_suspend_handler,
916         .resume = tpacpi_resume_handler,
917         .shutdown = tpacpi_shutdown_handler,
918 };
919
920 static struct platform_driver tpacpi_hwmon_pdriver = {
921         .driver = {
922                 .name = TPACPI_HWMON_DRVR_NAME,
923                 .owner = THIS_MODULE,
924         },
925 };
926
927 /*************************************************************************
928  * sysfs support helpers
929  */
930
931 struct attribute_set {
932         unsigned int members, max_members;
933         struct attribute_group group;
934 };
935
936 struct attribute_set_obj {
937         struct attribute_set s;
938         struct attribute *a;
939 } __attribute__((packed));
940
941 static struct attribute_set *create_attr_set(unsigned int max_members,
942                                                 const char *name)
943 {
944         struct attribute_set_obj *sobj;
945
946         if (max_members == 0)
947                 return NULL;
948
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;
958
959         return &sobj->s;
960 }
961
962 #define destroy_attr_set(_set) \
963         kfree(_set);
964
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)
967 {
968         if (!s || !attr)
969                 return -EINVAL;
970
971         if (s->members >= s->max_members)
972                 return -ENOMEM;
973
974         s->group.attrs[s->members] = attr;
975         s->members++;
976
977         return 0;
978 }
979
980 static int add_many_to_attr_set(struct attribute_set *s,
981                         struct attribute **attr,
982                         unsigned int count)
983 {
984         int i, res;
985
986         for (i = 0; i < count; i++) {
987                 res = add_to_attr_set(s, attr[i]);
988                 if (res)
989                         return res;
990         }
991
992         return 0;
993 }
994
995 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
996 {
997         sysfs_remove_group(kobj, &s->group);
998         destroy_attr_set(s);
999 }
1000
1001 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1002         sysfs_create_group(_kobj, &_attr_set->group)
1003
1004 static int parse_strtoul(const char *buf,
1005                 unsigned long max, unsigned long *value)
1006 {
1007         char *endp;
1008
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;
1016
1017         return 0;
1018 }
1019
1020 static void tpacpi_disable_brightness_delay(void)
1021 {
1022         if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1023                 printk(TPACPI_NOTICE
1024                         "ACPI backlight control delay disabled\n");
1025 }
1026
1027 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
1028 {
1029         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1030         union acpi_object *obj;
1031         int rc;
1032
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;
1041                 }
1042         } else {
1043                 return 0;
1044         }
1045
1046         kfree(buffer.pointer);
1047         return rc;
1048 }
1049
1050 static acpi_status __init tpacpi_acpi_walk_find_bcl(acpi_handle handle,
1051                                         u32 lvl, void *context, void **rv)
1052 {
1053         char name[ACPI_PATH_SEGMENT_LENGTH];
1054         struct acpi_buffer buffer = { sizeof(name), &name };
1055
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;
1063         }
1064 }
1065
1066 /*
1067  * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
1068  */
1069 static int __init tpacpi_check_std_acpi_brightness_support(void)
1070 {
1071         int status;
1072         int bcl_levels = 0;
1073         void *bcl_ptr = &bcl_levels;
1074
1075         if (!vid_handle) {
1076                 TPACPI_ACPIHANDLE_INIT(vid);
1077         }
1078         if (!vid_handle)
1079                 return 0;
1080
1081         /*
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.
1087          */
1088
1089         status = acpi_walk_namespace(ACPI_TYPE_METHOD, vid_handle, 3,
1090                                      tpacpi_acpi_walk_find_bcl, NULL,
1091                                      &bcl_ptr);
1092
1093         if (ACPI_SUCCESS(status) && bcl_levels > 2) {
1094                 tp_features.bright_acpimode = 1;
1095                 return (bcl_levels - 2);
1096         }
1097
1098         return 0;
1099 }
1100
1101 static void printk_deprecated_attribute(const char * const what,
1102                                         const char * const details)
1103 {
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);
1108 }
1109
1110 /*************************************************************************
1111  * rfkill and radio control support helpers
1112  */
1113
1114 /*
1115  * ThinkPad-ACPI firmware handling model:
1116  *
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
1120  *
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).
1123  *
1124  * The only time there are shadow radio state changes, is when
1125  * masked-off hotkeys are used.
1126  */
1127
1128 /*
1129  * Internal driver API for radio state:
1130  *
1131  * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1132  * bool: true means radio blocked (off)
1133  */
1134 enum tpacpi_rfkill_state {
1135         TPACPI_RFK_RADIO_OFF = 0,
1136         TPACPI_RFK_RADIO_ON
1137 };
1138
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
1145 };
1146
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
1152 };
1153
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;
1159 };
1160
1161 struct tpacpi_rfk_ops {
1162         /* firmware interface */
1163         int (*get_status)(void);
1164         int (*set_status)(const enum tpacpi_rfkill_state);
1165 };
1166
1167 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1168
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)
1171 {
1172         int status;
1173
1174         if (!tp_rfk)
1175                 return -ENODEV;
1176
1177         status = (tp_rfk->ops->get_status)();
1178         if (status < 0)
1179                 return status;
1180
1181         rfkill_set_sw_state(tp_rfk->rfkill,
1182                             (status == TPACPI_RFK_RADIO_OFF));
1183
1184         return status;
1185 }
1186
1187 /* Query FW and update rfkill sw state for all rfkill switches */
1188 static void tpacpi_rfk_update_swstate_all(void)
1189 {
1190         unsigned int i;
1191
1192         for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1193                 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1194 }
1195
1196 /*
1197  * Sync the HW-blocking state of all rfkill switches,
1198  * do notice it causes the rfkill core to schedule uevents
1199  */
1200 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1201 {
1202         unsigned int i;
1203         struct tpacpi_rfk *tp_rfk;
1204
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 */
1211                         }
1212                 }
1213         }
1214 }
1215
1216 /* Call to get the WLSW state from the firmware */
1217 static int hotkey_get_wlsw(void);
1218
1219 /* Call to query WLSW state and update all rfkill switches */
1220 static bool tpacpi_rfk_check_hwblock_state(void)
1221 {
1222         int res = hotkey_get_wlsw();
1223         int hw_blocked;
1224
1225         /* When unknown or unsupported, we have to assume it is unblocked */
1226         if (res < 0)
1227                 return false;
1228
1229         hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1230         tpacpi_rfk_update_hwblock_state(hw_blocked);
1231
1232         return hw_blocked;
1233 }
1234
1235 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1236 {
1237         struct tpacpi_rfk *tp_rfk = data;
1238         int res;
1239
1240         dbg_printk(TPACPI_DBG_RFKILL,
1241                    "request to change radio state to %s\n",
1242                    blocked ? "blocked" : "unblocked");
1243
1244         /* try to set radio state */
1245         res = (tp_rfk->ops->set_status)(blocked ?
1246                                 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1247
1248         /* and update the rfkill core with whatever the FW really did */
1249         tpacpi_rfk_update_swstate(tp_rfk);
1250
1251         return (res < 0) ? res : 0;
1252 }
1253
1254 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1255         .set_block = tpacpi_rfk_hook_set_block,
1256 };
1257
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)
1263 {
1264         struct tpacpi_rfk *atp_rfk;
1265         int res;
1266         bool sw_state = false;
1267         int sw_status;
1268
1269         BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1270
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;
1283         }
1284
1285         atp_rfk->id = id;
1286         atp_rfk->ops = tp_rfkops;
1287
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);
1299                 }
1300         }
1301         rfkill_set_hw_state(atp_rfk->rfkill, tpacpi_rfk_check_hwblock_state());
1302
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;
1311         }
1312
1313         tpacpi_rfkill_switches[id] = atp_rfk;
1314         return 0;
1315 }
1316
1317 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1318 {
1319         struct tpacpi_rfk *tp_rfk;
1320
1321         BUG_ON(id >= TPACPI_RFK_SW_MAX);
1322
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);
1329         }
1330 }
1331
1332 static void printk_deprecated_rfkill_attribute(const char * const what)
1333 {
1334         printk_deprecated_attribute(what,
1335                         "Please switch to generic rfkill before year 2010");
1336 }
1337
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)
1342 {
1343         int status;
1344
1345         printk_deprecated_rfkill_attribute(attr->attr.name);
1346
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;
1354         }
1355
1356         return snprintf(buf, PAGE_SIZE, "%d\n",
1357                         (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1358 }
1359
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)
1363 {
1364         unsigned long t;
1365         int res;
1366
1367         printk_deprecated_rfkill_attribute(attr->attr.name);
1368
1369         if (parse_strtoul(buf, 1, &t))
1370                 return -EINVAL;
1371
1372         tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1373
1374         /* This is in the ABI... */
1375         if (tpacpi_rfk_check_hwblock_state() && !!t)
1376                 return -EPERM;
1377
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]);
1381
1382         return (res < 0) ? res : count;
1383 }
1384
1385 /* procfs -------------------------------------------------------------- */
1386 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, char *p)
1387 {
1388         int len = 0;
1389
1390         if (id >= TPACPI_RFK_SW_MAX)
1391                 len += sprintf(p + len, "status:\t\tnot supported\n");
1392         else {
1393                 int status;
1394
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;
1403                 }
1404
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");
1409         }
1410
1411         return len;
1412 }
1413
1414 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1415 {
1416         char *cmd;
1417         int status = -1;
1418         int res = 0;
1419
1420         if (id >= TPACPI_RFK_SW_MAX)
1421                 return -ENODEV;
1422
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;
1430         }
1431
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]);
1439         }
1440
1441         return res;
1442 }
1443
1444 /*************************************************************************
1445  * thinkpad-acpi driver attributes
1446  */
1447
1448 /* interface_version --------------------------------------------------- */
1449 static ssize_t tpacpi_driver_interface_version_show(
1450                                 struct device_driver *drv,
1451                                 char *buf)
1452 {
1453         return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1454 }
1455
1456 static DRIVER_ATTR(interface_version, S_IRUGO,
1457                 tpacpi_driver_interface_version_show, NULL);
1458
1459 /* debug_level --------------------------------------------------------- */
1460 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1461                                                 char *buf)
1462 {
1463         return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1464 }
1465
1466 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1467                                                 const char *buf, size_t count)
1468 {
1469         unsigned long t;
1470
1471         if (parse_strtoul(buf, 0xffff, &t))
1472                 return -EINVAL;
1473
1474         dbg_level = t;
1475
1476         return count;
1477 }
1478
1479 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1480                 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1481
1482 /* version ------------------------------------------------------------- */
1483 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1484                                                 char *buf)
1485 {
1486         return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1487                         TPACPI_DESC, TPACPI_VERSION);
1488 }
1489
1490 static DRIVER_ATTR(version, S_IRUGO,
1491                 tpacpi_driver_version_show, NULL);
1492
1493 /* --------------------------------------------------------------------- */
1494
1495 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1496
1497 /* wlsw_emulstate ------------------------------------------------------ */
1498 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1499                                                 char *buf)
1500 {
1501         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1502 }
1503
1504 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1505                                                 const char *buf, size_t count)
1506 {
1507         unsigned long t;
1508
1509         if (parse_strtoul(buf, 1, &t))
1510                 return -EINVAL;
1511
1512         if (tpacpi_wlsw_emulstate != !!t) {
1513                 tpacpi_wlsw_emulstate = !!t;
1514                 tpacpi_rfk_update_hwblock_state(!t);    /* negative logic */
1515         }
1516
1517         return count;
1518 }
1519
1520 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1521                 tpacpi_driver_wlsw_emulstate_show,
1522                 tpacpi_driver_wlsw_emulstate_store);
1523
1524 /* bluetooth_emulstate ------------------------------------------------- */
1525 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1526                                         struct device_driver *drv,
1527                                         char *buf)
1528 {
1529         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1530 }
1531
1532 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1533                                         struct device_driver *drv,
1534                                         const char *buf, size_t count)
1535 {
1536         unsigned long t;
1537
1538         if (parse_strtoul(buf, 1, &t))
1539                 return -EINVAL;
1540
1541         tpacpi_bluetooth_emulstate = !!t;
1542
1543         return count;
1544 }
1545
1546 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1547                 tpacpi_driver_bluetooth_emulstate_show,
1548                 tpacpi_driver_bluetooth_emulstate_store);
1549
1550 /* wwan_emulstate ------------------------------------------------- */
1551 static ssize_t tpacpi_driver_wwan_emulstate_show(
1552                                         struct device_driver *drv,
1553                                         char *buf)
1554 {
1555         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1556 }
1557
1558 static ssize_t tpacpi_driver_wwan_emulstate_store(
1559                                         struct device_driver *drv,
1560                                         const char *buf, size_t count)
1561 {
1562         unsigned long t;
1563
1564         if (parse_strtoul(buf, 1, &t))
1565                 return -EINVAL;
1566
1567         tpacpi_wwan_emulstate = !!t;
1568
1569         return count;
1570 }
1571
1572 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1573                 tpacpi_driver_wwan_emulstate_show,
1574                 tpacpi_driver_wwan_emulstate_store);
1575
1576 /* uwb_emulstate ------------------------------------------------- */
1577 static ssize_t tpacpi_driver_uwb_emulstate_show(
1578                                         struct device_driver *drv,
1579                                         char *buf)
1580 {
1581         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1582 }
1583
1584 static ssize_t tpacpi_driver_uwb_emulstate_store(
1585                                         struct device_driver *drv,
1586                                         const char *buf, size_t count)
1587 {
1588         unsigned long t;
1589
1590         if (parse_strtoul(buf, 1, &t))
1591                 return -EINVAL;
1592
1593         tpacpi_uwb_emulstate = !!t;
1594
1595         return count;
1596 }
1597
1598 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1599                 tpacpi_driver_uwb_emulstate_show,
1600                 tpacpi_driver_uwb_emulstate_store);
1601 #endif
1602
1603 /* --------------------------------------------------------------------- */
1604
1605 static struct driver_attribute *tpacpi_driver_attributes[] = {
1606         &driver_attr_debug_level, &driver_attr_version,
1607         &driver_attr_interface_version,
1608 };
1609
1610 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1611 {
1612         int i, res;
1613
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++;
1619         }
1620
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
1631
1632         return res;
1633 }
1634
1635 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1636 {
1637         int i;
1638
1639         for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1640                 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1641
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
1648 }
1649
1650 /*************************************************************************
1651  * Firmware Data
1652  */
1653
1654 /*
1655  * Table of recommended minimum BIOS versions
1656  *
1657  * Reasons for listing:
1658  *    1. Stable BIOS, listed because the unknown ammount of
1659  *       bugs and bad ACPI behaviour on older versions
1660  *
1661  *    2. BIOS or EC fw with known bugs that trigger on Linux
1662  *
1663  *    3. BIOS with known reduced functionality in older versions
1664  *
1665  *  We recommend the latest BIOS and EC version.
1666  *  We only support the latest BIOS and EC fw version as a rule.
1667  *
1668  *  Sources: IBM ThinkPad Public Web Documents (update changelogs),
1669  *  Information from users in ThinkWiki
1670  *
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.
1673  */
1674
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) }
1681
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) }
1689
1690 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1691         TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1692
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)
1701
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)
1711
1712 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1713         TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1714
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)
1719
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)
1725
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 */
1738
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) */
1752
1753         /* G-series ------------------------- */
1754         /*      FW MODEL   BIOS VERS          */
1755         TPV_QI0('1', 'T',  'A', '6'),            /* G40 */
1756         TPV_QI0('1', 'X',  '5', '7'),            /* G41 */
1757
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) */
1772
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) */
1779
1780         TPV_QL1('7', '9',  'E', '3',  '5', '0'), /* T60/p */
1781         TPV_QL1('7', 'C',  'D', '2',  '2', '2'), /* R60, R60i */
1782         TPV_QL0('7', 'E',  'D', '0'),            /* R60e, R60i */
1783
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 */
1787
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) */
1797
1798         TPV_QL0('7', 'B',  'D', '7'),            /* X60/s */
1799         TPV_QL0('7', 'J',  '3', '0'),            /* X60t */
1800
1801         /* (0) - older versions lack DMI EC fw string and functionality */
1802         /* (1) - older versions known to lack functionality */
1803 };
1804
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
1812
1813 static void __init tpacpi_check_outdated_fw(void)
1814 {
1815         unsigned long fwvers;
1816         u16 ec_version, bios_version;
1817
1818         fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1819                                 ARRAY_SIZE(tpacpi_bios_version_qtable));
1820
1821         if (!fwvers)
1822                 return;
1823
1824         bios_version = fwvers & 0xffffU;
1825         ec_version = (fwvers >> 16) & 0xffffU;
1826
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)) {
1831                 /*
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.
1837                  */
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");
1843         }
1844 }
1845
1846 static bool __init tpacpi_is_fw_known(void)
1847 {
1848         return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1849                         ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1850 }
1851
1852 /****************************************************************************
1853  ****************************************************************************
1854  *
1855  * Subdrivers
1856  *
1857  ****************************************************************************
1858  ****************************************************************************/
1859
1860 /*************************************************************************
1861  * thinkpad-acpi init subdriver
1862  */
1863
1864 static int __init thinkpad_acpi_driver_init(struct ibm_init_struct *iibm)
1865 {
1866         printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
1867         printk(TPACPI_INFO "%s\n", TPACPI_URL);
1868
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");
1874
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");
1884
1885         tpacpi_check_outdated_fw();
1886         return 0;
1887 }
1888
1889 static int thinkpad_acpi_driver_read(char *p)
1890 {
1891         int len = 0;
1892
1893         len += sprintf(p + len, "driver:\t\t%s\n", TPACPI_DESC);
1894         len += sprintf(p + len, "version:\t%s\n", TPACPI_VERSION);
1895
1896         return len;
1897 }
1898
1899 static struct ibm_struct thinkpad_acpi_driver_data = {
1900         .name = "driver",
1901         .read = thinkpad_acpi_driver_read,
1902 };
1903
1904 /*************************************************************************
1905  * Hotkey subdriver
1906  */
1907
1908 /*
1909  * ThinkPad firmware event model
1910  *
1911  * The ThinkPad firmware has two main event interfaces: normal ACPI
1912  * notifications (which follow the ACPI standard), and a private event
1913  * interface.
1914  *
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.
1919  *
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.
1923  *
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.
1927  */
1928
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,
1954 };
1955
1956 enum {  /* Keys/events available through NVRAM polling */
1957         TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1958         TPACPI_HKEY_NVRAM_GOOD_MASK  = 0x00fb8000U,
1959 };
1960
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,
1973 };
1974
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,
1985 };
1986
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;
1999
2000        u8 brightness_level;
2001        u8 volume_level;
2002 };
2003
2004 /* kthread for the hotkey poller */
2005 static struct task_struct *tpacpi_hotkey_task;
2006
2007 /* Acquired while the poller kthread is running, use to sync start/stop */
2008 static struct mutex hotkey_thread_mutex;
2009
2010 /*
2011  * Acquire mutex to write poller control variables as an
2012  * atomic block.
2013  *
2014  * Increment hotkey_config_change when changing them if you
2015  * want the kthread to forget old state.
2016  *
2017  * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2018  */
2019 static struct mutex hotkey_thread_data_mutex;
2020 static unsigned int hotkey_config_change;
2021
2022 /*
2023  * hotkey poller control variables
2024  *
2025  * Must be atomic or readers will also need to acquire mutex
2026  *
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.
2031  */
2032 static u32 hotkey_source_mask;          /* bit mask 0=ACPI,1=NVRAM */
2033 static unsigned int hotkey_poll_freq = 10; /* Hz */
2034
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);
2042
2043 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2044
2045 #define hotkey_source_mask 0U
2046 #define HOTKEY_CONFIG_CRITICAL_START
2047 #define HOTKEY_CONFIG_CRITICAL_END
2048
2049 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2050
2051 static struct mutex hotkey_mutex;
2052
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;
2058
2059 static int hotkey_autosleep_ack;
2060
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 */
2067
2068 static unsigned int hotkey_report_mode;
2069
2070 static u16 *hotkey_keycode_map;
2071
2072 static struct attribute_set *hotkey_dev_attributes;
2073
2074 static void tpacpi_driver_event(const unsigned int hkey_event);
2075 static void hotkey_driver_event(const unsigned int scancode);
2076
2077 /* HKEY.MHKG() return bits */
2078 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2079
2080 static int hotkey_get_wlsw(void)
2081 {
2082         int status;
2083
2084         if (!tp_features.hotkey_wlsw)
2085                 return -ENODEV;
2086
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
2092
2093         if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2094                 return -EIO;
2095
2096         return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2097 }
2098
2099 static int hotkey_get_tablet_mode(int *status)
2100 {
2101         int s;
2102
2103         if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2104                 return -EIO;
2105
2106         *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2107         return 0;
2108 }
2109
2110 /*
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).
2115  *
2116  * Call with hotkey_mutex held
2117  */
2118 static int hotkey_mask_get(void)
2119 {
2120         if (tp_features.hotkey_mask) {
2121                 u32 m = 0;
2122
2123                 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2124                         return -EIO;
2125
2126                 hotkey_acpi_mask = m;
2127         } else {
2128                 /* no mask support doesn't mean no event support... */
2129                 hotkey_acpi_mask = hotkey_all_mask;
2130         }
2131
2132         /* sync userspace-visible mask */
2133         hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2134
2135         return 0;
2136 }
2137
2138 void static hotkey_mask_warn_incomplete_mask(void)
2139 {
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);
2144
2145         if (wantedmask)
2146                 printk(TPACPI_NOTICE
2147                         "required events 0x%08x not enabled!\n",
2148                         wantedmask);
2149 }
2150
2151 /*
2152  * Set the firmware mask when supported
2153  *
2154  * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2155  *
2156  * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2157  *
2158  * Call with hotkey_mutex held
2159  */
2160 static int hotkey_mask_set(u32 mask)
2161 {
2162         int i;
2163         int rc = 0;
2164
2165         const u32 fwmask = mask & ~hotkey_source_mask;
2166
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;
2174                         }
2175                 }
2176         }
2177
2178         /*
2179          * We *must* make an inconditional call to hotkey_mask_get to
2180          * refresh hotkey_acpi_mask and update hotkey_user_mask
2181          *
2182          * Take the opportunity to also log when we cannot _enable_
2183          * a given event.
2184          */
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);
2190         }
2191
2192         hotkey_mask_warn_incomplete_mask();
2193
2194         return rc;
2195 }
2196
2197 /*
2198  * Sets hotkey_user_mask and tries to set the firmware mask
2199  *
2200  * Call with hotkey_mutex held
2201  */
2202 static int hotkey_user_mask_set(const u32 mask)
2203 {
2204         int rc;
2205
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");
2219         }
2220
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);
2224
2225         /* Enable the available bits in hotkey_user_mask */
2226         hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2227
2228         return rc;
2229 }
2230
2231 /*
2232  * Sets the driver hotkey mask.
2233  *
2234  * Can be called even if the hotkey subdriver is inactive
2235  */
2236 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2237 {
2238         int rc;
2239
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;
2244         }
2245
2246         mutex_lock(&hotkey_mutex);
2247
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
2254
2255         rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2256                                                         ~hotkey_source_mask);
2257         mutex_unlock(&hotkey_mutex);
2258
2259         return rc;
2260 }
2261
2262 static int hotkey_status_get(int *status)
2263 {
2264         if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2265                 return -EIO;
2266
2267         return 0;
2268 }
2269
2270 static int hotkey_status_set(bool enable)
2271 {
2272         if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2273                 return -EIO;
2274
2275         return 0;
2276 }
2277
2278 static void tpacpi_input_send_tabletsw(void)
2279 {
2280         int state;
2281
2282         if (tp_features.hotkey_tablet &&
2283             !hotkey_get_tablet_mode(&state)) {
2284                 mutex_lock(&tpacpi_inputdev_send_mutex);
2285
2286                 input_report_switch(tpacpi_inputdev,
2287                                     SW_TABLET_MODE, !!state);
2288                 input_sync(tpacpi_inputdev);
2289
2290                 mutex_unlock(&tpacpi_inputdev_send_mutex);
2291         }
2292 }
2293
2294 /* Do NOT call without validating scancode first */
2295 static void tpacpi_input_send_key(const unsigned int scancode)
2296 {
2297         const unsigned int keycode = hotkey_keycode_map[scancode];
2298
2299         if (keycode != KEY_RESERVED) {
2300                 mutex_lock(&tpacpi_inputdev_send_mutex);
2301
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);
2307
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);
2313
2314                 mutex_unlock(&tpacpi_inputdev_send_mutex);
2315         }
2316 }
2317
2318 /* Do NOT call without validating scancode first */
2319 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2320 {
2321         hotkey_driver_event(scancode);
2322         if (hotkey_user_mask & (1 << scancode))
2323                 tpacpi_input_send_key(scancode);
2324 }
2325
2326 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2327 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2328
2329 /* Do NOT call without validating scancode first */
2330 static void tpacpi_hotkey_send_key(unsigned int scancode)
2331 {
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);
2336         }
2337 }
2338
2339 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2340 {
2341         u8 d;
2342
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);
2349         }
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);
2353         }
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);
2358         }
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);
2365         }
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);
2372         }
2373 }
2374
2375 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2376                                            struct tp_nvram_state *newn,
2377                                            const u32 event_mask)
2378 {
2379
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)
2386
2387 #define TPACPI_MAY_SEND_KEY(__scancode) \
2388         do { \
2389                 if (event_mask & (1 << __scancode)) \
2390                         tpacpi_hotkey_send_key(__scancode); \
2391         } while (0)
2392
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);
2397
2398         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2399
2400         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2401
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);
2406                 }
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);
2419                         }
2420                 }
2421         }
2422
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);
2435                         }
2436                 }
2437         }
2438
2439 #undef TPACPI_COMPARE_KEY
2440 #undef TPACPI_MAY_SEND_KEY
2441 }
2442
2443 /*
2444  * Polling driver
2445  *
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.
2449  */
2450 static int hotkey_kthread(void *data)
2451 {
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;
2458
2459         mutex_lock(&hotkey_thread_mutex);
2460
2461         if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2462                 goto exit;
2463
2464         set_freezable();
2465
2466         so = 0;
2467         si = 1;
2468         t = 0;
2469
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);
2479
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... */
2486                 }
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;
2493
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;
2500                 }
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);
2506
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);
2512                         }
2513                 }
2514
2515                 so = si;
2516                 si ^= 1;
2517         }
2518
2519 exit:
2520         mutex_unlock(&hotkey_thread_mutex);
2521         return 0;
2522 }
2523
2524 /* call with hotkey_mutex held */
2525 static void hotkey_poll_stop_sync(void)
2526 {
2527         if (tpacpi_hotkey_task) {
2528                 if (frozen(tpacpi_hotkey_task) ||
2529                     freezing(tpacpi_hotkey_task))
2530                         thaw_process(tpacpi_hotkey_task);
2531
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);
2537         }
2538 }
2539
2540 /* call with hotkey_mutex held */
2541 static void hotkey_poll_setup(bool may_warn)
2542 {
2543         const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2544         const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2545
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");
2557                         }
2558                 }
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);
2568                 }
2569         }
2570 }
2571
2572 static void hotkey_poll_setup_safe(bool may_warn)
2573 {
2574         mutex_lock(&hotkey_mutex);
2575         hotkey_poll_setup(may_warn);
2576         mutex_unlock(&hotkey_mutex);
2577 }
2578
2579 /* call with hotkey_mutex held */
2580 static void hotkey_poll_set_freq(unsigned int freq)
2581 {
2582         if (!freq)
2583                 hotkey_poll_stop_sync();
2584
2585         hotkey_poll_freq = freq;
2586 }
2587
2588 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2589
2590 static void hotkey_poll_setup_safe(bool __unused)
2591 {
2592 }
2593
2594 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2595
2596 static int hotkey_inputdev_open(struct input_dev *dev)
2597 {
2598         switch (tpacpi_lifecycle) {
2599         case TPACPI_LIFE_INIT:
2600                 /*
2601                  * hotkey_init will call hotkey_poll_setup_safe
2602                  * at the appropriate moment
2603                  */
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;
2610         }
2611
2612         /* Should only happen if tpacpi_lifecycle is corrupt */
2613         BUG();
2614         return -EBUSY;
2615 }
2616
2617 static void hotkey_inputdev_close(struct input_dev *dev)
2618 {
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);
2623 }
2624
2625 /* sysfs hotkey enable ------------------------------------------------- */
2626 static ssize_t hotkey_enable_show(struct device *dev,
2627                            struct device_attribute *attr,
2628                            char *buf)
2629 {
2630         int res, status;
2631
2632         printk_deprecated_attribute("hotkey_enable",
2633                         "Hotkey reporting is always enabled");
2634
2635         res = hotkey_status_get(&status);
2636         if (res)
2637                 return res;
2638
2639         return snprintf(buf, PAGE_SIZE, "%d\n", status);
2640 }
2641
2642 static ssize_t hotkey_enable_store(struct device *dev,
2643                             struct device_attribute *attr,
2644                             const char *buf, size_t count)
2645 {
2646         unsigned long t;
2647
2648         printk_deprecated_attribute("hotkey_enable",
2649                         "Hotkeys can be disabled through hotkey_mask");
2650
2651         if (parse_strtoul(buf, 1, &t))
2652                 return -EINVAL;
2653
2654         if (t == 0)
2655                 return -EPERM;
2656
2657         return count;
2658 }
2659
2660 static struct device_attribute dev_attr_hotkey_enable =
2661         __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2662                 hotkey_enable_show, hotkey_enable_store);
2663
2664 /* sysfs hotkey mask --------------------------------------------------- */
2665 static ssize_t hotkey_mask_show(struct device *dev,
2666                            struct device_attribute *attr,
2667                            char *buf)
2668 {
2669         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2670 }
2671
2672 static ssize_t hotkey_mask_store(struct device *dev,
2673                             struct device_attribute *attr,
2674                             const char *buf, size_t count)
2675 {
2676         unsigned long t;
2677         int res;
2678
2679         if (parse_strtoul(buf, 0xffffffffUL, &t))
2680                 return -EINVAL;
2681
2682         if (mutex_lock_killable(&hotkey_mutex))
2683                 return -ERESTARTSYS;
2684
2685         res = hotkey_user_mask_set(t);
2686
2687 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2688         hotkey_poll_setup(true);
2689 #endif
2690
2691         mutex_unlock(&hotkey_mutex);
2692
2693         tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2694
2695         return (res) ? res : count;
2696 }
2697
2698 static struct device_attribute dev_attr_hotkey_mask =
2699         __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2700                 hotkey_mask_show, hotkey_mask_store);
2701
2702 /* sysfs hotkey bios_enabled ------------------------------------------- */
2703 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2704                            struct device_attribute *attr,
2705                            char *buf)
2706 {
2707         return sprintf(buf, "0\n");
2708 }
2709
2710 static struct device_attribute dev_attr_hotkey_bios_enabled =
2711         __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2712
2713 /* sysfs hotkey bios_mask ---------------------------------------------- */
2714 static ssize_t hotkey_bios_mask_show(struct device *dev,
2715                            struct device_attribute *attr,
2716                            char *buf)
2717 {
2718         printk_deprecated_attribute("hotkey_bios_mask",
2719                         "This attribute is useless.");
2720         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2721 }
2722
2723 static struct device_attribute dev_attr_hotkey_bios_mask =
2724         __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2725
2726 /* sysfs hotkey all_mask ----------------------------------------------- */
2727 static ssize_t hotkey_all_mask_show(struct device *dev,
2728                            struct device_attribute *attr,
2729                            char *buf)
2730 {
2731         return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2732                                 hotkey_all_mask | hotkey_source_mask);
2733 }
2734
2735 static struct device_attribute dev_attr_hotkey_all_mask =
2736         __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2737
2738 /* sysfs hotkey recommended_mask --------------------------------------- */
2739 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2740                                             struct device_attribute *attr,
2741                                             char *buf)
2742 {
2743         return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2744                         (hotkey_all_mask | hotkey_source_mask)
2745                         & ~hotkey_reserved_mask);
2746 }
2747
2748 static struct device_attribute dev_attr_hotkey_recommended_mask =
2749         __ATTR(hotkey_recommended_mask, S_IRUGO,
2750                 hotkey_recommended_mask_show, NULL);
2751
2752 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2753
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)
2758 {
2759         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2760 }
2761
2762 static ssize_t hotkey_source_mask_store(struct device *dev,
2763                             struct device_attribute *attr,
2764                             const char *buf, size_t count)
2765 {
2766         unsigned long t;
2767         u32 r_ev;
2768         int rc;
2769
2770         if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2771                 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2772                 return -EINVAL;
2773
2774         if (mutex_lock_killable(&hotkey_mutex))
2775                 return -ERESTARTSYS;
2776
2777         HOTKEY_CONFIG_CRITICAL_START
2778         hotkey_source_mask = t;
2779         HOTKEY_CONFIG_CRITICAL_END
2780
2781         rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2782                         ~hotkey_source_mask);
2783         hotkey_poll_setup(true);
2784
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;
2788
2789         mutex_unlock(&hotkey_mutex);
2790
2791         if (rc < 0)
2792                 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2793                         "firmware event mask!\n");
2794
2795         if (r_ev)
2796                 printk(TPACPI_NOTICE "hotkey_source_mask: "
2797                         "some important events were disabled: "
2798                         "0x%04x\n", r_ev);
2799
2800         tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2801
2802         return (rc < 0) ? rc : count;
2803 }
2804
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);
2808
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)
2813 {
2814         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2815 }
2816
2817 static ssize_t hotkey_poll_freq_store(struct device *dev,
2818                             struct device_attribute *attr,
2819                             const char *buf, size_t count)
2820 {
2821         unsigned long t;
2822
2823         if (parse_strtoul(buf, 25, &t))
2824                 return -EINVAL;
2825
2826         if (mutex_lock_killable(&hotkey_mutex))
2827                 return -ERESTARTSYS;
2828
2829         hotkey_poll_set_freq(t);
2830         hotkey_poll_setup(true);
2831
2832         mutex_unlock(&hotkey_mutex);
2833
2834         tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2835
2836         return count;
2837 }
2838
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);
2842
2843 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2844
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)
2849 {
2850         int res;
2851         res = hotkey_get_wlsw();
2852         if (res < 0)
2853                 return res;
2854
2855         /* Opportunistic update */
2856         tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2857
2858         return snprintf(buf, PAGE_SIZE, "%d\n",
2859                         (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2860 }
2861
2862 static struct device_attribute dev_attr_hotkey_radio_sw =
2863         __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2864
2865 static void hotkey_radio_sw_notify_change(void)
2866 {
2867         if (tp_features.hotkey_wlsw)
2868                 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2869                              "hotkey_radio_sw");
2870 }
2871
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)
2876 {
2877         int res, s;
2878         res = hotkey_get_tablet_mode(&s);
2879         if (res < 0)
2880                 return res;
2881
2882         return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2883 }
2884
2885 static struct device_attribute dev_attr_hotkey_tablet_mode =
2886         __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2887
2888 static void hotkey_tablet_mode_notify_change(void)
2889 {
2890         if (tp_features.hotkey_tablet)
2891                 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2892                              "hotkey_tablet_mode");
2893 }
2894
2895 /* sysfs hotkey report_mode -------------------------------------------- */
2896 static ssize_t hotkey_report_mode_show(struct device *dev,
2897                            struct device_attribute *attr,
2898                            char *buf)
2899 {
2900         return snprintf(buf, PAGE_SIZE, "%d\n",
2901                 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2902 }
2903
2904 static struct device_attribute dev_attr_hotkey_report_mode =
2905         __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2906
2907 /* sysfs wakeup reason (pollable) -------------------------------------- */
2908 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2909                            struct device_attribute *attr,
2910                            char *buf)
2911 {
2912         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2913 }
2914
2915 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2916         __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2917
2918 static void hotkey_wakeup_reason_notify_change(void)
2919 {
2920         sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2921                      "wakeup_reason");
2922 }
2923
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)
2928 {
2929         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2930 }
2931
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);
2935
2936 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2937 {
2938         sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2939                      "wakeup_hotunplug_complete");
2940 }
2941
2942 /* --------------------------------------------------------------------- */
2943
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
2958 };
2959
2960 /*
2961  * Sync both the hw and sw blocking state of all switches
2962  */
2963 static void tpacpi_send_radiosw_update(void)
2964 {
2965         int wlsw;
2966