Merge branch 'for-next' into for-linus
[safe/jmp/linux-2.6] / drivers / platform / x86 / thinkpad_acpi.c
1 /*
2  *  thinkpad_acpi.c - ThinkPad ACPI Extras
3  *
4  *
5  *  Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6  *  Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21  *  02110-1301, USA.
22  */
23
24 #define TPACPI_VERSION "0.24"
25 #define TPACPI_SYSFS_VERSION 0x020700
26
27 /*
28  *  Changelog:
29  *  2007-10-20          changelog trimmed down
30  *
31  *  2007-03-27  0.14    renamed to thinkpad_acpi and moved to
32  *                      drivers/misc.
33  *
34  *  2006-11-22  0.13    new maintainer
35  *                      changelog now lives in git commit history, and will
36  *                      not be updated further in-file.
37  *
38  *  2005-03-17  0.11    support for 600e, 770x
39  *                          thanks to Jamie Lentin <lentinj@dial.pipex.com>
40  *
41  *  2005-01-16  0.9     use MODULE_VERSION
42  *                          thanks to Henrik Brix Andersen <brix@gentoo.org>
43  *                      fix parameter passing on module loading
44  *                          thanks to Rusty Russell <rusty@rustcorp.com.au>
45  *                          thanks to Jim Radford <radford@blackbean.org>
46  *  2004-11-08  0.8     fix init error case, don't return from a macro
47  *                          thanks to Chris Wright <chrisw@osdl.org>
48  */
49
50 #include <linux/kernel.h>
51 #include <linux/module.h>
52 #include <linux/init.h>
53 #include <linux/types.h>
54 #include <linux/string.h>
55 #include <linux/list.h>
56 #include <linux/mutex.h>
57 #include <linux/sched.h>
58 #include <linux/kthread.h>
59 #include <linux/freezer.h>
60 #include <linux/delay.h>
61
62 #include <linux/nvram.h>
63 #include <linux/proc_fs.h>
64 #include <linux/seq_file.h>
65 #include <linux/sysfs.h>
66 #include <linux/backlight.h>
67 #include <linux/fb.h>
68 #include <linux/platform_device.h>
69 #include <linux/hwmon.h>
70 #include <linux/hwmon-sysfs.h>
71 #include <linux/input.h>
72 #include <linux/leds.h>
73 #include <linux/rfkill.h>
74 #include <asm/uaccess.h>
75
76 #include <linux/dmi.h>
77 #include <linux/jiffies.h>
78 #include <linux/workqueue.h>
79
80 #include <sound/core.h>
81 #include <sound/control.h>
82 #include <sound/initval.h>
83
84 #include <acpi/acpi_drivers.h>
85
86 #include <linux/pci_ids.h>
87
88
89 /* ThinkPad CMOS commands */
90 #define TP_CMOS_VOLUME_DOWN     0
91 #define TP_CMOS_VOLUME_UP       1
92 #define TP_CMOS_VOLUME_MUTE     2
93 #define TP_CMOS_BRIGHTNESS_UP   4
94 #define TP_CMOS_BRIGHTNESS_DOWN 5
95 #define TP_CMOS_THINKLIGHT_ON   12
96 #define TP_CMOS_THINKLIGHT_OFF  13
97
98 /* NVRAM Addresses */
99 enum tp_nvram_addr {
100         TP_NVRAM_ADDR_HK2               = 0x57,
101         TP_NVRAM_ADDR_THINKLIGHT        = 0x58,
102         TP_NVRAM_ADDR_VIDEO             = 0x59,
103         TP_NVRAM_ADDR_BRIGHTNESS        = 0x5e,
104         TP_NVRAM_ADDR_MIXER             = 0x60,
105 };
106
107 /* NVRAM bit masks */
108 enum {
109         TP_NVRAM_MASK_HKT_THINKPAD      = 0x08,
110         TP_NVRAM_MASK_HKT_ZOOM          = 0x20,
111         TP_NVRAM_MASK_HKT_DISPLAY       = 0x40,
112         TP_NVRAM_MASK_HKT_HIBERNATE     = 0x80,
113         TP_NVRAM_MASK_THINKLIGHT        = 0x10,
114         TP_NVRAM_MASK_HKT_DISPEXPND     = 0x30,
115         TP_NVRAM_MASK_HKT_BRIGHTNESS    = 0x20,
116         TP_NVRAM_MASK_LEVEL_BRIGHTNESS  = 0x0f,
117         TP_NVRAM_POS_LEVEL_BRIGHTNESS   = 0,
118         TP_NVRAM_MASK_MUTE              = 0x40,
119         TP_NVRAM_MASK_HKT_VOLUME        = 0x80,
120         TP_NVRAM_MASK_LEVEL_VOLUME      = 0x0f,
121         TP_NVRAM_POS_LEVEL_VOLUME       = 0,
122 };
123
124 /* ACPI HIDs */
125 #define TPACPI_ACPI_HKEY_HID            "IBM0068"
126
127 /* Input IDs */
128 #define TPACPI_HKEY_INPUT_PRODUCT       0x5054 /* "TP" */
129 #define TPACPI_HKEY_INPUT_VERSION       0x4101
130
131 /* ACPI \WGSV commands */
132 enum {
133         TP_ACPI_WGSV_GET_STATE          = 0x01, /* Get state information */
134         TP_ACPI_WGSV_PWR_ON_ON_RESUME   = 0x02, /* Resume WWAN powered on */
135         TP_ACPI_WGSV_PWR_OFF_ON_RESUME  = 0x03, /* Resume WWAN powered off */
136         TP_ACPI_WGSV_SAVE_STATE         = 0x04, /* Save state for S4/S5 */
137 };
138
139 /* TP_ACPI_WGSV_GET_STATE bits */
140 enum {
141         TP_ACPI_WGSV_STATE_WWANEXIST    = 0x0001, /* WWAN hw available */
142         TP_ACPI_WGSV_STATE_WWANPWR      = 0x0002, /* WWAN radio enabled */
143         TP_ACPI_WGSV_STATE_WWANPWRRES   = 0x0004, /* WWAN state at resume */
144         TP_ACPI_WGSV_STATE_WWANBIOSOFF  = 0x0008, /* WWAN disabled in BIOS */
145         TP_ACPI_WGSV_STATE_BLTHEXIST    = 0x0001, /* BLTH hw available */
146         TP_ACPI_WGSV_STATE_BLTHPWR      = 0x0002, /* BLTH radio enabled */
147         TP_ACPI_WGSV_STATE_BLTHPWRRES   = 0x0004, /* BLTH state at resume */
148         TP_ACPI_WGSV_STATE_BLTHBIOSOFF  = 0x0008, /* BLTH disabled in BIOS */
149         TP_ACPI_WGSV_STATE_UWBEXIST     = 0x0010, /* UWB hw available */
150         TP_ACPI_WGSV_STATE_UWBPWR       = 0x0020, /* UWB radio enabled */
151 };
152
153 /* HKEY events */
154 enum tpacpi_hkey_event_t {
155         /* Hotkey-related */
156         TP_HKEY_EV_HOTKEY_BASE          = 0x1001, /* first hotkey (FN+F1) */
157         TP_HKEY_EV_BRGHT_UP             = 0x1010, /* Brightness up */
158         TP_HKEY_EV_BRGHT_DOWN           = 0x1011, /* Brightness down */
159         TP_HKEY_EV_VOL_UP               = 0x1015, /* Volume up or unmute */
160         TP_HKEY_EV_VOL_DOWN             = 0x1016, /* Volume down or unmute */
161         TP_HKEY_EV_VOL_MUTE             = 0x1017, /* Mixer output mute */
162
163         /* Reasons for waking up from S3/S4 */
164         TP_HKEY_EV_WKUP_S3_UNDOCK       = 0x2304, /* undock requested, S3 */
165         TP_HKEY_EV_WKUP_S4_UNDOCK       = 0x2404, /* undock requested, S4 */
166         TP_HKEY_EV_WKUP_S3_BAYEJ        = 0x2305, /* bay ejection req, S3 */
167         TP_HKEY_EV_WKUP_S4_BAYEJ        = 0x2405, /* bay ejection req, S4 */
168         TP_HKEY_EV_WKUP_S3_BATLOW       = 0x2313, /* battery empty, S3 */
169         TP_HKEY_EV_WKUP_S4_BATLOW       = 0x2413, /* battery empty, S4 */
170
171         /* Auto-sleep after eject request */
172         TP_HKEY_EV_BAYEJ_ACK            = 0x3003, /* bay ejection complete */
173         TP_HKEY_EV_UNDOCK_ACK           = 0x4003, /* undock complete */
174
175         /* Misc bay events */
176         TP_HKEY_EV_OPTDRV_EJ            = 0x3006, /* opt. drive tray ejected */
177
178         /* User-interface events */
179         TP_HKEY_EV_LID_CLOSE            = 0x5001, /* laptop lid closed */
180         TP_HKEY_EV_LID_OPEN             = 0x5002, /* laptop lid opened */
181         TP_HKEY_EV_TABLET_TABLET        = 0x5009, /* tablet swivel up */
182         TP_HKEY_EV_TABLET_NOTEBOOK      = 0x500a, /* tablet swivel down */
183         TP_HKEY_EV_PEN_INSERTED         = 0x500b, /* tablet pen inserted */
184         TP_HKEY_EV_PEN_REMOVED          = 0x500c, /* tablet pen removed */
185         TP_HKEY_EV_BRGHT_CHANGED        = 0x5010, /* backlight control event */
186
187         /* Thermal events */
188         TP_HKEY_EV_ALARM_BAT_HOT        = 0x6011, /* battery too hot */
189         TP_HKEY_EV_ALARM_BAT_XHOT       = 0x6012, /* battery critically hot */
190         TP_HKEY_EV_ALARM_SENSOR_HOT     = 0x6021, /* sensor too hot */
191         TP_HKEY_EV_ALARM_SENSOR_XHOT    = 0x6022, /* sensor critically hot */
192         TP_HKEY_EV_THM_TABLE_CHANGED    = 0x6030, /* thermal table changed */
193
194         /* Misc */
195         TP_HKEY_EV_RFKILL_CHANGED       = 0x7000, /* rfkill switch changed */
196 };
197
198 /****************************************************************************
199  * Main driver
200  */
201
202 #define TPACPI_NAME "thinkpad"
203 #define TPACPI_DESC "ThinkPad ACPI Extras"
204 #define TPACPI_FILE TPACPI_NAME "_acpi"
205 #define TPACPI_URL "http://ibm-acpi.sf.net/"
206 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
207
208 #define TPACPI_PROC_DIR "ibm"
209 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
210 #define TPACPI_DRVR_NAME TPACPI_FILE
211 #define TPACPI_DRVR_SHORTNAME "tpacpi"
212 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
213
214 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
215 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
216
217 #define TPACPI_MAX_ACPI_ARGS 3
218
219 /* printk headers */
220 #define TPACPI_LOG TPACPI_FILE ": "
221 #define TPACPI_EMERG    KERN_EMERG      TPACPI_LOG
222 #define TPACPI_ALERT    KERN_ALERT      TPACPI_LOG
223 #define TPACPI_CRIT     KERN_CRIT       TPACPI_LOG
224 #define TPACPI_ERR      KERN_ERR        TPACPI_LOG
225 #define TPACPI_WARN     KERN_WARNING    TPACPI_LOG
226 #define TPACPI_NOTICE   KERN_NOTICE     TPACPI_LOG
227 #define TPACPI_INFO     KERN_INFO       TPACPI_LOG
228 #define TPACPI_DEBUG    KERN_DEBUG      TPACPI_LOG
229
230 /* Debugging printk groups */
231 #define TPACPI_DBG_ALL          0xffff
232 #define TPACPI_DBG_DISCLOSETASK 0x8000
233 #define TPACPI_DBG_INIT         0x0001
234 #define TPACPI_DBG_EXIT         0x0002
235 #define TPACPI_DBG_RFKILL       0x0004
236 #define TPACPI_DBG_HKEY         0x0008
237 #define TPACPI_DBG_FAN          0x0010
238 #define TPACPI_DBG_BRGHT        0x0020
239 #define TPACPI_DBG_MIXER        0x0040
240
241 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
242 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
243 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
244
245
246 /****************************************************************************
247  * Driver-wide structs and misc. variables
248  */
249
250 struct ibm_struct;
251
252 struct tp_acpi_drv_struct {
253         const struct acpi_device_id *hid;
254         struct acpi_driver *driver;
255
256         void (*notify) (struct ibm_struct *, u32);
257         acpi_handle *handle;
258         u32 type;
259         struct acpi_device *device;
260 };
261
262 struct ibm_struct {
263         char *name;
264
265         int (*read) (struct seq_file *);
266         int (*write) (char *);
267         void (*exit) (void);
268         void (*resume) (void);
269         void (*suspend) (pm_message_t state);
270         void (*shutdown) (void);
271
272         struct list_head all_drivers;
273
274         struct tp_acpi_drv_struct *acpi;
275
276         struct {
277                 u8 acpi_driver_registered:1;
278                 u8 acpi_notify_installed:1;
279                 u8 proc_created:1;
280                 u8 init_called:1;
281                 u8 experimental:1;
282         } flags;
283 };
284
285 struct ibm_init_struct {
286         char param[32];
287
288         int (*init) (struct ibm_init_struct *);
289         mode_t base_procfs_mode;
290         struct ibm_struct *data;
291 };
292
293 static struct {
294         u32 bluetooth:1;
295         u32 hotkey:1;
296         u32 hotkey_mask:1;
297         u32 hotkey_wlsw:1;
298         u32 hotkey_tablet:1;
299         u32 light:1;
300         u32 light_status:1;
301         u32 bright_16levels:1;
302         u32 bright_acpimode:1;
303         u32 wan:1;
304         u32 uwb:1;
305         u32 fan_ctrl_status_undef:1;
306         u32 second_fan:1;
307         u32 beep_needs_two_args:1;
308         u32 mixer_no_level_control:1;
309         u32 input_device_registered:1;
310         u32 platform_drv_registered:1;
311         u32 platform_drv_attrs_registered:1;
312         u32 sensors_pdrv_registered:1;
313         u32 sensors_pdrv_attrs_registered:1;
314         u32 sensors_pdev_attrs_registered:1;
315         u32 hotkey_poll_active:1;
316 } tp_features;
317
318 static struct {
319         u16 hotkey_mask_ff:1;
320         u16 volume_ctrl_forbidden:1;
321 } tp_warned;
322
323 struct thinkpad_id_data {
324         unsigned int vendor;    /* ThinkPad vendor:
325                                  * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
326
327         char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
328         char *ec_version_str;   /* Something like 1ZHT51WW-1.04a */
329
330         u16 bios_model;         /* 1Y = 0x5931, 0 = unknown */
331         u16 ec_model;
332         u16 bios_release;       /* 1ZETK1WW = 0x314b, 0 = unknown */
333         u16 ec_release;
334
335         char *model_str;        /* ThinkPad T43 */
336         char *nummodel_str;     /* 9384A9C for a 9384-A9C model */
337 };
338 static struct thinkpad_id_data thinkpad_id;
339
340 static enum {
341         TPACPI_LIFE_INIT = 0,
342         TPACPI_LIFE_RUNNING,
343         TPACPI_LIFE_EXITING,
344 } tpacpi_lifecycle;
345
346 static int experimental;
347 static u32 dbg_level;
348
349 static struct workqueue_struct *tpacpi_wq;
350
351 enum led_status_t {
352         TPACPI_LED_OFF = 0,
353         TPACPI_LED_ON,
354         TPACPI_LED_BLINK,
355 };
356
357 /* Special LED class that can defer work */
358 struct tpacpi_led_classdev {
359         struct led_classdev led_classdev;
360         struct work_struct work;
361         enum led_status_t new_state;
362         unsigned int led;
363 };
364
365 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
366 static int dbg_wlswemul;
367 static int tpacpi_wlsw_emulstate;
368 static int dbg_bluetoothemul;
369 static int tpacpi_bluetooth_emulstate;
370 static int dbg_wwanemul;
371 static int tpacpi_wwan_emulstate;
372 static int dbg_uwbemul;
373 static int tpacpi_uwb_emulstate;
374 #endif
375
376
377 /*************************************************************************
378  *  Debugging helpers
379  */
380
381 #define dbg_printk(a_dbg_level, format, arg...) \
382         do { if (dbg_level & (a_dbg_level)) \
383                 printk(TPACPI_DEBUG "%s: " format, __func__ , ## arg); \
384         } while (0)
385
386 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
387 #define vdbg_printk dbg_printk
388 static const char *str_supported(int is_supported);
389 #else
390 #define vdbg_printk(a_dbg_level, format, arg...) \
391         do { } while (0)
392 #endif
393
394 static void tpacpi_log_usertask(const char * const what)
395 {
396         printk(TPACPI_DEBUG "%s: access by process with PID %d\n",
397                 what, task_tgid_vnr(current));
398 }
399
400 #define tpacpi_disclose_usertask(what, format, arg...) \
401         do { \
402                 if (unlikely( \
403                     (dbg_level & TPACPI_DBG_DISCLOSETASK) && \
404                     (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
405                         printk(TPACPI_DEBUG "%s: PID %d: " format, \
406                                 what, task_tgid_vnr(current), ## arg); \
407                 } \
408         } while (0)
409
410 /*
411  * Quirk handling helpers
412  *
413  * ThinkPad IDs and versions seen in the field so far
414  * are two-characters from the set [0-9A-Z], i.e. base 36.
415  *
416  * We use values well outside that range as specials.
417  */
418
419 #define TPACPI_MATCH_ANY                0xffffU
420 #define TPACPI_MATCH_UNKNOWN            0U
421
422 /* TPID('1', 'Y') == 0x5931 */
423 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
424
425 #define TPACPI_Q_IBM(__id1, __id2, __quirk)     \
426         { .vendor = PCI_VENDOR_ID_IBM,          \
427           .bios = TPID(__id1, __id2),           \
428           .ec = TPACPI_MATCH_ANY,               \
429           .quirks = (__quirk) }
430
431 #define TPACPI_Q_LNV(__id1, __id2, __quirk)     \
432         { .vendor = PCI_VENDOR_ID_LENOVO,       \
433           .bios = TPID(__id1, __id2),           \
434           .ec = TPACPI_MATCH_ANY,               \
435           .quirks = (__quirk) }
436
437 #define TPACPI_QEC_LNV(__id1, __id2, __quirk)   \
438         { .vendor = PCI_VENDOR_ID_LENOVO,       \
439           .bios = TPACPI_MATCH_ANY,             \
440           .ec = TPID(__id1, __id2),             \
441           .quirks = (__quirk) }
442
443 struct tpacpi_quirk {
444         unsigned int vendor;
445         u16 bios;
446         u16 ec;
447         unsigned long quirks;
448 };
449
450 /**
451  * tpacpi_check_quirks() - search BIOS/EC version on a list
452  * @qlist:              array of &struct tpacpi_quirk
453  * @qlist_size:         number of elements in @qlist
454  *
455  * Iterates over a quirks list until one is found that matches the
456  * ThinkPad's vendor, BIOS and EC model.
457  *
458  * Returns 0 if nothing matches, otherwise returns the quirks field of
459  * the matching &struct tpacpi_quirk entry.
460  *
461  * The match criteria is: vendor, ec and bios much match.
462  */
463 static unsigned long __init tpacpi_check_quirks(
464                         const struct tpacpi_quirk *qlist,
465                         unsigned int qlist_size)
466 {
467         while (qlist_size) {
468                 if ((qlist->vendor == thinkpad_id.vendor ||
469                                 qlist->vendor == TPACPI_MATCH_ANY) &&
470                     (qlist->bios == thinkpad_id.bios_model ||
471                                 qlist->bios == TPACPI_MATCH_ANY) &&
472                     (qlist->ec == thinkpad_id.ec_model ||
473                                 qlist->ec == TPACPI_MATCH_ANY))
474                         return qlist->quirks;
475
476                 qlist_size--;
477                 qlist++;
478         }
479         return 0;
480 }
481
482
483 /****************************************************************************
484  ****************************************************************************
485  *
486  * ACPI Helpers and device model
487  *
488  ****************************************************************************
489  ****************************************************************************/
490
491 /*************************************************************************
492  * ACPI basic handles
493  */
494
495 static acpi_handle root_handle;
496
497 #define TPACPI_HANDLE(object, parent, paths...)                 \
498         static acpi_handle  object##_handle;                    \
499         static acpi_handle *object##_parent = &parent##_handle; \
500         static char        *object##_path;                      \
501         static char        *object##_paths[] = { paths }
502
503 TPACPI_HANDLE(ec, root, "\\_SB.PCI0.ISA.EC0",   /* 240, 240x */
504            "\\_SB.PCI.ISA.EC",  /* 570 */
505            "\\_SB.PCI0.ISA0.EC0",       /* 600e/x, 770e, 770x */
506            "\\_SB.PCI0.ISA.EC", /* A21e, A2xm/p, T20-22, X20-21 */
507            "\\_SB.PCI0.AD4S.EC0",       /* i1400, R30 */
508            "\\_SB.PCI0.ICH3.EC0",       /* R31 */
509            "\\_SB.PCI0.LPC.EC", /* all others */
510            );
511
512 TPACPI_HANDLE(ecrd, ec, "ECRD");        /* 570 */
513 TPACPI_HANDLE(ecwr, ec, "ECWR");        /* 570 */
514
515 TPACPI_HANDLE(cmos, root, "\\UCMS",     /* R50, R50e, R50p, R51, */
516                                         /* T4x, X31, X40 */
517            "\\CMOS",            /* A3x, G4x, R32, T23, T30, X22-24, X30 */
518            "\\CMS",             /* R40, R40e */
519            );                   /* all others */
520
521 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY",   /* 600e/x, 770e, 770x */
522            "^HKEY",             /* R30, R31 */
523            "HKEY",              /* all others */
524            );                   /* 570 */
525
526 TPACPI_HANDLE(vid, root, "\\_SB.PCI.AGP.VGA",   /* 570 */
527            "\\_SB.PCI0.AGP0.VID0",      /* 600e/x, 770x */
528            "\\_SB.PCI0.VID0",   /* 770e */
529            "\\_SB.PCI0.VID",    /* A21e, G4x, R50e, X30, X40 */
530            "\\_SB.PCI0.AGP.VID",        /* all others */
531            );                           /* R30, R31 */
532
533
534 /*************************************************************************
535  * ACPI helpers
536  */
537
538 static int acpi_evalf(acpi_handle handle,
539                       void *res, char *method, char *fmt, ...)
540 {
541         char *fmt0 = fmt;
542         struct acpi_object_list params;
543         union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
544         struct acpi_buffer result, *resultp;
545         union acpi_object out_obj;
546         acpi_status status;
547         va_list ap;
548         char res_type;
549         int success;
550         int quiet;
551
552         if (!*fmt) {
553                 printk(TPACPI_ERR "acpi_evalf() called with empty format\n");
554                 return 0;
555         }
556
557         if (*fmt == 'q') {
558                 quiet = 1;
559                 fmt++;
560         } else
561                 quiet = 0;
562
563         res_type = *(fmt++);
564
565         params.count = 0;
566         params.pointer = &in_objs[0];
567
568         va_start(ap, fmt);
569         while (*fmt) {
570                 char c = *(fmt++);
571                 switch (c) {
572                 case 'd':       /* int */
573                         in_objs[params.count].integer.value = va_arg(ap, int);
574                         in_objs[params.count++].type = ACPI_TYPE_INTEGER;
575                         break;
576                         /* add more types as needed */
577                 default:
578                         printk(TPACPI_ERR "acpi_evalf() called "
579                                "with invalid format character '%c'\n", c);
580                         return 0;
581                 }
582         }
583         va_end(ap);
584
585         if (res_type != 'v') {
586                 result.length = sizeof(out_obj);
587                 result.pointer = &out_obj;
588                 resultp = &result;
589         } else
590                 resultp = NULL;
591
592         status = acpi_evaluate_object(handle, method, &params, resultp);
593
594         switch (res_type) {
595         case 'd':               /* int */
596                 if (res)
597                         *(int *)res = out_obj.integer.value;
598                 success = status == AE_OK && out_obj.type == ACPI_TYPE_INTEGER;
599                 break;
600         case 'v':               /* void */
601                 success = status == AE_OK;
602                 break;
603                 /* add more types as needed */
604         default:
605                 printk(TPACPI_ERR "acpi_evalf() called "
606                        "with invalid format character '%c'\n", res_type);
607                 return 0;
608         }
609
610         if (!success && !quiet)
611                 printk(TPACPI_ERR "acpi_evalf(%s, %s, ...) failed: %d\n",
612                        method, fmt0, status);
613
614         return success;
615 }
616
617 static int acpi_ec_read(int i, u8 *p)
618 {
619         int v;
620
621         if (ecrd_handle) {
622                 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
623                         return 0;
624                 *p = v;
625         } else {
626                 if (ec_read(i, p) < 0)
627                         return 0;
628         }
629
630         return 1;
631 }
632
633 static int acpi_ec_write(int i, u8 v)
634 {
635         if (ecwr_handle) {
636                 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
637                         return 0;
638         } else {
639                 if (ec_write(i, v) < 0)
640                         return 0;
641         }
642
643         return 1;
644 }
645
646 static int issue_thinkpad_cmos_command(int cmos_cmd)
647 {
648         if (!cmos_handle)
649                 return -ENXIO;
650
651         if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
652                 return -EIO;
653
654         return 0;
655 }
656
657 /*************************************************************************
658  * ACPI device model
659  */
660
661 #define TPACPI_ACPIHANDLE_INIT(object) \
662         drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
663                 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
664
665 static void drv_acpi_handle_init(char *name,
666                            acpi_handle *handle, acpi_handle parent,
667                            char **paths, int num_paths, char **path)
668 {
669         int i;
670         acpi_status status;
671
672         vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
673                 name);
674
675         for (i = 0; i < num_paths; i++) {
676                 status = acpi_get_handle(parent, paths[i], handle);
677                 if (ACPI_SUCCESS(status)) {
678                         *path = paths[i];
679                         dbg_printk(TPACPI_DBG_INIT,
680                                    "Found ACPI handle %s for %s\n",
681                                    *path, name);
682                         return;
683                 }
684         }
685
686         vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
687                     name);
688         *handle = NULL;
689 }
690
691 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
692 {
693         struct ibm_struct *ibm = data;
694
695         if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
696                 return;
697
698         if (!ibm || !ibm->acpi || !ibm->acpi->notify)
699                 return;
700
701         ibm->acpi->notify(ibm, event);
702 }
703
704 static int __init setup_acpi_notify(struct ibm_struct *ibm)
705 {
706         acpi_status status;
707         int rc;
708
709         BUG_ON(!ibm->acpi);
710
711         if (!*ibm->acpi->handle)
712                 return 0;
713
714         vdbg_printk(TPACPI_DBG_INIT,
715                 "setting up ACPI notify for %s\n", ibm->name);
716
717         rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
718         if (rc < 0) {
719                 printk(TPACPI_ERR "acpi_bus_get_device(%s) failed: %d\n",
720                         ibm->name, rc);
721                 return -ENODEV;
722         }
723
724         ibm->acpi->device->driver_data = ibm;
725         sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
726                 TPACPI_ACPI_EVENT_PREFIX,
727                 ibm->name);
728
729         status = acpi_install_notify_handler(*ibm->acpi->handle,
730                         ibm->acpi->type, dispatch_acpi_notify, ibm);
731         if (ACPI_FAILURE(status)) {
732                 if (status == AE_ALREADY_EXISTS) {
733                         printk(TPACPI_NOTICE
734                                "another device driver is already "
735                                "handling %s events\n", ibm->name);
736                 } else {
737                         printk(TPACPI_ERR
738                                "acpi_install_notify_handler(%s) failed: %d\n",
739                                ibm->name, status);
740                 }
741                 return -ENODEV;
742         }
743         ibm->flags.acpi_notify_installed = 1;
744         return 0;
745 }
746
747 static int __init tpacpi_device_add(struct acpi_device *device)
748 {
749         return 0;
750 }
751
752 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
753 {
754         int rc;
755
756         dbg_printk(TPACPI_DBG_INIT,
757                 "registering %s as an ACPI driver\n", ibm->name);
758
759         BUG_ON(!ibm->acpi);
760
761         ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
762         if (!ibm->acpi->driver) {
763                 printk(TPACPI_ERR
764                        "failed to allocate memory for ibm->acpi->driver\n");
765                 return -ENOMEM;
766         }
767
768         sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
769         ibm->acpi->driver->ids = ibm->acpi->hid;
770
771         ibm->acpi->driver->ops.add = &tpacpi_device_add;
772
773         rc = acpi_bus_register_driver(ibm->acpi->driver);
774         if (rc < 0) {
775                 printk(TPACPI_ERR "acpi_bus_register_driver(%s) failed: %d\n",
776                        ibm->name, rc);
777                 kfree(ibm->acpi->driver);
778                 ibm->acpi->driver = NULL;
779         } else if (!rc)
780                 ibm->flags.acpi_driver_registered = 1;
781
782         return rc;
783 }
784
785
786 /****************************************************************************
787  ****************************************************************************
788  *
789  * Procfs Helpers
790  *
791  ****************************************************************************
792  ****************************************************************************/
793
794 static int dispatch_proc_show(struct seq_file *m, void *v)
795 {
796         struct ibm_struct *ibm = m->private;
797
798         if (!ibm || !ibm->read)
799                 return -EINVAL;
800         return ibm->read(m);
801 }
802
803 static int dispatch_proc_open(struct inode *inode, struct file *file)
804 {
805         return single_open(file, dispatch_proc_show, PDE(inode)->data);
806 }
807
808 static ssize_t dispatch_proc_write(struct file *file,
809                         const char __user *userbuf,
810                         size_t count, loff_t *pos)
811 {
812         struct ibm_struct *ibm = PDE(file->f_path.dentry->d_inode)->data;
813         char *kernbuf;
814         int ret;
815
816         if (!ibm || !ibm->write)
817                 return -EINVAL;
818         if (count > PAGE_SIZE - 2)
819                 return -EINVAL;
820
821         kernbuf = kmalloc(count + 2, GFP_KERNEL);
822         if (!kernbuf)
823                 return -ENOMEM;
824
825         if (copy_from_user(kernbuf, userbuf, count)) {
826                 kfree(kernbuf);
827                 return -EFAULT;
828         }
829
830         kernbuf[count] = 0;
831         strcat(kernbuf, ",");
832         ret = ibm->write(kernbuf);
833         if (ret == 0)
834                 ret = count;
835
836         kfree(kernbuf);
837
838         return ret;
839 }
840
841 static const struct file_operations dispatch_proc_fops = {
842         .owner          = THIS_MODULE,
843         .open           = dispatch_proc_open,
844         .read           = seq_read,
845         .llseek         = seq_lseek,
846         .release        = single_release,
847         .write          = dispatch_proc_write,
848 };
849
850 static char *next_cmd(char **cmds)
851 {
852         char *start = *cmds;
853         char *end;
854
855         while ((end = strchr(start, ',')) && end == start)
856                 start = end + 1;
857
858         if (!end)
859                 return NULL;
860
861         *end = 0;
862         *cmds = end + 1;
863         return start;
864 }
865
866
867 /****************************************************************************
868  ****************************************************************************
869  *
870  * Device model: input, hwmon and platform
871  *
872  ****************************************************************************
873  ****************************************************************************/
874
875 static struct platform_device *tpacpi_pdev;
876 static struct platform_device *tpacpi_sensors_pdev;
877 static struct device *tpacpi_hwmon;
878 static struct input_dev *tpacpi_inputdev;
879 static struct mutex tpacpi_inputdev_send_mutex;
880 static LIST_HEAD(tpacpi_all_drivers);
881
882 static int tpacpi_suspend_handler(struct platform_device *pdev,
883                                   pm_message_t state)
884 {
885         struct ibm_struct *ibm, *itmp;
886
887         list_for_each_entry_safe(ibm, itmp,
888                                  &tpacpi_all_drivers,
889                                  all_drivers) {
890                 if (ibm->suspend)
891                         (ibm->suspend)(state);
892         }
893
894         return 0;
895 }
896
897 static int tpacpi_resume_handler(struct platform_device *pdev)
898 {
899         struct ibm_struct *ibm, *itmp;
900
901         list_for_each_entry_safe(ibm, itmp,
902                                  &tpacpi_all_drivers,
903                                  all_drivers) {
904                 if (ibm->resume)
905                         (ibm->resume)();
906         }
907
908         return 0;
909 }
910
911 static void tpacpi_shutdown_handler(struct platform_device *pdev)
912 {
913         struct ibm_struct *ibm, *itmp;
914
915         list_for_each_entry_safe(ibm, itmp,
916                                  &tpacpi_all_drivers,
917                                  all_drivers) {
918                 if (ibm->shutdown)
919                         (ibm->shutdown)();
920         }
921 }
922
923 static struct platform_driver tpacpi_pdriver = {
924         .driver = {
925                 .name = TPACPI_DRVR_NAME,
926                 .owner = THIS_MODULE,
927         },
928         .suspend = tpacpi_suspend_handler,
929         .resume = tpacpi_resume_handler,
930         .shutdown = tpacpi_shutdown_handler,
931 };
932
933 static struct platform_driver tpacpi_hwmon_pdriver = {
934         .driver = {
935                 .name = TPACPI_HWMON_DRVR_NAME,
936                 .owner = THIS_MODULE,
937         },
938 };
939
940 /*************************************************************************
941  * sysfs support helpers
942  */
943
944 struct attribute_set {
945         unsigned int members, max_members;
946         struct attribute_group group;
947 };
948
949 struct attribute_set_obj {
950         struct attribute_set s;
951         struct attribute *a;
952 } __attribute__((packed));
953
954 static struct attribute_set *create_attr_set(unsigned int max_members,
955                                                 const char *name)
956 {
957         struct attribute_set_obj *sobj;
958
959         if (max_members == 0)
960                 return NULL;
961
962         /* Allocates space for implicit NULL at the end too */
963         sobj = kzalloc(sizeof(struct attribute_set_obj) +
964                     max_members * sizeof(struct attribute *),
965                     GFP_KERNEL);
966         if (!sobj)
967                 return NULL;
968         sobj->s.max_members = max_members;
969         sobj->s.group.attrs = &sobj->a;
970         sobj->s.group.name = name;
971
972         return &sobj->s;
973 }
974
975 #define destroy_attr_set(_set) \
976         kfree(_set);
977
978 /* not multi-threaded safe, use it in a single thread per set */
979 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
980 {
981         if (!s || !attr)
982                 return -EINVAL;
983
984         if (s->members >= s->max_members)
985                 return -ENOMEM;
986
987         s->group.attrs[s->members] = attr;
988         s->members++;
989
990         return 0;
991 }
992
993 static int add_many_to_attr_set(struct attribute_set *s,
994                         struct attribute **attr,
995                         unsigned int count)
996 {
997         int i, res;
998
999         for (i = 0; i < count; i++) {
1000                 res = add_to_attr_set(s, attr[i]);
1001                 if (res)
1002                         return res;
1003         }
1004
1005         return 0;
1006 }
1007
1008 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1009 {
1010         sysfs_remove_group(kobj, &s->group);
1011         destroy_attr_set(s);
1012 }
1013
1014 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1015         sysfs_create_group(_kobj, &_attr_set->group)
1016
1017 static int parse_strtoul(const char *buf,
1018                 unsigned long max, unsigned long *value)
1019 {
1020         char *endp;
1021
1022         *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1023         endp = skip_spaces(endp);
1024         if (*endp || *value > max)
1025                 return -EINVAL;
1026
1027         return 0;
1028 }
1029
1030 static void tpacpi_disable_brightness_delay(void)
1031 {
1032         if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1033                 printk(TPACPI_NOTICE
1034                         "ACPI backlight control delay disabled\n");
1035 }
1036
1037 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
1038 {
1039         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1040         union acpi_object *obj;
1041         int rc;
1042
1043         if (ACPI_SUCCESS(acpi_evaluate_object(handle, NULL, NULL, &buffer))) {
1044                 obj = (union acpi_object *)buffer.pointer;
1045                 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
1046                         printk(TPACPI_ERR "Unknown _BCL data, "
1047                                "please report this to %s\n", TPACPI_MAIL);
1048                         rc = 0;
1049                 } else {
1050                         rc = obj->package.count;
1051                 }
1052         } else {
1053                 return 0;
1054         }
1055
1056         kfree(buffer.pointer);
1057         return rc;
1058 }
1059
1060 static acpi_status __init tpacpi_acpi_walk_find_bcl(acpi_handle handle,
1061                                         u32 lvl, void *context, void **rv)
1062 {
1063         char name[ACPI_PATH_SEGMENT_LENGTH];
1064         struct acpi_buffer buffer = { sizeof(name), &name };
1065
1066         if (ACPI_SUCCESS(acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer)) &&
1067             !strncmp("_BCL", name, sizeof(name) - 1)) {
1068                 BUG_ON(!rv || !*rv);
1069                 **(int **)rv = tpacpi_query_bcl_levels(handle);
1070                 return AE_CTRL_TERMINATE;
1071         } else {
1072                 return AE_OK;
1073         }
1074 }
1075
1076 /*
1077  * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
1078  */
1079 static int __init tpacpi_check_std_acpi_brightness_support(void)
1080 {
1081         int status;
1082         int bcl_levels = 0;
1083         void *bcl_ptr = &bcl_levels;
1084
1085         if (!vid_handle) {
1086                 TPACPI_ACPIHANDLE_INIT(vid);
1087         }
1088         if (!vid_handle)
1089                 return 0;
1090
1091         /*
1092          * Search for a _BCL method, and execute it.  This is safe on all
1093          * ThinkPads, and as a side-effect, _BCL will place a Lenovo Vista
1094          * BIOS in ACPI backlight control mode.  We do NOT have to care
1095          * about calling the _BCL method in an enabled video device, any
1096          * will do for our purposes.
1097          */
1098
1099         status = acpi_walk_namespace(ACPI_TYPE_METHOD, vid_handle, 3,
1100                                      tpacpi_acpi_walk_find_bcl, NULL, NULL,
1101                                      &bcl_ptr);
1102
1103         if (ACPI_SUCCESS(status) && bcl_levels > 2) {
1104                 tp_features.bright_acpimode = 1;
1105                 return (bcl_levels - 2);
1106         }
1107
1108         return 0;
1109 }
1110
1111 static void printk_deprecated_attribute(const char * const what,
1112                                         const char * const details)
1113 {
1114         tpacpi_log_usertask("deprecated sysfs attribute");
1115         printk(TPACPI_WARN "WARNING: sysfs attribute %s is deprecated and "
1116                 "will be removed. %s\n",
1117                 what, details);
1118 }
1119
1120 /*************************************************************************
1121  * rfkill and radio control support helpers
1122  */
1123
1124 /*
1125  * ThinkPad-ACPI firmware handling model:
1126  *
1127  * WLSW (master wireless switch) is event-driven, and is common to all
1128  * firmware-controlled radios.  It cannot be controlled, just monitored,
1129  * as expected.  It overrides all radio state in firmware
1130  *
1131  * The kernel, a masked-off hotkey, and WLSW can change the radio state
1132  * (TODO: verify how WLSW interacts with the returned radio state).
1133  *
1134  * The only time there are shadow radio state changes, is when
1135  * masked-off hotkeys are used.
1136  */
1137
1138 /*
1139  * Internal driver API for radio state:
1140  *
1141  * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1142  * bool: true means radio blocked (off)
1143  */
1144 enum tpacpi_rfkill_state {
1145         TPACPI_RFK_RADIO_OFF = 0,
1146         TPACPI_RFK_RADIO_ON
1147 };
1148
1149 /* rfkill switches */
1150 enum tpacpi_rfk_id {
1151         TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1152         TPACPI_RFK_WWAN_SW_ID,
1153         TPACPI_RFK_UWB_SW_ID,
1154         TPACPI_RFK_SW_MAX
1155 };
1156
1157 static const char *tpacpi_rfkill_names[] = {
1158         [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1159         [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1160         [TPACPI_RFK_UWB_SW_ID] = "uwb",
1161         [TPACPI_RFK_SW_MAX] = NULL
1162 };
1163
1164 /* ThinkPad-ACPI rfkill subdriver */
1165 struct tpacpi_rfk {
1166         struct rfkill *rfkill;
1167         enum tpacpi_rfk_id id;
1168         const struct tpacpi_rfk_ops *ops;
1169 };
1170
1171 struct tpacpi_rfk_ops {
1172         /* firmware interface */
1173         int (*get_status)(void);
1174         int (*set_status)(const enum tpacpi_rfkill_state);
1175 };
1176
1177 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1178
1179 /* Query FW and update rfkill sw state for a given rfkill switch */
1180 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1181 {
1182         int status;
1183
1184         if (!tp_rfk)
1185                 return -ENODEV;
1186
1187         status = (tp_rfk->ops->get_status)();
1188         if (status < 0)
1189                 return status;
1190
1191         rfkill_set_sw_state(tp_rfk->rfkill,
1192                             (status == TPACPI_RFK_RADIO_OFF));
1193
1194         return status;
1195 }
1196
1197 /* Query FW and update rfkill sw state for all rfkill switches */
1198 static void tpacpi_rfk_update_swstate_all(void)
1199 {
1200         unsigned int i;
1201
1202         for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1203                 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1204 }
1205
1206 /*
1207  * Sync the HW-blocking state of all rfkill switches,
1208  * do notice it causes the rfkill core to schedule uevents
1209  */
1210 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1211 {
1212         unsigned int i;
1213         struct tpacpi_rfk *tp_rfk;
1214
1215         for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1216                 tp_rfk = tpacpi_rfkill_switches[i];
1217                 if (tp_rfk) {
1218                         if (rfkill_set_hw_state(tp_rfk->rfkill,
1219                                                 blocked)) {
1220                                 /* ignore -- we track sw block */
1221                         }
1222                 }
1223         }
1224 }
1225
1226 /* Call to get the WLSW state from the firmware */
1227 static int hotkey_get_wlsw(void);
1228
1229 /* Call to query WLSW state and update all rfkill switches */
1230 static bool tpacpi_rfk_check_hwblock_state(void)
1231 {
1232         int res = hotkey_get_wlsw();
1233         int hw_blocked;
1234
1235         /* When unknown or unsupported, we have to assume it is unblocked */
1236         if (res < 0)
1237                 return false;
1238
1239         hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1240         tpacpi_rfk_update_hwblock_state(hw_blocked);
1241
1242         return hw_blocked;
1243 }
1244
1245 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1246 {
1247         struct tpacpi_rfk *tp_rfk = data;
1248         int res;
1249
1250         dbg_printk(TPACPI_DBG_RFKILL,
1251                    "request to change radio state to %s\n",
1252                    blocked ? "blocked" : "unblocked");
1253
1254         /* try to set radio state */
1255         res = (tp_rfk->ops->set_status)(blocked ?
1256                                 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1257
1258         /* and update the rfkill core with whatever the FW really did */
1259         tpacpi_rfk_update_swstate(tp_rfk);
1260
1261         return (res < 0) ? res : 0;
1262 }
1263
1264 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1265         .set_block = tpacpi_rfk_hook_set_block,
1266 };
1267
1268 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1269                         const struct tpacpi_rfk_ops *tp_rfkops,
1270                         const enum rfkill_type rfktype,
1271                         const char *name,
1272                         const bool set_default)
1273 {
1274         struct tpacpi_rfk *atp_rfk;
1275         int res;
1276         bool sw_state = false;
1277         bool hw_state;
1278         int sw_status;
1279
1280         BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1281
1282         atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1283         if (atp_rfk)
1284                 atp_rfk->rfkill = rfkill_alloc(name,
1285                                                 &tpacpi_pdev->dev,
1286                                                 rfktype,
1287                                                 &tpacpi_rfk_rfkill_ops,
1288                                                 atp_rfk);
1289         if (!atp_rfk || !atp_rfk->rfkill) {
1290                 printk(TPACPI_ERR
1291                         "failed to allocate memory for rfkill class\n");
1292                 kfree(atp_rfk);
1293                 return -ENOMEM;
1294         }
1295
1296         atp_rfk->id = id;
1297         atp_rfk->ops = tp_rfkops;
1298
1299         sw_status = (tp_rfkops->get_status)();
1300         if (sw_status < 0) {
1301                 printk(TPACPI_ERR
1302                         "failed to read initial state for %s, error %d\n",
1303                         name, sw_status);
1304         } else {
1305                 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1306                 if (set_default) {
1307                         /* try to keep the initial state, since we ask the
1308                          * firmware to preserve it across S5 in NVRAM */
1309                         rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1310                 }
1311         }
1312         hw_state = tpacpi_rfk_check_hwblock_state();
1313         rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1314
1315         res = rfkill_register(atp_rfk->rfkill);
1316         if (res < 0) {
1317                 printk(TPACPI_ERR
1318                         "failed to register %s rfkill switch: %d\n",
1319                         name, res);
1320                 rfkill_destroy(atp_rfk->rfkill);
1321                 kfree(atp_rfk);
1322                 return res;
1323         }
1324
1325         tpacpi_rfkill_switches[id] = atp_rfk;
1326
1327         printk(TPACPI_INFO "rfkill switch %s: radio is %sblocked\n",
1328                 name, (sw_state || hw_state) ? "" : "un");
1329         return 0;
1330 }
1331
1332 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1333 {
1334         struct tpacpi_rfk *tp_rfk;
1335
1336         BUG_ON(id >= TPACPI_RFK_SW_MAX);
1337
1338         tp_rfk = tpacpi_rfkill_switches[id];
1339         if (tp_rfk) {
1340                 rfkill_unregister(tp_rfk->rfkill);
1341                 rfkill_destroy(tp_rfk->rfkill);
1342                 tpacpi_rfkill_switches[id] = NULL;
1343                 kfree(tp_rfk);
1344         }
1345 }
1346
1347 static void printk_deprecated_rfkill_attribute(const char * const what)
1348 {
1349         printk_deprecated_attribute(what,
1350                         "Please switch to generic rfkill before year 2010");
1351 }
1352
1353 /* sysfs <radio> enable ------------------------------------------------ */
1354 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1355                                             struct device_attribute *attr,
1356                                             char *buf)
1357 {
1358         int status;
1359
1360         printk_deprecated_rfkill_attribute(attr->attr.name);
1361
1362         /* This is in the ABI... */
1363         if (tpacpi_rfk_check_hwblock_state()) {
1364                 status = TPACPI_RFK_RADIO_OFF;
1365         } else {
1366                 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1367                 if (status < 0)
1368                         return status;
1369         }
1370
1371         return snprintf(buf, PAGE_SIZE, "%d\n",
1372                         (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1373 }
1374
1375 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1376                             struct device_attribute *attr,
1377                             const char *buf, size_t count)
1378 {
1379         unsigned long t;
1380         int res;
1381
1382         printk_deprecated_rfkill_attribute(attr->attr.name);
1383
1384         if (parse_strtoul(buf, 1, &t))
1385                 return -EINVAL;
1386
1387         tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1388
1389         /* This is in the ABI... */
1390         if (tpacpi_rfk_check_hwblock_state() && !!t)
1391                 return -EPERM;
1392
1393         res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1394                                 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1395         tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1396
1397         return (res < 0) ? res : count;
1398 }
1399
1400 /* procfs -------------------------------------------------------------- */
1401 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1402 {
1403         if (id >= TPACPI_RFK_SW_MAX)
1404                 seq_printf(m, "status:\t\tnot supported\n");
1405         else {
1406                 int status;
1407
1408                 /* This is in the ABI... */
1409                 if (tpacpi_rfk_check_hwblock_state()) {
1410                         status = TPACPI_RFK_RADIO_OFF;
1411                 } else {
1412                         status = tpacpi_rfk_update_swstate(
1413                                                 tpacpi_rfkill_switches[id]);
1414                         if (status < 0)
1415                                 return status;
1416                 }
1417
1418                 seq_printf(m, "status:\t\t%s\n",
1419                                 (status == TPACPI_RFK_RADIO_ON) ?
1420                                         "enabled" : "disabled");
1421                 seq_printf(m, "commands:\tenable, disable\n");
1422         }
1423
1424         return 0;
1425 }
1426
1427 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1428 {
1429         char *cmd;
1430         int status = -1;
1431         int res = 0;
1432
1433         if (id >= TPACPI_RFK_SW_MAX)
1434                 return -ENODEV;
1435
1436         while ((cmd = next_cmd(&buf))) {
1437                 if (strlencmp(cmd, "enable") == 0)
1438                         status = TPACPI_RFK_RADIO_ON;
1439                 else if (strlencmp(cmd, "disable") == 0)
1440                         status = TPACPI_RFK_RADIO_OFF;
1441                 else
1442                         return -EINVAL;
1443         }
1444
1445         if (status != -1) {
1446                 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1447                                 (status == TPACPI_RFK_RADIO_ON) ?
1448                                                 "enable" : "disable",
1449                                 tpacpi_rfkill_names[id]);
1450                 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1451                 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1452         }
1453
1454         return res;
1455 }
1456
1457 /*************************************************************************
1458  * thinkpad-acpi driver attributes
1459  */
1460
1461 /* interface_version --------------------------------------------------- */
1462 static ssize_t tpacpi_driver_interface_version_show(
1463                                 struct device_driver *drv,
1464                                 char *buf)
1465 {
1466         return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1467 }
1468
1469 static DRIVER_ATTR(interface_version, S_IRUGO,
1470                 tpacpi_driver_interface_version_show, NULL);
1471
1472 /* debug_level --------------------------------------------------------- */
1473 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1474                                                 char *buf)
1475 {
1476         return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1477 }
1478
1479 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1480                                                 const char *buf, size_t count)
1481 {
1482         unsigned long t;
1483
1484         if (parse_strtoul(buf, 0xffff, &t))
1485                 return -EINVAL;
1486
1487         dbg_level = t;
1488
1489         return count;
1490 }
1491
1492 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1493                 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1494
1495 /* version ------------------------------------------------------------- */
1496 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1497                                                 char *buf)
1498 {
1499         return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1500                         TPACPI_DESC, TPACPI_VERSION);
1501 }
1502
1503 static DRIVER_ATTR(version, S_IRUGO,
1504                 tpacpi_driver_version_show, NULL);
1505
1506 /* --------------------------------------------------------------------- */
1507
1508 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1509
1510 /* wlsw_emulstate ------------------------------------------------------ */
1511 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1512                                                 char *buf)
1513 {
1514         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1515 }
1516
1517 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1518                                                 const char *buf, size_t count)
1519 {
1520         unsigned long t;
1521
1522         if (parse_strtoul(buf, 1, &t))
1523                 return -EINVAL;
1524
1525         if (tpacpi_wlsw_emulstate != !!t) {
1526                 tpacpi_wlsw_emulstate = !!t;
1527                 tpacpi_rfk_update_hwblock_state(!t);    /* negative logic */
1528         }
1529
1530         return count;
1531 }
1532
1533 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1534                 tpacpi_driver_wlsw_emulstate_show,
1535                 tpacpi_driver_wlsw_emulstate_store);
1536
1537 /* bluetooth_emulstate ------------------------------------------------- */
1538 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1539                                         struct device_driver *drv,
1540                                         char *buf)
1541 {
1542         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1543 }
1544
1545 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1546                                         struct device_driver *drv,
1547                                         const char *buf, size_t count)
1548 {
1549         unsigned long t;
1550
1551         if (parse_strtoul(buf, 1, &t))
1552                 return -EINVAL;
1553
1554         tpacpi_bluetooth_emulstate = !!t;
1555
1556         return count;
1557 }
1558
1559 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1560                 tpacpi_driver_bluetooth_emulstate_show,
1561                 tpacpi_driver_bluetooth_emulstate_store);
1562
1563 /* wwan_emulstate ------------------------------------------------- */
1564 static ssize_t tpacpi_driver_wwan_emulstate_show(
1565                                         struct device_driver *drv,
1566                                         char *buf)
1567 {
1568         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1569 }
1570
1571 static ssize_t tpacpi_driver_wwan_emulstate_store(
1572                                         struct device_driver *drv,
1573                                         const char *buf, size_t count)
1574 {
1575         unsigned long t;
1576
1577         if (parse_strtoul(buf, 1, &t))
1578                 return -EINVAL;
1579
1580         tpacpi_wwan_emulstate = !!t;
1581
1582         return count;
1583 }
1584
1585 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1586                 tpacpi_driver_wwan_emulstate_show,
1587                 tpacpi_driver_wwan_emulstate_store);
1588
1589 /* uwb_emulstate ------------------------------------------------- */
1590 static ssize_t tpacpi_driver_uwb_emulstate_show(
1591                                         struct device_driver *drv,
1592                                         char *buf)
1593 {
1594         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1595 }
1596
1597 static ssize_t tpacpi_driver_uwb_emulstate_store(
1598                                         struct device_driver *drv,
1599                                         const char *buf, size_t count)
1600 {
1601         unsigned long t;
1602
1603         if (parse_strtoul(buf, 1, &t))
1604                 return -EINVAL;
1605
1606         tpacpi_uwb_emulstate = !!t;
1607
1608         return count;
1609 }
1610
1611 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1612                 tpacpi_driver_uwb_emulstate_show,
1613                 tpacpi_driver_uwb_emulstate_store);
1614 #endif
1615
1616 /* --------------------------------------------------------------------- */
1617
1618 static struct driver_attribute *tpacpi_driver_attributes[] = {
1619         &driver_attr_debug_level, &driver_attr_version,
1620         &driver_attr_interface_version,
1621 };
1622
1623 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1624 {
1625         int i, res;
1626
1627         i = 0;
1628         res = 0;
1629         while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1630                 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1631                 i++;
1632         }
1633
1634 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1635         if (!res && dbg_wlswemul)
1636                 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1637         if (!res && dbg_bluetoothemul)
1638                 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1639         if (!res && dbg_wwanemul)
1640                 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1641         if (!res && dbg_uwbemul)
1642                 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1643 #endif
1644
1645         return res;
1646 }
1647
1648 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1649 {
1650         int i;
1651
1652         for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1653                 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1654
1655 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1656         driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1657         driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1658         driver_remove_file(drv, &driver_attr_wwan_emulstate);
1659         driver_remove_file(drv, &driver_attr_uwb_emulstate);
1660 #endif
1661 }
1662
1663 /*************************************************************************
1664  * Firmware Data
1665  */
1666
1667 /*
1668  * Table of recommended minimum BIOS versions
1669  *
1670  * Reasons for listing:
1671  *    1. Stable BIOS, listed because the unknown amount of
1672  *       bugs and bad ACPI behaviour on older versions
1673  *
1674  *    2. BIOS or EC fw with known bugs that trigger on Linux
1675  *
1676  *    3. BIOS with known reduced functionality in older versions
1677  *
1678  *  We recommend the latest BIOS and EC version.
1679  *  We only support the latest BIOS and EC fw version as a rule.
1680  *
1681  *  Sources: IBM ThinkPad Public Web Documents (update changelogs),
1682  *  Information from users in ThinkWiki
1683  *
1684  *  WARNING: we use this table also to detect that the machine is
1685  *  a ThinkPad in some cases, so don't remove entries lightly.
1686  */
1687
1688 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2)          \
1689         { .vendor       = (__v),                        \
1690           .bios         = TPID(__id1, __id2),           \
1691           .ec           = TPACPI_MATCH_ANY,             \
1692           .quirks       = TPACPI_MATCH_ANY << 16        \
1693                           | (__bv1) << 8 | (__bv2) }
1694
1695 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2,      \
1696                 __eid, __ev1, __ev2)                    \
1697         { .vendor       = (__v),                        \
1698           .bios         = TPID(__bid1, __bid2),         \
1699           .ec           = __eid,                        \
1700           .quirks       = (__ev1) << 24 | (__ev2) << 16 \
1701                           | (__bv1) << 8 | (__bv2) }
1702
1703 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1704         TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1705
1706 /* Outdated IBM BIOSes often lack the EC id string */
1707 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1708         TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2,        \
1709                 __bv1, __bv2, TPID(__id1, __id2),       \
1710                 __ev1, __ev2),                          \
1711         TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2,        \
1712                 __bv1, __bv2, TPACPI_MATCH_UNKNOWN,     \
1713                 __ev1, __ev2)
1714
1715 /* Outdated IBM BIOSes often lack the EC id string */
1716 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2,           \
1717                 __eid1, __eid2, __ev1, __ev2)           \
1718         TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2,      \
1719                 __bv1, __bv2, TPID(__eid1, __eid2),     \
1720                 __ev1, __ev2),                          \
1721         TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2,      \
1722                 __bv1, __bv2, TPACPI_MATCH_UNKNOWN,     \
1723                 __ev1, __ev2)
1724
1725 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1726         TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1727
1728 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1729         TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2,     \
1730                 __bv1, __bv2, TPID(__id1, __id2),       \
1731                 __ev1, __ev2)
1732
1733 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2,           \
1734                 __eid1, __eid2, __ev1, __ev2)           \
1735         TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2,   \
1736                 __bv1, __bv2, TPID(__eid1, __eid2),     \
1737                 __ev1, __ev2)
1738
1739 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1740         /*  Numeric models ------------------ */
1741         /*      FW MODEL   BIOS VERS          */
1742         TPV_QI0('I', 'M',  '6', '5'),            /* 570 */
1743         TPV_QI0('I', 'U',  '2', '6'),            /* 570E */
1744         TPV_QI0('I', 'B',  '5', '4'),            /* 600 */
1745         TPV_QI0('I', 'H',  '4', '7'),            /* 600E */
1746         TPV_QI0('I', 'N',  '3', '6'),            /* 600E */
1747         TPV_QI0('I', 'T',  '5', '5'),            /* 600X */
1748         TPV_QI0('I', 'D',  '4', '8'),            /* 770, 770E, 770ED */
1749         TPV_QI0('I', 'I',  '4', '2'),            /* 770X */
1750         TPV_QI0('I', 'O',  '2', '3'),            /* 770Z */
1751
1752         /* A-series ------------------------- */
1753         /*      FW MODEL   BIOS VERS  EC VERS */
1754         TPV_QI0('I', 'W',  '5', '9'),            /* A20m */
1755         TPV_QI0('I', 'V',  '6', '9'),            /* A20p */
1756         TPV_QI0('1', '0',  '2', '6'),            /* A21e, A22e */
1757         TPV_QI0('K', 'U',  '3', '6'),            /* A21e */
1758         TPV_QI0('K', 'X',  '3', '6'),            /* A21m, A22m */
1759         TPV_QI0('K', 'Y',  '3', '8'),            /* A21p, A22p */
1760         TPV_QI0('1', 'B',  '1', '7'),            /* A22e */
1761         TPV_QI0('1', '3',  '2', '0'),            /* A22m */
1762         TPV_QI0('1', 'E',  '7', '3'),            /* A30/p (0) */
1763         TPV_QI1('1', 'G',  '4', '1',  '1', '7'), /* A31/p (0) */
1764         TPV_QI1('1', 'N',  '1', '6',  '0', '7'), /* A31/p (0) */
1765
1766         /* G-series ------------------------- */
1767         /*      FW MODEL   BIOS VERS          */
1768         TPV_QI0('1', 'T',  'A', '6'),            /* G40 */
1769         TPV_QI0('1', 'X',  '5', '7'),            /* G41 */
1770
1771         /* R-series, T-series --------------- */
1772         /*      FW MODEL   BIOS VERS  EC VERS */
1773         TPV_QI0('1', 'C',  'F', '0'),            /* R30 */
1774         TPV_QI0('1', 'F',  'F', '1'),            /* R31 */
1775         TPV_QI0('1', 'M',  '9', '7'),            /* R32 */
1776         TPV_QI0('1', 'O',  '6', '1'),            /* R40 */
1777         TPV_QI0('1', 'P',  '6', '5'),            /* R40 */
1778         TPV_QI0('1', 'S',  '7', '0'),            /* R40e */
1779         TPV_QI1('1', 'R',  'D', 'R',  '7', '1'), /* R50/p, R51,
1780                                                     T40/p, T41/p, T42/p (1) */
1781         TPV_QI1('1', 'V',  '7', '1',  '2', '8'), /* R50e, R51 (1) */
1782         TPV_QI1('7', '8',  '7', '1',  '0', '6'), /* R51e (1) */
1783         TPV_QI1('7', '6',  '6', '9',  '1', '6'), /* R52 (1) */
1784         TPV_QI1('7', '0',  '6', '9',  '2', '8'), /* R52, T43 (1) */
1785
1786         TPV_QI0('I', 'Y',  '6', '1'),            /* T20 */
1787         TPV_QI0('K', 'Z',  '3', '4'),            /* T21 */
1788         TPV_QI0('1', '6',  '3', '2'),            /* T22 */
1789         TPV_QI1('1', 'A',  '6', '4',  '2', '3'), /* T23 (0) */
1790         TPV_QI1('1', 'I',  '7', '1',  '2', '0'), /* T30 (0) */
1791         TPV_QI1('1', 'Y',  '6', '5',  '2', '9'), /* T43/p (1) */
1792
1793         TPV_QL1('7', '9',  'E', '3',  '5', '0'), /* T60/p */
1794         TPV_QL1('7', 'C',  'D', '2',  '2', '2'), /* R60, R60i */
1795         TPV_QL1('7', 'E',  'D', '0',  '1', '5'), /* R60e, R60i */
1796
1797         /*      BIOS FW    BIOS VERS  EC FW     EC VERS */
1798         TPV_QI2('1', 'W',  '9', '0',  '1', 'V', '2', '8'), /* R50e (1) */
1799         TPV_QL2('7', 'I',  '3', '4',  '7', '9', '5', '0'), /* T60/p wide */
1800
1801         /* X-series ------------------------- */
1802         /*      FW MODEL   BIOS VERS  EC VERS */
1803         TPV_QI0('I', 'Z',  '9', 'D'),            /* X20, X21 */
1804         TPV_QI0('1', 'D',  '7', '0'),            /* X22, X23, X24 */
1805         TPV_QI1('1', 'K',  '4', '8',  '1', '8'), /* X30 (0) */
1806         TPV_QI1('1', 'Q',  '9', '7',  '2', '3'), /* X31, X32 (0) */
1807         TPV_QI1('1', 'U',  'D', '3',  'B', '2'), /* X40 (0) */
1808         TPV_QI1('7', '4',  '6', '4',  '2', '7'), /* X41 (0) */
1809         TPV_QI1('7', '5',  '6', '0',  '2', '0'), /* X41t (0) */
1810
1811         TPV_QL1('7', 'B',  'D', '7',  '4', '0'), /* X60/s */
1812         TPV_QL1('7', 'J',  '3', '0',  '1', '3'), /* X60t */
1813
1814         /* (0) - older versions lack DMI EC fw string and functionality */
1815         /* (1) - older versions known to lack functionality */
1816 };
1817
1818 #undef TPV_QL1
1819 #undef TPV_QL0
1820 #undef TPV_QI2
1821 #undef TPV_QI1
1822 #undef TPV_QI0
1823 #undef TPV_Q_X
1824 #undef TPV_Q
1825
1826 static void __init tpacpi_check_outdated_fw(void)
1827 {
1828         unsigned long fwvers;
1829         u16 ec_version, bios_version;
1830
1831         fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1832                                 ARRAY_SIZE(tpacpi_bios_version_qtable));
1833
1834         if (!fwvers)
1835                 return;
1836
1837         bios_version = fwvers & 0xffffU;
1838         ec_version = (fwvers >> 16) & 0xffffU;
1839
1840         /* note that unknown versions are set to 0x0000 and we use that */
1841         if ((bios_version > thinkpad_id.bios_release) ||
1842             (ec_version > thinkpad_id.ec_release &&
1843                                 ec_version != TPACPI_MATCH_ANY)) {
1844                 /*
1845                  * The changelogs would let us track down the exact
1846                  * reason, but it is just too much of a pain to track
1847                  * it.  We only list BIOSes that are either really
1848                  * broken, or really stable to begin with, so it is
1849                  * best if the user upgrades the firmware anyway.
1850                  */
1851                 printk(TPACPI_WARN
1852                         "WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1853                 printk(TPACPI_WARN
1854                         "WARNING: This firmware may be missing critical bug "
1855                         "fixes and/or important features\n");
1856         }
1857 }
1858
1859 static bool __init tpacpi_is_fw_known(void)
1860 {
1861         return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1862                         ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1863 }
1864
1865 /****************************************************************************
1866  ****************************************************************************
1867  *
1868  * Subdrivers
1869  *
1870  ****************************************************************************
1871  ****************************************************************************/
1872
1873 /*************************************************************************
1874  * thinkpad-acpi init subdriver
1875  */
1876
1877 static int __init thinkpad_acpi_driver_init(struct ibm_init_struct *iibm)
1878 {
1879         printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
1880         printk(TPACPI_INFO "%s\n", TPACPI_URL);
1881
1882         printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
1883                 (thinkpad_id.bios_version_str) ?
1884                         thinkpad_id.bios_version_str : "unknown",
1885                 (thinkpad_id.ec_version_str) ?
1886                         thinkpad_id.ec_version_str : "unknown");
1887
1888         if (thinkpad_id.vendor && thinkpad_id.model_str)
1889                 printk(TPACPI_INFO "%s %s, model %s\n",
1890                         (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
1891                                 "IBM" : ((thinkpad_id.vendor ==
1892                                                 PCI_VENDOR_ID_LENOVO) ?
1893                                         "Lenovo" : "Unknown vendor"),
1894                         thinkpad_id.model_str,
1895                         (thinkpad_id.nummodel_str) ?
1896                                 thinkpad_id.nummodel_str : "unknown");
1897
1898         tpacpi_check_outdated_fw();
1899         return 0;
1900 }
1901
1902 static int thinkpad_acpi_driver_read(struct seq_file *m)
1903 {
1904         seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1905         seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1906         return 0;
1907 }
1908
1909 static struct ibm_struct thinkpad_acpi_driver_data = {
1910         .name = "driver",
1911         .read = thinkpad_acpi_driver_read,
1912 };
1913
1914 /*************************************************************************
1915  * Hotkey subdriver
1916  */
1917
1918 /*
1919  * ThinkPad firmware event model
1920  *
1921  * The ThinkPad firmware has two main event interfaces: normal ACPI
1922  * notifications (which follow the ACPI standard), and a private event
1923  * interface.
1924  *
1925  * The private event interface also issues events for the hotkeys.  As
1926  * the driver gained features, the event handling code ended up being
1927  * built around the hotkey subdriver.  This will need to be refactored
1928  * to a more formal event API eventually.
1929  *
1930  * Some "hotkeys" are actually supposed to be used as event reports,
1931  * such as "brightness has changed", "volume has changed", depending on
1932  * the ThinkPad model and how the firmware is operating.
1933  *
1934  * Unlike other classes, hotkey-class events have mask/unmask control on
1935  * non-ancient firmware.  However, how it behaves changes a lot with the
1936  * firmware model and version.
1937  */
1938
1939 enum {  /* hot key scan codes (derived from ACPI DSDT) */
1940         TP_ACPI_HOTKEYSCAN_FNF1         = 0,
1941         TP_ACPI_HOTKEYSCAN_FNF2,
1942         TP_ACPI_HOTKEYSCAN_FNF3,
1943         TP_ACPI_HOTKEYSCAN_FNF4,
1944         TP_ACPI_HOTKEYSCAN_FNF5,
1945         TP_ACPI_HOTKEYSCAN_FNF6,
1946         TP_ACPI_HOTKEYSCAN_FNF7,
1947         TP_ACPI_HOTKEYSCAN_FNF8,
1948         TP_ACPI_HOTKEYSCAN_FNF9,
1949         TP_ACPI_HOTKEYSCAN_FNF10,
1950         TP_ACPI_HOTKEYSCAN_FNF11,
1951         TP_ACPI_HOTKEYSCAN_FNF12,
1952         TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1953         TP_ACPI_HOTKEYSCAN_FNINSERT,
1954         TP_ACPI_HOTKEYSCAN_FNDELETE,
1955         TP_ACPI_HOTKEYSCAN_FNHOME,
1956         TP_ACPI_HOTKEYSCAN_FNEND,
1957         TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1958         TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1959         TP_ACPI_HOTKEYSCAN_FNSPACE,
1960         TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1961         TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1962         TP_ACPI_HOTKEYSCAN_MUTE,
1963         TP_ACPI_HOTKEYSCAN_THINKPAD,
1964 };
1965
1966 enum {  /* Keys/events available through NVRAM polling */
1967         TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1968         TPACPI_HKEY_NVRAM_GOOD_MASK  = 0x00fb8000U,
1969 };
1970
1971 enum {  /* Positions of some of the keys in hotkey masks */
1972         TP_ACPI_HKEY_DISPSWTCH_MASK     = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1973         TP_ACPI_HKEY_DISPXPAND_MASK     = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1974         TP_ACPI_HKEY_HIBERNATE_MASK     = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1975         TP_ACPI_HKEY_BRGHTUP_MASK       = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1976         TP_ACPI_HKEY_BRGHTDWN_MASK      = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1977         TP_ACPI_HKEY_THNKLGHT_MASK      = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1978         TP_ACPI_HKEY_ZOOM_MASK          = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1979         TP_ACPI_HKEY_VOLUP_MASK         = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1980         TP_ACPI_HKEY_VOLDWN_MASK        = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1981         TP_ACPI_HKEY_MUTE_MASK          = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1982         TP_ACPI_HKEY_THINKPAD_MASK      = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1983 };
1984
1985 enum {  /* NVRAM to ACPI HKEY group map */
1986         TP_NVRAM_HKEY_GROUP_HK2         = TP_ACPI_HKEY_THINKPAD_MASK |
1987                                           TP_ACPI_HKEY_ZOOM_MASK |
1988                                           TP_ACPI_HKEY_DISPSWTCH_MASK |
1989                                           TP_ACPI_HKEY_HIBERNATE_MASK,
1990         TP_NVRAM_HKEY_GROUP_BRIGHTNESS  = TP_ACPI_HKEY_BRGHTUP_MASK |
1991                                           TP_ACPI_HKEY_BRGHTDWN_MASK,
1992         TP_NVRAM_HKEY_GROUP_VOLUME      = TP_ACPI_HKEY_VOLUP_MASK |
1993                                           TP_ACPI_HKEY_VOLDWN_MASK |
1994                                           TP_ACPI_HKEY_MUTE_MASK,
1995 };
1996
1997 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1998 struct tp_nvram_state {
1999        u16 thinkpad_toggle:1;
2000        u16 zoom_toggle:1;
2001        u16 display_toggle:1;
2002        u16 thinklight_toggle:1;
2003        u16 hibernate_toggle:1;
2004        u16 displayexp_toggle:1;
2005        u16 display_state:1;
2006        u16 brightness_toggle:1;
2007        u16 volume_toggle:1;
2008        u16 mute:1;
2009
2010        u8 brightness_level;
2011        u8 volume_level;
2012 };
2013
2014 /* kthread for the hotkey poller */
2015 static struct task_struct *tpacpi_hotkey_task;
2016
2017 /* Acquired while the poller kthread is running, use to sync start/stop */
2018 static struct mutex hotkey_thread_mutex;
2019
2020 /*
2021  * Acquire mutex to write poller control variables as an
2022  * atomic block.
2023  *
2024  * Increment hotkey_config_change when changing them if you
2025  * want the kthread to forget old state.
2026  *
2027  * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2028  */
2029 static struct mutex hotkey_thread_data_mutex;
2030 static unsigned int hotkey_config_change;
2031
2032 /*
2033  * hotkey poller control variables
2034  *
2035  * Must be atomic or readers will also need to acquire mutex
2036  *
2037  * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2038  * should be used only when the changes need to be taken as
2039  * a block, OR when one needs to force the kthread to forget
2040  * old state.
2041  */
2042 static u32 hotkey_source_mask;          /* bit mask 0=ACPI,1=NVRAM */
2043 static unsigned int hotkey_poll_freq = 10; /* Hz */
2044
2045 #define HOTKEY_CONFIG_CRITICAL_START \
2046         do { \
2047                 mutex_lock(&hotkey_thread_data_mutex); \
2048                 hotkey_config_change++; \
2049         } while (0);
2050 #define HOTKEY_CONFIG_CRITICAL_END \
2051         mutex_unlock(&hotkey_thread_data_mutex);
2052
2053 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2054
2055 #define hotkey_source_mask 0U
2056 #define HOTKEY_CONFIG_CRITICAL_START
2057 #define HOTKEY_CONFIG_CRITICAL_END
2058
2059 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2060
2061 static struct mutex hotkey_mutex;
2062
2063 static enum {   /* Reasons for waking up */
2064         TP_ACPI_WAKEUP_NONE = 0,        /* None or unknown */
2065         TP_ACPI_WAKEUP_BAYEJ,           /* Bay ejection request */
2066         TP_ACPI_WAKEUP_UNDOCK,          /* Undock request */
2067 } hotkey_wakeup_reason;
2068
2069 static int hotkey_autosleep_ack;
2070
2071 static u32 hotkey_orig_mask;            /* events the BIOS had enabled */
2072 static u32 hotkey_all_mask;             /* all events supported in fw */
2073 static u32 hotkey_reserved_mask;        /* events better left disabled */
2074 static u32 hotkey_driver_mask;          /* events needed by the driver */
2075 static u32 hotkey_user_mask;            /* events visible to userspace */
2076 static u32 hotkey_acpi_mask;            /* events enabled in firmware */
2077
2078 static unsigned int hotkey_report_mode;
2079
2080 static u16 *hotkey_keycode_map;
2081
2082 static struct attribute_set *hotkey_dev_attributes;
2083
2084 static void tpacpi_driver_event(const unsigned int hkey_event);
2085 static void hotkey_driver_event(const unsigned int scancode);
2086 static void hotkey_poll_setup(const bool may_warn);
2087
2088 /* HKEY.MHKG() return bits */
2089 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2090
2091 static int hotkey_get_wlsw(void)
2092 {
2093         int status;
2094
2095         if (!tp_features.hotkey_wlsw)
2096                 return -ENODEV;
2097
2098 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2099         if (dbg_wlswemul)
2100                 return (tpacpi_wlsw_emulstate) ?
2101                                 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2102 #endif
2103
2104         if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2105                 return -EIO;
2106
2107         return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2108 }
2109
2110 static int hotkey_get_tablet_mode(int *status)
2111 {
2112         int s;
2113
2114         if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2115                 return -EIO;
2116
2117         *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2118         return 0;
2119 }
2120
2121 /*
2122  * Reads current event mask from firmware, and updates
2123  * hotkey_acpi_mask accordingly.  Also resets any bits
2124  * from hotkey_user_mask that are unavailable to be
2125  * delivered (shadow requirement of the userspace ABI).
2126  *
2127  * Call with hotkey_mutex held
2128  */
2129 static int hotkey_mask_get(void)
2130 {
2131         if (tp_features.hotkey_mask) {
2132                 u32 m = 0;
2133
2134                 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2135                         return -EIO;
2136
2137                 hotkey_acpi_mask = m;
2138         } else {
2139                 /* no mask support doesn't mean no event support... */
2140                 hotkey_acpi_mask = hotkey_all_mask;
2141         }
2142
2143         /* sync userspace-visible mask */
2144         hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2145
2146         return 0;
2147 }
2148
2149 void static hotkey_mask_warn_incomplete_mask(void)
2150 {
2151         /* log only what the user can fix... */
2152         const u32 wantedmask = hotkey_driver_mask &
2153                 ~(hotkey_acpi_mask | hotkey_source_mask) &
2154                 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2155
2156         if (wantedmask)
2157                 printk(TPACPI_NOTICE
2158                         "required events 0x%08x not enabled!\n",
2159                         wantedmask);
2160 }
2161
2162 /*
2163  * Set the firmware mask when supported
2164  *
2165  * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2166  *
2167  * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2168  *
2169  * Call with hotkey_mutex held
2170  */
2171 static int hotkey_mask_set(u32 mask)
2172 {
2173         int i;
2174         int rc = 0;
2175
2176         const u32 fwmask = mask & ~hotkey_source_mask;
2177
2178         if (tp_features.hotkey_mask) {
2179                 for (i = 0; i < 32; i++) {
2180                         if (!acpi_evalf(hkey_handle,
2181                                         NULL, "MHKM", "vdd", i + 1,
2182                                         !!(mask & (1 << i)))) {
2183                                 rc = -EIO;
2184                                 break;
2185                         }
2186                 }
2187         }
2188
2189         /*
2190          * We *must* make an inconditional call to hotkey_mask_get to
2191          * refresh hotkey_acpi_mask and update hotkey_user_mask
2192          *
2193          * Take the opportunity to also log when we cannot _enable_
2194          * a given event.
2195          */
2196         if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2197                 printk(TPACPI_NOTICE
2198                        "asked for hotkey mask 0x%08x, but "
2199                        "firmware forced it to 0x%08x\n",
2200                        fwmask, hotkey_acpi_mask);
2201         }
2202
2203         if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2204                 hotkey_mask_warn_incomplete_mask();
2205
2206         return rc;
2207 }
2208
2209 /*
2210  * Sets hotkey_user_mask and tries to set the firmware mask
2211  *
2212  * Call with hotkey_mutex held
2213  */
2214 static int hotkey_user_mask_set(const u32 mask)
2215 {
2216         int rc;
2217
2218         /* Give people a chance to notice they are doing something that
2219          * is bound to go boom on their users sooner or later */
2220         if (!tp_warned.hotkey_mask_ff &&
2221             (mask == 0xffff || mask == 0xffffff ||
2222              mask == 0xffffffff)) {
2223                 tp_warned.hotkey_mask_ff = 1;
2224                 printk(TPACPI_NOTICE
2225                        "setting the hotkey mask to 0x%08x is likely "
2226                        "not the best way to go about it\n", mask);
2227                 printk(TPACPI_NOTICE
2228                        "please consider using the driver defaults, "
2229                        "and refer to up-to-date thinkpad-acpi "
2230                        "documentation\n");
2231         }
2232
2233         /* Try to enable what the user asked for, plus whatever we need.
2234          * this syncs everything but won't enable bits in hotkey_user_mask */
2235         rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2236
2237         /* Enable the available bits in hotkey_user_mask */
2238         hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2239
2240         return rc;
2241 }
2242
2243 /*
2244  * Sets the driver hotkey mask.
2245  *
2246  * Can be called even if the hotkey subdriver is inactive
2247  */
2248 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2249 {
2250         int rc;
2251
2252         /* Do the right thing if hotkey_init has not been called yet */
2253         if (!tp_features.hotkey) {
2254                 hotkey_driver_mask = mask;
2255                 return 0;
2256         }
2257
2258         mutex_lock(&hotkey_mutex);
2259
2260         HOTKEY_CONFIG_CRITICAL_START
2261         hotkey_driver_mask = mask;
2262 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2263         hotkey_source_mask |= (mask & ~hotkey_all_mask);
2264 #endif
2265         HOTKEY_CONFIG_CRITICAL_END
2266
2267         rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2268                                                         ~hotkey_source_mask);
2269         hotkey_poll_setup(true);
2270
2271         mutex_unlock(&hotkey_mutex);
2272
2273         return rc;
2274 }
2275
2276 static int hotkey_status_get(int *status)
2277 {
2278         if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2279                 return -EIO;
2280
2281         return 0;
2282 }
2283
2284 static int hotkey_status_set(bool enable)
2285 {
2286         if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2287                 return -EIO;
2288
2289         return 0;
2290 }
2291
2292 static void tpacpi_input_send_tabletsw(void)
2293 {
2294         int state;
2295
2296         if (tp_features.hotkey_tablet &&
2297             !hotkey_get_tablet_mode(&state)) {
2298                 mutex_lock(&tpacpi_inputdev_send_mutex);
2299
2300                 input_report_switch(tpacpi_inputdev,
2301                                     SW_TABLET_MODE, !!state);
2302                 input_sync(tpacpi_inputdev);
2303
2304                 mutex_unlock(&tpacpi_inputdev_send_mutex);
2305         }
2306 }
2307
2308 /* Do NOT call without validating scancode first */
2309 static void tpacpi_input_send_key(const unsigned int scancode)
2310 {
2311         const unsigned int keycode = hotkey_keycode_map[scancode];
2312
2313         if (keycode != KEY_RESERVED) {
2314                 mutex_lock(&tpacpi_inputdev_send_mutex);
2315
2316                 input_report_key(tpacpi_inputdev, keycode, 1);
2317                 if (keycode == KEY_UNKNOWN)
2318                         input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2319                                     scancode);
2320                 input_sync(tpacpi_inputdev);
2321
2322                 input_report_key(tpacpi_inputdev, keycode, 0);
2323                 if (keycode == KEY_UNKNOWN)
2324                         input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2325                                     scancode);
2326                 input_sync(tpacpi_inputdev);
2327
2328                 mutex_unlock(&tpacpi_inputdev_send_mutex);
2329         }
2330 }
2331
2332 /* Do NOT call without validating scancode first */
2333 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2334 {
2335         hotkey_driver_event(scancode);
2336         if (hotkey_user_mask & (1 << scancode))
2337                 tpacpi_input_send_key(scancode);
2338 }
2339
2340 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2341 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2342
2343 /* Do NOT call without validating scancode first */
2344 static void tpacpi_hotkey_send_key(unsigned int scancode)
2345 {
2346         tpacpi_input_send_key_masked(scancode);
2347         if (hotkey_report_mode < 2) {
2348                 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2349                                 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2350         }
2351 }
2352
2353 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2354 {
2355         u8 d;
2356
2357         if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2358                 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2359                 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2360                 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2361                 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2362                 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2363         }
2364         if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2365                 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2366                 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2367         }
2368         if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2369                 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2370                 n->displayexp_toggle =
2371                                 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2372         }
2373         if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2374                 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2375                 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2376                                 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2377                 n->brightness_toggle =
2378                                 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2379         }
2380         if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2381                 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2382                 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2383                                 >> TP_NVRAM_POS_LEVEL_VOLUME;
2384                 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2385                 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2386         }
2387 }
2388
2389 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2390                                            struct tp_nvram_state *newn,
2391                                            const u32 event_mask)
2392 {
2393
2394 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2395         do { \
2396                 if ((event_mask & (1 << __scancode)) && \
2397                     oldn->__member != newn->__member) \
2398                         tpacpi_hotkey_send_key(__scancode); \
2399         } while (0)
2400
2401 #define TPACPI_MAY_SEND_KEY(__scancode) \
2402         do { \
2403                 if (event_mask & (1 << __scancode)) \
2404                         tpacpi_hotkey_send_key(__scancode); \
2405         } while (0)
2406
2407         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2408         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2409         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2410         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2411
2412         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2413
2414         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2415
2416         /* handle volume */
2417         if (oldn->volume_toggle != newn->volume_toggle) {
2418                 if (oldn->mute != newn->mute) {
2419                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2420                 }
2421                 if (oldn->volume_level > newn->volume_level) {
2422                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2423                 } else if (oldn->volume_level < newn->volume_level) {
2424                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2425                 } else if (oldn->mute == newn->mute) {
2426                         /* repeated key presses that didn't change state */
2427                         if (newn->mute) {
2428                                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2429                         } else if (newn->volume_level != 0) {
2430                                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2431                         } else {
2432                                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2433                         }
2434                 }
2435         }
2436
2437         /* handle brightness */
2438         if (oldn->brightness_toggle != newn->brightness_toggle) {
2439                 if (oldn->brightness_level < newn->brightness_level) {
2440                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2441                 } else if (oldn->brightness_level > newn->brightness_level) {
2442                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2443                 } else {
2444                         /* repeated key presses that didn't change state */
2445                         if (newn->brightness_level != 0) {
2446                                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2447                         } else {
2448                                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2449                         }
2450                 }
2451         }
2452
2453 #undef TPACPI_COMPARE_KEY
2454 #undef TPACPI_MAY_SEND_KEY
2455 }
2456
2457 /*
2458  * Polling driver
2459  *
2460  * We track all events in hotkey_source_mask all the time, since
2461  * most of them are edge-based.  We only issue those requested by
2462  * hotkey_user_mask or hotkey_driver_mask, though.
2463  */
2464 static int hotkey_kthread(void *data)
2465 {
2466         struct tp_nvram_state s[2];
2467         u32 poll_mask, event_mask;
2468         unsigned int si, so;
2469         unsigned long t;
2470         unsigned int change_detector, must_reset;
2471         unsigned int poll_freq;
2472
2473         mutex_lock(&hotkey_thread_mutex);
2474
2475         if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2476                 goto exit;
2477
2478         set_freezable();
2479
2480         so = 0;
2481         si = 1;
2482         t = 0;
2483
2484         /* Initial state for compares */
2485         mutex_lock(&hotkey_thread_data_mutex);
2486         change_detector = hotkey_config_change;
2487         poll_mask = hotkey_source_mask;
2488         event_mask = hotkey_source_mask &
2489                         (hotkey_driver_mask | hotkey_user_mask);
2490         poll_freq = hotkey_poll_freq;
2491         mutex_unlock(&hotkey_thread_data_mutex);
2492         hotkey_read_nvram(&s[so], poll_mask);
2493
2494         while (!kthread_should_stop()) {
2495                 if (t == 0) {
2496                         if (likely(poll_freq))
2497                                 t = 1000/poll_freq;
2498                         else
2499                                 t = 100;        /* should never happen... */
2500                 }
2501                 t = msleep_interruptible(t);
2502                 if (unlikely(kthread_should_stop()))
2503                         break;
2504                 must_reset = try_to_freeze();
2505                 if (t > 0 && !must_reset)
2506                         continue;
2507
2508                 mutex_lock(&hotkey_thread_data_mutex);
2509                 if (must_reset || hotkey_config_change != change_detector) {
2510                         /* forget old state on thaw or config change */
2511                         si = so;
2512                         t = 0;
2513                         change_detector = hotkey_config_change;
2514                 }
2515                 poll_mask = hotkey_source_mask;
2516                 event_mask = hotkey_source_mask &
2517                                 (hotkey_driver_mask | hotkey_user_mask);
2518                 poll_freq = hotkey_poll_freq;
2519                 mutex_unlock(&hotkey_thread_data_mutex);
2520
2521                 if (likely(poll_mask)) {
2522                         hotkey_read_nvram(&s[si], poll_mask);
2523                         if (likely(si != so)) {
2524                                 hotkey_compare_and_issue_event(&s[so], &s[si],
2525                                                                 event_mask);
2526                         }
2527                 }
2528
2529                 so = si;
2530                 si ^= 1;
2531         }
2532
2533 exit:
2534         mutex_unlock(&hotkey_thread_mutex);
2535         return 0;
2536 }
2537
2538 /* call with hotkey_mutex held */
2539 static void hotkey_poll_stop_sync(void)
2540 {
2541         if (tpacpi_hotkey_task) {
2542                 if (frozen(tpacpi_hotkey_task) ||
2543                     freezing(tpacpi_hotkey_task))
2544                         thaw_process(tpacpi_hotkey_task);
2545
2546                 kthread_stop(tpacpi_hotkey_task);
2547                 tpacpi_hotkey_task = NULL;
2548                 mutex_lock(&hotkey_thread_mutex);
2549                 /* at this point, the thread did exit */
2550                 mutex_unlock(&hotkey_thread_mutex);
2551         }
2552 }
2553
2554 /* call with hotkey_mutex held */
2555 static void hotkey_poll_setup(const bool may_warn)
2556 {
2557         const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2558         const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2559
2560         if (hotkey_poll_freq > 0 &&
2561             (poll_driver_mask ||
2562              (poll_user_mask && tpacpi_inputdev->users > 0))) {
2563                 if (!tpacpi_hotkey_task) {
2564                         tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2565                                         NULL, TPACPI_NVRAM_KTHREAD_NAME);
2566                         if (IS_ERR(tpacpi_hotkey_task)) {
2567                                 tpacpi_hotkey_task = NULL;
2568                                 printk(TPACPI_ERR
2569                                        "could not create kernel thread "
2570                                        "for hotkey polling\n");
2571                         }
2572                 }
2573         } else {
2574                 hotkey_poll_stop_sync();
2575                 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2576                     hotkey_poll_freq == 0) {
2577                         printk(TPACPI_NOTICE
2578                                 "hot keys 0x%08x and/or events 0x%08x "
2579                                 "require polling, which is currently "
2580                                 "disabled\n",
2581                                 poll_user_mask, poll_driver_mask);
2582                 }
2583         }
2584 }
2585
2586 static void hotkey_poll_setup_safe(const bool may_warn)
2587 {
2588         mutex_lock(&hotkey_mutex);
2589         hotkey_poll_setup(may_warn);
2590         mutex_unlock(&hotkey_mutex);
2591 }
2592
2593 /* call with hotkey_mutex held */
2594 static void hotkey_poll_set_freq(unsigned int freq)
2595 {
2596         if (!freq)
2597                 hotkey_poll_stop_sync();
2598
2599         hotkey_poll_freq = freq;
2600 }
2601
2602 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2603
2604 static void hotkey_poll_setup(const bool __unused)
2605 {
2606 }
2607
2608 static void hotkey_poll_setup_safe(const bool __unused)
2609 {
2610 }
2611
2612 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2613
2614 static int hotkey_inputdev_open(struct input_dev *dev)
2615 {
2616         switch (tpacpi_lifecycle) {
2617         case TPACPI_LIFE_INIT:
2618         case TPACPI_LIFE_RUNNING:
2619                 hotkey_poll_setup_safe(false);
2620                 return 0;
2621         case TPACPI_LIFE_EXITING:
2622                 return -EBUSY;
2623         }
2624
2625         /* Should only happen if tpacpi_lifecycle is corrupt */
2626         BUG();
2627         return -EBUSY;
2628 }
2629
2630 static void hotkey_inputdev_close(struct input_dev *dev)
2631 {
2632         /* disable hotkey polling when possible */
2633         if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2634             !(hotkey_source_mask & hotkey_driver_mask))
2635                 hotkey_poll_setup_safe(false);
2636 }
2637
2638 /* sysfs hotkey enable ------------------------------------------------- */
2639 static ssize_t hotkey_enable_show(struct device *dev,
2640                            struct device_attribute *attr,
2641                            char *buf)
2642 {
2643         int res, status;
2644
2645         printk_deprecated_attribute("hotkey_enable",
2646                         "Hotkey reporting is always enabled");
2647
2648         res = hotkey_status_get(&status);
2649         if (res)
2650                 return res;
2651
2652         return snprintf(buf, PAGE_SIZE, "%d\n", status);
2653 }
2654
2655 static ssize_t hotkey_enable_store(struct device *dev,
2656                             struct device_attribute *attr,
2657                             const char *buf, size_t count)
2658 {
2659         unsigned long t;
2660
2661         printk_deprecated_attribute("hotkey_enable",
2662                         "Hotkeys can be disabled through hotkey_mask");
2663
2664         if (parse_strtoul(buf, 1, &t))
2665                 return -EINVAL;
2666
2667         if (t == 0)
2668                 return -EPERM;
2669
2670         return count;
2671 }
2672
2673 static struct device_attribute dev_attr_hotkey_enable =
2674         __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2675                 hotkey_enable_show, hotkey_enable_store);
2676
2677 /* sysfs hotkey mask --------------------------------------------------- */
2678 static ssize_t hotkey_mask_show(struct device *dev,
2679                            struct device_attribute *attr,
2680                            char *buf)
2681 {
2682         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2683 }
2684
2685 static ssize_t hotkey_mask_store(struct device *dev,
2686                             struct device_attribute *attr,
2687                             const char *buf, size_t count)
2688 {
2689         unsigned long t;
2690         int res;
2691
2692         if (parse_strtoul(buf, 0xffffffffUL, &t))
2693                 return -EINVAL;
2694
2695         if (mutex_lock_killable(&hotkey_mutex))
2696                 return -ERESTARTSYS;
2697
2698         res = hotkey_user_mask_set(t);
2699
2700 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2701         hotkey_poll_setup(true);
2702 #endif
2703
2704         mutex_unlock(&hotkey_mutex);
2705
2706         tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2707
2708         return (res) ? res : count;
2709 }
2710
2711 static struct device_attribute dev_attr_hotkey_mask =
2712         __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2713                 hotkey_mask_show, hotkey_mask_store);
2714
2715 /* sysfs hotkey bios_enabled ------------------------------------------- */
2716 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2717                            struct device_attribute *attr,
2718                            char *buf)
2719 {
2720         return sprintf(buf, "0\n");
2721 }
2722
2723 static struct device_attribute dev_attr_hotkey_bios_enabled =
2724         __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2725
2726 /* sysfs hotkey bios_mask ---------------------------------------------- */
2727 static ssize_t hotkey_bios_mask_show(struct device *dev,
2728                            struct device_attribute *attr,
2729                            char *buf)
2730 {
2731         printk_deprecated_attribute("hotkey_bios_mask",
2732                         "This attribute is useless.");
2733         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2734 }
2735
2736 static struct device_attribute dev_attr_hotkey_bios_mask =
2737         __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2738
2739 /* sysfs hotkey all_mask ----------------------------------------------- */
2740 static ssize_t hotkey_all_mask_show(struct device *dev,
2741                            struct device_attribute *attr,
2742                            char *buf)
2743 {
2744         return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2745                                 hotkey_all_mask | hotkey_source_mask);
2746 }
2747
2748 static struct device_attribute dev_attr_hotkey_all_mask =
2749         __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2750
2751 /* sysfs hotkey recommended_mask --------------------------------------- */
2752 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2753                                             struct device_attribute *attr,
2754                                             char *buf)
2755 {
2756         return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2757                         (hotkey_all_mask | hotkey_source_mask)
2758                         & ~hotkey_reserved_mask);
2759 }
2760
2761 static struct device_attribute dev_attr_hotkey_recommended_mask =
2762         __ATTR(hotkey_recommended_mask, S_IRUGO,
2763                 hotkey_recommended_mask_show, NULL);
2764
2765 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2766
2767 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2768 static ssize_t hotkey_source_mask_show(struct device *dev,
2769                            struct device_attribute *attr,
2770                            char *buf)
2771 {
2772         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2773 }
2774
2775 static ssize_t hotkey_source_mask_store(struct device *dev,
2776                             struct device_attribute *attr,
2777                             const char *buf, size_t count)
2778 {
2779         unsigned long t;
2780         u32 r_ev;
2781         int rc;
2782
2783         if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2784                 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2785                 return -EINVAL;
2786
2787         if (mutex_lock_killable(&hotkey_mutex))
2788                 return -ERESTARTSYS;
2789
2790         HOTKEY_CONFIG_CRITICAL_START
2791         hotkey_source_mask = t;
2792         HOTKEY_CONFIG_CRITICAL_END
2793
2794         rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2795                         ~hotkey_source_mask);
2796         hotkey_poll_setup(true);
2797
2798         /* check if events needed by the driver got disabled */
2799         r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2800                 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2801
2802         mutex_unlock(&hotkey_mutex);
2803
2804         if (rc < 0)
2805                 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2806                         "firmware event mask!\n");
2807
2808         if (r_ev)
2809                 printk(TPACPI_NOTICE "hotkey_source_mask: "
2810                         "some important events were disabled: "
2811                         "0x%04x\n", r_ev);
2812
2813         tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2814
2815         return (rc < 0) ? rc : count;
2816 }
2817
2818 static struct device_attribute dev_attr_hotkey_source_mask =
2819         __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2820                 hotkey_source_mask_show, hotkey_source_mask_store);
2821
2822 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2823 static ssize_t hotkey_poll_freq_show(struct device *dev,
2824                            struct device_attribute *attr,
2825                            char *buf)
2826 {
2827         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2828 }
2829
2830 static ssize_t hotkey_poll_freq_store(struct device *dev,
2831                             struct device_attribute *attr,
2832                             const char *buf, size_t count)
2833 {
2834         unsigned long t;
2835
2836         if (parse_strtoul(buf, 25, &t))
2837                 return -EINVAL;
2838
2839         if (mutex_lock_killable(&hotkey_mutex))
2840                 return -ERESTARTSYS;
2841
2842         hotkey_poll_set_freq(t);
2843         hotkey_poll_setup(true);
2844
2845         mutex_unlock(&hotkey_mutex);
2846
2847         tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2848
2849         return count;
2850 }
2851
2852 static struct device_attribute dev_attr_hotkey_poll_freq =
2853         __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2854                 hotkey_poll_freq_show, hotkey_poll_freq_store);
2855
2856 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2857
2858 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2859 static ssize_t hotkey_radio_sw_show(struct device *dev,
2860                            struct device_attribute *attr,
2861                            char *buf)
2862 {
2863         int res;
2864         res = hotkey_get_wlsw();
2865         if (res < 0)
2866                 return res;
2867
2868         /* Opportunistic update */
2869         tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2870
2871         return snprintf(buf, PAGE_SIZE, "%d\n",
2872                         (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2873 }
2874
2875 static struct device_attribute dev_attr_hotkey_radio_sw =
2876         __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2877
2878 static void hotkey_radio_sw_notify_change(void)
2879 {
2880         if (tp_features.hotkey_wlsw)
2881                 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2882                              "hotkey_radio_sw");
2883 }
2884
2885 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2886 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2887                            struct device_attribute *attr,
2888                            char *buf)
2889 {
2890         int res, s;
2891         res = hotkey_get_tablet_mode(&s);
2892         if (res < 0)
2893                 return res;
2894
2895         return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2896 }
2897
2898 static struct device_attribute dev_attr_hotkey_tablet_mode =
2899         __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2900
2901 static void hotkey_tablet_mode_notify_change(void)
2902 {
2903         if (tp_features.hotkey_tablet)
2904                 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2905                              "hotkey_tablet_mode");
2906 }
2907
2908 /* sysfs hotkey report_mode -------------------------------------------- */
2909 static ssize_t hotkey_report_mode_show(struct device *dev,
2910                            struct device_attribute *attr,
2911                            char *buf)
2912 {
2913         return snprintf(buf, PAGE_SIZE, "%d\n",
2914                 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2915 }
2916
2917 static struct device_attribute dev_attr_hotkey_report_mode =
2918         __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2919
2920 /* sysfs wakeup reason (pollable) -------------------------------------- */
2921 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2922                            struct device_attribute *attr,
2923                            char *buf)
2924 {
2925         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2926 }
2927
2928 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2929         __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2930
2931 static void hotkey_wakeup_reason_notify_change(void)
2932 {
2933         sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2934                      "wakeup_reason");
2935 }
2936
2937 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2938 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2939                            struct device_attribute *attr,
2940                            char *buf)
2941 {
2942         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2943 }
2944
2945 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2946         __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2947                hotkey_wakeup_hotunplug_complete_show, NULL);
2948
2949 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2950 {
2951         sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2952                      "wakeup_hotunplug_complete");
2953 }
2954
2955 /* --------------------------------------------------------------------- */
2956
2957 static struct attribute *hotkey_attributes[] __initdata = {
2958         &dev_attr_hotkey_enable.attr,
2959         &dev_attr_hotkey_bios_enabled.attr,
2960         &dev_attr_hotkey_bios_mask.attr,
2961         &dev_attr_hotkey_report_mode.attr,
2962         &dev_attr_hotkey_wakeup_reason.attr,
2963         &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2964         &dev_attr_hotkey_mask.attr,
2965         &dev_attr_hotkey_all_mask.attr,
2966         &dev_attr_hotkey_recommended_mask.attr,
2967 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2968         &dev_attr_hotkey_source_mask.attr,
2969         &dev_attr_hotkey_poll_freq.attr,
2970 #endif
2971 };
2972
2973 /*
2974  * Sync both the hw and sw blocking state of all switches
2975  */
2976 static void tpacpi_send_radiosw_update(void)
2977 {
2978         int wlsw;
2979
2980         /*
2981          * We must sync all rfkill controllers *before* issuing any
2982          * rfkill input events, or we will race the rfkill core input
2983          * handler.
2984          *
2985          * tpacpi_inputdev_send_mutex works as a syncronization point
2986          * for the above.
2987          *
2988          * We optimize to avoid numerous calls to hotkey_get_wlsw.
2989          */
2990
2991         wlsw = hotkey_get_wlsw();
2992
2993         /* Sync hw blocking state first if it is hw-blocked */
2994         if (wlsw == TPACPI_RFK_RADIO_OFF)
2995                 tpacpi_rfk_update_hwblock_state(true);
2996
2997         /* Sync sw blocking state */
2998         tpacpi_rfk_update_swstate_all();
2999
3000         /* Sync hw blocking state last if it is hw-unblocked */
3001         if (wlsw == TPACPI_RFK_RADIO_ON)
3002                 tpacpi_rfk_update_hwblock_state(false);
3003
3004         /* Issue rfkill input event for WLSW switch */
3005         if (!(wlsw < 0)) {
3006                 mutex_lock(&tpacpi_inputdev_send_mutex);
3007
3008                 input_report_switch(tpacpi_inputdev,
3009                                     SW_RFKILL_ALL, (wlsw > 0));
3010                 input_sync(tpacpi_inputdev);
3011
3012                 mutex_unlock(&tpacpi_inputdev_send_mutex);
3013         }
3014
3015         /*
3016          * this can be unconditional, as we will poll state again
3017          * if userspace uses the notify to read data
3018          */
3019         hotkey_radio_sw_notify_change();
3020 }
3021
3022 static void hotkey_exit(void)
3023 {
3024 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3025         mutex_lock(&hotkey_mutex);
3026         hotkey_poll_stop_sync();
3027         mutex_unlock(&hotkey_mutex);
3028 #endif
3029
3030         if (hotkey_dev_attributes)
3031                 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3032
3033         kfree(hotkey_keycode_map);
3034
3035         dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3036                    "restoring original HKEY status and mask\n");
3037         /* yes, there is a bitwise or below, we want the
3038          * functions to be called even if one of them fail */
3039         if (((tp_features.hotkey_mask &&
3040               hotkey_mask_set(hotkey_orig_mask)) |
3041              hotkey_status_set(false)) != 0)
3042                 printk(TPACPI_ERR
3043                        "failed to restore hot key mask "
3044                        "to BIOS defaults\n");
3045 }
3046
3047 static void __init hotkey_unmap(const unsigned int scancode)
3048 {
3049         if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3050                 clear_bit(hotkey_keycode_map[scancode],
3051                           tpacpi_inputdev->keybit);
3052                 hotkey_keycode_map[scancode] = KEY_RESERVED;
3053         }
3054 }
3055
3056 /*
3057  * HKEY quirks:
3058  *   TPACPI_HK_Q_INIMASK:       Supports FN+F3,FN+F4,FN+F12
3059  */
3060
3061 #define TPACPI_HK_Q_INIMASK     0x0001
3062
3063 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3064         TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3065         TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3066         TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3067         TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3068         TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3069         TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3070         TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3071         TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3072         TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3073         TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3074         TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3075         TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3076         TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3077         TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3078         TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3079         TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3080         TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3081         TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3082         TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3083 };
3084
3085 static int __init hotkey_init(struct ibm_init_struct *iibm)
3086 {
3087         /* Requirements for changing the default keymaps:
3088          *
3089          * 1. Many of the keys are mapped to KEY_RESERVED for very
3090          *    good reasons.  Do not change them unless you have deep
3091          *    knowledge on the IBM and Lenovo ThinkPad firmware for
3092          *    the various ThinkPad models.  The driver behaves
3093          *    differently for KEY_RESERVED: such keys have their
3094          *    hot key mask *unset* in mask_recommended, and also
3095          *    in the initial hot key mask programmed into the
3096          *    firmware at driver load time, which means the firm-
3097          *    ware may react very differently if you change them to
3098          *    something else;
3099          *
3100          * 2. You must be subscribed to the linux-thinkpad and
3101          *    ibm-acpi-devel mailing lists, and you should read the
3102          *    list archives since 2007 if you want to change the
3103          *    keymaps.  This requirement exists so that you will
3104          *    know the past history of problems with the thinkpad-
3105          *    acpi driver keymaps, and also that you will be
3106          *    listening to any bug reports;
3107          *
3108          * 3. Do not send thinkpad-acpi specific patches directly to
3109          *    for merging, *ever*.  Send them to the linux-acpi
3110          *    mailinglist for comments.  Merging is to be done only
3111          *    through acpi-test and the ACPI maintainer.
3112          *
3113          * If the above is too much to ask, don't change the keymap.
3114          * Ask the thinkpad-acpi maintainer to do it, instead.
3115          */
3116         static u16 ibm_keycode_map[] __initdata = {
3117                 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3118                 KEY_FN_F1,      KEY_FN_F2,      KEY_COFFEE,     KEY_SLEEP,
3119                 KEY_WLAN,       KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3120                 KEY_FN_F9,      KEY_FN_F10,     KEY_FN_F11,     KEY_SUSPEND,
3121
3122                 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3123                 KEY_UNKNOWN,    /* 0x0C: FN+BACKSPACE */
3124                 KEY_UNKNOWN,    /* 0x0D: FN+INSERT */
3125                 KEY_UNKNOWN,    /* 0x0E: FN+DELETE */
3126
3127                 /* brightness: firmware always reacts to them */
3128                 KEY_RESERVED,   /* 0x0F: FN+HOME (brightness up) */
3129                 KEY_RESERVED,   /* 0x10: FN+END (brightness down) */
3130
3131                 /* Thinklight: firmware always react to it */
3132                 KEY_RESERVED,   /* 0x11: FN+PGUP (thinklight toggle) */
3133
3134                 KEY_UNKNOWN,    /* 0x12: FN+PGDOWN */
3135                 KEY_ZOOM,       /* 0x13: FN+SPACE (zoom) */
3136
3137                 /* Volume: firmware always react to it and reprograms
3138                  * the built-in *extra* mixer.  Never map it to control
3139                  * another mixer by default. */
3140                 KEY_RESERVED,   /* 0x14: VOLUME UP */
3141                 KEY_RESERVED,   /* 0x15: VOLUME DOWN */
3142                 KEY_RESERVED,   /* 0x16: MUTE */
3143
3144                 KEY_VENDOR,     /* 0x17: Thinkpad/AccessIBM/Lenovo */
3145
3146                 /* (assignments unknown, please report if found) */
3147                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3148                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3149         };
3150         static u16 lenovo_keycode_map[] __initdata = {
3151                 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3152                 KEY_FN_F1,      KEY_COFFEE,     KEY_BATTERY,    KEY_SLEEP,
3153                 KEY_WLAN,       KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3154                 KEY_FN_F9,      KEY_FN_F10,     KEY_FN_F11,     KEY_SUSPEND,
3155
3156                 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3157                 KEY_UNKNOWN,    /* 0x0C: FN+BACKSPACE */
3158                 KEY_UNKNOWN,    /* 0x0D: FN+INSERT */
3159                 KEY_UNKNOWN,    /* 0x0E: FN+DELETE */
3160
3161                 /* These should be enabled --only-- when ACPI video
3162                  * is disabled (i.e. in "vendor" mode), and are handled
3163                  * in a special way by the init code */
3164                 KEY_BRIGHTNESSUP,       /* 0x0F: FN+HOME (brightness up) */
3165                 KEY_BRIGHTNESSDOWN,     /* 0x10: FN+END (brightness down) */
3166
3167                 KEY_RESERVED,   /* 0x11: FN+PGUP (thinklight toggle) */
3168
3169                 KEY_UNKNOWN,    /* 0x12: FN+PGDOWN */
3170                 KEY_ZOOM,       /* 0x13: FN+SPACE (zoom) */
3171
3172                 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3173                  * react to it and reprograms the built-in *extra* mixer.
3174                  * Never map it to control another mixer by default.
3175                  *
3176                  * T60?, T61, R60?, R61: firmware and EC tries to send
3177                  * these over the regular keyboard, so these are no-ops,
3178                  * but there are still weird bugs re. MUTE, so do not
3179                  * change unless you get test reports from all Lenovo
3180                  * models.  May cause the BIOS to interfere with the
3181                  * HDA mixer.
3182                  */
3183                 KEY_RESERVED,   /* 0x14: VOLUME UP */
3184                 KEY_RESERVED,   /* 0x15: VOLUME DOWN */
3185                 KEY_RESERVED,   /* 0x16: MUTE */
3186
3187                 KEY_VENDOR,     /* 0x17: Thinkpad/AccessIBM/Lenovo */
3188
3189                 /* (assignments unknown, please report if found) */
3190                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3191                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3192         };
3193
3194 #define TPACPI_HOTKEY_MAP_LEN           ARRAY_SIZE(ibm_keycode_map)
3195 #define TPACPI_HOTKEY_MAP_SIZE          sizeof(ibm_keycode_map)
3196 #define TPACPI_HOTKEY_MAP_TYPESIZE      sizeof(ibm_keycode_map[0])
3197
3198         int res, i;
3199         int status;
3200         int hkeyv;
3201         bool radiosw_state  = false;
3202         bool tabletsw_state = false;
3203
3204         unsigned long quirks;
3205
3206         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3207                         "initializing hotkey subdriver\n");
3208
3209         BUG_ON(!tpacpi_inputdev);
3210         BUG_ON(tpacpi_inputdev->open != NULL ||
3211                tpacpi_inputdev->close != NULL);
3212
3213         TPACPI_ACPIHANDLE_INIT(hkey);
3214         mutex_init(&hotkey_mutex);
3215
3216 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3217         mutex_init(&hotkey_thread_mutex);
3218         mutex_init(&hotkey_thread_data_mutex);
3219 #endif
3220
3221         /* hotkey not supported on 570 */
3222         tp_features.hotkey = hkey_handle != NULL;
3223
3224         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3225                 "hotkeys are %s\n",
3226                 str_supported(tp_features.hotkey));
3227
3228         if (!tp_features.hotkey)
3229                 return 1;
3230
3231         quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3232                                      ARRAY_SIZE(tpacpi_hotkey_qtable));
3233
3234         tpacpi_disable_brightness_delay();
3235
3236         /* MUST have enough space for all attributes to be added to
3237          * hotkey_dev_attributes */
3238         hotkey_dev_attributes = create_attr_set(
3239                                         ARRAY_SIZE(hotkey_attributes) + 2,
3240                                         NULL);
3241         if (!hotkey_dev_attributes)
3242                 return -ENOMEM;
3243         res = add_many_to_attr_set(hotkey_dev_attributes,
3244                         hotkey_attributes,
3245                         ARRAY_SIZE(hotkey_attributes));
3246         if (res)
3247                 goto err_exit;
3248
3249         /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3250            A30, R30, R31, T20-22, X20-21, X22-24.  Detected by checking
3251            for HKEY interface version 0x100 */
3252         if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3253                 if ((hkeyv >> 8) != 1) {
3254                         printk(TPACPI_ERR "unknown version of the "
3255                                "HKEY interface: 0x%x\n", hkeyv);
3256                         printk(TPACPI_ERR "please report this to %s\n",
3257                                TPACPI_MAIL);
3258                 } else {
3259                         /*
3260                          * MHKV 0x100 in A31, R40, R40e,
3261                          * T4x, X31, and later
3262                          */
3263                         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3264                                 "firmware HKEY interface version: 0x%x\n",
3265                                 hkeyv);
3266
3267                         /* Paranoia check AND init hotkey_all_mask */
3268                         if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3269                                         "MHKA", "qd")) {
3270                                 printk(TPACPI_ERR
3271                                        "missing MHKA handler, "
3272                                        "please report this to %s\n",
3273                                        TPACPI_MAIL);
3274                                 /* Fallback: pre-init for FN+F3,F4,F12 */
3275                                 hotkey_all_mask = 0x080cU;
3276                         } else {
3277                                 tp_features.hotkey_mask = 1;
3278                         }
3279                 }
3280         }
3281
3282         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3283                 "hotkey masks are %s\n",
3284                 str_supported(tp_features.hotkey_mask));
3285
3286         /* Init hotkey_all_mask if not initialized yet */
3287         if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3288             (quirks & TPACPI_HK_Q_INIMASK))
3289                 hotkey_all_mask = 0x080cU;  /* FN+F12, FN+F4, FN+F3 */
3290
3291         /* Init hotkey_acpi_mask and hotkey_orig_mask */
3292         if (tp_features.hotkey_mask) {
3293                 /* hotkey_source_mask *must* be zero for
3294                  * the first hotkey_mask_get to return hotkey_orig_mask */
3295                 res = hotkey_mask_get();
3296                 if (res)
3297                         goto err_exit;
3298
3299                 hotkey_orig_mask = hotkey_acpi_mask;
3300         } else {
3301                 hotkey_orig_mask = hotkey_all_mask;
3302                 hotkey_acpi_mask = hotkey_all_mask;
3303         }
3304
3305 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3306         if (dbg_wlswemul) {
3307                 tp_features.hotkey_wlsw = 1;
3308                 radiosw_state = !!tpacpi_wlsw_emulstate;
3309                 printk(TPACPI_INFO
3310                         "radio switch emulation enabled\n");
3311         } else
3312 #endif
3313         /* Not all thinkpads have a hardware radio switch */
3314         if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3315                 tp_features.hotkey_wlsw = 1;
3316                 radiosw_state = !!status;
3317                 printk(TPACPI_INFO
3318                         "radio switch found; radios are %s\n",
3319                         enabled(status, 0));
3320         }
3321         if (tp_features.hotkey_wlsw)
3322                 res = add_to_attr_set(hotkey_dev_attributes,
3323                                 &dev_attr_hotkey_radio_sw.attr);
3324
3325         /* For X41t, X60t, X61t Tablets... */
3326         if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3327                 tp_features.hotkey_tablet = 1;
3328                 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3329                 printk(TPACPI_INFO
3330                         "possible tablet mode switch found; "
3331                         "ThinkPad in %s mode\n",
3332                         (tabletsw_state) ? "tablet" : "laptop");
3333                 res = add_to_attr_set(hotkey_dev_attributes,
3334                                 &dev_attr_hotkey_tablet_mode.attr);
3335         }
3336
3337         if (!res)
3338                 res = register_attr_set_with_sysfs(
3339                                 hotkey_dev_attributes,
3340                                 &tpacpi_pdev->dev.kobj);
3341         if (res)
3342                 goto err_exit;
3343
3344         /* Set up key map */
3345
3346         hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3347                                         GFP_KERNEL);
3348         if (!hotkey_keycode_map) {
3349                 printk(TPACPI_ERR
3350                         "failed to allocate memory for key map\n");
3351                 res = -ENOMEM;
3352                 goto err_exit;
3353         }
3354
3355         if (thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO) {
3356                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3357                            "using Lenovo default hot key map\n");
3358                 memcpy(hotkey_keycode_map, &lenovo_keycode_map,
3359                         TPACPI_HOTKEY_MAP_SIZE);
3360         } else {
3361                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3362                            "using IBM default hot key map\n");
3363                 memcpy(hotkey_keycode_map, &ibm_keycode_map,
3364                         TPACPI_HOTKEY_MAP_SIZE);
3365         }
3366
3367         input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3368         tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3369         tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3370         tpacpi_inputdev->keycode = hotkey_keycode_map;
3371         for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3372                 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3373                         input_set_capability(tpacpi_inputdev, EV_KEY,
3374                                                 hotkey_keycode_map[i]);
3375                 } else {
3376                         if (i < sizeof(hotkey_reserved_mask)*8)
3377                                 hotkey_reserved_mask |= 1 << i;
3378                 }
3379         }
3380
3381         if (tp_features.hotkey_wlsw) {
3382                 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3383                 input_report_switch(tpacpi_inputdev,
3384                                     SW_RFKILL_ALL, radiosw_state);
3385         }
3386         if (tp_features.hotkey_tablet) {
3387                 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3388                 input_report_switch(tpacpi_inputdev,
3389                                     SW_TABLET_MODE, tabletsw_state);
3390         }
3391
3392         /* Do not issue duplicate brightness change events to
3393          * userspace */
3394         if (!tp_features.bright_acpimode)
3395                 /* update bright_acpimode... */
3396                 tpacpi_check_std_acpi_brightness_support();
3397
3398         if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3399                 printk(TPACPI_INFO
3400                        "This ThinkPad has standard ACPI backlight "
3401                        "brightness control, supported by the ACPI "
3402                        "video driver\n");
3403                 printk(TPACPI_NOTICE
3404                        "Disabling thinkpad-acpi brightness events "
3405                        "by default...\n");
3406
3407                 /* Disable brightness up/down on Lenovo thinkpads when
3408                  * ACPI is handling them, otherwise it is plain impossible
3409                  * for userspace to do something even remotely sane */
3410                 hotkey_reserved_mask |=
3411                         (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3412                         | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3413                 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3414                 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3415         }
3416
3417 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3418         hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3419                                 & ~hotkey_all_mask
3420                                 & ~hotkey_reserved_mask;
3421
3422         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3423                     "hotkey source mask 0x%08x, polling freq %u\n",
3424                     hotkey_source_mask, hotkey_poll_freq);
3425 #endif
3426
3427         dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3428                         "enabling firmware HKEY event interface...\n");
3429         res = hotkey_status_set(true);
3430         if (res) {
3431                 hotkey_exit();
3432                 return res;
3433         }
3434         res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3435                                | hotkey_driver_mask)
3436                               & ~hotkey_source_mask);
3437         if (res < 0 && res != -ENXIO) {
3438                 hotkey_exit();
3439                 return res;
3440         }
3441         hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3442                                 & ~hotkey_reserved_mask;
3443         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3444                 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3445                 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3446
3447         dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3448                         "legacy ibm/hotkey event reporting over procfs %s\n",
3449                         (hotkey_report_mode < 2) ?
3450                                 "enabled" : "disabled");
3451
3452         tpacpi_inputdev->open = &hotkey_inputdev_open;
3453         tpacpi_inputdev->close = &hotkey_inputdev_close;
3454
3455         hotkey_poll_setup_safe(true);
3456
3457         return 0;
3458
3459 err_exit:
3460         delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3461         hotkey_dev_attributes = NULL;
3462
3463         return (res < 0)? res : 1;
3464 }
3465
3466 static bool hotkey_notify_hotkey(const u32 hkey,
3467                                  bool *send_acpi_ev,
3468                                  bool *ignore_acpi_ev)
3469 {
3470         /* 0x1000-0x1FFF: key presses */
3471         unsigned int scancode = hkey & 0xfff;
3472         *send_acpi_ev = true;
3473         *ignore_acpi_ev = false;
3474
3475         if (scancode > 0 && scancode < 0x21) {
3476                 scancode--;
3477                 if (!(hotkey_source_mask & (1 << scancode))) {
3478                         tpacpi_input_send_key_masked(scancode);
3479                         *send_acpi_ev = false;
3480                 } else {
3481                         *ignore_acpi_ev = true;
3482                 }
3483                 return true;
3484         }
3485         return false;
3486 }
3487
3488 static bool hotkey_notify_wakeup(const u32 hkey,
3489                                  bool *send_acpi_ev,
3490                                  bool *ignore_acpi_ev)
3491 {
3492         /* 0x2000-0x2FFF: Wakeup reason */
3493         *send_acpi_ev = true;
3494         *ignore_acpi_ev = false;
3495
3496         switch (hkey) {
3497         case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3498         case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3499                 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3500                 *ignore_acpi_ev = true;
3501                 break;
3502
3503         case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3504         case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3505                 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3506                 *ignore_acpi_ev = true;
3507                 break;
3508
3509         case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3510         case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3511                 printk(TPACPI_ALERT
3512                         "EMERGENCY WAKEUP: battery almost empty\n");
3513                 /* how to auto-heal: */
3514                 /* 2313: woke up from S3, go to S4/S5 */
3515                 /* 2413: woke up from S4, go to S5 */
3516                 break;
3517
3518         default:
3519                 return false;
3520         }
3521
3522         if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3523                 printk(TPACPI_INFO
3524                        "woke up due to a hot-unplug "
3525                        "request...\n");
3526                 hotkey_wakeup_reason_notify_change();
3527         }
3528         return true;
3529 }
3530
3531 static bool hotkey_notify_usrevent(const u32 hkey,
3532                                  bool *send_acpi_ev,
3533                                  bool *ignore_acpi_ev)
3534 {
3535         /* 0x5000-0x5FFF: human interface helpers */
3536         *send_acpi_ev = true;
3537         *ignore_acpi_ev = false;
3538
3539         switch (hkey) {
3540         case TP_HKEY_EV_PEN_INSERTED:  /* X61t: tablet pen inserted into bay */
3541         case TP_HKEY_EV_PEN_REMOVED:   /* X61t: tablet pen removed from bay */
3542                 return true;
3543
3544         case TP_HKEY_EV_TABLET_TABLET:   /* X41t-X61t: tablet mode */
3545         case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3546                 tpacpi_input_send_tabletsw();
3547                 hotkey_tablet_mode_notify_change();
3548                 *send_acpi_ev = false;
3549                 return true;
3550
3551         case TP_HKEY_EV_LID_CLOSE:      /* Lid closed */
3552         case TP_HKEY_EV_LID_OPEN:       /* Lid opened */
3553         case TP_HKEY_EV_BRGHT_CHANGED:  /* brightness changed */
3554                 /* do not propagate these events */
3555                 *ignore_acpi_ev = true;
3556                 return true;
3557
3558         default:
3559                 return false;
3560         }
3561 }
3562
3563 static void thermal_dump_all_sensors(void);
3564
3565 static bool hotkey_notify_thermal(const u32 hkey,
3566                                  bool *send_acpi_ev,
3567                                  bool *ignore_acpi_ev)
3568 {
3569         bool known = true;
3570
3571         /* 0x6000-0x6FFF: thermal alarms */
3572         *send_acpi_ev = true;
3573         *ignore_acpi_ev = false;
3574
3575         switch (hkey) {
3576         case TP_HKEY_EV_THM_TABLE_CHANGED:
3577                 printk(TPACPI_INFO
3578                         "EC reports that Thermal Table has changed\n");
3579                 /* recommended action: do nothing, we don't have
3580                  * Lenovo ATM information */
3581                 return true;
3582         case TP_HKEY_EV_ALARM_BAT_HOT:
3583                 printk(TPACPI_CRIT
3584                         "THERMAL ALARM: battery is too hot!\n");
3585                 /* recommended action: warn user through gui */
3586                 break;
3587         case TP_HKEY_EV_ALARM_BAT_XHOT:
3588                 printk(TPACPI_ALERT
3589                         "THERMAL EMERGENCY: battery is extremely hot!\n");
3590                 /* recommended action: immediate sleep/hibernate */
3591                 break;
3592         case TP_HKEY_EV_ALARM_SENSOR_HOT:
3593                 printk(TPACPI_CRIT
3594                         "THERMAL ALARM: "
3595                         "a sensor reports something is too hot!\n");
3596                 /* recommended action: warn user through gui, that */
3597                 /* some internal component is too hot */
3598                 break;
3599         case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3600                 printk(TPACPI_ALERT
3601                         "THERMAL EMERGENCY: "
3602                         "a sensor reports something is extremely hot!\n");
3603                 /* recommended action: immediate sleep/hibernate */
3604                 break;
3605         default:
3606                 printk(TPACPI_ALERT
3607                          "THERMAL ALERT: unknown thermal alarm received\n");
3608                 known = false;
3609         }
3610
3611         thermal_dump_all_sensors();
3612
3613         return known;
3614 }
3615
3616 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3617 {
3618         u32 hkey;
3619         bool send_acpi_ev;
3620         bool ignore_acpi_ev;
3621         bool known_ev;
3622
3623         if (event != 0x80) {
3624                 printk(TPACPI_ERR
3625                        "unknown HKEY notification event %d\n", event);
3626                 /* forward it to userspace, maybe it knows how to handle it */
3627                 acpi_bus_generate_netlink_event(
3628                                         ibm->acpi->device->pnp.device_class,
3629                                         dev_name(&ibm->acpi->device->dev),
3630                                         event, 0);
3631                 return;
3632         }
3633
3634         while (1) {
3635                 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3636                         printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3637                         return;
3638                 }
3639
3640                 if (hkey == 0) {
3641                         /* queue empty */
3642                         return;
3643                 }
3644
3645                 send_acpi_ev = true;
3646                 ignore_acpi_ev = false;
3647
3648                 switch (hkey >> 12) {
3649                 case 1:
3650                         /* 0x1000-0x1FFF: key presses */
3651                         known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3652                                                  &ignore_acpi_ev);
3653                         break;
3654                 case 2:
3655                         /* 0x2000-0x2FFF: Wakeup reason */
3656                         known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3657                                                  &ignore_acpi_ev);
3658                         break;
3659                 case 3:
3660                         /* 0x3000-0x3FFF: bay-related wakeups */
3661                         switch (hkey) {
3662                         case TP_HKEY_EV_BAYEJ_ACK:
3663                                 hotkey_autosleep_ack = 1;
3664                                 printk(TPACPI_INFO
3665                                        "bay ejected\n");
3666                                 hotkey_wakeup_hotunplug_complete_notify_change();
3667                                 known_ev = true;
3668                                 break;
3669                         case TP_HKEY_EV_OPTDRV_EJ:
3670                                 /* FIXME: kick libata if SATA link offline */
3671                                 known_ev = true;
3672                                 break;
3673                         default:
3674                                 known_ev = false;
3675                         }
3676                         break;
3677                 case 4:
3678                         /* 0x4000-0x4FFF: dock-related wakeups */
3679                         if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3680                                 hotkey_autosleep_ack = 1;
3681                                 printk(TPACPI_INFO
3682                                        "undocked\n");
3683                                 hotkey_wakeup_hotunplug_complete_notify_change();
3684                                 known_ev = true;
3685                         } else {
3686                                 known_ev = false;
3687                         }
3688                         break;
3689                 case 5:
3690                         /* 0x5000-0x5FFF: human interface helpers */
3691                         known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3692                                                  &ignore_acpi_ev);
3693                         break;
3694                 case 6:
3695                         /* 0x6000-0x6FFF: thermal alarms */
3696                         known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3697                                                  &ignore_acpi_ev);
3698                         break;
3699                 case 7:
3700                         /* 0x7000-0x7FFF: misc */
3701                         if (tp_features.hotkey_wlsw &&
3702                                         hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3703                                 tpacpi_send_radiosw_update();
3704                                 send_acpi_ev = 0;
3705                                 known_ev = true;
3706                                 break;
3707                         }
3708                         /* fallthrough to default */
3709                 default:
3710                         known_ev = false;
3711                 }
3712                 if (!known_ev) {
3713                         printk(TPACPI_NOTICE
3714                                "unhandled HKEY event 0x%04x\n", hkey);
3715                         printk(TPACPI_NOTICE
3716                                "please report the conditions when this "
3717                                "event happened to %s\n", TPACPI_MAIL);
3718                 }
3719
3720                 /* Legacy events */
3721                 if (!ignore_acpi_ev &&
3722                     (send_acpi_ev || hotkey_report_mode < 2)) {
3723                         acpi_bus_generate_proc_event(ibm->acpi->device,
3724                                                      event, hkey);
3725                 }
3726
3727                 /* netlink events */
3728                 if (!ignore_acpi_ev && send_acpi_ev) {
3729                         acpi_bus_generate_netlink_event(
3730                                         ibm->acpi->device->pnp.device_class,
3731                                         dev_name(&ibm->acpi->device->dev),
3732                                         event, hkey);
3733                 }
3734         }
3735 }
3736
3737 static void hotkey_suspend(pm_message_t state)
3738 {
3739         /* Do these on suspend, we get the events on early resume! */
3740         hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3741         hotkey_autosleep_ack = 0;
3742 }
3743
3744 static void hotkey_resume(void)
3745 {
3746         tpacpi_disable_brightness_delay();
3747
3748         if (hotkey_status_set(true) < 0 ||
3749             hotkey_mask_set(hotkey_acpi_mask) < 0)
3750                 printk(TPACPI_ERR
3751                        "error while attempting to reset the event "
3752                        "firmware interface\n");
3753
3754         tpacpi_send_radiosw_update();
3755         hotkey_tablet_mode_notify_change();
3756         hotkey_wakeup_reason_notify_change();
3757         hotkey_wakeup_hotunplug_complete_notify_change();
3758         hotkey_poll_setup_safe(false);
3759 }
3760
3761 /* procfs -------------------------------------------------------------- */
3762 static int hotkey_read(struct seq_file *m)
3763 {
3764         int res, status;
3765
3766         if (!tp_features.hotkey) {
3767                 seq_printf(m, "status:\t\tnot supported\n");
3768                 return 0;
3769         }
3770
3771         if (mutex_lock_killable(&hotkey_mutex))
3772                 return -ERESTARTSYS;
3773         res = hotkey_status_get(&status);
3774         if (!res)
3775                 res = hotkey_mask_get();
3776         mutex_unlock(&hotkey_mutex);
3777         if (res)
3778                 return res;
3779
3780         seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3781         if (hotkey_all_mask) {
3782                 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3783                 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3784         } else {
3785                 seq_printf(m, "mask:\t\tnot supported\n");
3786                 seq_printf(m, "commands:\tenable, disable, reset\n");
3787         }
3788
3789         return 0;
3790 }
3791
3792 static void hotkey_enabledisable_warn(bool enable)
3793 {
3794         tpacpi_log_usertask("procfs hotkey enable/disable");
3795         if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3796                         TPACPI_WARN
3797                         "hotkey enable/disable functionality has been "
3798                         "removed from the driver.  Hotkeys are always "
3799                         "enabled\n"))
3800                 printk(TPACPI_ERR
3801                         "Please remove the hotkey=enable module "
3802                         "parameter, it is deprecated.  Hotkeys are always "
3803                         "enabled\n");
3804 }
3805
3806 static int hotkey_write(char *buf)
3807 {
3808         int res;
3809         u32 mask;
3810         char *cmd;
3811
3812         if (!tp_features.hotkey)
3813                 return -ENODEV;
3814
3815         if (mutex_lock_killable(&hotkey_mutex))
3816                 return -ERESTARTSYS;
3817
3818         mask = hotkey_user_mask;
3819
3820         res = 0;
3821         while ((cmd = next_cmd(&buf))) {
3822                 if (strlencmp(cmd, "enable") == 0) {
3823                         hotkey_enabledisable_warn(1);
3824                 } else if (strlencmp(cmd, "disable") == 0) {
3825                         hotkey_enabledisable_warn(0);
3826                         res = -EPERM;
3827                 } else if (strlencmp(cmd, "reset") == 0) {
3828                         mask = (hotkey_all_mask | hotkey_source_mask)
3829                                 & ~hotkey_reserved_mask;
3830                 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3831                         /* mask set */
3832                 } else if (sscanf(cmd, "%x", &mask) == 1) {
3833                         /* mask set */
3834                 } else {
3835                         res = -EINVAL;
3836                         goto errexit;
3837                 }
3838         }
3839
3840         if (!res) {
3841                 tpacpi_disclose_usertask("procfs hotkey",
3842                         "set mask to 0x%08x\n", mask);
3843                 res = hotkey_user_mask_set(mask);
3844         }
3845
3846 errexit:
3847         mutex_unlock(&hotkey_mutex);
3848         return res;
3849 }
3850
3851 static const struct acpi_device_id ibm_htk_device_ids[] = {
3852         {TPACPI_ACPI_HKEY_HID, 0},
3853         {"", 0},
3854 };
3855
3856 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3857         .hid = ibm_htk_device_ids,
3858         .notify = hotkey_notify,
3859         .handle = &hkey_handle,
3860         .type = ACPI_DEVICE_NOTIFY,
3861 };
3862
3863 static struct ibm_struct hotkey_driver_data = {
3864         .name = "hotkey",
3865         .read = hotkey_read,
3866         .write = hotkey_write,
3867         .exit = hotkey_exit,
3868         .resume = hotkey_resume,
3869         .suspend = hotkey_suspend,
3870         .acpi = &ibm_hotkey_acpidriver,
3871 };
3872
3873 /*************************************************************************
3874  * Bluetooth subdriver
3875  */
3876
3877 enum {
3878         /* ACPI GBDC/SBDC bits */
3879         TP_ACPI_BLUETOOTH_HWPRESENT     = 0x01, /* Bluetooth hw available */
3880         TP_ACPI_BLUETOOTH_RADIOSSW      = 0x02, /* Bluetooth radio enabled */
3881         TP_ACPI_BLUETOOTH_RESUMECTRL    = 0x04, /* Bluetooth state at resume:
3882                                                    0 = disable, 1 = enable */
3883 };
3884
3885 enum {
3886         /* ACPI \BLTH commands */
3887         TP_ACPI_BLTH_GET_ULTRAPORT_ID   = 0x00, /* Get Ultraport BT ID */
3888         TP_ACPI_BLTH_GET_PWR_ON_RESUME  = 0x01, /* Get power-on-resume state */
3889         TP_ACPI_BLTH_PWR_ON_ON_RESUME   = 0x02, /* Resume powered on */
3890         TP_ACPI_BLTH_PWR_OFF_ON_RESUME  = 0x03, /* Resume powered off */
3891         TP_ACPI_BLTH_SAVE_STATE         = 0x05, /* Save state for S4/S5 */
3892 };
3893
3894 #define TPACPI_RFK_BLUETOOTH_SW_NAME    "tpacpi_bluetooth_sw"
3895
3896 static int bluetooth_get_status(void)
3897 {
3898         int status;
3899
3900 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3901         if (dbg_bluetoothemul)
3902                 return (tpacpi_bluetooth_emulstate) ?
3903                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3904 #endif
3905
3906         if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3907                 return -EIO;
3908
3909         return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3910                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3911 }
3912
3913 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3914 {
3915         int status;
3916
3917         vdbg_printk(TPACPI_DBG_RFKILL,
3918                 "will attempt to %s bluetooth\n",
3919                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3920
3921 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3922         if (dbg_bluetoothemul) {
3923                 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3924                 return 0;
3925         }
3926 #endif
3927
3928         if (state == TPACPI_RFK_RADIO_ON)
3929                 status = TP_ACPI_BLUETOOTH_RADIOSSW
3930                           | TP_ACPI_BLUETOOTH_RESUMECTRL;
3931         else
3932                 status = 0;
3933
3934         if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3935                 return -EIO;
3936
3937         return 0;
3938 }
3939
3940 /* sysfs bluetooth enable ---------------------------------------------- */
3941 static ssize_t bluetooth_enable_show(struct device *dev,
3942                            struct device_attribute *attr,
3943                            char *buf)
3944 {
3945         return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3946                         attr, buf);
3947 }
3948
3949 static ssize_t bluetooth_enable_store(struct device *dev,
3950                             struct device_attribute *attr,
3951                             const char *buf, size_t count)
3952 {
3953         return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3954                                 attr, buf, count);
3955 }
3956
3957 static struct device_attribute dev_attr_bluetooth_enable =
3958         __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3959                 bluetooth_enable_show, bluetooth_enable_store);
3960
3961 /* --------------------------------------------------------------------- */
3962
3963 static struct attribute *bluetooth_attributes[] = {
3964         &dev_attr_bluetooth_enable.attr,
3965         NULL
3966 };
3967
3968 static const struct attribute_group bluetooth_attr_group = {
3969         .attrs = bluetooth_attributes,
3970 };
3971
3972 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
3973         .get_status = bluetooth_get_status,
3974         .set_status = bluetooth_set_status,
3975 };
3976
3977 static void bluetooth_shutdown(void)
3978 {
3979         /* Order firmware to save current state to NVRAM */
3980         if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
3981                         TP_ACPI_BLTH_SAVE_STATE))
3982                 printk(TPACPI_NOTICE
3983                         "failed to save bluetooth state to NVRAM\n");
3984         else
3985                 vdbg_printk(TPACPI_DBG_RFKILL,
3986                         "bluestooth state saved to NVRAM\n");
3987 }
3988
3989 static void bluetooth_exit(void)
3990 {
3991         sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3992                         &bluetooth_attr_group);
3993
3994         tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
3995
3996         bluetooth_shutdown();
3997 }
3998
3999 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4000 {
4001         int res;
4002         int status = 0;
4003
4004         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4005                         "initializing bluetooth subdriver\n");
4006
4007         TPACPI_ACPIHANDLE_INIT(hkey);
4008
4009         /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4010            G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4011         tp_features.bluetooth = hkey_handle &&
4012             acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4013
4014         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4015                 "bluetooth is %s, status 0x%02x\n",
4016                 str_supported(tp_features.bluetooth),
4017                 status);
4018
4019 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4020         if (dbg_bluetoothemul) {
4021                 tp_features.bluetooth = 1;
4022                 printk(TPACPI_INFO
4023                         "bluetooth switch emulation enabled\n");
4024         } else
4025 #endif
4026         if (tp_features.bluetooth &&
4027             !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4028                 /* no bluetooth hardware present in system */
4029                 tp_features.bluetooth = 0;
4030                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4031                            "bluetooth hardware not installed\n");
4032         }
4033
4034         if (!tp_features.bluetooth)
4035                 return 1;
4036
4037         res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4038                                 &bluetooth_tprfk_ops,
4039                                 RFKILL_TYPE_BLUETOOTH,
4040                                 TPACPI_RFK_BLUETOOTH_SW_NAME,
4041                                 true);
4042         if (res)
4043                 return res;
4044
4045         res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4046                                 &bluetooth_attr_group);
4047         if (res) {
4048                 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4049                 return res;
4050         }
4051
4052         return 0;
4053 }
4054
4055 /* procfs -------------------------------------------------------------- */
4056 static int bluetooth_read(struct seq_file *m)
4057 {
4058         return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4059 }
4060
4061 static int bluetooth_write(char *buf)
4062 {
4063         return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4064 }
4065
4066 static struct ibm_struct bluetooth_driver_data = {
4067         .name = "bluetooth",
4068         .read = bluetooth_read,
4069         .write = bluetooth_write,
4070         .exit = bluetooth_exit,
4071         .shutdown = bluetooth_shutdown,
4072 };
4073
4074 /*************************************************************************
4075  * Wan subdriver
4076  */
4077
4078 enum {
4079         /* ACPI GWAN/SWAN bits */
4080         TP_ACPI_WANCARD_HWPRESENT       = 0x01, /* Wan hw available */
4081         TP_ACPI_WANCARD_RADIOSSW        = 0x02, /* Wan radio enabled */
4082         TP_ACPI_WANCARD_RESUMECTRL      = 0x04, /* Wan state at resume:
4083                                                    0 = disable, 1 = enable */
4084 };
4085
4086 #define TPACPI_RFK_WWAN_SW_NAME         "tpacpi_wwan_sw"
4087
4088 static int wan_get_status(void)
4089 {
4090         int status;
4091
4092 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4093         if (dbg_wwanemul)
4094                 return (tpacpi_wwan_emulstate) ?
4095                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4096 #endif
4097
4098         if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4099                 return -EIO;
4100
4101         return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4102                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4103 }
4104
4105 static int wan_set_status(enum tpacpi_rfkill_state state)
4106 {
4107         int status;
4108
4109         vdbg_printk(TPACPI_DBG_RFKILL,
4110                 "will attempt to %s wwan\n",
4111                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4112
4113 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4114         if (dbg_wwanemul) {
4115                 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4116                 return 0;
4117         }
4118 #endif
4119
4120         if (state == TPACPI_RFK_RADIO_ON)
4121                 status = TP_ACPI_WANCARD_RADIOSSW
4122                          | TP_ACPI_WANCARD_RESUMECTRL;
4123         else
4124                 status = 0;
4125
4126         if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4127                 return -EIO;
4128
4129         return 0;
4130 }
4131
4132 /* sysfs wan enable ---------------------------------------------------- */
4133 static ssize_t wan_enable_show(struct device *dev,
4134                            struct device_attribute *attr,
4135                            char *buf)
4136 {
4137         return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4138                         attr, buf);
4139 }
4140
4141 static ssize_t wan_enable_store(struct device *dev,
4142                             struct device_attribute *attr,
4143                             const char *buf, size_t count)
4144 {
4145         return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4146                         attr, buf, count);
4147 }
4148
4149 static struct device_attribute dev_attr_wan_enable =
4150         __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4151                 wan_enable_show, wan_enable_store);
4152
4153 /* --------------------------------------------------------------------- */
4154
4155 static struct attribute *wan_attributes[] = {
4156         &dev_attr_wan_enable.attr,
4157         NULL
4158 };
4159
4160 static const struct attribute_group wan_attr_group = {
4161         .attrs = wan_attributes,
4162 };
4163
4164 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4165         .get_status = wan_get_status,
4166         .set_status = wan_set_status,
4167 };
4168
4169 static void wan_shutdown(void)
4170 {
4171         /* Order firmware to save current state to NVRAM */
4172         if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4173                         TP_ACPI_WGSV_SAVE_STATE))
4174                 printk(TPACPI_NOTICE
4175                         "failed to save WWAN state to NVRAM\n");
4176         else
4177                 vdbg_printk(TPACPI_DBG_RFKILL,
4178                         "WWAN state saved to NVRAM\n");
4179 }
4180
4181 static void wan_exit(void)
4182 {
4183         sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4184                 &wan_attr_group);
4185
4186         tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4187
4188         wan_shutdown();
4189 }
4190
4191 static int __init wan_init(struct ibm_init_struct *iibm)
4192 {
4193         int res;
4194         int status = 0;
4195
4196         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4197                         "initializing wan subdriver\n");
4198
4199         TPACPI_ACPIHANDLE_INIT(hkey);
4200
4201         tp_features.wan = hkey_handle &&
4202             acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4203
4204         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4205                 "wan is %s, status 0x%02x\n",
4206                 str_supported(tp_features.wan),
4207                 status);
4208
4209 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4210         if (dbg_wwanemul) {
4211                 tp_features.wan = 1;
4212                 printk(TPACPI_INFO
4213                         "wwan switch emulation enabled\n");
4214         } else
4215 #endif
4216         if (tp_features.wan &&
4217             !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4218                 /* no wan hardware present in system */
4219                 tp_features.wan = 0;
4220                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4221                            "wan hardware not installed\n");
4222         }
4223
4224         if (!tp_features.wan)
4225                 return 1;
4226
4227         res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4228                                 &wan_tprfk_ops,
4229                                 RFKILL_TYPE_WWAN,
4230                                 TPACPI_RFK_WWAN_SW_NAME,
4231                                 true);
4232         if (res)
4233                 return res;
4234
4235         res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4236                                 &wan_attr_group);
4237
4238         if (res) {
4239                 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4240                 return res;
4241         }
4242
4243         return 0;
4244 }
4245
4246 /* procfs -------------------------------------------------------------- */
4247 static int wan_read(struct seq_file *m)
4248 {
4249         return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4250 }
4251
4252 static int wan_write(char *buf)
4253 {
4254         return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4255 }
4256
4257 static struct ibm_struct wan_driver_data = {
4258         .name = "wan",
4259         .read = wan_read,
4260         .write = wan_write,
4261         .exit = wan_exit,
4262         .shutdown = wan_shutdown,
4263 };
4264
4265 /*************************************************************************
4266  * UWB subdriver
4267  */
4268
4269 enum {
4270         /* ACPI GUWB/SUWB bits */
4271         TP_ACPI_UWB_HWPRESENT   = 0x01, /* UWB hw available */
4272         TP_ACPI_UWB_RADIOSSW    = 0x02, /* UWB radio enabled */
4273 };
4274
4275 #define TPACPI_RFK_UWB_SW_NAME  "tpacpi_uwb_sw"
4276
4277 static int uwb_get_status(void)
4278 {
4279         int status;
4280
4281 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4282         if (dbg_uwbemul)
4283                 return (tpacpi_uwb_emulstate) ?
4284                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4285 #endif
4286
4287         if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4288                 return -EIO;
4289
4290         return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4291                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4292 }
4293
4294 static int uwb_set_status(enum tpacpi_rfkill_state state)
4295 {
4296         int status;
4297
4298         vdbg_printk(TPACPI_DBG_RFKILL,
4299                 "will attempt to %s UWB\n",
4300                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4301
4302 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4303         if (dbg_uwbemul) {
4304                 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4305                 return 0;
4306         }
4307 #endif
4308
4309         if (state == TPACPI_RFK_RADIO_ON)
4310                 status = TP_ACPI_UWB_RADIOSSW;
4311         else
4312                 status = 0;
4313
4314         if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4315                 return -EIO;
4316
4317         return 0;
4318 }
4319
4320 /* --------------------------------------------------------------------- */
4321
4322 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4323         .get_status = uwb_get_status,
4324         .set_status = uwb_set_status,
4325 };
4326
4327 static void uwb_exit(void)
4328 {
4329         tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4330 }
4331
4332 static int __init uwb_init(struct ibm_init_struct *iibm)
4333 {
4334         int res;
4335         int status = 0;
4336
4337         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4338                         "initializing uwb subdriver\n");
4339
4340         TPACPI_ACPIHANDLE_INIT(hkey);
4341
4342         tp_features.uwb = hkey_handle &&
4343             acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4344
4345         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4346                 "uwb is %s, status 0x%02x\n",
4347                 str_supported(tp_features.uwb),
4348                 status);
4349
4350 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4351         if (dbg_uwbemul) {
4352                 tp_features.uwb = 1;
4353                 printk(TPACPI_INFO
4354                         "uwb switch emulation enabled\n");
4355         } else
4356 #endif
4357         if (tp_features.uwb &&
4358             !(status & TP_ACPI_UWB_HWPRESENT)) {
4359                 /* no uwb hardware present in system */
4360                 tp_features.uwb = 0;
4361                 dbg_printk(TPACPI_DBG_INIT,
4362                            "uwb hardware not installed\n");
4363         }
4364
4365         if (!tp_features.uwb)
4366                 return 1;
4367
4368         res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4369                                 &uwb_tprfk_ops,
4370                                 RFKILL_TYPE_UWB,
4371                                 TPACPI_RFK_UWB_SW_NAME,
4372                                 false);
4373         return res;
4374 }
4375
4376 static struct ibm_struct uwb_driver_data = {
4377         .name = "uwb",
4378         .exit = uwb_exit,
4379         .flags.experimental = 1,
4380 };
4381
4382 /*************************************************************************
4383  * Video subdriver
4384  */
4385
4386 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4387
4388 enum video_access_mode {
4389         TPACPI_VIDEO_NONE = 0,
4390         TPACPI_VIDEO_570,       /* 570 */
4391         TPACPI_VIDEO_770,       /* 600e/x, 770e, 770x */
4392         TPACPI_VIDEO_NEW,       /* all others */
4393 };
4394
4395 enum {  /* video status flags, based on VIDEO_570 */
4396         TP_ACPI_VIDEO_S_LCD = 0x01,     /* LCD output enabled */
4397         TP_ACPI_VIDEO_S_CRT = 0x02,     /* CRT output enabled */
4398         TP_ACPI_VIDEO_S_DVI = 0x08,     /* DVI output enabled */
4399 };
4400
4401 enum {  /* TPACPI_VIDEO_570 constants */
4402         TP_ACPI_VIDEO_570_PHSCMD = 0x87,        /* unknown magic constant :( */
4403         TP_ACPI_VIDEO_570_PHSMASK = 0x03,       /* PHS bits that map to
4404                                                  * video_status_flags */
4405         TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,       /* unknown magic constant :( */
4406         TP_ACPI_VIDEO_570_PHS2SET = 0x80,       /* unknown magic constant :( */
4407 };
4408
4409 static enum video_access_mode video_supported;
4410 static int video_orig_autosw;
4411
4412 static int video_autosw_get(void);
4413 static int video_autosw_set(int enable);
4414
4415 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID");       /* G41 */
4416
4417 static int __init video_init(struct ibm_init_struct *iibm)
4418 {
4419         int ivga;
4420
4421         vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4422
4423         TPACPI_ACPIHANDLE_INIT(vid);
4424         TPACPI_ACPIHANDLE_INIT(vid2);
4425
4426         if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4427                 /* G41, assume IVGA doesn't change */
4428                 vid_handle = vid2_handle;
4429
4430         if (!vid_handle)
4431                 /* video switching not supported on R30, R31 */
4432                 video_supported = TPACPI_VIDEO_NONE;
4433         else if (acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4434                 /* 570 */
4435                 video_supported = TPACPI_VIDEO_570;
4436         else if (acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4437                 /* 600e/x, 770e, 770x */
4438                 video_supported = TPACPI_VIDEO_770;
4439         else
4440                 /* all others */
4441                 video_supported = TPACPI_VIDEO_NEW;
4442
4443         vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4444                 str_supported(video_supported != TPACPI_VIDEO_NONE),
4445                 video_supported);
4446
4447         return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4448 }
4449
4450 static void video_exit(void)
4451 {
4452         dbg_printk(TPACPI_DBG_EXIT,
4453                    "restoring original video autoswitch mode\n");
4454         if (video_autosw_set(video_orig_autosw))
4455                 printk(TPACPI_ERR "error while trying to restore original "
4456                         "video autoswitch mode\n");
4457 }
4458
4459 static int video_outputsw_get(void)
4460 {
4461         int status = 0;
4462         int i;
4463
4464         switch (video_supported) {
4465         case TPACPI_VIDEO_570:
4466                 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4467                                  TP_ACPI_VIDEO_570_PHSCMD))
4468                         return -EIO;
4469                 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4470                 break;
4471         case TPACPI_VIDEO_770:
4472                 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4473                         return -EIO;
4474                 if (i)
4475                         status |= TP_ACPI_VIDEO_S_LCD;
4476                 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4477                         return -EIO;
4478                 if (i)
4479                         status |= TP_ACPI_VIDEO_S_CRT;
4480                 break;
4481         case TPACPI_VIDEO_NEW:
4482                 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4483                     !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4484                         return -EIO;
4485                 if (i)
4486                         status |= TP_ACPI_VIDEO_S_CRT;
4487
4488                 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4489                     !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4490                         return -EIO;
4491                 if (i)
4492                         status |= TP_ACPI_VIDEO_S_LCD;
4493                 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4494                         return -EIO;
4495                 if (i)
4496                         status |= TP_ACPI_VIDEO_S_DVI;
4497                 break;
4498         default:
4499                 return -ENOSYS;
4500         }
4501
4502         return status;
4503 }
4504
4505 static int video_outputsw_set(int status)
4506 {
4507         int autosw;
4508         int res = 0;
4509
4510         switch (video_supported) {
4511         case TPACPI_VIDEO_570:
4512                 res = acpi_evalf(NULL, NULL,
4513                                  "\\_SB.PHS2", "vdd",
4514                                  TP_ACPI_VIDEO_570_PHS2CMD,
4515                                  status | TP_ACPI_VIDEO_570_PHS2SET);
4516                 break;
4517         case TPACPI_VIDEO_770:
4518                 autosw = video_autosw_get();
4519                 if (autosw < 0)
4520                         return autosw;
4521
4522                 res = video_autosw_set(1);
4523                 if (res)
4524                         return res;
4525                 res = acpi_evalf(vid_handle, NULL,
4526                                  "ASWT", "vdd", status * 0x100, 0);
4527                 if (!autosw && video_autosw_set(autosw)) {
4528                         printk(TPACPI_ERR
4529                                "video auto-switch left enabled due to error\n");
4530                         return -EIO;
4531                 }
4532                 break;
4533         case TPACPI_VIDEO_NEW:
4534                 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4535                       acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4536                 break;
4537         default:
4538                 return -ENOSYS;
4539         }
4540
4541         return (res)? 0 : -EIO;
4542 }
4543
4544 static int video_autosw_get(void)
4545 {
4546         int autosw = 0;
4547
4548         switch (video_supported) {
4549         case TPACPI_VIDEO_570:
4550                 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4551                         return -EIO;
4552                 break;
4553         case TPACPI_VIDEO_770:
4554         case TPACPI_VIDEO_NEW:
4555                 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4556                         return -EIO;
4557                 break;
4558         default:
4559                 return -ENOSYS;
4560         }
4561
4562         return autosw & 1;
4563 }
4564
4565 static int video_autosw_set(int enable)
4566 {
4567         if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4568                 return -EIO;
4569         return 0;
4570 }
4571
4572 static int video_outputsw_cycle(void)
4573 {
4574         int autosw = video_autosw_get();
4575         int res;
4576
4577         if (autosw < 0)
4578                 return autosw;
4579
4580         switch (video_supported) {
4581         case TPACPI_VIDEO_570:
4582                 res = video_autosw_set(1);
4583                 if (res)
4584                         return res;
4585                 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4586                 break;
4587         case TPACPI_VIDEO_770:
4588         case TPACPI_VIDEO_NEW:
4589                 res = video_autosw_set(1);
4590                 if (res)
4591                         return res;
4592                 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4593                 break;
4594         default:
4595                 return -ENOSYS;
4596         }
4597         if (!autosw && video_autosw_set(autosw)) {
4598                 printk(TPACPI_ERR
4599                        "video auto-switch left enabled due to error\n");
4600                 return -EIO;
4601         }
4602
4603         return (res)? 0 : -EIO;
4604 }
4605
4606 static int video_expand_toggle(void)
4607 {
4608         switch (video_supported) {
4609         case TPACPI_VIDEO_570:
4610                 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4611                         0 : -EIO;
4612         case TPACPI_VIDEO_770:
4613                 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4614                         0 : -EIO;
4615         case TPACPI_VIDEO_NEW:
4616                 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4617                         0 : -EIO;
4618         default:
4619                 return -ENOSYS;
4620         }
4621         /* not reached */
4622 }
4623
4624 static int video_read(struct seq_file *m)
4625 {
4626         int status, autosw;
4627
4628         if (video_supported == TPACPI_VIDEO_NONE) {
4629                 seq_printf(m, "status:\t\tnot supported\n");
4630                 return 0;
4631         }
4632
4633         /* Even reads can crash X.org, so... */
4634         if (!capable(CAP_SYS_ADMIN))
4635                 return -EPERM;
4636
4637         status = video_outputsw_get();
4638         if (status < 0)
4639                 return status;
4640
4641         autosw = video_autosw_get();
4642         if (autosw < 0)
4643                 return autosw;
4644
4645         seq_printf(m, "status:\t\tsupported\n");
4646         seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4647         seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4648         if (video_supported == TPACPI_VIDEO_NEW)
4649                 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4650         seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4651         seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4652         seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4653         if (video_supported == TPACPI_VIDEO_NEW)
4654                 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4655         seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4656         seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4657
4658         return 0;
4659 }
4660
4661 static int video_write(char *buf)
4662 {
4663         char *cmd;
4664         int enable, disable, status;
4665         int res;
4666
4667         if (video_supported == TPACPI_VIDEO_NONE)
4668                 return -ENODEV;
4669
4670         /* Even reads can crash X.org, let alone writes... */
4671         if (!capable(CAP_SYS_ADMIN))
4672                 return -EPERM;
4673
4674         enable = 0;
4675         disable = 0;
4676
4677         while ((cmd = next_cmd(&buf))) {
4678                 if (strlencmp(cmd, "lcd_enable") == 0) {
4679                         enable |= TP_ACPI_VIDEO_S_LCD;
4680                 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4681                         disable |= TP_ACPI_VIDEO_S_LCD;
4682                 } else if (strlencmp(cmd, "crt_enable") == 0) {
4683                         enable |= TP_ACPI_VIDEO_S_CRT;
4684                 } else if (strlencmp(cmd, "crt_disable") == 0) {
4685                         disable |= TP_ACPI_VIDEO_S_CRT;
4686                 } else if (video_supported == TPACPI_VIDEO_NEW &&
4687                            strlencmp(cmd, "dvi_enable") == 0) {
4688                         enable |= TP_ACPI_VIDEO_S_DVI;
4689                 } else if (video_supported == TPACPI_VIDEO_NEW &&
4690                            strlencmp(cmd, "dvi_disable") == 0) {
4691                         disable |= TP_ACPI_VIDEO_S_DVI;
4692                 } else if (strlencmp(cmd, "auto_enable") == 0) {
4693                         res = video_autosw_set(1);
4694                         if (res)
4695                                 return res;
4696                 } else if (strlencmp(cmd, "auto_disable") == 0) {
4697                         res = video_autosw_set(0);
4698                         if (res)
4699                                 return res;
4700                 } else if (strlencmp(cmd, "video_switch") == 0) {
4701                         res = video_outputsw_cycle();
4702                         if (res)
4703                                 return res;
4704                 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4705                         res = video_expand_toggle();
4706                         if (res)
4707                                 return res;
4708                 } else
4709                         return -EINVAL;
4710         }
4711
4712         if (enable || disable) {
4713                 status = video_outputsw_get();
4714                 if (status < 0)
4715                         return status;
4716                 res = video_outputsw_set((status & ~disable) | enable);
4717                 if (res)
4718                         return res;
4719         }
4720
4721         return 0;
4722 }
4723
4724 static struct ibm_struct video_driver_data = {
4725         .name = "video",
4726         .read = video_read,
4727         .write = video_write,
4728         .exit = video_exit,
4729 };
4730
4731 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4732
4733 /*************************************************************************
4734  * Light (thinklight) subdriver
4735  */
4736
4737 TPACPI_HANDLE(lght, root, "\\LGHT");    /* A21e, A2xm/p, T20-22, X20-21 */
4738 TPACPI_HANDLE(ledb, ec, "LEDB");                /* G4x */
4739
4740 static int light_get_status(void)
4741 {
4742         int status = 0;
4743
4744         if (tp_features.light_status) {
4745                 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4746                         return -EIO;
4747                 return (!!status);
4748         }
4749
4750         return -ENXIO;
4751 }
4752
4753 static int light_set_status(int status)
4754 {
4755         int rc;
4756
4757         if (tp_features.light) {
4758                 if (cmos_handle) {
4759                         rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4760                                         (status)?
4761                                                 TP_CMOS_THINKLIGHT_ON :
4762                                                 TP_CMOS_THINKLIGHT_OFF);
4763                 } else {
4764                         rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4765                                         (status)? 1 : 0);
4766                 }
4767                 return (rc)? 0 : -EIO;
4768         }
4769
4770         return -ENXIO;
4771 }
4772
4773 static void light_set_status_worker(struct work_struct *work)
4774 {
4775         struct tpacpi_led_classdev *data =
4776                         container_of(work, struct tpacpi_led_classdev, work);
4777
4778         if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4779                 light_set_status((data->new_state != TPACPI_LED_OFF));
4780 }
4781
4782 static void light_sysfs_set(struct led_classdev *led_cdev,
4783                         enum led_brightness brightness)
4784 {
4785         struct tpacpi_led_classdev *data =
4786                 container_of(led_cdev,
4787                              struct tpacpi_led_classdev,
4788                              led_classdev);
4789         data->new_state = (brightness != LED_OFF) ?
4790                                 TPACPI_LED_ON : TPACPI_LED_OFF;
4791         queue_work(tpacpi_wq, &data->work);
4792 }
4793
4794 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4795 {
4796         return (light_get_status() == 1)? LED_FULL : LED_OFF;
4797 }
4798
4799 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4800         .led_classdev = {
4801                 .name           = "tpacpi::thinklight",
4802                 .brightness_set = &light_sysfs_set,
4803                 .brightness_get = &light_sysfs_get,
4804         }
4805 };
4806
4807 static int __init light_init(struct ibm_init_struct *iibm)
4808 {
4809         int rc;
4810
4811         vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4812
4813         TPACPI_ACPIHANDLE_INIT(ledb);
4814         TPACPI_ACPIHANDLE_INIT(lght);
4815         TPACPI_ACPIHANDLE_INIT(cmos);
4816         INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4817
4818         /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4819         tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4820
4821         if (tp_features.light)
4822                 /* light status not supported on
4823                    570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4824                 tp_features.light_status =
4825                         acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4826
4827         vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4828                 str_supported(tp_features.light),
4829                 str_supported(tp_features.light_status));
4830
4831         if (!tp_features.light)
4832                 return 1;
4833
4834         rc = led_classdev_register(&tpacpi_pdev->dev,
4835                                    &tpacpi_led_thinklight.led_classdev);
4836
4837         if (rc < 0) {
4838                 tp_features.light = 0;
4839                 tp_features.light_status = 0;
4840         } else  {
4841                 rc = 0;
4842         }
4843
4844         return rc;
4845 }
4846
4847 static void light_exit(void)
4848 {
4849         led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4850         if (work_pending(&tpacpi_led_thinklight.work))
4851                 flush_workqueue(tpacpi_wq);
4852 }
4853
4854 static int light_read(struct seq_file *m)
4855 {
4856         int status;
4857
4858         if (!tp_features.light) {
4859                 seq_printf(m, "status:\t\tnot supported\n");
4860         } else if (!tp_features.light_status) {
4861                 seq_printf(m, "status:\t\tunknown\n");
4862                 seq_printf(m, "commands:\ton, off\n");
4863         } else {
4864                 status = light_get_status();
4865                 if (status < 0)
4866                         return status;
4867                 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4868                 seq_printf(m, "commands:\ton, off\n");
4869         }
4870
4871         return 0;
4872 }
4873
4874 static int light_write(char *buf)
4875 {
4876         char *cmd;
4877         int newstatus = 0;
4878
4879         if (!tp_features.light)
4880                 return -ENODEV;
4881
4882         while ((cmd = next_cmd(&buf))) {
4883                 if (strlencmp(cmd, "on") == 0) {
4884                         newstatus = 1;
4885                 } else if (strlencmp(cmd, "off") == 0) {
4886                         newstatus = 0;
4887                 } else
4888                         return -EINVAL;
4889         }
4890
4891         return light_set_status(newstatus);
4892 }
4893
4894 static struct ibm_struct light_driver_data = {
4895         .name = "light",
4896         .read = light_read,
4897         .write = light_write,
4898         .exit = light_exit,
4899 };
4900
4901 /*************************************************************************
4902  * CMOS subdriver
4903  */
4904
4905 /* sysfs cmos_command -------------------------------------------------- */
4906 static ssize_t cmos_command_store(struct device *dev,
4907                             struct device_attribute *attr,
4908                             const char *buf, size_t count)
4909 {
4910         unsigned long cmos_cmd;
4911         int res;
4912
4913         if (parse_strtoul(buf, 21, &cmos_cmd))
4914                 return -EINVAL;
4915
4916         res = issue_thinkpad_cmos_command(cmos_cmd);
4917         return (res)? res : count;
4918 }
4919
4920 static struct device_attribute dev_attr_cmos_command =
4921         __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4922
4923 /* --------------------------------------------------------------------- */
4924
4925 static int __init cmos_init(struct ibm_init_struct *iibm)
4926 {
4927         int res;
4928
4929         vdbg_printk(TPACPI_DBG_INIT,
4930                 "initializing cmos commands subdriver\n");
4931
4932         TPACPI_ACPIHANDLE_INIT(cmos);
4933
4934         vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4935                 str_supported(cmos_handle != NULL));
4936
4937         res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4938         if (res)
4939                 return res;
4940
4941         return (cmos_handle)? 0 : 1;
4942 }
4943
4944 static void cmos_exit(void)
4945 {
4946         device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4947 }
4948
4949 static int cmos_read(struct seq_file *m)
4950 {
4951         /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4952            R30, R31, T20-22, X20-21 */
4953         if (!cmos_handle)
4954                 seq_printf(m, "status:\t\tnot supported\n");
4955         else {
4956                 seq_printf(m, "status:\t\tsupported\n");
4957                 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
4958         }
4959
4960         return 0;
4961 }
4962
4963 static int cmos_write(char *buf)
4964 {
4965         char *cmd;
4966         int cmos_cmd, res;
4967
4968         while ((cmd = next_cmd(&buf))) {
4969                 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
4970                     cmos_cmd >= 0 && cmos_cmd <= 21) {
4971                         /* cmos_cmd set */
4972                 } else
4973                         return -EINVAL;
4974
4975                 res = issue_thinkpad_cmos_command(cmos_cmd);
4976                 if (res)
4977                         return res;
4978         }
4979
4980         return 0;
4981 }
4982
4983 static struct ibm_struct cmos_driver_data = {
4984         .name = "cmos",
4985         .read = cmos_read,
4986         .write = cmos_write,
4987         .exit = cmos_exit,
4988 };
4989
4990 /*************************************************************************
4991  * LED subdriver
4992  */
4993
4994 enum led_access_mode {
4995         TPACPI_LED_NONE = 0,
4996         TPACPI_LED_570, /* 570 */
4997         TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
4998         TPACPI_LED_NEW, /* all others */
4999 };
5000
5001 enum {  /* For TPACPI_LED_OLD */
5002         TPACPI_LED_EC_HLCL = 0x0c,      /* EC reg to get led to power on */
5003         TPACPI_LED_EC_HLBL = 0x0d,      /* EC reg to blink a lit led */
5004         TPACPI_LED_EC_HLMS = 0x0e,      /* EC reg to select led to command */
5005 };
5006
5007 static enum led_access_mode led_supported;
5008
5009 TPACPI_HANDLE(led, ec, "SLED",  /* 570 */
5010            "SYSL",              /* 600e/x, 770e, 770x, A21e, A2xm/p, */
5011                                 /* T20-22, X20-21 */
5012            "LED",               /* all others */
5013            );                   /* R30, R31 */
5014
5015 #define TPACPI_LED_NUMLEDS 16
5016 static struct tpacpi_led_classdev *tpacpi_leds;
5017 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5018 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5019         /* there's a limit of 19 chars + NULL before 2.6.26 */
5020         "tpacpi::power",
5021         "tpacpi:orange:batt",
5022         "tpacpi:green:batt",
5023         "tpacpi::dock_active",
5024         "tpacpi::bay_active",
5025         "tpacpi::dock_batt",
5026         "tpacpi::unknown_led",
5027         "tpacpi::standby",
5028         "tpacpi::dock_status1",
5029         "tpacpi::dock_status2",
5030         "tpacpi::unknown_led2",
5031         "tpacpi::unknown_led3",
5032         "tpacpi::thinkvantage",
5033 };
5034 #define TPACPI_SAFE_LEDS        0x1081U
5035
5036 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5037 {
5038 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5039         return false;
5040 #else
5041         return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5042 #endif
5043 }
5044
5045 static int led_get_status(const unsigned int led)
5046 {
5047         int status;
5048         enum led_status_t led_s;
5049
5050         switch (led_supported) {
5051         case TPACPI_LED_570:
5052                 if (!acpi_evalf(ec_handle,
5053                                 &status, "GLED", "dd", 1 << led))
5054                         return -EIO;
5055                 led_s = (status == 0)?
5056                                 TPACPI_LED_OFF :
5057                                 ((status == 1)?
5058                                         TPACPI_LED_ON :
5059                                         TPACPI_LED_BLINK);
5060                 tpacpi_led_state_cache[led] = led_s;
5061                 return led_s;
5062         default:
5063                 return -ENXIO;
5064         }
5065
5066         /* not reached */
5067 }
5068
5069 static int led_set_status(const unsigned int led,
5070                           const enum led_status_t ledstatus)
5071 {
5072         /* off, on, blink. Index is led_status_t */
5073         static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5074         static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5075
5076         int rc = 0;
5077
5078         switch (led_supported) {
5079         case TPACPI_LED_570:
5080                 /* 570 */
5081                 if (unlikely(led > 7))
5082                         return -EINVAL;
5083                 if (unlikely(tpacpi_is_led_restricted(led)))
5084                         return -EPERM;
5085                 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5086                                 (1 << led), led_sled_arg1[ledstatus]))
5087                         rc = -EIO;
5088                 break;
5089         case TPACPI_LED_OLD:
5090                 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5091                 if (unlikely(led > 7))
5092                         return -EINVAL;
5093                 if (unlikely(tpacpi_is_led_restricted(led)))
5094                         return -EPERM;
5095                 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5096                 if (rc >= 0)
5097                         rc = ec_write(TPACPI_LED_EC_HLBL,
5098                                       (ledstatus == TPACPI_LED_BLINK) << led);
5099                 if (rc >= 0)
5100                         rc = ec_write(TPACPI_LED_EC_HLCL,
5101                                       (ledstatus != TPACPI_LED_OFF) << led);
5102                 break;
5103         case TPACPI_LED_NEW:
5104                 /* all others */
5105                 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5106                         return -EINVAL;
5107                 if (unlikely(tpacpi_is_led_restricted(led)))
5108                         return -EPERM;
5109                 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5110                                 led, led_led_arg1[ledstatus]))
5111                         rc = -EIO;
5112                 break;
5113         default:
5114                 rc = -ENXIO;
5115         }
5116
5117         if (!rc)
5118                 tpacpi_led_state_cache[led] = ledstatus;
5119
5120         return rc;
5121 }
5122
5123 static void led_set_status_worker(struct work_struct *work)
5124 {
5125         struct tpacpi_led_classdev *data =
5126                 container_of(work, struct tpacpi_led_classdev, work);
5127
5128         if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5129                 led_set_status(data->led, data->new_state);
5130 }
5131
5132 static void led_sysfs_set(struct led_classdev *led_cdev,
5133                         enum led_brightness brightness)
5134 {
5135         struct tpacpi_led_classdev *data = container_of(led_cdev,
5136                              struct tpacpi_led_classdev, led_classdev);
5137
5138         if (brightness == LED_OFF)
5139                 data->new_state = TPACPI_LED_OFF;
5140         else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5141                 data->new_state = TPACPI_LED_ON;
5142         else
5143                 data->new_state = TPACPI_LED_BLINK;
5144
5145         queue_work(tpacpi_wq, &data->work);
5146 }
5147
5148 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5149                         unsigned long *delay_on, unsigned long *delay_off)
5150 {
5151         struct tpacpi_led_classdev *data = container_of(led_cdev,
5152                              struct tpacpi_led_classdev, led_classdev);
5153
5154         /* Can we choose the flash rate? */
5155         if (*delay_on == 0 && *delay_off == 0) {
5156                 /* yes. set them to the hardware blink rate (1 Hz) */
5157                 *delay_on = 500; /* ms */
5158                 *delay_off = 500; /* ms */
5159         } else if ((*delay_on != 500) || (*delay_off != 500))
5160                 return -EINVAL;
5161
5162         data->new_state = TPACPI_LED_BLINK;
5163         queue_work(tpacpi_wq, &data->work);
5164
5165         return 0;
5166 }
5167
5168 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5169 {
5170         int rc;
5171
5172         struct tpacpi_led_classdev *data = container_of(led_cdev,
5173                              struct tpacpi_led_classdev, led_classdev);
5174
5175         rc = led_get_status(data->led);
5176
5177         if (rc == TPACPI_LED_OFF || rc < 0)
5178                 rc = LED_OFF;   /* no error handling in led class :( */
5179         else
5180                 rc = LED_FULL;
5181
5182         return rc;
5183 }
5184
5185 static void led_exit(void)
5186 {
5187         unsigned int i;
5188
5189         for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5190                 if (tpacpi_leds[i].led_classdev.name)
5191                         led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5192         }
5193
5194         kfree(tpacpi_leds);
5195 }
5196
5197 static int __init tpacpi_init_led(unsigned int led)
5198 {
5199         int rc;
5200
5201         tpacpi_leds[led].led = led;
5202
5203         /* LEDs with no name don't get registered */
5204         if (!tpacpi_led_names[led])
5205                 return 0;
5206
5207         tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5208         tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5209         if (led_supported == TPACPI_LED_570)
5210                 tpacpi_leds[led].led_classdev.brightness_get =
5211                                                 &led_sysfs_get;
5212
5213         tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5214
5215         INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5216
5217         rc = led_classdev_register(&tpacpi_pdev->dev,
5218                                 &tpacpi_leds[led].led_classdev);
5219         if (rc < 0)
5220                 tpacpi_leds[led].led_classdev.name = NULL;
5221
5222         return rc;
5223 }
5224
5225 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5226         TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5227         TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5228         TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5229
5230         TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5231         TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5232         TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5233         TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5234         TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5235         TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5236         TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5237         TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5238
5239         TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5240         TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5241         TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5242         TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5243         TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5244
5245         TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5246         TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5247         TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5248         TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5249
5250         /* (1) - may have excess leds enabled on MSB */
5251
5252         /* Defaults (order matters, keep last, don't reorder!) */
5253         { /* Lenovo */
5254           .vendor = PCI_VENDOR_ID_LENOVO,
5255           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5256           .quirks = 0x1fffU,
5257         },
5258         { /* IBM ThinkPads with no EC version string */
5259           .vendor = PCI_VENDOR_ID_IBM,
5260           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5261           .quirks = 0x00ffU,
5262         },
5263         { /* IBM ThinkPads with EC version string */
5264           .vendor = PCI_VENDOR_ID_IBM,
5265           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5266           .quirks = 0x00bfU,
5267         },
5268 };
5269
5270 #undef TPACPI_LEDQ_IBM
5271 #undef TPACPI_LEDQ_LNV
5272
5273 static int __init led_init(struct ibm_init_struct *iibm)
5274 {
5275         unsigned int i;
5276         int rc;
5277         unsigned long useful_leds;
5278
5279         vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5280
5281         TPACPI_ACPIHANDLE_INIT(led);
5282
5283         if (!led_handle)
5284                 /* led not supported on R30, R31 */
5285                 led_supported = TPACPI_LED_NONE;
5286         else if (strlencmp(led_path, "SLED") == 0)
5287                 /* 570 */
5288                 led_supported = TPACPI_LED_570;
5289         else if (strlencmp(led_path, "SYSL") == 0)
5290                 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5291                 led_supported = TPACPI_LED_OLD;
5292         else
5293                 /* all others */
5294                 led_supported = TPACPI_LED_NEW;
5295
5296         vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5297                 str_supported(led_supported), led_supported);
5298
5299         if (led_supported == TPACPI_LED_NONE)
5300                 return 1;
5301
5302         tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5303                               GFP_KERNEL);
5304         if (!tpacpi_leds) {
5305                 printk(TPACPI_ERR "Out of memory for LED data\n");
5306                 return -ENOMEM;
5307         }
5308
5309         useful_leds = tpacpi_check_quirks(led_useful_qtable,
5310                                           ARRAY_SIZE(led_useful_qtable));
5311
5312         for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5313                 if (!tpacpi_is_led_restricted(i) &&
5314                     test_bit(i, &useful_leds)) {
5315                         rc = tpacpi_init_led(i);
5316                         if (rc < 0) {
5317                                 led_exit();
5318                                 return rc;
5319                         }
5320                 }
5321         }
5322
5323 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5324         printk(TPACPI_NOTICE
5325                 "warning: userspace override of important "
5326                 "firmware LEDs is enabled\n");
5327 #endif
5328         return 0;
5329 }
5330
5331 #define str_led_status(s) \
5332         ((s) == TPACPI_LED_OFF ? "off" : \
5333                 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5334
5335 static int led_read(struct seq_file *m)
5336 {
5337         if (!led_supported) {
5338                 seq_printf(m, "status:\t\tnot supported\n");
5339                 return 0;
5340         }
5341         seq_printf(m, "status:\t\tsupported\n");
5342
5343         if (led_supported == TPACPI_LED_570) {
5344                 /* 570 */
5345                 int i, status;
5346                 for (i = 0; i < 8; i++) {
5347                         status = led_get_status(i);
5348                         if (status < 0)
5349                                 return -EIO;
5350                         seq_printf(m, "%d:\t\t%s\n",
5351                                        i, str_led_status(status));
5352                 }
5353         }
5354
5355         seq_printf(m, "commands:\t"
5356                        "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5357
5358         return 0;
5359 }
5360
5361 static int led_write(char *buf)
5362 {
5363         char *cmd;
5364         int led, rc;
5365         enum led_status_t s;
5366
5367         if (!led_supported)
5368                 return -ENODEV;
5369
5370         while ((cmd = next_cmd(&buf))) {
5371                 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5372                         return -EINVAL;
5373
5374                 if (strstr(cmd, "off")) {
5375                         s = TPACPI_LED_OFF;
5376                 } else if (strstr(cmd, "on")) {
5377                         s = TPACPI_LED_ON;
5378                 } else if (strstr(cmd, "blink")) {
5379                         s = TPACPI_LED_BLINK;
5380                 } else {
5381                         return -EINVAL;
5382                 }
5383
5384                 rc = led_set_status(led, s);
5385                 if (rc < 0)
5386                         return rc;
5387         }
5388
5389         return 0;
5390 }
5391
5392 static struct ibm_struct led_driver_data = {
5393         .name = "led",
5394         .read = led_read,
5395         .write = led_write,
5396         .exit = led_exit,
5397 };
5398
5399 /*************************************************************************
5400  * Beep subdriver
5401  */
5402
5403 TPACPI_HANDLE(beep, ec, "BEEP");        /* all except R30, R31 */
5404
5405 #define TPACPI_BEEP_Q1 0x0001
5406
5407 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5408         TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5409         TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5410 };
5411
5412 static int __init beep_init(struct ibm_init_struct *iibm)
5413 {
5414         unsigned long quirks;
5415
5416         vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5417
5418         TPACPI_ACPIHANDLE_INIT(beep);
5419
5420         vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5421                 str_supported(beep_handle != NULL));
5422
5423         quirks = tpacpi_check_quirks(beep_quirk_table,
5424                                      ARRAY_SIZE(beep_quirk_table));
5425
5426         tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5427
5428         return (beep_handle)? 0 : 1;
5429 }
5430
5431 static int beep_read(struct seq_file *m)
5432 {
5433         if (!beep_handle)
5434                 seq_printf(m, "status:\t\tnot supported\n");
5435         else {
5436                 seq_printf(m, "status:\t\tsupported\n");
5437                 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5438         }
5439
5440         return 0;
5441 }
5442
5443 static int beep_write(char *buf)
5444 {
5445         char *cmd;
5446         int beep_cmd;
5447
5448         if (!beep_handle)
5449                 return -ENODEV;
5450
5451         while ((cmd = next_cmd(&buf))) {
5452                 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5453                     beep_cmd >= 0 && beep_cmd <= 17) {
5454                         /* beep_cmd set */
5455                 } else
5456                         return -EINVAL;
5457                 if (tp_features.beep_needs_two_args) {
5458                         if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5459                                         beep_cmd, 0))
5460                                 return -EIO;
5461                 } else {
5462                         if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5463                                         beep_cmd))
5464                                 return -EIO;
5465                 }
5466         }
5467
5468         return 0;
5469 }
5470
5471 static struct ibm_struct beep_driver_data = {
5472         .name = "beep",
5473         .read = beep_read,
5474         .write = beep_write,
5475 };
5476
5477 /*************************************************************************
5478  * Thermal subdriver
5479  */
5480
5481 enum thermal_access_mode {
5482         TPACPI_THERMAL_NONE = 0,        /* No thermal support */
5483         TPACPI_THERMAL_ACPI_TMP07,      /* Use ACPI TMP0-7 */
5484         TPACPI_THERMAL_ACPI_UPDT,       /* Use ACPI TMP0-7 with UPDT */
5485         TPACPI_THERMAL_TPEC_8,          /* Use ACPI EC regs, 8 sensors */
5486         TPACPI_THERMAL_TPEC_16,         /* Use ACPI EC regs, 16 sensors */
5487 };
5488
5489 enum { /* TPACPI_THERMAL_TPEC_* */
5490         TP_EC_THERMAL_TMP0 = 0x78,      /* ACPI EC regs TMP 0..7 */
5491         TP_EC_THERMAL_TMP8 = 0xC0,      /* ACPI EC regs TMP 8..15 */
5492         TP_EC_THERMAL_TMP_NA = -128,    /* ACPI EC sensor not available */
5493
5494         TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5495 };
5496
5497
5498 #define TPACPI_MAX_THERMAL_SENSORS 16   /* Max thermal sensors supported */
5499 struct ibm_thermal_sensors_struct {
5500         s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5501 };
5502
5503 static enum thermal_access_mode thermal_read_mode;
5504
5505 /* idx is zero-based */
5506 static int thermal_get_sensor(int idx, s32 *value)
5507 {
5508         int t;
5509         s8 tmp;
5510         char tmpi[5];
5511
5512         t = TP_EC_THERMAL_TMP0;
5513
5514         switch (thermal_read_mode) {
5515 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5516         case TPACPI_THERMAL_TPEC_16:
5517                 if (idx >= 8 && idx <= 15) {
5518                         t = TP_EC_THERMAL_TMP8;
5519                         idx -= 8;
5520                 }
5521                 /* fallthrough */
5522 #endif
5523         case TPACPI_THERMAL_TPEC_8:
5524                 if (idx <= 7) {
5525                         if (!acpi_ec_read(t + idx, &tmp))
5526                                 return -EIO;
5527                         *value = tmp * 1000;
5528                         return 0;
5529                 }
5530                 break;
5531
5532         case TPACPI_THERMAL_ACPI_UPDT:
5533                 if (idx <= 7) {
5534                         snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5535                         if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5536                                 return -EIO;
5537                         if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5538                                 return -EIO;
5539                         *value = (t - 2732) * 100;
5540                         return 0;
5541                 }
5542                 break;
5543
5544         case TPACPI_THERMAL_ACPI_TMP07:
5545                 if (idx <= 7) {
5546                         snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5547                         if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5548                                 return -EIO;
5549                         if (t > 127 || t < -127)
5550                                 t = TP_EC_THERMAL_TMP_NA;
5551                         *value = t * 1000;
5552                         return 0;
5553                 }
5554                 break;
5555
5556         case TPACPI_THERMAL_NONE:
5557         default:
5558                 return -ENOSYS;
5559         }
5560
5561         return -EINVAL;
5562 }
5563
5564 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5565 {
5566         int res, i;
5567         int n;
5568
5569         n = 8;
5570         i = 0;
5571
5572         if (!s)
5573                 return -EINVAL;
5574
5575         if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5576                 n = 16;
5577
5578         for (i = 0 ; i < n; i++) {
5579                 res = thermal_get_sensor(i, &s->temp[i]);
5580                 if (res)
5581                         return res;
5582         }
5583
5584         return n;
5585 }
5586
5587 static void thermal_dump_all_sensors(void)
5588 {
5589         int n, i;
5590         struct ibm_thermal_sensors_struct t;
5591
5592         n = thermal_get_sensors(&t);
5593         if (n <= 0)
5594                 return;
5595
5596         printk(TPACPI_NOTICE
5597                 "temperatures (Celsius):");
5598
5599         for (i = 0; i < n; i++) {
5600                 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5601                         printk(KERN_CONT " %d", (int)(t.temp[i] / 1000));
5602                 else
5603                         printk(KERN_CONT " N/A");
5604         }
5605
5606         printk(KERN_CONT "\n");
5607 }
5608
5609 /* sysfs temp##_input -------------------------------------------------- */
5610
5611 static ssize_t thermal_temp_input_show(struct device *dev,
5612                            struct device_attribute *attr,
5613                            char *buf)
5614 {
5615         struct sensor_device_attribute *sensor_attr =
5616                                         to_sensor_dev_attr(attr);
5617         int idx = sensor_attr->index;
5618         s32 value;
5619         int res;
5620
5621         res = thermal_get_sensor(idx, &value);
5622         if (res)
5623                 return res;
5624         if (value == TPACPI_THERMAL_SENSOR_NA)
5625                 return -ENXIO;
5626
5627         return snprintf(buf, PAGE_SIZE, "%d\n", value);
5628 }
5629
5630 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5631          SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5632                      thermal_temp_input_show, NULL, _idxB)
5633
5634 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5635         THERMAL_SENSOR_ATTR_TEMP(1, 0),
5636         THERMAL_SENSOR_ATTR_TEMP(2, 1),
5637         THERMAL_SENSOR_ATTR_TEMP(3, 2),
5638         THERMAL_SENSOR_ATTR_TEMP(4, 3),
5639         THERMAL_SENSOR_ATTR_TEMP(5, 4),
5640         THERMAL_SENSOR_ATTR_TEMP(6, 5),
5641         THERMAL_SENSOR_ATTR_TEMP(7, 6),
5642         THERMAL_SENSOR_ATTR_TEMP(8, 7),
5643         THERMAL_SENSOR_ATTR_TEMP(9, 8),
5644         THERMAL_SENSOR_ATTR_TEMP(10, 9),
5645         THERMAL_SENSOR_ATTR_TEMP(11, 10),
5646         THERMAL_SENSOR_ATTR_TEMP(12, 11),
5647         THERMAL_SENSOR_ATTR_TEMP(13, 12),
5648         THERMAL_SENSOR_ATTR_TEMP(14, 13),
5649         THERMAL_SENSOR_ATTR_TEMP(15, 14),
5650         THERMAL_SENSOR_ATTR_TEMP(16, 15),
5651 };
5652
5653 #define THERMAL_ATTRS(X) \
5654         &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5655
5656 static struct attribute *thermal_temp_input_attr[] = {
5657         THERMAL_ATTRS(8),
5658         THERMAL_ATTRS(9),
5659         THERMAL_ATTRS(10),
5660         THERMAL_ATTRS(11),
5661         THERMAL_ATTRS(12),
5662         THERMAL_ATTRS(13),
5663         THERMAL_ATTRS(14),
5664         THERMAL_ATTRS(15),
5665         THERMAL_ATTRS(0),
5666         THERMAL_ATTRS(1),
5667         THERMAL_ATTRS(2),
5668         THERMAL_ATTRS(3),
5669         THERMAL_ATTRS(4),
5670         THERMAL_ATTRS(5),
5671         THERMAL_ATTRS(6),
5672         THERMAL_ATTRS(7),
5673         NULL
5674 };
5675
5676 static const struct attribute_group thermal_temp_input16_group = {
5677         .attrs = thermal_temp_input_attr
5678 };
5679
5680 static const struct attribute_group thermal_temp_input8_group = {
5681         .attrs = &thermal_temp_input_attr[8]
5682 };
5683
5684 #undef THERMAL_SENSOR_ATTR_TEMP
5685 #undef THERMAL_ATTRS
5686
5687 /* --------------------------------------------------------------------- */
5688
5689 static int __init thermal_init(struct ibm_init_struct *iibm)
5690 {
5691         u8 t, ta1, ta2;
5692         int i;
5693         int acpi_tmp7;
5694         int res;
5695
5696         vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5697
5698         acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5699
5700         if (thinkpad_id.ec_model) {
5701                 /*
5702                  * Direct EC access mode: sensors at registers
5703                  * 0x78-0x7F, 0xC0-0xC7.  Registers return 0x00 for
5704                  * non-implemented, thermal sensors return 0x80 when
5705                  * not available
5706                  */
5707
5708                 ta1 = ta2 = 0;
5709                 for (i = 0; i < 8; i++) {
5710                         if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5711                                 ta1 |= t;
5712                         } else {
5713                                 ta1 = 0;
5714                                 break;
5715                         }
5716                         if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5717                                 ta2 |= t;
5718                         } else {
5719                                 ta1 = 0;
5720                                 break;
5721                         }
5722                 }
5723                 if (ta1 == 0) {
5724                         /* This is sheer paranoia, but we handle it anyway */
5725                         if (acpi_tmp7) {
5726                                 printk(TPACPI_ERR
5727                                        "ThinkPad ACPI EC access misbehaving, "
5728                                        "falling back to ACPI TMPx access "
5729                                        "mode\n");
5730                                 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5731                         } else {
5732                                 printk(TPACPI_ERR
5733                                        "ThinkPad ACPI EC access misbehaving, "
5734                                        "disabling thermal sensors access\n");
5735                                 thermal_read_mode = TPACPI_THERMAL_NONE;
5736                         }
5737                 } else {
5738                         thermal_read_mode =
5739                             (ta2 != 0) ?
5740                             TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5741                 }
5742         } else if (acpi_tmp7) {
5743                 if (acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5744                         /* 600e/x, 770e, 770x */
5745                         thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5746                 } else {
5747                         /* Standard ACPI TMPx access, max 8 sensors */
5748                         thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5749                 }
5750         } else {
5751                 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5752                 thermal_read_mode = TPACPI_THERMAL_NONE;
5753         }
5754
5755         vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5756                 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5757                 thermal_read_mode);
5758
5759         switch (thermal_read_mode) {
5760         case TPACPI_THERMAL_TPEC_16:
5761                 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5762                                 &thermal_temp_input16_group);
5763                 if (res)
5764                         return res;
5765                 break;
5766         case TPACPI_THERMAL_TPEC_8:
5767         case TPACPI_THERMAL_ACPI_TMP07:
5768         case TPACPI_THERMAL_ACPI_UPDT:
5769                 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5770                                 &thermal_temp_input8_group);
5771                 if (res)
5772                         return res;
5773                 break;
5774         case TPACPI_THERMAL_NONE:
5775         default:
5776                 return 1;
5777         }
5778
5779         return 0;
5780 }
5781
5782 static void thermal_exit(void)
5783 {
5784         switch (thermal_read_mode) {
5785         case TPACPI_THERMAL_TPEC_16:
5786                 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5787                                    &thermal_temp_input16_group);
5788                 break;
5789         case TPACPI_THERMAL_TPEC_8:
5790         case TPACPI_THERMAL_ACPI_TMP07:
5791         case TPACPI_THERMAL_ACPI_UPDT:
5792                 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5793                                    &thermal_temp_input8_group);
5794                 break;
5795         case TPACPI_THERMAL_NONE:
5796         default:
5797                 break;
5798         }
5799 }
5800
5801 static int thermal_read(struct seq_file *m)
5802 {
5803         int n, i;
5804         struct ibm_thermal_sensors_struct t;
5805
5806         n = thermal_get_sensors(&t);
5807         if (unlikely(n < 0))
5808                 return n;
5809
5810         seq_printf(m, "temperatures:\t");
5811
5812         if (n > 0) {
5813                 for (i = 0; i < (n - 1); i++)
5814                         seq_printf(m, "%d ", t.temp[i] / 1000);
5815                 seq_printf(m, "%d\n", t.temp[i] / 1000);
5816         } else
5817                 seq_printf(m, "not supported\n");
5818
5819         return 0;
5820 }
5821
5822 static struct ibm_struct thermal_driver_data = {
5823         .name = "thermal",
5824         .read = thermal_read,
5825         .exit = thermal_exit,
5826 };
5827
5828 /*************************************************************************
5829  * EC Dump subdriver
5830  */
5831
5832 static u8 ecdump_regs[256];
5833
5834 static int ecdump_read(struct seq_file *m)
5835 {
5836         int i, j;
5837         u8 v;
5838
5839         seq_printf(m, "EC      "
5840                        " +00 +01 +02 +03 +04 +05 +06 +07"
5841                        " +08 +09 +0a +0b +0c +0d +0e +0f\n");
5842         for (i = 0; i < 256; i += 16) {
5843                 seq_printf(m, "EC 0x%02x:", i);
5844                 for (j = 0; j < 16; j++) {
5845                         if (!acpi_ec_read(i + j, &v))
5846                                 break;
5847                         if (v != ecdump_regs[i + j])
5848                                 seq_printf(m, " *%02x", v);
5849                         else
5850                                 seq_printf(m, "  %02x", v);
5851                         ecdump_regs[i + j] = v;
5852                 }
5853                 seq_putc(m, '\n');
5854                 if (j != 16)
5855                         break;
5856         }
5857
5858         /* These are way too dangerous to advertise openly... */
5859 #if 0
5860         seq_printf(m, "commands:\t0x<offset> 0x<value>"
5861                        " (<offset> is 00-ff, <value> is 00-ff)\n");
5862         seq_printf(m, "commands:\t0x<offset> <value>  "
5863                        " (<offset> is 00-ff, <value> is 0-255)\n");
5864 #endif
5865         return 0;
5866 }
5867
5868 static int ecdump_write(char *buf)
5869 {
5870         char *cmd;
5871         int i, v;
5872
5873         while ((cmd = next_cmd(&buf))) {
5874                 if (sscanf(cmd, "0x%x 0x%x", &i, &v) == 2) {
5875                         /* i and v set */
5876                 } else if (sscanf(cmd, "0x%x %u", &i, &v) == 2) {
5877                         /* i and v set */
5878                 } else
5879                         return -EINVAL;
5880                 if (i >= 0 && i < 256 && v >= 0 && v < 256) {
5881                         if (!acpi_ec_write(i, v))
5882                                 return -EIO;
5883                 } else
5884                         return -EINVAL;
5885         }
5886
5887         return 0;
5888 }
5889
5890 static struct ibm_struct ecdump_driver_data = {
5891         .name = "ecdump",
5892         .read = ecdump_read,
5893         .write = ecdump_write,
5894         .flags.experimental = 1,
5895 };
5896
5897 /*************************************************************************
5898  * Backlight/brightness subdriver
5899  */
5900
5901 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5902
5903 /*
5904  * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5905  * CMOS NVRAM byte 0x5E, bits 0-3.
5906  *
5907  * EC HBRV (0x31) has the following layout
5908  *   Bit 7: unknown function
5909  *   Bit 6: unknown function
5910  *   Bit 5: Z: honour scale changes, NZ: ignore scale changes
5911  *   Bit 4: must be set to zero to avoid problems
5912  *   Bit 3-0: backlight brightness level
5913  *
5914  * brightness_get_raw returns status data in the HBRV layout
5915  *
5916  * WARNING: The X61 has been verified to use HBRV for something else, so
5917  * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5918  * testing on the very early *60 Lenovo models...
5919  */
5920
5921 enum {
5922         TP_EC_BACKLIGHT = 0x31,
5923
5924         /* TP_EC_BACKLIGHT bitmasks */
5925         TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5926         TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5927         TP_EC_BACKLIGHT_MAPSW = 0x20,
5928 };
5929
5930 enum tpacpi_brightness_access_mode {
5931         TPACPI_BRGHT_MODE_AUTO = 0,     /* Not implemented yet */
5932         TPACPI_BRGHT_MODE_EC,           /* EC control */
5933         TPACPI_BRGHT_MODE_UCMS_STEP,    /* UCMS step-based control */
5934         TPACPI_BRGHT_MODE_ECNVRAM,      /* EC control w/ NVRAM store */
5935         TPACPI_BRGHT_MODE_MAX
5936 };
5937
5938 static struct backlight_device *ibm_backlight_device;
5939
5940 static enum tpacpi_brightness_access_mode brightness_mode =
5941                 TPACPI_BRGHT_MODE_MAX;
5942
5943 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5944
5945 static struct mutex brightness_mutex;
5946
5947 /* NVRAM brightness access,
5948  * call with brightness_mutex held! */
5949 static unsigned int tpacpi_brightness_nvram_get(void)
5950 {
5951         u8 lnvram;
5952
5953         lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5954                   & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5955                   >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5956         lnvram &= (tp_features.bright_16levels) ? 0x0f : 0x07;
5957
5958         return lnvram;
5959 }
5960
5961 static void tpacpi_brightness_checkpoint_nvram(void)
5962 {
5963         u8 lec = 0;
5964         u8 b_nvram;
5965
5966         if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
5967                 return;
5968
5969         vdbg_printk(TPACPI_DBG_BRGHT,
5970                 "trying to checkpoint backlight level to NVRAM...\n");
5971
5972         if (mutex_lock_killable(&brightness_mutex) < 0)
5973                 return;
5974
5975         if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5976                 goto unlock;
5977         lec &= TP_EC_BACKLIGHT_LVLMSK;
5978         b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
5979
5980         if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5981                              >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
5982                 /* NVRAM needs update */
5983                 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
5984                                 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
5985                 b_nvram |= lec;
5986                 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
5987                 dbg_printk(TPACPI_DBG_BRGHT,
5988                            "updated NVRAM backlight level to %u (0x%02x)\n",
5989                            (unsigned int) lec, (unsigned int) b_nvram);
5990         } else
5991                 vdbg_printk(TPACPI_DBG_BRGHT,
5992                            "NVRAM backlight level already is %u (0x%02x)\n",
5993                            (unsigned int) lec, (unsigned int) b_nvram);
5994
5995 unlock:
5996         mutex_unlock(&brightness_mutex);
5997 }
5998
5999
6000 /* call with brightness_mutex held! */
6001 static int tpacpi_brightness_get_raw(int *status)
6002 {
6003         u8 lec = 0;
6004
6005         switch (brightness_mode) {
6006         case TPACPI_BRGHT_MODE_UCMS_STEP:
6007                 *status = tpacpi_brightness_nvram_get();
6008                 return 0;
6009         case TPACPI_BRGHT_MODE_EC:
6010         case TPACPI_BRGHT_MODE_ECNVRAM:
6011                 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6012                         return -EIO;
6013                 *status = lec;
6014                 return 0;
6015         default:
6016                 return -ENXIO;
6017         }
6018 }
6019
6020 /* call with brightness_mutex held! */
6021 /* do NOT call with illegal backlight level value */
6022 static int tpacpi_brightness_set_ec(unsigned int value)
6023 {
6024         u8 lec = 0;
6025
6026         if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6027                 return -EIO;
6028
6029         if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6030                                 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6031                                 (value & TP_EC_BACKLIGHT_LVLMSK))))
6032                 return -EIO;
6033
6034         return 0;
6035 }
6036
6037 /* call with brightness_mutex held! */
6038 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6039 {
6040         int cmos_cmd, inc;
6041         unsigned int current_value, i;
6042
6043         current_value = tpacpi_brightness_nvram_get();
6044
6045         if (value == current_value)
6046                 return 0;
6047
6048         cmos_cmd = (value > current_value) ?
6049                         TP_CMOS_BRIGHTNESS_UP :
6050                         TP_CMOS_BRIGHTNESS_DOWN;
6051         inc = (value > current_value) ? 1 : -1;
6052
6053         for (i = current_value; i != value; i += inc)
6054                 if (issue_thinkpad_cmos_command(cmos_cmd))
6055                         return -EIO;
6056
6057         return 0;
6058 }
6059
6060 /* May return EINTR which can always be mapped to ERESTARTSYS */
6061 static int brightness_set(unsigned int value)
6062 {
6063         int res;
6064
6065         if (value > ((tp_features.bright_16levels)? 15 : 7) ||
6066             value < 0)
6067                 return -EINVAL;
6068
6069         vdbg_printk(TPACPI_DBG_BRGHT,
6070                         "set backlight level to %d\n", value);
6071
6072         res = mutex_lock_killable(&brightness_mutex);
6073         if (res < 0)
6074                 return res;
6075
6076         switch (brightness_mode) {
6077         case TPACPI_BRGHT_MODE_EC:
6078         case TPACPI_BRGHT_MODE_ECNVRAM:
6079                 res = tpacpi_brightness_set_ec(value);
6080                 break;
6081         case TPACPI_BRGHT_MODE_UCMS_STEP:
6082                 res = tpacpi_brightness_set_ucmsstep(value);
6083                 break;
6084         default:
6085                 res = -ENXIO;
6086         }
6087
6088         mutex_unlock(&brightness_mutex);
6089         return res;
6090 }
6091
6092 /* sysfs backlight class ----------------------------------------------- */
6093
6094 static int brightness_update_status(struct backlight_device *bd)
6095 {
6096         unsigned int level =
6097                 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6098                  bd->props.power == FB_BLANK_UNBLANK) ?
6099                                 bd->props.brightness : 0;
6100
6101         dbg_printk(TPACPI_DBG_BRGHT,
6102                         "backlight: attempt to set level to %d\n",
6103                         level);
6104
6105         /* it is the backlight class's job (caller) to handle
6106          * EINTR and other errors properly */
6107         return brightness_set(level);
6108 }
6109
6110 static int brightness_get(struct backlight_device *bd)
6111 {
6112         int status, res;
6113
6114         res = mutex_lock_killable(&brightness_mutex);
6115         if (res < 0)
6116                 return 0;
6117
6118         res = tpacpi_brightness_get_raw(&status);
6119
6120         mutex_unlock(&brightness_mutex);
6121
6122         if (res < 0)
6123                 return 0;
6124
6125         return status & TP_EC_BACKLIGHT_LVLMSK;
6126 }
6127
6128 static void tpacpi_brightness_notify_change(void)
6129 {
6130         backlight_force_update(ibm_backlight_device,
6131                                BACKLIGHT_UPDATE_HOTKEY);
6132 }
6133
6134 static struct backlight_ops ibm_backlight_data = {
6135         .get_brightness = brightness_get,
6136         .update_status  = brightness_update_status,
6137 };
6138
6139 /* --------------------------------------------------------------------- */
6140
6141 /*
6142  * These are only useful for models that have only one possibility
6143  * of GPU.  If the BIOS model handles both ATI and Intel, don't use
6144  * these quirks.
6145  */
6146 #define TPACPI_BRGHT_Q_NOEC     0x0001  /* Must NOT use EC HBRV */
6147 #define TPACPI_BRGHT_Q_EC       0x0002  /* Should or must use EC HBRV */
6148 #define TPACPI_BRGHT_Q_ASK      0x8000  /* Ask for user report */
6149
6150 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6151         /* Models with ATI GPUs known to require ECNVRAM mode */
6152         TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC),      /* T43/p ATI */
6153
6154         /* Models with ATI GPUs that can use ECNVRAM */
6155         TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC),      /* R50,51 T40-42 */
6156         TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6157         TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC),      /* R52 */
6158         TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6159
6160         /* Models with Intel Extreme Graphics 2 */
6161         TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC),    /* X40 */
6162         TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6163         TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6164
6165         /* Models with Intel GMA900 */
6166         TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC),    /* T43, R52 */
6167         TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC),    /* X41 */
6168         TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC),    /* X41 Tablet */
6169 };
6170
6171 static int __init brightness_init(struct ibm_init_struct *iibm)
6172 {
6173         int b;
6174         unsigned long quirks;
6175
6176         vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6177
6178         mutex_init(&brightness_mutex);
6179
6180         quirks = tpacpi_check_quirks(brightness_quirk_table,
6181                                 ARRAY_SIZE(brightness_quirk_table));
6182
6183         /*
6184          * We always attempt to detect acpi support, so as to switch
6185          * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6186          * going to publish a backlight interface
6187          */
6188         b = tpacpi_check_std_acpi_brightness_support();
6189         if (b > 0) {
6190
6191                 if (acpi_video_backlight_support()) {
6192                         if (brightness_enable > 1) {
6193                                 printk(TPACPI_NOTICE
6194                                        "Standard ACPI backlight interface "
6195                                        "available, not loading native one.\n");
6196                                 return 1;
6197                         } else if (brightness_enable == 1) {
6198                                 printk(TPACPI_NOTICE
6199                                        "Backlight control force enabled, even if standard "
6200                                        "ACPI backlight interface is available\n");
6201                         }
6202                 } else {
6203                         if (brightness_enable > 1) {
6204                                 printk(TPACPI_NOTICE
6205                                        "Standard ACPI backlight interface not "
6206                                        "available, thinkpad_acpi native "
6207                                        "brightness control enabled\n");
6208                         }
6209                 }
6210         }
6211
6212         if (!brightness_enable) {
6213                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6214                            "brightness support disabled by "
6215                            "module parameter\n");
6216                 return 1;
6217         }
6218
6219         if (b > 16) {
6220                 printk(TPACPI_ERR
6221                        "Unsupported brightness interface, "
6222                        "please contact %s\n", TPACPI_MAIL);
6223                 return 1;
6224         }
6225         if (b == 16)
6226                 tp_features.bright_16levels = 1;
6227
6228         /*
6229          * Check for module parameter bogosity, note that we
6230          * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6231          * able to detect "unspecified"
6232          */
6233         if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6234                 return -EINVAL;
6235
6236         /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6237         if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6238             brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6239                 if (quirks & TPACPI_BRGHT_Q_EC)
6240                         brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6241                 else
6242                         brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6243
6244                 dbg_printk(TPACPI_DBG_BRGHT,
6245                            "driver auto-selected brightness_mode=%d\n",
6246                            brightness_mode);
6247         }
6248
6249         /* Safety */
6250         if (thinkpad_id.vendor != PCI_VENDOR_ID_IBM &&
6251             (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6252              brightness_mode == TPACPI_BRGHT_MODE_EC))
6253                 return -EINVAL;
6254
6255         if (tpacpi_brightness_get_raw(&b) < 0)
6256                 return 1;
6257
6258         if (tp_features.bright_16levels)
6259                 printk(TPACPI_INFO
6260                        "detected a 16-level brightness capable ThinkPad\n");
6261
6262         ibm_backlight_device = backlight_device_register(
6263                                         TPACPI_BACKLIGHT_DEV_NAME, NULL, NULL,
6264                                         &ibm_backlight_data);
6265         if (IS_ERR(ibm_backlight_device)) {
6266                 int rc = PTR_ERR(ibm_backlight_device);
6267                 ibm_backlight_device = NULL;
6268                 printk(TPACPI_ERR "Could not register backlight device\n");
6269                 return rc;
6270         }
6271         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6272                         "brightness is supported\n");
6273
6274         if (quirks & TPACPI_BRGHT_Q_ASK) {
6275                 printk(TPACPI_NOTICE
6276                         "brightness: will use unverified default: "
6277                         "brightness_mode=%d\n", brightness_mode);
6278                 printk(TPACPI_NOTICE
6279                         "brightness: please report to %s whether it works well "
6280                         "or not on your ThinkPad\n", TPACPI_MAIL);
6281         }
6282
6283         ibm_backlight_device->props.max_brightness =
6284                                 (tp_features.bright_16levels)? 15 : 7;
6285         ibm_backlight_device->props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6286         backlight_update_status(ibm_backlight_device);
6287
6288         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6289                         "brightness: registering brightness hotkeys "
6290                         "as change notification\n");
6291         tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6292                                 | TP_ACPI_HKEY_BRGHTUP_MASK
6293                                 | TP_ACPI_HKEY_BRGHTDWN_MASK);;
6294         return 0;
6295 }
6296
6297 static void brightness_suspend(pm_message_t state)
6298 {
6299         tpacpi_brightness_checkpoint_nvram();
6300 }
6301
6302 static void brightness_shutdown(void)
6303 {
6304         tpacpi_brightness_checkpoint_nvram();
6305 }
6306
6307 static void brightness_exit(void)
6308 {
6309         if (ibm_backlight_device) {
6310                 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6311                             "calling backlight_device_unregister()\n");
6312                 backlight_device_unregister(ibm_backlight_device);
6313         }
6314
6315         tpacpi_brightness_checkpoint_nvram();
6316 }
6317
6318 static int brightness_read(struct seq_file *m)
6319 {
6320         int level;
6321
6322         level = brightness_get(NULL);
6323         if (level < 0) {
6324                 seq_printf(m, "level:\t\tunreadable\n");
6325         } else {
6326                 seq_printf(m, "level:\t\t%d\n", level);
6327                 seq_printf(m, "commands:\tup, down\n");
6328                 seq_printf(m, "commands:\tlevel <level>"
6329                                " (<level> is 0-%d)\n",
6330                                (tp_features.bright_16levels) ? 15 : 7);
6331         }
6332
6333         return 0;
6334 }
6335
6336 static int brightness_write(char *buf)
6337 {
6338         int level;
6339         int rc;
6340         char *cmd;
6341         int max_level = (tp_features.bright_16levels) ? 15 : 7;
6342
6343         level = brightness_get(NULL);
6344         if (level < 0)
6345                 return level;
6346
6347         while ((cmd = next_cmd(&buf))) {
6348                 if (strlencmp(cmd, "up") == 0) {
6349                         if (level < max_level)
6350                                 level++;
6351                 } else if (strlencmp(cmd, "down") == 0) {
6352                         if (level > 0)
6353                                 level--;
6354                 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6355                            level >= 0 && level <= max_level) {
6356                         /* new level set */
6357                 } else
6358                         return -EINVAL;
6359         }
6360
6361         tpacpi_disclose_usertask("procfs brightness",
6362                         "set level to %d\n", level);
6363
6364         /*
6365          * Now we know what the final level should be, so we try to set it.
6366          * Doing it this way makes the syscall restartable in case of EINTR
6367          */
6368         rc = brightness_set(level);
6369         if (!rc && ibm_backlight_device)
6370                 backlight_force_update(ibm_backlight_device,
6371                                         BACKLIGHT_UPDATE_SYSFS);
6372         return (rc == -EINTR)? -ERESTARTSYS : rc;
6373 }
6374
6375 static struct ibm_struct brightness_driver_data = {
6376         .name = "brightness",
6377         .read = brightness_read,
6378         .write = brightness_write,
6379         .exit = brightness_exit,
6380         .suspend = brightness_suspend,
6381         .shutdown = brightness_shutdown,
6382 };
6383
6384 /*************************************************************************
6385  * Volume subdriver
6386  */
6387
6388 /*
6389  * IBM ThinkPads have a simple volume controller with MUTE gating.
6390  * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6391  *
6392  * Since the *61 series (and probably also the later *60 series), Lenovo
6393  * ThinkPads only implement the MUTE gate.
6394  *
6395  * EC register 0x30
6396  *   Bit 6: MUTE (1 mutes sound)
6397  *   Bit 3-0: Volume
6398  *   Other bits should be zero as far as we know.
6399  *
6400  * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6401  * bits 3-0 (volume).  Other bits in NVRAM may have other functions,
6402  * such as bit 7 which is used to detect repeated presses of MUTE,
6403  * and we leave them unchanged.
6404  */
6405
6406 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6407
6408 #define TPACPI_ALSA_DRVNAME  "ThinkPad EC"
6409 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6410 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6411
6412 static int alsa_index = ~((1 << (SNDRV_CARDS - 3)) - 1); /* last three slots */
6413 static char *alsa_id = "ThinkPadEC";
6414 static int alsa_enable = SNDRV_DEFAULT_ENABLE1;
6415
6416 struct tpacpi_alsa_data {
6417         struct snd_card *card;
6418         struct snd_ctl_elem_id *ctl_mute_id;
6419         struct snd_ctl_elem_id *ctl_vol_id;
6420 };
6421
6422 static struct snd_card *alsa_card;
6423
6424 enum {
6425         TP_EC_AUDIO = 0x30,
6426
6427         /* TP_EC_AUDIO bits */
6428         TP_EC_AUDIO_MUTESW = 6,
6429
6430         /* TP_EC_AUDIO bitmasks */
6431         TP_EC_AUDIO_LVL_MSK = 0x0F,
6432         TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6433
6434         /* Maximum volume */
6435         TP_EC_VOLUME_MAX = 14,
6436 };
6437
6438 enum tpacpi_volume_access_mode {
6439         TPACPI_VOL_MODE_AUTO = 0,       /* Not implemented yet */
6440         TPACPI_VOL_MODE_EC,             /* Pure EC control */
6441         TPACPI_VOL_MODE_UCMS_STEP,      /* UCMS step-based control: N/A */
6442         TPACPI_VOL_MODE_ECNVRAM,        /* EC control w/ NVRAM store */
6443         TPACPI_VOL_MODE_MAX
6444 };
6445
6446 enum tpacpi_volume_capabilities {
6447         TPACPI_VOL_CAP_AUTO = 0,        /* Use white/blacklist */
6448         TPACPI_VOL_CAP_VOLMUTE,         /* Output vol and mute */
6449         TPACPI_VOL_CAP_MUTEONLY,        /* Output mute only */
6450         TPACPI_VOL_CAP_MAX
6451 };
6452
6453 static enum tpacpi_volume_access_mode volume_mode =
6454         TPACPI_VOL_MODE_MAX;
6455
6456 static enum tpacpi_volume_capabilities volume_capabilities;
6457 static int volume_control_allowed;
6458
6459 /*
6460  * Used to syncronize writers to TP_EC_AUDIO and
6461  * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6462  */
6463 static struct mutex volume_mutex;
6464
6465 static void tpacpi_volume_checkpoint_nvram(void)
6466 {
6467         u8 lec = 0;
6468         u8 b_nvram;
6469         u8 ec_mask;
6470
6471         if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6472                 return;
6473         if (!volume_control_allowed)
6474                 return;
6475
6476         vdbg_printk(TPACPI_DBG_MIXER,
6477                 "trying to checkpoint mixer state to NVRAM...\n");
6478
6479         if (tp_features.mixer_no_level_control)
6480                 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6481         else
6482                 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6483
6484         if (mutex_lock_killable(&volume_mutex) < 0)
6485                 return;
6486
6487         if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6488                 goto unlock;
6489         lec &= ec_mask;
6490         b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6491
6492         if (lec != (b_nvram & ec_mask)) {
6493                 /* NVRAM needs update */
6494                 b_nvram &= ~ec_mask;
6495                 b_nvram |= lec;
6496                 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6497                 dbg_printk(TPACPI_DBG_MIXER,
6498                            "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6499                            (unsigned int) lec, (unsigned int) b_nvram);
6500         } else {
6501                 vdbg_printk(TPACPI_DBG_MIXER,
6502                            "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6503                            (unsigned int) lec, (unsigned int) b_nvram);
6504         }
6505
6506 unlock:
6507         mutex_unlock(&volume_mutex);
6508 }
6509
6510 static int volume_get_status_ec(u8 *status)
6511 {
6512         u8 s;
6513
6514         if (!acpi_ec_read(TP_EC_AUDIO, &s))
6515                 return -EIO;
6516
6517         *status = s;
6518
6519         dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6520
6521         return 0;
6522 }
6523
6524 static int volume_get_status(u8 *status)
6525 {
6526         return volume_get_status_ec(status);
6527 }
6528
6529 static int volume_set_status_ec(const u8 status)
6530 {
6531         if (!acpi_ec_write(TP_EC_AUDIO, status))
6532                 return -EIO;
6533
6534         dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6535
6536         return 0;
6537 }
6538
6539 static int volume_set_status(const u8 status)
6540 {
6541         return volume_set_status_ec(status);
6542 }
6543
6544 /* returns < 0 on error, 0 on no change, 1 on change */
6545 static int __volume_set_mute_ec(const bool mute)
6546 {
6547         int rc;
6548         u8 s, n;
6549
6550         if (mutex_lock_killable(&volume_mutex) < 0)
6551                 return -EINTR;
6552
6553         rc = volume_get_status_ec(&s);
6554         if (rc)
6555                 goto unlock;
6556
6557         n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6558                      s & ~TP_EC_AUDIO_MUTESW_MSK;
6559
6560         if (n != s) {
6561                 rc = volume_set_status_ec(n);
6562                 if (!rc)
6563                         rc = 1;
6564         }
6565
6566 unlock:
6567         mutex_unlock(&volume_mutex);
6568         return rc;
6569 }
6570
6571 static int volume_alsa_set_mute(const bool mute)
6572 {
6573         dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6574                    (mute) ? "" : "un");
6575         return __volume_set_mute_ec(mute);
6576 }
6577
6578 static int volume_set_mute(const bool mute)
6579 {
6580         int rc;
6581
6582         dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6583                    (mute) ? "" : "un");
6584
6585         rc = __volume_set_mute_ec(mute);
6586         return (rc < 0) ? rc : 0;
6587 }
6588
6589 /* returns < 0 on error, 0 on no change, 1 on change */
6590 static int __volume_set_volume_ec(const u8 vol)
6591 {
6592         int rc;
6593         u8 s, n;
6594
6595         if (vol > TP_EC_VOLUME_MAX)
6596                 return -EINVAL;
6597
6598         if (mutex_lock_killable(&volume_mutex) < 0)
6599                 return -EINTR;
6600
6601         rc = volume_get_status_ec(&s);
6602         if (rc)
6603                 goto unlock;
6604
6605         n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6606
6607         if (n != s) {
6608                 rc = volume_set_status_ec(n);
6609                 if (!rc)
6610                         rc = 1;
6611         }
6612
6613 unlock:
6614         mutex_unlock(&volume_mutex);
6615         return rc;
6616 }
6617
6618 static int volume_alsa_set_volume(const u8 vol)
6619 {
6620         dbg_printk(TPACPI_DBG_MIXER,
6621                    "ALSA: trying to set volume level to %hu\n", vol);
6622         return __volume_set_volume_ec(vol);
6623 }
6624
6625 static void volume_alsa_notify_change(void)
6626 {
6627         struct tpacpi_alsa_data *d;
6628
6629         if (alsa_card && alsa_card->private_data) {
6630                 d = alsa_card->private_data;
6631                 if (d->ctl_mute_id)
6632                         snd_ctl_notify(alsa_card,
6633                                         SNDRV_CTL_EVENT_MASK_VALUE,
6634                                         d->ctl_mute_id);
6635                 if (d->ctl_vol_id)
6636                         snd_ctl_notify(alsa_card,
6637                                         SNDRV_CTL_EVENT_MASK_VALUE,
6638                                         d->ctl_vol_id);
6639         }
6640 }
6641
6642 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6643                                 struct snd_ctl_elem_info *uinfo)
6644 {
6645         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6646         uinfo->count = 1;
6647         uinfo->value.integer.min = 0;
6648         uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6649         return 0;
6650 }
6651
6652 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6653                                 struct snd_ctl_elem_value *ucontrol)
6654 {
6655         u8 s;
6656         int rc;
6657
6658         rc = volume_get_status(&s);
6659         if (rc < 0)
6660                 return rc;
6661
6662         ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6663         return 0;
6664 }
6665
6666 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6667                                 struct snd_ctl_elem_value *ucontrol)
6668 {
6669         return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6670 }
6671
6672 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
6673
6674 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6675                                 struct snd_ctl_elem_value *ucontrol)
6676 {
6677         u8 s;
6678         int rc;
6679
6680         rc = volume_get_status(&s);
6681         if (rc < 0)
6682                 return rc;
6683
6684         ucontrol->value.integer.value[0] =
6685                                 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6686         return 0;
6687 }
6688
6689 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6690                                 struct snd_ctl_elem_value *ucontrol)
6691 {
6692         return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6693 }
6694
6695 static struct snd_kcontrol_new volume_alsa_control_vol __devinitdata = {
6696         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6697         .name = "Console Playback Volume",
6698         .index = 0,
6699         .access = SNDRV_CTL_ELEM_ACCESS_READ,
6700         .info = volume_alsa_vol_info,
6701         .get = volume_alsa_vol_get,
6702 };
6703
6704 static struct snd_kcontrol_new volume_alsa_control_mute __devinitdata = {
6705         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6706         .name = "Console Playback Switch",
6707         .index = 0,
6708         .access = SNDRV_CTL_ELEM_ACCESS_READ,
6709         .info = volume_alsa_mute_info,
6710         .get = volume_alsa_mute_get,
6711 };
6712
6713 static void volume_suspend(pm_message_t state)
6714 {
6715         tpacpi_volume_checkpoint_nvram();
6716 }
6717
6718 static void volume_resume(void)
6719 {
6720         volume_alsa_notify_change();
6721 }
6722
6723 static void volume_shutdown(void)
6724 {
6725         tpacpi_volume_checkpoint_nvram();
6726 }
6727
6728 static void volume_exit(void)
6729 {
6730         if (alsa_card) {
6731                 snd_card_free(alsa_card);
6732                 alsa_card = NULL;
6733         }
6734
6735         tpacpi_volume_checkpoint_nvram();
6736 }
6737
6738 static int __init volume_create_alsa_mixer(void)
6739 {
6740         struct snd_card *card;
6741         struct tpacpi_alsa_data *data;
6742         struct snd_kcontrol *ctl_vol;
6743         struct snd_kcontrol *ctl_mute;
6744         int rc;
6745
6746         rc = snd_card_create(alsa_index, alsa_id, THIS_MODULE,
6747                             sizeof(struct tpacpi_alsa_data), &card);
6748         if (rc < 0 || !card) {
6749                 printk(TPACPI_ERR
6750                         "Failed to create ALSA card structures: %d\n", rc);
6751                 return 1;
6752         }
6753
6754         BUG_ON(!card->private_data);
6755         data = card->private_data;
6756         data->card = card;
6757
6758         strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6759                 sizeof(card->driver));
6760         strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6761                 sizeof(card->shortname));
6762         snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6763                  (thinkpad_id.ec_version_str) ?
6764                         thinkpad_id.ec_version_str : "(unknown)");
6765         snprintf(card->longname, sizeof(card->longname),
6766                  "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6767                  (thinkpad_id.ec_version_str) ?
6768                         thinkpad_id.ec_version_str : "unknown");
6769
6770         if (volume_control_allowed) {
6771                 volume_alsa_control_vol.put = volume_alsa_vol_put;
6772                 volume_alsa_control_vol.access =
6773                                 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6774
6775                 volume_alsa_control_mute.put = volume_alsa_mute_put;
6776                 volume_alsa_control_mute.access =
6777                                 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6778         }
6779
6780         if (!tp_features.mixer_no_level_control) {
6781                 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6782                 rc = snd_ctl_add(card, ctl_vol);
6783                 if (rc < 0) {
6784                         printk(TPACPI_ERR
6785                                 "Failed to create ALSA volume control: %d\n",
6786                                 rc);
6787                         goto err_exit;
6788                 }
6789                 data->ctl_vol_id = &ctl_vol->id;
6790         }
6791
6792         ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6793         rc = snd_ctl_add(card, ctl_mute);
6794         if (rc < 0) {
6795                 printk(TPACPI_ERR "Failed to create ALSA mute control: %d\n",
6796                         rc);
6797                 goto err_exit;
6798         }
6799         data->ctl_mute_id = &ctl_mute->id;
6800
6801         snd_card_set_dev(card, &tpacpi_pdev->dev);
6802         rc = snd_card_register(card);
6803         if (rc < 0) {
6804                 printk(TPACPI_ERR "Failed to register ALSA card: %d\n", rc);
6805                 goto err_exit;
6806         }
6807
6808         alsa_card = card;
6809         return 0;
6810
6811 err_exit:
6812         snd_card_free(card);
6813         return 1;
6814 }
6815
6816 #define TPACPI_VOL_Q_MUTEONLY   0x0001  /* Mute-only control available */
6817 #define TPACPI_VOL_Q_LEVEL      0x0002  /* Volume control available */
6818
6819 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6820         /* Whitelist volume level on all IBM by default */
6821         { .vendor = PCI_VENDOR_ID_IBM,
6822           .bios   = TPACPI_MATCH_ANY,
6823           .ec     = TPACPI_MATCH_ANY,
6824           .quirks = TPACPI_VOL_Q_LEVEL },
6825
6826         /* Lenovo models with volume control (needs confirmation) */
6827         TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6828         TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6829         TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6830         TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6831         TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6832         TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6833         TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6834
6835         /* Whitelist mute-only on all Lenovo by default */
6836         { .vendor = PCI_VENDOR_ID_LENOVO,
6837           .bios   = TPACPI_MATCH_ANY,
6838           .ec     = TPACPI_MATCH_ANY,
6839           .quirks = TPACPI_VOL_Q_MUTEONLY }
6840 };
6841
6842 static int __init volume_init(struct ibm_init_struct *iibm)
6843 {
6844         unsigned long quirks;
6845         int rc;
6846
6847         vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
6848
6849         mutex_init(&volume_mutex);
6850
6851         /*
6852          * Check for module parameter bogosity, note that we
6853          * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
6854          * able to detect "unspecified"
6855          */
6856         if (volume_mode > TPACPI_VOL_MODE_MAX)
6857                 return -EINVAL;
6858
6859         if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
6860                 printk(TPACPI_ERR
6861                         "UCMS step volume mode not implemented, "
6862                         "please contact %s\n", TPACPI_MAIL);
6863                 return 1;
6864         }
6865
6866         if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
6867                 return -EINVAL;
6868
6869         /*
6870          * The ALSA mixer is our primary interface.
6871          * When disabled, don't install the subdriver at all
6872          */
6873         if (!alsa_enable) {
6874                 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6875                             "ALSA mixer disabled by parameter, "
6876                             "not loading volume subdriver...\n");
6877                 return 1;
6878         }
6879
6880         quirks = tpacpi_check_quirks(volume_quirk_table,
6881                                      ARRAY_SIZE(volume_quirk_table));
6882
6883         switch (volume_capabilities) {
6884         case TPACPI_VOL_CAP_AUTO:
6885                 if (quirks & TPACPI_VOL_Q_MUTEONLY)
6886                         tp_features.mixer_no_level_control = 1;
6887                 else if (quirks & TPACPI_VOL_Q_LEVEL)
6888                         tp_features.mixer_no_level_control = 0;
6889                 else
6890                         return 1; /* no mixer */
6891                 break;
6892         case TPACPI_VOL_CAP_VOLMUTE:
6893                 tp_features.mixer_no_level_control = 0;
6894                 break;
6895         case TPACPI_VOL_CAP_MUTEONLY:
6896                 tp_features.mixer_no_level_control = 1;
6897                 break;
6898         default:
6899                 return 1;
6900         }
6901
6902         if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
6903                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6904                                 "using user-supplied volume_capabilities=%d\n",
6905                                 volume_capabilities);
6906
6907         if (volume_mode == TPACPI_VOL_MODE_AUTO ||
6908             volume_mode == TPACPI_VOL_MODE_MAX) {
6909                 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
6910
6911                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6912                                 "driver auto-selected volume_mode=%d\n",
6913                                 volume_mode);
6914         } else {
6915                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6916                                 "using user-supplied volume_mode=%d\n",
6917                                 volume_mode);
6918         }
6919
6920         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6921                         "mute is supported, volume control is %s\n",
6922                         str_supported(!tp_features.mixer_no_level_control));
6923
6924         rc = volume_create_alsa_mixer();
6925         if (rc) {
6926                 printk(TPACPI_ERR
6927                         "Could not create the ALSA mixer interface\n");
6928                 return rc;
6929         }
6930
6931         printk(TPACPI_INFO
6932                 "Console audio control enabled, mode: %s\n",
6933                 (volume_control_allowed) ?
6934                         "override (read/write)" :
6935                         "monitor (read only)");
6936
6937         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6938                 "registering volume hotkeys as change notification\n");
6939         tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6940                         | TP_ACPI_HKEY_VOLUP_MASK
6941                         | TP_ACPI_HKEY_VOLDWN_MASK
6942                         | TP_ACPI_HKEY_MUTE_MASK);
6943
6944         return 0;
6945 }
6946
6947 static int volume_read(struct seq_file *m)
6948 {
6949         u8 status;
6950
6951         if (volume_get_status(&status) < 0) {
6952                 seq_printf(m, "level:\t\tunreadable\n");
6953         } else {
6954                 if (tp_features.mixer_no_level_control)
6955                         seq_printf(m, "level:\t\tunsupported\n");
6956                 else
6957                         seq_printf(m, "level:\t\t%d\n",
6958                                         status & TP_EC_AUDIO_LVL_MSK);
6959
6960                 seq_printf(m, "mute:\t\t%s\n",
6961                                 onoff(status, TP_EC_AUDIO_MUTESW));
6962
6963                 if (volume_control_allowed) {
6964                         seq_printf(m, "commands:\tunmute, mute\n");
6965                         if (!tp_features.mixer_no_level_control) {
6966                                 seq_printf(m,
6967                                                "commands:\tup, down\n");
6968                                 seq_printf(m,
6969                                                "commands:\tlevel <level>"
6970                                                " (<level> is 0-%d)\n",
6971                                                TP_EC_VOLUME_MAX);
6972                         }
6973                 }
6974         }
6975
6976         return 0;
6977 }
6978
6979 static int volume_write(char *buf)
6980 {
6981         u8 s;
6982         u8 new_level, new_mute;
6983         int l;
6984         char *cmd;
6985         int rc;
6986
6987         /*
6988          * We do allow volume control at driver startup, so that the
6989          * user can set initial state through the volume=... parameter hack.
6990          */
6991         if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
6992                 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
6993                         tp_warned.volume_ctrl_forbidden = 1;
6994                         printk(TPACPI_NOTICE
6995                                 "Console audio control in monitor mode, "
6996                                 "changes are not allowed.\n");
6997                         printk(TPACPI_NOTICE
6998                                 "Use the volume_control=1 module parameter "
6999                                 "to enable volume control\n");
7000                 }
7001                 return -EPERM;
7002         }
7003
7004         rc = volume_get_status(&s);
7005         if (rc < 0)
7006                 return rc;
7007
7008         new_level = s & TP_EC_AUDIO_LVL_MSK;
7009         new_mute  = s & TP_EC_AUDIO_MUTESW_MSK;
7010
7011         while ((cmd = next_cmd(&buf))) {
7012                 if (!tp_features.mixer_no_level_control) {
7013                         if (strlencmp(cmd, "up") == 0) {
7014                                 if (new_mute)
7015                                         new_mute = 0;
7016                                 else if (new_level < TP_EC_VOLUME_MAX)
7017                                         new_level++;
7018                                 continue;
7019                         } else if (strlencmp(cmd, "down") == 0) {
7020                                 if (new_mute)
7021                                         new_mute = 0;
7022                                 else if (new_level > 0)
7023                                         new_level--;
7024                                 continue;
7025                         } else if (sscanf(cmd, "level %u", &l) == 1 &&
7026                                    l >= 0 && l <= TP_EC_VOLUME_MAX) {
7027                                         new_level = l;
7028                                 continue;
7029                         }
7030                 }
7031                 if (strlencmp(cmd, "mute") == 0)
7032                         new_mute = TP_EC_AUDIO_MUTESW_MSK;
7033                 else if (strlencmp(cmd, "unmute") == 0)
7034                         new_mute = 0;
7035                 else
7036                         return -EINVAL;
7037         }
7038
7039         if (tp_features.mixer_no_level_control) {
7040                 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7041                                         new_mute ? "" : "un");
7042                 rc = volume_set_mute(!!new_mute);
7043         } else {
7044                 tpacpi_disclose_usertask("procfs volume",
7045                                         "%smute and set level to %d\n",
7046                                         new_mute ? "" : "un", new_level);
7047                 rc = volume_set_status(new_mute | new_level);
7048         }
7049         volume_alsa_notify_change();
7050
7051         return (rc == -EINTR) ? -ERESTARTSYS : rc;
7052 }
7053
7054 static struct ibm_struct volume_driver_data = {
7055         .name = "volume",
7056         .read = volume_read,
7057         .write = volume_write,
7058         .exit = volume_exit,
7059         .suspend = volume_suspend,
7060         .resume = volume_resume,
7061         .shutdown = volume_shutdown,
7062 };
7063
7064 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7065
7066 #define alsa_card NULL
7067
7068 static void inline volume_alsa_notify_change(void)
7069 {
7070 }
7071
7072 static int __init volume_init(struct ibm_init_struct *iibm)
7073 {
7074         printk(TPACPI_INFO
7075                 "volume: disabled as there is no ALSA support in this kernel\n");
7076
7077         return 1;
7078 }
7079
7080 static struct ibm_struct volume_driver_data = {
7081         .name = "volume",
7082 };
7083
7084 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7085
7086 /*************************************************************************
7087  * Fan subdriver
7088  */
7089
7090 /*
7091  * FAN ACCESS MODES
7092  *
7093  * TPACPI_FAN_RD_ACPI_GFAN:
7094  *      ACPI GFAN method: returns fan level
7095  *
7096  *      see TPACPI_FAN_WR_ACPI_SFAN
7097  *      EC 0x2f (HFSP) not available if GFAN exists
7098  *
7099  * TPACPI_FAN_WR_ACPI_SFAN:
7100  *      ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7101  *
7102  *      EC 0x2f (HFSP) might be available *for reading*, but do not use
7103  *      it for writing.
7104  *
7105  * TPACPI_FAN_WR_TPEC:
7106  *      ThinkPad EC register 0x2f (HFSP): fan control loop mode
7107  *      Supported on almost all ThinkPads
7108  *
7109  *      Fan speed changes of any sort (including those caused by the
7110  *      disengaged mode) are usually done slowly by the firmware as the
7111  *      maximum amount of fan duty cycle change per second seems to be
7112  *      limited.
7113  *
7114  *      Reading is not available if GFAN exists.
7115  *      Writing is not available if SFAN exists.
7116  *
7117  *      Bits
7118  *       7      automatic mode engaged;
7119  *              (default operation mode of the ThinkPad)
7120  *              fan level is ignored in this mode.
7121  *       6      full speed mode (takes precedence over bit 7);
7122  *              not available on all thinkpads.  May disable
7123  *              the tachometer while the fan controller ramps up
7124  *              the speed (which can take up to a few *minutes*).
7125  *              Speeds up fan to 100% duty-cycle, which is far above
7126  *              the standard RPM levels.  It is not impossible that
7127  *              it could cause hardware damage.
7128  *      5-3     unused in some models.  Extra bits for fan level
7129  *              in others, but still useless as all values above
7130  *              7 map to the same speed as level 7 in these models.
7131  *      2-0     fan level (0..7 usually)
7132  *                      0x00 = stop
7133  *                      0x07 = max (set when temperatures critical)
7134  *              Some ThinkPads may have other levels, see
7135  *              TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7136  *
7137  *      FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7138  *      boot. Apparently the EC does not intialize it, so unless ACPI DSDT
7139  *      does so, its initial value is meaningless (0x07).
7140  *
7141  *      For firmware bugs, refer to:
7142  *      http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7143  *
7144  *      ----
7145  *
7146  *      ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7147  *      Main fan tachometer reading (in RPM)
7148  *
7149  *      This register is present on all ThinkPads with a new-style EC, and
7150  *      it is known not to be present on the A21m/e, and T22, as there is
7151  *      something else in offset 0x84 according to the ACPI DSDT.  Other
7152  *      ThinkPads from this same time period (and earlier) probably lack the
7153  *      tachometer as well.
7154  *
7155  *      Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7156  *      was never fixed by IBM to report the EC firmware version string
7157  *      probably support the tachometer (like the early X models), so
7158  *      detecting it is quite hard.  We need more data to know for sure.
7159  *
7160  *      FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7161  *      might result.
7162  *
7163  *      FIRMWARE BUG: may go stale while the EC is switching to full speed
7164  *      mode.
7165  *
7166  *      For firmware bugs, refer to:
7167  *      http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7168  *
7169  *      ----
7170  *
7171  *      ThinkPad EC register 0x31 bit 0 (only on select models)
7172  *
7173  *      When bit 0 of EC register 0x31 is zero, the tachometer registers
7174  *      show the speed of the main fan.  When bit 0 of EC register 0x31
7175  *      is one, the tachometer registers show the speed of the auxiliary
7176  *      fan.
7177  *
7178  *      Fan control seems to affect both fans, regardless of the state
7179  *      of this bit.
7180  *
7181  *      So far, only the firmware for the X60/X61 non-tablet versions
7182  *      seem to support this (firmware TP-7M).
7183  *
7184  * TPACPI_FAN_WR_ACPI_FANS:
7185  *      ThinkPad X31, X40, X41.  Not available in the X60.
7186  *
7187  *      FANS ACPI handle: takes three arguments: low speed, medium speed,
7188  *      high speed.  ACPI DSDT seems to map these three speeds to levels
7189  *      as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7190  *      (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7191  *
7192  *      The speeds are stored on handles
7193  *      (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7194  *
7195  *      There are three default speed sets, accessible as handles:
7196  *      FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7197  *
7198  *      ACPI DSDT switches which set is in use depending on various
7199  *      factors.
7200  *
7201  *      TPACPI_FAN_WR_TPEC is also available and should be used to
7202  *      command the fan.  The X31/X40/X41 seems to have 8 fan levels,
7203  *      but the ACPI tables just mention level 7.
7204  */
7205
7206 enum {                                  /* Fan control constants */
7207         fan_status_offset = 0x2f,       /* EC register 0x2f */
7208         fan_rpm_offset = 0x84,          /* EC register 0x84: LSB, 0x85 MSB (RPM)
7209                                          * 0x84 must be read before 0x85 */
7210         fan_select_offset = 0x31,       /* EC register 0x31 (Firmware 7M)
7211                                            bit 0 selects which fan is active */
7212
7213         TP_EC_FAN_FULLSPEED = 0x40,     /* EC fan mode: full speed */
7214         TP_EC_FAN_AUTO      = 0x80,     /* EC fan mode: auto fan control */
7215
7216         TPACPI_FAN_LAST_LEVEL = 0x100,  /* Use cached last-seen fan level */
7217 };
7218
7219 enum fan_status_access_mode {
7220         TPACPI_FAN_NONE = 0,            /* No fan status or control */
7221         TPACPI_FAN_RD_ACPI_GFAN,        /* Use ACPI GFAN */
7222         TPACPI_FAN_RD_TPEC,             /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7223 };
7224
7225 enum fan_control_access_mode {
7226         TPACPI_FAN_WR_NONE = 0,         /* No fan control */
7227         TPACPI_FAN_WR_ACPI_SFAN,        /* Use ACPI SFAN */
7228         TPACPI_FAN_WR_TPEC,             /* Use ACPI EC reg 0x2f */
7229         TPACPI_FAN_WR_ACPI_FANS,        /* Use ACPI FANS and EC reg 0x2f */
7230 };
7231
7232 enum fan_control_commands {
7233         TPACPI_FAN_CMD_SPEED    = 0x0001,       /* speed command */
7234         TPACPI_FAN_CMD_LEVEL    = 0x0002,       /* level command  */
7235         TPACPI_FAN_CMD_ENABLE   = 0x0004,       /* enable/disable cmd,
7236                                                  * and also watchdog cmd */
7237 };
7238
7239 static int fan_control_allowed;
7240
7241 static enum fan_status_access_mode fan_status_access_mode;
7242 static enum fan_control_access_mode fan_control_access_mode;
7243 static enum fan_control_commands fan_control_commands;
7244
7245 static u8 fan_control_initial_status;
7246 static u8 fan_control_desired_level;
7247 static u8 fan_control_resume_level;
7248 static int fan_watchdog_maxinterval;
7249
7250 static struct mutex fan_mutex;
7251
7252 static void fan_watchdog_fire(struct work_struct *ignored);
7253 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7254
7255 TPACPI_HANDLE(fans, ec, "FANS");        /* X31, X40, X41 */
7256 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7257            "\\FSPD",            /* 600e/x, 770e, 770x */
7258            );                   /* all others */
7259 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7260            "JFNS",              /* 770x-JL */
7261            );                   /* all others */
7262
7263 /*
7264  * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7265  * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7266  * be in auto mode (0x80).
7267  *
7268  * This is corrected by any write to HFSP either by the driver, or
7269  * by the firmware.
7270  *
7271  * We assume 0x07 really means auto mode while this quirk is active,
7272  * as this is far more likely than the ThinkPad being in level 7,
7273  * which is only used by the firmware during thermal emergencies.
7274  *
7275  * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7276  * TP-70 (T43, R52), which are known to be buggy.
7277  */
7278
7279 static void fan_quirk1_setup(void)
7280 {
7281         if (fan_control_initial_status == 0x07) {
7282                 printk(TPACPI_NOTICE
7283                        "fan_init: initial fan status is unknown, "
7284                        "assuming it is in auto mode\n");
7285                 tp_features.fan_ctrl_status_undef = 1;
7286         }
7287 }
7288
7289 static void fan_quirk1_handle(u8 *fan_status)
7290 {
7291         if (unlikely(tp_features.fan_ctrl_status_undef)) {
7292                 if (*fan_status != fan_control_initial_status) {
7293                         /* something changed the HFSP regisnter since
7294                          * driver init time, so it is not undefined
7295                          * anymore */
7296                         tp_features.fan_ctrl_status_undef = 0;
7297                 } else {
7298                         /* Return most likely status. In fact, it
7299                          * might be the only possible status */
7300                         *fan_status = TP_EC_FAN_AUTO;
7301                 }
7302         }
7303 }
7304
7305 /* Select main fan on X60/X61, NOOP on others */
7306 static bool fan_select_fan1(void)
7307 {
7308         if (tp_features.second_fan) {
7309                 u8 val;
7310
7311                 if (ec_read(fan_select_offset, &val) < 0)
7312                         return false;
7313                 val &= 0xFEU;
7314                 if (ec_write(fan_select_offset, val) < 0)
7315                         return false;
7316         }
7317         return true;
7318 }
7319
7320 /* Select secondary fan on X60/X61 */
7321 static bool fan_select_fan2(void)
7322 {
7323         u8 val;
7324
7325         if (!tp_features.second_fan)
7326                 return false;
7327
7328         if (ec_read(fan_select_offset, &val) < 0)
7329                 return false;
7330         val |= 0x01U;
7331         if (ec_write(fan_select_offset, val) < 0)
7332                 return false;
7333
7334         return true;
7335 }
7336
7337 /*
7338  * Call with fan_mutex held
7339  */
7340 static void fan_update_desired_level(u8 status)
7341 {
7342         if ((status &
7343              (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7344                 if (status > 7)
7345                         fan_control_desired_level = 7;
7346                 else
7347                         fan_control_desired_level = status;
7348         }
7349 }
7350
7351 static int fan_get_status(u8 *status)
7352 {
7353         u8 s;
7354
7355         /* TODO:
7356          * Add TPACPI_FAN_RD_ACPI_FANS ? */
7357
7358         switch (fan_status_access_mode) {
7359         case TPACPI_FAN_RD_ACPI_GFAN:
7360                 /* 570, 600e/x, 770e, 770x */
7361
7362                 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
7363                         return -EIO;
7364
7365                 if (likely(status))
7366                         *status = s & 0x07;
7367
7368                 break;
7369
7370         case TPACPI_FAN_RD_TPEC:
7371                 /* all except 570, 600e/x, 770e, 770x */
7372                 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7373                         return -EIO;
7374
7375                 if (likely(status)) {
7376                         *status = s;
7377                         fan_quirk1_handle(status);
7378                 }
7379
7380                 break;
7381
7382         default:
7383                 return -ENXIO;
7384         }
7385
7386         return 0;
7387 }
7388
7389 static int fan_get_status_safe(u8 *status)
7390 {
7391         int rc;
7392         u8 s;
7393
7394         if (mutex_lock_killable(&fan_mutex))
7395                 return -ERESTARTSYS;
7396         rc = fan_get_status(&s);
7397         if (!rc)
7398                 fan_update_desired_level(s);
7399         mutex_unlock(&fan_mutex);
7400
7401         if (status)
7402                 *status = s;
7403
7404         return rc;
7405 }
7406
7407 static int fan_get_speed(unsigned int *speed)
7408 {
7409         u8 hi, lo;
7410
7411         switch (fan_status_access_mode) {
7412         case TPACPI_FAN_RD_TPEC:
7413                 /* all except 570, 600e/x, 770e, 770x */
7414                 if (unlikely(!fan_select_fan1()))
7415                         return -EIO;
7416                 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7417                              !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7418                         return -EIO;
7419
7420                 if (likely(speed))
7421                         *speed = (hi << 8) | lo;
7422
7423                 break;
7424
7425         default:
7426                 return -ENXIO;
7427         }
7428
7429         return 0;
7430 }
7431
7432 static int fan2_get_speed(unsigned int *speed)
7433 {
7434         u8 hi, lo;
7435         bool rc;
7436
7437         switch (fan_status_access_mode) {
7438         case TPACPI_FAN_RD_TPEC:
7439                 /* all except 570, 600e/x, 770e, 770x */
7440                 if (unlikely(!fan_select_fan2()))
7441                         return -EIO;
7442                 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7443                              !acpi_ec_read(fan_rpm_offset + 1, &hi);
7444                 fan_select_fan1(); /* play it safe */
7445                 if (rc)
7446                         return -EIO;
7447
7448                 if (likely(speed))
7449                         *speed = (hi << 8) | lo;
7450
7451                 break;
7452
7453         default:
7454                 return -ENXIO;
7455         }
7456
7457         return 0;
7458 }
7459
7460 static int fan_set_level(int level)
7461 {
7462         if (!fan_control_allowed)
7463                 return -EPERM;
7464
7465         switch (fan_control_access_mode) {
7466         case TPACPI_FAN_WR_ACPI_SFAN:
7467                 if (level >= 0 && level <= 7) {
7468                         if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7469                                 return -EIO;
7470                 } else
7471                         return -EINVAL;
7472                 break;
7473
7474         case TPACPI_FAN_WR_ACPI_FANS:
7475         case TPACPI_FAN_WR_TPEC:
7476                 if (!(level & TP_EC_FAN_AUTO) &&
7477                     !(level & TP_EC_FAN_FULLSPEED) &&
7478                     ((level < 0) || (level > 7)))
7479                         return -EINVAL;
7480
7481                 /* safety net should the EC not support AUTO
7482                  * or FULLSPEED mode bits and just ignore them */
7483                 if (level & TP_EC_FAN_FULLSPEED)
7484                         level |= 7;     /* safety min speed 7 */
7485                 else if (level & TP_EC_FAN_AUTO)
7486                         level |= 4;     /* safety min speed 4 */
7487
7488                 if (!acpi_ec_write(fan_status_offset, level))
7489                         return -EIO;
7490                 else
7491                         tp_features.fan_ctrl_status_undef = 0;
7492                 break;
7493
7494         default:
7495                 return -ENXIO;
7496         }
7497
7498         vdbg_printk(TPACPI_DBG_FAN,
7499                 "fan control: set fan control register to 0x%02x\n", level);
7500         return 0;
7501 }
7502
7503 static int fan_set_level_safe(int level)
7504 {
7505         int rc;
7506
7507         if (!fan_control_allowed)
7508                 return -EPERM;
7509
7510         if (mutex_lock_killable(&fan_mutex))
7511                 return -ERESTARTSYS;
7512
7513         if (level == TPACPI_FAN_LAST_LEVEL)
7514                 level = fan_control_desired_level;
7515
7516         rc = fan_set_level(level);
7517         if (!rc)
7518                 fan_update_desired_level(level);
7519
7520         mutex_unlock(&fan_mutex);
7521         return rc;
7522 }
7523
7524 static int fan_set_enable(void)
7525 {
7526         u8 s;
7527         int rc;
7528
7529         if (!fan_control_allowed)
7530                 return -EPERM;
7531
7532         if (mutex_lock_killable(&fan_mutex))
7533                 return -ERESTARTSYS;
7534
7535         switch (fan_control_access_mode) {
7536         case TPACPI_FAN_WR_ACPI_FANS:
7537         case TPACPI_FAN_WR_TPEC:
7538                 rc = fan_get_status(&s);
7539                 if (rc < 0)
7540                         break;
7541
7542                 /* Don't go out of emergency fan mode */
7543                 if (s != 7) {
7544                         s &= 0x07;
7545                         s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7546                 }
7547
7548                 if (!acpi_ec_write(fan_status_offset, s))
7549                         rc = -EIO;
7550                 else {
7551                         tp_features.fan_ctrl_status_undef = 0;
7552                         rc = 0;
7553                 }
7554                 break;
7555
7556         case TPACPI_FAN_WR_ACPI_SFAN:
7557                 rc = fan_get_status(&s);
7558                 if (rc < 0)
7559                         break;
7560
7561                 s &= 0x07;
7562
7563                 /* Set fan to at least level 4 */
7564                 s |= 4;
7565
7566                 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7567                         rc = -EIO;
7568                 else
7569                         rc = 0;
7570                 break;
7571
7572         default:
7573                 rc = -ENXIO;
7574         }
7575
7576         mutex_unlock(&fan_mutex);
7577
7578         if (!rc)
7579                 vdbg_printk(TPACPI_DBG_FAN,
7580                         "fan control: set fan control register to 0x%02x\n",
7581                         s);
7582         return rc;
7583 }
7584
7585 static int fan_set_disable(void)
7586 {
7587         int rc;
7588
7589         if (!fan_control_allowed)
7590                 return -EPERM;
7591
7592         if (mutex_lock_killable(&fan_mutex))
7593                 return -ERESTARTSYS;
7594
7595         rc = 0;
7596         switch (fan_control_access_mode) {
7597         case TPACPI_FAN_WR_ACPI_FANS:
7598         case TPACPI_FAN_WR_TPEC:
7599                 if (!acpi_ec_write(fan_status_offset, 0x00))
7600                         rc = -EIO;
7601                 else {
7602                         fan_control_desired_level = 0;
7603                         tp_features.fan_ctrl_status_undef = 0;
7604                 }
7605                 break;
7606
7607         case TPACPI_FAN_WR_ACPI_SFAN:
7608                 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7609                         rc = -EIO;
7610                 else
7611                         fan_control_desired_level = 0;
7612                 break;
7613
7614         default:
7615                 rc = -ENXIO;
7616         }
7617
7618         if (!rc)
7619                 vdbg_printk(TPACPI_DBG_FAN,
7620                         "fan control: set fan control register to 0\n");
7621
7622         mutex_unlock(&fan_mutex);
7623         return rc;
7624 }
7625
7626 static int fan_set_speed(int speed)
7627 {
7628         int rc;
7629
7630         if (!fan_control_allowed)
7631                 return -EPERM;
7632
7633         if (mutex_lock_killable(&fan_mutex))
7634                 return -ERESTARTSYS;
7635
7636         rc = 0;
7637         switch (fan_control_access_mode) {
7638         case TPACPI_FAN_WR_ACPI_FANS:
7639                 if (speed >= 0 && speed <= 65535) {
7640                         if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7641                                         speed, speed, speed))
7642                                 rc = -EIO;
7643                 } else
7644                         rc = -EINVAL;
7645                 break;
7646
7647         default:
7648                 rc = -ENXIO;
7649         }
7650
7651         mutex_unlock(&fan_mutex);
7652         return rc;
7653 }
7654
7655 static void fan_watchdog_reset(void)
7656 {
7657         static int fan_watchdog_active;
7658
7659         if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7660                 return;
7661
7662         if (fan_watchdog_active)
7663                 cancel_delayed_work(&fan_watchdog_task);
7664
7665         if (fan_watchdog_maxinterval > 0 &&
7666             tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7667                 fan_watchdog_active = 1;
7668                 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7669                                 msecs_to_jiffies(fan_watchdog_maxinterval
7670                                                  * 1000))) {
7671                         printk(TPACPI_ERR
7672                                "failed to queue the fan watchdog, "
7673                                "watchdog will not trigger\n");
7674                 }
7675         } else
7676                 fan_watchdog_active = 0;
7677 }
7678
7679 static void fan_watchdog_fire(struct work_struct *ignored)
7680 {
7681         int rc;
7682
7683         if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7684                 return;
7685
7686         printk(TPACPI_NOTICE "fan watchdog: enabling fan\n");
7687         rc = fan_set_enable();
7688         if (rc < 0) {
7689                 printk(TPACPI_ERR "fan watchdog: error %d while enabling fan, "
7690                         "will try again later...\n", -rc);
7691                 /* reschedule for later */
7692                 fan_watchdog_reset();
7693         }
7694 }
7695
7696 /*
7697  * SYSFS fan layout: hwmon compatible (device)
7698  *
7699  * pwm*_enable:
7700  *      0: "disengaged" mode
7701  *      1: manual mode
7702  *      2: native EC "auto" mode (recommended, hardware default)
7703  *
7704  * pwm*: set speed in manual mode, ignored otherwise.
7705  *      0 is level 0; 255 is level 7. Intermediate points done with linear
7706  *      interpolation.
7707  *
7708  * fan*_input: tachometer reading, RPM
7709  *
7710  *
7711  * SYSFS fan layout: extensions
7712  *
7713  * fan_watchdog (driver):
7714  *      fan watchdog interval in seconds, 0 disables (default), max 120
7715  */
7716
7717 /* sysfs fan pwm1_enable ----------------------------------------------- */
7718 static ssize_t fan_pwm1_enable_show(struct device *dev,
7719                                     struct device_attribute *attr,
7720                                     char *buf)
7721 {
7722         int res, mode;
7723         u8 status;
7724
7725         res = fan_get_status_safe(&status);
7726         if (res)
7727                 return res;
7728
7729         if (status & TP_EC_FAN_FULLSPEED) {
7730                 mode = 0;
7731         } else if (status & TP_EC_FAN_AUTO) {
7732                 mode = 2;
7733         } else
7734                 mode = 1;
7735
7736         return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7737 }
7738
7739 static ssize_t fan_pwm1_enable_store(struct device *dev,
7740                                      struct device_attribute *attr,
7741                                      const char *buf, size_t count)
7742 {
7743         unsigned long t;
7744         int res, level;
7745
7746         if (parse_strtoul(buf, 2, &t))
7747                 return -EINVAL;
7748
7749         tpacpi_disclose_usertask("hwmon pwm1_enable",
7750                         "set fan mode to %lu\n", t);
7751
7752         switch (t) {
7753         case 0:
7754                 level = TP_EC_FAN_FULLSPEED;
7755                 break;
7756         case 1:
7757                 level = TPACPI_FAN_LAST_LEVEL;
7758                 break;
7759         case 2:
7760                 level = TP_EC_FAN_AUTO;
7761                 break;
7762         case 3:
7763                 /* reserved for software-controlled auto mode */
7764                 return -ENOSYS;
7765         default:
7766                 return -EINVAL;
7767         }
7768
7769         res = fan_set_level_safe(level);
7770         if (res == -ENXIO)
7771                 return -EINVAL;
7772         else if (res < 0)
7773                 return res;
7774
7775         fan_watchdog_reset();
7776
7777         return count;
7778 }
7779
7780 static struct device_attribute dev_attr_fan_pwm1_enable =
7781         __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7782                 fan_pwm1_enable_show, fan_pwm1_enable_store);
7783
7784 /* sysfs fan pwm1 ------------------------------------------------------ */
7785 static ssize_t fan_pwm1_show(struct device *dev,
7786                              struct device_attribute *attr,
7787                              char *buf)
7788 {
7789         int res;
7790         u8 status;
7791
7792         res = fan_get_status_safe(&status);
7793         if (res)
7794                 return res;
7795
7796         if ((status &
7797              (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7798                 status = fan_control_desired_level;
7799
7800         if (status > 7)
7801                 status = 7;
7802
7803         return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7804 }
7805
7806 static ssize_t fan_pwm1_store(struct device *dev,
7807                               struct device_attribute *attr,
7808                               const char *buf, size_t count)
7809 {
7810         unsigned long s;
7811         int rc;
7812         u8 status, newlevel;
7813
7814         if (parse_strtoul(buf, 255, &s))
7815                 return -EINVAL;
7816
7817         tpacpi_disclose_usertask("hwmon pwm1",
7818                         "set fan speed to %lu\n", s);
7819
7820         /* scale down from 0-255 to 0-7 */
7821         newlevel = (s >> 5) & 0x07;
7822
7823         if (mutex_lock_killable(&fan_mutex))
7824                 return -ERESTARTSYS;
7825
7826         rc = fan_get_status(&status);
7827         if (!rc && (status &
7828                     (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7829                 rc = fan_set_level(newlevel);
7830                 if (rc == -ENXIO)
7831                         rc = -EINVAL;
7832                 else if (!rc) {
7833                         fan_update_desired_level(newlevel);
7834                         fan_watchdog_reset();
7835                 }
7836         }
7837
7838         mutex_unlock(&fan_mutex);
7839         return (rc)? rc : count;
7840 }
7841
7842 static struct device_attribute dev_attr_fan_pwm1 =
7843         __ATTR(pwm1, S_IWUSR | S_IRUGO,
7844                 fan_pwm1_show, fan_pwm1_store);
7845
7846 /* sysfs fan fan1_input ------------------------------------------------ */
7847 static ssize_t fan_fan1_input_show(struct device *dev,
7848                            struct device_attribute *attr,
7849                            char *buf)
7850 {
7851         int res;
7852         unsigned int speed;
7853
7854         res = fan_get_speed(&speed);
7855         if (res < 0)
7856                 return res;
7857
7858         return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7859 }
7860
7861 static struct device_attribute dev_attr_fan_fan1_input =
7862         __ATTR(fan1_input, S_IRUGO,
7863                 fan_fan1_input_show, NULL);
7864
7865 /* sysfs fan fan2_input ------------------------------------------------ */
7866 static ssize_t fan_fan2_input_show(struct device *dev,
7867                            struct device_attribute *attr,
7868                            char *buf)
7869 {
7870         int res;
7871         unsigned int speed;
7872
7873         res = fan2_get_speed(&speed);
7874         if (res < 0)
7875                 return res;
7876
7877         return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7878 }
7879
7880 static struct device_attribute dev_attr_fan_fan2_input =
7881         __ATTR(fan2_input, S_IRUGO,
7882                 fan_fan2_input_show, NULL);
7883
7884 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7885 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7886                                      char *buf)
7887 {
7888         return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7889 }
7890
7891 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7892                                       const char *buf, size_t count)
7893 {
7894         unsigned long t;
7895
7896         if (parse_strtoul(buf, 120, &t))
7897                 return -EINVAL;
7898
7899         if (!fan_control_allowed)
7900                 return -EPERM;
7901
7902         fan_watchdog_maxinterval = t;
7903         fan_watchdog_reset();
7904
7905         tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7906
7907         return count;
7908 }
7909
7910 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7911                 fan_fan_watchdog_show, fan_fan_watchdog_store);
7912
7913 /* --------------------------------------------------------------------- */
7914 static struct attribute *fan_attributes[] = {
7915         &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7916         &dev_attr_fan_fan1_input.attr,
7917         NULL, /* for fan2_input */
7918         NULL
7919 };
7920
7921 static const struct attribute_group fan_attr_group = {
7922         .attrs = fan_attributes,
7923 };
7924
7925 #define TPACPI_FAN_Q1   0x0001          /* Unitialized HFSP */
7926 #define TPACPI_FAN_2FAN 0x0002          /* EC 0x31 bit 0 selects fan2 */
7927
7928 #define TPACPI_FAN_QI(__id1, __id2, __quirks)   \
7929         { .vendor = PCI_VENDOR_ID_IBM,          \
7930           .bios = TPACPI_MATCH_ANY,             \
7931           .ec = TPID(__id1, __id2),             \
7932           .quirks = __quirks }
7933
7934 #define TPACPI_FAN_QL(__id1, __id2, __quirks)   \
7935         { .vendor = PCI_VENDOR_ID_LENOVO,       \
7936           .bios = TPACPI_MATCH_ANY,             \
7937           .ec = TPID(__id1, __id2),             \
7938           .quirks = __quirks }
7939
7940 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
7941         TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
7942         TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
7943         TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
7944         TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
7945         TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
7946 };
7947
7948 #undef TPACPI_FAN_QL
7949 #undef TPACPI_FAN_QI
7950
7951 static int __init fan_init(struct ibm_init_struct *iibm)
7952 {
7953         int rc;
7954         unsigned long quirks;
7955
7956         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7957                         "initializing fan subdriver\n");
7958
7959         mutex_init(&fan_mutex);
7960         fan_status_access_mode = TPACPI_FAN_NONE;
7961         fan_control_access_mode = TPACPI_FAN_WR_NONE;
7962         fan_control_commands = 0;
7963         fan_watchdog_maxinterval = 0;
7964         tp_features.fan_ctrl_status_undef = 0;
7965         tp_features.second_fan = 0;
7966         fan_control_desired_level = 7;
7967
7968         TPACPI_ACPIHANDLE_INIT(fans);
7969         TPACPI_ACPIHANDLE_INIT(gfan);
7970         TPACPI_ACPIHANDLE_INIT(sfan);
7971
7972         quirks = tpacpi_check_quirks(fan_quirk_table,
7973                                      ARRAY_SIZE(fan_quirk_table));
7974
7975         if (gfan_handle) {
7976                 /* 570, 600e/x, 770e, 770x */
7977                 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
7978         } else {
7979                 /* all other ThinkPads: note that even old-style
7980                  * ThinkPad ECs supports the fan control register */
7981                 if (likely(acpi_ec_read(fan_status_offset,
7982                                         &fan_control_initial_status))) {
7983                         fan_status_access_mode = TPACPI_FAN_RD_TPEC;
7984                         if (quirks & TPACPI_FAN_Q1)
7985                                 fan_quirk1_setup();
7986                         if (quirks & TPACPI_FAN_2FAN) {
7987                                 tp_features.second_fan = 1;
7988                                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7989                                         "secondary fan support enabled\n");
7990                         }
7991                 } else {
7992                         printk(TPACPI_ERR
7993                                "ThinkPad ACPI EC access misbehaving, "
7994                                "fan status and control unavailable\n");
7995                         return 1;
7996                 }
7997         }
7998
7999         if (sfan_handle) {
8000                 /* 570, 770x-JL */
8001                 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8002                 fan_control_commands |=
8003                     TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8004         } else {
8005                 if (!gfan_handle) {
8006                         /* gfan without sfan means no fan control */
8007                         /* all other models implement TP EC 0x2f control */
8008
8009                         if (fans_handle) {
8010                                 /* X31, X40, X41 */
8011                                 fan_control_access_mode =
8012                                     TPACPI_FAN_WR_ACPI_FANS;
8013                                 fan_control_commands |=
8014                                     TPACPI_FAN_CMD_SPEED |
8015                                     TPACPI_FAN_CMD_LEVEL |
8016                                     TPACPI_FAN_CMD_ENABLE;
8017                         } else {
8018                                 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8019                                 fan_control_commands |=
8020                                     TPACPI_FAN_CMD_LEVEL |
8021                                     TPACPI_FAN_CMD_ENABLE;
8022                         }
8023                 }
8024         }
8025
8026         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8027                 "fan is %s, modes %d, %d\n",
8028                 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8029                   fan_control_access_mode != TPACPI_FAN_WR_NONE),
8030                 fan_status_access_mode, fan_control_access_mode);
8031
8032         /* fan control master switch */
8033         if (!fan_control_allowed) {
8034                 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8035                 fan_control_commands = 0;
8036                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8037                            "fan control features disabled by parameter\n");
8038         }
8039
8040         /* update fan_control_desired_level */
8041         if (fan_status_access_mode != TPACPI_FAN_NONE)
8042                 fan_get_status_safe(NULL);
8043
8044         if (fan_status_access_mode != TPACPI_FAN_NONE ||
8045             fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8046                 if (tp_features.second_fan) {
8047                         /* attach second fan tachometer */
8048                         fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8049                                         &dev_attr_fan_fan2_input.attr;
8050                 }
8051                 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8052                                          &fan_attr_group);
8053                 if (rc < 0)
8054                         return rc;
8055
8056                 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8057                                         &driver_attr_fan_watchdog);
8058                 if (rc < 0) {
8059                         sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8060                                         &fan_attr_group);
8061                         return rc;
8062                 }
8063                 return 0;
8064         } else
8065                 return 1;
8066 }
8067
8068 static void fan_exit(void)
8069 {
8070         vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8071                     "cancelling any pending fan watchdog tasks\n");
8072
8073         /* FIXME: can we really do this unconditionally? */
8074         sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8075         driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8076                            &driver_attr_fan_watchdog);
8077
8078         cancel_delayed_work(&fan_watchdog_task);
8079         flush_workqueue(tpacpi_wq);
8080 }
8081
8082 static void fan_suspend(pm_message_t state)
8083 {
8084         int rc;
8085
8086         if (!fan_control_allowed)
8087                 return;
8088
8089         /* Store fan status in cache */
8090         fan_control_resume_level = 0;
8091         rc = fan_get_status_safe(&fan_control_resume_level);
8092         if (rc < 0)
8093                 printk(TPACPI_NOTICE
8094                         "failed to read fan level for later "
8095                         "restore during resume: %d\n", rc);
8096
8097         /* if it is undefined, don't attempt to restore it.
8098          * KEEP THIS LAST */
8099         if (tp_features.fan_ctrl_status_undef)
8100                 fan_control_resume_level = 0;
8101 }
8102
8103 static void fan_resume(void)
8104 {
8105         u8 current_level = 7;
8106         bool do_set = false;
8107         int rc;
8108
8109         /* DSDT *always* updates status on resume */
8110         tp_features.fan_ctrl_status_undef = 0;
8111
8112         if (!fan_control_allowed ||
8113             !fan_control_resume_level ||
8114             (fan_get_status_safe(&current_level) < 0))
8115                 return;
8116
8117         switch (fan_control_access_mode) {
8118         case TPACPI_FAN_WR_ACPI_SFAN:
8119                 /* never decrease fan level */
8120                 do_set = (fan_control_resume_level > current_level);
8121                 break;
8122         case TPACPI_FAN_WR_ACPI_FANS:
8123         case TPACPI_FAN_WR_TPEC:
8124                 /* never decrease fan level, scale is:
8125                  * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8126                  *
8127                  * We expect the firmware to set either 7 or AUTO, but we
8128                  * handle FULLSPEED out of paranoia.
8129                  *
8130                  * So, we can safely only restore FULLSPEED or 7, anything
8131                  * else could slow the fan.  Restoring AUTO is useless, at
8132                  * best that's exactly what the DSDT already set (it is the
8133                  * slower it uses).
8134                  *
8135                  * Always keep in mind that the DSDT *will* have set the
8136                  * fans to what the vendor supposes is the best level.  We
8137                  * muck with it only to speed the fan up.
8138                  */
8139                 if (fan_control_resume_level != 7 &&
8140                     !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8141                         return;
8142                 else
8143                         do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8144                                  (current_level != fan_control_resume_level);
8145                 break;
8146         default:
8147                 return;
8148         }
8149         if (do_set) {
8150                 printk(TPACPI_NOTICE
8151                         "restoring fan level to 0x%02x\n",
8152                         fan_control_resume_level);
8153                 rc = fan_set_level_safe(fan_control_resume_level);
8154                 if (rc < 0)
8155                         printk(TPACPI_NOTICE
8156                                 "failed to restore fan level: %d\n", rc);
8157         }
8158 }
8159
8160 static int fan_read(struct seq_file *m)
8161 {
8162         int rc;
8163         u8 status;
8164         unsigned int speed = 0;
8165
8166         switch (fan_status_access_mode) {
8167         case TPACPI_FAN_RD_ACPI_GFAN:
8168                 /* 570, 600e/x, 770e, 770x */
8169                 rc = fan_get_status_safe(&status);
8170                 if (rc < 0)
8171                         return rc;
8172
8173                 seq_printf(m, "status:\t\t%s\n"
8174                                "level:\t\t%d\n",
8175                                (status != 0) ? "enabled" : "disabled", status);
8176                 break;
8177
8178         case TPACPI_FAN_RD_TPEC:
8179                 /* all except 570, 600e/x, 770e, 770x */
8180                 rc = fan_get_status_safe(&status);
8181                 if (rc < 0)
8182                         return rc;
8183
8184                 seq_printf(m, "status:\t\t%s\n",
8185                                (status != 0) ? "enabled" : "disabled");
8186
8187                 rc = fan_get_speed(&speed);
8188                 if (rc < 0)
8189                         return rc;
8190
8191                 seq_printf(m, "speed:\t\t%d\n", speed);
8192
8193                 if (status & TP_EC_FAN_FULLSPEED)
8194                         /* Disengaged mode takes precedence */
8195                         seq_printf(m, "level:\t\tdisengaged\n");
8196                 else if (status & TP_EC_FAN_AUTO)
8197                         seq_printf(m, "level:\t\tauto\n");
8198                 else
8199                         seq_printf(m, "level:\t\t%d\n", status);
8200                 break;
8201
8202         case TPACPI_FAN_NONE:
8203         default:
8204                 seq_printf(m, "status:\t\tnot supported\n");
8205         }
8206
8207         if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8208                 seq_printf(m, "commands:\tlevel <level>");
8209
8210                 switch (fan_control_access_mode) {
8211                 case TPACPI_FAN_WR_ACPI_SFAN:
8212                         seq_printf(m, " (<level> is 0-7)\n");
8213                         break;
8214
8215                 default:
8216                         seq_printf(m, " (<level> is 0-7, "
8217                                        "auto, disengaged, full-speed)\n");
8218                         break;
8219                 }
8220         }
8221
8222         if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8223                 seq_printf(m, "commands:\tenable, disable\n"
8224                                "commands:\twatchdog <timeout> (<timeout> "
8225                                "is 0 (off), 1-120 (seconds))\n");
8226
8227         if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8228                 seq_printf(m, "commands:\tspeed <speed>"
8229                                " (<speed> is 0-65535)\n");
8230
8231         return 0;
8232 }
8233
8234 static int fan_write_cmd_level(const char *cmd, int *rc)
8235 {
8236         int level;
8237
8238         if (strlencmp(cmd, "level auto") == 0)
8239                 level = TP_EC_FAN_AUTO;
8240         else if ((strlencmp(cmd, "level disengaged") == 0) |
8241                         (strlencmp(cmd, "level full-speed") == 0))
8242                 level = TP_EC_FAN_FULLSPEED;
8243         else if (sscanf(cmd, "level %d", &level) != 1)
8244                 return 0;
8245
8246         *rc = fan_set_level_safe(level);
8247         if (*rc == -ENXIO)
8248                 printk(TPACPI_ERR "level command accepted for unsupported "
8249                        "access mode %d", fan_control_access_mode);
8250         else if (!*rc)
8251                 tpacpi_disclose_usertask("procfs fan",
8252                         "set level to %d\n", level);
8253
8254         return 1;
8255 }
8256
8257 static int fan_write_cmd_enable(const char *cmd, int *rc)
8258 {
8259         if (strlencmp(cmd, "enable") != 0)
8260                 return 0;
8261
8262         *rc = fan_set_enable();
8263         if (*rc == -ENXIO)
8264                 printk(TPACPI_ERR "enable command accepted for unsupported "
8265                        "access mode %d", fan_control_access_mode);
8266         else if (!*rc)
8267                 tpacpi_disclose_usertask("procfs fan", "enable\n");
8268
8269         return 1;
8270 }
8271
8272 static int fan_write_cmd_disable(const char *cmd, int *rc)
8273 {
8274         if (strlencmp(cmd, "disable") != 0)
8275                 return 0;
8276
8277         *rc = fan_set_disable();
8278         if (*rc == -ENXIO)
8279                 printk(TPACPI_ERR "disable command accepted for unsupported "
8280                        "access mode %d", fan_control_access_mode);
8281         else if (!*rc)
8282                 tpacpi_disclose_usertask("procfs fan", "disable\n");
8283
8284         return 1;
8285 }
8286
8287 static int fan_write_cmd_speed(const char *cmd, int *rc)
8288 {
8289         int speed;
8290
8291         /* TODO:
8292          * Support speed <low> <medium> <high> ? */
8293
8294         if (sscanf(cmd, "speed %d", &speed) != 1)
8295                 return 0;
8296
8297         *rc = fan_set_speed(speed);
8298         if (*rc == -ENXIO)
8299                 printk(TPACPI_ERR "speed command accepted for unsupported "
8300                        "access mode %d", fan_control_access_mode);
8301         else if (!*rc)
8302                 tpacpi_disclose_usertask("procfs fan",
8303                         "set speed to %d\n", speed);
8304
8305         return 1;
8306 }
8307
8308 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8309 {
8310         int interval;
8311
8312         if (sscanf(cmd, "watchdog %d", &interval) != 1)
8313                 return 0;
8314
8315         if (interval < 0 || interval > 120)
8316                 *rc = -EINVAL;
8317         else {
8318                 fan_watchdog_maxinterval = interval;
8319                 tpacpi_disclose_usertask("procfs fan",
8320                         "set watchdog timer to %d\n",
8321                         interval);
8322         }
8323
8324         return 1;
8325 }
8326
8327 static int fan_write(char *buf)
8328 {
8329         char *cmd;
8330         int rc = 0;
8331
8332         while (!rc && (cmd = next_cmd(&buf))) {
8333                 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8334                       fan_write_cmd_level(cmd, &rc)) &&
8335                     !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8336                       (fan_write_cmd_enable(cmd, &rc) ||
8337                        fan_write_cmd_disable(cmd, &rc) ||
8338                        fan_write_cmd_watchdog(cmd, &rc))) &&
8339                     !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8340                       fan_write_cmd_speed(cmd, &rc))
8341                     )
8342                         rc = -EINVAL;
8343                 else if (!rc)
8344                         fan_watchdog_reset();
8345         }
8346
8347         return rc;
8348 }
8349
8350 static struct ibm_struct fan_driver_data = {
8351         .name = "fan",
8352         .read = fan_read,
8353         .write = fan_write,
8354         .exit = fan_exit,
8355         .suspend = fan_suspend,
8356         .resume = fan_resume,
8357 };
8358
8359 /****************************************************************************
8360  ****************************************************************************
8361  *
8362  * Infrastructure
8363  *
8364  ****************************************************************************
8365  ****************************************************************************/
8366
8367 /*
8368  * HKEY event callout for other subdrivers go here
8369  * (yes, it is ugly, but it is quick, safe, and gets the job done
8370  */
8371 static void tpacpi_driver_event(const unsigned int hkey_event)
8372 {
8373         if (ibm_backlight_device) {
8374                 switch (hkey_event) {
8375                 case TP_HKEY_EV_BRGHT_UP:
8376                 case TP_HKEY_EV_BRGHT_DOWN:
8377                         tpacpi_brightness_notify_change();
8378                 }
8379         }
8380         if (alsa_card) {
8381                 switch (hkey_event) {
8382                 case TP_HKEY_EV_VOL_UP:
8383                 case TP_HKEY_EV_VOL_DOWN:
8384                 case TP_HKEY_EV_VOL_MUTE:
8385                         volume_alsa_notify_change();
8386                 }
8387         }
8388 }
8389
8390 static void hotkey_driver_event(const unsigned int scancode)
8391 {
8392         tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8393 }
8394
8395 /* sysfs name ---------------------------------------------------------- */
8396 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8397                            struct device_attribute *attr,
8398                            char *buf)
8399 {
8400         return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8401 }
8402
8403 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8404         __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8405
8406 /* --------------------------------------------------------------------- */
8407
8408 /* /proc support */
8409 static struct proc_dir_entry *proc_dir;
8410
8411 /*
8412  * Module and infrastructure proble, init and exit handling
8413  */
8414
8415 static int force_load;
8416
8417 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
8418 static const char * __init str_supported(int is_supported)
8419 {
8420         static char text_unsupported[] __initdata = "not supported";
8421
8422         return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8423 }
8424 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8425
8426 static void ibm_exit(struct ibm_struct *ibm)
8427 {
8428         dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8429
8430         list_del_init(&ibm->all_drivers);
8431
8432         if (ibm->flags.acpi_notify_installed) {
8433                 dbg_printk(TPACPI_DBG_EXIT,
8434                         "%s: acpi_remove_notify_handler\n", ibm->name);
8435                 BUG_ON(!ibm->acpi);
8436                 acpi_remove_notify_handler(*ibm->acpi->handle,
8437                                            ibm->acpi->type,
8438                                            dispatch_acpi_notify);
8439                 ibm->flags.acpi_notify_installed = 0;
8440                 ibm->flags.acpi_notify_installed = 0;
8441         }
8442
8443         if (ibm->flags.proc_created) {
8444                 dbg_printk(TPACPI_DBG_EXIT,
8445                         "%s: remove_proc_entry\n", ibm->name);
8446                 remove_proc_entry(ibm->name, proc_dir);
8447                 ibm->flags.proc_created = 0;
8448         }
8449
8450         if (ibm->flags.acpi_driver_registered) {
8451                 dbg_printk(TPACPI_DBG_EXIT,
8452                         "%s: acpi_bus_unregister_driver\n", ibm->name);
8453                 BUG_ON(!ibm->acpi);
8454                 acpi_bus_unregister_driver(ibm->acpi->driver);
8455                 kfree(ibm->acpi->driver);
8456                 ibm->acpi->driver = NULL;
8457                 ibm->flags.acpi_driver_registered = 0;
8458         }
8459
8460         if (ibm->flags.init_called && ibm->exit) {
8461                 ibm->exit();
8462                 ibm->flags.init_called = 0;
8463         }
8464
8465         dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8466 }
8467
8468 static int __init ibm_init(struct ibm_init_struct *iibm)
8469 {
8470         int ret;
8471         struct ibm_struct *ibm = iibm->data;
8472         struct proc_dir_entry *entry;
8473
8474         BUG_ON(ibm == NULL);
8475
8476         INIT_LIST_HEAD(&ibm->all_drivers);
8477
8478         if (ibm->flags.experimental && !experimental)
8479                 return 0;
8480
8481         dbg_printk(TPACPI_DBG_INIT,
8482                 "probing for %s\n", ibm->name);
8483
8484         if (iibm->init) {
8485                 ret = iibm->init(iibm);
8486                 if (ret > 0)
8487                         return 0;       /* probe failed */
8488                 if (ret)
8489                         return ret;
8490
8491                 ibm->flags.init_called = 1;
8492         }
8493
8494         if (ibm->acpi) {
8495                 if (ibm->acpi->hid) {
8496                         ret = register_tpacpi_subdriver(ibm);
8497                         if (ret)
8498                                 goto err_out;
8499                 }
8500
8501                 if (ibm->acpi->notify) {
8502                         ret = setup_acpi_notify(ibm);
8503                         if (ret == -ENODEV) {
8504                                 printk(TPACPI_NOTICE "disabling subdriver %s\n",
8505                                         ibm->name);
8506                                 ret = 0;
8507                                 goto err_out;
8508                         }
8509                         if (ret < 0)
8510                                 goto err_out;
8511                 }
8512         }
8513
8514         dbg_printk(TPACPI_DBG_INIT,
8515                 "%s installed\n", ibm->name);
8516
8517         if (ibm->read) {
8518                 mode_t mode = iibm->base_procfs_mode;
8519
8520                 if (!mode)
8521                         mode = S_IRUGO;
8522                 if (ibm->write)
8523                         mode |= S_IWUSR;
8524                 entry = proc_create_data(ibm->name, mode, proc_dir,
8525                                          &dispatch_proc_fops, ibm);
8526                 if (!entry) {
8527                         printk(TPACPI_ERR "unable to create proc entry %s\n",
8528                                ibm->name);
8529                         ret = -ENODEV;
8530                         goto err_out;
8531                 }
8532                 ibm->flags.proc_created = 1;
8533         }
8534
8535         list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8536
8537         return 0;
8538
8539 err_out:
8540         dbg_printk(TPACPI_DBG_INIT,
8541                 "%s: at error exit path with result %d\n",
8542                 ibm->name, ret);
8543
8544         ibm_exit(ibm);
8545         return (ret < 0)? ret : 0;
8546 }
8547
8548 /* Probing */
8549
8550 static bool __pure __init tpacpi_is_fw_digit(const char c)
8551 {
8552         return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8553 }
8554
8555 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8556 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8557                                                 const char t)
8558 {
8559         return s && strlen(s) >= 8 &&
8560                 tpacpi_is_fw_digit(s[0]) &&
8561                 tpacpi_is_fw_digit(s[1]) &&
8562                 s[2] == t && s[3] == 'T' &&
8563                 tpacpi_is_fw_digit(s[4]) &&
8564                 tpacpi_is_fw_digit(s[5]) &&
8565                 s[6] == 'W' && s[7] == 'W';
8566 }
8567
8568 /* returns 0 - probe ok, or < 0 - probe error.
8569  * Probe ok doesn't mean thinkpad found.
8570  * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8571 static int __must_check __init get_thinkpad_model_data(
8572                                                 struct thinkpad_id_data *tp)
8573 {
8574         const struct dmi_device *dev = NULL;
8575         char ec_fw_string[18];
8576         char const *s;
8577
8578         if (!tp)
8579                 return -EINVAL;
8580
8581         memset(tp, 0, sizeof(*tp));
8582
8583         if (dmi_name_in_vendors("IBM"))
8584                 tp->vendor = PCI_VENDOR_ID_IBM;
8585         else if (dmi_name_in_vendors("LENOVO"))
8586                 tp->vendor = PCI_VENDOR_ID_LENOVO;
8587         else
8588                 return 0;
8589
8590         s = dmi_get_system_info(DMI_BIOS_VERSION);
8591         tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8592         if (s && !tp->bios_version_str)
8593                 return -ENOMEM;
8594
8595         /* Really ancient ThinkPad 240X will fail this, which is fine */
8596         if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
8597                 return 0;
8598
8599         tp->bios_model = tp->bios_version_str[0]
8600                          | (tp->bios_version_str[1] << 8);
8601         tp->bios_release = (tp->bios_version_str[4] << 8)
8602                          | tp->bios_version_str[5];
8603
8604         /*
8605          * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8606          * X32 or newer, all Z series;  Some models must have an
8607          * up-to-date BIOS or they will not be detected.
8608          *
8609          * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8610          */
8611         while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8612                 if (sscanf(dev->name,
8613                            "IBM ThinkPad Embedded Controller -[%17c",
8614                            ec_fw_string) == 1) {
8615                         ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8616                         ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8617
8618                         tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8619                         if (!tp->ec_version_str)
8620                                 return -ENOMEM;
8621
8622                         if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8623                                 tp->ec_model = ec_fw_string[0]
8624                                                 | (ec_fw_string[1] << 8);
8625                                 tp->ec_release = (ec_fw_string[4] << 8)
8626                                                 | ec_fw_string[5];
8627                         } else {
8628                                 printk(TPACPI_NOTICE
8629                                         "ThinkPad firmware release %s "
8630                                         "doesn't match the known patterns\n",
8631                                         ec_fw_string);
8632                                 printk(TPACPI_NOTICE
8633                                         "please report this to %s\n",
8634                                         TPACPI_MAIL);
8635                         }
8636                         break;
8637                 }
8638         }
8639
8640         s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8641         if (s && !strnicmp(s, "ThinkPad", 8)) {
8642                 tp->model_str = kstrdup(s, GFP_KERNEL);
8643                 if (!tp->model_str)
8644                         return -ENOMEM;
8645         }
8646
8647         s = dmi_get_system_info(DMI_PRODUCT_NAME);
8648         tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8649         if (s && !tp->nummodel_str)
8650                 return -ENOMEM;
8651
8652         return 0;
8653 }
8654
8655 static int __init probe_for_thinkpad(void)
8656 {
8657         int is_thinkpad;
8658
8659         if (acpi_disabled)
8660                 return -ENODEV;
8661
8662         /*
8663          * Non-ancient models have better DMI tagging, but very old models
8664          * don't.  tpacpi_is_fw_known() is a cheat to help in that case.
8665          */
8666         is_thinkpad = (thinkpad_id.model_str != NULL) ||
8667                       (thinkpad_id.ec_model != 0) ||
8668                       tpacpi_is_fw_known();
8669
8670         /* ec is required because many other handles are relative to it */
8671         TPACPI_ACPIHANDLE_INIT(ec);
8672         if (!ec_handle) {
8673                 if (is_thinkpad)
8674                         printk(TPACPI_ERR
8675                                 "Not yet supported ThinkPad detected!\n");
8676                 return -ENODEV;
8677         }
8678
8679         if (!is_thinkpad && !force_load)
8680                 return -ENODEV;
8681
8682         return 0;
8683 }
8684
8685
8686 /* Module init, exit, parameters */
8687
8688 static struct ibm_init_struct ibms_init[] __initdata = {
8689         {
8690                 .init = thinkpad_acpi_driver_init,
8691                 .data = &thinkpad_acpi_driver_data,
8692         },
8693         {
8694                 .init = hotkey_init,
8695                 .data = &hotkey_driver_data,
8696         },
8697         {
8698                 .init = bluetooth_init,
8699                 .data = &bluetooth_driver_data,
8700         },
8701         {
8702                 .init = wan_init,
8703                 .data = &wan_driver_data,
8704         },
8705         {
8706                 .init = uwb_init,
8707                 .data = &uwb_driver_data,
8708         },
8709 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8710         {
8711                 .init = video_init,
8712                 .base_procfs_mode = S_IRUSR,
8713                 .data = &video_driver_data,
8714         },
8715 #endif
8716         {
8717                 .init = light_init,
8718                 .data = &light_driver_data,
8719         },
8720         {
8721                 .init = cmos_init,
8722                 .data = &cmos_driver_data,
8723         },
8724         {
8725                 .init = led_init,
8726                 .data = &led_driver_data,
8727         },
8728         {
8729                 .init = beep_init,
8730                 .data = &beep_driver_data,
8731         },
8732         {
8733                 .init = thermal_init,
8734                 .data = &thermal_driver_data,
8735         },
8736         {
8737                 .data = &ecdump_driver_data,
8738         },
8739         {
8740                 .init = brightness_init,
8741                 .data = &brightness_driver_data,
8742         },
8743         {
8744                 .init = volume_init,
8745                 .data = &volume_driver_data,
8746         },
8747         {
8748                 .init = fan_init,
8749                 .data = &fan_driver_data,
8750         },
8751 };
8752
8753 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8754 {
8755         unsigned int i;
8756         struct ibm_struct *ibm;
8757
8758         if (!kp || !kp->name || !val)
8759                 return -EINVAL;
8760
8761         for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8762                 ibm = ibms_init[i].data;
8763                 WARN_ON(ibm == NULL);
8764
8765                 if (!ibm || !ibm->name)
8766                         continue;
8767
8768                 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8769                         if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8770                                 return -ENOSPC;
8771                         strcpy(ibms_init[i].param, val);
8772                         strcat(ibms_init[i].param, ",");
8773                         return 0;
8774                 }
8775         }
8776
8777         return -EINVAL;
8778 }
8779
8780 module_param(experimental, int, 0444);
8781 MODULE_PARM_DESC(experimental,
8782                  "Enables experimental features when non-zero");
8783
8784 module_param_named(debug, dbg_level, uint, 0);
8785 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8786
8787 module_param(force_load, bool, 0444);
8788 MODULE_PARM_DESC(force_load,
8789                  "Attempts to load the driver even on a "
8790                  "mis-identified ThinkPad when true");
8791
8792 module_param_named(fan_control, fan_control_allowed, bool, 0444);
8793 MODULE_PARM_DESC(fan_control,
8794                  "Enables setting fan parameters features when true");
8795
8796 module_param_named(brightness_mode, brightness_mode, uint, 0444);
8797 MODULE_PARM_DESC(brightness_mode,
8798                  "Selects brightness control strategy: "
8799                  "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8800
8801 module_param(brightness_enable, uint, 0444);
8802 MODULE_PARM_DESC(brightness_enable,
8803                  "Enables backlight control when 1, disables when 0");
8804
8805 module_param(hotkey_report_mode, uint, 0444);
8806 MODULE_PARM_DESC(hotkey_report_mode,
8807                  "used for backwards compatibility with userspace, "
8808                  "see documentation");
8809
8810 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8811 module_param_named(volume_mode, volume_mode, uint, 0444);
8812 MODULE_PARM_DESC(volume_mode,
8813                  "Selects volume control strategy: "
8814                  "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8815
8816 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8817 MODULE_PARM_DESC(volume_capabilities,
8818                  "Selects the mixer capabilites: "
8819                  "0=auto, 1=volume and mute, 2=mute only");
8820
8821 module_param_named(volume_control, volume_control_allowed, bool, 0444);
8822 MODULE_PARM_DESC(volume_control,
8823                  "Enables software override for the console audio "
8824                  "control when true");
8825
8826 /* ALSA module API parameters */
8827 module_param_named(index, alsa_index, int, 0444);
8828 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8829 module_param_named(id, alsa_id, charp, 0444);
8830 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8831 module_param_named(enable, alsa_enable, bool, 0444);
8832 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8833 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8834
8835 #define TPACPI_PARAM(feature) \
8836         module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8837         MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8838                          "at module load, see documentation")
8839
8840 TPACPI_PARAM(hotkey);
8841 TPACPI_PARAM(bluetooth);
8842 TPACPI_PARAM(video);
8843 TPACPI_PARAM(light);
8844 TPACPI_PARAM(cmos);
8845 TPACPI_PARAM(led);
8846 TPACPI_PARAM(beep);
8847 TPACPI_PARAM(ecdump);
8848 TPACPI_PARAM(brightness);
8849 TPACPI_PARAM(volume);
8850 TPACPI_PARAM(fan);
8851
8852 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8853 module_param(dbg_wlswemul, uint, 0444);
8854 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8855 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8856 MODULE_PARM_DESC(wlsw_state,
8857                  "Initial state of the emulated WLSW switch");
8858
8859 module_param(dbg_bluetoothemul, uint, 0444);
8860 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8861 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8862 MODULE_PARM_DESC(bluetooth_state,
8863                  "Initial state of the emulated bluetooth switch");
8864
8865 module_param(dbg_wwanemul, uint, 0444);
8866 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8867 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8868 MODULE_PARM_DESC(wwan_state,
8869                  "Initial state of the emulated WWAN switch");
8870
8871 module_param(dbg_uwbemul, uint, 0444);
8872 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8873 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8874 MODULE_PARM_DESC(uwb_state,
8875                  "Initial state of the emulated UWB switch");
8876 #endif
8877
8878 static void thinkpad_acpi_module_exit(void)
8879 {
8880         struct ibm_struct *ibm, *itmp;
8881
8882         tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8883
8884         list_for_each_entry_safe_reverse(ibm, itmp,
8885                                          &tpacpi_all_drivers,
8886                                          all_drivers) {
8887                 ibm_exit(ibm);
8888         }
8889
8890         dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8891
8892         if (tpacpi_inputdev) {
8893                 if (tp_features.input_device_registered)
8894                         input_unregister_device(tpacpi_inputdev);
8895                 else
8896                         input_free_device(tpacpi_inputdev);
8897         }
8898
8899         if (tpacpi_hwmon)
8900                 hwmon_device_unregister(tpacpi_hwmon);
8901
8902         if (tp_features.sensors_pdev_attrs_registered)
8903                 device_remove_file(&tpacpi_sensors_pdev->dev,
8904                                    &dev_attr_thinkpad_acpi_pdev_name);
8905         if (tpacpi_sensors_pdev)
8906                 platform_device_unregister(tpacpi_sensors_pdev);
8907         if (tpacpi_pdev)
8908                 platform_device_unregister(tpacpi_pdev);
8909
8910         if (tp_features.sensors_pdrv_attrs_registered)
8911                 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8912         if (tp_features.platform_drv_attrs_registered)
8913                 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8914
8915         if (tp_features.sensors_pdrv_registered)
8916                 platform_driver_unregister(&tpacpi_hwmon_pdriver);
8917
8918         if (tp_features.platform_drv_registered)
8919                 platform_driver_unregister(&tpacpi_pdriver);
8920
8921         if (proc_dir)
8922                 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
8923
8924         if (tpacpi_wq)
8925                 destroy_workqueue(tpacpi_wq);
8926
8927         kfree(thinkpad_id.bios_version_str);
8928         kfree(thinkpad_id.ec_version_str);
8929         kfree(thinkpad_id.model_str);
8930 }
8931
8932
8933 static int __init thinkpad_acpi_module_init(void)
8934 {
8935         int ret, i;
8936
8937         tpacpi_lifecycle = TPACPI_LIFE_INIT;
8938
8939         /* Parameter checking */
8940         if (hotkey_report_mode > 2)
8941                 return -EINVAL;
8942
8943         /* Driver-level probe */
8944
8945         ret = get_thinkpad_model_data(&thinkpad_id);
8946         if (ret) {
8947                 printk(TPACPI_ERR
8948                         "unable to get DMI data: %d\n", ret);
8949                 thinkpad_acpi_module_exit();
8950                 return ret;
8951         }
8952         ret = probe_for_thinkpad();
8953         if (ret) {
8954                 thinkpad_acpi_module_exit();
8955                 return ret;
8956         }
8957
8958         /* Driver initialization */
8959
8960         TPACPI_ACPIHANDLE_INIT(ecrd);
8961         TPACPI_ACPIHANDLE_INIT(ecwr);
8962
8963         tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
8964         if (!tpacpi_wq) {
8965                 thinkpad_acpi_module_exit();
8966                 return -ENOMEM;
8967         }
8968
8969         proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
8970         if (!proc_dir) {
8971                 printk(TPACPI_ERR
8972                        "unable to create proc dir " TPACPI_PROC_DIR);
8973                 thinkpad_acpi_module_exit();
8974                 return -ENODEV;
8975         }
8976
8977         ret = platform_driver_register(&tpacpi_pdriver);
8978         if (ret) {
8979                 printk(TPACPI_ERR
8980                        "unable to register main platform driver\n");
8981                 thinkpad_acpi_module_exit();
8982                 return ret;
8983         }
8984         tp_features.platform_drv_registered = 1;
8985
8986         ret = platform_driver_register(&tpacpi_hwmon_pdriver);
8987         if (ret) {
8988                 printk(TPACPI_ERR
8989                        "unable to register hwmon platform driver\n");
8990                 thinkpad_acpi_module_exit();
8991                 return ret;
8992         }
8993         tp_features.sensors_pdrv_registered = 1;
8994
8995         ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
8996         if (!ret) {
8997                 tp_features.platform_drv_attrs_registered = 1;
8998                 ret = tpacpi_create_driver_attributes(
8999                                         &tpacpi_hwmon_pdriver.driver);
9000         }
9001         if (ret) {
9002                 printk(TPACPI_ERR
9003                        "unable to create sysfs driver attributes\n");
9004                 thinkpad_acpi_module_exit();
9005                 return ret;
9006         }
9007         tp_features.sensors_pdrv_attrs_registered = 1;
9008
9009
9010         /* Device initialization */
9011         tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9012                                                         NULL, 0);
9013         if (IS_ERR(tpacpi_pdev)) {
9014                 ret = PTR_ERR(tpacpi_pdev);
9015                 tpacpi_pdev = NULL;
9016                 printk(TPACPI_ERR "unable to register platform device\n");
9017                 thinkpad_acpi_module_exit();
9018                 return ret;
9019         }
9020         tpacpi_sensors_pdev = platform_device_register_simple(
9021                                                 TPACPI_HWMON_DRVR_NAME,
9022                                                 -1, NULL, 0);
9023         if (IS_ERR(tpacpi_sensors_pdev)) {
9024                 ret = PTR_ERR(tpacpi_sensors_pdev);
9025                 tpacpi_sensors_pdev = NULL;
9026                 printk(TPACPI_ERR
9027                        "unable to register hwmon platform device\n");
9028                 thinkpad_acpi_module_exit();
9029                 return ret;
9030         }
9031         ret = device_create_file(&tpacpi_sensors_pdev->dev,
9032                                  &dev_attr_thinkpad_acpi_pdev_name);
9033         if (ret) {
9034                 printk(TPACPI_ERR
9035                        "unable to create sysfs hwmon device attributes\n");
9036                 thinkpad_acpi_module_exit();
9037                 return ret;
9038         }
9039         tp_features.sensors_pdev_attrs_registered = 1;
9040         tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9041         if (IS_ERR(tpacpi_hwmon)) {
9042                 ret = PTR_ERR(tpacpi_hwmon);
9043                 tpacpi_hwmon = NULL;
9044                 printk(TPACPI_ERR "unable to register hwmon device\n");
9045                 thinkpad_acpi_module_exit();
9046                 return ret;
9047         }
9048         mutex_init(&tpacpi_inputdev_send_mutex);
9049         tpacpi_inputdev = input_allocate_device();
9050         if (!tpacpi_inputdev) {
9051                 printk(TPACPI_ERR "unable to allocate input device\n");
9052                 thinkpad_acpi_module_exit();
9053                 return -ENOMEM;
9054         } else {
9055                 /* Prepare input device, but don't register */
9056                 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9057                 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9058                 tpacpi_inputdev->id.bustype = BUS_HOST;
9059                 tpacpi_inputdev->id.vendor = (thinkpad_id.vendor) ?
9060                                                 thinkpad_id.vendor :
9061                                                 PCI_VENDOR_ID_IBM;
9062                 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9063                 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9064                 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9065         }
9066         for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9067                 ret = ibm_init(&ibms_init[i]);
9068                 if (ret >= 0 && *ibms_init[i].param)
9069                         ret = ibms_init[i].data->write(ibms_init[i].param);
9070                 if (ret < 0) {
9071                         thinkpad_acpi_module_exit();
9072                         return ret;
9073                 }
9074         }
9075
9076         tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9077
9078         ret = input_register_device(tpacpi_inputdev);
9079         if (ret < 0) {
9080                 printk(TPACPI_ERR "unable to register input device\n");
9081                 thinkpad_acpi_module_exit();
9082                 return ret;
9083         } else {
9084                 tp_features.input_device_registered = 1;
9085         }
9086
9087         return 0;
9088 }
9089
9090 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9091
9092 /*
9093  * This will autoload the driver in almost every ThinkPad
9094  * in widespread use.
9095  *
9096  * Only _VERY_ old models, like the 240, 240x and 570 lack
9097  * the HKEY event interface.
9098  */
9099 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9100
9101 /*
9102  * DMI matching for module autoloading
9103  *
9104  * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9105  * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9106  *
9107  * Only models listed in thinkwiki will be supported, so add yours
9108  * if it is not there yet.
9109  */
9110 #define IBM_BIOS_MODULE_ALIAS(__type) \
9111         MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9112
9113 /* Ancient thinkpad BIOSes have to be identified by
9114  * BIOS type or model number, and there are far less
9115  * BIOS types than model numbers... */
9116 IBM_BIOS_MODULE_ALIAS("I[MU]");         /* 570, 570e */
9117
9118 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9119 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9120 MODULE_DESCRIPTION(TPACPI_DESC);
9121 MODULE_VERSION(TPACPI_VERSION);
9122 MODULE_LICENSE("GPL");
9123
9124 module_init(thinkpad_acpi_module_init);
9125 module_exit(thinkpad_acpi_module_exit);