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