drivers/platform/x86/thinkpad_acpi.c

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