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 static void palmsensor_refresh(void);
4032
4033 static bool hotkey_notify_6xxx(const u32 hkey,
4034                                  bool *send_acpi_ev,
4035                                  bool *ignore_acpi_ev)
4036 {
4037         /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
4038         *send_acpi_ev = true;
4039         *ignore_acpi_ev = false;
4040
4041         switch (hkey) {
4042         case TP_HKEY_EV_THM_TABLE_CHANGED:
4043                 pr_debug("EC reports: Thermal Table has changed\n");
4044                 /* recommended action: do nothing, we don't have
4045                  * Lenovo ATM information */
4046                 return true;
4047         case TP_HKEY_EV_THM_CSM_COMPLETED:
4048                 pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
4049                 /* Thermal event - pass on to event handler */
4050                 tpacpi_driver_event(hkey);
4051                 return true;
4052         case TP_HKEY_EV_THM_TRANSFM_CHANGED:
4053                 pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
4054                 /* recommended action: do nothing, we don't have
4055                  * Lenovo ATM information */
4056                 return true;
4057         case TP_HKEY_EV_ALARM_BAT_HOT:
4058                 pr_crit("THERMAL ALARM: battery is too hot!\n");
4059                 /* recommended action: warn user through gui */
4060                 break;
4061         case TP_HKEY_EV_ALARM_BAT_XHOT:
4062                 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
4063                 /* recommended action: immediate sleep/hibernate */
4064                 break;
4065         case TP_HKEY_EV_ALARM_SENSOR_HOT:
4066                 pr_crit("THERMAL ALARM: a sensor reports something is too hot!\n");
4067                 /* recommended action: warn user through gui, that */
4068                 /* some internal component is too hot */
4069                 break;
4070         case TP_HKEY_EV_ALARM_SENSOR_XHOT:
4071                 pr_alert("THERMAL EMERGENCY: a sensor reports something is extremely hot!\n");
4072                 /* recommended action: immediate sleep/hibernate */
4073                 break;
4074         case TP_HKEY_EV_AC_CHANGED:
4075                 /* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
4076                  * AC status changed; can be triggered by plugging or
4077                  * unplugging AC adapter, docking or undocking. */
4078
4079                 fallthrough;
4080
4081         case TP_HKEY_EV_KEY_NUMLOCK:
4082         case TP_HKEY_EV_KEY_FN:
4083         case TP_HKEY_EV_KEY_FN_ESC:
4084                 /* key press events, we just ignore them as long as the EC
4085                  * is still reporting them in the normal keyboard stream */
4086                 *send_acpi_ev = false;
4087                 *ignore_acpi_ev = true;
4088                 return true;
4089
4090         case TP_HKEY_EV_TABLET_CHANGED:
4091                 tpacpi_input_send_tabletsw();
4092                 hotkey_tablet_mode_notify_change();
4093                 *send_acpi_ev = false;
4094                 return true;
4095
4096         case TP_HKEY_EV_PALM_DETECTED:
4097         case TP_HKEY_EV_PALM_UNDETECTED:
4098                 /* palm detected  - pass on to event handler */
4099                 palmsensor_refresh();
4100                 return true;
4101
4102         default:
4103                 /* report simply as unknown, no sensor dump */
4104                 return false;
4105         }
4106
4107         thermal_dump_all_sensors();
4108         return true;
4109 }
4110
4111 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
4112 {
4113         u32 hkey;
4114         bool send_acpi_ev;
4115         bool ignore_acpi_ev;
4116         bool known_ev;
4117
4118         if (event != 0x80) {
4119                 pr_err("unknown HKEY notification event %d\n", event);
4120                 /* forward it to userspace, maybe it knows how to handle it */
4121                 acpi_bus_generate_netlink_event(
4122                                         ibm->acpi->device->pnp.device_class,
4123                                         dev_name(&ibm->acpi->device->dev),
4124                                         event, 0);
4125                 return;
4126         }
4127
4128         while (1) {
4129                 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
4130                         pr_err("failed to retrieve HKEY event\n");
4131                         return;
4132                 }
4133
4134                 if (hkey == 0) {
4135                         /* queue empty */
4136                         return;
4137                 }
4138
4139                 send_acpi_ev = true;
4140                 ignore_acpi_ev = false;
4141
4142                 switch (hkey >> 12) {
4143                 case 1:
4144                         /* 0x1000-0x1FFF: key presses */
4145                         known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
4146                                                  &ignore_acpi_ev);
4147                         break;
4148                 case 2:
4149                         /* 0x2000-0x2FFF: Wakeup reason */
4150                         known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
4151                                                  &ignore_acpi_ev);
4152                         break;
4153                 case 3:
4154                         /* 0x3000-0x3FFF: bay-related wakeups */
4155                         switch (hkey) {
4156                         case TP_HKEY_EV_BAYEJ_ACK:
4157                                 hotkey_autosleep_ack = 1;
4158                                 pr_info("bay ejected\n");
4159                                 hotkey_wakeup_hotunplug_complete_notify_change();
4160                                 known_ev = true;
4161                                 break;
4162                         case TP_HKEY_EV_OPTDRV_EJ:
4163                                 /* FIXME: kick libata if SATA link offline */
4164                                 known_ev = true;
4165                                 break;
4166                         default:
4167                                 known_ev = false;
4168                         }
4169                         break;
4170                 case 4:
4171                         /* 0x4000-0x4FFF: dock-related events */
4172                         known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
4173                                                 &ignore_acpi_ev);
4174                         break;
4175                 case 5:
4176                         /* 0x5000-0x5FFF: human interface helpers */
4177                         known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
4178                                                  &ignore_acpi_ev);
4179                         break;
4180                 case 6:
4181                         /* 0x6000-0x6FFF: thermal alarms/notices and
4182                          *                keyboard events */
4183                         known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
4184                                                  &ignore_acpi_ev);
4185                         break;
4186                 case 7:
4187                         /* 0x7000-0x7FFF: misc */
4188                         if (tp_features.hotkey_wlsw &&
4189                                         hkey == TP_HKEY_EV_RFKILL_CHANGED) {
4190                                 tpacpi_send_radiosw_update();
4191                                 send_acpi_ev = 0;
4192                                 known_ev = true;
4193                                 break;
4194                         }
4195                         fallthrough;    /* to default */
4196                 default:
4197                         known_ev = false;
4198                 }
4199                 if (!known_ev) {
4200                         pr_notice("unhandled HKEY event 0x%04x\n", hkey);
4201                         pr_notice("please report the conditions when this event happened to %s\n",
4202                                   TPACPI_MAIL);
4203                 }
4204
4205                 /* netlink events */
4206                 if (!ignore_acpi_ev && send_acpi_ev) {
4207                         acpi_bus_generate_netlink_event(
4208                                         ibm->acpi->device->pnp.device_class,
4209                                         dev_name(&ibm->acpi->device->dev),
4210                                         event, hkey);
4211                 }
4212         }
4213 }
4214
4215 static void hotkey_suspend(void)
4216 {
4217         /* Do these on suspend, we get the events on early resume! */
4218         hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
4219         hotkey_autosleep_ack = 0;
4220
4221         /* save previous mode of adaptive keyboard of X1 Carbon */
4222         if (tp_features.has_adaptive_kbd) {
4223                 if (!acpi_evalf(hkey_handle, &adaptive_keyboard_prev_mode,
4224                                         "GTRW", "dd", 0)) {
4225                         pr_err("Cannot read adaptive keyboard mode.\n");
4226                 }
4227         }
4228 }
4229
4230 static void hotkey_resume(void)
4231 {
4232         tpacpi_disable_brightness_delay();
4233
4234         if (hotkey_status_set(true) < 0 ||
4235             hotkey_mask_set(hotkey_acpi_mask) < 0)
4236                 pr_err("error while attempting to reset the event firmware interface\n");
4237
4238         tpacpi_send_radiosw_update();
4239         tpacpi_input_send_tabletsw();
4240         hotkey_tablet_mode_notify_change();
4241         hotkey_wakeup_reason_notify_change();
4242         hotkey_wakeup_hotunplug_complete_notify_change();
4243         hotkey_poll_setup_safe(false);
4244
4245         /* restore previous mode of adapive keyboard of X1 Carbon */
4246         if (tp_features.has_adaptive_kbd) {
4247                 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd",
4248                                         adaptive_keyboard_prev_mode)) {
4249                         pr_err("Cannot set adaptive keyboard mode.\n");
4250                 }
4251         }
4252 }
4253
4254 /* procfs -------------------------------------------------------------- */
4255 static int hotkey_read(struct seq_file *m)
4256 {
4257         int res, status;
4258
4259         if (!tp_features.hotkey) {
4260                 seq_printf(m, "status:\t\tnot supported\n");
4261                 return 0;
4262         }
4263
4264         if (mutex_lock_killable(&hotkey_mutex))
4265                 return -ERESTARTSYS;
4266         res = hotkey_status_get(&status);
4267         if (!res)
4268                 res = hotkey_mask_get();
4269         mutex_unlock(&hotkey_mutex);
4270         if (res)
4271                 return res;
4272
4273         seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
4274         if (hotkey_all_mask) {
4275                 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
4276                 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
4277         } else {
4278                 seq_printf(m, "mask:\t\tnot supported\n");
4279                 seq_printf(m, "commands:\tenable, disable, reset\n");
4280         }
4281
4282         return 0;
4283 }
4284
4285 static void hotkey_enabledisable_warn(bool enable)
4286 {
4287         tpacpi_log_usertask("procfs hotkey enable/disable");
4288         if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
4289                   pr_fmt("hotkey enable/disable functionality has been removed from the driver.  Hotkeys are always enabled.\n")))
4290                 pr_err("Please remove the hotkey=enable module parameter, it is deprecated.  Hotkeys are always enabled.\n");
4291 }
4292
4293 static int hotkey_write(char *buf)
4294 {
4295         int res;
4296         u32 mask;
4297         char *cmd;
4298
4299         if (!tp_features.hotkey)
4300                 return -ENODEV;
4301
4302         if (mutex_lock_killable(&hotkey_mutex))
4303                 return -ERESTARTSYS;
4304
4305         mask = hotkey_user_mask;
4306
4307         res = 0;
4308         while ((cmd = strsep(&buf, ","))) {
4309                 if (strlencmp(cmd, "enable") == 0) {
4310                         hotkey_enabledisable_warn(1);
4311                 } else if (strlencmp(cmd, "disable") == 0) {
4312                         hotkey_enabledisable_warn(0);
4313                         res = -EPERM;
4314                 } else if (strlencmp(cmd, "reset") == 0) {
4315                         mask = (hotkey_all_mask | hotkey_source_mask)
4316                                 & ~hotkey_reserved_mask;
4317                 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
4318                         /* mask set */
4319                 } else if (sscanf(cmd, "%x", &mask) == 1) {
4320                         /* mask set */
4321                 } else {
4322                         res = -EINVAL;
4323                         goto errexit;
4324                 }
4325         }
4326
4327         if (!res) {
4328                 tpacpi_disclose_usertask("procfs hotkey",
4329                         "set mask to 0x%08x\n", mask);
4330                 res = hotkey_user_mask_set(mask);
4331         }
4332
4333 errexit:
4334         mutex_unlock(&hotkey_mutex);
4335         return res;
4336 }
4337
4338 static const struct acpi_device_id ibm_htk_device_ids[] = {
4339         {TPACPI_ACPI_IBM_HKEY_HID, 0},
4340         {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
4341         {TPACPI_ACPI_LENOVO_HKEY_V2_HID, 0},
4342         {"", 0},
4343 };
4344
4345 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
4346         .hid = ibm_htk_device_ids,
4347         .notify = hotkey_notify,
4348         .handle = &hkey_handle,
4349         .type = ACPI_DEVICE_NOTIFY,
4350 };
4351
4352 static struct ibm_struct hotkey_driver_data = {
4353         .name = "hotkey",
4354         .read = hotkey_read,
4355         .write = hotkey_write,
4356         .exit = hotkey_exit,
4357         .resume = hotkey_resume,
4358         .suspend = hotkey_suspend,
4359         .acpi = &ibm_hotkey_acpidriver,
4360 };
4361
4362 /*************************************************************************
4363  * Bluetooth subdriver
4364  */
4365
4366 enum {
4367         /* ACPI GBDC/SBDC bits */
4368         TP_ACPI_BLUETOOTH_HWPRESENT     = 0x01, /* Bluetooth hw available */
4369         TP_ACPI_BLUETOOTH_RADIOSSW      = 0x02, /* Bluetooth radio enabled */
4370         TP_ACPI_BLUETOOTH_RESUMECTRL    = 0x04, /* Bluetooth state at resume:
4371                                                    0 = disable, 1 = enable */
4372 };
4373
4374 enum {
4375         /* ACPI \BLTH commands */
4376         TP_ACPI_BLTH_GET_ULTRAPORT_ID   = 0x00, /* Get Ultraport BT ID */
4377         TP_ACPI_BLTH_GET_PWR_ON_RESUME  = 0x01, /* Get power-on-resume state */
4378         TP_ACPI_BLTH_PWR_ON_ON_RESUME   = 0x02, /* Resume powered on */
4379         TP_ACPI_BLTH_PWR_OFF_ON_RESUME  = 0x03, /* Resume powered off */
4380         TP_ACPI_BLTH_SAVE_STATE         = 0x05, /* Save state for S4/S5 */
4381 };
4382
4383 #define TPACPI_RFK_BLUETOOTH_SW_NAME    "tpacpi_bluetooth_sw"
4384
4385 static int bluetooth_get_status(void)
4386 {
4387         int status;
4388
4389 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4390         if (dbg_bluetoothemul)
4391                 return (tpacpi_bluetooth_emulstate) ?
4392                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4393 #endif
4394
4395         if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4396                 return -EIO;
4397
4398         return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4399                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4400 }
4401
4402 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4403 {
4404         int status;
4405
4406         vdbg_printk(TPACPI_DBG_RFKILL,
4407                 "will attempt to %s bluetooth\n",
4408                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4409
4410 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4411         if (dbg_bluetoothemul) {
4412                 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4413                 return 0;
4414         }
4415 #endif
4416
4417         if (state == TPACPI_RFK_RADIO_ON)
4418                 status = TP_ACPI_BLUETOOTH_RADIOSSW
4419                           | TP_ACPI_BLUETOOTH_RESUMECTRL;
4420         else
4421                 status = 0;
4422
4423         if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4424                 return -EIO;
4425
4426         return 0;
4427 }
4428
4429 /* sysfs bluetooth enable ---------------------------------------------- */
4430 static ssize_t bluetooth_enable_show(struct device *dev,
4431                            struct device_attribute *attr,
4432                            char *buf)
4433 {
4434         return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4435                         attr, buf);
4436 }
4437
4438 static ssize_t bluetooth_enable_store(struct device *dev,
4439                             struct device_attribute *attr,
4440                             const char *buf, size_t count)
4441 {
4442         return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4443                                 attr, buf, count);
4444 }
4445
4446 static DEVICE_ATTR_RW(bluetooth_enable);
4447
4448 /* --------------------------------------------------------------------- */
4449
4450 static struct attribute *bluetooth_attributes[] = {
4451         &dev_attr_bluetooth_enable.attr,
4452         NULL
4453 };
4454
4455 static const struct attribute_group bluetooth_attr_group = {
4456         .attrs = bluetooth_attributes,
4457 };
4458
4459 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4460         .get_status = bluetooth_get_status,
4461         .set_status = bluetooth_set_status,
4462 };
4463
4464 static void bluetooth_shutdown(void)
4465 {
4466         /* Order firmware to save current state to NVRAM */
4467         if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4468                         TP_ACPI_BLTH_SAVE_STATE))
4469                 pr_notice("failed to save bluetooth state to NVRAM\n");
4470         else
4471                 vdbg_printk(TPACPI_DBG_RFKILL,
4472                         "bluetooth state saved to NVRAM\n");
4473 }
4474
4475 static void bluetooth_exit(void)
4476 {
4477         sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4478                         &bluetooth_attr_group);
4479
4480         tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4481
4482         bluetooth_shutdown();
4483 }
4484
4485 static const struct dmi_system_id bt_fwbug_list[] __initconst = {
4486         {
4487                 .ident = "ThinkPad E485",
4488                 .matches = {
4489                         DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4490                         DMI_MATCH(DMI_BOARD_NAME, "20KU"),
4491                 },
4492         },
4493         {
4494                 .ident = "ThinkPad E585",
4495                 .matches = {
4496                         DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4497                         DMI_MATCH(DMI_BOARD_NAME, "20KV"),
4498                 },
4499         },
4500         {
4501                 .ident = "ThinkPad A285 - 20MW",
4502                 .matches = {
4503                         DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4504                         DMI_MATCH(DMI_BOARD_NAME, "20MW"),
4505                 },
4506         },
4507         {
4508                 .ident = "ThinkPad A285 - 20MX",
4509                 .matches = {
4510                         DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4511                         DMI_MATCH(DMI_BOARD_NAME, "20MX"),
4512                 },
4513         },
4514         {
4515                 .ident = "ThinkPad A485 - 20MU",
4516                 .matches = {
4517                         DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4518                         DMI_MATCH(DMI_BOARD_NAME, "20MU"),
4519                 },
4520         },
4521         {
4522                 .ident = "ThinkPad A485 - 20MV",
4523                 .matches = {
4524                         DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4525                         DMI_MATCH(DMI_BOARD_NAME, "20MV"),
4526                 },
4527         },
4528         {}
4529 };
4530
4531 static const struct pci_device_id fwbug_cards_ids[] __initconst = {
4532         { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24F3) },
4533         { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24FD) },
4534         { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x2526) },
4535         {}
4536 };
4537
4538
4539 static int __init have_bt_fwbug(void)
4540 {
4541         /*
4542          * Some AMD based ThinkPads have a firmware bug that calling
4543          * "GBDC" will cause bluetooth on Intel wireless cards blocked
4544          */
4545         if (dmi_check_system(bt_fwbug_list) && pci_dev_present(fwbug_cards_ids)) {
4546                 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4547                         FW_BUG "disable bluetooth subdriver for Intel cards\n");
4548                 return 1;
4549         } else
4550                 return 0;
4551 }
4552
4553 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4554 {
4555         int res;
4556         int status = 0;
4557
4558         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4559                         "initializing bluetooth subdriver\n");
4560
4561         TPACPI_ACPIHANDLE_INIT(hkey);
4562
4563         /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4564            G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4565         tp_features.bluetooth = !have_bt_fwbug() && hkey_handle &&
4566             acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4567
4568         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4569                 "bluetooth is %s, status 0x%02x\n",
4570                 str_supported(tp_features.bluetooth),
4571                 status);
4572
4573 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4574         if (dbg_bluetoothemul) {
4575                 tp_features.bluetooth = 1;
4576                 pr_info("bluetooth switch emulation enabled\n");
4577         } else
4578 #endif
4579         if (tp_features.bluetooth &&
4580             !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4581                 /* no bluetooth hardware present in system */
4582                 tp_features.bluetooth = 0;
4583                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4584                            "bluetooth hardware not installed\n");
4585         }
4586
4587         if (!tp_features.bluetooth)
4588                 return 1;
4589
4590         res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4591                                 &bluetooth_tprfk_ops,
4592                                 RFKILL_TYPE_BLUETOOTH,
4593                                 TPACPI_RFK_BLUETOOTH_SW_NAME,
4594                                 true);
4595         if (res)
4596                 return res;
4597
4598         res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4599                                 &bluetooth_attr_group);
4600         if (res) {
4601                 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4602                 return res;
4603         }
4604
4605         return 0;
4606 }
4607
4608 /* procfs -------------------------------------------------------------- */
4609 static int bluetooth_read(struct seq_file *m)
4610 {
4611         return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4612 }
4613
4614 static int bluetooth_write(char *buf)
4615 {
4616         return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4617 }
4618
4619 static struct ibm_struct bluetooth_driver_data = {
4620         .name = "bluetooth",
4621         .read = bluetooth_read,
4622         .write = bluetooth_write,
4623         .exit = bluetooth_exit,
4624         .shutdown = bluetooth_shutdown,
4625 };
4626
4627 /*************************************************************************
4628  * Wan subdriver
4629  */
4630
4631 enum {
4632         /* ACPI GWAN/SWAN bits */
4633         TP_ACPI_WANCARD_HWPRESENT       = 0x01, /* Wan hw available */
4634         TP_ACPI_WANCARD_RADIOSSW        = 0x02, /* Wan radio enabled */
4635         TP_ACPI_WANCARD_RESUMECTRL      = 0x04, /* Wan state at resume:
4636                                                    0 = disable, 1 = enable */
4637 };
4638
4639 #define TPACPI_RFK_WWAN_SW_NAME         "tpacpi_wwan_sw"
4640
4641 static int wan_get_status(void)
4642 {
4643         int status;
4644
4645 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4646         if (dbg_wwanemul)
4647                 return (tpacpi_wwan_emulstate) ?
4648                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4649 #endif
4650
4651         if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4652                 return -EIO;
4653
4654         return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4655                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4656 }
4657
4658 static int wan_set_status(enum tpacpi_rfkill_state state)
4659 {
4660         int status;
4661
4662         vdbg_printk(TPACPI_DBG_RFKILL,
4663                 "will attempt to %s wwan\n",
4664                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4665
4666 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4667         if (dbg_wwanemul) {
4668                 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4669                 return 0;
4670         }
4671 #endif
4672
4673         if (state == TPACPI_RFK_RADIO_ON)
4674                 status = TP_ACPI_WANCARD_RADIOSSW
4675                          | TP_ACPI_WANCARD_RESUMECTRL;
4676         else
4677                 status = 0;
4678
4679         if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4680                 return -EIO;
4681
4682         return 0;
4683 }
4684
4685 /* sysfs wan enable ---------------------------------------------------- */
4686 static ssize_t wan_enable_show(struct device *dev,
4687                            struct device_attribute *attr,
4688                            char *buf)
4689 {
4690         return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4691                         attr, buf);
4692 }
4693
4694 static ssize_t wan_enable_store(struct device *dev,
4695                             struct device_attribute *attr,
4696                             const char *buf, size_t count)
4697 {
4698         return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4699                         attr, buf, count);
4700 }
4701
4702 static DEVICE_ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4703                    wan_enable_show, wan_enable_store);
4704
4705 /* --------------------------------------------------------------------- */
4706
4707 static struct attribute *wan_attributes[] = {
4708         &dev_attr_wwan_enable.attr,
4709         NULL
4710 };
4711
4712 static const struct attribute_group wan_attr_group = {
4713         .attrs = wan_attributes,
4714 };
4715
4716 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4717         .get_status = wan_get_status,
4718         .set_status = wan_set_status,
4719 };
4720
4721 static void wan_shutdown(void)
4722 {
4723         /* Order firmware to save current state to NVRAM */
4724         if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4725                         TP_ACPI_WGSV_SAVE_STATE))
4726                 pr_notice("failed to save WWAN state to NVRAM\n");
4727         else
4728                 vdbg_printk(TPACPI_DBG_RFKILL,
4729                         "WWAN state saved to NVRAM\n");
4730 }
4731
4732 static void wan_exit(void)
4733 {
4734         sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4735                 &wan_attr_group);
4736
4737         tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4738
4739         wan_shutdown();
4740 }
4741
4742 static int __init wan_init(struct ibm_init_struct *iibm)
4743 {
4744         int res;
4745         int status = 0;
4746
4747         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4748                         "initializing wan subdriver\n");
4749
4750         TPACPI_ACPIHANDLE_INIT(hkey);
4751
4752         tp_features.wan = hkey_handle &&
4753             acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4754
4755         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4756                 "wan is %s, status 0x%02x\n",
4757                 str_supported(tp_features.wan),
4758                 status);
4759
4760 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4761         if (dbg_wwanemul) {
4762                 tp_features.wan = 1;
4763                 pr_info("wwan switch emulation enabled\n");
4764         } else
4765 #endif
4766         if (tp_features.wan &&
4767             !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4768                 /* no wan hardware present in system */
4769                 tp_features.wan = 0;
4770                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4771                            "wan hardware not installed\n");
4772         }
4773
4774         if (!tp_features.wan)
4775                 return 1;
4776
4777         res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4778                                 &wan_tprfk_ops,
4779                                 RFKILL_TYPE_WWAN,
4780                                 TPACPI_RFK_WWAN_SW_NAME,
4781                                 true);
4782         if (res)
4783                 return res;
4784
4785         res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4786                                 &wan_attr_group);
4787
4788         if (res) {
4789                 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4790                 return res;
4791         }
4792
4793         return 0;
4794 }
4795
4796 /* procfs -------------------------------------------------------------- */
4797 static int wan_read(struct seq_file *m)
4798 {
4799         return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4800 }
4801
4802 static int wan_write(char *buf)
4803 {
4804         return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4805 }
4806
4807 static struct ibm_struct wan_driver_data = {
4808         .name = "wan",
4809         .read = wan_read,
4810         .write = wan_write,
4811         .exit = wan_exit,
4812         .shutdown = wan_shutdown,
4813 };
4814
4815 /*************************************************************************
4816  * UWB subdriver
4817  */
4818
4819 enum {
4820         /* ACPI GUWB/SUWB bits */
4821         TP_ACPI_UWB_HWPRESENT   = 0x01, /* UWB hw available */
4822         TP_ACPI_UWB_RADIOSSW    = 0x02, /* UWB radio enabled */
4823 };
4824
4825 #define TPACPI_RFK_UWB_SW_NAME  "tpacpi_uwb_sw"
4826
4827 static int uwb_get_status(void)
4828 {
4829         int status;
4830
4831 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4832         if (dbg_uwbemul)
4833                 return (tpacpi_uwb_emulstate) ?
4834                        TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4835 #endif
4836
4837         if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4838                 return -EIO;
4839
4840         return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4841                         TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4842 }
4843
4844 static int uwb_set_status(enum tpacpi_rfkill_state state)
4845 {
4846         int status;
4847
4848         vdbg_printk(TPACPI_DBG_RFKILL,
4849                 "will attempt to %s UWB\n",
4850                 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4851
4852 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4853         if (dbg_uwbemul) {
4854                 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4855                 return 0;
4856         }
4857 #endif
4858
4859         if (state == TPACPI_RFK_RADIO_ON)
4860                 status = TP_ACPI_UWB_RADIOSSW;
4861         else
4862                 status = 0;
4863
4864         if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4865                 return -EIO;
4866
4867         return 0;
4868 }
4869
4870 /* --------------------------------------------------------------------- */
4871
4872 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4873         .get_status = uwb_get_status,
4874         .set_status = uwb_set_status,
4875 };
4876
4877 static void uwb_exit(void)
4878 {
4879         tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4880 }
4881
4882 static int __init uwb_init(struct ibm_init_struct *iibm)
4883 {
4884         int res;
4885         int status = 0;
4886
4887         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4888                         "initializing uwb subdriver\n");
4889
4890         TPACPI_ACPIHANDLE_INIT(hkey);
4891
4892         tp_features.uwb = hkey_handle &&
4893             acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4894
4895         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4896                 "uwb is %s, status 0x%02x\n",
4897                 str_supported(tp_features.uwb),
4898                 status);
4899
4900 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4901         if (dbg_uwbemul) {
4902                 tp_features.uwb = 1;
4903                 pr_info("uwb switch emulation enabled\n");
4904         } else
4905 #endif
4906         if (tp_features.uwb &&
4907             !(status & TP_ACPI_UWB_HWPRESENT)) {
4908                 /* no uwb hardware present in system */
4909                 tp_features.uwb = 0;
4910                 dbg_printk(TPACPI_DBG_INIT,
4911                            "uwb hardware not installed\n");
4912         }
4913
4914         if (!tp_features.uwb)
4915                 return 1;
4916
4917         res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4918                                 &uwb_tprfk_ops,
4919                                 RFKILL_TYPE_UWB,
4920                                 TPACPI_RFK_UWB_SW_NAME,
4921                                 false);
4922         return res;
4923 }
4924
4925 static struct ibm_struct uwb_driver_data = {
4926         .name = "uwb",
4927         .exit = uwb_exit,
4928         .flags.experimental = 1,
4929 };
4930
4931 /*************************************************************************
4932  * Video subdriver
4933  */
4934
4935 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4936
4937 enum video_access_mode {
4938         TPACPI_VIDEO_NONE = 0,
4939         TPACPI_VIDEO_570,       /* 570 */
4940         TPACPI_VIDEO_770,       /* 600e/x, 770e, 770x */
4941         TPACPI_VIDEO_NEW,       /* all others */
4942 };
4943
4944 enum {  /* video status flags, based on VIDEO_570 */
4945         TP_ACPI_VIDEO_S_LCD = 0x01,     /* LCD output enabled */
4946         TP_ACPI_VIDEO_S_CRT = 0x02,     /* CRT output enabled */
4947         TP_ACPI_VIDEO_S_DVI = 0x08,     /* DVI output enabled */
4948 };
4949
4950 enum {  /* TPACPI_VIDEO_570 constants */
4951         TP_ACPI_VIDEO_570_PHSCMD = 0x87,        /* unknown magic constant :( */
4952         TP_ACPI_VIDEO_570_PHSMASK = 0x03,       /* PHS bits that map to
4953                                                  * video_status_flags */
4954         TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,       /* unknown magic constant :( */
4955         TP_ACPI_VIDEO_570_PHS2SET = 0x80,       /* unknown magic constant :( */
4956 };
4957
4958 static enum video_access_mode video_supported;
4959 static int video_orig_autosw;
4960
4961 static int video_autosw_get(void);
4962 static int video_autosw_set(int enable);
4963
4964 TPACPI_HANDLE(vid, root,
4965               "\\_SB.PCI.AGP.VGA",      /* 570 */
4966               "\\_SB.PCI0.AGP0.VID0",   /* 600e/x, 770x */
4967               "\\_SB.PCI0.VID0",        /* 770e */
4968               "\\_SB.PCI0.VID",         /* A21e, G4x, R50e, X30, X40 */
4969               "\\_SB.PCI0.AGP.VGA",     /* X100e and a few others */
4970               "\\_SB.PCI0.AGP.VID",     /* all others */
4971         );                              /* R30, R31 */
4972
4973 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID");       /* G41 */
4974
4975 static int __init video_init(struct ibm_init_struct *iibm)
4976 {
4977         int ivga;
4978
4979         vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4980
4981         TPACPI_ACPIHANDLE_INIT(vid);
4982         if (tpacpi_is_ibm())
4983                 TPACPI_ACPIHANDLE_INIT(vid2);
4984
4985         if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4986                 /* G41, assume IVGA doesn't change */
4987                 vid_handle = vid2_handle;
4988
4989         if (!vid_handle)
4990                 /* video switching not supported on R30, R31 */
4991                 video_supported = TPACPI_VIDEO_NONE;
4992         else if (tpacpi_is_ibm() &&
4993                  acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4994                 /* 570 */
4995                 video_supported = TPACPI_VIDEO_570;
4996         else if (tpacpi_is_ibm() &&
4997                  acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4998                 /* 600e/x, 770e, 770x */
4999                 video_supported = TPACPI_VIDEO_770;
5000         else
5001                 /* all others */
5002                 video_supported = TPACPI_VIDEO_NEW;
5003
5004         vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
5005                 str_supported(video_supported != TPACPI_VIDEO_NONE),
5006                 video_supported);
5007
5008         return (video_supported != TPACPI_VIDEO_NONE) ? 0 : 1;
5009 }
5010
5011 static void video_exit(void)
5012 {
5013         dbg_printk(TPACPI_DBG_EXIT,
5014                    "restoring original video autoswitch mode\n");
5015         if (video_autosw_set(video_orig_autosw))
5016                 pr_err("error while trying to restore original video autoswitch mode\n");
5017 }
5018
5019 static int video_outputsw_get(void)
5020 {
5021         int status = 0;
5022         int i;
5023
5024         switch (video_supported) {
5025         case TPACPI_VIDEO_570:
5026                 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
5027                                  TP_ACPI_VIDEO_570_PHSCMD))
5028                         return -EIO;
5029                 status = i & TP_ACPI_VIDEO_570_PHSMASK;
5030                 break;
5031         case TPACPI_VIDEO_770:
5032                 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
5033                         return -EIO;
5034                 if (i)
5035                         status |= TP_ACPI_VIDEO_S_LCD;
5036                 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
5037                         return -EIO;
5038                 if (i)
5039                         status |= TP_ACPI_VIDEO_S_CRT;
5040                 break;
5041         case TPACPI_VIDEO_NEW:
5042                 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
5043                     !acpi_evalf(NULL, &i, "\\VCDC", "d"))
5044                         return -EIO;
5045                 if (i)
5046                         status |= TP_ACPI_VIDEO_S_CRT;
5047
5048                 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
5049                     !acpi_evalf(NULL, &i, "\\VCDL", "d"))
5050                         return -EIO;
5051                 if (i)
5052                         status |= TP_ACPI_VIDEO_S_LCD;
5053                 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
5054                         return -EIO;
5055                 if (i)
5056                         status |= TP_ACPI_VIDEO_S_DVI;
5057                 break;
5058         default:
5059                 return -ENOSYS;
5060         }
5061
5062         return status;
5063 }
5064
5065 static int video_outputsw_set(int status)
5066 {
5067         int autosw;
5068         int res = 0;
5069
5070         switch (video_supported) {
5071         case TPACPI_VIDEO_570:
5072                 res = acpi_evalf(NULL, NULL,
5073                                  "\\_SB.PHS2", "vdd",
5074                                  TP_ACPI_VIDEO_570_PHS2CMD,
5075                                  status | TP_ACPI_VIDEO_570_PHS2SET);
5076                 break;
5077         case TPACPI_VIDEO_770:
5078                 autosw = video_autosw_get();
5079                 if (autosw < 0)
5080                         return autosw;
5081
5082                 res = video_autosw_set(1);
5083                 if (res)
5084                         return res;
5085                 res = acpi_evalf(vid_handle, NULL,
5086                                  "ASWT", "vdd", status * 0x100, 0);
5087                 if (!autosw && video_autosw_set(autosw)) {
5088                         pr_err("video auto-switch left enabled due to error\n");
5089                         return -EIO;
5090                 }
5091                 break;
5092         case TPACPI_VIDEO_NEW:
5093                 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
5094                       acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
5095                 break;
5096         default:
5097                 return -ENOSYS;
5098         }
5099
5100         return (res) ? 0 : -EIO;
5101 }
5102
5103 static int video_autosw_get(void)
5104 {
5105         int autosw = 0;
5106
5107         switch (video_supported) {
5108         case TPACPI_VIDEO_570:
5109                 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
5110                         return -EIO;
5111                 break;
5112         case TPACPI_VIDEO_770:
5113         case TPACPI_VIDEO_NEW:
5114                 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
5115                         return -EIO;
5116                 break;
5117         default:
5118                 return -ENOSYS;
5119         }
5120
5121         return autosw & 1;
5122 }
5123
5124 static int video_autosw_set(int enable)
5125 {
5126         if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable) ? 1 : 0))
5127                 return -EIO;
5128         return 0;
5129 }
5130
5131 static int video_outputsw_cycle(void)
5132 {
5133         int autosw = video_autosw_get();
5134         int res;
5135
5136         if (autosw < 0)
5137                 return autosw;
5138
5139         switch (video_supported) {
5140         case TPACPI_VIDEO_570:
5141                 res = video_autosw_set(1);
5142                 if (res)
5143                         return res;
5144                 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
5145                 break;
5146         case TPACPI_VIDEO_770:
5147         case TPACPI_VIDEO_NEW:
5148                 res = video_autosw_set(1);
5149                 if (res)
5150                         return res;
5151                 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
5152                 break;
5153         default:
5154                 return -ENOSYS;
5155         }
5156         if (!autosw && video_autosw_set(autosw)) {
5157                 pr_err("video auto-switch left enabled due to error\n");
5158                 return -EIO;
5159         }
5160
5161         return (res) ? 0 : -EIO;
5162 }
5163
5164 static int video_expand_toggle(void)
5165 {
5166         switch (video_supported) {
5167         case TPACPI_VIDEO_570:
5168                 return acpi_evalf(ec_handle, NULL, "_Q17", "v") ?
5169                         0 : -EIO;
5170         case TPACPI_VIDEO_770:
5171                 return acpi_evalf(vid_handle, NULL, "VEXP", "v") ?
5172                         0 : -EIO;
5173         case TPACPI_VIDEO_NEW:
5174                 return acpi_evalf(NULL, NULL, "\\VEXP", "v") ?
5175                         0 : -EIO;
5176         default:
5177                 return -ENOSYS;
5178         }
5179         /* not reached */
5180 }
5181
5182 static int video_read(struct seq_file *m)
5183 {
5184         int status, autosw;
5185
5186         if (video_supported == TPACPI_VIDEO_NONE) {
5187                 seq_printf(m, "status:\t\tnot supported\n");
5188                 return 0;
5189         }
5190
5191         /* Even reads can crash X.org, so... */
5192         if (!capable(CAP_SYS_ADMIN))
5193                 return -EPERM;
5194
5195         status = video_outputsw_get();
5196         if (status < 0)
5197                 return status;
5198
5199         autosw = video_autosw_get();
5200         if (autosw < 0)
5201                 return autosw;
5202
5203         seq_printf(m, "status:\t\tsupported\n");
5204         seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
5205         seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
5206         if (video_supported == TPACPI_VIDEO_NEW)
5207                 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
5208         seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
5209         seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
5210         seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
5211         if (video_supported == TPACPI_VIDEO_NEW)
5212                 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
5213         seq_printf(m, "commands:\tauto_enable, auto_disable\n");
5214         seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
5215
5216         return 0;
5217 }
5218
5219 static int video_write(char *buf)
5220 {
5221         char *cmd;
5222         int enable, disable, status;
5223         int res;
5224
5225         if (video_supported == TPACPI_VIDEO_NONE)
5226                 return -ENODEV;
5227
5228         /* Even reads can crash X.org, let alone writes... */
5229         if (!capable(CAP_SYS_ADMIN))
5230                 return -EPERM;
5231
5232         enable = 0;
5233         disable = 0;
5234
5235         while ((cmd = strsep(&buf, ","))) {
5236                 if (strlencmp(cmd, "lcd_enable") == 0) {
5237                         enable |= TP_ACPI_VIDEO_S_LCD;
5238                 } else if (strlencmp(cmd, "lcd_disable") == 0) {
5239                         disable |= TP_ACPI_VIDEO_S_LCD;
5240                 } else if (strlencmp(cmd, "crt_enable") == 0) {
5241                         enable |= TP_ACPI_VIDEO_S_CRT;
5242                 } else if (strlencmp(cmd, "crt_disable") == 0) {
5243                         disable |= TP_ACPI_VIDEO_S_CRT;
5244                 } else if (video_supported == TPACPI_VIDEO_NEW &&
5245                            strlencmp(cmd, "dvi_enable") == 0) {
5246                         enable |= TP_ACPI_VIDEO_S_DVI;
5247                 } else if (video_supported == TPACPI_VIDEO_NEW &&
5248                            strlencmp(cmd, "dvi_disable") == 0) {
5249                         disable |= TP_ACPI_VIDEO_S_DVI;
5250                 } else if (strlencmp(cmd, "auto_enable") == 0) {
5251                         res = video_autosw_set(1);
5252                         if (res)
5253                                 return res;
5254                 } else if (strlencmp(cmd, "auto_disable") == 0) {
5255                         res = video_autosw_set(0);
5256                         if (res)
5257                                 return res;
5258                 } else if (strlencmp(cmd, "video_switch") == 0) {
5259                         res = video_outputsw_cycle();
5260                         if (res)
5261                                 return res;
5262                 } else if (strlencmp(cmd, "expand_toggle") == 0) {
5263                         res = video_expand_toggle();
5264                         if (res)
5265                                 return res;
5266                 } else
5267                         return -EINVAL;
5268         }
5269
5270         if (enable || disable) {
5271                 status = video_outputsw_get();
5272                 if (status < 0)
5273                         return status;
5274                 res = video_outputsw_set((status & ~disable) | enable);
5275                 if (res)
5276                         return res;
5277         }
5278
5279         return 0;
5280 }
5281
5282 static struct ibm_struct video_driver_data = {
5283         .name = "video",
5284         .read = video_read,
5285         .write = video_write,
5286         .exit = video_exit,
5287 };
5288
5289 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
5290
5291 /*************************************************************************
5292  * Keyboard backlight subdriver
5293  */
5294
5295 static enum led_brightness kbdlight_brightness;
5296 static DEFINE_MUTEX(kbdlight_mutex);
5297
5298 static int kbdlight_set_level(int level)
5299 {
5300         int ret = 0;
5301
5302         if (!hkey_handle)
5303                 return -ENXIO;
5304
5305         mutex_lock(&kbdlight_mutex);
5306
5307         if (!acpi_evalf(hkey_handle, NULL, "MLCS", "dd", level))
5308                 ret = -EIO;
5309         else
5310                 kbdlight_brightness = level;
5311
5312         mutex_unlock(&kbdlight_mutex);
5313
5314         return ret;
5315 }
5316
5317 static int kbdlight_get_level(void)
5318 {
5319         int status = 0;
5320
5321         if (!hkey_handle)
5322                 return -ENXIO;
5323
5324         if (!acpi_evalf(hkey_handle, &status, "MLCG", "dd", 0))
5325                 return -EIO;
5326
5327         if (status < 0)
5328                 return status;
5329
5330         return status & 0x3;
5331 }
5332
5333 static bool kbdlight_is_supported(void)
5334 {
5335         int status = 0;
5336
5337         if (!hkey_handle)
5338                 return false;
5339
5340         if (!acpi_has_method(hkey_handle, "MLCG")) {
5341                 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG is unavailable\n");
5342                 return false;
5343         }
5344
5345         if (!acpi_evalf(hkey_handle, &status, "MLCG", "qdd", 0)) {
5346                 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG failed\n");
5347                 return false;
5348         }
5349
5350         if (status < 0) {
5351                 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG err: %d\n", status);
5352                 return false;
5353         }
5354
5355         vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG returned 0x%x\n", status);
5356         /*
5357          * Guessed test for keyboard backlight:
5358          *
5359          * Machines with backlight keyboard return:
5360          *   b010100000010000000XX - ThinkPad X1 Carbon 3rd
5361          *   b110100010010000000XX - ThinkPad x230
5362          *   b010100000010000000XX - ThinkPad x240
5363          *   b010100000010000000XX - ThinkPad W541
5364          * (XX is current backlight level)
5365          *
5366          * Machines without backlight keyboard return:
5367          *   b10100001000000000000 - ThinkPad x230
5368          *   b10110001000000000000 - ThinkPad E430
5369          *   b00000000000000000000 - ThinkPad E450
5370          *
5371          * Candidate BITs for detection test (XOR):
5372          *   b01000000001000000000
5373          *              ^
5374          */
5375         return status & BIT(9);
5376 }
5377
5378 static int kbdlight_sysfs_set(struct led_classdev *led_cdev,
5379                         enum led_brightness brightness)
5380 {
5381         return kbdlight_set_level(brightness);
5382 }
5383
5384 static enum led_brightness kbdlight_sysfs_get(struct led_classdev *led_cdev)
5385 {
5386         int level;
5387
5388         level = kbdlight_get_level();
5389         if (level < 0)
5390                 return 0;
5391
5392         return level;
5393 }
5394
5395 static struct tpacpi_led_classdev tpacpi_led_kbdlight = {
5396         .led_classdev = {
5397                 .name           = "tpacpi::kbd_backlight",
5398                 .max_brightness = 2,
5399                 .flags          = LED_BRIGHT_HW_CHANGED,
5400                 .brightness_set_blocking = &kbdlight_sysfs_set,
5401                 .brightness_get = &kbdlight_sysfs_get,
5402         }
5403 };
5404
5405 static int __init kbdlight_init(struct ibm_init_struct *iibm)
5406 {
5407         int rc;
5408
5409         vdbg_printk(TPACPI_DBG_INIT, "initializing kbdlight subdriver\n");
5410
5411         TPACPI_ACPIHANDLE_INIT(hkey);
5412
5413         if (!kbdlight_is_supported()) {
5414                 tp_features.kbdlight = 0;
5415                 vdbg_printk(TPACPI_DBG_INIT, "kbdlight is unsupported\n");
5416                 return 1;
5417         }
5418
5419         kbdlight_brightness = kbdlight_sysfs_get(NULL);
5420         tp_features.kbdlight = 1;
5421
5422         rc = led_classdev_register(&tpacpi_pdev->dev,
5423                                    &tpacpi_led_kbdlight.led_classdev);
5424         if (rc < 0) {
5425                 tp_features.kbdlight = 0;
5426                 return rc;
5427         }
5428
5429         tpacpi_hotkey_driver_mask_set(hotkey_driver_mask |
5430                                       TP_ACPI_HKEY_KBD_LIGHT_MASK);
5431         return 0;
5432 }
5433
5434 static void kbdlight_exit(void)
5435 {
5436         led_classdev_unregister(&tpacpi_led_kbdlight.led_classdev);
5437 }
5438
5439 static int kbdlight_set_level_and_update(int level)
5440 {
5441         int ret;
5442         struct led_classdev *led_cdev;
5443
5444         ret = kbdlight_set_level(level);
5445         led_cdev = &tpacpi_led_kbdlight.led_classdev;
5446
5447         if (ret == 0 && !(led_cdev->flags & LED_SUSPENDED))
5448                 led_cdev->brightness = level;
5449
5450         return ret;
5451 }
5452
5453 static int kbdlight_read(struct seq_file *m)
5454 {
5455         int level;
5456
5457         if (!tp_features.kbdlight) {
5458                 seq_printf(m, "status:\t\tnot supported\n");
5459         } else {
5460                 level = kbdlight_get_level();
5461                 if (level < 0)
5462                         seq_printf(m, "status:\t\terror %d\n", level);
5463                 else
5464                         seq_printf(m, "status:\t\t%d\n", level);
5465                 seq_printf(m, "commands:\t0, 1, 2\n");
5466         }
5467
5468         return 0;
5469 }
5470
5471 static int kbdlight_write(char *buf)
5472 {
5473         char *cmd;
5474         int res, level = -EINVAL;
5475
5476         if (!tp_features.kbdlight)
5477                 return -ENODEV;
5478
5479         while ((cmd = strsep(&buf, ","))) {
5480                 res = kstrtoint(cmd, 10, &level);
5481                 if (res < 0)
5482                         return res;
5483         }
5484
5485         if (level >= 3 || level < 0)
5486                 return -EINVAL;
5487
5488         return kbdlight_set_level_and_update(level);
5489 }
5490
5491 static void kbdlight_suspend(void)
5492 {
5493         struct led_classdev *led_cdev;
5494
5495         if (!tp_features.kbdlight)
5496                 return;
5497
5498         led_cdev = &tpacpi_led_kbdlight.led_classdev;
5499         led_update_brightness(led_cdev);
5500         led_classdev_suspend(led_cdev);
5501 }
5502
5503 static void kbdlight_resume(void)
5504 {
5505         if (!tp_features.kbdlight)
5506                 return;
5507
5508         led_classdev_resume(&tpacpi_led_kbdlight.led_classdev);
5509 }
5510
5511 static struct ibm_struct kbdlight_driver_data = {
5512         .name = "kbdlight",
5513         .read = kbdlight_read,
5514         .write = kbdlight_write,
5515         .suspend = kbdlight_suspend,
5516         .resume = kbdlight_resume,
5517         .exit = kbdlight_exit,
5518 };
5519
5520 /*************************************************************************
5521  * Light (thinklight) subdriver
5522  */
5523
5524 TPACPI_HANDLE(lght, root, "\\LGHT");    /* A21e, A2xm/p, T20-22, X20-21 */
5525 TPACPI_HANDLE(ledb, ec, "LEDB");                /* G4x */
5526
5527 static int light_get_status(void)
5528 {
5529         int status = 0;
5530
5531         if (tp_features.light_status) {
5532                 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
5533                         return -EIO;
5534                 return (!!status);
5535         }
5536
5537         return -ENXIO;
5538 }
5539
5540 static int light_set_status(int status)
5541 {
5542         int rc;
5543
5544         if (tp_features.light) {
5545                 if (cmos_handle) {
5546                         rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
5547                                         (status) ?
5548                                                 TP_CMOS_THINKLIGHT_ON :
5549                                                 TP_CMOS_THINKLIGHT_OFF);
5550                 } else {
5551                         rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
5552                                         (status) ? 1 : 0);
5553                 }
5554                 return (rc) ? 0 : -EIO;
5555         }
5556
5557         return -ENXIO;
5558 }
5559
5560 static int light_sysfs_set(struct led_classdev *led_cdev,
5561                         enum led_brightness brightness)
5562 {
5563         return light_set_status((brightness != LED_OFF) ?
5564                                 TPACPI_LED_ON : TPACPI_LED_OFF);
5565 }
5566
5567 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
5568 {
5569         return (light_get_status() == 1) ? LED_FULL : LED_OFF;
5570 }
5571
5572 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
5573         .led_classdev = {
5574                 .name           = "tpacpi::thinklight",
5575                 .brightness_set_blocking = &light_sysfs_set,
5576                 .brightness_get = &light_sysfs_get,
5577         }
5578 };
5579
5580 static int __init light_init(struct ibm_init_struct *iibm)
5581 {
5582         int rc;
5583
5584         vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
5585
5586         if (tpacpi_is_ibm()) {
5587                 TPACPI_ACPIHANDLE_INIT(ledb);
5588                 TPACPI_ACPIHANDLE_INIT(lght);
5589         }
5590         TPACPI_ACPIHANDLE_INIT(cmos);
5591
5592         /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
5593         tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
5594
5595         if (tp_features.light)
5596                 /* light status not supported on
5597                    570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
5598                 tp_features.light_status =
5599                         acpi_evalf(ec_handle, NULL, "KBLT", "qv");
5600
5601         vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
5602                 str_supported(tp_features.light),
5603                 str_supported(tp_features.light_status));
5604
5605         if (!tp_features.light)
5606                 return 1;
5607
5608         rc = led_classdev_register(&tpacpi_pdev->dev,
5609                                    &tpacpi_led_thinklight.led_classdev);
5610
5611         if (rc < 0) {
5612                 tp_features.light = 0;
5613                 tp_features.light_status = 0;
5614         } else  {
5615                 rc = 0;
5616         }
5617
5618         return rc;
5619 }
5620
5621 static void light_exit(void)
5622 {
5623         led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
5624 }
5625
5626 static int light_read(struct seq_file *m)
5627 {
5628         int status;
5629
5630         if (!tp_features.light) {
5631                 seq_printf(m, "status:\t\tnot supported\n");
5632         } else if (!tp_features.light_status) {
5633                 seq_printf(m, "status:\t\tunknown\n");
5634                 seq_printf(m, "commands:\ton, off\n");
5635         } else {
5636                 status = light_get_status();
5637                 if (status < 0)
5638                         return status;
5639                 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
5640                 seq_printf(m, "commands:\ton, off\n");
5641         }
5642
5643         return 0;
5644 }
5645
5646 static int light_write(char *buf)
5647 {
5648         char *cmd;
5649         int newstatus = 0;
5650
5651         if (!tp_features.light)
5652                 return -ENODEV;
5653
5654         while ((cmd = strsep(&buf, ","))) {
5655                 if (strlencmp(cmd, "on") == 0) {
5656                         newstatus = 1;
5657                 } else if (strlencmp(cmd, "off") == 0) {
5658                         newstatus = 0;
5659                 } else
5660                         return -EINVAL;
5661         }
5662
5663         return light_set_status(newstatus);
5664 }
5665
5666 static struct ibm_struct light_driver_data = {
5667         .name = "light",
5668         .read = light_read,
5669         .write = light_write,
5670         .exit = light_exit,
5671 };
5672
5673 /*************************************************************************
5674  * CMOS subdriver
5675  */
5676
5677 /* sysfs cmos_command -------------------------------------------------- */
5678 static ssize_t cmos_command_store(struct device *dev,
5679                             struct device_attribute *attr,
5680                             const char *buf, size_t count)
5681 {
5682         unsigned long cmos_cmd;
5683         int res;
5684
5685         if (parse_strtoul(buf, 21, &cmos_cmd))
5686                 return -EINVAL;
5687
5688         res = issue_thinkpad_cmos_command(cmos_cmd);
5689         return (res) ? res : count;
5690 }
5691
5692 static DEVICE_ATTR_WO(cmos_command);
5693
5694 /* --------------------------------------------------------------------- */
5695
5696 static int __init cmos_init(struct ibm_init_struct *iibm)
5697 {
5698         int res;
5699
5700         vdbg_printk(TPACPI_DBG_INIT,
5701                 "initializing cmos commands subdriver\n");
5702
5703         TPACPI_ACPIHANDLE_INIT(cmos);
5704
5705         vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5706                 str_supported(cmos_handle != NULL));
5707
5708         res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5709         if (res)
5710                 return res;
5711
5712         return (cmos_handle) ? 0 : 1;
5713 }
5714
5715 static void cmos_exit(void)
5716 {
5717         device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5718 }
5719
5720 static int cmos_read(struct seq_file *m)
5721 {
5722         /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5723            R30, R31, T20-22, X20-21 */
5724         if (!cmos_handle)
5725                 seq_printf(m, "status:\t\tnot supported\n");
5726         else {
5727                 seq_printf(m, "status:\t\tsupported\n");
5728                 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5729         }
5730
5731         return 0;
5732 }
5733
5734 static int cmos_write(char *buf)
5735 {
5736         char *cmd;
5737         int cmos_cmd, res;
5738
5739         while ((cmd = strsep(&buf, ","))) {
5740                 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5741                     cmos_cmd >= 0 && cmos_cmd <= 21) {
5742                         /* cmos_cmd set */
5743                 } else
5744                         return -EINVAL;
5745
5746                 res = issue_thinkpad_cmos_command(cmos_cmd);
5747                 if (res)
5748                         return res;
5749         }
5750
5751         return 0;
5752 }
5753
5754 static struct ibm_struct cmos_driver_data = {
5755         .name = "cmos",
5756         .read = cmos_read,
5757         .write = cmos_write,
5758         .exit = cmos_exit,
5759 };
5760
5761 /*************************************************************************
5762  * LED subdriver
5763  */
5764
5765 enum led_access_mode {
5766         TPACPI_LED_NONE = 0,
5767         TPACPI_LED_570, /* 570 */
5768         TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5769         TPACPI_LED_NEW, /* all others */
5770 };
5771
5772 enum {  /* For TPACPI_LED_OLD */
5773         TPACPI_LED_EC_HLCL = 0x0c,      /* EC reg to get led to power on */
5774         TPACPI_LED_EC_HLBL = 0x0d,      /* EC reg to blink a lit led */
5775         TPACPI_LED_EC_HLMS = 0x0e,      /* EC reg to select led to command */
5776 };
5777
5778 static enum led_access_mode led_supported;
5779
5780 static acpi_handle led_handle;
5781
5782 #define TPACPI_LED_NUMLEDS 16
5783 static struct tpacpi_led_classdev *tpacpi_leds;
5784 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5785 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5786         /* there's a limit of 19 chars + NULL before 2.6.26 */
5787         "tpacpi::power",
5788         "tpacpi:orange:batt",
5789         "tpacpi:green:batt",
5790         "tpacpi::dock_active",
5791         "tpacpi::bay_active",
5792         "tpacpi::dock_batt",
5793         "tpacpi::unknown_led",
5794         "tpacpi::standby",
5795         "tpacpi::dock_status1",
5796         "tpacpi::dock_status2",
5797         "tpacpi::unknown_led2",
5798         "tpacpi::unknown_led3",
5799         "tpacpi::thinkvantage",
5800 };
5801 #define TPACPI_SAFE_LEDS        0x1081U
5802
5803 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5804 {
5805 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5806         return false;
5807 #else
5808         return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5809 #endif
5810 }
5811
5812 static int led_get_status(const unsigned int led)
5813 {
5814         int status;
5815         enum led_status_t led_s;
5816
5817         switch (led_supported) {
5818         case TPACPI_LED_570:
5819                 if (!acpi_evalf(ec_handle,
5820                                 &status, "GLED", "dd", 1 << led))
5821                         return -EIO;
5822                 led_s = (status == 0) ?
5823                                 TPACPI_LED_OFF :
5824                                 ((status == 1) ?
5825                                         TPACPI_LED_ON :
5826                                         TPACPI_LED_BLINK);
5827                 tpacpi_led_state_cache[led] = led_s;
5828                 return led_s;
5829         default:
5830                 return -ENXIO;
5831         }
5832
5833         /* not reached */
5834 }
5835
5836 static int led_set_status(const unsigned int led,
5837                           const enum led_status_t ledstatus)
5838 {
5839         /* off, on, blink. Index is led_status_t */
5840         static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5841         static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5842
5843         int rc = 0;
5844
5845         switch (led_supported) {
5846         case TPACPI_LED_570:
5847                 /* 570 */
5848                 if (unlikely(led > 7))
5849                         return -EINVAL;
5850                 if (unlikely(tpacpi_is_led_restricted(led)))
5851                         return -EPERM;
5852                 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5853                                 (1 << led), led_sled_arg1[ledstatus]))
5854                         return -EIO;
5855                 break;
5856         case TPACPI_LED_OLD:
5857                 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5858                 if (unlikely(led > 7))
5859                         return -EINVAL;
5860                 if (unlikely(tpacpi_is_led_restricted(led)))
5861                         return -EPERM;
5862                 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5863                 if (rc >= 0)
5864                         rc = ec_write(TPACPI_LED_EC_HLBL,
5865                                       (ledstatus == TPACPI_LED_BLINK) << led);
5866                 if (rc >= 0)
5867                         rc = ec_write(TPACPI_LED_EC_HLCL,
5868                                       (ledstatus != TPACPI_LED_OFF) << led);
5869                 break;
5870         case TPACPI_LED_NEW:
5871                 /* all others */
5872                 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5873                         return -EINVAL;
5874                 if (unlikely(tpacpi_is_led_restricted(led)))
5875                         return -EPERM;
5876                 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5877                                 led, led_led_arg1[ledstatus]))
5878                         return -EIO;
5879                 break;
5880         default:
5881                 return -ENXIO;
5882         }
5883
5884         if (!rc)
5885                 tpacpi_led_state_cache[led] = ledstatus;
5886
5887         return rc;
5888 }
5889
5890 static int led_sysfs_set(struct led_classdev *led_cdev,
5891                         enum led_brightness brightness)
5892 {
5893         struct tpacpi_led_classdev *data = container_of(led_cdev,
5894                              struct tpacpi_led_classdev, led_classdev);
5895         enum led_status_t new_state;
5896
5897         if (brightness == LED_OFF)
5898                 new_state = TPACPI_LED_OFF;
5899         else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5900                 new_state = TPACPI_LED_ON;
5901         else
5902                 new_state = TPACPI_LED_BLINK;
5903
5904         return led_set_status(data->led, new_state);
5905 }
5906
5907 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5908                         unsigned long *delay_on, unsigned long *delay_off)
5909 {
5910         struct tpacpi_led_classdev *data = container_of(led_cdev,
5911                              struct tpacpi_led_classdev, led_classdev);
5912
5913         /* Can we choose the flash rate? */
5914         if (*delay_on == 0 && *delay_off == 0) {
5915                 /* yes. set them to the hardware blink rate (1 Hz) */
5916                 *delay_on = 500; /* ms */
5917                 *delay_off = 500; /* ms */
5918         } else if ((*delay_on != 500) || (*delay_off != 500))
5919                 return -EINVAL;
5920
5921         return led_set_status(data->led, TPACPI_LED_BLINK);
5922 }
5923
5924 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5925 {
5926         int rc;
5927
5928         struct tpacpi_led_classdev *data = container_of(led_cdev,
5929                              struct tpacpi_led_classdev, led_classdev);
5930
5931         rc = led_get_status(data->led);
5932
5933         if (rc == TPACPI_LED_OFF || rc < 0)
5934                 rc = LED_OFF;   /* no error handling in led class :( */
5935         else
5936                 rc = LED_FULL;
5937
5938         return rc;
5939 }
5940
5941 static void led_exit(void)
5942 {
5943         unsigned int i;
5944
5945         for (i = 0; i < TPACPI_LED_NUMLEDS; i++)
5946                 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5947
5948         kfree(tpacpi_leds);
5949 }
5950
5951 static int __init tpacpi_init_led(unsigned int led)
5952 {
5953         /* LEDs with no name don't get registered */
5954         if (!tpacpi_led_names[led])
5955                 return 0;
5956
5957         tpacpi_leds[led].led_classdev.brightness_set_blocking = &led_sysfs_set;
5958         tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5959         if (led_supported == TPACPI_LED_570)
5960                 tpacpi_leds[led].led_classdev.brightness_get = &led_sysfs_get;
5961
5962         tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5963         tpacpi_leds[led].led = led;
5964
5965         return led_classdev_register(&tpacpi_pdev->dev, &tpacpi_leds[led].led_classdev);
5966 }
5967
5968 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5969         TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5970         TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5971         TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5972
5973         TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5974         TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5975         TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5976         TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5977         TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5978         TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5979         TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5980         TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5981
5982         TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5983         TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5984         TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5985         TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5986         TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5987
5988         TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5989         TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5990         TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5991         TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5992
5993         /* (1) - may have excess leds enabled on MSB */
5994
5995         /* Defaults (order matters, keep last, don't reorder!) */
5996         { /* Lenovo */
5997           .vendor = PCI_VENDOR_ID_LENOVO,
5998           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5999           .quirks = 0x1fffU,
6000         },
6001         { /* IBM ThinkPads with no EC version string */
6002           .vendor = PCI_VENDOR_ID_IBM,
6003           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
6004           .quirks = 0x00ffU,
6005         },
6006         { /* IBM ThinkPads with EC version string */
6007           .vendor = PCI_VENDOR_ID_IBM,
6008           .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
6009           .quirks = 0x00bfU,
6010         },
6011 };
6012
6013 static enum led_access_mode __init led_init_detect_mode(void)
6014 {
6015         acpi_status status;
6016
6017         if (tpacpi_is_ibm()) {
6018                 /* 570 */
6019                 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
6020                 if (ACPI_SUCCESS(status))
6021                         return TPACPI_LED_570;
6022
6023                 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
6024                 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
6025                 if (ACPI_SUCCESS(status))
6026                         return TPACPI_LED_OLD;
6027         }
6028
6029         /* most others */
6030         status = acpi_get_handle(ec_handle, "LED", &led_handle);
6031         if (ACPI_SUCCESS(status))
6032                 return TPACPI_LED_NEW;
6033
6034         /* R30, R31, and unknown firmwares */
6035         led_handle = NULL;
6036         return TPACPI_LED_NONE;
6037 }
6038
6039 static int __init led_init(struct ibm_init_struct *iibm)
6040 {
6041         unsigned int i;
6042         int rc;
6043         unsigned long useful_leds;
6044
6045         vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
6046
6047         led_supported = led_init_detect_mode();
6048
6049         if (led_supported != TPACPI_LED_NONE) {
6050                 useful_leds = tpacpi_check_quirks(led_useful_qtable,
6051                                 ARRAY_SIZE(led_useful_qtable));
6052
6053                 if (!useful_leds) {
6054                         led_handle = NULL;
6055                         led_supported = TPACPI_LED_NONE;
6056                 }
6057         }
6058
6059         vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
6060                 str_supported(led_supported), led_supported);
6061
6062         if (led_supported == TPACPI_LED_NONE)
6063                 return 1;
6064
6065         tpacpi_leds = kcalloc(TPACPI_LED_NUMLEDS, sizeof(*tpacpi_leds),
6066                               GFP_KERNEL);
6067         if (!tpacpi_leds) {
6068                 pr_err("Out of memory for LED data\n");
6069                 return -ENOMEM;
6070         }
6071
6072         for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
6073                 tpacpi_leds[i].led = -1;
6074
6075                 if (!tpacpi_is_led_restricted(i) && test_bit(i, &useful_leds)) {
6076                         rc = tpacpi_init_led(i);
6077                         if (rc < 0) {
6078                                 led_exit();
6079                                 return rc;
6080                         }
6081                 }
6082         }
6083
6084 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
6085         pr_notice("warning: userspace override of important firmware LEDs is enabled\n");
6086 #endif
6087         return 0;
6088 }
6089
6090 #define str_led_status(s) \
6091         ((s) == TPACPI_LED_OFF ? "off" : \
6092                 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
6093
6094 static int led_read(struct seq_file *m)
6095 {
6096         if (!led_supported) {
6097                 seq_printf(m, "status:\t\tnot supported\n");
6098                 return 0;
6099         }
6100         seq_printf(m, "status:\t\tsupported\n");
6101
6102         if (led_supported == TPACPI_LED_570) {
6103                 /* 570 */
6104                 int i, status;
6105                 for (i = 0; i < 8; i++) {
6106                         status = led_get_status(i);
6107                         if (status < 0)
6108                                 return -EIO;
6109                         seq_printf(m, "%d:\t\t%s\n",
6110                                        i, str_led_status(status));
6111                 }
6112         }
6113
6114         seq_printf(m, "commands:\t<led> on, <led> off, <led> blink (<led> is 0-15)\n");
6115
6116         return 0;
6117 }
6118
6119 static int led_write(char *buf)
6120 {
6121         char *cmd;
6122         int led, rc;
6123         enum led_status_t s;
6124
6125         if (!led_supported)
6126                 return -ENODEV;
6127
6128         while ((cmd = strsep(&buf, ","))) {
6129                 if (sscanf(cmd, "%d", &led) != 1)
6130                         return -EINVAL;
6131
6132                 if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1))
6133                         return -ENODEV;
6134
6135                 if (tpacpi_leds[led].led < 0)
6136                         return -ENODEV;
6137
6138                 if (strstr(cmd, "off")) {
6139                         s = TPACPI_LED_OFF;
6140                 } else if (strstr(cmd, "on")) {
6141                         s = TPACPI_LED_ON;
6142                 } else if (strstr(cmd, "blink")) {
6143                         s = TPACPI_LED_BLINK;
6144                 } else {
6145                         return -EINVAL;
6146                 }
6147
6148                 rc = led_set_status(led, s);
6149                 if (rc < 0)
6150                         return rc;
6151         }
6152
6153         return 0;
6154 }
6155
6156 static struct ibm_struct led_driver_data = {
6157         .name = "led",
6158         .read = led_read,
6159         .write = led_write,
6160         .exit = led_exit,
6161 };
6162
6163 /*************************************************************************
6164  * Beep subdriver
6165  */
6166
6167 TPACPI_HANDLE(beep, ec, "BEEP");        /* all except R30, R31 */
6168
6169 #define TPACPI_BEEP_Q1 0x0001
6170
6171 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
6172         TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
6173         TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
6174 };
6175
6176 static int __init beep_init(struct ibm_init_struct *iibm)
6177 {
6178         unsigned long quirks;
6179
6180         vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
6181
6182         TPACPI_ACPIHANDLE_INIT(beep);
6183
6184         vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
6185                 str_supported(beep_handle != NULL));
6186
6187         quirks = tpacpi_check_quirks(beep_quirk_table,
6188                                      ARRAY_SIZE(beep_quirk_table));
6189
6190         tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
6191
6192         return (beep_handle) ? 0 : 1;
6193 }
6194
6195 static int beep_read(struct seq_file *m)
6196 {
6197         if (!beep_handle)
6198                 seq_printf(m, "status:\t\tnot supported\n");
6199         else {
6200                 seq_printf(m, "status:\t\tsupported\n");
6201                 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
6202         }
6203
6204         return 0;
6205 }
6206
6207 static int beep_write(char *buf)
6208 {
6209         char *cmd;
6210         int beep_cmd;
6211
6212         if (!beep_handle)
6213                 return -ENODEV;
6214
6215         while ((cmd = strsep(&buf, ","))) {
6216                 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
6217                     beep_cmd >= 0 && beep_cmd <= 17) {
6218                         /* beep_cmd set */
6219                 } else
6220                         return -EINVAL;
6221                 if (tp_features.beep_needs_two_args) {
6222                         if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
6223                                         beep_cmd, 0))
6224                                 return -EIO;
6225                 } else {
6226                         if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
6227                                         beep_cmd))
6228                                 return -EIO;
6229                 }
6230         }
6231
6232         return 0;
6233 }
6234
6235 static struct ibm_struct beep_driver_data = {
6236         .name = "beep",
6237         .read = beep_read,
6238         .write = beep_write,
6239 };
6240
6241 /*************************************************************************
6242  * Thermal subdriver
6243  */
6244
6245 enum thermal_access_mode {
6246         TPACPI_THERMAL_NONE = 0,        /* No thermal support */
6247         TPACPI_THERMAL_ACPI_TMP07,      /* Use ACPI TMP0-7 */
6248         TPACPI_THERMAL_ACPI_UPDT,       /* Use ACPI TMP0-7 with UPDT */
6249         TPACPI_THERMAL_TPEC_8,          /* Use ACPI EC regs, 8 sensors */
6250         TPACPI_THERMAL_TPEC_16,         /* Use ACPI EC regs, 16 sensors */
6251 };
6252
6253 enum { /* TPACPI_THERMAL_TPEC_* */
6254         TP_EC_THERMAL_TMP0 = 0x78,      /* ACPI EC regs TMP 0..7 */
6255         TP_EC_THERMAL_TMP8 = 0xC0,      /* ACPI EC regs TMP 8..15 */
6256         TP_EC_THERMAL_TMP_NA = -128,    /* ACPI EC sensor not available */
6257
6258         TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
6259 };
6260
6261
6262 #define TPACPI_MAX_THERMAL_SENSORS 16   /* Max thermal sensors supported */
6263 struct ibm_thermal_sensors_struct {
6264         s32 temp[TPACPI_MAX_THERMAL_SENSORS];
6265 };
6266
6267 static enum thermal_access_mode thermal_read_mode;
6268
6269 /* idx is zero-based */
6270 static int thermal_get_sensor(int idx, s32 *value)
6271 {
6272         int t;
6273         s8 tmp;
6274         char tmpi[5];
6275
6276         t = TP_EC_THERMAL_TMP0;
6277
6278         switch (thermal_read_mode) {
6279 #if TPACPI_MAX_THERMAL_SENSORS >= 16
6280         case TPACPI_THERMAL_TPEC_16:
6281                 if (idx >= 8 && idx <= 15) {
6282                         t = TP_EC_THERMAL_TMP8;
6283                         idx -= 8;
6284                 }
6285 #endif
6286                 fallthrough;
6287         case TPACPI_THERMAL_TPEC_8:
6288                 if (idx <= 7) {
6289                         if (!acpi_ec_read(t + idx, &tmp))
6290                                 return -EIO;
6291                         *value = tmp * 1000;
6292                         return 0;
6293                 }
6294                 break;
6295
6296         case TPACPI_THERMAL_ACPI_UPDT:
6297                 if (idx <= 7) {
6298                         snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6299                         if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
6300                                 return -EIO;
6301                         if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6302                                 return -EIO;
6303                         *value = (t - 2732) * 100;
6304                         return 0;
6305                 }
6306                 break;
6307
6308         case TPACPI_THERMAL_ACPI_TMP07:
6309                 if (idx <= 7) {
6310                         snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6311                         if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6312                                 return -EIO;
6313                         if (t > 127 || t < -127)
6314                                 t = TP_EC_THERMAL_TMP_NA;
6315                         *value = t * 1000;
6316                         return 0;
6317                 }
6318                 break;
6319
6320         case TPACPI_THERMAL_NONE:
6321         default:
6322                 return -ENOSYS;
6323         }
6324
6325         return -EINVAL;
6326 }
6327
6328 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
6329 {
6330         int res, i;
6331         int n;
6332
6333         n = 8;
6334         i = 0;
6335
6336         if (!s)
6337                 return -EINVAL;
6338
6339         if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
6340                 n = 16;
6341
6342         for (i = 0 ; i < n; i++) {
6343                 res = thermal_get_sensor(i, &s->temp[i]);
6344                 if (res)
6345                         return res;
6346         }
6347
6348         return n;
6349 }
6350
6351 static void thermal_dump_all_sensors(void)
6352 {
6353         int n, i;
6354         struct ibm_thermal_sensors_struct t;
6355
6356         n = thermal_get_sensors(&t);
6357         if (n <= 0)
6358                 return;
6359
6360         pr_notice("temperatures (Celsius):");
6361
6362         for (i = 0; i < n; i++) {
6363                 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
6364                         pr_cont(" %d", (int)(t.temp[i] / 1000));
6365                 else
6366                         pr_cont(" N/A");
6367         }
6368
6369         pr_cont("\n");
6370 }
6371
6372 /* sysfs temp##_input -------------------------------------------------- */
6373
6374 static ssize_t thermal_temp_input_show(struct device *dev,
6375                            struct device_attribute *attr,
6376                            char *buf)
6377 {
6378         struct sensor_device_attribute *sensor_attr =
6379                                         to_sensor_dev_attr(attr);
6380         int idx = sensor_attr->index;
6381         s32 value;
6382         int res;
6383
6384         res = thermal_get_sensor(idx, &value);
6385         if (res)
6386                 return res;
6387         if (value == TPACPI_THERMAL_SENSOR_NA)
6388                 return -ENXIO;
6389
6390         return snprintf(buf, PAGE_SIZE, "%d\n", value);
6391 }
6392
6393 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
6394          SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
6395                      thermal_temp_input_show, NULL, _idxB)
6396
6397 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
6398         THERMAL_SENSOR_ATTR_TEMP(1, 0),
6399         THERMAL_SENSOR_ATTR_TEMP(2, 1),
6400         THERMAL_SENSOR_ATTR_TEMP(3, 2),
6401         THERMAL_SENSOR_ATTR_TEMP(4, 3),
6402         THERMAL_SENSOR_ATTR_TEMP(5, 4),
6403         THERMAL_SENSOR_ATTR_TEMP(6, 5),
6404         THERMAL_SENSOR_ATTR_TEMP(7, 6),
6405         THERMAL_SENSOR_ATTR_TEMP(8, 7),
6406         THERMAL_SENSOR_ATTR_TEMP(9, 8),
6407         THERMAL_SENSOR_ATTR_TEMP(10, 9),
6408         THERMAL_SENSOR_ATTR_TEMP(11, 10),
6409         THERMAL_SENSOR_ATTR_TEMP(12, 11),
6410         THERMAL_SENSOR_ATTR_TEMP(13, 12),
6411         THERMAL_SENSOR_ATTR_TEMP(14, 13),
6412         THERMAL_SENSOR_ATTR_TEMP(15, 14),
6413         THERMAL_SENSOR_ATTR_TEMP(16, 15),
6414 };
6415
6416 #define THERMAL_ATTRS(X) \
6417         &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
6418
6419 static struct attribute *thermal_temp_input_attr[] = {
6420         THERMAL_ATTRS(8),
6421         THERMAL_ATTRS(9),
6422         THERMAL_ATTRS(10),
6423         THERMAL_ATTRS(11),
6424         THERMAL_ATTRS(12),
6425         THERMAL_ATTRS(13),
6426         THERMAL_ATTRS(14),
6427         THERMAL_ATTRS(15),
6428         THERMAL_ATTRS(0),
6429         THERMAL_ATTRS(1),
6430         THERMAL_ATTRS(2),
6431         THERMAL_ATTRS(3),
6432         THERMAL_ATTRS(4),
6433         THERMAL_ATTRS(5),
6434         THERMAL_ATTRS(6),
6435         THERMAL_ATTRS(7),
6436         NULL
6437 };
6438
6439 static const struct attribute_group thermal_temp_input16_group = {
6440         .attrs = thermal_temp_input_attr
6441 };
6442
6443 static const struct attribute_group thermal_temp_input8_group = {
6444         .attrs = &thermal_temp_input_attr[8]
6445 };
6446
6447 #undef THERMAL_SENSOR_ATTR_TEMP
6448 #undef THERMAL_ATTRS
6449
6450 /* --------------------------------------------------------------------- */
6451
6452 static int __init thermal_init(struct ibm_init_struct *iibm)
6453 {
6454         u8 t, ta1, ta2;
6455         int i;
6456         int acpi_tmp7;
6457         int res;
6458
6459         vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
6460
6461         acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
6462
6463         if (thinkpad_id.ec_model) {
6464                 /*
6465                  * Direct EC access mode: sensors at registers
6466                  * 0x78-0x7F, 0xC0-0xC7.  Registers return 0x00 for
6467                  * non-implemented, thermal sensors return 0x80 when
6468                  * not available
6469                  */
6470
6471                 ta1 = ta2 = 0;
6472                 for (i = 0; i < 8; i++) {
6473                         if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
6474                                 ta1 |= t;
6475                         } else {
6476                                 ta1 = 0;
6477                                 break;
6478                         }
6479                         if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
6480                                 ta2 |= t;
6481                         } else {
6482                                 ta1 = 0;
6483                                 break;
6484                         }
6485                 }
6486                 if (ta1 == 0) {
6487                         /* This is sheer paranoia, but we handle it anyway */
6488                         if (acpi_tmp7) {
6489                                 pr_err("ThinkPad ACPI EC access misbehaving, falling back to ACPI TMPx access mode\n");
6490                                 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6491                         } else {
6492                                 pr_err("ThinkPad ACPI EC access misbehaving, disabling thermal sensors access\n");
6493                                 thermal_read_mode = TPACPI_THERMAL_NONE;
6494                         }
6495                 } else {
6496                         thermal_read_mode =
6497                             (ta2 != 0) ?
6498                             TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
6499                 }
6500         } else if (acpi_tmp7) {
6501                 if (tpacpi_is_ibm() &&
6502                     acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
6503                         /* 600e/x, 770e, 770x */
6504                         thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
6505                 } else {
6506                         /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
6507                         thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6508                 }
6509         } else {
6510                 /* temperatures not supported on 570, G4x, R30, R31, R32 */
6511                 thermal_read_mode = TPACPI_THERMAL_NONE;
6512         }
6513
6514         vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
6515                 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
6516                 thermal_read_mode);
6517
6518         switch (thermal_read_mode) {
6519         case TPACPI_THERMAL_TPEC_16:
6520                 res = sysfs_create_group(&tpacpi_hwmon->kobj,
6521                                 &thermal_temp_input16_group);
6522                 if (res)
6523                         return res;
6524                 break;
6525         case TPACPI_THERMAL_TPEC_8:
6526         case TPACPI_THERMAL_ACPI_TMP07:
6527         case TPACPI_THERMAL_ACPI_UPDT:
6528                 res = sysfs_create_group(&tpacpi_hwmon->kobj,
6529                                 &thermal_temp_input8_group);
6530                 if (res)
6531                         return res;
6532                 break;
6533         case TPACPI_THERMAL_NONE:
6534         default:
6535                 return 1;
6536         }
6537
6538         return 0;
6539 }
6540
6541 static void thermal_exit(void)
6542 {
6543         switch (thermal_read_mode) {
6544         case TPACPI_THERMAL_TPEC_16:
6545                 sysfs_remove_group(&tpacpi_hwmon->kobj,
6546                                    &thermal_temp_input16_group);
6547                 break;
6548         case TPACPI_THERMAL_TPEC_8:
6549         case TPACPI_THERMAL_ACPI_TMP07:
6550         case TPACPI_THERMAL_ACPI_UPDT:
6551                 sysfs_remove_group(&tpacpi_hwmon->kobj,
6552                                    &thermal_temp_input8_group);
6553                 break;
6554         case TPACPI_THERMAL_NONE:
6555         default:
6556                 break;
6557         }
6558 }
6559
6560 static int thermal_read(struct seq_file *m)
6561 {
6562         int n, i;
6563         struct ibm_thermal_sensors_struct t;
6564
6565         n = thermal_get_sensors(&t);
6566         if (unlikely(n < 0))
6567                 return n;
6568
6569         seq_printf(m, "temperatures:\t");
6570
6571         if (n > 0) {
6572                 for (i = 0; i < (n - 1); i++)
6573                         seq_printf(m, "%d ", t.temp[i] / 1000);
6574                 seq_printf(m, "%d\n", t.temp[i] / 1000);
6575         } else
6576                 seq_printf(m, "not supported\n");
6577
6578         return 0;
6579 }
6580
6581 static struct ibm_struct thermal_driver_data = {
6582         .name = "thermal",
6583         .read = thermal_read,
6584         .exit = thermal_exit,
6585 };
6586
6587 /*************************************************************************
6588  * Backlight/brightness subdriver
6589  */
6590
6591 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
6592
6593 /*
6594  * ThinkPads can read brightness from two places: EC HBRV (0x31), or
6595  * CMOS NVRAM byte 0x5E, bits 0-3.
6596  *
6597  * EC HBRV (0x31) has the following layout
6598  *   Bit 7: unknown function
6599  *   Bit 6: unknown function
6600  *   Bit 5: Z: honour scale changes, NZ: ignore scale changes
6601  *   Bit 4: must be set to zero to avoid problems
6602  *   Bit 3-0: backlight brightness level
6603  *
6604  * brightness_get_raw returns status data in the HBRV layout
6605  *
6606  * WARNING: The X61 has been verified to use HBRV for something else, so
6607  * this should be used _only_ on IBM ThinkPads, and maybe with some careful
6608  * testing on the very early *60 Lenovo models...
6609  */
6610
6611 enum {
6612         TP_EC_BACKLIGHT = 0x31,
6613
6614         /* TP_EC_BACKLIGHT bitmasks */
6615         TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6616         TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6617         TP_EC_BACKLIGHT_MAPSW = 0x20,
6618 };
6619
6620 enum tpacpi_brightness_access_mode {
6621         TPACPI_BRGHT_MODE_AUTO = 0,     /* Not implemented yet */
6622         TPACPI_BRGHT_MODE_EC,           /* EC control */
6623         TPACPI_BRGHT_MODE_UCMS_STEP,    /* UCMS step-based control */
6624         TPACPI_BRGHT_MODE_ECNVRAM,      /* EC control w/ NVRAM store */
6625         TPACPI_BRGHT_MODE_MAX
6626 };
6627
6628 static struct backlight_device *ibm_backlight_device;
6629
6630 static enum tpacpi_brightness_access_mode brightness_mode =
6631                 TPACPI_BRGHT_MODE_MAX;
6632
6633 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6634
6635 static struct mutex brightness_mutex;
6636
6637 /* NVRAM brightness access,
6638  * call with brightness_mutex held! */
6639 static unsigned int tpacpi_brightness_nvram_get(void)
6640 {
6641         u8 lnvram;
6642
6643         lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6644                   & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6645                   >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6646         lnvram &= bright_maxlvl;
6647
6648         return lnvram;
6649 }
6650
6651 static void tpacpi_brightness_checkpoint_nvram(void)
6652 {
6653         u8 lec = 0;
6654         u8 b_nvram;
6655
6656         if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6657                 return;
6658
6659         vdbg_printk(TPACPI_DBG_BRGHT,
6660                 "trying to checkpoint backlight level to NVRAM...\n");
6661
6662         if (mutex_lock_killable(&brightness_mutex) < 0)
6663                 return;
6664
6665         if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6666                 goto unlock;
6667         lec &= TP_EC_BACKLIGHT_LVLMSK;
6668         b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6669
6670         if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6671                              >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6672                 /* NVRAM needs update */
6673                 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6674                                 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6675                 b_nvram |= lec;
6676                 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6677                 dbg_printk(TPACPI_DBG_BRGHT,
6678                            "updated NVRAM backlight level to %u (0x%02x)\n",
6679                            (unsigned int) lec, (unsigned int) b_nvram);
6680         } else
6681                 vdbg_printk(TPACPI_DBG_BRGHT,
6682                            "NVRAM backlight level already is %u (0x%02x)\n",
6683                            (unsigned int) lec, (unsigned int) b_nvram);
6684
6685 unlock:
6686         mutex_unlock(&brightness_mutex);
6687 }
6688
6689
6690 /* call with brightness_mutex held! */
6691 static int tpacpi_brightness_get_raw(int *status)
6692 {
6693         u8 lec = 0;
6694
6695         switch (brightness_mode) {
6696         case TPACPI_BRGHT_MODE_UCMS_STEP:
6697                 *status = tpacpi_brightness_nvram_get();
6698                 return 0;
6699         case TPACPI_BRGHT_MODE_EC:
6700         case TPACPI_BRGHT_MODE_ECNVRAM:
6701                 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6702                         return -EIO;
6703                 *status = lec;
6704                 return 0;
6705         default:
6706                 return -ENXIO;
6707         }
6708 }
6709
6710 /* call with brightness_mutex held! */
6711 /* do NOT call with illegal backlight level value */
6712 static int tpacpi_brightness_set_ec(unsigned int value)
6713 {
6714         u8 lec = 0;
6715
6716         if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6717                 return -EIO;
6718
6719         if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6720                                 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6721                                 (value & TP_EC_BACKLIGHT_LVLMSK))))
6722                 return -EIO;
6723
6724         return 0;
6725 }
6726
6727 /* call with brightness_mutex held! */
6728 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6729 {
6730         int cmos_cmd, inc;
6731         unsigned int current_value, i;
6732
6733         current_value = tpacpi_brightness_nvram_get();
6734
6735         if (value == current_value)
6736                 return 0;
6737
6738         cmos_cmd = (value > current_value) ?
6739                         TP_CMOS_BRIGHTNESS_UP :
6740                         TP_CMOS_BRIGHTNESS_DOWN;
6741         inc = (value > current_value) ? 1 : -1;
6742
6743         for (i = current_value; i != value; i += inc)
6744                 if (issue_thinkpad_cmos_command(cmos_cmd))
6745                         return -EIO;
6746
6747         return 0;
6748 }
6749
6750 /* May return EINTR which can always be mapped to ERESTARTSYS */
6751 static int brightness_set(unsigned int value)
6752 {
6753         int res;
6754
6755         if (value > bright_maxlvl)
6756                 return -EINVAL;
6757
6758         vdbg_printk(TPACPI_DBG_BRGHT,
6759                         "set backlight level to %d\n", value);
6760
6761         res = mutex_lock_killable(&brightness_mutex);
6762         if (res < 0)
6763                 return res;
6764
6765         switch (brightness_mode) {
6766         case TPACPI_BRGHT_MODE_EC:
6767         case TPACPI_BRGHT_MODE_ECNVRAM:
6768                 res = tpacpi_brightness_set_ec(value);
6769                 break;
6770         case TPACPI_BRGHT_MODE_UCMS_STEP:
6771                 res = tpacpi_brightness_set_ucmsstep(value);
6772                 break;
6773         default:
6774                 res = -ENXIO;
6775         }
6776
6777         mutex_unlock(&brightness_mutex);
6778         return res;
6779 }
6780
6781 /* sysfs backlight class ----------------------------------------------- */
6782
6783 static int brightness_update_status(struct backlight_device *bd)
6784 {
6785         unsigned int level =
6786                 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6787                  bd->props.power == FB_BLANK_UNBLANK) ?
6788                                 bd->props.brightness : 0;
6789
6790         dbg_printk(TPACPI_DBG_BRGHT,
6791                         "backlight: attempt to set level to %d\n",
6792                         level);
6793
6794         /* it is the backlight class's job (caller) to handle
6795          * EINTR and other errors properly */
6796         return brightness_set(level);
6797 }
6798
6799 static int brightness_get(struct backlight_device *bd)
6800 {
6801         int status, res;
6802
6803         res = mutex_lock_killable(&brightness_mutex);
6804         if (res < 0)
6805                 return 0;
6806
6807         res = tpacpi_brightness_get_raw(&status);
6808
6809         mutex_unlock(&brightness_mutex);
6810
6811         if (res < 0)
6812                 return 0;
6813
6814         return status & TP_EC_BACKLIGHT_LVLMSK;
6815 }
6816
6817 static void tpacpi_brightness_notify_change(void)
6818 {
6819         backlight_force_update(ibm_backlight_device,
6820                                BACKLIGHT_UPDATE_HOTKEY);
6821 }
6822
6823 static const struct backlight_ops ibm_backlight_data = {
6824         .get_brightness = brightness_get,
6825         .update_status  = brightness_update_status,
6826 };
6827
6828 /* --------------------------------------------------------------------- */
6829
6830 /*
6831  * Call _BCL method of video device.  On some ThinkPads this will
6832  * switch the firmware to the ACPI brightness control mode.
6833  */
6834
6835 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6836 {
6837         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6838         union acpi_object *obj;
6839         struct acpi_device *device, *child;
6840         int rc;
6841
6842         if (acpi_bus_get_device(handle, &device))
6843                 return 0;
6844
6845         rc = 0;
6846         list_for_each_entry(child, &device->children, node) {
6847                 acpi_status status = acpi_evaluate_object(child->handle, "_BCL",
6848                                                           NULL, &buffer);
6849                 if (ACPI_FAILURE(status)) {
6850                         buffer.length = ACPI_ALLOCATE_BUFFER;
6851                         continue;
6852                 }
6853
6854                 obj = (union acpi_object *)buffer.pointer;
6855                 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6856                         pr_err("Unknown _BCL data, please report this to %s\n",
6857                                 TPACPI_MAIL);
6858                         rc = 0;
6859                 } else {
6860                         rc = obj->package.count;
6861                 }
6862                 break;
6863         }
6864
6865         kfree(buffer.pointer);
6866         return rc;
6867 }
6868
6869
6870 /*
6871  * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6872  */
6873 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6874 {
6875         acpi_handle video_device;
6876         int bcl_levels = 0;
6877
6878         tpacpi_acpi_handle_locate("video", NULL, &video_device);
6879         if (video_device)
6880                 bcl_levels = tpacpi_query_bcl_levels(video_device);
6881
6882         tp_features.bright_acpimode = (bcl_levels > 0);
6883
6884         return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6885 }
6886
6887 /*
6888  * These are only useful for models that have only one possibility
6889  * of GPU.  If the BIOS model handles both ATI and Intel, don't use
6890  * these quirks.
6891  */
6892 #define TPACPI_BRGHT_Q_NOEC     0x0001  /* Must NOT use EC HBRV */
6893 #define TPACPI_BRGHT_Q_EC       0x0002  /* Should or must use EC HBRV */
6894 #define TPACPI_BRGHT_Q_ASK      0x8000  /* Ask for user report */
6895
6896 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6897         /* Models with ATI GPUs known to require ECNVRAM mode */
6898         TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC),      /* T43/p ATI */
6899
6900         /* Models with ATI GPUs that can use ECNVRAM */
6901         TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC),      /* R50,51 T40-42 */
6902         TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6903         TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC),      /* R52 */
6904         TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6905
6906         /* Models with Intel Extreme Graphics 2 */
6907         TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC),    /* X40 */
6908         TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6909         TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6910
6911         /* Models with Intel GMA900 */
6912         TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC),    /* T43, R52 */
6913         TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC),    /* X41 */
6914         TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC),    /* X41 Tablet */
6915 };
6916
6917 /*
6918  * Returns < 0 for error, otherwise sets tp_features.bright_*
6919  * and bright_maxlvl.
6920  */
6921 static void __init tpacpi_detect_brightness_capabilities(void)
6922 {
6923         unsigned int b;
6924
6925         vdbg_printk(TPACPI_DBG_INIT,
6926                     "detecting firmware brightness interface capabilities\n");
6927
6928         /* we could run a quirks check here (same table used by
6929          * brightness_init) if needed */
6930
6931         /*
6932          * We always attempt to detect acpi support, so as to switch
6933          * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6934          * going to publish a backlight interface
6935          */
6936         b = tpacpi_check_std_acpi_brightness_support();
6937         switch (b) {
6938         case 16:
6939                 bright_maxlvl = 15;
6940                 break;
6941         case 8:
6942         case 0:
6943                 bright_maxlvl = 7;
6944                 break;
6945         default:
6946                 tp_features.bright_unkfw = 1;
6947                 bright_maxlvl = b - 1;
6948         }
6949         pr_debug("detected %u brightness levels\n", bright_maxlvl + 1);
6950 }
6951
6952 static int __init brightness_init(struct ibm_init_struct *iibm)
6953 {
6954         struct backlight_properties props;
6955         int b;
6956         unsigned long quirks;
6957
6958         vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6959
6960         mutex_init(&brightness_mutex);
6961
6962         quirks = tpacpi_check_quirks(brightness_quirk_table,
6963                                 ARRAY_SIZE(brightness_quirk_table));
6964
6965         /* tpacpi_detect_brightness_capabilities() must have run already */
6966
6967         /* if it is unknown, we don't handle it: it wouldn't be safe */
6968         if (tp_features.bright_unkfw)
6969                 return 1;
6970
6971         if (!brightness_enable) {
6972                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6973                            "brightness support disabled by module parameter\n");
6974                 return 1;
6975         }
6976
6977         if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
6978                 if (brightness_enable > 1) {
6979                         pr_info("Standard ACPI backlight interface available, not loading native one\n");
6980                         return 1;
6981                 } else if (brightness_enable == 1) {
6982                         pr_warn("Cannot enable backlight brightness support, ACPI is already handling it.  Refer to the acpi_backlight kernel parameter.\n");
6983                         return 1;
6984                 }
6985         } else if (!tp_features.bright_acpimode) {
6986                 pr_notice("ACPI backlight interface not available\n");
6987                 return 1;
6988         }
6989
6990         pr_notice("ACPI native brightness control enabled\n");
6991
6992         /*
6993          * Check for module parameter bogosity, note that we
6994          * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6995          * able to detect "unspecified"
6996          */
6997         if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6998                 return -EINVAL;
6999
7000         /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
7001         if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
7002             brightness_mode == TPACPI_BRGHT_MODE_MAX) {
7003                 if (quirks & TPACPI_BRGHT_Q_EC)
7004                         brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
7005                 else
7006                         brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
7007
7008                 dbg_printk(TPACPI_DBG_BRGHT,
7009                            "driver auto-selected brightness_mode=%d\n",
7010                            brightness_mode);
7011         }
7012
7013         /* Safety */
7014         if (!tpacpi_is_ibm() &&
7015             (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
7016              brightness_mode == TPACPI_BRGHT_MODE_EC))
7017                 return -EINVAL;
7018
7019         if (tpacpi_brightness_get_raw(&b) < 0)
7020                 return 1;
7021
7022         memset(&props, 0, sizeof(struct backlight_properties));
7023         props.type = BACKLIGHT_PLATFORM;
7024         props.max_brightness = bright_maxlvl;
7025         props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
7026         ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
7027                                                          NULL, NULL,
7028                                                          &ibm_backlight_data,
7029                                                          &props);
7030         if (IS_ERR(ibm_backlight_device)) {
7031                 int rc = PTR_ERR(ibm_backlight_device);
7032                 ibm_backlight_device = NULL;
7033                 pr_err("Could not register backlight device\n");
7034                 return rc;
7035         }
7036         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
7037                         "brightness is supported\n");
7038
7039         if (quirks & TPACPI_BRGHT_Q_ASK) {
7040                 pr_notice("brightness: will use unverified default: brightness_mode=%d\n",
7041                           brightness_mode);
7042                 pr_notice("brightness: please report to %s whether it works well or not on your ThinkPad\n",
7043                           TPACPI_MAIL);
7044         }
7045
7046         /* Added by mistake in early 2007.  Probably useless, but it could
7047          * be working around some unknown firmware problem where the value
7048          * read at startup doesn't match the real hardware state... so leave
7049          * it in place just in case */
7050         backlight_update_status(ibm_backlight_device);
7051
7052         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
7053                     "brightness: registering brightness hotkeys as change notification\n");
7054         tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7055                                 | TP_ACPI_HKEY_BRGHTUP_MASK
7056                                 | TP_ACPI_HKEY_BRGHTDWN_MASK);
7057         return 0;
7058 }
7059
7060 static void brightness_suspend(void)
7061 {
7062         tpacpi_brightness_checkpoint_nvram();
7063 }
7064
7065 static void brightness_shutdown(void)
7066 {
7067         tpacpi_brightness_checkpoint_nvram();
7068 }
7069
7070 static void brightness_exit(void)
7071 {
7072         if (ibm_backlight_device) {
7073                 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
7074                             "calling backlight_device_unregister()\n");
7075                 backlight_device_unregister(ibm_backlight_device);
7076         }
7077
7078         tpacpi_brightness_checkpoint_nvram();
7079 }
7080
7081 static int brightness_read(struct seq_file *m)
7082 {
7083         int level;
7084
7085         level = brightness_get(NULL);
7086         if (level < 0) {
7087                 seq_printf(m, "level:\t\tunreadable\n");
7088         } else {
7089                 seq_printf(m, "level:\t\t%d\n", level);
7090                 seq_printf(m, "commands:\tup, down\n");
7091                 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7092                                bright_maxlvl);
7093         }
7094
7095         return 0;
7096 }
7097
7098 static int brightness_write(char *buf)
7099 {
7100         int level;
7101         int rc;
7102         char *cmd;
7103
7104         level = brightness_get(NULL);
7105         if (level < 0)
7106                 return level;
7107
7108         while ((cmd = strsep(&buf, ","))) {
7109                 if (strlencmp(cmd, "up") == 0) {
7110                         if (level < bright_maxlvl)
7111                                 level++;
7112                 } else if (strlencmp(cmd, "down") == 0) {
7113                         if (level > 0)
7114                                 level--;
7115                 } else if (sscanf(cmd, "level %d", &level) == 1 &&
7116                            level >= 0 && level <= bright_maxlvl) {
7117                         /* new level set */
7118                 } else
7119                         return -EINVAL;
7120         }
7121
7122         tpacpi_disclose_usertask("procfs brightness",
7123                         "set level to %d\n", level);
7124
7125         /*
7126          * Now we know what the final level should be, so we try to set it.
7127          * Doing it this way makes the syscall restartable in case of EINTR
7128          */
7129         rc = brightness_set(level);
7130         if (!rc && ibm_backlight_device)
7131                 backlight_force_update(ibm_backlight_device,
7132                                         BACKLIGHT_UPDATE_SYSFS);
7133         return (rc == -EINTR) ? -ERESTARTSYS : rc;
7134 }
7135
7136 static struct ibm_struct brightness_driver_data = {
7137         .name = "brightness",
7138         .read = brightness_read,
7139         .write = brightness_write,
7140         .exit = brightness_exit,
7141         .suspend = brightness_suspend,
7142         .shutdown = brightness_shutdown,
7143 };
7144
7145 /*************************************************************************
7146  * Volume subdriver
7147  */
7148
7149 /*
7150  * IBM ThinkPads have a simple volume controller with MUTE gating.
7151  * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
7152  *
7153  * Since the *61 series (and probably also the later *60 series), Lenovo
7154  * ThinkPads only implement the MUTE gate.
7155  *
7156  * EC register 0x30
7157  *   Bit 6: MUTE (1 mutes sound)
7158  *   Bit 3-0: Volume
7159  *   Other bits should be zero as far as we know.
7160  *
7161  * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
7162  * bits 3-0 (volume).  Other bits in NVRAM may have other functions,
7163  * such as bit 7 which is used to detect repeated presses of MUTE,
7164  * and we leave them unchanged.
7165  *
7166  * On newer Lenovo ThinkPads, the EC can automatically change the volume
7167  * in response to user input.  Unfortunately, this rarely works well.
7168  * The laptop changes the state of its internal MUTE gate and, on some
7169  * models, sends KEY_MUTE, causing any user code that responds to the
7170  * mute button to get confused.  The hardware MUTE gate is also
7171  * unnecessary, since user code can handle the mute button without
7172  * kernel or EC help.
7173  *
7174  * To avoid confusing userspace, we simply disable all EC-based mute
7175  * and volume controls when possible.
7176  */
7177
7178 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
7179
7180 #define TPACPI_ALSA_DRVNAME  "ThinkPad EC"
7181 #define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
7182 #define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
7183
7184 #if SNDRV_CARDS <= 32
7185 #define DEFAULT_ALSA_IDX                ~((1 << (SNDRV_CARDS - 3)) - 1)
7186 #else
7187 #define DEFAULT_ALSA_IDX                ~((1 << (32 - 3)) - 1)
7188 #endif
7189 static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
7190 static char *alsa_id = "ThinkPadEC";
7191 static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
7192
7193 struct tpacpi_alsa_data {
7194         struct snd_card *card;
7195         struct snd_ctl_elem_id *ctl_mute_id;
7196         struct snd_ctl_elem_id *ctl_vol_id;
7197 };
7198
7199 static struct snd_card *alsa_card;
7200
7201 enum {
7202         TP_EC_AUDIO = 0x30,
7203
7204         /* TP_EC_AUDIO bits */
7205         TP_EC_AUDIO_MUTESW = 6,
7206
7207         /* TP_EC_AUDIO bitmasks */
7208         TP_EC_AUDIO_LVL_MSK = 0x0F,
7209         TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
7210
7211         /* Maximum volume */
7212         TP_EC_VOLUME_MAX = 14,
7213 };
7214
7215 enum tpacpi_volume_access_mode {
7216         TPACPI_VOL_MODE_AUTO = 0,       /* Not implemented yet */
7217         TPACPI_VOL_MODE_EC,             /* Pure EC control */
7218         TPACPI_VOL_MODE_UCMS_STEP,      /* UCMS step-based control: N/A */
7219         TPACPI_VOL_MODE_ECNVRAM,        /* EC control w/ NVRAM store */
7220         TPACPI_VOL_MODE_MAX
7221 };
7222
7223 enum tpacpi_volume_capabilities {
7224         TPACPI_VOL_CAP_AUTO = 0,        /* Use white/blacklist */
7225         TPACPI_VOL_CAP_VOLMUTE,         /* Output vol and mute */
7226         TPACPI_VOL_CAP_MUTEONLY,        /* Output mute only */
7227         TPACPI_VOL_CAP_MAX
7228 };
7229
7230 enum tpacpi_mute_btn_mode {
7231         TP_EC_MUTE_BTN_LATCH  = 0,      /* Mute mutes; up/down unmutes */
7232         /* We don't know what mode 1 is. */
7233         TP_EC_MUTE_BTN_NONE   = 2,      /* Mute and up/down are just keys */
7234         TP_EC_MUTE_BTN_TOGGLE = 3,      /* Mute toggles; up/down unmutes */
7235 };
7236
7237 static enum tpacpi_volume_access_mode volume_mode =
7238         TPACPI_VOL_MODE_MAX;
7239
7240 static enum tpacpi_volume_capabilities volume_capabilities;
7241 static bool volume_control_allowed;
7242 static bool software_mute_requested = true;
7243 static bool software_mute_active;
7244 static int software_mute_orig_mode;
7245
7246 /*
7247  * Used to syncronize writers to TP_EC_AUDIO and
7248  * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
7249  */
7250 static struct mutex volume_mutex;
7251
7252 static void tpacpi_volume_checkpoint_nvram(void)
7253 {
7254         u8 lec = 0;
7255         u8 b_nvram;
7256         u8 ec_mask;
7257
7258         if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
7259                 return;
7260         if (!volume_control_allowed)
7261                 return;
7262         if (software_mute_active)
7263                 return;
7264
7265         vdbg_printk(TPACPI_DBG_MIXER,
7266                 "trying to checkpoint mixer state to NVRAM...\n");
7267
7268         if (tp_features.mixer_no_level_control)
7269                 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
7270         else
7271                 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
7272
7273         if (mutex_lock_killable(&volume_mutex) < 0)
7274                 return;
7275
7276         if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
7277                 goto unlock;
7278         lec &= ec_mask;
7279         b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
7280
7281         if (lec != (b_nvram & ec_mask)) {
7282                 /* NVRAM needs update */
7283                 b_nvram &= ~ec_mask;
7284                 b_nvram |= lec;
7285                 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
7286                 dbg_printk(TPACPI_DBG_MIXER,
7287                            "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
7288                            (unsigned int) lec, (unsigned int) b_nvram);
7289         } else {
7290                 vdbg_printk(TPACPI_DBG_MIXER,
7291                            "NVRAM mixer status already is 0x%02x (0x%02x)\n",
7292                            (unsigned int) lec, (unsigned int) b_nvram);
7293         }
7294
7295 unlock:
7296         mutex_unlock(&volume_mutex);
7297 }
7298
7299 static int volume_get_status_ec(u8 *status)
7300 {
7301         u8 s;
7302
7303         if (!acpi_ec_read(TP_EC_AUDIO, &s))
7304                 return -EIO;
7305
7306         *status = s;
7307
7308         dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
7309
7310         return 0;
7311 }
7312
7313 static int volume_get_status(u8 *status)
7314 {
7315         return volume_get_status_ec(status);
7316 }
7317
7318 static int volume_set_status_ec(const u8 status)
7319 {
7320         if (!acpi_ec_write(TP_EC_AUDIO, status))
7321                 return -EIO;
7322
7323         dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
7324
7325         /*
7326          * On X200s, and possibly on others, it can take a while for
7327          * reads to become correct.
7328          */
7329         msleep(1);
7330
7331         return 0;
7332 }
7333
7334 static int volume_set_status(const u8 status)
7335 {
7336         return volume_set_status_ec(status);
7337 }
7338
7339 /* returns < 0 on error, 0 on no change, 1 on change */
7340 static int __volume_set_mute_ec(const bool mute)
7341 {
7342         int rc;
7343         u8 s, n;
7344
7345         if (mutex_lock_killable(&volume_mutex) < 0)
7346                 return -EINTR;
7347
7348         rc = volume_get_status_ec(&s);
7349         if (rc)
7350                 goto unlock;
7351
7352         n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
7353                      s & ~TP_EC_AUDIO_MUTESW_MSK;
7354
7355         if (n != s) {
7356                 rc = volume_set_status_ec(n);
7357                 if (!rc)
7358                         rc = 1;
7359         }
7360
7361 unlock:
7362         mutex_unlock(&volume_mutex);
7363         return rc;
7364 }
7365
7366 static int volume_alsa_set_mute(const bool mute)
7367 {
7368         dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
7369                    (mute) ? "" : "un");
7370         return __volume_set_mute_ec(mute);
7371 }
7372
7373 static int volume_set_mute(const bool mute)
7374 {
7375         int rc;
7376
7377         dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
7378                    (mute) ? "" : "un");
7379
7380         rc = __volume_set_mute_ec(mute);
7381         return (rc < 0) ? rc : 0;
7382 }
7383
7384 /* returns < 0 on error, 0 on no change, 1 on change */
7385 static int __volume_set_volume_ec(const u8 vol)
7386 {
7387         int rc;
7388         u8 s, n;
7389
7390         if (vol > TP_EC_VOLUME_MAX)
7391                 return -EINVAL;
7392
7393         if (mutex_lock_killable(&volume_mutex) < 0)
7394                 return -EINTR;
7395
7396         rc = volume_get_status_ec(&s);
7397         if (rc)
7398                 goto unlock;
7399
7400         n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
7401
7402         if (n != s) {
7403                 rc = volume_set_status_ec(n);
7404                 if (!rc)
7405                         rc = 1;
7406         }
7407
7408 unlock:
7409         mutex_unlock(&volume_mutex);
7410         return rc;
7411 }
7412
7413 static int volume_set_software_mute(bool startup)
7414 {
7415         int result;
7416
7417         if (!tpacpi_is_lenovo())
7418                 return -ENODEV;
7419
7420         if (startup) {
7421                 if (!acpi_evalf(ec_handle, &software_mute_orig_mode,
7422                                 "HAUM", "qd"))
7423                         return -EIO;
7424
7425                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7426                             "Initial HAUM setting was %d\n",
7427                             software_mute_orig_mode);
7428         }
7429
7430         if (!acpi_evalf(ec_handle, &result, "SAUM", "qdd",
7431                         (int)TP_EC_MUTE_BTN_NONE))
7432                 return -EIO;
7433
7434         if (result != TP_EC_MUTE_BTN_NONE)
7435                 pr_warn("Unexpected SAUM result %d\n",
7436                         result);
7437
7438         /*
7439          * In software mute mode, the standard codec controls take
7440          * precendence, so we unmute the ThinkPad HW switch at
7441          * startup.  Just on case there are SAUM-capable ThinkPads
7442          * with level controls, set max HW volume as well.
7443          */
7444         if (tp_features.mixer_no_level_control)
7445                 result = volume_set_mute(false);
7446         else
7447                 result = volume_set_status(TP_EC_VOLUME_MAX);
7448
7449         if (result != 0)
7450                 pr_warn("Failed to unmute the HW mute switch\n");
7451
7452         return 0;
7453 }
7454
7455 static void volume_exit_software_mute(void)
7456 {
7457         int r;
7458
7459         if (!acpi_evalf(ec_handle, &r, "SAUM", "qdd", software_mute_orig_mode)
7460             || r != software_mute_orig_mode)
7461                 pr_warn("Failed to restore mute mode\n");
7462 }
7463
7464 static int volume_alsa_set_volume(const u8 vol)
7465 {
7466         dbg_printk(TPACPI_DBG_MIXER,
7467                    "ALSA: trying to set volume level to %hu\n", vol);
7468         return __volume_set_volume_ec(vol);
7469 }
7470
7471 static void volume_alsa_notify_change(void)
7472 {
7473         struct tpacpi_alsa_data *d;
7474
7475         if (alsa_card && alsa_card->private_data) {
7476                 d = alsa_card->private_data;
7477                 if (d->ctl_mute_id)
7478                         snd_ctl_notify(alsa_card,
7479                                         SNDRV_CTL_EVENT_MASK_VALUE,
7480                                         d->ctl_mute_id);
7481                 if (d->ctl_vol_id)
7482                         snd_ctl_notify(alsa_card,
7483                                         SNDRV_CTL_EVENT_MASK_VALUE,
7484                                         d->ctl_vol_id);
7485         }
7486 }
7487
7488 static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
7489                                 struct snd_ctl_elem_info *uinfo)
7490 {
7491         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
7492         uinfo->count = 1;
7493         uinfo->value.integer.min = 0;
7494         uinfo->value.integer.max = TP_EC_VOLUME_MAX;
7495         return 0;
7496 }
7497
7498 static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
7499                                 struct snd_ctl_elem_value *ucontrol)
7500 {
7501         u8 s;
7502         int rc;
7503
7504         rc = volume_get_status(&s);
7505         if (rc < 0)
7506                 return rc;
7507
7508         ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
7509         return 0;
7510 }
7511
7512 static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
7513                                 struct snd_ctl_elem_value *ucontrol)
7514 {
7515         tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
7516                                  ucontrol->value.integer.value[0]);
7517         return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
7518 }
7519
7520 #define volume_alsa_mute_info snd_ctl_boolean_mono_info
7521
7522 static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
7523                                 struct snd_ctl_elem_value *ucontrol)
7524 {
7525         u8 s;
7526         int rc;
7527
7528         rc = volume_get_status(&s);
7529         if (rc < 0)
7530                 return rc;
7531
7532         ucontrol->value.integer.value[0] =
7533                                 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
7534         return 0;
7535 }
7536
7537 static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
7538                                 struct snd_ctl_elem_value *ucontrol)
7539 {
7540         tpacpi_disclose_usertask("ALSA", "%smute\n",
7541                                  ucontrol->value.integer.value[0] ?
7542                                         "un" : "");
7543         return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
7544 }
7545
7546 static struct snd_kcontrol_new volume_alsa_control_vol __initdata = {
7547         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7548         .name = "Console Playback Volume",
7549         .index = 0,
7550         .access = SNDRV_CTL_ELEM_ACCESS_READ,
7551         .info = volume_alsa_vol_info,
7552         .get = volume_alsa_vol_get,
7553 };
7554
7555 static struct snd_kcontrol_new volume_alsa_control_mute __initdata = {
7556         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7557         .name = "Console Playback Switch",
7558         .index = 0,
7559         .access = SNDRV_CTL_ELEM_ACCESS_READ,
7560         .info = volume_alsa_mute_info,
7561         .get = volume_alsa_mute_get,
7562 };
7563
7564 static void volume_suspend(void)
7565 {
7566         tpacpi_volume_checkpoint_nvram();
7567 }
7568
7569 static void volume_resume(void)
7570 {
7571         if (software_mute_active) {
7572                 if (volume_set_software_mute(false) < 0)
7573                         pr_warn("Failed to restore software mute\n");
7574         } else {
7575                 volume_alsa_notify_change();
7576         }
7577 }
7578
7579 static void volume_shutdown(void)
7580 {
7581         tpacpi_volume_checkpoint_nvram();
7582 }
7583
7584 static void volume_exit(void)
7585 {
7586         if (alsa_card) {
7587                 snd_card_free(alsa_card);
7588                 alsa_card = NULL;
7589         }
7590
7591         tpacpi_volume_checkpoint_nvram();
7592
7593         if (software_mute_active)
7594                 volume_exit_software_mute();
7595 }
7596
7597 static int __init volume_create_alsa_mixer(void)
7598 {
7599         struct snd_card *card;
7600         struct tpacpi_alsa_data *data;
7601         struct snd_kcontrol *ctl_vol;
7602         struct snd_kcontrol *ctl_mute;
7603         int rc;
7604
7605         rc = snd_card_new(&tpacpi_pdev->dev,
7606                           alsa_index, alsa_id, THIS_MODULE,
7607                           sizeof(struct tpacpi_alsa_data), &card);
7608         if (rc < 0 || !card) {
7609                 pr_err("Failed to create ALSA card structures: %d\n", rc);
7610                 return 1;
7611         }
7612
7613         BUG_ON(!card->private_data);
7614         data = card->private_data;
7615         data->card = card;
7616
7617         strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
7618                 sizeof(card->driver));
7619         strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
7620                 sizeof(card->shortname));
7621         snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
7622                  (thinkpad_id.ec_version_str) ?
7623                         thinkpad_id.ec_version_str : "(unknown)");
7624         snprintf(card->longname, sizeof(card->longname),
7625                  "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
7626                  (thinkpad_id.ec_version_str) ?
7627                         thinkpad_id.ec_version_str : "unknown");
7628
7629         if (volume_control_allowed) {
7630                 volume_alsa_control_vol.put = volume_alsa_vol_put;
7631                 volume_alsa_control_vol.access =
7632                                 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7633
7634                 volume_alsa_control_mute.put = volume_alsa_mute_put;
7635                 volume_alsa_control_mute.access =
7636                                 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7637         }
7638
7639         if (!tp_features.mixer_no_level_control) {
7640                 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
7641                 rc = snd_ctl_add(card, ctl_vol);
7642                 if (rc < 0) {
7643                         pr_err("Failed to create ALSA volume control: %d\n",
7644                                rc);
7645                         goto err_exit;
7646                 }
7647                 data->ctl_vol_id = &ctl_vol->id;
7648         }
7649
7650         ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
7651         rc = snd_ctl_add(card, ctl_mute);
7652         if (rc < 0) {
7653                 pr_err("Failed to create ALSA mute control: %d\n", rc);
7654                 goto err_exit;
7655         }
7656         data->ctl_mute_id = &ctl_mute->id;
7657
7658         rc = snd_card_register(card);
7659         if (rc < 0) {
7660                 pr_err("Failed to register ALSA card: %d\n", rc);
7661                 goto err_exit;
7662         }
7663
7664         alsa_card = card;
7665         return 0;
7666
7667 err_exit:
7668         snd_card_free(card);
7669         return 1;
7670 }
7671
7672 #define TPACPI_VOL_Q_MUTEONLY   0x0001  /* Mute-only control available */
7673 #define TPACPI_VOL_Q_LEVEL      0x0002  /* Volume control available */
7674
7675 static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
7676         /* Whitelist volume level on all IBM by default */
7677         { .vendor = PCI_VENDOR_ID_IBM,
7678           .bios   = TPACPI_MATCH_ANY,
7679           .ec     = TPACPI_MATCH_ANY,
7680           .quirks = TPACPI_VOL_Q_LEVEL },
7681
7682         /* Lenovo models with volume control (needs confirmation) */
7683         TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
7684         TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
7685         TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
7686         TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
7687         TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
7688         TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
7689         TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
7690
7691         /* Whitelist mute-only on all Lenovo by default */
7692         { .vendor = PCI_VENDOR_ID_LENOVO,
7693           .bios   = TPACPI_MATCH_ANY,
7694           .ec     = TPACPI_MATCH_ANY,
7695           .quirks = TPACPI_VOL_Q_MUTEONLY }
7696 };
7697
7698 static int __init volume_init(struct ibm_init_struct *iibm)
7699 {
7700         unsigned long quirks;
7701         int rc;
7702
7703         vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7704
7705         mutex_init(&volume_mutex);
7706
7707         /*
7708          * Check for module parameter bogosity, note that we
7709          * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7710          * able to detect "unspecified"
7711          */
7712         if (volume_mode > TPACPI_VOL_MODE_MAX)
7713                 return -EINVAL;
7714
7715         if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7716                 pr_err("UCMS step volume mode not implemented, please contact %s\n",
7717                        TPACPI_MAIL);
7718                 return 1;
7719         }
7720
7721         if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7722                 return -EINVAL;
7723
7724         /*
7725          * The ALSA mixer is our primary interface.
7726          * When disabled, don't install the subdriver at all
7727          */
7728         if (!alsa_enable) {
7729                 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7730                             "ALSA mixer disabled by parameter, not loading volume subdriver...\n");
7731                 return 1;
7732         }
7733
7734         quirks = tpacpi_check_quirks(volume_quirk_table,
7735                                      ARRAY_SIZE(volume_quirk_table));
7736
7737         switch (volume_capabilities) {
7738         case TPACPI_VOL_CAP_AUTO:
7739                 if (quirks & TPACPI_VOL_Q_MUTEONLY)
7740                         tp_features.mixer_no_level_control = 1;
7741                 else if (quirks & TPACPI_VOL_Q_LEVEL)
7742                         tp_features.mixer_no_level_control = 0;
7743                 else
7744                         return 1; /* no mixer */
7745                 break;
7746         case TPACPI_VOL_CAP_VOLMUTE:
7747                 tp_features.mixer_no_level_control = 0;
7748                 break;
7749         case TPACPI_VOL_CAP_MUTEONLY:
7750                 tp_features.mixer_no_level_control = 1;
7751                 break;
7752         default:
7753                 return 1;
7754         }
7755
7756         if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7757                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7758                                 "using user-supplied volume_capabilities=%d\n",
7759                                 volume_capabilities);
7760
7761         if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7762             volume_mode == TPACPI_VOL_MODE_MAX) {
7763                 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7764
7765                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7766                                 "driver auto-selected volume_mode=%d\n",
7767                                 volume_mode);
7768         } else {
7769                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7770                                 "using user-supplied volume_mode=%d\n",
7771                                 volume_mode);
7772         }
7773
7774         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7775                         "mute is supported, volume control is %s\n",
7776                         str_supported(!tp_features.mixer_no_level_control));
7777
7778         if (software_mute_requested && volume_set_software_mute(true) == 0) {
7779                 software_mute_active = true;
7780         } else {
7781                 rc = volume_create_alsa_mixer();
7782                 if (rc) {
7783                         pr_err("Could not create the ALSA mixer interface\n");
7784                         return rc;
7785                 }
7786
7787                 pr_info("Console audio control enabled, mode: %s\n",
7788                         (volume_control_allowed) ?
7789                                 "override (read/write)" :
7790                                 "monitor (read only)");
7791         }
7792
7793         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7794                 "registering volume hotkeys as change notification\n");
7795         tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7796                         | TP_ACPI_HKEY_VOLUP_MASK
7797                         | TP_ACPI_HKEY_VOLDWN_MASK
7798                         | TP_ACPI_HKEY_MUTE_MASK);
7799
7800         return 0;
7801 }
7802
7803 static int volume_read(struct seq_file *m)
7804 {
7805         u8 status;
7806
7807         if (volume_get_status(&status) < 0) {
7808                 seq_printf(m, "level:\t\tunreadable\n");
7809         } else {
7810                 if (tp_features.mixer_no_level_control)
7811                         seq_printf(m, "level:\t\tunsupported\n");
7812                 else
7813                         seq_printf(m, "level:\t\t%d\n",
7814                                         status & TP_EC_AUDIO_LVL_MSK);
7815
7816                 seq_printf(m, "mute:\t\t%s\n",
7817                                 onoff(status, TP_EC_AUDIO_MUTESW));
7818
7819                 if (volume_control_allowed) {
7820                         seq_printf(m, "commands:\tunmute, mute\n");
7821                         if (!tp_features.mixer_no_level_control) {
7822                                 seq_printf(m, "commands:\tup, down\n");
7823                                 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7824                                               TP_EC_VOLUME_MAX);
7825                         }
7826                 }
7827         }
7828
7829         return 0;
7830 }
7831
7832 static int volume_write(char *buf)
7833 {
7834         u8 s;
7835         u8 new_level, new_mute;
7836         int l;
7837         char *cmd;
7838         int rc;
7839
7840         /*
7841          * We do allow volume control at driver startup, so that the
7842          * user can set initial state through the volume=... parameter hack.
7843          */
7844         if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7845                 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7846                         tp_warned.volume_ctrl_forbidden = 1;
7847                         pr_notice("Console audio control in monitor mode, changes are not allowed\n");
7848                         pr_notice("Use the volume_control=1 module parameter to enable volume control\n");
7849                 }
7850                 return -EPERM;
7851         }
7852
7853         rc = volume_get_status(&s);
7854         if (rc < 0)
7855                 return rc;
7856
7857         new_level = s & TP_EC_AUDIO_LVL_MSK;
7858         new_mute  = s & TP_EC_AUDIO_MUTESW_MSK;
7859
7860         while ((cmd = strsep(&buf, ","))) {
7861                 if (!tp_features.mixer_no_level_control) {
7862                         if (strlencmp(cmd, "up") == 0) {
7863                                 if (new_mute)
7864                                         new_mute = 0;
7865                                 else if (new_level < TP_EC_VOLUME_MAX)
7866                                         new_level++;
7867                                 continue;
7868                         } else if (strlencmp(cmd, "down") == 0) {
7869                                 if (new_mute)
7870                                         new_mute = 0;
7871                                 else if (new_level > 0)
7872                                         new_level--;
7873                                 continue;
7874                         } else if (sscanf(cmd, "level %u", &l) == 1 &&
7875                                    l >= 0 && l <= TP_EC_VOLUME_MAX) {
7876                                         new_level = l;
7877                                 continue;
7878                         }
7879                 }
7880                 if (strlencmp(cmd, "mute") == 0)
7881                         new_mute = TP_EC_AUDIO_MUTESW_MSK;
7882                 else if (strlencmp(cmd, "unmute") == 0)
7883                         new_mute = 0;
7884                 else
7885                         return -EINVAL;
7886         }
7887
7888         if (tp_features.mixer_no_level_control) {
7889                 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7890                                         new_mute ? "" : "un");
7891                 rc = volume_set_mute(!!new_mute);
7892         } else {
7893                 tpacpi_disclose_usertask("procfs volume",
7894                                         "%smute and set level to %d\n",
7895                                         new_mute ? "" : "un", new_level);
7896                 rc = volume_set_status(new_mute | new_level);
7897         }
7898         volume_alsa_notify_change();
7899
7900         return (rc == -EINTR) ? -ERESTARTSYS : rc;
7901 }
7902
7903 static struct ibm_struct volume_driver_data = {
7904         .name = "volume",
7905         .read = volume_read,
7906         .write = volume_write,
7907         .exit = volume_exit,
7908         .suspend = volume_suspend,
7909         .resume = volume_resume,
7910         .shutdown = volume_shutdown,
7911 };
7912
7913 #else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7914
7915 #define alsa_card NULL
7916
7917 static inline void volume_alsa_notify_change(void)
7918 {
7919 }
7920
7921 static int __init volume_init(struct ibm_init_struct *iibm)
7922 {
7923         pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7924
7925         return 1;
7926 }
7927
7928 static struct ibm_struct volume_driver_data = {
7929         .name = "volume",
7930 };
7931
7932 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7933
7934 /*************************************************************************
7935  * Fan subdriver
7936  */
7937
7938 /*
7939  * FAN ACCESS MODES
7940  *
7941  * TPACPI_FAN_RD_ACPI_GFAN:
7942  *      ACPI GFAN method: returns fan level
7943  *
7944  *      see TPACPI_FAN_WR_ACPI_SFAN
7945  *      EC 0x2f (HFSP) not available if GFAN exists
7946  *
7947  * TPACPI_FAN_WR_ACPI_SFAN:
7948  *      ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7949  *
7950  *      EC 0x2f (HFSP) might be available *for reading*, but do not use
7951  *      it for writing.
7952  *
7953  * TPACPI_FAN_WR_TPEC:
7954  *      ThinkPad EC register 0x2f (HFSP): fan control loop mode
7955  *      Supported on almost all ThinkPads
7956  *
7957  *      Fan speed changes of any sort (including those caused by the
7958  *      disengaged mode) are usually done slowly by the firmware as the
7959  *      maximum amount of fan duty cycle change per second seems to be
7960  *      limited.
7961  *
7962  *      Reading is not available if GFAN exists.
7963  *      Writing is not available if SFAN exists.
7964  *
7965  *      Bits
7966  *       7      automatic mode engaged;
7967  *              (default operation mode of the ThinkPad)
7968  *              fan level is ignored in this mode.
7969  *       6      full speed mode (takes precedence over bit 7);
7970  *              not available on all thinkpads.  May disable
7971  *              the tachometer while the fan controller ramps up
7972  *              the speed (which can take up to a few *minutes*).
7973  *              Speeds up fan to 100% duty-cycle, which is far above
7974  *              the standard RPM levels.  It is not impossible that
7975  *              it could cause hardware damage.
7976  *      5-3     unused in some models.  Extra bits for fan level
7977  *              in others, but still useless as all values above
7978  *              7 map to the same speed as level 7 in these models.
7979  *      2-0     fan level (0..7 usually)
7980  *                      0x00 = stop
7981  *                      0x07 = max (set when temperatures critical)
7982  *              Some ThinkPads may have other levels, see
7983  *              TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7984  *
7985  *      FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7986  *      boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7987  *      does so, its initial value is meaningless (0x07).
7988  *
7989  *      For firmware bugs, refer to:
7990  *      https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7991  *
7992  *      ----
7993  *
7994  *      ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7995  *      Main fan tachometer reading (in RPM)
7996  *
7997  *      This register is present on all ThinkPads with a new-style EC, and
7998  *      it is known not to be present on the A21m/e, and T22, as there is
7999  *      something else in offset 0x84 according to the ACPI DSDT.  Other
8000  *      ThinkPads from this same time period (and earlier) probably lack the
8001  *      tachometer as well.
8002  *
8003  *      Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
8004  *      was never fixed by IBM to report the EC firmware version string
8005  *      probably support the tachometer (like the early X models), so
8006  *      detecting it is quite hard.  We need more data to know for sure.
8007  *
8008  *      FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
8009  *      might result.
8010  *
8011  *      FIRMWARE BUG: may go stale while the EC is switching to full speed
8012  *      mode.
8013  *
8014  *      For firmware bugs, refer to:
8015  *      https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
8016  *
8017  *      ----
8018  *
8019  *      ThinkPad EC register 0x31 bit 0 (only on select models)
8020  *
8021  *      When bit 0 of EC register 0x31 is zero, the tachometer registers
8022  *      show the speed of the main fan.  When bit 0 of EC register 0x31
8023  *      is one, the tachometer registers show the speed of the auxiliary
8024  *      fan.
8025  *
8026  *      Fan control seems to affect both fans, regardless of the state
8027  *      of this bit.
8028  *
8029  *      So far, only the firmware for the X60/X61 non-tablet versions
8030  *      seem to support this (firmware TP-7M).
8031  *
8032  * TPACPI_FAN_WR_ACPI_FANS:
8033  *      ThinkPad X31, X40, X41.  Not available in the X60.
8034  *
8035  *      FANS ACPI handle: takes three arguments: low speed, medium speed,
8036  *      high speed.  ACPI DSDT seems to map these three speeds to levels
8037  *      as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
8038  *      (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
8039  *
8040  *      The speeds are stored on handles
8041  *      (FANA:FAN9), (FANC:FANB), (FANE:FAND).
8042  *
8043  *      There are three default speed sets, accessible as handles:
8044  *      FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
8045  *
8046  *      ACPI DSDT switches which set is in use depending on various
8047  *      factors.
8048  *
8049  *      TPACPI_FAN_WR_TPEC is also available and should be used to
8050  *      command the fan.  The X31/X40/X41 seems to have 8 fan levels,
8051  *      but the ACPI tables just mention level 7.
8052  */
8053
8054 enum {                                  /* Fan control constants */
8055         fan_status_offset = 0x2f,       /* EC register 0x2f */
8056         fan_rpm_offset = 0x84,          /* EC register 0x84: LSB, 0x85 MSB (RPM)
8057                                          * 0x84 must be read before 0x85 */
8058         fan_select_offset = 0x31,       /* EC register 0x31 (Firmware 7M)
8059                                            bit 0 selects which fan is active */
8060
8061         TP_EC_FAN_FULLSPEED = 0x40,     /* EC fan mode: full speed */
8062         TP_EC_FAN_AUTO      = 0x80,     /* EC fan mode: auto fan control */
8063
8064         TPACPI_FAN_LAST_LEVEL = 0x100,  /* Use cached last-seen fan level */
8065 };
8066
8067 enum fan_status_access_mode {
8068         TPACPI_FAN_NONE = 0,            /* No fan status or control */
8069         TPACPI_FAN_RD_ACPI_GFAN,        /* Use ACPI GFAN */
8070         TPACPI_FAN_RD_TPEC,             /* Use ACPI EC regs 0x2f, 0x84-0x85 */
8071 };
8072
8073 enum fan_control_access_mode {
8074         TPACPI_FAN_WR_NONE = 0,         /* No fan control */
8075         TPACPI_FAN_WR_ACPI_SFAN,        /* Use ACPI SFAN */
8076         TPACPI_FAN_WR_TPEC,             /* Use ACPI EC reg 0x2f */
8077         TPACPI_FAN_WR_ACPI_FANS,        /* Use ACPI FANS and EC reg 0x2f */
8078 };
8079
8080 enum fan_control_commands {
8081         TPACPI_FAN_CMD_SPEED    = 0x0001,       /* speed command */
8082         TPACPI_FAN_CMD_LEVEL    = 0x0002,       /* level command  */
8083         TPACPI_FAN_CMD_ENABLE   = 0x0004,       /* enable/disable cmd,
8084                                                  * and also watchdog cmd */
8085 };
8086
8087 static bool fan_control_allowed;
8088
8089 static enum fan_status_access_mode fan_status_access_mode;
8090 static enum fan_control_access_mode fan_control_access_mode;
8091 static enum fan_control_commands fan_control_commands;
8092
8093 static u8 fan_control_initial_status;
8094 static u8 fan_control_desired_level;
8095 static u8 fan_control_resume_level;
8096 static int fan_watchdog_maxinterval;
8097
8098 static struct mutex fan_mutex;
8099
8100 static void fan_watchdog_fire(struct work_struct *ignored);
8101 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
8102
8103 TPACPI_HANDLE(fans, ec, "FANS");        /* X31, X40, X41 */
8104 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
8105            "\\FSPD",            /* 600e/x, 770e, 770x */
8106            );                   /* all others */
8107 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
8108            "JFNS",              /* 770x-JL */
8109            );                   /* all others */
8110
8111 /*
8112  * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
8113  * HFSP register at boot, so it contains 0x07 but the Thinkpad could
8114  * be in auto mode (0x80).
8115  *
8116  * This is corrected by any write to HFSP either by the driver, or
8117  * by the firmware.
8118  *
8119  * We assume 0x07 really means auto mode while this quirk is active,
8120  * as this is far more likely than the ThinkPad being in level 7,
8121  * which is only used by the firmware during thermal emergencies.
8122  *
8123  * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
8124  * TP-70 (T43, R52), which are known to be buggy.
8125  */
8126
8127 static void fan_quirk1_setup(void)
8128 {
8129         if (fan_control_initial_status == 0x07) {
8130                 pr_notice("fan_init: initial fan status is unknown, assuming it is in auto mode\n");
8131                 tp_features.fan_ctrl_status_undef = 1;
8132         }
8133 }
8134
8135 static void fan_quirk1_handle(u8 *fan_status)
8136 {
8137         if (unlikely(tp_features.fan_ctrl_status_undef)) {
8138                 if (*fan_status != fan_control_initial_status) {
8139                         /* something changed the HFSP regisnter since
8140                          * driver init time, so it is not undefined
8141                          * anymore */
8142                         tp_features.fan_ctrl_status_undef = 0;
8143                 } else {
8144                         /* Return most likely status. In fact, it
8145                          * might be the only possible status */
8146                         *fan_status = TP_EC_FAN_AUTO;
8147                 }
8148         }
8149 }
8150
8151 /* Select main fan on X60/X61, NOOP on others */
8152 static bool fan_select_fan1(void)
8153 {
8154         if (tp_features.second_fan) {
8155                 u8 val;
8156
8157                 if (ec_read(fan_select_offset, &val) < 0)
8158                         return false;
8159                 val &= 0xFEU;
8160                 if (ec_write(fan_select_offset, val) < 0)
8161                         return false;
8162         }
8163         return true;
8164 }
8165
8166 /* Select secondary fan on X60/X61 */
8167 static bool fan_select_fan2(void)
8168 {
8169         u8 val;
8170
8171         if (!tp_features.second_fan)
8172                 return false;
8173
8174         if (ec_read(fan_select_offset, &val) < 0)
8175                 return false;
8176         val |= 0x01U;
8177         if (ec_write(fan_select_offset, val) < 0)
8178                 return false;
8179
8180         return true;
8181 }
8182
8183 /*
8184  * Call with fan_mutex held
8185  */
8186 static void fan_update_desired_level(u8 status)
8187 {
8188         if ((status &
8189              (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8190                 if (status > 7)
8191                         fan_control_desired_level = 7;
8192                 else
8193                         fan_control_desired_level = status;
8194         }
8195 }
8196
8197 static int fan_get_status(u8 *status)
8198 {
8199         u8 s;
8200
8201         /* TODO:
8202          * Add TPACPI_FAN_RD_ACPI_FANS ? */
8203
8204         switch (fan_status_access_mode) {
8205         case TPACPI_FAN_RD_ACPI_GFAN: {
8206                 /* 570, 600e/x, 770e, 770x */
8207                 int res;
8208
8209                 if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
8210                         return -EIO;
8211
8212                 if (likely(status))
8213                         *status = res & 0x07;
8214
8215                 break;
8216         }
8217         case TPACPI_FAN_RD_TPEC:
8218                 /* all except 570, 600e/x, 770e, 770x */
8219                 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
8220                         return -EIO;
8221
8222                 if (likely(status)) {
8223                         *status = s;
8224                         fan_quirk1_handle(status);
8225                 }
8226
8227                 break;
8228
8229         default:
8230                 return -ENXIO;
8231         }
8232
8233         return 0;
8234 }
8235
8236 static int fan_get_status_safe(u8 *status)
8237 {
8238         int rc;
8239         u8 s;
8240
8241         if (mutex_lock_killable(&fan_mutex))
8242                 return -ERESTARTSYS;
8243         rc = fan_get_status(&s);
8244         if (!rc)
8245                 fan_update_desired_level(s);
8246         mutex_unlock(&fan_mutex);
8247
8248         if (rc)
8249                 return rc;
8250         if (status)
8251                 *status = s;
8252
8253         return 0;
8254 }
8255
8256 static int fan_get_speed(unsigned int *speed)
8257 {
8258         u8 hi, lo;
8259
8260         switch (fan_status_access_mode) {
8261         case TPACPI_FAN_RD_TPEC:
8262                 /* all except 570, 600e/x, 770e, 770x */
8263                 if (unlikely(!fan_select_fan1()))
8264                         return -EIO;
8265                 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
8266                              !acpi_ec_read(fan_rpm_offset + 1, &hi)))
8267                         return -EIO;
8268
8269                 if (likely(speed))
8270                         *speed = (hi << 8) | lo;
8271
8272                 break;
8273
8274         default:
8275                 return -ENXIO;
8276         }
8277
8278         return 0;
8279 }
8280
8281 static int fan2_get_speed(unsigned int *speed)
8282 {
8283         u8 hi, lo;
8284         bool rc;
8285
8286         switch (fan_status_access_mode) {
8287         case TPACPI_FAN_RD_TPEC:
8288                 /* all except 570, 600e/x, 770e, 770x */
8289                 if (unlikely(!fan_select_fan2()))
8290                         return -EIO;
8291                 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
8292                              !acpi_ec_read(fan_rpm_offset + 1, &hi);
8293                 fan_select_fan1(); /* play it safe */
8294                 if (rc)
8295                         return -EIO;
8296
8297                 if (likely(speed))
8298                         *speed = (hi << 8) | lo;
8299
8300                 break;
8301
8302         default:
8303                 return -ENXIO;
8304         }
8305
8306         return 0;
8307 }
8308
8309 static int fan_set_level(int level)
8310 {
8311         if (!fan_control_allowed)
8312                 return -EPERM;
8313
8314         switch (fan_control_access_mode) {
8315         case TPACPI_FAN_WR_ACPI_SFAN:
8316                 if ((level < 0) || (level > 7))
8317                         return -EINVAL;
8318
8319                 if (tp_features.second_fan_ctl) {
8320                         if (!fan_select_fan2() ||
8321                             !acpi_evalf(sfan_handle, NULL, NULL, "vd", level)) {
8322                                 pr_warn("Couldn't set 2nd fan level, disabling support\n");
8323                                 tp_features.second_fan_ctl = 0;
8324                         }
8325                         fan_select_fan1();
8326                 }
8327                 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
8328                         return -EIO;
8329                 break;
8330
8331         case TPACPI_FAN_WR_ACPI_FANS:
8332         case TPACPI_FAN_WR_TPEC:
8333                 if (!(level & TP_EC_FAN_AUTO) &&
8334                     !(level & TP_EC_FAN_FULLSPEED) &&
8335                     ((level < 0) || (level > 7)))
8336                         return -EINVAL;
8337
8338                 /* safety net should the EC not support AUTO
8339                  * or FULLSPEED mode bits and just ignore them */
8340                 if (level & TP_EC_FAN_FULLSPEED)
8341                         level |= 7;     /* safety min speed 7 */
8342                 else if (level & TP_EC_FAN_AUTO)
8343                         level |= 4;     /* safety min speed 4 */
8344
8345                 if (tp_features.second_fan_ctl) {
8346                         if (!fan_select_fan2() ||
8347                             !acpi_ec_write(fan_status_offset, level)) {
8348                                 pr_warn("Couldn't set 2nd fan level, disabling support\n");
8349                                 tp_features.second_fan_ctl = 0;
8350                         }
8351                         fan_select_fan1();
8352
8353                 }
8354                 if (!acpi_ec_write(fan_status_offset, level))
8355                         return -EIO;
8356                 else
8357                         tp_features.fan_ctrl_status_undef = 0;
8358                 break;
8359
8360         default:
8361                 return -ENXIO;
8362         }
8363
8364         vdbg_printk(TPACPI_DBG_FAN,
8365                 "fan control: set fan control register to 0x%02x\n", level);
8366         return 0;
8367 }
8368
8369 static int fan_set_level_safe(int level)
8370 {
8371         int rc;
8372
8373         if (!fan_control_allowed)
8374                 return -EPERM;
8375
8376         if (mutex_lock_killable(&fan_mutex))
8377                 return -ERESTARTSYS;
8378
8379         if (level == TPACPI_FAN_LAST_LEVEL)
8380                 level = fan_control_desired_level;
8381
8382         rc = fan_set_level(level);
8383         if (!rc)
8384                 fan_update_desired_level(level);
8385
8386         mutex_unlock(&fan_mutex);
8387         return rc;
8388 }
8389
8390 static int fan_set_enable(void)
8391 {
8392         u8 s;
8393         int rc;
8394
8395         if (!fan_control_allowed)
8396                 return -EPERM;
8397
8398         if (mutex_lock_killable(&fan_mutex))
8399                 return -ERESTARTSYS;
8400
8401         switch (fan_control_access_mode) {
8402         case TPACPI_FAN_WR_ACPI_FANS:
8403         case TPACPI_FAN_WR_TPEC:
8404                 rc = fan_get_status(&s);
8405                 if (rc < 0)
8406                         break;
8407
8408                 /* Don't go out of emergency fan mode */
8409                 if (s != 7) {
8410                         s &= 0x07;
8411                         s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
8412                 }
8413
8414                 if (!acpi_ec_write(fan_status_offset, s))
8415                         rc = -EIO;
8416                 else {
8417                         tp_features.fan_ctrl_status_undef = 0;
8418                         rc = 0;
8419                 }
8420                 break;
8421
8422         case TPACPI_FAN_WR_ACPI_SFAN:
8423                 rc = fan_get_status(&s);
8424                 if (rc < 0)
8425                         break;
8426
8427                 s &= 0x07;
8428
8429                 /* Set fan to at least level 4 */
8430                 s |= 4;
8431
8432                 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
8433                         rc = -EIO;
8434                 else
8435                         rc = 0;
8436                 break;
8437
8438         default:
8439                 rc = -ENXIO;
8440         }
8441
8442         mutex_unlock(&fan_mutex);
8443
8444         if (!rc)
8445                 vdbg_printk(TPACPI_DBG_FAN,
8446                         "fan control: set fan control register to 0x%02x\n",
8447                         s);
8448         return rc;
8449 }
8450
8451 static int fan_set_disable(void)
8452 {
8453         int rc;
8454
8455         if (!fan_control_allowed)
8456                 return -EPERM;
8457
8458         if (mutex_lock_killable(&fan_mutex))
8459                 return -ERESTARTSYS;
8460
8461         rc = 0;
8462         switch (fan_control_access_mode) {
8463         case TPACPI_FAN_WR_ACPI_FANS:
8464         case TPACPI_FAN_WR_TPEC:
8465                 if (!acpi_ec_write(fan_status_offset, 0x00))
8466                         rc = -EIO;
8467                 else {
8468                         fan_control_desired_level = 0;
8469                         tp_features.fan_ctrl_status_undef = 0;
8470                 }
8471                 break;
8472
8473         case TPACPI_FAN_WR_ACPI_SFAN:
8474                 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
8475                         rc = -EIO;
8476                 else
8477                         fan_control_desired_level = 0;
8478                 break;
8479
8480         default:
8481                 rc = -ENXIO;
8482         }
8483
8484         if (!rc)
8485                 vdbg_printk(TPACPI_DBG_FAN,
8486                         "fan control: set fan control register to 0\n");
8487
8488         mutex_unlock(&fan_mutex);
8489         return rc;
8490 }
8491
8492 static int fan_set_speed(int speed)
8493 {
8494         int rc;
8495
8496         if (!fan_control_allowed)
8497                 return -EPERM;
8498
8499         if (mutex_lock_killable(&fan_mutex))
8500                 return -ERESTARTSYS;
8501
8502         rc = 0;
8503         switch (fan_control_access_mode) {
8504         case TPACPI_FAN_WR_ACPI_FANS:
8505                 if (speed >= 0 && speed <= 65535) {
8506                         if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
8507                                         speed, speed, speed))
8508                                 rc = -EIO;
8509                 } else
8510                         rc = -EINVAL;
8511                 break;
8512
8513         default:
8514                 rc = -ENXIO;
8515         }
8516
8517         mutex_unlock(&fan_mutex);
8518         return rc;
8519 }
8520
8521 static void fan_watchdog_reset(void)
8522 {
8523         if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
8524                 return;
8525
8526         if (fan_watchdog_maxinterval > 0 &&
8527             tpacpi_lifecycle != TPACPI_LIFE_EXITING)
8528                 mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
8529                         msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
8530         else
8531                 cancel_delayed_work(&fan_watchdog_task);
8532 }
8533
8534 static void fan_watchdog_fire(struct work_struct *ignored)
8535 {
8536         int rc;
8537
8538         if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
8539                 return;
8540
8541         pr_notice("fan watchdog: enabling fan\n");
8542         rc = fan_set_enable();
8543         if (rc < 0) {
8544                 pr_err("fan watchdog: error %d while enabling fan, will try again later...\n",
8545                        rc);
8546                 /* reschedule for later */
8547                 fan_watchdog_reset();
8548         }
8549 }
8550
8551 /*
8552  * SYSFS fan layout: hwmon compatible (device)
8553  *
8554  * pwm*_enable:
8555  *      0: "disengaged" mode
8556  *      1: manual mode
8557  *      2: native EC "auto" mode (recommended, hardware default)
8558  *
8559  * pwm*: set speed in manual mode, ignored otherwise.
8560  *      0 is level 0; 255 is level 7. Intermediate points done with linear
8561  *      interpolation.
8562  *
8563  * fan*_input: tachometer reading, RPM
8564  *
8565  *
8566  * SYSFS fan layout: extensions
8567  *
8568  * fan_watchdog (driver):
8569  *      fan watchdog interval in seconds, 0 disables (default), max 120
8570  */
8571
8572 /* sysfs fan pwm1_enable ----------------------------------------------- */
8573 static ssize_t fan_pwm1_enable_show(struct device *dev,
8574                                     struct device_attribute *attr,
8575                                     char *buf)
8576 {
8577         int res, mode;
8578         u8 status;
8579
8580         res = fan_get_status_safe(&status);
8581         if (res)
8582                 return res;
8583
8584         if (status & TP_EC_FAN_FULLSPEED) {
8585                 mode = 0;
8586         } else if (status & TP_EC_FAN_AUTO) {
8587                 mode = 2;
8588         } else
8589                 mode = 1;
8590
8591         return snprintf(buf, PAGE_SIZE, "%d\n", mode);
8592 }
8593
8594 static ssize_t fan_pwm1_enable_store(struct device *dev,
8595                                      struct device_attribute *attr,
8596                                      const char *buf, size_t count)
8597 {
8598         unsigned long t;
8599         int res, level;
8600
8601         if (parse_strtoul(buf, 2, &t))
8602                 return -EINVAL;
8603
8604         tpacpi_disclose_usertask("hwmon pwm1_enable",
8605                         "set fan mode to %lu\n", t);
8606
8607         switch (t) {
8608         case 0:
8609                 level = TP_EC_FAN_FULLSPEED;
8610                 break;
8611         case 1:
8612                 level = TPACPI_FAN_LAST_LEVEL;
8613                 break;
8614         case 2:
8615                 level = TP_EC_FAN_AUTO;
8616                 break;
8617         case 3:
8618                 /* reserved for software-controlled auto mode */
8619                 return -ENOSYS;
8620         default:
8621                 return -EINVAL;
8622         }
8623
8624         res = fan_set_level_safe(level);
8625         if (res == -ENXIO)
8626                 return -EINVAL;
8627         else if (res < 0)
8628                 return res;
8629
8630         fan_watchdog_reset();
8631
8632         return count;
8633 }
8634
8635 static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
8636                    fan_pwm1_enable_show, fan_pwm1_enable_store);
8637
8638 /* sysfs fan pwm1 ------------------------------------------------------ */
8639 static ssize_t fan_pwm1_show(struct device *dev,
8640                              struct device_attribute *attr,
8641                              char *buf)
8642 {
8643         int res;
8644         u8 status;
8645
8646         res = fan_get_status_safe(&status);
8647         if (res)
8648                 return res;
8649
8650         if ((status &
8651              (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
8652                 status = fan_control_desired_level;
8653
8654         if (status > 7)
8655                 status = 7;
8656
8657         return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
8658 }
8659
8660 static ssize_t fan_pwm1_store(struct device *dev,
8661                               struct device_attribute *attr,
8662                               const char *buf, size_t count)
8663 {
8664         unsigned long s;
8665         int rc;
8666         u8 status, newlevel;
8667
8668         if (parse_strtoul(buf, 255, &s))
8669                 return -EINVAL;
8670
8671         tpacpi_disclose_usertask("hwmon pwm1",
8672                         "set fan speed to %lu\n", s);
8673
8674         /* scale down from 0-255 to 0-7 */
8675         newlevel = (s >> 5) & 0x07;
8676
8677         if (mutex_lock_killable(&fan_mutex))
8678                 return -ERESTARTSYS;
8679
8680         rc = fan_get_status(&status);
8681         if (!rc && (status &
8682                     (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8683                 rc = fan_set_level(newlevel);
8684                 if (rc == -ENXIO)
8685                         rc = -EINVAL;
8686                 else if (!rc) {
8687                         fan_update_desired_level(newlevel);
8688                         fan_watchdog_reset();
8689                 }
8690         }
8691
8692         mutex_unlock(&fan_mutex);
8693         return (rc) ? rc : count;
8694 }
8695
8696 static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, fan_pwm1_show, fan_pwm1_store);
8697
8698 /* sysfs fan fan1_input ------------------------------------------------ */
8699 static ssize_t fan_fan1_input_show(struct device *dev,
8700                            struct device_attribute *attr,
8701                            char *buf)
8702 {
8703         int res;
8704         unsigned int speed;
8705
8706         res = fan_get_speed(&speed);
8707         if (res < 0)
8708                 return res;
8709
8710         return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8711 }
8712
8713 static DEVICE_ATTR(fan1_input, S_IRUGO, fan_fan1_input_show, NULL);
8714
8715 /* sysfs fan fan2_input ------------------------------------------------ */
8716 static ssize_t fan_fan2_input_show(struct device *dev,
8717                            struct device_attribute *attr,
8718                            char *buf)
8719 {
8720         int res;
8721         unsigned int speed;
8722
8723         res = fan2_get_speed(&speed);
8724         if (res < 0)
8725                 return res;
8726
8727         return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8728 }
8729
8730 static DEVICE_ATTR(fan2_input, S_IRUGO, fan_fan2_input_show, NULL);
8731
8732 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8733 static ssize_t fan_watchdog_show(struct device_driver *drv, char *buf)
8734 {
8735         return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
8736 }
8737
8738 static ssize_t fan_watchdog_store(struct device_driver *drv, const char *buf,
8739                                   size_t count)
8740 {
8741         unsigned long t;
8742
8743         if (parse_strtoul(buf, 120, &t))
8744                 return -EINVAL;
8745
8746         if (!fan_control_allowed)
8747                 return -EPERM;
8748
8749         fan_watchdog_maxinterval = t;
8750         fan_watchdog_reset();
8751
8752         tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8753
8754         return count;
8755 }
8756 static DRIVER_ATTR_RW(fan_watchdog);
8757
8758 /* --------------------------------------------------------------------- */
8759 static struct attribute *fan_attributes[] = {
8760         &dev_attr_pwm1_enable.attr, &dev_attr_pwm1.attr,
8761         &dev_attr_fan1_input.attr,
8762         NULL, /* for fan2_input */
8763         NULL
8764 };
8765
8766 static const struct attribute_group fan_attr_group = {
8767         .attrs = fan_attributes,
8768 };
8769
8770 #define TPACPI_FAN_Q1   0x0001          /* Unitialized HFSP */
8771 #define TPACPI_FAN_2FAN 0x0002          /* EC 0x31 bit 0 selects fan2 */
8772 #define TPACPI_FAN_2CTL 0x0004          /* selects fan2 control */
8773
8774 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8775         TPACPI_QEC_IBM('1', 'Y', TPACPI_FAN_Q1),
8776         TPACPI_QEC_IBM('7', '8', TPACPI_FAN_Q1),
8777         TPACPI_QEC_IBM('7', '6', TPACPI_FAN_Q1),
8778         TPACPI_QEC_IBM('7', '0', TPACPI_FAN_Q1),
8779         TPACPI_QEC_LNV('7', 'M', TPACPI_FAN_2FAN),
8780         TPACPI_Q_LNV('N', '1', TPACPI_FAN_2FAN),
8781         TPACPI_Q_LNV3('N', '1', 'D', TPACPI_FAN_2CTL),  /* P70 */
8782         TPACPI_Q_LNV3('N', '1', 'E', TPACPI_FAN_2CTL),  /* P50 */
8783         TPACPI_Q_LNV3('N', '1', 'T', TPACPI_FAN_2CTL),  /* P71 */
8784         TPACPI_Q_LNV3('N', '1', 'U', TPACPI_FAN_2CTL),  /* P51 */
8785         TPACPI_Q_LNV3('N', '2', 'C', TPACPI_FAN_2CTL),  /* P52 / P72 */
8786         TPACPI_Q_LNV3('N', '2', 'E', TPACPI_FAN_2CTL),  /* P1 / X1 Extreme (1st gen) */
8787         TPACPI_Q_LNV3('N', '2', 'O', TPACPI_FAN_2CTL),  /* P1 / X1 Extreme (2nd gen) */
8788         TPACPI_Q_LNV3('N', '2', 'V', TPACPI_FAN_2CTL),  /* P1 / X1 Extreme (3nd gen) */
8789         TPACPI_Q_LNV3('N', '3', '0', TPACPI_FAN_2CTL),  /* P15 (1st gen) / P15v (1st gen) */
8790 };
8791
8792 static int __init fan_init(struct ibm_init_struct *iibm)
8793 {
8794         int rc;
8795         unsigned long quirks;
8796
8797         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8798                         "initializing fan subdriver\n");
8799
8800         mutex_init(&fan_mutex);
8801         fan_status_access_mode = TPACPI_FAN_NONE;
8802         fan_control_access_mode = TPACPI_FAN_WR_NONE;
8803         fan_control_commands = 0;
8804         fan_watchdog_maxinterval = 0;
8805         tp_features.fan_ctrl_status_undef = 0;
8806         tp_features.second_fan = 0;
8807         tp_features.second_fan_ctl = 0;
8808         fan_control_desired_level = 7;
8809
8810         if (tpacpi_is_ibm()) {
8811                 TPACPI_ACPIHANDLE_INIT(fans);
8812                 TPACPI_ACPIHANDLE_INIT(gfan);
8813                 TPACPI_ACPIHANDLE_INIT(sfan);
8814         }
8815
8816         quirks = tpacpi_check_quirks(fan_quirk_table,
8817                                      ARRAY_SIZE(fan_quirk_table));
8818
8819         if (gfan_handle) {
8820                 /* 570, 600e/x, 770e, 770x */
8821                 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8822         } else {
8823                 /* all other ThinkPads: note that even old-style
8824                  * ThinkPad ECs supports the fan control register */
8825                 if (likely(acpi_ec_read(fan_status_offset,
8826                                         &fan_control_initial_status))) {
8827                         fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8828                         if (quirks & TPACPI_FAN_Q1)
8829                                 fan_quirk1_setup();
8830                         if (quirks & TPACPI_FAN_2FAN) {
8831                                 tp_features.second_fan = 1;
8832                                 pr_info("secondary fan support enabled\n");
8833                         }
8834                         if (quirks & TPACPI_FAN_2CTL) {
8835                                 tp_features.second_fan = 1;
8836                                 tp_features.second_fan_ctl = 1;
8837                                 pr_info("secondary fan control enabled\n");
8838                         }
8839                 } else {
8840                         pr_err("ThinkPad ACPI EC access misbehaving, fan status and control unavailable\n");
8841                         return 1;
8842                 }
8843         }
8844
8845         if (sfan_handle) {
8846                 /* 570, 770x-JL */
8847                 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8848                 fan_control_commands |=
8849                     TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8850         } else {
8851                 if (!gfan_handle) {
8852                         /* gfan without sfan means no fan control */
8853                         /* all other models implement TP EC 0x2f control */
8854
8855                         if (fans_handle) {
8856                                 /* X31, X40, X41 */
8857                                 fan_control_access_mode =
8858                                     TPACPI_FAN_WR_ACPI_FANS;
8859                                 fan_control_commands |=
8860                                     TPACPI_FAN_CMD_SPEED |
8861                                     TPACPI_FAN_CMD_LEVEL |
8862                                     TPACPI_FAN_CMD_ENABLE;
8863                         } else {
8864                                 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8865                                 fan_control_commands |=
8866                                     TPACPI_FAN_CMD_LEVEL |
8867                                     TPACPI_FAN_CMD_ENABLE;
8868                         }
8869                 }
8870         }
8871
8872         vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8873                 "fan is %s, modes %d, %d\n",
8874                 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8875                   fan_control_access_mode != TPACPI_FAN_WR_NONE),
8876                 fan_status_access_mode, fan_control_access_mode);
8877
8878         /* fan control master switch */
8879         if (!fan_control_allowed) {
8880                 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8881                 fan_control_commands = 0;
8882                 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8883                            "fan control features disabled by parameter\n");
8884         }
8885
8886         /* update fan_control_desired_level */
8887         if (fan_status_access_mode != TPACPI_FAN_NONE)
8888                 fan_get_status_safe(NULL);
8889
8890         if (fan_status_access_mode != TPACPI_FAN_NONE ||
8891             fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8892                 if (tp_features.second_fan) {
8893                         /* attach second fan tachometer */
8894                         fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8895                                         &dev_attr_fan2_input.attr;
8896                 }
8897                 rc = sysfs_create_group(&tpacpi_hwmon->kobj,
8898                                          &fan_attr_group);
8899                 if (rc < 0)
8900                         return rc;
8901
8902                 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8903                                         &driver_attr_fan_watchdog);
8904                 if (rc < 0) {
8905                         sysfs_remove_group(&tpacpi_hwmon->kobj,
8906                                         &fan_attr_group);
8907                         return rc;
8908                 }
8909                 return 0;
8910         } else
8911                 return 1;
8912 }
8913
8914 static void fan_exit(void)
8915 {
8916         vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8917                     "cancelling any pending fan watchdog tasks\n");
8918
8919         /* FIXME: can we really do this unconditionally? */
8920         sysfs_remove_group(&tpacpi_hwmon->kobj, &fan_attr_group);
8921         driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8922                            &driver_attr_fan_watchdog);
8923
8924         cancel_delayed_work(&fan_watchdog_task);
8925         flush_workqueue(tpacpi_wq);
8926 }
8927
8928 static void fan_suspend(void)
8929 {
8930         int rc;
8931
8932         if (!fan_control_allowed)
8933                 return;
8934
8935         /* Store fan status in cache */
8936         fan_control_resume_level = 0;
8937         rc = fan_get_status_safe(&fan_control_resume_level);
8938         if (rc < 0)
8939                 pr_notice("failed to read fan level for later restore during resume: %d\n",
8940                           rc);
8941
8942         /* if it is undefined, don't attempt to restore it.
8943          * KEEP THIS LAST */
8944         if (tp_features.fan_ctrl_status_undef)
8945                 fan_control_resume_level = 0;
8946 }
8947
8948 static void fan_resume(void)
8949 {
8950         u8 current_level = 7;
8951         bool do_set = false;
8952         int rc;
8953
8954         /* DSDT *always* updates status on resume */
8955         tp_features.fan_ctrl_status_undef = 0;
8956
8957         if (!fan_control_allowed ||
8958             !fan_control_resume_level ||
8959             (fan_get_status_safe(&current_level) < 0))
8960                 return;
8961
8962         switch (fan_control_access_mode) {
8963         case TPACPI_FAN_WR_ACPI_SFAN:
8964                 /* never decrease fan level */
8965                 do_set = (fan_control_resume_level > current_level);
8966                 break;
8967         case TPACPI_FAN_WR_ACPI_FANS:
8968         case TPACPI_FAN_WR_TPEC:
8969                 /* never decrease fan level, scale is:
8970                  * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8971                  *
8972                  * We expect the firmware to set either 7 or AUTO, but we
8973                  * handle FULLSPEED out of paranoia.
8974                  *
8975                  * So, we can safely only restore FULLSPEED or 7, anything
8976                  * else could slow the fan.  Restoring AUTO is useless, at
8977                  * best that's exactly what the DSDT already set (it is the
8978                  * slower it uses).
8979                  *
8980                  * Always keep in mind that the DSDT *will* have set the
8981                  * fans to what the vendor supposes is the best level.  We
8982                  * muck with it only to speed the fan up.
8983                  */
8984                 if (fan_control_resume_level != 7 &&
8985                     !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8986                         return;
8987                 else
8988                         do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8989                                  (current_level != fan_control_resume_level);
8990                 break;
8991         default:
8992                 return;
8993         }
8994         if (do_set) {
8995                 pr_notice("restoring fan level to 0x%02x\n",
8996                           fan_control_resume_level);
8997                 rc = fan_set_level_safe(fan_control_resume_level);
8998                 if (rc < 0)
8999                         pr_notice("failed to restore fan level: %d\n", rc);
9000         }
9001 }
9002
9003 static int fan_read(struct seq_file *m)
9004 {
9005         int rc;
9006         u8 status;
9007         unsigned int speed = 0;
9008
9009         switch (fan_status_access_mode) {
9010         case TPACPI_FAN_RD_ACPI_GFAN:
9011                 /* 570, 600e/x, 770e, 770x */
9012                 rc = fan_get_status_safe(&status);
9013                 if (rc < 0)
9014                         return rc;
9015
9016                 seq_printf(m, "status:\t\t%s\n"
9017                                "level:\t\t%d\n",
9018                                (status != 0) ? "enabled" : "disabled", status);
9019                 break;
9020
9021         case TPACPI_FAN_RD_TPEC:
9022                 /* all except 570, 600e/x, 770e, 770x */
9023                 rc = fan_get_status_safe(&status);
9024                 if (rc < 0)
9025                         return rc;
9026
9027                 seq_printf(m, "status:\t\t%s\n",
9028                                (status != 0) ? "enabled" : "disabled");
9029
9030                 rc = fan_get_speed(&speed);
9031                 if (rc < 0)
9032                         return rc;
9033
9034                 seq_printf(m, "speed:\t\t%d\n", speed);
9035
9036                 if (status & TP_EC_FAN_FULLSPEED)
9037                         /* Disengaged mode takes precedence */
9038                         seq_printf(m, "level:\t\tdisengaged\n");
9039                 else if (status & TP_EC_FAN_AUTO)
9040                         seq_printf(m, "level:\t\tauto\n");
9041                 else
9042                         seq_printf(m, "level:\t\t%d\n", status);
9043                 break;
9044
9045         case TPACPI_FAN_NONE:
9046         default:
9047                 seq_printf(m, "status:\t\tnot supported\n");
9048         }
9049
9050         if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
9051                 seq_printf(m, "commands:\tlevel <level>");
9052
9053                 switch (fan_control_access_mode) {
9054                 case TPACPI_FAN_WR_ACPI_SFAN:
9055                         seq_printf(m, " (<level> is 0-7)\n");
9056                         break;
9057
9058                 default:
9059                         seq_printf(m, " (<level> is 0-7, auto, disengaged, full-speed)\n");
9060                         break;
9061                 }
9062         }
9063
9064         if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
9065                 seq_printf(m, "commands:\tenable, disable\n"
9066                                "commands:\twatchdog <timeout> (<timeout> is 0 (off), 1-120 (seconds))\n");
9067
9068         if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
9069                 seq_printf(m, "commands:\tspeed <speed> (<speed> is 0-65535)\n");
9070
9071         return 0;
9072 }
9073
9074 static int fan_write_cmd_level(const char *cmd, int *rc)
9075 {
9076         int level;
9077
9078         if (strlencmp(cmd, "level auto") == 0)
9079                 level = TP_EC_FAN_AUTO;
9080         else if ((strlencmp(cmd, "level disengaged") == 0) |
9081                         (strlencmp(cmd, "level full-speed") == 0))
9082                 level = TP_EC_FAN_FULLSPEED;
9083         else if (sscanf(cmd, "level %d", &level) != 1)
9084                 return 0;
9085
9086         *rc = fan_set_level_safe(level);
9087         if (*rc == -ENXIO)
9088                 pr_err("level command accepted for unsupported access mode %d\n",
9089                        fan_control_access_mode);
9090         else if (!*rc)
9091                 tpacpi_disclose_usertask("procfs fan",
9092                         "set level to %d\n", level);
9093
9094         return 1;
9095 }
9096
9097 static int fan_write_cmd_enable(const char *cmd, int *rc)
9098 {
9099         if (strlencmp(cmd, "enable") != 0)
9100                 return 0;
9101
9102         *rc = fan_set_enable();
9103         if (*rc == -ENXIO)
9104                 pr_err("enable command accepted for unsupported access mode %d\n",
9105                        fan_control_access_mode);
9106         else if (!*rc)
9107                 tpacpi_disclose_usertask("procfs fan", "enable\n");
9108
9109         return 1;
9110 }
9111
9112 static int fan_write_cmd_disable(const char *cmd, int *rc)
9113 {
9114         if (strlencmp(cmd, "disable") != 0)
9115                 return 0;
9116
9117         *rc = fan_set_disable();
9118         if (*rc == -ENXIO)
9119                 pr_err("disable command accepted for unsupported access mode %d\n",
9120                        fan_control_access_mode);
9121         else if (!*rc)
9122                 tpacpi_disclose_usertask("procfs fan", "disable\n");
9123
9124         return 1;
9125 }
9126
9127 static int fan_write_cmd_speed(const char *cmd, int *rc)
9128 {
9129         int speed;
9130
9131         /* TODO:
9132          * Support speed <low> <medium> <high> ? */
9133
9134         if (sscanf(cmd, "speed %d", &speed) != 1)
9135                 return 0;
9136
9137         *rc = fan_set_speed(speed);
9138         if (*rc == -ENXIO)
9139                 pr_err("speed command accepted for unsupported access mode %d\n",
9140                        fan_control_access_mode);
9141         else if (!*rc)
9142                 tpacpi_disclose_usertask("procfs fan",
9143                         "set speed to %d\n", speed);
9144
9145         return 1;
9146 }
9147
9148 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
9149 {
9150         int interval;
9151
9152         if (sscanf(cmd, "watchdog %d", &interval) != 1)
9153                 return 0;
9154
9155         if (interval < 0 || interval > 120)
9156                 *rc = -EINVAL;
9157         else {
9158                 fan_watchdog_maxinterval = interval;
9159                 tpacpi_disclose_usertask("procfs fan",
9160                         "set watchdog timer to %d\n",
9161                         interval);
9162         }
9163
9164         return 1;
9165 }
9166
9167 static int fan_write(char *buf)
9168 {
9169         char *cmd;
9170         int rc = 0;
9171
9172         while (!rc && (cmd = strsep(&buf, ","))) {
9173                 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
9174                       fan_write_cmd_level(cmd, &rc)) &&
9175                     !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
9176                       (fan_write_cmd_enable(cmd, &rc) ||
9177                        fan_write_cmd_disable(cmd, &rc) ||
9178                        fan_write_cmd_watchdog(cmd, &rc))) &&
9179                     !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
9180                       fan_write_cmd_speed(cmd, &rc))
9181                     )
9182                         rc = -EINVAL;
9183                 else if (!rc)
9184                         fan_watchdog_reset();
9185         }
9186
9187         return rc;
9188 }
9189
9190 static struct ibm_struct fan_driver_data = {
9191         .name = "fan",
9192         .read = fan_read,
9193         .write = fan_write,
9194         .exit = fan_exit,
9195         .suspend = fan_suspend,
9196         .resume = fan_resume,
9197 };
9198
9199 /*************************************************************************
9200  * Mute LED subdriver
9201  */
9202
9203 #define TPACPI_LED_MAX          2
9204
9205 struct tp_led_table {
9206         acpi_string name;
9207         int on_value;
9208         int off_value;
9209         int state;
9210 };
9211
9212 static struct tp_led_table led_tables[TPACPI_LED_MAX] = {
9213         [LED_AUDIO_MUTE] = {
9214                 .name = "SSMS",
9215                 .on_value = 1,
9216                 .off_value = 0,
9217         },
9218         [LED_AUDIO_MICMUTE] = {
9219                 .name = "MMTS",
9220                 .on_value = 2,
9221                 .off_value = 0,
9222         },
9223 };
9224
9225 static int mute_led_on_off(struct tp_led_table *t, bool state)
9226 {
9227         acpi_handle temp;
9228         int output;
9229
9230         if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9231                 pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
9232                 return -EIO;
9233         }
9234
9235         if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
9236                         state ? t->on_value : t->off_value))
9237                 return -EIO;
9238
9239         t->state = state;
9240         return state;
9241 }
9242
9243 static int tpacpi_led_set(int whichled, bool on)
9244 {
9245         struct tp_led_table *t;
9246
9247         t = &led_tables[whichled];
9248         if (t->state < 0 || t->state == on)
9249                 return t->state;
9250         return mute_led_on_off(t, on);
9251 }
9252
9253 static int tpacpi_led_mute_set(struct led_classdev *led_cdev,
9254                                enum led_brightness brightness)
9255 {
9256         return tpacpi_led_set(LED_AUDIO_MUTE, brightness != LED_OFF);
9257 }
9258
9259 static int tpacpi_led_micmute_set(struct led_classdev *led_cdev,
9260                                   enum led_brightness brightness)
9261 {
9262         return tpacpi_led_set(LED_AUDIO_MICMUTE, brightness != LED_OFF);
9263 }
9264
9265 static struct led_classdev mute_led_cdev[TPACPI_LED_MAX] = {
9266         [LED_AUDIO_MUTE] = {
9267                 .name           = "platform::mute",
9268                 .max_brightness = 1,
9269                 .brightness_set_blocking = tpacpi_led_mute_set,
9270                 .default_trigger = "audio-mute",
9271         },
9272         [LED_AUDIO_MICMUTE] = {
9273                 .name           = "platform::micmute",
9274                 .max_brightness = 1,
9275                 .brightness_set_blocking = tpacpi_led_micmute_set,
9276                 .default_trigger = "audio-micmute",
9277         },
9278 };
9279
9280 static int mute_led_init(struct ibm_init_struct *iibm)
9281 {
9282         acpi_handle temp;
9283         int i, err;
9284
9285         for (i = 0; i < TPACPI_LED_MAX; i++) {
9286                 struct tp_led_table *t = &led_tables[i];
9287                 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9288                         t->state = -ENODEV;
9289                         continue;
9290                 }
9291
9292                 mute_led_cdev[i].brightness = ledtrig_audio_get(i);
9293                 err = led_classdev_register(&tpacpi_pdev->dev, &mute_led_cdev[i]);
9294                 if (err < 0) {
9295                         while (i--)
9296                                 led_classdev_unregister(&mute_led_cdev[i]);
9297                         return err;
9298                 }
9299         }
9300         return 0;
9301 }
9302
9303 static void mute_led_exit(void)
9304 {
9305         int i;
9306
9307         for (i = 0; i < TPACPI_LED_MAX; i++) {
9308                 led_classdev_unregister(&mute_led_cdev[i]);
9309                 tpacpi_led_set(i, false);
9310         }
9311 }
9312
9313 static void mute_led_resume(void)
9314 {
9315         int i;
9316
9317         for (i = 0; i < TPACPI_LED_MAX; i++) {
9318                 struct tp_led_table *t = &led_tables[i];
9319                 if (t->state >= 0)
9320                         mute_led_on_off(t, t->state);
9321         }
9322 }
9323
9324 static struct ibm_struct mute_led_driver_data = {
9325         .name = "mute_led",
9326         .exit = mute_led_exit,
9327         .resume = mute_led_resume,
9328 };
9329
9330 /*
9331  * Battery Wear Control Driver
9332  * Contact: Ognjen Galic <smclt30p@gmail.com>
9333  */
9334
9335 /* Metadata */
9336
9337 #define GET_START       "BCTG"
9338 #define SET_START       "BCCS"
9339 #define GET_STOP        "BCSG"
9340 #define SET_STOP        "BCSS"
9341
9342 enum {
9343         BAT_ANY = 0,
9344         BAT_PRIMARY = 1,
9345         BAT_SECONDARY = 2
9346 };
9347
9348 enum {
9349         /* Error condition bit */
9350         METHOD_ERR = BIT(31),
9351 };
9352
9353 enum {
9354         /* This is used in the get/set helpers */
9355         THRESHOLD_START,
9356         THRESHOLD_STOP,
9357 };
9358
9359 struct tpacpi_battery_data {
9360         int charge_start;
9361         int start_support;
9362         int charge_stop;
9363         int stop_support;
9364 };
9365
9366 struct tpacpi_battery_driver_data {
9367         struct tpacpi_battery_data batteries[3];
9368         int individual_addressing;
9369 };
9370
9371 static struct tpacpi_battery_driver_data battery_info;
9372
9373 /* ACPI helpers/functions/probes */
9374
9375 /**
9376  * This evaluates a ACPI method call specific to the battery
9377  * ACPI extension. The specifics are that an error is marked
9378  * in the 32rd bit of the response, so we just check that here.
9379  */
9380 static acpi_status tpacpi_battery_acpi_eval(char *method, int *ret, int param)
9381 {
9382         int response;
9383
9384         if (!acpi_evalf(hkey_handle, &response, method, "dd", param)) {
9385                 acpi_handle_err(hkey_handle, "%s: evaluate failed", method);
9386                 return AE_ERROR;
9387         }
9388         if (response & METHOD_ERR) {
9389                 acpi_handle_err(hkey_handle,
9390                                 "%s evaluated but flagged as error", method);
9391                 return AE_ERROR;
9392         }
9393         *ret = response;
9394         return AE_OK;
9395 }
9396
9397 static int tpacpi_battery_get(int what, int battery, int *ret)
9398 {
9399         switch (what) {
9400         case THRESHOLD_START:
9401                 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, ret, battery))
9402                         return -ENODEV;
9403
9404                 /* The value is in the low 8 bits of the response */
9405                 *ret = *ret & 0xFF;
9406                 return 0;
9407         case THRESHOLD_STOP:
9408                 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, ret, battery))
9409                         return -ENODEV;
9410                 /* Value is in lower 8 bits */
9411                 *ret = *ret & 0xFF;
9412                 /*
9413                  * On the stop value, if we return 0 that
9414                  * does not make any sense. 0 means Default, which
9415                  * means that charging stops at 100%, so we return
9416                  * that.
9417                  */
9418                 if (*ret == 0)
9419                         *ret = 100;
9420                 return 0;
9421         default:
9422                 pr_crit("wrong parameter: %d", what);
9423                 return -EINVAL;
9424         }
9425 }
9426
9427 static int tpacpi_battery_set(int what, int battery, int value)
9428 {
9429         int param, ret;
9430         /* The first 8 bits are the value of the threshold */
9431         param = value;
9432         /* The battery ID is in bits 8-9, 2 bits */
9433         param |= battery << 8;
9434
9435         switch (what) {
9436         case THRESHOLD_START:
9437                 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_START, &ret, param)) {
9438                         pr_err("failed to set charge threshold on battery %d",
9439                                         battery);
9440                         return -ENODEV;
9441                 }
9442                 return 0;
9443         case THRESHOLD_STOP:
9444                 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_STOP, &ret, param)) {
9445                         pr_err("failed to set stop threshold: %d", battery);
9446                         return -ENODEV;
9447                 }
9448                 return 0;
9449         default:
9450                 pr_crit("wrong parameter: %d", what);
9451                 return -EINVAL;
9452         }
9453 }
9454
9455 static int tpacpi_battery_probe(int battery)
9456 {
9457         int ret = 0;
9458
9459         memset(&battery_info.batteries[battery], 0,
9460                 sizeof(battery_info.batteries[battery]));
9461
9462         /*
9463          * 1) Get the current start threshold
9464          * 2) Check for support
9465          * 3) Get the current stop threshold
9466          * 4) Check for support
9467          */
9468         if (acpi_has_method(hkey_handle, GET_START)) {
9469                 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, &ret, battery)) {
9470                         pr_err("Error probing battery %d\n", battery);
9471                         return -ENODEV;
9472                 }
9473                 /* Individual addressing is in bit 9 */
9474                 if (ret & BIT(9))
9475                         battery_info.individual_addressing = true;
9476                 /* Support is marked in bit 8 */
9477                 if (ret & BIT(8))
9478                         battery_info.batteries[battery].start_support = 1;
9479                 else
9480                         return -ENODEV;
9481                 if (tpacpi_battery_get(THRESHOLD_START, battery,
9482                         &battery_info.batteries[battery].charge_start)) {
9483                         pr_err("Error probing battery %d\n", battery);
9484                         return -ENODEV;
9485                 }
9486         }
9487         if (acpi_has_method(hkey_handle, GET_STOP)) {
9488                 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, &ret, battery)) {
9489                         pr_err("Error probing battery stop; %d\n", battery);
9490                         return -ENODEV;
9491                 }
9492                 /* Support is marked in bit 8 */
9493                 if (ret & BIT(8))
9494                         battery_info.batteries[battery].stop_support = 1;
9495                 else
9496                         return -ENODEV;
9497                 if (tpacpi_battery_get(THRESHOLD_STOP, battery,
9498                         &battery_info.batteries[battery].charge_stop)) {
9499                         pr_err("Error probing battery stop: %d\n", battery);
9500                         return -ENODEV;
9501                 }
9502         }
9503         pr_info("battery %d registered (start %d, stop %d)",
9504                         battery,
9505                         battery_info.batteries[battery].charge_start,
9506                         battery_info.batteries[battery].charge_stop);
9507
9508         return 0;
9509 }
9510
9511 /* General helper functions */
9512
9513 static int tpacpi_battery_get_id(const char *battery_name)
9514 {
9515
9516         if (strcmp(battery_name, "BAT0") == 0 ||
9517             tp_features.battery_force_primary)
9518                 return BAT_PRIMARY;
9519         if (strcmp(battery_name, "BAT1") == 0)
9520                 return BAT_SECONDARY;
9521         /*
9522          * If for some reason the battery is not BAT0 nor is it
9523          * BAT1, we will assume it's the default, first battery,
9524          * AKA primary.
9525          */
9526         pr_warn("unknown battery %s, assuming primary", battery_name);
9527         return BAT_PRIMARY;
9528 }
9529
9530 /* sysfs interface */
9531
9532 static ssize_t tpacpi_battery_store(int what,
9533                                     struct device *dev,
9534                                     const char *buf, size_t count)
9535 {
9536         struct power_supply *supply = to_power_supply(dev);
9537         unsigned long value;
9538         int battery, rval;
9539         /*
9540          * Some systems have support for more than
9541          * one battery. If that is the case,
9542          * tpacpi_battery_probe marked that addressing
9543          * them individually is supported, so we do that
9544          * based on the device struct.
9545          *
9546          * On systems that are not supported, we assume
9547          * the primary as most of the ACPI calls fail
9548          * with "Any Battery" as the parameter.
9549          */
9550         if (battery_info.individual_addressing)
9551                 /* BAT_PRIMARY or BAT_SECONDARY */
9552                 battery = tpacpi_battery_get_id(supply->desc->name);
9553         else
9554                 battery = BAT_PRIMARY;
9555
9556         rval = kstrtoul(buf, 10, &value);
9557         if (rval)
9558                 return rval;
9559
9560         switch (what) {
9561         case THRESHOLD_START:
9562                 if (!battery_info.batteries[battery].start_support)
9563                         return -ENODEV;
9564                 /* valid values are [0, 99] */
9565                 if (value > 99)
9566                         return -EINVAL;
9567                 if (value > battery_info.batteries[battery].charge_stop)
9568                         return -EINVAL;
9569                 if (tpacpi_battery_set(THRESHOLD_START, battery, value))
9570                         return -ENODEV;
9571                 battery_info.batteries[battery].charge_start = value;
9572                 return count;
9573
9574         case THRESHOLD_STOP:
9575                 if (!battery_info.batteries[battery].stop_support)
9576                         return -ENODEV;
9577                 /* valid values are [1, 100] */
9578                 if (value < 1 || value > 100)
9579                         return -EINVAL;
9580                 if (value < battery_info.batteries[battery].charge_start)
9581                         return -EINVAL;
9582                 battery_info.batteries[battery].charge_stop = value;
9583                 /*
9584                  * When 100 is passed to stop, we need to flip
9585                  * it to 0 as that the EC understands that as
9586                  * "Default", which will charge to 100%
9587                  */
9588                 if (value == 100)
9589                         value = 0;
9590                 if (tpacpi_battery_set(THRESHOLD_STOP, battery, value))
9591                         return -EINVAL;
9592                 return count;
9593         default:
9594                 pr_crit("Wrong parameter: %d", what);
9595                 return -EINVAL;
9596         }
9597         return count;
9598 }
9599
9600 static ssize_t tpacpi_battery_show(int what,
9601                                    struct device *dev,
9602                                    char *buf)
9603 {
9604         struct power_supply *supply = to_power_supply(dev);
9605         int ret, battery;
9606         /*
9607          * Some systems have support for more than
9608          * one battery. If that is the case,
9609          * tpacpi_battery_probe marked that addressing
9610          * them individually is supported, so we;
9611          * based on the device struct.
9612          *
9613          * On systems that are not supported, we assume
9614          * the primary as most of the ACPI calls fail
9615          * with "Any Battery" as the parameter.
9616          */
9617         if (battery_info.individual_addressing)
9618                 /* BAT_PRIMARY or BAT_SECONDARY */
9619                 battery = tpacpi_battery_get_id(supply->desc->name);
9620         else
9621                 battery = BAT_PRIMARY;
9622         if (tpacpi_battery_get(what, battery, &ret))
9623                 return -ENODEV;
9624         return sprintf(buf, "%d\n", ret);
9625 }
9626
9627 static ssize_t charge_control_start_threshold_show(struct device *device,
9628                                 struct device_attribute *attr,
9629                                 char *buf)
9630 {
9631         return tpacpi_battery_show(THRESHOLD_START, device, buf);
9632 }
9633
9634 static ssize_t charge_control_end_threshold_show(struct device *device,
9635                                 struct device_attribute *attr,
9636                                 char *buf)
9637 {
9638         return tpacpi_battery_show(THRESHOLD_STOP, device, buf);
9639 }
9640
9641 static ssize_t charge_control_start_threshold_store(struct device *dev,
9642                                 struct device_attribute *attr,
9643                                 const char *buf, size_t count)
9644 {
9645         return tpacpi_battery_store(THRESHOLD_START, dev, buf, count);
9646 }
9647
9648 static ssize_t charge_control_end_threshold_store(struct device *dev,
9649                                 struct device_attribute *attr,
9650                                 const char *buf, size_t count)
9651 {
9652         return tpacpi_battery_store(THRESHOLD_STOP, dev, buf, count);
9653 }
9654
9655 static DEVICE_ATTR_RW(charge_control_start_threshold);
9656 static DEVICE_ATTR_RW(charge_control_end_threshold);
9657 static struct device_attribute dev_attr_charge_start_threshold = __ATTR(
9658         charge_start_threshold,
9659         0644,
9660         charge_control_start_threshold_show,
9661         charge_control_start_threshold_store
9662 );
9663 static struct device_attribute dev_attr_charge_stop_threshold = __ATTR(
9664         charge_stop_threshold,
9665         0644,
9666         charge_control_end_threshold_show,
9667         charge_control_end_threshold_store
9668 );
9669
9670 static struct attribute *tpacpi_battery_attrs[] = {
9671         &dev_attr_charge_control_start_threshold.attr,
9672         &dev_attr_charge_control_end_threshold.attr,
9673         &dev_attr_charge_start_threshold.attr,
9674         &dev_attr_charge_stop_threshold.attr,
9675         NULL,
9676 };
9677
9678 ATTRIBUTE_GROUPS(tpacpi_battery);
9679
9680 /* ACPI battery hooking */
9681
9682 static int tpacpi_battery_add(struct power_supply *battery)
9683 {
9684         int batteryid = tpacpi_battery_get_id(battery->desc->name);
9685
9686         if (tpacpi_battery_probe(batteryid))
9687                 return -ENODEV;
9688         if (device_add_groups(&battery->dev, tpacpi_battery_groups))
9689                 return -ENODEV;
9690         return 0;
9691 }
9692
9693 static int tpacpi_battery_remove(struct power_supply *battery)
9694 {
9695         device_remove_groups(&battery->dev, tpacpi_battery_groups);
9696         return 0;
9697 }
9698
9699 static struct acpi_battery_hook battery_hook = {
9700         .add_battery = tpacpi_battery_add,
9701         .remove_battery = tpacpi_battery_remove,
9702         .name = "ThinkPad Battery Extension",
9703 };
9704
9705 /* Subdriver init/exit */
9706
9707 static const struct tpacpi_quirk battery_quirk_table[] __initconst = {
9708         /*
9709          * Individual addressing is broken on models that expose the
9710          * primary battery as BAT1.
9711          */
9712         TPACPI_Q_LNV('J', '7', true),       /* B5400 */
9713         TPACPI_Q_LNV('J', 'I', true),       /* Thinkpad 11e */
9714         TPACPI_Q_LNV3('R', '0', 'B', true), /* Thinkpad 11e gen 3 */
9715         TPACPI_Q_LNV3('R', '0', 'C', true), /* Thinkpad 13 */
9716         TPACPI_Q_LNV3('R', '0', 'J', true), /* Thinkpad 13 gen 2 */
9717         TPACPI_Q_LNV3('R', '0', 'K', true), /* Thinkpad 11e gen 4 celeron BIOS */
9718 };
9719
9720 static int __init tpacpi_battery_init(struct ibm_init_struct *ibm)
9721 {
9722         memset(&battery_info, 0, sizeof(battery_info));
9723
9724         tp_features.battery_force_primary = tpacpi_check_quirks(
9725                                         battery_quirk_table,
9726                                         ARRAY_SIZE(battery_quirk_table));
9727
9728         battery_hook_register(&battery_hook);
9729         return 0;
9730 }
9731
9732 static void tpacpi_battery_exit(void)
9733 {
9734         battery_hook_unregister(&battery_hook);
9735 }
9736
9737 static struct ibm_struct battery_driver_data = {
9738         .name = "battery",
9739         .exit = tpacpi_battery_exit,
9740 };
9741
9742 /*************************************************************************
9743  * LCD Shadow subdriver, for the Lenovo PrivacyGuard feature
9744  */
9745
9746 static int lcdshadow_state;
9747
9748 static int lcdshadow_on_off(bool state)
9749 {
9750         acpi_handle set_shadow_handle;
9751         int output;
9752
9753         if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "SSSS", &set_shadow_handle))) {
9754                 pr_warn("Thinkpad ACPI has no %s interface.\n", "SSSS");
9755                 return -EIO;
9756         }
9757
9758         if (!acpi_evalf(set_shadow_handle, &output, NULL, "dd", (int)state))
9759                 return -EIO;
9760
9761         lcdshadow_state = state;
9762         return 0;
9763 }
9764
9765 static int lcdshadow_set(bool on)
9766 {
9767         if (lcdshadow_state < 0)
9768                 return lcdshadow_state;
9769         if (lcdshadow_state == on)
9770                 return 0;
9771         return lcdshadow_on_off(on);
9772 }
9773
9774 static int tpacpi_lcdshadow_init(struct ibm_init_struct *iibm)
9775 {
9776         acpi_handle get_shadow_handle;
9777         int output;
9778
9779         if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GSSS", &get_shadow_handle))) {
9780                 lcdshadow_state = -ENODEV;
9781                 return 0;
9782         }
9783
9784         if (!acpi_evalf(get_shadow_handle, &output, NULL, "dd", 0)) {
9785                 lcdshadow_state = -EIO;
9786                 return -EIO;
9787         }
9788         if (!(output & 0x10000)) {
9789                 lcdshadow_state = -ENODEV;
9790                 return 0;
9791         }
9792         lcdshadow_state = output & 0x1;
9793
9794         return 0;
9795 }
9796
9797 static void lcdshadow_resume(void)
9798 {
9799         if (lcdshadow_state >= 0)
9800                 lcdshadow_on_off(lcdshadow_state);
9801 }
9802
9803 static int lcdshadow_read(struct seq_file *m)
9804 {
9805         if (lcdshadow_state < 0) {
9806                 seq_puts(m, "status:\t\tnot supported\n");
9807         } else {
9808                 seq_printf(m, "status:\t\t%d\n", lcdshadow_state);
9809                 seq_puts(m, "commands:\t0, 1\n");
9810         }
9811
9812         return 0;
9813 }
9814
9815 static int lcdshadow_write(char *buf)
9816 {
9817         char *cmd;
9818         int res, state = -EINVAL;
9819
9820         if (lcdshadow_state < 0)
9821                 return -ENODEV;
9822
9823         while ((cmd = strsep(&buf, ","))) {
9824                 res = kstrtoint(cmd, 10, &state);
9825                 if (res < 0)
9826                         return res;
9827         }
9828
9829         if (state >= 2 || state < 0)
9830                 return -EINVAL;
9831
9832         return lcdshadow_set(state);
9833 }
9834
9835 static struct ibm_struct lcdshadow_driver_data = {
9836         .name = "lcdshadow",
9837         .resume = lcdshadow_resume,
9838         .read = lcdshadow_read,
9839         .write = lcdshadow_write,
9840 };
9841
9842 /*************************************************************************
9843  * Thinkpad sensor interfaces
9844  */
9845
9846 #define DYTC_CMD_GET          2 /* To get current IC function and mode */
9847 #define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
9848
9849 #define PALMSENSOR_PRESENT_BIT 0 /* Determine if psensor present */
9850 #define PALMSENSOR_ON_BIT      1 /* psensor status */
9851
9852 static bool has_palmsensor;
9853 static bool has_lapsensor;
9854 static bool palm_state;
9855 static bool lap_state;
9856
9857 static int lapsensor_get(bool *present, bool *state)
9858 {
9859         acpi_handle dytc_handle;
9860         int output;
9861
9862         *present = false;
9863         if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle)))
9864                 return -ENODEV;
9865         if (!acpi_evalf(dytc_handle, &output, NULL, "dd", DYTC_CMD_GET))
9866                 return -EIO;
9867
9868         *present = true; /*If we get his far, we have lapmode support*/
9869         *state = output & BIT(DYTC_GET_LAPMODE_BIT) ? true : false;
9870         return 0;
9871 }
9872
9873 static int palmsensor_get(bool *present, bool *state)
9874 {
9875         acpi_handle psensor_handle;
9876         int output;
9877
9878         *present = false;
9879         if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GPSS", &psensor_handle)))
9880                 return -ENODEV;
9881         if (!acpi_evalf(psensor_handle, &output, NULL, "d"))
9882                 return -EIO;
9883
9884         *present = output & BIT(PALMSENSOR_PRESENT_BIT) ? true : false;
9885         *state = output & BIT(PALMSENSOR_ON_BIT) ? true : false;
9886         return 0;
9887 }
9888
9889 static void lapsensor_refresh(void)
9890 {
9891         bool state;
9892         int err;
9893
9894         if (has_lapsensor) {
9895                 err = lapsensor_get(&has_lapsensor, &state);
9896                 if (err)
9897                         return;
9898                 if (lap_state != state) {
9899                         lap_state = state;
9900                         sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
9901                 }
9902         }
9903 }
9904
9905 static void palmsensor_refresh(void)
9906 {
9907         bool state;
9908         int err;
9909
9910         if (has_palmsensor) {
9911                 err = palmsensor_get(&has_palmsensor, &state);
9912                 if (err)
9913                         return;
9914                 if (palm_state != state) {
9915                         palm_state = state;
9916                         sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "palmsensor");
9917                 }
9918         }
9919 }
9920
9921 static ssize_t dytc_lapmode_show(struct device *dev,
9922                                         struct device_attribute *attr,
9923                                         char *buf)
9924 {
9925         if (has_lapsensor)
9926                 return sysfs_emit(buf, "%d\n", lap_state);
9927         return sysfs_emit(buf, "\n");
9928 }
9929 static DEVICE_ATTR_RO(dytc_lapmode);
9930
9931 static ssize_t palmsensor_show(struct device *dev,
9932                                         struct device_attribute *attr,
9933                                         char *buf)
9934 {
9935         if (has_palmsensor)
9936                 return sysfs_emit(buf, "%d\n", palm_state);
9937         return sysfs_emit(buf, "\n");
9938 }
9939 static DEVICE_ATTR_RO(palmsensor);
9940
9941 static int tpacpi_proxsensor_init(struct ibm_init_struct *iibm)
9942 {
9943         int palm_err, lap_err, err;
9944
9945         palm_err = palmsensor_get(&has_palmsensor, &palm_state);
9946         lap_err = lapsensor_get(&has_lapsensor, &lap_state);
9947         /*
9948          * If support isn't available (ENODEV) for both devices then quit, but
9949          * don't return an error.
9950          */
9951         if ((palm_err == -ENODEV) && (lap_err == -ENODEV))
9952                 return 0;
9953         /* Otherwise, if there was an error return it */
9954         if (palm_err && (palm_err != -ENODEV))
9955                 return palm_err;
9956         if (lap_err && (lap_err != -ENODEV))
9957                 return lap_err;
9958
9959         if (has_palmsensor) {
9960                 err = sysfs_create_file(&tpacpi_pdev->dev.kobj, &dev_attr_palmsensor.attr);
9961                 if (err)
9962                         return err;
9963         }
9964         if (has_lapsensor) {
9965                 err = sysfs_create_file(&tpacpi_pdev->dev.kobj, &dev_attr_dytc_lapmode.attr);
9966                 if (err)
9967                         return err;
9968         }
9969         return 0;
9970 }
9971
9972 static void proxsensor_exit(void)
9973 {
9974         if (has_lapsensor)
9975                 sysfs_remove_file(&tpacpi_pdev->dev.kobj, &dev_attr_dytc_lapmode.attr);
9976         if (has_palmsensor)
9977                 sysfs_remove_file(&tpacpi_pdev->dev.kobj, &dev_attr_palmsensor.attr);
9978 }
9979
9980 static struct ibm_struct proxsensor_driver_data = {
9981         .name = "proximity-sensor",
9982         .exit = proxsensor_exit,
9983 };
9984
9985 /****************************************************************************
9986  ****************************************************************************
9987  *
9988  * Infrastructure
9989  *
9990  ****************************************************************************
9991  ****************************************************************************/
9992
9993 /*
9994  * HKEY event callout for other subdrivers go here
9995  * (yes, it is ugly, but it is quick, safe, and gets the job done
9996  */
9997 static void tpacpi_driver_event(const unsigned int hkey_event)
9998 {
9999         if (ibm_backlight_device) {
10000                 switch (hkey_event) {
10001                 case TP_HKEY_EV_BRGHT_UP:
10002                 case TP_HKEY_EV_BRGHT_DOWN:
10003                         tpacpi_brightness_notify_change();
10004                 }
10005         }
10006         if (alsa_card) {
10007                 switch (hkey_event) {
10008                 case TP_HKEY_EV_VOL_UP:
10009                 case TP_HKEY_EV_VOL_DOWN:
10010                 case TP_HKEY_EV_VOL_MUTE:
10011                         volume_alsa_notify_change();
10012                 }
10013         }
10014         if (tp_features.kbdlight && hkey_event == TP_HKEY_EV_KBD_LIGHT) {
10015                 enum led_brightness brightness;
10016
10017                 mutex_lock(&kbdlight_mutex);
10018
10019                 /*
10020                  * Check the brightness actually changed, setting the brightness
10021                  * through kbdlight_set_level() also triggers this event.
10022                  */
10023                 brightness = kbdlight_sysfs_get(NULL);
10024                 if (kbdlight_brightness != brightness) {
10025                         kbdlight_brightness = brightness;
10026                         led_classdev_notify_brightness_hw_changed(
10027                                 &tpacpi_led_kbdlight.led_classdev, brightness);
10028                 }
10029
10030                 mutex_unlock(&kbdlight_mutex);
10031         }
10032
10033         if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
10034                 lapsensor_refresh();
10035 }
10036
10037 static void hotkey_driver_event(const unsigned int scancode)
10038 {
10039         tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
10040 }
10041
10042 /* --------------------------------------------------------------------- */
10043
10044 /* /proc support */
10045 static struct proc_dir_entry *proc_dir;
10046
10047 /*
10048  * Module and infrastructure proble, init and exit handling
10049  */
10050
10051 static bool force_load;
10052
10053 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
10054 static const char * __init str_supported(int is_supported)
10055 {
10056         static char text_unsupported[] __initdata = "not supported";
10057
10058         return (is_supported) ? &text_unsupported[4] : &text_unsupported[0];
10059 }
10060 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
10061
10062 static void ibm_exit(struct ibm_struct *ibm)
10063 {
10064         dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
10065
10066         list_del_init(&ibm->all_drivers);
10067
10068         if (ibm->flags.acpi_notify_installed) {
10069                 dbg_printk(TPACPI_DBG_EXIT,
10070                         "%s: acpi_remove_notify_handler\n", ibm->name);
10071                 BUG_ON(!ibm->acpi);
10072                 acpi_remove_notify_handler(*ibm->acpi->handle,
10073                                            ibm->acpi->type,
10074                                            dispatch_acpi_notify);
10075                 ibm->flags.acpi_notify_installed = 0;
10076         }
10077
10078         if (ibm->flags.proc_created) {
10079                 dbg_printk(TPACPI_DBG_EXIT,
10080                         "%s: remove_proc_entry\n", ibm->name);
10081                 remove_proc_entry(ibm->name, proc_dir);
10082                 ibm->flags.proc_created = 0;
10083         }
10084
10085         if (ibm->flags.acpi_driver_registered) {
10086                 dbg_printk(TPACPI_DBG_EXIT,
10087                         "%s: acpi_bus_unregister_driver\n", ibm->name);
10088                 BUG_ON(!ibm->acpi);
10089                 acpi_bus_unregister_driver(ibm->acpi->driver);
10090                 kfree(ibm->acpi->driver);
10091                 ibm->acpi->driver = NULL;
10092                 ibm->flags.acpi_driver_registered = 0;
10093         }
10094
10095         if (ibm->flags.init_called && ibm->exit) {
10096                 ibm->exit();
10097                 ibm->flags.init_called = 0;
10098         }
10099
10100         dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
10101 }
10102
10103 static int __init ibm_init(struct ibm_init_struct *iibm)
10104 {
10105         int ret;
10106         struct ibm_struct *ibm = iibm->data;
10107         struct proc_dir_entry *entry;
10108
10109         BUG_ON(ibm == NULL);
10110
10111         INIT_LIST_HEAD(&ibm->all_drivers);
10112
10113         if (ibm->flags.experimental && !experimental)
10114                 return 0;
10115
10116         dbg_printk(TPACPI_DBG_INIT,
10117                 "probing for %s\n", ibm->name);
10118
10119         if (iibm->init) {
10120                 ret = iibm->init(iibm);
10121                 if (ret > 0)
10122                         return 0;       /* probe failed */
10123                 if (ret)
10124                         return ret;
10125
10126                 ibm->flags.init_called = 1;
10127         }
10128
10129         if (ibm->acpi) {
10130                 if (ibm->acpi->hid) {
10131                         ret = register_tpacpi_subdriver(ibm);
10132                         if (ret)
10133                                 goto err_out;
10134                 }
10135
10136                 if (ibm->acpi->notify) {
10137                         ret = setup_acpi_notify(ibm);
10138                         if (ret == -ENODEV) {
10139                                 pr_notice("disabling subdriver %s\n",
10140                                           ibm->name);
10141                                 ret = 0;
10142                                 goto err_out;
10143                         }
10144                         if (ret < 0)
10145                                 goto err_out;
10146                 }
10147         }
10148
10149         dbg_printk(TPACPI_DBG_INIT,
10150                 "%s installed\n", ibm->name);
10151
10152         if (ibm->read) {
10153                 umode_t mode = iibm->base_procfs_mode;
10154
10155                 if (!mode)
10156                         mode = S_IRUGO;
10157                 if (ibm->write)
10158                         mode |= S_IWUSR;
10159                 entry = proc_create_data(ibm->name, mode, proc_dir,
10160                                          &dispatch_proc_ops, ibm);
10161                 if (!entry) {
10162                         pr_err("unable to create proc entry %s\n", ibm->name);
10163                         ret = -ENODEV;
10164                         goto err_out;
10165                 }
10166                 ibm->flags.proc_created = 1;
10167         }
10168
10169         list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
10170
10171         return 0;
10172
10173 err_out:
10174         dbg_printk(TPACPI_DBG_INIT,
10175                 "%s: at error exit path with result %d\n",
10176                 ibm->name, ret);
10177
10178         ibm_exit(ibm);
10179         return (ret < 0) ? ret : 0;
10180 }
10181
10182 /* Probing */
10183
10184 static char __init tpacpi_parse_fw_id(const char * const s,
10185                                       u32 *model, u16 *release)
10186 {
10187         int i;
10188
10189         if (!s || strlen(s) < 8)
10190                 goto invalid;
10191
10192         for (i = 0; i < 8; i++)
10193                 if (!((s[i] >= '0' && s[i] <= '9') ||
10194                       (s[i] >= 'A' && s[i] <= 'Z')))
10195                         goto invalid;
10196
10197         /*
10198          * Most models: xxyTkkWW (#.##c)
10199          * Ancient 570/600 and -SL lacks (#.##c)
10200          */
10201         if (s[3] == 'T' || s[3] == 'N') {
10202                 *model = TPID(s[0], s[1]);
10203                 *release = TPVER(s[4], s[5]);
10204                 return s[2];
10205
10206         /* New models: xxxyTkkW (#.##c); T550 and some others */
10207         } else if (s[4] == 'T' || s[4] == 'N') {
10208                 *model = TPID3(s[0], s[1], s[2]);
10209                 *release = TPVER(s[5], s[6]);
10210                 return s[3];
10211         }
10212
10213 invalid:
10214         return '\0';
10215 }
10216
10217 static void find_new_ec_fwstr(const struct dmi_header *dm, void *private)
10218 {
10219         char *ec_fw_string = (char *) private;
10220         const char *dmi_data = (const char *)dm;
10221         /*
10222          * ThinkPad Embedded Controller Program Table on newer models
10223          *
10224          * Offset |  Name                | Width  | Description
10225          * ----------------------------------------------------
10226          *  0x00  | Type                 | BYTE   | 0x8C
10227          *  0x01  | Length               | BYTE   |
10228          *  0x02  | Handle               | WORD   | Varies
10229          *  0x04  | Signature            | BYTEx6 | ASCII for "LENOVO"
10230          *  0x0A  | OEM struct offset    | BYTE   | 0x0B
10231          *  0x0B  | OEM struct number    | BYTE   | 0x07, for this structure
10232          *  0x0C  | OEM struct revision  | BYTE   | 0x01, for this format
10233          *  0x0D  | ECP version ID       | STR ID |
10234          *  0x0E  | ECP release date     | STR ID |
10235          */
10236
10237         /* Return if data structure not match */
10238         if (dm->type != 140 || dm->length < 0x0F ||
10239         memcmp(dmi_data + 4, "LENOVO", 6) != 0 ||
10240         dmi_data[0x0A] != 0x0B || dmi_data[0x0B] != 0x07 ||
10241         dmi_data[0x0C] != 0x01)
10242                 return;
10243
10244         /* fwstr is the first 8byte string  */
10245         strncpy(ec_fw_string, dmi_data + 0x0F, 8);
10246 }
10247
10248 /* returns 0 - probe ok, or < 0 - probe error.
10249  * Probe ok doesn't mean thinkpad found.
10250  * On error, kfree() cleanup on tp->* is not performed, caller must do it */
10251 static int __must_check __init get_thinkpad_model_data(
10252                                                 struct thinkpad_id_data *tp)
10253 {
10254         const struct dmi_device *dev = NULL;
10255         char ec_fw_string[18] = {0};
10256         char const *s;
10257         char t;
10258
10259         if (!tp)
10260                 return -EINVAL;
10261
10262         memset(tp, 0, sizeof(*tp));
10263
10264         if (dmi_name_in_vendors("IBM"))
10265                 tp->vendor = PCI_VENDOR_ID_IBM;
10266         else if (dmi_name_in_vendors("LENOVO"))
10267                 tp->vendor = PCI_VENDOR_ID_LENOVO;
10268         else
10269                 return 0;
10270
10271         s = dmi_get_system_info(DMI_BIOS_VERSION);
10272         tp->bios_version_str = kstrdup(s, GFP_KERNEL);
10273         if (s && !tp->bios_version_str)
10274                 return -ENOMEM;
10275
10276         /* Really ancient ThinkPad 240X will fail this, which is fine */
10277         t = tpacpi_parse_fw_id(tp->bios_version_str,
10278                                &tp->bios_model, &tp->bios_release);
10279         if (t != 'E' && t != 'C')
10280                 return 0;
10281
10282         /*
10283          * ThinkPad T23 or newer, A31 or newer, R50e or newer,
10284          * X32 or newer, all Z series;  Some models must have an
10285          * up-to-date BIOS or they will not be detected.
10286          *
10287          * See https://thinkwiki.org/wiki/List_of_DMI_IDs
10288          */
10289         while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
10290                 if (sscanf(dev->name,
10291                            "IBM ThinkPad Embedded Controller -[%17c",
10292                            ec_fw_string) == 1) {
10293                         ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
10294                         ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
10295                         break;
10296                 }
10297         }
10298
10299         /* Newer ThinkPads have different EC program info table */
10300         if (!ec_fw_string[0])
10301                 dmi_walk(find_new_ec_fwstr, &ec_fw_string);
10302
10303         if (ec_fw_string[0]) {
10304                 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
10305                 if (!tp->ec_version_str)
10306                         return -ENOMEM;
10307
10308                 t = tpacpi_parse_fw_id(ec_fw_string,
10309                          &tp->ec_model, &tp->ec_release);
10310                 if (t != 'H') {
10311                         pr_notice("ThinkPad firmware release %s doesn't match the known patterns\n",
10312                                   ec_fw_string);
10313                         pr_notice("please report this to %s\n", TPACPI_MAIL);
10314                 }
10315         }
10316
10317         s = dmi_get_system_info(DMI_PRODUCT_VERSION);
10318         if (s && !(strncasecmp(s, "ThinkPad", 8) && strncasecmp(s, "Lenovo", 6))) {
10319                 tp->model_str = kstrdup(s, GFP_KERNEL);
10320                 if (!tp->model_str)
10321                         return -ENOMEM;
10322         } else {
10323                 s = dmi_get_system_info(DMI_BIOS_VENDOR);
10324                 if (s && !(strncasecmp(s, "Lenovo", 6))) {
10325                         tp->model_str = kstrdup(s, GFP_KERNEL);
10326                         if (!tp->model_str)
10327                                 return -ENOMEM;
10328                 }
10329         }
10330
10331         s = dmi_get_system_info(DMI_PRODUCT_NAME);
10332         tp->nummodel_str = kstrdup(s, GFP_KERNEL);
10333         if (s && !tp->nummodel_str)
10334                 return -ENOMEM;
10335
10336         return 0;
10337 }
10338
10339 static int __init probe_for_thinkpad(void)
10340 {
10341         int is_thinkpad;
10342
10343         if (acpi_disabled)
10344                 return -ENODEV;
10345
10346         /* It would be dangerous to run the driver in this case */
10347         if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
10348                 return -ENODEV;
10349
10350         /*
10351          * Non-ancient models have better DMI tagging, but very old models
10352          * don't.  tpacpi_is_fw_known() is a cheat to help in that case.
10353          */
10354         is_thinkpad = (thinkpad_id.model_str != NULL) ||
10355                       (thinkpad_id.ec_model != 0) ||
10356                       tpacpi_is_fw_known();
10357
10358         /* The EC handler is required */
10359         tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
10360         if (!ec_handle) {
10361                 if (is_thinkpad)
10362                         pr_err("Not yet supported ThinkPad detected!\n");
10363                 return -ENODEV;
10364         }
10365
10366         if (!is_thinkpad && !force_load)
10367                 return -ENODEV;
10368
10369         return 0;
10370 }
10371
10372 static void __init thinkpad_acpi_init_banner(void)
10373 {
10374         pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
10375         pr_info("%s\n", TPACPI_URL);
10376
10377         pr_info("ThinkPad BIOS %s, EC %s\n",
10378                 (thinkpad_id.bios_version_str) ?
10379                         thinkpad_id.bios_version_str : "unknown",
10380                 (thinkpad_id.ec_version_str) ?
10381                         thinkpad_id.ec_version_str : "unknown");
10382
10383         BUG_ON(!thinkpad_id.vendor);
10384
10385         if (thinkpad_id.model_str)
10386                 pr_info("%s %s, model %s\n",
10387                         (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
10388                                 "IBM" : ((thinkpad_id.vendor ==
10389                                                 PCI_VENDOR_ID_LENOVO) ?
10390                                         "Lenovo" : "Unknown vendor"),
10391                         thinkpad_id.model_str,
10392                         (thinkpad_id.nummodel_str) ?
10393                                 thinkpad_id.nummodel_str : "unknown");
10394 }
10395
10396 /* Module init, exit, parameters */
10397
10398 static struct ibm_init_struct ibms_init[] __initdata = {
10399         {
10400                 .data = &thinkpad_acpi_driver_data,
10401         },
10402         {
10403                 .init = hotkey_init,
10404                 .data = &hotkey_driver_data,
10405         },
10406         {
10407                 .init = bluetooth_init,
10408                 .data = &bluetooth_driver_data,
10409         },
10410         {
10411                 .init = wan_init,
10412                 .data = &wan_driver_data,
10413         },
10414         {
10415                 .init = uwb_init,
10416                 .data = &uwb_driver_data,
10417         },
10418 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
10419         {
10420                 .init = video_init,
10421                 .base_procfs_mode = S_IRUSR,
10422                 .data = &video_driver_data,
10423         },
10424 #endif
10425         {
10426                 .init = kbdlight_init,
10427                 .data = &kbdlight_driver_data,
10428         },
10429         {
10430                 .init = light_init,
10431                 .data = &light_driver_data,
10432         },
10433         {
10434                 .init = cmos_init,
10435                 .data = &cmos_driver_data,
10436         },
10437         {
10438                 .init = led_init,
10439                 .data = &led_driver_data,
10440         },
10441         {
10442                 .init = beep_init,
10443                 .data = &beep_driver_data,
10444         },
10445         {
10446                 .init = thermal_init,
10447                 .data = &thermal_driver_data,
10448         },
10449         {
10450                 .init = brightness_init,
10451                 .data = &brightness_driver_data,
10452         },
10453         {
10454                 .init = volume_init,
10455                 .data = &volume_driver_data,
10456         },
10457         {
10458                 .init = fan_init,
10459                 .data = &fan_driver_data,
10460         },
10461         {
10462                 .init = mute_led_init,
10463                 .data = &mute_led_driver_data,
10464         },
10465         {
10466                 .init = tpacpi_battery_init,
10467                 .data = &battery_driver_data,
10468         },
10469         {
10470                 .init = tpacpi_lcdshadow_init,
10471                 .data = &lcdshadow_driver_data,
10472         },
10473         {
10474                 .init = tpacpi_proxsensor_init,
10475                 .data = &proxsensor_driver_data,
10476         },
10477 };
10478
10479 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
10480 {
10481         unsigned int i;
10482         struct ibm_struct *ibm;
10483
10484         if (!kp || !kp->name || !val)
10485                 return -EINVAL;
10486
10487         for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
10488                 ibm = ibms_init[i].data;
10489                 WARN_ON(ibm == NULL);
10490
10491                 if (!ibm || !ibm->name)
10492                         continue;
10493
10494                 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
10495                         if (strlen(val) > sizeof(ibms_init[i].param) - 1)
10496                                 return -ENOSPC;
10497                         strcpy(ibms_init[i].param, val);
10498                         return 0;
10499                 }
10500         }
10501
10502         return -EINVAL;
10503 }
10504
10505 module_param(experimental, int, 0444);
10506 MODULE_PARM_DESC(experimental,
10507                  "Enables experimental features when non-zero");
10508
10509 module_param_named(debug, dbg_level, uint, 0);
10510 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
10511
10512 module_param(force_load, bool, 0444);
10513 MODULE_PARM_DESC(force_load,
10514                  "Attempts to load the driver even on a mis-identified ThinkPad when true");
10515
10516 module_param_named(fan_control, fan_control_allowed, bool, 0444);
10517 MODULE_PARM_DESC(fan_control,
10518                  "Enables setting fan parameters features when true");
10519
10520 module_param_named(brightness_mode, brightness_mode, uint, 0444);
10521 MODULE_PARM_DESC(brightness_mode,
10522                  "Selects brightness control strategy: 0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
10523
10524 module_param(brightness_enable, uint, 0444);
10525 MODULE_PARM_DESC(brightness_enable,
10526                  "Enables backlight control when 1, disables when 0");
10527
10528 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
10529 module_param_named(volume_mode, volume_mode, uint, 0444);
10530 MODULE_PARM_DESC(volume_mode,
10531                  "Selects volume control strategy: 0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
10532
10533 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
10534 MODULE_PARM_DESC(volume_capabilities,
10535                  "Selects the mixer capabilities: 0=auto, 1=volume and mute, 2=mute only");
10536
10537 module_param_named(volume_control, volume_control_allowed, bool, 0444);
10538 MODULE_PARM_DESC(volume_control,
10539                  "Enables software override for the console audio control when true");
10540
10541 module_param_named(software_mute, software_mute_requested, bool, 0444);
10542 MODULE_PARM_DESC(software_mute,
10543                  "Request full software mute control");
10544
10545 /* ALSA module API parameters */
10546 module_param_named(index, alsa_index, int, 0444);
10547 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
10548 module_param_named(id, alsa_id, charp, 0444);
10549 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
10550 module_param_named(enable, alsa_enable, bool, 0444);
10551 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
10552 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
10553
10554 /* The module parameter can't be read back, that's why 0 is used here */
10555 #define TPACPI_PARAM(feature) \
10556         module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
10557         MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command at module load, see documentation")
10558
10559 TPACPI_PARAM(hotkey);
10560 TPACPI_PARAM(bluetooth);
10561 TPACPI_PARAM(video);
10562 TPACPI_PARAM(light);
10563 TPACPI_PARAM(cmos);
10564 TPACPI_PARAM(led);
10565 TPACPI_PARAM(beep);
10566 TPACPI_PARAM(brightness);
10567 TPACPI_PARAM(volume);
10568 TPACPI_PARAM(fan);
10569
10570 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10571 module_param(dbg_wlswemul, uint, 0444);
10572 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
10573 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
10574 MODULE_PARM_DESC(wlsw_state,
10575                  "Initial state of the emulated WLSW switch");
10576
10577 module_param(dbg_bluetoothemul, uint, 0444);
10578 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
10579 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
10580 MODULE_PARM_DESC(bluetooth_state,
10581                  "Initial state of the emulated bluetooth switch");
10582
10583 module_param(dbg_wwanemul, uint, 0444);
10584 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
10585 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
10586 MODULE_PARM_DESC(wwan_state,
10587                  "Initial state of the emulated WWAN switch");
10588
10589 module_param(dbg_uwbemul, uint, 0444);
10590 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
10591 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
10592 MODULE_PARM_DESC(uwb_state,
10593                  "Initial state of the emulated UWB switch");
10594 #endif
10595
10596 static void thinkpad_acpi_module_exit(void)
10597 {
10598         struct ibm_struct *ibm, *itmp;
10599
10600         tpacpi_lifecycle = TPACPI_LIFE_EXITING;
10601
10602         list_for_each_entry_safe_reverse(ibm, itmp,
10603                                          &tpacpi_all_drivers,
10604                                          all_drivers) {
10605                 ibm_exit(ibm);
10606         }
10607
10608         dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
10609
10610         if (tpacpi_inputdev) {
10611                 if (tp_features.input_device_registered)
10612                         input_unregister_device(tpacpi_inputdev);
10613                 else
10614                         input_free_device(tpacpi_inputdev);
10615                 kfree(hotkey_keycode_map);
10616         }
10617
10618         if (tpacpi_hwmon)
10619                 hwmon_device_unregister(tpacpi_hwmon);
10620
10621         if (tpacpi_sensors_pdev)
10622                 platform_device_unregister(tpacpi_sensors_pdev);
10623         if (tpacpi_pdev)
10624                 platform_device_unregister(tpacpi_pdev);
10625
10626         if (tp_features.sensors_pdrv_attrs_registered)
10627                 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
10628         if (tp_features.platform_drv_attrs_registered)
10629                 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
10630
10631         if (tp_features.sensors_pdrv_registered)
10632                 platform_driver_unregister(&tpacpi_hwmon_pdriver);
10633
10634         if (tp_features.platform_drv_registered)
10635                 platform_driver_unregister(&tpacpi_pdriver);
10636
10637         if (proc_dir)
10638                 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
10639
10640         if (tpacpi_wq)
10641                 destroy_workqueue(tpacpi_wq);
10642
10643         kfree(thinkpad_id.bios_version_str);
10644         kfree(thinkpad_id.ec_version_str);
10645         kfree(thinkpad_id.model_str);
10646         kfree(thinkpad_id.nummodel_str);
10647 }
10648
10649
10650 static int __init thinkpad_acpi_module_init(void)
10651 {
10652         int ret, i;
10653
10654         tpacpi_lifecycle = TPACPI_LIFE_INIT;
10655
10656         /* Driver-level probe */
10657
10658         ret = get_thinkpad_model_data(&thinkpad_id);
10659         if (ret) {
10660                 pr_err("unable to get DMI data: %d\n", ret);
10661                 thinkpad_acpi_module_exit();
10662                 return ret;
10663         }
10664         ret = probe_for_thinkpad();
10665         if (ret) {
10666                 thinkpad_acpi_module_exit();
10667                 return ret;
10668         }
10669
10670         /* Driver initialization */
10671
10672         thinkpad_acpi_init_banner();
10673         tpacpi_check_outdated_fw();
10674
10675         TPACPI_ACPIHANDLE_INIT(ecrd);
10676         TPACPI_ACPIHANDLE_INIT(ecwr);
10677
10678         tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
10679         if (!tpacpi_wq) {
10680                 thinkpad_acpi_module_exit();
10681                 return -ENOMEM;
10682         }
10683
10684         proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
10685         if (!proc_dir) {
10686                 pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
10687                 thinkpad_acpi_module_exit();
10688                 return -ENODEV;
10689         }
10690
10691         ret = platform_driver_register(&tpacpi_pdriver);
10692         if (ret) {
10693                 pr_err("unable to register main platform driver\n");
10694                 thinkpad_acpi_module_exit();
10695                 return ret;
10696         }
10697         tp_features.platform_drv_registered = 1;
10698
10699         ret = platform_driver_register(&tpacpi_hwmon_pdriver);
10700         if (ret) {
10701                 pr_err("unable to register hwmon platform driver\n");
10702                 thinkpad_acpi_module_exit();
10703                 return ret;
10704         }
10705         tp_features.sensors_pdrv_registered = 1;
10706
10707         ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
10708         if (!ret) {
10709                 tp_features.platform_drv_attrs_registered = 1;
10710                 ret = tpacpi_create_driver_attributes(
10711                                         &tpacpi_hwmon_pdriver.driver);
10712         }
10713         if (ret) {
10714                 pr_err("unable to create sysfs driver attributes\n");
10715                 thinkpad_acpi_module_exit();
10716                 return ret;
10717         }
10718         tp_features.sensors_pdrv_attrs_registered = 1;
10719
10720
10721         /* Device initialization */
10722         tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
10723                                                         NULL, 0);
10724         if (IS_ERR(tpacpi_pdev)) {
10725                 ret = PTR_ERR(tpacpi_pdev);
10726                 tpacpi_pdev = NULL;
10727                 pr_err("unable to register platform device\n");
10728                 thinkpad_acpi_module_exit();
10729                 return ret;
10730         }
10731         tpacpi_sensors_pdev = platform_device_register_simple(
10732                                                 TPACPI_HWMON_DRVR_NAME,
10733                                                 -1, NULL, 0);
10734         if (IS_ERR(tpacpi_sensors_pdev)) {
10735                 ret = PTR_ERR(tpacpi_sensors_pdev);
10736                 tpacpi_sensors_pdev = NULL;
10737                 pr_err("unable to register hwmon platform device\n");
10738                 thinkpad_acpi_module_exit();
10739                 return ret;
10740         }
10741         tp_features.sensors_pdev_attrs_registered = 1;
10742         tpacpi_hwmon = hwmon_device_register_with_groups(
10743                 &tpacpi_sensors_pdev->dev, TPACPI_NAME, NULL, NULL);
10744
10745         if (IS_ERR(tpacpi_hwmon)) {
10746                 ret = PTR_ERR(tpacpi_hwmon);
10747                 tpacpi_hwmon = NULL;
10748                 pr_err("unable to register hwmon device\n");
10749                 thinkpad_acpi_module_exit();
10750                 return ret;
10751         }
10752         mutex_init(&tpacpi_inputdev_send_mutex);
10753         tpacpi_inputdev = input_allocate_device();
10754         if (!tpacpi_inputdev) {
10755                 thinkpad_acpi_module_exit();
10756                 return -ENOMEM;
10757         } else {
10758                 /* Prepare input device, but don't register */
10759                 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
10760                 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
10761                 tpacpi_inputdev->id.bustype = BUS_HOST;
10762                 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
10763                 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
10764                 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
10765                 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
10766         }
10767
10768         /* Init subdriver dependencies */
10769         tpacpi_detect_brightness_capabilities();
10770
10771         /* Init subdrivers */
10772         for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
10773                 ret = ibm_init(&ibms_init[i]);
10774                 if (ret >= 0 && *ibms_init[i].param)
10775                         ret = ibms_init[i].data->write(ibms_init[i].param);
10776                 if (ret < 0) {
10777                         thinkpad_acpi_module_exit();
10778                         return ret;
10779                 }
10780         }
10781
10782         tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
10783
10784         ret = input_register_device(tpacpi_inputdev);
10785         if (ret < 0) {
10786                 pr_err("unable to register input device\n");
10787                 thinkpad_acpi_module_exit();
10788                 return ret;
10789         } else {
10790                 tp_features.input_device_registered = 1;
10791         }
10792
10793         return 0;
10794 }
10795
10796 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
10797
10798 /*
10799  * This will autoload the driver in almost every ThinkPad
10800  * in widespread use.
10801  *
10802  * Only _VERY_ old models, like the 240, 240x and 570 lack
10803  * the HKEY event interface.
10804  */
10805 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
10806
10807 /*
10808  * DMI matching for module autoloading
10809  *
10810  * See https://thinkwiki.org/wiki/List_of_DMI_IDs
10811  * See https://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
10812  *
10813  * Only models listed in thinkwiki will be supported, so add yours
10814  * if it is not there yet.
10815  */
10816 #define IBM_BIOS_MODULE_ALIAS(__type) \
10817         MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
10818
10819 /* Ancient thinkpad BIOSes have to be identified by
10820  * BIOS type or model number, and there are far less
10821  * BIOS types than model numbers... */
10822 IBM_BIOS_MODULE_ALIAS("I[MU]");         /* 570, 570e */
10823
10824 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
10825 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
10826 MODULE_DESCRIPTION(TPACPI_DESC);
10827 MODULE_VERSION(TPACPI_VERSION);
10828 MODULE_LICENSE("GPL");
10829
10830 module_init(thinkpad_acpi_module_init);
10831 module_exit(thinkpad_acpi_module_exit);