drivers/platform/x86/thinkpad_acpi.c

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