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