Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[linux.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 */
3163
3164                 /* (assignments unknown, please report if found) */
3165                 KEY_UNKNOWN, KEY_UNKNOWN,
3166
3167                 /*
3168                  * The mic mute button only sends 0x1a.  It does not
3169                  * automatically mute the mic or change the mute light.
3170                  */
3171                 KEY_MICMUTE,    /* 0x1a: Mic mute (since ?400 or so) */
3172
3173                 /* (assignments unknown, please report if found) */
3174                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3175                 KEY_UNKNOWN,
3176                 },
3177         };
3178
3179         static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3180                 /* Generic maps (fallback) */
3181                 {
3182                   .vendor = PCI_VENDOR_ID_IBM,
3183                   .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3184                   .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3185                 },
3186                 {
3187                   .vendor = PCI_VENDOR_ID_LENOVO,
3188                   .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3189                   .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3190                 },
3191         };
3192
3193 #define TPACPI_HOTKEY_MAP_SIZE          sizeof(tpacpi_keymap_t)
3194 #define TPACPI_HOTKEY_MAP_TYPESIZE      sizeof(tpacpi_keymap_entry_t)
3195
3196         int res, i;
3197         int status;
3198         int hkeyv;
3199         bool radiosw_state  = false;
3200         bool tabletsw_state = false;
3201
3202         unsigned long quirks;
3203         unsigned long keymap_id;
3204
3205         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3206                         "initializing hotkey subdriver\n");
3207
3208         BUG_ON(!tpacpi_inputdev);
3209         BUG_ON(tpacpi_inputdev->open != NULL ||
3210                tpacpi_inputdev->close != NULL);
3211
3212         TPACPI_ACPIHANDLE_INIT(hkey);
3213         mutex_init(&hotkey_mutex);
3214
3215 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3216         mutex_init(&hotkey_thread_data_mutex);
3217 #endif
3218
3219         /* hotkey not supported on 570 */
3220         tp_features.hotkey = hkey_handle != NULL;
3221
3222         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3223                 "hotkeys are %s\n",
3224                 str_supported(tp_features.hotkey));
3225
3226         if (!tp_features.hotkey)
3227                 return 1;
3228
3229         quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3230                                      ARRAY_SIZE(tpacpi_hotkey_qtable));
3231
3232         tpacpi_disable_brightness_delay();
3233
3234         /* MUST have enough space for all attributes to be added to
3235          * hotkey_dev_attributes */
3236         hotkey_dev_attributes = create_attr_set(
3237                                         ARRAY_SIZE(hotkey_attributes) + 2,
3238                                         NULL);
3239         if (!hotkey_dev_attributes)
3240                 return -ENOMEM;
3241         res = add_many_to_attr_set(hotkey_dev_attributes,
3242                         hotkey_attributes,
3243                         ARRAY_SIZE(hotkey_attributes));
3244         if (res)
3245                 goto err_exit;
3246
3247         /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3248            A30, R30, R31, T20-22, X20-21, X22-24.  Detected by checking
3249            for HKEY interface version 0x100 */
3250         if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3251                 if ((hkeyv >> 8) != 1) {
3252                         pr_err("unknown version of the HKEY interface: 0x%x\n",
3253                                hkeyv);
3254                         pr_err("please report this to %s\n", TPACPI_MAIL);
3255                 } else {
3256                         /*
3257                          * MHKV 0x100 in A31, R40, R40e,
3258                          * T4x, X31, and later
3259                          */
3260                         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3261                                 "firmware HKEY interface version: 0x%x\n",
3262                                 hkeyv);
3263
3264                         /* Paranoia check AND init hotkey_all_mask */
3265                         if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3266                                         "MHKA", "qd")) {
3267                                 pr_err("missing MHKA handler, "
3268                                        "please report this to %s\n",
3269                                        TPACPI_MAIL);
3270                                 /* Fallback: pre-init for FN+F3,F4,F12 */
3271                                 hotkey_all_mask = 0x080cU;
3272                         } else {
3273                                 tp_features.hotkey_mask = 1;
3274                         }
3275                 }
3276         }
3277
3278         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3279                 "hotkey masks are %s\n",
3280                 str_supported(tp_features.hotkey_mask));
3281
3282         /* Init hotkey_all_mask if not initialized yet */
3283         if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3284             (quirks & TPACPI_HK_Q_INIMASK))
3285                 hotkey_all_mask = 0x080cU;  /* FN+F12, FN+F4, FN+F3 */
3286
3287         /* Init hotkey_acpi_mask and hotkey_orig_mask */
3288         if (tp_features.hotkey_mask) {
3289                 /* hotkey_source_mask *must* be zero for
3290                  * the first hotkey_mask_get to return hotkey_orig_mask */
3291                 res = hotkey_mask_get();
3292                 if (res)
3293                         goto err_exit;
3294
3295                 hotkey_orig_mask = hotkey_acpi_mask;
3296         } else {
3297                 hotkey_orig_mask = hotkey_all_mask;
3298                 hotkey_acpi_mask = hotkey_all_mask;
3299         }
3300
3301 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3302         if (dbg_wlswemul) {
3303                 tp_features.hotkey_wlsw = 1;
3304                 radiosw_state = !!tpacpi_wlsw_emulstate;
3305                 pr_info("radio switch emulation enabled\n");
3306         } else
3307 #endif
3308         /* Not all thinkpads have a hardware radio switch */
3309         if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3310                 tp_features.hotkey_wlsw = 1;
3311                 radiosw_state = !!status;
3312                 pr_info("radio switch found; radios are %s\n",
3313                         enabled(status, 0));
3314         }
3315         if (tp_features.hotkey_wlsw)
3316                 res = add_to_attr_set(hotkey_dev_attributes,
3317                                 &dev_attr_hotkey_radio_sw.attr);
3318
3319         /* For X41t, X60t, X61t Tablets... */
3320         if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3321                 tp_features.hotkey_tablet = 1;
3322                 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3323                 pr_info("possible tablet mode switch found; "
3324                         "ThinkPad in %s mode\n",
3325                         (tabletsw_state) ? "tablet" : "laptop");
3326                 res = add_to_attr_set(hotkey_dev_attributes,
3327                                 &dev_attr_hotkey_tablet_mode.attr);
3328         }
3329
3330         if (!res)
3331                 res = register_attr_set_with_sysfs(
3332                                 hotkey_dev_attributes,
3333                                 &tpacpi_pdev->dev.kobj);
3334         if (res)
3335                 goto err_exit;
3336
3337         /* Set up key map */
3338         hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3339                                         GFP_KERNEL);
3340         if (!hotkey_keycode_map) {
3341                 pr_err("failed to allocate memory for key map\n");
3342                 res = -ENOMEM;
3343                 goto err_exit;
3344         }
3345
3346         keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3347                                         ARRAY_SIZE(tpacpi_keymap_qtable));
3348         BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3349         dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3350                    "using keymap number %lu\n", keymap_id);
3351
3352         memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3353                 TPACPI_HOTKEY_MAP_SIZE);
3354
3355         input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3356         tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3357         tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3358         tpacpi_inputdev->keycode = hotkey_keycode_map;
3359         for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3360                 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3361                         input_set_capability(tpacpi_inputdev, EV_KEY,
3362                                                 hotkey_keycode_map[i]);
3363                 } else {
3364                         if (i < sizeof(hotkey_reserved_mask)*8)
3365                                 hotkey_reserved_mask |= 1 << i;
3366                 }
3367         }
3368
3369         if (tp_features.hotkey_wlsw) {
3370                 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3371                 input_report_switch(tpacpi_inputdev,
3372                                     SW_RFKILL_ALL, radiosw_state);
3373         }
3374         if (tp_features.hotkey_tablet) {
3375                 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3376                 input_report_switch(tpacpi_inputdev,
3377                                     SW_TABLET_MODE, tabletsw_state);
3378         }
3379
3380         /* Do not issue duplicate brightness change events to
3381          * userspace. tpacpi_detect_brightness_capabilities() must have
3382          * been called before this point  */
3383         if (acpi_video_backlight_support()) {
3384                 pr_info("This ThinkPad has standard ACPI backlight "
3385                         "brightness control, supported by the ACPI "
3386                         "video driver\n");
3387                 pr_notice("Disabling thinkpad-acpi brightness events "
3388                           "by default...\n");
3389
3390                 /* Disable brightness up/down on Lenovo thinkpads when
3391                  * ACPI is handling them, otherwise it is plain impossible
3392                  * for userspace to do something even remotely sane */
3393                 hotkey_reserved_mask |=
3394                         (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3395                         | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3396                 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3397                 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3398         }
3399
3400 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3401         hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3402                                 & ~hotkey_all_mask
3403                                 & ~hotkey_reserved_mask;
3404
3405         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3406                     "hotkey source mask 0x%08x, polling freq %u\n",
3407                     hotkey_source_mask, hotkey_poll_freq);
3408 #endif
3409
3410         dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3411                         "enabling firmware HKEY event interface...\n");
3412         res = hotkey_status_set(true);
3413         if (res) {
3414                 hotkey_exit();
3415                 return res;
3416         }
3417         res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3418                                | hotkey_driver_mask)
3419                               & ~hotkey_source_mask);
3420         if (res < 0 && res != -ENXIO) {
3421                 hotkey_exit();
3422                 return res;
3423         }
3424         hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3425                                 & ~hotkey_reserved_mask;
3426         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3427                 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3428                 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3429
3430         tpacpi_inputdev->open = &hotkey_inputdev_open;
3431         tpacpi_inputdev->close = &hotkey_inputdev_close;
3432
3433         hotkey_poll_setup_safe(true);
3434
3435         return 0;
3436
3437 err_exit:
3438         delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3439         hotkey_dev_attributes = NULL;
3440
3441         return (res < 0)? res : 1;
3442 }
3443
3444 /* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3445  * mode, Web conference mode, Function mode and Lay-flat mode.
3446  * We support Home mode and Function mode currently.
3447  *
3448  * Will consider support rest of modes in future.
3449  *
3450  */
3451 enum ADAPTIVE_KEY_MODE {
3452         HOME_MODE,
3453         WEB_BROWSER_MODE,
3454         WEB_CONFERENCE_MODE,
3455         FUNCTION_MODE,
3456         LAYFLAT_MODE
3457 };
3458
3459 const int adaptive_keyboard_modes[] = {
3460         HOME_MODE,
3461 /*      WEB_BROWSER_MODE = 2,
3462         WEB_CONFERENCE_MODE = 3, */
3463         FUNCTION_MODE
3464 };
3465
3466 #define DFR_CHANGE_ROW                  0x101
3467 #define DFR_SHOW_QUICKVIEW_ROW          0x102
3468
3469 /* press Fn key a while second, it will switch to Function Mode. Then
3470  * release Fn key, previous mode be restored.
3471  */
3472 static bool adaptive_keyboard_mode_is_saved;
3473 static int adaptive_keyboard_prev_mode;
3474
3475 static int adaptive_keyboard_get_next_mode(int mode)
3476 {
3477         size_t i;
3478         size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3479
3480         for (i = 0; i <= max_mode; i++) {
3481                 if (adaptive_keyboard_modes[i] == mode)
3482                         break;
3483         }
3484
3485         if (i >= max_mode)
3486                 i = 0;
3487         else
3488                 i++;
3489
3490         return adaptive_keyboard_modes[i];
3491 }
3492
3493 static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3494 {
3495         u32 current_mode = 0;
3496         int new_mode = 0;
3497
3498         switch (scancode) {
3499         case DFR_CHANGE_ROW:
3500                 if (adaptive_keyboard_mode_is_saved) {
3501                         new_mode = adaptive_keyboard_prev_mode;
3502                         adaptive_keyboard_mode_is_saved = false;
3503                 } else {
3504                         if (!acpi_evalf(
3505                                         hkey_handle, &current_mode,
3506                                         "GTRW", "dd", 0)) {
3507                                 pr_err("Cannot read adaptive keyboard mode\n");
3508                                 return false;
3509                         } else {
3510                                 new_mode = adaptive_keyboard_get_next_mode(
3511                                                 current_mode);
3512                         }
3513                 }
3514
3515                 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3516                         pr_err("Cannot set adaptive keyboard mode\n");
3517                         return false;
3518                 }
3519
3520                 return true;
3521
3522         case DFR_SHOW_QUICKVIEW_ROW:
3523                 if (!acpi_evalf(hkey_handle,
3524                                 &adaptive_keyboard_prev_mode,
3525                                 "GTRW", "dd", 0)) {
3526                         pr_err("Cannot read adaptive keyboard mode\n");
3527                         return false;
3528                 } else {
3529                         adaptive_keyboard_mode_is_saved = true;
3530
3531                         if (!acpi_evalf(hkey_handle,
3532                                         NULL, "STRW", "vd", FUNCTION_MODE)) {
3533                                 pr_err("Cannot set adaptive keyboard mode\n");
3534                                 return false;
3535                         }
3536                 }
3537                 return true;
3538
3539         default:
3540                 return false;
3541         }
3542 }
3543
3544 static bool hotkey_notify_hotkey(const u32 hkey,
3545                                  bool *send_acpi_ev,
3546                                  bool *ignore_acpi_ev)
3547 {
3548         /* 0x1000-0x1FFF: key presses */
3549         unsigned int scancode = hkey & 0xfff;
3550         *send_acpi_ev = true;
3551         *ignore_acpi_ev = false;
3552
3553         /* HKEY event 0x1001 is scancode 0x00 */
3554         if (scancode > 0 && scancode <= TPACPI_HOTKEY_MAP_LEN) {
3555                 scancode--;
3556                 if (!(hotkey_source_mask & (1 << scancode))) {
3557                         tpacpi_input_send_key_masked(scancode);
3558                         *send_acpi_ev = false;
3559                 } else {
3560                         *ignore_acpi_ev = true;
3561                 }
3562                 return true;
3563         } else {
3564                 return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3565         }
3566         return false;
3567 }
3568
3569 static bool hotkey_notify_wakeup(const u32 hkey,
3570                                  bool *send_acpi_ev,
3571                                  bool *ignore_acpi_ev)
3572 {
3573         /* 0x2000-0x2FFF: Wakeup reason */
3574         *send_acpi_ev = true;
3575         *ignore_acpi_ev = false;
3576
3577         switch (hkey) {
3578         case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3579         case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3580                 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3581                 *ignore_acpi_ev = true;
3582                 break;
3583
3584         case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3585         case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3586                 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3587                 *ignore_acpi_ev = true;
3588                 break;
3589
3590         case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3591         case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3592                 pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3593                 /* how to auto-heal: */
3594                 /* 2313: woke up from S3, go to S4/S5 */
3595                 /* 2413: woke up from S4, go to S5 */
3596                 break;
3597
3598         default:
3599                 return false;
3600         }
3601
3602         if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3603                 pr_info("woke up due to a hot-unplug request...\n");
3604                 hotkey_wakeup_reason_notify_change();
3605         }
3606         return true;
3607 }
3608
3609 static bool hotkey_notify_dockevent(const u32 hkey,
3610                                  bool *send_acpi_ev,
3611                                  bool *ignore_acpi_ev)
3612 {
3613         /* 0x4000-0x4FFF: dock-related events */
3614         *send_acpi_ev = true;
3615         *ignore_acpi_ev = false;
3616
3617         switch (hkey) {
3618         case TP_HKEY_EV_UNDOCK_ACK:
3619                 /* ACPI undock operation completed after wakeup */
3620                 hotkey_autosleep_ack = 1;
3621                 pr_info("undocked\n");
3622                 hotkey_wakeup_hotunplug_complete_notify_change();
3623                 return true;
3624
3625         case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3626                 pr_info("docked into hotplug port replicator\n");
3627                 return true;
3628         case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3629                 pr_info("undocked from hotplug port replicator\n");
3630                 return true;
3631
3632         default:
3633                 return false;
3634         }
3635 }
3636
3637 static bool hotkey_notify_usrevent(const u32 hkey,
3638                                  bool *send_acpi_ev,
3639                                  bool *ignore_acpi_ev)
3640 {
3641         /* 0x5000-0x5FFF: human interface helpers */
3642         *send_acpi_ev = true;
3643         *ignore_acpi_ev = false;
3644
3645         switch (hkey) {
3646         case TP_HKEY_EV_PEN_INSERTED:  /* X61t: tablet pen inserted into bay */
3647         case TP_HKEY_EV_PEN_REMOVED:   /* X61t: tablet pen removed from bay */
3648                 return true;
3649
3650         case TP_HKEY_EV_TABLET_TABLET:   /* X41t-X61t: tablet mode */
3651         case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3652                 tpacpi_input_send_tabletsw();
3653                 hotkey_tablet_mode_notify_change();
3654                 *send_acpi_ev = false;
3655                 return true;
3656
3657         case TP_HKEY_EV_LID_CLOSE:      /* Lid closed */
3658         case TP_HKEY_EV_LID_OPEN:       /* Lid opened */
3659         case TP_HKEY_EV_BRGHT_CHANGED:  /* brightness changed */
3660                 /* do not propagate these events */
3661                 *ignore_acpi_ev = true;
3662                 return true;
3663
3664         default:
3665                 return false;
3666         }
3667 }
3668
3669 static void thermal_dump_all_sensors(void);
3670
3671 static bool hotkey_notify_6xxx(const u32 hkey,
3672                                  bool *send_acpi_ev,
3673                                  bool *ignore_acpi_ev)
3674 {
3675         bool known = true;
3676
3677         /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
3678         *send_acpi_ev = true;
3679         *ignore_acpi_ev = false;
3680
3681         switch (hkey) {
3682         case TP_HKEY_EV_THM_TABLE_CHANGED:
3683                 pr_info("EC reports that Thermal Table has changed\n");
3684                 /* recommended action: do nothing, we don't have
3685                  * Lenovo ATM information */
3686                 return true;
3687         case TP_HKEY_EV_ALARM_BAT_HOT:
3688                 pr_crit("THERMAL ALARM: battery is too hot!\n");
3689                 /* recommended action: warn user through gui */
3690                 break;
3691         case TP_HKEY_EV_ALARM_BAT_XHOT:
3692                 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
3693                 /* recommended action: immediate sleep/hibernate */
3694                 break;
3695         case TP_HKEY_EV_ALARM_SENSOR_HOT:
3696                 pr_crit("THERMAL ALARM: "
3697                         "a sensor reports something is too hot!\n");
3698                 /* recommended action: warn user through gui, that */
3699                 /* some internal component is too hot */
3700                 break;
3701         case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3702                 pr_alert("THERMAL EMERGENCY: "
3703                          "a sensor reports something is extremely hot!\n");
3704                 /* recommended action: immediate sleep/hibernate */
3705                 break;
3706         case TP_HKEY_EV_AC_CHANGED:
3707                 /* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
3708                  * AC status changed; can be triggered by plugging or
3709                  * unplugging AC adapter, docking or undocking. */
3710
3711                 /* fallthrough */
3712
3713         case TP_HKEY_EV_KEY_NUMLOCK:
3714         case TP_HKEY_EV_KEY_FN:
3715                 /* key press events, we just ignore them as long as the EC
3716                  * is still reporting them in the normal keyboard stream */
3717                 *send_acpi_ev = false;
3718                 *ignore_acpi_ev = true;
3719                 return true;
3720
3721         default:
3722                 pr_warn("unknown possible thermal alarm or keyboard event received\n");
3723                 known = false;
3724         }
3725
3726         thermal_dump_all_sensors();
3727
3728         return known;
3729 }
3730
3731 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3732 {
3733         u32 hkey;
3734         bool send_acpi_ev;
3735         bool ignore_acpi_ev;
3736         bool known_ev;
3737
3738         if (event != 0x80) {
3739                 pr_err("unknown HKEY notification event %d\n", event);
3740                 /* forward it to userspace, maybe it knows how to handle it */
3741                 acpi_bus_generate_netlink_event(
3742                                         ibm->acpi->device->pnp.device_class,
3743                                         dev_name(&ibm->acpi->device->dev),
3744                                         event, 0);
3745                 return;
3746         }
3747
3748         while (1) {
3749                 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3750                         pr_err("failed to retrieve HKEY event\n");
3751                         return;
3752                 }
3753
3754                 if (hkey == 0) {
3755                         /* queue empty */
3756                         return;
3757                 }
3758
3759                 send_acpi_ev = true;
3760                 ignore_acpi_ev = false;
3761
3762                 switch (hkey >> 12) {
3763                 case 1:
3764                         /* 0x1000-0x1FFF: key presses */
3765                         known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3766                                                  &ignore_acpi_ev);
3767                         break;
3768                 case 2:
3769                         /* 0x2000-0x2FFF: Wakeup reason */
3770                         known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3771                                                  &ignore_acpi_ev);
3772                         break;
3773                 case 3:
3774                         /* 0x3000-0x3FFF: bay-related wakeups */
3775                         switch (hkey) {
3776                         case TP_HKEY_EV_BAYEJ_ACK:
3777                                 hotkey_autosleep_ack = 1;
3778                                 pr_info("bay ejected\n");
3779                                 hotkey_wakeup_hotunplug_complete_notify_change();
3780                                 known_ev = true;
3781                                 break;
3782                         case TP_HKEY_EV_OPTDRV_EJ:
3783                                 /* FIXME: kick libata if SATA link offline */
3784                                 known_ev = true;
3785                                 break;
3786                         default:
3787                                 known_ev = false;
3788                         }
3789                         break;
3790                 case 4:
3791                         /* 0x4000-0x4FFF: dock-related events */
3792                         known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
3793                                                 &ignore_acpi_ev);
3794                         break;
3795                 case 5:
3796                         /* 0x5000-0x5FFF: human interface helpers */
3797                         known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3798                                                  &ignore_acpi_ev);
3799                         break;
3800                 case 6:
3801                         /* 0x6000-0x6FFF: thermal alarms/notices and
3802                          *                keyboard events */
3803                         known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
3804                                                  &ignore_acpi_ev);
3805                         break;
3806                 case 7:
3807                         /* 0x7000-0x7FFF: misc */
3808                         if (tp_features.hotkey_wlsw &&
3809                                         hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3810                                 tpacpi_send_radiosw_update();
3811                                 send_acpi_ev = 0;
3812                                 known_ev = true;
3813                                 break;
3814                         }
3815                         /* fallthrough to default */
3816                 default:
3817                         known_ev = false;
3818                 }
3819                 if (!known_ev) {
3820                         pr_notice("unhandled HKEY event 0x%04x\n", hkey);
3821                         pr_notice("please report the conditions when this "
3822                                   "event happened to %s\n", TPACPI_MAIL);
3823                 }
3824
3825                 /* netlink events */
3826                 if (!ignore_acpi_ev && send_acpi_ev) {
3827                         acpi_bus_generate_netlink_event(
3828                                         ibm->acpi->device->pnp.device_class,
3829                                         dev_name(&ibm->acpi->device->dev),
3830                                         event, hkey);
3831                 }
3832         }
3833 }
3834
3835 static void hotkey_suspend(void)
3836 {
3837         int hkeyv;
3838
3839         /* Do these on suspend, we get the events on early resume! */
3840         hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3841         hotkey_autosleep_ack = 0;
3842
3843         /* save previous mode of adaptive keyboard of X1 Carbon */
3844         if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3845                 if ((hkeyv >> 8) == 2) {
3846                         if (!acpi_evalf(hkey_handle,
3847                                                 &adaptive_keyboard_prev_mode,
3848                                                 "GTRW", "dd", 0)) {
3849                                 pr_err("Cannot read adaptive keyboard mode.\n");
3850                         }
3851                 }
3852         }
3853 }
3854
3855 static void hotkey_resume(void)
3856 {
3857         int hkeyv;
3858
3859         tpacpi_disable_brightness_delay();
3860
3861         if (hotkey_status_set(true) < 0 ||
3862             hotkey_mask_set(hotkey_acpi_mask) < 0)
3863                 pr_err("error while attempting to reset the event "
3864                        "firmware interface\n");
3865
3866         tpacpi_send_radiosw_update();
3867         hotkey_tablet_mode_notify_change();
3868         hotkey_wakeup_reason_notify_change();
3869         hotkey_wakeup_hotunplug_complete_notify_change();
3870         hotkey_poll_setup_safe(false);
3871
3872         /* restore previous mode of adapive keyboard of X1 Carbon */
3873         if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3874                 if ((hkeyv >> 8) == 2) {
3875                         if (!acpi_evalf(hkey_handle,
3876                                                 NULL,
3877                                                 "STRW", "vd",
3878                                                 adaptive_keyboard_prev_mode)) {
3879                                 pr_err("Cannot set adaptive keyboard mode.\n");
3880                         }
3881                 }
3882         }
3883 }
3884
3885 /* procfs -------------------------------------------------------------- */
3886 static int hotkey_read(struct seq_file *m)
3887 {
3888         int res, status;
3889
3890         if (!tp_features.hotkey) {
3891                 seq_printf(m, "status:\t\tnot supported\n");
3892                 return 0;
3893         }
3894
3895         if (mutex_lock_killable(&hotkey_mutex))
3896                 return -ERESTARTSYS;
3897         res = hotkey_status_get(&status);
3898         if (!res)
3899                 res = hotkey_mask_get();
3900         mutex_unlock(&hotkey_mutex);
3901         if (res)
3902                 return res;
3903
3904         seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3905         if (hotkey_all_mask) {
3906                 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3907                 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3908         } else {
3909                 seq_printf(m, "mask:\t\tnot supported\n");
3910                 seq_printf(m, "commands:\tenable, disable, reset\n");
3911         }
3912
3913         return 0;
3914 }
3915
3916 static void hotkey_enabledisable_warn(bool enable)
3917 {
3918         tpacpi_log_usertask("procfs hotkey enable/disable");
3919         if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3920                   pr_fmt("hotkey enable/disable functionality has been "
3921                          "removed from the driver.  "
3922                          "Hotkeys are always enabled.\n")))
3923                 pr_err("Please remove the hotkey=enable module "
3924                        "parameter, it is deprecated.  "
3925                        "Hotkeys are always enabled.\n");
3926 }
3927
3928 static int hotkey_write(char *buf)
3929 {
3930         int res;
3931         u32 mask;
3932         char *cmd;
3933
3934         if (!tp_features.hotkey)
3935                 return -ENODEV;
3936
3937         if (mutex_lock_killable(&hotkey_mutex))
3938                 return -ERESTARTSYS;
3939
3940         mask = hotkey_user_mask;
3941
3942         res = 0;
3943         while ((cmd = next_cmd(&buf))) {
3944                 if (strlencmp(cmd, "enable") == 0) {
3945                         hotkey_enabledisable_warn(1);
3946                 } else if (strlencmp(cmd, "disable") == 0) {
3947                         hotkey_enabledisable_warn(0);
3948                         res = -EPERM;
3949                 } else if (strlencmp(cmd, "reset") == 0) {
3950                         mask = (hotkey_all_mask | hotkey_source_mask)
3951                                 & ~hotkey_reserved_mask;
3952                 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3953                         /* mask set */
3954                 } else if (sscanf(cmd, "%x", &mask) == 1) {
3955                         /* mask set */
3956                 } else {
3957                         res = -EINVAL;
3958                         goto errexit;
3959                 }
3960         }
3961
3962         if (!res) {
3963                 tpacpi_disclose_usertask("procfs hotkey",
3964                         "set mask to 0x%08x\n", mask);
3965                 res = hotkey_user_mask_set(mask);
3966         }
3967
3968 errexit:
3969         mutex_unlock(&hotkey_mutex);
3970         return res;
3971 }
3972
3973 static const struct acpi_device_id ibm_htk_device_ids[] = {
3974         {TPACPI_ACPI_IBM_HKEY_HID, 0},
3975         {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
3976         {"", 0},
3977 };
3978
3979 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3980         .hid = ibm_htk_device_ids,
3981         .notify = hotkey_notify,
3982         .handle = &hkey_handle,
3983         .type = ACPI_DEVICE_NOTIFY,
3984 };
3985
3986 static struct ibm_struct hotkey_driver_data = {
3987         .name = "hotkey",
3988         .read = hotkey_read,
3989         .write = hotkey_write,
3990         .exit = hotkey_exit,
3991         .resume = hotkey_resume,
3992         .suspend = hotkey_suspend,
3993         .acpi = &ibm_hotkey_acpidriver,
3994 };
3995
3996 /*************************************************************************
3997  * Bluetooth subdriver
3998  */
3999
4000 enum {
4001         /* ACPI GBDC/SBDC bits */
4002         TP_ACPI_BLUETOOTH_HWPRESENT     = 0x01, /* Bluetooth hw available */
4003         TP_ACPI_BLUETOOTH_RADIOSSW      = 0x02, /* Bluetooth radio enabled */
4004         TP_ACPI_BLUETOOTH_RESUMECTRL    = 0x04, /* Bluetooth state at resume:
4005                                                    0 = disable, 1 = enable */
4006 };
4007
4008 enum {
4009         /* ACPI \BLTH commands */
4010         TP_ACPI_BLTH_GET_ULTRAPORT_ID   = 0x00, /* Get Ultraport BT ID */
4011         TP_ACPI_BLTH_GET_PWR_ON_RESUME  = 0x01, /* Get power-on-resume state */
4012         TP_ACPI_BLTH_PWR_ON_ON_RESUME   = 0x02, /* Resume powered on */
4013         TP_ACPI_BLTH_PWR_OFF_ON_RESUME  = 0x03, /* Resume powered off */
4014         TP_ACPI_BLTH_SAVE_STATE         = 0x05, /* Save state for S4/S5 */
4015 };
4016
4017 #define TPACPI_RFK_BLUETOOTH_SW_NAME    "tpacpi_bluetooth_sw"
4018
4019 static int bluetooth_get_status(void)
4020 {
4021         int status;
4022
4023 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4024         if (dbg_bluetoothemul)
4025                 return (tpacpi_bluetooth_emulstate) ?
4026                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4027 #endif
4028
4029         if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4030                 return -EIO;
4031
4032         return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4033                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4034 }
4035
4036 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4037 {
4038         int status;
4039
4040         vdbg_printk(TPACPI_DBG_RFKILL,
4041                 "will attempt to %s bluetooth\n",
4042                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4043
4044 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4045         if (dbg_bluetoothemul) {
4046                 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4047                 return 0;
4048         }
4049 #endif
4050
4051         if (state == TPACPI_RFK_RADIO_ON)
4052                 status = TP_ACPI_BLUETOOTH_RADIOSSW
4053                           | TP_ACPI_BLUETOOTH_RESUMECTRL;
4054         else
4055                 status = 0;
4056
4057         if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4058                 return -EIO;
4059
4060         return 0;
4061 }
4062
4063 /* sysfs bluetooth enable ---------------------------------------------- */
4064 static ssize_t bluetooth_enable_show(struct device *dev,
4065                            struct device_attribute *attr,
4066                            char *buf)
4067 {
4068         return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4069                         attr, buf);
4070 }
4071
4072 static ssize_t bluetooth_enable_store(struct device *dev,
4073                             struct device_attribute *attr,
4074                             const char *buf, size_t count)
4075 {
4076         return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4077                                 attr, buf, count);
4078 }
4079
4080 static struct device_attribute dev_attr_bluetooth_enable =
4081         __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
4082                 bluetooth_enable_show, bluetooth_enable_store);
4083
4084 /* --------------------------------------------------------------------- */
4085
4086 static struct attribute *bluetooth_attributes[] = {
4087         &dev_attr_bluetooth_enable.attr,
4088         NULL
4089 };
4090
4091 static const struct attribute_group bluetooth_attr_group = {
4092         .attrs = bluetooth_attributes,
4093 };
4094
4095 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4096         .get_status = bluetooth_get_status,
4097         .set_status = bluetooth_set_status,
4098 };
4099
4100 static void bluetooth_shutdown(void)
4101 {
4102         /* Order firmware to save current state to NVRAM */
4103         if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4104                         TP_ACPI_BLTH_SAVE_STATE))
4105                 pr_notice("failed to save bluetooth state to NVRAM\n");
4106         else
4107                 vdbg_printk(TPACPI_DBG_RFKILL,
4108                         "bluetooth state saved to NVRAM\n");
4109 }
4110
4111 static void bluetooth_exit(void)
4112 {
4113         sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4114                         &bluetooth_attr_group);
4115
4116         tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4117
4118         bluetooth_shutdown();
4119 }
4120
4121 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4122 {
4123         int res;
4124         int status = 0;
4125
4126         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4127                         "initializing bluetooth subdriver\n");
4128
4129         TPACPI_ACPIHANDLE_INIT(hkey);
4130
4131         /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4132            G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4133         tp_features.bluetooth = hkey_handle &&
4134             acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4135
4136         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4137                 "bluetooth is %s, status 0x%02x\n",
4138                 str_supported(tp_features.bluetooth),
4139                 status);
4140
4141 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4142         if (dbg_bluetoothemul) {
4143                 tp_features.bluetooth = 1;
4144                 pr_info("bluetooth switch emulation enabled\n");
4145         } else
4146 #endif
4147         if (tp_features.bluetooth &&
4148             !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4149                 /* no bluetooth hardware present in system */
4150                 tp_features.bluetooth = 0;
4151                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4152                            "bluetooth hardware not installed\n");
4153         }
4154
4155         if (!tp_features.bluetooth)
4156                 return 1;
4157
4158         res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4159                                 &bluetooth_tprfk_ops,
4160                                 RFKILL_TYPE_BLUETOOTH,
4161                                 TPACPI_RFK_BLUETOOTH_SW_NAME,
4162                                 true);
4163         if (res)
4164                 return res;
4165
4166         res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4167                                 &bluetooth_attr_group);
4168         if (res) {
4169                 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4170                 return res;
4171         }
4172
4173         return 0;
4174 }
4175
4176 /* procfs -------------------------------------------------------------- */
4177 static int bluetooth_read(struct seq_file *m)
4178 {
4179         return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4180 }
4181
4182 static int bluetooth_write(char *buf)
4183 {
4184         return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4185 }
4186
4187 static struct ibm_struct bluetooth_driver_data = {
4188         .name = "bluetooth",
4189         .read = bluetooth_read,
4190         .write = bluetooth_write,
4191         .exit = bluetooth_exit,
4192         .shutdown = bluetooth_shutdown,
4193 };
4194
4195 /*************************************************************************
4196  * Wan subdriver
4197  */
4198
4199 enum {
4200         /* ACPI GWAN/SWAN bits */
4201         TP_ACPI_WANCARD_HWPRESENT       = 0x01, /* Wan hw available */
4202         TP_ACPI_WANCARD_RADIOSSW        = 0x02, /* Wan radio enabled */
4203         TP_ACPI_WANCARD_RESUMECTRL      = 0x04, /* Wan state at resume:
4204                                                    0 = disable, 1 = enable */
4205 };
4206
4207 #define TPACPI_RFK_WWAN_SW_NAME         "tpacpi_wwan_sw"
4208
4209 static int wan_get_status(void)
4210 {
4211         int status;
4212
4213 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4214         if (dbg_wwanemul)
4215                 return (tpacpi_wwan_emulstate) ?
4216                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4217 #endif
4218
4219         if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4220                 return -EIO;
4221
4222         return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4223                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4224 }
4225
4226 static int wan_set_status(enum tpacpi_rfkill_state state)
4227 {
4228         int status;
4229
4230         vdbg_printk(TPACPI_DBG_RFKILL,
4231                 "will attempt to %s wwan\n",
4232                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4233
4234 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4235         if (dbg_wwanemul) {
4236                 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4237                 return 0;
4238         }
4239 #endif
4240
4241         if (state == TPACPI_RFK_RADIO_ON)
4242                 status = TP_ACPI_WANCARD_RADIOSSW
4243                          | TP_ACPI_WANCARD_RESUMECTRL;
4244         else
4245                 status = 0;
4246
4247         if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4248                 return -EIO;
4249
4250         return 0;
4251 }
4252
4253 /* sysfs wan enable ---------------------------------------------------- */
4254 static ssize_t wan_enable_show(struct device *dev,
4255                            struct device_attribute *attr,
4256                            char *buf)
4257 {
4258         return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4259                         attr, buf);
4260 }
4261
4262 static ssize_t wan_enable_store(struct device *dev,
4263                             struct device_attribute *attr,
4264                             const char *buf, size_t count)
4265 {
4266         return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4267                         attr, buf, count);
4268 }
4269
4270 static struct device_attribute dev_attr_wan_enable =
4271         __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4272                 wan_enable_show, wan_enable_store);
4273
4274 /* --------------------------------------------------------------------- */
4275
4276 static struct attribute *wan_attributes[] = {
4277         &dev_attr_wan_enable.attr,
4278         NULL
4279 };
4280
4281 static const struct attribute_group wan_attr_group = {
4282         .attrs = wan_attributes,
4283 };
4284
4285 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4286         .get_status = wan_get_status,
4287         .set_status = wan_set_status,
4288 };
4289
4290 static void wan_shutdown(void)
4291 {
4292         /* Order firmware to save current state to NVRAM */
4293         if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4294                         TP_ACPI_WGSV_SAVE_STATE))
4295                 pr_notice("failed to save WWAN state to NVRAM\n");
4296         else
4297                 vdbg_printk(TPACPI_DBG_RFKILL,
4298                         "WWAN state saved to NVRAM\n");
4299 }
4300
4301 static void wan_exit(void)
4302 {
4303         sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4304                 &wan_attr_group);
4305
4306         tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4307
4308         wan_shutdown();
4309 }
4310
4311 static int __init wan_init(struct ibm_init_struct *iibm)
4312 {
4313         int res;
4314         int status = 0;
4315
4316         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4317                         "initializing wan subdriver\n");
4318
4319         TPACPI_ACPIHANDLE_INIT(hkey);
4320
4321         tp_features.wan = hkey_handle &&
4322             acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4323
4324         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4325                 "wan is %s, status 0x%02x\n",
4326                 str_supported(tp_features.wan),
4327                 status);
4328
4329 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4330         if (dbg_wwanemul) {
4331                 tp_features.wan = 1;
4332                 pr_info("wwan switch emulation enabled\n");
4333         } else
4334 #endif
4335         if (tp_features.wan &&
4336             !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4337                 /* no wan hardware present in system */
4338                 tp_features.wan = 0;
4339                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4340                            "wan hardware not installed\n");
4341         }
4342
4343         if (!tp_features.wan)
4344                 return 1;
4345
4346         res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4347                                 &wan_tprfk_ops,
4348                                 RFKILL_TYPE_WWAN,
4349                                 TPACPI_RFK_WWAN_SW_NAME,
4350                                 true);
4351         if (res)
4352                 return res;
4353
4354         res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4355                                 &wan_attr_group);
4356
4357         if (res) {
4358                 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4359                 return res;
4360         }
4361
4362         return 0;
4363 }
4364
4365 /* procfs -------------------------------------------------------------- */
4366 static int wan_read(struct seq_file *m)
4367 {
4368         return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4369 }
4370
4371 static int wan_write(char *buf)
4372 {
4373         return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4374 }
4375
4376 static struct ibm_struct wan_driver_data = {
4377         .name = "wan",
4378         .read = wan_read,
4379         .write = wan_write,
4380         .exit = wan_exit,
4381         .shutdown = wan_shutdown,
4382 };
4383
4384 /*************************************************************************
4385  * UWB subdriver
4386  */
4387
4388 enum {
4389         /* ACPI GUWB/SUWB bits */
4390         TP_ACPI_UWB_HWPRESENT   = 0x01, /* UWB hw available */
4391         TP_ACPI_UWB_RADIOSSW    = 0x02, /* UWB radio enabled */
4392 };
4393
4394 #define TPACPI_RFK_UWB_SW_NAME  "tpacpi_uwb_sw"
4395
4396 static int uwb_get_status(void)
4397 {
4398         int status;
4399
4400 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4401         if (dbg_uwbemul)
4402                 return (tpacpi_uwb_emulstate) ?
4403                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4404 #endif
4405
4406         if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4407                 return -EIO;
4408
4409         return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4410                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4411 }
4412
4413 static int uwb_set_status(enum tpacpi_rfkill_state state)
4414 {
4415         int status;
4416
4417         vdbg_printk(TPACPI_DBG_RFKILL,
4418                 "will attempt to %s UWB\n",
4419                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4420
4421 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4422         if (dbg_uwbemul) {
4423                 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4424                 return 0;
4425         }
4426 #endif
4427
4428         if (state == TPACPI_RFK_RADIO_ON)
4429                 status = TP_ACPI_UWB_RADIOSSW;
4430         else
4431                 status = 0;
4432
4433         if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4434                 return -EIO;
4435
4436         return 0;
4437 }
4438
4439 /* --------------------------------------------------------------------- */
4440
4441 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4442         .get_status = uwb_get_status,
4443         .set_status = uwb_set_status,
4444 };
4445
4446 static void uwb_exit(void)
4447 {
4448         tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4449 }
4450
4451 static int __init uwb_init(struct ibm_init_struct *iibm)
4452 {
4453         int res;
4454         int status = 0;
4455
4456         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4457                         "initializing uwb subdriver\n");
4458
4459         TPACPI_ACPIHANDLE_INIT(hkey);
4460
4461         tp_features.uwb = hkey_handle &&
4462             acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4463
4464         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4465                 "uwb is %s, status 0x%02x\n",
4466                 str_supported(tp_features.uwb),
4467                 status);
4468
4469 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4470         if (dbg_uwbemul) {
4471                 tp_features.uwb = 1;
4472                 pr_info("uwb switch emulation enabled\n");
4473         } else
4474 #endif
4475         if (tp_features.uwb &&
4476             !(status & TP_ACPI_UWB_HWPRESENT)) {
4477                 /* no uwb hardware present in system */
4478                 tp_features.uwb = 0;
4479                 dbg_printk(TPACPI_DBG_INIT,
4480                            "uwb hardware not installed\n");
4481         }
4482
4483         if (!tp_features.uwb)
4484                 return 1;
4485
4486         res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4487                                 &uwb_tprfk_ops,
4488                                 RFKILL_TYPE_UWB,
4489                                 TPACPI_RFK_UWB_SW_NAME,
4490                                 false);
4491         return res;
4492 }
4493
4494 static struct ibm_struct uwb_driver_data = {
4495         .name = "uwb",
4496         .exit = uwb_exit,
4497         .flags.experimental = 1,
4498 };
4499
4500 /*************************************************************************
4501  * Video subdriver
4502  */
4503
4504 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4505
4506 enum video_access_mode {
4507         TPACPI_VIDEO_NONE = 0,
4508         TPACPI_VIDEO_570,       /* 570 */
4509         TPACPI_VIDEO_770,       /* 600e/x, 770e, 770x */
4510         TPACPI_VIDEO_NEW,       /* all others */
4511 };
4512
4513 enum {  /* video status flags, based on VIDEO_570 */
4514         TP_ACPI_VIDEO_S_LCD = 0x01,     /* LCD output enabled */
4515         TP_ACPI_VIDEO_S_CRT = 0x02,     /* CRT output enabled */
4516         TP_ACPI_VIDEO_S_DVI = 0x08,     /* DVI output enabled */
4517 };
4518
4519 enum {  /* TPACPI_VIDEO_570 constants */
4520         TP_ACPI_VIDEO_570_PHSCMD = 0x87,        /* unknown magic constant :( */
4521         TP_ACPI_VIDEO_570_PHSMASK = 0x03,       /* PHS bits that map to
4522                                                  * video_status_flags */
4523         TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,       /* unknown magic constant :( */
4524         TP_ACPI_VIDEO_570_PHS2SET = 0x80,       /* unknown magic constant :( */
4525 };
4526
4527 static enum video_access_mode video_supported;
4528 static int video_orig_autosw;
4529
4530 static int video_autosw_get(void);
4531 static int video_autosw_set(int enable);
4532
4533 TPACPI_HANDLE(vid, root,
4534               "\\_SB.PCI.AGP.VGA",      /* 570 */
4535               "\\_SB.PCI0.AGP0.VID0",   /* 600e/x, 770x */
4536               "\\_SB.PCI0.VID0",        /* 770e */
4537               "\\_SB.PCI0.VID",         /* A21e, G4x, R50e, X30, X40 */
4538               "\\_SB.PCI0.AGP.VGA",     /* X100e and a few others */
4539               "\\_SB.PCI0.AGP.VID",     /* all others */
4540         );                              /* R30, R31 */
4541
4542 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID");       /* G41 */
4543
4544 static int __init video_init(struct ibm_init_struct *iibm)
4545 {
4546         int ivga;
4547
4548         vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4549
4550         TPACPI_ACPIHANDLE_INIT(vid);
4551         if (tpacpi_is_ibm())
4552                 TPACPI_ACPIHANDLE_INIT(vid2);
4553
4554         if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4555                 /* G41, assume IVGA doesn't change */
4556                 vid_handle = vid2_handle;
4557
4558         if (!vid_handle)
4559                 /* video switching not supported on R30, R31 */
4560                 video_supported = TPACPI_VIDEO_NONE;
4561         else if (tpacpi_is_ibm() &&
4562                  acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4563                 /* 570 */
4564                 video_supported = TPACPI_VIDEO_570;
4565         else if (tpacpi_is_ibm() &&
4566                  acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4567                 /* 600e/x, 770e, 770x */
4568                 video_supported = TPACPI_VIDEO_770;
4569         else
4570                 /* all others */
4571                 video_supported = TPACPI_VIDEO_NEW;
4572
4573         vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4574                 str_supported(video_supported != TPACPI_VIDEO_NONE),
4575                 video_supported);
4576
4577         return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4578 }
4579
4580 static void video_exit(void)
4581 {
4582         dbg_printk(TPACPI_DBG_EXIT,
4583                    "restoring original video autoswitch mode\n");
4584         if (video_autosw_set(video_orig_autosw))
4585                 pr_err("error while trying to restore original "
4586                         "video autoswitch mode\n");
4587 }
4588
4589 static int video_outputsw_get(void)
4590 {
4591         int status = 0;
4592         int i;
4593
4594         switch (video_supported) {
4595         case TPACPI_VIDEO_570:
4596                 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4597                                  TP_ACPI_VIDEO_570_PHSCMD))
4598                         return -EIO;
4599                 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4600                 break;
4601         case TPACPI_VIDEO_770:
4602                 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4603                         return -EIO;
4604                 if (i)
4605                         status |= TP_ACPI_VIDEO_S_LCD;
4606                 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4607                         return -EIO;
4608                 if (i)
4609                         status |= TP_ACPI_VIDEO_S_CRT;
4610                 break;
4611         case TPACPI_VIDEO_NEW:
4612                 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4613                     !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4614                         return -EIO;
4615                 if (i)
4616                         status |= TP_ACPI_VIDEO_S_CRT;
4617
4618                 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4619                     !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4620                         return -EIO;
4621                 if (i)
4622                         status |= TP_ACPI_VIDEO_S_LCD;
4623                 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4624                         return -EIO;
4625                 if (i)
4626                         status |= TP_ACPI_VIDEO_S_DVI;
4627                 break;
4628         default:
4629                 return -ENOSYS;
4630         }
4631
4632         return status;
4633 }
4634
4635 static int video_outputsw_set(int status)
4636 {
4637         int autosw;
4638         int res = 0;
4639
4640         switch (video_supported) {
4641         case TPACPI_VIDEO_570:
4642                 res = acpi_evalf(NULL, NULL,
4643                                  "\\_SB.PHS2", "vdd",
4644                                  TP_ACPI_VIDEO_570_PHS2CMD,
4645                                  status | TP_ACPI_VIDEO_570_PHS2SET);
4646                 break;
4647         case TPACPI_VIDEO_770:
4648                 autosw = video_autosw_get();
4649                 if (autosw < 0)
4650                         return autosw;
4651
4652                 res = video_autosw_set(1);
4653                 if (res)
4654                         return res;
4655                 res = acpi_evalf(vid_handle, NULL,
4656                                  "ASWT", "vdd", status * 0x100, 0);
4657                 if (!autosw && video_autosw_set(autosw)) {
4658                         pr_err("video auto-switch left enabled due to error\n");
4659                         return -EIO;
4660                 }
4661                 break;
4662         case TPACPI_VIDEO_NEW:
4663                 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4664                       acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4665                 break;
4666         default:
4667                 return -ENOSYS;
4668         }
4669
4670         return (res)? 0 : -EIO;
4671 }
4672
4673 static int video_autosw_get(void)
4674 {
4675         int autosw = 0;
4676
4677         switch (video_supported) {
4678         case TPACPI_VIDEO_570:
4679                 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4680                         return -EIO;
4681                 break;
4682         case TPACPI_VIDEO_770:
4683         case TPACPI_VIDEO_NEW:
4684                 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4685                         return -EIO;
4686                 break;
4687         default:
4688                 return -ENOSYS;
4689         }
4690
4691         return autosw & 1;
4692 }
4693
4694 static int video_autosw_set(int enable)
4695 {
4696         if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4697                 return -EIO;
4698         return 0;
4699 }
4700
4701 static int video_outputsw_cycle(void)
4702 {
4703         int autosw = video_autosw_get();
4704         int res;
4705
4706         if (autosw < 0)
4707                 return autosw;
4708
4709         switch (video_supported) {
4710         case TPACPI_VIDEO_570:
4711                 res = video_autosw_set(1);
4712                 if (res)
4713                         return res;
4714                 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4715                 break;
4716         case TPACPI_VIDEO_770:
4717         case TPACPI_VIDEO_NEW:
4718                 res = video_autosw_set(1);
4719                 if (res)
4720                         return res;
4721                 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4722                 break;
4723         default:
4724                 return -ENOSYS;
4725         }
4726         if (!autosw && video_autosw_set(autosw)) {
4727                 pr_err("video auto-switch left enabled due to error\n");
4728                 return -EIO;
4729         }
4730
4731         return (res)? 0 : -EIO;
4732 }
4733
4734 static int video_expand_toggle(void)
4735 {
4736         switch (video_supported) {
4737         case TPACPI_VIDEO_570:
4738                 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4739                         0 : -EIO;
4740         case TPACPI_VIDEO_770:
4741                 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4742                         0 : -EIO;
4743         case TPACPI_VIDEO_NEW:
4744                 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4745                         0 : -EIO;
4746         default:
4747                 return -ENOSYS;
4748         }
4749         /* not reached */
4750 }
4751
4752 static int video_read(struct seq_file *m)
4753 {
4754         int status, autosw;
4755
4756         if (video_supported == TPACPI_VIDEO_NONE) {
4757                 seq_printf(m, "status:\t\tnot supported\n");
4758                 return 0;
4759         }
4760
4761         /* Even reads can crash X.org, so... */
4762         if (!capable(CAP_SYS_ADMIN))
4763                 return -EPERM;
4764
4765         status = video_outputsw_get();
4766         if (status < 0)
4767                 return status;
4768
4769         autosw = video_autosw_get();
4770         if (autosw < 0)
4771                 return autosw;
4772
4773         seq_printf(m, "status:\t\tsupported\n");
4774         seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4775         seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4776         if (video_supported == TPACPI_VIDEO_NEW)
4777                 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4778         seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4779         seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4780         seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4781         if (video_supported == TPACPI_VIDEO_NEW)
4782                 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4783         seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4784         seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4785
4786         return 0;
4787 }
4788
4789 static int video_write(char *buf)
4790 {
4791         char *cmd;
4792         int enable, disable, status;
4793         int res;
4794
4795         if (video_supported == TPACPI_VIDEO_NONE)
4796                 return -ENODEV;
4797
4798         /* Even reads can crash X.org, let alone writes... */
4799         if (!capable(CAP_SYS_ADMIN))
4800                 return -EPERM;
4801
4802         enable = 0;
4803         disable = 0;
4804
4805         while ((cmd = next_cmd(&buf))) {
4806                 if (strlencmp(cmd, "lcd_enable") == 0) {
4807                         enable |= TP_ACPI_VIDEO_S_LCD;
4808                 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4809                         disable |= TP_ACPI_VIDEO_S_LCD;
4810                 } else if (strlencmp(cmd, "crt_enable") == 0) {
4811                         enable |= TP_ACPI_VIDEO_S_CRT;
4812                 } else if (strlencmp(cmd, "crt_disable") == 0) {
4813                         disable |= TP_ACPI_VIDEO_S_CRT;
4814                 } else if (video_supported == TPACPI_VIDEO_NEW &&
4815                            strlencmp(cmd, "dvi_enable") == 0) {
4816                         enable |= TP_ACPI_VIDEO_S_DVI;
4817                 } else if (video_supported == TPACPI_VIDEO_NEW &&
4818                            strlencmp(cmd, "dvi_disable") == 0) {
4819                         disable |= TP_ACPI_VIDEO_S_DVI;
4820                 } else if (strlencmp(cmd, "auto_enable") == 0) {
4821                         res = video_autosw_set(1);
4822                         if (res)
4823                                 return res;
4824                 } else if (strlencmp(cmd, "auto_disable") == 0) {
4825                         res = video_autosw_set(0);
4826                         if (res)
4827                                 return res;
4828                 } else if (strlencmp(cmd, "video_switch") == 0) {
4829                         res = video_outputsw_cycle();
4830                         if (res)
4831                                 return res;
4832                 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4833                         res = video_expand_toggle();
4834                         if (res)
4835                                 return res;
4836                 } else
4837                         return -EINVAL;
4838         }
4839
4840         if (enable || disable) {
4841                 status = video_outputsw_get();
4842                 if (status < 0)
4843                         return status;
4844                 res = video_outputsw_set((status & ~disable) | enable);
4845                 if (res)
4846                         return res;
4847         }
4848
4849         return 0;
4850 }
4851
4852 static struct ibm_struct video_driver_data = {
4853         .name = "video",
4854         .read = video_read,
4855         .write = video_write,
4856         .exit = video_exit,
4857 };
4858
4859 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4860
4861 /*************************************************************************
4862  * Light (thinklight) subdriver
4863  */
4864
4865 TPACPI_HANDLE(lght, root, "\\LGHT");    /* A21e, A2xm/p, T20-22, X20-21 */
4866 TPACPI_HANDLE(ledb, ec, "LEDB");                /* G4x */
4867
4868 static int light_get_status(void)
4869 {
4870         int status = 0;
4871
4872         if (tp_features.light_status) {
4873                 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4874                         return -EIO;
4875                 return (!!status);
4876         }
4877
4878         return -ENXIO;
4879 }
4880
4881 static int light_set_status(int status)
4882 {
4883         int rc;
4884
4885         if (tp_features.light) {
4886                 if (cmos_handle) {
4887                         rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4888                                         (status)?
4889                                                 TP_CMOS_THINKLIGHT_ON :
4890                                                 TP_CMOS_THINKLIGHT_OFF);
4891                 } else {
4892                         rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4893                                         (status)? 1 : 0);
4894                 }
4895                 return (rc)? 0 : -EIO;
4896         }
4897
4898         return -ENXIO;
4899 }
4900
4901 static void light_set_status_worker(struct work_struct *work)
4902 {
4903         struct tpacpi_led_classdev *data =
4904                         container_of(work, struct tpacpi_led_classdev, work);
4905
4906         if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4907                 light_set_status((data->new_state != TPACPI_LED_OFF));
4908 }
4909
4910 static void light_sysfs_set(struct led_classdev *led_cdev,
4911                         enum led_brightness brightness)
4912 {
4913         struct tpacpi_led_classdev *data =
4914                 container_of(led_cdev,
4915                              struct tpacpi_led_classdev,
4916                              led_classdev);
4917         data->new_state = (brightness != LED_OFF) ?
4918                                 TPACPI_LED_ON : TPACPI_LED_OFF;
4919         queue_work(tpacpi_wq, &data->work);
4920 }
4921
4922 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4923 {
4924         return (light_get_status() == 1)? LED_FULL : LED_OFF;
4925 }
4926
4927 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4928         .led_classdev = {
4929                 .name           = "tpacpi::thinklight",
4930                 .brightness_set = &light_sysfs_set,
4931                 .brightness_get = &light_sysfs_get,
4932         }
4933 };
4934
4935 static int __init light_init(struct ibm_init_struct *iibm)
4936 {
4937         int rc;
4938
4939         vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4940
4941         if (tpacpi_is_ibm()) {
4942                 TPACPI_ACPIHANDLE_INIT(ledb);
4943                 TPACPI_ACPIHANDLE_INIT(lght);
4944         }
4945         TPACPI_ACPIHANDLE_INIT(cmos);
4946         INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4947
4948         /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4949         tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4950
4951         if (tp_features.light)
4952                 /* light status not supported on
4953                    570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4954                 tp_features.light_status =
4955                         acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4956
4957         vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4958                 str_supported(tp_features.light),
4959                 str_supported(tp_features.light_status));
4960
4961         if (!tp_features.light)
4962                 return 1;
4963
4964         rc = led_classdev_register(&tpacpi_pdev->dev,
4965                                    &tpacpi_led_thinklight.led_classdev);
4966
4967         if (rc < 0) {
4968                 tp_features.light = 0;
4969                 tp_features.light_status = 0;
4970         } else  {
4971                 rc = 0;
4972         }
4973
4974         return rc;
4975 }
4976
4977 static void light_exit(void)
4978 {
4979         led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4980         flush_workqueue(tpacpi_wq);
4981 }
4982
4983 static int light_read(struct seq_file *m)
4984 {
4985         int status;
4986
4987         if (!tp_features.light) {
4988                 seq_printf(m, "status:\t\tnot supported\n");
4989         } else if (!tp_features.light_status) {
4990                 seq_printf(m, "status:\t\tunknown\n");
4991                 seq_printf(m, "commands:\ton, off\n");
4992         } else {
4993                 status = light_get_status();
4994                 if (status < 0)
4995                         return status;
4996                 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4997                 seq_printf(m, "commands:\ton, off\n");
4998         }
4999
5000         return 0;
5001 }
5002
5003 static int light_write(char *buf)
5004 {
5005         char *cmd;
5006         int newstatus = 0;
5007
5008         if (!tp_features.light)
5009                 return -ENODEV;
5010
5011         while ((cmd = next_cmd(&buf))) {
5012                 if (strlencmp(cmd, "on") == 0) {
5013                         newstatus = 1;
5014                 } else if (strlencmp(cmd, "off") == 0) {
5015                         newstatus = 0;
5016                 } else
5017                         return -EINVAL;
5018         }
5019
5020         return light_set_status(newstatus);
5021 }
5022
5023 static struct ibm_struct light_driver_data = {
5024         .name = "light",
5025         .read = light_read,
5026         .write = light_write,
5027         .exit = light_exit,
5028 };
5029
5030 /*************************************************************************
5031  * CMOS subdriver
5032  */
5033
5034 /* sysfs cmos_command -------------------------------------------------- */
5035 static ssize_t cmos_command_store(struct device *dev,
5036                             struct device_attribute *attr,
5037                             const char *buf, size_t count)
5038 {
5039         unsigned long cmos_cmd;
5040         int res;
5041
5042         if (parse_strtoul(buf, 21, &cmos_cmd))
5043                 return -EINVAL;
5044
5045         res = issue_thinkpad_cmos_command(cmos_cmd);
5046         return (res)? res : count;
5047 }
5048
5049 static struct device_attribute dev_attr_cmos_command =
5050         __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
5051
5052 /* --------------------------------------------------------------------- */
5053
5054 static int __init cmos_init(struct ibm_init_struct *iibm)
5055 {
5056         int res;
5057
5058         vdbg_printk(TPACPI_DBG_INIT,
5059                 "initializing cmos commands subdriver\n");
5060
5061         TPACPI_ACPIHANDLE_INIT(cmos);
5062
5063         vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5064                 str_supported(cmos_handle != NULL));
5065
5066         res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5067         if (res)
5068                 return res;
5069
5070         return (cmos_handle)? 0 : 1;
5071 }
5072
5073 static void cmos_exit(void)
5074 {
5075         device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5076 }
5077
5078 static int cmos_read(struct seq_file *m)
5079 {
5080         /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5081            R30, R31, T20-22, X20-21 */
5082         if (!cmos_handle)
5083                 seq_printf(m, "status:\t\tnot supported\n");
5084         else {
5085                 seq_printf(m, "status:\t\tsupported\n");
5086                 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5087         }
5088
5089         return 0;
5090 }
5091
5092 static int cmos_write(char *buf)
5093 {
5094         char *cmd;
5095         int cmos_cmd, res;
5096
5097         while ((cmd = next_cmd(&buf))) {
5098                 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5099                     cmos_cmd >= 0 && cmos_cmd <= 21) {
5100                         /* cmos_cmd set */
5101                 } else
5102                         return -EINVAL;
5103
5104                 res = issue_thinkpad_cmos_command(cmos_cmd);
5105                 if (res)
5106                         return res;
5107         }
5108
5109         return 0;
5110 }
5111
5112 static struct ibm_struct cmos_driver_data = {
5113         .name = "cmos",
5114         .read = cmos_read,
5115         .write = cmos_write,
5116         .exit = cmos_exit,
5117 };
5118
5119 /*************************************************************************
5120  * LED subdriver
5121  */
5122
5123 enum led_access_mode {
5124         TPACPI_LED_NONE = 0,
5125         TPACPI_LED_570, /* 570 */
5126         TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5127         TPACPI_LED_NEW, /* all others */
5128 };
5129
5130 enum {  /* For TPACPI_LED_OLD */
5131         TPACPI_LED_EC_HLCL = 0x0c,      /* EC reg to get led to power on */
5132         TPACPI_LED_EC_HLBL = 0x0d,      /* EC reg to blink a lit led */
5133         TPACPI_LED_EC_HLMS = 0x0e,      /* EC reg to select led to command */
5134 };
5135
5136 static enum led_access_mode led_supported;
5137
5138 static acpi_handle led_handle;
5139
5140 #define TPACPI_LED_NUMLEDS 16
5141 static struct tpacpi_led_classdev *tpacpi_leds;
5142 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5143 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5144         /* there's a limit of 19 chars + NULL before 2.6.26 */
5145         "tpacpi::power",
5146         "tpacpi:orange:batt",
5147         "tpacpi:green:batt",
5148         "tpacpi::dock_active",
5149         "tpacpi::bay_active",
5150         "tpacpi::dock_batt",
5151         "tpacpi::unknown_led",
5152         "tpacpi::standby",
5153         "tpacpi::dock_status1",
5154         "tpacpi::dock_status2",
5155         "tpacpi::unknown_led2",
5156         "tpacpi::unknown_led3",
5157         "tpacpi::thinkvantage",
5158 };
5159 #define TPACPI_SAFE_LEDS        0x1081U
5160
5161 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5162 {
5163 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5164         return false;
5165 #else
5166         return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5167 #endif
5168 }
5169
5170 static int led_get_status(const unsigned int led)
5171 {
5172         int status;
5173         enum led_status_t led_s;
5174
5175         switch (led_supported) {
5176         case TPACPI_LED_570:
5177                 if (!acpi_evalf(ec_handle,
5178                                 &status, "GLED", "dd", 1 << led))
5179                         return -EIO;
5180                 led_s = (status == 0)?
5181                                 TPACPI_LED_OFF :
5182                                 ((status == 1)?
5183                                         TPACPI_LED_ON :
5184                                         TPACPI_LED_BLINK);
5185                 tpacpi_led_state_cache[led] = led_s;
5186                 return led_s;
5187         default:
5188                 return -ENXIO;
5189         }
5190
5191         /* not reached */
5192 }
5193
5194 static int led_set_status(const unsigned int led,
5195                           const enum led_status_t ledstatus)
5196 {
5197         /* off, on, blink. Index is led_status_t */
5198         static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5199         static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5200
5201         int rc = 0;
5202
5203         switch (led_supported) {
5204         case TPACPI_LED_570:
5205                 /* 570 */
5206                 if (unlikely(led > 7))
5207                         return -EINVAL;
5208                 if (unlikely(tpacpi_is_led_restricted(led)))
5209                         return -EPERM;
5210                 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5211                                 (1 << led), led_sled_arg1[ledstatus]))
5212                         rc = -EIO;
5213                 break;
5214         case TPACPI_LED_OLD:
5215                 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5216                 if (unlikely(led > 7))
5217                         return -EINVAL;
5218                 if (unlikely(tpacpi_is_led_restricted(led)))
5219                         return -EPERM;
5220                 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5221                 if (rc >= 0)
5222                         rc = ec_write(TPACPI_LED_EC_HLBL,
5223                                       (ledstatus == TPACPI_LED_BLINK) << led);
5224                 if (rc >= 0)
5225                         rc = ec_write(TPACPI_LED_EC_HLCL,
5226                                       (ledstatus != TPACPI_LED_OFF) << led);
5227                 break;
5228         case TPACPI_LED_NEW:
5229                 /* all others */
5230                 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5231                         return -EINVAL;
5232                 if (unlikely(tpacpi_is_led_restricted(led)))
5233                         return -EPERM;
5234                 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5235                                 led, led_led_arg1[ledstatus]))
5236                         rc = -EIO;
5237                 break;
5238         default:
5239                 rc = -ENXIO;
5240         }
5241
5242         if (!rc)
5243                 tpacpi_led_state_cache[led] = ledstatus;
5244
5245         return rc;
5246 }
5247
5248 static void led_set_status_worker(struct work_struct *work)
5249 {
5250         struct tpacpi_led_classdev *data =
5251                 container_of(work, struct tpacpi_led_classdev, work);
5252
5253         if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5254                 led_set_status(data->led, data->new_state);
5255 }
5256
5257 static void led_sysfs_set(struct led_classdev *led_cdev,
5258                         enum led_brightness brightness)
5259 {
5260         struct tpacpi_led_classdev *data = container_of(led_cdev,
5261                              struct tpacpi_led_classdev, led_classdev);
5262
5263         if (brightness == LED_OFF)
5264                 data->new_state = TPACPI_LED_OFF;
5265         else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5266                 data->new_state = TPACPI_LED_ON;
5267         else
5268                 data->new_state = TPACPI_LED_BLINK;
5269
5270         queue_work(tpacpi_wq, &data->work);
5271 }
5272
5273 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5274                         unsigned long *delay_on, unsigned long *delay_off)
5275 {
5276         struct tpacpi_led_classdev *data = container_of(led_cdev,
5277                              struct tpacpi_led_classdev, led_classdev);
5278
5279         /* Can we choose the flash rate? */
5280         if (*delay_on == 0 && *delay_off == 0) {
5281                 /* yes. set them to the hardware blink rate (1 Hz) */
5282                 *delay_on = 500; /* ms */
5283                 *delay_off = 500; /* ms */
5284         } else if ((*delay_on != 500) || (*delay_off != 500))
5285                 return -EINVAL;
5286
5287         data->new_state = TPACPI_LED_BLINK;
5288         queue_work(tpacpi_wq, &data->work);
5289
5290         return 0;
5291 }
5292
5293 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5294 {
5295         int rc;
5296
5297         struct tpacpi_led_classdev *data = container_of(led_cdev,
5298                              struct tpacpi_led_classdev, led_classdev);
5299
5300         rc = led_get_status(data->led);
5301
5302         if (rc == TPACPI_LED_OFF || rc < 0)
5303                 rc = LED_OFF;   /* no error handling in led class :( */
5304         else
5305                 rc = LED_FULL;
5306
5307         return rc;
5308 }
5309
5310 static void led_exit(void)
5311 {
5312         unsigned int i;
5313
5314         for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5315                 if (tpacpi_leds[i].led_classdev.name)
5316                         led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5317         }
5318
5319         flush_workqueue(tpacpi_wq);
5320         kfree(tpacpi_leds);
5321 }
5322
5323 static int __init tpacpi_init_led(unsigned int led)
5324 {
5325         int rc;
5326
5327         tpacpi_leds[led].led = led;
5328
5329         /* LEDs with no name don't get registered */
5330         if (!tpacpi_led_names[led])
5331                 return 0;
5332
5333         tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5334         tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5335         if (led_supported == TPACPI_LED_570)
5336                 tpacpi_leds[led].led_classdev.brightness_get =
5337                                                 &led_sysfs_get;
5338
5339         tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5340
5341         INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5342
5343         rc = led_classdev_register(&tpacpi_pdev->dev,
5344                                 &tpacpi_leds[led].led_classdev);
5345         if (rc < 0)
5346                 tpacpi_leds[led].led_classdev.name = NULL;
5347
5348         return rc;
5349 }
5350
5351 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5352         TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5353         TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5354         TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5355
5356         TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5357         TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5358         TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5359         TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5360         TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5361         TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5362         TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5363         TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5364
5365         TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5366         TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5367         TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5368         TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5369         TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5370
5371         TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5372         TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5373         TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5374         TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5375
5376         /* (1) - may have excess leds enabled on MSB */
5377
5378         /* Defaults (order matters, keep last, don't reorder!) */
5379         { /* Lenovo */
5380           .vendor = PCI_VENDOR_ID_LENOVO,
5381           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5382           .quirks = 0x1fffU,
5383         },
5384         { /* IBM ThinkPads with no EC version string */
5385           .vendor = PCI_VENDOR_ID_IBM,
5386           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5387           .quirks = 0x00ffU,
5388         },
5389         { /* IBM ThinkPads with EC version string */
5390           .vendor = PCI_VENDOR_ID_IBM,
5391           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5392           .quirks = 0x00bfU,
5393         },
5394 };
5395
5396 #undef TPACPI_LEDQ_IBM
5397 #undef TPACPI_LEDQ_LNV
5398
5399 static enum led_access_mode __init led_init_detect_mode(void)
5400 {
5401         acpi_status status;
5402
5403         if (tpacpi_is_ibm()) {
5404                 /* 570 */
5405                 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5406                 if (ACPI_SUCCESS(status))
5407                         return TPACPI_LED_570;
5408
5409                 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5410                 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5411                 if (ACPI_SUCCESS(status))
5412                         return TPACPI_LED_OLD;
5413         }
5414
5415         /* most others */
5416         status = acpi_get_handle(ec_handle, "LED", &led_handle);
5417         if (ACPI_SUCCESS(status))
5418                 return TPACPI_LED_NEW;
5419
5420         /* R30, R31, and unknown firmwares */
5421         led_handle = NULL;
5422         return TPACPI_LED_NONE;
5423 }
5424
5425 static int __init led_init(struct ibm_init_struct *iibm)
5426 {
5427         unsigned int i;
5428         int rc;
5429         unsigned long useful_leds;
5430
5431         vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5432
5433         led_supported = led_init_detect_mode();
5434
5435         if (led_supported != TPACPI_LED_NONE) {
5436                 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5437                                 ARRAY_SIZE(led_useful_qtable));
5438
5439                 if (!useful_leds) {
5440                         led_handle = NULL;
5441                         led_supported = TPACPI_LED_NONE;
5442                 }
5443         }
5444
5445         vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5446                 str_supported(led_supported), led_supported);
5447
5448         if (led_supported == TPACPI_LED_NONE)
5449                 return 1;
5450
5451         tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5452                               GFP_KERNEL);
5453         if (!tpacpi_leds) {
5454                 pr_err("Out of memory for LED data\n");
5455                 return -ENOMEM;
5456         }
5457
5458         for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5459                 tpacpi_leds[i].led = -1;
5460
5461                 if (!tpacpi_is_led_restricted(i) &&
5462                     test_bit(i, &useful_leds)) {
5463                         rc = tpacpi_init_led(i);
5464                         if (rc < 0) {
5465                                 led_exit();
5466                                 return rc;
5467                         }
5468                 }
5469         }
5470
5471 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5472         pr_notice("warning: userspace override of important "
5473                   "firmware LEDs is enabled\n");
5474 #endif
5475         return 0;
5476 }
5477
5478 #define str_led_status(s) \
5479         ((s) == TPACPI_LED_OFF ? "off" : \
5480                 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5481
5482 static int led_read(struct seq_file *m)
5483 {
5484         if (!led_supported) {
5485                 seq_printf(m, "status:\t\tnot supported\n");
5486                 return 0;
5487         }
5488         seq_printf(m, "status:\t\tsupported\n");
5489
5490         if (led_supported == TPACPI_LED_570) {
5491                 /* 570 */
5492                 int i, status;
5493                 for (i = 0; i < 8; i++) {
5494                         status = led_get_status(i);
5495                         if (status < 0)
5496                                 return -EIO;
5497                         seq_printf(m, "%d:\t\t%s\n",
5498                                        i, str_led_status(status));
5499                 }
5500         }
5501
5502         seq_printf(m, "commands:\t"
5503                        "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5504
5505         return 0;
5506 }
5507
5508 static int led_write(char *buf)
5509 {
5510         char *cmd;
5511         int led, rc;
5512         enum led_status_t s;
5513
5514         if (!led_supported)
5515                 return -ENODEV;
5516
5517         while ((cmd = next_cmd(&buf))) {
5518                 if (sscanf(cmd, "%d", &led) != 1)
5519                         return -EINVAL;
5520
5521                 if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1) ||
5522                                 tpacpi_leds[led].led < 0)
5523                         return -ENODEV;
5524
5525                 if (strstr(cmd, "off")) {
5526                         s = TPACPI_LED_OFF;
5527                 } else if (strstr(cmd, "on")) {
5528                         s = TPACPI_LED_ON;
5529                 } else if (strstr(cmd, "blink")) {
5530                         s = TPACPI_LED_BLINK;
5531                 } else {
5532                         return -EINVAL;
5533                 }
5534
5535                 rc = led_set_status(led, s);
5536                 if (rc < 0)
5537                         return rc;
5538         }
5539
5540         return 0;
5541 }
5542
5543 static struct ibm_struct led_driver_data = {
5544         .name = "led",
5545         .read = led_read,
5546         .write = led_write,
5547         .exit = led_exit,
5548 };
5549
5550 /*************************************************************************
5551  * Beep subdriver
5552  */
5553
5554 TPACPI_HANDLE(beep, ec, "BEEP");        /* all except R30, R31 */
5555
5556 #define TPACPI_BEEP_Q1 0x0001
5557
5558 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5559         TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5560         TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5561 };
5562
5563 static int __init beep_init(struct ibm_init_struct *iibm)
5564 {
5565         unsigned long quirks;
5566
5567         vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5568
5569         TPACPI_ACPIHANDLE_INIT(beep);
5570
5571         vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5572                 str_supported(beep_handle != NULL));
5573
5574         quirks = tpacpi_check_quirks(beep_quirk_table,
5575                                      ARRAY_SIZE(beep_quirk_table));
5576
5577         tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5578
5579         return (beep_handle)? 0 : 1;
5580 }
5581
5582 static int beep_read(struct seq_file *m)
5583 {
5584         if (!beep_handle)
5585                 seq_printf(m, "status:\t\tnot supported\n");
5586         else {
5587                 seq_printf(m, "status:\t\tsupported\n");
5588                 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5589         }
5590
5591         return 0;
5592 }
5593
5594 static int beep_write(char *buf)
5595 {
5596         char *cmd;
5597         int beep_cmd;
5598
5599         if (!beep_handle)
5600                 return -ENODEV;
5601
5602         while ((cmd = next_cmd(&buf))) {
5603                 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5604                     beep_cmd >= 0 && beep_cmd <= 17) {
5605                         /* beep_cmd set */
5606                 } else
5607                         return -EINVAL;
5608                 if (tp_features.beep_needs_two_args) {
5609                         if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5610                                         beep_cmd, 0))
5611                                 return -EIO;
5612                 } else {
5613                         if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5614                                         beep_cmd))
5615                                 return -EIO;
5616                 }
5617         }
5618
5619         return 0;
5620 }
5621
5622 static struct ibm_struct beep_driver_data = {
5623         .name = "beep",
5624         .read = beep_read,
5625         .write = beep_write,
5626 };
5627
5628 /*************************************************************************
5629  * Thermal subdriver
5630  */
5631
5632 enum thermal_access_mode {
5633         TPACPI_THERMAL_NONE = 0,        /* No thermal support */
5634         TPACPI_THERMAL_ACPI_TMP07,      /* Use ACPI TMP0-7 */
5635         TPACPI_THERMAL_ACPI_UPDT,       /* Use ACPI TMP0-7 with UPDT */
5636         TPACPI_THERMAL_TPEC_8,          /* Use ACPI EC regs, 8 sensors */
5637         TPACPI_THERMAL_TPEC_16,         /* Use ACPI EC regs, 16 sensors */
5638 };
5639
5640 enum { /* TPACPI_THERMAL_TPEC_* */
5641         TP_EC_THERMAL_TMP0 = 0x78,      /* ACPI EC regs TMP 0..7 */
5642         TP_EC_THERMAL_TMP8 = 0xC0,      /* ACPI EC regs TMP 8..15 */
5643         TP_EC_THERMAL_TMP_NA = -128,    /* ACPI EC sensor not available */
5644
5645         TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5646 };
5647
5648
5649 #define TPACPI_MAX_THERMAL_SENSORS 16   /* Max thermal sensors supported */
5650 struct ibm_thermal_sensors_struct {
5651         s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5652 };
5653
5654 static enum thermal_access_mode thermal_read_mode;
5655
5656 /* idx is zero-based */
5657 static int thermal_get_sensor(int idx, s32 *value)
5658 {
5659         int t;
5660         s8 tmp;
5661         char tmpi[5];
5662
5663         t = TP_EC_THERMAL_TMP0;
5664
5665         switch (thermal_read_mode) {
5666 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5667         case TPACPI_THERMAL_TPEC_16:
5668                 if (idx >= 8 && idx <= 15) {
5669                         t = TP_EC_THERMAL_TMP8;
5670                         idx -= 8;
5671                 }
5672                 /* fallthrough */
5673 #endif
5674         case TPACPI_THERMAL_TPEC_8:
5675                 if (idx <= 7) {
5676                         if (!acpi_ec_read(t + idx, &tmp))
5677                                 return -EIO;
5678                         *value = tmp * 1000;
5679                         return 0;
5680                 }
5681                 break;
5682
5683         case TPACPI_THERMAL_ACPI_UPDT:
5684                 if (idx <= 7) {
5685                         snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5686                         if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5687                                 return -EIO;
5688                         if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5689                                 return -EIO;
5690                         *value = (t - 2732) * 100;
5691                         return 0;
5692                 }
5693                 break;
5694
5695         case TPACPI_THERMAL_ACPI_TMP07:
5696                 if (idx <= 7) {
5697                         snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5698                         if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5699                                 return -EIO;
5700                         if (t > 127 || t < -127)
5701                                 t = TP_EC_THERMAL_TMP_NA;
5702                         *value = t * 1000;
5703                         return 0;
5704                 }
5705                 break;
5706
5707         case TPACPI_THERMAL_NONE:
5708         default:
5709                 return -ENOSYS;
5710         }
5711
5712         return -EINVAL;
5713 }
5714
5715 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5716 {
5717         int res, i;
5718         int n;
5719
5720         n = 8;
5721         i = 0;
5722
5723         if (!s)
5724                 return -EINVAL;
5725
5726         if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5727                 n = 16;
5728
5729         for (i = 0 ; i < n; i++) {
5730                 res = thermal_get_sensor(i, &s->temp[i]);
5731                 if (res)
5732                         return res;
5733         }
5734
5735         return n;
5736 }
5737
5738 static void thermal_dump_all_sensors(void)
5739 {
5740         int n, i;
5741         struct ibm_thermal_sensors_struct t;
5742
5743         n = thermal_get_sensors(&t);
5744         if (n <= 0)
5745                 return;
5746
5747         pr_notice("temperatures (Celsius):");
5748
5749         for (i = 0; i < n; i++) {
5750                 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5751                         pr_cont(" %d", (int)(t.temp[i] / 1000));
5752                 else
5753                         pr_cont(" N/A");
5754         }
5755
5756         pr_cont("\n");
5757 }
5758
5759 /* sysfs temp##_input -------------------------------------------------- */
5760
5761 static ssize_t thermal_temp_input_show(struct device *dev,
5762                            struct device_attribute *attr,
5763                            char *buf)
5764 {
5765         struct sensor_device_attribute *sensor_attr =
5766                                         to_sensor_dev_attr(attr);
5767         int idx = sensor_attr->index;
5768         s32 value;
5769         int res;
5770
5771         res = thermal_get_sensor(idx, &value);
5772         if (res)
5773                 return res;
5774         if (value == TPACPI_THERMAL_SENSOR_NA)
5775                 return -ENXIO;
5776
5777         return snprintf(buf, PAGE_SIZE, "%d\n", value);
5778 }
5779
5780 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5781          SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5782                      thermal_temp_input_show, NULL, _idxB)
5783
5784 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5785         THERMAL_SENSOR_ATTR_TEMP(1, 0),
5786         THERMAL_SENSOR_ATTR_TEMP(2, 1),
5787         THERMAL_SENSOR_ATTR_TEMP(3, 2),
5788         THERMAL_SENSOR_ATTR_TEMP(4, 3),
5789         THERMAL_SENSOR_ATTR_TEMP(5, 4),
5790         THERMAL_SENSOR_ATTR_TEMP(6, 5),
5791         THERMAL_SENSOR_ATTR_TEMP(7, 6),
5792         THERMAL_SENSOR_ATTR_TEMP(8, 7),
5793         THERMAL_SENSOR_ATTR_TEMP(9, 8),
5794         THERMAL_SENSOR_ATTR_TEMP(10, 9),
5795         THERMAL_SENSOR_ATTR_TEMP(11, 10),
5796         THERMAL_SENSOR_ATTR_TEMP(12, 11),
5797         THERMAL_SENSOR_ATTR_TEMP(13, 12),
5798         THERMAL_SENSOR_ATTR_TEMP(14, 13),
5799         THERMAL_SENSOR_ATTR_TEMP(15, 14),
5800         THERMAL_SENSOR_ATTR_TEMP(16, 15),
5801 };
5802
5803 #define THERMAL_ATTRS(X) \
5804         &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5805
5806 static struct attribute *thermal_temp_input_attr[] = {
5807         THERMAL_ATTRS(8),
5808         THERMAL_ATTRS(9),
5809         THERMAL_ATTRS(10),
5810         THERMAL_ATTRS(11),
5811         THERMAL_ATTRS(12),
5812         THERMAL_ATTRS(13),
5813         THERMAL_ATTRS(14),
5814         THERMAL_ATTRS(15),
5815         THERMAL_ATTRS(0),
5816         THERMAL_ATTRS(1),
5817         THERMAL_ATTRS(2),
5818         THERMAL_ATTRS(3),
5819         THERMAL_ATTRS(4),
5820         THERMAL_ATTRS(5),
5821         THERMAL_ATTRS(6),
5822         THERMAL_ATTRS(7),
5823         NULL
5824 };
5825
5826 static const struct attribute_group thermal_temp_input16_group = {
5827         .attrs = thermal_temp_input_attr
5828 };
5829
5830 static const struct attribute_group thermal_temp_input8_group = {
5831         .attrs = &thermal_temp_input_attr[8]
5832 };
5833
5834 #undef THERMAL_SENSOR_ATTR_TEMP
5835 #undef THERMAL_ATTRS
5836
5837 /* --------------------------------------------------------------------- */
5838
5839 static int __init thermal_init(struct ibm_init_struct *iibm)
5840 {
5841         u8 t, ta1, ta2;
5842         int i;
5843         int acpi_tmp7;
5844         int res;
5845
5846         vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5847
5848         acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5849
5850         if (thinkpad_id.ec_model) {
5851                 /*
5852                  * Direct EC access mode: sensors at registers
5853                  * 0x78-0x7F, 0xC0-0xC7.  Registers return 0x00 for
5854                  * non-implemented, thermal sensors return 0x80 when
5855                  * not available
5856                  */
5857
5858                 ta1 = ta2 = 0;
5859                 for (i = 0; i < 8; i++) {
5860                         if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5861                                 ta1 |= t;
5862                         } else {
5863                                 ta1 = 0;
5864                                 break;
5865                         }
5866                         if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5867                                 ta2 |= t;
5868                         } else {
5869                                 ta1 = 0;
5870                                 break;
5871                         }
5872                 }
5873                 if (ta1 == 0) {
5874                         /* This is sheer paranoia, but we handle it anyway */
5875                         if (acpi_tmp7) {
5876                                 pr_err("ThinkPad ACPI EC access misbehaving, "
5877                                        "falling back to ACPI TMPx access "
5878                                        "mode\n");
5879                                 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5880                         } else {
5881                                 pr_err("ThinkPad ACPI EC access misbehaving, "
5882                                        "disabling thermal sensors access\n");
5883                                 thermal_read_mode = TPACPI_THERMAL_NONE;
5884                         }
5885                 } else {
5886                         thermal_read_mode =
5887                             (ta2 != 0) ?
5888                             TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5889                 }
5890         } else if (acpi_tmp7) {
5891                 if (tpacpi_is_ibm() &&
5892                     acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5893                         /* 600e/x, 770e, 770x */
5894                         thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5895                 } else {
5896                         /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5897                         thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5898                 }
5899         } else {
5900                 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5901                 thermal_read_mode = TPACPI_THERMAL_NONE;
5902         }
5903
5904         vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5905                 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5906                 thermal_read_mode);
5907
5908         switch (thermal_read_mode) {
5909         case TPACPI_THERMAL_TPEC_16:
5910                 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5911                                 &thermal_temp_input16_group);
5912                 if (res)
5913                         return res;
5914                 break;
5915         case TPACPI_THERMAL_TPEC_8:
5916         case TPACPI_THERMAL_ACPI_TMP07:
5917         case TPACPI_THERMAL_ACPI_UPDT:
5918                 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5919                                 &thermal_temp_input8_group);
5920                 if (res)
5921                         return res;
5922                 break;
5923         case TPACPI_THERMAL_NONE:
5924         default:
5925                 return 1;
5926         }
5927
5928         return 0;
5929 }
5930
5931 static void thermal_exit(void)
5932 {
5933         switch (thermal_read_mode) {
5934         case TPACPI_THERMAL_TPEC_16:
5935                 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5936                                    &thermal_temp_input16_group);
5937                 break;
5938         case TPACPI_THERMAL_TPEC_8:
5939         case TPACPI_THERMAL_ACPI_TMP07:
5940         case TPACPI_THERMAL_ACPI_UPDT:
5941                 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5942                                    &thermal_temp_input8_group);
5943                 break;
5944         case TPACPI_THERMAL_NONE:
5945         default:
5946                 break;
5947         }
5948 }
5949
5950 static int thermal_read(struct seq_file *m)
5951 {
5952         int n, i;
5953         struct ibm_thermal_sensors_struct t;
5954
5955         n = thermal_get_sensors(&t);
5956         if (unlikely(n < 0))
5957                 return n;
5958
5959         seq_printf(m, "temperatures:\t");
5960
5961         if (n > 0) {
5962                 for (i = 0; i < (n - 1); i++)
5963                         seq_printf(m, "%d ", t.temp[i] / 1000);
5964                 seq_printf(m, "%d\n", t.temp[i] / 1000);
5965         } else
5966                 seq_printf(m, "not supported\n");
5967
5968         return 0;
5969 }
5970
5971 static struct ibm_struct thermal_driver_data = {
5972         .name = "thermal",
5973         .read = thermal_read,
5974         .exit = thermal_exit,
5975 };
5976
5977 /*************************************************************************
5978  * Backlight/brightness subdriver
5979  */
5980
5981 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5982
5983 /*
5984  * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5985  * CMOS NVRAM byte 0x5E, bits 0-3.
5986  *
5987  * EC HBRV (0x31) has the following layout
5988  *   Bit 7: unknown function
5989  *   Bit 6: unknown function
5990  *   Bit 5: Z: honour scale changes, NZ: ignore scale changes
5991  *   Bit 4: must be set to zero to avoid problems
5992  *   Bit 3-0: backlight brightness level
5993  *
5994  * brightness_get_raw returns status data in the HBRV layout
5995  *
5996  * WARNING: The X61 has been verified to use HBRV for something else, so
5997  * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5998  * testing on the very early *60 Lenovo models...
5999  */
6000
6001 enum {
6002         TP_EC_BACKLIGHT = 0x31,
6003
6004         /* TP_EC_BACKLIGHT bitmasks */
6005         TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6006         TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6007         TP_EC_BACKLIGHT_MAPSW = 0x20,
6008 };
6009
6010 enum tpacpi_brightness_access_mode {
6011         TPACPI_BRGHT_MODE_AUTO = 0,     /* Not implemented yet */
6012         TPACPI_BRGHT_MODE_EC,           /* EC control */
6013         TPACPI_BRGHT_MODE_UCMS_STEP,    /* UCMS step-based control */
6014         TPACPI_BRGHT_MODE_ECNVRAM,      /* EC control w/ NVRAM store */
6015         TPACPI_BRGHT_MODE_MAX
6016 };
6017
6018 static struct backlight_device *ibm_backlight_device;
6019
6020 static enum tpacpi_brightness_access_mode brightness_mode =
6021                 TPACPI_BRGHT_MODE_MAX;
6022
6023 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6024
6025 static struct mutex brightness_mutex;
6026
6027 /* NVRAM brightness access,
6028  * call with brightness_mutex held! */
6029 static unsigned int tpacpi_brightness_nvram_get(void)
6030 {
6031         u8 lnvram;
6032
6033         lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6034                   & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6035                   >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6036         lnvram &= bright_maxlvl;
6037
6038         return lnvram;
6039 }
6040
6041 static void tpacpi_brightness_checkpoint_nvram(void)
6042 {
6043         u8 lec = 0;
6044         u8 b_nvram;
6045
6046         if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6047                 return;
6048
6049         vdbg_printk(TPACPI_DBG_BRGHT,
6050                 "trying to checkpoint backlight level to NVRAM...\n");
6051
6052         if (mutex_lock_killable(&brightness_mutex) < 0)
6053                 return;
6054
6055         if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6056                 goto unlock;
6057         lec &= TP_EC_BACKLIGHT_LVLMSK;
6058         b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6059
6060         if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6061                              >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6062                 /* NVRAM needs update */
6063                 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6064                                 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6065                 b_nvram |= lec;
6066                 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6067                 dbg_printk(TPACPI_DBG_BRGHT,
6068                            "updated NVRAM backlight level to %u (0x%02x)\n",
6069                            (unsigned int) lec, (unsigned int) b_nvram);
6070         } else
6071                 vdbg_printk(TPACPI_DBG_BRGHT,
6072                            "NVRAM backlight level already is %u (0x%02x)\n",
6073                            (unsigned int) lec, (unsigned int) b_nvram);
6074
6075 unlock:
6076         mutex_unlock(&brightness_mutex);
6077 }
6078
6079
6080 /* call with brightness_mutex held! */
6081 static int tpacpi_brightness_get_raw(int *status)
6082 {
6083         u8 lec = 0;
6084
6085         switch (brightness_mode) {
6086         case TPACPI_BRGHT_MODE_UCMS_STEP:
6087                 *status = tpacpi_brightness_nvram_get();
6088                 return 0;
6089         case TPACPI_BRGHT_MODE_EC:
6090         case TPACPI_BRGHT_MODE_ECNVRAM:
6091                 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6092                         return -EIO;
6093                 *status = lec;
6094                 return 0;
6095         default:
6096                 return -ENXIO;
6097         }
6098 }
6099
6100 /* call with brightness_mutex held! */
6101 /* do NOT call with illegal backlight level value */
6102 static int tpacpi_brightness_set_ec(unsigned int value)
6103 {
6104         u8 lec = 0;
6105
6106         if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6107                 return -EIO;
6108
6109         if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6110                                 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6111                                 (value & TP_EC_BACKLIGHT_LVLMSK))))
6112                 return -EIO;
6113
6114         return 0;
6115 }
6116
6117 /* call with brightness_mutex held! */
6118 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6119 {
6120         int cmos_cmd, inc;
6121         unsigned int current_value, i;
6122
6123         current_value = tpacpi_brightness_nvram_get();
6124
6125         if (value == current_value)
6126                 return 0;
6127
6128         cmos_cmd = (value > current_value) ?
6129                         TP_CMOS_BRIGHTNESS_UP :
6130                         TP_CMOS_BRIGHTNESS_DOWN;
6131         inc = (value > current_value) ? 1 : -1;
6132
6133         for (i = current_value; i != value; i += inc)
6134                 if (issue_thinkpad_cmos_command(cmos_cmd))
6135                         return -EIO;
6136
6137         return 0;
6138 }
6139
6140 /* May return EINTR which can always be mapped to ERESTARTSYS */
6141 static int brightness_set(unsigned int value)
6142 {
6143         int res;
6144
6145         if (value > bright_maxlvl || value < 0)
6146                 return -EINVAL;
6147
6148         vdbg_printk(TPACPI_DBG_BRGHT,
6149                         "set backlight level to %d\n", value);
6150
6151         res = mutex_lock_killable(&brightness_mutex);
6152         if (res < 0)
6153                 return res;
6154
6155         switch (brightness_mode) {
6156         case TPACPI_BRGHT_MODE_EC:
6157         case TPACPI_BRGHT_MODE_ECNVRAM:
6158                 res = tpacpi_brightness_set_ec(value);
6159                 break;
6160         case TPACPI_BRGHT_MODE_UCMS_STEP:
6161                 res = tpacpi_brightness_set_ucmsstep(value);
6162                 break;
6163         default:
6164                 res = -ENXIO;
6165         }
6166
6167         mutex_unlock(&brightness_mutex);
6168         return res;
6169 }
6170
6171 /* sysfs backlight class ----------------------------------------------- */
6172
6173 static int brightness_update_status(struct backlight_device *bd)
6174 {
6175         unsigned int level =
6176                 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6177                  bd->props.power == FB_BLANK_UNBLANK) ?
6178                                 bd->props.brightness : 0;
6179
6180         dbg_printk(TPACPI_DBG_BRGHT,
6181                         "backlight: attempt to set level to %d\n",
6182                         level);
6183
6184         /* it is the backlight class's job (caller) to handle
6185          * EINTR and other errors properly */
6186         return brightness_set(level);
6187 }
6188
6189 static int brightness_get(struct backlight_device *bd)
6190 {
6191         int status, res;
6192
6193         res = mutex_lock_killable(&brightness_mutex);
6194         if (res < 0)
6195                 return 0;
6196
6197         res = tpacpi_brightness_get_raw(&status);
6198
6199         mutex_unlock(&brightness_mutex);
6200
6201         if (res < 0)
6202                 return 0;
6203
6204         return status & TP_EC_BACKLIGHT_LVLMSK;
6205 }
6206
6207 static void tpacpi_brightness_notify_change(void)
6208 {
6209         backlight_force_update(ibm_backlight_device,
6210                                BACKLIGHT_UPDATE_HOTKEY);
6211 }
6212
6213 static const struct backlight_ops ibm_backlight_data = {
6214         .get_brightness = brightness_get,
6215         .update_status  = brightness_update_status,
6216 };
6217
6218 /* --------------------------------------------------------------------- */
6219
6220 /*
6221  * Call _BCL method of video device.  On some ThinkPads this will
6222  * switch the firmware to the ACPI brightness control mode.
6223  */
6224
6225 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6226 {
6227         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6228         union acpi_object *obj;
6229         struct acpi_device *device, *child;
6230         int rc;
6231
6232         if (acpi_bus_get_device(handle, &device))
6233                 return 0;
6234
6235         rc = 0;
6236         list_for_each_entry(child, &device->children, node) {
6237                 acpi_status status = acpi_evaluate_object(child->handle, "_BCL",
6238                                                           NULL, &buffer);
6239                 if (ACPI_FAILURE(status))
6240                         continue;
6241
6242                 obj = (union acpi_object *)buffer.pointer;
6243                 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6244                         pr_err("Unknown _BCL data, please report this to %s\n",
6245                                 TPACPI_MAIL);
6246                         rc = 0;
6247                 } else {
6248                         rc = obj->package.count;
6249                 }
6250                 break;
6251         }
6252
6253         kfree(buffer.pointer);
6254         return rc;
6255 }
6256
6257
6258 /*
6259  * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6260  */
6261 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6262 {
6263         acpi_handle video_device;
6264         int bcl_levels = 0;
6265
6266         tpacpi_acpi_handle_locate("video", NULL, &video_device);
6267         if (video_device)
6268                 bcl_levels = tpacpi_query_bcl_levels(video_device);
6269
6270         tp_features.bright_acpimode = (bcl_levels > 0);
6271
6272         return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6273 }
6274
6275 /*
6276  * These are only useful for models that have only one possibility
6277  * of GPU.  If the BIOS model handles both ATI and Intel, don't use
6278  * these quirks.
6279  */
6280 #define TPACPI_BRGHT_Q_NOEC     0x0001  /* Must NOT use EC HBRV */
6281 #define TPACPI_BRGHT_Q_EC       0x0002  /* Should or must use EC HBRV */
6282 #define TPACPI_BRGHT_Q_ASK      0x8000  /* Ask for user report */
6283
6284 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6285         /* Models with ATI GPUs known to require ECNVRAM mode */
6286         TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC),      /* T43/p ATI */
6287
6288         /* Models with ATI GPUs that can use ECNVRAM */
6289         TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC),      /* R50,51 T40-42 */
6290         TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6291         TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC),      /* R52 */
6292         TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6293
6294         /* Models with Intel Extreme Graphics 2 */
6295         TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC),    /* X40 */
6296         TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6297         TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6298
6299         /* Models with Intel GMA900 */
6300         TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC),    /* T43, R52 */
6301         TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC),    /* X41 */
6302         TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC),    /* X41 Tablet */
6303 };
6304
6305 /*
6306  * Returns < 0 for error, otherwise sets tp_features.bright_*
6307  * and bright_maxlvl.
6308  */
6309 static void __init tpacpi_detect_brightness_capabilities(void)
6310 {
6311         unsigned int b;
6312
6313         vdbg_printk(TPACPI_DBG_INIT,
6314                     "detecting firmware brightness interface capabilities\n");
6315
6316         /* we could run a quirks check here (same table used by
6317          * brightness_init) if needed */
6318
6319         /*
6320          * We always attempt to detect acpi support, so as to switch
6321          * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6322          * going to publish a backlight interface
6323          */
6324         b = tpacpi_check_std_acpi_brightness_support();
6325         switch (b) {
6326         case 16:
6327                 bright_maxlvl = 15;
6328                 pr_info("detected a 16-level brightness capable ThinkPad\n");
6329                 break;
6330         case 8:
6331         case 0:
6332                 bright_maxlvl = 7;
6333                 pr_info("detected a 8-level brightness capable ThinkPad\n");
6334                 break;
6335         default:
6336                 pr_err("Unsupported brightness interface, "
6337                        "please contact %s\n", TPACPI_MAIL);
6338                 tp_features.bright_unkfw = 1;
6339                 bright_maxlvl = b - 1;
6340         }
6341 }
6342
6343 static int __init brightness_init(struct ibm_init_struct *iibm)
6344 {
6345         struct backlight_properties props;
6346         int b;
6347         unsigned long quirks;
6348
6349         vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6350
6351         mutex_init(&brightness_mutex);
6352
6353         quirks = tpacpi_check_quirks(brightness_quirk_table,
6354                                 ARRAY_SIZE(brightness_quirk_table));
6355
6356         /* tpacpi_detect_brightness_capabilities() must have run already */
6357
6358         /* if it is unknown, we don't handle it: it wouldn't be safe */
6359         if (tp_features.bright_unkfw)
6360                 return 1;
6361
6362         if (!brightness_enable) {
6363                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6364                            "brightness support disabled by "
6365                            "module parameter\n");
6366                 return 1;
6367         }
6368
6369         if (acpi_video_backlight_support()) {
6370                 if (brightness_enable > 1) {
6371                         pr_info("Standard ACPI backlight interface "
6372                                 "available, not loading native one\n");
6373                         return 1;
6374                 } else if (brightness_enable == 1) {
6375                         pr_warn("Cannot enable backlight brightness support, "
6376                                 "ACPI is already handling it.  Refer to the "
6377                                 "acpi_backlight kernel parameter.\n");
6378                         return 1;
6379                 }
6380         } else if (tp_features.bright_acpimode && brightness_enable > 1) {
6381                 pr_notice("Standard ACPI backlight interface not "
6382                           "available, thinkpad_acpi native "
6383                           "brightness control enabled\n");
6384         }
6385
6386         /*
6387          * Check for module parameter bogosity, note that we
6388          * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6389          * able to detect "unspecified"
6390          */
6391         if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6392                 return -EINVAL;
6393
6394         /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6395         if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6396             brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6397                 if (quirks & TPACPI_BRGHT_Q_EC)
6398                         brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6399                 else
6400                         brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6401
6402                 dbg_printk(TPACPI_DBG_BRGHT,
6403                            "driver auto-selected brightness_mode=%d\n",
6404                            brightness_mode);
6405         }
6406
6407         /* Safety */
6408         if (!tpacpi_is_ibm() &&
6409             (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6410              brightness_mode == TPACPI_BRGHT_MODE_EC))
6411                 return -EINVAL;
6412
6413         if (tpacpi_brightness_get_raw(&b) < 0)
6414                 return 1;
6415
6416         memset(&props, 0, sizeof(struct backlight_properties));
6417         props.type = BACKLIGHT_PLATFORM;
6418         props.max_brightness = bright_maxlvl;
6419         props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6420         ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6421                                                          NULL, NULL,
6422                                                          &ibm_backlight_data,
6423                                                          &props);
6424         if (IS_ERR(ibm_backlight_device)) {
6425                 int rc = PTR_ERR(ibm_backlight_device);
6426                 ibm_backlight_device = NULL;
6427                 pr_err("Could not register backlight device\n");
6428                 return rc;
6429         }
6430         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6431                         "brightness is supported\n");
6432
6433         if (quirks & TPACPI_BRGHT_Q_ASK) {
6434                 pr_notice("brightness: will use unverified default: "
6435                           "brightness_mode=%d\n", brightness_mode);
6436                 pr_notice("brightness: please report to %s whether it works well "
6437                           "or not on your ThinkPad\n", TPACPI_MAIL);
6438         }
6439
6440         /* Added by mistake in early 2007.  Probably useless, but it could
6441          * be working around some unknown firmware problem where the value
6442          * read at startup doesn't match the real hardware state... so leave
6443          * it in place just in case */
6444         backlight_update_status(ibm_backlight_device);
6445
6446         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6447                         "brightness: registering brightness hotkeys "
6448                         "as change notification\n");
6449         tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6450                                 | TP_ACPI_HKEY_BRGHTUP_MASK
6451                                 | TP_ACPI_HKEY_BRGHTDWN_MASK);
6452         return 0;
6453 }
6454
6455 static void brightness_suspend(void)
6456 {
6457         tpacpi_brightness_checkpoint_nvram();
6458 }
6459
6460 static void brightness_shutdown(void)
6461 {
6462         tpacpi_brightness_checkpoint_nvram();
6463 }
6464
6465 static void brightness_exit(void)
6466 {
6467         if (ibm_backlight_device) {
6468                 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6469                             "calling backlight_device_unregister()\n");
6470                 backlight_device_unregister(ibm_backlight_device);
6471         }
6472
6473         tpacpi_brightness_checkpoint_nvram();
6474 }
6475
6476 static int brightness_read(struct seq_file *m)
6477 {
6478         int level;
6479
6480         level = brightness_get(NULL);
6481         if (level < 0) {
6482                 seq_printf(m, "level:\t\tunreadable\n");
6483         } else {
6484                 seq_printf(m, "level:\t\t%d\n", level);
6485                 seq_printf(m, "commands:\tup, down\n");
6486                 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6487                                bright_maxlvl);
6488         }
6489
6490         return 0;
6491 }
6492
6493 static int brightness_write(char *buf)
6494 {
6495         int level;
6496         int rc;
6497         char *cmd;
6498
6499         level = brightness_get(NULL);
6500         if (level < 0)
6501                 return level;
6502
6503         while ((cmd = next_cmd(&buf))) {
6504                 if (strlencmp(cmd, "up") == 0) {
6505                         if (level < bright_maxlvl)
6506                                 level++;
6507                 } else if (strlencmp(cmd, "down") == 0) {
6508                         if (level > 0)
6509                                 level--;
6510                 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6511                            level >= 0 && level <= bright_maxlvl) {
6512                         /* new level set */
6513                 } else
6514                         return -EINVAL;
6515         }
6516
6517         tpacpi_disclose_usertask("procfs brightness",
6518                         "set level to %d\n", level);
6519
6520         /*
6521          * Now we know what the final level should be, so we try to set it.
6522          * Doing it this way makes the syscall restartable in case of EINTR
6523          */
6524         rc = brightness_set(level);
6525         if (!rc && ibm_backlight_device)
6526                 backlight_force_update(ibm_backlight_device,
6527                                         BACKLIGHT_UPDATE_SYSFS);
6528         return (rc == -EINTR)? -ERESTARTSYS : rc;
6529 }
6530
6531 static struct ibm_struct brightness_driver_data = {
6532         .name = "brightness",
6533         .read = brightness_read,
6534         .write = brightness_write,
6535         .exit = brightness_exit,
6536         .suspend = brightness_suspend,
6537         .shutdown = brightness_shutdown,
6538 };
6539
6540 /*************************************************************************
6541  * Volume subdriver
6542  */
6543
6544 /*
6545  * IBM ThinkPads have a simple volume controller with MUTE gating.
6546  * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6547  *
6548  * Since the *61 series (and probably also the later *60 series), Lenovo
6549  * ThinkPads only implement the MUTE gate.
6550  *
6551  * EC register 0x30
6552  *   Bit 6: MUTE (1 mutes sound)
6553  *   Bit 3-0: Volume
6554  *   Other bits should be zero as far as we know.
6555  *
6556  * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6557  * bits 3-0 (volume).  Other bits in NVRAM may have other functions,
6558  * such as bit 7 which is used to detect repeated presses of MUTE,
6559  * and we leave them unchanged.
6560  */
6561
6562 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6563
6564 #define TPACPI_ALSA_DRVNAME  "ThinkPad EC"
6565 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6566 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6567
6568 #if SNDRV_CARDS <= 32
6569 #define DEFAULT_ALSA_IDX                ~((1 << (SNDRV_CARDS - 3)) - 1)
6570 #else
6571 #define DEFAULT_ALSA_IDX                ~((1 << (32 - 3)) - 1)
6572 #endif
6573 static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
6574 static char *alsa_id = "ThinkPadEC";
6575 static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
6576
6577 struct tpacpi_alsa_data {
6578         struct snd_card *card;
6579         struct snd_ctl_elem_id *ctl_mute_id;
6580         struct snd_ctl_elem_id *ctl_vol_id;
6581 };
6582
6583 static struct snd_card *alsa_card;
6584
6585 enum {
6586         TP_EC_AUDIO = 0x30,
6587
6588         /* TP_EC_AUDIO bits */
6589         TP_EC_AUDIO_MUTESW = 6,
6590
6591         /* TP_EC_AUDIO bitmasks */
6592         TP_EC_AUDIO_LVL_MSK = 0x0F,
6593         TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6594
6595         /* Maximum volume */
6596         TP_EC_VOLUME_MAX = 14,
6597 };
6598
6599 enum tpacpi_volume_access_mode {
6600         TPACPI_VOL_MODE_AUTO = 0,       /* Not implemented yet */
6601         TPACPI_VOL_MODE_EC,             /* Pure EC control */
6602         TPACPI_VOL_MODE_UCMS_STEP,      /* UCMS step-based control: N/A */
6603         TPACPI_VOL_MODE_ECNVRAM,        /* EC control w/ NVRAM store */
6604         TPACPI_VOL_MODE_MAX
6605 };
6606
6607 enum tpacpi_volume_capabilities {
6608         TPACPI_VOL_CAP_AUTO = 0,        /* Use white/blacklist */
6609         TPACPI_VOL_CAP_VOLMUTE,         /* Output vol and mute */
6610         TPACPI_VOL_CAP_MUTEONLY,        /* Output mute only */
6611         TPACPI_VOL_CAP_MAX
6612 };
6613
6614 static enum tpacpi_volume_access_mode volume_mode =
6615         TPACPI_VOL_MODE_MAX;
6616
6617 static enum tpacpi_volume_capabilities volume_capabilities;
6618 static bool volume_control_allowed;
6619
6620 /*
6621  * Used to syncronize writers to TP_EC_AUDIO and
6622  * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6623  */
6624 static struct mutex volume_mutex;
6625
6626 static void tpacpi_volume_checkpoint_nvram(void)
6627 {
6628         u8 lec = 0;
6629         u8 b_nvram;
6630         u8 ec_mask;
6631
6632         if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6633                 return;
6634         if (!volume_control_allowed)
6635                 return;
6636
6637         vdbg_printk(TPACPI_DBG_MIXER,
6638                 "trying to checkpoint mixer state to NVRAM...\n");
6639
6640         if (tp_features.mixer_no_level_control)
6641                 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6642         else
6643                 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6644
6645         if (mutex_lock_killable(&volume_mutex) < 0)
6646                 return;
6647
6648         if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6649                 goto unlock;
6650         lec &= ec_mask;
6651         b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6652
6653         if (lec != (b_nvram & ec_mask)) {
6654                 /* NVRAM needs update */
6655                 b_nvram &= ~ec_mask;
6656                 b_nvram |= lec;
6657                 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6658                 dbg_printk(TPACPI_DBG_MIXER,
6659                            "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6660                            (unsigned int) lec, (unsigned int) b_nvram);
6661         } else {
6662                 vdbg_printk(TPACPI_DBG_MIXER,
6663                            "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6664                            (unsigned int) lec, (unsigned int) b_nvram);
6665         }
6666
6667 unlock:
6668         mutex_unlock(&volume_mutex);
6669 }
6670
6671 static int volume_get_status_ec(u8 *status)
6672 {
6673         u8 s;
6674
6675         if (!acpi_ec_read(TP_EC_AUDIO, &s))
6676                 return -EIO;
6677
6678         *status = s;
6679
6680         dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6681
6682         return 0;
6683 }
6684
6685 static int volume_get_status(u8 *status)
6686 {
6687         return volume_get_status_ec(status);
6688 }
6689
6690 static int volume_set_status_ec(const u8 status)
6691 {
6692         if (!acpi_ec_write(TP_EC_AUDIO, status))
6693                 return -EIO;
6694
6695         dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6696
6697         return 0;
6698 }
6699
6700 static int volume_set_status(const u8 status)
6701 {
6702         return volume_set_status_ec(status);
6703 }
6704
6705 /* returns < 0 on error, 0 on no change, 1 on change */
6706 static int __volume_set_mute_ec(const bool mute)
6707 {
6708         int rc;
6709         u8 s, n;
6710
6711         if (mutex_lock_killable(&volume_mutex) < 0)
6712                 return -EINTR;
6713
6714         rc = volume_get_status_ec(&s);
6715         if (rc)
6716                 goto unlock;
6717
6718         n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6719                      s & ~TP_EC_AUDIO_MUTESW_MSK;
6720
6721         if (n != s) {
6722                 rc = volume_set_status_ec(n);
6723                 if (!rc)
6724                         rc = 1;
6725         }
6726
6727 unlock:
6728         mutex_unlock(&volume_mutex);
6729         return rc;
6730 }
6731
6732 static int volume_alsa_set_mute(const bool mute)
6733 {
6734         dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6735                    (mute) ? "" : "un");
6736         return __volume_set_mute_ec(mute);
6737 }
6738
6739 static int volume_set_mute(const bool mute)
6740 {
6741         int rc;
6742
6743         dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6744                    (mute) ? "" : "un");
6745
6746         rc = __volume_set_mute_ec(mute);
6747         return (rc < 0) ? rc : 0;
6748 }
6749
6750 /* returns < 0 on error, 0 on no change, 1 on change */
6751 static int __volume_set_volume_ec(const u8 vol)
6752 {
6753         int rc;
6754         u8 s, n;
6755
6756         if (vol > TP_EC_VOLUME_MAX)
6757                 return -EINVAL;
6758
6759         if (mutex_lock_killable(&volume_mutex) < 0)
6760                 return -EINTR;
6761
6762         rc = volume_get_status_ec(&s);
6763         if (rc)
6764                 goto unlock;
6765
6766         n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6767
6768         if (n != s) {
6769                 rc = volume_set_status_ec(n);
6770                 if (!rc)
6771                         rc = 1;
6772         }
6773
6774 unlock:
6775         mutex_unlock(&volume_mutex);
6776         return rc;
6777 }
6778
6779 static int volume_alsa_set_volume(const u8 vol)
6780 {
6781         dbg_printk(TPACPI_DBG_MIXER,
6782                    "ALSA: trying to set volume level to %hu\n", vol);
6783         return __volume_set_volume_ec(vol);
6784 }
6785
6786 static void volume_alsa_notify_change(void)
6787 {
6788         struct tpacpi_alsa_data *d;
6789
6790         if (alsa_card && alsa_card->private_data) {
6791                 d = alsa_card->private_data;
6792                 if (d->ctl_mute_id)
6793                         snd_ctl_notify(alsa_card,
6794                                         SNDRV_CTL_EVENT_MASK_VALUE,
6795                                         d->ctl_mute_id);
6796                 if (d->ctl_vol_id)
6797                         snd_ctl_notify(alsa_card,
6798                                         SNDRV_CTL_EVENT_MASK_VALUE,
6799                                         d->ctl_vol_id);
6800         }
6801 }
6802
6803 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6804                                 struct snd_ctl_elem_info *uinfo)
6805 {
6806         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6807         uinfo->count = 1;
6808         uinfo->value.integer.min = 0;
6809         uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6810         return 0;
6811 }
6812
6813 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6814                                 struct snd_ctl_elem_value *ucontrol)
6815 {
6816         u8 s;
6817         int rc;
6818
6819         rc = volume_get_status(&s);
6820         if (rc < 0)
6821                 return rc;
6822
6823         ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6824         return 0;
6825 }
6826
6827 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6828                                 struct snd_ctl_elem_value *ucontrol)
6829 {
6830         tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
6831                                  ucontrol->value.integer.value[0]);
6832         return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6833 }
6834
6835 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
6836
6837 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6838                                 struct snd_ctl_elem_value *ucontrol)
6839 {
6840         u8 s;
6841         int rc;
6842
6843         rc = volume_get_status(&s);
6844         if (rc < 0)
6845                 return rc;
6846
6847         ucontrol->value.integer.value[0] =
6848                                 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6849         return 0;
6850 }
6851
6852 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6853                                 struct snd_ctl_elem_value *ucontrol)
6854 {
6855         tpacpi_disclose_usertask("ALSA", "%smute\n",
6856                                  ucontrol->value.integer.value[0] ?
6857                                         "un" : "");
6858         return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6859 }
6860
6861 static struct snd_kcontrol_new volume_alsa_control_vol = {
6862         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6863         .name = "Console Playback Volume",
6864         .index = 0,
6865         .access = SNDRV_CTL_ELEM_ACCESS_READ,
6866         .info = volume_alsa_vol_info,
6867         .get = volume_alsa_vol_get,
6868 };
6869
6870 static struct snd_kcontrol_new volume_alsa_control_mute = {
6871         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6872         .name = "Console Playback Switch",
6873         .index = 0,
6874         .access = SNDRV_CTL_ELEM_ACCESS_READ,
6875         .info = volume_alsa_mute_info,
6876         .get = volume_alsa_mute_get,
6877 };
6878
6879 static void volume_suspend(void)
6880 {
6881         tpacpi_volume_checkpoint_nvram();
6882 }
6883
6884 static void volume_resume(void)
6885 {
6886         volume_alsa_notify_change();
6887 }
6888
6889 static void volume_shutdown(void)
6890 {
6891         tpacpi_volume_checkpoint_nvram();
6892 }
6893
6894 static void volume_exit(void)
6895 {
6896         if (alsa_card) {
6897                 snd_card_free(alsa_card);
6898                 alsa_card = NULL;
6899         }
6900
6901         tpacpi_volume_checkpoint_nvram();
6902 }
6903
6904 static int __init volume_create_alsa_mixer(void)
6905 {
6906         struct snd_card *card;
6907         struct tpacpi_alsa_data *data;
6908         struct snd_kcontrol *ctl_vol;
6909         struct snd_kcontrol *ctl_mute;
6910         int rc;
6911
6912         rc = snd_card_new(&tpacpi_pdev->dev,
6913                           alsa_index, alsa_id, THIS_MODULE,
6914                           sizeof(struct tpacpi_alsa_data), &card);
6915         if (rc < 0 || !card) {
6916                 pr_err("Failed to create ALSA card structures: %d\n", rc);
6917                 return 1;
6918         }
6919
6920         BUG_ON(!card->private_data);
6921         data = card->private_data;
6922         data->card = card;
6923
6924         strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6925                 sizeof(card->driver));
6926         strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6927                 sizeof(card->shortname));
6928         snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6929                  (thinkpad_id.ec_version_str) ?
6930                         thinkpad_id.ec_version_str : "(unknown)");
6931         snprintf(card->longname, sizeof(card->longname),
6932                  "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6933                  (thinkpad_id.ec_version_str) ?
6934                         thinkpad_id.ec_version_str : "unknown");
6935
6936         if (volume_control_allowed) {
6937                 volume_alsa_control_vol.put = volume_alsa_vol_put;
6938                 volume_alsa_control_vol.access =
6939                                 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6940
6941                 volume_alsa_control_mute.put = volume_alsa_mute_put;
6942                 volume_alsa_control_mute.access =
6943                                 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6944         }
6945
6946         if (!tp_features.mixer_no_level_control) {
6947                 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6948                 rc = snd_ctl_add(card, ctl_vol);
6949                 if (rc < 0) {
6950                         pr_err("Failed to create ALSA volume control: %d\n",
6951                                rc);
6952                         goto err_exit;
6953                 }
6954                 data->ctl_vol_id = &ctl_vol->id;
6955         }
6956
6957         ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6958         rc = snd_ctl_add(card, ctl_mute);
6959         if (rc < 0) {
6960                 pr_err("Failed to create ALSA mute control: %d\n", rc);
6961                 goto err_exit;
6962         }
6963         data->ctl_mute_id = &ctl_mute->id;
6964
6965         rc = snd_card_register(card);
6966         if (rc < 0) {
6967                 pr_err("Failed to register ALSA card: %d\n", rc);
6968                 goto err_exit;
6969         }
6970
6971         alsa_card = card;
6972         return 0;
6973
6974 err_exit:
6975         snd_card_free(card);
6976         return 1;
6977 }
6978
6979 #define TPACPI_VOL_Q_MUTEONLY   0x0001  /* Mute-only control available */
6980 #define TPACPI_VOL_Q_LEVEL      0x0002  /* Volume control available */
6981
6982 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6983         /* Whitelist volume level on all IBM by default */
6984         { .vendor = PCI_VENDOR_ID_IBM,
6985           .bios   = TPACPI_MATCH_ANY,
6986           .ec     = TPACPI_MATCH_ANY,
6987           .quirks = TPACPI_VOL_Q_LEVEL },
6988
6989         /* Lenovo models with volume control (needs confirmation) */
6990         TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6991         TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6992         TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6993         TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6994         TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6995         TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6996         TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6997
6998         /* Whitelist mute-only on all Lenovo by default */
6999         { .vendor = PCI_VENDOR_ID_LENOVO,
7000           .bios   = TPACPI_MATCH_ANY,
7001           .ec     = TPACPI_MATCH_ANY,
7002           .quirks = TPACPI_VOL_Q_MUTEONLY }
7003 };
7004
7005 static int __init volume_init(struct ibm_init_struct *iibm)
7006 {
7007         unsigned long quirks;
7008         int rc;
7009
7010         vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7011
7012         mutex_init(&volume_mutex);
7013
7014         /*
7015          * Check for module parameter bogosity, note that we
7016          * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7017          * able to detect "unspecified"
7018          */
7019         if (volume_mode > TPACPI_VOL_MODE_MAX)
7020                 return -EINVAL;
7021
7022         if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7023                 pr_err("UCMS step volume mode not implemented, "
7024                        "please contact %s\n", TPACPI_MAIL);
7025                 return 1;
7026         }
7027
7028         if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7029                 return -EINVAL;
7030
7031         /*
7032          * The ALSA mixer is our primary interface.
7033          * When disabled, don't install the subdriver at all
7034          */
7035         if (!alsa_enable) {
7036                 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7037                             "ALSA mixer disabled by parameter, "
7038                             "not loading volume subdriver...\n");
7039                 return 1;
7040         }
7041
7042         quirks = tpacpi_check_quirks(volume_quirk_table,
7043                                      ARRAY_SIZE(volume_quirk_table));
7044
7045         switch (volume_capabilities) {
7046         case TPACPI_VOL_CAP_AUTO:
7047                 if (quirks & TPACPI_VOL_Q_MUTEONLY)
7048                         tp_features.mixer_no_level_control = 1;
7049                 else if (quirks & TPACPI_VOL_Q_LEVEL)
7050                         tp_features.mixer_no_level_control = 0;
7051                 else
7052                         return 1; /* no mixer */
7053                 break;
7054         case TPACPI_VOL_CAP_VOLMUTE:
7055                 tp_features.mixer_no_level_control = 0;
7056                 break;
7057         case TPACPI_VOL_CAP_MUTEONLY:
7058                 tp_features.mixer_no_level_control = 1;
7059                 break;
7060         default:
7061                 return 1;
7062         }
7063
7064         if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7065                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7066                                 "using user-supplied volume_capabilities=%d\n",
7067                                 volume_capabilities);
7068
7069         if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7070             volume_mode == TPACPI_VOL_MODE_MAX) {
7071                 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7072
7073                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7074                                 "driver auto-selected volume_mode=%d\n",
7075                                 volume_mode);
7076         } else {
7077                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7078                                 "using user-supplied volume_mode=%d\n",
7079                                 volume_mode);
7080         }
7081
7082         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7083                         "mute is supported, volume control is %s\n",
7084                         str_supported(!tp_features.mixer_no_level_control));
7085
7086         rc = volume_create_alsa_mixer();
7087         if (rc) {
7088                 pr_err("Could not create the ALSA mixer interface\n");
7089                 return rc;
7090         }
7091
7092         pr_info("Console audio control enabled, mode: %s\n",
7093                 (volume_control_allowed) ?
7094                         "override (read/write)" :
7095                         "monitor (read only)");
7096
7097         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7098                 "registering volume hotkeys as change notification\n");
7099         tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7100                         | TP_ACPI_HKEY_VOLUP_MASK
7101                         | TP_ACPI_HKEY_VOLDWN_MASK
7102                         | TP_ACPI_HKEY_MUTE_MASK);
7103
7104         return 0;
7105 }
7106
7107 static int volume_read(struct seq_file *m)
7108 {
7109         u8 status;
7110
7111         if (volume_get_status(&status) < 0) {
7112                 seq_printf(m, "level:\t\tunreadable\n");
7113         } else {
7114                 if (tp_features.mixer_no_level_control)
7115                         seq_printf(m, "level:\t\tunsupported\n");
7116                 else
7117                         seq_printf(m, "level:\t\t%d\n",
7118                                         status & TP_EC_AUDIO_LVL_MSK);
7119
7120                 seq_printf(m, "mute:\t\t%s\n",
7121                                 onoff(status, TP_EC_AUDIO_MUTESW));
7122
7123                 if (volume_control_allowed) {
7124                         seq_printf(m, "commands:\tunmute, mute\n");
7125                         if (!tp_features.mixer_no_level_control) {
7126                                 seq_printf(m,
7127                                                "commands:\tup, down\n");
7128                                 seq_printf(m,
7129                                                "commands:\tlevel <level>"
7130                                                " (<level> is 0-%d)\n",
7131                                                TP_EC_VOLUME_MAX);
7132                         }
7133                 }
7134         }
7135
7136         return 0;
7137 }
7138
7139 static int volume_write(char *buf)
7140 {
7141         u8 s;
7142         u8 new_level, new_mute;
7143         int l;
7144         char *cmd;
7145         int rc;
7146
7147         /*
7148          * We do allow volume control at driver startup, so that the
7149          * user can set initial state through the volume=... parameter hack.
7150          */
7151         if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7152                 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7153                         tp_warned.volume_ctrl_forbidden = 1;
7154                         pr_notice("Console audio control in monitor mode, "
7155                                   "changes are not allowed\n");
7156                         pr_notice("Use the volume_control=1 module parameter "
7157                                   "to enable volume control\n");
7158                 }
7159                 return -EPERM;
7160         }
7161
7162         rc = volume_get_status(&s);
7163         if (rc < 0)
7164                 return rc;
7165
7166         new_level = s & TP_EC_AUDIO_LVL_MSK;
7167         new_mute  = s & TP_EC_AUDIO_MUTESW_MSK;
7168
7169         while ((cmd = next_cmd(&buf))) {
7170                 if (!tp_features.mixer_no_level_control) {
7171                         if (strlencmp(cmd, "up") == 0) {
7172                                 if (new_mute)
7173                                         new_mute = 0;
7174                                 else if (new_level < TP_EC_VOLUME_MAX)
7175                                         new_level++;
7176                                 continue;
7177                         } else if (strlencmp(cmd, "down") == 0) {
7178                                 if (new_mute)
7179                                         new_mute = 0;
7180                                 else if (new_level > 0)
7181                                         new_level--;
7182                                 continue;
7183                         } else if (sscanf(cmd, "level %u", &l) == 1 &&
7184                                    l >= 0 && l <= TP_EC_VOLUME_MAX) {
7185                                         new_level = l;
7186                                 continue;
7187                         }
7188                 }
7189                 if (strlencmp(cmd, "mute") == 0)
7190                         new_mute = TP_EC_AUDIO_MUTESW_MSK;
7191                 else if (strlencmp(cmd, "unmute") == 0)
7192                         new_mute = 0;
7193                 else
7194                         return -EINVAL;
7195         }
7196
7197         if (tp_features.mixer_no_level_control) {
7198                 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7199                                         new_mute ? "" : "un");
7200                 rc = volume_set_mute(!!new_mute);
7201         } else {
7202                 tpacpi_disclose_usertask("procfs volume",
7203                                         "%smute and set level to %d\n",
7204                                         new_mute ? "" : "un", new_level);
7205                 rc = volume_set_status(new_mute | new_level);
7206         }
7207         volume_alsa_notify_change();
7208
7209         return (rc == -EINTR) ? -ERESTARTSYS : rc;
7210 }
7211
7212 static struct ibm_struct volume_driver_data = {
7213         .name = "volume",
7214         .read = volume_read,
7215         .write = volume_write,
7216         .exit = volume_exit,
7217         .suspend = volume_suspend,
7218         .resume = volume_resume,
7219         .shutdown = volume_shutdown,
7220 };
7221
7222 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7223
7224 #define alsa_card NULL
7225
7226 static void inline volume_alsa_notify_change(void)
7227 {
7228 }
7229
7230 static int __init volume_init(struct ibm_init_struct *iibm)
7231 {
7232         pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7233
7234         return 1;
7235 }
7236
7237 static struct ibm_struct volume_driver_data = {
7238         .name = "volume",
7239 };
7240
7241 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7242
7243 /*************************************************************************
7244  * Fan subdriver
7245  */
7246
7247 /*
7248  * FAN ACCESS MODES
7249  *
7250  * TPACPI_FAN_RD_ACPI_GFAN:
7251  *      ACPI GFAN method: returns fan level
7252  *
7253  *      see TPACPI_FAN_WR_ACPI_SFAN
7254  *      EC 0x2f (HFSP) not available if GFAN exists
7255  *
7256  * TPACPI_FAN_WR_ACPI_SFAN:
7257  *      ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7258  *
7259  *      EC 0x2f (HFSP) might be available *for reading*, but do not use
7260  *      it for writing.
7261  *
7262  * TPACPI_FAN_WR_TPEC:
7263  *      ThinkPad EC register 0x2f (HFSP): fan control loop mode
7264  *      Supported on almost all ThinkPads
7265  *
7266  *      Fan speed changes of any sort (including those caused by the
7267  *      disengaged mode) are usually done slowly by the firmware as the
7268  *      maximum amount of fan duty cycle change per second seems to be
7269  *      limited.
7270  *
7271  *      Reading is not available if GFAN exists.
7272  *      Writing is not available if SFAN exists.
7273  *
7274  *      Bits
7275  *       7      automatic mode engaged;
7276  *              (default operation mode of the ThinkPad)
7277  *              fan level is ignored in this mode.
7278  *       6      full speed mode (takes precedence over bit 7);
7279  *              not available on all thinkpads.  May disable
7280  *              the tachometer while the fan controller ramps up
7281  *              the speed (which can take up to a few *minutes*).
7282  *              Speeds up fan to 100% duty-cycle, which is far above
7283  *              the standard RPM levels.  It is not impossible that
7284  *              it could cause hardware damage.
7285  *      5-3     unused in some models.  Extra bits for fan level
7286  *              in others, but still useless as all values above
7287  *              7 map to the same speed as level 7 in these models.
7288  *      2-0     fan level (0..7 usually)
7289  *                      0x00 = stop
7290  *                      0x07 = max (set when temperatures critical)
7291  *              Some ThinkPads may have other levels, see
7292  *              TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7293  *
7294  *      FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7295  *      boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7296  *      does so, its initial value is meaningless (0x07).
7297  *
7298  *      For firmware bugs, refer to:
7299  *      http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7300  *
7301  *      ----
7302  *
7303  *      ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7304  *      Main fan tachometer reading (in RPM)
7305  *
7306  *      This register is present on all ThinkPads with a new-style EC, and
7307  *      it is known not to be present on the A21m/e, and T22, as there is
7308  *      something else in offset 0x84 according to the ACPI DSDT.  Other
7309  *      ThinkPads from this same time period (and earlier) probably lack the
7310  *      tachometer as well.
7311  *
7312  *      Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7313  *      was never fixed by IBM to report the EC firmware version string
7314  *      probably support the tachometer (like the early X models), so
7315  *      detecting it is quite hard.  We need more data to know for sure.
7316  *
7317  *      FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7318  *      might result.
7319  *
7320  *      FIRMWARE BUG: may go stale while the EC is switching to full speed
7321  *      mode.
7322  *
7323  *      For firmware bugs, refer to:
7324  *      http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7325  *
7326  *      ----
7327  *
7328  *      ThinkPad EC register 0x31 bit 0 (only on select models)
7329  *
7330  *      When bit 0 of EC register 0x31 is zero, the tachometer registers
7331  *      show the speed of the main fan.  When bit 0 of EC register 0x31
7332  *      is one, the tachometer registers show the speed of the auxiliary
7333  *      fan.
7334  *
7335  *      Fan control seems to affect both fans, regardless of the state
7336  *      of this bit.
7337  *
7338  *      So far, only the firmware for the X60/X61 non-tablet versions
7339  *      seem to support this (firmware TP-7M).
7340  *
7341  * TPACPI_FAN_WR_ACPI_FANS:
7342  *      ThinkPad X31, X40, X41.  Not available in the X60.
7343  *
7344  *      FANS ACPI handle: takes three arguments: low speed, medium speed,
7345  *      high speed.  ACPI DSDT seems to map these three speeds to levels
7346  *      as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7347  *      (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7348  *
7349  *      The speeds are stored on handles
7350  *      (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7351  *
7352  *      There are three default speed sets, accessible as handles:
7353  *      FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7354  *
7355  *      ACPI DSDT switches which set is in use depending on various
7356  *      factors.
7357  *
7358  *      TPACPI_FAN_WR_TPEC is also available and should be used to
7359  *      command the fan.  The X31/X40/X41 seems to have 8 fan levels,
7360  *      but the ACPI tables just mention level 7.
7361  */
7362
7363 enum {                                  /* Fan control constants */
7364         fan_status_offset = 0x2f,       /* EC register 0x2f */
7365         fan_rpm_offset = 0x84,          /* EC register 0x84: LSB, 0x85 MSB (RPM)
7366                                          * 0x84 must be read before 0x85 */
7367         fan_select_offset = 0x31,       /* EC register 0x31 (Firmware 7M)
7368                                            bit 0 selects which fan is active */
7369
7370         TP_EC_FAN_FULLSPEED = 0x40,     /* EC fan mode: full speed */
7371         TP_EC_FAN_AUTO      = 0x80,     /* EC fan mode: auto fan control */
7372
7373         TPACPI_FAN_LAST_LEVEL = 0x100,  /* Use cached last-seen fan level */
7374 };
7375
7376 enum fan_status_access_mode {
7377         TPACPI_FAN_NONE = 0,            /* No fan status or control */
7378         TPACPI_FAN_RD_ACPI_GFAN,        /* Use ACPI GFAN */
7379         TPACPI_FAN_RD_TPEC,             /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7380 };
7381
7382 enum fan_control_access_mode {
7383         TPACPI_FAN_WR_NONE = 0,         /* No fan control */
7384         TPACPI_FAN_WR_ACPI_SFAN,        /* Use ACPI SFAN */
7385         TPACPI_FAN_WR_TPEC,             /* Use ACPI EC reg 0x2f */
7386         TPACPI_FAN_WR_ACPI_FANS,        /* Use ACPI FANS and EC reg 0x2f */
7387 };
7388
7389 enum fan_control_commands {
7390         TPACPI_FAN_CMD_SPEED    = 0x0001,       /* speed command */
7391         TPACPI_FAN_CMD_LEVEL    = 0x0002,       /* level command  */
7392         TPACPI_FAN_CMD_ENABLE   = 0x0004,       /* enable/disable cmd,
7393                                                  * and also watchdog cmd */
7394 };
7395
7396 static bool fan_control_allowed;
7397
7398 static enum fan_status_access_mode fan_status_access_mode;
7399 static enum fan_control_access_mode fan_control_access_mode;
7400 static enum fan_control_commands fan_control_commands;
7401
7402 static u8 fan_control_initial_status;
7403 static u8 fan_control_desired_level;
7404 static u8 fan_control_resume_level;
7405 static int fan_watchdog_maxinterval;
7406
7407 static struct mutex fan_mutex;
7408
7409 static void fan_watchdog_fire(struct work_struct *ignored);
7410 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7411
7412 TPACPI_HANDLE(fans, ec, "FANS");        /* X31, X40, X41 */
7413 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7414            "\\FSPD",            /* 600e/x, 770e, 770x */
7415            );                   /* all others */
7416 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7417            "JFNS",              /* 770x-JL */
7418            );                   /* all others */
7419
7420 /*
7421  * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7422  * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7423  * be in auto mode (0x80).
7424  *
7425  * This is corrected by any write to HFSP either by the driver, or
7426  * by the firmware.
7427  *
7428  * We assume 0x07 really means auto mode while this quirk is active,
7429  * as this is far more likely than the ThinkPad being in level 7,
7430  * which is only used by the firmware during thermal emergencies.
7431  *
7432  * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7433  * TP-70 (T43, R52), which are known to be buggy.
7434  */
7435
7436 static void fan_quirk1_setup(void)
7437 {
7438         if (fan_control_initial_status == 0x07) {
7439                 pr_notice("fan_init: initial fan status is unknown, "
7440                           "assuming it is in auto mode\n");
7441                 tp_features.fan_ctrl_status_undef = 1;
7442         }
7443 }
7444
7445 static void fan_quirk1_handle(u8 *fan_status)
7446 {
7447         if (unlikely(tp_features.fan_ctrl_status_undef)) {
7448                 if (*fan_status != fan_control_initial_status) {
7449                         /* something changed the HFSP regisnter since
7450                          * driver init time, so it is not undefined
7451                          * anymore */
7452                         tp_features.fan_ctrl_status_undef = 0;
7453                 } else {
7454                         /* Return most likely status. In fact, it
7455                          * might be the only possible status */
7456                         *fan_status = TP_EC_FAN_AUTO;
7457                 }
7458         }
7459 }
7460
7461 /* Select main fan on X60/X61, NOOP on others */
7462 static bool fan_select_fan1(void)
7463 {
7464         if (tp_features.second_fan) {
7465                 u8 val;
7466
7467                 if (ec_read(fan_select_offset, &val) < 0)
7468                         return false;
7469                 val &= 0xFEU;
7470                 if (ec_write(fan_select_offset, val) < 0)
7471                         return false;
7472         }
7473         return true;
7474 }
7475
7476 /* Select secondary fan on X60/X61 */
7477 static bool fan_select_fan2(void)
7478 {
7479         u8 val;
7480
7481         if (!tp_features.second_fan)
7482                 return false;
7483
7484         if (ec_read(fan_select_offset, &val) < 0)
7485                 return false;
7486         val |= 0x01U;
7487         if (ec_write(fan_select_offset, val) < 0)
7488                 return false;
7489
7490         return true;
7491 }
7492
7493 /*
7494  * Call with fan_mutex held
7495  */
7496 static void fan_update_desired_level(u8 status)
7497 {
7498         if ((status &
7499              (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7500                 if (status > 7)
7501                         fan_control_desired_level = 7;
7502                 else
7503                         fan_control_desired_level = status;
7504         }
7505 }
7506
7507 static int fan_get_status(u8 *status)
7508 {
7509         u8 s;
7510
7511         /* TODO:
7512          * Add TPACPI_FAN_RD_ACPI_FANS ? */
7513
7514         switch (fan_status_access_mode) {
7515         case TPACPI_FAN_RD_ACPI_GFAN: {
7516                 /* 570, 600e/x, 770e, 770x */
7517                 int res;
7518
7519                 if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
7520                         return -EIO;
7521
7522                 if (likely(status))
7523                         *status = res & 0x07;
7524
7525                 break;
7526         }
7527         case TPACPI_FAN_RD_TPEC:
7528                 /* all except 570, 600e/x, 770e, 770x */
7529                 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7530                         return -EIO;
7531
7532                 if (likely(status)) {
7533                         *status = s;
7534                         fan_quirk1_handle(status);
7535                 }
7536
7537                 break;
7538
7539         default:
7540                 return -ENXIO;
7541         }
7542
7543         return 0;
7544 }
7545
7546 static int fan_get_status_safe(u8 *status)
7547 {
7548         int rc;
7549         u8 s;
7550
7551         if (mutex_lock_killable(&fan_mutex))
7552                 return -ERESTARTSYS;
7553         rc = fan_get_status(&s);
7554         if (!rc)
7555                 fan_update_desired_level(s);
7556         mutex_unlock(&fan_mutex);
7557
7558         if (status)
7559                 *status = s;
7560
7561         return rc;
7562 }
7563
7564 static int fan_get_speed(unsigned int *speed)
7565 {
7566         u8 hi, lo;
7567
7568         switch (fan_status_access_mode) {
7569         case TPACPI_FAN_RD_TPEC:
7570                 /* all except 570, 600e/x, 770e, 770x */
7571                 if (unlikely(!fan_select_fan1()))
7572                         return -EIO;
7573                 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7574                              !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7575                         return -EIO;
7576
7577                 if (likely(speed))
7578                         *speed = (hi << 8) | lo;
7579
7580                 break;
7581
7582         default:
7583                 return -ENXIO;
7584         }
7585
7586         return 0;
7587 }
7588
7589 static int fan2_get_speed(unsigned int *speed)
7590 {
7591         u8 hi, lo;
7592         bool rc;
7593
7594         switch (fan_status_access_mode) {
7595         case TPACPI_FAN_RD_TPEC:
7596                 /* all except 570, 600e/x, 770e, 770x */
7597                 if (unlikely(!fan_select_fan2()))
7598                         return -EIO;
7599                 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7600                              !acpi_ec_read(fan_rpm_offset + 1, &hi);
7601                 fan_select_fan1(); /* play it safe */
7602                 if (rc)
7603                         return -EIO;
7604
7605                 if (likely(speed))
7606                         *speed = (hi << 8) | lo;
7607
7608                 break;
7609
7610         default:
7611                 return -ENXIO;
7612         }
7613
7614         return 0;
7615 }
7616
7617 static int fan_set_level(int level)
7618 {
7619         if (!fan_control_allowed)
7620                 return -EPERM;
7621
7622         switch (fan_control_access_mode) {
7623         case TPACPI_FAN_WR_ACPI_SFAN:
7624                 if (level >= 0 && level <= 7) {
7625                         if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7626                                 return -EIO;
7627                 } else
7628                         return -EINVAL;
7629                 break;
7630
7631         case TPACPI_FAN_WR_ACPI_FANS:
7632         case TPACPI_FAN_WR_TPEC:
7633                 if (!(level & TP_EC_FAN_AUTO) &&
7634                     !(level & TP_EC_FAN_FULLSPEED) &&
7635                     ((level < 0) || (level > 7)))
7636                         return -EINVAL;
7637
7638                 /* safety net should the EC not support AUTO
7639                  * or FULLSPEED mode bits and just ignore them */
7640                 if (level & TP_EC_FAN_FULLSPEED)
7641                         level |= 7;     /* safety min speed 7 */
7642                 else if (level & TP_EC_FAN_AUTO)
7643                         level |= 4;     /* safety min speed 4 */
7644
7645                 if (!acpi_ec_write(fan_status_offset, level))
7646                         return -EIO;
7647                 else
7648                         tp_features.fan_ctrl_status_undef = 0;
7649                 break;
7650
7651         default:
7652                 return -ENXIO;
7653         }
7654
7655         vdbg_printk(TPACPI_DBG_FAN,
7656                 "fan control: set fan control register to 0x%02x\n", level);
7657         return 0;
7658 }
7659
7660 static int fan_set_level_safe(int level)
7661 {
7662         int rc;
7663
7664         if (!fan_control_allowed)
7665                 return -EPERM;
7666
7667         if (mutex_lock_killable(&fan_mutex))
7668                 return -ERESTARTSYS;
7669
7670         if (level == TPACPI_FAN_LAST_LEVEL)
7671                 level = fan_control_desired_level;
7672
7673         rc = fan_set_level(level);
7674         if (!rc)
7675                 fan_update_desired_level(level);
7676
7677         mutex_unlock(&fan_mutex);
7678         return rc;
7679 }
7680
7681 static int fan_set_enable(void)
7682 {
7683         u8 s;
7684         int rc;
7685
7686         if (!fan_control_allowed)
7687                 return -EPERM;
7688
7689         if (mutex_lock_killable(&fan_mutex))
7690                 return -ERESTARTSYS;
7691
7692         switch (fan_control_access_mode) {
7693         case TPACPI_FAN_WR_ACPI_FANS:
7694         case TPACPI_FAN_WR_TPEC:
7695                 rc = fan_get_status(&s);
7696                 if (rc < 0)
7697                         break;
7698
7699                 /* Don't go out of emergency fan mode */
7700                 if (s != 7) {
7701                         s &= 0x07;
7702                         s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7703                 }
7704
7705                 if (!acpi_ec_write(fan_status_offset, s))
7706                         rc = -EIO;
7707                 else {
7708                         tp_features.fan_ctrl_status_undef = 0;
7709                         rc = 0;
7710                 }
7711                 break;
7712
7713         case TPACPI_FAN_WR_ACPI_SFAN:
7714                 rc = fan_get_status(&s);
7715                 if (rc < 0)
7716                         break;
7717
7718                 s &= 0x07;
7719
7720                 /* Set fan to at least level 4 */
7721                 s |= 4;
7722
7723                 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7724                         rc = -EIO;
7725                 else
7726                         rc = 0;
7727                 break;
7728
7729         default:
7730                 rc = -ENXIO;
7731         }
7732
7733         mutex_unlock(&fan_mutex);
7734
7735         if (!rc)
7736                 vdbg_printk(TPACPI_DBG_FAN,
7737                         "fan control: set fan control register to 0x%02x\n",
7738                         s);
7739         return rc;
7740 }
7741
7742 static int fan_set_disable(void)
7743 {
7744         int rc;
7745
7746         if (!fan_control_allowed)
7747                 return -EPERM;
7748
7749         if (mutex_lock_killable(&fan_mutex))
7750                 return -ERESTARTSYS;
7751
7752         rc = 0;
7753         switch (fan_control_access_mode) {
7754         case TPACPI_FAN_WR_ACPI_FANS:
7755         case TPACPI_FAN_WR_TPEC:
7756                 if (!acpi_ec_write(fan_status_offset, 0x00))
7757                         rc = -EIO;
7758                 else {
7759                         fan_control_desired_level = 0;
7760                         tp_features.fan_ctrl_status_undef = 0;
7761                 }
7762                 break;
7763
7764         case TPACPI_FAN_WR_ACPI_SFAN:
7765                 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7766                         rc = -EIO;
7767                 else
7768                         fan_control_desired_level = 0;
7769                 break;
7770
7771         default:
7772                 rc = -ENXIO;
7773         }
7774
7775         if (!rc)
7776                 vdbg_printk(TPACPI_DBG_FAN,
7777                         "fan control: set fan control register to 0\n");
7778
7779         mutex_unlock(&fan_mutex);
7780         return rc;
7781 }
7782
7783 static int fan_set_speed(int speed)
7784 {
7785         int rc;
7786
7787         if (!fan_control_allowed)
7788                 return -EPERM;
7789
7790         if (mutex_lock_killable(&fan_mutex))
7791                 return -ERESTARTSYS;
7792
7793         rc = 0;
7794         switch (fan_control_access_mode) {
7795         case TPACPI_FAN_WR_ACPI_FANS:
7796                 if (speed >= 0 && speed <= 65535) {
7797                         if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7798                                         speed, speed, speed))
7799                                 rc = -EIO;
7800                 } else
7801                         rc = -EINVAL;
7802                 break;
7803
7804         default:
7805                 rc = -ENXIO;
7806         }
7807
7808         mutex_unlock(&fan_mutex);
7809         return rc;
7810 }
7811
7812 static void fan_watchdog_reset(void)
7813 {
7814         if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7815                 return;
7816
7817         if (fan_watchdog_maxinterval > 0 &&
7818             tpacpi_lifecycle != TPACPI_LIFE_EXITING)
7819                 mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
7820                         msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
7821         else
7822                 cancel_delayed_work(&fan_watchdog_task);
7823 }
7824
7825 static void fan_watchdog_fire(struct work_struct *ignored)
7826 {
7827         int rc;
7828
7829         if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7830                 return;
7831
7832         pr_notice("fan watchdog: enabling fan\n");
7833         rc = fan_set_enable();
7834         if (rc < 0) {
7835                 pr_err("fan watchdog: error %d while enabling fan, "
7836                        "will try again later...\n", -rc);
7837                 /* reschedule for later */
7838                 fan_watchdog_reset();
7839         }
7840 }
7841
7842 /*
7843  * SYSFS fan layout: hwmon compatible (device)
7844  *
7845  * pwm*_enable:
7846  *      0: "disengaged" mode
7847  *      1: manual mode
7848  *      2: native EC "auto" mode (recommended, hardware default)
7849  *
7850  * pwm*: set speed in manual mode, ignored otherwise.
7851  *      0 is level 0; 255 is level 7. Intermediate points done with linear
7852  *      interpolation.
7853  *
7854  * fan*_input: tachometer reading, RPM
7855  *
7856  *
7857  * SYSFS fan layout: extensions
7858  *
7859  * fan_watchdog (driver):
7860  *      fan watchdog interval in seconds, 0 disables (default), max 120
7861  */
7862
7863 /* sysfs fan pwm1_enable ----------------------------------------------- */
7864 static ssize_t fan_pwm1_enable_show(struct device *dev,
7865                                     struct device_attribute *attr,
7866                                     char *buf)
7867 {
7868         int res, mode;
7869         u8 status;
7870
7871         res = fan_get_status_safe(&status);
7872         if (res)
7873                 return res;
7874
7875         if (status & TP_EC_FAN_FULLSPEED) {
7876                 mode = 0;
7877         } else if (status & TP_EC_FAN_AUTO) {
7878                 mode = 2;
7879         } else
7880                 mode = 1;
7881
7882         return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7883 }
7884
7885 static ssize_t fan_pwm1_enable_store(struct device *dev,
7886                                      struct device_attribute *attr,
7887                                      const char *buf, size_t count)
7888 {
7889         unsigned long t;
7890         int res, level;
7891
7892         if (parse_strtoul(buf, 2, &t))
7893                 return -EINVAL;
7894
7895         tpacpi_disclose_usertask("hwmon pwm1_enable",
7896                         "set fan mode to %lu\n", t);
7897
7898         switch (t) {
7899         case 0:
7900                 level = TP_EC_FAN_FULLSPEED;
7901                 break;
7902         case 1:
7903                 level = TPACPI_FAN_LAST_LEVEL;
7904                 break;
7905         case 2:
7906                 level = TP_EC_FAN_AUTO;
7907                 break;
7908         case 3:
7909                 /* reserved for software-controlled auto mode */
7910                 return -ENOSYS;
7911         default:
7912                 return -EINVAL;
7913         }
7914
7915         res = fan_set_level_safe(level);
7916         if (res == -ENXIO)
7917                 return -EINVAL;
7918         else if (res < 0)
7919                 return res;
7920
7921         fan_watchdog_reset();
7922
7923         return count;
7924 }
7925
7926 static struct device_attribute dev_attr_fan_pwm1_enable =
7927         __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7928                 fan_pwm1_enable_show, fan_pwm1_enable_store);
7929
7930 /* sysfs fan pwm1 ------------------------------------------------------ */
7931 static ssize_t fan_pwm1_show(struct device *dev,
7932                              struct device_attribute *attr,
7933                              char *buf)
7934 {
7935         int res;
7936         u8 status;
7937
7938         res = fan_get_status_safe(&status);
7939         if (res)
7940                 return res;
7941
7942         if ((status &
7943              (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7944                 status = fan_control_desired_level;
7945
7946         if (status > 7)
7947                 status = 7;
7948
7949         return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7950 }
7951
7952 static ssize_t fan_pwm1_store(struct device *dev,
7953                               struct device_attribute *attr,
7954                               const char *buf, size_t count)
7955 {
7956         unsigned long s;
7957         int rc;
7958         u8 status, newlevel;
7959
7960         if (parse_strtoul(buf, 255, &s))
7961                 return -EINVAL;
7962
7963         tpacpi_disclose_usertask("hwmon pwm1",
7964                         "set fan speed to %lu\n", s);
7965
7966         /* scale down from 0-255 to 0-7 */
7967         newlevel = (s >> 5) & 0x07;
7968
7969         if (mutex_lock_killable(&fan_mutex))
7970                 return -ERESTARTSYS;
7971
7972         rc = fan_get_status(&status);
7973         if (!rc && (status &
7974                     (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7975                 rc = fan_set_level(newlevel);
7976                 if (rc == -ENXIO)
7977                         rc = -EINVAL;
7978                 else if (!rc) {
7979                         fan_update_desired_level(newlevel);
7980                         fan_watchdog_reset();
7981                 }
7982         }
7983
7984         mutex_unlock(&fan_mutex);
7985         return (rc)? rc : count;
7986 }
7987
7988 static struct device_attribute dev_attr_fan_pwm1 =
7989         __ATTR(pwm1, S_IWUSR | S_IRUGO,
7990                 fan_pwm1_show, fan_pwm1_store);
7991
7992 /* sysfs fan fan1_input ------------------------------------------------ */
7993 static ssize_t fan_fan1_input_show(struct device *dev,
7994                            struct device_attribute *attr,
7995                            char *buf)
7996 {
7997         int res;
7998         unsigned int speed;
7999
8000         res = fan_get_speed(&speed);
8001         if (res < 0)
8002                 return res;
8003
8004         return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8005 }
8006
8007 static struct device_attribute dev_attr_fan_fan1_input =
8008         __ATTR(fan1_input, S_IRUGO,
8009                 fan_fan1_input_show, NULL);
8010
8011 /* sysfs fan fan2_input ------------------------------------------------ */
8012 static ssize_t fan_fan2_input_show(struct device *dev,
8013                            struct device_attribute *attr,
8014                            char *buf)
8015 {
8016         int res;
8017         unsigned int speed;
8018
8019         res = fan2_get_speed(&speed);
8020         if (res < 0)
8021                 return res;
8022
8023         return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8024 }
8025
8026 static struct device_attribute dev_attr_fan_fan2_input =
8027         __ATTR(fan2_input, S_IRUGO,
8028                 fan_fan2_input_show, NULL);
8029
8030 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8031 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
8032                                      char *buf)
8033 {
8034         return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
8035 }
8036
8037 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
8038                                       const char *buf, size_t count)
8039 {
8040         unsigned long t;
8041
8042         if (parse_strtoul(buf, 120, &t))
8043                 return -EINVAL;
8044
8045         if (!fan_control_allowed)
8046                 return -EPERM;
8047
8048         fan_watchdog_maxinterval = t;
8049         fan_watchdog_reset();
8050
8051         tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8052
8053         return count;
8054 }
8055
8056 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
8057                 fan_fan_watchdog_show, fan_fan_watchdog_store);
8058
8059 /* --------------------------------------------------------------------- */
8060 static struct attribute *fan_attributes[] = {
8061         &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
8062         &dev_attr_fan_fan1_input.attr,
8063         NULL, /* for fan2_input */
8064         NULL
8065 };
8066
8067 static const struct attribute_group fan_attr_group = {
8068         .attrs = fan_attributes,
8069 };
8070
8071 #define TPACPI_FAN_Q1   0x0001          /* Unitialized HFSP */
8072 #define TPACPI_FAN_2FAN 0x0002          /* EC 0x31 bit 0 selects fan2 */
8073
8074 #define TPACPI_FAN_QI(__id1, __id2, __quirks)   \
8075         { .vendor = PCI_VENDOR_ID_IBM,          \
8076           .bios = TPACPI_MATCH_ANY,             \
8077           .ec = TPID(__id1, __id2),             \
8078           .quirks = __quirks }
8079
8080 #define TPACPI_FAN_QL(__id1, __id2, __quirks)   \
8081         { .vendor = PCI_VENDOR_ID_LENOVO,       \
8082           .bios = TPACPI_MATCH_ANY,             \
8083           .ec = TPID(__id1, __id2),             \
8084           .quirks = __quirks }
8085
8086 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8087         TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
8088         TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
8089         TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
8090         TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
8091         TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
8092 };
8093
8094 #undef TPACPI_FAN_QL
8095 #undef TPACPI_FAN_QI
8096
8097 static int __init fan_init(struct ibm_init_struct *iibm)
8098 {
8099         int rc;
8100         unsigned long quirks;
8101
8102         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8103                         "initializing fan subdriver\n");
8104
8105         mutex_init(&fan_mutex);
8106         fan_status_access_mode = TPACPI_FAN_NONE;
8107         fan_control_access_mode = TPACPI_FAN_WR_NONE;
8108         fan_control_commands = 0;
8109         fan_watchdog_maxinterval = 0;
8110         tp_features.fan_ctrl_status_undef = 0;
8111         tp_features.second_fan = 0;
8112         fan_control_desired_level = 7;
8113
8114         if (tpacpi_is_ibm()) {
8115                 TPACPI_ACPIHANDLE_INIT(fans);
8116                 TPACPI_ACPIHANDLE_INIT(gfan);
8117                 TPACPI_ACPIHANDLE_INIT(sfan);
8118         }
8119
8120         quirks = tpacpi_check_quirks(fan_quirk_table,
8121                                      ARRAY_SIZE(fan_quirk_table));
8122
8123         if (gfan_handle) {
8124                 /* 570, 600e/x, 770e, 770x */
8125                 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8126         } else {
8127                 /* all other ThinkPads: note that even old-style
8128                  * ThinkPad ECs supports the fan control register */
8129                 if (likely(acpi_ec_read(fan_status_offset,
8130                                         &fan_control_initial_status))) {
8131                         fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8132                         if (quirks & TPACPI_FAN_Q1)
8133                                 fan_quirk1_setup();
8134                         if (quirks & TPACPI_FAN_2FAN) {
8135                                 tp_features.second_fan = 1;
8136                                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8137                                         "secondary fan support enabled\n");
8138                         }
8139                 } else {
8140                         pr_err("ThinkPad ACPI EC access misbehaving, "
8141                                "fan status and control unavailable\n");
8142                         return 1;
8143                 }
8144         }
8145
8146         if (sfan_handle) {
8147                 /* 570, 770x-JL */
8148                 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8149                 fan_control_commands |=
8150                     TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8151         } else {
8152                 if (!gfan_handle) {
8153                         /* gfan without sfan means no fan control */
8154                         /* all other models implement TP EC 0x2f control */
8155
8156                         if (fans_handle) {
8157                                 /* X31, X40, X41 */
8158                                 fan_control_access_mode =
8159                                     TPACPI_FAN_WR_ACPI_FANS;
8160                                 fan_control_commands |=
8161                                     TPACPI_FAN_CMD_SPEED |
8162                                     TPACPI_FAN_CMD_LEVEL |
8163                                     TPACPI_FAN_CMD_ENABLE;
8164                         } else {
8165                                 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8166                                 fan_control_commands |=
8167                                     TPACPI_FAN_CMD_LEVEL |
8168                                     TPACPI_FAN_CMD_ENABLE;
8169                         }
8170                 }
8171         }
8172
8173         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8174                 "fan is %s, modes %d, %d\n",
8175                 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8176                   fan_control_access_mode != TPACPI_FAN_WR_NONE),
8177                 fan_status_access_mode, fan_control_access_mode);
8178
8179         /* fan control master switch */
8180         if (!fan_control_allowed) {
8181                 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8182                 fan_control_commands = 0;
8183                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8184                            "fan control features disabled by parameter\n");
8185         }
8186
8187         /* update fan_control_desired_level */
8188         if (fan_status_access_mode != TPACPI_FAN_NONE)
8189                 fan_get_status_safe(NULL);
8190
8191         if (fan_status_access_mode != TPACPI_FAN_NONE ||
8192             fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8193                 if (tp_features.second_fan) {
8194                         /* attach second fan tachometer */
8195                         fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8196                                         &dev_attr_fan_fan2_input.attr;
8197                 }
8198                 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8199                                          &fan_attr_group);
8200                 if (rc < 0)
8201                         return rc;
8202
8203                 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8204                                         &driver_attr_fan_watchdog);
8205                 if (rc < 0) {
8206                         sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8207                                         &fan_attr_group);
8208                         return rc;
8209                 }
8210                 return 0;
8211         } else
8212                 return 1;
8213 }
8214
8215 static void fan_exit(void)
8216 {
8217         vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8218                     "cancelling any pending fan watchdog tasks\n");
8219
8220         /* FIXME: can we really do this unconditionally? */
8221         sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8222         driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8223                            &driver_attr_fan_watchdog);
8224
8225         cancel_delayed_work(&fan_watchdog_task);
8226         flush_workqueue(tpacpi_wq);
8227 }
8228
8229 static void fan_suspend(void)
8230 {
8231         int rc;
8232
8233         if (!fan_control_allowed)
8234                 return;
8235
8236         /* Store fan status in cache */
8237         fan_control_resume_level = 0;
8238         rc = fan_get_status_safe(&fan_control_resume_level);
8239         if (rc < 0)
8240                 pr_notice("failed to read fan level for later "
8241                           "restore during resume: %d\n", rc);
8242
8243         /* if it is undefined, don't attempt to restore it.
8244          * KEEP THIS LAST */
8245         if (tp_features.fan_ctrl_status_undef)
8246                 fan_control_resume_level = 0;
8247 }
8248
8249 static void fan_resume(void)
8250 {
8251         u8 current_level = 7;
8252         bool do_set = false;
8253         int rc;
8254
8255         /* DSDT *always* updates status on resume */
8256         tp_features.fan_ctrl_status_undef = 0;
8257
8258         if (!fan_control_allowed ||
8259             !fan_control_resume_level ||
8260             (fan_get_status_safe(&current_level) < 0))
8261                 return;
8262
8263         switch (fan_control_access_mode) {
8264         case TPACPI_FAN_WR_ACPI_SFAN:
8265                 /* never decrease fan level */
8266                 do_set = (fan_control_resume_level > current_level);
8267                 break;
8268         case TPACPI_FAN_WR_ACPI_FANS:
8269         case TPACPI_FAN_WR_TPEC:
8270                 /* never decrease fan level, scale is:
8271                  * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8272                  *
8273                  * We expect the firmware to set either 7 or AUTO, but we
8274                  * handle FULLSPEED out of paranoia.
8275                  *
8276                  * So, we can safely only restore FULLSPEED or 7, anything
8277                  * else could slow the fan.  Restoring AUTO is useless, at
8278                  * best that's exactly what the DSDT already set (it is the
8279                  * slower it uses).
8280                  *
8281                  * Always keep in mind that the DSDT *will* have set the
8282                  * fans to what the vendor supposes is the best level.  We
8283                  * muck with it only to speed the fan up.
8284                  */
8285                 if (fan_control_resume_level != 7 &&
8286                     !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8287                         return;
8288                 else
8289                         do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8290                                  (current_level != fan_control_resume_level);
8291                 break;
8292         default:
8293                 return;
8294         }
8295         if (do_set) {
8296                 pr_notice("restoring fan level to 0x%02x\n",
8297                           fan_control_resume_level);
8298                 rc = fan_set_level_safe(fan_control_resume_level);
8299                 if (rc < 0)
8300                         pr_notice("failed to restore fan level: %d\n", rc);
8301         }
8302 }
8303
8304 static int fan_read(struct seq_file *m)
8305 {
8306         int rc;
8307         u8 status;
8308         unsigned int speed = 0;
8309
8310         switch (fan_status_access_mode) {
8311         case TPACPI_FAN_RD_ACPI_GFAN:
8312                 /* 570, 600e/x, 770e, 770x */
8313                 rc = fan_get_status_safe(&status);
8314                 if (rc < 0)
8315                         return rc;
8316
8317                 seq_printf(m, "status:\t\t%s\n"
8318                                "level:\t\t%d\n",
8319                                (status != 0) ? "enabled" : "disabled", status);
8320                 break;
8321
8322         case TPACPI_FAN_RD_TPEC:
8323                 /* all except 570, 600e/x, 770e, 770x */
8324                 rc = fan_get_status_safe(&status);
8325                 if (rc < 0)
8326                         return rc;
8327
8328                 seq_printf(m, "status:\t\t%s\n",
8329                                (status != 0) ? "enabled" : "disabled");
8330
8331                 rc = fan_get_speed(&speed);
8332                 if (rc < 0)
8333                         return rc;
8334
8335                 seq_printf(m, "speed:\t\t%d\n", speed);
8336
8337                 if (status & TP_EC_FAN_FULLSPEED)
8338                         /* Disengaged mode takes precedence */
8339                         seq_printf(m, "level:\t\tdisengaged\n");
8340                 else if (status & TP_EC_FAN_AUTO)
8341                         seq_printf(m, "level:\t\tauto\n");
8342                 else
8343                         seq_printf(m, "level:\t\t%d\n", status);
8344                 break;
8345
8346         case TPACPI_FAN_NONE:
8347         default:
8348                 seq_printf(m, "status:\t\tnot supported\n");
8349         }
8350
8351         if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8352                 seq_printf(m, "commands:\tlevel <level>");
8353
8354                 switch (fan_control_access_mode) {
8355                 case TPACPI_FAN_WR_ACPI_SFAN:
8356                         seq_printf(m, " (<level> is 0-7)\n");
8357                         break;
8358
8359                 default:
8360                         seq_printf(m, " (<level> is 0-7, "
8361                                        "auto, disengaged, full-speed)\n");
8362                         break;
8363                 }
8364         }
8365
8366         if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8367                 seq_printf(m, "commands:\tenable, disable\n"
8368                                "commands:\twatchdog <timeout> (<timeout> "
8369                                "is 0 (off), 1-120 (seconds))\n");
8370
8371         if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8372                 seq_printf(m, "commands:\tspeed <speed>"
8373                                " (<speed> is 0-65535)\n");
8374
8375         return 0;
8376 }
8377
8378 static int fan_write_cmd_level(const char *cmd, int *rc)
8379 {
8380         int level;
8381
8382         if (strlencmp(cmd, "level auto") == 0)
8383                 level = TP_EC_FAN_AUTO;
8384         else if ((strlencmp(cmd, "level disengaged") == 0) |
8385                         (strlencmp(cmd, "level full-speed") == 0))
8386                 level = TP_EC_FAN_FULLSPEED;
8387         else if (sscanf(cmd, "level %d", &level) != 1)
8388                 return 0;
8389
8390         *rc = fan_set_level_safe(level);
8391         if (*rc == -ENXIO)
8392                 pr_err("level command accepted for unsupported access mode %d\n",
8393                        fan_control_access_mode);
8394         else if (!*rc)
8395                 tpacpi_disclose_usertask("procfs fan",
8396                         "set level to %d\n", level);
8397
8398         return 1;
8399 }
8400
8401 static int fan_write_cmd_enable(const char *cmd, int *rc)
8402 {
8403         if (strlencmp(cmd, "enable") != 0)
8404                 return 0;
8405
8406         *rc = fan_set_enable();
8407         if (*rc == -ENXIO)
8408                 pr_err("enable command accepted for unsupported access mode %d\n",
8409                        fan_control_access_mode);
8410         else if (!*rc)
8411                 tpacpi_disclose_usertask("procfs fan", "enable\n");
8412
8413         return 1;
8414 }
8415
8416 static int fan_write_cmd_disable(const char *cmd, int *rc)
8417 {
8418         if (strlencmp(cmd, "disable") != 0)
8419                 return 0;
8420
8421         *rc = fan_set_disable();
8422         if (*rc == -ENXIO)
8423                 pr_err("disable command accepted for unsupported access mode %d\n",
8424                        fan_control_access_mode);
8425         else if (!*rc)
8426                 tpacpi_disclose_usertask("procfs fan", "disable\n");
8427
8428         return 1;
8429 }
8430
8431 static int fan_write_cmd_speed(const char *cmd, int *rc)
8432 {
8433         int speed;
8434
8435         /* TODO:
8436          * Support speed <low> <medium> <high> ? */
8437
8438         if (sscanf(cmd, "speed %d", &speed) != 1)
8439                 return 0;
8440
8441         *rc = fan_set_speed(speed);
8442         if (*rc == -ENXIO)
8443                 pr_err("speed command accepted for unsupported access mode %d\n",
8444                        fan_control_access_mode);
8445         else if (!*rc)
8446                 tpacpi_disclose_usertask("procfs fan",
8447                         "set speed to %d\n", speed);
8448
8449         return 1;
8450 }
8451
8452 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8453 {
8454         int interval;
8455
8456         if (sscanf(cmd, "watchdog %d", &interval) != 1)
8457                 return 0;
8458
8459         if (interval < 0 || interval > 120)
8460                 *rc = -EINVAL;
8461         else {
8462                 fan_watchdog_maxinterval = interval;
8463                 tpacpi_disclose_usertask("procfs fan",
8464                         "set watchdog timer to %d\n",
8465                         interval);
8466         }
8467
8468         return 1;
8469 }
8470
8471 static int fan_write(char *buf)
8472 {
8473         char *cmd;
8474         int rc = 0;
8475
8476         while (!rc && (cmd = next_cmd(&buf))) {
8477                 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8478                       fan_write_cmd_level(cmd, &rc)) &&
8479                     !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8480                       (fan_write_cmd_enable(cmd, &rc) ||
8481                        fan_write_cmd_disable(cmd, &rc) ||
8482                        fan_write_cmd_watchdog(cmd, &rc))) &&
8483                     !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8484                       fan_write_cmd_speed(cmd, &rc))
8485                     )
8486                         rc = -EINVAL;
8487                 else if (!rc)
8488                         fan_watchdog_reset();
8489         }
8490
8491         return rc;
8492 }
8493
8494 static struct ibm_struct fan_driver_data = {
8495         .name = "fan",
8496         .read = fan_read,
8497         .write = fan_write,
8498         .exit = fan_exit,
8499         .suspend = fan_suspend,
8500         .resume = fan_resume,
8501 };
8502
8503 /*************************************************************************
8504  * Mute LED subdriver
8505  */
8506
8507
8508 struct tp_led_table {
8509         acpi_string name;
8510         int on_value;
8511         int off_value;
8512         int state;
8513 };
8514
8515 static struct tp_led_table led_tables[] = {
8516         [TPACPI_LED_MUTE] = {
8517                 .name = "SSMS",
8518                 .on_value = 1,
8519                 .off_value = 0,
8520         },
8521         [TPACPI_LED_MICMUTE] = {
8522                 .name = "MMTS",
8523                 .on_value = 2,
8524                 .off_value = 0,
8525         },
8526 };
8527
8528 static int mute_led_on_off(struct tp_led_table *t, bool state)
8529 {
8530         acpi_handle temp;
8531         int output;
8532
8533         if (!ACPI_SUCCESS(acpi_get_handle(hkey_handle, t->name, &temp))) {
8534                 pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
8535                 return -EIO;
8536         }
8537
8538         if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
8539                         state ? t->on_value : t->off_value))
8540                 return -EIO;
8541
8542         t->state = state;
8543         return state;
8544 }
8545
8546 int tpacpi_led_set(int whichled, bool on)
8547 {
8548         struct tp_led_table *t;
8549
8550         if (whichled < 0 || whichled >= TPACPI_LED_MAX)
8551                 return -EINVAL;
8552
8553         t = &led_tables[whichled];
8554         if (t->state < 0 || t->state == on)
8555                 return t->state;
8556         return mute_led_on_off(t, on);
8557 }
8558 EXPORT_SYMBOL_GPL(tpacpi_led_set);
8559
8560 static int mute_led_init(struct ibm_init_struct *iibm)
8561 {
8562         acpi_handle temp;
8563         int i;
8564
8565         for (i = 0; i < TPACPI_LED_MAX; i++) {
8566                 struct tp_led_table *t = &led_tables[i];
8567                 if (ACPI_SUCCESS(acpi_get_handle(hkey_handle, t->name, &temp)))
8568                         mute_led_on_off(t, false);
8569                 else
8570                         t->state = -ENODEV;
8571         }
8572         return 0;
8573 }
8574
8575 static void mute_led_exit(void)
8576 {
8577         int i;
8578
8579         for (i = 0; i < TPACPI_LED_MAX; i++)
8580                 tpacpi_led_set(i, false);
8581 }
8582
8583 static void mute_led_resume(void)
8584 {
8585         int i;
8586
8587         for (i = 0; i < TPACPI_LED_MAX; i++) {
8588                 struct tp_led_table *t = &led_tables[i];
8589                 if (t->state >= 0)
8590                         mute_led_on_off(t, t->state);
8591         }
8592 }
8593
8594 static struct ibm_struct mute_led_driver_data = {
8595         .name = "mute_led",
8596         .exit = mute_led_exit,
8597         .resume = mute_led_resume,
8598 };
8599
8600 /****************************************************************************
8601  ****************************************************************************
8602  *
8603  * Infrastructure
8604  *
8605  ****************************************************************************
8606  ****************************************************************************/
8607
8608 /*
8609  * HKEY event callout for other subdrivers go here
8610  * (yes, it is ugly, but it is quick, safe, and gets the job done
8611  */
8612 static void tpacpi_driver_event(const unsigned int hkey_event)
8613 {
8614         if (ibm_backlight_device) {
8615                 switch (hkey_event) {
8616                 case TP_HKEY_EV_BRGHT_UP:
8617                 case TP_HKEY_EV_BRGHT_DOWN:
8618                         tpacpi_brightness_notify_change();
8619                 }
8620         }
8621         if (alsa_card) {
8622                 switch (hkey_event) {
8623                 case TP_HKEY_EV_VOL_UP:
8624                 case TP_HKEY_EV_VOL_DOWN:
8625                 case TP_HKEY_EV_VOL_MUTE:
8626                         volume_alsa_notify_change();
8627                 }
8628         }
8629 }
8630
8631 static void hotkey_driver_event(const unsigned int scancode)
8632 {
8633         tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8634 }
8635
8636 /* sysfs name ---------------------------------------------------------- */
8637 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8638                            struct device_attribute *attr,
8639                            char *buf)
8640 {
8641         return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8642 }
8643
8644 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8645         __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8646
8647 /* --------------------------------------------------------------------- */
8648
8649 /* /proc support */
8650 static struct proc_dir_entry *proc_dir;
8651
8652 /*
8653  * Module and infrastructure proble, init and exit handling
8654  */
8655
8656 static bool force_load;
8657
8658 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
8659 static const char * __init str_supported(int is_supported)
8660 {
8661         static char text_unsupported[] __initdata = "not supported";
8662
8663         return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8664 }
8665 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8666
8667 static void ibm_exit(struct ibm_struct *ibm)
8668 {
8669         dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8670
8671         list_del_init(&ibm->all_drivers);
8672
8673         if (ibm->flags.acpi_notify_installed) {
8674                 dbg_printk(TPACPI_DBG_EXIT,
8675                         "%s: acpi_remove_notify_handler\n", ibm->name);
8676                 BUG_ON(!ibm->acpi);
8677                 acpi_remove_notify_handler(*ibm->acpi->handle,
8678                                            ibm->acpi->type,
8679                                            dispatch_acpi_notify);
8680                 ibm->flags.acpi_notify_installed = 0;
8681         }
8682
8683         if (ibm->flags.proc_created) {
8684                 dbg_printk(TPACPI_DBG_EXIT,
8685                         "%s: remove_proc_entry\n", ibm->name);
8686                 remove_proc_entry(ibm->name, proc_dir);
8687                 ibm->flags.proc_created = 0;
8688         }
8689
8690         if (ibm->flags.acpi_driver_registered) {
8691                 dbg_printk(TPACPI_DBG_EXIT,
8692                         "%s: acpi_bus_unregister_driver\n", ibm->name);
8693                 BUG_ON(!ibm->acpi);
8694                 acpi_bus_unregister_driver(ibm->acpi->driver);
8695                 kfree(ibm->acpi->driver);
8696                 ibm->acpi->driver = NULL;
8697                 ibm->flags.acpi_driver_registered = 0;
8698         }
8699
8700         if (ibm->flags.init_called && ibm->exit) {
8701                 ibm->exit();
8702                 ibm->flags.init_called = 0;
8703         }
8704
8705         dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8706 }
8707
8708 static int __init ibm_init(struct ibm_init_struct *iibm)
8709 {
8710         int ret;
8711         struct ibm_struct *ibm = iibm->data;
8712         struct proc_dir_entry *entry;
8713
8714         BUG_ON(ibm == NULL);
8715
8716         INIT_LIST_HEAD(&ibm->all_drivers);
8717
8718         if (ibm->flags.experimental && !experimental)
8719                 return 0;
8720
8721         dbg_printk(TPACPI_DBG_INIT,
8722                 "probing for %s\n", ibm->name);
8723
8724         if (iibm->init) {
8725                 ret = iibm->init(iibm);
8726                 if (ret > 0)
8727                         return 0;       /* probe failed */
8728                 if (ret)
8729                         return ret;
8730
8731                 ibm->flags.init_called = 1;
8732         }
8733
8734         if (ibm->acpi) {
8735                 if (ibm->acpi->hid) {
8736                         ret = register_tpacpi_subdriver(ibm);
8737                         if (ret)
8738                                 goto err_out;
8739                 }
8740
8741                 if (ibm->acpi->notify) {
8742                         ret = setup_acpi_notify(ibm);
8743                         if (ret == -ENODEV) {
8744                                 pr_notice("disabling subdriver %s\n",
8745                                           ibm->name);
8746                                 ret = 0;
8747                                 goto err_out;
8748                         }
8749                         if (ret < 0)
8750                                 goto err_out;
8751                 }
8752         }
8753
8754         dbg_printk(TPACPI_DBG_INIT,
8755                 "%s installed\n", ibm->name);
8756
8757         if (ibm->read) {
8758                 umode_t mode = iibm->base_procfs_mode;
8759
8760                 if (!mode)
8761                         mode = S_IRUGO;
8762                 if (ibm->write)
8763                         mode |= S_IWUSR;
8764                 entry = proc_create_data(ibm->name, mode, proc_dir,
8765                                          &dispatch_proc_fops, ibm);
8766                 if (!entry) {
8767                         pr_err("unable to create proc entry %s\n", ibm->name);
8768                         ret = -ENODEV;
8769                         goto err_out;
8770                 }
8771                 ibm->flags.proc_created = 1;
8772         }
8773
8774         list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8775
8776         return 0;
8777
8778 err_out:
8779         dbg_printk(TPACPI_DBG_INIT,
8780                 "%s: at error exit path with result %d\n",
8781                 ibm->name, ret);
8782
8783         ibm_exit(ibm);
8784         return (ret < 0)? ret : 0;
8785 }
8786
8787 /* Probing */
8788
8789 static bool __pure __init tpacpi_is_fw_digit(const char c)
8790 {
8791         return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8792 }
8793
8794 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8795 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8796                                                 const char t)
8797 {
8798         return s && strlen(s) >= 8 &&
8799                 tpacpi_is_fw_digit(s[0]) &&
8800                 tpacpi_is_fw_digit(s[1]) &&
8801                 s[2] == t &&
8802                 (s[3] == 'T' || s[3] == 'N') &&
8803                 tpacpi_is_fw_digit(s[4]) &&
8804                 tpacpi_is_fw_digit(s[5]);
8805 }
8806
8807 /* returns 0 - probe ok, or < 0 - probe error.
8808  * Probe ok doesn't mean thinkpad found.
8809  * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8810 static int __must_check __init get_thinkpad_model_data(
8811                                                 struct thinkpad_id_data *tp)
8812 {
8813         const struct dmi_device *dev = NULL;
8814         char ec_fw_string[18];
8815         char const *s;
8816
8817         if (!tp)
8818                 return -EINVAL;
8819
8820         memset(tp, 0, sizeof(*tp));
8821
8822         if (dmi_name_in_vendors("IBM"))
8823                 tp->vendor = PCI_VENDOR_ID_IBM;
8824         else if (dmi_name_in_vendors("LENOVO"))
8825                 tp->vendor = PCI_VENDOR_ID_LENOVO;
8826         else
8827                 return 0;
8828
8829         s = dmi_get_system_info(DMI_BIOS_VERSION);
8830         tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8831         if (s && !tp->bios_version_str)
8832                 return -ENOMEM;
8833
8834         /* Really ancient ThinkPad 240X will fail this, which is fine */
8835         if (!(tpacpi_is_valid_fw_id(tp->bios_version_str, 'E') ||
8836               tpacpi_is_valid_fw_id(tp->bios_version_str, 'C')))
8837                 return 0;
8838
8839         tp->bios_model = tp->bios_version_str[0]
8840                          | (tp->bios_version_str[1] << 8);
8841         tp->bios_release = (tp->bios_version_str[4] << 8)
8842                          | tp->bios_version_str[5];
8843
8844         /*
8845          * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8846          * X32 or newer, all Z series;  Some models must have an
8847          * up-to-date BIOS or they will not be detected.
8848          *
8849          * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8850          */
8851         while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8852                 if (sscanf(dev->name,
8853                            "IBM ThinkPad Embedded Controller -[%17c",
8854                            ec_fw_string) == 1) {
8855                         ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8856                         ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8857
8858                         tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8859                         if (!tp->ec_version_str)
8860                                 return -ENOMEM;
8861
8862                         if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8863                                 tp->ec_model = ec_fw_string[0]
8864                                                 | (ec_fw_string[1] << 8);
8865                                 tp->ec_release = (ec_fw_string[4] << 8)
8866                                                 | ec_fw_string[5];
8867                         } else {
8868                                 pr_notice("ThinkPad firmware release %s "
8869                                           "doesn't match the known patterns\n",
8870                                           ec_fw_string);
8871                                 pr_notice("please report this to %s\n",
8872                                           TPACPI_MAIL);
8873                         }
8874                         break;
8875                 }
8876         }
8877
8878         s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8879         if (s && !(strnicmp(s, "ThinkPad", 8) && strnicmp(s, "Lenovo", 6))) {
8880                 tp->model_str = kstrdup(s, GFP_KERNEL);
8881                 if (!tp->model_str)
8882                         return -ENOMEM;
8883         } else {
8884                 s = dmi_get_system_info(DMI_BIOS_VENDOR);
8885                 if (s && !(strnicmp(s, "Lenovo", 6))) {
8886                         tp->model_str = kstrdup(s, GFP_KERNEL);
8887                         if (!tp->model_str)
8888                                 return -ENOMEM;
8889                 }
8890         }
8891
8892         s = dmi_get_system_info(DMI_PRODUCT_NAME);
8893         tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8894         if (s && !tp->nummodel_str)
8895                 return -ENOMEM;
8896
8897         return 0;
8898 }
8899
8900 static int __init probe_for_thinkpad(void)
8901 {
8902         int is_thinkpad;
8903
8904         if (acpi_disabled)
8905                 return -ENODEV;
8906
8907         /* It would be dangerous to run the driver in this case */
8908         if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8909                 return -ENODEV;
8910
8911         /*
8912          * Non-ancient models have better DMI tagging, but very old models
8913          * don't.  tpacpi_is_fw_known() is a cheat to help in that case.
8914          */
8915         is_thinkpad = (thinkpad_id.model_str != NULL) ||
8916                       (thinkpad_id.ec_model != 0) ||
8917                       tpacpi_is_fw_known();
8918
8919         /* The EC handler is required */
8920         tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
8921         if (!ec_handle) {
8922                 if (is_thinkpad)
8923                         pr_err("Not yet supported ThinkPad detected!\n");
8924                 return -ENODEV;
8925         }
8926
8927         if (!is_thinkpad && !force_load)
8928                 return -ENODEV;
8929
8930         return 0;
8931 }
8932
8933 static void __init thinkpad_acpi_init_banner(void)
8934 {
8935         pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
8936         pr_info("%s\n", TPACPI_URL);
8937
8938         pr_info("ThinkPad BIOS %s, EC %s\n",
8939                 (thinkpad_id.bios_version_str) ?
8940                         thinkpad_id.bios_version_str : "unknown",
8941                 (thinkpad_id.ec_version_str) ?
8942                         thinkpad_id.ec_version_str : "unknown");
8943
8944         BUG_ON(!thinkpad_id.vendor);
8945
8946         if (thinkpad_id.model_str)
8947                 pr_info("%s %s, model %s\n",
8948                         (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
8949                                 "IBM" : ((thinkpad_id.vendor ==
8950                                                 PCI_VENDOR_ID_LENOVO) ?
8951                                         "Lenovo" : "Unknown vendor"),
8952                         thinkpad_id.model_str,
8953                         (thinkpad_id.nummodel_str) ?
8954                                 thinkpad_id.nummodel_str : "unknown");
8955 }
8956
8957 /* Module init, exit, parameters */
8958
8959 static struct ibm_init_struct ibms_init[] __initdata = {
8960         {
8961                 .data = &thinkpad_acpi_driver_data,
8962         },
8963         {
8964                 .init = hotkey_init,
8965                 .data = &hotkey_driver_data,
8966         },
8967         {
8968                 .init = bluetooth_init,
8969                 .data = &bluetooth_driver_data,
8970         },
8971         {
8972                 .init = wan_init,
8973                 .data = &wan_driver_data,
8974         },
8975         {
8976                 .init = uwb_init,
8977                 .data = &uwb_driver_data,
8978         },
8979 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8980         {
8981                 .init = video_init,
8982                 .base_procfs_mode = S_IRUSR,
8983                 .data = &video_driver_data,
8984         },
8985 #endif
8986         {
8987                 .init = light_init,
8988                 .data = &light_driver_data,
8989         },
8990         {
8991                 .init = cmos_init,
8992                 .data = &cmos_driver_data,
8993         },
8994         {
8995                 .init = led_init,
8996                 .data = &led_driver_data,
8997         },
8998         {
8999                 .init = beep_init,
9000                 .data = &beep_driver_data,
9001         },
9002         {
9003                 .init = thermal_init,
9004                 .data = &thermal_driver_data,
9005         },
9006         {
9007                 .init = brightness_init,
9008                 .data = &brightness_driver_data,
9009         },
9010         {
9011                 .init = volume_init,
9012                 .data = &volume_driver_data,
9013         },
9014         {
9015                 .init = fan_init,
9016                 .data = &fan_driver_data,
9017         },
9018         {
9019                 .init = mute_led_init,
9020                 .data = &mute_led_driver_data,
9021         },
9022 };
9023
9024 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
9025 {
9026         unsigned int i;
9027         struct ibm_struct *ibm;
9028
9029         if (!kp || !kp->name || !val)
9030                 return -EINVAL;
9031
9032         for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9033                 ibm = ibms_init[i].data;
9034                 WARN_ON(ibm == NULL);
9035
9036                 if (!ibm || !ibm->name)
9037                         continue;
9038
9039                 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
9040                         if (strlen(val) > sizeof(ibms_init[i].param) - 2)
9041                                 return -ENOSPC;
9042                         strcpy(ibms_init[i].param, val);
9043                         strcat(ibms_init[i].param, ",");
9044                         return 0;
9045                 }
9046         }
9047
9048         return -EINVAL;
9049 }
9050
9051 module_param(experimental, int, 0444);
9052 MODULE_PARM_DESC(experimental,
9053                  "Enables experimental features when non-zero");
9054
9055 module_param_named(debug, dbg_level, uint, 0);
9056 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
9057
9058 module_param(force_load, bool, 0444);
9059 MODULE_PARM_DESC(force_load,
9060                  "Attempts to load the driver even on a "
9061                  "mis-identified ThinkPad when true");
9062
9063 module_param_named(fan_control, fan_control_allowed, bool, 0444);
9064 MODULE_PARM_DESC(fan_control,
9065                  "Enables setting fan parameters features when true");
9066
9067 module_param_named(brightness_mode, brightness_mode, uint, 0444);
9068 MODULE_PARM_DESC(brightness_mode,
9069                  "Selects brightness control strategy: "
9070                  "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
9071
9072 module_param(brightness_enable, uint, 0444);
9073 MODULE_PARM_DESC(brightness_enable,
9074                  "Enables backlight control when 1, disables when 0");
9075
9076 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
9077 module_param_named(volume_mode, volume_mode, uint, 0444);
9078 MODULE_PARM_DESC(volume_mode,
9079                  "Selects volume control strategy: "
9080                  "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
9081
9082 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
9083 MODULE_PARM_DESC(volume_capabilities,
9084                  "Selects the mixer capabilites: "
9085                  "0=auto, 1=volume and mute, 2=mute only");
9086
9087 module_param_named(volume_control, volume_control_allowed, bool, 0444);
9088 MODULE_PARM_DESC(volume_control,
9089                  "Enables software override for the console audio "
9090                  "control when true");
9091
9092 /* ALSA module API parameters */
9093 module_param_named(index, alsa_index, int, 0444);
9094 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
9095 module_param_named(id, alsa_id, charp, 0444);
9096 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
9097 module_param_named(enable, alsa_enable, bool, 0444);
9098 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
9099 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
9100
9101 #define TPACPI_PARAM(feature) \
9102         module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
9103         MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
9104                          "at module load, see documentation")
9105
9106 TPACPI_PARAM(hotkey);
9107 TPACPI_PARAM(bluetooth);
9108 TPACPI_PARAM(video);
9109 TPACPI_PARAM(light);
9110 TPACPI_PARAM(cmos);
9111 TPACPI_PARAM(led);
9112 TPACPI_PARAM(beep);
9113 TPACPI_PARAM(brightness);
9114 TPACPI_PARAM(volume);
9115 TPACPI_PARAM(fan);
9116
9117 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
9118 module_param(dbg_wlswemul, uint, 0444);
9119 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
9120 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
9121 MODULE_PARM_DESC(wlsw_state,
9122                  "Initial state of the emulated WLSW switch");
9123
9124 module_param(dbg_bluetoothemul, uint, 0444);
9125 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
9126 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
9127 MODULE_PARM_DESC(bluetooth_state,
9128                  "Initial state of the emulated bluetooth switch");
9129
9130 module_param(dbg_wwanemul, uint, 0444);
9131 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
9132 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
9133 MODULE_PARM_DESC(wwan_state,
9134                  "Initial state of the emulated WWAN switch");
9135
9136 module_param(dbg_uwbemul, uint, 0444);
9137 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
9138 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
9139 MODULE_PARM_DESC(uwb_state,
9140                  "Initial state of the emulated UWB switch");
9141 #endif
9142
9143 static void thinkpad_acpi_module_exit(void)
9144 {
9145         struct ibm_struct *ibm, *itmp;
9146
9147         tpacpi_lifecycle = TPACPI_LIFE_EXITING;
9148
9149         list_for_each_entry_safe_reverse(ibm, itmp,
9150                                          &tpacpi_all_drivers,
9151                                          all_drivers) {
9152                 ibm_exit(ibm);
9153         }
9154
9155         dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
9156
9157         if (tpacpi_inputdev) {
9158                 if (tp_features.input_device_registered)
9159                         input_unregister_device(tpacpi_inputdev);
9160                 else
9161                         input_free_device(tpacpi_inputdev);
9162                 kfree(hotkey_keycode_map);
9163         }
9164
9165         if (tpacpi_hwmon)
9166                 hwmon_device_unregister(tpacpi_hwmon);
9167
9168         if (tp_features.sensors_pdev_attrs_registered)
9169                 device_remove_file(&tpacpi_sensors_pdev->dev,
9170                                    &dev_attr_thinkpad_acpi_pdev_name);
9171         if (tpacpi_sensors_pdev)
9172                 platform_device_unregister(tpacpi_sensors_pdev);
9173         if (tpacpi_pdev)
9174                 platform_device_unregister(tpacpi_pdev);
9175
9176         if (tp_features.sensors_pdrv_attrs_registered)
9177                 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
9178         if (tp_features.platform_drv_attrs_registered)
9179                 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
9180
9181         if (tp_features.sensors_pdrv_registered)
9182                 platform_driver_unregister(&tpacpi_hwmon_pdriver);
9183
9184         if (tp_features.platform_drv_registered)
9185                 platform_driver_unregister(&tpacpi_pdriver);
9186
9187         if (proc_dir)
9188                 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
9189
9190         if (tpacpi_wq)
9191                 destroy_workqueue(tpacpi_wq);
9192
9193         kfree(thinkpad_id.bios_version_str);
9194         kfree(thinkpad_id.ec_version_str);
9195         kfree(thinkpad_id.model_str);
9196         kfree(thinkpad_id.nummodel_str);
9197 }
9198
9199
9200 static int __init thinkpad_acpi_module_init(void)
9201 {
9202         int ret, i;
9203
9204         tpacpi_lifecycle = TPACPI_LIFE_INIT;
9205
9206         /* Driver-level probe */
9207
9208         ret = get_thinkpad_model_data(&thinkpad_id);
9209         if (ret) {
9210                 pr_err("unable to get DMI data: %d\n", ret);
9211                 thinkpad_acpi_module_exit();
9212                 return ret;
9213         }
9214         ret = probe_for_thinkpad();
9215         if (ret) {
9216                 thinkpad_acpi_module_exit();
9217                 return ret;
9218         }
9219
9220         /* Driver initialization */
9221
9222         thinkpad_acpi_init_banner();
9223         tpacpi_check_outdated_fw();
9224
9225         TPACPI_ACPIHANDLE_INIT(ecrd);
9226         TPACPI_ACPIHANDLE_INIT(ecwr);
9227
9228         tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9229         if (!tpacpi_wq) {
9230                 thinkpad_acpi_module_exit();
9231                 return -ENOMEM;
9232         }
9233
9234         proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9235         if (!proc_dir) {
9236                 pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
9237                 thinkpad_acpi_module_exit();
9238                 return -ENODEV;
9239         }
9240
9241         ret = platform_driver_register(&tpacpi_pdriver);
9242         if (ret) {
9243                 pr_err("unable to register main platform driver\n");
9244                 thinkpad_acpi_module_exit();
9245                 return ret;
9246         }
9247         tp_features.platform_drv_registered = 1;
9248
9249         ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9250         if (ret) {
9251                 pr_err("unable to register hwmon platform driver\n");
9252                 thinkpad_acpi_module_exit();
9253                 return ret;
9254         }
9255         tp_features.sensors_pdrv_registered = 1;
9256
9257         ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9258         if (!ret) {
9259                 tp_features.platform_drv_attrs_registered = 1;
9260                 ret = tpacpi_create_driver_attributes(
9261                                         &tpacpi_hwmon_pdriver.driver);
9262         }
9263         if (ret) {
9264                 pr_err("unable to create sysfs driver attributes\n");
9265                 thinkpad_acpi_module_exit();
9266                 return ret;
9267         }
9268         tp_features.sensors_pdrv_attrs_registered = 1;
9269
9270
9271         /* Device initialization */
9272         tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9273                                                         NULL, 0);
9274         if (IS_ERR(tpacpi_pdev)) {
9275                 ret = PTR_ERR(tpacpi_pdev);
9276                 tpacpi_pdev = NULL;
9277                 pr_err("unable to register platform device\n");
9278                 thinkpad_acpi_module_exit();
9279                 return ret;
9280         }
9281         tpacpi_sensors_pdev = platform_device_register_simple(
9282                                                 TPACPI_HWMON_DRVR_NAME,
9283                                                 -1, NULL, 0);
9284         if (IS_ERR(tpacpi_sensors_pdev)) {
9285                 ret = PTR_ERR(tpacpi_sensors_pdev);
9286                 tpacpi_sensors_pdev = NULL;
9287                 pr_err("unable to register hwmon platform device\n");
9288                 thinkpad_acpi_module_exit();
9289                 return ret;
9290         }
9291         ret = device_create_file(&tpacpi_sensors_pdev->dev,
9292                                  &dev_attr_thinkpad_acpi_pdev_name);
9293         if (ret) {
9294                 pr_err("unable to create sysfs hwmon device attributes\n");
9295                 thinkpad_acpi_module_exit();
9296                 return ret;
9297         }
9298         tp_features.sensors_pdev_attrs_registered = 1;
9299         tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9300         if (IS_ERR(tpacpi_hwmon)) {
9301                 ret = PTR_ERR(tpacpi_hwmon);
9302                 tpacpi_hwmon = NULL;
9303                 pr_err("unable to register hwmon device\n");
9304                 thinkpad_acpi_module_exit();
9305                 return ret;
9306         }
9307         mutex_init(&tpacpi_inputdev_send_mutex);
9308         tpacpi_inputdev = input_allocate_device();
9309         if (!tpacpi_inputdev) {
9310                 thinkpad_acpi_module_exit();
9311                 return -ENOMEM;
9312         } else {
9313                 /* Prepare input device, but don't register */
9314                 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9315                 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9316                 tpacpi_inputdev->id.bustype = BUS_HOST;
9317                 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9318                 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9319                 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9320                 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9321         }
9322
9323         /* Init subdriver dependencies */
9324         tpacpi_detect_brightness_capabilities();
9325
9326         /* Init subdrivers */
9327         for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9328                 ret = ibm_init(&ibms_init[i]);
9329                 if (ret >= 0 && *ibms_init[i].param)
9330                         ret = ibms_init[i].data->write(ibms_init[i].param);
9331                 if (ret < 0) {
9332                         thinkpad_acpi_module_exit();
9333                         return ret;
9334                 }
9335         }
9336
9337         tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9338
9339         ret = input_register_device(tpacpi_inputdev);
9340         if (ret < 0) {
9341                 pr_err("unable to register input device\n");
9342                 thinkpad_acpi_module_exit();
9343                 return ret;
9344         } else {
9345                 tp_features.input_device_registered = 1;
9346         }
9347
9348         return 0;
9349 }
9350
9351 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9352
9353 /*
9354  * This will autoload the driver in almost every ThinkPad
9355  * in widespread use.
9356  *
9357  * Only _VERY_ old models, like the 240, 240x and 570 lack
9358  * the HKEY event interface.
9359  */
9360 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9361
9362 /*
9363  * DMI matching for module autoloading
9364  *
9365  * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9366  * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9367  *
9368  * Only models listed in thinkwiki will be supported, so add yours
9369  * if it is not there yet.
9370  */
9371 #define IBM_BIOS_MODULE_ALIAS(__type) \
9372         MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9373
9374 /* Ancient thinkpad BIOSes have to be identified by
9375  * BIOS type or model number, and there are far less
9376  * BIOS types than model numbers... */
9377 IBM_BIOS_MODULE_ALIAS("I[MU]");         /* 570, 570e */
9378
9379 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9380 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9381 MODULE_DESCRIPTION(TPACPI_DESC);
9382 MODULE_VERSION(TPACPI_VERSION);
9383 MODULE_LICENSE("GPL");
9384
9385 module_init(thinkpad_acpi_module_init);
9386 module_exit(thinkpad_acpi_module_exit);