drivers/platform/x86/thinkpad_acpi.c

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