Version:  2.0.40 2.2.26 2.4.37 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2 4.3 4.4 4.5 4.6

Linux/drivers/platform/x86/thinkpad_acpi.c

  1 /*
  2  *  thinkpad_acpi.c - ThinkPad ACPI Extras
  3  *
  4  *
  5  *  Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
  6  *  Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
  7  *
  8  *  This program is free software; you can redistribute it and/or modify
  9  *  it under the terms of the GNU General Public License as published by
 10  *  the Free Software Foundation; either version 2 of the License, or
 11  *  (at your option) any later version.
 12  *
 13  *  This program is distributed in the hope that it will be useful,
 14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 16  *  GNU General Public License for more details.
 17  *
 18  *  You should have received a copy of the GNU General Public License
 19  *  along with this program; if not, write to the Free Software
 20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 21  *  02110-1301, USA.
 22  */
 23 
 24 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 25 
 26 #define TPACPI_VERSION "0.25"
 27 #define TPACPI_SYSFS_VERSION 0x020700
 28 
 29 /*
 30  *  Changelog:
 31  *  2007-10-20          changelog trimmed down
 32  *
 33  *  2007-03-27  0.14    renamed to thinkpad_acpi and moved to
 34  *                      drivers/misc.
 35  *
 36  *  2006-11-22  0.13    new maintainer
 37  *                      changelog now lives in git commit history, and will
 38  *                      not be updated further in-file.
 39  *
 40  *  2005-03-17  0.11    support for 600e, 770x
 41  *                          thanks to Jamie Lentin <lentinj@dial.pipex.com>
 42  *
 43  *  2005-01-16  0.9     use MODULE_VERSION
 44  *                          thanks to Henrik Brix Andersen <brix@gentoo.org>
 45  *                      fix parameter passing on module loading
 46  *                          thanks to Rusty Russell <rusty@rustcorp.com.au>
 47  *                          thanks to Jim Radford <radford@blackbean.org>
 48  *  2004-11-08  0.8     fix init error case, don't return from a macro
 49  *                          thanks to Chris Wright <chrisw@osdl.org>
 50  */
 51 
 52 #include <linux/kernel.h>
 53 #include <linux/module.h>
 54 #include <linux/init.h>
 55 #include <linux/types.h>
 56 #include <linux/string.h>
 57 #include <linux/list.h>
 58 #include <linux/mutex.h>
 59 #include <linux/sched.h>
 60 #include <linux/kthread.h>
 61 #include <linux/freezer.h>
 62 #include <linux/delay.h>
 63 #include <linux/slab.h>
 64 #include <linux/nvram.h>
 65 #include <linux/proc_fs.h>
 66 #include <linux/seq_file.h>
 67 #include <linux/sysfs.h>
 68 #include <linux/backlight.h>
 69 #include <linux/fb.h>
 70 #include <linux/platform_device.h>
 71 #include <linux/hwmon.h>
 72 #include <linux/hwmon-sysfs.h>
 73 #include <linux/input.h>
 74 #include <linux/leds.h>
 75 #include <linux/rfkill.h>
 76 #include <linux/dmi.h>
 77 #include <linux/jiffies.h>
 78 #include <linux/workqueue.h>
 79 #include <linux/acpi.h>
 80 #include <linux/pci_ids.h>
 81 #include <linux/thinkpad_acpi.h>
 82 #include <sound/core.h>
 83 #include <sound/control.h>
 84 #include <sound/initval.h>
 85 #include <asm/uaccess.h>
 86 #include <acpi/video.h>
 87 
 88 /* ThinkPad CMOS commands */
 89 #define TP_CMOS_VOLUME_DOWN     0
 90 #define TP_CMOS_VOLUME_UP       1
 91 #define TP_CMOS_VOLUME_MUTE     2
 92 #define TP_CMOS_BRIGHTNESS_UP   4
 93 #define TP_CMOS_BRIGHTNESS_DOWN 5
 94 #define TP_CMOS_THINKLIGHT_ON   12
 95 #define TP_CMOS_THINKLIGHT_OFF  13
 96 
 97 /* NVRAM Addresses */
 98 enum tp_nvram_addr {
 99         TP_NVRAM_ADDR_HK2               = 0x57,
100         TP_NVRAM_ADDR_THINKLIGHT        = 0x58,
101         TP_NVRAM_ADDR_VIDEO             = 0x59,
102         TP_NVRAM_ADDR_BRIGHTNESS        = 0x5e,
103         TP_NVRAM_ADDR_MIXER             = 0x60,
104 };
105 
106 /* NVRAM bit masks */
107 enum {
108         TP_NVRAM_MASK_HKT_THINKPAD      = 0x08,
109         TP_NVRAM_MASK_HKT_ZOOM          = 0x20,
110         TP_NVRAM_MASK_HKT_DISPLAY       = 0x40,
111         TP_NVRAM_MASK_HKT_HIBERNATE     = 0x80,
112         TP_NVRAM_MASK_THINKLIGHT        = 0x10,
113         TP_NVRAM_MASK_HKT_DISPEXPND     = 0x30,
114         TP_NVRAM_MASK_HKT_BRIGHTNESS    = 0x20,
115         TP_NVRAM_MASK_LEVEL_BRIGHTNESS  = 0x0f,
116         TP_NVRAM_POS_LEVEL_BRIGHTNESS   = 0,
117         TP_NVRAM_MASK_MUTE              = 0x40,
118         TP_NVRAM_MASK_HKT_VOLUME        = 0x80,
119         TP_NVRAM_MASK_LEVEL_VOLUME      = 0x0f,
120         TP_NVRAM_POS_LEVEL_VOLUME       = 0,
121 };
122 
123 /* Misc NVRAM-related */
124 enum {
125         TP_NVRAM_LEVEL_VOLUME_MAX = 14,
126 };
127 
128 /* ACPI HIDs */
129 #define TPACPI_ACPI_IBM_HKEY_HID        "IBM0068"
130 #define TPACPI_ACPI_LENOVO_HKEY_HID     "LEN0068"
131 #define TPACPI_ACPI_EC_HID              "PNP0C09"
132 
133 /* Input IDs */
134 #define TPACPI_HKEY_INPUT_PRODUCT       0x5054 /* "TP" */
135 #define TPACPI_HKEY_INPUT_VERSION       0x4101
136 
137 /* ACPI \WGSV commands */
138 enum {
139         TP_ACPI_WGSV_GET_STATE          = 0x01, /* Get state information */
140         TP_ACPI_WGSV_PWR_ON_ON_RESUME   = 0x02, /* Resume WWAN powered on */
141         TP_ACPI_WGSV_PWR_OFF_ON_RESUME  = 0x03, /* Resume WWAN powered off */
142         TP_ACPI_WGSV_SAVE_STATE         = 0x04, /* Save state for S4/S5 */
143 };
144 
145 /* TP_ACPI_WGSV_GET_STATE bits */
146 enum {
147         TP_ACPI_WGSV_STATE_WWANEXIST    = 0x0001, /* WWAN hw available */
148         TP_ACPI_WGSV_STATE_WWANPWR      = 0x0002, /* WWAN radio enabled */
149         TP_ACPI_WGSV_STATE_WWANPWRRES   = 0x0004, /* WWAN state at resume */
150         TP_ACPI_WGSV_STATE_WWANBIOSOFF  = 0x0008, /* WWAN disabled in BIOS */
151         TP_ACPI_WGSV_STATE_BLTHEXIST    = 0x0001, /* BLTH hw available */
152         TP_ACPI_WGSV_STATE_BLTHPWR      = 0x0002, /* BLTH radio enabled */
153         TP_ACPI_WGSV_STATE_BLTHPWRRES   = 0x0004, /* BLTH state at resume */
154         TP_ACPI_WGSV_STATE_BLTHBIOSOFF  = 0x0008, /* BLTH disabled in BIOS */
155         TP_ACPI_WGSV_STATE_UWBEXIST     = 0x0010, /* UWB hw available */
156         TP_ACPI_WGSV_STATE_UWBPWR       = 0x0020, /* UWB radio enabled */
157 };
158 
159 /* HKEY events */
160 enum tpacpi_hkey_event_t {
161         /* Hotkey-related */
162         TP_HKEY_EV_HOTKEY_BASE          = 0x1001, /* first hotkey (FN+F1) */
163         TP_HKEY_EV_BRGHT_UP             = 0x1010, /* Brightness up */
164         TP_HKEY_EV_BRGHT_DOWN           = 0x1011, /* Brightness down */
165         TP_HKEY_EV_VOL_UP               = 0x1015, /* Volume up or unmute */
166         TP_HKEY_EV_VOL_DOWN             = 0x1016, /* Volume down or unmute */
167         TP_HKEY_EV_VOL_MUTE             = 0x1017, /* Mixer output mute */
168 
169         /* Reasons for waking up from S3/S4 */
170         TP_HKEY_EV_WKUP_S3_UNDOCK       = 0x2304, /* undock requested, S3 */
171         TP_HKEY_EV_WKUP_S4_UNDOCK       = 0x2404, /* undock requested, S4 */
172         TP_HKEY_EV_WKUP_S3_BAYEJ        = 0x2305, /* bay ejection req, S3 */
173         TP_HKEY_EV_WKUP_S4_BAYEJ        = 0x2405, /* bay ejection req, S4 */
174         TP_HKEY_EV_WKUP_S3_BATLOW       = 0x2313, /* battery empty, S3 */
175         TP_HKEY_EV_WKUP_S4_BATLOW       = 0x2413, /* battery empty, S4 */
176 
177         /* Auto-sleep after eject request */
178         TP_HKEY_EV_BAYEJ_ACK            = 0x3003, /* bay ejection complete */
179         TP_HKEY_EV_UNDOCK_ACK           = 0x4003, /* undock complete */
180 
181         /* Misc bay events */
182         TP_HKEY_EV_OPTDRV_EJ            = 0x3006, /* opt. drive tray ejected */
183         TP_HKEY_EV_HOTPLUG_DOCK         = 0x4010, /* docked into hotplug dock
184                                                      or port replicator */
185         TP_HKEY_EV_HOTPLUG_UNDOCK       = 0x4011, /* undocked from hotplug
186                                                      dock or port replicator */
187 
188         /* User-interface events */
189         TP_HKEY_EV_LID_CLOSE            = 0x5001, /* laptop lid closed */
190         TP_HKEY_EV_LID_OPEN             = 0x5002, /* laptop lid opened */
191         TP_HKEY_EV_TABLET_TABLET        = 0x5009, /* tablet swivel up */
192         TP_HKEY_EV_TABLET_NOTEBOOK      = 0x500a, /* tablet swivel down */
193         TP_HKEY_EV_PEN_INSERTED         = 0x500b, /* tablet pen inserted */
194         TP_HKEY_EV_PEN_REMOVED          = 0x500c, /* tablet pen removed */
195         TP_HKEY_EV_BRGHT_CHANGED        = 0x5010, /* backlight control event */
196 
197         /* Key-related user-interface events */
198         TP_HKEY_EV_KEY_NUMLOCK          = 0x6000, /* NumLock key pressed */
199         TP_HKEY_EV_KEY_FN               = 0x6005, /* Fn key pressed? E420 */
200         TP_HKEY_EV_KEY_FN_ESC           = 0x6060, /* Fn+Esc key pressed X240 */
201 
202         /* Thermal events */
203         TP_HKEY_EV_ALARM_BAT_HOT        = 0x6011, /* battery too hot */
204         TP_HKEY_EV_ALARM_BAT_XHOT       = 0x6012, /* battery critically hot */
205         TP_HKEY_EV_ALARM_SENSOR_HOT     = 0x6021, /* sensor too hot */
206         TP_HKEY_EV_ALARM_SENSOR_XHOT    = 0x6022, /* sensor critically hot */
207         TP_HKEY_EV_THM_TABLE_CHANGED    = 0x6030, /* thermal table changed */
208 
209         /* AC-related events */
210         TP_HKEY_EV_AC_CHANGED           = 0x6040, /* AC status changed */
211 
212         /* Misc */
213         TP_HKEY_EV_RFKILL_CHANGED       = 0x7000, /* rfkill switch changed */
214 };
215 
216 /****************************************************************************
217  * Main driver
218  */
219 
220 #define TPACPI_NAME "thinkpad"
221 #define TPACPI_DESC "ThinkPad ACPI Extras"
222 #define TPACPI_FILE TPACPI_NAME "_acpi"
223 #define TPACPI_URL "http://ibm-acpi.sf.net/"
224 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
225 
226 #define TPACPI_PROC_DIR "ibm"
227 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
228 #define TPACPI_DRVR_NAME TPACPI_FILE
229 #define TPACPI_DRVR_SHORTNAME "tpacpi"
230 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
231 
232 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
233 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
234 
235 #define TPACPI_MAX_ACPI_ARGS 3
236 
237 /* Debugging printk groups */
238 #define TPACPI_DBG_ALL          0xffff
239 #define TPACPI_DBG_DISCLOSETASK 0x8000
240 #define TPACPI_DBG_INIT         0x0001
241 #define TPACPI_DBG_EXIT         0x0002
242 #define TPACPI_DBG_RFKILL       0x0004
243 #define TPACPI_DBG_HKEY         0x0008
244 #define TPACPI_DBG_FAN          0x0010
245 #define TPACPI_DBG_BRGHT        0x0020
246 #define TPACPI_DBG_MIXER        0x0040
247 
248 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
249 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
250 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
251 
252 
253 /****************************************************************************
254  * Driver-wide structs and misc. variables
255  */
256 
257 struct ibm_struct;
258 
259 struct tp_acpi_drv_struct {
260         const struct acpi_device_id *hid;
261         struct acpi_driver *driver;
262 
263         void (*notify) (struct ibm_struct *, u32);
264         acpi_handle *handle;
265         u32 type;
266         struct acpi_device *device;
267 };
268 
269 struct ibm_struct {
270         char *name;
271 
272         int (*read) (struct seq_file *);
273         int (*write) (char *);
274         void (*exit) (void);
275         void (*resume) (void);
276         void (*suspend) (void);
277         void (*shutdown) (void);
278 
279         struct list_head all_drivers;
280 
281         struct tp_acpi_drv_struct *acpi;
282 
283         struct {
284                 u8 acpi_driver_registered:1;
285                 u8 acpi_notify_installed:1;
286                 u8 proc_created:1;
287                 u8 init_called:1;
288                 u8 experimental:1;
289         } flags;
290 };
291 
292 struct ibm_init_struct {
293         char param[32];
294 
295         int (*init) (struct ibm_init_struct *);
296         umode_t base_procfs_mode;
297         struct ibm_struct *data;
298 };
299 
300 static struct {
301         u32 bluetooth:1;
302         u32 hotkey:1;
303         u32 hotkey_mask:1;
304         u32 hotkey_wlsw:1;
305         u32 hotkey_tablet:1;
306         u32 kbdlight:1;
307         u32 light:1;
308         u32 light_status:1;
309         u32 bright_acpimode:1;
310         u32 bright_unkfw:1;
311         u32 wan:1;
312         u32 uwb:1;
313         u32 fan_ctrl_status_undef:1;
314         u32 second_fan:1;
315         u32 beep_needs_two_args:1;
316         u32 mixer_no_level_control:1;
317         u32 input_device_registered:1;
318         u32 platform_drv_registered:1;
319         u32 platform_drv_attrs_registered:1;
320         u32 sensors_pdrv_registered:1;
321         u32 sensors_pdrv_attrs_registered:1;
322         u32 sensors_pdev_attrs_registered:1;
323         u32 hotkey_poll_active:1;
324         u32 has_adaptive_kbd:1;
325 } tp_features;
326 
327 static struct {
328         u16 hotkey_mask_ff:1;
329         u16 volume_ctrl_forbidden:1;
330 } tp_warned;
331 
332 struct thinkpad_id_data {
333         unsigned int vendor;    /* ThinkPad vendor:
334                                  * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
335 
336         char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
337         char *ec_version_str;   /* Something like 1ZHT51WW-1.04a */
338 
339         u16 bios_model;         /* 1Y = 0x5931, 0 = unknown */
340         u16 ec_model;
341         u16 bios_release;       /* 1ZETK1WW = 0x314b, 0 = unknown */
342         u16 ec_release;
343 
344         char *model_str;        /* ThinkPad T43 */
345         char *nummodel_str;     /* 9384A9C for a 9384-A9C model */
346 };
347 static struct thinkpad_id_data thinkpad_id;
348 
349 static enum {
350         TPACPI_LIFE_INIT = 0,
351         TPACPI_LIFE_RUNNING,
352         TPACPI_LIFE_EXITING,
353 } tpacpi_lifecycle;
354 
355 static int experimental;
356 static u32 dbg_level;
357 
358 static struct workqueue_struct *tpacpi_wq;
359 
360 enum led_status_t {
361         TPACPI_LED_OFF = 0,
362         TPACPI_LED_ON,
363         TPACPI_LED_BLINK,
364 };
365 
366 /* Special LED class that can defer work */
367 struct tpacpi_led_classdev {
368         struct led_classdev led_classdev;
369         struct work_struct work;
370         enum led_status_t new_state;
371         int led;
372 };
373 
374 /* brightness level capabilities */
375 static unsigned int bright_maxlvl;      /* 0 = unknown */
376 
377 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
378 static int dbg_wlswemul;
379 static bool tpacpi_wlsw_emulstate;
380 static int dbg_bluetoothemul;
381 static bool tpacpi_bluetooth_emulstate;
382 static int dbg_wwanemul;
383 static bool tpacpi_wwan_emulstate;
384 static int dbg_uwbemul;
385 static bool tpacpi_uwb_emulstate;
386 #endif
387 
388 
389 /*************************************************************************
390  *  Debugging helpers
391  */
392 
393 #define dbg_printk(a_dbg_level, format, arg...)                         \
394 do {                                                                    \
395         if (dbg_level & (a_dbg_level))                                  \
396                 printk(KERN_DEBUG pr_fmt("%s: " format),                \
397                        __func__, ##arg);                                \
398 } while (0)
399 
400 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
401 #define vdbg_printk dbg_printk
402 static const char *str_supported(int is_supported);
403 #else
404 static inline const char *str_supported(int is_supported) { return ""; }
405 #define vdbg_printk(a_dbg_level, format, arg...)        \
406         do { if (0) no_printk(format, ##arg); } while (0)
407 #endif
408 
409 static void tpacpi_log_usertask(const char * const what)
410 {
411         printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
412                what, task_tgid_vnr(current));
413 }
414 
415 #define tpacpi_disclose_usertask(what, format, arg...)                  \
416 do {                                                                    \
417         if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) &&           \
418                      (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) {      \
419                 printk(KERN_DEBUG pr_fmt("%s: PID %d: " format),        \
420                        what, task_tgid_vnr(current), ## arg);           \
421         }                                                               \
422 } while (0)
423 
424 /*
425  * Quirk handling helpers
426  *
427  * ThinkPad IDs and versions seen in the field so far
428  * are two-characters from the set [0-9A-Z], i.e. base 36.
429  *
430  * We use values well outside that range as specials.
431  */
432 
433 #define TPACPI_MATCH_ANY                0xffffU
434 #define TPACPI_MATCH_UNKNOWN            0U
435 
436 /* TPID('1', 'Y') == 0x5931 */
437 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
438 
439 #define TPACPI_Q_IBM(__id1, __id2, __quirk)     \
440         { .vendor = PCI_VENDOR_ID_IBM,          \
441           .bios = TPID(__id1, __id2),           \
442           .ec = TPACPI_MATCH_ANY,               \
443           .quirks = (__quirk) }
444 
445 #define TPACPI_Q_LNV(__id1, __id2, __quirk)     \
446         { .vendor = PCI_VENDOR_ID_LENOVO,       \
447           .bios = TPID(__id1, __id2),           \
448           .ec = TPACPI_MATCH_ANY,               \
449           .quirks = (__quirk) }
450 
451 #define TPACPI_QEC_LNV(__id1, __id2, __quirk)   \
452         { .vendor = PCI_VENDOR_ID_LENOVO,       \
453           .bios = TPACPI_MATCH_ANY,             \
454           .ec = TPID(__id1, __id2),             \
455           .quirks = (__quirk) }
456 
457 struct tpacpi_quirk {
458         unsigned int vendor;
459         u16 bios;
460         u16 ec;
461         unsigned long quirks;
462 };
463 
464 /**
465  * tpacpi_check_quirks() - search BIOS/EC version on a list
466  * @qlist:              array of &struct tpacpi_quirk
467  * @qlist_size:         number of elements in @qlist
468  *
469  * Iterates over a quirks list until one is found that matches the
470  * ThinkPad's vendor, BIOS and EC model.
471  *
472  * Returns 0 if nothing matches, otherwise returns the quirks field of
473  * the matching &struct tpacpi_quirk entry.
474  *
475  * The match criteria is: vendor, ec and bios much match.
476  */
477 static unsigned long __init tpacpi_check_quirks(
478                         const struct tpacpi_quirk *qlist,
479                         unsigned int qlist_size)
480 {
481         while (qlist_size) {
482                 if ((qlist->vendor == thinkpad_id.vendor ||
483                                 qlist->vendor == TPACPI_MATCH_ANY) &&
484                     (qlist->bios == thinkpad_id.bios_model ||
485                                 qlist->bios == TPACPI_MATCH_ANY) &&
486                     (qlist->ec == thinkpad_id.ec_model ||
487                                 qlist->ec == TPACPI_MATCH_ANY))
488                         return qlist->quirks;
489 
490                 qlist_size--;
491                 qlist++;
492         }
493         return 0;
494 }
495 
496 static inline bool __pure __init tpacpi_is_lenovo(void)
497 {
498         return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
499 }
500 
501 static inline bool __pure __init tpacpi_is_ibm(void)
502 {
503         return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
504 }
505 
506 /****************************************************************************
507  ****************************************************************************
508  *
509  * ACPI Helpers and device model
510  *
511  ****************************************************************************
512  ****************************************************************************/
513 
514 /*************************************************************************
515  * ACPI basic handles
516  */
517 
518 static acpi_handle root_handle;
519 static acpi_handle ec_handle;
520 
521 #define TPACPI_HANDLE(object, parent, paths...)                 \
522         static acpi_handle  object##_handle;                    \
523         static const acpi_handle * const object##_parent __initconst =  \
524                                                 &parent##_handle; \
525         static char *object##_paths[] __initdata = { paths }
526 
527 TPACPI_HANDLE(ecrd, ec, "ECRD");        /* 570 */
528 TPACPI_HANDLE(ecwr, ec, "ECWR");        /* 570 */
529 
530 TPACPI_HANDLE(cmos, root, "\\UCMS",     /* R50, R50e, R50p, R51, */
531                                         /* T4x, X31, X40 */
532            "\\CMOS",            /* A3x, G4x, R32, T23, T30, X22-24, X30 */
533            "\\CMS",             /* R40, R40e */
534            );                   /* all others */
535 
536 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY",   /* 600e/x, 770e, 770x */
537            "^HKEY",             /* R30, R31 */
538            "HKEY",              /* all others */
539            );                   /* 570 */
540 
541 /*************************************************************************
542  * ACPI helpers
543  */
544 
545 static int acpi_evalf(acpi_handle handle,
546                       int *res, char *method, char *fmt, ...)
547 {
548         char *fmt0 = fmt;
549         struct acpi_object_list params;
550         union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
551         struct acpi_buffer result, *resultp;
552         union acpi_object out_obj;
553         acpi_status status;
554         va_list ap;
555         char res_type;
556         int success;
557         int quiet;
558 
559         if (!*fmt) {
560                 pr_err("acpi_evalf() called with empty format\n");
561                 return 0;
562         }
563 
564         if (*fmt == 'q') {
565                 quiet = 1;
566                 fmt++;
567         } else
568                 quiet = 0;
569 
570         res_type = *(fmt++);
571 
572         params.count = 0;
573         params.pointer = &in_objs[0];
574 
575         va_start(ap, fmt);
576         while (*fmt) {
577                 char c = *(fmt++);
578                 switch (c) {
579                 case 'd':       /* int */
580                         in_objs[params.count].integer.value = va_arg(ap, int);
581                         in_objs[params.count++].type = ACPI_TYPE_INTEGER;
582                         break;
583                         /* add more types as needed */
584                 default:
585                         pr_err("acpi_evalf() called "
586                                "with invalid format character '%c'\n", c);
587                         va_end(ap);
588                         return 0;
589                 }
590         }
591         va_end(ap);
592 
593         if (res_type != 'v') {
594                 result.length = sizeof(out_obj);
595                 result.pointer = &out_obj;
596                 resultp = &result;
597         } else
598                 resultp = NULL;
599 
600         status = acpi_evaluate_object(handle, method, &params, resultp);
601 
602         switch (res_type) {
603         case 'd':               /* int */
604                 success = (status == AE_OK &&
605                            out_obj.type == ACPI_TYPE_INTEGER);
606                 if (success && res)
607                         *res = out_obj.integer.value;
608                 break;
609         case 'v':               /* void */
610                 success = status == AE_OK;
611                 break;
612                 /* add more types as needed */
613         default:
614                 pr_err("acpi_evalf() called "
615                        "with invalid format character '%c'\n", res_type);
616                 return 0;
617         }
618 
619         if (!success && !quiet)
620                 pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
621                        method, fmt0, acpi_format_exception(status));
622 
623         return success;
624 }
625 
626 static int acpi_ec_read(int i, u8 *p)
627 {
628         int v;
629 
630         if (ecrd_handle) {
631                 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
632                         return 0;
633                 *p = v;
634         } else {
635                 if (ec_read(i, p) < 0)
636                         return 0;
637         }
638 
639         return 1;
640 }
641 
642 static int acpi_ec_write(int i, u8 v)
643 {
644         if (ecwr_handle) {
645                 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
646                         return 0;
647         } else {
648                 if (ec_write(i, v) < 0)
649                         return 0;
650         }
651 
652         return 1;
653 }
654 
655 static int issue_thinkpad_cmos_command(int cmos_cmd)
656 {
657         if (!cmos_handle)
658                 return -ENXIO;
659 
660         if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
661                 return -EIO;
662 
663         return 0;
664 }
665 
666 /*************************************************************************
667  * ACPI device model
668  */
669 
670 #define TPACPI_ACPIHANDLE_INIT(object) \
671         drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
672                 object##_paths, ARRAY_SIZE(object##_paths))
673 
674 static void __init drv_acpi_handle_init(const char *name,
675                            acpi_handle *handle, const acpi_handle parent,
676                            char **paths, const int num_paths)
677 {
678         int i;
679         acpi_status status;
680 
681         vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
682                 name);
683 
684         for (i = 0; i < num_paths; i++) {
685                 status = acpi_get_handle(parent, paths[i], handle);
686                 if (ACPI_SUCCESS(status)) {
687                         dbg_printk(TPACPI_DBG_INIT,
688                                    "Found ACPI handle %s for %s\n",
689                                    paths[i], name);
690                         return;
691                 }
692         }
693 
694         vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
695                     name);
696         *handle = NULL;
697 }
698 
699 static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
700                         u32 level, void *context, void **return_value)
701 {
702         struct acpi_device *dev;
703         if (!strcmp(context, "video")) {
704                 if (acpi_bus_get_device(handle, &dev))
705                         return AE_OK;
706                 if (strcmp(ACPI_VIDEO_HID, acpi_device_hid(dev)))
707                         return AE_OK;
708         }
709 
710         *(acpi_handle *)return_value = handle;
711 
712         return AE_CTRL_TERMINATE;
713 }
714 
715 static void __init tpacpi_acpi_handle_locate(const char *name,
716                 const char *hid,
717                 acpi_handle *handle)
718 {
719         acpi_status status;
720         acpi_handle device_found;
721 
722         BUG_ON(!name || !handle);
723         vdbg_printk(TPACPI_DBG_INIT,
724                         "trying to locate ACPI handle for %s, using HID %s\n",
725                         name, hid ? hid : "NULL");
726 
727         memset(&device_found, 0, sizeof(device_found));
728         status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
729                                   (void *)name, &device_found);
730 
731         *handle = NULL;
732 
733         if (ACPI_SUCCESS(status)) {
734                 *handle = device_found;
735                 dbg_printk(TPACPI_DBG_INIT,
736                            "Found ACPI handle for %s\n", name);
737         } else {
738                 vdbg_printk(TPACPI_DBG_INIT,
739                             "Could not locate an ACPI handle for %s: %s\n",
740                             name, acpi_format_exception(status));
741         }
742 }
743 
744 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
745 {
746         struct ibm_struct *ibm = data;
747 
748         if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
749                 return;
750 
751         if (!ibm || !ibm->acpi || !ibm->acpi->notify)
752                 return;
753 
754         ibm->acpi->notify(ibm, event);
755 }
756 
757 static int __init setup_acpi_notify(struct ibm_struct *ibm)
758 {
759         acpi_status status;
760         int rc;
761 
762         BUG_ON(!ibm->acpi);
763 
764         if (!*ibm->acpi->handle)
765                 return 0;
766 
767         vdbg_printk(TPACPI_DBG_INIT,
768                 "setting up ACPI notify for %s\n", ibm->name);
769 
770         rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
771         if (rc < 0) {
772                 pr_err("acpi_bus_get_device(%s) failed: %d\n", ibm->name, rc);
773                 return -ENODEV;
774         }
775 
776         ibm->acpi->device->driver_data = ibm;
777         sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
778                 TPACPI_ACPI_EVENT_PREFIX,
779                 ibm->name);
780 
781         status = acpi_install_notify_handler(*ibm->acpi->handle,
782                         ibm->acpi->type, dispatch_acpi_notify, ibm);
783         if (ACPI_FAILURE(status)) {
784                 if (status == AE_ALREADY_EXISTS) {
785                         pr_notice("another device driver is already "
786                                   "handling %s events\n", ibm->name);
787                 } else {
788                         pr_err("acpi_install_notify_handler(%s) failed: %s\n",
789                                ibm->name, acpi_format_exception(status));
790                 }
791                 return -ENODEV;
792         }
793         ibm->flags.acpi_notify_installed = 1;
794         return 0;
795 }
796 
797 static int __init tpacpi_device_add(struct acpi_device *device)
798 {
799         return 0;
800 }
801 
802 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
803 {
804         int rc;
805 
806         dbg_printk(TPACPI_DBG_INIT,
807                 "registering %s as an ACPI driver\n", ibm->name);
808 
809         BUG_ON(!ibm->acpi);
810 
811         ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
812         if (!ibm->acpi->driver) {
813                 pr_err("failed to allocate memory for ibm->acpi->driver\n");
814                 return -ENOMEM;
815         }
816 
817         sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
818         ibm->acpi->driver->ids = ibm->acpi->hid;
819 
820         ibm->acpi->driver->ops.add = &tpacpi_device_add;
821 
822         rc = acpi_bus_register_driver(ibm->acpi->driver);
823         if (rc < 0) {
824                 pr_err("acpi_bus_register_driver(%s) failed: %d\n",
825                        ibm->name, rc);
826                 kfree(ibm->acpi->driver);
827                 ibm->acpi->driver = NULL;
828         } else if (!rc)
829                 ibm->flags.acpi_driver_registered = 1;
830 
831         return rc;
832 }
833 
834 
835 /****************************************************************************
836  ****************************************************************************
837  *
838  * Procfs Helpers
839  *
840  ****************************************************************************
841  ****************************************************************************/
842 
843 static int dispatch_proc_show(struct seq_file *m, void *v)
844 {
845         struct ibm_struct *ibm = m->private;
846 
847         if (!ibm || !ibm->read)
848                 return -EINVAL;
849         return ibm->read(m);
850 }
851 
852 static int dispatch_proc_open(struct inode *inode, struct file *file)
853 {
854         return single_open(file, dispatch_proc_show, PDE_DATA(inode));
855 }
856 
857 static ssize_t dispatch_proc_write(struct file *file,
858                         const char __user *userbuf,
859                         size_t count, loff_t *pos)
860 {
861         struct ibm_struct *ibm = PDE_DATA(file_inode(file));
862         char *kernbuf;
863         int ret;
864 
865         if (!ibm || !ibm->write)
866                 return -EINVAL;
867         if (count > PAGE_SIZE - 2)
868                 return -EINVAL;
869 
870         kernbuf = kmalloc(count + 2, GFP_KERNEL);
871         if (!kernbuf)
872                 return -ENOMEM;
873 
874         if (copy_from_user(kernbuf, userbuf, count)) {
875                 kfree(kernbuf);
876                 return -EFAULT;
877         }
878 
879         kernbuf[count] = 0;
880         strcat(kernbuf, ",");
881         ret = ibm->write(kernbuf);
882         if (ret == 0)
883                 ret = count;
884 
885         kfree(kernbuf);
886 
887         return ret;
888 }
889 
890 static const struct file_operations dispatch_proc_fops = {
891         .owner          = THIS_MODULE,
892         .open           = dispatch_proc_open,
893         .read           = seq_read,
894         .llseek         = seq_lseek,
895         .release        = single_release,
896         .write          = dispatch_proc_write,
897 };
898 
899 static char *next_cmd(char **cmds)
900 {
901         char *start = *cmds;
902         char *end;
903 
904         while ((end = strchr(start, ',')) && end == start)
905                 start = end + 1;
906 
907         if (!end)
908                 return NULL;
909 
910         *end = 0;
911         *cmds = end + 1;
912         return start;
913 }
914 
915 
916 /****************************************************************************
917  ****************************************************************************
918  *
919  * Device model: input, hwmon and platform
920  *
921  ****************************************************************************
922  ****************************************************************************/
923 
924 static struct platform_device *tpacpi_pdev;
925 static struct platform_device *tpacpi_sensors_pdev;
926 static struct device *tpacpi_hwmon;
927 static struct input_dev *tpacpi_inputdev;
928 static struct mutex tpacpi_inputdev_send_mutex;
929 static LIST_HEAD(tpacpi_all_drivers);
930 
931 #ifdef CONFIG_PM_SLEEP
932 static int tpacpi_suspend_handler(struct device *dev)
933 {
934         struct ibm_struct *ibm, *itmp;
935 
936         list_for_each_entry_safe(ibm, itmp,
937                                  &tpacpi_all_drivers,
938                                  all_drivers) {
939                 if (ibm->suspend)
940                         (ibm->suspend)();
941         }
942 
943         return 0;
944 }
945 
946 static int tpacpi_resume_handler(struct device *dev)
947 {
948         struct ibm_struct *ibm, *itmp;
949 
950         list_for_each_entry_safe(ibm, itmp,
951                                  &tpacpi_all_drivers,
952                                  all_drivers) {
953                 if (ibm->resume)
954                         (ibm->resume)();
955         }
956 
957         return 0;
958 }
959 #endif
960 
961 static SIMPLE_DEV_PM_OPS(tpacpi_pm,
962                          tpacpi_suspend_handler, tpacpi_resume_handler);
963 
964 static void tpacpi_shutdown_handler(struct platform_device *pdev)
965 {
966         struct ibm_struct *ibm, *itmp;
967 
968         list_for_each_entry_safe(ibm, itmp,
969                                  &tpacpi_all_drivers,
970                                  all_drivers) {
971                 if (ibm->shutdown)
972                         (ibm->shutdown)();
973         }
974 }
975 
976 static struct platform_driver tpacpi_pdriver = {
977         .driver = {
978                 .name = TPACPI_DRVR_NAME,
979                 .pm = &tpacpi_pm,
980         },
981         .shutdown = tpacpi_shutdown_handler,
982 };
983 
984 static struct platform_driver tpacpi_hwmon_pdriver = {
985         .driver = {
986                 .name = TPACPI_HWMON_DRVR_NAME,
987         },
988 };
989 
990 /*************************************************************************
991  * sysfs support helpers
992  */
993 
994 struct attribute_set {
995         unsigned int members, max_members;
996         struct attribute_group group;
997 };
998 
999 struct attribute_set_obj {
1000         struct attribute_set s;
1001         struct attribute *a;
1002 } __attribute__((packed));
1003 
1004 static struct attribute_set *create_attr_set(unsigned int max_members,
1005                                                 const char *name)
1006 {
1007         struct attribute_set_obj *sobj;
1008 
1009         if (max_members == 0)
1010                 return NULL;
1011 
1012         /* Allocates space for implicit NULL at the end too */
1013         sobj = kzalloc(sizeof(struct attribute_set_obj) +
1014                     max_members * sizeof(struct attribute *),
1015                     GFP_KERNEL);
1016         if (!sobj)
1017                 return NULL;
1018         sobj->s.max_members = max_members;
1019         sobj->s.group.attrs = &sobj->a;
1020         sobj->s.group.name = name;
1021 
1022         return &sobj->s;
1023 }
1024 
1025 #define destroy_attr_set(_set) \
1026         kfree(_set);
1027 
1028 /* not multi-threaded safe, use it in a single thread per set */
1029 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1030 {
1031         if (!s || !attr)
1032                 return -EINVAL;
1033 
1034         if (s->members >= s->max_members)
1035                 return -ENOMEM;
1036 
1037         s->group.attrs[s->members] = attr;
1038         s->members++;
1039 
1040         return 0;
1041 }
1042 
1043 static int add_many_to_attr_set(struct attribute_set *s,
1044                         struct attribute **attr,
1045                         unsigned int count)
1046 {
1047         int i, res;
1048 
1049         for (i = 0; i < count; i++) {
1050                 res = add_to_attr_set(s, attr[i]);
1051                 if (res)
1052                         return res;
1053         }
1054 
1055         return 0;
1056 }
1057 
1058 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1059 {
1060         sysfs_remove_group(kobj, &s->group);
1061         destroy_attr_set(s);
1062 }
1063 
1064 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1065         sysfs_create_group(_kobj, &_attr_set->group)
1066 
1067 static int parse_strtoul(const char *buf,
1068                 unsigned long max, unsigned long *value)
1069 {
1070         char *endp;
1071 
1072         *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1073         endp = skip_spaces(endp);
1074         if (*endp || *value > max)
1075                 return -EINVAL;
1076 
1077         return 0;
1078 }
1079 
1080 static void tpacpi_disable_brightness_delay(void)
1081 {
1082         if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1083                 pr_notice("ACPI backlight control delay disabled\n");
1084 }
1085 
1086 static void printk_deprecated_attribute(const char * const what,
1087                                         const char * const details)
1088 {
1089         tpacpi_log_usertask("deprecated sysfs attribute");
1090         pr_warn("WARNING: sysfs attribute %s is deprecated and "
1091                 "will be removed. %s\n",
1092                 what, details);
1093 }
1094 
1095 /*************************************************************************
1096  * rfkill and radio control support helpers
1097  */
1098 
1099 /*
1100  * ThinkPad-ACPI firmware handling model:
1101  *
1102  * WLSW (master wireless switch) is event-driven, and is common to all
1103  * firmware-controlled radios.  It cannot be controlled, just monitored,
1104  * as expected.  It overrides all radio state in firmware
1105  *
1106  * The kernel, a masked-off hotkey, and WLSW can change the radio state
1107  * (TODO: verify how WLSW interacts with the returned radio state).
1108  *
1109  * The only time there are shadow radio state changes, is when
1110  * masked-off hotkeys are used.
1111  */
1112 
1113 /*
1114  * Internal driver API for radio state:
1115  *
1116  * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1117  * bool: true means radio blocked (off)
1118  */
1119 enum tpacpi_rfkill_state {
1120         TPACPI_RFK_RADIO_OFF = 0,
1121         TPACPI_RFK_RADIO_ON
1122 };
1123 
1124 /* rfkill switches */
1125 enum tpacpi_rfk_id {
1126         TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1127         TPACPI_RFK_WWAN_SW_ID,
1128         TPACPI_RFK_UWB_SW_ID,
1129         TPACPI_RFK_SW_MAX
1130 };
1131 
1132 static const char *tpacpi_rfkill_names[] = {
1133         [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1134         [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1135         [TPACPI_RFK_UWB_SW_ID] = "uwb",
1136         [TPACPI_RFK_SW_MAX] = NULL
1137 };
1138 
1139 /* ThinkPad-ACPI rfkill subdriver */
1140 struct tpacpi_rfk {
1141         struct rfkill *rfkill;
1142         enum tpacpi_rfk_id id;
1143         const struct tpacpi_rfk_ops *ops;
1144 };
1145 
1146 struct tpacpi_rfk_ops {
1147         /* firmware interface */
1148         int (*get_status)(void);
1149         int (*set_status)(const enum tpacpi_rfkill_state);
1150 };
1151 
1152 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1153 
1154 /* Query FW and update rfkill sw state for a given rfkill switch */
1155 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1156 {
1157         int status;
1158 
1159         if (!tp_rfk)
1160                 return -ENODEV;
1161 
1162         status = (tp_rfk->ops->get_status)();
1163         if (status < 0)
1164                 return status;
1165 
1166         rfkill_set_sw_state(tp_rfk->rfkill,
1167                             (status == TPACPI_RFK_RADIO_OFF));
1168 
1169         return status;
1170 }
1171 
1172 /* Query FW and update rfkill sw state for all rfkill switches */
1173 static void tpacpi_rfk_update_swstate_all(void)
1174 {
1175         unsigned int i;
1176 
1177         for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1178                 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1179 }
1180 
1181 /*
1182  * Sync the HW-blocking state of all rfkill switches,
1183  * do notice it causes the rfkill core to schedule uevents
1184  */
1185 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1186 {
1187         unsigned int i;
1188         struct tpacpi_rfk *tp_rfk;
1189 
1190         for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1191                 tp_rfk = tpacpi_rfkill_switches[i];
1192                 if (tp_rfk) {
1193                         if (rfkill_set_hw_state(tp_rfk->rfkill,
1194                                                 blocked)) {
1195                                 /* ignore -- we track sw block */
1196                         }
1197                 }
1198         }
1199 }
1200 
1201 /* Call to get the WLSW state from the firmware */
1202 static int hotkey_get_wlsw(void);
1203 
1204 /* Call to query WLSW state and update all rfkill switches */
1205 static bool tpacpi_rfk_check_hwblock_state(void)
1206 {
1207         int res = hotkey_get_wlsw();
1208         int hw_blocked;
1209 
1210         /* When unknown or unsupported, we have to assume it is unblocked */
1211         if (res < 0)
1212                 return false;
1213 
1214         hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1215         tpacpi_rfk_update_hwblock_state(hw_blocked);
1216 
1217         return hw_blocked;
1218 }
1219 
1220 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1221 {
1222         struct tpacpi_rfk *tp_rfk = data;
1223         int res;
1224 
1225         dbg_printk(TPACPI_DBG_RFKILL,
1226                    "request to change radio state to %s\n",
1227                    blocked ? "blocked" : "unblocked");
1228 
1229         /* try to set radio state */
1230         res = (tp_rfk->ops->set_status)(blocked ?
1231                                 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1232 
1233         /* and update the rfkill core with whatever the FW really did */
1234         tpacpi_rfk_update_swstate(tp_rfk);
1235 
1236         return (res < 0) ? res : 0;
1237 }
1238 
1239 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1240         .set_block = tpacpi_rfk_hook_set_block,
1241 };
1242 
1243 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1244                         const struct tpacpi_rfk_ops *tp_rfkops,
1245                         const enum rfkill_type rfktype,
1246                         const char *name,
1247                         const bool set_default)
1248 {
1249         struct tpacpi_rfk *atp_rfk;
1250         int res;
1251         bool sw_state = false;
1252         bool hw_state;
1253         int sw_status;
1254 
1255         BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1256 
1257         atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1258         if (atp_rfk)
1259                 atp_rfk->rfkill = rfkill_alloc(name,
1260                                                 &tpacpi_pdev->dev,
1261                                                 rfktype,
1262                                                 &tpacpi_rfk_rfkill_ops,
1263                                                 atp_rfk);
1264         if (!atp_rfk || !atp_rfk->rfkill) {
1265                 pr_err("failed to allocate memory for rfkill class\n");
1266                 kfree(atp_rfk);
1267                 return -ENOMEM;
1268         }
1269 
1270         atp_rfk->id = id;
1271         atp_rfk->ops = tp_rfkops;
1272 
1273         sw_status = (tp_rfkops->get_status)();
1274         if (sw_status < 0) {
1275                 pr_err("failed to read initial state for %s, error %d\n",
1276                        name, sw_status);
1277         } else {
1278                 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1279                 if (set_default) {
1280                         /* try to keep the initial state, since we ask the
1281                          * firmware to preserve it across S5 in NVRAM */
1282                         rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1283                 }
1284         }
1285         hw_state = tpacpi_rfk_check_hwblock_state();
1286         rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1287 
1288         res = rfkill_register(atp_rfk->rfkill);
1289         if (res < 0) {
1290                 pr_err("failed to register %s rfkill switch: %d\n", name, res);
1291                 rfkill_destroy(atp_rfk->rfkill);
1292                 kfree(atp_rfk);
1293                 return res;
1294         }
1295 
1296         tpacpi_rfkill_switches[id] = atp_rfk;
1297 
1298         pr_info("rfkill switch %s: radio is %sblocked\n",
1299                 name, (sw_state || hw_state) ? "" : "un");
1300         return 0;
1301 }
1302 
1303 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1304 {
1305         struct tpacpi_rfk *tp_rfk;
1306 
1307         BUG_ON(id >= TPACPI_RFK_SW_MAX);
1308 
1309         tp_rfk = tpacpi_rfkill_switches[id];
1310         if (tp_rfk) {
1311                 rfkill_unregister(tp_rfk->rfkill);
1312                 rfkill_destroy(tp_rfk->rfkill);
1313                 tpacpi_rfkill_switches[id] = NULL;
1314                 kfree(tp_rfk);
1315         }
1316 }
1317 
1318 static void printk_deprecated_rfkill_attribute(const char * const what)
1319 {
1320         printk_deprecated_attribute(what,
1321                         "Please switch to generic rfkill before year 2010");
1322 }
1323 
1324 /* sysfs <radio> enable ------------------------------------------------ */
1325 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1326                                             struct device_attribute *attr,
1327                                             char *buf)
1328 {
1329         int status;
1330 
1331         printk_deprecated_rfkill_attribute(attr->attr.name);
1332 
1333         /* This is in the ABI... */
1334         if (tpacpi_rfk_check_hwblock_state()) {
1335                 status = TPACPI_RFK_RADIO_OFF;
1336         } else {
1337                 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1338                 if (status < 0)
1339                         return status;
1340         }
1341 
1342         return snprintf(buf, PAGE_SIZE, "%d\n",
1343                         (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1344 }
1345 
1346 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1347                             struct device_attribute *attr,
1348                             const char *buf, size_t count)
1349 {
1350         unsigned long t;
1351         int res;
1352 
1353         printk_deprecated_rfkill_attribute(attr->attr.name);
1354 
1355         if (parse_strtoul(buf, 1, &t))
1356                 return -EINVAL;
1357 
1358         tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1359 
1360         /* This is in the ABI... */
1361         if (tpacpi_rfk_check_hwblock_state() && !!t)
1362                 return -EPERM;
1363 
1364         res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1365                                 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1366         tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1367 
1368         return (res < 0) ? res : count;
1369 }
1370 
1371 /* procfs -------------------------------------------------------------- */
1372 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1373 {
1374         if (id >= TPACPI_RFK_SW_MAX)
1375                 seq_printf(m, "status:\t\tnot supported\n");
1376         else {
1377                 int status;
1378 
1379                 /* This is in the ABI... */
1380                 if (tpacpi_rfk_check_hwblock_state()) {
1381                         status = TPACPI_RFK_RADIO_OFF;
1382                 } else {
1383                         status = tpacpi_rfk_update_swstate(
1384                                                 tpacpi_rfkill_switches[id]);
1385                         if (status < 0)
1386                                 return status;
1387                 }
1388 
1389                 seq_printf(m, "status:\t\t%s\n",
1390                                 (status == TPACPI_RFK_RADIO_ON) ?
1391                                         "enabled" : "disabled");
1392                 seq_printf(m, "commands:\tenable, disable\n");
1393         }
1394 
1395         return 0;
1396 }
1397 
1398 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1399 {
1400         char *cmd;
1401         int status = -1;
1402         int res = 0;
1403 
1404         if (id >= TPACPI_RFK_SW_MAX)
1405                 return -ENODEV;
1406 
1407         while ((cmd = next_cmd(&buf))) {
1408                 if (strlencmp(cmd, "enable") == 0)
1409                         status = TPACPI_RFK_RADIO_ON;
1410                 else if (strlencmp(cmd, "disable") == 0)
1411                         status = TPACPI_RFK_RADIO_OFF;
1412                 else
1413                         return -EINVAL;
1414         }
1415 
1416         if (status != -1) {
1417                 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1418                                 (status == TPACPI_RFK_RADIO_ON) ?
1419                                                 "enable" : "disable",
1420                                 tpacpi_rfkill_names[id]);
1421                 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1422                 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1423         }
1424 
1425         return res;
1426 }
1427 
1428 /*************************************************************************
1429  * thinkpad-acpi driver attributes
1430  */
1431 
1432 /* interface_version --------------------------------------------------- */
1433 static ssize_t tpacpi_driver_interface_version_show(
1434                                 struct device_driver *drv,
1435                                 char *buf)
1436 {
1437         return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1438 }
1439 
1440 static DRIVER_ATTR(interface_version, S_IRUGO,
1441                 tpacpi_driver_interface_version_show, NULL);
1442 
1443 /* debug_level --------------------------------------------------------- */
1444 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1445                                                 char *buf)
1446 {
1447         return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1448 }
1449 
1450 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1451                                                 const char *buf, size_t count)
1452 {
1453         unsigned long t;
1454 
1455         if (parse_strtoul(buf, 0xffff, &t))
1456                 return -EINVAL;
1457 
1458         dbg_level = t;
1459 
1460         return count;
1461 }
1462 
1463 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1464                 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1465 
1466 /* version ------------------------------------------------------------- */
1467 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1468                                                 char *buf)
1469 {
1470         return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1471                         TPACPI_DESC, TPACPI_VERSION);
1472 }
1473 
1474 static DRIVER_ATTR(version, S_IRUGO,
1475                 tpacpi_driver_version_show, NULL);
1476 
1477 /* --------------------------------------------------------------------- */
1478 
1479 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1480 
1481 /* wlsw_emulstate ------------------------------------------------------ */
1482 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1483                                                 char *buf)
1484 {
1485         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1486 }
1487 
1488 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1489                                                 const char *buf, size_t count)
1490 {
1491         unsigned long t;
1492 
1493         if (parse_strtoul(buf, 1, &t))
1494                 return -EINVAL;
1495 
1496         if (tpacpi_wlsw_emulstate != !!t) {
1497                 tpacpi_wlsw_emulstate = !!t;
1498                 tpacpi_rfk_update_hwblock_state(!t);    /* negative logic */
1499         }
1500 
1501         return count;
1502 }
1503 
1504 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1505                 tpacpi_driver_wlsw_emulstate_show,
1506                 tpacpi_driver_wlsw_emulstate_store);
1507 
1508 /* bluetooth_emulstate ------------------------------------------------- */
1509 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1510                                         struct device_driver *drv,
1511                                         char *buf)
1512 {
1513         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1514 }
1515 
1516 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1517                                         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         tpacpi_bluetooth_emulstate = !!t;
1526 
1527         return count;
1528 }
1529 
1530 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1531                 tpacpi_driver_bluetooth_emulstate_show,
1532                 tpacpi_driver_bluetooth_emulstate_store);
1533 
1534 /* wwan_emulstate ------------------------------------------------- */
1535 static ssize_t tpacpi_driver_wwan_emulstate_show(
1536                                         struct device_driver *drv,
1537                                         char *buf)
1538 {
1539         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1540 }
1541 
1542 static ssize_t tpacpi_driver_wwan_emulstate_store(
1543                                         struct device_driver *drv,
1544                                         const char *buf, size_t count)
1545 {
1546         unsigned long t;
1547 
1548         if (parse_strtoul(buf, 1, &t))
1549                 return -EINVAL;
1550 
1551         tpacpi_wwan_emulstate = !!t;
1552 
1553         return count;
1554 }
1555 
1556 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1557                 tpacpi_driver_wwan_emulstate_show,
1558                 tpacpi_driver_wwan_emulstate_store);
1559 
1560 /* uwb_emulstate ------------------------------------------------- */
1561 static ssize_t tpacpi_driver_uwb_emulstate_show(
1562                                         struct device_driver *drv,
1563                                         char *buf)
1564 {
1565         return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1566 }
1567 
1568 static ssize_t tpacpi_driver_uwb_emulstate_store(
1569                                         struct device_driver *drv,
1570                                         const char *buf, size_t count)
1571 {
1572         unsigned long t;
1573 
1574         if (parse_strtoul(buf, 1, &t))
1575                 return -EINVAL;
1576 
1577         tpacpi_uwb_emulstate = !!t;
1578 
1579         return count;
1580 }
1581 
1582 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1583                 tpacpi_driver_uwb_emulstate_show,
1584                 tpacpi_driver_uwb_emulstate_store);
1585 #endif
1586 
1587 /* --------------------------------------------------------------------- */
1588 
1589 static struct driver_attribute *tpacpi_driver_attributes[] = {
1590         &driver_attr_debug_level, &driver_attr_version,
1591         &driver_attr_interface_version,
1592 };
1593 
1594 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1595 {
1596         int i, res;
1597 
1598         i = 0;
1599         res = 0;
1600         while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1601                 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1602                 i++;
1603         }
1604 
1605 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1606         if (!res && dbg_wlswemul)
1607                 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1608         if (!res && dbg_bluetoothemul)
1609                 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1610         if (!res && dbg_wwanemul)
1611                 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1612         if (!res && dbg_uwbemul)
1613                 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1614 #endif
1615 
1616         return res;
1617 }
1618 
1619 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1620 {
1621         int i;
1622 
1623         for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1624                 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1625 
1626 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1627         driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1628         driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1629         driver_remove_file(drv, &driver_attr_wwan_emulstate);
1630         driver_remove_file(drv, &driver_attr_uwb_emulstate);
1631 #endif
1632 }
1633 
1634 /*************************************************************************
1635  * Firmware Data
1636  */
1637 
1638 /*
1639  * Table of recommended minimum BIOS versions
1640  *
1641  * Reasons for listing:
1642  *    1. Stable BIOS, listed because the unknown amount of
1643  *       bugs and bad ACPI behaviour on older versions
1644  *
1645  *    2. BIOS or EC fw with known bugs that trigger on Linux
1646  *
1647  *    3. BIOS with known reduced functionality in older versions
1648  *
1649  *  We recommend the latest BIOS and EC version.
1650  *  We only support the latest BIOS and EC fw version as a rule.
1651  *
1652  *  Sources: IBM ThinkPad Public Web Documents (update changelogs),
1653  *  Information from users in ThinkWiki
1654  *
1655  *  WARNING: we use this table also to detect that the machine is
1656  *  a ThinkPad in some cases, so don't remove entries lightly.
1657  */
1658 
1659 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2)          \
1660         { .vendor       = (__v),                        \
1661           .bios         = TPID(__id1, __id2),           \
1662           .ec           = TPACPI_MATCH_ANY,             \
1663           .quirks       = TPACPI_MATCH_ANY << 16        \
1664                           | (__bv1) << 8 | (__bv2) }
1665 
1666 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2,      \
1667                 __eid, __ev1, __ev2)                    \
1668         { .vendor       = (__v),                        \
1669           .bios         = TPID(__bid1, __bid2),         \
1670           .ec           = __eid,                        \
1671           .quirks       = (__ev1) << 24 | (__ev2) << 16 \
1672                           | (__bv1) << 8 | (__bv2) }
1673 
1674 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1675         TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1676 
1677 /* Outdated IBM BIOSes often lack the EC id string */
1678 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1679         TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2,        \
1680                 __bv1, __bv2, TPID(__id1, __id2),       \
1681                 __ev1, __ev2),                          \
1682         TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2,        \
1683                 __bv1, __bv2, TPACPI_MATCH_UNKNOWN,     \
1684                 __ev1, __ev2)
1685 
1686 /* Outdated IBM BIOSes often lack the EC id string */
1687 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2,           \
1688                 __eid1, __eid2, __ev1, __ev2)           \
1689         TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2,      \
1690                 __bv1, __bv2, TPID(__eid1, __eid2),     \
1691                 __ev1, __ev2),                          \
1692         TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2,      \
1693                 __bv1, __bv2, TPACPI_MATCH_UNKNOWN,     \
1694                 __ev1, __ev2)
1695 
1696 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1697         TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1698 
1699 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1700         TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2,     \
1701                 __bv1, __bv2, TPID(__id1, __id2),       \
1702                 __ev1, __ev2)
1703 
1704 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2,           \
1705                 __eid1, __eid2, __ev1, __ev2)           \
1706         TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2,   \
1707                 __bv1, __bv2, TPID(__eid1, __eid2),     \
1708                 __ev1, __ev2)
1709 
1710 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1711         /*  Numeric models ------------------ */
1712         /*      FW MODEL   BIOS VERS          */
1713         TPV_QI0('I', 'M',  '6', '5'),            /* 570 */
1714         TPV_QI0('I', 'U',  '2', '6'),            /* 570E */
1715         TPV_QI0('I', 'B',  '5', '4'),            /* 600 */
1716         TPV_QI0('I', 'H',  '4', '7'),            /* 600E */
1717         TPV_QI0('I', 'N',  '3', '6'),            /* 600E */
1718         TPV_QI0('I', 'T',  '5', '5'),            /* 600X */
1719         TPV_QI0('I', 'D',  '4', '8'),            /* 770, 770E, 770ED */
1720         TPV_QI0('I', 'I',  '4', '2'),            /* 770X */
1721         TPV_QI0('I', 'O',  '2', '3'),            /* 770Z */
1722 
1723         /* A-series ------------------------- */
1724         /*      FW MODEL   BIOS VERS  EC VERS */
1725         TPV_QI0('I', 'W',  '5', '9'),            /* A20m */
1726         TPV_QI0('I', 'V',  '6', '9'),            /* A20p */
1727         TPV_QI0('1', '',  '2', '6'),            /* A21e, A22e */
1728         TPV_QI0('K', 'U',  '3', '6'),            /* A21e */
1729         TPV_QI0('K', 'X',  '3', '6'),            /* A21m, A22m */
1730         TPV_QI0('K', 'Y',  '3', '8'),            /* A21p, A22p */
1731         TPV_QI0('1', 'B',  '1', '7'),            /* A22e */
1732         TPV_QI0('1', '3',  '2', ''),            /* A22m */
1733         TPV_QI0('1', 'E',  '7', '3'),            /* A30/p (0) */
1734         TPV_QI1('1', 'G',  '4', '1',  '1', '7'), /* A31/p (0) */
1735         TPV_QI1('1', 'N',  '1', '6',  '', '7'), /* A31/p (0) */
1736 
1737         /* G-series ------------------------- */
1738         /*      FW MODEL   BIOS VERS          */
1739         TPV_QI0('1', 'T',  'A', '6'),            /* G40 */
1740         TPV_QI0('1', 'X',  '5', '7'),            /* G41 */
1741 
1742         /* R-series, T-series --------------- */
1743         /*      FW MODEL   BIOS VERS  EC VERS */
1744         TPV_QI0('1', 'C',  'F', ''),            /* R30 */
1745         TPV_QI0('1', 'F',  'F', '1'),            /* R31 */
1746         TPV_QI0('1', 'M',  '9', '7'),            /* R32 */
1747         TPV_QI0('1', 'O',  '6', '1'),            /* R40 */
1748         TPV_QI0('1', 'P',  '6', '5'),            /* R40 */
1749         TPV_QI0('1', 'S',  '7', ''),            /* R40e */
1750         TPV_QI1('1', 'R',  'D', 'R',  '7', '1'), /* R50/p, R51,
1751                                                     T40/p, T41/p, T42/p (1) */
1752         TPV_QI1('1', 'V',  '7', '1',  '2', '8'), /* R50e, R51 (1) */
1753         TPV_QI1('7', '8',  '7', '1',  '', '6'), /* R51e (1) */
1754         TPV_QI1('7', '6',  '6', '9',  '1', '6'), /* R52 (1) */
1755         TPV_QI1('7', '',  '6', '9',  '2', '8'), /* R52, T43 (1) */
1756 
1757         TPV_QI0('I', 'Y',  '6', '1'),            /* T20 */
1758         TPV_QI0('K', 'Z',  '3', '4'),            /* T21 */
1759         TPV_QI0('1', '6',  '3', '2'),            /* T22 */
1760         TPV_QI1('1', 'A',  '6', '4',  '2', '3'), /* T23 (0) */
1761         TPV_QI1('1', 'I',  '7', '1',  '2', ''), /* T30 (0) */
1762         TPV_QI1('1', 'Y',  '6', '5',  '2', '9'), /* T43/p (1) */
1763 
1764         TPV_QL1('7', '9',  'E', '3',  '5', ''), /* T60/p */
1765         TPV_QL1('7', 'C',  'D', '2',  '2', '2'), /* R60, R60i */
1766         TPV_QL1('7', 'E',  'D', '',  '1', '5'), /* R60e, R60i */
1767 
1768         /*      BIOS FW    BIOS VERS  EC FW     EC VERS */
1769         TPV_QI2('1', 'W',  '9', '',  '1', 'V', '2', '8'), /* R50e (1) */
1770         TPV_QL2('7', 'I',  '3', '4',  '7', '9', '5', ''), /* T60/p wide */
1771 
1772         /* X-series ------------------------- */
1773         /*      FW MODEL   BIOS VERS  EC VERS */
1774         TPV_QI0('I', 'Z',  '9', 'D'),            /* X20, X21 */
1775         TPV_QI0('1', 'D',  '7', ''),            /* X22, X23, X24 */
1776         TPV_QI1('1', 'K',  '4', '8',  '1', '8'), /* X30 (0) */
1777         TPV_QI1('1', 'Q',  '9', '7',  '2', '3'), /* X31, X32 (0) */
1778         TPV_QI1('1', 'U',  'D', '3',  'B', '2'), /* X40 (0) */
1779         TPV_QI1('7', '4',  '6', '4',  '2', '7'), /* X41 (0) */
1780         TPV_QI1('7', '5',  '6', '',  '2', ''), /* X41t (0) */
1781 
1782         TPV_QL1('7', 'B',  'D', '7',  '4', ''), /* X60/s */
1783         TPV_QL1('7', 'J',  '3', '',  '1', '3'), /* X60t */
1784 
1785         /* (0) - older versions lack DMI EC fw string and functionality */
1786         /* (1) - older versions known to lack functionality */
1787 };
1788 
1789 #undef TPV_QL1
1790 #undef TPV_QL0
1791 #undef TPV_QI2
1792 #undef TPV_QI1
1793 #undef TPV_QI0
1794 #undef TPV_Q_X
1795 #undef TPV_Q
1796 
1797 static void __init tpacpi_check_outdated_fw(void)
1798 {
1799         unsigned long fwvers;
1800         u16 ec_version, bios_version;
1801 
1802         fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1803                                 ARRAY_SIZE(tpacpi_bios_version_qtable));
1804 
1805         if (!fwvers)
1806                 return;
1807 
1808         bios_version = fwvers & 0xffffU;
1809         ec_version = (fwvers >> 16) & 0xffffU;
1810 
1811         /* note that unknown versions are set to 0x0000 and we use that */
1812         if ((bios_version > thinkpad_id.bios_release) ||
1813             (ec_version > thinkpad_id.ec_release &&
1814                                 ec_version != TPACPI_MATCH_ANY)) {
1815                 /*
1816                  * The changelogs would let us track down the exact
1817                  * reason, but it is just too much of a pain to track
1818                  * it.  We only list BIOSes that are either really
1819                  * broken, or really stable to begin with, so it is
1820                  * best if the user upgrades the firmware anyway.
1821                  */
1822                 pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1823                 pr_warn("WARNING: This firmware may be missing critical bug "
1824                         "fixes and/or important features\n");
1825         }
1826 }
1827 
1828 static bool __init tpacpi_is_fw_known(void)
1829 {
1830         return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1831                         ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1832 }
1833 
1834 /****************************************************************************
1835  ****************************************************************************
1836  *
1837  * Subdrivers
1838  *
1839  ****************************************************************************
1840  ****************************************************************************/
1841 
1842 /*************************************************************************
1843  * thinkpad-acpi metadata subdriver
1844  */
1845 
1846 static int thinkpad_acpi_driver_read(struct seq_file *m)
1847 {
1848         seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1849         seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1850         return 0;
1851 }
1852 
1853 static struct ibm_struct thinkpad_acpi_driver_data = {
1854         .name = "driver",
1855         .read = thinkpad_acpi_driver_read,
1856 };
1857 
1858 /*************************************************************************
1859  * Hotkey subdriver
1860  */
1861 
1862 /*
1863  * ThinkPad firmware event model
1864  *
1865  * The ThinkPad firmware has two main event interfaces: normal ACPI
1866  * notifications (which follow the ACPI standard), and a private event
1867  * interface.
1868  *
1869  * The private event interface also issues events for the hotkeys.  As
1870  * the driver gained features, the event handling code ended up being
1871  * built around the hotkey subdriver.  This will need to be refactored
1872  * to a more formal event API eventually.
1873  *
1874  * Some "hotkeys" are actually supposed to be used as event reports,
1875  * such as "brightness has changed", "volume has changed", depending on
1876  * the ThinkPad model and how the firmware is operating.
1877  *
1878  * Unlike other classes, hotkey-class events have mask/unmask control on
1879  * non-ancient firmware.  However, how it behaves changes a lot with the
1880  * firmware model and version.
1881  */
1882 
1883 enum {  /* hot key scan codes (derived from ACPI DSDT) */
1884         TP_ACPI_HOTKEYSCAN_FNF1         = 0,
1885         TP_ACPI_HOTKEYSCAN_FNF2,
1886         TP_ACPI_HOTKEYSCAN_FNF3,
1887         TP_ACPI_HOTKEYSCAN_FNF4,
1888         TP_ACPI_HOTKEYSCAN_FNF5,
1889         TP_ACPI_HOTKEYSCAN_FNF6,
1890         TP_ACPI_HOTKEYSCAN_FNF7,
1891         TP_ACPI_HOTKEYSCAN_FNF8,
1892         TP_ACPI_HOTKEYSCAN_FNF9,
1893         TP_ACPI_HOTKEYSCAN_FNF10,
1894         TP_ACPI_HOTKEYSCAN_FNF11,
1895         TP_ACPI_HOTKEYSCAN_FNF12,
1896         TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1897         TP_ACPI_HOTKEYSCAN_FNINSERT,
1898         TP_ACPI_HOTKEYSCAN_FNDELETE,
1899         TP_ACPI_HOTKEYSCAN_FNHOME,
1900         TP_ACPI_HOTKEYSCAN_FNEND,
1901         TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1902         TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1903         TP_ACPI_HOTKEYSCAN_FNSPACE,
1904         TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1905         TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1906         TP_ACPI_HOTKEYSCAN_MUTE,
1907         TP_ACPI_HOTKEYSCAN_THINKPAD,
1908         TP_ACPI_HOTKEYSCAN_UNK1,
1909         TP_ACPI_HOTKEYSCAN_UNK2,
1910         TP_ACPI_HOTKEYSCAN_UNK3,
1911         TP_ACPI_HOTKEYSCAN_UNK4,
1912         TP_ACPI_HOTKEYSCAN_UNK5,
1913         TP_ACPI_HOTKEYSCAN_UNK6,
1914         TP_ACPI_HOTKEYSCAN_UNK7,
1915         TP_ACPI_HOTKEYSCAN_UNK8,
1916 
1917         TP_ACPI_HOTKEYSCAN_MUTE2,
1918         TP_ACPI_HOTKEYSCAN_BRIGHTNESS_ZERO,
1919         TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL,
1920         TP_ACPI_HOTKEYSCAN_CLOUD,
1921         TP_ACPI_HOTKEYSCAN_UNK9,
1922         TP_ACPI_HOTKEYSCAN_VOICE,
1923         TP_ACPI_HOTKEYSCAN_UNK10,
1924         TP_ACPI_HOTKEYSCAN_GESTURES,
1925         TP_ACPI_HOTKEYSCAN_UNK11,
1926         TP_ACPI_HOTKEYSCAN_UNK12,
1927         TP_ACPI_HOTKEYSCAN_UNK13,
1928         TP_ACPI_HOTKEYSCAN_CONFIG,
1929         TP_ACPI_HOTKEYSCAN_NEW_TAB,
1930         TP_ACPI_HOTKEYSCAN_RELOAD,
1931         TP_ACPI_HOTKEYSCAN_BACK,
1932         TP_ACPI_HOTKEYSCAN_MIC_DOWN,
1933         TP_ACPI_HOTKEYSCAN_MIC_UP,
1934         TP_ACPI_HOTKEYSCAN_MIC_CANCELLATION,
1935         TP_ACPI_HOTKEYSCAN_CAMERA_MODE,
1936         TP_ACPI_HOTKEYSCAN_ROTATE_DISPLAY,
1937 
1938         /* Hotkey keymap size */
1939         TPACPI_HOTKEY_MAP_LEN
1940 };
1941 
1942 enum {  /* Keys/events available through NVRAM polling */
1943         TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1944         TPACPI_HKEY_NVRAM_GOOD_MASK  = 0x00fb8000U,
1945 };
1946 
1947 enum {  /* Positions of some of the keys in hotkey masks */
1948         TP_ACPI_HKEY_DISPSWTCH_MASK     = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1949         TP_ACPI_HKEY_DISPXPAND_MASK     = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1950         TP_ACPI_HKEY_HIBERNATE_MASK     = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1951         TP_ACPI_HKEY_BRGHTUP_MASK       = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1952         TP_ACPI_HKEY_BRGHTDWN_MASK      = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1953         TP_ACPI_HKEY_THNKLGHT_MASK      = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1954         TP_ACPI_HKEY_ZOOM_MASK          = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1955         TP_ACPI_HKEY_VOLUP_MASK         = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1956         TP_ACPI_HKEY_VOLDWN_MASK        = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1957         TP_ACPI_HKEY_MUTE_MASK          = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1958         TP_ACPI_HKEY_THINKPAD_MASK      = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1959 };
1960 
1961 enum {  /* NVRAM to ACPI HKEY group map */
1962         TP_NVRAM_HKEY_GROUP_HK2         = TP_ACPI_HKEY_THINKPAD_MASK |
1963                                           TP_ACPI_HKEY_ZOOM_MASK |
1964                                           TP_ACPI_HKEY_DISPSWTCH_MASK |
1965                                           TP_ACPI_HKEY_HIBERNATE_MASK,
1966         TP_NVRAM_HKEY_GROUP_BRIGHTNESS  = TP_ACPI_HKEY_BRGHTUP_MASK |
1967                                           TP_ACPI_HKEY_BRGHTDWN_MASK,
1968         TP_NVRAM_HKEY_GROUP_VOLUME      = TP_ACPI_HKEY_VOLUP_MASK |
1969                                           TP_ACPI_HKEY_VOLDWN_MASK |
1970                                           TP_ACPI_HKEY_MUTE_MASK,
1971 };
1972 
1973 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1974 struct tp_nvram_state {
1975        u16 thinkpad_toggle:1;
1976        u16 zoom_toggle:1;
1977        u16 display_toggle:1;
1978        u16 thinklight_toggle:1;
1979        u16 hibernate_toggle:1;
1980        u16 displayexp_toggle:1;
1981        u16 display_state:1;
1982        u16 brightness_toggle:1;
1983        u16 volume_toggle:1;
1984        u16 mute:1;
1985 
1986        u8 brightness_level;
1987        u8 volume_level;
1988 };
1989 
1990 /* kthread for the hotkey poller */
1991 static struct task_struct *tpacpi_hotkey_task;
1992 
1993 /*
1994  * Acquire mutex to write poller control variables as an
1995  * atomic block.
1996  *
1997  * Increment hotkey_config_change when changing them if you
1998  * want the kthread to forget old state.
1999  *
2000  * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2001  */
2002 static struct mutex hotkey_thread_data_mutex;
2003 static unsigned int hotkey_config_change;
2004 
2005 /*
2006  * hotkey poller control variables
2007  *
2008  * Must be atomic or readers will also need to acquire mutex
2009  *
2010  * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2011  * should be used only when the changes need to be taken as
2012  * a block, OR when one needs to force the kthread to forget
2013  * old state.
2014  */
2015 static u32 hotkey_source_mask;          /* bit mask 0=ACPI,1=NVRAM */
2016 static unsigned int hotkey_poll_freq = 10; /* Hz */
2017 
2018 #define HOTKEY_CONFIG_CRITICAL_START \
2019         do { \
2020                 mutex_lock(&hotkey_thread_data_mutex); \
2021                 hotkey_config_change++; \
2022         } while (0);
2023 #define HOTKEY_CONFIG_CRITICAL_END \
2024         mutex_unlock(&hotkey_thread_data_mutex);
2025 
2026 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2027 
2028 #define hotkey_source_mask 0U
2029 #define HOTKEY_CONFIG_CRITICAL_START
2030 #define HOTKEY_CONFIG_CRITICAL_END
2031 
2032 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2033 
2034 static struct mutex hotkey_mutex;
2035 
2036 static enum {   /* Reasons for waking up */
2037         TP_ACPI_WAKEUP_NONE = 0,        /* None or unknown */
2038         TP_ACPI_WAKEUP_BAYEJ,           /* Bay ejection request */
2039         TP_ACPI_WAKEUP_UNDOCK,          /* Undock request */
2040 } hotkey_wakeup_reason;
2041 
2042 static int hotkey_autosleep_ack;
2043 
2044 static u32 hotkey_orig_mask;            /* events the BIOS had enabled */
2045 static u32 hotkey_all_mask;             /* all events supported in fw */
2046 static u32 hotkey_reserved_mask;        /* events better left disabled */
2047 static u32 hotkey_driver_mask;          /* events needed by the driver */
2048 static u32 hotkey_user_mask;            /* events visible to userspace */
2049 static u32 hotkey_acpi_mask;            /* events enabled in firmware */
2050 
2051 static u16 *hotkey_keycode_map;
2052 
2053 static struct attribute_set *hotkey_dev_attributes;
2054 
2055 static void tpacpi_driver_event(const unsigned int hkey_event);
2056 static void hotkey_driver_event(const unsigned int scancode);
2057 static void hotkey_poll_setup(const bool may_warn);
2058 
2059 /* HKEY.MHKG() return bits */
2060 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2061 
2062 static int hotkey_get_wlsw(void)
2063 {
2064         int status;
2065 
2066         if (!tp_features.hotkey_wlsw)
2067                 return -ENODEV;
2068 
2069 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2070         if (dbg_wlswemul)
2071                 return (tpacpi_wlsw_emulstate) ?
2072                                 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2073 #endif
2074 
2075         if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2076                 return -EIO;
2077 
2078         return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2079 }
2080 
2081 static int hotkey_get_tablet_mode(int *status)
2082 {
2083         int s;
2084 
2085         if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2086                 return -EIO;
2087 
2088         *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2089         return 0;
2090 }
2091 
2092 /*
2093  * Reads current event mask from firmware, and updates
2094  * hotkey_acpi_mask accordingly.  Also resets any bits
2095  * from hotkey_user_mask that are unavailable to be
2096  * delivered (shadow requirement of the userspace ABI).
2097  *
2098  * Call with hotkey_mutex held
2099  */
2100 static int hotkey_mask_get(void)
2101 {
2102         if (tp_features.hotkey_mask) {
2103                 u32 m = 0;
2104 
2105                 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2106                         return -EIO;
2107 
2108                 hotkey_acpi_mask = m;
2109         } else {
2110                 /* no mask support doesn't mean no event support... */
2111                 hotkey_acpi_mask = hotkey_all_mask;
2112         }
2113 
2114         /* sync userspace-visible mask */
2115         hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2116 
2117         return 0;
2118 }
2119 
2120 static void hotkey_mask_warn_incomplete_mask(void)
2121 {
2122         /* log only what the user can fix... */
2123         const u32 wantedmask = hotkey_driver_mask &
2124                 ~(hotkey_acpi_mask | hotkey_source_mask) &
2125                 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2126 
2127         if (wantedmask)
2128                 pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2129 }
2130 
2131 /*
2132  * Set the firmware mask when supported
2133  *
2134  * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2135  *
2136  * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2137  *
2138  * Call with hotkey_mutex held
2139  */
2140 static int hotkey_mask_set(u32 mask)
2141 {
2142         int i;
2143         int rc = 0;
2144 
2145         const u32 fwmask = mask & ~hotkey_source_mask;
2146 
2147         if (tp_features.hotkey_mask) {
2148                 for (i = 0; i < 32; i++) {
2149                         if (!acpi_evalf(hkey_handle,
2150                                         NULL, "MHKM", "vdd", i + 1,
2151                                         !!(mask & (1 << i)))) {
2152                                 rc = -EIO;
2153                                 break;
2154                         }
2155                 }
2156         }
2157 
2158         /*
2159          * We *must* make an inconditional call to hotkey_mask_get to
2160          * refresh hotkey_acpi_mask and update hotkey_user_mask
2161          *
2162          * Take the opportunity to also log when we cannot _enable_
2163          * a given event.
2164          */
2165         if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2166                 pr_notice("asked for hotkey mask 0x%08x, but "
2167                           "firmware forced it to 0x%08x\n",
2168                           fwmask, hotkey_acpi_mask);
2169         }
2170 
2171         if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2172                 hotkey_mask_warn_incomplete_mask();
2173 
2174         return rc;
2175 }
2176 
2177 /*
2178  * Sets hotkey_user_mask and tries to set the firmware mask
2179  *
2180  * Call with hotkey_mutex held
2181  */
2182 static int hotkey_user_mask_set(const u32 mask)
2183 {
2184         int rc;
2185 
2186         /* Give people a chance to notice they are doing something that
2187          * is bound to go boom on their users sooner or later */
2188         if (!tp_warned.hotkey_mask_ff &&
2189             (mask == 0xffff || mask == 0xffffff ||
2190              mask == 0xffffffff)) {
2191                 tp_warned.hotkey_mask_ff = 1;
2192                 pr_notice("setting the hotkey mask to 0x%08x is likely "
2193                           "not the best way to go about it\n", mask);
2194                 pr_notice("please consider using the driver defaults, "
2195                           "and refer to up-to-date thinkpad-acpi "
2196                           "documentation\n");
2197         }
2198 
2199         /* Try to enable what the user asked for, plus whatever we need.
2200          * this syncs everything but won't enable bits in hotkey_user_mask */
2201         rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2202 
2203         /* Enable the available bits in hotkey_user_mask */
2204         hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2205 
2206         return rc;
2207 }
2208 
2209 /*
2210  * Sets the driver hotkey mask.
2211  *
2212  * Can be called even if the hotkey subdriver is inactive
2213  */
2214 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2215 {
2216         int rc;
2217 
2218         /* Do the right thing if hotkey_init has not been called yet */
2219         if (!tp_features.hotkey) {
2220                 hotkey_driver_mask = mask;
2221                 return 0;
2222         }
2223 
2224         mutex_lock(&hotkey_mutex);
2225 
2226         HOTKEY_CONFIG_CRITICAL_START
2227         hotkey_driver_mask = mask;
2228 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2229         hotkey_source_mask |= (mask & ~hotkey_all_mask);
2230 #endif
2231         HOTKEY_CONFIG_CRITICAL_END
2232 
2233         rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2234                                                         ~hotkey_source_mask);
2235         hotkey_poll_setup(true);
2236 
2237         mutex_unlock(&hotkey_mutex);
2238 
2239         return rc;
2240 }
2241 
2242 static int hotkey_status_get(int *status)
2243 {
2244         if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2245                 return -EIO;
2246 
2247         return 0;
2248 }
2249 
2250 static int hotkey_status_set(bool enable)
2251 {
2252         if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2253                 return -EIO;
2254 
2255         return 0;
2256 }
2257 
2258 static void tpacpi_input_send_tabletsw(void)
2259 {
2260         int state;
2261 
2262         if (tp_features.hotkey_tablet &&
2263             !hotkey_get_tablet_mode(&state)) {
2264                 mutex_lock(&tpacpi_inputdev_send_mutex);
2265 
2266                 input_report_switch(tpacpi_inputdev,
2267                                     SW_TABLET_MODE, !!state);
2268                 input_sync(tpacpi_inputdev);
2269 
2270                 mutex_unlock(&tpacpi_inputdev_send_mutex);
2271         }
2272 }
2273 
2274 /* Do NOT call without validating scancode first */
2275 static void tpacpi_input_send_key(const unsigned int scancode)
2276 {
2277         const unsigned int keycode = hotkey_keycode_map[scancode];
2278 
2279         if (keycode != KEY_RESERVED) {
2280                 mutex_lock(&tpacpi_inputdev_send_mutex);
2281 
2282                 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2283                 input_report_key(tpacpi_inputdev, keycode, 1);
2284                 input_sync(tpacpi_inputdev);
2285 
2286                 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2287                 input_report_key(tpacpi_inputdev, keycode, 0);
2288                 input_sync(tpacpi_inputdev);
2289 
2290                 mutex_unlock(&tpacpi_inputdev_send_mutex);
2291         }
2292 }
2293 
2294 /* Do NOT call without validating scancode first */
2295 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2296 {
2297         hotkey_driver_event(scancode);
2298         if (hotkey_user_mask & (1 << scancode))
2299                 tpacpi_input_send_key(scancode);
2300 }
2301 
2302 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2303 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2304 
2305 /* Do NOT call without validating scancode first */
2306 static void tpacpi_hotkey_send_key(unsigned int scancode)
2307 {
2308         tpacpi_input_send_key_masked(scancode);
2309 }
2310 
2311 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2312 {
2313         u8 d;
2314 
2315         if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2316                 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2317                 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2318                 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2319                 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2320                 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2321         }
2322         if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2323                 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2324                 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2325         }
2326         if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2327                 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2328                 n->displayexp_toggle =
2329                                 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2330         }
2331         if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2332                 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2333                 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2334                                 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2335                 n->brightness_toggle =
2336                                 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2337         }
2338         if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2339                 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2340                 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2341                                 >> TP_NVRAM_POS_LEVEL_VOLUME;
2342                 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2343                 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2344         }
2345 }
2346 
2347 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2348 do { \
2349         if ((event_mask & (1 << __scancode)) && \
2350             oldn->__member != newn->__member) \
2351                 tpacpi_hotkey_send_key(__scancode); \
2352 } while (0)
2353 
2354 #define TPACPI_MAY_SEND_KEY(__scancode) \
2355 do { \
2356         if (event_mask & (1 << __scancode)) \
2357                 tpacpi_hotkey_send_key(__scancode); \
2358 } while (0)
2359 
2360 static void issue_volchange(const unsigned int oldvol,
2361                             const unsigned int newvol,
2362                             const u32 event_mask)
2363 {
2364         unsigned int i = oldvol;
2365 
2366         while (i > newvol) {
2367                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2368                 i--;
2369         }
2370         while (i < newvol) {
2371                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2372                 i++;
2373         }
2374 }
2375 
2376 static void issue_brightnesschange(const unsigned int oldbrt,
2377                                    const unsigned int newbrt,
2378                                    const u32 event_mask)
2379 {
2380         unsigned int i = oldbrt;
2381 
2382         while (i > newbrt) {
2383                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2384                 i--;
2385         }
2386         while (i < newbrt) {
2387                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2388                 i++;
2389         }
2390 }
2391 
2392 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2393                                            struct tp_nvram_state *newn,
2394                                            const u32 event_mask)
2395 {
2396 
2397         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2398         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2399         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2400         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2401 
2402         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2403 
2404         TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2405 
2406         /*
2407          * Handle volume
2408          *
2409          * This code is supposed to duplicate the IBM firmware behaviour:
2410          * - Pressing MUTE issues mute hotkey message, even when already mute
2411          * - Pressing Volume up/down issues volume up/down hotkey messages,
2412          *   even when already at maximum or minimum volume
2413          * - The act of unmuting issues volume up/down notification,
2414          *   depending which key was used to unmute
2415          *
2416          * We are constrained to what the NVRAM can tell us, which is not much
2417          * and certainly not enough if more than one volume hotkey was pressed
2418          * since the last poll cycle.
2419          *
2420          * Just to make our life interesting, some newer Lenovo ThinkPads have
2421          * bugs in the BIOS and may fail to update volume_toggle properly.
2422          */
2423         if (newn->mute) {
2424                 /* muted */
2425                 if (!oldn->mute ||
2426                     oldn->volume_toggle != newn->volume_toggle ||
2427                     oldn->volume_level != newn->volume_level) {
2428                         /* recently muted, or repeated mute keypress, or
2429                          * multiple presses ending in mute */
2430                         issue_volchange(oldn->volume_level, newn->volume_level,
2431                                 event_mask);
2432                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2433                 }
2434         } else {
2435                 /* unmute */
2436                 if (oldn->mute) {
2437                         /* recently unmuted, issue 'unmute' keypress */
2438                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2439                 }
2440                 if (oldn->volume_level != newn->volume_level) {
2441                         issue_volchange(oldn->volume_level, newn->volume_level,
2442                                 event_mask);
2443                 } else if (oldn->volume_toggle != newn->volume_toggle) {
2444                         /* repeated vol up/down keypress at end of scale ? */
2445                         if (newn->volume_level == 0)
2446                                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2447                         else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2448                                 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2449                 }
2450         }
2451 
2452         /* handle brightness */
2453         if (oldn->brightness_level != newn->brightness_level) {
2454                 issue_brightnesschange(oldn->brightness_level,
2455                                        newn->brightness_level, event_mask);
2456         } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2457                 /* repeated key presses that didn't change state */
2458                 if (newn->brightness_level == 0)
2459                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2460                 else if (newn->brightness_level >= bright_maxlvl
2461                                 && !tp_features.bright_unkfw)
2462                         TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2463         }
2464 
2465 #undef TPACPI_COMPARE_KEY
2466 #undef TPACPI_MAY_SEND_KEY
2467 }
2468 
2469 /*
2470  * Polling driver
2471  *
2472  * We track all events in hotkey_source_mask all the time, since
2473  * most of them are edge-based.  We only issue those requested by
2474  * hotkey_user_mask or hotkey_driver_mask, though.
2475  */
2476 static int hotkey_kthread(void *data)
2477 {
2478         struct tp_nvram_state s[2];
2479         u32 poll_mask, event_mask;
2480         unsigned int si, so;
2481         unsigned long t;
2482         unsigned int change_detector;
2483         unsigned int poll_freq;
2484         bool was_frozen;
2485 
2486         if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2487                 goto exit;
2488 
2489         set_freezable();
2490 
2491         so = 0;
2492         si = 1;
2493         t = 0;
2494 
2495         /* Initial state for compares */
2496         mutex_lock(&hotkey_thread_data_mutex);
2497         change_detector = hotkey_config_change;
2498         poll_mask = hotkey_source_mask;
2499         event_mask = hotkey_source_mask &
2500                         (hotkey_driver_mask | hotkey_user_mask);
2501         poll_freq = hotkey_poll_freq;
2502         mutex_unlock(&hotkey_thread_data_mutex);
2503         hotkey_read_nvram(&s[so], poll_mask);
2504 
2505         while (!kthread_should_stop()) {
2506                 if (t == 0) {
2507                         if (likely(poll_freq))
2508                                 t = 1000/poll_freq;
2509                         else
2510                                 t = 100;        /* should never happen... */
2511                 }
2512                 t = msleep_interruptible(t);
2513                 if (unlikely(kthread_freezable_should_stop(&was_frozen)))
2514                         break;
2515 
2516                 if (t > 0 && !was_frozen)
2517                         continue;
2518 
2519                 mutex_lock(&hotkey_thread_data_mutex);
2520                 if (was_frozen || hotkey_config_change != change_detector) {
2521                         /* forget old state on thaw or config change */
2522                         si = so;
2523                         t = 0;
2524                         change_detector = hotkey_config_change;
2525                 }
2526                 poll_mask = hotkey_source_mask;
2527                 event_mask = hotkey_source_mask &
2528                                 (hotkey_driver_mask | hotkey_user_mask);
2529                 poll_freq = hotkey_poll_freq;
2530                 mutex_unlock(&hotkey_thread_data_mutex);
2531 
2532                 if (likely(poll_mask)) {
2533                         hotkey_read_nvram(&s[si], poll_mask);
2534                         if (likely(si != so)) {
2535                                 hotkey_compare_and_issue_event(&s[so], &s[si],
2536                                                                 event_mask);
2537                         }
2538                 }
2539 
2540                 so = si;
2541                 si ^= 1;
2542         }
2543 
2544 exit:
2545         return 0;
2546 }
2547 
2548 /* call with hotkey_mutex held */
2549 static void hotkey_poll_stop_sync(void)
2550 {
2551         if (tpacpi_hotkey_task) {
2552                 kthread_stop(tpacpi_hotkey_task);
2553                 tpacpi_hotkey_task = NULL;
2554         }
2555 }
2556 
2557 /* call with hotkey_mutex held */
2558 static void hotkey_poll_setup(const bool may_warn)
2559 {
2560         const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2561         const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2562 
2563         if (hotkey_poll_freq > 0 &&
2564             (poll_driver_mask ||
2565              (poll_user_mask && tpacpi_inputdev->users > 0))) {
2566                 if (!tpacpi_hotkey_task) {
2567                         tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2568                                         NULL, TPACPI_NVRAM_KTHREAD_NAME);
2569                         if (IS_ERR(tpacpi_hotkey_task)) {
2570                                 tpacpi_hotkey_task = NULL;
2571                                 pr_err("could not create kernel thread "
2572                                        "for hotkey polling\n");
2573                         }
2574                 }
2575         } else {
2576                 hotkey_poll_stop_sync();
2577                 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2578                     hotkey_poll_freq == 0) {
2579                         pr_notice("hot keys 0x%08x and/or events 0x%08x "
2580                                   "require polling, which is currently "
2581                                   "disabled\n",
2582                                   poll_user_mask, poll_driver_mask);
2583                 }
2584         }
2585 }
2586 
2587 static void hotkey_poll_setup_safe(const bool may_warn)
2588 {
2589         mutex_lock(&hotkey_mutex);
2590         hotkey_poll_setup(may_warn);
2591         mutex_unlock(&hotkey_mutex);
2592 }
2593 
2594 /* call with hotkey_mutex held */
2595 static void hotkey_poll_set_freq(unsigned int freq)
2596 {
2597         if (!freq)
2598                 hotkey_poll_stop_sync();
2599 
2600         hotkey_poll_freq = freq;
2601 }
2602 
2603 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2604 
2605 static void hotkey_poll_setup(const bool __unused)
2606 {
2607 }
2608 
2609 static void hotkey_poll_setup_safe(const bool __unused)
2610 {
2611 }
2612 
2613 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2614 
2615 static int hotkey_inputdev_open(struct input_dev *dev)
2616 {
2617         switch (tpacpi_lifecycle) {
2618         case TPACPI_LIFE_INIT:
2619         case TPACPI_LIFE_RUNNING:
2620                 hotkey_poll_setup_safe(false);
2621                 return 0;
2622         case TPACPI_LIFE_EXITING:
2623                 return -EBUSY;
2624         }
2625 
2626         /* Should only happen if tpacpi_lifecycle is corrupt */
2627         BUG();
2628         return -EBUSY;
2629 }
2630 
2631 static void hotkey_inputdev_close(struct input_dev *dev)
2632 {
2633         /* disable hotkey polling when possible */
2634         if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2635             !(hotkey_source_mask & hotkey_driver_mask))
2636                 hotkey_poll_setup_safe(false);
2637 }
2638 
2639 /* sysfs hotkey enable ------------------------------------------------- */
2640 static ssize_t hotkey_enable_show(struct device *dev,
2641                            struct device_attribute *attr,
2642                            char *buf)
2643 {
2644         int res, status;
2645 
2646         printk_deprecated_attribute("hotkey_enable",
2647                         "Hotkey reporting is always enabled");
2648 
2649         res = hotkey_status_get(&status);
2650         if (res)
2651                 return res;
2652 
2653         return snprintf(buf, PAGE_SIZE, "%d\n", status);
2654 }
2655 
2656 static ssize_t hotkey_enable_store(struct device *dev,
2657                             struct device_attribute *attr,
2658                             const char *buf, size_t count)
2659 {
2660         unsigned long t;
2661 
2662         printk_deprecated_attribute("hotkey_enable",
2663                         "Hotkeys can be disabled through hotkey_mask");
2664 
2665         if (parse_strtoul(buf, 1, &t))
2666                 return -EINVAL;
2667 
2668         if (t == 0)
2669                 return -EPERM;
2670 
2671         return count;
2672 }
2673 
2674 static DEVICE_ATTR_RW(hotkey_enable);
2675 
2676 /* sysfs hotkey mask --------------------------------------------------- */
2677 static ssize_t hotkey_mask_show(struct device *dev,
2678                            struct device_attribute *attr,
2679                            char *buf)
2680 {
2681         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2682 }
2683 
2684 static ssize_t hotkey_mask_store(struct device *dev,
2685                             struct device_attribute *attr,
2686                             const char *buf, size_t count)
2687 {
2688         unsigned long t;
2689         int res;
2690 
2691         if (parse_strtoul(buf, 0xffffffffUL, &t))
2692                 return -EINVAL;
2693 
2694         if (mutex_lock_killable(&hotkey_mutex))
2695                 return -ERESTARTSYS;
2696 
2697         res = hotkey_user_mask_set(t);
2698 
2699 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2700         hotkey_poll_setup(true);
2701 #endif
2702 
2703         mutex_unlock(&hotkey_mutex);
2704 
2705         tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2706 
2707         return (res) ? res : count;
2708 }
2709 
2710 static DEVICE_ATTR_RW(hotkey_mask);
2711 
2712 /* sysfs hotkey bios_enabled ------------------------------------------- */
2713 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2714                            struct device_attribute *attr,
2715                            char *buf)
2716 {
2717         return sprintf(buf, "\n");
2718 }
2719 
2720 static DEVICE_ATTR_RO(hotkey_bios_enabled);
2721 
2722 /* sysfs hotkey bios_mask ---------------------------------------------- */
2723 static ssize_t hotkey_bios_mask_show(struct device *dev,
2724                            struct device_attribute *attr,
2725                            char *buf)
2726 {
2727         printk_deprecated_attribute("hotkey_bios_mask",
2728                         "This attribute is useless.");
2729         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2730 }
2731 
2732 static DEVICE_ATTR_RO(hotkey_bios_mask);
2733 
2734 /* sysfs hotkey all_mask ----------------------------------------------- */
2735 static ssize_t hotkey_all_mask_show(struct device *dev,
2736                            struct device_attribute *attr,
2737                            char *buf)
2738 {
2739         return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2740                                 hotkey_all_mask | hotkey_source_mask);
2741 }
2742 
2743 static DEVICE_ATTR_RO(hotkey_all_mask);
2744 
2745 /* sysfs hotkey recommended_mask --------------------------------------- */
2746 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2747                                             struct device_attribute *attr,
2748                                             char *buf)
2749 {
2750         return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2751                         (hotkey_all_mask | hotkey_source_mask)
2752                         & ~hotkey_reserved_mask);
2753 }
2754 
2755 static DEVICE_ATTR_RO(hotkey_recommended_mask);
2756 
2757 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2758 
2759 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2760 static ssize_t hotkey_source_mask_show(struct device *dev,
2761                            struct device_attribute *attr,
2762                            char *buf)
2763 {
2764         return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2765 }
2766 
2767 static ssize_t hotkey_source_mask_store(struct device *dev,
2768                             struct device_attribute *attr,
2769                             const char *buf, size_t count)
2770 {
2771         unsigned long t;
2772         u32 r_ev;
2773         int rc;
2774 
2775         if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2776                 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2777                 return -EINVAL;
2778 
2779         if (mutex_lock_killable(&hotkey_mutex))
2780                 return -ERESTARTSYS;
2781 
2782         HOTKEY_CONFIG_CRITICAL_START
2783         hotkey_source_mask = t;
2784         HOTKEY_CONFIG_CRITICAL_END
2785 
2786         rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2787                         ~hotkey_source_mask);
2788         hotkey_poll_setup(true);
2789 
2790         /* check if events needed by the driver got disabled */
2791         r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2792                 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2793 
2794         mutex_unlock(&hotkey_mutex);
2795 
2796         if (rc < 0)
2797                 pr_err("hotkey_source_mask: "
2798                        "failed to update the firmware event mask!\n");
2799 
2800         if (r_ev)
2801                 pr_notice("hotkey_source_mask: "
2802                           "some important events were disabled: 0x%04x\n",
2803                           r_ev);
2804 
2805         tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2806 
2807         return (rc < 0) ? rc : count;
2808 }
2809 
2810 static DEVICE_ATTR_RW(hotkey_source_mask);
2811 
2812 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2813 static ssize_t hotkey_poll_freq_show(struct device *dev,
2814                            struct device_attribute *attr,
2815                            char *buf)
2816 {
2817         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2818 }
2819 
2820 static ssize_t hotkey_poll_freq_store(struct device *dev,
2821                             struct device_attribute *attr,
2822                             const char *buf, size_t count)
2823 {
2824         unsigned long t;
2825 
2826         if (parse_strtoul(buf, 25, &t))
2827                 return -EINVAL;
2828 
2829         if (mutex_lock_killable(&hotkey_mutex))
2830                 return -ERESTARTSYS;
2831 
2832         hotkey_poll_set_freq(t);
2833         hotkey_poll_setup(true);
2834 
2835         mutex_unlock(&hotkey_mutex);
2836 
2837         tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2838 
2839         return count;
2840 }
2841 
2842 static DEVICE_ATTR_RW(hotkey_poll_freq);
2843 
2844 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2845 
2846 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2847 static ssize_t hotkey_radio_sw_show(struct device *dev,
2848                            struct device_attribute *attr,
2849                            char *buf)
2850 {
2851         int res;
2852         res = hotkey_get_wlsw();
2853         if (res < 0)
2854                 return res;
2855 
2856         /* Opportunistic update */
2857         tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2858 
2859         return snprintf(buf, PAGE_SIZE, "%d\n",
2860                         (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2861 }
2862 
2863 static DEVICE_ATTR_RO(hotkey_radio_sw);
2864 
2865 static void hotkey_radio_sw_notify_change(void)
2866 {
2867         if (tp_features.hotkey_wlsw)
2868                 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2869                              "hotkey_radio_sw");
2870 }
2871 
2872 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2873 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2874                            struct device_attribute *attr,
2875                            char *buf)
2876 {
2877         int res, s;
2878         res = hotkey_get_tablet_mode(&s);
2879         if (res < 0)
2880                 return res;
2881 
2882         return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2883 }
2884 
2885 static DEVICE_ATTR_RO(hotkey_tablet_mode);
2886 
2887 static void hotkey_tablet_mode_notify_change(void)
2888 {
2889         if (tp_features.hotkey_tablet)
2890                 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2891                              "hotkey_tablet_mode");
2892 }
2893 
2894 /* sysfs wakeup reason (pollable) -------------------------------------- */
2895 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2896                            struct device_attribute *attr,
2897                            char *buf)
2898 {
2899         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2900 }
2901 
2902 static DEVICE_ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2903 
2904 static void hotkey_wakeup_reason_notify_change(void)
2905 {
2906         sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2907                      "wakeup_reason");
2908 }
2909 
2910 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2911 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2912                            struct device_attribute *attr,
2913                            char *buf)
2914 {
2915         return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2916 }
2917 
2918 static DEVICE_ATTR(wakeup_hotunplug_complete, S_IRUGO,
2919                    hotkey_wakeup_hotunplug_complete_show, NULL);
2920 
2921 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2922 {
2923         sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2924                      "wakeup_hotunplug_complete");
2925 }
2926 
2927 /* sysfs adaptive kbd mode --------------------------------------------- */
2928 
2929 static int adaptive_keyboard_get_mode(void);
2930 static int adaptive_keyboard_set_mode(int new_mode);
2931 
2932 enum ADAPTIVE_KEY_MODE {
2933         HOME_MODE,
2934         WEB_BROWSER_MODE,
2935         WEB_CONFERENCE_MODE,
2936         FUNCTION_MODE,
2937         LAYFLAT_MODE
2938 };
2939 
2940 static ssize_t adaptive_kbd_mode_show(struct device *dev,
2941                            struct device_attribute *attr,
2942                            char *buf)
2943 {
2944         int current_mode;
2945 
2946         current_mode = adaptive_keyboard_get_mode();
2947         if (current_mode < 0)
2948                 return current_mode;
2949 
2950         return snprintf(buf, PAGE_SIZE, "%d\n", current_mode);
2951 }
2952 
2953 static ssize_t adaptive_kbd_mode_store(struct device *dev,
2954                             struct device_attribute *attr,
2955                             const char *buf, size_t count)
2956 {
2957         unsigned long t;
2958         int res;
2959 
2960         if (parse_strtoul(buf, LAYFLAT_MODE, &t))
2961                 return -EINVAL;
2962 
2963         res = adaptive_keyboard_set_mode(t);
2964         return (res < 0) ? res : count;
2965 }
2966 
2967 static DEVICE_ATTR_RW(adaptive_kbd_mode);
2968 
2969 static struct attribute *adaptive_kbd_attributes[] = {
2970         &dev_attr_adaptive_kbd_mode.attr,
2971         NULL
2972 };
2973 
2974 static const struct attribute_group adaptive_kbd_attr_group = {
2975         .attrs = adaptive_kbd_attributes,
2976 };
2977 
2978 /* --------------------------------------------------------------------- */
2979 
2980 static struct attribute *hotkey_attributes[] __initdata = {
2981         &dev_attr_hotkey_enable.attr,
2982         &dev_attr_hotkey_bios_enabled.attr,
2983         &dev_attr_hotkey_bios_mask.attr,
2984         &dev_attr_wakeup_reason.attr,
2985         &dev_attr_wakeup_hotunplug_complete.attr,
2986         &dev_attr_hotkey_mask.attr,
2987         &dev_attr_hotkey_all_mask.attr,
2988         &dev_attr_hotkey_recommended_mask.attr,
2989 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2990         &dev_attr_hotkey_source_mask.attr,
2991         &dev_attr_hotkey_poll_freq.attr,
2992 #endif
2993 };
2994 
2995 /*
2996  * Sync both the hw and sw blocking state of all switches
2997  */
2998 static void tpacpi_send_radiosw_update(void)
2999 {
3000         int wlsw;
3001 
3002         /*
3003          * We must sync all rfkill controllers *before* issuing any
3004          * rfkill input events, or we will race the rfkill core input
3005          * handler.
3006          *
3007          * tpacpi_inputdev_send_mutex works as a synchronization point
3008          * for the above.
3009          *
3010          * We optimize to avoid numerous calls to hotkey_get_wlsw.
3011          */
3012 
3013         wlsw = hotkey_get_wlsw();
3014 
3015         /* Sync hw blocking state first if it is hw-blocked */
3016         if (wlsw == TPACPI_RFK_RADIO_OFF)
3017                 tpacpi_rfk_update_hwblock_state(true);
3018 
3019         /* Sync sw blocking state */
3020         tpacpi_rfk_update_swstate_all();
3021 
3022         /* Sync hw blocking state last if it is hw-unblocked */
3023         if (wlsw == TPACPI_RFK_RADIO_ON)
3024                 tpacpi_rfk_update_hwblock_state(false);
3025 
3026         /* Issue rfkill input event for WLSW switch */
3027         if (!(wlsw < 0)) {
3028                 mutex_lock(&tpacpi_inputdev_send_mutex);
3029 
3030                 input_report_switch(tpacpi_inputdev,
3031                                     SW_RFKILL_ALL, (wlsw > 0));
3032                 input_sync(tpacpi_inputdev);
3033 
3034                 mutex_unlock(&tpacpi_inputdev_send_mutex);
3035         }
3036 
3037         /*
3038          * this can be unconditional, as we will poll state again
3039          * if userspace uses the notify to read data
3040          */
3041         hotkey_radio_sw_notify_change();
3042 }
3043 
3044 static void hotkey_exit(void)
3045 {
3046 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3047         mutex_lock(&hotkey_mutex);
3048         hotkey_poll_stop_sync();
3049         mutex_unlock(&hotkey_mutex);
3050 #endif
3051 
3052         if (hotkey_dev_attributes)
3053                 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3054 
3055         dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3056                    "restoring original HKEY status and mask\n");
3057         /* yes, there is a bitwise or below, we want the
3058          * functions to be called even if one of them fail */
3059         if (((tp_features.hotkey_mask &&
3060               hotkey_mask_set(hotkey_orig_mask)) |
3061              hotkey_status_set(false)) != 0)
3062                 pr_err("failed to restore hot key mask "
3063                        "to BIOS defaults\n");
3064 }
3065 
3066 static void __init hotkey_unmap(const unsigned int scancode)
3067 {
3068         if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3069                 clear_bit(hotkey_keycode_map[scancode],
3070                           tpacpi_inputdev->keybit);
3071                 hotkey_keycode_map[scancode] = KEY_RESERVED;
3072         }
3073 }
3074 
3075 /*
3076  * HKEY quirks:
3077  *   TPACPI_HK_Q_INIMASK:       Supports FN+F3,FN+F4,FN+F12
3078  */
3079 
3080 #define TPACPI_HK_Q_INIMASK     0x0001
3081 
3082 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3083         TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3084         TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3085         TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3086         TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3087         TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3088         TPACPI_Q_IBM('1', '', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3089         TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3090         TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3091         TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3092         TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3093         TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3094         TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3095         TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3096         TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3097         TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3098         TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3099         TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3100         TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3101         TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3102 };
3103 
3104 typedef u16 tpacpi_keymap_entry_t;
3105 typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3106 
3107 static int __init hotkey_init(struct ibm_init_struct *iibm)
3108 {
3109         /* Requirements for changing the default keymaps:
3110          *
3111          * 1. Many of the keys are mapped to KEY_RESERVED for very
3112          *    good reasons.  Do not change them unless you have deep
3113          *    knowledge on the IBM and Lenovo ThinkPad firmware for
3114          *    the various ThinkPad models.  The driver behaves
3115          *    differently for KEY_RESERVED: such keys have their
3116          *    hot key mask *unset* in mask_recommended, and also
3117          *    in the initial hot key mask programmed into the
3118          *    firmware at driver load time, which means the firm-
3119          *    ware may react very differently if you change them to
3120          *    something else;
3121          *
3122          * 2. You must be subscribed to the linux-thinkpad and
3123          *    ibm-acpi-devel mailing lists, and you should read the
3124          *    list archives since 2007 if you want to change the
3125          *    keymaps.  This requirement exists so that you will
3126          *    know the past history of problems with the thinkpad-
3127          *    acpi driver keymaps, and also that you will be
3128          *    listening to any bug reports;
3129          *
3130          * 3. Do not send thinkpad-acpi specific patches directly to
3131          *    for merging, *ever*.  Send them to the linux-acpi
3132          *    mailinglist for comments.  Merging is to be done only
3133          *    through acpi-test and the ACPI maintainer.
3134          *
3135          * If the above is too much to ask, don't change the keymap.
3136          * Ask the thinkpad-acpi maintainer to do it, instead.
3137          */
3138 
3139         enum keymap_index {
3140                 TPACPI_KEYMAP_IBM_GENERIC = 0,
3141                 TPACPI_KEYMAP_LENOVO_GENERIC,
3142         };
3143 
3144         static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3145         /* Generic keymap for IBM ThinkPads */
3146         [TPACPI_KEYMAP_IBM_GENERIC] = {
3147                 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3148                 KEY_FN_F1,      KEY_BATTERY,    KEY_COFFEE,     KEY_SLEEP,
3149                 KEY_WLAN,       KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3150                 KEY_FN_F9,      KEY_FN_F10,     KEY_FN_F11,     KEY_SUSPEND,
3151 
3152                 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3153                 KEY_UNKNOWN,    /* 0x0C: FN+BACKSPACE */
3154                 KEY_UNKNOWN,    /* 0x0D: FN+INSERT */
3155                 KEY_UNKNOWN,    /* 0x0E: FN+DELETE */
3156 
3157                 /* brightness: firmware always reacts to them */
3158                 KEY_RESERVED,   /* 0x0F: FN+HOME (brightness up) */
3159                 KEY_RESERVED,   /* 0x10: FN+END (brightness down) */
3160 
3161                 /* Thinklight: firmware always react to it */
3162                 KEY_RESERVED,   /* 0x11: FN+PGUP (thinklight toggle) */
3163 
3164                 KEY_UNKNOWN,    /* 0x12: FN+PGDOWN */
3165                 KEY_ZOOM,       /* 0x13: FN+SPACE (zoom) */
3166 
3167                 /* Volume: firmware always react to it and reprograms
3168                  * the built-in *extra* mixer.  Never map it to control
3169                  * another mixer by default. */
3170                 KEY_RESERVED,   /* 0x14: VOLUME UP */
3171                 KEY_RESERVED,   /* 0x15: VOLUME DOWN */
3172                 KEY_RESERVED,   /* 0x16: MUTE */
3173 
3174                 KEY_VENDOR,     /* 0x17: Thinkpad/AccessIBM/Lenovo */
3175 
3176                 /* (assignments unknown, please report if found) */
3177                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3178                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3179 
3180                 /* No assignments, only used for Adaptive keyboards. */
3181                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3182                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3183                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3184                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3185                 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3186                 },
3187 
3188         /* Generic keymap for Lenovo ThinkPads */
3189         [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3190                 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3191                 KEY_FN_F1,      KEY_COFFEE,     KEY_BATTERY,    KEY_SLEEP,
3192                 KEY_WLAN,       KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3193                 KEY_FN_F9,      KEY_FN_F10,     KEY_FN_F11,     KEY_SUSPEND,
3194 
3195                 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3196                 KEY_UNKNOWN,    /* 0x0C: FN+BACKSPACE */
3197                 KEY_UNKNOWN,    /* 0x0D: FN+INSERT */
3198                 KEY_UNKNOWN,    /* 0x0E: FN+DELETE */
3199 
3200                 /* These should be enabled --only-- when ACPI video
3201                  * is disabled (i.e. in "vendor" mode), and are handled
3202                  * in a special way by the init code */
3203                 KEY_BRIGHTNESSUP,       /* 0x0F: FN+HOME (brightness up) */
3204                 KEY_BRIGHTNESSDOWN,     /* 0x10: FN+END (brightness down) */
3205 
3206                 KEY_RESERVED,   /* 0x11: FN+PGUP (thinklight toggle) */
3207 
3208                 KEY_UNKNOWN,    /* 0x12: FN+PGDOWN */
3209                 KEY_ZOOM,       /* 0x13: FN+SPACE (zoom) */
3210 
3211                 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3212                  * react to it and reprograms the built-in *extra* mixer.
3213                  * Never map it to control another mixer by default.
3214                  *
3215                  * T60?, T61, R60?, R61: firmware and EC tries to send
3216                  * these over the regular keyboard, so these are no-ops,
3217                  * but there are still weird bugs re. MUTE, so do not
3218                  * change unless you get test reports from all Lenovo
3219                  * models.  May cause the BIOS to interfere with the
3220                  * HDA mixer.
3221                  */
3222                 KEY_RESERVED,   /* 0x14: VOLUME UP */
3223                 KEY_RESERVED,   /* 0x15: VOLUME DOWN */
3224                 KEY_RESERVED,   /* 0x16: MUTE */
3225 
3226                 KEY_VENDOR,     /* 0x17: Thinkpad/AccessIBM/Lenovo */
3227 
3228                 /* (assignments unknown, please report if found) */
3229                 KEY_UNKNOWN, KEY_UNKNOWN,
3230 
3231                 /*
3232                  * The mic mute button only sends 0x1a.  It does not
3233                  * automatically mute the mic or change the mute light.
3234                  */
3235                 KEY_MICMUTE,    /* 0x1a: Mic mute (since ?400 or so) */
3236 
3237                 /* (assignments unknown, please report if found) */
3238                 KEY_UNKNOWN,
3239 
3240                 /* Extra keys in use since the X240 / T440 / T540 */
3241                 KEY_CONFIG, KEY_SEARCH, KEY_SCALE, KEY_FILE,
3242 
3243                 /*
3244                  * These are the adaptive keyboard keycodes for Carbon X1 2014.
3245                  * The first item in this list is the Mute button which is
3246                  * emitted with 0x103 through
3247                  * adaptive_keyboard_hotkey_notify_hotkey() when the sound
3248                  * symbol is held.
3249                  * We'll need to offset those by 0x20.
3250                  */
3251                 KEY_RESERVED,        /* Mute held, 0x103 */
3252                 KEY_BRIGHTNESS_MIN,  /* Backlight off */
3253                 KEY_RESERVED,        /* Clipping tool */
3254                 KEY_RESERVED,        /* Cloud */
3255                 KEY_RESERVED,
3256                 KEY_VOICECOMMAND,    /* Voice */
3257                 KEY_RESERVED,
3258                 KEY_RESERVED,        /* Gestures */
3259                 KEY_RESERVED,
3260                 KEY_RESERVED,
3261                 KEY_RESERVED,
3262                 KEY_CONFIG,          /* Settings */
3263                 KEY_RESERVED,        /* New tab */
3264                 KEY_REFRESH,         /* Reload */
3265                 KEY_BACK,            /* Back */
3266                 KEY_RESERVED,        /* Microphone down */
3267                 KEY_RESERVED,        /* Microphone up */
3268                 KEY_RESERVED,        /* Microphone cancellation */
3269                 KEY_RESERVED,        /* Camera mode */
3270                 KEY_RESERVED,        /* Rotate display, 0x116 */
3271                 },
3272         };
3273 
3274         static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3275                 /* Generic maps (fallback) */
3276                 {
3277                   .vendor = PCI_VENDOR_ID_IBM,
3278                   .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3279                   .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3280                 },
3281                 {
3282                   .vendor = PCI_VENDOR_ID_LENOVO,
3283                   .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3284                   .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3285                 },
3286         };
3287 
3288 #define TPACPI_HOTKEY_MAP_SIZE          sizeof(tpacpi_keymap_t)
3289 #define TPACPI_HOTKEY_MAP_TYPESIZE      sizeof(tpacpi_keymap_entry_t)
3290 
3291         int res, i;
3292         int status;
3293         int hkeyv;
3294         bool radiosw_state  = false;
3295         bool tabletsw_state = false;
3296 
3297         unsigned long quirks;
3298         unsigned long keymap_id;
3299 
3300         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3301                         "initializing hotkey subdriver\n");
3302 
3303         BUG_ON(!tpacpi_inputdev);
3304         BUG_ON(tpacpi_inputdev->open != NULL ||
3305                tpacpi_inputdev->close != NULL);
3306 
3307         TPACPI_ACPIHANDLE_INIT(hkey);
3308         mutex_init(&hotkey_mutex);
3309 
3310 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3311         mutex_init(&hotkey_thread_data_mutex);
3312 #endif
3313 
3314         /* hotkey not supported on 570 */
3315         tp_features.hotkey = hkey_handle != NULL;
3316 
3317         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3318                 "hotkeys are %s\n",
3319                 str_supported(tp_features.hotkey));
3320 
3321         if (!tp_features.hotkey)
3322                 return 1;
3323 
3324         /*
3325          * Check if we have an adaptive keyboard, like on the
3326          * Lenovo Carbon X1 2014 (2nd Gen).
3327          */
3328         if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3329                 if ((hkeyv >> 8) == 2) {
3330                         tp_features.has_adaptive_kbd = true;
3331                         res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
3332                                         &adaptive_kbd_attr_group);
3333                         if (res)
3334                                 goto err_exit;
3335                 }
3336         }
3337 
3338         quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3339                                      ARRAY_SIZE(tpacpi_hotkey_qtable));
3340 
3341         tpacpi_disable_brightness_delay();
3342 
3343         /* MUST have enough space for all attributes to be added to
3344          * hotkey_dev_attributes */
3345         hotkey_dev_attributes = create_attr_set(
3346                                         ARRAY_SIZE(hotkey_attributes) + 2,
3347                                         NULL);
3348         if (!hotkey_dev_attributes)
3349                 return -ENOMEM;
3350         res = add_many_to_attr_set(hotkey_dev_attributes,
3351                         hotkey_attributes,
3352                         ARRAY_SIZE(hotkey_attributes));
3353         if (res)
3354                 goto err_exit;
3355 
3356         /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3357            A30, R30, R31, T20-22, X20-21, X22-24.  Detected by checking
3358            for HKEY interface version 0x100 */
3359         if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3360                 if ((hkeyv >> 8) != 1) {
3361                         pr_err("unknown version of the HKEY interface: 0x%x\n",
3362                                hkeyv);
3363                         pr_err("please report this to %s\n", TPACPI_MAIL);
3364                 } else {
3365                         /*
3366                          * MHKV 0x100 in A31, R40, R40e,
3367                          * T4x, X31, and later
3368                          */
3369                         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3370                                 "firmware HKEY interface version: 0x%x\n",
3371                                 hkeyv);
3372 
3373                         /* Paranoia check AND init hotkey_all_mask */
3374                         if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3375                                         "MHKA", "qd")) {
3376                                 pr_err("missing MHKA handler, "
3377                                        "please report this to %s\n",
3378                                        TPACPI_MAIL);
3379                                 /* Fallback: pre-init for FN+F3,F4,F12 */
3380                                 hotkey_all_mask = 0x080cU;
3381                         } else {
3382                                 tp_features.hotkey_mask = 1;
3383                         }
3384                 }
3385         }
3386 
3387         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3388                 "hotkey masks are %s\n",
3389                 str_supported(tp_features.hotkey_mask));
3390 
3391         /* Init hotkey_all_mask if not initialized yet */
3392         if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3393             (quirks & TPACPI_HK_Q_INIMASK))
3394                 hotkey_all_mask = 0x080cU;  /* FN+F12, FN+F4, FN+F3 */
3395 
3396         /* Init hotkey_acpi_mask and hotkey_orig_mask */
3397         if (tp_features.hotkey_mask) {
3398                 /* hotkey_source_mask *must* be zero for
3399                  * the first hotkey_mask_get to return hotkey_orig_mask */
3400                 res = hotkey_mask_get();
3401                 if (res)
3402                         goto err_exit;
3403 
3404                 hotkey_orig_mask = hotkey_acpi_mask;
3405         } else {
3406                 hotkey_orig_mask = hotkey_all_mask;
3407                 hotkey_acpi_mask = hotkey_all_mask;
3408         }
3409 
3410 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3411         if (dbg_wlswemul) {
3412                 tp_features.hotkey_wlsw = 1;
3413                 radiosw_state = !!tpacpi_wlsw_emulstate;
3414                 pr_info("radio switch emulation enabled\n");
3415         } else
3416 #endif
3417         /* Not all thinkpads have a hardware radio switch */
3418         if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3419                 tp_features.hotkey_wlsw = 1;
3420                 radiosw_state = !!status;
3421                 pr_info("radio switch found; radios are %s\n",
3422                         enabled(status, 0));
3423         }
3424         if (tp_features.hotkey_wlsw)
3425                 res = add_to_attr_set(hotkey_dev_attributes,
3426                                 &dev_attr_hotkey_radio_sw.attr);
3427 
3428         /* For X41t, X60t, X61t Tablets... */
3429         if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3430                 tp_features.hotkey_tablet = 1;
3431                 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3432                 pr_info("possible tablet mode switch found; "
3433                         "ThinkPad in %s mode\n",
3434                         (tabletsw_state) ? "tablet" : "laptop");
3435                 res = add_to_attr_set(hotkey_dev_attributes,
3436                                 &dev_attr_hotkey_tablet_mode.attr);
3437         }
3438 
3439         if (!res)
3440                 res = register_attr_set_with_sysfs(
3441                                 hotkey_dev_attributes,
3442                                 &tpacpi_pdev->dev.kobj);
3443         if (res)
3444                 goto err_exit;
3445 
3446         /* Set up key map */
3447         hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3448                                         GFP_KERNEL);
3449         if (!hotkey_keycode_map) {
3450                 pr_err("failed to allocate memory for key map\n");
3451                 res = -ENOMEM;
3452                 goto err_exit;
3453         }
3454 
3455         keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3456                                         ARRAY_SIZE(tpacpi_keymap_qtable));
3457         BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3458         dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3459                    "using keymap number %lu\n", keymap_id);
3460 
3461         memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3462                 TPACPI_HOTKEY_MAP_SIZE);
3463 
3464         input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3465         tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3466         tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3467         tpacpi_inputdev->keycode = hotkey_keycode_map;
3468         for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3469                 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3470                         input_set_capability(tpacpi_inputdev, EV_KEY,
3471                                                 hotkey_keycode_map[i]);
3472                 } else {
3473                         if (i < sizeof(hotkey_reserved_mask)*8)
3474                                 hotkey_reserved_mask |= 1 << i;
3475                 }
3476         }
3477 
3478         if (tp_features.hotkey_wlsw) {
3479                 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3480                 input_report_switch(tpacpi_inputdev,
3481                                     SW_RFKILL_ALL, radiosw_state);
3482         }
3483         if (tp_features.hotkey_tablet) {
3484                 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3485                 input_report_switch(tpacpi_inputdev,
3486                                     SW_TABLET_MODE, tabletsw_state);
3487         }
3488 
3489         /* Do not issue duplicate brightness change events to
3490          * userspace. tpacpi_detect_brightness_capabilities() must have
3491          * been called before this point  */
3492         if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
3493                 pr_info("This ThinkPad has standard ACPI backlight "
3494                         "brightness control, supported by the ACPI "
3495                         "video driver\n");
3496                 pr_notice("Disabling thinkpad-acpi brightness events "
3497                           "by default...\n");
3498 
3499                 /* Disable brightness up/down on Lenovo thinkpads when
3500                  * ACPI is handling them, otherwise it is plain impossible
3501                  * for userspace to do something even remotely sane */
3502                 hotkey_reserved_mask |=
3503                         (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3504                         | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3505                 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3506                 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3507         }
3508 
3509 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3510         hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3511                                 & ~hotkey_all_mask
3512                                 & ~hotkey_reserved_mask;
3513 
3514         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3515                     "hotkey source mask 0x%08x, polling freq %u\n",
3516                     hotkey_source_mask, hotkey_poll_freq);
3517 #endif
3518 
3519         dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3520                         "enabling firmware HKEY event interface...\n");
3521         res = hotkey_status_set(true);
3522         if (res) {
3523                 hotkey_exit();
3524                 return res;
3525         }
3526         res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3527                                | hotkey_driver_mask)
3528                               & ~hotkey_source_mask);
3529         if (res < 0 && res != -ENXIO) {
3530                 hotkey_exit();
3531                 return res;
3532         }
3533         hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3534                                 & ~hotkey_reserved_mask;
3535         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3536                 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3537                 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3538 
3539         tpacpi_inputdev->open = &hotkey_inputdev_open;
3540         tpacpi_inputdev->close = &hotkey_inputdev_close;
3541 
3542         hotkey_poll_setup_safe(true);
3543 
3544         return 0;
3545 
3546 err_exit:
3547         delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3548         sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3549                         &adaptive_kbd_attr_group);
3550 
3551         hotkey_dev_attributes = NULL;
3552 
3553         return (res < 0) ? res : 1;
3554 }
3555 
3556 /* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3557  * mode, Web conference mode, Function mode and Lay-flat mode.
3558  * We support Home mode and Function mode currently.
3559  *
3560  * Will consider support rest of modes in future.
3561  *
3562  */
3563 static const int adaptive_keyboard_modes[] = {
3564         HOME_MODE,
3565 /*      WEB_BROWSER_MODE = 2,
3566         WEB_CONFERENCE_MODE = 3, */
3567         FUNCTION_MODE
3568 };
3569 
3570 #define DFR_CHANGE_ROW                  0x101
3571 #define DFR_SHOW_QUICKVIEW_ROW          0x102
3572 #define FIRST_ADAPTIVE_KEY              0x103
3573 #define ADAPTIVE_KEY_OFFSET             0x020
3574 
3575 /* press Fn key a while second, it will switch to Function Mode. Then
3576  * release Fn key, previous mode be restored.
3577  */
3578 static bool adaptive_keyboard_mode_is_saved;
3579 static int adaptive_keyboard_prev_mode;
3580 
3581 static int adaptive_keyboard_get_mode(void)
3582 {
3583         int mode = 0;
3584 
3585         if (!acpi_evalf(hkey_handle, &mode, "GTRW", "dd", 0)) {
3586                 pr_err("Cannot read adaptive keyboard mode\n");
3587                 return -EIO;
3588         }
3589 
3590         return mode;
3591 }
3592 
3593 static int adaptive_keyboard_set_mode(int new_mode)
3594 {
3595         if (new_mode < 0 ||
3596                 new_mode > LAYFLAT_MODE)
3597                 return -EINVAL;
3598 
3599         if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3600                 pr_err("Cannot set adaptive keyboard mode\n");
3601                 return -EIO;
3602         }
3603 
3604         return 0;
3605 }
3606 
3607 static int adaptive_keyboard_get_next_mode(int mode)
3608 {
3609         size_t i;
3610         size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3611 
3612         for (i = 0; i <= max_mode; i++) {
3613                 if (adaptive_keyboard_modes[i] == mode)
3614                         break;
3615         }
3616 
3617         if (i >= max_mode)
3618                 i = 0;
3619         else
3620                 i++;
3621 
3622         return adaptive_keyboard_modes[i];
3623 }
3624 
3625 static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3626 {
3627         int current_mode = 0;
3628         int new_mode = 0;
3629         int keycode;
3630 
3631         switch (scancode) {
3632         case DFR_CHANGE_ROW:
3633                 if (adaptive_keyboard_mode_is_saved) {
3634                         new_mode = adaptive_keyboard_prev_mode;
3635                         adaptive_keyboard_mode_is_saved = false;
3636                 } else {
3637                         current_mode = adaptive_keyboard_get_mode();
3638                         if (current_mode < 0)
3639                                 return false;
3640                         new_mode = adaptive_keyboard_get_next_mode(
3641                                         current_mode);
3642                 }
3643 
3644                 if (adaptive_keyboard_set_mode(new_mode) < 0)
3645                         return false;
3646 
3647                 return true;
3648 
3649         case DFR_SHOW_QUICKVIEW_ROW:
3650                 current_mode = adaptive_keyboard_get_mode();
3651                 if (current_mode < 0)
3652                         return false;
3653 
3654                 adaptive_keyboard_prev_mode = current_mode;
3655                 adaptive_keyboard_mode_is_saved = true;
3656 
3657                 if (adaptive_keyboard_set_mode (FUNCTION_MODE) < 0)
3658                         return false;
3659                 return true;
3660 
3661         default:
3662                 if (scancode < FIRST_ADAPTIVE_KEY ||
3663                     scancode >= FIRST_ADAPTIVE_KEY + TPACPI_HOTKEY_MAP_LEN -
3664                                 ADAPTIVE_KEY_OFFSET) {
3665                         pr_info("Unhandled adaptive keyboard key: 0x%x\n",
3666                                         scancode);
3667                         return false;
3668                 }
3669                 keycode = hotkey_keycode_map[scancode - FIRST_ADAPTIVE_KEY + ADAPTIVE_KEY_OFFSET];
3670                 if (keycode != KEY_RESERVED) {
3671                         mutex_lock(&tpacpi_inputdev_send_mutex);
3672 
3673                         input_report_key(tpacpi_inputdev, keycode, 1);
3674                         input_sync(tpacpi_inputdev);
3675 
3676                         input_report_key(tpacpi_inputdev, keycode, 0);
3677                         input_sync(tpacpi_inputdev);
3678 
3679                         mutex_unlock(&tpacpi_inputdev_send_mutex);
3680                 }
3681                 return true;
3682         }
3683 }
3684 
3685 static bool hotkey_notify_hotkey(const u32 hkey,
3686                                  bool *send_acpi_ev,
3687                                  bool *ignore_acpi_ev)
3688 {
3689         /* 0x1000-0x1FFF: key presses */
3690         unsigned int scancode = hkey & 0xfff;
3691         *send_acpi_ev = true;
3692         *ignore_acpi_ev = false;
3693 
3694         /* HKEY event 0x1001 is scancode 0x00 */
3695         if (scancode > 0 && scancode <= TPACPI_HOTKEY_MAP_LEN) {
3696                 scancode--;
3697                 if (!(hotkey_source_mask & (1 << scancode))) {
3698                         tpacpi_input_send_key_masked(scancode);
3699                         *send_acpi_ev = false;
3700                 } else {
3701                         *ignore_acpi_ev = true;
3702                 }
3703                 return true;
3704         } else {
3705                 return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3706         }
3707         return false;
3708 }
3709 
3710 static bool hotkey_notify_wakeup(const u32 hkey,
3711                                  bool *send_acpi_ev,
3712                                  bool *ignore_acpi_ev)
3713 {
3714         /* 0x2000-0x2FFF: Wakeup reason */
3715         *send_acpi_ev = true;
3716         *ignore_acpi_ev = false;
3717 
3718         switch (hkey) {
3719         case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3720         case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3721                 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3722                 *ignore_acpi_ev = true;
3723                 break;
3724 
3725         case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3726         case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3727                 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3728                 *ignore_acpi_ev = true;
3729                 break;
3730 
3731         case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3732         case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3733                 pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3734                 /* how to auto-heal: */
3735                 /* 2313: woke up from S3, go to S4/S5 */
3736                 /* 2413: woke up from S4, go to S5 */
3737                 break;
3738 
3739         default:
3740                 return false;
3741         }
3742 
3743         if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3744                 pr_info("woke up due to a hot-unplug request...\n");
3745                 hotkey_wakeup_reason_notify_change();
3746         }
3747         return true;
3748 }
3749 
3750 static bool hotkey_notify_dockevent(const u32 hkey,
3751                                  bool *send_acpi_ev,
3752                                  bool *ignore_acpi_ev)
3753 {
3754         /* 0x4000-0x4FFF: dock-related events */
3755         *send_acpi_ev = true;
3756         *ignore_acpi_ev = false;
3757 
3758         switch (hkey) {
3759         case TP_HKEY_EV_UNDOCK_ACK:
3760                 /* ACPI undock operation completed after wakeup */
3761                 hotkey_autosleep_ack = 1;
3762                 pr_info("undocked\n");
3763                 hotkey_wakeup_hotunplug_complete_notify_change();
3764                 return true;
3765 
3766         case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3767                 pr_info("docked into hotplug port replicator\n");
3768                 return true;
3769         case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3770                 pr_info("undocked from hotplug port replicator\n");
3771                 return true;
3772 
3773         default:
3774                 return false;
3775         }
3776 }
3777 
3778 static bool hotkey_notify_usrevent(const u32 hkey,
3779                                  bool *send_acpi_ev,
3780                                  bool *ignore_acpi_ev)
3781 {
3782         /* 0x5000-0x5FFF: human interface helpers */
3783         *send_acpi_ev = true;
3784         *ignore_acpi_ev = false;
3785 
3786         switch (hkey) {
3787         case TP_HKEY_EV_PEN_INSERTED:  /* X61t: tablet pen inserted into bay */
3788         case TP_HKEY_EV_PEN_REMOVED:   /* X61t: tablet pen removed from bay */
3789                 return true;
3790 
3791         case TP_HKEY_EV_TABLET_TABLET:   /* X41t-X61t: tablet mode */
3792         case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3793                 tpacpi_input_send_tabletsw();
3794                 hotkey_tablet_mode_notify_change();
3795                 *send_acpi_ev = false;
3796                 return true;
3797 
3798         case TP_HKEY_EV_LID_CLOSE:      /* Lid closed */
3799         case TP_HKEY_EV_LID_OPEN:       /* Lid opened */
3800         case TP_HKEY_EV_BRGHT_CHANGED:  /* brightness changed */
3801                 /* do not propagate these events */
3802                 *ignore_acpi_ev = true;
3803                 return true;
3804 
3805         default:
3806                 return false;
3807         }
3808 }
3809 
3810 static void thermal_dump_all_sensors(void);
3811 
3812 static bool hotkey_notify_6xxx(const u32 hkey,
3813                                  bool *send_acpi_ev,
3814                                  bool *ignore_acpi_ev)
3815 {
3816         bool known = true;
3817 
3818         /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
3819         *send_acpi_ev = true;
3820         *ignore_acpi_ev = false;
3821 
3822         switch (hkey) {
3823         case TP_HKEY_EV_THM_TABLE_CHANGED:
3824                 pr_info("EC reports that Thermal Table has changed\n");
3825                 /* recommended action: do nothing, we don't have
3826                  * Lenovo ATM information */
3827                 return true;
3828         case TP_HKEY_EV_ALARM_BAT_HOT:
3829                 pr_crit("THERMAL ALARM: battery is too hot!\n");
3830                 /* recommended action: warn user through gui */
3831                 break;
3832         case TP_HKEY_EV_ALARM_BAT_XHOT:
3833                 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
3834                 /* recommended action: immediate sleep/hibernate */
3835                 break;
3836         case TP_HKEY_EV_ALARM_SENSOR_HOT:
3837                 pr_crit("THERMAL ALARM: "
3838                         "a sensor reports something is too hot!\n");
3839                 /* recommended action: warn user through gui, that */
3840                 /* some internal component is too hot */
3841                 break;
3842         case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3843                 pr_alert("THERMAL EMERGENCY: "
3844                          "a sensor reports something is extremely hot!\n");
3845                 /* recommended action: immediate sleep/hibernate */
3846                 break;
3847         case TP_HKEY_EV_AC_CHANGED:
3848                 /* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
3849                  * AC status changed; can be triggered by plugging or
3850                  * unplugging AC adapter, docking or undocking. */
3851 
3852                 /* fallthrough */
3853 
3854         case TP_HKEY_EV_KEY_NUMLOCK:
3855         case TP_HKEY_EV_KEY_FN:
3856         case TP_HKEY_EV_KEY_FN_ESC:
3857                 /* key press events, we just ignore them as long as the EC
3858                  * is still reporting them in the normal keyboard stream */
3859                 *send_acpi_ev = false;
3860                 *ignore_acpi_ev = true;
3861                 return true;
3862 
3863         default:
3864                 pr_warn("unknown possible thermal alarm or keyboard event received\n");
3865                 known = false;
3866         }
3867 
3868         thermal_dump_all_sensors();
3869 
3870         return known;
3871 }
3872 
3873 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3874 {
3875         u32 hkey;
3876         bool send_acpi_ev;
3877         bool ignore_acpi_ev;
3878         bool known_ev;
3879 
3880         if (event != 0x80) {
3881                 pr_err("unknown HKEY notification event %d\n", event);
3882                 /* forward it to userspace, maybe it knows how to handle it */
3883                 acpi_bus_generate_netlink_event(
3884                                         ibm->acpi->device->pnp.device_class,
3885                                         dev_name(&ibm->acpi->device->dev),
3886                                         event, 0);
3887                 return;
3888         }
3889 
3890         while (1) {
3891                 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3892                         pr_err("failed to retrieve HKEY event\n");
3893                         return;
3894                 }
3895 
3896                 if (hkey == 0) {
3897                         /* queue empty */
3898                         return;
3899                 }
3900 
3901                 send_acpi_ev = true;
3902                 ignore_acpi_ev = false;
3903 
3904                 switch (hkey >> 12) {
3905                 case 1:
3906                         /* 0x1000-0x1FFF: key presses */
3907                         known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3908                                                  &ignore_acpi_ev);
3909                         break;
3910                 case 2:
3911                         /* 0x2000-0x2FFF: Wakeup reason */
3912                         known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3913                                                  &ignore_acpi_ev);
3914                         break;
3915                 case 3:
3916                         /* 0x3000-0x3FFF: bay-related wakeups */
3917                         switch (hkey) {
3918                         case TP_HKEY_EV_BAYEJ_ACK:
3919                                 hotkey_autosleep_ack = 1;
3920                                 pr_info("bay ejected\n");
3921                                 hotkey_wakeup_hotunplug_complete_notify_change();
3922                                 known_ev = true;
3923                                 break;
3924                         case TP_HKEY_EV_OPTDRV_EJ:
3925                                 /* FIXME: kick libata if SATA link offline */
3926                                 known_ev = true;
3927                                 break;
3928                         default:
3929                                 known_ev = false;
3930                         }
3931                         break;
3932                 case 4:
3933                         /* 0x4000-0x4FFF: dock-related events */
3934                         known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
3935                                                 &ignore_acpi_ev);
3936                         break;
3937                 case 5:
3938                         /* 0x5000-0x5FFF: human interface helpers */
3939                         known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3940                                                  &ignore_acpi_ev);
3941                         break;
3942                 case 6:
3943                         /* 0x6000-0x6FFF: thermal alarms/notices and
3944                          *                keyboard events */
3945                         known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
3946                                                  &ignore_acpi_ev);
3947                         break;
3948                 case 7:
3949                         /* 0x7000-0x7FFF: misc */
3950                         if (tp_features.hotkey_wlsw &&
3951                                         hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3952                                 tpacpi_send_radiosw_update();
3953                                 send_acpi_ev = 0;
3954                                 known_ev = true;
3955                                 break;
3956                         }
3957                         /* fallthrough to default */
3958                 default:
3959                         known_ev = false;
3960                 }
3961                 if (!known_ev) {
3962                         pr_notice("unhandled HKEY event 0x%04x\n", hkey);
3963                         pr_notice("please report the conditions when this "
3964                                   "event happened to %s\n", TPACPI_MAIL);
3965                 }
3966 
3967                 /* netlink events */
3968                 if (!ignore_acpi_ev && send_acpi_ev) {
3969                         acpi_bus_generate_netlink_event(
3970                                         ibm->acpi->device->pnp.device_class,
3971                                         dev_name(&ibm->acpi->device->dev),
3972                                         event, hkey);
3973                 }
3974         }
3975 }
3976 
3977 static void hotkey_suspend(void)
3978 {
3979         /* Do these on suspend, we get the events on early resume! */
3980         hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3981         hotkey_autosleep_ack = 0;
3982 
3983         /* save previous mode of adaptive keyboard of X1 Carbon */
3984         if (tp_features.has_adaptive_kbd) {
3985                 if (!acpi_evalf(hkey_handle, &adaptive_keyboard_prev_mode,
3986                                         "GTRW", "dd", 0)) {
3987                         pr_err("Cannot read adaptive keyboard mode.\n");
3988                 }
3989         }
3990 }
3991 
3992 static void hotkey_resume(void)
3993 {
3994         tpacpi_disable_brightness_delay();
3995 
3996         if (hotkey_status_set(true) < 0 ||
3997             hotkey_mask_set(hotkey_acpi_mask) < 0)
3998                 pr_err("error while attempting to reset the event "
3999                        "firmware interface\n");
4000 
4001         tpacpi_send_radiosw_update();
4002         hotkey_tablet_mode_notify_change();
4003         hotkey_wakeup_reason_notify_change();
4004         hotkey_wakeup_hotunplug_complete_notify_change();
4005         hotkey_poll_setup_safe(false);
4006 
4007         /* restore previous mode of adapive keyboard of X1 Carbon */
4008         if (tp_features.has_adaptive_kbd) {
4009                 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd",
4010                                         adaptive_keyboard_prev_mode)) {
4011                         pr_err("Cannot set adaptive keyboard mode.\n");
4012                 }
4013         }
4014 }
4015 
4016 /* procfs -------------------------------------------------------------- */
4017 static int hotkey_read(struct seq_file *m)
4018 {
4019         int res, status;
4020 
4021         if (!tp_features.hotkey) {
4022                 seq_printf(m, "status:\t\tnot supported\n");
4023                 return 0;
4024         }
4025 
4026         if (mutex_lock_killable(&hotkey_mutex))
4027                 return -ERESTARTSYS;
4028         res = hotkey_status_get(&status);
4029         if (!res)
4030                 res = hotkey_mask_get();
4031         mutex_unlock(&hotkey_mutex);
4032         if (res)
4033                 return res;
4034 
4035         seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
4036         if (hotkey_all_mask) {
4037                 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
4038                 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
4039         } else {
4040                 seq_printf(m, "mask:\t\tnot supported\n");
4041                 seq_printf(m, "commands:\tenable, disable, reset\n");
4042         }
4043 
4044         return 0;
4045 }
4046 
4047 static void hotkey_enabledisable_warn(bool enable)
4048 {
4049         tpacpi_log_usertask("procfs hotkey enable/disable");
4050         if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
4051                   pr_fmt("hotkey enable/disable functionality has been "
4052                          "removed from the driver.  "
4053                          "Hotkeys are always enabled.\n")))
4054                 pr_err("Please remove the hotkey=enable module "
4055                        "parameter, it is deprecated.  "
4056                        "Hotkeys are always enabled.\n");
4057 }
4058 
4059 static int hotkey_write(char *buf)
4060 {
4061         int res;
4062         u32 mask;
4063         char *cmd;
4064 
4065         if (!tp_features.hotkey)
4066                 return -ENODEV;
4067 
4068         if (mutex_lock_killable(&hotkey_mutex))
4069                 return -ERESTARTSYS;
4070 
4071         mask = hotkey_user_mask;
4072 
4073         res = 0;
4074         while ((cmd = next_cmd(&buf))) {
4075                 if (strlencmp(cmd, "enable") == 0) {
4076                         hotkey_enabledisable_warn(1);
4077                 } else if (strlencmp(cmd, "disable") == 0) {
4078                         hotkey_enabledisable_warn(0);
4079                         res = -EPERM;
4080                 } else if (strlencmp(cmd, "reset") == 0) {
4081                         mask = (hotkey_all_mask | hotkey_source_mask)
4082                                 & ~hotkey_reserved_mask;
4083                 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
4084                         /* mask set */
4085                 } else if (sscanf(cmd, "%x", &mask) == 1) {
4086                         /* mask set */
4087                 } else {
4088                         res = -EINVAL;
4089                         goto errexit;
4090                 }
4091         }
4092 
4093         if (!res) {
4094                 tpacpi_disclose_usertask("procfs hotkey",
4095                         "set mask to 0x%08x\n", mask);
4096                 res = hotkey_user_mask_set(mask);
4097         }
4098 
4099 errexit:
4100         mutex_unlock(&hotkey_mutex);
4101         return res;
4102 }
4103 
4104 static const struct acpi_device_id ibm_htk_device_ids[] = {
4105         {TPACPI_ACPI_IBM_HKEY_HID, 0},
4106         {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
4107         {"", 0},
4108 };
4109 
4110 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
4111         .hid = ibm_htk_device_ids,
4112         .notify = hotkey_notify,
4113         .handle = &hkey_handle,
4114         .type = ACPI_DEVICE_NOTIFY,
4115 };
4116 
4117 static struct ibm_struct hotkey_driver_data = {
4118         .name = "hotkey",
4119         .read = hotkey_read,
4120         .write = hotkey_write,
4121         .exit = hotkey_exit,
4122         .resume = hotkey_resume,
4123         .suspend = hotkey_suspend,
4124         .acpi = &ibm_hotkey_acpidriver,
4125 };
4126 
4127 /*************************************************************************
4128  * Bluetooth subdriver
4129  */
4130 
4131 enum {
4132         /* ACPI GBDC/SBDC bits */
4133         TP_ACPI_BLUETOOTH_HWPRESENT     = 0x01, /* Bluetooth hw available */
4134         TP_ACPI_BLUETOOTH_RADIOSSW      = 0x02, /* Bluetooth radio enabled */
4135         TP_ACPI_BLUETOOTH_RESUMECTRL    = 0x04, /* Bluetooth state at resume:
4136                                                    0 = disable, 1 = enable */
4137 };
4138 
4139 enum {
4140         /* ACPI \BLTH commands */
4141         TP_ACPI_BLTH_GET_ULTRAPORT_ID   = 0x00, /* Get Ultraport BT ID */
4142         TP_ACPI_BLTH_GET_PWR_ON_RESUME  = 0x01, /* Get power-on-resume state */
4143         TP_ACPI_BLTH_PWR_ON_ON_RESUME   = 0x02, /* Resume powered on */
4144         TP_ACPI_BLTH_PWR_OFF_ON_RESUME  = 0x03, /* Resume powered off */
4145         TP_ACPI_BLTH_SAVE_STATE         = 0x05, /* Save state for S4/S5 */
4146 };
4147 
4148 #define TPACPI_RFK_BLUETOOTH_SW_NAME    "tpacpi_bluetooth_sw"
4149 
4150 static int bluetooth_get_status(void)
4151 {
4152         int status;
4153 
4154 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4155         if (dbg_bluetoothemul)
4156                 return (tpacpi_bluetooth_emulstate) ?
4157                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4158 #endif
4159 
4160         if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4161                 return -EIO;
4162 
4163         return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4164                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4165 }
4166 
4167 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4168 {
4169         int status;
4170 
4171         vdbg_printk(TPACPI_DBG_RFKILL,
4172                 "will attempt to %s bluetooth\n",
4173                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4174 
4175 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4176         if (dbg_bluetoothemul) {
4177                 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4178                 return 0;
4179         }
4180 #endif
4181 
4182         if (state == TPACPI_RFK_RADIO_ON)
4183                 status = TP_ACPI_BLUETOOTH_RADIOSSW
4184                           | TP_ACPI_BLUETOOTH_RESUMECTRL;
4185         else
4186                 status = 0;
4187 
4188         if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4189                 return -EIO;
4190 
4191         return 0;
4192 }
4193 
4194 /* sysfs bluetooth enable ---------------------------------------------- */
4195 static ssize_t bluetooth_enable_show(struct device *dev,
4196                            struct device_attribute *attr,
4197                            char *buf)
4198 {
4199         return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4200                         attr, buf);
4201 }
4202 
4203 static ssize_t bluetooth_enable_store(struct device *dev,
4204                             struct device_attribute *attr,
4205                             const char *buf, size_t count)
4206 {
4207         return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4208                                 attr, buf, count);
4209 }
4210 
4211 static DEVICE_ATTR_RW(bluetooth_enable);
4212 
4213 /* --------------------------------------------------------------------- */
4214 
4215 static struct attribute *bluetooth_attributes[] = {
4216         &dev_attr_bluetooth_enable.attr,
4217         NULL
4218 };
4219 
4220 static const struct attribute_group bluetooth_attr_group = {
4221         .attrs = bluetooth_attributes,
4222 };
4223 
4224 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4225         .get_status = bluetooth_get_status,
4226         .set_status = bluetooth_set_status,
4227 };
4228 
4229 static void bluetooth_shutdown(void)
4230 {
4231         /* Order firmware to save current state to NVRAM */
4232         if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4233                         TP_ACPI_BLTH_SAVE_STATE))
4234                 pr_notice("failed to save bluetooth state to NVRAM\n");
4235         else
4236                 vdbg_printk(TPACPI_DBG_RFKILL,
4237                         "bluetooth state saved to NVRAM\n");
4238 }
4239 
4240 static void bluetooth_exit(void)
4241 {
4242         sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4243                         &bluetooth_attr_group);
4244 
4245         tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4246 
4247         bluetooth_shutdown();
4248 }
4249 
4250 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4251 {
4252         int res;
4253         int status = 0;
4254 
4255         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4256                         "initializing bluetooth subdriver\n");
4257 
4258         TPACPI_ACPIHANDLE_INIT(hkey);
4259 
4260         /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4261            G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4262         tp_features.bluetooth = hkey_handle &&
4263             acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4264 
4265         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4266                 "bluetooth is %s, status 0x%02x\n",
4267                 str_supported(tp_features.bluetooth),
4268                 status);
4269 
4270 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4271         if (dbg_bluetoothemul) {
4272                 tp_features.bluetooth = 1;
4273                 pr_info("bluetooth switch emulation enabled\n");
4274         } else
4275 #endif
4276         if (tp_features.bluetooth &&
4277             !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4278                 /* no bluetooth hardware present in system */
4279                 tp_features.bluetooth = 0;
4280                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4281                            "bluetooth hardware not installed\n");
4282         }
4283 
4284         if (!tp_features.bluetooth)
4285                 return 1;
4286 
4287         res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4288                                 &bluetooth_tprfk_ops,
4289                                 RFKILL_TYPE_BLUETOOTH,
4290                                 TPACPI_RFK_BLUETOOTH_SW_NAME,
4291                                 true);
4292         if (res)
4293                 return res;
4294 
4295         res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4296                                 &bluetooth_attr_group);
4297         if (res) {
4298                 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4299                 return res;
4300         }
4301 
4302         return 0;
4303 }
4304 
4305 /* procfs -------------------------------------------------------------- */
4306 static int bluetooth_read(struct seq_file *m)
4307 {
4308         return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4309 }
4310 
4311 static int bluetooth_write(char *buf)
4312 {
4313         return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4314 }
4315 
4316 static struct ibm_struct bluetooth_driver_data = {
4317         .name = "bluetooth",
4318         .read = bluetooth_read,
4319         .write = bluetooth_write,
4320         .exit = bluetooth_exit,
4321         .shutdown = bluetooth_shutdown,
4322 };
4323 
4324 /*************************************************************************
4325  * Wan subdriver
4326  */
4327 
4328 enum {
4329         /* ACPI GWAN/SWAN bits */
4330         TP_ACPI_WANCARD_HWPRESENT       = 0x01, /* Wan hw available */
4331         TP_ACPI_WANCARD_RADIOSSW        = 0x02, /* Wan radio enabled */
4332         TP_ACPI_WANCARD_RESUMECTRL      = 0x04, /* Wan state at resume:
4333                                                    0 = disable, 1 = enable */
4334 };
4335 
4336 #define TPACPI_RFK_WWAN_SW_NAME         "tpacpi_wwan_sw"
4337 
4338 static int wan_get_status(void)
4339 {
4340         int status;
4341 
4342 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4343         if (dbg_wwanemul)
4344                 return (tpacpi_wwan_emulstate) ?
4345                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4346 #endif
4347 
4348         if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4349                 return -EIO;
4350 
4351         return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4352                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4353 }
4354 
4355 static int wan_set_status(enum tpacpi_rfkill_state state)
4356 {
4357         int status;
4358 
4359         vdbg_printk(TPACPI_DBG_RFKILL,
4360                 "will attempt to %s wwan\n",
4361                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4362 
4363 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4364         if (dbg_wwanemul) {
4365                 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4366                 return 0;
4367         }
4368 #endif
4369 
4370         if (state == TPACPI_RFK_RADIO_ON)
4371                 status = TP_ACPI_WANCARD_RADIOSSW
4372                          | TP_ACPI_WANCARD_RESUMECTRL;
4373         else
4374                 status = 0;
4375 
4376         if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4377                 return -EIO;
4378 
4379         return 0;
4380 }
4381 
4382 /* sysfs wan enable ---------------------------------------------------- */
4383 static ssize_t wan_enable_show(struct device *dev,
4384                            struct device_attribute *attr,
4385                            char *buf)
4386 {
4387         return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4388                         attr, buf);
4389 }
4390 
4391 static ssize_t wan_enable_store(struct device *dev,
4392                             struct device_attribute *attr,
4393                             const char *buf, size_t count)
4394 {
4395         return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4396                         attr, buf, count);
4397 }
4398 
4399 static DEVICE_ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4400                    wan_enable_show, wan_enable_store);
4401 
4402 /* --------------------------------------------------------------------- */
4403 
4404 static struct attribute *wan_attributes[] = {
4405         &dev_attr_wwan_enable.attr,
4406         NULL
4407 };
4408 
4409 static const struct attribute_group wan_attr_group = {
4410         .attrs = wan_attributes,
4411 };
4412 
4413 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4414         .get_status = wan_get_status,
4415         .set_status = wan_set_status,
4416 };
4417 
4418 static void wan_shutdown(void)
4419 {
4420         /* Order firmware to save current state to NVRAM */
4421         if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4422                         TP_ACPI_WGSV_SAVE_STATE))
4423                 pr_notice("failed to save WWAN state to NVRAM\n");
4424         else
4425                 vdbg_printk(TPACPI_DBG_RFKILL,
4426                         "WWAN state saved to NVRAM\n");
4427 }
4428 
4429 static void wan_exit(void)
4430 {
4431         sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4432                 &wan_attr_group);
4433 
4434         tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4435 
4436         wan_shutdown();
4437 }
4438 
4439 static int __init wan_init(struct ibm_init_struct *iibm)
4440 {
4441         int res;
4442         int status = 0;
4443 
4444         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4445                         "initializing wan subdriver\n");
4446 
4447         TPACPI_ACPIHANDLE_INIT(hkey);
4448 
4449         tp_features.wan = hkey_handle &&
4450             acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4451 
4452         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4453                 "wan is %s, status 0x%02x\n",
4454                 str_supported(tp_features.wan),
4455                 status);
4456 
4457 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4458         if (dbg_wwanemul) {
4459                 tp_features.wan = 1;
4460                 pr_info("wwan switch emulation enabled\n");
4461         } else
4462 #endif
4463         if (tp_features.wan &&
4464             !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4465                 /* no wan hardware present in system */
4466                 tp_features.wan = 0;
4467                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4468                            "wan hardware not installed\n");
4469         }
4470 
4471         if (!tp_features.wan)
4472                 return 1;
4473 
4474         res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4475                                 &wan_tprfk_ops,
4476                                 RFKILL_TYPE_WWAN,
4477                                 TPACPI_RFK_WWAN_SW_NAME,
4478                                 true);
4479         if (res)
4480                 return res;
4481 
4482         res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4483                                 &wan_attr_group);
4484 
4485         if (res) {
4486                 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4487                 return res;
4488         }
4489 
4490         return 0;
4491 }
4492 
4493 /* procfs -------------------------------------------------------------- */
4494 static int wan_read(struct seq_file *m)
4495 {
4496         return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4497 }
4498 
4499 static int wan_write(char *buf)
4500 {
4501         return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4502 }
4503 
4504 static struct ibm_struct wan_driver_data = {
4505         .name = "wan",
4506         .read = wan_read,
4507         .write = wan_write,
4508         .exit = wan_exit,
4509         .shutdown = wan_shutdown,
4510 };
4511 
4512 /*************************************************************************
4513  * UWB subdriver
4514  */
4515 
4516 enum {
4517         /* ACPI GUWB/SUWB bits */
4518         TP_ACPI_UWB_HWPRESENT   = 0x01, /* UWB hw available */
4519         TP_ACPI_UWB_RADIOSSW    = 0x02, /* UWB radio enabled */
4520 };
4521 
4522 #define TPACPI_RFK_UWB_SW_NAME  "tpacpi_uwb_sw"
4523 
4524 static int uwb_get_status(void)
4525 {
4526         int status;
4527 
4528 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4529         if (dbg_uwbemul)
4530                 return (tpacpi_uwb_emulstate) ?
4531                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4532 #endif
4533 
4534         if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4535                 return -EIO;
4536 
4537         return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4538                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4539 }
4540 
4541 static int uwb_set_status(enum tpacpi_rfkill_state state)
4542 {
4543         int status;
4544 
4545         vdbg_printk(TPACPI_DBG_RFKILL,
4546                 "will attempt to %s UWB\n",
4547                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4548 
4549 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4550         if (dbg_uwbemul) {
4551                 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4552                 return 0;
4553         }
4554 #endif
4555 
4556         if (state == TPACPI_RFK_RADIO_ON)
4557                 status = TP_ACPI_UWB_RADIOSSW;
4558         else
4559                 status = 0;
4560 
4561         if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4562                 return -EIO;
4563 
4564         return 0;
4565 }
4566 
4567 /* --------------------------------------------------------------------- */
4568 
4569 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4570         .get_status = uwb_get_status,
4571         .set_status = uwb_set_status,
4572 };
4573 
4574 static void uwb_exit(void)
4575 {
4576         tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4577 }
4578 
4579 static int __init uwb_init(struct ibm_init_struct *iibm)
4580 {
4581         int res;
4582         int status = 0;
4583 
4584         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4585                         "initializing uwb subdriver\n");
4586 
4587         TPACPI_ACPIHANDLE_INIT(hkey);
4588 
4589         tp_features.uwb = hkey_handle &&
4590             acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4591 
4592         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4593                 "uwb is %s, status 0x%02x\n",
4594                 str_supported(tp_features.uwb),
4595                 status);
4596 
4597 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4598         if (dbg_uwbemul) {
4599                 tp_features.uwb = 1;
4600                 pr_info("uwb switch emulation enabled\n");
4601         } else
4602 #endif
4603         if (tp_features.uwb &&
4604             !(status & TP_ACPI_UWB_HWPRESENT)) {
4605                 /* no uwb hardware present in system */
4606                 tp_features.uwb = 0;
4607                 dbg_printk(TPACPI_DBG_INIT,
4608                            "uwb hardware not installed\n");
4609         }
4610 
4611         if (!tp_features.uwb)
4612                 return 1;
4613 
4614         res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4615                                 &uwb_tprfk_ops,
4616                                 RFKILL_TYPE_UWB,
4617                                 TPACPI_RFK_UWB_SW_NAME,
4618                                 false);
4619         return res;
4620 }
4621 
4622 static struct ibm_struct uwb_driver_data = {
4623         .name = "uwb",
4624         .exit = uwb_exit,
4625         .flags.experimental = 1,
4626 };
4627 
4628 /*************************************************************************
4629  * Video subdriver
4630  */
4631 
4632 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4633 
4634 enum video_access_mode {
4635         TPACPI_VIDEO_NONE = 0,
4636         TPACPI_VIDEO_570,       /* 570 */
4637         TPACPI_VIDEO_770,       /* 600e/x, 770e, 770x */
4638         TPACPI_VIDEO_NEW,       /* all others */
4639 };
4640 
4641 enum {  /* video status flags, based on VIDEO_570 */
4642         TP_ACPI_VIDEO_S_LCD = 0x01,     /* LCD output enabled */
4643         TP_ACPI_VIDEO_S_CRT = 0x02,     /* CRT output enabled */
4644         TP_ACPI_VIDEO_S_DVI = 0x08,     /* DVI output enabled */
4645 };
4646 
4647 enum {  /* TPACPI_VIDEO_570 constants */
4648         TP_ACPI_VIDEO_570_PHSCMD = 0x87,        /* unknown magic constant :( */
4649         TP_ACPI_VIDEO_570_PHSMASK = 0x03,       /* PHS bits that map to
4650                                                  * video_status_flags */
4651         TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,       /* unknown magic constant :( */
4652         TP_ACPI_VIDEO_570_PHS2SET = 0x80,       /* unknown magic constant :( */
4653 };
4654 
4655 static enum video_access_mode video_supported;
4656 static int video_orig_autosw;
4657 
4658 static int video_autosw_get(void);
4659 static int video_autosw_set(int enable);
4660 
4661 TPACPI_HANDLE(vid, root,
4662               "\\_SB.PCI.AGP.VGA",      /* 570 */
4663               "\\_SB.PCI0.AGP0.VID0",   /* 600e/x, 770x */
4664               "\\_SB.PCI0.VID0",        /* 770e */
4665               "\\_SB.PCI0.VID",         /* A21e, G4x, R50e, X30, X40 */
4666               "\\_SB.PCI0.AGP.VGA",     /* X100e and a few others */
4667               "\\_SB.PCI0.AGP.VID",     /* all others */
4668         );                              /* R30, R31 */
4669 
4670 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID");       /* G41 */
4671 
4672 static int __init video_init(struct ibm_init_struct *iibm)
4673 {
4674         int ivga;
4675 
4676         vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4677 
4678         TPACPI_ACPIHANDLE_INIT(vid);
4679         if (tpacpi_is_ibm())
4680                 TPACPI_ACPIHANDLE_INIT(vid2);
4681 
4682         if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4683                 /* G41, assume IVGA doesn't change */
4684                 vid_handle = vid2_handle;
4685 
4686         if (!vid_handle)
4687                 /* video switching not supported on R30, R31 */
4688                 video_supported = TPACPI_VIDEO_NONE;
4689         else if (tpacpi_is_ibm() &&
4690                  acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4691                 /* 570 */
4692                 video_supported = TPACPI_VIDEO_570;
4693         else if (tpacpi_is_ibm() &&
4694                  acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4695                 /* 600e/x, 770e, 770x */
4696                 video_supported = TPACPI_VIDEO_770;
4697         else
4698                 /* all others */
4699                 video_supported = TPACPI_VIDEO_NEW;
4700 
4701         vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4702                 str_supported(video_supported != TPACPI_VIDEO_NONE),
4703                 video_supported);
4704 
4705         return (video_supported != TPACPI_VIDEO_NONE) ? 0 : 1;
4706 }
4707 
4708 static void video_exit(void)
4709 {
4710         dbg_printk(TPACPI_DBG_EXIT,
4711                    "restoring original video autoswitch mode\n");
4712         if (video_autosw_set(video_orig_autosw))
4713                 pr_err("error while trying to restore original "
4714                         "video autoswitch mode\n");
4715 }
4716 
4717 static int video_outputsw_get(void)
4718 {
4719         int status = 0;
4720         int i;
4721 
4722         switch (video_supported) {
4723         case TPACPI_VIDEO_570:
4724                 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4725                                  TP_ACPI_VIDEO_570_PHSCMD))
4726                         return -EIO;
4727                 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4728                 break;
4729         case TPACPI_VIDEO_770:
4730                 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4731                         return -EIO;
4732                 if (i)
4733                         status |= TP_ACPI_VIDEO_S_LCD;
4734                 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4735                         return -EIO;
4736                 if (i)
4737                         status |= TP_ACPI_VIDEO_S_CRT;
4738                 break;
4739         case TPACPI_VIDEO_NEW:
4740                 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4741                     !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4742                         return -EIO;
4743                 if (i)
4744                         status |= TP_ACPI_VIDEO_S_CRT;
4745 
4746                 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4747                     !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4748                         return -EIO;
4749                 if (i)
4750                         status |= TP_ACPI_VIDEO_S_LCD;
4751                 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4752                         return -EIO;
4753                 if (i)
4754                         status |= TP_ACPI_VIDEO_S_DVI;
4755                 break;
4756         default:
4757                 return -ENOSYS;
4758         }
4759 
4760         return status;
4761 }
4762 
4763 static int video_outputsw_set(int status)
4764 {
4765         int autosw;
4766         int res = 0;
4767 
4768         switch (video_supported) {
4769         case TPACPI_VIDEO_570:
4770                 res = acpi_evalf(NULL, NULL,
4771                                  "\\_SB.PHS2", "vdd",
4772                                  TP_ACPI_VIDEO_570_PHS2CMD,
4773                                  status | TP_ACPI_VIDEO_570_PHS2SET);
4774                 break;
4775         case TPACPI_VIDEO_770:
4776                 autosw = video_autosw_get();
4777                 if (autosw < 0)
4778                         return autosw;
4779 
4780                 res = video_autosw_set(1);
4781                 if (res)
4782                         return res;
4783                 res = acpi_evalf(vid_handle, NULL,
4784                                  "ASWT", "vdd", status * 0x100, 0);
4785                 if (!autosw && video_autosw_set(autosw)) {
4786                         pr_err("video auto-switch left enabled due to error\n");
4787                         return -EIO;
4788                 }
4789                 break;
4790         case TPACPI_VIDEO_NEW:
4791                 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4792                       acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4793                 break;
4794         default:
4795                 return -ENOSYS;
4796         }
4797 
4798         return (res) ? 0 : -EIO;
4799 }
4800 
4801 static int video_autosw_get(void)
4802 {
4803         int autosw = 0;
4804 
4805         switch (video_supported) {
4806         case TPACPI_VIDEO_570:
4807                 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4808                         return -EIO;
4809                 break;
4810         case TPACPI_VIDEO_770:
4811         case TPACPI_VIDEO_NEW:
4812                 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4813                         return -EIO;
4814                 break;
4815         default:
4816                 return -ENOSYS;
4817         }
4818 
4819         return autosw & 1;
4820 }
4821 
4822 static int video_autosw_set(int enable)
4823 {
4824         if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable) ? 1 : 0))
4825                 return -EIO;
4826         return 0;
4827 }
4828 
4829 static int video_outputsw_cycle(void)
4830 {
4831         int autosw = video_autosw_get();
4832         int res;
4833 
4834         if (autosw < 0)
4835                 return autosw;
4836 
4837         switch (video_supported) {
4838         case TPACPI_VIDEO_570:
4839                 res = video_autosw_set(1);
4840                 if (res)
4841                         return res;
4842                 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4843                 break;
4844         case TPACPI_VIDEO_770:
4845         case TPACPI_VIDEO_NEW:
4846                 res = video_autosw_set(1);
4847                 if (res)
4848                         return res;
4849                 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4850                 break;
4851         default:
4852                 return -ENOSYS;
4853         }
4854         if (!autosw && video_autosw_set(autosw)) {
4855                 pr_err("video auto-switch left enabled due to error\n");
4856                 return -EIO;
4857         }
4858 
4859         return (res) ? 0 : -EIO;
4860 }
4861 
4862 static int video_expand_toggle(void)
4863 {
4864         switch (video_supported) {
4865         case TPACPI_VIDEO_570:
4866                 return acpi_evalf(ec_handle, NULL, "_Q17", "v") ?
4867                         0 : -EIO;
4868         case TPACPI_VIDEO_770:
4869                 return acpi_evalf(vid_handle, NULL, "VEXP", "v") ?
4870                         0 : -EIO;
4871         case TPACPI_VIDEO_NEW:
4872                 return acpi_evalf(NULL, NULL, "\\VEXP", "v") ?
4873                         0 : -EIO;
4874         default:
4875                 return -ENOSYS;
4876         }
4877         /* not reached */
4878 }
4879 
4880 static int video_read(struct seq_file *m)
4881 {
4882         int status, autosw;
4883 
4884         if (video_supported == TPACPI_VIDEO_NONE) {
4885                 seq_printf(m, "status:\t\tnot supported\n");
4886                 return 0;
4887         }
4888 
4889         /* Even reads can crash X.org, so... */
4890         if (!capable(CAP_SYS_ADMIN))
4891                 return -EPERM;
4892 
4893         status = video_outputsw_get();
4894         if (status < 0)
4895                 return status;
4896 
4897         autosw = video_autosw_get();
4898         if (autosw < 0)
4899                 return autosw;
4900 
4901         seq_printf(m, "status:\t\tsupported\n");
4902         seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4903         seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4904         if (video_supported == TPACPI_VIDEO_NEW)
4905                 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4906         seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4907         seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4908         seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4909         if (video_supported == TPACPI_VIDEO_NEW)
4910                 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4911         seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4912         seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4913 
4914         return 0;
4915 }
4916 
4917 static int video_write(char *buf)
4918 {
4919         char *cmd;
4920         int enable, disable, status;
4921         int res;
4922 
4923         if (video_supported == TPACPI_VIDEO_NONE)
4924                 return -ENODEV;
4925 
4926         /* Even reads can crash X.org, let alone writes... */
4927         if (!capable(CAP_SYS_ADMIN))
4928                 return -EPERM;
4929 
4930         enable = 0;
4931         disable = 0;
4932 
4933         while ((cmd = next_cmd(&buf))) {
4934                 if (strlencmp(cmd, "lcd_enable") == 0) {
4935                         enable |= TP_ACPI_VIDEO_S_LCD;
4936                 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4937                         disable |= TP_ACPI_VIDEO_S_LCD;
4938                 } else if (strlencmp(cmd, "crt_enable") == 0) {
4939                         enable |= TP_ACPI_VIDEO_S_CRT;
4940                 } else if (strlencmp(cmd, "crt_disable") == 0) {
4941                         disable |= TP_ACPI_VIDEO_S_CRT;
4942                 } else if (video_supported == TPACPI_VIDEO_NEW &&
4943                            strlencmp(cmd, "dvi_enable") == 0) {
4944                         enable |= TP_ACPI_VIDEO_S_DVI;
4945                 } else if (video_supported == TPACPI_VIDEO_NEW &&
4946                            strlencmp(cmd, "dvi_disable") == 0) {
4947                         disable |= TP_ACPI_VIDEO_S_DVI;
4948                 } else if (strlencmp(cmd, "auto_enable") == 0) {
4949                         res = video_autosw_set(1);
4950                         if (res)
4951                                 return res;
4952                 } else if (strlencmp(cmd, "auto_disable") == 0) {
4953                         res = video_autosw_set(0);
4954                         if (res)
4955                                 return res;
4956                 } else if (strlencmp(cmd, "video_switch") == 0) {
4957                         res = video_outputsw_cycle();
4958                         if (res)
4959                                 return res;
4960                 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4961                         res = video_expand_toggle();
4962                         if (res)
4963                                 return res;
4964                 } else
4965                         return -EINVAL;
4966         }
4967 
4968         if (enable || disable) {
4969                 status = video_outputsw_get();
4970                 if (status < 0)
4971                         return status;
4972                 res = video_outputsw_set((status & ~disable) | enable);
4973                 if (res)
4974                         return res;
4975         }
4976 
4977         return 0;
4978 }
4979 
4980 static struct ibm_struct video_driver_data = {
4981         .name = "video",
4982         .read = video_read,
4983         .write = video_write,
4984         .exit = video_exit,
4985 };
4986 
4987 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4988 
4989 /*************************************************************************
4990  * Keyboard backlight subdriver
4991  */
4992 
4993 static int kbdlight_set_level(int level)
4994 {
4995         if (!hkey_handle)
4996                 return -ENXIO;
4997 
4998         if (!acpi_evalf(hkey_handle, NULL, "MLCS", "dd", level))
4999                 return -EIO;
5000 
5001         return 0;
5002 }
5003 
5004 static int kbdlight_get_level(void)
5005 {
5006         int status = 0;
5007 
5008         if (!hkey_handle)
5009                 return -ENXIO;
5010 
5011         if (!acpi_evalf(hkey_handle, &status, "MLCG", "dd", 0))
5012                 return -EIO;
5013 
5014         if (status < 0)
5015                 return status;
5016 
5017         return status & 0x3;
5018 }
5019 
5020 static bool kbdlight_is_supported(void)
5021 {
5022         int status = 0;
5023 
5024         if (!hkey_handle)
5025                 return false;
5026 
5027         if (!acpi_has_method(hkey_handle, "MLCG")) {
5028                 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG is unavailable\n");
5029                 return false;
5030         }
5031 
5032         if (!acpi_evalf(hkey_handle, &status, "MLCG", "qdd", 0)) {
5033                 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG failed\n");
5034                 return false;
5035         }
5036 
5037         if (status < 0) {
5038                 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG err: %d\n", status);
5039                 return false;
5040         }
5041 
5042         vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG returned 0x%x\n", status);
5043         /*
5044          * Guessed test for keyboard backlight:
5045          *
5046          * Machines with backlight keyboard return:
5047          *   b010100000010000000XX - ThinkPad X1 Carbon 3rd
5048          *   b110100010010000000XX - ThinkPad x230
5049          *   b010100000010000000XX - ThinkPad x240
5050          *   b010100000010000000XX - ThinkPad W541
5051          * (XX is current backlight level)
5052          *
5053          * Machines without backlight keyboard return:
5054          *   b10100001000000000000 - ThinkPad x230
5055          *   b10110001000000000000 - ThinkPad E430
5056          *   b00000000000000000000 - ThinkPad E450
5057          *
5058          * Candidate BITs for detection test (XOR):
5059          *   b01000000001000000000
5060          *              ^
5061          */
5062         return status & BIT(9);
5063 }
5064 
5065 static void kbdlight_set_worker(struct work_struct *work)
5066 {
5067         struct tpacpi_led_classdev *data =
5068                         container_of(work, struct tpacpi_led_classdev, work);
5069 
5070         if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5071                 kbdlight_set_level(data->new_state);
5072 }
5073 
5074 static void kbdlight_sysfs_set(struct led_classdev *led_cdev,
5075                         enum led_brightness brightness)
5076 {
5077         struct tpacpi_led_classdev *data =
5078                         container_of(led_cdev,
5079                                      struct tpacpi_led_classdev,
5080                                      led_classdev);
5081         data->new_state = brightness;
5082         queue_work(tpacpi_wq, &data->work);
5083 }
5084 
5085 static enum led_brightness kbdlight_sysfs_get(struct led_classdev *led_cdev)
5086 {
5087         int level;
5088 
5089         level = kbdlight_get_level();
5090         if (level < 0)
5091                 return 0;
5092 
5093         return level;
5094 }
5095 
5096 static struct tpacpi_led_classdev tpacpi_led_kbdlight = {
5097         .led_classdev = {
5098                 .name           = "tpacpi::kbd_backlight",
5099                 .max_brightness = 2,
5100                 .brightness_set = &kbdlight_sysfs_set,
5101                 .brightness_get = &kbdlight_sysfs_get,
5102                 .flags          = LED_CORE_SUSPENDRESUME,
5103         }
5104 };
5105 
5106 static int __init kbdlight_init(struct ibm_init_struct *iibm)
5107 {
5108         int rc;
5109 
5110         vdbg_printk(TPACPI_DBG_INIT, "initializing kbdlight subdriver\n");
5111 
5112         TPACPI_ACPIHANDLE_INIT(hkey);
5113         INIT_WORK(&tpacpi_led_kbdlight.work, kbdlight_set_worker);
5114 
5115         if (!kbdlight_is_supported()) {
5116                 tp_features.kbdlight = 0;
5117                 vdbg_printk(TPACPI_DBG_INIT, "kbdlight is unsupported\n");
5118                 return 1;
5119         }
5120 
5121         tp_features.kbdlight = 1;
5122 
5123         rc = led_classdev_register(&tpacpi_pdev->dev,
5124                                    &tpacpi_led_kbdlight.led_classdev);
5125         if (rc < 0) {
5126                 tp_features.kbdlight = 0;
5127                 return rc;
5128         }
5129 
5130         return 0;
5131 }
5132 
5133 static void kbdlight_exit(void)
5134 {
5135         if (tp_features.kbdlight)
5136                 led_classdev_unregister(&tpacpi_led_kbdlight.led_classdev);
5137         flush_workqueue(tpacpi_wq);
5138 }
5139 
5140 static int kbdlight_read(struct seq_file *m)
5141 {
5142         int level;
5143 
5144         if (!tp_features.kbdlight) {
5145                 seq_printf(m, "status:\t\tnot supported\n");
5146         } else {
5147                 level = kbdlight_get_level();
5148                 if (level < 0)
5149                         seq_printf(m, "status:\t\terror %d\n", level);
5150                 else
5151                         seq_printf(m, "status:\t\t%d\n", level);
5152                 seq_printf(m, "commands:\t0, 1, 2\n");
5153         }
5154 
5155         return 0;
5156 }
5157 
5158 static int kbdlight_write(char *buf)
5159 {
5160         char *cmd;
5161         int level = -1;
5162 
5163         if (!tp_features.kbdlight)
5164                 return -ENODEV;
5165 
5166         while ((cmd = next_cmd(&buf))) {
5167                 if (strlencmp(cmd, "") == 0)
5168                         level = 0;
5169                 else if (strlencmp(cmd, "1") == 0)
5170                         level = 1;
5171                 else if (strlencmp(cmd, "2") == 0)
5172                         level = 2;
5173                 else
5174                         return -EINVAL;
5175         }
5176 
5177         if (level == -1)
5178                 return -EINVAL;
5179 
5180         return kbdlight_set_level(level);
5181 }
5182 
5183 static struct ibm_struct kbdlight_driver_data = {
5184         .name = "kbdlight",
5185         .read = kbdlight_read,
5186         .write = kbdlight_write,
5187         .exit = kbdlight_exit,
5188 };
5189 
5190 /*************************************************************************
5191  * Light (thinklight) subdriver
5192  */
5193 
5194 TPACPI_HANDLE(lght, root, "\\LGHT");    /* A21e, A2xm/p, T20-22, X20-21 */
5195 TPACPI_HANDLE(ledb, ec, "LEDB");                /* G4x */
5196 
5197 static int light_get_status(void)
5198 {
5199         int status = 0;
5200 
5201         if (tp_features.light_status) {
5202                 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
5203                         return -EIO;
5204                 return (!!status);
5205         }
5206 
5207         return -ENXIO;
5208 }
5209 
5210 static int light_set_status(int status)
5211 {
5212         int rc;
5213 
5214         if (tp_features.light) {
5215                 if (cmos_handle) {
5216                         rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
5217                                         (status) ?
5218                                                 TP_CMOS_THINKLIGHT_ON :
5219                                                 TP_CMOS_THINKLIGHT_OFF);
5220                 } else {
5221                         rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
5222                                         (status) ? 1 : 0);
5223                 }
5224                 return (rc) ? 0 : -EIO;
5225         }
5226 
5227         return -ENXIO;
5228 }
5229 
5230 static void light_set_status_worker(struct work_struct *work)
5231 {
5232         struct tpacpi_led_classdev *data =
5233                         container_of(work, struct tpacpi_led_classdev, work);
5234 
5235         if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5236                 light_set_status((data->new_state != TPACPI_LED_OFF));
5237 }
5238 
5239 static void light_sysfs_set(struct led_classdev *led_cdev,
5240                         enum led_brightness brightness)
5241 {
5242         struct tpacpi_led_classdev *data =
5243                 container_of(led_cdev,
5244                              struct tpacpi_led_classdev,
5245                              led_classdev);
5246         data->new_state = (brightness != LED_OFF) ?
5247                                 TPACPI_LED_ON : TPACPI_LED_OFF;
5248         queue_work(tpacpi_wq, &data->work);
5249 }
5250 
5251 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
5252 {
5253         return (light_get_status() == 1) ? LED_FULL : LED_OFF;
5254 }
5255 
5256 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
5257         .led_classdev = {
5258                 .name           = "tpacpi::thinklight",
5259                 .brightness_set = &light_sysfs_set,
5260                 .brightness_get = &light_sysfs_get,
5261         }
5262 };
5263 
5264 static int __init light_init(struct ibm_init_struct *iibm)
5265 {
5266         int rc;
5267 
5268         vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
5269 
5270         if (tpacpi_is_ibm()) {
5271                 TPACPI_ACPIHANDLE_INIT(ledb);
5272                 TPACPI_ACPIHANDLE_INIT(lght);
5273         }
5274         TPACPI_ACPIHANDLE_INIT(cmos);
5275         INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
5276 
5277         /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
5278         tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
5279 
5280         if (tp_features.light)
5281                 /* light status not supported on
5282                    570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
5283                 tp_features.light_status =
5284                         acpi_evalf(ec_handle, NULL, "KBLT", "qv");
5285 
5286         vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
5287                 str_supported(tp_features.light),
5288                 str_supported(tp_features.light_status));
5289 
5290         if (!tp_features.light)
5291                 return 1;
5292 
5293         rc = led_classdev_register(&tpacpi_pdev->dev,
5294                                    &tpacpi_led_thinklight.led_classdev);
5295 
5296         if (rc < 0) {
5297                 tp_features.light = 0;
5298                 tp_features.light_status = 0;
5299         } else  {
5300                 rc = 0;
5301         }
5302 
5303         return rc;
5304 }
5305 
5306 static void light_exit(void)
5307 {
5308         led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
5309         flush_workqueue(tpacpi_wq);
5310 }
5311 
5312 static int light_read(struct seq_file *m)
5313 {
5314         int status;
5315 
5316         if (!tp_features.light) {
5317                 seq_printf(m, "status:\t\tnot supported\n");
5318         } else if (!tp_features.light_status) {
5319                 seq_printf(m, "status:\t\tunknown\n");
5320                 seq_printf(m, "commands:\ton, off\n");
5321         } else {
5322                 status = light_get_status();
5323                 if (status < 0)
5324                         return status;
5325                 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
5326                 seq_printf(m, "commands:\ton, off\n");
5327         }
5328 
5329         return 0;
5330 }
5331 
5332 static int light_write(char *buf)
5333 {
5334         char *cmd;
5335         int newstatus = 0;
5336 
5337         if (!tp_features.light)
5338                 return -ENODEV;
5339 
5340         while ((cmd = next_cmd(&buf))) {
5341                 if (strlencmp(cmd, "on") == 0) {
5342                         newstatus = 1;
5343                 } else if (strlencmp(cmd, "off") == 0) {
5344                         newstatus = 0;
5345                 } else
5346                         return -EINVAL;
5347         }
5348 
5349         return light_set_status(newstatus);
5350 }
5351 
5352 static struct ibm_struct light_driver_data = {
5353         .name = "light",
5354         .read = light_read,
5355         .write = light_write,
5356         .exit = light_exit,
5357 };
5358 
5359 /*************************************************************************
5360  * CMOS subdriver
5361  */
5362 
5363 /* sysfs cmos_command -------------------------------------------------- */
5364 static ssize_t cmos_command_store(struct device *dev,
5365                             struct device_attribute *attr,
5366                             const char *buf, size_t count)
5367 {
5368         unsigned long cmos_cmd;
5369         int res;
5370 
5371         if (parse_strtoul(buf, 21, &cmos_cmd))
5372                 return -EINVAL;
5373 
5374         res = issue_thinkpad_cmos_command(cmos_cmd);
5375         return (res) ? res : count;
5376 }
5377 
5378 static DEVICE_ATTR_WO(cmos_command);
5379 
5380 /* --------------------------------------------------------------------- */
5381 
5382 static int __init cmos_init(struct ibm_init_struct *iibm)
5383 {
5384         int res;
5385 
5386         vdbg_printk(TPACPI_DBG_INIT,
5387                 "initializing cmos commands subdriver\n");
5388 
5389         TPACPI_ACPIHANDLE_INIT(cmos);
5390 
5391         vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5392                 str_supported(cmos_handle != NULL));
5393 
5394         res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5395         if (res)
5396                 return res;
5397 
5398         return (cmos_handle) ? 0 : 1;
5399 }
5400 
5401 static void cmos_exit(void)
5402 {
5403         device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5404 }
5405 
5406 static int cmos_read(struct seq_file *m)
5407 {
5408         /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5409            R30, R31, T20-22, X20-21 */
5410         if (!cmos_handle)
5411                 seq_printf(m, "status:\t\tnot supported\n");
5412         else {
5413                 seq_printf(m, "status:\t\tsupported\n");
5414                 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5415         }
5416 
5417         return 0;
5418 }
5419 
5420 static int cmos_write(char *buf)
5421 {
5422         char *cmd;
5423         int cmos_cmd, res;
5424 
5425         while ((cmd = next_cmd(&buf))) {
5426                 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5427                     cmos_cmd >= 0 && cmos_cmd <= 21) {
5428                         /* cmos_cmd set */
5429                 } else
5430                         return -EINVAL;
5431 
5432                 res = issue_thinkpad_cmos_command(cmos_cmd);
5433                 if (res)
5434                         return res;
5435         }
5436 
5437         return 0;
5438 }
5439 
5440 static struct ibm_struct cmos_driver_data = {
5441         .name = "cmos",
5442         .read = cmos_read,
5443         .write = cmos_write,
5444         .exit = cmos_exit,
5445 };
5446 
5447 /*************************************************************************
5448  * LED subdriver
5449  */
5450 
5451 enum led_access_mode {
5452         TPACPI_LED_NONE = 0,
5453         TPACPI_LED_570, /* 570 */
5454         TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5455         TPACPI_LED_NEW, /* all others */
5456 };
5457 
5458 enum {  /* For TPACPI_LED_OLD */
5459         TPACPI_LED_EC_HLCL = 0x0c,      /* EC reg to get led to power on */
5460         TPACPI_LED_EC_HLBL = 0x0d,      /* EC reg to blink a lit led */
5461         TPACPI_LED_EC_HLMS = 0x0e,      /* EC reg to select led to command */
5462 };
5463 
5464 static enum led_access_mode led_supported;
5465 
5466 static acpi_handle led_handle;
5467 
5468 #define TPACPI_LED_NUMLEDS 16
5469 static struct tpacpi_led_classdev *tpacpi_leds;
5470 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5471 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5472         /* there's a limit of 19 chars + NULL before 2.6.26 */
5473         "tpacpi::power",
5474         "tpacpi:orange:batt",
5475         "tpacpi:green:batt",
5476         "tpacpi::dock_active",
5477         "tpacpi::bay_active",
5478         "tpacpi::dock_batt",
5479         "tpacpi::unknown_led",
5480         "tpacpi::standby",
5481         "tpacpi::dock_status1",
5482         "tpacpi::dock_status2",
5483         "tpacpi::unknown_led2",
5484         "tpacpi::unknown_led3",
5485         "tpacpi::thinkvantage",
5486 };
5487 #define TPACPI_SAFE_LEDS        0x1081U
5488 
5489 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5490 {
5491 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5492         return false;
5493 #else
5494         return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5495 #endif
5496 }
5497 
5498 static int led_get_status(const unsigned int led)
5499 {
5500         int status;
5501         enum led_status_t led_s;
5502 
5503         switch (led_supported) {
5504         case TPACPI_LED_570:
5505                 if (!acpi_evalf(ec_handle,
5506                                 &status, "GLED", "dd", 1 << led))
5507                         return -EIO;
5508                 led_s = (status == 0) ?
5509                                 TPACPI_LED_OFF :
5510                                 ((status == 1) ?
5511                                         TPACPI_LED_ON :
5512                                         TPACPI_LED_BLINK);
5513                 tpacpi_led_state_cache[led] = led_s;
5514                 return led_s;
5515         default:
5516                 return -ENXIO;
5517         }
5518 
5519         /* not reached */
5520 }
5521 
5522 static int led_set_status(const unsigned int led,
5523                           const enum led_status_t ledstatus)
5524 {
5525         /* off, on, blink. Index is led_status_t */
5526         static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5527         static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5528 
5529         int rc = 0;
5530 
5531         switch (led_supported) {
5532         case TPACPI_LED_570:
5533                 /* 570 */
5534                 if (unlikely(led > 7))
5535                         return -EINVAL;
5536                 if (unlikely(tpacpi_is_led_restricted(led)))
5537                         return -EPERM;
5538                 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5539                                 (1 << led), led_sled_arg1[ledstatus]))
5540                         rc = -EIO;
5541                 break;
5542         case TPACPI_LED_OLD:
5543                 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5544                 if (unlikely(led > 7))
5545                         return -EINVAL;
5546                 if (unlikely(tpacpi_is_led_restricted(led)))
5547                         return -EPERM;
5548                 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5549                 if (rc >= 0)
5550                         rc = ec_write(TPACPI_LED_EC_HLBL,
5551                                       (ledstatus == TPACPI_LED_BLINK) << led);
5552                 if (rc >= 0)
5553                         rc = ec_write(TPACPI_LED_EC_HLCL,
5554                                       (ledstatus != TPACPI_LED_OFF) << led);
5555                 break;
5556         case TPACPI_LED_NEW:
5557                 /* all others */
5558                 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5559                         return -EINVAL;
5560                 if (unlikely(tpacpi_is_led_restricted(led)))
5561                         return -EPERM;
5562                 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5563                                 led, led_led_arg1[ledstatus]))
5564                         rc = -EIO;
5565                 break;
5566         default:
5567                 rc = -ENXIO;
5568         }
5569 
5570         if (!rc)
5571                 tpacpi_led_state_cache[led] = ledstatus;
5572 
5573         return rc;
5574 }
5575 
5576 static void led_set_status_worker(struct work_struct *work)
5577 {
5578         struct tpacpi_led_classdev *data =
5579                 container_of(work, struct tpacpi_led_classdev, work);
5580 
5581         if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5582                 led_set_status(data->led, data->new_state);
5583 }
5584 
5585 static void led_sysfs_set(struct led_classdev *led_cdev,
5586                         enum led_brightness brightness)
5587 {
5588         struct tpacpi_led_classdev *data = container_of(led_cdev,
5589                              struct tpacpi_led_classdev, led_classdev);
5590 
5591         if (brightness == LED_OFF)
5592                 data->new_state = TPACPI_LED_OFF;
5593         else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5594                 data->new_state = TPACPI_LED_ON;
5595         else
5596                 data->new_state = TPACPI_LED_BLINK;
5597 
5598         queue_work(tpacpi_wq, &data->work);
5599 }
5600 
5601 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5602                         unsigned long *delay_on, unsigned long *delay_off)
5603 {
5604         struct tpacpi_led_classdev *data = container_of(led_cdev,
5605                              struct tpacpi_led_classdev, led_classdev);
5606 
5607         /* Can we choose the flash rate? */
5608         if (*delay_on == 0 && *delay_off == 0) {
5609                 /* yes. set them to the hardware blink rate (1 Hz) */
5610                 *delay_on = 500; /* ms */
5611                 *delay_off = 500; /* ms */
5612         } else if ((*delay_on != 500) || (*delay_off != 500))
5613                 return -EINVAL;
5614 
5615         data->new_state = TPACPI_LED_BLINK;
5616         queue_work(tpacpi_wq, &data->work);
5617 
5618         return 0;
5619 }
5620 
5621 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5622 {
5623         int rc;
5624 
5625         struct tpacpi_led_classdev *data = container_of(led_cdev,
5626                              struct tpacpi_led_classdev, led_classdev);
5627 
5628         rc = led_get_status(data->led);
5629 
5630         if (rc == TPACPI_LED_OFF || rc < 0)
5631                 rc = LED_OFF;   /* no error handling in led class :( */
5632         else
5633                 rc = LED_FULL;
5634 
5635         return rc;
5636 }
5637 
5638 static void led_exit(void)
5639 {
5640         unsigned int i;
5641 
5642         for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5643                 if (tpacpi_leds[i].led_classdev.name)
5644                         led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5645         }
5646 
5647         flush_workqueue(tpacpi_wq);
5648         kfree(tpacpi_leds);
5649 }
5650 
5651 static int __init tpacpi_init_led(unsigned int led)
5652 {
5653         int rc;
5654 
5655         tpacpi_leds[led].led = led;
5656 
5657         /* LEDs with no name don't get registered */
5658         if (!tpacpi_led_names[led])
5659                 return 0;
5660 
5661         tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5662         tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5663         if (led_supported == TPACPI_LED_570)
5664                 tpacpi_leds[led].led_classdev.brightness_get =
5665                                                 &led_sysfs_get;
5666 
5667         tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5668 
5669         INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5670 
5671         rc = led_classdev_register(&tpacpi_pdev->dev,
5672                                 &tpacpi_leds[led].led_classdev);
5673         if (rc < 0)
5674                 tpacpi_leds[led].led_classdev.name = NULL;
5675 
5676         return rc;
5677 }
5678 
5679 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5680         TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5681         TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5682         TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5683 
5684         TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5685         TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5686         TPACPI_Q_IBM('7', '', 0x0097), /* T43, R52 */
5687         TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5688         TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5689         TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5690         TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5691         TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5692 
5693         TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5694         TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5695         TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5696         TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5697         TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5698 
5699         TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5700         TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5701         TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5702         TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5703 
5704         /* (1) - may have excess leds enabled on MSB */
5705 
5706         /* Defaults (order matters, keep last, don't reorder!) */
5707         { /* Lenovo */
5708           .vendor = PCI_VENDOR_ID_LENOVO,
5709           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5710           .quirks = 0x1fffU,
5711         },
5712         { /* IBM ThinkPads with no EC version string */
5713           .vendor = PCI_VENDOR_ID_IBM,
5714           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5715           .quirks = 0x00ffU,
5716         },
5717         { /* IBM ThinkPads with EC version string */
5718           .vendor = PCI_VENDOR_ID_IBM,
5719           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5720           .quirks = 0x00bfU,
5721         },
5722 };
5723 
5724 #undef TPACPI_LEDQ_IBM
5725 #undef TPACPI_LEDQ_LNV
5726 
5727 static enum led_access_mode __init led_init_detect_mode(void)
5728 {
5729         acpi_status status;
5730 
5731         if (tpacpi_is_ibm()) {
5732                 /* 570 */
5733                 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5734                 if (ACPI_SUCCESS(status))
5735                         return TPACPI_LED_570;
5736 
5737                 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5738                 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5739                 if (ACPI_SUCCESS(status))
5740                         return TPACPI_LED_OLD;
5741         }
5742 
5743         /* most others */
5744         status = acpi_get_handle(ec_handle, "LED", &led_handle);
5745         if (ACPI_SUCCESS(status))
5746                 return TPACPI_LED_NEW;
5747 
5748         /* R30, R31, and unknown firmwares */
5749         led_handle = NULL;
5750         return TPACPI_LED_NONE;
5751 }
5752 
5753 static int __init led_init(struct ibm_init_struct *iibm)
5754 {
5755         unsigned int i;
5756         int rc;
5757         unsigned long useful_leds;
5758 
5759         vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5760 
5761         led_supported = led_init_detect_mode();
5762 
5763         if (led_supported != TPACPI_LED_NONE) {
5764                 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5765                                 ARRAY_SIZE(led_useful_qtable));
5766 
5767                 if (!useful_leds) {
5768                         led_handle = NULL;
5769                         led_supported = TPACPI_LED_NONE;
5770                 }
5771         }
5772 
5773         vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5774                 str_supported(led_supported), led_supported);
5775 
5776         if (led_supported == TPACPI_LED_NONE)
5777                 return 1;
5778 
5779         tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5780                               GFP_KERNEL);
5781         if (!tpacpi_leds) {
5782                 pr_err("Out of memory for LED data\n");
5783                 return -ENOMEM;
5784         }
5785 
5786         for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5787                 tpacpi_leds[i].led = -1;
5788 
5789                 if (!tpacpi_is_led_restricted(i) &&
5790                     test_bit(i, &useful_leds)) {
5791                         rc = tpacpi_init_led(i);
5792                         if (rc < 0) {
5793                                 led_exit();
5794                                 return rc;
5795                         }
5796                 }
5797         }
5798 
5799 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5800         pr_notice("warning: userspace override of important "
5801                   "firmware LEDs is enabled\n");
5802 #endif
5803         return 0;
5804 }
5805 
5806 #define str_led_status(s) \
5807         ((s) == TPACPI_LED_OFF ? "off" : \
5808                 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5809 
5810 static int led_read(struct seq_file *m)
5811 {
5812         if (!led_supported) {
5813                 seq_printf(m, "status:\t\tnot supported\n");
5814                 return 0;
5815         }
5816         seq_printf(m, "status:\t\tsupported\n");
5817 
5818         if (led_supported == TPACPI_LED_570) {
5819                 /* 570 */
5820                 int i, status;
5821                 for (i = 0; i < 8; i++) {
5822                         status = led_get_status(i);
5823                         if (status < 0)
5824                                 return -EIO;
5825                         seq_printf(m, "%d:\t\t%s\n",
5826                                        i, str_led_status(status));
5827                 }
5828         }
5829 
5830         seq_printf(m, "commands:\t"
5831                        "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5832 
5833         return 0;
5834 }
5835 
5836 static int led_write(char *buf)
5837 {
5838         char *cmd;
5839         int led, rc;
5840         enum led_status_t s;
5841 
5842         if (!led_supported)
5843                 return -ENODEV;
5844 
5845         while ((cmd = next_cmd(&buf))) {
5846                 if (sscanf(cmd, "%d", &led) != 1)
5847                         return -EINVAL;
5848 
5849                 if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1) ||
5850                                 tpacpi_leds[led].led < 0)
5851                         return -ENODEV;
5852 
5853                 if (strstr(cmd, "off")) {
5854                         s = TPACPI_LED_OFF;
5855                 } else if (strstr(cmd, "on")) {
5856                         s = TPACPI_LED_ON;
5857                 } else if (strstr(cmd, "blink")) {
5858                         s = TPACPI_LED_BLINK;
5859                 } else {
5860                         return -EINVAL;
5861                 }
5862 
5863                 rc = led_set_status(led, s);
5864                 if (rc < 0)
5865                         return rc;
5866         }
5867 
5868         return 0;
5869 }
5870 
5871 static struct ibm_struct led_driver_data = {
5872         .name = "led",
5873         .read = led_read,
5874         .write = led_write,
5875         .exit = led_exit,
5876 };
5877 
5878 /*************************************************************************
5879  * Beep subdriver
5880  */
5881 
5882 TPACPI_HANDLE(beep, ec, "BEEP");        /* all except R30, R31 */
5883 
5884 #define TPACPI_BEEP_Q1 0x0001
5885 
5886 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5887         TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5888         TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5889 };
5890 
5891 static int __init beep_init(struct ibm_init_struct *iibm)
5892 {
5893         unsigned long quirks;
5894 
5895         vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5896 
5897         TPACPI_ACPIHANDLE_INIT(beep);
5898 
5899         vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5900                 str_supported(beep_handle != NULL));
5901 
5902         quirks = tpacpi_check_quirks(beep_quirk_table,
5903                                      ARRAY_SIZE(beep_quirk_table));
5904 
5905         tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5906 
5907         return (beep_handle) ? 0 : 1;
5908 }
5909 
5910 static int beep_read(struct seq_file *m)
5911 {
5912         if (!beep_handle)
5913                 seq_printf(m, "status:\t\tnot supported\n");
5914         else {
5915                 seq_printf(m, "status:\t\tsupported\n");
5916                 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5917         }
5918 
5919         return 0;
5920 }
5921 
5922 static int beep_write(char *buf)
5923 {
5924         char *cmd;
5925         int beep_cmd;
5926 
5927         if (!beep_handle)
5928                 return -ENODEV;
5929 
5930         while ((cmd = next_cmd(&buf))) {
5931                 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5932                     beep_cmd >= 0 && beep_cmd <= 17) {
5933                         /* beep_cmd set */
5934                 } else
5935                         return -EINVAL;
5936                 if (tp_features.beep_needs_two_args) {
5937                         if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5938                                         beep_cmd, 0))
5939                                 return -EIO;
5940                 } else {
5941                         if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5942                                         beep_cmd))
5943                                 return -EIO;
5944                 }
5945         }
5946 
5947         return 0;
5948 }
5949 
5950 static struct ibm_struct beep_driver_data = {
5951         .name = "beep",
5952         .read = beep_read,
5953         .write = beep_write,
5954 };
5955 
5956 /*************************************************************************
5957  * Thermal subdriver
5958  */
5959 
5960 enum thermal_access_mode {
5961         TPACPI_THERMAL_NONE = 0,        /* No thermal support */
5962         TPACPI_THERMAL_ACPI_TMP07,      /* Use ACPI TMP0-7 */
5963         TPACPI_THERMAL_ACPI_UPDT,       /* Use ACPI TMP0-7 with UPDT */
5964         TPACPI_THERMAL_TPEC_8,          /* Use ACPI EC regs, 8 sensors */
5965         TPACPI_THERMAL_TPEC_16,         /* Use ACPI EC regs, 16 sensors */
5966 };
5967 
5968 enum { /* TPACPI_THERMAL_TPEC_* */
5969         TP_EC_THERMAL_TMP0 = 0x78,      /* ACPI EC regs TMP 0..7 */
5970         TP_EC_THERMAL_TMP8 = 0xC0,      /* ACPI EC regs TMP 8..15 */
5971         TP_EC_THERMAL_TMP_NA = -128,    /* ACPI EC sensor not available */
5972 
5973         TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5974 };
5975 
5976 
5977 #define TPACPI_MAX_THERMAL_SENSORS 16   /* Max thermal sensors supported */
5978 struct ibm_thermal_sensors_struct {
5979         s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5980 };
5981 
5982 static enum thermal_access_mode thermal_read_mode;
5983 
5984 /* idx is zero-based */
5985 static int thermal_get_sensor(int idx, s32 *value)
5986 {
5987         int t;
5988         s8 tmp;
5989         char tmpi[5];
5990 
5991         t = TP_EC_THERMAL_TMP0;
5992 
5993         switch (thermal_read_mode) {
5994 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5995         case TPACPI_THERMAL_TPEC_16:
5996                 if (idx >= 8 && idx <= 15) {
5997                         t = TP_EC_THERMAL_TMP8;
5998                         idx -= 8;
5999                 }
6000                 /* fallthrough */
6001 #endif
6002         case TPACPI_THERMAL_TPEC_8:
6003                 if (idx <= 7) {
6004                         if (!acpi_ec_read(t + idx, &tmp))
6005                                 return -EIO;
6006                         *value = tmp * 1000;
6007                         return 0;
6008                 }
6009                 break;
6010 
6011         case TPACPI_THERMAL_ACPI_UPDT:
6012                 if (idx <= 7) {
6013                         snprintf(tmpi, sizeof(tmpi), "TMP%c", '' + idx);
6014                         if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
6015                                 return -EIO;
6016                         if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6017                                 return -EIO;
6018                         *value = (t - 2732) * 100;
6019                         return 0;
6020                 }
6021                 break;
6022 
6023         case TPACPI_THERMAL_ACPI_TMP07:
6024                 if (idx <= 7) {
6025                         snprintf(tmpi, sizeof(tmpi), "TMP%c", '' + idx);
6026                         if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6027                                 return -EIO;
6028                         if (t > 127 || t < -127)
6029                                 t = TP_EC_THERMAL_TMP_NA;
6030                         *value = t * 1000;
6031                         return 0;
6032                 }
6033                 break;
6034 
6035         case TPACPI_THERMAL_NONE:
6036         default:
6037                 return -ENOSYS;
6038         }
6039 
6040         return -EINVAL;
6041 }
6042 
6043 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
6044 {
6045         int res, i;
6046         int n;
6047 
6048         n = 8;
6049         i = 0;
6050 
6051         if (!s)
6052                 return -EINVAL;
6053 
6054         if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
6055                 n = 16;
6056 
6057         for (i = 0 ; i < n; i++) {
6058                 res = thermal_get_sensor(i, &s->temp[i]);
6059                 if (res)
6060                         return res;
6061         }
6062 
6063         return n;
6064 }
6065 
6066 static void thermal_dump_all_sensors(void)
6067 {
6068         int n, i;
6069         struct ibm_thermal_sensors_struct t;
6070 
6071         n = thermal_get_sensors(&t);
6072         if (n <= 0)
6073                 return;
6074 
6075         pr_notice("temperatures (Celsius):");
6076 
6077         for (i = 0; i < n; i++) {
6078                 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
6079                         pr_cont(" %d", (int)(t.temp[i] / 1000));
6080                 else
6081                         pr_cont(" N/A");
6082         }
6083 
6084         pr_cont("\n");
6085 }
6086 
6087 /* sysfs temp##_input -------------------------------------------------- */
6088 
6089 static ssize_t thermal_temp_input_show(struct device *dev,
6090                            struct device_attribute *attr,
6091                            char *buf)
6092 {
6093         struct sensor_device_attribute *sensor_attr =
6094                                         to_sensor_dev_attr(attr);
6095         int idx = sensor_attr->index;
6096         s32 value;
6097         int res;
6098 
6099         res = thermal_get_sensor(idx, &value);
6100         if (res)
6101                 return res;
6102         if (value == TPACPI_THERMAL_SENSOR_NA)
6103                 return -ENXIO;
6104 
6105         return snprintf(buf, PAGE_SIZE, "%d\n", value);
6106 }
6107 
6108 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
6109          SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
6110                      thermal_temp_input_show, NULL, _idxB)
6111 
6112 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
6113         THERMAL_SENSOR_ATTR_TEMP(1, 0),
6114         THERMAL_SENSOR_ATTR_TEMP(2, 1),
6115         THERMAL_SENSOR_ATTR_TEMP(3, 2),
6116         THERMAL_SENSOR_ATTR_TEMP(4, 3),
6117         THERMAL_SENSOR_ATTR_TEMP(5, 4),
6118         THERMAL_SENSOR_ATTR_TEMP(6, 5),
6119         THERMAL_SENSOR_ATTR_TEMP(7, 6),
6120         THERMAL_SENSOR_ATTR_TEMP(8, 7),
6121         THERMAL_SENSOR_ATTR_TEMP(9, 8),
6122         THERMAL_SENSOR_ATTR_TEMP(10, 9),
6123         THERMAL_SENSOR_ATTR_TEMP(11, 10),
6124         THERMAL_SENSOR_ATTR_TEMP(12, 11),
6125         THERMAL_SENSOR_ATTR_TEMP(13, 12),
6126         THERMAL_SENSOR_ATTR_TEMP(14, 13),
6127         THERMAL_SENSOR_ATTR_TEMP(15, 14),
6128         THERMAL_SENSOR_ATTR_TEMP(16, 15),
6129 };
6130 
6131 #define THERMAL_ATTRS(X) \
6132         &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
6133 
6134 static struct attribute *thermal_temp_input_attr[] = {
6135         THERMAL_ATTRS(8),
6136         THERMAL_ATTRS(9),
6137         THERMAL_ATTRS(10),
6138         THERMAL_ATTRS(11),
6139         THERMAL_ATTRS(12),
6140         THERMAL_ATTRS(13),
6141         THERMAL_ATTRS(14),
6142         THERMAL_ATTRS(15),
6143         THERMAL_ATTRS(0),
6144         THERMAL_ATTRS(1),
6145         THERMAL_ATTRS(2),
6146         THERMAL_ATTRS(3),
6147         THERMAL_ATTRS(4),
6148         THERMAL_ATTRS(5),
6149         THERMAL_ATTRS(6),
6150         THERMAL_ATTRS(7),
6151         NULL
6152 };
6153 
6154 static const struct attribute_group thermal_temp_input16_group = {
6155         .attrs = thermal_temp_input_attr
6156 };
6157 
6158 static const struct attribute_group thermal_temp_input8_group = {
6159         .attrs = &thermal_temp_input_attr[8]
6160 };
6161 
6162 #undef THERMAL_SENSOR_ATTR_TEMP
6163 #undef THERMAL_ATTRS
6164 
6165 /* --------------------------------------------------------------------- */
6166 
6167 static int __init thermal_init(struct ibm_init_struct *iibm)
6168 {
6169         u8 t, ta1, ta2;
6170         int i;
6171         int acpi_tmp7;
6172         int res;
6173 
6174         vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
6175 
6176         acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
6177 
6178         if (thinkpad_id.ec_model) {
6179                 /*
6180                  * Direct EC access mode: sensors at registers
6181                  * 0x78-0x7F, 0xC0-0xC7.  Registers return 0x00 for
6182                  * non-implemented, thermal sensors return 0x80 when
6183                  * not available
6184                  */
6185 
6186                 ta1 = ta2 = 0;
6187                 for (i = 0; i < 8; i++) {
6188                         if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
6189                                 ta1 |= t;
6190                         } else {
6191                                 ta1 = 0;
6192                                 break;
6193                         }
6194                         if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
6195                                 ta2 |= t;
6196                         } else {
6197                                 ta1 = 0;
6198                                 break;
6199                         }
6200                 }
6201                 if (ta1 == 0) {
6202                         /* This is sheer paranoia, but we handle it anyway */
6203                         if (acpi_tmp7) {
6204                                 pr_err("ThinkPad ACPI EC access misbehaving, "
6205                                        "falling back to ACPI TMPx access "
6206                                        "mode\n");
6207                                 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6208                         } else {
6209                                 pr_err("ThinkPad ACPI EC access misbehaving, "
6210                                        "disabling thermal sensors access\n");
6211                                 thermal_read_mode = TPACPI_THERMAL_NONE;
6212                         }
6213                 } else {
6214                         thermal_read_mode =
6215                             (ta2 != 0) ?
6216                             TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
6217                 }
6218         } else if (acpi_tmp7) {
6219                 if (tpacpi_is_ibm() &&
6220                     acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
6221                         /* 600e/x, 770e, 770x */
6222                         thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
6223                 } else {
6224                         /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
6225                         thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6226                 }
6227         } else {
6228                 /* temperatures not supported on 570, G4x, R30, R31, R32 */
6229                 thermal_read_mode = TPACPI_THERMAL_NONE;
6230         }
6231 
6232         vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
6233                 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
6234                 thermal_read_mode);
6235 
6236         switch (thermal_read_mode) {
6237         case TPACPI_THERMAL_TPEC_16:
6238                 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
6239                                 &thermal_temp_input16_group);
6240                 if (res)
6241                         return res;
6242                 break;
6243         case TPACPI_THERMAL_TPEC_8:
6244         case TPACPI_THERMAL_ACPI_TMP07:
6245         case TPACPI_THERMAL_ACPI_UPDT:
6246                 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
6247                                 &thermal_temp_input8_group);
6248                 if (res)
6249                         return res;
6250                 break;
6251         case TPACPI_THERMAL_NONE:
6252         default:
6253                 return 1;
6254         }
6255 
6256         return 0;
6257 }
6258 
6259 static void thermal_exit(void)
6260 {
6261         switch (thermal_read_mode) {
6262         case TPACPI_THERMAL_TPEC_16:
6263                 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
6264                                    &thermal_temp_input16_group);
6265                 break;
6266         case TPACPI_THERMAL_TPEC_8:
6267         case TPACPI_THERMAL_ACPI_TMP07:
6268         case TPACPI_THERMAL_ACPI_UPDT:
6269                 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
6270                                    &thermal_temp_input8_group);
6271                 break;
6272         case TPACPI_THERMAL_NONE:
6273         default:
6274                 break;
6275         }
6276 }
6277 
6278 static int thermal_read(struct seq_file *m)
6279 {
6280         int n, i;
6281         struct ibm_thermal_sensors_struct t;
6282 
6283         n = thermal_get_sensors(&t);
6284         if (unlikely(n < 0))
6285                 return n;
6286 
6287         seq_printf(m, "temperatures:\t");
6288 
6289         if (n > 0) {
6290                 for (i = 0; i < (n - 1); i++)
6291                         seq_printf(m, "%d ", t.temp[i] / 1000);
6292                 seq_printf(m, "%d\n", t.temp[i] / 1000);
6293         } else
6294                 seq_printf(m, "not supported\n");
6295 
6296         return 0;
6297 }
6298 
6299 static struct ibm_struct thermal_driver_data = {
6300         .name = "thermal",
6301         .read = thermal_read,
6302         .exit = thermal_exit,
6303 };
6304 
6305 /*************************************************************************
6306  * Backlight/brightness subdriver
6307  */
6308 
6309 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
6310 
6311 /*
6312  * ThinkPads can read brightness from two places: EC HBRV (0x31), or
6313  * CMOS NVRAM byte 0x5E, bits 0-3.
6314  *
6315  * EC HBRV (0x31) has the following layout
6316  *   Bit 7: unknown function
6317  *   Bit 6: unknown function
6318  *   Bit 5: Z: honour scale changes, NZ: ignore scale changes
6319  *   Bit 4: must be set to zero to avoid problems
6320  *   Bit 3-0: backlight brightness level
6321  *
6322  * brightness_get_raw returns status data in the HBRV layout
6323  *
6324  * WARNING: The X61 has been verified to use HBRV for something else, so
6325  * this should be used _only_ on IBM ThinkPads, and maybe with some careful
6326  * testing on the very early *60 Lenovo models...
6327  */
6328 
6329 enum {
6330         TP_EC_BACKLIGHT = 0x31,
6331 
6332         /* TP_EC_BACKLIGHT bitmasks */
6333         TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6334         TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6335         TP_EC_BACKLIGHT_MAPSW = 0x20,
6336 };
6337 
6338 enum tpacpi_brightness_access_mode {
6339         TPACPI_BRGHT_MODE_AUTO = 0,     /* Not implemented yet */
6340         TPACPI_BRGHT_MODE_EC,           /* EC control */
6341         TPACPI_BRGHT_MODE_UCMS_STEP,    /* UCMS step-based control */
6342         TPACPI_BRGHT_MODE_ECNVRAM,      /* EC control w/ NVRAM store */
6343         TPACPI_BRGHT_MODE_MAX
6344 };
6345 
6346 static struct backlight_device *ibm_backlight_device;
6347 
6348 static enum tpacpi_brightness_access_mode brightness_mode =
6349                 TPACPI_BRGHT_MODE_MAX;
6350 
6351 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6352 
6353 static struct mutex brightness_mutex;
6354 
6355 /* NVRAM brightness access,
6356  * call with brightness_mutex held! */
6357 static unsigned int tpacpi_brightness_nvram_get(void)
6358 {
6359         u8 lnvram;
6360 
6361         lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6362                   & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6363                   >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6364         lnvram &= bright_maxlvl;
6365 
6366         return lnvram;
6367 }
6368 
6369 static void tpacpi_brightness_checkpoint_nvram(void)
6370 {
6371         u8 lec = 0;
6372         u8 b_nvram;
6373 
6374         if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6375                 return;
6376 
6377         vdbg_printk(TPACPI_DBG_BRGHT,
6378                 "trying to checkpoint backlight level to NVRAM...\n");
6379 
6380         if (mutex_lock_killable(&brightness_mutex) < 0)
6381                 return;
6382 
6383         if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6384                 goto unlock;
6385         lec &= TP_EC_BACKLIGHT_LVLMSK;
6386         b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6387 
6388         if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6389                              >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6390                 /* NVRAM needs update */
6391                 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6392                                 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6393                 b_nvram |= lec;
6394                 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6395                 dbg_printk(TPACPI_DBG_BRGHT,
6396                            "updated NVRAM backlight level to %u (0x%02x)\n",
6397                            (unsigned int) lec, (unsigned int) b_nvram);
6398         } else
6399                 vdbg_printk(TPACPI_DBG_BRGHT,
6400                            "NVRAM backlight level already is %u (0x%02x)\n",
6401                            (unsigned int) lec, (unsigned int) b_nvram);
6402 
6403 unlock:
6404         mutex_unlock(&brightness_mutex);
6405 }
6406 
6407 
6408 /* call with brightness_mutex held! */
6409 static int tpacpi_brightness_get_raw(int *status)
6410 {
6411         u8 lec = 0;
6412 
6413         switch (brightness_mode) {
6414         case TPACPI_BRGHT_MODE_UCMS_STEP:
6415                 *status = tpacpi_brightness_nvram_get();
6416                 return 0;
6417         case TPACPI_BRGHT_MODE_EC:
6418         case TPACPI_BRGHT_MODE_ECNVRAM:
6419                 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6420                         return -EIO;
6421                 *status = lec;
6422                 return 0;
6423         default:
6424                 return -ENXIO;
6425         }
6426 }
6427 
6428 /* call with brightness_mutex held! */
6429 /* do NOT call with illegal backlight level value */
6430 static int tpacpi_brightness_set_ec(unsigned int value)
6431 {
6432         u8 lec = 0;
6433 
6434         if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6435                 return -EIO;
6436 
6437         if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6438                                 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6439                                 (value & TP_EC_BACKLIGHT_LVLMSK))))
6440                 return -EIO;
6441 
6442         return 0;
6443 }
6444 
6445 /* call with brightness_mutex held! */
6446 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6447 {
6448         int cmos_cmd, inc;
6449         unsigned int current_value, i;
6450 
6451         current_value = tpacpi_brightness_nvram_get();
6452 
6453         if (value == current_value)
6454                 return 0;
6455 
6456         cmos_cmd = (value > current_value) ?
6457                         TP_CMOS_BRIGHTNESS_UP :
6458                         TP_CMOS_BRIGHTNESS_DOWN;
6459         inc = (value > current_value) ? 1 : -1;
6460 
6461         for (i = current_value; i != value; i += inc)
6462                 if (issue_thinkpad_cmos_command(cmos_cmd))
6463                         return -EIO;
6464 
6465         return 0;
6466 }
6467 
6468 /* May return EINTR which can always be mapped to ERESTARTSYS */
6469 static int brightness_set(unsigned int value)
6470 {
6471         int res;
6472 
6473         if (value > bright_maxlvl)
6474                 return -EINVAL;
6475 
6476         vdbg_printk(TPACPI_DBG_BRGHT,
6477                         "set backlight level to %d\n", value);
6478 
6479         res = mutex_lock_killable(&brightness_mutex);
6480         if (res < 0)
6481                 return res;
6482 
6483         switch (brightness_mode) {
6484         case TPACPI_BRGHT_MODE_EC:
6485         case TPACPI_BRGHT_MODE_ECNVRAM:
6486                 res = tpacpi_brightness_set_ec(value);
6487                 break;
6488         case TPACPI_BRGHT_MODE_UCMS_STEP:
6489                 res = tpacpi_brightness_set_ucmsstep(value);
6490                 break;
6491         default:
6492                 res = -ENXIO;
6493         }
6494 
6495         mutex_unlock(&brightness_mutex);
6496         return res;
6497 }
6498 
6499 /* sysfs backlight class ----------------------------------------------- */
6500 
6501 static int brightness_update_status(struct backlight_device *bd)
6502 {
6503         unsigned int level =
6504                 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6505                  bd->props.power == FB_BLANK_UNBLANK) ?
6506                                 bd->props.brightness : 0;
6507 
6508         dbg_printk(TPACPI_DBG_BRGHT,
6509                         "backlight: attempt to set level to %d\n",
6510                         level);
6511 
6512         /* it is the backlight class's job (caller) to handle
6513          * EINTR and other errors properly */
6514         return brightness_set(level);
6515 }
6516 
6517 static int brightness_get(struct backlight_device *bd)
6518 {
6519         int status, res;
6520 
6521         res = mutex_lock_killable(&brightness_mutex);
6522         if (res < 0)
6523                 return 0;
6524 
6525         res = tpacpi_brightness_get_raw(&status);
6526 
6527         mutex_unlock(&brightness_mutex);
6528 
6529         if (res < 0)
6530                 return 0;
6531 
6532         return status & TP_EC_BACKLIGHT_LVLMSK;
6533 }
6534 
6535 static void tpacpi_brightness_notify_change(void)
6536 {
6537         backlight_force_update(ibm_backlight_device,
6538                                BACKLIGHT_UPDATE_HOTKEY);
6539 }
6540 
6541 static const struct backlight_ops ibm_backlight_data = {
6542         .get_brightness = brightness_get,
6543         .update_status  = brightness_update_status,
6544 };
6545 
6546 /* --------------------------------------------------------------------- */
6547 
6548 /*
6549  * Call _BCL method of video device.  On some ThinkPads this will
6550  * switch the firmware to the ACPI brightness control mode.
6551  */
6552 
6553 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6554 {
6555         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6556         union acpi_object *obj;
6557         struct acpi_device *device, *child;
6558         int rc;
6559 
6560         if (acpi_bus_get_device(handle, &device))
6561                 return 0;
6562 
6563         rc = 0;
6564         list_for_each_entry(child, &device->children, node) {
6565                 acpi_status status = acpi_evaluate_object(child->handle, "_BCL",
6566                                                           NULL, &buffer);
6567                 if (ACPI_FAILURE(status))
6568                         continue;
6569 
6570                 obj = (union acpi_object *)buffer.pointer;
6571                 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6572                         pr_err("Unknown _BCL data, please report this to %s\n",
6573                                 TPACPI_MAIL);
6574                         rc = 0;
6575                 } else {
6576                         rc = obj->package.count;
6577                 }
6578                 break;
6579         }
6580 
6581         kfree(buffer.pointer);
6582         return rc;
6583 }
6584 
6585 
6586 /*
6587  * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6588  */
6589 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6590 {
6591         acpi_handle video_device;
6592         int bcl_levels = 0;
6593 
6594         tpacpi_acpi_handle_locate("video", NULL, &video_device);
6595         if (video_device)
6596                 bcl_levels = tpacpi_query_bcl_levels(video_device);
6597 
6598         tp_features.bright_acpimode = (bcl_levels > 0);
6599 
6600         return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6601 }
6602 
6603 /*
6604  * These are only useful for models that have only one possibility
6605  * of GPU.  If the BIOS model handles both ATI and Intel, don't use
6606  * these quirks.
6607  */
6608 #define TPACPI_BRGHT_Q_NOEC     0x0001  /* Must NOT use EC HBRV */
6609 #define TPACPI_BRGHT_Q_EC       0x0002  /* Should or must use EC HBRV */
6610 #define TPACPI_BRGHT_Q_ASK      0x8000  /* Ask for user report */
6611 
6612 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6613         /* Models with ATI GPUs known to require ECNVRAM mode */
6614         TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC),      /* T43/p ATI */
6615 
6616         /* Models with ATI GPUs that can use ECNVRAM */
6617         TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC),      /* R50,51 T40-42 */
6618         TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6619         TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC),      /* R52 */
6620         TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6621 
6622         /* Models with Intel Extreme Graphics 2 */
6623         TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC),    /* X40 */
6624         TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6625         TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6626 
6627         /* Models with Intel GMA900 */
6628         TPACPI_Q_IBM('7', '', TPACPI_BRGHT_Q_NOEC),    /* T43, R52 */
6629         TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC),    /* X41 */
6630         TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC),    /* X41 Tablet */
6631 };
6632 
6633 /*
6634  * Returns < 0 for error, otherwise sets tp_features.bright_*
6635  * and bright_maxlvl.
6636  */
6637 static void __init tpacpi_detect_brightness_capabilities(void)
6638 {
6639         unsigned int b;
6640 
6641         vdbg_printk(TPACPI_DBG_INIT,
6642                     "detecting firmware brightness interface capabilities\n");
6643 
6644         /* we could run a quirks check here (same table used by
6645          * brightness_init) if needed */
6646 
6647         /*
6648          * We always attempt to detect acpi support, so as to switch
6649          * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6650          * going to publish a backlight interface
6651          */
6652         b = tpacpi_check_std_acpi_brightness_support();
6653         switch (b) {
6654         case 16:
6655                 bright_maxlvl = 15;
6656                 break;
6657         case 8:
6658         case 0:
6659                 bright_maxlvl = 7;
6660                 break;
6661         default:
6662                 tp_features.bright_unkfw = 1;
6663                 bright_maxlvl = b - 1;
6664         }
6665         pr_debug("detected %u brightness levels\n", bright_maxlvl + 1);
6666 }
6667 
6668 static int __init brightness_init(struct ibm_init_struct *iibm)
6669 {
6670         struct backlight_properties props;
6671         int b;
6672         unsigned long quirks;
6673 
6674         vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6675 
6676         mutex_init(&brightness_mutex);
6677 
6678         quirks = tpacpi_check_quirks(brightness_quirk_table,
6679                                 ARRAY_SIZE(brightness_quirk_table));
6680 
6681         /* tpacpi_detect_brightness_capabilities() must have run already */
6682 
6683         /* if it is unknown, we don't handle it: it wouldn't be safe */
6684         if (tp_features.bright_unkfw)
6685                 return 1;
6686 
6687         if (!brightness_enable) {
6688                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6689                            "brightness support disabled by "
6690                            "module parameter\n");
6691                 return 1;
6692         }
6693 
6694         if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
6695                 if (brightness_enable > 1) {
6696                         pr_info("Standard ACPI backlight interface "
6697                                 "available, not loading native one\n");
6698                         return 1;
6699                 } else if (brightness_enable == 1) {
6700                         pr_warn("Cannot enable backlight brightness support, "
6701                                 "ACPI is already handling it.  Refer to the "
6702                                 "acpi_backlight kernel parameter.\n");
6703                         return 1;
6704                 }
6705         } else if (tp_features.bright_acpimode && brightness_enable > 1) {
6706                 pr_notice("Standard ACPI backlight interface not "
6707                           "available, thinkpad_acpi native "
6708                           "brightness control enabled\n");
6709         }
6710 
6711         /*
6712          * Check for module parameter bogosity, note that we
6713          * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6714          * able to detect "unspecified"
6715          */
6716         if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6717                 return -EINVAL;
6718 
6719         /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6720         if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6721             brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6722                 if (quirks & TPACPI_BRGHT_Q_EC)
6723                         brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6724                 else
6725                         brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6726 
6727                 dbg_printk(TPACPI_DBG_BRGHT,
6728                            "driver auto-selected brightness_mode=%d\n",
6729                            brightness_mode);
6730         }
6731 
6732         /* Safety */
6733         if (!tpacpi_is_ibm() &&
6734             (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6735              brightness_mode == TPACPI_BRGHT_MODE_EC))
6736                 return -EINVAL;
6737 
6738         if (tpacpi_brightness_get_raw(&b) < 0)
6739                 return 1;
6740 
6741         memset(&props, 0, sizeof(struct backlight_properties));
6742         props.type = BACKLIGHT_PLATFORM;
6743         props.max_brightness = bright_maxlvl;
6744         props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6745         ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6746                                                          NULL, NULL,
6747                                                          &ibm_backlight_data,
6748                                                          &props);
6749         if (IS_ERR(ibm_backlight_device)) {
6750                 int rc = PTR_ERR(ibm_backlight_device);
6751                 ibm_backlight_device = NULL;
6752                 pr_err("Could not register backlight device\n");
6753                 return rc;
6754         }
6755         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6756                         "brightness is supported\n");
6757 
6758         if (quirks & TPACPI_BRGHT_Q_ASK) {
6759                 pr_notice("brightness: will use unverified default: "
6760                           "brightness_mode=%d\n", brightness_mode);
6761                 pr_notice("brightness: please report to %s whether it works well "
6762                           "or not on your ThinkPad\n", TPACPI_MAIL);
6763         }
6764 
6765         /* Added by mistake in early 2007.  Probably useless, but it could
6766          * be working around some unknown firmware problem where the value
6767          * read at startup doesn't match the real hardware state... so leave
6768          * it in place just in case */
6769         backlight_update_status(ibm_backlight_device);
6770 
6771         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6772                         "brightness: registering brightness hotkeys "
6773                         "as change notification\n");
6774         tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6775                                 | TP_ACPI_HKEY_BRGHTUP_MASK
6776                                 | TP_ACPI_HKEY_BRGHTDWN_MASK);
6777         return 0;
6778 }
6779 
6780 static void brightness_suspend(void)
6781 {
6782         tpacpi_brightness_checkpoint_nvram();
6783 }
6784 
6785 static void brightness_shutdown(void)
6786 {
6787         tpacpi_brightness_checkpoint_nvram();
6788 }
6789 
6790 static void brightness_exit(void)
6791 {
6792         if (ibm_backlight_device) {
6793                 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6794                             "calling backlight_device_unregister()\n");
6795                 backlight_device_unregister(ibm_backlight_device);
6796         }
6797 
6798         tpacpi_brightness_checkpoint_nvram();
6799 }
6800 
6801 static int brightness_read(struct seq_file *m)
6802 {
6803         int level;
6804 
6805         level = brightness_get(NULL);
6806         if (level < 0) {
6807                 seq_printf(m, "level:\t\tunreadable\n");
6808         } else {
6809                 seq_printf(m, "level:\t\t%d\n", level);
6810                 seq_printf(m, "commands:\tup, down\n");
6811                 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6812                                bright_maxlvl);
6813         }
6814 
6815         return 0;
6816 }
6817 
6818 static int brightness_write(char *buf)
6819 {
6820         int level;
6821         int rc;
6822         char *cmd;
6823 
6824         level = brightness_get(NULL);
6825         if (level < 0)
6826                 return level;
6827 
6828         while ((cmd = next_cmd(&buf))) {
6829                 if (strlencmp(cmd, "up") == 0) {
6830                         if (level < bright_maxlvl)
6831                                 level++;
6832                 } else if (strlencmp(cmd, "down") == 0) {
6833                         if (level > 0)
6834                                 level--;
6835                 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6836                            level >= 0 && level <= bright_maxlvl) {
6837                         /* new level set */
6838                 } else
6839                         return -EINVAL;
6840         }
6841 
6842         tpacpi_disclose_usertask("procfs brightness",
6843                         "set level to %d\n", level);
6844 
6845         /*
6846          * Now we know what the final level should be, so we try to set it.
6847          * Doing it this way makes the syscall restartable in case of EINTR
6848          */
6849         rc = brightness_set(level);
6850         if (!rc && ibm_backlight_device)
6851                 backlight_force_update(ibm_backlight_device,
6852                                         BACKLIGHT_UPDATE_SYSFS);
6853         return (rc == -EINTR) ? -ERESTARTSYS : rc;
6854 }
6855 
6856 static struct ibm_struct brightness_driver_data = {
6857         .name = "brightness",
6858         .read = brightness_read,
6859         .write = brightness_write,
6860         .exit = brightness_exit,
6861         .suspend = brightness_suspend,
6862         .shutdown = brightness_shutdown,
6863 };
6864 
6865 /*************************************************************************
6866  * Volume subdriver
6867  */
6868 
6869 /*
6870  * IBM ThinkPads have a simple volume controller with MUTE gating.
6871  * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6872  *
6873  * Since the *61 series (and probably also the later *60 series), Lenovo
6874  * ThinkPads only implement the MUTE gate.
6875  *
6876  * EC register 0x30
6877  *   Bit 6: MUTE (1 mutes sound)
6878  *   Bit 3-0: Volume
6879  *   Other bits should be zero as far as we know.
6880  *
6881  * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6882  * bits 3-0 (volume).  Other bits in NVRAM may have other functions,
6883  * such as bit 7 which is used to detect repeated presses of MUTE,
6884  * and we leave them unchanged.
6885  *
6886  * On newer Lenovo ThinkPads, the EC can automatically change the volume
6887  * in response to user input.  Unfortunately, this rarely works well.
6888  * The laptop changes the state of its internal MUTE gate and, on some
6889  * models, sends KEY_MUTE, causing any user code that responds to the
6890  * mute button to get confused.  The hardware MUTE gate is also
6891  * unnecessary, since user code can handle the mute button without
6892  * kernel or EC help.
6893  *
6894  * To avoid confusing userspace, we simply disable all EC-based mute
6895  * and volume controls when possible.
6896  */
6897 
6898 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6899 
6900 #define TPACPI_ALSA_DRVNAME  "ThinkPad EC"
6901 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6902 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6903 
6904 #if SNDRV_CARDS <= 32
6905 #define DEFAULT_ALSA_IDX                ~((1 << (SNDRV_CARDS - 3)) - 1)
6906 #else
6907 #define DEFAULT_ALSA_IDX                ~((1 << (32 - 3)) - 1)
6908 #endif
6909 static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
6910 static char *alsa_id = "ThinkPadEC";
6911 static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
6912 
6913 struct tpacpi_alsa_data {
6914         struct snd_card *card;
6915         struct snd_ctl_elem_id *ctl_mute_id;
6916         struct snd_ctl_elem_id *ctl_vol_id;
6917 };
6918 
6919 static struct snd_card *alsa_card;
6920 
6921 enum {
6922         TP_EC_AUDIO = 0x30,
6923 
6924         /* TP_EC_AUDIO bits */
6925         TP_EC_AUDIO_MUTESW = 6,
6926 
6927         /* TP_EC_AUDIO bitmasks */
6928         TP_EC_AUDIO_LVL_MSK = 0x0F,
6929         TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6930 
6931         /* Maximum volume */
6932         TP_EC_VOLUME_MAX = 14,
6933 };
6934 
6935 enum tpacpi_volume_access_mode {
6936         TPACPI_VOL_MODE_AUTO = 0,       /* Not implemented yet */
6937         TPACPI_VOL_MODE_EC,             /* Pure EC control */
6938         TPACPI_VOL_MODE_UCMS_STEP,      /* UCMS step-based control: N/A */
6939         TPACPI_VOL_MODE_ECNVRAM,        /* EC control w/ NVRAM store */
6940         TPACPI_VOL_MODE_MAX
6941 };
6942 
6943 enum tpacpi_volume_capabilities {
6944         TPACPI_VOL_CAP_AUTO = 0,        /* Use white/blacklist */
6945         TPACPI_VOL_CAP_VOLMUTE,         /* Output vol and mute */
6946         TPACPI_VOL_CAP_MUTEONLY,        /* Output mute only */
6947         TPACPI_VOL_CAP_MAX
6948 };
6949 
6950 enum tpacpi_mute_btn_mode {
6951         TP_EC_MUTE_BTN_LATCH  = 0,      /* Mute mutes; up/down unmutes */
6952         /* We don't know what mode 1 is. */
6953         TP_EC_MUTE_BTN_NONE   = 2,      /* Mute and up/down are just keys */
6954         TP_EC_MUTE_BTN_TOGGLE = 3,      /* Mute toggles; up/down unmutes */
6955 };
6956 
6957 static enum tpacpi_volume_access_mode volume_mode =
6958         TPACPI_VOL_MODE_MAX;
6959 
6960 static enum tpacpi_volume_capabilities volume_capabilities;
6961 static bool volume_control_allowed;
6962 static bool software_mute_requested = true;
6963 static bool software_mute_active;
6964 static int software_mute_orig_mode;
6965 
6966 /*
6967  * Used to syncronize writers to TP_EC_AUDIO and
6968  * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6969  */
6970 static struct mutex volume_mutex;
6971 
6972 static void tpacpi_volume_checkpoint_nvram(void)
6973 {
6974         u8 lec = 0;
6975         u8 b_nvram;
6976         u8 ec_mask;
6977 
6978         if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6979                 return;
6980         if (!volume_control_allowed)
6981                 return;
6982         if (software_mute_active)
6983                 return;
6984 
6985         vdbg_printk(TPACPI_DBG_MIXER,
6986                 "trying to checkpoint mixer state to NVRAM...\n");
6987 
6988         if (tp_features.mixer_no_level_control)
6989                 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6990         else
6991                 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6992 
6993         if (mutex_lock_killable(&volume_mutex) < 0)
6994                 return;
6995 
6996         if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6997                 goto unlock;
6998         lec &= ec_mask;
6999         b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
7000 
7001         if (lec != (b_nvram & ec_mask)) {
7002                 /* NVRAM needs update */
7003                 b_nvram &= ~ec_mask;
7004                 b_nvram |= lec;
7005                 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
7006                 dbg_printk(TPACPI_DBG_MIXER,
7007                            "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
7008                            (unsigned int) lec, (unsigned int) b_nvram);
7009         } else {
7010                 vdbg_printk(TPACPI_DBG_MIXER,
7011                            "NVRAM mixer status already is 0x%02x (0x%02x)\n",
7012                            (unsigned int) lec, (unsigned int) b_nvram);
7013         }
7014 
7015 unlock:
7016         mutex_unlock(&volume_mutex);
7017 }
7018 
7019 static int volume_get_status_ec(u8 *status)
7020 {
7021         u8 s;
7022 
7023         if (!acpi_ec_read(TP_EC_AUDIO, &s))
7024                 return -EIO;
7025 
7026         *status = s;
7027 
7028         dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
7029 
7030         return 0;
7031 }
7032 
7033 static int volume_get_status(u8 *status)
7034 {
7035         return volume_get_status_ec(status);
7036 }
7037 
7038 static int volume_set_status_ec(const u8 status)
7039 {
7040         if (!acpi_ec_write(TP_EC_AUDIO, status))
7041                 return -EIO;
7042 
7043         dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
7044 
7045         /*
7046          * On X200s, and possibly on others, it can take a while for
7047          * reads to become correct.
7048          */
7049         msleep(1);
7050 
7051         return 0;
7052 }
7053 
7054 static int volume_set_status(const u8 status)
7055 {
7056         return volume_set_status_ec(status);
7057 }
7058 
7059 /* returns < 0 on error, 0 on no change, 1 on change */
7060 static int __volume_set_mute_ec(const bool mute)
7061 {
7062         int rc;
7063         u8 s, n;
7064 
7065         if (mutex_lock_killable(&volume_mutex) < 0)
7066                 return -EINTR;
7067 
7068         rc = volume_get_status_ec(&s);
7069         if (rc)
7070                 goto unlock;
7071 
7072         n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
7073                      s & ~TP_EC_AUDIO_MUTESW_MSK;
7074 
7075         if (n != s) {
7076                 rc = volume_set_status_ec(n);
7077                 if (!rc)
7078                         rc = 1;
7079         }
7080 
7081 unlock:
7082         mutex_unlock(&volume_mutex);
7083         return rc;
7084 }
7085 
7086 static int volume_alsa_set_mute(const bool mute)
7087 {
7088         dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
7089                    (mute) ? "" : "un");
7090         return __volume_set_mute_ec(mute);
7091 }
7092 
7093 static int volume_set_mute(const bool mute)
7094 {
7095         int rc;
7096 
7097         dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
7098                    (mute) ? "" : "un");
7099 
7100         rc = __volume_set_mute_ec(mute);
7101         return (rc < 0) ? rc : 0;
7102 }
7103 
7104 /* returns < 0 on error, 0 on no change, 1 on change */
7105 static int __volume_set_volume_ec(const u8 vol)
7106 {
7107         int rc;
7108         u8 s, n;
7109 
7110         if (vol > TP_EC_VOLUME_MAX)
7111                 return -EINVAL;
7112 
7113         if (mutex_lock_killable(&volume_mutex) < 0)
7114                 return -EINTR;
7115 
7116         rc = volume_get_status_ec(&s);
7117         if (rc)
7118                 goto unlock;
7119 
7120         n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
7121 
7122         if (n != s) {
7123                 rc = volume_set_status_ec(n);
7124                 if (!rc)
7125                         rc = 1;
7126         }
7127 
7128 unlock:
7129         mutex_unlock(&volume_mutex);
7130         return rc;
7131 }
7132 
7133 static int volume_set_software_mute(bool startup)
7134 {
7135         int result;
7136 
7137         if (!tpacpi_is_lenovo())
7138                 return -ENODEV;
7139 
7140         if (startup) {
7141                 if (!acpi_evalf(ec_handle, &software_mute_orig_mode,
7142                                 "HAUM", "qd"))
7143                         return -EIO;
7144 
7145                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7146                             "Initial HAUM setting was %d\n",
7147                             software_mute_orig_mode);
7148         }
7149 
7150         if (!acpi_evalf(ec_handle, &result, "SAUM", "qdd",
7151                         (int)TP_EC_MUTE_BTN_NONE))
7152                 return -EIO;
7153 
7154         if (result != TP_EC_MUTE_BTN_NONE)
7155                 pr_warn("Unexpected SAUM result %d\n",
7156                         result);
7157 
7158         /*
7159          * In software mute mode, the standard codec controls take
7160          * precendence, so we unmute the ThinkPad HW switch at
7161          * startup.  Just on case there are SAUM-capable ThinkPads
7162          * with level controls, set max HW volume as well.
7163          */
7164         if (tp_features.mixer_no_level_control)
7165                 result = volume_set_mute(false);
7166         else
7167                 result = volume_set_status(TP_EC_VOLUME_MAX);
7168 
7169         if (result != 0)
7170                 pr_warn("Failed to unmute the HW mute switch\n");
7171 
7172         return 0;
7173 }
7174 
7175 static void volume_exit_software_mute(void)
7176 {
7177         int r;
7178 
7179         if (!acpi_evalf(ec_handle, &r, "SAUM", "qdd", software_mute_orig_mode)
7180             || r != software_mute_orig_mode)
7181                 pr_warn("Failed to restore mute mode\n");
7182 }
7183 
7184 static int volume_alsa_set_volume(const u8 vol)
7185 {
7186         dbg_printk(TPACPI_DBG_MIXER,
7187                    "ALSA: trying to set volume level to %hu\n", vol);
7188         return __volume_set_volume_ec(vol);
7189 }
7190 
7191 static void volume_alsa_notify_change(void)
7192 {
7193         struct tpacpi_alsa_data *d;
7194 
7195         if (alsa_card && alsa_card->private_data) {
7196                 d = alsa_card->private_data;
7197                 if (d->ctl_mute_id)
7198                         snd_ctl_notify(alsa_card,
7199                                         SNDRV_CTL_EVENT_MASK_VALUE,
7200                                         d->ctl_mute_id);
7201                 if (d->ctl_vol_id)
7202                         snd_ctl_notify(alsa_card,
7203                                         SNDRV_CTL_EVENT_MASK_VALUE,
7204                                         d->ctl_vol_id);
7205         }
7206 }
7207 
7208 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
7209                                 struct snd_ctl_elem_info *uinfo)
7210 {
7211         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
7212         uinfo->count = 1;
7213         uinfo->value.integer.min = 0;
7214         uinfo->value.integer.max = TP_EC_VOLUME_MAX;
7215         return 0;
7216 }
7217 
7218 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
7219                                 struct snd_ctl_elem_value *ucontrol)
7220 {
7221         u8 s;
7222         int rc;
7223 
7224         rc = volume_get_status(&s);
7225         if (rc < 0)
7226                 return rc;
7227 
7228         ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
7229         return 0;
7230 }
7231 
7232 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
7233                                 struct snd_ctl_elem_value *ucontrol)
7234 {
7235         tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
7236                                  ucontrol->value.integer.value[0]);
7237         return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
7238 }
7239 
7240 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
7241 
7242 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
7243                                 struct snd_ctl_elem_value *ucontrol)
7244 {
7245         u8 s;
7246         int rc;
7247 
7248         rc = volume_get_status(&s);
7249         if (rc < 0)
7250                 return rc;
7251 
7252         ucontrol->value.integer.value[0] =
7253                                 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;