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