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