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