drivers/platform/x86/thinkpad_acpi.c

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