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