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