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