Merge branch 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mjg59/platf...
[sfrench/cifs-2.6.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.24"
25 #define TPACPI_SYSFS_VERSION 0x020700
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 #include <linux/slab.h>
62
63 #include <linux/nvram.h>
64 #include <linux/proc_fs.h>
65 #include <linux/seq_file.h>
66 #include <linux/sysfs.h>
67 #include <linux/backlight.h>
68 #include <linux/fb.h>
69 #include <linux/platform_device.h>
70 #include <linux/hwmon.h>
71 #include <linux/hwmon-sysfs.h>
72 #include <linux/input.h>
73 #include <linux/leds.h>
74 #include <linux/rfkill.h>
75 #include <asm/uaccess.h>
76
77 #include <linux/dmi.h>
78 #include <linux/jiffies.h>
79 #include <linux/workqueue.h>
80
81 #include <sound/core.h>
82 #include <sound/control.h>
83 #include <sound/initval.h>
84
85 #include <acpi/acpi_drivers.h>
86
87 #include <linux/pci_ids.h>
88
89
90 /* ThinkPad CMOS commands */
91 #define TP_CMOS_VOLUME_DOWN     0
92 #define TP_CMOS_VOLUME_UP       1
93 #define TP_CMOS_VOLUME_MUTE     2
94 #define TP_CMOS_BRIGHTNESS_UP   4
95 #define TP_CMOS_BRIGHTNESS_DOWN 5
96 #define TP_CMOS_THINKLIGHT_ON   12
97 #define TP_CMOS_THINKLIGHT_OFF  13
98
99 /* NVRAM Addresses */
100 enum tp_nvram_addr {
101         TP_NVRAM_ADDR_HK2               = 0x57,
102         TP_NVRAM_ADDR_THINKLIGHT        = 0x58,
103         TP_NVRAM_ADDR_VIDEO             = 0x59,
104         TP_NVRAM_ADDR_BRIGHTNESS        = 0x5e,
105         TP_NVRAM_ADDR_MIXER             = 0x60,
106 };
107
108 /* NVRAM bit masks */
109 enum {
110         TP_NVRAM_MASK_HKT_THINKPAD      = 0x08,
111         TP_NVRAM_MASK_HKT_ZOOM          = 0x20,
112         TP_NVRAM_MASK_HKT_DISPLAY       = 0x40,
113         TP_NVRAM_MASK_HKT_HIBERNATE     = 0x80,
114         TP_NVRAM_MASK_THINKLIGHT        = 0x10,
115         TP_NVRAM_MASK_HKT_DISPEXPND     = 0x30,
116         TP_NVRAM_MASK_HKT_BRIGHTNESS    = 0x20,
117         TP_NVRAM_MASK_LEVEL_BRIGHTNESS  = 0x0f,
118         TP_NVRAM_POS_LEVEL_BRIGHTNESS   = 0,
119         TP_NVRAM_MASK_MUTE              = 0x40,
120         TP_NVRAM_MASK_HKT_VOLUME        = 0x80,
121         TP_NVRAM_MASK_LEVEL_VOLUME      = 0x0f,
122         TP_NVRAM_POS_LEVEL_VOLUME       = 0,
123 };
124
125 /* Misc NVRAM-related */
126 enum {
127         TP_NVRAM_LEVEL_VOLUME_MAX = 14,
128 };
129
130 /* ACPI HIDs */
131 #define TPACPI_ACPI_HKEY_HID            "IBM0068"
132 #define TPACPI_ACPI_EC_HID              "PNP0C09"
133
134 /* Input IDs */
135 #define TPACPI_HKEY_INPUT_PRODUCT       0x5054 /* "TP" */
136 #define TPACPI_HKEY_INPUT_VERSION       0x4101
137
138 /* ACPI \WGSV commands */
139 enum {
140         TP_ACPI_WGSV_GET_STATE          = 0x01, /* Get state information */
141         TP_ACPI_WGSV_PWR_ON_ON_RESUME   = 0x02, /* Resume WWAN powered on */
142         TP_ACPI_WGSV_PWR_OFF_ON_RESUME  = 0x03, /* Resume WWAN powered off */
143         TP_ACPI_WGSV_SAVE_STATE         = 0x04, /* Save state for S4/S5 */
144 };
145
146 /* TP_ACPI_WGSV_GET_STATE bits */
147 enum {
148         TP_ACPI_WGSV_STATE_WWANEXIST    = 0x0001, /* WWAN hw available */
149         TP_ACPI_WGSV_STATE_WWANPWR      = 0x0002, /* WWAN radio enabled */
150         TP_ACPI_WGSV_STATE_WWANPWRRES   = 0x0004, /* WWAN state at resume */
151         TP_ACPI_WGSV_STATE_WWANBIOSOFF  = 0x0008, /* WWAN disabled in BIOS */
152         TP_ACPI_WGSV_STATE_BLTHEXIST    = 0x0001, /* BLTH hw available */
153         TP_ACPI_WGSV_STATE_BLTHPWR      = 0x0002, /* BLTH radio enabled */
154         TP_ACPI_WGSV_STATE_BLTHPWRRES   = 0x0004, /* BLTH state at resume */
155         TP_ACPI_WGSV_STATE_BLTHBIOSOFF  = 0x0008, /* BLTH disabled in BIOS */
156         TP_ACPI_WGSV_STATE_UWBEXIST     = 0x0010, /* UWB hw available */
157         TP_ACPI_WGSV_STATE_UWBPWR       = 0x0020, /* UWB radio enabled */
158 };
159
160 /* HKEY events */
161 enum tpacpi_hkey_event_t {
162         /* Hotkey-related */
163         TP_HKEY_EV_HOTKEY_BASE          = 0x1001, /* first hotkey (FN+F1) */
164         TP_HKEY_EV_BRGHT_UP             = 0x1010, /* Brightness up */
165         TP_HKEY_EV_BRGHT_DOWN           = 0x1011, /* Brightness down */
166         TP_HKEY_EV_VOL_UP               = 0x1015, /* Volume up or unmute */
167         TP_HKEY_EV_VOL_DOWN             = 0x1016, /* Volume down or unmute */
168         TP_HKEY_EV_VOL_MUTE             = 0x1017, /* Mixer output mute */
169
170         /* Reasons for waking up from S3/S4 */
171         TP_HKEY_EV_WKUP_S3_UNDOCK       = 0x2304, /* undock requested, S3 */
172         TP_HKEY_EV_WKUP_S4_UNDOCK       = 0x2404, /* undock requested, S4 */
173         TP_HKEY_EV_WKUP_S3_BAYEJ        = 0x2305, /* bay ejection req, S3 */
174         TP_HKEY_EV_WKUP_S4_BAYEJ        = 0x2405, /* bay ejection req, S4 */
175         TP_HKEY_EV_WKUP_S3_BATLOW       = 0x2313, /* battery empty, S3 */
176         TP_HKEY_EV_WKUP_S4_BATLOW       = 0x2413, /* battery empty, S4 */
177
178         /* Auto-sleep after eject request */
179         TP_HKEY_EV_BAYEJ_ACK            = 0x3003, /* bay ejection complete */
180         TP_HKEY_EV_UNDOCK_ACK           = 0x4003, /* undock complete */
181
182         /* Misc bay events */
183         TP_HKEY_EV_OPTDRV_EJ            = 0x3006, /* opt. drive tray ejected */
184
185         /* User-interface events */
186         TP_HKEY_EV_LID_CLOSE            = 0x5001, /* laptop lid closed */
187         TP_HKEY_EV_LID_OPEN             = 0x5002, /* laptop lid opened */
188         TP_HKEY_EV_TABLET_TABLET        = 0x5009, /* tablet swivel up */
189         TP_HKEY_EV_TABLET_NOTEBOOK      = 0x500a, /* tablet swivel down */
190         TP_HKEY_EV_PEN_INSERTED         = 0x500b, /* tablet pen inserted */
191         TP_HKEY_EV_PEN_REMOVED          = 0x500c, /* tablet pen removed */
192         TP_HKEY_EV_BRGHT_CHANGED        = 0x5010, /* backlight control event */
193
194         /* Thermal events */
195         TP_HKEY_EV_ALARM_BAT_HOT        = 0x6011, /* battery too hot */
196         TP_HKEY_EV_ALARM_BAT_XHOT       = 0x6012, /* battery critically hot */
197         TP_HKEY_EV_ALARM_SENSOR_HOT     = 0x6021, /* sensor too hot */
198         TP_HKEY_EV_ALARM_SENSOR_XHOT    = 0x6022, /* sensor critically hot */
199         TP_HKEY_EV_THM_TABLE_CHANGED    = 0x6030, /* thermal table changed */
200
201         /* Misc */
202         TP_HKEY_EV_RFKILL_CHANGED       = 0x7000, /* rfkill switch changed */
203 };
204
205 /****************************************************************************
206  * Main driver
207  */
208
209 #define TPACPI_NAME "thinkpad"
210 #define TPACPI_DESC "ThinkPad ACPI Extras"
211 #define TPACPI_FILE TPACPI_NAME "_acpi"
212 #define TPACPI_URL "http://ibm-acpi.sf.net/"
213 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
214
215 #define TPACPI_PROC_DIR "ibm"
216 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
217 #define TPACPI_DRVR_NAME TPACPI_FILE
218 #define TPACPI_DRVR_SHORTNAME "tpacpi"
219 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
220
221 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
222 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
223
224 #define TPACPI_MAX_ACPI_ARGS 3
225
226 /* printk headers */
227 #define TPACPI_LOG TPACPI_FILE ": "
228 #define TPACPI_EMERG    KERN_EMERG      TPACPI_LOG
229 #define TPACPI_ALERT    KERN_ALERT      TPACPI_LOG
230 #define TPACPI_CRIT     KERN_CRIT       TPACPI_LOG
231 #define TPACPI_ERR      KERN_ERR        TPACPI_LOG
232 #define TPACPI_WARN     KERN_WARNING    TPACPI_LOG
233 #define TPACPI_NOTICE   KERN_NOTICE     TPACPI_LOG
234 #define TPACPI_INFO     KERN_INFO       TPACPI_LOG
235 #define TPACPI_DEBUG    KERN_DEBUG      TPACPI_LOG
236
237 /* Debugging printk groups */
238 #define TPACPI_DBG_ALL          0xffff
239 #define TPACPI_DBG_DISCLOSETASK 0x8000
240 #define TPACPI_DBG_INIT         0x0001
241 #define TPACPI_DBG_EXIT         0x0002
242 #define TPACPI_DBG_RFKILL       0x0004
243 #define TPACPI_DBG_HKEY         0x0008
244 #define TPACPI_DBG_FAN          0x0010
245 #define TPACPI_DBG_BRGHT        0x0020
246 #define TPACPI_DBG_MIXER        0x0040
247
248 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
249 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
250 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
251
252
253 /****************************************************************************
254  * Driver-wide structs and misc. variables
255  */
256
257 struct ibm_struct;
258
259 struct tp_acpi_drv_struct {
260         const struct acpi_device_id *hid;
261         struct acpi_driver *driver;
262
263         void (*notify) (struct ibm_struct *, u32);
264         acpi_handle *handle;
265         u32 type;
266         struct acpi_device *device;
267 };
268
269 struct ibm_struct {
270         char *name;
271
272         int (*read) (struct seq_file *);
273         int (*write) (char *);
274         void (*exit) (void);
275         void (*resume) (void);
276         void (*suspend) (pm_message_t state);
277         void (*shutdown) (void);
278
279         struct list_head all_drivers;
280
281         struct tp_acpi_drv_struct *acpi;
282
283         struct {
284                 u8 acpi_driver_registered:1;
285                 u8 acpi_notify_installed:1;
286                 u8 proc_created:1;
287                 u8 init_called:1;
288                 u8 experimental:1;
289         } flags;
290 };
291
292 struct ibm_init_struct {
293         char param[32];
294
295         int (*init) (struct ibm_init_struct *);
296         mode_t base_procfs_mode;
297         struct ibm_struct *data;
298 };
299
300 static struct {
301         u32 bluetooth:1;
302         u32 hotkey:1;
303         u32 hotkey_mask:1;
304         u32 hotkey_wlsw:1;
305         u32 hotkey_tablet:1;
306         u32 light:1;
307         u32 light_status:1;
308         u32 bright_acpimode:1;
309         u32 bright_unkfw:1;
310         u32 wan:1;
311         u32 uwb:1;
312         u32 fan_ctrl_status_undef:1;
313         u32 second_fan:1;
314         u32 beep_needs_two_args:1;
315         u32 mixer_no_level_control:1;
316         u32 input_device_registered:1;
317         u32 platform_drv_registered:1;
318         u32 platform_drv_attrs_registered:1;
319         u32 sensors_pdrv_registered:1;
320         u32 sensors_pdrv_attrs_registered:1;
321         u32 sensors_pdev_attrs_registered:1;
322         u32 hotkey_poll_active:1;
323 } tp_features;
324
325 static struct {
326         u16 hotkey_mask_ff:1;
327         u16 volume_ctrl_forbidden:1;
328 } tp_warned;
329
330 struct thinkpad_id_data {
331         unsigned int vendor;    /* ThinkPad vendor:
332                                  * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
333
334         char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
335         char *ec_version_str;   /* Something like 1ZHT51WW-1.04a */
336
337         u16 bios_model;         /* 1Y = 0x5931, 0 = unknown */
338         u16 ec_model;
339         u16 bios_release;       /* 1ZETK1WW = 0x314b, 0 = unknown */
340         u16 ec_release;
341
342         char *model_str;        /* ThinkPad T43 */
343         char *nummodel_str;     /* 9384A9C for a 9384-A9C model */
344 };
345 static struct thinkpad_id_data thinkpad_id;
346
347 static enum {
348         TPACPI_LIFE_INIT = 0,
349         TPACPI_LIFE_RUNNING,
350         TPACPI_LIFE_EXITING,
351 } tpacpi_lifecycle;
352
353 static int experimental;
354 static u32 dbg_level;
355
356 static struct workqueue_struct *tpacpi_wq;
357
358 enum led_status_t {
359         TPACPI_LED_OFF = 0,
360         TPACPI_LED_ON,
361         TPACPI_LED_BLINK,
362 };
363
364 /* Special LED class that can defer work */
365 struct tpacpi_led_classdev {
366         struct led_classdev led_classdev;
367         struct work_struct work;
368         enum led_status_t new_state;
369         unsigned int led;
370 };
371
372 /* brightness level capabilities */
373 static unsigned int bright_maxlvl;      /* 0 = unknown */
374
375 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
376 static int dbg_wlswemul;
377 static int tpacpi_wlsw_emulstate;
378 static int dbg_bluetoothemul;
379 static int tpacpi_bluetooth_emulstate;
380 static int dbg_wwanemul;
381 static int tpacpi_wwan_emulstate;
382 static int dbg_uwbemul;
383 static int tpacpi_uwb_emulstate;
384 #endif
385
386
387 /*************************************************************************
388  *  Debugging helpers
389  */
390
391 #define dbg_printk(a_dbg_level, format, arg...) \
392         do { if (dbg_level & (a_dbg_level)) \
393                 printk(TPACPI_DEBUG "%s: " format, __func__ , ## arg); \
394         } while (0)
395
396 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
397 #define vdbg_printk dbg_printk
398 static const char *str_supported(int is_supported);
399 #else
400 #define vdbg_printk(a_dbg_level, format, arg...) \
401         do { } while (0)
402 #endif
403
404 static void tpacpi_log_usertask(const char * const what)
405 {
406         printk(TPACPI_DEBUG "%s: access by process with PID %d\n",
407                 what, task_tgid_vnr(current));
408 }
409
410 #define tpacpi_disclose_usertask(what, format, arg...) \
411         do { \
412                 if (unlikely( \
413                     (dbg_level & TPACPI_DBG_DISCLOSETASK) && \
414                     (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
415                         printk(TPACPI_DEBUG "%s: PID %d: " format, \
416                                 what, task_tgid_vnr(current), ## arg); \
417                 } \
418         } while (0)
419
420 /*
421  * Quirk handling helpers
422  *
423  * ThinkPad IDs and versions seen in the field so far
424  * are two-characters from the set [0-9A-Z], i.e. base 36.
425  *
426  * We use values well outside that range as specials.
427  */
428
429 #define TPACPI_MATCH_ANY                0xffffU
430 #define TPACPI_MATCH_UNKNOWN            0U
431
432 /* TPID('1', 'Y') == 0x5931 */
433 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
434
435 #define TPACPI_Q_IBM(__id1, __id2, __quirk)     \
436         { .vendor = PCI_VENDOR_ID_IBM,          \
437           .bios = TPID(__id1, __id2),           \
438           .ec = TPACPI_MATCH_ANY,               \
439           .quirks = (__quirk) }
440
441 #define TPACPI_Q_LNV(__id1, __id2, __quirk)     \
442         { .vendor = PCI_VENDOR_ID_LENOVO,       \
443           .bios = TPID(__id1, __id2),           \
444           .ec = TPACPI_MATCH_ANY,               \
445           .quirks = (__quirk) }
446
447 #define TPACPI_QEC_LNV(__id1, __id2, __quirk)   \
448         { .vendor = PCI_VENDOR_ID_LENOVO,       \
449           .bios = TPACPI_MATCH_ANY,             \
450           .ec = TPID(__id1, __id2),             \
451           .quirks = (__quirk) }
452
453 struct tpacpi_quirk {
454         unsigned int vendor;
455         u16 bios;
456         u16 ec;
457         unsigned long quirks;
458 };
459
460 /**
461  * tpacpi_check_quirks() - search BIOS/EC version on a list
462  * @qlist:              array of &struct tpacpi_quirk
463  * @qlist_size:         number of elements in @qlist
464  *
465  * Iterates over a quirks list until one is found that matches the
466  * ThinkPad's vendor, BIOS and EC model.
467  *
468  * Returns 0 if nothing matches, otherwise returns the quirks field of
469  * the matching &struct tpacpi_quirk entry.
470  *
471  * The match criteria is: vendor, ec and bios much match.
472  */
473 static unsigned long __init tpacpi_check_quirks(
474                         const struct tpacpi_quirk *qlist,
475                         unsigned int qlist_size)
476 {
477         while (qlist_size) {
478                 if ((qlist->vendor == thinkpad_id.vendor ||
479                                 qlist->vendor == TPACPI_MATCH_ANY) &&
480                     (qlist->bios == thinkpad_id.bios_model ||
481                                 qlist->bios == TPACPI_MATCH_ANY) &&
482                     (qlist->ec == thinkpad_id.ec_model ||
483                                 qlist->ec == TPACPI_MATCH_ANY))
484                         return qlist->quirks;
485
486                 qlist_size--;
487                 qlist++;
488         }
489         return 0;
490 }
491
492 static inline bool __pure __init tpacpi_is_lenovo(void)
493 {
494         return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
495 }
496
497 static inline bool __pure __init tpacpi_is_ibm(void)
498 {
499         return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
500 }
501
502 /****************************************************************************
503  ****************************************************************************
504  *
505  * ACPI Helpers and device model
506  *
507  ****************************************************************************
508  ****************************************************************************/
509
510 /*************************************************************************
511  * ACPI basic handles
512  */
513
514 static acpi_handle root_handle;
515 static acpi_handle ec_handle;
516
517 #define TPACPI_HANDLE(object, parent, paths...)                 \
518         static acpi_handle  object##_handle;                    \
519         static const acpi_handle *object##_parent __initdata =  \
520                                                 &parent##_handle; \
521         static char *object##_paths[] __initdata = { paths }
522
523 TPACPI_HANDLE(ecrd, ec, "ECRD");        /* 570 */
524 TPACPI_HANDLE(ecwr, ec, "ECWR");        /* 570 */
525
526 TPACPI_HANDLE(cmos, root, "\\UCMS",     /* R50, R50e, R50p, R51, */
527                                         /* T4x, X31, X40 */
528            "\\CMOS",            /* A3x, G4x, R32, T23, T30, X22-24, X30 */
529            "\\CMS",             /* R40, R40e */
530            );                   /* all others */
531
532 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY",   /* 600e/x, 770e, 770x */
533            "^HKEY",             /* R30, R31 */
534            "HKEY",              /* all others */
535            );                   /* 570 */
536
537 TPACPI_HANDLE(vid, root, "\\_SB.PCI.AGP.VGA",   /* 570 */
538            "\\_SB.PCI0.AGP0.VID0",      /* 600e/x, 770x */
539            "\\_SB.PCI0.VID0",   /* 770e */
540            "\\_SB.PCI0.VID",    /* A21e, G4x, R50e, X30, X40 */
541            "\\_SB.PCI0.AGP.VGA",        /* X100e and a few others */
542            "\\_SB.PCI0.AGP.VID",        /* all others */
543            );                           /* R30, R31 */
544
545
546 /*************************************************************************
547  * ACPI helpers
548  */
549
550 static int acpi_evalf(acpi_handle handle,
551                       void *res, char *method, char *fmt, ...)
552 {
553         char *fmt0 = fmt;
554         struct acpi_object_list params;
555         union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
556         struct acpi_buffer result, *resultp;
557         union acpi_object out_obj;
558         acpi_status status;
559         va_list ap;
560         char res_type;
561         int success;
562         int quiet;
563
564         if (!*fmt) {
565                 printk(TPACPI_ERR "acpi_evalf() called with empty format\n");
566                 return 0;
567         }
568
569         if (*fmt == 'q') {
570                 quiet = 1;
571                 fmt++;
572         } else
573                 quiet = 0;
574
575         res_type = *(fmt++);
576
577         params.count = 0;
578         params.pointer = &in_objs[0];
579
580         va_start(ap, fmt);
581         while (*fmt) {
582                 char c = *(fmt++);
583                 switch (c) {
584                 case 'd':       /* int */
585                         in_objs[params.count].integer.value = va_arg(ap, int);
586                         in_objs[params.count++].type = ACPI_TYPE_INTEGER;
587                         break;
588                         /* add more types as needed */
589                 default:
590                         printk(TPACPI_ERR "acpi_evalf() called "
591                                "with invalid format character '%c'\n", c);
592                         return 0;
593                 }
594         }
595         va_end(ap);
596
597         if (res_type != 'v') {
598                 result.length = sizeof(out_obj);
599                 result.pointer = &out_obj;
600                 resultp = &result;
601         } else
602                 resultp = NULL;
603
604         status = acpi_evaluate_object(handle, method, &params, resultp);
605
606         switch (res_type) {
607         case 'd':               /* int */
608                 success = (status == AE_OK &&
609                            out_obj.type == ACPI_TYPE_INTEGER);
610                 if (success && res)
611                         *(int *)res = out_obj.integer.value;
612                 break;
613         case 'v':               /* void */
614                 success = status == AE_OK;
615                 break;
616                 /* add more types as needed */
617         default:
618                 printk(TPACPI_ERR "acpi_evalf() called "
619                        "with invalid format character '%c'\n", res_type);
620                 return 0;
621         }
622
623         if (!success && !quiet)
624                 printk(TPACPI_ERR "acpi_evalf(%s, %s, ...) failed: %s\n",
625                        method, fmt0, acpi_format_exception(status));
626
627         return success;
628 }
629
630 static int acpi_ec_read(int i, u8 *p)
631 {
632         int v;
633
634         if (ecrd_handle) {
635                 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
636                         return 0;
637                 *p = v;
638         } else {
639                 if (ec_read(i, p) < 0)
640                         return 0;
641         }
642
643         return 1;
644 }
645
646 static int acpi_ec_write(int i, u8 v)
647 {
648         if (ecwr_handle) {
649                 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
650                         return 0;
651         } else {
652                 if (ec_write(i, v) < 0)
653                         return 0;
654         }
655
656         return 1;
657 }
658
659 static int issue_thinkpad_cmos_command(int cmos_cmd)
660 {
661         if (!cmos_handle)
662                 return -ENXIO;
663
664         if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
665                 return -EIO;
666
667         return 0;
668 }
669
670 /*************************************************************************
671  * ACPI device model
672  */
673
674 #define TPACPI_ACPIHANDLE_INIT(object) \
675         drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
676                 object##_paths, ARRAY_SIZE(object##_paths))
677
678 static void __init drv_acpi_handle_init(const char *name,
679                            acpi_handle *handle, const acpi_handle parent,
680                            char **paths, const int num_paths)
681 {
682         int i;
683         acpi_status status;
684
685         vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
686                 name);
687
688         for (i = 0; i < num_paths; i++) {
689                 status = acpi_get_handle(parent, paths[i], handle);
690                 if (ACPI_SUCCESS(status)) {
691                         dbg_printk(TPACPI_DBG_INIT,
692                                    "Found ACPI handle %s for %s\n",
693                                    paths[i], name);
694                         return;
695                 }
696         }
697
698         vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
699                     name);
700         *handle = NULL;
701 }
702
703 static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
704                         u32 level, void *context, void **return_value)
705 {
706         *(acpi_handle *)return_value = handle;
707
708         return AE_CTRL_TERMINATE;
709 }
710
711 static void __init tpacpi_acpi_handle_locate(const char *name,
712                 const char *hid,
713                 acpi_handle *handle)
714 {
715         acpi_status status;
716         acpi_handle device_found;
717
718         BUG_ON(!name || !hid || !handle);
719         vdbg_printk(TPACPI_DBG_INIT,
720                         "trying to locate ACPI handle for %s, using HID %s\n",
721                         name, hid);
722
723         memset(&device_found, 0, sizeof(device_found));
724         status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
725                                   (void *)name, &device_found);
726
727         *handle = NULL;
728
729         if (ACPI_SUCCESS(status)) {
730                 *handle = device_found;
731                 dbg_printk(TPACPI_DBG_INIT,
732                            "Found ACPI handle for %s\n", name);
733         } else {
734                 vdbg_printk(TPACPI_DBG_INIT,
735                             "Could not locate an ACPI handle for %s: %s\n",
736                             name, acpi_format_exception(status));
737         }
738 }
739
740 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
741 {
742         struct ibm_struct *ibm = data;
743
744         if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
745                 return;
746
747         if (!ibm || !ibm->acpi || !ibm->acpi->notify)
748                 return;
749
750         ibm->acpi->notify(ibm, event);
751 }
752
753 static int __init setup_acpi_notify(struct ibm_struct *ibm)
754 {
755         acpi_status status;
756         int rc;
757
758         BUG_ON(!ibm->acpi);
759
760         if (!*ibm->acpi->handle)
761                 return 0;
762
763         vdbg_printk(TPACPI_DBG_INIT,
764                 "setting up ACPI notify for %s\n", ibm->name);
765
766         rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
767         if (rc < 0) {
768                 printk(TPACPI_ERR "acpi_bus_get_device(%s) failed: %d\n",
769                         ibm->name, rc);
770                 return -ENODEV;
771         }
772
773         ibm->acpi->device->driver_data = ibm;
774         sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
775                 TPACPI_ACPI_EVENT_PREFIX,
776                 ibm->name);
777
778         status = acpi_install_notify_handler(*ibm->acpi->handle,
779                         ibm->acpi->type, dispatch_acpi_notify, ibm);
780         if (ACPI_FAILURE(status)) {
781                 if (status == AE_ALREADY_EXISTS) {
782                         printk(TPACPI_NOTICE
783                                "another device driver is already "
784                                "handling %s events\n", ibm->name);
785                 } else {
786                         printk(TPACPI_ERR
787                                "acpi_install_notify_handler(%s) failed: %s\n",
788                                ibm->name, acpi_format_exception(status));
789                 }
790                 return -ENODEV;
791         }
792         ibm->flags.acpi_notify_installed = 1;
793         return 0;
794 }
795
796 static int __init tpacpi_device_add(struct acpi_device *device)
797 {
798         return 0;
799 }
800
801 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
802 {
803         int rc;
804
805         dbg_printk(TPACPI_DBG_INIT,
806                 "registering %s as an ACPI driver\n", ibm->name);
807
808         BUG_ON(!ibm->acpi);
809
810         ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
811         if (!ibm->acpi->driver) {
812                 printk(TPACPI_ERR
813                        "failed to allocate memory for ibm->acpi->driver\n");
814                 return -ENOMEM;
815         }
816
817         sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
818         ibm->acpi->driver->ids = ibm->acpi->hid;
819
820         ibm->acpi->driver->ops.add = &tpacpi_device_add;
821
822         rc = acpi_bus_register_driver(ibm->acpi->driver);
823         if (rc < 0) {
824                 printk(TPACPI_ERR "acpi_bus_register_driver(%s) failed: %d\n",
825                        ibm->name, rc);
826                 kfree(ibm->acpi->driver);
827                 ibm->acpi->driver = NULL;
828         } else if (!rc)
829                 ibm->flags.acpi_driver_registered = 1;
830
831         return rc;
832 }
833
834
835 /****************************************************************************
836  ****************************************************************************
837  *
838  * Procfs Helpers
839  *
840  ****************************************************************************
841  ****************************************************************************/
842
843 static int dispatch_proc_show(struct seq_file *m, void *v)
844 {
845         struct ibm_struct *ibm = m->private;
846
847         if (!ibm || !ibm->read)
848                 return -EINVAL;
849         return ibm->read(m);
850 }
851
852 static int dispatch_proc_open(struct inode *inode, struct file *file)
853 {
854         return single_open(file, dispatch_proc_show, PDE(inode)->data);
855 }
856
857 static ssize_t dispatch_proc_write(struct file *file,
858                         const char __user *userbuf,
859                         size_t count, loff_t *pos)
860 {
861         struct ibm_struct *ibm = PDE(file->f_path.dentry->d_inode)->data;
862         char *kernbuf;
863         int ret;
864
865         if (!ibm || !ibm->write)
866                 return -EINVAL;
867         if (count > PAGE_SIZE - 2)
868                 return -EINVAL;
869
870         kernbuf = kmalloc(count + 2, GFP_KERNEL);
871         if (!kernbuf)
872                 return -ENOMEM;
873
874         if (copy_from_user(kernbuf, userbuf, count)) {
875                 kfree(kernbuf);
876                 return -EFAULT;
877         }
878
879         kernbuf[count] = 0;
880         strcat(kernbuf, ",");
881         ret = ibm->write(kernbuf);
882         if (ret == 0)
883                 ret = count;
884
885         kfree(kernbuf);
886
887         return ret;
888 }
889
890 static const struct file_operations dispatch_proc_fops = {
891         .owner          = THIS_MODULE,
892         .open           = dispatch_proc_open,
893         .read           = seq_read,
894         .llseek         = seq_lseek,
895         .release        = single_release,
896         .write          = dispatch_proc_write,
897 };
898
899 static char *next_cmd(char **cmds)
900 {
901         char *start = *cmds;
902         char *end;
903
904         while ((end = strchr(start, ',')) && end == start)
905                 start = end + 1;
906
907         if (!end)
908                 return NULL;
909
910         *end = 0;
911         *cmds = end + 1;
912         return start;
913 }
914
915
916 /****************************************************************************
917  ****************************************************************************
918  *
919  * Device model: input, hwmon and platform
920  *
921  ****************************************************************************
922  ****************************************************************************/
923
924 static struct platform_device *tpacpi_pdev;
925 static struct platform_device *tpacpi_sensors_pdev;
926 static struct device *tpacpi_hwmon;
927 static struct input_dev *tpacpi_inputdev;
928 static struct mutex tpacpi_inputdev_send_mutex;
929 static LIST_HEAD(tpacpi_all_drivers);
930
931 static int tpacpi_suspend_handler(struct platform_device *pdev,
932                                   pm_message_t state)
933 {
934         struct ibm_struct *ibm, *itmp;
935
936         list_for_each_entry_safe(ibm, itmp,
937                                  &tpacpi_all_drivers,
938                                  all_drivers) {
939                 if (ibm->suspend)
940                         (ibm->suspend)(state);
941         }
942
943         return 0;
944 }
945
946 static int tpacpi_resume_handler(struct platform_device *pdev)
947 {
948         struct ibm_struct *ibm, *itmp;
949
950         list_for_each_entry_safe(ibm, itmp,
951                                  &tpacpi_all_drivers,
952                                  all_drivers) {
953                 if (ibm->resume)
954                         (ibm->resume)();
955         }
956
957         return 0;
958 }
959
960 static void tpacpi_shutdown_handler(struct platform_device *pdev)
961 {
962         struct ibm_struct *ibm, *itmp;
963
964         list_for_each_entry_safe(ibm, itmp,
965                                  &tpacpi_all_drivers,
966                                  all_drivers) {
967                 if (ibm->shutdown)
968                         (ibm->shutdown)();
969         }
970 }
971
972 static struct platform_driver tpacpi_pdriver = {
973         .driver = {
974                 .name = TPACPI_DRVR_NAME,
975                 .owner = THIS_MODULE,
976         },
977         .suspend = tpacpi_suspend_handler,
978         .resume = tpacpi_resume_handler,
979         .shutdown = tpacpi_shutdown_handler,
980 };
981
982 static struct platform_driver tpacpi_hwmon_pdriver = {
983         .driver = {
984                 .name = TPACPI_HWMON_DRVR_NAME,
985                 .owner = THIS_MODULE,
986         },
987 };
988
989 /*************************************************************************
990  * sysfs support helpers
991  */
992
993 struct attribute_set {
994         unsigned int members, max_members;
995         struct attribute_group group;
996 };
997
998 struct attribute_set_obj {
999         struct attribute_set s;
1000         struct attribute *a;
1001 } __attribute__((packed));
1002
1003 static struct attribute_set *create_attr_set(unsigned int max_members,
1004                                                 const char *name)
1005 {
1006         struct attribute_set_obj *sobj;
1007
1008         if (max_members == 0)
1009                 return NULL;
1010
1011         /* Allocates space for implicit NULL at the end too */
1012         sobj = kzalloc(sizeof(struct attribute_set_obj) +
1013                     max_members * sizeof(struct attribute *),
1014                     GFP_KERNEL);
1015         if (!sobj)
1016                 return NULL;
1017         sobj->s.max_members = max_members;
1018         sobj->s.group.attrs = &sobj->a;
1019         sobj->s.group.name = name;
1020
1021         return &sobj->s;
1022 }
1023
1024 #define destroy_attr_set(_set) \
1025         kfree(_set);
1026
1027 /* not multi-threaded safe, use it in a single thread per set */
1028 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1029 {
1030         if (!s || !attr)
1031                 return -EINVAL;
1032
1033         if (s->members >= s->max_members)
1034                 return -ENOMEM;
1035
1036         s->group.attrs[s->members] = attr;
1037         s->members++;
1038
1039         return 0;
1040 }
1041
1042 static int add_many_to_attr_set(struct attribute_set *s,
1043                         struct attribute **attr,
1044                         unsigned int count)
1045 {
1046         int i, res;
1047
1048         for (i = 0; i < count; i++) {
1049                 res = add_to_attr_set(s, attr[i]);
1050                 if (res)
1051                         return res;
1052         }
1053
1054         return 0;
1055 }
1056
1057 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1058 {
1059         sysfs_remove_group(kobj, &s->group);
1060         destroy_attr_set(s);
1061 }
1062
1063 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1064         sysfs_create_group(_kobj, &_attr_set->group)
1065
1066 static int parse_strtoul(const char *buf,
1067                 unsigned long max, unsigned long *value)
1068 {
1069         char *endp;
1070
1071         *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1072         endp = skip_spaces(endp);
1073         if (*endp || *value > max)
1074                 return -EINVAL;
1075
1076         return 0;
1077 }
1078
1079 static void tpacpi_disable_brightness_delay(void)
1080 {
1081         if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1082                 printk(TPACPI_NOTICE
1083                         "ACPI backlight control delay disabled\n");
1084 }
1085
1086 static void printk_deprecated_attribute(const char * const what,
1087                                         const char * const details)
1088 {
1089         tpacpi_log_usertask("deprecated sysfs attribute");
1090         printk(TPACPI_WARN "WARNING: sysfs attribute %s is deprecated and "
1091                 "will be removed. %s\n",
1092                 what, details);
1093 }
1094
1095 /*************************************************************************
1096  * rfkill and radio control support helpers
1097  */
1098
1099 /*
1100  * ThinkPad-ACPI firmware handling model:
1101  *
1102  * WLSW (master wireless switch) is event-driven, and is common to all
1103  * firmware-controlled radios.  It cannot be controlled, just monitored,
1104  * as expected.  It overrides all radio state in firmware
1105  *
1106  * The kernel, a masked-off hotkey, and WLSW can change the radio state
1107  * (TODO: verify how WLSW interacts with the returned radio state).
1108  *
1109  * The only time there are shadow radio state changes, is when
1110  * masked-off hotkeys are used.
1111  */
1112
1113 /*
1114  * Internal driver API for radio state:
1115  *
1116  * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1117  * bool: true means radio blocked (off)
1118  */
1119 enum tpacpi_rfkill_state {
1120         TPACPI_RFK_RADIO_OFF = 0,
1121         TPACPI_RFK_RADIO_ON
1122 };
1123
1124 /* rfkill switches */
1125 enum tpacpi_rfk_id {
1126         TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1127         TPACPI_RFK_WWAN_SW_ID,
1128         TPACPI_RFK_UWB_SW_ID,
1129         TPACPI_RFK_SW_MAX
1130 };
1131
1132 static const char *tpacpi_rfkill_names[] = {
1133         [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1134         [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1135         [TPACPI_RFK_UWB_SW_ID] = "uwb",
1136         [TPACPI_RFK_SW_MAX] = NULL
1137 };
1138
1139 /* ThinkPad-ACPI rfkill subdriver */
1140 struct tpacpi_rfk {
1141         struct rfkill *rfkill;
1142         enum tpacpi_rfk_id id;
1143         const struct tpacpi_rfk_ops *ops;
1144 };
1145
1146 struct tpacpi_rfk_ops {
1147         /* firmware interface */
1148         int (*get_status)(void);
1149         int (*set_status)(const enum tpacpi_rfkill_state);
1150 };
1151
1152 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1153
1154 /* Query FW and update rfkill sw state for a given rfkill switch */
1155 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1156 {
1157         int status;
1158
1159         if (!tp_rfk)
1160                 return -ENODEV;
1161
1162         status = (tp_rfk->ops->get_status)();
1163         if (status < 0)
1164                 return status;
1165
1166         rfkill_set_sw_state(tp_rfk->rfkill,
1167                             (status == TPACPI_RFK_RADIO_OFF));
1168
1169         return status;
1170 }
1171
1172 /* Query FW and update rfkill sw state for all rfkill switches */
1173 static void tpacpi_rfk_update_swstate_all(void)
1174 {
1175         unsigned int i;
1176
1177         for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1178                 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1179 }
1180
1181 /*
1182  * Sync the HW-blocking state of all rfkill switches,
1183  * do notice it causes the rfkill core to schedule uevents
1184  */
1185 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1186 {
1187         unsigned int i;
1188         struct tpacpi_rfk *tp_rfk;
1189
1190         for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1191                 tp_rfk = tpacpi_rfkill_switches[i];
1192                 if (tp_rfk) {
1193                         if (rfkill_set_hw_state(tp_rfk->rfkill,
1194                                                 blocked)) {
1195                                 /* ignore -- we track sw block */
1196                         }
1197                 }
1198         }
1199 }
1200
1201 /* Call to get the WLSW state from the firmware */
1202 static int hotkey_get_wlsw(void);
1203
1204 /* Call to query WLSW state and update all rfkill switches */
1205 static bool tpacpi_rfk_check_hwblock_state(void)
1206 {
1207         int res = hotkey_get_wlsw();
1208         int hw_blocked;
1209
1210         /* When unknown or unsupported, we have to assume it is unblocked */
1211         if (res < 0)
1212                 return false;
1213
1214         hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1215         tpacpi_rfk_update_hwblock_state(hw_blocked);
1216
1217         return hw_blocked;
1218 }
1219
1220 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1221 {
1222         struct tpacpi_rfk *tp_rfk = data;
1223         int res;
1224
1225         dbg_printk(TPACPI_DBG_RFKILL,
1226                    "request to change radio state to %s\n",
1227                    blocked ? "blocked" : "unblocked");
1228
1229         /* try to set radio state */
1230         res = (tp_rfk->ops->set_status)(blocked ?
1231                                 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1232
1233         /* and update the rfkill core with whatever the FW really did */
1234         tpacpi_rfk_update_swstate(tp_rfk);
1235
1236         return (res < 0) ? res : 0;
1237 }
1238
1239 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1240         .set_block = tpacpi_rfk_hook_set_block,
1241 };
1242
1243 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1244                         const struct tpacpi_rfk_ops *tp_rfkops,
1245                         const enum rfkill_type rfktype,
1246                         const char *name,
1247                         const bool set_default)
1248 {
1249         struct tpacpi_rfk *atp_rfk;
1250         int res;
1251         bool sw_state = false;
1252         bool hw_state;
1253         int sw_status;
1254
1255         BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1256
1257         atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1258         if (atp_rfk)
1259                 atp_rfk->rfkill = rfkill_alloc(name,
1260                                                 &tpacpi_pdev->dev,
1261                                                 rfktype,
1262                                                 &tpacpi_rfk_rfkill_ops,
1263                                                 atp_rfk);
1264         if (!atp_rfk || !atp_rfk->rfkill) {
1265                 printk(TPACPI_ERR
1266                         "failed to allocate memory for rfkill class\n");
1267                 kfree(atp_rfk);
1268                 return -ENOMEM;
1269         }
1270
1271         atp_rfk->id = id;
1272         atp_rfk->ops = tp_rfkops;
1273
1274         sw_status = (tp_rfkops->get_status)();
1275         if (sw_status < 0) {
1276                 printk(TPACPI_ERR
1277                         "failed to read initial state for %s, error %d\n",
1278                         name, sw_status);
1279         } else {
1280                 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1281                 if (set_default) {
1282                         /* try to keep the initial state, since we ask the
1283                          * firmware to preserve it across S5 in NVRAM */
1284                         rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1285                 }
1286         }
1287         hw_state = tpacpi_rfk_check_hwblock_state();
1288         rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1289
1290         res = rfkill_register(atp_rfk->rfkill);
1291         if (res < 0) {
1292                 printk(TPACPI_ERR
1293                         "failed to register %s rfkill switch: %d\n",
1294                         name, res);
1295                 rfkill_destroy(atp_rfk->rfkill);
1296                 kfree(atp_rfk);
1297                 return res;
1298         }
1299
1300         tpacpi_rfkill_switches[id] = atp_rfk;
1301
1302         printk(TPACPI_INFO "rfkill switch %s: radio is %sblocked\n",
1303                 name, (sw_state || hw_state) ? "" : "un");
1304         return 0;
1305 }
1306
1307 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1308 {
1309         struct tpacpi_rfk *tp_rfk;
1310
1311         BUG_ON(id >= TPACPI_RFK_SW_MAX);
1312
1313         tp_rfk = tpacpi_rfkill_switches[id];
1314         if (tp_rfk) {
1315                 rfkill_unregister(tp_rfk->rfkill);
1316                 rfkill_destroy(tp_rfk->rfkill);
1317                 tpacpi_rfkill_switches[id] = NULL;
1318                 kfree(tp_rfk);
1319         }
1320 }
1321
1322 static void printk_deprecated_rfkill_attribute(const char * const what)
1323 {
1324         printk_deprecated_attribute(what,
1325                         "Please switch to generic rfkill before year 2010");
1326 }
1327
1328 /* sysfs <radio> enable ------------------------------------------------ */
1329 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1330                                             struct device_attribute *attr,
1331                                             char *buf)
1332 {
1333         int status;
1334
1335         printk_deprecated_rfkill_attribute(attr->attr.name);
1336
1337         /* This is in the ABI... */
1338         if (tpacpi_rfk_check_hwblock_state()) {
1339                 status = TPACPI_RFK_RADIO_OFF;
1340         } else {
1341                 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1342                 if (status < 0)
1343                         return status;
1344         }
1345
1346         return snprintf(buf, PAGE_SIZE, "%d\n",
1347                         (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1348 }
1349
1350 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1351                             struct device_attribute *attr,
1352                             const char *buf, size_t count)
1353 {
1354         unsigned long t;
1355         int res;
1356
1357         printk_deprecated_rfkill_attribute(attr->attr.name);
1358
1359         if (parse_strtoul(buf, 1, &t))
1360                 return -EINVAL;
1361
1362         tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1363
1364         /* This is in the ABI... */
1365         if (tpacpi_rfk_check_hwblock_state() && !!t)
1366                 return -EPERM;
1367
1368         res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1369                                 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1370         tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1371
1372         return (res < 0) ? res : count;
1373 }
1374
1375 /* procfs -------------------------------------------------------------- */
1376 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1377 {
1378         if (id >= TPACPI_RFK_SW_MAX)
1379                 seq_printf(m, "status:\t\tnot supported\n");
1380         else {
1381                 int status;
1382
1383                 /* This is in the ABI... */
1384                 if (tpacpi_rfk_check_hwblock_state()) {
1385                         status = TPACPI_RFK_RADIO_OFF;
1386                 } else {
1387                         status = tpacpi_rfk_update_swstate(
1388                                                 tpacpi_rfkill_switches[id]);
1389                         if (status < 0)
1390                                 return status;
1391                 }
1392
1393                 seq_printf(m, "status:\t\t%s\n",
1394                                 (status == TPACPI_RFK_RADIO_ON) ?
1395                                         "enabled" : "disabled");
1396                 seq_printf(m, "commands:\tenable, disable\n");
1397         }
1398
1399         return 0;
1400 }
1401
1402 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1403 {
1404         char *cmd;
1405         int status = -1;
1406         int res = 0;
1407
1408         if (id >= TPACPI_RFK_SW_MAX)
1409                 return -ENODEV;
1410
1411         while ((cmd = next_cmd(&buf))) {
1412                 if (strlencmp(cmd, "enable") == 0)
1413                         status = TPACPI_RFK_RADIO_ON;
1414                 else if (strlencmp(cmd, "disable") == 0)
1415                         status = TPACPI_RFK_RADIO_OFF;
1416                 else
1417                         return -EINVAL;
1418         }
1419
1420         if (status != -1) {
1421                 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1422                                 (status == TPACPI_RFK_RADIO_ON) ?
1423                                                 "enable" : "disable",
1424                                 tpacpi_rfkill_names[id]);
1425                 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1426                 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1427         }
1428
1429         return res;
1430 }
1431
1432 /*************************************************************************
1433  * thinkpad-acpi driver attributes
1434  */
1435
1436 /* interface_version --------------------------------------------------- */
1437 static ssize_t tpacpi_driver_interface_version_show(
1438                                 struct device_driver *drv,
1439                                 char *buf)
1440 {
1441         return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1442 }
1443
1444 static DRIVER_ATTR(interface_version, S_IRUGO,
1445                 tpacpi_driver_interface_version_show, NULL);
1446
1447 /* debug_level --------------------------------------------------------- */
1448 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1449                                                 char *buf)
1450 {
1451         return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1452 }
1453
1454 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1455                                                 const char *buf, size_t count)
1456 {
1457         unsigned long t;
1458
1459         if (parse_strtoul(buf, 0xffff, &t))
1460                 return -EINVAL;
1461
1462         dbg_level = t;
1463
1464         return count;
1465 }
1466
1467 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1468                 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1469
1470 /* version ------------------------------------------------------------- */
1471 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1472                                                 char *buf)
1473 {
1474         return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1475                         TPACPI_DESC, TPACPI_VERSION);
1476 }
1477
1478 static DRIVER_ATTR(version, S_IRUGO,
1479                 tpacpi_driver_version_show, NULL);
1480
1481 /* --------------------------------------------------------------------- */
1482
1483 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1484
1485 /* wlsw_emulstate ------------------------------------------------------ */
1486 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1487                                                 char *buf)
1488 {
1489         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1490 }
1491
1492 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1493                                                 const char *buf, size_t count)
1494 {
1495         unsigned long t;
1496
1497         if (parse_strtoul(buf, 1, &t))
1498                 return -EINVAL;
1499
1500         if (tpacpi_wlsw_emulstate != !!t) {
1501                 tpacpi_wlsw_emulstate = !!t;
1502                 tpacpi_rfk_update_hwblock_state(!t);    /* negative logic */
1503         }
1504
1505         return count;
1506 }
1507
1508 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1509                 tpacpi_driver_wlsw_emulstate_show,
1510                 tpacpi_driver_wlsw_emulstate_store);
1511
1512 /* bluetooth_emulstate ------------------------------------------------- */
1513 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1514                                         struct device_driver *drv,
1515                                         char *buf)
1516 {
1517         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1518 }
1519
1520 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1521                                         struct device_driver *drv,
1522                                         const char *buf, size_t count)
1523 {
1524         unsigned long t;
1525
1526         if (parse_strtoul(buf, 1, &t))
1527                 return -EINVAL;
1528
1529         tpacpi_bluetooth_emulstate = !!t;
1530
1531         return count;
1532 }
1533
1534 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1535                 tpacpi_driver_bluetooth_emulstate_show,
1536                 tpacpi_driver_bluetooth_emulstate_store);
1537
1538 /* wwan_emulstate ------------------------------------------------- */
1539 static ssize_t tpacpi_driver_wwan_emulstate_show(
1540                                         struct device_driver *drv,
1541                                         char *buf)
1542 {
1543         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1544 }
1545
1546 static ssize_t tpacpi_driver_wwan_emulstate_store(
1547                                         struct device_driver *drv,
1548                                         const char *buf, size_t count)
1549 {
1550         unsigned long t;
1551
1552         if (parse_strtoul(buf, 1, &t))
1553                 return -EINVAL;
1554
1555         tpacpi_wwan_emulstate = !!t;
1556
1557         return count;
1558 }
1559
1560 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1561                 tpacpi_driver_wwan_emulstate_show,
1562                 tpacpi_driver_wwan_emulstate_store);
1563
1564 /* uwb_emulstate ------------------------------------------------- */
1565 static ssize_t tpacpi_driver_uwb_emulstate_show(
1566                                         struct device_driver *drv,
1567                                         char *buf)
1568 {
1569         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1570 }
1571
1572 static ssize_t tpacpi_driver_uwb_emulstate_store(
1573                                         struct device_driver *drv,
1574                                         const char *buf, size_t count)
1575 {
1576         unsigned long t;
1577
1578         if (parse_strtoul(buf, 1, &t))
1579                 return -EINVAL;
1580
1581         tpacpi_uwb_emulstate = !!t;
1582
1583         return count;
1584 }
1585
1586 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1587                 tpacpi_driver_uwb_emulstate_show,
1588                 tpacpi_driver_uwb_emulstate_store);
1589 #endif
1590
1591 /* --------------------------------------------------------------------- */
1592
1593 static struct driver_attribute *tpacpi_driver_attributes[] = {
1594         &driver_attr_debug_level, &driver_attr_version,
1595         &driver_attr_interface_version,
1596 };
1597
1598 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1599 {
1600         int i, res;
1601
1602         i = 0;
1603         res = 0;
1604         while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1605                 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1606                 i++;
1607         }
1608
1609 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1610         if (!res && dbg_wlswemul)
1611                 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1612         if (!res && dbg_bluetoothemul)
1613                 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1614         if (!res && dbg_wwanemul)
1615                 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1616         if (!res && dbg_uwbemul)
1617                 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1618 #endif
1619
1620         return res;
1621 }
1622
1623 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1624 {
1625         int i;
1626
1627         for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1628                 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1629
1630 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1631         driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1632         driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1633         driver_remove_file(drv, &driver_attr_wwan_emulstate);
1634         driver_remove_file(drv, &driver_attr_uwb_emulstate);
1635 #endif
1636 }
1637
1638 /*************************************************************************
1639  * Firmware Data
1640  */
1641
1642 /*
1643  * Table of recommended minimum BIOS versions
1644  *
1645  * Reasons for listing:
1646  *    1. Stable BIOS, listed because the unknown amount of
1647  *       bugs and bad ACPI behaviour on older versions
1648  *
1649  *    2. BIOS or EC fw with known bugs that trigger on Linux
1650  *
1651  *    3. BIOS with known reduced functionality in older versions
1652  *
1653  *  We recommend the latest BIOS and EC version.
1654  *  We only support the latest BIOS and EC fw version as a rule.
1655  *
1656  *  Sources: IBM ThinkPad Public Web Documents (update changelogs),
1657  *  Information from users in ThinkWiki
1658  *
1659  *  WARNING: we use this table also to detect that the machine is
1660  *  a ThinkPad in some cases, so don't remove entries lightly.
1661  */
1662
1663 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2)          \
1664         { .vendor       = (__v),                        \
1665           .bios         = TPID(__id1, __id2),           \
1666           .ec           = TPACPI_MATCH_ANY,             \
1667           .quirks       = TPACPI_MATCH_ANY << 16        \
1668                           | (__bv1) << 8 | (__bv2) }
1669
1670 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2,      \
1671                 __eid, __ev1, __ev2)                    \
1672         { .vendor       = (__v),                        \
1673           .bios         = TPID(__bid1, __bid2),         \
1674           .ec           = __eid,                        \
1675           .quirks       = (__ev1) << 24 | (__ev2) << 16 \
1676                           | (__bv1) << 8 | (__bv2) }
1677
1678 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1679         TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1680
1681 /* Outdated IBM BIOSes often lack the EC id string */
1682 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1683         TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2,        \
1684                 __bv1, __bv2, TPID(__id1, __id2),       \
1685                 __ev1, __ev2),                          \
1686         TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2,        \
1687                 __bv1, __bv2, TPACPI_MATCH_UNKNOWN,     \
1688                 __ev1, __ev2)
1689
1690 /* Outdated IBM BIOSes often lack the EC id string */
1691 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2,           \
1692                 __eid1, __eid2, __ev1, __ev2)           \
1693         TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2,      \
1694                 __bv1, __bv2, TPID(__eid1, __eid2),     \
1695                 __ev1, __ev2),                          \
1696         TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2,      \
1697                 __bv1, __bv2, TPACPI_MATCH_UNKNOWN,     \
1698                 __ev1, __ev2)
1699
1700 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1701         TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1702
1703 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1704         TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2,     \
1705                 __bv1, __bv2, TPID(__id1, __id2),       \
1706                 __ev1, __ev2)
1707
1708 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2,           \
1709                 __eid1, __eid2, __ev1, __ev2)           \
1710         TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2,   \
1711                 __bv1, __bv2, TPID(__eid1, __eid2),     \
1712                 __ev1, __ev2)
1713
1714 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1715         /*  Numeric models ------------------ */
1716         /*      FW MODEL   BIOS VERS          */
1717         TPV_QI0('I', 'M',  '6', '5'),            /* 570 */
1718         TPV_QI0('I', 'U',  '2', '6'),            /* 570E */
1719         TPV_QI0('I', 'B',  '5', '4'),            /* 600 */
1720         TPV_QI0('I', 'H',  '4', '7'),            /* 600E */
1721         TPV_QI0('I', 'N',  '3', '6'),            /* 600E */
1722         TPV_QI0('I', 'T',  '5', '5'),            /* 600X */
1723         TPV_QI0('I', 'D',  '4', '8'),            /* 770, 770E, 770ED */
1724         TPV_QI0('I', 'I',  '4', '2'),            /* 770X */
1725         TPV_QI0('I', 'O',  '2', '3'),            /* 770Z */
1726
1727         /* A-series ------------------------- */
1728         /*      FW MODEL   BIOS VERS  EC VERS */
1729         TPV_QI0('I', 'W',  '5', '9'),            /* A20m */
1730         TPV_QI0('I', 'V',  '6', '9'),            /* A20p */
1731         TPV_QI0('1', '0',  '2', '6'),            /* A21e, A22e */
1732         TPV_QI0('K', 'U',  '3', '6'),            /* A21e */
1733         TPV_QI0('K', 'X',  '3', '6'),            /* A21m, A22m */
1734         TPV_QI0('K', 'Y',  '3', '8'),            /* A21p, A22p */
1735         TPV_QI0('1', 'B',  '1', '7'),            /* A22e */
1736         TPV_QI0('1', '3',  '2', '0'),            /* A22m */
1737         TPV_QI0('1', 'E',  '7', '3'),            /* A30/p (0) */
1738         TPV_QI1('1', 'G',  '4', '1',  '1', '7'), /* A31/p (0) */
1739         TPV_QI1('1', 'N',  '1', '6',  '0', '7'), /* A31/p (0) */
1740
1741         /* G-series ------------------------- */
1742         /*      FW MODEL   BIOS VERS          */
1743         TPV_QI0('1', 'T',  'A', '6'),            /* G40 */
1744         TPV_QI0('1', 'X',  '5', '7'),            /* G41 */
1745
1746         /* R-series, T-series --------------- */
1747         /*      FW MODEL   BIOS VERS  EC VERS */
1748         TPV_QI0('1', 'C',  'F', '0'),            /* R30 */
1749         TPV_QI0('1', 'F',  'F', '1'),            /* R31 */
1750         TPV_QI0('1', 'M',  '9', '7'),            /* R32 */
1751         TPV_QI0('1', 'O',  '6', '1'),            /* R40 */
1752         TPV_QI0('1', 'P',  '6', '5'),            /* R40 */
1753         TPV_QI0('1', 'S',  '7', '0'),            /* R40e */
1754         TPV_QI1('1', 'R',  'D', 'R',  '7', '1'), /* R50/p, R51,
1755                                                     T40/p, T41/p, T42/p (1) */
1756         TPV_QI1('1', 'V',  '7', '1',  '2', '8'), /* R50e, R51 (1) */
1757         TPV_QI1('7', '8',  '7', '1',  '0', '6'), /* R51e (1) */
1758         TPV_QI1('7', '6',  '6', '9',  '1', '6'), /* R52 (1) */
1759         TPV_QI1('7', '0',  '6', '9',  '2', '8'), /* R52, T43 (1) */
1760
1761         TPV_QI0('I', 'Y',  '6', '1'),            /* T20 */
1762         TPV_QI0('K', 'Z',  '3', '4'),            /* T21 */
1763         TPV_QI0('1', '6',  '3', '2'),            /* T22 */
1764         TPV_QI1('1', 'A',  '6', '4',  '2', '3'), /* T23 (0) */
1765         TPV_QI1('1', 'I',  '7', '1',  '2', '0'), /* T30 (0) */
1766         TPV_QI1('1', 'Y',  '6', '5',  '2', '9'), /* T43/p (1) */
1767
1768         TPV_QL1('7', '9',  'E', '3',  '5', '0'), /* T60/p */
1769         TPV_QL1('7', 'C',  'D', '2',  '2', '2'), /* R60, R60i */
1770         TPV_QL1('7', 'E',  'D', '0',  '1', '5'), /* R60e, R60i */
1771
1772         /*      BIOS FW    BIOS VERS  EC FW     EC VERS */
1773         TPV_QI2('1', 'W',  '9', '0',  '1', 'V', '2', '8'), /* R50e (1) */
1774         TPV_QL2('7', 'I',  '3', '4',  '7', '9', '5', '0'), /* T60/p wide */
1775
1776         /* X-series ------------------------- */
1777         /*      FW MODEL   BIOS VERS  EC VERS */
1778         TPV_QI0('I', 'Z',  '9', 'D'),            /* X20, X21 */
1779         TPV_QI0('1', 'D',  '7', '0'),            /* X22, X23, X24 */
1780         TPV_QI1('1', 'K',  '4', '8',  '1', '8'), /* X30 (0) */
1781         TPV_QI1('1', 'Q',  '9', '7',  '2', '3'), /* X31, X32 (0) */
1782         TPV_QI1('1', 'U',  'D', '3',  'B', '2'), /* X40 (0) */
1783         TPV_QI1('7', '4',  '6', '4',  '2', '7'), /* X41 (0) */
1784         TPV_QI1('7', '5',  '6', '0',  '2', '0'), /* X41t (0) */
1785
1786         TPV_QL1('7', 'B',  'D', '7',  '4', '0'), /* X60/s */
1787         TPV_QL1('7', 'J',  '3', '0',  '1', '3'), /* X60t */
1788
1789         /* (0) - older versions lack DMI EC fw string and functionality */
1790         /* (1) - older versions known to lack functionality */
1791 };
1792
1793 #undef TPV_QL1
1794 #undef TPV_QL0
1795 #undef TPV_QI2
1796 #undef TPV_QI1
1797 #undef TPV_QI0
1798 #undef TPV_Q_X
1799 #undef TPV_Q
1800
1801 static void __init tpacpi_check_outdated_fw(void)
1802 {
1803         unsigned long fwvers;
1804         u16 ec_version, bios_version;
1805
1806         fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1807                                 ARRAY_SIZE(tpacpi_bios_version_qtable));
1808
1809         if (!fwvers)
1810                 return;
1811
1812         bios_version = fwvers & 0xffffU;
1813         ec_version = (fwvers >> 16) & 0xffffU;
1814
1815         /* note that unknown versions are set to 0x0000 and we use that */
1816         if ((bios_version > thinkpad_id.bios_release) ||
1817             (ec_version > thinkpad_id.ec_release &&
1818                                 ec_version != TPACPI_MATCH_ANY)) {
1819                 /*
1820                  * The changelogs would let us track down the exact
1821                  * reason, but it is just too much of a pain to track
1822                  * it.  We only list BIOSes that are either really
1823                  * broken, or really stable to begin with, so it is
1824                  * best if the user upgrades the firmware anyway.
1825                  */
1826                 printk(TPACPI_WARN
1827                         "WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1828                 printk(TPACPI_WARN
1829                         "WARNING: This firmware may be missing critical bug "
1830                         "fixes and/or important features\n");
1831         }
1832 }
1833
1834 static bool __init tpacpi_is_fw_known(void)
1835 {
1836         return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1837                         ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1838 }
1839
1840 /****************************************************************************
1841  ****************************************************************************
1842  *
1843  * Subdrivers
1844  *
1845  ****************************************************************************
1846  ****************************************************************************/
1847
1848 /*************************************************************************
1849  * thinkpad-acpi metadata subdriver
1850  */
1851
1852 static int thinkpad_acpi_driver_read(struct seq_file *m)
1853 {
1854         seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1855         seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1856         return 0;
1857 }
1858
1859 static struct ibm_struct thinkpad_acpi_driver_data = {
1860         .name = "driver",
1861         .read = thinkpad_acpi_driver_read,
1862 };
1863
1864 /*************************************************************************
1865  * Hotkey subdriver
1866  */
1867
1868 /*
1869  * ThinkPad firmware event model
1870  *
1871  * The ThinkPad firmware has two main event interfaces: normal ACPI
1872  * notifications (which follow the ACPI standard), and a private event
1873  * interface.
1874  *
1875  * The private event interface also issues events for the hotkeys.  As
1876  * the driver gained features, the event handling code ended up being
1877  * built around the hotkey subdriver.  This will need to be refactored
1878  * to a more formal event API eventually.
1879  *
1880  * Some "hotkeys" are actually supposed to be used as event reports,
1881  * such as "brightness has changed", "volume has changed", depending on
1882  * the ThinkPad model and how the firmware is operating.
1883  *
1884  * Unlike other classes, hotkey-class events have mask/unmask control on
1885  * non-ancient firmware.  However, how it behaves changes a lot with the
1886  * firmware model and version.
1887  */
1888
1889 enum {  /* hot key scan codes (derived from ACPI DSDT) */
1890         TP_ACPI_HOTKEYSCAN_FNF1         = 0,
1891         TP_ACPI_HOTKEYSCAN_FNF2,
1892         TP_ACPI_HOTKEYSCAN_FNF3,
1893         TP_ACPI_HOTKEYSCAN_FNF4,
1894         TP_ACPI_HOTKEYSCAN_FNF5,
1895         TP_ACPI_HOTKEYSCAN_FNF6,
1896         TP_ACPI_HOTKEYSCAN_FNF7,
1897         TP_ACPI_HOTKEYSCAN_FNF8,
1898         TP_ACPI_HOTKEYSCAN_FNF9,
1899         TP_ACPI_HOTKEYSCAN_FNF10,
1900         TP_ACPI_HOTKEYSCAN_FNF11,
1901         TP_ACPI_HOTKEYSCAN_FNF12,
1902         TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1903         TP_ACPI_HOTKEYSCAN_FNINSERT,
1904         TP_ACPI_HOTKEYSCAN_FNDELETE,
1905         TP_ACPI_HOTKEYSCAN_FNHOME,
1906         TP_ACPI_HOTKEYSCAN_FNEND,
1907         TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1908         TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1909         TP_ACPI_HOTKEYSCAN_FNSPACE,
1910         TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1911         TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1912         TP_ACPI_HOTKEYSCAN_MUTE,
1913         TP_ACPI_HOTKEYSCAN_THINKPAD,
1914 };
1915
1916 enum {  /* Keys/events available through NVRAM polling */
1917         TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1918         TPACPI_HKEY_NVRAM_GOOD_MASK  = 0x00fb8000U,
1919 };
1920
1921 enum {  /* Positions of some of the keys in hotkey masks */
1922         TP_ACPI_HKEY_DISPSWTCH_MASK     = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1923         TP_ACPI_HKEY_DISPXPAND_MASK     = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1924         TP_ACPI_HKEY_HIBERNATE_MASK     = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1925         TP_ACPI_HKEY_BRGHTUP_MASK       = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1926         TP_ACPI_HKEY_BRGHTDWN_MASK      = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1927         TP_ACPI_HKEY_THNKLGHT_MASK      = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1928         TP_ACPI_HKEY_ZOOM_MASK          = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1929         TP_ACPI_HKEY_VOLUP_MASK         = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1930         TP_ACPI_HKEY_VOLDWN_MASK        = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1931         TP_ACPI_HKEY_MUTE_MASK          = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1932         TP_ACPI_HKEY_THINKPAD_MASK      = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1933 };
1934
1935 enum {  /* NVRAM to ACPI HKEY group map */
1936         TP_NVRAM_HKEY_GROUP_HK2         = TP_ACPI_HKEY_THINKPAD_MASK |
1937                                           TP_ACPI_HKEY_ZOOM_MASK |
1938                                           TP_ACPI_HKEY_DISPSWTCH_MASK |
1939                                           TP_ACPI_HKEY_HIBERNATE_MASK,
1940         TP_NVRAM_HKEY_GROUP_BRIGHTNESS  = TP_ACPI_HKEY_BRGHTUP_MASK |
1941                                           TP_ACPI_HKEY_BRGHTDWN_MASK,
1942         TP_NVRAM_HKEY_GROUP_VOLUME      = TP_ACPI_HKEY_VOLUP_MASK |
1943                                           TP_ACPI_HKEY_VOLDWN_MASK |
1944                                           TP_ACPI_HKEY_MUTE_MASK,
1945 };
1946
1947 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1948 struct tp_nvram_state {
1949        u16 thinkpad_toggle:1;
1950        u16 zoom_toggle:1;
1951        u16 display_toggle:1;
1952        u16 thinklight_toggle:1;
1953        u16 hibernate_toggle:1;
1954        u16 displayexp_toggle:1;
1955        u16 display_state:1;
1956        u16 brightness_toggle:1;
1957        u16 volume_toggle:1;
1958        u16 mute:1;
1959
1960        u8 brightness_level;
1961        u8 volume_level;
1962 };
1963
1964 /* kthread for the hotkey poller */
1965 static struct task_struct *tpacpi_hotkey_task;
1966
1967 /* Acquired while the poller kthread is running, use to sync start/stop */
1968 static struct mutex hotkey_thread_mutex;
1969
1970 /*
1971  * Acquire mutex to write poller control variables as an
1972  * atomic block.
1973  *
1974  * Increment hotkey_config_change when changing them if you
1975  * want the kthread to forget old state.
1976  *
1977  * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1978  */
1979 static struct mutex hotkey_thread_data_mutex;
1980 static unsigned int hotkey_config_change;
1981
1982 /*
1983  * hotkey poller control variables
1984  *
1985  * Must be atomic or readers will also need to acquire mutex
1986  *
1987  * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1988  * should be used only when the changes need to be taken as
1989  * a block, OR when one needs to force the kthread to forget
1990  * old state.
1991  */
1992 static u32 hotkey_source_mask;          /* bit mask 0=ACPI,1=NVRAM */
1993 static unsigned int hotkey_poll_freq = 10; /* Hz */
1994
1995 #define HOTKEY_CONFIG_CRITICAL_START \
1996         do { \
1997                 mutex_lock(&hotkey_thread_data_mutex); \
1998                 hotkey_config_change++; \
1999         } while (0);
2000 #define HOTKEY_CONFIG_CRITICAL_END \
2001         mutex_unlock(&hotkey_thread_data_mutex);
2002
2003 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2004
2005 #define hotkey_source_mask 0U
2006 #define HOTKEY_CONFIG_CRITICAL_START
2007 #define HOTKEY_CONFIG_CRITICAL_END
2008
2009 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2010
2011 static struct mutex hotkey_mutex;
2012
2013 static enum {   /* Reasons for waking up */
2014         TP_ACPI_WAKEUP_NONE = 0,        /* None or unknown */
2015         TP_ACPI_WAKEUP_BAYEJ,           /* Bay ejection request */
2016         TP_ACPI_WAKEUP_UNDOCK,          /* Undock request */
2017 } hotkey_wakeup_reason;
2018
2019 static int hotkey_autosleep_ack;
2020
2021 static u32 hotkey_orig_mask;            /* events the BIOS had enabled */
2022 static u32 hotkey_all_mask;             /* all events supported in fw */
2023 static u32 hotkey_reserved_mask;        /* events better left disabled */
2024 static u32 hotkey_driver_mask;          /* events needed by the driver */
2025 static u32 hotkey_user_mask;            /* events visible to userspace */
2026 static u32 hotkey_acpi_mask;            /* events enabled in firmware */
2027
2028 static unsigned int hotkey_report_mode;
2029
2030 static u16 *hotkey_keycode_map;
2031
2032 static struct attribute_set *hotkey_dev_attributes;
2033
2034 static void tpacpi_driver_event(const unsigned int hkey_event);
2035 static void hotkey_driver_event(const unsigned int scancode);
2036 static void hotkey_poll_setup(const bool may_warn);
2037
2038 /* HKEY.MHKG() return bits */
2039 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2040
2041 static int hotkey_get_wlsw(void)
2042 {
2043         int status;
2044
2045         if (!tp_features.hotkey_wlsw)
2046                 return -ENODEV;
2047
2048 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2049         if (dbg_wlswemul)
2050                 return (tpacpi_wlsw_emulstate) ?
2051                                 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2052 #endif
2053
2054         if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2055                 return -EIO;
2056
2057         return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2058 }
2059
2060 static int hotkey_get_tablet_mode(int *status)
2061 {
2062         int s;
2063
2064         if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2065                 return -EIO;
2066
2067         *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2068         return 0;
2069 }
2070
2071 /*
2072  * Reads current event mask from firmware, and updates
2073  * hotkey_acpi_mask accordingly.  Also resets any bits
2074  * from hotkey_user_mask that are unavailable to be
2075  * delivered (shadow requirement of the userspace ABI).
2076  *
2077  * Call with hotkey_mutex held
2078  */
2079 static int hotkey_mask_get(void)
2080 {
2081         if (tp_features.hotkey_mask) {
2082                 u32 m = 0;
2083
2084                 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2085                         return -EIO;
2086
2087                 hotkey_acpi_mask = m;
2088         } else {
2089                 /* no mask support doesn't mean no event support... */
2090                 hotkey_acpi_mask = hotkey_all_mask;
2091         }
2092
2093         /* sync userspace-visible mask */
2094         hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2095
2096         return 0;
2097 }
2098
2099 void static hotkey_mask_warn_incomplete_mask(void)
2100 {
2101         /* log only what the user can fix... */
2102         const u32 wantedmask = hotkey_driver_mask &
2103                 ~(hotkey_acpi_mask | hotkey_source_mask) &
2104                 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2105
2106         if (wantedmask)
2107                 printk(TPACPI_NOTICE
2108                         "required events 0x%08x not enabled!\n",
2109                         wantedmask);
2110 }
2111
2112 /*
2113  * Set the firmware mask when supported
2114  *
2115  * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2116  *
2117  * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2118  *
2119  * Call with hotkey_mutex held
2120  */
2121 static int hotkey_mask_set(u32 mask)
2122 {
2123         int i;
2124         int rc = 0;
2125
2126         const u32 fwmask = mask & ~hotkey_source_mask;
2127
2128         if (tp_features.hotkey_mask) {
2129                 for (i = 0; i < 32; i++) {
2130                         if (!acpi_evalf(hkey_handle,
2131                                         NULL, "MHKM", "vdd", i + 1,
2132                                         !!(mask & (1 << i)))) {
2133                                 rc = -EIO;
2134                                 break;
2135                         }
2136                 }
2137         }
2138
2139         /*
2140          * We *must* make an inconditional call to hotkey_mask_get to
2141          * refresh hotkey_acpi_mask and update hotkey_user_mask
2142          *
2143          * Take the opportunity to also log when we cannot _enable_
2144          * a given event.
2145          */
2146         if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2147                 printk(TPACPI_NOTICE
2148                        "asked for hotkey mask 0x%08x, but "
2149                        "firmware forced it to 0x%08x\n",
2150                        fwmask, hotkey_acpi_mask);
2151         }
2152
2153         if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2154                 hotkey_mask_warn_incomplete_mask();
2155
2156         return rc;
2157 }
2158
2159 /*
2160  * Sets hotkey_user_mask and tries to set the firmware mask
2161  *
2162  * Call with hotkey_mutex held
2163  */
2164 static int hotkey_user_mask_set(const u32 mask)
2165 {
2166         int rc;
2167
2168         /* Give people a chance to notice they are doing something that
2169          * is bound to go boom on their users sooner or later */
2170         if (!tp_warned.hotkey_mask_ff &&
2171             (mask == 0xffff || mask == 0xffffff ||
2172              mask == 0xffffffff)) {
2173                 tp_warned.hotkey_mask_ff = 1;
2174                 printk(TPACPI_NOTICE
2175                        "setting the hotkey mask to 0x%08x is likely "
2176                        "not the best way to go about it\n", mask);
2177                 printk(TPACPI_NOTICE
2178                        "please consider using the driver defaults, "
2179                        "and refer to up-to-date thinkpad-acpi "
2180                        "documentation\n");
2181         }
2182
2183         /* Try to enable what the user asked for, plus whatever we need.
2184          * this syncs everything but won't enable bits in hotkey_user_mask */
2185         rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2186
2187         /* Enable the available bits in hotkey_user_mask */
2188         hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2189
2190         return rc;
2191 }
2192
2193 /*
2194  * Sets the driver hotkey mask.
2195  *
2196  * Can be called even if the hotkey subdriver is inactive
2197  */
2198 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2199 {
2200         int rc;
2201
2202         /* Do the right thing if hotkey_init has not been called yet */
2203         if (!tp_features.hotkey) {
2204                 hotkey_driver_mask = mask;
2205                 return 0;
2206         }
2207
2208         mutex_lock(&hotkey_mutex);
2209
2210         HOTKEY_CONFIG_CRITICAL_START
2211         hotkey_driver_mask = mask;
2212 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2213         hotkey_source_mask |= (mask & ~hotkey_all_mask);
2214 #endif
2215         HOTKEY_CONFIG_CRITICAL_END
2216
2217         rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2218                                                         ~hotkey_source_mask);
2219         hotkey_poll_setup(true);
2220
2221         mutex_unlock(&hotkey_mutex);
2222
2223         return rc;
2224 }
2225
2226 static int hotkey_status_get(int *status)
2227 {
2228         if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2229                 return -EIO;
2230
2231         return 0;
2232 }
2233
2234 static int hotkey_status_set(bool enable)
2235 {
2236         if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2237                 return -EIO;
2238
2239         return 0;
2240 }
2241
2242 static void tpacpi_input_send_tabletsw(void)
2243 {
2244         int state;
2245
2246         if (tp_features.hotkey_tablet &&
2247             !hotkey_get_tablet_mode(&state)) {
2248                 mutex_lock(&tpacpi_inputdev_send_mutex);
2249
2250                 input_report_switch(tpacpi_inputdev,
2251                                     SW_TABLET_MODE, !!state);
2252                 input_sync(tpacpi_inputdev);
2253
2254                 mutex_unlock(&tpacpi_inputdev_send_mutex);
2255         }
2256 }
2257
2258 /* Do NOT call without validating scancode first */
2259 static void tpacpi_input_send_key(const unsigned int scancode)
2260 {
2261         const unsigned int keycode = hotkey_keycode_map[scancode];
2262
2263         if (keycode != KEY_RESERVED) {
2264                 mutex_lock(&tpacpi_inputdev_send_mutex);
2265
2266                 input_report_key(tpacpi_inputdev, keycode, 1);
2267                 if (keycode == KEY_UNKNOWN)
2268                         input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2269                                     scancode);
2270                 input_sync(tpacpi_inputdev);
2271
2272                 input_report_key(tpacpi_inputdev, keycode, 0);
2273                 if (keycode == KEY_UNKNOWN)
2274                         input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2275                                     scancode);
2276                 input_sync(tpacpi_inputdev);
2277
2278                 mutex_unlock(&tpacpi_inputdev_send_mutex);
2279         }
2280 }
2281
2282 /* Do NOT call without validating scancode first */
2283 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2284 {
2285         hotkey_driver_event(scancode);
2286         if (hotkey_user_mask & (1 << scancode))
2287                 tpacpi_input_send_key(scancode);
2288 }
2289
2290 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2291 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2292
2293 /* Do NOT call without validating scancode first */
2294 static void tpacpi_hotkey_send_key(unsigned int scancode)
2295 {
2296         tpacpi_input_send_key_masked(scancode);
2297         if (hotkey_report_mode < 2) {
2298                 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2299                                 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2300         }
2301 }
2302
2303 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2304 {
2305         u8 d;
2306
2307         if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2308                 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2309                 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2310                 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2311                 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2312                 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2313         }
2314         if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2315                 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2316                 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2317         }
2318         if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2319                 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2320                 n->displayexp_toggle =
2321                                 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2322         }
2323         if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2324                 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2325                 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2326                                 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2327                 n->brightness_toggle =
2328                                 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2329         }
2330         if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2331                 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2332                 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2333                                 >> TP_NVRAM_POS_LEVEL_VOLUME;
2334                 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2335                 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2336         }
2337 }
2338
2339 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2340                                            struct tp_nvram_state *newn,
2341                                            const u32 event_mask)
2342 {
2343
2344 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2345         do { \
2346                 if ((event_mask & (1 << __scancode)) && \
2347                     oldn->__member != newn->__member) \
2348                         tpacpi_hotkey_send_key(__scancode); \
2349         } while (0)
2350
2351 #define TPACPI_MAY_SEND_KEY(__scancode) \
2352         do { \
2353                 if (event_mask & (1 << __scancode)) \
2354                         tpacpi_hotkey_send_key(__scancode); \
2355         } while (0)
2356
2357         void issue_volchange(const unsigned int oldvol,
2358                              const unsigned int newvol)
2359         {
2360                 unsigned int i = oldvol;
2361
2362                 while (i > newvol) {
2363                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2364                         i--;
2365                 }
2366                 while (i < newvol) {
2367                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2368                         i++;
2369                 }
2370         }
2371
2372         void issue_brightnesschange(const unsigned int oldbrt,
2373                                     const unsigned int newbrt)
2374         {
2375                 unsigned int i = oldbrt;
2376
2377                 while (i > newbrt) {
2378                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2379                         i--;
2380                 }
2381                 while (i < newbrt) {
2382                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2383                         i++;
2384                 }
2385         }
2386
2387         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2388         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2389         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2390         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2391
2392         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2393
2394         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2395
2396         /*
2397          * Handle volume
2398          *
2399          * This code is supposed to duplicate the IBM firmware behaviour:
2400          * - Pressing MUTE issues mute hotkey message, even when already mute
2401          * - Pressing Volume up/down issues volume up/down hotkey messages,
2402          *   even when already at maximum or minumum volume
2403          * - The act of unmuting issues volume up/down notification,
2404          *   depending which key was used to unmute
2405          *
2406          * We are constrained to what the NVRAM can tell us, which is not much
2407          * and certainly not enough if more than one volume hotkey was pressed
2408          * since the last poll cycle.
2409          *
2410          * Just to make our life interesting, some newer Lenovo ThinkPads have
2411          * bugs in the BIOS and may fail to update volume_toggle properly.
2412          */
2413         if (newn->mute) {
2414                 /* muted */
2415                 if (!oldn->mute ||
2416                     oldn->volume_toggle != newn->volume_toggle ||
2417                     oldn->volume_level != newn->volume_level) {
2418                         /* recently muted, or repeated mute keypress, or
2419                          * multiple presses ending in mute */
2420                         issue_volchange(oldn->volume_level, newn->volume_level);
2421                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2422                 }
2423         } else {
2424                 /* unmute */
2425                 if (oldn->mute) {
2426                         /* recently unmuted, issue 'unmute' keypress */
2427                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2428                 }
2429                 if (oldn->volume_level != newn->volume_level) {
2430                         issue_volchange(oldn->volume_level, newn->volume_level);
2431                 } else if (oldn->volume_toggle != newn->volume_toggle) {
2432                         /* repeated vol up/down keypress at end of scale ? */
2433                         if (newn->volume_level == 0)
2434                                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2435                         else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2436                                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2437                 }
2438         }
2439
2440         /* handle brightness */
2441         if (oldn->brightness_level != newn->brightness_level) {
2442                 issue_brightnesschange(oldn->brightness_level,
2443                                        newn->brightness_level);
2444         } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2445                 /* repeated key presses that didn't change state */
2446                 if (newn->brightness_level == 0)
2447                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2448                 else if (newn->brightness_level >= bright_maxlvl
2449                                 && !tp_features.bright_unkfw)
2450                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2451         }
2452
2453 #undef TPACPI_COMPARE_KEY
2454 #undef TPACPI_MAY_SEND_KEY
2455 }
2456
2457 /*
2458  * Polling driver
2459  *
2460  * We track all events in hotkey_source_mask all the time, since
2461  * most of them are edge-based.  We only issue those requested by
2462  * hotkey_user_mask or hotkey_driver_mask, though.
2463  */
2464 static int hotkey_kthread(void *data)
2465 {
2466         struct tp_nvram_state s[2];
2467         u32 poll_mask, event_mask;
2468         unsigned int si, so;
2469         unsigned long t;
2470         unsigned int change_detector, must_reset;
2471         unsigned int poll_freq;
2472
2473         mutex_lock(&hotkey_thread_mutex);
2474
2475         if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2476                 goto exit;
2477
2478         set_freezable();
2479
2480         so = 0;
2481         si = 1;
2482         t = 0;
2483
2484         /* Initial state for compares */
2485         mutex_lock(&hotkey_thread_data_mutex);
2486         change_detector = hotkey_config_change;
2487         poll_mask = hotkey_source_mask;
2488         event_mask = hotkey_source_mask &
2489                         (hotkey_driver_mask | hotkey_user_mask);
2490         poll_freq = hotkey_poll_freq;
2491         mutex_unlock(&hotkey_thread_data_mutex);
2492         hotkey_read_nvram(&s[so], poll_mask);
2493
2494         while (!kthread_should_stop()) {
2495                 if (t == 0) {
2496                         if (likely(poll_freq))
2497                                 t = 1000/poll_freq;
2498                         else
2499                                 t = 100;        /* should never happen... */
2500                 }
2501                 t = msleep_interruptible(t);
2502                 if (unlikely(kthread_should_stop()))
2503                         break;
2504                 must_reset = try_to_freeze();
2505                 if (t > 0 && !must_reset)
2506                         continue;
2507
2508                 mutex_lock(&hotkey_thread_data_mutex);
2509                 if (must_reset || hotkey_config_change != change_detector) {
2510                         /* forget old state on thaw or config change */
2511                         si = so;
2512                         t = 0;
2513                         change_detector = hotkey_config_change;
2514                 }
2515                 poll_mask = hotkey_source_mask;
2516                 event_mask = hotkey_source_mask &
2517                                 (hotkey_driver_mask | hotkey_user_mask);
2518                 poll_freq = hotkey_poll_freq;
2519                 mutex_unlock(&hotkey_thread_data_mutex);
2520
2521                 if (likely(poll_mask)) {
2522                         hotkey_read_nvram(&s[si], poll_mask);
2523                         if (likely(si != so)) {
2524                                 hotkey_compare_and_issue_event(&s[so], &s[si],
2525                                                                 event_mask);
2526                         }
2527                 }
2528
2529                 so = si;
2530                 si ^= 1;
2531         }
2532
2533 exit:
2534         mutex_unlock(&hotkey_thread_mutex);
2535         return 0;
2536 }
2537
2538 /* call with hotkey_mutex held */
2539 static void hotkey_poll_stop_sync(void)
2540 {
2541         if (tpacpi_hotkey_task) {
2542                 if (frozen(tpacpi_hotkey_task) ||
2543                     freezing(tpacpi_hotkey_task))
2544                         thaw_process(tpacpi_hotkey_task);
2545
2546                 kthread_stop(tpacpi_hotkey_task);
2547                 tpacpi_hotkey_task = NULL;
2548                 mutex_lock(&hotkey_thread_mutex);
2549                 /* at this point, the thread did exit */
2550                 mutex_unlock(&hotkey_thread_mutex);
2551         }
2552 }
2553
2554 /* call with hotkey_mutex held */
2555 static void hotkey_poll_setup(const bool may_warn)
2556 {
2557         const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2558         const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2559
2560         if (hotkey_poll_freq > 0 &&
2561             (poll_driver_mask ||
2562              (poll_user_mask && tpacpi_inputdev->users > 0))) {
2563                 if (!tpacpi_hotkey_task) {
2564                         tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2565                                         NULL, TPACPI_NVRAM_KTHREAD_NAME);
2566                         if (IS_ERR(tpacpi_hotkey_task)) {
2567                                 tpacpi_hotkey_task = NULL;
2568                                 printk(TPACPI_ERR
2569                                        "could not create kernel thread "
2570                                        "for hotkey polling\n");
2571                         }
2572                 }
2573         } else {
2574                 hotkey_poll_stop_sync();
2575                 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2576                     hotkey_poll_freq == 0) {
2577                         printk(TPACPI_NOTICE
2578                                 "hot keys 0x%08x and/or events 0x%08x "
2579                                 "require polling, which is currently "
2580                                 "disabled\n",
2581                                 poll_user_mask, poll_driver_mask);
2582                 }
2583         }
2584 }
2585
2586 static void hotkey_poll_setup_safe(const bool may_warn)
2587 {
2588         mutex_lock(&hotkey_mutex);
2589         hotkey_poll_setup(may_warn);
2590         mutex_unlock(&hotkey_mutex);
2591 }
2592
2593 /* call with hotkey_mutex held */
2594 static void hotkey_poll_set_freq(unsigned int freq)
2595 {
2596         if (!freq)
2597                 hotkey_poll_stop_sync();
2598
2599         hotkey_poll_freq = freq;
2600 }
2601
2602 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2603
2604 static void hotkey_poll_setup(const bool __unused)
2605 {
2606 }
2607
2608 static void hotkey_poll_setup_safe(const bool __unused)
2609 {
2610 }
2611
2612 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2613
2614 static int hotkey_inputdev_open(struct input_dev *dev)
2615 {
2616         switch (tpacpi_lifecycle) {
2617         case TPACPI_LIFE_INIT:
2618         case TPACPI_LIFE_RUNNING:
2619                 hotkey_poll_setup_safe(false);
2620                 return 0;
2621         case TPACPI_LIFE_EXITING:
2622                 return -EBUSY;
2623         }
2624
2625         /* Should only happen if tpacpi_lifecycle is corrupt */
2626         BUG();
2627         return -EBUSY;
2628 }
2629
2630 static void hotkey_inputdev_close(struct input_dev *dev)
2631 {
2632         /* disable hotkey polling when possible */
2633         if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2634             !(hotkey_source_mask & hotkey_driver_mask))
2635                 hotkey_poll_setup_safe(false);
2636 }
2637
2638 /* sysfs hotkey enable ------------------------------------------------- */
2639 static ssize_t hotkey_enable_show(struct device *dev,
2640                            struct device_attribute *attr,
2641                            char *buf)
2642 {
2643         int res, status;
2644
2645         printk_deprecated_attribute("hotkey_enable",
2646                         "Hotkey reporting is always enabled");
2647
2648         res = hotkey_status_get(&status);
2649         if (res)
2650                 return res;
2651
2652         return snprintf(buf, PAGE_SIZE, "%d\n", status);
2653 }
2654
2655 static ssize_t hotkey_enable_store(struct device *dev,
2656                             struct device_attribute *attr,
2657                             const char *buf, size_t count)
2658 {
2659         unsigned long t;
2660
2661         printk_deprecated_attribute("hotkey_enable",
2662                         "Hotkeys can be disabled through hotkey_mask");
2663
2664         if (parse_strtoul(buf, 1, &t))
2665                 return -EINVAL;
2666
2667         if (t == 0)
2668                 return -EPERM;
2669
2670         return count;
2671 }
2672
2673 static struct device_attribute dev_attr_hotkey_enable =
2674         __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2675                 hotkey_enable_show, hotkey_enable_store);
2676
2677 /* sysfs hotkey mask --------------------------------------------------- */
2678 static ssize_t hotkey_mask_show(struct device *dev,
2679                            struct device_attribute *attr,
2680                            char *buf)
2681 {
2682         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2683 }
2684
2685 static ssize_t hotkey_mask_store(struct device *dev,
2686                             struct device_attribute *attr,
2687                             const char *buf, size_t count)
2688 {
2689         unsigned long t;
2690         int res;
2691
2692         if (parse_strtoul(buf, 0xffffffffUL, &t))
2693                 return -EINVAL;
2694
2695         if (mutex_lock_killable(&hotkey_mutex))
2696                 return -ERESTARTSYS;
2697
2698         res = hotkey_user_mask_set(t);
2699
2700 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2701         hotkey_poll_setup(true);
2702 #endif
2703
2704         mutex_unlock(&hotkey_mutex);
2705
2706         tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2707
2708         return (res) ? res : count;
2709 }
2710
2711 static struct device_attribute dev_attr_hotkey_mask =
2712         __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2713                 hotkey_mask_show, hotkey_mask_store);
2714
2715 /* sysfs hotkey bios_enabled ------------------------------------------- */
2716 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2717                            struct device_attribute *attr,
2718                            char *buf)
2719 {
2720         return sprintf(buf, "0\n");
2721 }
2722
2723 static struct device_attribute dev_attr_hotkey_bios_enabled =
2724         __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2725
2726 /* sysfs hotkey bios_mask ---------------------------------------------- */
2727 static ssize_t hotkey_bios_mask_show(struct device *dev,
2728                            struct device_attribute *attr,
2729                            char *buf)
2730 {
2731         printk_deprecated_attribute("hotkey_bios_mask",
2732                         "This attribute is useless.");
2733         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2734 }
2735
2736 static struct device_attribute dev_attr_hotkey_bios_mask =
2737         __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2738
2739 /* sysfs hotkey all_mask ----------------------------------------------- */
2740 static ssize_t hotkey_all_mask_show(struct device *dev,
2741                            struct device_attribute *attr,
2742                            char *buf)
2743 {
2744         return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2745                                 hotkey_all_mask | hotkey_source_mask);
2746 }
2747
2748 static struct device_attribute dev_attr_hotkey_all_mask =
2749         __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2750
2751 /* sysfs hotkey recommended_mask --------------------------------------- */
2752 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2753                                             struct device_attribute *attr,
2754                                             char *buf)
2755 {
2756         return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2757                         (hotkey_all_mask | hotkey_source_mask)
2758                         & ~hotkey_reserved_mask);
2759 }
2760
2761 static struct device_attribute dev_attr_hotkey_recommended_mask =
2762         __ATTR(hotkey_recommended_mask, S_IRUGO,
2763                 hotkey_recommended_mask_show, NULL);
2764
2765 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2766
2767 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2768 static ssize_t hotkey_source_mask_show(struct device *dev,
2769                            struct device_attribute *attr,
2770                            char *buf)
2771 {
2772         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2773 }
2774
2775 static ssize_t hotkey_source_mask_store(struct device *dev,
2776                             struct device_attribute *attr,
2777                             const char *buf, size_t count)
2778 {
2779         unsigned long t;
2780         u32 r_ev;
2781         int rc;
2782
2783         if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2784                 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2785                 return -EINVAL;
2786
2787         if (mutex_lock_killable(&hotkey_mutex))
2788                 return -ERESTARTSYS;
2789
2790         HOTKEY_CONFIG_CRITICAL_START
2791         hotkey_source_mask = t;
2792         HOTKEY_CONFIG_CRITICAL_END
2793
2794         rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2795                         ~hotkey_source_mask);
2796         hotkey_poll_setup(true);
2797
2798         /* check if events needed by the driver got disabled */
2799         r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2800                 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2801
2802         mutex_unlock(&hotkey_mutex);
2803
2804         if (rc < 0)
2805                 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2806                         "firmware event mask!\n");
2807
2808         if (r_ev)
2809                 printk(TPACPI_NOTICE "hotkey_source_mask: "
2810                         "some important events were disabled: "
2811                         "0x%04x\n", r_ev);
2812
2813         tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2814
2815         return (rc < 0) ? rc : count;
2816 }
2817
2818 static struct device_attribute dev_attr_hotkey_source_mask =
2819         __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2820                 hotkey_source_mask_show, hotkey_source_mask_store);
2821
2822 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2823 static ssize_t hotkey_poll_freq_show(struct device *dev,
2824                            struct device_attribute *attr,
2825                            char *buf)
2826 {
2827         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2828 }
2829
2830 static ssize_t hotkey_poll_freq_store(struct device *dev,
2831                             struct device_attribute *attr,
2832                             const char *buf, size_t count)
2833 {
2834         unsigned long t;
2835
2836         if (parse_strtoul(buf, 25, &t))
2837                 return -EINVAL;
2838
2839         if (mutex_lock_killable(&hotkey_mutex))
2840                 return -ERESTARTSYS;
2841
2842         hotkey_poll_set_freq(t);
2843         hotkey_poll_setup(true);
2844
2845         mutex_unlock(&hotkey_mutex);
2846
2847         tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2848
2849         return count;
2850 }
2851
2852 static struct device_attribute dev_attr_hotkey_poll_freq =
2853         __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2854                 hotkey_poll_freq_show, hotkey_poll_freq_store);
2855
2856 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2857
2858 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2859 static ssize_t hotkey_radio_sw_show(struct device *dev,
2860                            struct device_attribute *attr,
2861                            char *buf)
2862 {
2863         int res;
2864         res = hotkey_get_wlsw();
2865         if (res < 0)
2866                 return res;
2867
2868         /* Opportunistic update */
2869         tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2870
2871         return snprintf(buf, PAGE_SIZE, "%d\n",
2872                         (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2873 }
2874
2875 static struct device_attribute dev_attr_hotkey_radio_sw =
2876         __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2877
2878 static void hotkey_radio_sw_notify_change(void)
2879 {
2880         if (tp_features.hotkey_wlsw)
2881                 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2882                              "hotkey_radio_sw");
2883 }
2884
2885 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2886 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2887                            struct device_attribute *attr,
2888                            char *buf)
2889 {
2890         int res, s;
2891         res = hotkey_get_tablet_mode(&s);
2892         if (res < 0)
2893                 return res;
2894
2895         return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2896 }
2897
2898 static struct device_attribute dev_attr_hotkey_tablet_mode =
2899         __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2900
2901 static void hotkey_tablet_mode_notify_change(void)
2902 {
2903         if (tp_features.hotkey_tablet)
2904                 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2905                              "hotkey_tablet_mode");
2906 }
2907
2908 /* sysfs hotkey report_mode -------------------------------------------- */
2909 static ssize_t hotkey_report_mode_show(struct device *dev,
2910                            struct device_attribute *attr,
2911                            char *buf)
2912 {
2913         return snprintf(buf, PAGE_SIZE, "%d\n",
2914                 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2915 }
2916
2917 static struct device_attribute dev_attr_hotkey_report_mode =
2918         __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2919
2920 /* sysfs wakeup reason (pollable) -------------------------------------- */
2921 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2922                            struct device_attribute *attr,
2923                            char *buf)
2924 {
2925         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2926 }
2927
2928 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2929         __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2930
2931 static void hotkey_wakeup_reason_notify_change(void)
2932 {
2933         sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2934                      "wakeup_reason");
2935 }
2936
2937 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2938 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2939                            struct device_attribute *attr,
2940                            char *buf)
2941 {
2942         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2943 }
2944
2945 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2946         __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2947                hotkey_wakeup_hotunplug_complete_show, NULL);
2948
2949 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2950 {
2951         sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2952                      "wakeup_hotunplug_complete");
2953 }
2954
2955 /* --------------------------------------------------------------------- */
2956
2957 static struct attribute *hotkey_attributes[] __initdata = {
2958         &dev_attr_hotkey_enable.attr,
2959         &dev_attr_hotkey_bios_enabled.attr,
2960         &dev_attr_hotkey_bios_mask.attr,
2961         &dev_attr_hotkey_report_mode.attr,
2962         &dev_attr_hotkey_wakeup_reason.attr,
2963         &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2964         &dev_attr_hotkey_mask.attr,
2965         &dev_attr_hotkey_all_mask.attr,
2966         &dev_attr_hotkey_recommended_mask.attr,
2967 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2968         &dev_attr_hotkey_source_mask.attr,
2969         &dev_attr_hotkey_poll_freq.attr,
2970 #endif
2971 };
2972
2973 /*
2974  * Sync both the hw and sw blocking state of all switches
2975  */
2976 static void tpacpi_send_radiosw_update(void)
2977 {
2978         int wlsw;
2979
2980         /*
2981          * We must sync all rfkill controllers *before* issuing any
2982          * rfkill input events, or we will race the rfkill core input
2983          * handler.
2984          *
2985          * tpacpi_inputdev_send_mutex works as a syncronization point
2986          * for the above.
2987          *
2988          * We optimize to avoid numerous calls to hotkey_get_wlsw.
2989          */
2990
2991         wlsw = hotkey_get_wlsw();
2992
2993         /* Sync hw blocking state first if it is hw-blocked */
2994         if (wlsw == TPACPI_RFK_RADIO_OFF)
2995                 tpacpi_rfk_update_hwblock_state(true);
2996
2997         /* Sync sw blocking state */
2998         tpacpi_rfk_update_swstate_all();
2999
3000         /* Sync hw blocking state last if it is hw-unblocked */
3001         if (wlsw == TPACPI_RFK_RADIO_ON)
3002                 tpacpi_rfk_update_hwblock_state(false);
3003
3004         /* Issue rfkill input event for WLSW switch */
3005         if (!(wlsw < 0)) {
3006                 mutex_lock(&tpacpi_inputdev_send_mutex);
3007
3008                 input_report_switch(tpacpi_inputdev,
3009                                     SW_RFKILL_ALL, (wlsw > 0));
3010                 input_sync(tpacpi_inputdev);
3011
3012                 mutex_unlock(&tpacpi_inputdev_send_mutex);
3013         }
3014
3015         /*
3016          * this can be unconditional, as we will poll state again
3017          * if userspace uses the notify to read data
3018          */
3019         hotkey_radio_sw_notify_change();
3020 }
3021
3022 static void hotkey_exit(void)
3023 {
3024 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3025         mutex_lock(&hotkey_mutex);
3026         hotkey_poll_stop_sync();
3027         mutex_unlock(&hotkey_mutex);
3028 #endif
3029
3030         if (hotkey_dev_attributes)
3031                 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3032
3033         kfree(hotkey_keycode_map);
3034
3035         dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3036                    "restoring original HKEY status and mask\n");
3037         /* yes, there is a bitwise or below, we want the
3038          * functions to be called even if one of them fail */
3039         if (((tp_features.hotkey_mask &&
3040               hotkey_mask_set(hotkey_orig_mask)) |
3041              hotkey_status_set(false)) != 0)
3042                 printk(TPACPI_ERR
3043                        "failed to restore hot key mask "
3044                        "to BIOS defaults\n");
3045 }
3046
3047 static void __init hotkey_unmap(const unsigned int scancode)
3048 {
3049         if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3050                 clear_bit(hotkey_keycode_map[scancode],
3051                           tpacpi_inputdev->keybit);
3052                 hotkey_keycode_map[scancode] = KEY_RESERVED;
3053         }
3054 }
3055
3056 /*
3057  * HKEY quirks:
3058  *   TPACPI_HK_Q_INIMASK:       Supports FN+F3,FN+F4,FN+F12
3059  */
3060
3061 #define TPACPI_HK_Q_INIMASK     0x0001
3062
3063 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3064         TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3065         TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3066         TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3067         TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3068         TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3069         TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3070         TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3071         TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3072         TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3073         TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3074         TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3075         TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3076         TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3077         TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3078         TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3079         TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3080         TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3081         TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3082         TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3083 };
3084
3085 static int __init hotkey_init(struct ibm_init_struct *iibm)
3086 {
3087         /* Requirements for changing the default keymaps:
3088          *
3089          * 1. Many of the keys are mapped to KEY_RESERVED for very
3090          *    good reasons.  Do not change them unless you have deep
3091          *    knowledge on the IBM and Lenovo ThinkPad firmware for
3092          *    the various ThinkPad models.  The driver behaves
3093          *    differently for KEY_RESERVED: such keys have their
3094          *    hot key mask *unset* in mask_recommended, and also
3095          *    in the initial hot key mask programmed into the
3096          *    firmware at driver load time, which means the firm-
3097          *    ware may react very differently if you change them to
3098          *    something else;
3099          *
3100          * 2. You must be subscribed to the linux-thinkpad and
3101          *    ibm-acpi-devel mailing lists, and you should read the
3102          *    list archives since 2007 if you want to change the
3103          *    keymaps.  This requirement exists so that you will
3104          *    know the past history of problems with the thinkpad-
3105          *    acpi driver keymaps, and also that you will be
3106          *    listening to any bug reports;
3107          *
3108          * 3. Do not send thinkpad-acpi specific patches directly to
3109          *    for merging, *ever*.  Send them to the linux-acpi
3110          *    mailinglist for comments.  Merging is to be done only
3111          *    through acpi-test and the ACPI maintainer.
3112          *
3113          * If the above is too much to ask, don't change the keymap.
3114          * Ask the thinkpad-acpi maintainer to do it, instead.
3115          */
3116         static u16 ibm_keycode_map[] __initdata = {
3117                 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3118                 KEY_FN_F1,      KEY_FN_F2,      KEY_COFFEE,     KEY_SLEEP,
3119                 KEY_WLAN,       KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3120                 KEY_FN_F9,      KEY_FN_F10,     KEY_FN_F11,     KEY_SUSPEND,
3121
3122                 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3123                 KEY_UNKNOWN,    /* 0x0C: FN+BACKSPACE */
3124                 KEY_UNKNOWN,    /* 0x0D: FN+INSERT */
3125                 KEY_UNKNOWN,    /* 0x0E: FN+DELETE */
3126
3127                 /* brightness: firmware always reacts to them */
3128                 KEY_RESERVED,   /* 0x0F: FN+HOME (brightness up) */
3129                 KEY_RESERVED,   /* 0x10: FN+END (brightness down) */
3130
3131                 /* Thinklight: firmware always react to it */
3132                 KEY_RESERVED,   /* 0x11: FN+PGUP (thinklight toggle) */
3133
3134                 KEY_UNKNOWN,    /* 0x12: FN+PGDOWN */
3135                 KEY_ZOOM,       /* 0x13: FN+SPACE (zoom) */
3136
3137                 /* Volume: firmware always react to it and reprograms
3138                  * the built-in *extra* mixer.  Never map it to control
3139                  * another mixer by default. */
3140                 KEY_RESERVED,   /* 0x14: VOLUME UP */
3141                 KEY_RESERVED,   /* 0x15: VOLUME DOWN */
3142                 KEY_RESERVED,   /* 0x16: MUTE */
3143
3144                 KEY_VENDOR,     /* 0x17: Thinkpad/AccessIBM/Lenovo */
3145
3146                 /* (assignments unknown, please report if found) */
3147                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3148                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3149         };
3150         static u16 lenovo_keycode_map[] __initdata = {
3151                 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3152                 KEY_FN_F1,      KEY_COFFEE,     KEY_BATTERY,    KEY_SLEEP,
3153                 KEY_WLAN,       KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3154                 KEY_FN_F9,      KEY_FN_F10,     KEY_FN_F11,     KEY_SUSPEND,
3155
3156                 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3157                 KEY_UNKNOWN,    /* 0x0C: FN+BACKSPACE */
3158                 KEY_UNKNOWN,    /* 0x0D: FN+INSERT */
3159                 KEY_UNKNOWN,    /* 0x0E: FN+DELETE */
3160
3161                 /* These should be enabled --only-- when ACPI video
3162                  * is disabled (i.e. in "vendor" mode), and are handled
3163                  * in a special way by the&nb