SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/platform/x86/thinkpad_acpi.c

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