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