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