drivers/platform/x86/thinkpad_acpi.c

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