drivers/platform/x86/thinkpad_acpi.c

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