Linux Audio

Check our new training course

Loading...
v3.1
   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 pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  25
  26#define TPACPI_VERSION "0.24"
  27#define TPACPI_SYSFS_VERSION 0x020700
  28
  29/*
  30 *  Changelog:
  31 *  2007-10-20		changelog trimmed down
  32 *
  33 *  2007-03-27  0.14	renamed to thinkpad_acpi and moved to
  34 *  			drivers/misc.
  35 *
  36 *  2006-11-22	0.13	new maintainer
  37 *  			changelog now lives in git commit history, and will
  38 *  			not be updated further in-file.
  39 *
  40 *  2005-03-17	0.11	support for 600e, 770x
  41 *			    thanks to Jamie Lentin <lentinj@dial.pipex.com>
  42 *
  43 *  2005-01-16	0.9	use MODULE_VERSION
  44 *			    thanks to Henrik Brix Andersen <brix@gentoo.org>
  45 *			fix parameter passing on module loading
  46 *			    thanks to Rusty Russell <rusty@rustcorp.com.au>
  47 *			    thanks to Jim Radford <radford@blackbean.org>
  48 *  2004-11-08	0.8	fix init error case, don't return from a macro
  49 *			    thanks to Chris Wright <chrisw@osdl.org>
  50 */
  51
  52#include <linux/kernel.h>
  53#include <linux/module.h>
  54#include <linux/init.h>
  55#include <linux/types.h>
  56#include <linux/string.h>
  57#include <linux/list.h>
  58#include <linux/mutex.h>
  59#include <linux/sched.h>
  60#include <linux/kthread.h>
  61#include <linux/freezer.h>
  62#include <linux/delay.h>
  63#include <linux/slab.h>
  64
  65#include <linux/nvram.h>
  66#include <linux/proc_fs.h>
  67#include <linux/seq_file.h>
  68#include <linux/sysfs.h>
  69#include <linux/backlight.h>
  70#include <linux/fb.h>
  71#include <linux/platform_device.h>
  72#include <linux/hwmon.h>
  73#include <linux/hwmon-sysfs.h>
  74#include <linux/input.h>
  75#include <linux/leds.h>
  76#include <linux/rfkill.h>
  77#include <asm/uaccess.h>
  78
  79#include <linux/dmi.h>
  80#include <linux/jiffies.h>
  81#include <linux/workqueue.h>
  82
 
 
  83#include <sound/core.h>
  84#include <sound/control.h>
  85#include <sound/initval.h>
  86
  87#include <acpi/acpi_drivers.h>
  88
  89#include <linux/pci_ids.h>
  90
  91
  92/* ThinkPad CMOS commands */
  93#define TP_CMOS_VOLUME_DOWN	0
  94#define TP_CMOS_VOLUME_UP	1
  95#define TP_CMOS_VOLUME_MUTE	2
  96#define TP_CMOS_BRIGHTNESS_UP	4
  97#define TP_CMOS_BRIGHTNESS_DOWN	5
  98#define TP_CMOS_THINKLIGHT_ON	12
  99#define TP_CMOS_THINKLIGHT_OFF	13
 100
 101/* NVRAM Addresses */
 102enum tp_nvram_addr {
 103	TP_NVRAM_ADDR_HK2		= 0x57,
 104	TP_NVRAM_ADDR_THINKLIGHT	= 0x58,
 105	TP_NVRAM_ADDR_VIDEO		= 0x59,
 106	TP_NVRAM_ADDR_BRIGHTNESS	= 0x5e,
 107	TP_NVRAM_ADDR_MIXER		= 0x60,
 108};
 109
 110/* NVRAM bit masks */
 111enum {
 112	TP_NVRAM_MASK_HKT_THINKPAD	= 0x08,
 113	TP_NVRAM_MASK_HKT_ZOOM		= 0x20,
 114	TP_NVRAM_MASK_HKT_DISPLAY	= 0x40,
 115	TP_NVRAM_MASK_HKT_HIBERNATE	= 0x80,
 116	TP_NVRAM_MASK_THINKLIGHT	= 0x10,
 117	TP_NVRAM_MASK_HKT_DISPEXPND	= 0x30,
 118	TP_NVRAM_MASK_HKT_BRIGHTNESS	= 0x20,
 119	TP_NVRAM_MASK_LEVEL_BRIGHTNESS	= 0x0f,
 120	TP_NVRAM_POS_LEVEL_BRIGHTNESS	= 0,
 121	TP_NVRAM_MASK_MUTE		= 0x40,
 122	TP_NVRAM_MASK_HKT_VOLUME	= 0x80,
 123	TP_NVRAM_MASK_LEVEL_VOLUME	= 0x0f,
 124	TP_NVRAM_POS_LEVEL_VOLUME	= 0,
 125};
 126
 127/* Misc NVRAM-related */
 128enum {
 129	TP_NVRAM_LEVEL_VOLUME_MAX = 14,
 130};
 131
 132/* ACPI HIDs */
 133#define TPACPI_ACPI_IBM_HKEY_HID	"IBM0068"
 134#define TPACPI_ACPI_LENOVO_HKEY_HID	"LEN0068"
 135#define TPACPI_ACPI_EC_HID		"PNP0C09"
 136
 137/* Input IDs */
 138#define TPACPI_HKEY_INPUT_PRODUCT	0x5054 /* "TP" */
 139#define TPACPI_HKEY_INPUT_VERSION	0x4101
 140
 141/* ACPI \WGSV commands */
 142enum {
 143	TP_ACPI_WGSV_GET_STATE		= 0x01, /* Get state information */
 144	TP_ACPI_WGSV_PWR_ON_ON_RESUME	= 0x02, /* Resume WWAN powered on */
 145	TP_ACPI_WGSV_PWR_OFF_ON_RESUME	= 0x03,	/* Resume WWAN powered off */
 146	TP_ACPI_WGSV_SAVE_STATE		= 0x04, /* Save state for S4/S5 */
 147};
 148
 149/* TP_ACPI_WGSV_GET_STATE bits */
 150enum {
 151	TP_ACPI_WGSV_STATE_WWANEXIST	= 0x0001, /* WWAN hw available */
 152	TP_ACPI_WGSV_STATE_WWANPWR	= 0x0002, /* WWAN radio enabled */
 153	TP_ACPI_WGSV_STATE_WWANPWRRES	= 0x0004, /* WWAN state at resume */
 154	TP_ACPI_WGSV_STATE_WWANBIOSOFF	= 0x0008, /* WWAN disabled in BIOS */
 155	TP_ACPI_WGSV_STATE_BLTHEXIST	= 0x0001, /* BLTH hw available */
 156	TP_ACPI_WGSV_STATE_BLTHPWR	= 0x0002, /* BLTH radio enabled */
 157	TP_ACPI_WGSV_STATE_BLTHPWRRES	= 0x0004, /* BLTH state at resume */
 158	TP_ACPI_WGSV_STATE_BLTHBIOSOFF	= 0x0008, /* BLTH disabled in BIOS */
 159	TP_ACPI_WGSV_STATE_UWBEXIST	= 0x0010, /* UWB hw available */
 160	TP_ACPI_WGSV_STATE_UWBPWR	= 0x0020, /* UWB radio enabled */
 161};
 162
 163/* HKEY events */
 164enum tpacpi_hkey_event_t {
 165	/* Hotkey-related */
 166	TP_HKEY_EV_HOTKEY_BASE		= 0x1001, /* first hotkey (FN+F1) */
 167	TP_HKEY_EV_BRGHT_UP		= 0x1010, /* Brightness up */
 168	TP_HKEY_EV_BRGHT_DOWN		= 0x1011, /* Brightness down */
 169	TP_HKEY_EV_VOL_UP		= 0x1015, /* Volume up or unmute */
 170	TP_HKEY_EV_VOL_DOWN		= 0x1016, /* Volume down or unmute */
 171	TP_HKEY_EV_VOL_MUTE		= 0x1017, /* Mixer output mute */
 172
 173	/* Reasons for waking up from S3/S4 */
 174	TP_HKEY_EV_WKUP_S3_UNDOCK	= 0x2304, /* undock requested, S3 */
 175	TP_HKEY_EV_WKUP_S4_UNDOCK	= 0x2404, /* undock requested, S4 */
 176	TP_HKEY_EV_WKUP_S3_BAYEJ	= 0x2305, /* bay ejection req, S3 */
 177	TP_HKEY_EV_WKUP_S4_BAYEJ	= 0x2405, /* bay ejection req, S4 */
 178	TP_HKEY_EV_WKUP_S3_BATLOW	= 0x2313, /* battery empty, S3 */
 179	TP_HKEY_EV_WKUP_S4_BATLOW	= 0x2413, /* battery empty, S4 */
 180
 181	/* Auto-sleep after eject request */
 182	TP_HKEY_EV_BAYEJ_ACK		= 0x3003, /* bay ejection complete */
 183	TP_HKEY_EV_UNDOCK_ACK		= 0x4003, /* undock complete */
 184
 185	/* Misc bay events */
 186	TP_HKEY_EV_OPTDRV_EJ		= 0x3006, /* opt. drive tray ejected */
 187	TP_HKEY_EV_HOTPLUG_DOCK		= 0x4010, /* docked into hotplug dock
 188						     or port replicator */
 189	TP_HKEY_EV_HOTPLUG_UNDOCK	= 0x4011, /* undocked from hotplug
 190						     dock or port replicator */
 191
 192	/* User-interface events */
 193	TP_HKEY_EV_LID_CLOSE		= 0x5001, /* laptop lid closed */
 194	TP_HKEY_EV_LID_OPEN		= 0x5002, /* laptop lid opened */
 195	TP_HKEY_EV_TABLET_TABLET	= 0x5009, /* tablet swivel up */
 196	TP_HKEY_EV_TABLET_NOTEBOOK	= 0x500a, /* tablet swivel down */
 197	TP_HKEY_EV_PEN_INSERTED		= 0x500b, /* tablet pen inserted */
 198	TP_HKEY_EV_PEN_REMOVED		= 0x500c, /* tablet pen removed */
 199	TP_HKEY_EV_BRGHT_CHANGED	= 0x5010, /* backlight control event */
 200
 201	/* Key-related user-interface events */
 202	TP_HKEY_EV_KEY_NUMLOCK		= 0x6000, /* NumLock key pressed */
 203	TP_HKEY_EV_KEY_FN		= 0x6005, /* Fn key pressed? E420 */
 204
 205	/* Thermal events */
 206	TP_HKEY_EV_ALARM_BAT_HOT	= 0x6011, /* battery too hot */
 207	TP_HKEY_EV_ALARM_BAT_XHOT	= 0x6012, /* battery critically hot */
 208	TP_HKEY_EV_ALARM_SENSOR_HOT	= 0x6021, /* sensor too hot */
 209	TP_HKEY_EV_ALARM_SENSOR_XHOT	= 0x6022, /* sensor critically hot */
 210	TP_HKEY_EV_THM_TABLE_CHANGED	= 0x6030, /* thermal table changed */
 211
 212	TP_HKEY_EV_UNK_6040		= 0x6040, /* Related to AC change?
 213						     some sort of APM hint,
 214						     W520 */
 215
 216	/* Misc */
 217	TP_HKEY_EV_RFKILL_CHANGED	= 0x7000, /* rfkill switch changed */
 218};
 219
 220/****************************************************************************
 221 * Main driver
 222 */
 223
 224#define TPACPI_NAME "thinkpad"
 225#define TPACPI_DESC "ThinkPad ACPI Extras"
 226#define TPACPI_FILE TPACPI_NAME "_acpi"
 227#define TPACPI_URL "http://ibm-acpi.sf.net/"
 228#define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
 229
 230#define TPACPI_PROC_DIR "ibm"
 231#define TPACPI_ACPI_EVENT_PREFIX "ibm"
 232#define TPACPI_DRVR_NAME TPACPI_FILE
 233#define TPACPI_DRVR_SHORTNAME "tpacpi"
 234#define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
 235
 236#define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
 237#define TPACPI_WORKQUEUE_NAME "ktpacpid"
 238
 239#define TPACPI_MAX_ACPI_ARGS 3
 240
 241/* Debugging printk groups */
 242#define TPACPI_DBG_ALL		0xffff
 243#define TPACPI_DBG_DISCLOSETASK	0x8000
 244#define TPACPI_DBG_INIT		0x0001
 245#define TPACPI_DBG_EXIT		0x0002
 246#define TPACPI_DBG_RFKILL	0x0004
 247#define TPACPI_DBG_HKEY		0x0008
 248#define TPACPI_DBG_FAN		0x0010
 249#define TPACPI_DBG_BRGHT	0x0020
 250#define TPACPI_DBG_MIXER	0x0040
 251
 252#define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
 253#define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
 254#define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
 255
 256
 257/****************************************************************************
 258 * Driver-wide structs and misc. variables
 259 */
 260
 261struct ibm_struct;
 262
 263struct tp_acpi_drv_struct {
 264	const struct acpi_device_id *hid;
 265	struct acpi_driver *driver;
 266
 267	void (*notify) (struct ibm_struct *, u32);
 268	acpi_handle *handle;
 269	u32 type;
 270	struct acpi_device *device;
 271};
 272
 273struct ibm_struct {
 274	char *name;
 275
 276	int (*read) (struct seq_file *);
 277	int (*write) (char *);
 278	void (*exit) (void);
 279	void (*resume) (void);
 280	void (*suspend) (pm_message_t state);
 281	void (*shutdown) (void);
 282
 283	struct list_head all_drivers;
 284
 285	struct tp_acpi_drv_struct *acpi;
 286
 287	struct {
 288		u8 acpi_driver_registered:1;
 289		u8 acpi_notify_installed:1;
 290		u8 proc_created:1;
 291		u8 init_called:1;
 292		u8 experimental:1;
 293	} flags;
 294};
 295
 296struct ibm_init_struct {
 297	char param[32];
 298
 299	int (*init) (struct ibm_init_struct *);
 300	mode_t base_procfs_mode;
 301	struct ibm_struct *data;
 302};
 303
 304static struct {
 305	u32 bluetooth:1;
 306	u32 hotkey:1;
 307	u32 hotkey_mask:1;
 308	u32 hotkey_wlsw:1;
 309	u32 hotkey_tablet:1;
 310	u32 light:1;
 311	u32 light_status:1;
 312	u32 bright_acpimode:1;
 313	u32 bright_unkfw:1;
 314	u32 wan:1;
 315	u32 uwb:1;
 316	u32 fan_ctrl_status_undef:1;
 317	u32 second_fan:1;
 318	u32 beep_needs_two_args:1;
 319	u32 mixer_no_level_control:1;
 320	u32 input_device_registered:1;
 321	u32 platform_drv_registered:1;
 322	u32 platform_drv_attrs_registered:1;
 323	u32 sensors_pdrv_registered:1;
 324	u32 sensors_pdrv_attrs_registered:1;
 325	u32 sensors_pdev_attrs_registered:1;
 326	u32 hotkey_poll_active:1;
 327} tp_features;
 328
 329static struct {
 330	u16 hotkey_mask_ff:1;
 331	u16 volume_ctrl_forbidden:1;
 332} tp_warned;
 333
 334struct thinkpad_id_data {
 335	unsigned int vendor;	/* ThinkPad vendor:
 336				 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
 337
 338	char *bios_version_str;	/* Something like 1ZET51WW (1.03z) */
 339	char *ec_version_str;	/* Something like 1ZHT51WW-1.04a */
 340
 341	u16 bios_model;		/* 1Y = 0x5931, 0 = unknown */
 342	u16 ec_model;
 343	u16 bios_release;	/* 1ZETK1WW = 0x314b, 0 = unknown */
 344	u16 ec_release;
 345
 346	char *model_str;	/* ThinkPad T43 */
 347	char *nummodel_str;	/* 9384A9C for a 9384-A9C model */
 348};
 349static struct thinkpad_id_data thinkpad_id;
 350
 351static enum {
 352	TPACPI_LIFE_INIT = 0,
 353	TPACPI_LIFE_RUNNING,
 354	TPACPI_LIFE_EXITING,
 355} tpacpi_lifecycle;
 356
 357static int experimental;
 358static u32 dbg_level;
 359
 360static struct workqueue_struct *tpacpi_wq;
 361
 362enum led_status_t {
 363	TPACPI_LED_OFF = 0,
 364	TPACPI_LED_ON,
 365	TPACPI_LED_BLINK,
 366};
 367
 368/* Special LED class that can defer work */
 369struct tpacpi_led_classdev {
 370	struct led_classdev led_classdev;
 371	struct work_struct work;
 372	enum led_status_t new_state;
 373	unsigned int led;
 374};
 375
 376/* brightness level capabilities */
 377static unsigned int bright_maxlvl;	/* 0 = unknown */
 378
 379#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
 380static int dbg_wlswemul;
 381static int tpacpi_wlsw_emulstate;
 382static int dbg_bluetoothemul;
 383static int tpacpi_bluetooth_emulstate;
 384static int dbg_wwanemul;
 385static int tpacpi_wwan_emulstate;
 386static int dbg_uwbemul;
 387static int tpacpi_uwb_emulstate;
 388#endif
 389
 390
 391/*************************************************************************
 392 *  Debugging helpers
 393 */
 394
 395#define dbg_printk(a_dbg_level, format, arg...)				\
 396do {									\
 397	if (dbg_level & (a_dbg_level))					\
 398		printk(KERN_DEBUG pr_fmt("%s: " format),		\
 399		       __func__, ##arg);				\
 400} while (0)
 401
 402#ifdef CONFIG_THINKPAD_ACPI_DEBUG
 403#define vdbg_printk dbg_printk
 404static const char *str_supported(int is_supported);
 405#else
 406static inline const char *str_supported(int is_supported) { return ""; }
 407#define vdbg_printk(a_dbg_level, format, arg...)	\
 408	no_printk(format, ##arg)
 409#endif
 410
 411static void tpacpi_log_usertask(const char * const what)
 412{
 413	printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
 414	       what, task_tgid_vnr(current));
 415}
 416
 417#define tpacpi_disclose_usertask(what, format, arg...)			\
 418do {									\
 419	if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) &&		\
 420		     (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) {	\
 421		printk(KERN_DEBUG pr_fmt("%s: PID %d: " format),	\
 422		       what, task_tgid_vnr(current), ## arg);		\
 423	}								\
 424} while (0)
 425
 426/*
 427 * Quirk handling helpers
 428 *
 429 * ThinkPad IDs and versions seen in the field so far
 430 * are two-characters from the set [0-9A-Z], i.e. base 36.
 431 *
 432 * We use values well outside that range as specials.
 433 */
 434
 435#define TPACPI_MATCH_ANY		0xffffU
 436#define TPACPI_MATCH_UNKNOWN		0U
 437
 438/* TPID('1', 'Y') == 0x5931 */
 439#define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
 440
 441#define TPACPI_Q_IBM(__id1, __id2, __quirk)	\
 442	{ .vendor = PCI_VENDOR_ID_IBM,		\
 443	  .bios = TPID(__id1, __id2),		\
 444	  .ec = TPACPI_MATCH_ANY,		\
 445	  .quirks = (__quirk) }
 446
 447#define TPACPI_Q_LNV(__id1, __id2, __quirk)	\
 448	{ .vendor = PCI_VENDOR_ID_LENOVO,	\
 449	  .bios = TPID(__id1, __id2),		\
 450	  .ec = TPACPI_MATCH_ANY,		\
 451	  .quirks = (__quirk) }
 452
 453#define TPACPI_QEC_LNV(__id1, __id2, __quirk)	\
 454	{ .vendor = PCI_VENDOR_ID_LENOVO,	\
 455	  .bios = TPACPI_MATCH_ANY,		\
 456	  .ec = TPID(__id1, __id2),		\
 457	  .quirks = (__quirk) }
 458
 459struct tpacpi_quirk {
 460	unsigned int vendor;
 461	u16 bios;
 462	u16 ec;
 463	unsigned long quirks;
 464};
 465
 466/**
 467 * tpacpi_check_quirks() - search BIOS/EC version on a list
 468 * @qlist:		array of &struct tpacpi_quirk
 469 * @qlist_size:		number of elements in @qlist
 470 *
 471 * Iterates over a quirks list until one is found that matches the
 472 * ThinkPad's vendor, BIOS and EC model.
 473 *
 474 * Returns 0 if nothing matches, otherwise returns the quirks field of
 475 * the matching &struct tpacpi_quirk entry.
 476 *
 477 * The match criteria is: vendor, ec and bios much match.
 478 */
 479static unsigned long __init tpacpi_check_quirks(
 480			const struct tpacpi_quirk *qlist,
 481			unsigned int qlist_size)
 482{
 483	while (qlist_size) {
 484		if ((qlist->vendor == thinkpad_id.vendor ||
 485				qlist->vendor == TPACPI_MATCH_ANY) &&
 486		    (qlist->bios == thinkpad_id.bios_model ||
 487				qlist->bios == TPACPI_MATCH_ANY) &&
 488		    (qlist->ec == thinkpad_id.ec_model ||
 489				qlist->ec == TPACPI_MATCH_ANY))
 490			return qlist->quirks;
 491
 492		qlist_size--;
 493		qlist++;
 494	}
 495	return 0;
 496}
 497
 498static inline bool __pure __init tpacpi_is_lenovo(void)
 499{
 500	return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
 501}
 502
 503static inline bool __pure __init tpacpi_is_ibm(void)
 504{
 505	return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
 506}
 507
 508/****************************************************************************
 509 ****************************************************************************
 510 *
 511 * ACPI Helpers and device model
 512 *
 513 ****************************************************************************
 514 ****************************************************************************/
 515
 516/*************************************************************************
 517 * ACPI basic handles
 518 */
 519
 520static acpi_handle root_handle;
 521static acpi_handle ec_handle;
 522
 523#define TPACPI_HANDLE(object, parent, paths...)			\
 524	static acpi_handle  object##_handle;			\
 525	static const acpi_handle *object##_parent __initdata =	\
 526						&parent##_handle; \
 527	static char *object##_paths[] __initdata = { paths }
 528
 529TPACPI_HANDLE(ecrd, ec, "ECRD");	/* 570 */
 530TPACPI_HANDLE(ecwr, ec, "ECWR");	/* 570 */
 531
 532TPACPI_HANDLE(cmos, root, "\\UCMS",	/* R50, R50e, R50p, R51, */
 533					/* T4x, X31, X40 */
 534	   "\\CMOS",		/* A3x, G4x, R32, T23, T30, X22-24, X30 */
 535	   "\\CMS",		/* R40, R40e */
 536	   );			/* all others */
 537
 538TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY",	/* 600e/x, 770e, 770x */
 539	   "^HKEY",		/* R30, R31 */
 540	   "HKEY",		/* all others */
 541	   );			/* 570 */
 542
 543/*************************************************************************
 544 * ACPI helpers
 545 */
 546
 547static int acpi_evalf(acpi_handle handle,
 548		      void *res, char *method, char *fmt, ...)
 549{
 550	char *fmt0 = fmt;
 551	struct acpi_object_list params;
 552	union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
 553	struct acpi_buffer result, *resultp;
 554	union acpi_object out_obj;
 555	acpi_status status;
 556	va_list ap;
 557	char res_type;
 558	int success;
 559	int quiet;
 560
 561	if (!*fmt) {
 562		pr_err("acpi_evalf() called with empty format\n");
 563		return 0;
 564	}
 565
 566	if (*fmt == 'q') {
 567		quiet = 1;
 568		fmt++;
 569	} else
 570		quiet = 0;
 571
 572	res_type = *(fmt++);
 573
 574	params.count = 0;
 575	params.pointer = &in_objs[0];
 576
 577	va_start(ap, fmt);
 578	while (*fmt) {
 579		char c = *(fmt++);
 580		switch (c) {
 581		case 'd':	/* int */
 582			in_objs[params.count].integer.value = va_arg(ap, int);
 583			in_objs[params.count++].type = ACPI_TYPE_INTEGER;
 584			break;
 585			/* add more types as needed */
 586		default:
 587			pr_err("acpi_evalf() called "
 588			       "with invalid format character '%c'\n", c);
 589			va_end(ap);
 590			return 0;
 591		}
 592	}
 593	va_end(ap);
 594
 595	if (res_type != 'v') {
 596		result.length = sizeof(out_obj);
 597		result.pointer = &out_obj;
 598		resultp = &result;
 599	} else
 600		resultp = NULL;
 601
 602	status = acpi_evaluate_object(handle, method, &params, resultp);
 603
 604	switch (res_type) {
 605	case 'd':		/* int */
 606		success = (status == AE_OK &&
 607			   out_obj.type == ACPI_TYPE_INTEGER);
 608		if (success && res)
 609			*(int *)res = out_obj.integer.value;
 610		break;
 611	case 'v':		/* void */
 612		success = status == AE_OK;
 613		break;
 614		/* add more types as needed */
 615	default:
 616		pr_err("acpi_evalf() called "
 617		       "with invalid format character '%c'\n", res_type);
 618		return 0;
 619	}
 620
 621	if (!success && !quiet)
 622		pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
 623		       method, fmt0, acpi_format_exception(status));
 624
 625	return success;
 626}
 627
 628static int acpi_ec_read(int i, u8 *p)
 629{
 630	int v;
 631
 632	if (ecrd_handle) {
 633		if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
 634			return 0;
 635		*p = v;
 636	} else {
 637		if (ec_read(i, p) < 0)
 638			return 0;
 639	}
 640
 641	return 1;
 642}
 643
 644static int acpi_ec_write(int i, u8 v)
 645{
 646	if (ecwr_handle) {
 647		if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
 648			return 0;
 649	} else {
 650		if (ec_write(i, v) < 0)
 651			return 0;
 652	}
 653
 654	return 1;
 655}
 656
 657static int issue_thinkpad_cmos_command(int cmos_cmd)
 658{
 659	if (!cmos_handle)
 660		return -ENXIO;
 661
 662	if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
 663		return -EIO;
 664
 665	return 0;
 666}
 667
 668/*************************************************************************
 669 * ACPI device model
 670 */
 671
 672#define TPACPI_ACPIHANDLE_INIT(object) \
 673	drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
 674		object##_paths, ARRAY_SIZE(object##_paths))
 675
 676static void __init drv_acpi_handle_init(const char *name,
 677			   acpi_handle *handle, const acpi_handle parent,
 678			   char **paths, const int num_paths)
 679{
 680	int i;
 681	acpi_status status;
 682
 683	vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
 684		name);
 685
 686	for (i = 0; i < num_paths; i++) {
 687		status = acpi_get_handle(parent, paths[i], handle);
 688		if (ACPI_SUCCESS(status)) {
 689			dbg_printk(TPACPI_DBG_INIT,
 690				   "Found ACPI handle %s for %s\n",
 691				   paths[i], name);
 692			return;
 693		}
 694	}
 695
 696	vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
 697		    name);
 698	*handle = NULL;
 699}
 700
 701static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
 702			u32 level, void *context, void **return_value)
 703{
 
 
 
 
 
 
 
 
 704	*(acpi_handle *)return_value = handle;
 705
 706	return AE_CTRL_TERMINATE;
 707}
 708
 709static void __init tpacpi_acpi_handle_locate(const char *name,
 710		const char *hid,
 711		acpi_handle *handle)
 712{
 713	acpi_status status;
 714	acpi_handle device_found;
 715
 716	BUG_ON(!name || !hid || !handle);
 717	vdbg_printk(TPACPI_DBG_INIT,
 718			"trying to locate ACPI handle for %s, using HID %s\n",
 719			name, hid);
 720
 721	memset(&device_found, 0, sizeof(device_found));
 722	status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
 723				  (void *)name, &device_found);
 724
 725	*handle = NULL;
 726
 727	if (ACPI_SUCCESS(status)) {
 728		*handle = device_found;
 729		dbg_printk(TPACPI_DBG_INIT,
 730			   "Found ACPI handle for %s\n", name);
 731	} else {
 732		vdbg_printk(TPACPI_DBG_INIT,
 733			    "Could not locate an ACPI handle for %s: %s\n",
 734			    name, acpi_format_exception(status));
 735	}
 736}
 737
 738static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
 739{
 740	struct ibm_struct *ibm = data;
 741
 742	if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
 743		return;
 744
 745	if (!ibm || !ibm->acpi || !ibm->acpi->notify)
 746		return;
 747
 748	ibm->acpi->notify(ibm, event);
 749}
 750
 751static int __init setup_acpi_notify(struct ibm_struct *ibm)
 752{
 753	acpi_status status;
 754	int rc;
 755
 756	BUG_ON(!ibm->acpi);
 757
 758	if (!*ibm->acpi->handle)
 759		return 0;
 760
 761	vdbg_printk(TPACPI_DBG_INIT,
 762		"setting up ACPI notify for %s\n", ibm->name);
 763
 764	rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
 765	if (rc < 0) {
 766		pr_err("acpi_bus_get_device(%s) failed: %d\n", ibm->name, rc);
 767		return -ENODEV;
 768	}
 769
 770	ibm->acpi->device->driver_data = ibm;
 771	sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
 772		TPACPI_ACPI_EVENT_PREFIX,
 773		ibm->name);
 774
 775	status = acpi_install_notify_handler(*ibm->acpi->handle,
 776			ibm->acpi->type, dispatch_acpi_notify, ibm);
 777	if (ACPI_FAILURE(status)) {
 778		if (status == AE_ALREADY_EXISTS) {
 779			pr_notice("another device driver is already "
 780				  "handling %s events\n", ibm->name);
 781		} else {
 782			pr_err("acpi_install_notify_handler(%s) failed: %s\n",
 783			       ibm->name, acpi_format_exception(status));
 784		}
 785		return -ENODEV;
 786	}
 787	ibm->flags.acpi_notify_installed = 1;
 788	return 0;
 789}
 790
 791static int __init tpacpi_device_add(struct acpi_device *device)
 792{
 793	return 0;
 794}
 795
 796static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
 797{
 798	int rc;
 799
 800	dbg_printk(TPACPI_DBG_INIT,
 801		"registering %s as an ACPI driver\n", ibm->name);
 802
 803	BUG_ON(!ibm->acpi);
 804
 805	ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
 806	if (!ibm->acpi->driver) {
 807		pr_err("failed to allocate memory for ibm->acpi->driver\n");
 808		return -ENOMEM;
 809	}
 810
 811	sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
 812	ibm->acpi->driver->ids = ibm->acpi->hid;
 813
 814	ibm->acpi->driver->ops.add = &tpacpi_device_add;
 815
 816	rc = acpi_bus_register_driver(ibm->acpi->driver);
 817	if (rc < 0) {
 818		pr_err("acpi_bus_register_driver(%s) failed: %d\n",
 819		       ibm->name, rc);
 820		kfree(ibm->acpi->driver);
 821		ibm->acpi->driver = NULL;
 822	} else if (!rc)
 823		ibm->flags.acpi_driver_registered = 1;
 824
 825	return rc;
 826}
 827
 828
 829/****************************************************************************
 830 ****************************************************************************
 831 *
 832 * Procfs Helpers
 833 *
 834 ****************************************************************************
 835 ****************************************************************************/
 836
 837static int dispatch_proc_show(struct seq_file *m, void *v)
 838{
 839	struct ibm_struct *ibm = m->private;
 840
 841	if (!ibm || !ibm->read)
 842		return -EINVAL;
 843	return ibm->read(m);
 844}
 845
 846static int dispatch_proc_open(struct inode *inode, struct file *file)
 847{
 848	return single_open(file, dispatch_proc_show, PDE(inode)->data);
 849}
 850
 851static ssize_t dispatch_proc_write(struct file *file,
 852			const char __user *userbuf,
 853			size_t count, loff_t *pos)
 854{
 855	struct ibm_struct *ibm = PDE(file->f_path.dentry->d_inode)->data;
 856	char *kernbuf;
 857	int ret;
 858
 859	if (!ibm || !ibm->write)
 860		return -EINVAL;
 861	if (count > PAGE_SIZE - 2)
 862		return -EINVAL;
 863
 864	kernbuf = kmalloc(count + 2, GFP_KERNEL);
 865	if (!kernbuf)
 866		return -ENOMEM;
 867
 868	if (copy_from_user(kernbuf, userbuf, count)) {
 869		kfree(kernbuf);
 870		return -EFAULT;
 871	}
 872
 873	kernbuf[count] = 0;
 874	strcat(kernbuf, ",");
 875	ret = ibm->write(kernbuf);
 876	if (ret == 0)
 877		ret = count;
 878
 879	kfree(kernbuf);
 880
 881	return ret;
 882}
 883
 884static const struct file_operations dispatch_proc_fops = {
 885	.owner		= THIS_MODULE,
 886	.open		= dispatch_proc_open,
 887	.read		= seq_read,
 888	.llseek		= seq_lseek,
 889	.release	= single_release,
 890	.write		= dispatch_proc_write,
 891};
 892
 893static char *next_cmd(char **cmds)
 894{
 895	char *start = *cmds;
 896	char *end;
 897
 898	while ((end = strchr(start, ',')) && end == start)
 899		start = end + 1;
 900
 901	if (!end)
 902		return NULL;
 903
 904	*end = 0;
 905	*cmds = end + 1;
 906	return start;
 907}
 908
 909
 910/****************************************************************************
 911 ****************************************************************************
 912 *
 913 * Device model: input, hwmon and platform
 914 *
 915 ****************************************************************************
 916 ****************************************************************************/
 917
 918static struct platform_device *tpacpi_pdev;
 919static struct platform_device *tpacpi_sensors_pdev;
 920static struct device *tpacpi_hwmon;
 921static struct input_dev *tpacpi_inputdev;
 922static struct mutex tpacpi_inputdev_send_mutex;
 923static LIST_HEAD(tpacpi_all_drivers);
 924
 925static int tpacpi_suspend_handler(struct platform_device *pdev,
 926				  pm_message_t state)
 927{
 928	struct ibm_struct *ibm, *itmp;
 929
 930	list_for_each_entry_safe(ibm, itmp,
 931				 &tpacpi_all_drivers,
 932				 all_drivers) {
 933		if (ibm->suspend)
 934			(ibm->suspend)(state);
 935	}
 936
 937	return 0;
 938}
 939
 940static int tpacpi_resume_handler(struct platform_device *pdev)
 941{
 942	struct ibm_struct *ibm, *itmp;
 943
 944	list_for_each_entry_safe(ibm, itmp,
 945				 &tpacpi_all_drivers,
 946				 all_drivers) {
 947		if (ibm->resume)
 948			(ibm->resume)();
 949	}
 950
 951	return 0;
 952}
 
 
 
 
 953
 954static void tpacpi_shutdown_handler(struct platform_device *pdev)
 955{
 956	struct ibm_struct *ibm, *itmp;
 957
 958	list_for_each_entry_safe(ibm, itmp,
 959				 &tpacpi_all_drivers,
 960				 all_drivers) {
 961		if (ibm->shutdown)
 962			(ibm->shutdown)();
 963	}
 964}
 965
 966static struct platform_driver tpacpi_pdriver = {
 967	.driver = {
 968		.name = TPACPI_DRVR_NAME,
 969		.owner = THIS_MODULE,
 
 970	},
 971	.suspend = tpacpi_suspend_handler,
 972	.resume = tpacpi_resume_handler,
 973	.shutdown = tpacpi_shutdown_handler,
 974};
 975
 976static struct platform_driver tpacpi_hwmon_pdriver = {
 977	.driver = {
 978		.name = TPACPI_HWMON_DRVR_NAME,
 979		.owner = THIS_MODULE,
 980	},
 981};
 982
 983/*************************************************************************
 984 * sysfs support helpers
 985 */
 986
 987struct attribute_set {
 988	unsigned int members, max_members;
 989	struct attribute_group group;
 990};
 991
 992struct attribute_set_obj {
 993	struct attribute_set s;
 994	struct attribute *a;
 995} __attribute__((packed));
 996
 997static struct attribute_set *create_attr_set(unsigned int max_members,
 998						const char *name)
 999{
1000	struct attribute_set_obj *sobj;
1001
1002	if (max_members == 0)
1003		return NULL;
1004
1005	/* Allocates space for implicit NULL at the end too */
1006	sobj = kzalloc(sizeof(struct attribute_set_obj) +
1007		    max_members * sizeof(struct attribute *),
1008		    GFP_KERNEL);
1009	if (!sobj)
1010		return NULL;
1011	sobj->s.max_members = max_members;
1012	sobj->s.group.attrs = &sobj->a;
1013	sobj->s.group.name = name;
1014
1015	return &sobj->s;
1016}
1017
1018#define destroy_attr_set(_set) \
1019	kfree(_set);
1020
1021/* not multi-threaded safe, use it in a single thread per set */
1022static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1023{
1024	if (!s || !attr)
1025		return -EINVAL;
1026
1027	if (s->members >= s->max_members)
1028		return -ENOMEM;
1029
1030	s->group.attrs[s->members] = attr;
1031	s->members++;
1032
1033	return 0;
1034}
1035
1036static int add_many_to_attr_set(struct attribute_set *s,
1037			struct attribute **attr,
1038			unsigned int count)
1039{
1040	int i, res;
1041
1042	for (i = 0; i < count; i++) {
1043		res = add_to_attr_set(s, attr[i]);
1044		if (res)
1045			return res;
1046	}
1047
1048	return 0;
1049}
1050
1051static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1052{
1053	sysfs_remove_group(kobj, &s->group);
1054	destroy_attr_set(s);
1055}
1056
1057#define register_attr_set_with_sysfs(_attr_set, _kobj) \
1058	sysfs_create_group(_kobj, &_attr_set->group)
1059
1060static int parse_strtoul(const char *buf,
1061		unsigned long max, unsigned long *value)
1062{
1063	char *endp;
1064
1065	*value = simple_strtoul(skip_spaces(buf), &endp, 0);
1066	endp = skip_spaces(endp);
1067	if (*endp || *value > max)
1068		return -EINVAL;
1069
1070	return 0;
1071}
1072
1073static void tpacpi_disable_brightness_delay(void)
1074{
1075	if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1076		pr_notice("ACPI backlight control delay disabled\n");
1077}
1078
1079static void printk_deprecated_attribute(const char * const what,
1080					const char * const details)
1081{
1082	tpacpi_log_usertask("deprecated sysfs attribute");
1083	pr_warn("WARNING: sysfs attribute %s is deprecated and "
1084		"will be removed. %s\n",
1085		what, details);
1086}
1087
1088/*************************************************************************
1089 * rfkill and radio control support helpers
1090 */
1091
1092/*
1093 * ThinkPad-ACPI firmware handling model:
1094 *
1095 * WLSW (master wireless switch) is event-driven, and is common to all
1096 * firmware-controlled radios.  It cannot be controlled, just monitored,
1097 * as expected.  It overrides all radio state in firmware
1098 *
1099 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1100 * (TODO: verify how WLSW interacts with the returned radio state).
1101 *
1102 * The only time there are shadow radio state changes, is when
1103 * masked-off hotkeys are used.
1104 */
1105
1106/*
1107 * Internal driver API for radio state:
1108 *
1109 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1110 * bool: true means radio blocked (off)
1111 */
1112enum tpacpi_rfkill_state {
1113	TPACPI_RFK_RADIO_OFF = 0,
1114	TPACPI_RFK_RADIO_ON
1115};
1116
1117/* rfkill switches */
1118enum tpacpi_rfk_id {
1119	TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1120	TPACPI_RFK_WWAN_SW_ID,
1121	TPACPI_RFK_UWB_SW_ID,
1122	TPACPI_RFK_SW_MAX
1123};
1124
1125static const char *tpacpi_rfkill_names[] = {
1126	[TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1127	[TPACPI_RFK_WWAN_SW_ID] = "wwan",
1128	[TPACPI_RFK_UWB_SW_ID] = "uwb",
1129	[TPACPI_RFK_SW_MAX] = NULL
1130};
1131
1132/* ThinkPad-ACPI rfkill subdriver */
1133struct tpacpi_rfk {
1134	struct rfkill *rfkill;
1135	enum tpacpi_rfk_id id;
1136	const struct tpacpi_rfk_ops *ops;
1137};
1138
1139struct tpacpi_rfk_ops {
1140	/* firmware interface */
1141	int (*get_status)(void);
1142	int (*set_status)(const enum tpacpi_rfkill_state);
1143};
1144
1145static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1146
1147/* Query FW and update rfkill sw state for a given rfkill switch */
1148static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1149{
1150	int status;
1151
1152	if (!tp_rfk)
1153		return -ENODEV;
1154
1155	status = (tp_rfk->ops->get_status)();
1156	if (status < 0)
1157		return status;
1158
1159	rfkill_set_sw_state(tp_rfk->rfkill,
1160			    (status == TPACPI_RFK_RADIO_OFF));
1161
1162	return status;
1163}
1164
1165/* Query FW and update rfkill sw state for all rfkill switches */
1166static void tpacpi_rfk_update_swstate_all(void)
1167{
1168	unsigned int i;
1169
1170	for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1171		tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1172}
1173
1174/*
1175 * Sync the HW-blocking state of all rfkill switches,
1176 * do notice it causes the rfkill core to schedule uevents
1177 */
1178static void tpacpi_rfk_update_hwblock_state(bool blocked)
1179{
1180	unsigned int i;
1181	struct tpacpi_rfk *tp_rfk;
1182
1183	for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1184		tp_rfk = tpacpi_rfkill_switches[i];
1185		if (tp_rfk) {
1186			if (rfkill_set_hw_state(tp_rfk->rfkill,
1187						blocked)) {
1188				/* ignore -- we track sw block */
1189			}
1190		}
1191	}
1192}
1193
1194/* Call to get the WLSW state from the firmware */
1195static int hotkey_get_wlsw(void);
1196
1197/* Call to query WLSW state and update all rfkill switches */
1198static bool tpacpi_rfk_check_hwblock_state(void)
1199{
1200	int res = hotkey_get_wlsw();
1201	int hw_blocked;
1202
1203	/* When unknown or unsupported, we have to assume it is unblocked */
1204	if (res < 0)
1205		return false;
1206
1207	hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1208	tpacpi_rfk_update_hwblock_state(hw_blocked);
1209
1210	return hw_blocked;
1211}
1212
1213static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1214{
1215	struct tpacpi_rfk *tp_rfk = data;
1216	int res;
1217
1218	dbg_printk(TPACPI_DBG_RFKILL,
1219		   "request to change radio state to %s\n",
1220		   blocked ? "blocked" : "unblocked");
1221
1222	/* try to set radio state */
1223	res = (tp_rfk->ops->set_status)(blocked ?
1224				TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1225
1226	/* and update the rfkill core with whatever the FW really did */
1227	tpacpi_rfk_update_swstate(tp_rfk);
1228
1229	return (res < 0) ? res : 0;
1230}
1231
1232static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1233	.set_block = tpacpi_rfk_hook_set_block,
1234};
1235
1236static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1237			const struct tpacpi_rfk_ops *tp_rfkops,
1238			const enum rfkill_type rfktype,
1239			const char *name,
1240			const bool set_default)
1241{
1242	struct tpacpi_rfk *atp_rfk;
1243	int res;
1244	bool sw_state = false;
1245	bool hw_state;
1246	int sw_status;
1247
1248	BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1249
1250	atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1251	if (atp_rfk)
1252		atp_rfk->rfkill = rfkill_alloc(name,
1253						&tpacpi_pdev->dev,
1254						rfktype,
1255						&tpacpi_rfk_rfkill_ops,
1256						atp_rfk);
1257	if (!atp_rfk || !atp_rfk->rfkill) {
1258		pr_err("failed to allocate memory for rfkill class\n");
1259		kfree(atp_rfk);
1260		return -ENOMEM;
1261	}
1262
1263	atp_rfk->id = id;
1264	atp_rfk->ops = tp_rfkops;
1265
1266	sw_status = (tp_rfkops->get_status)();
1267	if (sw_status < 0) {
1268		pr_err("failed to read initial state for %s, error %d\n",
1269		       name, sw_status);
1270	} else {
1271		sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1272		if (set_default) {
1273			/* try to keep the initial state, since we ask the
1274			 * firmware to preserve it across S5 in NVRAM */
1275			rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1276		}
1277	}
1278	hw_state = tpacpi_rfk_check_hwblock_state();
1279	rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1280
1281	res = rfkill_register(atp_rfk->rfkill);
1282	if (res < 0) {
1283		pr_err("failed to register %s rfkill switch: %d\n", name, res);
1284		rfkill_destroy(atp_rfk->rfkill);
1285		kfree(atp_rfk);
1286		return res;
1287	}
1288
1289	tpacpi_rfkill_switches[id] = atp_rfk;
1290
1291	pr_info("rfkill switch %s: radio is %sblocked\n",
1292		name, (sw_state || hw_state) ? "" : "un");
1293	return 0;
1294}
1295
1296static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1297{
1298	struct tpacpi_rfk *tp_rfk;
1299
1300	BUG_ON(id >= TPACPI_RFK_SW_MAX);
1301
1302	tp_rfk = tpacpi_rfkill_switches[id];
1303	if (tp_rfk) {
1304		rfkill_unregister(tp_rfk->rfkill);
1305		rfkill_destroy(tp_rfk->rfkill);
1306		tpacpi_rfkill_switches[id] = NULL;
1307		kfree(tp_rfk);
1308	}
1309}
1310
1311static void printk_deprecated_rfkill_attribute(const char * const what)
1312{
1313	printk_deprecated_attribute(what,
1314			"Please switch to generic rfkill before year 2010");
1315}
1316
1317/* sysfs <radio> enable ------------------------------------------------ */
1318static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1319					    struct device_attribute *attr,
1320					    char *buf)
1321{
1322	int status;
1323
1324	printk_deprecated_rfkill_attribute(attr->attr.name);
1325
1326	/* This is in the ABI... */
1327	if (tpacpi_rfk_check_hwblock_state()) {
1328		status = TPACPI_RFK_RADIO_OFF;
1329	} else {
1330		status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1331		if (status < 0)
1332			return status;
1333	}
1334
1335	return snprintf(buf, PAGE_SIZE, "%d\n",
1336			(status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1337}
1338
1339static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1340			    struct device_attribute *attr,
1341			    const char *buf, size_t count)
1342{
1343	unsigned long t;
1344	int res;
1345
1346	printk_deprecated_rfkill_attribute(attr->attr.name);
1347
1348	if (parse_strtoul(buf, 1, &t))
1349		return -EINVAL;
1350
1351	tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1352
1353	/* This is in the ABI... */
1354	if (tpacpi_rfk_check_hwblock_state() && !!t)
1355		return -EPERM;
1356
1357	res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1358				TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1359	tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1360
1361	return (res < 0) ? res : count;
1362}
1363
1364/* procfs -------------------------------------------------------------- */
1365static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1366{
1367	if (id >= TPACPI_RFK_SW_MAX)
1368		seq_printf(m, "status:\t\tnot supported\n");
1369	else {
1370		int status;
1371
1372		/* This is in the ABI... */
1373		if (tpacpi_rfk_check_hwblock_state()) {
1374			status = TPACPI_RFK_RADIO_OFF;
1375		} else {
1376			status = tpacpi_rfk_update_swstate(
1377						tpacpi_rfkill_switches[id]);
1378			if (status < 0)
1379				return status;
1380		}
1381
1382		seq_printf(m, "status:\t\t%s\n",
1383				(status == TPACPI_RFK_RADIO_ON) ?
1384					"enabled" : "disabled");
1385		seq_printf(m, "commands:\tenable, disable\n");
1386	}
1387
1388	return 0;
1389}
1390
1391static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1392{
1393	char *cmd;
1394	int status = -1;
1395	int res = 0;
1396
1397	if (id >= TPACPI_RFK_SW_MAX)
1398		return -ENODEV;
1399
1400	while ((cmd = next_cmd(&buf))) {
1401		if (strlencmp(cmd, "enable") == 0)
1402			status = TPACPI_RFK_RADIO_ON;
1403		else if (strlencmp(cmd, "disable") == 0)
1404			status = TPACPI_RFK_RADIO_OFF;
1405		else
1406			return -EINVAL;
1407	}
1408
1409	if (status != -1) {
1410		tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1411				(status == TPACPI_RFK_RADIO_ON) ?
1412						"enable" : "disable",
1413				tpacpi_rfkill_names[id]);
1414		res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1415		tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1416	}
1417
1418	return res;
1419}
1420
1421/*************************************************************************
1422 * thinkpad-acpi driver attributes
1423 */
1424
1425/* interface_version --------------------------------------------------- */
1426static ssize_t tpacpi_driver_interface_version_show(
1427				struct device_driver *drv,
1428				char *buf)
1429{
1430	return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1431}
1432
1433static DRIVER_ATTR(interface_version, S_IRUGO,
1434		tpacpi_driver_interface_version_show, NULL);
1435
1436/* debug_level --------------------------------------------------------- */
1437static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1438						char *buf)
1439{
1440	return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1441}
1442
1443static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1444						const char *buf, size_t count)
1445{
1446	unsigned long t;
1447
1448	if (parse_strtoul(buf, 0xffff, &t))
1449		return -EINVAL;
1450
1451	dbg_level = t;
1452
1453	return count;
1454}
1455
1456static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1457		tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1458
1459/* version ------------------------------------------------------------- */
1460static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1461						char *buf)
1462{
1463	return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1464			TPACPI_DESC, TPACPI_VERSION);
1465}
1466
1467static DRIVER_ATTR(version, S_IRUGO,
1468		tpacpi_driver_version_show, NULL);
1469
1470/* --------------------------------------------------------------------- */
1471
1472#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1473
1474/* wlsw_emulstate ------------------------------------------------------ */
1475static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1476						char *buf)
1477{
1478	return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1479}
1480
1481static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1482						const char *buf, size_t count)
1483{
1484	unsigned long t;
1485
1486	if (parse_strtoul(buf, 1, &t))
1487		return -EINVAL;
1488
1489	if (tpacpi_wlsw_emulstate != !!t) {
1490		tpacpi_wlsw_emulstate = !!t;
1491		tpacpi_rfk_update_hwblock_state(!t);	/* negative logic */
1492	}
1493
1494	return count;
1495}
1496
1497static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1498		tpacpi_driver_wlsw_emulstate_show,
1499		tpacpi_driver_wlsw_emulstate_store);
1500
1501/* bluetooth_emulstate ------------------------------------------------- */
1502static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1503					struct device_driver *drv,
1504					char *buf)
1505{
1506	return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1507}
1508
1509static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1510					struct device_driver *drv,
1511					const char *buf, size_t count)
1512{
1513	unsigned long t;
1514
1515	if (parse_strtoul(buf, 1, &t))
1516		return -EINVAL;
1517
1518	tpacpi_bluetooth_emulstate = !!t;
1519
1520	return count;
1521}
1522
1523static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1524		tpacpi_driver_bluetooth_emulstate_show,
1525		tpacpi_driver_bluetooth_emulstate_store);
1526
1527/* wwan_emulstate ------------------------------------------------- */
1528static ssize_t tpacpi_driver_wwan_emulstate_show(
1529					struct device_driver *drv,
1530					char *buf)
1531{
1532	return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1533}
1534
1535static ssize_t tpacpi_driver_wwan_emulstate_store(
1536					struct device_driver *drv,
1537					const char *buf, size_t count)
1538{
1539	unsigned long t;
1540
1541	if (parse_strtoul(buf, 1, &t))
1542		return -EINVAL;
1543
1544	tpacpi_wwan_emulstate = !!t;
1545
1546	return count;
1547}
1548
1549static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1550		tpacpi_driver_wwan_emulstate_show,
1551		tpacpi_driver_wwan_emulstate_store);
1552
1553/* uwb_emulstate ------------------------------------------------- */
1554static ssize_t tpacpi_driver_uwb_emulstate_show(
1555					struct device_driver *drv,
1556					char *buf)
1557{
1558	return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1559}
1560
1561static ssize_t tpacpi_driver_uwb_emulstate_store(
1562					struct device_driver *drv,
1563					const char *buf, size_t count)
1564{
1565	unsigned long t;
1566
1567	if (parse_strtoul(buf, 1, &t))
1568		return -EINVAL;
1569
1570	tpacpi_uwb_emulstate = !!t;
1571
1572	return count;
1573}
1574
1575static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1576		tpacpi_driver_uwb_emulstate_show,
1577		tpacpi_driver_uwb_emulstate_store);
1578#endif
1579
1580/* --------------------------------------------------------------------- */
1581
1582static struct driver_attribute *tpacpi_driver_attributes[] = {
1583	&driver_attr_debug_level, &driver_attr_version,
1584	&driver_attr_interface_version,
1585};
1586
1587static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1588{
1589	int i, res;
1590
1591	i = 0;
1592	res = 0;
1593	while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1594		res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1595		i++;
1596	}
1597
1598#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1599	if (!res && dbg_wlswemul)
1600		res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1601	if (!res && dbg_bluetoothemul)
1602		res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1603	if (!res && dbg_wwanemul)
1604		res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1605	if (!res && dbg_uwbemul)
1606		res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1607#endif
1608
1609	return res;
1610}
1611
1612static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1613{
1614	int i;
1615
1616	for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1617		driver_remove_file(drv, tpacpi_driver_attributes[i]);
1618
1619#ifdef THINKPAD_ACPI_DEBUGFACILITIES
1620	driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1621	driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1622	driver_remove_file(drv, &driver_attr_wwan_emulstate);
1623	driver_remove_file(drv, &driver_attr_uwb_emulstate);
1624#endif
1625}
1626
1627/*************************************************************************
1628 * Firmware Data
1629 */
1630
1631/*
1632 * Table of recommended minimum BIOS versions
1633 *
1634 * Reasons for listing:
1635 *    1. Stable BIOS, listed because the unknown amount of
1636 *       bugs and bad ACPI behaviour on older versions
1637 *
1638 *    2. BIOS or EC fw with known bugs that trigger on Linux
1639 *
1640 *    3. BIOS with known reduced functionality in older versions
1641 *
1642 *  We recommend the latest BIOS and EC version.
1643 *  We only support the latest BIOS and EC fw version as a rule.
1644 *
1645 *  Sources: IBM ThinkPad Public Web Documents (update changelogs),
1646 *  Information from users in ThinkWiki
1647 *
1648 *  WARNING: we use this table also to detect that the machine is
1649 *  a ThinkPad in some cases, so don't remove entries lightly.
1650 */
1651
1652#define TPV_Q(__v, __id1, __id2, __bv1, __bv2)		\
1653	{ .vendor	= (__v),			\
1654	  .bios		= TPID(__id1, __id2),		\
1655	  .ec		= TPACPI_MATCH_ANY,		\
1656	  .quirks	= TPACPI_MATCH_ANY << 16	\
1657			  | (__bv1) << 8 | (__bv2) }
1658
1659#define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2,	\
1660		__eid, __ev1, __ev2)			\
1661	{ .vendor	= (__v),			\
1662	  .bios		= TPID(__bid1, __bid2),		\
1663	  .ec		= __eid,			\
1664	  .quirks	= (__ev1) << 24 | (__ev2) << 16 \
1665			  | (__bv1) << 8 | (__bv2) }
1666
1667#define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1668	TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1669
1670/* Outdated IBM BIOSes often lack the EC id string */
1671#define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1672	TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, 	\
1673		__bv1, __bv2, TPID(__id1, __id2),	\
1674		__ev1, __ev2),				\
1675	TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, 	\
1676		__bv1, __bv2, TPACPI_MATCH_UNKNOWN,	\
1677		__ev1, __ev2)
1678
1679/* Outdated IBM BIOSes often lack the EC id string */
1680#define TPV_QI2(__bid1, __bid2, __bv1, __bv2,		\
1681		__eid1, __eid2, __ev1, __ev2) 		\
1682	TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, 	\
1683		__bv1, __bv2, TPID(__eid1, __eid2),	\
1684		__ev1, __ev2),				\
1685	TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, 	\
1686		__bv1, __bv2, TPACPI_MATCH_UNKNOWN,	\
1687		__ev1, __ev2)
1688
1689#define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1690	TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1691
1692#define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1693	TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, 	\
1694		__bv1, __bv2, TPID(__id1, __id2),	\
1695		__ev1, __ev2)
1696
1697#define TPV_QL2(__bid1, __bid2, __bv1, __bv2,		\
1698		__eid1, __eid2, __ev1, __ev2) 		\
1699	TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, 	\
1700		__bv1, __bv2, TPID(__eid1, __eid2),	\
1701		__ev1, __ev2)
1702
1703static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1704	/*  Numeric models ------------------ */
1705	/*      FW MODEL   BIOS VERS	      */
1706	TPV_QI0('I', 'M',  '6', '5'),		 /* 570 */
1707	TPV_QI0('I', 'U',  '2', '6'),		 /* 570E */
1708	TPV_QI0('I', 'B',  '5', '4'),		 /* 600 */
1709	TPV_QI0('I', 'H',  '4', '7'),		 /* 600E */
1710	TPV_QI0('I', 'N',  '3', '6'),		 /* 600E */
1711	TPV_QI0('I', 'T',  '5', '5'),		 /* 600X */
1712	TPV_QI0('I', 'D',  '4', '8'),		 /* 770, 770E, 770ED */
1713	TPV_QI0('I', 'I',  '4', '2'),		 /* 770X */
1714	TPV_QI0('I', 'O',  '2', '3'),		 /* 770Z */
1715
1716	/* A-series ------------------------- */
1717	/*      FW MODEL   BIOS VERS  EC VERS */
1718	TPV_QI0('I', 'W',  '5', '9'),		 /* A20m */
1719	TPV_QI0('I', 'V',  '6', '9'),		 /* A20p */
1720	TPV_QI0('1', '0',  '2', '6'),		 /* A21e, A22e */
1721	TPV_QI0('K', 'U',  '3', '6'),		 /* A21e */
1722	TPV_QI0('K', 'X',  '3', '6'),		 /* A21m, A22m */
1723	TPV_QI0('K', 'Y',  '3', '8'),		 /* A21p, A22p */
1724	TPV_QI0('1', 'B',  '1', '7'),		 /* A22e */
1725	TPV_QI0('1', '3',  '2', '0'),		 /* A22m */
1726	TPV_QI0('1', 'E',  '7', '3'),		 /* A30/p (0) */
1727	TPV_QI1('1', 'G',  '4', '1',  '1', '7'), /* A31/p (0) */
1728	TPV_QI1('1', 'N',  '1', '6',  '0', '7'), /* A31/p (0) */
1729
1730	/* G-series ------------------------- */
1731	/*      FW MODEL   BIOS VERS	      */
1732	TPV_QI0('1', 'T',  'A', '6'),		 /* G40 */
1733	TPV_QI0('1', 'X',  '5', '7'),		 /* G41 */
1734
1735	/* R-series, T-series --------------- */
1736	/*      FW MODEL   BIOS VERS  EC VERS */
1737	TPV_QI0('1', 'C',  'F', '0'),		 /* R30 */
1738	TPV_QI0('1', 'F',  'F', '1'),		 /* R31 */
1739	TPV_QI0('1', 'M',  '9', '7'),		 /* R32 */
1740	TPV_QI0('1', 'O',  '6', '1'),		 /* R40 */
1741	TPV_QI0('1', 'P',  '6', '5'),		 /* R40 */
1742	TPV_QI0('1', 'S',  '7', '0'),		 /* R40e */
1743	TPV_QI1('1', 'R',  'D', 'R',  '7', '1'), /* R50/p, R51,
1744						    T40/p, T41/p, T42/p (1) */
1745	TPV_QI1('1', 'V',  '7', '1',  '2', '8'), /* R50e, R51 (1) */
1746	TPV_QI1('7', '8',  '7', '1',  '0', '6'), /* R51e (1) */
1747	TPV_QI1('7', '6',  '6', '9',  '1', '6'), /* R52 (1) */
1748	TPV_QI1('7', '0',  '6', '9',  '2', '8'), /* R52, T43 (1) */
1749
1750	TPV_QI0('I', 'Y',  '6', '1'),		 /* T20 */
1751	TPV_QI0('K', 'Z',  '3', '4'),		 /* T21 */
1752	TPV_QI0('1', '6',  '3', '2'),		 /* T22 */
1753	TPV_QI1('1', 'A',  '6', '4',  '2', '3'), /* T23 (0) */
1754	TPV_QI1('1', 'I',  '7', '1',  '2', '0'), /* T30 (0) */
1755	TPV_QI1('1', 'Y',  '6', '5',  '2', '9'), /* T43/p (1) */
1756
1757	TPV_QL1('7', '9',  'E', '3',  '5', '0'), /* T60/p */
1758	TPV_QL1('7', 'C',  'D', '2',  '2', '2'), /* R60, R60i */
1759	TPV_QL1('7', 'E',  'D', '0',  '1', '5'), /* R60e, R60i */
1760
1761	/*      BIOS FW    BIOS VERS  EC FW     EC VERS */
1762	TPV_QI2('1', 'W',  '9', '0',  '1', 'V', '2', '8'), /* R50e (1) */
1763	TPV_QL2('7', 'I',  '3', '4',  '7', '9', '5', '0'), /* T60/p wide */
1764
1765	/* X-series ------------------------- */
1766	/*      FW MODEL   BIOS VERS  EC VERS */
1767	TPV_QI0('I', 'Z',  '9', 'D'),		 /* X20, X21 */
1768	TPV_QI0('1', 'D',  '7', '0'),		 /* X22, X23, X24 */
1769	TPV_QI1('1', 'K',  '4', '8',  '1', '8'), /* X30 (0) */
1770	TPV_QI1('1', 'Q',  '9', '7',  '2', '3'), /* X31, X32 (0) */
1771	TPV_QI1('1', 'U',  'D', '3',  'B', '2'), /* X40 (0) */
1772	TPV_QI1('7', '4',  '6', '4',  '2', '7'), /* X41 (0) */
1773	TPV_QI1('7', '5',  '6', '0',  '2', '0'), /* X41t (0) */
1774
1775	TPV_QL1('7', 'B',  'D', '7',  '4', '0'), /* X60/s */
1776	TPV_QL1('7', 'J',  '3', '0',  '1', '3'), /* X60t */
1777
1778	/* (0) - older versions lack DMI EC fw string and functionality */
1779	/* (1) - older versions known to lack functionality */
1780};
1781
1782#undef TPV_QL1
1783#undef TPV_QL0
1784#undef TPV_QI2
1785#undef TPV_QI1
1786#undef TPV_QI0
1787#undef TPV_Q_X
1788#undef TPV_Q
1789
1790static void __init tpacpi_check_outdated_fw(void)
1791{
1792	unsigned long fwvers;
1793	u16 ec_version, bios_version;
1794
1795	fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1796				ARRAY_SIZE(tpacpi_bios_version_qtable));
1797
1798	if (!fwvers)
1799		return;
1800
1801	bios_version = fwvers & 0xffffU;
1802	ec_version = (fwvers >> 16) & 0xffffU;
1803
1804	/* note that unknown versions are set to 0x0000 and we use that */
1805	if ((bios_version > thinkpad_id.bios_release) ||
1806	    (ec_version > thinkpad_id.ec_release &&
1807				ec_version != TPACPI_MATCH_ANY)) {
1808		/*
1809		 * The changelogs would let us track down the exact
1810		 * reason, but it is just too much of a pain to track
1811		 * it.  We only list BIOSes that are either really
1812		 * broken, or really stable to begin with, so it is
1813		 * best if the user upgrades the firmware anyway.
1814		 */
1815		pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1816		pr_warn("WARNING: This firmware may be missing critical bug "
1817			"fixes and/or important features\n");
1818	}
1819}
1820
1821static bool __init tpacpi_is_fw_known(void)
1822{
1823	return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1824			ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1825}
1826
1827/****************************************************************************
1828 ****************************************************************************
1829 *
1830 * Subdrivers
1831 *
1832 ****************************************************************************
1833 ****************************************************************************/
1834
1835/*************************************************************************
1836 * thinkpad-acpi metadata subdriver
1837 */
1838
1839static int thinkpad_acpi_driver_read(struct seq_file *m)
1840{
1841	seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1842	seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1843	return 0;
1844}
1845
1846static struct ibm_struct thinkpad_acpi_driver_data = {
1847	.name = "driver",
1848	.read = thinkpad_acpi_driver_read,
1849};
1850
1851/*************************************************************************
1852 * Hotkey subdriver
1853 */
1854
1855/*
1856 * ThinkPad firmware event model
1857 *
1858 * The ThinkPad firmware has two main event interfaces: normal ACPI
1859 * notifications (which follow the ACPI standard), and a private event
1860 * interface.
1861 *
1862 * The private event interface also issues events for the hotkeys.  As
1863 * the driver gained features, the event handling code ended up being
1864 * built around the hotkey subdriver.  This will need to be refactored
1865 * to a more formal event API eventually.
1866 *
1867 * Some "hotkeys" are actually supposed to be used as event reports,
1868 * such as "brightness has changed", "volume has changed", depending on
1869 * the ThinkPad model and how the firmware is operating.
1870 *
1871 * Unlike other classes, hotkey-class events have mask/unmask control on
1872 * non-ancient firmware.  However, how it behaves changes a lot with the
1873 * firmware model and version.
1874 */
1875
1876enum {	/* hot key scan codes (derived from ACPI DSDT) */
1877	TP_ACPI_HOTKEYSCAN_FNF1		= 0,
1878	TP_ACPI_HOTKEYSCAN_FNF2,
1879	TP_ACPI_HOTKEYSCAN_FNF3,
1880	TP_ACPI_HOTKEYSCAN_FNF4,
1881	TP_ACPI_HOTKEYSCAN_FNF5,
1882	TP_ACPI_HOTKEYSCAN_FNF6,
1883	TP_ACPI_HOTKEYSCAN_FNF7,
1884	TP_ACPI_HOTKEYSCAN_FNF8,
1885	TP_ACPI_HOTKEYSCAN_FNF9,
1886	TP_ACPI_HOTKEYSCAN_FNF10,
1887	TP_ACPI_HOTKEYSCAN_FNF11,
1888	TP_ACPI_HOTKEYSCAN_FNF12,
1889	TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1890	TP_ACPI_HOTKEYSCAN_FNINSERT,
1891	TP_ACPI_HOTKEYSCAN_FNDELETE,
1892	TP_ACPI_HOTKEYSCAN_FNHOME,
1893	TP_ACPI_HOTKEYSCAN_FNEND,
1894	TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1895	TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1896	TP_ACPI_HOTKEYSCAN_FNSPACE,
1897	TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1898	TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1899	TP_ACPI_HOTKEYSCAN_MUTE,
1900	TP_ACPI_HOTKEYSCAN_THINKPAD,
1901	TP_ACPI_HOTKEYSCAN_UNK1,
1902	TP_ACPI_HOTKEYSCAN_UNK2,
1903	TP_ACPI_HOTKEYSCAN_UNK3,
1904	TP_ACPI_HOTKEYSCAN_UNK4,
1905	TP_ACPI_HOTKEYSCAN_UNK5,
1906	TP_ACPI_HOTKEYSCAN_UNK6,
1907	TP_ACPI_HOTKEYSCAN_UNK7,
1908	TP_ACPI_HOTKEYSCAN_UNK8,
1909
1910	/* Hotkey keymap size */
1911	TPACPI_HOTKEY_MAP_LEN
1912};
1913
1914enum {	/* Keys/events available through NVRAM polling */
1915	TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1916	TPACPI_HKEY_NVRAM_GOOD_MASK  = 0x00fb8000U,
1917};
1918
1919enum {	/* Positions of some of the keys in hotkey masks */
1920	TP_ACPI_HKEY_DISPSWTCH_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1921	TP_ACPI_HKEY_DISPXPAND_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1922	TP_ACPI_HKEY_HIBERNATE_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1923	TP_ACPI_HKEY_BRGHTUP_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1924	TP_ACPI_HKEY_BRGHTDWN_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1925	TP_ACPI_HKEY_THNKLGHT_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1926	TP_ACPI_HKEY_ZOOM_MASK		= 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1927	TP_ACPI_HKEY_VOLUP_MASK		= 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1928	TP_ACPI_HKEY_VOLDWN_MASK	= 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1929	TP_ACPI_HKEY_MUTE_MASK		= 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1930	TP_ACPI_HKEY_THINKPAD_MASK	= 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1931};
1932
1933enum {	/* NVRAM to ACPI HKEY group map */
1934	TP_NVRAM_HKEY_GROUP_HK2		= TP_ACPI_HKEY_THINKPAD_MASK |
1935					  TP_ACPI_HKEY_ZOOM_MASK |
1936					  TP_ACPI_HKEY_DISPSWTCH_MASK |
1937					  TP_ACPI_HKEY_HIBERNATE_MASK,
1938	TP_NVRAM_HKEY_GROUP_BRIGHTNESS	= TP_ACPI_HKEY_BRGHTUP_MASK |
1939					  TP_ACPI_HKEY_BRGHTDWN_MASK,
1940	TP_NVRAM_HKEY_GROUP_VOLUME	= TP_ACPI_HKEY_VOLUP_MASK |
1941					  TP_ACPI_HKEY_VOLDWN_MASK |
1942					  TP_ACPI_HKEY_MUTE_MASK,
1943};
1944
1945#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1946struct tp_nvram_state {
1947       u16 thinkpad_toggle:1;
1948       u16 zoom_toggle:1;
1949       u16 display_toggle:1;
1950       u16 thinklight_toggle:1;
1951       u16 hibernate_toggle:1;
1952       u16 displayexp_toggle:1;
1953       u16 display_state:1;
1954       u16 brightness_toggle:1;
1955       u16 volume_toggle:1;
1956       u16 mute:1;
1957
1958       u8 brightness_level;
1959       u8 volume_level;
1960};
1961
1962/* kthread for the hotkey poller */
1963static struct task_struct *tpacpi_hotkey_task;
1964
1965/* Acquired while the poller kthread is running, use to sync start/stop */
1966static struct mutex hotkey_thread_mutex;
1967
1968/*
1969 * Acquire mutex to write poller control variables as an
1970 * atomic block.
1971 *
1972 * Increment hotkey_config_change when changing them if you
1973 * want the kthread to forget old state.
1974 *
1975 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1976 */
1977static struct mutex hotkey_thread_data_mutex;
1978static unsigned int hotkey_config_change;
1979
1980/*
1981 * hotkey poller control variables
1982 *
1983 * Must be atomic or readers will also need to acquire mutex
1984 *
1985 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1986 * should be used only when the changes need to be taken as
1987 * a block, OR when one needs to force the kthread to forget
1988 * old state.
1989 */
1990static u32 hotkey_source_mask;		/* bit mask 0=ACPI,1=NVRAM */
1991static unsigned int hotkey_poll_freq = 10; /* Hz */
1992
1993#define HOTKEY_CONFIG_CRITICAL_START \
1994	do { \
1995		mutex_lock(&hotkey_thread_data_mutex); \
1996		hotkey_config_change++; \
1997	} while (0);
1998#define HOTKEY_CONFIG_CRITICAL_END \
1999	mutex_unlock(&hotkey_thread_data_mutex);
2000
2001#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2002
2003#define hotkey_source_mask 0U
2004#define HOTKEY_CONFIG_CRITICAL_START
2005#define HOTKEY_CONFIG_CRITICAL_END
2006
2007#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2008
2009static struct mutex hotkey_mutex;
2010
2011static enum {	/* Reasons for waking up */
2012	TP_ACPI_WAKEUP_NONE = 0,	/* None or unknown */
2013	TP_ACPI_WAKEUP_BAYEJ,		/* Bay ejection request */
2014	TP_ACPI_WAKEUP_UNDOCK,		/* Undock request */
2015} hotkey_wakeup_reason;
2016
2017static int hotkey_autosleep_ack;
2018
2019static u32 hotkey_orig_mask;		/* events the BIOS had enabled */
2020static u32 hotkey_all_mask;		/* all events supported in fw */
2021static u32 hotkey_reserved_mask;	/* events better left disabled */
2022static u32 hotkey_driver_mask;		/* events needed by the driver */
2023static u32 hotkey_user_mask;		/* events visible to userspace */
2024static u32 hotkey_acpi_mask;		/* events enabled in firmware */
2025
2026static unsigned int hotkey_report_mode;
2027
2028static u16 *hotkey_keycode_map;
2029
2030static struct attribute_set *hotkey_dev_attributes;
2031
2032static void tpacpi_driver_event(const unsigned int hkey_event);
2033static void hotkey_driver_event(const unsigned int scancode);
2034static void hotkey_poll_setup(const bool may_warn);
2035
2036/* HKEY.MHKG() return bits */
2037#define TP_HOTKEY_TABLET_MASK (1 << 3)
2038
2039static int hotkey_get_wlsw(void)
2040{
2041	int status;
2042
2043	if (!tp_features.hotkey_wlsw)
2044		return -ENODEV;
2045
2046#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2047	if (dbg_wlswemul)
2048		return (tpacpi_wlsw_emulstate) ?
2049				TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2050#endif
2051
2052	if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2053		return -EIO;
2054
2055	return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2056}
2057
2058static int hotkey_get_tablet_mode(int *status)
2059{
2060	int s;
2061
2062	if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2063		return -EIO;
2064
2065	*status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2066	return 0;
2067}
2068
2069/*
2070 * Reads current event mask from firmware, and updates
2071 * hotkey_acpi_mask accordingly.  Also resets any bits
2072 * from hotkey_user_mask that are unavailable to be
2073 * delivered (shadow requirement of the userspace ABI).
2074 *
2075 * Call with hotkey_mutex held
2076 */
2077static int hotkey_mask_get(void)
2078{
2079	if (tp_features.hotkey_mask) {
2080		u32 m = 0;
2081
2082		if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2083			return -EIO;
2084
2085		hotkey_acpi_mask = m;
2086	} else {
2087		/* no mask support doesn't mean no event support... */
2088		hotkey_acpi_mask = hotkey_all_mask;
2089	}
2090
2091	/* sync userspace-visible mask */
2092	hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2093
2094	return 0;
2095}
2096
2097void static hotkey_mask_warn_incomplete_mask(void)
2098{
2099	/* log only what the user can fix... */
2100	const u32 wantedmask = hotkey_driver_mask &
2101		~(hotkey_acpi_mask | hotkey_source_mask) &
2102		(hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2103
2104	if (wantedmask)
2105		pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2106}
2107
2108/*
2109 * Set the firmware mask when supported
2110 *
2111 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2112 *
2113 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2114 *
2115 * Call with hotkey_mutex held
2116 */
2117static int hotkey_mask_set(u32 mask)
2118{
2119	int i;
2120	int rc = 0;
2121
2122	const u32 fwmask = mask & ~hotkey_source_mask;
2123
2124	if (tp_features.hotkey_mask) {
2125		for (i = 0; i < 32; i++) {
2126			if (!acpi_evalf(hkey_handle,
2127					NULL, "MHKM", "vdd", i + 1,
2128					!!(mask & (1 << i)))) {
2129				rc = -EIO;
2130				break;
2131			}
2132		}
2133	}
2134
2135	/*
2136	 * We *must* make an inconditional call to hotkey_mask_get to
2137	 * refresh hotkey_acpi_mask and update hotkey_user_mask
2138	 *
2139	 * Take the opportunity to also log when we cannot _enable_
2140	 * a given event.
2141	 */
2142	if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2143		pr_notice("asked for hotkey mask 0x%08x, but "
2144			  "firmware forced it to 0x%08x\n",
2145			  fwmask, hotkey_acpi_mask);
2146	}
2147
2148	if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2149		hotkey_mask_warn_incomplete_mask();
2150
2151	return rc;
2152}
2153
2154/*
2155 * Sets hotkey_user_mask and tries to set the firmware mask
2156 *
2157 * Call with hotkey_mutex held
2158 */
2159static int hotkey_user_mask_set(const u32 mask)
2160{
2161	int rc;
2162
2163	/* Give people a chance to notice they are doing something that
2164	 * is bound to go boom on their users sooner or later */
2165	if (!tp_warned.hotkey_mask_ff &&
2166	    (mask == 0xffff || mask == 0xffffff ||
2167	     mask == 0xffffffff)) {
2168		tp_warned.hotkey_mask_ff = 1;
2169		pr_notice("setting the hotkey mask to 0x%08x is likely "
2170			  "not the best way to go about it\n", mask);
2171		pr_notice("please consider using the driver defaults, "
2172			  "and refer to up-to-date thinkpad-acpi "
2173			  "documentation\n");
2174	}
2175
2176	/* Try to enable what the user asked for, plus whatever we need.
2177	 * this syncs everything but won't enable bits in hotkey_user_mask */
2178	rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2179
2180	/* Enable the available bits in hotkey_user_mask */
2181	hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2182
2183	return rc;
2184}
2185
2186/*
2187 * Sets the driver hotkey mask.
2188 *
2189 * Can be called even if the hotkey subdriver is inactive
2190 */
2191static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2192{
2193	int rc;
2194
2195	/* Do the right thing if hotkey_init has not been called yet */
2196	if (!tp_features.hotkey) {
2197		hotkey_driver_mask = mask;
2198		return 0;
2199	}
2200
2201	mutex_lock(&hotkey_mutex);
2202
2203	HOTKEY_CONFIG_CRITICAL_START
2204	hotkey_driver_mask = mask;
2205#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2206	hotkey_source_mask |= (mask & ~hotkey_all_mask);
2207#endif
2208	HOTKEY_CONFIG_CRITICAL_END
2209
2210	rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2211							~hotkey_source_mask);
2212	hotkey_poll_setup(true);
2213
2214	mutex_unlock(&hotkey_mutex);
2215
2216	return rc;
2217}
2218
2219static int hotkey_status_get(int *status)
2220{
2221	if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2222		return -EIO;
2223
2224	return 0;
2225}
2226
2227static int hotkey_status_set(bool enable)
2228{
2229	if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2230		return -EIO;
2231
2232	return 0;
2233}
2234
2235static void tpacpi_input_send_tabletsw(void)
2236{
2237	int state;
2238
2239	if (tp_features.hotkey_tablet &&
2240	    !hotkey_get_tablet_mode(&state)) {
2241		mutex_lock(&tpacpi_inputdev_send_mutex);
2242
2243		input_report_switch(tpacpi_inputdev,
2244				    SW_TABLET_MODE, !!state);
2245		input_sync(tpacpi_inputdev);
2246
2247		mutex_unlock(&tpacpi_inputdev_send_mutex);
2248	}
2249}
2250
2251/* Do NOT call without validating scancode first */
2252static void tpacpi_input_send_key(const unsigned int scancode)
2253{
2254	const unsigned int keycode = hotkey_keycode_map[scancode];
2255
2256	if (keycode != KEY_RESERVED) {
2257		mutex_lock(&tpacpi_inputdev_send_mutex);
2258
2259		input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2260		input_report_key(tpacpi_inputdev, keycode, 1);
2261		input_sync(tpacpi_inputdev);
2262
2263		input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2264		input_report_key(tpacpi_inputdev, keycode, 0);
2265		input_sync(tpacpi_inputdev);
2266
2267		mutex_unlock(&tpacpi_inputdev_send_mutex);
2268	}
2269}
2270
2271/* Do NOT call without validating scancode first */
2272static void tpacpi_input_send_key_masked(const unsigned int scancode)
2273{
2274	hotkey_driver_event(scancode);
2275	if (hotkey_user_mask & (1 << scancode))
2276		tpacpi_input_send_key(scancode);
2277}
2278
2279#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2280static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2281
2282/* Do NOT call without validating scancode first */
2283static void tpacpi_hotkey_send_key(unsigned int scancode)
2284{
2285	tpacpi_input_send_key_masked(scancode);
2286	if (hotkey_report_mode < 2) {
2287		acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2288				0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2289	}
2290}
2291
2292static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2293{
2294	u8 d;
2295
2296	if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2297		d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2298		n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2299		n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2300		n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2301		n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2302	}
2303	if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2304		d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2305		n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2306	}
2307	if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2308		d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2309		n->displayexp_toggle =
2310				!!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2311	}
2312	if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2313		d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2314		n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2315				>> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2316		n->brightness_toggle =
2317				!!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2318	}
2319	if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2320		d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2321		n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2322				>> TP_NVRAM_POS_LEVEL_VOLUME;
2323		n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2324		n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2325	}
2326}
2327
2328static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2329					   struct tp_nvram_state *newn,
2330					   const u32 event_mask)
2331{
2332
2333#define TPACPI_COMPARE_KEY(__scancode, __member) \
2334	do { \
2335		if ((event_mask & (1 << __scancode)) && \
2336		    oldn->__member != newn->__member) \
2337			tpacpi_hotkey_send_key(__scancode); \
2338	} while (0)
2339
2340#define TPACPI_MAY_SEND_KEY(__scancode) \
2341	do { \
2342		if (event_mask & (1 << __scancode)) \
2343			tpacpi_hotkey_send_key(__scancode); \
2344	} while (0)
2345
2346	void issue_volchange(const unsigned int oldvol,
2347			     const unsigned int newvol)
2348	{
2349		unsigned int i = oldvol;
2350
2351		while (i > newvol) {
2352			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2353			i--;
2354		}
2355		while (i < newvol) {
2356			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2357			i++;
2358		}
 
2359	}
 
 
 
 
 
2360
2361	void issue_brightnesschange(const unsigned int oldbrt,
2362				    const unsigned int newbrt)
2363	{
2364		unsigned int i = oldbrt;
2365
2366		while (i > newbrt) {
2367			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2368			i--;
2369		}
2370		while (i < newbrt) {
2371			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2372			i++;
2373		}
2374	}
 
 
 
 
 
 
 
 
 
 
2375
2376	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2377	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2378	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2379	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2380
2381	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2382
2383	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2384
2385	/*
2386	 * Handle volume
2387	 *
2388	 * This code is supposed to duplicate the IBM firmware behaviour:
2389	 * - Pressing MUTE issues mute hotkey message, even when already mute
2390	 * - Pressing Volume up/down issues volume up/down hotkey messages,
2391	 *   even when already at maximum or minimum volume
2392	 * - The act of unmuting issues volume up/down notification,
2393	 *   depending which key was used to unmute
2394	 *
2395	 * We are constrained to what the NVRAM can tell us, which is not much
2396	 * and certainly not enough if more than one volume hotkey was pressed
2397	 * since the last poll cycle.
2398	 *
2399	 * Just to make our life interesting, some newer Lenovo ThinkPads have
2400	 * bugs in the BIOS and may fail to update volume_toggle properly.
2401	 */
2402	if (newn->mute) {
2403		/* muted */
2404		if (!oldn->mute ||
2405		    oldn->volume_toggle != newn->volume_toggle ||
2406		    oldn->volume_level != newn->volume_level) {
2407			/* recently muted, or repeated mute keypress, or
2408			 * multiple presses ending in mute */
2409			issue_volchange(oldn->volume_level, newn->volume_level);
 
2410			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2411		}
2412	} else {
2413		/* unmute */
2414		if (oldn->mute) {
2415			/* recently unmuted, issue 'unmute' keypress */
2416			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2417		}
2418		if (oldn->volume_level != newn->volume_level) {
2419			issue_volchange(oldn->volume_level, newn->volume_level);
 
2420		} else if (oldn->volume_toggle != newn->volume_toggle) {
2421			/* repeated vol up/down keypress at end of scale ? */
2422			if (newn->volume_level == 0)
2423				TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2424			else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2425				TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2426		}
2427	}
2428
2429	/* handle brightness */
2430	if (oldn->brightness_level != newn->brightness_level) {
2431		issue_brightnesschange(oldn->brightness_level,
2432				       newn->brightness_level);
2433	} else if (oldn->brightness_toggle != newn->brightness_toggle) {
2434		/* repeated key presses that didn't change state */
2435		if (newn->brightness_level == 0)
2436			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2437		else if (newn->brightness_level >= bright_maxlvl
2438				&& !tp_features.bright_unkfw)
2439			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2440	}
2441
2442#undef TPACPI_COMPARE_KEY
2443#undef TPACPI_MAY_SEND_KEY
2444}
2445
2446/*
2447 * Polling driver
2448 *
2449 * We track all events in hotkey_source_mask all the time, since
2450 * most of them are edge-based.  We only issue those requested by
2451 * hotkey_user_mask or hotkey_driver_mask, though.
2452 */
2453static int hotkey_kthread(void *data)
2454{
2455	struct tp_nvram_state s[2];
2456	u32 poll_mask, event_mask;
2457	unsigned int si, so;
2458	unsigned long t;
2459	unsigned int change_detector, must_reset;
2460	unsigned int poll_freq;
2461
2462	mutex_lock(&hotkey_thread_mutex);
2463
2464	if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2465		goto exit;
2466
2467	set_freezable();
2468
2469	so = 0;
2470	si = 1;
2471	t = 0;
2472
2473	/* Initial state for compares */
2474	mutex_lock(&hotkey_thread_data_mutex);
2475	change_detector = hotkey_config_change;
2476	poll_mask = hotkey_source_mask;
2477	event_mask = hotkey_source_mask &
2478			(hotkey_driver_mask | hotkey_user_mask);
2479	poll_freq = hotkey_poll_freq;
2480	mutex_unlock(&hotkey_thread_data_mutex);
2481	hotkey_read_nvram(&s[so], poll_mask);
2482
2483	while (!kthread_should_stop()) {
2484		if (t == 0) {
2485			if (likely(poll_freq))
2486				t = 1000/poll_freq;
2487			else
2488				t = 100;	/* should never happen... */
2489		}
2490		t = msleep_interruptible(t);
2491		if (unlikely(kthread_should_stop()))
2492			break;
2493		must_reset = try_to_freeze();
2494		if (t > 0 && !must_reset)
2495			continue;
2496
2497		mutex_lock(&hotkey_thread_data_mutex);
2498		if (must_reset || hotkey_config_change != change_detector) {
2499			/* forget old state on thaw or config change */
2500			si = so;
2501			t = 0;
2502			change_detector = hotkey_config_change;
2503		}
2504		poll_mask = hotkey_source_mask;
2505		event_mask = hotkey_source_mask &
2506				(hotkey_driver_mask | hotkey_user_mask);
2507		poll_freq = hotkey_poll_freq;
2508		mutex_unlock(&hotkey_thread_data_mutex);
2509
2510		if (likely(poll_mask)) {
2511			hotkey_read_nvram(&s[si], poll_mask);
2512			if (likely(si != so)) {
2513				hotkey_compare_and_issue_event(&s[so], &s[si],
2514								event_mask);
2515			}
2516		}
2517
2518		so = si;
2519		si ^= 1;
2520	}
2521
2522exit:
2523	mutex_unlock(&hotkey_thread_mutex);
2524	return 0;
2525}
2526
2527/* call with hotkey_mutex held */
2528static void hotkey_poll_stop_sync(void)
2529{
2530	if (tpacpi_hotkey_task) {
2531		if (frozen(tpacpi_hotkey_task) ||
2532		    freezing(tpacpi_hotkey_task))
2533			thaw_process(tpacpi_hotkey_task);
2534
2535		kthread_stop(tpacpi_hotkey_task);
2536		tpacpi_hotkey_task = NULL;
2537		mutex_lock(&hotkey_thread_mutex);
2538		/* at this point, the thread did exit */
2539		mutex_unlock(&hotkey_thread_mutex);
2540	}
2541}
2542
2543/* call with hotkey_mutex held */
2544static void hotkey_poll_setup(const bool may_warn)
2545{
2546	const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2547	const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2548
2549	if (hotkey_poll_freq > 0 &&
2550	    (poll_driver_mask ||
2551	     (poll_user_mask && tpacpi_inputdev->users > 0))) {
2552		if (!tpacpi_hotkey_task) {
2553			tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2554					NULL, TPACPI_NVRAM_KTHREAD_NAME);
2555			if (IS_ERR(tpacpi_hotkey_task)) {
2556				tpacpi_hotkey_task = NULL;
2557				pr_err("could not create kernel thread "
2558				       "for hotkey polling\n");
2559			}
2560		}
2561	} else {
2562		hotkey_poll_stop_sync();
2563		if (may_warn && (poll_driver_mask || poll_user_mask) &&
2564		    hotkey_poll_freq == 0) {
2565			pr_notice("hot keys 0x%08x and/or events 0x%08x "
2566				  "require polling, which is currently "
2567				  "disabled\n",
2568				  poll_user_mask, poll_driver_mask);
2569		}
2570	}
2571}
2572
2573static void hotkey_poll_setup_safe(const bool may_warn)
2574{
2575	mutex_lock(&hotkey_mutex);
2576	hotkey_poll_setup(may_warn);
2577	mutex_unlock(&hotkey_mutex);
2578}
2579
2580/* call with hotkey_mutex held */
2581static void hotkey_poll_set_freq(unsigned int freq)
2582{
2583	if (!freq)
2584		hotkey_poll_stop_sync();
2585
2586	hotkey_poll_freq = freq;
2587}
2588
2589#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2590
2591static void hotkey_poll_setup(const bool __unused)
2592{
2593}
2594
2595static void hotkey_poll_setup_safe(const bool __unused)
2596{
2597}
2598
2599#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2600
2601static int hotkey_inputdev_open(struct input_dev *dev)
2602{
2603	switch (tpacpi_lifecycle) {
2604	case TPACPI_LIFE_INIT:
2605	case TPACPI_LIFE_RUNNING:
2606		hotkey_poll_setup_safe(false);
2607		return 0;
2608	case TPACPI_LIFE_EXITING:
2609		return -EBUSY;
2610	}
2611
2612	/* Should only happen if tpacpi_lifecycle is corrupt */
2613	BUG();
2614	return -EBUSY;
2615}
2616
2617static void hotkey_inputdev_close(struct input_dev *dev)
2618{
2619	/* disable hotkey polling when possible */
2620	if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2621	    !(hotkey_source_mask & hotkey_driver_mask))
2622		hotkey_poll_setup_safe(false);
2623}
2624
2625/* sysfs hotkey enable ------------------------------------------------- */
2626static ssize_t hotkey_enable_show(struct device *dev,
2627			   struct device_attribute *attr,
2628			   char *buf)
2629{
2630	int res, status;
2631
2632	printk_deprecated_attribute("hotkey_enable",
2633			"Hotkey reporting is always enabled");
2634
2635	res = hotkey_status_get(&status);
2636	if (res)
2637		return res;
2638
2639	return snprintf(buf, PAGE_SIZE, "%d\n", status);
2640}
2641
2642static ssize_t hotkey_enable_store(struct device *dev,
2643			    struct device_attribute *attr,
2644			    const char *buf, size_t count)
2645{
2646	unsigned long t;
2647
2648	printk_deprecated_attribute("hotkey_enable",
2649			"Hotkeys can be disabled through hotkey_mask");
2650
2651	if (parse_strtoul(buf, 1, &t))
2652		return -EINVAL;
2653
2654	if (t == 0)
2655		return -EPERM;
2656
2657	return count;
2658}
2659
2660static struct device_attribute dev_attr_hotkey_enable =
2661	__ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2662		hotkey_enable_show, hotkey_enable_store);
2663
2664/* sysfs hotkey mask --------------------------------------------------- */
2665static ssize_t hotkey_mask_show(struct device *dev,
2666			   struct device_attribute *attr,
2667			   char *buf)
2668{
2669	return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2670}
2671
2672static ssize_t hotkey_mask_store(struct device *dev,
2673			    struct device_attribute *attr,
2674			    const char *buf, size_t count)
2675{
2676	unsigned long t;
2677	int res;
2678
2679	if (parse_strtoul(buf, 0xffffffffUL, &t))
2680		return -EINVAL;
2681
2682	if (mutex_lock_killable(&hotkey_mutex))
2683		return -ERESTARTSYS;
2684
2685	res = hotkey_user_mask_set(t);
2686
2687#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2688	hotkey_poll_setup(true);
2689#endif
2690
2691	mutex_unlock(&hotkey_mutex);
2692
2693	tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2694
2695	return (res) ? res : count;
2696}
2697
2698static struct device_attribute dev_attr_hotkey_mask =
2699	__ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2700		hotkey_mask_show, hotkey_mask_store);
2701
2702/* sysfs hotkey bios_enabled ------------------------------------------- */
2703static ssize_t hotkey_bios_enabled_show(struct device *dev,
2704			   struct device_attribute *attr,
2705			   char *buf)
2706{
2707	return sprintf(buf, "0\n");
2708}
2709
2710static struct device_attribute dev_attr_hotkey_bios_enabled =
2711	__ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2712
2713/* sysfs hotkey bios_mask ---------------------------------------------- */
2714static ssize_t hotkey_bios_mask_show(struct device *dev,
2715			   struct device_attribute *attr,
2716			   char *buf)
2717{
2718	printk_deprecated_attribute("hotkey_bios_mask",
2719			"This attribute is useless.");
2720	return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2721}
2722
2723static struct device_attribute dev_attr_hotkey_bios_mask =
2724	__ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2725
2726/* sysfs hotkey all_mask ----------------------------------------------- */
2727static ssize_t hotkey_all_mask_show(struct device *dev,
2728			   struct device_attribute *attr,
2729			   char *buf)
2730{
2731	return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2732				hotkey_all_mask | hotkey_source_mask);
2733}
2734
2735static struct device_attribute dev_attr_hotkey_all_mask =
2736	__ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2737
2738/* sysfs hotkey recommended_mask --------------------------------------- */
2739static ssize_t hotkey_recommended_mask_show(struct device *dev,
2740					    struct device_attribute *attr,
2741					    char *buf)
2742{
2743	return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2744			(hotkey_all_mask | hotkey_source_mask)
2745			& ~hotkey_reserved_mask);
2746}
2747
2748static struct device_attribute dev_attr_hotkey_recommended_mask =
2749	__ATTR(hotkey_recommended_mask, S_IRUGO,
2750		hotkey_recommended_mask_show, NULL);
2751
2752#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2753
2754/* sysfs hotkey hotkey_source_mask ------------------------------------- */
2755static ssize_t hotkey_source_mask_show(struct device *dev,
2756			   struct device_attribute *attr,
2757			   char *buf)
2758{
2759	return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2760}
2761
2762static ssize_t hotkey_source_mask_store(struct device *dev,
2763			    struct device_attribute *attr,
2764			    const char *buf, size_t count)
2765{
2766	unsigned long t;
2767	u32 r_ev;
2768	int rc;
2769
2770	if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2771		((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2772		return -EINVAL;
2773
2774	if (mutex_lock_killable(&hotkey_mutex))
2775		return -ERESTARTSYS;
2776
2777	HOTKEY_CONFIG_CRITICAL_START
2778	hotkey_source_mask = t;
2779	HOTKEY_CONFIG_CRITICAL_END
2780
2781	rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2782			~hotkey_source_mask);
2783	hotkey_poll_setup(true);
2784
2785	/* check if events needed by the driver got disabled */
2786	r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2787		& ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2788
2789	mutex_unlock(&hotkey_mutex);
2790
2791	if (rc < 0)
2792		pr_err("hotkey_source_mask: "
2793		       "failed to update the firmware event mask!\n");
2794
2795	if (r_ev)
2796		pr_notice("hotkey_source_mask: "
2797			  "some important events were disabled: 0x%04x\n",
2798			  r_ev);
2799
2800	tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2801
2802	return (rc < 0) ? rc : count;
2803}
2804
2805static struct device_attribute dev_attr_hotkey_source_mask =
2806	__ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2807		hotkey_source_mask_show, hotkey_source_mask_store);
2808
2809/* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2810static ssize_t hotkey_poll_freq_show(struct device *dev,
2811			   struct device_attribute *attr,
2812			   char *buf)
2813{
2814	return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2815}
2816
2817static ssize_t hotkey_poll_freq_store(struct device *dev,
2818			    struct device_attribute *attr,
2819			    const char *buf, size_t count)
2820{
2821	unsigned long t;
2822
2823	if (parse_strtoul(buf, 25, &t))
2824		return -EINVAL;
2825
2826	if (mutex_lock_killable(&hotkey_mutex))
2827		return -ERESTARTSYS;
2828
2829	hotkey_poll_set_freq(t);
2830	hotkey_poll_setup(true);
2831
2832	mutex_unlock(&hotkey_mutex);
2833
2834	tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2835
2836	return count;
2837}
2838
2839static struct device_attribute dev_attr_hotkey_poll_freq =
2840	__ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2841		hotkey_poll_freq_show, hotkey_poll_freq_store);
2842
2843#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2844
2845/* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2846static ssize_t hotkey_radio_sw_show(struct device *dev,
2847			   struct device_attribute *attr,
2848			   char *buf)
2849{
2850	int res;
2851	res = hotkey_get_wlsw();
2852	if (res < 0)
2853		return res;
2854
2855	/* Opportunistic update */
2856	tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2857
2858	return snprintf(buf, PAGE_SIZE, "%d\n",
2859			(res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2860}
2861
2862static struct device_attribute dev_attr_hotkey_radio_sw =
2863	__ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2864
2865static void hotkey_radio_sw_notify_change(void)
2866{
2867	if (tp_features.hotkey_wlsw)
2868		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2869			     "hotkey_radio_sw");
2870}
2871
2872/* sysfs hotkey tablet mode (pollable) --------------------------------- */
2873static ssize_t hotkey_tablet_mode_show(struct device *dev,
2874			   struct device_attribute *attr,
2875			   char *buf)
2876{
2877	int res, s;
2878	res = hotkey_get_tablet_mode(&s);
2879	if (res < 0)
2880		return res;
2881
2882	return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2883}
2884
2885static struct device_attribute dev_attr_hotkey_tablet_mode =
2886	__ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2887
2888static void hotkey_tablet_mode_notify_change(void)
2889{
2890	if (tp_features.hotkey_tablet)
2891		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2892			     "hotkey_tablet_mode");
2893}
2894
2895/* sysfs hotkey report_mode -------------------------------------------- */
2896static ssize_t hotkey_report_mode_show(struct device *dev,
2897			   struct device_attribute *attr,
2898			   char *buf)
2899{
2900	return snprintf(buf, PAGE_SIZE, "%d\n",
2901		(hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2902}
2903
2904static struct device_attribute dev_attr_hotkey_report_mode =
2905	__ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2906
2907/* sysfs wakeup reason (pollable) -------------------------------------- */
2908static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2909			   struct device_attribute *attr,
2910			   char *buf)
2911{
2912	return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2913}
2914
2915static struct device_attribute dev_attr_hotkey_wakeup_reason =
2916	__ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2917
2918static void hotkey_wakeup_reason_notify_change(void)
2919{
2920	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2921		     "wakeup_reason");
2922}
2923
2924/* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2925static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2926			   struct device_attribute *attr,
2927			   char *buf)
2928{
2929	return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2930}
2931
2932static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2933	__ATTR(wakeup_hotunplug_complete, S_IRUGO,
2934	       hotkey_wakeup_hotunplug_complete_show, NULL);
2935
2936static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2937{
2938	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2939		     "wakeup_hotunplug_complete");
2940}
2941
2942/* --------------------------------------------------------------------- */
2943
2944static struct attribute *hotkey_attributes[] __initdata = {
2945	&dev_attr_hotkey_enable.attr,
2946	&dev_attr_hotkey_bios_enabled.attr,
2947	&dev_attr_hotkey_bios_mask.attr,
2948	&dev_attr_hotkey_report_mode.attr,
2949	&dev_attr_hotkey_wakeup_reason.attr,
2950	&dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2951	&dev_attr_hotkey_mask.attr,
2952	&dev_attr_hotkey_all_mask.attr,
2953	&dev_attr_hotkey_recommended_mask.attr,
2954#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2955	&dev_attr_hotkey_source_mask.attr,
2956	&dev_attr_hotkey_poll_freq.attr,
2957#endif
2958};
2959
2960/*
2961 * Sync both the hw and sw blocking state of all switches
2962 */
2963static void tpacpi_send_radiosw_update(void)
2964{
2965	int wlsw;
2966
2967	/*
2968	 * We must sync all rfkill controllers *before* issuing any
2969	 * rfkill input events, or we will race the rfkill core input
2970	 * handler.
2971	 *
2972	 * tpacpi_inputdev_send_mutex works as a synchronization point
2973	 * for the above.
2974	 *
2975	 * We optimize to avoid numerous calls to hotkey_get_wlsw.
2976	 */
2977
2978	wlsw = hotkey_get_wlsw();
2979
2980	/* Sync hw blocking state first if it is hw-blocked */
2981	if (wlsw == TPACPI_RFK_RADIO_OFF)
2982		tpacpi_rfk_update_hwblock_state(true);
2983
2984	/* Sync sw blocking state */
2985	tpacpi_rfk_update_swstate_all();
2986
2987	/* Sync hw blocking state last if it is hw-unblocked */
2988	if (wlsw == TPACPI_RFK_RADIO_ON)
2989		tpacpi_rfk_update_hwblock_state(false);
2990
2991	/* Issue rfkill input event for WLSW switch */
2992	if (!(wlsw < 0)) {
2993		mutex_lock(&tpacpi_inputdev_send_mutex);
2994
2995		input_report_switch(tpacpi_inputdev,
2996				    SW_RFKILL_ALL, (wlsw > 0));
2997		input_sync(tpacpi_inputdev);
2998
2999		mutex_unlock(&tpacpi_inputdev_send_mutex);
3000	}
3001
3002	/*
3003	 * this can be unconditional, as we will poll state again
3004	 * if userspace uses the notify to read data
3005	 */
3006	hotkey_radio_sw_notify_change();
3007}
3008
3009static void hotkey_exit(void)
3010{
3011#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3012	mutex_lock(&hotkey_mutex);
3013	hotkey_poll_stop_sync();
3014	mutex_unlock(&hotkey_mutex);
3015#endif
3016
3017	if (hotkey_dev_attributes)
3018		delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3019
3020	kfree(hotkey_keycode_map);
3021
3022	dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3023		   "restoring original HKEY status and mask\n");
3024	/* yes, there is a bitwise or below, we want the
3025	 * functions to be called even if one of them fail */
3026	if (((tp_features.hotkey_mask &&
3027	      hotkey_mask_set(hotkey_orig_mask)) |
3028	     hotkey_status_set(false)) != 0)
3029		pr_err("failed to restore hot key mask "
3030		       "to BIOS defaults\n");
3031}
3032
3033static void __init hotkey_unmap(const unsigned int scancode)
3034{
3035	if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3036		clear_bit(hotkey_keycode_map[scancode],
3037			  tpacpi_inputdev->keybit);
3038		hotkey_keycode_map[scancode] = KEY_RESERVED;
3039	}
3040}
3041
3042/*
3043 * HKEY quirks:
3044 *   TPACPI_HK_Q_INIMASK:	Supports FN+F3,FN+F4,FN+F12
3045 */
3046
3047#define	TPACPI_HK_Q_INIMASK	0x0001
3048
3049static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3050	TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3051	TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3052	TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3053	TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3054	TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3055	TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3056	TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3057	TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3058	TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3059	TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3060	TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3061	TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3062	TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3063	TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3064	TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3065	TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3066	TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3067	TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3068	TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3069};
3070
3071typedef u16 tpacpi_keymap_entry_t;
3072typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3073
3074static int __init hotkey_init(struct ibm_init_struct *iibm)
3075{
3076	/* Requirements for changing the default keymaps:
3077	 *
3078	 * 1. Many of the keys are mapped to KEY_RESERVED for very
3079	 *    good reasons.  Do not change them unless you have deep
3080	 *    knowledge on the IBM and Lenovo ThinkPad firmware for
3081	 *    the various ThinkPad models.  The driver behaves
3082	 *    differently for KEY_RESERVED: such keys have their
3083	 *    hot key mask *unset* in mask_recommended, and also
3084	 *    in the initial hot key mask programmed into the
3085	 *    firmware at driver load time, which means the firm-
3086	 *    ware may react very differently if you change them to
3087	 *    something else;
3088	 *
3089	 * 2. You must be subscribed to the linux-thinkpad and
3090	 *    ibm-acpi-devel mailing lists, and you should read the
3091	 *    list archives since 2007 if you want to change the
3092	 *    keymaps.  This requirement exists so that you will
3093	 *    know the past history of problems with the thinkpad-
3094	 *    acpi driver keymaps, and also that you will be
3095	 *    listening to any bug reports;
3096	 *
3097	 * 3. Do not send thinkpad-acpi specific patches directly to
3098	 *    for merging, *ever*.  Send them to the linux-acpi
3099	 *    mailinglist for comments.  Merging is to be done only
3100	 *    through acpi-test and the ACPI maintainer.
3101	 *
3102	 * If the above is too much to ask, don't change the keymap.
3103	 * Ask the thinkpad-acpi maintainer to do it, instead.
3104	 */
3105
3106	enum keymap_index {
3107		TPACPI_KEYMAP_IBM_GENERIC = 0,
3108		TPACPI_KEYMAP_LENOVO_GENERIC,
3109	};
3110
3111	static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3112	/* Generic keymap for IBM ThinkPads */
3113	[TPACPI_KEYMAP_IBM_GENERIC] = {
3114		/* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3115		KEY_FN_F1,	KEY_BATTERY,	KEY_COFFEE,	KEY_SLEEP,
3116		KEY_WLAN,	KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3117		KEY_FN_F9,	KEY_FN_F10,	KEY_FN_F11,	KEY_SUSPEND,
3118
3119		/* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3120		KEY_UNKNOWN,	/* 0x0C: FN+BACKSPACE */
3121		KEY_UNKNOWN,	/* 0x0D: FN+INSERT */
3122		KEY_UNKNOWN,	/* 0x0E: FN+DELETE */
3123
3124		/* brightness: firmware always reacts to them */
3125		KEY_RESERVED,	/* 0x0F: FN+HOME (brightness up) */
3126		KEY_RESERVED,	/* 0x10: FN+END (brightness down) */
3127
3128		/* Thinklight: firmware always react to it */
3129		KEY_RESERVED,	/* 0x11: FN+PGUP (thinklight toggle) */
3130
3131		KEY_UNKNOWN,	/* 0x12: FN+PGDOWN */
3132		KEY_ZOOM,	/* 0x13: FN+SPACE (zoom) */
3133
3134		/* Volume: firmware always react to it and reprograms
3135		 * the built-in *extra* mixer.  Never map it to control
3136		 * another mixer by default. */
3137		KEY_RESERVED,	/* 0x14: VOLUME UP */
3138		KEY_RESERVED,	/* 0x15: VOLUME DOWN */
3139		KEY_RESERVED,	/* 0x16: MUTE */
3140
3141		KEY_VENDOR,	/* 0x17: Thinkpad/AccessIBM/Lenovo */
3142
3143		/* (assignments unknown, please report if found) */
3144		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3145		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3146		},
3147
3148	/* Generic keymap for Lenovo ThinkPads */
3149	[TPACPI_KEYMAP_LENOVO_GENERIC] = {
3150		/* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3151		KEY_FN_F1,	KEY_COFFEE,	KEY_BATTERY,	KEY_SLEEP,
3152		KEY_WLAN,	KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3153		KEY_FN_F9,	KEY_FN_F10,	KEY_FN_F11,	KEY_SUSPEND,
3154
3155		/* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3156		KEY_UNKNOWN,	/* 0x0C: FN+BACKSPACE */
3157		KEY_UNKNOWN,	/* 0x0D: FN+INSERT */
3158		KEY_UNKNOWN,	/* 0x0E: FN+DELETE */
3159
3160		/* These should be enabled --only-- when ACPI video
3161		 * is disabled (i.e. in "vendor" mode), and are handled
3162		 * in a special way by the init code */
3163		KEY_BRIGHTNESSUP,	/* 0x0F: FN+HOME (brightness up) */
3164		KEY_BRIGHTNESSDOWN,	/* 0x10: FN+END (brightness down) */
3165
3166		KEY_RESERVED,	/* 0x11: FN+PGUP (thinklight toggle) */
3167
3168		KEY_UNKNOWN,	/* 0x12: FN+PGDOWN */
3169		KEY_ZOOM,	/* 0x13: FN+SPACE (zoom) */
3170
3171		/* Volume: z60/z61, T60 (BIOS version?): firmware always
3172		 * react to it and reprograms the built-in *extra* mixer.
3173		 * Never map it to control another mixer by default.
3174		 *
3175		 * T60?, T61, R60?, R61: firmware and EC tries to send
3176		 * these over the regular keyboard, so these are no-ops,
3177		 * but there are still weird bugs re. MUTE, so do not
3178		 * change unless you get test reports from all Lenovo
3179		 * models.  May cause the BIOS to interfere with the
3180		 * HDA mixer.
3181		 */
3182		KEY_RESERVED,	/* 0x14: VOLUME UP */
3183		KEY_RESERVED,	/* 0x15: VOLUME DOWN */
3184		KEY_RESERVED,	/* 0x16: MUTE */
3185
3186		KEY_VENDOR,	/* 0x17: Thinkpad/AccessIBM/Lenovo */
3187
3188		/* (assignments unknown, please report if found) */
3189		KEY_UNKNOWN, KEY_UNKNOWN,
3190
3191		/*
3192		 * The mic mute button only sends 0x1a.  It does not
3193		 * automatically mute the mic or change the mute light.
3194		 */
3195		KEY_MICMUTE,	/* 0x1a: Mic mute (since ?400 or so) */
3196
3197		/* (assignments unknown, please report if found) */
3198		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3199		KEY_UNKNOWN,
3200		},
3201	};
3202
3203	static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3204		/* Generic maps (fallback) */
3205		{
3206		  .vendor = PCI_VENDOR_ID_IBM,
3207		  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3208		  .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3209		},
3210		{
3211		  .vendor = PCI_VENDOR_ID_LENOVO,
3212		  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3213		  .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3214		},
3215	};
3216
3217#define TPACPI_HOTKEY_MAP_SIZE		sizeof(tpacpi_keymap_t)
3218#define TPACPI_HOTKEY_MAP_TYPESIZE	sizeof(tpacpi_keymap_entry_t)
3219
3220	int res, i;
3221	int status;
3222	int hkeyv;
3223	bool radiosw_state  = false;
3224	bool tabletsw_state = false;
3225
3226	unsigned long quirks;
3227	unsigned long keymap_id;
3228
3229	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3230			"initializing hotkey subdriver\n");
3231
3232	BUG_ON(!tpacpi_inputdev);
3233	BUG_ON(tpacpi_inputdev->open != NULL ||
3234	       tpacpi_inputdev->close != NULL);
3235
3236	TPACPI_ACPIHANDLE_INIT(hkey);
3237	mutex_init(&hotkey_mutex);
3238
3239#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3240	mutex_init(&hotkey_thread_mutex);
3241	mutex_init(&hotkey_thread_data_mutex);
3242#endif
3243
3244	/* hotkey not supported on 570 */
3245	tp_features.hotkey = hkey_handle != NULL;
3246
3247	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3248		"hotkeys are %s\n",
3249		str_supported(tp_features.hotkey));
3250
3251	if (!tp_features.hotkey)
3252		return 1;
3253
3254	quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3255				     ARRAY_SIZE(tpacpi_hotkey_qtable));
3256
3257	tpacpi_disable_brightness_delay();
3258
3259	/* MUST have enough space for all attributes to be added to
3260	 * hotkey_dev_attributes */
3261	hotkey_dev_attributes = create_attr_set(
3262					ARRAY_SIZE(hotkey_attributes) + 2,
3263					NULL);
3264	if (!hotkey_dev_attributes)
3265		return -ENOMEM;
3266	res = add_many_to_attr_set(hotkey_dev_attributes,
3267			hotkey_attributes,
3268			ARRAY_SIZE(hotkey_attributes));
3269	if (res)
3270		goto err_exit;
3271
3272	/* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3273	   A30, R30, R31, T20-22, X20-21, X22-24.  Detected by checking
3274	   for HKEY interface version 0x100 */
3275	if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3276		if ((hkeyv >> 8) != 1) {
3277			pr_err("unknown version of the HKEY interface: 0x%x\n",
3278			       hkeyv);
3279			pr_err("please report this to %s\n", TPACPI_MAIL);
3280		} else {
3281			/*
3282			 * MHKV 0x100 in A31, R40, R40e,
3283			 * T4x, X31, and later
3284			 */
3285			vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3286				"firmware HKEY interface version: 0x%x\n",
3287				hkeyv);
3288
3289			/* Paranoia check AND init hotkey_all_mask */
3290			if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3291					"MHKA", "qd")) {
3292				pr_err("missing MHKA handler, "
3293				       "please report this to %s\n",
3294				       TPACPI_MAIL);
3295				/* Fallback: pre-init for FN+F3,F4,F12 */
3296				hotkey_all_mask = 0x080cU;
3297			} else {
3298				tp_features.hotkey_mask = 1;
3299			}
3300		}
3301	}
3302
3303	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3304		"hotkey masks are %s\n",
3305		str_supported(tp_features.hotkey_mask));
3306
3307	/* Init hotkey_all_mask if not initialized yet */
3308	if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3309	    (quirks & TPACPI_HK_Q_INIMASK))
3310		hotkey_all_mask = 0x080cU;  /* FN+F12, FN+F4, FN+F3 */
3311
3312	/* Init hotkey_acpi_mask and hotkey_orig_mask */
3313	if (tp_features.hotkey_mask) {
3314		/* hotkey_source_mask *must* be zero for
3315		 * the first hotkey_mask_get to return hotkey_orig_mask */
3316		res = hotkey_mask_get();
3317		if (res)
3318			goto err_exit;
3319
3320		hotkey_orig_mask = hotkey_acpi_mask;
3321	} else {
3322		hotkey_orig_mask = hotkey_all_mask;
3323		hotkey_acpi_mask = hotkey_all_mask;
3324	}
3325
3326#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3327	if (dbg_wlswemul) {
3328		tp_features.hotkey_wlsw = 1;
3329		radiosw_state = !!tpacpi_wlsw_emulstate;
3330		pr_info("radio switch emulation enabled\n");
3331	} else
3332#endif
3333	/* Not all thinkpads have a hardware radio switch */
3334	if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3335		tp_features.hotkey_wlsw = 1;
3336		radiosw_state = !!status;
3337		pr_info("radio switch found; radios are %s\n",
3338			enabled(status, 0));
3339	}
3340	if (tp_features.hotkey_wlsw)
3341		res = add_to_attr_set(hotkey_dev_attributes,
3342				&dev_attr_hotkey_radio_sw.attr);
3343
3344	/* For X41t, X60t, X61t Tablets... */
3345	if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3346		tp_features.hotkey_tablet = 1;
3347		tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3348		pr_info("possible tablet mode switch found; "
3349			"ThinkPad in %s mode\n",
3350			(tabletsw_state) ? "tablet" : "laptop");
3351		res = add_to_attr_set(hotkey_dev_attributes,
3352				&dev_attr_hotkey_tablet_mode.attr);
3353	}
3354
3355	if (!res)
3356		res = register_attr_set_with_sysfs(
3357				hotkey_dev_attributes,
3358				&tpacpi_pdev->dev.kobj);
3359	if (res)
3360		goto err_exit;
3361
3362	/* Set up key map */
3363	hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3364					GFP_KERNEL);
3365	if (!hotkey_keycode_map) {
3366		pr_err("failed to allocate memory for key map\n");
3367		res = -ENOMEM;
3368		goto err_exit;
3369	}
3370
3371	keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3372					ARRAY_SIZE(tpacpi_keymap_qtable));
3373	BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3374	dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3375		   "using keymap number %lu\n", keymap_id);
3376
3377	memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3378		TPACPI_HOTKEY_MAP_SIZE);
3379
3380	input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3381	tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3382	tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3383	tpacpi_inputdev->keycode = hotkey_keycode_map;
3384	for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3385		if (hotkey_keycode_map[i] != KEY_RESERVED) {
3386			input_set_capability(tpacpi_inputdev, EV_KEY,
3387						hotkey_keycode_map[i]);
3388		} else {
3389			if (i < sizeof(hotkey_reserved_mask)*8)
3390				hotkey_reserved_mask |= 1 << i;
3391		}
3392	}
3393
3394	if (tp_features.hotkey_wlsw) {
3395		input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3396		input_report_switch(tpacpi_inputdev,
3397				    SW_RFKILL_ALL, radiosw_state);
3398	}
3399	if (tp_features.hotkey_tablet) {
3400		input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3401		input_report_switch(tpacpi_inputdev,
3402				    SW_TABLET_MODE, tabletsw_state);
3403	}
3404
3405	/* Do not issue duplicate brightness change events to
3406	 * userspace. tpacpi_detect_brightness_capabilities() must have
3407	 * been called before this point  */
3408	if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3409		pr_info("This ThinkPad has standard ACPI backlight "
3410			"brightness control, supported by the ACPI "
3411			"video driver\n");
3412		pr_notice("Disabling thinkpad-acpi brightness events "
3413			  "by default...\n");
3414
3415		/* Disable brightness up/down on Lenovo thinkpads when
3416		 * ACPI is handling them, otherwise it is plain impossible
3417		 * for userspace to do something even remotely sane */
3418		hotkey_reserved_mask |=
3419			(1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3420			| (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3421		hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3422		hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3423	}
3424
3425#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3426	hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3427				& ~hotkey_all_mask
3428				& ~hotkey_reserved_mask;
3429
3430	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3431		    "hotkey source mask 0x%08x, polling freq %u\n",
3432		    hotkey_source_mask, hotkey_poll_freq);
3433#endif
3434
3435	dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3436			"enabling firmware HKEY event interface...\n");
3437	res = hotkey_status_set(true);
3438	if (res) {
3439		hotkey_exit();
3440		return res;
3441	}
3442	res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3443			       | hotkey_driver_mask)
3444			      & ~hotkey_source_mask);
3445	if (res < 0 && res != -ENXIO) {
3446		hotkey_exit();
3447		return res;
3448	}
3449	hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3450				& ~hotkey_reserved_mask;
3451	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3452		"initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3453		hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3454
3455	dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3456			"legacy ibm/hotkey event reporting over procfs %s\n",
3457			(hotkey_report_mode < 2) ?
3458				"enabled" : "disabled");
3459
3460	tpacpi_inputdev->open = &hotkey_inputdev_open;
3461	tpacpi_inputdev->close = &hotkey_inputdev_close;
3462
3463	hotkey_poll_setup_safe(true);
3464
3465	return 0;
3466
3467err_exit:
3468	delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3469	hotkey_dev_attributes = NULL;
3470
3471	return (res < 0)? res : 1;
3472}
3473
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3474static bool hotkey_notify_hotkey(const u32 hkey,
3475				 bool *send_acpi_ev,
3476				 bool *ignore_acpi_ev)
3477{
3478	/* 0x1000-0x1FFF: key presses */
3479	unsigned int scancode = hkey & 0xfff;
3480	*send_acpi_ev = true;
3481	*ignore_acpi_ev = false;
3482
3483	/* HKEY event 0x1001 is scancode 0x00 */
3484	if (scancode > 0 && scancode <= TPACPI_HOTKEY_MAP_LEN) {
3485		scancode--;
3486		if (!(hotkey_source_mask & (1 << scancode))) {
3487			tpacpi_input_send_key_masked(scancode);
3488			*send_acpi_ev = false;
3489		} else {
3490			*ignore_acpi_ev = true;
3491		}
3492		return true;
 
 
3493	}
3494	return false;
3495}
3496
3497static bool hotkey_notify_wakeup(const u32 hkey,
3498				 bool *send_acpi_ev,
3499				 bool *ignore_acpi_ev)
3500{
3501	/* 0x2000-0x2FFF: Wakeup reason */
3502	*send_acpi_ev = true;
3503	*ignore_acpi_ev = false;
3504
3505	switch (hkey) {
3506	case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3507	case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3508		hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3509		*ignore_acpi_ev = true;
3510		break;
3511
3512	case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3513	case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3514		hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3515		*ignore_acpi_ev = true;
3516		break;
3517
3518	case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3519	case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3520		pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3521		/* how to auto-heal: */
3522		/* 2313: woke up from S3, go to S4/S5 */
3523		/* 2413: woke up from S4, go to S5 */
3524		break;
3525
3526	default:
3527		return false;
3528	}
3529
3530	if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3531		pr_info("woke up due to a hot-unplug request...\n");
3532		hotkey_wakeup_reason_notify_change();
3533	}
3534	return true;
3535}
3536
3537static bool hotkey_notify_dockevent(const u32 hkey,
3538				 bool *send_acpi_ev,
3539				 bool *ignore_acpi_ev)
3540{
3541	/* 0x4000-0x4FFF: dock-related events */
3542	*send_acpi_ev = true;
3543	*ignore_acpi_ev = false;
3544
3545	switch (hkey) {
3546	case TP_HKEY_EV_UNDOCK_ACK:
3547		/* ACPI undock operation completed after wakeup */
3548		hotkey_autosleep_ack = 1;
3549		pr_info("undocked\n");
3550		hotkey_wakeup_hotunplug_complete_notify_change();
3551		return true;
3552
3553	case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3554		pr_info("docked into hotplug port replicator\n");
3555		return true;
3556	case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3557		pr_info("undocked from hotplug port replicator\n");
3558		return true;
3559
3560	default:
3561		return false;
3562	}
3563}
3564
3565static bool hotkey_notify_usrevent(const u32 hkey,
3566				 bool *send_acpi_ev,
3567				 bool *ignore_acpi_ev)
3568{
3569	/* 0x5000-0x5FFF: human interface helpers */
3570	*send_acpi_ev = true;
3571	*ignore_acpi_ev = false;
3572
3573	switch (hkey) {
3574	case TP_HKEY_EV_PEN_INSERTED:  /* X61t: tablet pen inserted into bay */
3575	case TP_HKEY_EV_PEN_REMOVED:   /* X61t: tablet pen removed from bay */
3576		return true;
3577
3578	case TP_HKEY_EV_TABLET_TABLET:   /* X41t-X61t: tablet mode */
3579	case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3580		tpacpi_input_send_tabletsw();
3581		hotkey_tablet_mode_notify_change();
3582		*send_acpi_ev = false;
3583		return true;
3584
3585	case TP_HKEY_EV_LID_CLOSE:	/* Lid closed */
3586	case TP_HKEY_EV_LID_OPEN:	/* Lid opened */
3587	case TP_HKEY_EV_BRGHT_CHANGED:	/* brightness changed */
3588		/* do not propagate these events */
3589		*ignore_acpi_ev = true;
3590		return true;
3591
3592	default:
3593		return false;
3594	}
3595}
3596
3597static void thermal_dump_all_sensors(void);
3598
3599static bool hotkey_notify_6xxx(const u32 hkey,
3600				 bool *send_acpi_ev,
3601				 bool *ignore_acpi_ev)
3602{
3603	bool known = true;
3604
3605	/* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
3606	*send_acpi_ev = true;
3607	*ignore_acpi_ev = false;
3608
3609	switch (hkey) {
3610	case TP_HKEY_EV_THM_TABLE_CHANGED:
3611		pr_info("EC reports that Thermal Table has changed\n");
3612		/* recommended action: do nothing, we don't have
3613		 * Lenovo ATM information */
3614		return true;
3615	case TP_HKEY_EV_ALARM_BAT_HOT:
3616		pr_crit("THERMAL ALARM: battery is too hot!\n");
3617		/* recommended action: warn user through gui */
3618		break;
3619	case TP_HKEY_EV_ALARM_BAT_XHOT:
3620		pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
3621		/* recommended action: immediate sleep/hibernate */
3622		break;
3623	case TP_HKEY_EV_ALARM_SENSOR_HOT:
3624		pr_crit("THERMAL ALARM: "
3625			"a sensor reports something is too hot!\n");
3626		/* recommended action: warn user through gui, that */
3627		/* some internal component is too hot */
3628		break;
3629	case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3630		pr_alert("THERMAL EMERGENCY: "
3631			 "a sensor reports something is extremely hot!\n");
3632		/* recommended action: immediate sleep/hibernate */
3633		break;
 
 
 
 
 
 
3634
3635	case TP_HKEY_EV_KEY_NUMLOCK:
3636	case TP_HKEY_EV_KEY_FN:
3637		/* key press events, we just ignore them as long as the EC
3638		 * is still reporting them in the normal keyboard stream */
3639		*send_acpi_ev = false;
3640		*ignore_acpi_ev = true;
3641		return true;
3642
3643	default:
3644		pr_warn("unknown possible thermal alarm or keyboard event received\n");
3645		known = false;
3646	}
3647
3648	thermal_dump_all_sensors();
3649
3650	return known;
3651}
3652
3653static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3654{
3655	u32 hkey;
3656	bool send_acpi_ev;
3657	bool ignore_acpi_ev;
3658	bool known_ev;
3659
3660	if (event != 0x80) {
3661		pr_err("unknown HKEY notification event %d\n", event);
3662		/* forward it to userspace, maybe it knows how to handle it */
3663		acpi_bus_generate_netlink_event(
3664					ibm->acpi->device->pnp.device_class,
3665					dev_name(&ibm->acpi->device->dev),
3666					event, 0);
3667		return;
3668	}
3669
3670	while (1) {
3671		if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3672			pr_err("failed to retrieve HKEY event\n");
3673			return;
3674		}
3675
3676		if (hkey == 0) {
3677			/* queue empty */
3678			return;
3679		}
3680
3681		send_acpi_ev = true;
3682		ignore_acpi_ev = false;
3683
3684		switch (hkey >> 12) {
3685		case 1:
3686			/* 0x1000-0x1FFF: key presses */
3687			known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3688						 &ignore_acpi_ev);
3689			break;
3690		case 2:
3691			/* 0x2000-0x2FFF: Wakeup reason */
3692			known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3693						 &ignore_acpi_ev);
3694			break;
3695		case 3:
3696			/* 0x3000-0x3FFF: bay-related wakeups */
3697			switch (hkey) {
3698			case TP_HKEY_EV_BAYEJ_ACK:
3699				hotkey_autosleep_ack = 1;
3700				pr_info("bay ejected\n");
3701				hotkey_wakeup_hotunplug_complete_notify_change();
3702				known_ev = true;
3703				break;
3704			case TP_HKEY_EV_OPTDRV_EJ:
3705				/* FIXME: kick libata if SATA link offline */
3706				known_ev = true;
3707				break;
3708			default:
3709				known_ev = false;
3710			}
3711			break;
3712		case 4:
3713			/* 0x4000-0x4FFF: dock-related events */
3714			known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
3715						&ignore_acpi_ev);
3716			break;
3717		case 5:
3718			/* 0x5000-0x5FFF: human interface helpers */
3719			known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3720						 &ignore_acpi_ev);
3721			break;
3722		case 6:
3723			/* 0x6000-0x6FFF: thermal alarms/notices and
3724			 *                keyboard events */
3725			known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
3726						 &ignore_acpi_ev);
3727			break;
3728		case 7:
3729			/* 0x7000-0x7FFF: misc */
3730			if (tp_features.hotkey_wlsw &&
3731					hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3732				tpacpi_send_radiosw_update();
3733				send_acpi_ev = 0;
3734				known_ev = true;
3735				break;
3736			}
3737			/* fallthrough to default */
3738		default:
3739			known_ev = false;
3740		}
3741		if (!known_ev) {
3742			pr_notice("unhandled HKEY event 0x%04x\n", hkey);
3743			pr_notice("please report the conditions when this "
3744				  "event happened to %s\n", TPACPI_MAIL);
3745		}
3746
3747		/* Legacy events */
3748		if (!ignore_acpi_ev &&
3749		    (send_acpi_ev || hotkey_report_mode < 2)) {
3750			acpi_bus_generate_proc_event(ibm->acpi->device,
3751						     event, hkey);
3752		}
3753
3754		/* netlink events */
3755		if (!ignore_acpi_ev && send_acpi_ev) {
3756			acpi_bus_generate_netlink_event(
3757					ibm->acpi->device->pnp.device_class,
3758					dev_name(&ibm->acpi->device->dev),
3759					event, hkey);
3760		}
3761	}
3762}
3763
3764static void hotkey_suspend(pm_message_t state)
3765{
 
 
3766	/* Do these on suspend, we get the events on early resume! */
3767	hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3768	hotkey_autosleep_ack = 0;
 
 
 
 
 
 
 
 
 
 
 
3769}
3770
3771static void hotkey_resume(void)
3772{
 
 
3773	tpacpi_disable_brightness_delay();
3774
3775	if (hotkey_status_set(true) < 0 ||
3776	    hotkey_mask_set(hotkey_acpi_mask) < 0)
3777		pr_err("error while attempting to reset the event "
3778		       "firmware interface\n");
3779
3780	tpacpi_send_radiosw_update();
3781	hotkey_tablet_mode_notify_change();
3782	hotkey_wakeup_reason_notify_change();
3783	hotkey_wakeup_hotunplug_complete_notify_change();
3784	hotkey_poll_setup_safe(false);
 
 
 
 
 
 
 
 
 
 
 
 
3785}
3786
3787/* procfs -------------------------------------------------------------- */
3788static int hotkey_read(struct seq_file *m)
3789{
3790	int res, status;
3791
3792	if (!tp_features.hotkey) {
3793		seq_printf(m, "status:\t\tnot supported\n");
3794		return 0;
3795	}
3796
3797	if (mutex_lock_killable(&hotkey_mutex))
3798		return -ERESTARTSYS;
3799	res = hotkey_status_get(&status);
3800	if (!res)
3801		res = hotkey_mask_get();
3802	mutex_unlock(&hotkey_mutex);
3803	if (res)
3804		return res;
3805
3806	seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3807	if (hotkey_all_mask) {
3808		seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3809		seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3810	} else {
3811		seq_printf(m, "mask:\t\tnot supported\n");
3812		seq_printf(m, "commands:\tenable, disable, reset\n");
3813	}
3814
3815	return 0;
3816}
3817
3818static void hotkey_enabledisable_warn(bool enable)
3819{
3820	tpacpi_log_usertask("procfs hotkey enable/disable");
3821	if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3822		  pr_fmt("hotkey enable/disable functionality has been "
3823			 "removed from the driver.  "
3824			 "Hotkeys are always enabled.\n")))
3825		pr_err("Please remove the hotkey=enable module "
3826		       "parameter, it is deprecated.  "
3827		       "Hotkeys are always enabled.\n");
3828}
3829
3830static int hotkey_write(char *buf)
3831{
3832	int res;
3833	u32 mask;
3834	char *cmd;
3835
3836	if (!tp_features.hotkey)
3837		return -ENODEV;
3838
3839	if (mutex_lock_killable(&hotkey_mutex))
3840		return -ERESTARTSYS;
3841
3842	mask = hotkey_user_mask;
3843
3844	res = 0;
3845	while ((cmd = next_cmd(&buf))) {
3846		if (strlencmp(cmd, "enable") == 0) {
3847			hotkey_enabledisable_warn(1);
3848		} else if (strlencmp(cmd, "disable") == 0) {
3849			hotkey_enabledisable_warn(0);
3850			res = -EPERM;
3851		} else if (strlencmp(cmd, "reset") == 0) {
3852			mask = (hotkey_all_mask | hotkey_source_mask)
3853				& ~hotkey_reserved_mask;
3854		} else if (sscanf(cmd, "0x%x", &mask) == 1) {
3855			/* mask set */
3856		} else if (sscanf(cmd, "%x", &mask) == 1) {
3857			/* mask set */
3858		} else {
3859			res = -EINVAL;
3860			goto errexit;
3861		}
3862	}
3863
3864	if (!res) {
3865		tpacpi_disclose_usertask("procfs hotkey",
3866			"set mask to 0x%08x\n", mask);
3867		res = hotkey_user_mask_set(mask);
3868	}
3869
3870errexit:
3871	mutex_unlock(&hotkey_mutex);
3872	return res;
3873}
3874
3875static const struct acpi_device_id ibm_htk_device_ids[] = {
3876	{TPACPI_ACPI_IBM_HKEY_HID, 0},
3877	{TPACPI_ACPI_LENOVO_HKEY_HID, 0},
3878	{"", 0},
3879};
3880
3881static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3882	.hid = ibm_htk_device_ids,
3883	.notify = hotkey_notify,
3884	.handle = &hkey_handle,
3885	.type = ACPI_DEVICE_NOTIFY,
3886};
3887
3888static struct ibm_struct hotkey_driver_data = {
3889	.name = "hotkey",
3890	.read = hotkey_read,
3891	.write = hotkey_write,
3892	.exit = hotkey_exit,
3893	.resume = hotkey_resume,
3894	.suspend = hotkey_suspend,
3895	.acpi = &ibm_hotkey_acpidriver,
3896};
3897
3898/*************************************************************************
3899 * Bluetooth subdriver
3900 */
3901
3902enum {
3903	/* ACPI GBDC/SBDC bits */
3904	TP_ACPI_BLUETOOTH_HWPRESENT	= 0x01,	/* Bluetooth hw available */
3905	TP_ACPI_BLUETOOTH_RADIOSSW	= 0x02,	/* Bluetooth radio enabled */
3906	TP_ACPI_BLUETOOTH_RESUMECTRL	= 0x04,	/* Bluetooth state at resume:
3907						   0 = disable, 1 = enable */
3908};
3909
3910enum {
3911	/* ACPI \BLTH commands */
3912	TP_ACPI_BLTH_GET_ULTRAPORT_ID	= 0x00, /* Get Ultraport BT ID */
3913	TP_ACPI_BLTH_GET_PWR_ON_RESUME	= 0x01, /* Get power-on-resume state */
3914	TP_ACPI_BLTH_PWR_ON_ON_RESUME	= 0x02, /* Resume powered on */
3915	TP_ACPI_BLTH_PWR_OFF_ON_RESUME	= 0x03,	/* Resume powered off */
3916	TP_ACPI_BLTH_SAVE_STATE		= 0x05, /* Save state for S4/S5 */
3917};
3918
3919#define TPACPI_RFK_BLUETOOTH_SW_NAME	"tpacpi_bluetooth_sw"
3920
3921static int bluetooth_get_status(void)
3922{
3923	int status;
3924
3925#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3926	if (dbg_bluetoothemul)
3927		return (tpacpi_bluetooth_emulstate) ?
3928		       TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3929#endif
3930
3931	if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3932		return -EIO;
3933
3934	return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3935			TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3936}
3937
3938static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3939{
3940	int status;
3941
3942	vdbg_printk(TPACPI_DBG_RFKILL,
3943		"will attempt to %s bluetooth\n",
3944		(state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3945
3946#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3947	if (dbg_bluetoothemul) {
3948		tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3949		return 0;
3950	}
3951#endif
3952
3953	if (state == TPACPI_RFK_RADIO_ON)
3954		status = TP_ACPI_BLUETOOTH_RADIOSSW
3955			  | TP_ACPI_BLUETOOTH_RESUMECTRL;
3956	else
3957		status = 0;
3958
3959	if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3960		return -EIO;
3961
3962	return 0;
3963}
3964
3965/* sysfs bluetooth enable ---------------------------------------------- */
3966static ssize_t bluetooth_enable_show(struct device *dev,
3967			   struct device_attribute *attr,
3968			   char *buf)
3969{
3970	return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3971			attr, buf);
3972}
3973
3974static ssize_t bluetooth_enable_store(struct device *dev,
3975			    struct device_attribute *attr,
3976			    const char *buf, size_t count)
3977{
3978	return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3979				attr, buf, count);
3980}
3981
3982static struct device_attribute dev_attr_bluetooth_enable =
3983	__ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3984		bluetooth_enable_show, bluetooth_enable_store);
3985
3986/* --------------------------------------------------------------------- */
3987
3988static struct attribute *bluetooth_attributes[] = {
3989	&dev_attr_bluetooth_enable.attr,
3990	NULL
3991};
3992
3993static const struct attribute_group bluetooth_attr_group = {
3994	.attrs = bluetooth_attributes,
3995};
3996
3997static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
3998	.get_status = bluetooth_get_status,
3999	.set_status = bluetooth_set_status,
4000};
4001
4002static void bluetooth_shutdown(void)
4003{
4004	/* Order firmware to save current state to NVRAM */
4005	if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4006			TP_ACPI_BLTH_SAVE_STATE))
4007		pr_notice("failed to save bluetooth state to NVRAM\n");
4008	else
4009		vdbg_printk(TPACPI_DBG_RFKILL,
4010			"bluestooth state saved to NVRAM\n");
4011}
4012
4013static void bluetooth_exit(void)
4014{
4015	sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4016			&bluetooth_attr_group);
4017
4018	tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4019
4020	bluetooth_shutdown();
4021}
4022
4023static int __init bluetooth_init(struct ibm_init_struct *iibm)
4024{
4025	int res;
4026	int status = 0;
4027
4028	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4029			"initializing bluetooth subdriver\n");
4030
4031	TPACPI_ACPIHANDLE_INIT(hkey);
4032
4033	/* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4034	   G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4035	tp_features.bluetooth = hkey_handle &&
4036	    acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4037
4038	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4039		"bluetooth is %s, status 0x%02x\n",
4040		str_supported(tp_features.bluetooth),
4041		status);
4042
4043#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4044	if (dbg_bluetoothemul) {
4045		tp_features.bluetooth = 1;
4046		pr_info("bluetooth switch emulation enabled\n");
4047	} else
4048#endif
4049	if (tp_features.bluetooth &&
4050	    !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4051		/* no bluetooth hardware present in system */
4052		tp_features.bluetooth = 0;
4053		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4054			   "bluetooth hardware not installed\n");
4055	}
4056
4057	if (!tp_features.bluetooth)
4058		return 1;
4059
4060	res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4061				&bluetooth_tprfk_ops,
4062				RFKILL_TYPE_BLUETOOTH,
4063				TPACPI_RFK_BLUETOOTH_SW_NAME,
4064				true);
4065	if (res)
4066		return res;
4067
4068	res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4069				&bluetooth_attr_group);
4070	if (res) {
4071		tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4072		return res;
4073	}
4074
4075	return 0;
4076}
4077
4078/* procfs -------------------------------------------------------------- */
4079static int bluetooth_read(struct seq_file *m)
4080{
4081	return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4082}
4083
4084static int bluetooth_write(char *buf)
4085{
4086	return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4087}
4088
4089static struct ibm_struct bluetooth_driver_data = {
4090	.name = "bluetooth",
4091	.read = bluetooth_read,
4092	.write = bluetooth_write,
4093	.exit = bluetooth_exit,
4094	.shutdown = bluetooth_shutdown,
4095};
4096
4097/*************************************************************************
4098 * Wan subdriver
4099 */
4100
4101enum {
4102	/* ACPI GWAN/SWAN bits */
4103	TP_ACPI_WANCARD_HWPRESENT	= 0x01,	/* Wan hw available */
4104	TP_ACPI_WANCARD_RADIOSSW	= 0x02,	/* Wan radio enabled */
4105	TP_ACPI_WANCARD_RESUMECTRL	= 0x04,	/* Wan state at resume:
4106						   0 = disable, 1 = enable */
4107};
4108
4109#define TPACPI_RFK_WWAN_SW_NAME		"tpacpi_wwan_sw"
4110
4111static int wan_get_status(void)
4112{
4113	int status;
4114
4115#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4116	if (dbg_wwanemul)
4117		return (tpacpi_wwan_emulstate) ?
4118		       TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4119#endif
4120
4121	if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4122		return -EIO;
4123
4124	return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4125			TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4126}
4127
4128static int wan_set_status(enum tpacpi_rfkill_state state)
4129{
4130	int status;
4131
4132	vdbg_printk(TPACPI_DBG_RFKILL,
4133		"will attempt to %s wwan\n",
4134		(state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4135
4136#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4137	if (dbg_wwanemul) {
4138		tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4139		return 0;
4140	}
4141#endif
4142
4143	if (state == TPACPI_RFK_RADIO_ON)
4144		status = TP_ACPI_WANCARD_RADIOSSW
4145			 | TP_ACPI_WANCARD_RESUMECTRL;
4146	else
4147		status = 0;
4148
4149	if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4150		return -EIO;
4151
4152	return 0;
4153}
4154
4155/* sysfs wan enable ---------------------------------------------------- */
4156static ssize_t wan_enable_show(struct device *dev,
4157			   struct device_attribute *attr,
4158			   char *buf)
4159{
4160	return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4161			attr, buf);
4162}
4163
4164static ssize_t wan_enable_store(struct device *dev,
4165			    struct device_attribute *attr,
4166			    const char *buf, size_t count)
4167{
4168	return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4169			attr, buf, count);
4170}
4171
4172static struct device_attribute dev_attr_wan_enable =
4173	__ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4174		wan_enable_show, wan_enable_store);
4175
4176/* --------------------------------------------------------------------- */
4177
4178static struct attribute *wan_attributes[] = {
4179	&dev_attr_wan_enable.attr,
4180	NULL
4181};
4182
4183static const struct attribute_group wan_attr_group = {
4184	.attrs = wan_attributes,
4185};
4186
4187static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4188	.get_status = wan_get_status,
4189	.set_status = wan_set_status,
4190};
4191
4192static void wan_shutdown(void)
4193{
4194	/* Order firmware to save current state to NVRAM */
4195	if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4196			TP_ACPI_WGSV_SAVE_STATE))
4197		pr_notice("failed to save WWAN state to NVRAM\n");
4198	else
4199		vdbg_printk(TPACPI_DBG_RFKILL,
4200			"WWAN state saved to NVRAM\n");
4201}
4202
4203static void wan_exit(void)
4204{
4205	sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4206		&wan_attr_group);
4207
4208	tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4209
4210	wan_shutdown();
4211}
4212
4213static int __init wan_init(struct ibm_init_struct *iibm)
4214{
4215	int res;
4216	int status = 0;
4217
4218	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4219			"initializing wan subdriver\n");
4220
4221	TPACPI_ACPIHANDLE_INIT(hkey);
4222
4223	tp_features.wan = hkey_handle &&
4224	    acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4225
4226	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4227		"wan is %s, status 0x%02x\n",
4228		str_supported(tp_features.wan),
4229		status);
4230
4231#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4232	if (dbg_wwanemul) {
4233		tp_features.wan = 1;
4234		pr_info("wwan switch emulation enabled\n");
4235	} else
4236#endif
4237	if (tp_features.wan &&
4238	    !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4239		/* no wan hardware present in system */
4240		tp_features.wan = 0;
4241		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4242			   "wan hardware not installed\n");
4243	}
4244
4245	if (!tp_features.wan)
4246		return 1;
4247
4248	res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4249				&wan_tprfk_ops,
4250				RFKILL_TYPE_WWAN,
4251				TPACPI_RFK_WWAN_SW_NAME,
4252				true);
4253	if (res)
4254		return res;
4255
4256	res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4257				&wan_attr_group);
4258
4259	if (res) {
4260		tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4261		return res;
4262	}
4263
4264	return 0;
4265}
4266
4267/* procfs -------------------------------------------------------------- */
4268static int wan_read(struct seq_file *m)
4269{
4270	return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4271}
4272
4273static int wan_write(char *buf)
4274{
4275	return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4276}
4277
4278static struct ibm_struct wan_driver_data = {
4279	.name = "wan",
4280	.read = wan_read,
4281	.write = wan_write,
4282	.exit = wan_exit,
4283	.shutdown = wan_shutdown,
4284};
4285
4286/*************************************************************************
4287 * UWB subdriver
4288 */
4289
4290enum {
4291	/* ACPI GUWB/SUWB bits */
4292	TP_ACPI_UWB_HWPRESENT	= 0x01,	/* UWB hw available */
4293	TP_ACPI_UWB_RADIOSSW	= 0x02,	/* UWB radio enabled */
4294};
4295
4296#define TPACPI_RFK_UWB_SW_NAME	"tpacpi_uwb_sw"
4297
4298static int uwb_get_status(void)
4299{
4300	int status;
4301
4302#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4303	if (dbg_uwbemul)
4304		return (tpacpi_uwb_emulstate) ?
4305		       TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4306#endif
4307
4308	if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4309		return -EIO;
4310
4311	return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4312			TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4313}
4314
4315static int uwb_set_status(enum tpacpi_rfkill_state state)
4316{
4317	int status;
4318
4319	vdbg_printk(TPACPI_DBG_RFKILL,
4320		"will attempt to %s UWB\n",
4321		(state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4322
4323#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4324	if (dbg_uwbemul) {
4325		tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4326		return 0;
4327	}
4328#endif
4329
4330	if (state == TPACPI_RFK_RADIO_ON)
4331		status = TP_ACPI_UWB_RADIOSSW;
4332	else
4333		status = 0;
4334
4335	if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4336		return -EIO;
4337
4338	return 0;
4339}
4340
4341/* --------------------------------------------------------------------- */
4342
4343static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4344	.get_status = uwb_get_status,
4345	.set_status = uwb_set_status,
4346};
4347
4348static void uwb_exit(void)
4349{
4350	tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4351}
4352
4353static int __init uwb_init(struct ibm_init_struct *iibm)
4354{
4355	int res;
4356	int status = 0;
4357
4358	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4359			"initializing uwb subdriver\n");
4360
4361	TPACPI_ACPIHANDLE_INIT(hkey);
4362
4363	tp_features.uwb = hkey_handle &&
4364	    acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4365
4366	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4367		"uwb is %s, status 0x%02x\n",
4368		str_supported(tp_features.uwb),
4369		status);
4370
4371#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4372	if (dbg_uwbemul) {
4373		tp_features.uwb = 1;
4374		pr_info("uwb switch emulation enabled\n");
4375	} else
4376#endif
4377	if (tp_features.uwb &&
4378	    !(status & TP_ACPI_UWB_HWPRESENT)) {
4379		/* no uwb hardware present in system */
4380		tp_features.uwb = 0;
4381		dbg_printk(TPACPI_DBG_INIT,
4382			   "uwb hardware not installed\n");
4383	}
4384
4385	if (!tp_features.uwb)
4386		return 1;
4387
4388	res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4389				&uwb_tprfk_ops,
4390				RFKILL_TYPE_UWB,
4391				TPACPI_RFK_UWB_SW_NAME,
4392				false);
4393	return res;
4394}
4395
4396static struct ibm_struct uwb_driver_data = {
4397	.name = "uwb",
4398	.exit = uwb_exit,
4399	.flags.experimental = 1,
4400};
4401
4402/*************************************************************************
4403 * Video subdriver
4404 */
4405
4406#ifdef CONFIG_THINKPAD_ACPI_VIDEO
4407
4408enum video_access_mode {
4409	TPACPI_VIDEO_NONE = 0,
4410	TPACPI_VIDEO_570,	/* 570 */
4411	TPACPI_VIDEO_770,	/* 600e/x, 770e, 770x */
4412	TPACPI_VIDEO_NEW,	/* all others */
4413};
4414
4415enum {	/* video status flags, based on VIDEO_570 */
4416	TP_ACPI_VIDEO_S_LCD = 0x01,	/* LCD output enabled */
4417	TP_ACPI_VIDEO_S_CRT = 0x02,	/* CRT output enabled */
4418	TP_ACPI_VIDEO_S_DVI = 0x08,	/* DVI output enabled */
4419};
4420
4421enum {  /* TPACPI_VIDEO_570 constants */
4422	TP_ACPI_VIDEO_570_PHSCMD = 0x87,	/* unknown magic constant :( */
4423	TP_ACPI_VIDEO_570_PHSMASK = 0x03,	/* PHS bits that map to
4424						 * video_status_flags */
4425	TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,	/* unknown magic constant :( */
4426	TP_ACPI_VIDEO_570_PHS2SET = 0x80,	/* unknown magic constant :( */
4427};
4428
4429static enum video_access_mode video_supported;
4430static int video_orig_autosw;
4431
4432static int video_autosw_get(void);
4433static int video_autosw_set(int enable);
4434
4435TPACPI_HANDLE(vid, root,
4436	      "\\_SB.PCI.AGP.VGA",	/* 570 */
4437	      "\\_SB.PCI0.AGP0.VID0",	/* 600e/x, 770x */
4438	      "\\_SB.PCI0.VID0",	/* 770e */
4439	      "\\_SB.PCI0.VID",		/* A21e, G4x, R50e, X30, X40 */
4440	      "\\_SB.PCI0.AGP.VGA",	/* X100e and a few others */
4441	      "\\_SB.PCI0.AGP.VID",	/* all others */
4442	);				/* R30, R31 */
4443
4444TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID");	/* G41 */
4445
4446static int __init video_init(struct ibm_init_struct *iibm)
4447{
4448	int ivga;
4449
4450	vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4451
4452	TPACPI_ACPIHANDLE_INIT(vid);
4453	if (tpacpi_is_ibm())
4454		TPACPI_ACPIHANDLE_INIT(vid2);
4455
4456	if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4457		/* G41, assume IVGA doesn't change */
4458		vid_handle = vid2_handle;
4459
4460	if (!vid_handle)
4461		/* video switching not supported on R30, R31 */
4462		video_supported = TPACPI_VIDEO_NONE;
4463	else if (tpacpi_is_ibm() &&
4464		 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4465		/* 570 */
4466		video_supported = TPACPI_VIDEO_570;
4467	else if (tpacpi_is_ibm() &&
4468		 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4469		/* 600e/x, 770e, 770x */
4470		video_supported = TPACPI_VIDEO_770;
4471	else
4472		/* all others */
4473		video_supported = TPACPI_VIDEO_NEW;
4474
4475	vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4476		str_supported(video_supported != TPACPI_VIDEO_NONE),
4477		video_supported);
4478
4479	return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4480}
4481
4482static void video_exit(void)
4483{
4484	dbg_printk(TPACPI_DBG_EXIT,
4485		   "restoring original video autoswitch mode\n");
4486	if (video_autosw_set(video_orig_autosw))
4487		pr_err("error while trying to restore original "
4488			"video autoswitch mode\n");
4489}
4490
4491static int video_outputsw_get(void)
4492{
4493	int status = 0;
4494	int i;
4495
4496	switch (video_supported) {
4497	case TPACPI_VIDEO_570:
4498		if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4499				 TP_ACPI_VIDEO_570_PHSCMD))
4500			return -EIO;
4501		status = i & TP_ACPI_VIDEO_570_PHSMASK;
4502		break;
4503	case TPACPI_VIDEO_770:
4504		if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4505			return -EIO;
4506		if (i)
4507			status |= TP_ACPI_VIDEO_S_LCD;
4508		if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4509			return -EIO;
4510		if (i)
4511			status |= TP_ACPI_VIDEO_S_CRT;
4512		break;
4513	case TPACPI_VIDEO_NEW:
4514		if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4515		    !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4516			return -EIO;
4517		if (i)
4518			status |= TP_ACPI_VIDEO_S_CRT;
4519
4520		if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4521		    !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4522			return -EIO;
4523		if (i)
4524			status |= TP_ACPI_VIDEO_S_LCD;
4525		if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4526			return -EIO;
4527		if (i)
4528			status |= TP_ACPI_VIDEO_S_DVI;
4529		break;
4530	default:
4531		return -ENOSYS;
4532	}
4533
4534	return status;
4535}
4536
4537static int video_outputsw_set(int status)
4538{
4539	int autosw;
4540	int res = 0;
4541
4542	switch (video_supported) {
4543	case TPACPI_VIDEO_570:
4544		res = acpi_evalf(NULL, NULL,
4545				 "\\_SB.PHS2", "vdd",
4546				 TP_ACPI_VIDEO_570_PHS2CMD,
4547				 status | TP_ACPI_VIDEO_570_PHS2SET);
4548		break;
4549	case TPACPI_VIDEO_770:
4550		autosw = video_autosw_get();
4551		if (autosw < 0)
4552			return autosw;
4553
4554		res = video_autosw_set(1);
4555		if (res)
4556			return res;
4557		res = acpi_evalf(vid_handle, NULL,
4558				 "ASWT", "vdd", status * 0x100, 0);
4559		if (!autosw && video_autosw_set(autosw)) {
4560			pr_err("video auto-switch left enabled due to error\n");
4561			return -EIO;
4562		}
4563		break;
4564	case TPACPI_VIDEO_NEW:
4565		res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4566		      acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4567		break;
4568	default:
4569		return -ENOSYS;
4570	}
4571
4572	return (res)? 0 : -EIO;
4573}
4574
4575static int video_autosw_get(void)
4576{
4577	int autosw = 0;
4578
4579	switch (video_supported) {
4580	case TPACPI_VIDEO_570:
4581		if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4582			return -EIO;
4583		break;
4584	case TPACPI_VIDEO_770:
4585	case TPACPI_VIDEO_NEW:
4586		if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4587			return -EIO;
4588		break;
4589	default:
4590		return -ENOSYS;
4591	}
4592
4593	return autosw & 1;
4594}
4595
4596static int video_autosw_set(int enable)
4597{
4598	if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4599		return -EIO;
4600	return 0;
4601}
4602
4603static int video_outputsw_cycle(void)
4604{
4605	int autosw = video_autosw_get();
4606	int res;
4607
4608	if (autosw < 0)
4609		return autosw;
4610
4611	switch (video_supported) {
4612	case TPACPI_VIDEO_570:
4613		res = video_autosw_set(1);
4614		if (res)
4615			return res;
4616		res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4617		break;
4618	case TPACPI_VIDEO_770:
4619	case TPACPI_VIDEO_NEW:
4620		res = video_autosw_set(1);
4621		if (res)
4622			return res;
4623		res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4624		break;
4625	default:
4626		return -ENOSYS;
4627	}
4628	if (!autosw && video_autosw_set(autosw)) {
4629		pr_err("video auto-switch left enabled due to error\n");
4630		return -EIO;
4631	}
4632
4633	return (res)? 0 : -EIO;
4634}
4635
4636static int video_expand_toggle(void)
4637{
4638	switch (video_supported) {
4639	case TPACPI_VIDEO_570:
4640		return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4641			0 : -EIO;
4642	case TPACPI_VIDEO_770:
4643		return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4644			0 : -EIO;
4645	case TPACPI_VIDEO_NEW:
4646		return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4647			0 : -EIO;
4648	default:
4649		return -ENOSYS;
4650	}
4651	/* not reached */
4652}
4653
4654static int video_read(struct seq_file *m)
4655{
4656	int status, autosw;
4657
4658	if (video_supported == TPACPI_VIDEO_NONE) {
4659		seq_printf(m, "status:\t\tnot supported\n");
4660		return 0;
4661	}
4662
4663	/* Even reads can crash X.org, so... */
4664	if (!capable(CAP_SYS_ADMIN))
4665		return -EPERM;
4666
4667	status = video_outputsw_get();
4668	if (status < 0)
4669		return status;
4670
4671	autosw = video_autosw_get();
4672	if (autosw < 0)
4673		return autosw;
4674
4675	seq_printf(m, "status:\t\tsupported\n");
4676	seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4677	seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4678	if (video_supported == TPACPI_VIDEO_NEW)
4679		seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4680	seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4681	seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4682	seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4683	if (video_supported == TPACPI_VIDEO_NEW)
4684		seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4685	seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4686	seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4687
4688	return 0;
4689}
4690
4691static int video_write(char *buf)
4692{
4693	char *cmd;
4694	int enable, disable, status;
4695	int res;
4696
4697	if (video_supported == TPACPI_VIDEO_NONE)
4698		return -ENODEV;
4699
4700	/* Even reads can crash X.org, let alone writes... */
4701	if (!capable(CAP_SYS_ADMIN))
4702		return -EPERM;
4703
4704	enable = 0;
4705	disable = 0;
4706
4707	while ((cmd = next_cmd(&buf))) {
4708		if (strlencmp(cmd, "lcd_enable") == 0) {
4709			enable |= TP_ACPI_VIDEO_S_LCD;
4710		} else if (strlencmp(cmd, "lcd_disable") == 0) {
4711			disable |= TP_ACPI_VIDEO_S_LCD;
4712		} else if (strlencmp(cmd, "crt_enable") == 0) {
4713			enable |= TP_ACPI_VIDEO_S_CRT;
4714		} else if (strlencmp(cmd, "crt_disable") == 0) {
4715			disable |= TP_ACPI_VIDEO_S_CRT;
4716		} else if (video_supported == TPACPI_VIDEO_NEW &&
4717			   strlencmp(cmd, "dvi_enable") == 0) {
4718			enable |= TP_ACPI_VIDEO_S_DVI;
4719		} else if (video_supported == TPACPI_VIDEO_NEW &&
4720			   strlencmp(cmd, "dvi_disable") == 0) {
4721			disable |= TP_ACPI_VIDEO_S_DVI;
4722		} else if (strlencmp(cmd, "auto_enable") == 0) {
4723			res = video_autosw_set(1);
4724			if (res)
4725				return res;
4726		} else if (strlencmp(cmd, "auto_disable") == 0) {
4727			res = video_autosw_set(0);
4728			if (res)
4729				return res;
4730		} else if (strlencmp(cmd, "video_switch") == 0) {
4731			res = video_outputsw_cycle();
4732			if (res)
4733				return res;
4734		} else if (strlencmp(cmd, "expand_toggle") == 0) {
4735			res = video_expand_toggle();
4736			if (res)
4737				return res;
4738		} else
4739			return -EINVAL;
4740	}
4741
4742	if (enable || disable) {
4743		status = video_outputsw_get();
4744		if (status < 0)
4745			return status;
4746		res = video_outputsw_set((status & ~disable) | enable);
4747		if (res)
4748			return res;
4749	}
4750
4751	return 0;
4752}
4753
4754static struct ibm_struct video_driver_data = {
4755	.name = "video",
4756	.read = video_read,
4757	.write = video_write,
4758	.exit = video_exit,
4759};
4760
4761#endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4762
4763/*************************************************************************
4764 * Light (thinklight) subdriver
4765 */
4766
4767TPACPI_HANDLE(lght, root, "\\LGHT");	/* A21e, A2xm/p, T20-22, X20-21 */
4768TPACPI_HANDLE(ledb, ec, "LEDB");		/* G4x */
4769
4770static int light_get_status(void)
4771{
4772	int status = 0;
4773
4774	if (tp_features.light_status) {
4775		if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4776			return -EIO;
4777		return (!!status);
4778	}
4779
4780	return -ENXIO;
4781}
4782
4783static int light_set_status(int status)
4784{
4785	int rc;
4786
4787	if (tp_features.light) {
4788		if (cmos_handle) {
4789			rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4790					(status)?
4791						TP_CMOS_THINKLIGHT_ON :
4792						TP_CMOS_THINKLIGHT_OFF);
4793		} else {
4794			rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4795					(status)? 1 : 0);
4796		}
4797		return (rc)? 0 : -EIO;
4798	}
4799
4800	return -ENXIO;
4801}
4802
4803static void light_set_status_worker(struct work_struct *work)
4804{
4805	struct tpacpi_led_classdev *data =
4806			container_of(work, struct tpacpi_led_classdev, work);
4807
4808	if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4809		light_set_status((data->new_state != TPACPI_LED_OFF));
4810}
4811
4812static void light_sysfs_set(struct led_classdev *led_cdev,
4813			enum led_brightness brightness)
4814{
4815	struct tpacpi_led_classdev *data =
4816		container_of(led_cdev,
4817			     struct tpacpi_led_classdev,
4818			     led_classdev);
4819	data->new_state = (brightness != LED_OFF) ?
4820				TPACPI_LED_ON : TPACPI_LED_OFF;
4821	queue_work(tpacpi_wq, &data->work);
4822}
4823
4824static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4825{
4826	return (light_get_status() == 1)? LED_FULL : LED_OFF;
4827}
4828
4829static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4830	.led_classdev = {
4831		.name		= "tpacpi::thinklight",
4832		.brightness_set	= &light_sysfs_set,
4833		.brightness_get	= &light_sysfs_get,
4834	}
4835};
4836
4837static int __init light_init(struct ibm_init_struct *iibm)
4838{
4839	int rc;
4840
4841	vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4842
4843	if (tpacpi_is_ibm()) {
4844		TPACPI_ACPIHANDLE_INIT(ledb);
4845		TPACPI_ACPIHANDLE_INIT(lght);
4846	}
4847	TPACPI_ACPIHANDLE_INIT(cmos);
4848	INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4849
4850	/* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4851	tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4852
4853	if (tp_features.light)
4854		/* light status not supported on
4855		   570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4856		tp_features.light_status =
4857			acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4858
4859	vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4860		str_supported(tp_features.light),
4861		str_supported(tp_features.light_status));
4862
4863	if (!tp_features.light)
4864		return 1;
4865
4866	rc = led_classdev_register(&tpacpi_pdev->dev,
4867				   &tpacpi_led_thinklight.led_classdev);
4868
4869	if (rc < 0) {
4870		tp_features.light = 0;
4871		tp_features.light_status = 0;
4872	} else  {
4873		rc = 0;
4874	}
4875
4876	return rc;
4877}
4878
4879static void light_exit(void)
4880{
4881	led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4882	if (work_pending(&tpacpi_led_thinklight.work))
4883		flush_workqueue(tpacpi_wq);
4884}
4885
4886static int light_read(struct seq_file *m)
4887{
4888	int status;
4889
4890	if (!tp_features.light) {
4891		seq_printf(m, "status:\t\tnot supported\n");
4892	} else if (!tp_features.light_status) {
4893		seq_printf(m, "status:\t\tunknown\n");
4894		seq_printf(m, "commands:\ton, off\n");
4895	} else {
4896		status = light_get_status();
4897		if (status < 0)
4898			return status;
4899		seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4900		seq_printf(m, "commands:\ton, off\n");
4901	}
4902
4903	return 0;
4904}
4905
4906static int light_write(char *buf)
4907{
4908	char *cmd;
4909	int newstatus = 0;
4910
4911	if (!tp_features.light)
4912		return -ENODEV;
4913
4914	while ((cmd = next_cmd(&buf))) {
4915		if (strlencmp(cmd, "on") == 0) {
4916			newstatus = 1;
4917		} else if (strlencmp(cmd, "off") == 0) {
4918			newstatus = 0;
4919		} else
4920			return -EINVAL;
4921	}
4922
4923	return light_set_status(newstatus);
4924}
4925
4926static struct ibm_struct light_driver_data = {
4927	.name = "light",
4928	.read = light_read,
4929	.write = light_write,
4930	.exit = light_exit,
4931};
4932
4933/*************************************************************************
4934 * CMOS subdriver
4935 */
4936
4937/* sysfs cmos_command -------------------------------------------------- */
4938static ssize_t cmos_command_store(struct device *dev,
4939			    struct device_attribute *attr,
4940			    const char *buf, size_t count)
4941{
4942	unsigned long cmos_cmd;
4943	int res;
4944
4945	if (parse_strtoul(buf, 21, &cmos_cmd))
4946		return -EINVAL;
4947
4948	res = issue_thinkpad_cmos_command(cmos_cmd);
4949	return (res)? res : count;
4950}
4951
4952static struct device_attribute dev_attr_cmos_command =
4953	__ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4954
4955/* --------------------------------------------------------------------- */
4956
4957static int __init cmos_init(struct ibm_init_struct *iibm)
4958{
4959	int res;
4960
4961	vdbg_printk(TPACPI_DBG_INIT,
4962		"initializing cmos commands subdriver\n");
4963
4964	TPACPI_ACPIHANDLE_INIT(cmos);
4965
4966	vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4967		str_supported(cmos_handle != NULL));
4968
4969	res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4970	if (res)
4971		return res;
4972
4973	return (cmos_handle)? 0 : 1;
4974}
4975
4976static void cmos_exit(void)
4977{
4978	device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4979}
4980
4981static int cmos_read(struct seq_file *m)
4982{
4983	/* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4984	   R30, R31, T20-22, X20-21 */
4985	if (!cmos_handle)
4986		seq_printf(m, "status:\t\tnot supported\n");
4987	else {
4988		seq_printf(m, "status:\t\tsupported\n");
4989		seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
4990	}
4991
4992	return 0;
4993}
4994
4995static int cmos_write(char *buf)
4996{
4997	char *cmd;
4998	int cmos_cmd, res;
4999
5000	while ((cmd = next_cmd(&buf))) {
5001		if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5002		    cmos_cmd >= 0 && cmos_cmd <= 21) {
5003			/* cmos_cmd set */
5004		} else
5005			return -EINVAL;
5006
5007		res = issue_thinkpad_cmos_command(cmos_cmd);
5008		if (res)
5009			return res;
5010	}
5011
5012	return 0;
5013}
5014
5015static struct ibm_struct cmos_driver_data = {
5016	.name = "cmos",
5017	.read = cmos_read,
5018	.write = cmos_write,
5019	.exit = cmos_exit,
5020};
5021
5022/*************************************************************************
5023 * LED subdriver
5024 */
5025
5026enum led_access_mode {
5027	TPACPI_LED_NONE = 0,
5028	TPACPI_LED_570,	/* 570 */
5029	TPACPI_LED_OLD,	/* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5030	TPACPI_LED_NEW,	/* all others */
5031};
5032
5033enum {	/* For TPACPI_LED_OLD */
5034	TPACPI_LED_EC_HLCL = 0x0c,	/* EC reg to get led to power on */
5035	TPACPI_LED_EC_HLBL = 0x0d,	/* EC reg to blink a lit led */
5036	TPACPI_LED_EC_HLMS = 0x0e,	/* EC reg to select led to command */
5037};
5038
5039static enum led_access_mode led_supported;
5040
5041static acpi_handle led_handle;
5042
5043#define TPACPI_LED_NUMLEDS 16
5044static struct tpacpi_led_classdev *tpacpi_leds;
5045static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5046static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5047	/* there's a limit of 19 chars + NULL before 2.6.26 */
5048	"tpacpi::power",
5049	"tpacpi:orange:batt",
5050	"tpacpi:green:batt",
5051	"tpacpi::dock_active",
5052	"tpacpi::bay_active",
5053	"tpacpi::dock_batt",
5054	"tpacpi::unknown_led",
5055	"tpacpi::standby",
5056	"tpacpi::dock_status1",
5057	"tpacpi::dock_status2",
5058	"tpacpi::unknown_led2",
5059	"tpacpi::unknown_led3",
5060	"tpacpi::thinkvantage",
5061};
5062#define TPACPI_SAFE_LEDS	0x1081U
5063
5064static inline bool tpacpi_is_led_restricted(const unsigned int led)
5065{
5066#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5067	return false;
5068#else
5069	return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5070#endif
5071}
5072
5073static int led_get_status(const unsigned int led)
5074{
5075	int status;
5076	enum led_status_t led_s;
5077
5078	switch (led_supported) {
5079	case TPACPI_LED_570:
5080		if (!acpi_evalf(ec_handle,
5081				&status, "GLED", "dd", 1 << led))
5082			return -EIO;
5083		led_s = (status == 0)?
5084				TPACPI_LED_OFF :
5085				((status == 1)?
5086					TPACPI_LED_ON :
5087					TPACPI_LED_BLINK);
5088		tpacpi_led_state_cache[led] = led_s;
5089		return led_s;
5090	default:
5091		return -ENXIO;
5092	}
5093
5094	/* not reached */
5095}
5096
5097static int led_set_status(const unsigned int led,
5098			  const enum led_status_t ledstatus)
5099{
5100	/* off, on, blink. Index is led_status_t */
5101	static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5102	static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5103
5104	int rc = 0;
5105
5106	switch (led_supported) {
5107	case TPACPI_LED_570:
5108		/* 570 */
5109		if (unlikely(led > 7))
5110			return -EINVAL;
5111		if (unlikely(tpacpi_is_led_restricted(led)))
5112			return -EPERM;
5113		if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5114				(1 << led), led_sled_arg1[ledstatus]))
5115			rc = -EIO;
5116		break;
5117	case TPACPI_LED_OLD:
5118		/* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5119		if (unlikely(led > 7))
5120			return -EINVAL;
5121		if (unlikely(tpacpi_is_led_restricted(led)))
5122			return -EPERM;
5123		rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5124		if (rc >= 0)
5125			rc = ec_write(TPACPI_LED_EC_HLBL,
5126				      (ledstatus == TPACPI_LED_BLINK) << led);
5127		if (rc >= 0)
5128			rc = ec_write(TPACPI_LED_EC_HLCL,
5129				      (ledstatus != TPACPI_LED_OFF) << led);
5130		break;
5131	case TPACPI_LED_NEW:
5132		/* all others */
5133		if (unlikely(led >= TPACPI_LED_NUMLEDS))
5134			return -EINVAL;
5135		if (unlikely(tpacpi_is_led_restricted(led)))
5136			return -EPERM;
5137		if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5138				led, led_led_arg1[ledstatus]))
5139			rc = -EIO;
5140		break;
5141	default:
5142		rc = -ENXIO;
5143	}
5144
5145	if (!rc)
5146		tpacpi_led_state_cache[led] = ledstatus;
5147
5148	return rc;
5149}
5150
5151static void led_set_status_worker(struct work_struct *work)
5152{
5153	struct tpacpi_led_classdev *data =
5154		container_of(work, struct tpacpi_led_classdev, work);
5155
5156	if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5157		led_set_status(data->led, data->new_state);
5158}
5159
5160static void led_sysfs_set(struct led_classdev *led_cdev,
5161			enum led_brightness brightness)
5162{
5163	struct tpacpi_led_classdev *data = container_of(led_cdev,
5164			     struct tpacpi_led_classdev, led_classdev);
5165
5166	if (brightness == LED_OFF)
5167		data->new_state = TPACPI_LED_OFF;
5168	else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5169		data->new_state = TPACPI_LED_ON;
5170	else
5171		data->new_state = TPACPI_LED_BLINK;
5172
5173	queue_work(tpacpi_wq, &data->work);
5174}
5175
5176static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5177			unsigned long *delay_on, unsigned long *delay_off)
5178{
5179	struct tpacpi_led_classdev *data = container_of(led_cdev,
5180			     struct tpacpi_led_classdev, led_classdev);
5181
5182	/* Can we choose the flash rate? */
5183	if (*delay_on == 0 && *delay_off == 0) {
5184		/* yes. set them to the hardware blink rate (1 Hz) */
5185		*delay_on = 500; /* ms */
5186		*delay_off = 500; /* ms */
5187	} else if ((*delay_on != 500) || (*delay_off != 500))
5188		return -EINVAL;
5189
5190	data->new_state = TPACPI_LED_BLINK;
5191	queue_work(tpacpi_wq, &data->work);
5192
5193	return 0;
5194}
5195
5196static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5197{
5198	int rc;
5199
5200	struct tpacpi_led_classdev *data = container_of(led_cdev,
5201			     struct tpacpi_led_classdev, led_classdev);
5202
5203	rc = led_get_status(data->led);
5204
5205	if (rc == TPACPI_LED_OFF || rc < 0)
5206		rc = LED_OFF;	/* no error handling in led class :( */
5207	else
5208		rc = LED_FULL;
5209
5210	return rc;
5211}
5212
5213static void led_exit(void)
5214{
5215	unsigned int i;
5216
5217	for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5218		if (tpacpi_leds[i].led_classdev.name)
5219			led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5220	}
5221
 
5222	kfree(tpacpi_leds);
5223}
5224
5225static int __init tpacpi_init_led(unsigned int led)
5226{
5227	int rc;
5228
5229	tpacpi_leds[led].led = led;
5230
5231	/* LEDs with no name don't get registered */
5232	if (!tpacpi_led_names[led])
5233		return 0;
5234
5235	tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5236	tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5237	if (led_supported == TPACPI_LED_570)
5238		tpacpi_leds[led].led_classdev.brightness_get =
5239						&led_sysfs_get;
5240
5241	tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5242
5243	INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5244
5245	rc = led_classdev_register(&tpacpi_pdev->dev,
5246				&tpacpi_leds[led].led_classdev);
5247	if (rc < 0)
5248		tpacpi_leds[led].led_classdev.name = NULL;
5249
5250	return rc;
5251}
5252
5253static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5254	TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5255	TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5256	TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5257
5258	TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5259	TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5260	TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5261	TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5262	TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5263	TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5264	TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5265	TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5266
5267	TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5268	TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5269	TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5270	TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5271	TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5272
5273	TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5274	TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5275	TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5276	TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5277
5278	/* (1) - may have excess leds enabled on MSB */
5279
5280	/* Defaults (order matters, keep last, don't reorder!) */
5281	{ /* Lenovo */
5282	  .vendor = PCI_VENDOR_ID_LENOVO,
5283	  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5284	  .quirks = 0x1fffU,
5285	},
5286	{ /* IBM ThinkPads with no EC version string */
5287	  .vendor = PCI_VENDOR_ID_IBM,
5288	  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5289	  .quirks = 0x00ffU,
5290	},
5291	{ /* IBM ThinkPads with EC version string */
5292	  .vendor = PCI_VENDOR_ID_IBM,
5293	  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5294	  .quirks = 0x00bfU,
5295	},
5296};
5297
5298#undef TPACPI_LEDQ_IBM
5299#undef TPACPI_LEDQ_LNV
5300
5301static enum led_access_mode __init led_init_detect_mode(void)
5302{
5303	acpi_status status;
5304
5305	if (tpacpi_is_ibm()) {
5306		/* 570 */
5307		status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5308		if (ACPI_SUCCESS(status))
5309			return TPACPI_LED_570;
5310
5311		/* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5312		status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5313		if (ACPI_SUCCESS(status))
5314			return TPACPI_LED_OLD;
5315	}
5316
5317	/* most others */
5318	status = acpi_get_handle(ec_handle, "LED", &led_handle);
5319	if (ACPI_SUCCESS(status))
5320		return TPACPI_LED_NEW;
5321
5322	/* R30, R31, and unknown firmwares */
5323	led_handle = NULL;
5324	return TPACPI_LED_NONE;
5325}
5326
5327static int __init led_init(struct ibm_init_struct *iibm)
5328{
5329	unsigned int i;
5330	int rc;
5331	unsigned long useful_leds;
5332
5333	vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5334
5335	led_supported = led_init_detect_mode();
5336
 
 
 
 
 
 
 
 
 
 
5337	vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5338		str_supported(led_supported), led_supported);
5339
5340	if (led_supported == TPACPI_LED_NONE)
5341		return 1;
5342
5343	tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5344			      GFP_KERNEL);
5345	if (!tpacpi_leds) {
5346		pr_err("Out of memory for LED data\n");
5347		return -ENOMEM;
5348	}
5349
5350	useful_leds = tpacpi_check_quirks(led_useful_qtable,
5351					  ARRAY_SIZE(led_useful_qtable));
5352
5353	for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
 
 
5354		if (!tpacpi_is_led_restricted(i) &&
5355		    test_bit(i, &useful_leds)) {
5356			rc = tpacpi_init_led(i);
5357			if (rc < 0) {
5358				led_exit();
5359				return rc;
5360			}
5361		}
5362	}
5363
5364#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5365	pr_notice("warning: userspace override of important "
5366		  "firmware LEDs is enabled\n");
5367#endif
5368	return 0;
5369}
5370
5371#define str_led_status(s) \
5372	((s) == TPACPI_LED_OFF ? "off" : \
5373		((s) == TPACPI_LED_ON ? "on" : "blinking"))
5374
5375static int led_read(struct seq_file *m)
5376{
5377	if (!led_supported) {
5378		seq_printf(m, "status:\t\tnot supported\n");
5379		return 0;
5380	}
5381	seq_printf(m, "status:\t\tsupported\n");
5382
5383	if (led_supported == TPACPI_LED_570) {
5384		/* 570 */
5385		int i, status;
5386		for (i = 0; i < 8; i++) {
5387			status = led_get_status(i);
5388			if (status < 0)
5389				return -EIO;
5390			seq_printf(m, "%d:\t\t%s\n",
5391				       i, str_led_status(status));
5392		}
5393	}
5394
5395	seq_printf(m, "commands:\t"
5396		       "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5397
5398	return 0;
5399}
5400
5401static int led_write(char *buf)
5402{
5403	char *cmd;
5404	int led, rc;
5405	enum led_status_t s;
5406
5407	if (!led_supported)
5408		return -ENODEV;
5409
5410	while ((cmd = next_cmd(&buf))) {
5411		if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5412			return -EINVAL;
5413
 
 
 
 
5414		if (strstr(cmd, "off")) {
5415			s = TPACPI_LED_OFF;
5416		} else if (strstr(cmd, "on")) {
5417			s = TPACPI_LED_ON;
5418		} else if (strstr(cmd, "blink")) {
5419			s = TPACPI_LED_BLINK;
5420		} else {
5421			return -EINVAL;
5422		}
5423
5424		rc = led_set_status(led, s);
5425		if (rc < 0)
5426			return rc;
5427	}
5428
5429	return 0;
5430}
5431
5432static struct ibm_struct led_driver_data = {
5433	.name = "led",
5434	.read = led_read,
5435	.write = led_write,
5436	.exit = led_exit,
5437};
5438
5439/*************************************************************************
5440 * Beep subdriver
5441 */
5442
5443TPACPI_HANDLE(beep, ec, "BEEP");	/* all except R30, R31 */
5444
5445#define TPACPI_BEEP_Q1 0x0001
5446
5447static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5448	TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5449	TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5450};
5451
5452static int __init beep_init(struct ibm_init_struct *iibm)
5453{
5454	unsigned long quirks;
5455
5456	vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5457
5458	TPACPI_ACPIHANDLE_INIT(beep);
5459
5460	vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5461		str_supported(beep_handle != NULL));
5462
5463	quirks = tpacpi_check_quirks(beep_quirk_table,
5464				     ARRAY_SIZE(beep_quirk_table));
5465
5466	tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5467
5468	return (beep_handle)? 0 : 1;
5469}
5470
5471static int beep_read(struct seq_file *m)
5472{
5473	if (!beep_handle)
5474		seq_printf(m, "status:\t\tnot supported\n");
5475	else {
5476		seq_printf(m, "status:\t\tsupported\n");
5477		seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5478	}
5479
5480	return 0;
5481}
5482
5483static int beep_write(char *buf)
5484{
5485	char *cmd;
5486	int beep_cmd;
5487
5488	if (!beep_handle)
5489		return -ENODEV;
5490
5491	while ((cmd = next_cmd(&buf))) {
5492		if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5493		    beep_cmd >= 0 && beep_cmd <= 17) {
5494			/* beep_cmd set */
5495		} else
5496			return -EINVAL;
5497		if (tp_features.beep_needs_two_args) {
5498			if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5499					beep_cmd, 0))
5500				return -EIO;
5501		} else {
5502			if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5503					beep_cmd))
5504				return -EIO;
5505		}
5506	}
5507
5508	return 0;
5509}
5510
5511static struct ibm_struct beep_driver_data = {
5512	.name = "beep",
5513	.read = beep_read,
5514	.write = beep_write,
5515};
5516
5517/*************************************************************************
5518 * Thermal subdriver
5519 */
5520
5521enum thermal_access_mode {
5522	TPACPI_THERMAL_NONE = 0,	/* No thermal support */
5523	TPACPI_THERMAL_ACPI_TMP07,	/* Use ACPI TMP0-7 */
5524	TPACPI_THERMAL_ACPI_UPDT,	/* Use ACPI TMP0-7 with UPDT */
5525	TPACPI_THERMAL_TPEC_8,		/* Use ACPI EC regs, 8 sensors */
5526	TPACPI_THERMAL_TPEC_16,		/* Use ACPI EC regs, 16 sensors */
5527};
5528
5529enum { /* TPACPI_THERMAL_TPEC_* */
5530	TP_EC_THERMAL_TMP0 = 0x78,	/* ACPI EC regs TMP 0..7 */
5531	TP_EC_THERMAL_TMP8 = 0xC0,	/* ACPI EC regs TMP 8..15 */
5532	TP_EC_THERMAL_TMP_NA = -128,	/* ACPI EC sensor not available */
5533
5534	TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5535};
5536
5537
5538#define TPACPI_MAX_THERMAL_SENSORS 16	/* Max thermal sensors supported */
5539struct ibm_thermal_sensors_struct {
5540	s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5541};
5542
5543static enum thermal_access_mode thermal_read_mode;
5544
5545/* idx is zero-based */
5546static int thermal_get_sensor(int idx, s32 *value)
5547{
5548	int t;
5549	s8 tmp;
5550	char tmpi[5];
5551
5552	t = TP_EC_THERMAL_TMP0;
5553
5554	switch (thermal_read_mode) {
5555#if TPACPI_MAX_THERMAL_SENSORS >= 16
5556	case TPACPI_THERMAL_TPEC_16:
5557		if (idx >= 8 && idx <= 15) {
5558			t = TP_EC_THERMAL_TMP8;
5559			idx -= 8;
5560		}
5561		/* fallthrough */
5562#endif
5563	case TPACPI_THERMAL_TPEC_8:
5564		if (idx <= 7) {
5565			if (!acpi_ec_read(t + idx, &tmp))
5566				return -EIO;
5567			*value = tmp * 1000;
5568			return 0;
5569		}
5570		break;
5571
5572	case TPACPI_THERMAL_ACPI_UPDT:
5573		if (idx <= 7) {
5574			snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5575			if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5576				return -EIO;
5577			if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5578				return -EIO;
5579			*value = (t - 2732) * 100;
5580			return 0;
5581		}
5582		break;
5583
5584	case TPACPI_THERMAL_ACPI_TMP07:
5585		if (idx <= 7) {
5586			snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5587			if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5588				return -EIO;
5589			if (t > 127 || t < -127)
5590				t = TP_EC_THERMAL_TMP_NA;
5591			*value = t * 1000;
5592			return 0;
5593		}
5594		break;
5595
5596	case TPACPI_THERMAL_NONE:
5597	default:
5598		return -ENOSYS;
5599	}
5600
5601	return -EINVAL;
5602}
5603
5604static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5605{
5606	int res, i;
5607	int n;
5608
5609	n = 8;
5610	i = 0;
5611
5612	if (!s)
5613		return -EINVAL;
5614
5615	if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5616		n = 16;
5617
5618	for (i = 0 ; i < n; i++) {
5619		res = thermal_get_sensor(i, &s->temp[i]);
5620		if (res)
5621			return res;
5622	}
5623
5624	return n;
5625}
5626
5627static void thermal_dump_all_sensors(void)
5628{
5629	int n, i;
5630	struct ibm_thermal_sensors_struct t;
5631
5632	n = thermal_get_sensors(&t);
5633	if (n <= 0)
5634		return;
5635
5636	pr_notice("temperatures (Celsius):");
5637
5638	for (i = 0; i < n; i++) {
5639		if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5640			pr_cont(" %d", (int)(t.temp[i] / 1000));
5641		else
5642			pr_cont(" N/A");
5643	}
5644
5645	pr_cont("\n");
5646}
5647
5648/* sysfs temp##_input -------------------------------------------------- */
5649
5650static ssize_t thermal_temp_input_show(struct device *dev,
5651			   struct device_attribute *attr,
5652			   char *buf)
5653{
5654	struct sensor_device_attribute *sensor_attr =
5655					to_sensor_dev_attr(attr);
5656	int idx = sensor_attr->index;
5657	s32 value;
5658	int res;
5659
5660	res = thermal_get_sensor(idx, &value);
5661	if (res)
5662		return res;
5663	if (value == TPACPI_THERMAL_SENSOR_NA)
5664		return -ENXIO;
5665
5666	return snprintf(buf, PAGE_SIZE, "%d\n", value);
5667}
5668
5669#define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5670	 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5671		     thermal_temp_input_show, NULL, _idxB)
5672
5673static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5674	THERMAL_SENSOR_ATTR_TEMP(1, 0),
5675	THERMAL_SENSOR_ATTR_TEMP(2, 1),
5676	THERMAL_SENSOR_ATTR_TEMP(3, 2),
5677	THERMAL_SENSOR_ATTR_TEMP(4, 3),
5678	THERMAL_SENSOR_ATTR_TEMP(5, 4),
5679	THERMAL_SENSOR_ATTR_TEMP(6, 5),
5680	THERMAL_SENSOR_ATTR_TEMP(7, 6),
5681	THERMAL_SENSOR_ATTR_TEMP(8, 7),
5682	THERMAL_SENSOR_ATTR_TEMP(9, 8),
5683	THERMAL_SENSOR_ATTR_TEMP(10, 9),
5684	THERMAL_SENSOR_ATTR_TEMP(11, 10),
5685	THERMAL_SENSOR_ATTR_TEMP(12, 11),
5686	THERMAL_SENSOR_ATTR_TEMP(13, 12),
5687	THERMAL_SENSOR_ATTR_TEMP(14, 13),
5688	THERMAL_SENSOR_ATTR_TEMP(15, 14),
5689	THERMAL_SENSOR_ATTR_TEMP(16, 15),
5690};
5691
5692#define THERMAL_ATTRS(X) \
5693	&sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5694
5695static struct attribute *thermal_temp_input_attr[] = {
5696	THERMAL_ATTRS(8),
5697	THERMAL_ATTRS(9),
5698	THERMAL_ATTRS(10),
5699	THERMAL_ATTRS(11),
5700	THERMAL_ATTRS(12),
5701	THERMAL_ATTRS(13),
5702	THERMAL_ATTRS(14),
5703	THERMAL_ATTRS(15),
5704	THERMAL_ATTRS(0),
5705	THERMAL_ATTRS(1),
5706	THERMAL_ATTRS(2),
5707	THERMAL_ATTRS(3),
5708	THERMAL_ATTRS(4),
5709	THERMAL_ATTRS(5),
5710	THERMAL_ATTRS(6),
5711	THERMAL_ATTRS(7),
5712	NULL
5713};
5714
5715static const struct attribute_group thermal_temp_input16_group = {
5716	.attrs = thermal_temp_input_attr
5717};
5718
5719static const struct attribute_group thermal_temp_input8_group = {
5720	.attrs = &thermal_temp_input_attr[8]
5721};
5722
5723#undef THERMAL_SENSOR_ATTR_TEMP
5724#undef THERMAL_ATTRS
5725
5726/* --------------------------------------------------------------------- */
5727
5728static int __init thermal_init(struct ibm_init_struct *iibm)
5729{
5730	u8 t, ta1, ta2;
5731	int i;
5732	int acpi_tmp7;
5733	int res;
5734
5735	vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5736
5737	acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5738
5739	if (thinkpad_id.ec_model) {
5740		/*
5741		 * Direct EC access mode: sensors at registers
5742		 * 0x78-0x7F, 0xC0-0xC7.  Registers return 0x00 for
5743		 * non-implemented, thermal sensors return 0x80 when
5744		 * not available
5745		 */
5746
5747		ta1 = ta2 = 0;
5748		for (i = 0; i < 8; i++) {
5749			if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5750				ta1 |= t;
5751			} else {
5752				ta1 = 0;
5753				break;
5754			}
5755			if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5756				ta2 |= t;
5757			} else {
5758				ta1 = 0;
5759				break;
5760			}
5761		}
5762		if (ta1 == 0) {
5763			/* This is sheer paranoia, but we handle it anyway */
5764			if (acpi_tmp7) {
5765				pr_err("ThinkPad ACPI EC access misbehaving, "
5766				       "falling back to ACPI TMPx access "
5767				       "mode\n");
5768				thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5769			} else {
5770				pr_err("ThinkPad ACPI EC access misbehaving, "
5771				       "disabling thermal sensors access\n");
5772				thermal_read_mode = TPACPI_THERMAL_NONE;
5773			}
5774		} else {
5775			thermal_read_mode =
5776			    (ta2 != 0) ?
5777			    TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5778		}
5779	} else if (acpi_tmp7) {
5780		if (tpacpi_is_ibm() &&
5781		    acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5782			/* 600e/x, 770e, 770x */
5783			thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5784		} else {
5785			/* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5786			thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5787		}
5788	} else {
5789		/* temperatures not supported on 570, G4x, R30, R31, R32 */
5790		thermal_read_mode = TPACPI_THERMAL_NONE;
5791	}
5792
5793	vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5794		str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5795		thermal_read_mode);
5796
5797	switch (thermal_read_mode) {
5798	case TPACPI_THERMAL_TPEC_16:
5799		res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5800				&thermal_temp_input16_group);
5801		if (res)
5802			return res;
5803		break;
5804	case TPACPI_THERMAL_TPEC_8:
5805	case TPACPI_THERMAL_ACPI_TMP07:
5806	case TPACPI_THERMAL_ACPI_UPDT:
5807		res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5808				&thermal_temp_input8_group);
5809		if (res)
5810			return res;
5811		break;
5812	case TPACPI_THERMAL_NONE:
5813	default:
5814		return 1;
5815	}
5816
5817	return 0;
5818}
5819
5820static void thermal_exit(void)
5821{
5822	switch (thermal_read_mode) {
5823	case TPACPI_THERMAL_TPEC_16:
5824		sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5825				   &thermal_temp_input16_group);
5826		break;
5827	case TPACPI_THERMAL_TPEC_8:
5828	case TPACPI_THERMAL_ACPI_TMP07:
5829	case TPACPI_THERMAL_ACPI_UPDT:
5830		sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5831				   &thermal_temp_input8_group);
5832		break;
5833	case TPACPI_THERMAL_NONE:
5834	default:
5835		break;
5836	}
5837}
5838
5839static int thermal_read(struct seq_file *m)
5840{
5841	int n, i;
5842	struct ibm_thermal_sensors_struct t;
5843
5844	n = thermal_get_sensors(&t);
5845	if (unlikely(n < 0))
5846		return n;
5847
5848	seq_printf(m, "temperatures:\t");
5849
5850	if (n > 0) {
5851		for (i = 0; i < (n - 1); i++)
5852			seq_printf(m, "%d ", t.temp[i] / 1000);
5853		seq_printf(m, "%d\n", t.temp[i] / 1000);
5854	} else
5855		seq_printf(m, "not supported\n");
5856
5857	return 0;
5858}
5859
5860static struct ibm_struct thermal_driver_data = {
5861	.name = "thermal",
5862	.read = thermal_read,
5863	.exit = thermal_exit,
5864};
5865
5866/*************************************************************************
5867 * Backlight/brightness subdriver
5868 */
5869
5870#define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5871
5872/*
5873 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5874 * CMOS NVRAM byte 0x5E, bits 0-3.
5875 *
5876 * EC HBRV (0x31) has the following layout
5877 *   Bit 7: unknown function
5878 *   Bit 6: unknown function
5879 *   Bit 5: Z: honour scale changes, NZ: ignore scale changes
5880 *   Bit 4: must be set to zero to avoid problems
5881 *   Bit 3-0: backlight brightness level
5882 *
5883 * brightness_get_raw returns status data in the HBRV layout
5884 *
5885 * WARNING: The X61 has been verified to use HBRV for something else, so
5886 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5887 * testing on the very early *60 Lenovo models...
5888 */
5889
5890enum {
5891	TP_EC_BACKLIGHT = 0x31,
5892
5893	/* TP_EC_BACKLIGHT bitmasks */
5894	TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5895	TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5896	TP_EC_BACKLIGHT_MAPSW = 0x20,
5897};
5898
5899enum tpacpi_brightness_access_mode {
5900	TPACPI_BRGHT_MODE_AUTO = 0,	/* Not implemented yet */
5901	TPACPI_BRGHT_MODE_EC,		/* EC control */
5902	TPACPI_BRGHT_MODE_UCMS_STEP,	/* UCMS step-based control */
5903	TPACPI_BRGHT_MODE_ECNVRAM,	/* EC control w/ NVRAM store */
5904	TPACPI_BRGHT_MODE_MAX
5905};
5906
5907static struct backlight_device *ibm_backlight_device;
5908
5909static enum tpacpi_brightness_access_mode brightness_mode =
5910		TPACPI_BRGHT_MODE_MAX;
5911
5912static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5913
5914static struct mutex brightness_mutex;
5915
5916/* NVRAM brightness access,
5917 * call with brightness_mutex held! */
5918static unsigned int tpacpi_brightness_nvram_get(void)
5919{
5920	u8 lnvram;
5921
5922	lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5923		  & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5924		  >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5925	lnvram &= bright_maxlvl;
5926
5927	return lnvram;
5928}
5929
5930static void tpacpi_brightness_checkpoint_nvram(void)
5931{
5932	u8 lec = 0;
5933	u8 b_nvram;
5934
5935	if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
5936		return;
5937
5938	vdbg_printk(TPACPI_DBG_BRGHT,
5939		"trying to checkpoint backlight level to NVRAM...\n");
5940
5941	if (mutex_lock_killable(&brightness_mutex) < 0)
5942		return;
5943
5944	if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5945		goto unlock;
5946	lec &= TP_EC_BACKLIGHT_LVLMSK;
5947	b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
5948
5949	if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5950			     >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
5951		/* NVRAM needs update */
5952		b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
5953				TP_NVRAM_POS_LEVEL_BRIGHTNESS);
5954		b_nvram |= lec;
5955		nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
5956		dbg_printk(TPACPI_DBG_BRGHT,
5957			   "updated NVRAM backlight level to %u (0x%02x)\n",
5958			   (unsigned int) lec, (unsigned int) b_nvram);
5959	} else
5960		vdbg_printk(TPACPI_DBG_BRGHT,
5961			   "NVRAM backlight level already is %u (0x%02x)\n",
5962			   (unsigned int) lec, (unsigned int) b_nvram);
5963
5964unlock:
5965	mutex_unlock(&brightness_mutex);
5966}
5967
5968
5969/* call with brightness_mutex held! */
5970static int tpacpi_brightness_get_raw(int *status)
5971{
5972	u8 lec = 0;
5973
5974	switch (brightness_mode) {
5975	case TPACPI_BRGHT_MODE_UCMS_STEP:
5976		*status = tpacpi_brightness_nvram_get();
5977		return 0;
5978	case TPACPI_BRGHT_MODE_EC:
5979	case TPACPI_BRGHT_MODE_ECNVRAM:
5980		if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5981			return -EIO;
5982		*status = lec;
5983		return 0;
5984	default:
5985		return -ENXIO;
5986	}
5987}
5988
5989/* call with brightness_mutex held! */
5990/* do NOT call with illegal backlight level value */
5991static int tpacpi_brightness_set_ec(unsigned int value)
5992{
5993	u8 lec = 0;
5994
5995	if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5996		return -EIO;
5997
5998	if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
5999				(lec & TP_EC_BACKLIGHT_CMDMSK) |
6000				(value & TP_EC_BACKLIGHT_LVLMSK))))
6001		return -EIO;
6002
6003	return 0;
6004}
6005
6006/* call with brightness_mutex held! */
6007static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6008{
6009	int cmos_cmd, inc;
6010	unsigned int current_value, i;
6011
6012	current_value = tpacpi_brightness_nvram_get();
6013
6014	if (value == current_value)
6015		return 0;
6016
6017	cmos_cmd = (value > current_value) ?
6018			TP_CMOS_BRIGHTNESS_UP :
6019			TP_CMOS_BRIGHTNESS_DOWN;
6020	inc = (value > current_value) ? 1 : -1;
6021
6022	for (i = current_value; i != value; i += inc)
6023		if (issue_thinkpad_cmos_command(cmos_cmd))
6024			return -EIO;
6025
6026	return 0;
6027}
6028
6029/* May return EINTR which can always be mapped to ERESTARTSYS */
6030static int brightness_set(unsigned int value)
6031{
6032	int res;
6033
6034	if (value > bright_maxlvl || value < 0)
6035		return -EINVAL;
6036
6037	vdbg_printk(TPACPI_DBG_BRGHT,
6038			"set backlight level to %d\n", value);
6039
6040	res = mutex_lock_killable(&brightness_mutex);
6041	if (res < 0)
6042		return res;
6043
6044	switch (brightness_mode) {
6045	case TPACPI_BRGHT_MODE_EC:
6046	case TPACPI_BRGHT_MODE_ECNVRAM:
6047		res = tpacpi_brightness_set_ec(value);
6048		break;
6049	case TPACPI_BRGHT_MODE_UCMS_STEP:
6050		res = tpacpi_brightness_set_ucmsstep(value);
6051		break;
6052	default:
6053		res = -ENXIO;
6054	}
6055
6056	mutex_unlock(&brightness_mutex);
6057	return res;
6058}
6059
6060/* sysfs backlight class ----------------------------------------------- */
6061
6062static int brightness_update_status(struct backlight_device *bd)
6063{
6064	unsigned int level =
6065		(bd->props.fb_blank == FB_BLANK_UNBLANK &&
6066		 bd->props.power == FB_BLANK_UNBLANK) ?
6067				bd->props.brightness : 0;
6068
6069	dbg_printk(TPACPI_DBG_BRGHT,
6070			"backlight: attempt to set level to %d\n",
6071			level);
6072
6073	/* it is the backlight class's job (caller) to handle
6074	 * EINTR and other errors properly */
6075	return brightness_set(level);
6076}
6077
6078static int brightness_get(struct backlight_device *bd)
6079{
6080	int status, res;
6081
6082	res = mutex_lock_killable(&brightness_mutex);
6083	if (res < 0)
6084		return 0;
6085
6086	res = tpacpi_brightness_get_raw(&status);
6087
6088	mutex_unlock(&brightness_mutex);
6089
6090	if (res < 0)
6091		return 0;
6092
6093	return status & TP_EC_BACKLIGHT_LVLMSK;
6094}
6095
6096static void tpacpi_brightness_notify_change(void)
6097{
6098	backlight_force_update(ibm_backlight_device,
6099			       BACKLIGHT_UPDATE_HOTKEY);
6100}
6101
6102static const struct backlight_ops ibm_backlight_data = {
6103	.get_brightness = brightness_get,
6104	.update_status  = brightness_update_status,
6105};
6106
6107/* --------------------------------------------------------------------- */
6108
6109/*
6110 * Call _BCL method of video device.  On some ThinkPads this will
6111 * switch the firmware to the ACPI brightness control mode.
6112 */
6113
6114static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6115{
6116	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6117	union acpi_object *obj;
 
6118	int rc;
6119
6120	if (ACPI_SUCCESS(acpi_evaluate_object(handle, "_BCL", NULL, &buffer))) {
 
 
 
 
 
 
 
 
 
6121		obj = (union acpi_object *)buffer.pointer;
6122		if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6123			pr_err("Unknown _BCL data, please report this to %s\n",
6124			       TPACPI_MAIL);
6125			rc = 0;
6126		} else {
6127			rc = obj->package.count;
6128		}
6129	} else {
6130		return 0;
6131	}
6132
6133	kfree(buffer.pointer);
6134	return rc;
6135}
6136
6137
6138/*
6139 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6140 */
6141static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6142{
6143	acpi_handle video_device;
6144	int bcl_levels = 0;
6145
6146	tpacpi_acpi_handle_locate("video", ACPI_VIDEO_HID, &video_device);
6147	if (video_device)
6148		bcl_levels = tpacpi_query_bcl_levels(video_device);
6149
6150	tp_features.bright_acpimode = (bcl_levels > 0);
6151
6152	return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6153}
6154
6155/*
6156 * These are only useful for models that have only one possibility
6157 * of GPU.  If the BIOS model handles both ATI and Intel, don't use
6158 * these quirks.
6159 */
6160#define TPACPI_BRGHT_Q_NOEC	0x0001	/* Must NOT use EC HBRV */
6161#define TPACPI_BRGHT_Q_EC	0x0002  /* Should or must use EC HBRV */
6162#define TPACPI_BRGHT_Q_ASK	0x8000	/* Ask for user report */
6163
6164static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6165	/* Models with ATI GPUs known to require ECNVRAM mode */
6166	TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC),	/* T43/p ATI */
6167
6168	/* Models with ATI GPUs that can use ECNVRAM */
6169	TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC),	/* R50,51 T40-42 */
6170	TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6171	TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC),	/* R52 */
6172	TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6173
6174	/* Models with Intel Extreme Graphics 2 */
6175	TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC),	/* X40 */
6176	TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6177	TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6178
6179	/* Models with Intel GMA900 */
6180	TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC),	/* T43, R52 */
6181	TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC),	/* X41 */
6182	TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC),	/* X41 Tablet */
6183};
6184
6185/*
6186 * Returns < 0 for error, otherwise sets tp_features.bright_*
6187 * and bright_maxlvl.
6188 */
6189static void __init tpacpi_detect_brightness_capabilities(void)
6190{
6191	unsigned int b;
6192
6193	vdbg_printk(TPACPI_DBG_INIT,
6194		    "detecting firmware brightness interface capabilities\n");
6195
6196	/* we could run a quirks check here (same table used by
6197	 * brightness_init) if needed */
6198
6199	/*
6200	 * We always attempt to detect acpi support, so as to switch
6201	 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6202	 * going to publish a backlight interface
6203	 */
6204	b = tpacpi_check_std_acpi_brightness_support();
6205	switch (b) {
6206	case 16:
6207		bright_maxlvl = 15;
6208		pr_info("detected a 16-level brightness capable ThinkPad\n");
6209		break;
6210	case 8:
6211	case 0:
6212		bright_maxlvl = 7;
6213		pr_info("detected a 8-level brightness capable ThinkPad\n");
6214		break;
6215	default:
6216		pr_err("Unsupported brightness interface, "
6217		       "please contact %s\n", TPACPI_MAIL);
6218		tp_features.bright_unkfw = 1;
6219		bright_maxlvl = b - 1;
6220	}
6221}
6222
6223static int __init brightness_init(struct ibm_init_struct *iibm)
6224{
6225	struct backlight_properties props;
6226	int b;
6227	unsigned long quirks;
6228
6229	vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6230
6231	mutex_init(&brightness_mutex);
6232
6233	quirks = tpacpi_check_quirks(brightness_quirk_table,
6234				ARRAY_SIZE(brightness_quirk_table));
6235
6236	/* tpacpi_detect_brightness_capabilities() must have run already */
6237
6238	/* if it is unknown, we don't handle it: it wouldn't be safe */
6239	if (tp_features.bright_unkfw)
6240		return 1;
6241
6242	if (!brightness_enable) {
6243		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6244			   "brightness support disabled by "
6245			   "module parameter\n");
6246		return 1;
6247	}
6248
6249	if (acpi_video_backlight_support()) {
6250		if (brightness_enable > 1) {
6251			pr_info("Standard ACPI backlight interface "
6252				"available, not loading native one\n");
6253			return 1;
6254		} else if (brightness_enable == 1) {
6255			pr_warn("Cannot enable backlight brightness support, "
6256				"ACPI is already handling it.  Refer to the "
6257				"acpi_backlight kernel parameter.\n");
6258			return 1;
6259		}
6260	} else if (tp_features.bright_acpimode && brightness_enable > 1) {
6261		pr_notice("Standard ACPI backlight interface not "
6262			  "available, thinkpad_acpi native "
6263			  "brightness control enabled\n");
6264	}
6265
6266	/*
6267	 * Check for module parameter bogosity, note that we
6268	 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6269	 * able to detect "unspecified"
6270	 */
6271	if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6272		return -EINVAL;
6273
6274	/* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6275	if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6276	    brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6277		if (quirks & TPACPI_BRGHT_Q_EC)
6278			brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6279		else
6280			brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6281
6282		dbg_printk(TPACPI_DBG_BRGHT,
6283			   "driver auto-selected brightness_mode=%d\n",
6284			   brightness_mode);
6285	}
6286
6287	/* Safety */
6288	if (!tpacpi_is_ibm() &&
6289	    (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6290	     brightness_mode == TPACPI_BRGHT_MODE_EC))
6291		return -EINVAL;
6292
6293	if (tpacpi_brightness_get_raw(&b) < 0)
6294		return 1;
6295
6296	memset(&props, 0, sizeof(struct backlight_properties));
6297	props.type = BACKLIGHT_PLATFORM;
6298	props.max_brightness = bright_maxlvl;
6299	props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6300	ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6301							 NULL, NULL,
6302							 &ibm_backlight_data,
6303							 &props);
6304	if (IS_ERR(ibm_backlight_device)) {
6305		int rc = PTR_ERR(ibm_backlight_device);
6306		ibm_backlight_device = NULL;
6307		pr_err("Could not register backlight device\n");
6308		return rc;
6309	}
6310	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6311			"brightness is supported\n");
6312
6313	if (quirks & TPACPI_BRGHT_Q_ASK) {
6314		pr_notice("brightness: will use unverified default: "
6315			  "brightness_mode=%d\n", brightness_mode);
6316		pr_notice("brightness: please report to %s whether it works well "
6317			  "or not on your ThinkPad\n", TPACPI_MAIL);
6318	}
6319
6320	/* Added by mistake in early 2007.  Probably useless, but it could
6321	 * be working around some unknown firmware problem where the value
6322	 * read at startup doesn't match the real hardware state... so leave
6323	 * it in place just in case */
6324	backlight_update_status(ibm_backlight_device);
6325
6326	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6327			"brightness: registering brightness hotkeys "
6328			"as change notification\n");
6329	tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6330				| TP_ACPI_HKEY_BRGHTUP_MASK
6331				| TP_ACPI_HKEY_BRGHTDWN_MASK);
6332	return 0;
6333}
6334
6335static void brightness_suspend(pm_message_t state)
6336{
6337	tpacpi_brightness_checkpoint_nvram();
6338}
6339
6340static void brightness_shutdown(void)
6341{
6342	tpacpi_brightness_checkpoint_nvram();
6343}
6344
6345static void brightness_exit(void)
6346{
6347	if (ibm_backlight_device) {
6348		vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6349			    "calling backlight_device_unregister()\n");
6350		backlight_device_unregister(ibm_backlight_device);
6351	}
6352
6353	tpacpi_brightness_checkpoint_nvram();
6354}
6355
6356static int brightness_read(struct seq_file *m)
6357{
6358	int level;
6359
6360	level = brightness_get(NULL);
6361	if (level < 0) {
6362		seq_printf(m, "level:\t\tunreadable\n");
6363	} else {
6364		seq_printf(m, "level:\t\t%d\n", level);
6365		seq_printf(m, "commands:\tup, down\n");
6366		seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6367			       bright_maxlvl);
6368	}
6369
6370	return 0;
6371}
6372
6373static int brightness_write(char *buf)
6374{
6375	int level;
6376	int rc;
6377	char *cmd;
6378
6379	level = brightness_get(NULL);
6380	if (level < 0)
6381		return level;
6382
6383	while ((cmd = next_cmd(&buf))) {
6384		if (strlencmp(cmd, "up") == 0) {
6385			if (level < bright_maxlvl)
6386				level++;
6387		} else if (strlencmp(cmd, "down") == 0) {
6388			if (level > 0)
6389				level--;
6390		} else if (sscanf(cmd, "level %d", &level) == 1 &&
6391			   level >= 0 && level <= bright_maxlvl) {
6392			/* new level set */
6393		} else
6394			return -EINVAL;
6395	}
6396
6397	tpacpi_disclose_usertask("procfs brightness",
6398			"set level to %d\n", level);
6399
6400	/*
6401	 * Now we know what the final level should be, so we try to set it.
6402	 * Doing it this way makes the syscall restartable in case of EINTR
6403	 */
6404	rc = brightness_set(level);
6405	if (!rc && ibm_backlight_device)
6406		backlight_force_update(ibm_backlight_device,
6407					BACKLIGHT_UPDATE_SYSFS);
6408	return (rc == -EINTR)? -ERESTARTSYS : rc;
6409}
6410
6411static struct ibm_struct brightness_driver_data = {
6412	.name = "brightness",
6413	.read = brightness_read,
6414	.write = brightness_write,
6415	.exit = brightness_exit,
6416	.suspend = brightness_suspend,
6417	.shutdown = brightness_shutdown,
6418};
6419
6420/*************************************************************************
6421 * Volume subdriver
6422 */
6423
6424/*
6425 * IBM ThinkPads have a simple volume controller with MUTE gating.
6426 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6427 *
6428 * Since the *61 series (and probably also the later *60 series), Lenovo
6429 * ThinkPads only implement the MUTE gate.
6430 *
6431 * EC register 0x30
6432 *   Bit 6: MUTE (1 mutes sound)
6433 *   Bit 3-0: Volume
6434 *   Other bits should be zero as far as we know.
6435 *
6436 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6437 * bits 3-0 (volume).  Other bits in NVRAM may have other functions,
6438 * such as bit 7 which is used to detect repeated presses of MUTE,
6439 * and we leave them unchanged.
6440 */
6441
6442#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6443
6444#define TPACPI_ALSA_DRVNAME  "ThinkPad EC"
6445#define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6446#define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6447
6448static int alsa_index = ~((1 << (SNDRV_CARDS - 3)) - 1); /* last three slots */
 
 
 
 
 
6449static char *alsa_id = "ThinkPadEC";
6450static int alsa_enable = SNDRV_DEFAULT_ENABLE1;
6451
6452struct tpacpi_alsa_data {
6453	struct snd_card *card;
6454	struct snd_ctl_elem_id *ctl_mute_id;
6455	struct snd_ctl_elem_id *ctl_vol_id;
6456};
6457
6458static struct snd_card *alsa_card;
6459
6460enum {
6461	TP_EC_AUDIO = 0x30,
6462
6463	/* TP_EC_AUDIO bits */
6464	TP_EC_AUDIO_MUTESW = 6,
6465
6466	/* TP_EC_AUDIO bitmasks */
6467	TP_EC_AUDIO_LVL_MSK = 0x0F,
6468	TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6469
6470	/* Maximum volume */
6471	TP_EC_VOLUME_MAX = 14,
6472};
6473
6474enum tpacpi_volume_access_mode {
6475	TPACPI_VOL_MODE_AUTO = 0,	/* Not implemented yet */
6476	TPACPI_VOL_MODE_EC,		/* Pure EC control */
6477	TPACPI_VOL_MODE_UCMS_STEP,	/* UCMS step-based control: N/A */
6478	TPACPI_VOL_MODE_ECNVRAM,	/* EC control w/ NVRAM store */
6479	TPACPI_VOL_MODE_MAX
6480};
6481
6482enum tpacpi_volume_capabilities {
6483	TPACPI_VOL_CAP_AUTO = 0,	/* Use white/blacklist */
6484	TPACPI_VOL_CAP_VOLMUTE,		/* Output vol and mute */
6485	TPACPI_VOL_CAP_MUTEONLY,	/* Output mute only */
6486	TPACPI_VOL_CAP_MAX
6487};
6488
6489static enum tpacpi_volume_access_mode volume_mode =
6490	TPACPI_VOL_MODE_MAX;
6491
6492static enum tpacpi_volume_capabilities volume_capabilities;
6493static int volume_control_allowed;
6494
6495/*
6496 * Used to syncronize writers to TP_EC_AUDIO and
6497 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6498 */
6499static struct mutex volume_mutex;
6500
6501static void tpacpi_volume_checkpoint_nvram(void)
6502{
6503	u8 lec = 0;
6504	u8 b_nvram;
6505	u8 ec_mask;
6506
6507	if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6508		return;
6509	if (!volume_control_allowed)
6510		return;
6511
6512	vdbg_printk(TPACPI_DBG_MIXER,
6513		"trying to checkpoint mixer state to NVRAM...\n");
6514
6515	if (tp_features.mixer_no_level_control)
6516		ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6517	else
6518		ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6519
6520	if (mutex_lock_killable(&volume_mutex) < 0)
6521		return;
6522
6523	if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6524		goto unlock;
6525	lec &= ec_mask;
6526	b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6527
6528	if (lec != (b_nvram & ec_mask)) {
6529		/* NVRAM needs update */
6530		b_nvram &= ~ec_mask;
6531		b_nvram |= lec;
6532		nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6533		dbg_printk(TPACPI_DBG_MIXER,
6534			   "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6535			   (unsigned int) lec, (unsigned int) b_nvram);
6536	} else {
6537		vdbg_printk(TPACPI_DBG_MIXER,
6538			   "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6539			   (unsigned int) lec, (unsigned int) b_nvram);
6540	}
6541
6542unlock:
6543	mutex_unlock(&volume_mutex);
6544}
6545
6546static int volume_get_status_ec(u8 *status)
6547{
6548	u8 s;
6549
6550	if (!acpi_ec_read(TP_EC_AUDIO, &s))
6551		return -EIO;
6552
6553	*status = s;
6554
6555	dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6556
6557	return 0;
6558}
6559
6560static int volume_get_status(u8 *status)
6561{
6562	return volume_get_status_ec(status);
6563}
6564
6565static int volume_set_status_ec(const u8 status)
6566{
6567	if (!acpi_ec_write(TP_EC_AUDIO, status))
6568		return -EIO;
6569
6570	dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6571
6572	return 0;
6573}
6574
6575static int volume_set_status(const u8 status)
6576{
6577	return volume_set_status_ec(status);
6578}
6579
6580/* returns < 0 on error, 0 on no change, 1 on change */
6581static int __volume_set_mute_ec(const bool mute)
6582{
6583	int rc;
6584	u8 s, n;
6585
6586	if (mutex_lock_killable(&volume_mutex) < 0)
6587		return -EINTR;
6588
6589	rc = volume_get_status_ec(&s);
6590	if (rc)
6591		goto unlock;
6592
6593	n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6594		     s & ~TP_EC_AUDIO_MUTESW_MSK;
6595
6596	if (n != s) {
6597		rc = volume_set_status_ec(n);
6598		if (!rc)
6599			rc = 1;
6600	}
6601
6602unlock:
6603	mutex_unlock(&volume_mutex);
6604	return rc;
6605}
6606
6607static int volume_alsa_set_mute(const bool mute)
6608{
6609	dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6610		   (mute) ? "" : "un");
6611	return __volume_set_mute_ec(mute);
6612}
6613
6614static int volume_set_mute(const bool mute)
6615{
6616	int rc;
6617
6618	dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6619		   (mute) ? "" : "un");
6620
6621	rc = __volume_set_mute_ec(mute);
6622	return (rc < 0) ? rc : 0;
6623}
6624
6625/* returns < 0 on error, 0 on no change, 1 on change */
6626static int __volume_set_volume_ec(const u8 vol)
6627{
6628	int rc;
6629	u8 s, n;
6630
6631	if (vol > TP_EC_VOLUME_MAX)
6632		return -EINVAL;
6633
6634	if (mutex_lock_killable(&volume_mutex) < 0)
6635		return -EINTR;
6636
6637	rc = volume_get_status_ec(&s);
6638	if (rc)
6639		goto unlock;
6640
6641	n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6642
6643	if (n != s) {
6644		rc = volume_set_status_ec(n);
6645		if (!rc)
6646			rc = 1;
6647	}
6648
6649unlock:
6650	mutex_unlock(&volume_mutex);
6651	return rc;
6652}
6653
6654static int volume_alsa_set_volume(const u8 vol)
6655{
6656	dbg_printk(TPACPI_DBG_MIXER,
6657		   "ALSA: trying to set volume level to %hu\n", vol);
6658	return __volume_set_volume_ec(vol);
6659}
6660
6661static void volume_alsa_notify_change(void)
6662{
6663	struct tpacpi_alsa_data *d;
6664
6665	if (alsa_card && alsa_card->private_data) {
6666		d = alsa_card->private_data;
6667		if (d->ctl_mute_id)
6668			snd_ctl_notify(alsa_card,
6669					SNDRV_CTL_EVENT_MASK_VALUE,
6670					d->ctl_mute_id);
6671		if (d->ctl_vol_id)
6672			snd_ctl_notify(alsa_card,
6673					SNDRV_CTL_EVENT_MASK_VALUE,
6674					d->ctl_vol_id);
6675	}
6676}
6677
6678static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6679				struct snd_ctl_elem_info *uinfo)
6680{
6681	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6682	uinfo->count = 1;
6683	uinfo->value.integer.min = 0;
6684	uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6685	return 0;
6686}
6687
6688static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6689				struct snd_ctl_elem_value *ucontrol)
6690{
6691	u8 s;
6692	int rc;
6693
6694	rc = volume_get_status(&s);
6695	if (rc < 0)
6696		return rc;
6697
6698	ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6699	return 0;
6700}
6701
6702static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6703				struct snd_ctl_elem_value *ucontrol)
6704{
6705	tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
6706				 ucontrol->value.integer.value[0]);
6707	return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6708}
6709
6710#define volume_alsa_mute_info snd_ctl_boolean_mono_info
6711
6712static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6713				struct snd_ctl_elem_value *ucontrol)
6714{
6715	u8 s;
6716	int rc;
6717
6718	rc = volume_get_status(&s);
6719	if (rc < 0)
6720		return rc;
6721
6722	ucontrol->value.integer.value[0] =
6723				(s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6724	return 0;
6725}
6726
6727static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6728				struct snd_ctl_elem_value *ucontrol)
6729{
6730	tpacpi_disclose_usertask("ALSA", "%smute\n",
6731				 ucontrol->value.integer.value[0] ?
6732					"un" : "");
6733	return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6734}
6735
6736static struct snd_kcontrol_new volume_alsa_control_vol __devinitdata = {
6737	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6738	.name = "Console Playback Volume",
6739	.index = 0,
6740	.access = SNDRV_CTL_ELEM_ACCESS_READ,
6741	.info = volume_alsa_vol_info,
6742	.get = volume_alsa_vol_get,
6743};
6744
6745static struct snd_kcontrol_new volume_alsa_control_mute __devinitdata = {
6746	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6747	.name = "Console Playback Switch",
6748	.index = 0,
6749	.access = SNDRV_CTL_ELEM_ACCESS_READ,
6750	.info = volume_alsa_mute_info,
6751	.get = volume_alsa_mute_get,
6752};
6753
6754static void volume_suspend(pm_message_t state)
6755{
6756	tpacpi_volume_checkpoint_nvram();
6757}
6758
6759static void volume_resume(void)
6760{
6761	volume_alsa_notify_change();
6762}
6763
6764static void volume_shutdown(void)
6765{
6766	tpacpi_volume_checkpoint_nvram();
6767}
6768
6769static void volume_exit(void)
6770{
6771	if (alsa_card) {
6772		snd_card_free(alsa_card);
6773		alsa_card = NULL;
6774	}
6775
6776	tpacpi_volume_checkpoint_nvram();
6777}
6778
6779static int __init volume_create_alsa_mixer(void)
6780{
6781	struct snd_card *card;
6782	struct tpacpi_alsa_data *data;
6783	struct snd_kcontrol *ctl_vol;
6784	struct snd_kcontrol *ctl_mute;
6785	int rc;
6786
6787	rc = snd_card_create(alsa_index, alsa_id, THIS_MODULE,
6788			    sizeof(struct tpacpi_alsa_data), &card);
 
6789	if (rc < 0 || !card) {
6790		pr_err("Failed to create ALSA card structures: %d\n", rc);
6791		return 1;
6792	}
6793
6794	BUG_ON(!card->private_data);
6795	data = card->private_data;
6796	data->card = card;
6797
6798	strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6799		sizeof(card->driver));
6800	strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6801		sizeof(card->shortname));
6802	snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6803		 (thinkpad_id.ec_version_str) ?
6804			thinkpad_id.ec_version_str : "(unknown)");
6805	snprintf(card->longname, sizeof(card->longname),
6806		 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6807		 (thinkpad_id.ec_version_str) ?
6808			thinkpad_id.ec_version_str : "unknown");
6809
6810	if (volume_control_allowed) {
6811		volume_alsa_control_vol.put = volume_alsa_vol_put;
6812		volume_alsa_control_vol.access =
6813				SNDRV_CTL_ELEM_ACCESS_READWRITE;
6814
6815		volume_alsa_control_mute.put = volume_alsa_mute_put;
6816		volume_alsa_control_mute.access =
6817				SNDRV_CTL_ELEM_ACCESS_READWRITE;
6818	}
6819
6820	if (!tp_features.mixer_no_level_control) {
6821		ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6822		rc = snd_ctl_add(card, ctl_vol);
6823		if (rc < 0) {
6824			pr_err("Failed to create ALSA volume control: %d\n",
6825			       rc);
6826			goto err_exit;
6827		}
6828		data->ctl_vol_id = &ctl_vol->id;
6829	}
6830
6831	ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6832	rc = snd_ctl_add(card, ctl_mute);
6833	if (rc < 0) {
6834		pr_err("Failed to create ALSA mute control: %d\n", rc);
6835		goto err_exit;
6836	}
6837	data->ctl_mute_id = &ctl_mute->id;
6838
6839	snd_card_set_dev(card, &tpacpi_pdev->dev);
6840	rc = snd_card_register(card);
6841	if (rc < 0) {
6842		pr_err("Failed to register ALSA card: %d\n", rc);
6843		goto err_exit;
6844	}
6845
6846	alsa_card = card;
6847	return 0;
6848
6849err_exit:
6850	snd_card_free(card);
6851	return 1;
6852}
6853
6854#define TPACPI_VOL_Q_MUTEONLY	0x0001	/* Mute-only control available */
6855#define TPACPI_VOL_Q_LEVEL	0x0002  /* Volume control available */
6856
6857static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6858	/* Whitelist volume level on all IBM by default */
6859	{ .vendor = PCI_VENDOR_ID_IBM,
6860	  .bios   = TPACPI_MATCH_ANY,
6861	  .ec     = TPACPI_MATCH_ANY,
6862	  .quirks = TPACPI_VOL_Q_LEVEL },
6863
6864	/* Lenovo models with volume control (needs confirmation) */
6865	TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6866	TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6867	TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6868	TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6869	TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6870	TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6871	TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6872
6873	/* Whitelist mute-only on all Lenovo by default */
6874	{ .vendor = PCI_VENDOR_ID_LENOVO,
6875	  .bios   = TPACPI_MATCH_ANY,
6876	  .ec	  = TPACPI_MATCH_ANY,
6877	  .quirks = TPACPI_VOL_Q_MUTEONLY }
6878};
6879
6880static int __init volume_init(struct ibm_init_struct *iibm)
6881{
6882	unsigned long quirks;
6883	int rc;
6884
6885	vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
6886
6887	mutex_init(&volume_mutex);
6888
6889	/*
6890	 * Check for module parameter bogosity, note that we
6891	 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
6892	 * able to detect "unspecified"
6893	 */
6894	if (volume_mode > TPACPI_VOL_MODE_MAX)
6895		return -EINVAL;
6896
6897	if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
6898		pr_err("UCMS step volume mode not implemented, "
6899		       "please contact %s\n", TPACPI_MAIL);
6900		return 1;
6901	}
6902
6903	if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
6904		return -EINVAL;
6905
6906	/*
6907	 * The ALSA mixer is our primary interface.
6908	 * When disabled, don't install the subdriver at all
6909	 */
6910	if (!alsa_enable) {
6911		vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6912			    "ALSA mixer disabled by parameter, "
6913			    "not loading volume subdriver...\n");
6914		return 1;
6915	}
6916
6917	quirks = tpacpi_check_quirks(volume_quirk_table,
6918				     ARRAY_SIZE(volume_quirk_table));
6919
6920	switch (volume_capabilities) {
6921	case TPACPI_VOL_CAP_AUTO:
6922		if (quirks & TPACPI_VOL_Q_MUTEONLY)
6923			tp_features.mixer_no_level_control = 1;
6924		else if (quirks & TPACPI_VOL_Q_LEVEL)
6925			tp_features.mixer_no_level_control = 0;
6926		else
6927			return 1; /* no mixer */
6928		break;
6929	case TPACPI_VOL_CAP_VOLMUTE:
6930		tp_features.mixer_no_level_control = 0;
6931		break;
6932	case TPACPI_VOL_CAP_MUTEONLY:
6933		tp_features.mixer_no_level_control = 1;
6934		break;
6935	default:
6936		return 1;
6937	}
6938
6939	if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
6940		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6941				"using user-supplied volume_capabilities=%d\n",
6942				volume_capabilities);
6943
6944	if (volume_mode == TPACPI_VOL_MODE_AUTO ||
6945	    volume_mode == TPACPI_VOL_MODE_MAX) {
6946		volume_mode = TPACPI_VOL_MODE_ECNVRAM;
6947
6948		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6949				"driver auto-selected volume_mode=%d\n",
6950				volume_mode);
6951	} else {
6952		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6953				"using user-supplied volume_mode=%d\n",
6954				volume_mode);
6955	}
6956
6957	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6958			"mute is supported, volume control is %s\n",
6959			str_supported(!tp_features.mixer_no_level_control));
6960
6961	rc = volume_create_alsa_mixer();
6962	if (rc) {
6963		pr_err("Could not create the ALSA mixer interface\n");
6964		return rc;
6965	}
6966
6967	pr_info("Console audio control enabled, mode: %s\n",
6968		(volume_control_allowed) ?
6969			"override (read/write)" :
6970			"monitor (read only)");
6971
6972	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6973		"registering volume hotkeys as change notification\n");
6974	tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6975			| TP_ACPI_HKEY_VOLUP_MASK
6976			| TP_ACPI_HKEY_VOLDWN_MASK
6977			| TP_ACPI_HKEY_MUTE_MASK);
6978
6979	return 0;
6980}
6981
6982static int volume_read(struct seq_file *m)
6983{
6984	u8 status;
6985
6986	if (volume_get_status(&status) < 0) {
6987		seq_printf(m, "level:\t\tunreadable\n");
6988	} else {
6989		if (tp_features.mixer_no_level_control)
6990			seq_printf(m, "level:\t\tunsupported\n");
6991		else
6992			seq_printf(m, "level:\t\t%d\n",
6993					status & TP_EC_AUDIO_LVL_MSK);
6994
6995		seq_printf(m, "mute:\t\t%s\n",
6996				onoff(status, TP_EC_AUDIO_MUTESW));
6997
6998		if (volume_control_allowed) {
6999			seq_printf(m, "commands:\tunmute, mute\n");
7000			if (!tp_features.mixer_no_level_control) {
7001				seq_printf(m,
7002					       "commands:\tup, down\n");
7003				seq_printf(m,
7004					       "commands:\tlevel <level>"
7005					       " (<level> is 0-%d)\n",
7006					       TP_EC_VOLUME_MAX);
7007			}
7008		}
7009	}
7010
7011	return 0;
7012}
7013
7014static int volume_write(char *buf)
7015{
7016	u8 s;
7017	u8 new_level, new_mute;
7018	int l;
7019	char *cmd;
7020	int rc;
7021
7022	/*
7023	 * We do allow volume control at driver startup, so that the
7024	 * user can set initial state through the volume=... parameter hack.
7025	 */
7026	if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7027		if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7028			tp_warned.volume_ctrl_forbidden = 1;
7029			pr_notice("Console audio control in monitor mode, "
7030				  "changes are not allowed\n");
7031			pr_notice("Use the volume_control=1 module parameter "
7032				  "to enable volume control\n");
7033		}
7034		return -EPERM;
7035	}
7036
7037	rc = volume_get_status(&s);
7038	if (rc < 0)
7039		return rc;
7040
7041	new_level = s & TP_EC_AUDIO_LVL_MSK;
7042	new_mute  = s & TP_EC_AUDIO_MUTESW_MSK;
7043
7044	while ((cmd = next_cmd(&buf))) {
7045		if (!tp_features.mixer_no_level_control) {
7046			if (strlencmp(cmd, "up") == 0) {
7047				if (new_mute)
7048					new_mute = 0;
7049				else if (new_level < TP_EC_VOLUME_MAX)
7050					new_level++;
7051				continue;
7052			} else if (strlencmp(cmd, "down") == 0) {
7053				if (new_mute)
7054					new_mute = 0;
7055				else if (new_level > 0)
7056					new_level--;
7057				continue;
7058			} else if (sscanf(cmd, "level %u", &l) == 1 &&
7059				   l >= 0 && l <= TP_EC_VOLUME_MAX) {
7060					new_level = l;
7061				continue;
7062			}
7063		}
7064		if (strlencmp(cmd, "mute") == 0)
7065			new_mute = TP_EC_AUDIO_MUTESW_MSK;
7066		else if (strlencmp(cmd, "unmute") == 0)
7067			new_mute = 0;
7068		else
7069			return -EINVAL;
7070	}
7071
7072	if (tp_features.mixer_no_level_control) {
7073		tpacpi_disclose_usertask("procfs volume", "%smute\n",
7074					new_mute ? "" : "un");
7075		rc = volume_set_mute(!!new_mute);
7076	} else {
7077		tpacpi_disclose_usertask("procfs volume",
7078					"%smute and set level to %d\n",
7079					new_mute ? "" : "un", new_level);
7080		rc = volume_set_status(new_mute | new_level);
7081	}
7082	volume_alsa_notify_change();
7083
7084	return (rc == -EINTR) ? -ERESTARTSYS : rc;
7085}
7086
7087static struct ibm_struct volume_driver_data = {
7088	.name = "volume",
7089	.read = volume_read,
7090	.write = volume_write,
7091	.exit = volume_exit,
7092	.suspend = volume_suspend,
7093	.resume = volume_resume,
7094	.shutdown = volume_shutdown,
7095};
7096
7097#else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7098
7099#define alsa_card NULL
7100
7101static void inline volume_alsa_notify_change(void)
7102{
7103}
7104
7105static int __init volume_init(struct ibm_init_struct *iibm)
7106{
7107	pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7108
7109	return 1;
7110}
7111
7112static struct ibm_struct volume_driver_data = {
7113	.name = "volume",
7114};
7115
7116#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7117
7118/*************************************************************************
7119 * Fan subdriver
7120 */
7121
7122/*
7123 * FAN ACCESS MODES
7124 *
7125 * TPACPI_FAN_RD_ACPI_GFAN:
7126 * 	ACPI GFAN method: returns fan level
7127 *
7128 * 	see TPACPI_FAN_WR_ACPI_SFAN
7129 * 	EC 0x2f (HFSP) not available if GFAN exists
7130 *
7131 * TPACPI_FAN_WR_ACPI_SFAN:
7132 * 	ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7133 *
7134 * 	EC 0x2f (HFSP) might be available *for reading*, but do not use
7135 * 	it for writing.
7136 *
7137 * TPACPI_FAN_WR_TPEC:
7138 * 	ThinkPad EC register 0x2f (HFSP): fan control loop mode
7139 * 	Supported on almost all ThinkPads
7140 *
7141 * 	Fan speed changes of any sort (including those caused by the
7142 * 	disengaged mode) are usually done slowly by the firmware as the
7143 * 	maximum amount of fan duty cycle change per second seems to be
7144 * 	limited.
7145 *
7146 * 	Reading is not available if GFAN exists.
7147 * 	Writing is not available if SFAN exists.
7148 *
7149 * 	Bits
7150 *	 7	automatic mode engaged;
7151 *  		(default operation mode of the ThinkPad)
7152 * 		fan level is ignored in this mode.
7153 *	 6	full speed mode (takes precedence over bit 7);
7154 *		not available on all thinkpads.  May disable
7155 *		the tachometer while the fan controller ramps up
7156 *		the speed (which can take up to a few *minutes*).
7157 *		Speeds up fan to 100% duty-cycle, which is far above
7158 *		the standard RPM levels.  It is not impossible that
7159 *		it could cause hardware damage.
7160 *	5-3	unused in some models.  Extra bits for fan level
7161 *		in others, but still useless as all values above
7162 *		7 map to the same speed as level 7 in these models.
7163 *	2-0	fan level (0..7 usually)
7164 *			0x00 = stop
7165 * 			0x07 = max (set when temperatures critical)
7166 * 		Some ThinkPads may have other levels, see
7167 * 		TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7168 *
7169 *	FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7170 *	boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7171 *	does so, its initial value is meaningless (0x07).
7172 *
7173 *	For firmware bugs, refer to:
7174 *	http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7175 *
7176 * 	----
7177 *
7178 *	ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7179 *	Main fan tachometer reading (in RPM)
7180 *
7181 *	This register is present on all ThinkPads with a new-style EC, and
7182 *	it is known not to be present on the A21m/e, and T22, as there is
7183 *	something else in offset 0x84 according to the ACPI DSDT.  Other
7184 *	ThinkPads from this same time period (and earlier) probably lack the
7185 *	tachometer as well.
7186 *
7187 *	Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7188 *	was never fixed by IBM to report the EC firmware version string
7189 *	probably support the tachometer (like the early X models), so
7190 *	detecting it is quite hard.  We need more data to know for sure.
7191 *
7192 *	FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7193 *	might result.
7194 *
7195 *	FIRMWARE BUG: may go stale while the EC is switching to full speed
7196 *	mode.
7197 *
7198 *	For firmware bugs, refer to:
7199 *	http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7200 *
7201 *	----
7202 *
7203 *	ThinkPad EC register 0x31 bit 0 (only on select models)
7204 *
7205 *	When bit 0 of EC register 0x31 is zero, the tachometer registers
7206 *	show the speed of the main fan.  When bit 0 of EC register 0x31
7207 *	is one, the tachometer registers show the speed of the auxiliary
7208 *	fan.
7209 *
7210 *	Fan control seems to affect both fans, regardless of the state
7211 *	of this bit.
7212 *
7213 *	So far, only the firmware for the X60/X61 non-tablet versions
7214 *	seem to support this (firmware TP-7M).
7215 *
7216 * TPACPI_FAN_WR_ACPI_FANS:
7217 *	ThinkPad X31, X40, X41.  Not available in the X60.
7218 *
7219 *	FANS ACPI handle: takes three arguments: low speed, medium speed,
7220 *	high speed.  ACPI DSDT seems to map these three speeds to levels
7221 *	as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7222 *	(this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7223 *
7224 * 	The speeds are stored on handles
7225 * 	(FANA:FAN9), (FANC:FANB), (FANE:FAND).
7226 *
7227 * 	There are three default speed sets, accessible as handles:
7228 * 	FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7229 *
7230 * 	ACPI DSDT switches which set is in use depending on various
7231 * 	factors.
7232 *
7233 * 	TPACPI_FAN_WR_TPEC is also available and should be used to
7234 * 	command the fan.  The X31/X40/X41 seems to have 8 fan levels,
7235 * 	but the ACPI tables just mention level 7.
7236 */
7237
7238enum {					/* Fan control constants */
7239	fan_status_offset = 0x2f,	/* EC register 0x2f */
7240	fan_rpm_offset = 0x84,		/* EC register 0x84: LSB, 0x85 MSB (RPM)
7241					 * 0x84 must be read before 0x85 */
7242	fan_select_offset = 0x31,	/* EC register 0x31 (Firmware 7M)
7243					   bit 0 selects which fan is active */
7244
7245	TP_EC_FAN_FULLSPEED = 0x40,	/* EC fan mode: full speed */
7246	TP_EC_FAN_AUTO	    = 0x80,	/* EC fan mode: auto fan control */
7247
7248	TPACPI_FAN_LAST_LEVEL = 0x100,	/* Use cached last-seen fan level */
7249};
7250
7251enum fan_status_access_mode {
7252	TPACPI_FAN_NONE = 0,		/* No fan status or control */
7253	TPACPI_FAN_RD_ACPI_GFAN,	/* Use ACPI GFAN */
7254	TPACPI_FAN_RD_TPEC,		/* Use ACPI EC regs 0x2f, 0x84-0x85 */
7255};
7256
7257enum fan_control_access_mode {
7258	TPACPI_FAN_WR_NONE = 0,		/* No fan control */
7259	TPACPI_FAN_WR_ACPI_SFAN,	/* Use ACPI SFAN */
7260	TPACPI_FAN_WR_TPEC,		/* Use ACPI EC reg 0x2f */
7261	TPACPI_FAN_WR_ACPI_FANS,	/* Use ACPI FANS and EC reg 0x2f */
7262};
7263
7264enum fan_control_commands {
7265	TPACPI_FAN_CMD_SPEED 	= 0x0001,	/* speed command */
7266	TPACPI_FAN_CMD_LEVEL 	= 0x0002,	/* level command  */
7267	TPACPI_FAN_CMD_ENABLE	= 0x0004,	/* enable/disable cmd,
7268						 * and also watchdog cmd */
7269};
7270
7271static int fan_control_allowed;
7272
7273static enum fan_status_access_mode fan_status_access_mode;
7274static enum fan_control_access_mode fan_control_access_mode;
7275static enum fan_control_commands fan_control_commands;
7276
7277static u8 fan_control_initial_status;
7278static u8 fan_control_desired_level;
7279static u8 fan_control_resume_level;
7280static int fan_watchdog_maxinterval;
7281
7282static struct mutex fan_mutex;
7283
7284static void fan_watchdog_fire(struct work_struct *ignored);
7285static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7286
7287TPACPI_HANDLE(fans, ec, "FANS");	/* X31, X40, X41 */
7288TPACPI_HANDLE(gfan, ec, "GFAN",	/* 570 */
7289	   "\\FSPD",		/* 600e/x, 770e, 770x */
7290	   );			/* all others */
7291TPACPI_HANDLE(sfan, ec, "SFAN",	/* 570 */
7292	   "JFNS",		/* 770x-JL */
7293	   );			/* all others */
7294
7295/*
7296 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7297 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7298 * be in auto mode (0x80).
7299 *
7300 * This is corrected by any write to HFSP either by the driver, or
7301 * by the firmware.
7302 *
7303 * We assume 0x07 really means auto mode while this quirk is active,
7304 * as this is far more likely than the ThinkPad being in level 7,
7305 * which is only used by the firmware during thermal emergencies.
7306 *
7307 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7308 * TP-70 (T43, R52), which are known to be buggy.
7309 */
7310
7311static void fan_quirk1_setup(void)
7312{
7313	if (fan_control_initial_status == 0x07) {
7314		pr_notice("fan_init: initial fan status is unknown, "
7315			  "assuming it is in auto mode\n");
7316		tp_features.fan_ctrl_status_undef = 1;
7317	}
7318}
7319
7320static void fan_quirk1_handle(u8 *fan_status)
7321{
7322	if (unlikely(tp_features.fan_ctrl_status_undef)) {
7323		if (*fan_status != fan_control_initial_status) {
7324			/* something changed the HFSP regisnter since
7325			 * driver init time, so it is not undefined
7326			 * anymore */
7327			tp_features.fan_ctrl_status_undef = 0;
7328		} else {
7329			/* Return most likely status. In fact, it
7330			 * might be the only possible status */
7331			*fan_status = TP_EC_FAN_AUTO;
7332		}
7333	}
7334}
7335
7336/* Select main fan on X60/X61, NOOP on others */
7337static bool fan_select_fan1(void)
7338{
7339	if (tp_features.second_fan) {
7340		u8 val;
7341
7342		if (ec_read(fan_select_offset, &val) < 0)
7343			return false;
7344		val &= 0xFEU;
7345		if (ec_write(fan_select_offset, val) < 0)
7346			return false;
7347	}
7348	return true;
7349}
7350
7351/* Select secondary fan on X60/X61 */
7352static bool fan_select_fan2(void)
7353{
7354	u8 val;
7355
7356	if (!tp_features.second_fan)
7357		return false;
7358
7359	if (ec_read(fan_select_offset, &val) < 0)
7360		return false;
7361	val |= 0x01U;
7362	if (ec_write(fan_select_offset, val) < 0)
7363		return false;
7364
7365	return true;
7366}
7367
7368/*
7369 * Call with fan_mutex held
7370 */
7371static void fan_update_desired_level(u8 status)
7372{
7373	if ((status &
7374	     (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7375		if (status > 7)
7376			fan_control_desired_level = 7;
7377		else
7378			fan_control_desired_level = status;
7379	}
7380}
7381
7382static int fan_get_status(u8 *status)
7383{
7384	u8 s;
7385
7386	/* TODO:
7387	 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7388
7389	switch (fan_status_access_mode) {
7390	case TPACPI_FAN_RD_ACPI_GFAN:
7391		/* 570, 600e/x, 770e, 770x */
 
7392
7393		if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
7394			return -EIO;
7395
7396		if (likely(status))
7397			*status = s & 0x07;
7398
7399		break;
7400
7401	case TPACPI_FAN_RD_TPEC:
7402		/* all except 570, 600e/x, 770e, 770x */
7403		if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7404			return -EIO;
7405
7406		if (likely(status)) {
7407			*status = s;
7408			fan_quirk1_handle(status);
7409		}
7410
7411		break;
7412
7413	default:
7414		return -ENXIO;
7415	}
7416
7417	return 0;
7418}
7419
7420static int fan_get_status_safe(u8 *status)
7421{
7422	int rc;
7423	u8 s;
7424
7425	if (mutex_lock_killable(&fan_mutex))
7426		return -ERESTARTSYS;
7427	rc = fan_get_status(&s);
7428	if (!rc)
7429		fan_update_desired_level(s);
7430	mutex_unlock(&fan_mutex);
7431
7432	if (status)
7433		*status = s;
7434
7435	return rc;
7436}
7437
7438static int fan_get_speed(unsigned int *speed)
7439{
7440	u8 hi, lo;
7441
7442	switch (fan_status_access_mode) {
7443	case TPACPI_FAN_RD_TPEC:
7444		/* all except 570, 600e/x, 770e, 770x */
7445		if (unlikely(!fan_select_fan1()))
7446			return -EIO;
7447		if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7448			     !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7449			return -EIO;
7450
7451		if (likely(speed))
7452			*speed = (hi << 8) | lo;
7453
7454		break;
7455
7456	default:
7457		return -ENXIO;
7458	}
7459
7460	return 0;
7461}
7462
7463static int fan2_get_speed(unsigned int *speed)
7464{
7465	u8 hi, lo;
7466	bool rc;
7467
7468	switch (fan_status_access_mode) {
7469	case TPACPI_FAN_RD_TPEC:
7470		/* all except 570, 600e/x, 770e, 770x */
7471		if (unlikely(!fan_select_fan2()))
7472			return -EIO;
7473		rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7474			     !acpi_ec_read(fan_rpm_offset + 1, &hi);
7475		fan_select_fan1(); /* play it safe */
7476		if (rc)
7477			return -EIO;
7478
7479		if (likely(speed))
7480			*speed = (hi << 8) | lo;
7481
7482		break;
7483
7484	default:
7485		return -ENXIO;
7486	}
7487
7488	return 0;
7489}
7490
7491static int fan_set_level(int level)
7492{
7493	if (!fan_control_allowed)
7494		return -EPERM;
7495
7496	switch (fan_control_access_mode) {
7497	case TPACPI_FAN_WR_ACPI_SFAN:
7498		if (level >= 0 && level <= 7) {
7499			if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7500				return -EIO;
7501		} else
7502			return -EINVAL;
7503		break;
7504
7505	case TPACPI_FAN_WR_ACPI_FANS:
7506	case TPACPI_FAN_WR_TPEC:
7507		if (!(level & TP_EC_FAN_AUTO) &&
7508		    !(level & TP_EC_FAN_FULLSPEED) &&
7509		    ((level < 0) || (level > 7)))
7510			return -EINVAL;
7511
7512		/* safety net should the EC not support AUTO
7513		 * or FULLSPEED mode bits and just ignore them */
7514		if (level & TP_EC_FAN_FULLSPEED)
7515			level |= 7;	/* safety min speed 7 */
7516		else if (level & TP_EC_FAN_AUTO)
7517			level |= 4;	/* safety min speed 4 */
7518
7519		if (!acpi_ec_write(fan_status_offset, level))
7520			return -EIO;
7521		else
7522			tp_features.fan_ctrl_status_undef = 0;
7523		break;
7524
7525	default:
7526		return -ENXIO;
7527	}
7528
7529	vdbg_printk(TPACPI_DBG_FAN,
7530		"fan control: set fan control register to 0x%02x\n", level);
7531	return 0;
7532}
7533
7534static int fan_set_level_safe(int level)
7535{
7536	int rc;
7537
7538	if (!fan_control_allowed)
7539		return -EPERM;
7540
7541	if (mutex_lock_killable(&fan_mutex))
7542		return -ERESTARTSYS;
7543
7544	if (level == TPACPI_FAN_LAST_LEVEL)
7545		level = fan_control_desired_level;
7546
7547	rc = fan_set_level(level);
7548	if (!rc)
7549		fan_update_desired_level(level);
7550
7551	mutex_unlock(&fan_mutex);
7552	return rc;
7553}
7554
7555static int fan_set_enable(void)
7556{
7557	u8 s;
7558	int rc;
7559
7560	if (!fan_control_allowed)
7561		return -EPERM;
7562
7563	if (mutex_lock_killable(&fan_mutex))
7564		return -ERESTARTSYS;
7565
7566	switch (fan_control_access_mode) {
7567	case TPACPI_FAN_WR_ACPI_FANS:
7568	case TPACPI_FAN_WR_TPEC:
7569		rc = fan_get_status(&s);
7570		if (rc < 0)
7571			break;
7572
7573		/* Don't go out of emergency fan mode */
7574		if (s != 7) {
7575			s &= 0x07;
7576			s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7577		}
7578
7579		if (!acpi_ec_write(fan_status_offset, s))
7580			rc = -EIO;
7581		else {
7582			tp_features.fan_ctrl_status_undef = 0;
7583			rc = 0;
7584		}
7585		break;
7586
7587	case TPACPI_FAN_WR_ACPI_SFAN:
7588		rc = fan_get_status(&s);
7589		if (rc < 0)
7590			break;
7591
7592		s &= 0x07;
7593
7594		/* Set fan to at least level 4 */
7595		s |= 4;
7596
7597		if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7598			rc = -EIO;
7599		else
7600			rc = 0;
7601		break;
7602
7603	default:
7604		rc = -ENXIO;
7605	}
7606
7607	mutex_unlock(&fan_mutex);
7608
7609	if (!rc)
7610		vdbg_printk(TPACPI_DBG_FAN,
7611			"fan control: set fan control register to 0x%02x\n",
7612			s);
7613	return rc;
7614}
7615
7616static int fan_set_disable(void)
7617{
7618	int rc;
7619
7620	if (!fan_control_allowed)
7621		return -EPERM;
7622
7623	if (mutex_lock_killable(&fan_mutex))
7624		return -ERESTARTSYS;
7625
7626	rc = 0;
7627	switch (fan_control_access_mode) {
7628	case TPACPI_FAN_WR_ACPI_FANS:
7629	case TPACPI_FAN_WR_TPEC:
7630		if (!acpi_ec_write(fan_status_offset, 0x00))
7631			rc = -EIO;
7632		else {
7633			fan_control_desired_level = 0;
7634			tp_features.fan_ctrl_status_undef = 0;
7635		}
7636		break;
7637
7638	case TPACPI_FAN_WR_ACPI_SFAN:
7639		if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7640			rc = -EIO;
7641		else
7642			fan_control_desired_level = 0;
7643		break;
7644
7645	default:
7646		rc = -ENXIO;
7647	}
7648
7649	if (!rc)
7650		vdbg_printk(TPACPI_DBG_FAN,
7651			"fan control: set fan control register to 0\n");
7652
7653	mutex_unlock(&fan_mutex);
7654	return rc;
7655}
7656
7657static int fan_set_speed(int speed)
7658{
7659	int rc;
7660
7661	if (!fan_control_allowed)
7662		return -EPERM;
7663
7664	if (mutex_lock_killable(&fan_mutex))
7665		return -ERESTARTSYS;
7666
7667	rc = 0;
7668	switch (fan_control_access_mode) {
7669	case TPACPI_FAN_WR_ACPI_FANS:
7670		if (speed >= 0 && speed <= 65535) {
7671			if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7672					speed, speed, speed))
7673				rc = -EIO;
7674		} else
7675			rc = -EINVAL;
7676		break;
7677
7678	default:
7679		rc = -ENXIO;
7680	}
7681
7682	mutex_unlock(&fan_mutex);
7683	return rc;
7684}
7685
7686static void fan_watchdog_reset(void)
7687{
7688	static int fan_watchdog_active;
7689
7690	if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7691		return;
7692
7693	if (fan_watchdog_active)
7694		cancel_delayed_work(&fan_watchdog_task);
7695
7696	if (fan_watchdog_maxinterval > 0 &&
7697	    tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7698		fan_watchdog_active = 1;
7699		if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7700				msecs_to_jiffies(fan_watchdog_maxinterval
7701						 * 1000))) {
7702			pr_err("failed to queue the fan watchdog, "
7703			       "watchdog will not trigger\n");
7704		}
7705	} else
7706		fan_watchdog_active = 0;
7707}
7708
7709static void fan_watchdog_fire(struct work_struct *ignored)
7710{
7711	int rc;
7712
7713	if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7714		return;
7715
7716	pr_notice("fan watchdog: enabling fan\n");
7717	rc = fan_set_enable();
7718	if (rc < 0) {
7719		pr_err("fan watchdog: error %d while enabling fan, "
7720		       "will try again later...\n", -rc);
7721		/* reschedule for later */
7722		fan_watchdog_reset();
7723	}
7724}
7725
7726/*
7727 * SYSFS fan layout: hwmon compatible (device)
7728 *
7729 * pwm*_enable:
7730 * 	0: "disengaged" mode
7731 * 	1: manual mode
7732 * 	2: native EC "auto" mode (recommended, hardware default)
7733 *
7734 * pwm*: set speed in manual mode, ignored otherwise.
7735 * 	0 is level 0; 255 is level 7. Intermediate points done with linear
7736 * 	interpolation.
7737 *
7738 * fan*_input: tachometer reading, RPM
7739 *
7740 *
7741 * SYSFS fan layout: extensions
7742 *
7743 * fan_watchdog (driver):
7744 * 	fan watchdog interval in seconds, 0 disables (default), max 120
7745 */
7746
7747/* sysfs fan pwm1_enable ----------------------------------------------- */
7748static ssize_t fan_pwm1_enable_show(struct device *dev,
7749				    struct device_attribute *attr,
7750				    char *buf)
7751{
7752	int res, mode;
7753	u8 status;
7754
7755	res = fan_get_status_safe(&status);
7756	if (res)
7757		return res;
7758
7759	if (status & TP_EC_FAN_FULLSPEED) {
7760		mode = 0;
7761	} else if (status & TP_EC_FAN_AUTO) {
7762		mode = 2;
7763	} else
7764		mode = 1;
7765
7766	return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7767}
7768
7769static ssize_t fan_pwm1_enable_store(struct device *dev,
7770				     struct device_attribute *attr,
7771				     const char *buf, size_t count)
7772{
7773	unsigned long t;
7774	int res, level;
7775
7776	if (parse_strtoul(buf, 2, &t))
7777		return -EINVAL;
7778
7779	tpacpi_disclose_usertask("hwmon pwm1_enable",
7780			"set fan mode to %lu\n", t);
7781
7782	switch (t) {
7783	case 0:
7784		level = TP_EC_FAN_FULLSPEED;
7785		break;
7786	case 1:
7787		level = TPACPI_FAN_LAST_LEVEL;
7788		break;
7789	case 2:
7790		level = TP_EC_FAN_AUTO;
7791		break;
7792	case 3:
7793		/* reserved for software-controlled auto mode */
7794		return -ENOSYS;
7795	default:
7796		return -EINVAL;
7797	}
7798
7799	res = fan_set_level_safe(level);
7800	if (res == -ENXIO)
7801		return -EINVAL;
7802	else if (res < 0)
7803		return res;
7804
7805	fan_watchdog_reset();
7806
7807	return count;
7808}
7809
7810static struct device_attribute dev_attr_fan_pwm1_enable =
7811	__ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7812		fan_pwm1_enable_show, fan_pwm1_enable_store);
7813
7814/* sysfs fan pwm1 ------------------------------------------------------ */
7815static ssize_t fan_pwm1_show(struct device *dev,
7816			     struct device_attribute *attr,
7817			     char *buf)
7818{
7819	int res;
7820	u8 status;
7821
7822	res = fan_get_status_safe(&status);
7823	if (res)
7824		return res;
7825
7826	if ((status &
7827	     (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7828		status = fan_control_desired_level;
7829
7830	if (status > 7)
7831		status = 7;
7832
7833	return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7834}
7835
7836static ssize_t fan_pwm1_store(struct device *dev,
7837			      struct device_attribute *attr,
7838			      const char *buf, size_t count)
7839{
7840	unsigned long s;
7841	int rc;
7842	u8 status, newlevel;
7843
7844	if (parse_strtoul(buf, 255, &s))
7845		return -EINVAL;
7846
7847	tpacpi_disclose_usertask("hwmon pwm1",
7848			"set fan speed to %lu\n", s);
7849
7850	/* scale down from 0-255 to 0-7 */
7851	newlevel = (s >> 5) & 0x07;
7852
7853	if (mutex_lock_killable(&fan_mutex))
7854		return -ERESTARTSYS;
7855
7856	rc = fan_get_status(&status);
7857	if (!rc && (status &
7858		    (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7859		rc = fan_set_level(newlevel);
7860		if (rc == -ENXIO)
7861			rc = -EINVAL;
7862		else if (!rc) {
7863			fan_update_desired_level(newlevel);
7864			fan_watchdog_reset();
7865		}
7866	}
7867
7868	mutex_unlock(&fan_mutex);
7869	return (rc)? rc : count;
7870}
7871
7872static struct device_attribute dev_attr_fan_pwm1 =
7873	__ATTR(pwm1, S_IWUSR | S_IRUGO,
7874		fan_pwm1_show, fan_pwm1_store);
7875
7876/* sysfs fan fan1_input ------------------------------------------------ */
7877static ssize_t fan_fan1_input_show(struct device *dev,
7878			   struct device_attribute *attr,
7879			   char *buf)
7880{
7881	int res;
7882	unsigned int speed;
7883
7884	res = fan_get_speed(&speed);
7885	if (res < 0)
7886		return res;
7887
7888	return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7889}
7890
7891static struct device_attribute dev_attr_fan_fan1_input =
7892	__ATTR(fan1_input, S_IRUGO,
7893		fan_fan1_input_show, NULL);
7894
7895/* sysfs fan fan2_input ------------------------------------------------ */
7896static ssize_t fan_fan2_input_show(struct device *dev,
7897			   struct device_attribute *attr,
7898			   char *buf)
7899{
7900	int res;
7901	unsigned int speed;
7902
7903	res = fan2_get_speed(&speed);
7904	if (res < 0)
7905		return res;
7906
7907	return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7908}
7909
7910static struct device_attribute dev_attr_fan_fan2_input =
7911	__ATTR(fan2_input, S_IRUGO,
7912		fan_fan2_input_show, NULL);
7913
7914/* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7915static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7916				     char *buf)
7917{
7918	return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7919}
7920
7921static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7922				      const char *buf, size_t count)
7923{
7924	unsigned long t;
7925
7926	if (parse_strtoul(buf, 120, &t))
7927		return -EINVAL;
7928
7929	if (!fan_control_allowed)
7930		return -EPERM;
7931
7932	fan_watchdog_maxinterval = t;
7933	fan_watchdog_reset();
7934
7935	tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7936
7937	return count;
7938}
7939
7940static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7941		fan_fan_watchdog_show, fan_fan_watchdog_store);
7942
7943/* --------------------------------------------------------------------- */
7944static struct attribute *fan_attributes[] = {
7945	&dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7946	&dev_attr_fan_fan1_input.attr,
7947	NULL, /* for fan2_input */
7948	NULL
7949};
7950
7951static const struct attribute_group fan_attr_group = {
7952	.attrs = fan_attributes,
7953};
7954
7955#define	TPACPI_FAN_Q1	0x0001		/* Unitialized HFSP */
7956#define TPACPI_FAN_2FAN	0x0002		/* EC 0x31 bit 0 selects fan2 */
7957
7958#define TPACPI_FAN_QI(__id1, __id2, __quirks)	\
7959	{ .vendor = PCI_VENDOR_ID_IBM,		\
7960	  .bios = TPACPI_MATCH_ANY,		\
7961	  .ec = TPID(__id1, __id2),		\
7962	  .quirks = __quirks }
7963
7964#define TPACPI_FAN_QL(__id1, __id2, __quirks)	\
7965	{ .vendor = PCI_VENDOR_ID_LENOVO,	\
7966	  .bios = TPACPI_MATCH_ANY,		\
7967	  .ec = TPID(__id1, __id2),		\
7968	  .quirks = __quirks }
7969
7970static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
7971	TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
7972	TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
7973	TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
7974	TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
7975	TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
7976};
7977
7978#undef TPACPI_FAN_QL
7979#undef TPACPI_FAN_QI
7980
7981static int __init fan_init(struct ibm_init_struct *iibm)
7982{
7983	int rc;
7984	unsigned long quirks;
7985
7986	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7987			"initializing fan subdriver\n");
7988
7989	mutex_init(&fan_mutex);
7990	fan_status_access_mode = TPACPI_FAN_NONE;
7991	fan_control_access_mode = TPACPI_FAN_WR_NONE;
7992	fan_control_commands = 0;
7993	fan_watchdog_maxinterval = 0;
7994	tp_features.fan_ctrl_status_undef = 0;
7995	tp_features.second_fan = 0;
7996	fan_control_desired_level = 7;
7997
7998	if (tpacpi_is_ibm()) {
7999		TPACPI_ACPIHANDLE_INIT(fans);
8000		TPACPI_ACPIHANDLE_INIT(gfan);
8001		TPACPI_ACPIHANDLE_INIT(sfan);
8002	}
8003
8004	quirks = tpacpi_check_quirks(fan_quirk_table,
8005				     ARRAY_SIZE(fan_quirk_table));
8006
8007	if (gfan_handle) {
8008		/* 570, 600e/x, 770e, 770x */
8009		fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8010	} else {
8011		/* all other ThinkPads: note that even old-style
8012		 * ThinkPad ECs supports the fan control register */
8013		if (likely(acpi_ec_read(fan_status_offset,
8014					&fan_control_initial_status))) {
8015			fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8016			if (quirks & TPACPI_FAN_Q1)
8017				fan_quirk1_setup();
8018			if (quirks & TPACPI_FAN_2FAN) {
8019				tp_features.second_fan = 1;
8020				dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8021					"secondary fan support enabled\n");
8022			}
8023		} else {
8024			pr_err("ThinkPad ACPI EC access misbehaving, "
8025			       "fan status and control unavailable\n");
8026			return 1;
8027		}
8028	}
8029
8030	if (sfan_handle) {
8031		/* 570, 770x-JL */
8032		fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8033		fan_control_commands |=
8034		    TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8035	} else {
8036		if (!gfan_handle) {
8037			/* gfan without sfan means no fan control */
8038			/* all other models implement TP EC 0x2f control */
8039
8040			if (fans_handle) {
8041				/* X31, X40, X41 */
8042				fan_control_access_mode =
8043				    TPACPI_FAN_WR_ACPI_FANS;
8044				fan_control_commands |=
8045				    TPACPI_FAN_CMD_SPEED |
8046				    TPACPI_FAN_CMD_LEVEL |
8047				    TPACPI_FAN_CMD_ENABLE;
8048			} else {
8049				fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8050				fan_control_commands |=
8051				    TPACPI_FAN_CMD_LEVEL |
8052				    TPACPI_FAN_CMD_ENABLE;
8053			}
8054		}
8055	}
8056
8057	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8058		"fan is %s, modes %d, %d\n",
8059		str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8060		  fan_control_access_mode != TPACPI_FAN_WR_NONE),
8061		fan_status_access_mode, fan_control_access_mode);
8062
8063	/* fan control master switch */
8064	if (!fan_control_allowed) {
8065		fan_control_access_mode = TPACPI_FAN_WR_NONE;
8066		fan_control_commands = 0;
8067		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8068			   "fan control features disabled by parameter\n");
8069	}
8070
8071	/* update fan_control_desired_level */
8072	if (fan_status_access_mode != TPACPI_FAN_NONE)
8073		fan_get_status_safe(NULL);
8074
8075	if (fan_status_access_mode != TPACPI_FAN_NONE ||
8076	    fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8077		if (tp_features.second_fan) {
8078			/* attach second fan tachometer */
8079			fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8080					&dev_attr_fan_fan2_input.attr;
8081		}
8082		rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8083					 &fan_attr_group);
8084		if (rc < 0)
8085			return rc;
8086
8087		rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8088					&driver_attr_fan_watchdog);
8089		if (rc < 0) {
8090			sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8091					&fan_attr_group);
8092			return rc;
8093		}
8094		return 0;
8095	} else
8096		return 1;
8097}
8098
8099static void fan_exit(void)
8100{
8101	vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8102		    "cancelling any pending fan watchdog tasks\n");
8103
8104	/* FIXME: can we really do this unconditionally? */
8105	sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8106	driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8107			   &driver_attr_fan_watchdog);
8108
8109	cancel_delayed_work(&fan_watchdog_task);
8110	flush_workqueue(tpacpi_wq);
8111}
8112
8113static void fan_suspend(pm_message_t state)
8114{
8115	int rc;
8116
8117	if (!fan_control_allowed)
8118		return;
8119
8120	/* Store fan status in cache */
8121	fan_control_resume_level = 0;
8122	rc = fan_get_status_safe(&fan_control_resume_level);
8123	if (rc < 0)
8124		pr_notice("failed to read fan level for later "
8125			  "restore during resume: %d\n", rc);
8126
8127	/* if it is undefined, don't attempt to restore it.
8128	 * KEEP THIS LAST */
8129	if (tp_features.fan_ctrl_status_undef)
8130		fan_control_resume_level = 0;
8131}
8132
8133static void fan_resume(void)
8134{
8135	u8 current_level = 7;
8136	bool do_set = false;
8137	int rc;
8138
8139	/* DSDT *always* updates status on resume */
8140	tp_features.fan_ctrl_status_undef = 0;
8141
8142	if (!fan_control_allowed ||
8143	    !fan_control_resume_level ||
8144	    (fan_get_status_safe(&current_level) < 0))
8145		return;
8146
8147	switch (fan_control_access_mode) {
8148	case TPACPI_FAN_WR_ACPI_SFAN:
8149		/* never decrease fan level */
8150		do_set = (fan_control_resume_level > current_level);
8151		break;
8152	case TPACPI_FAN_WR_ACPI_FANS:
8153	case TPACPI_FAN_WR_TPEC:
8154		/* never decrease fan level, scale is:
8155		 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8156		 *
8157		 * We expect the firmware to set either 7 or AUTO, but we
8158		 * handle FULLSPEED out of paranoia.
8159		 *
8160		 * So, we can safely only restore FULLSPEED or 7, anything
8161		 * else could slow the fan.  Restoring AUTO is useless, at
8162		 * best that's exactly what the DSDT already set (it is the
8163		 * slower it uses).
8164		 *
8165		 * Always keep in mind that the DSDT *will* have set the
8166		 * fans to what the vendor supposes is the best level.  We
8167		 * muck with it only to speed the fan up.
8168		 */
8169		if (fan_control_resume_level != 7 &&
8170		    !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8171			return;
8172		else
8173			do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8174				 (current_level != fan_control_resume_level);
8175		break;
8176	default:
8177		return;
8178	}
8179	if (do_set) {
8180		pr_notice("restoring fan level to 0x%02x\n",
8181			  fan_control_resume_level);
8182		rc = fan_set_level_safe(fan_control_resume_level);
8183		if (rc < 0)
8184			pr_notice("failed to restore fan level: %d\n", rc);
8185	}
8186}
8187
8188static int fan_read(struct seq_file *m)
8189{
8190	int rc;
8191	u8 status;
8192	unsigned int speed = 0;
8193
8194	switch (fan_status_access_mode) {
8195	case TPACPI_FAN_RD_ACPI_GFAN:
8196		/* 570, 600e/x, 770e, 770x */
8197		rc = fan_get_status_safe(&status);
8198		if (rc < 0)
8199			return rc;
8200
8201		seq_printf(m, "status:\t\t%s\n"
8202			       "level:\t\t%d\n",
8203			       (status != 0) ? "enabled" : "disabled", status);
8204		break;
8205
8206	case TPACPI_FAN_RD_TPEC:
8207		/* all except 570, 600e/x, 770e, 770x */
8208		rc = fan_get_status_safe(&status);
8209		if (rc < 0)
8210			return rc;
8211
8212		seq_printf(m, "status:\t\t%s\n",
8213			       (status != 0) ? "enabled" : "disabled");
8214
8215		rc = fan_get_speed(&speed);
8216		if (rc < 0)
8217			return rc;
8218
8219		seq_printf(m, "speed:\t\t%d\n", speed);
8220
8221		if (status & TP_EC_FAN_FULLSPEED)
8222			/* Disengaged mode takes precedence */
8223			seq_printf(m, "level:\t\tdisengaged\n");
8224		else if (status & TP_EC_FAN_AUTO)
8225			seq_printf(m, "level:\t\tauto\n");
8226		else
8227			seq_printf(m, "level:\t\t%d\n", status);
8228		break;
8229
8230	case TPACPI_FAN_NONE:
8231	default:
8232		seq_printf(m, "status:\t\tnot supported\n");
8233	}
8234
8235	if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8236		seq_printf(m, "commands:\tlevel <level>");
8237
8238		switch (fan_control_access_mode) {
8239		case TPACPI_FAN_WR_ACPI_SFAN:
8240			seq_printf(m, " (<level> is 0-7)\n");
8241			break;
8242
8243		default:
8244			seq_printf(m, " (<level> is 0-7, "
8245				       "auto, disengaged, full-speed)\n");
8246			break;
8247		}
8248	}
8249
8250	if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8251		seq_printf(m, "commands:\tenable, disable\n"
8252			       "commands:\twatchdog <timeout> (<timeout> "
8253			       "is 0 (off), 1-120 (seconds))\n");
8254
8255	if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8256		seq_printf(m, "commands:\tspeed <speed>"
8257			       " (<speed> is 0-65535)\n");
8258
8259	return 0;
8260}
8261
8262static int fan_write_cmd_level(const char *cmd, int *rc)
8263{
8264	int level;
8265
8266	if (strlencmp(cmd, "level auto") == 0)
8267		level = TP_EC_FAN_AUTO;
8268	else if ((strlencmp(cmd, "level disengaged") == 0) |
8269			(strlencmp(cmd, "level full-speed") == 0))
8270		level = TP_EC_FAN_FULLSPEED;
8271	else if (sscanf(cmd, "level %d", &level) != 1)
8272		return 0;
8273
8274	*rc = fan_set_level_safe(level);
8275	if (*rc == -ENXIO)
8276		pr_err("level command accepted for unsupported access mode %d\n",
8277		       fan_control_access_mode);
8278	else if (!*rc)
8279		tpacpi_disclose_usertask("procfs fan",
8280			"set level to %d\n", level);
8281
8282	return 1;
8283}
8284
8285static int fan_write_cmd_enable(const char *cmd, int *rc)
8286{
8287	if (strlencmp(cmd, "enable") != 0)
8288		return 0;
8289
8290	*rc = fan_set_enable();
8291	if (*rc == -ENXIO)
8292		pr_err("enable command accepted for unsupported access mode %d\n",
8293		       fan_control_access_mode);
8294	else if (!*rc)
8295		tpacpi_disclose_usertask("procfs fan", "enable\n");
8296
8297	return 1;
8298}
8299
8300static int fan_write_cmd_disable(const char *cmd, int *rc)
8301{
8302	if (strlencmp(cmd, "disable") != 0)
8303		return 0;
8304
8305	*rc = fan_set_disable();
8306	if (*rc == -ENXIO)
8307		pr_err("disable command accepted for unsupported access mode %d\n",
8308		       fan_control_access_mode);
8309	else if (!*rc)
8310		tpacpi_disclose_usertask("procfs fan", "disable\n");
8311
8312	return 1;
8313}
8314
8315static int fan_write_cmd_speed(const char *cmd, int *rc)
8316{
8317	int speed;
8318
8319	/* TODO:
8320	 * Support speed <low> <medium> <high> ? */
8321
8322	if (sscanf(cmd, "speed %d", &speed) != 1)
8323		return 0;
8324
8325	*rc = fan_set_speed(speed);
8326	if (*rc == -ENXIO)
8327		pr_err("speed command accepted for unsupported access mode %d\n",
8328		       fan_control_access_mode);
8329	else if (!*rc)
8330		tpacpi_disclose_usertask("procfs fan",
8331			"set speed to %d\n", speed);
8332
8333	return 1;
8334}
8335
8336static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8337{
8338	int interval;
8339
8340	if (sscanf(cmd, "watchdog %d", &interval) != 1)
8341		return 0;
8342
8343	if (interval < 0 || interval > 120)
8344		*rc = -EINVAL;
8345	else {
8346		fan_watchdog_maxinterval = interval;
8347		tpacpi_disclose_usertask("procfs fan",
8348			"set watchdog timer to %d\n",
8349			interval);
8350	}
8351
8352	return 1;
8353}
8354
8355static int fan_write(char *buf)
8356{
8357	char *cmd;
8358	int rc = 0;
8359
8360	while (!rc && (cmd = next_cmd(&buf))) {
8361		if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8362		      fan_write_cmd_level(cmd, &rc)) &&
8363		    !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8364		      (fan_write_cmd_enable(cmd, &rc) ||
8365		       fan_write_cmd_disable(cmd, &rc) ||
8366		       fan_write_cmd_watchdog(cmd, &rc))) &&
8367		    !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8368		      fan_write_cmd_speed(cmd, &rc))
8369		    )
8370			rc = -EINVAL;
8371		else if (!rc)
8372			fan_watchdog_reset();
8373	}
8374
8375	return rc;
8376}
8377
8378static struct ibm_struct fan_driver_data = {
8379	.name = "fan",
8380	.read = fan_read,
8381	.write = fan_write,
8382	.exit = fan_exit,
8383	.suspend = fan_suspend,
8384	.resume = fan_resume,
8385};
8386
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8387/****************************************************************************
8388 ****************************************************************************
8389 *
8390 * Infrastructure
8391 *
8392 ****************************************************************************
8393 ****************************************************************************/
8394
8395/*
8396 * HKEY event callout for other subdrivers go here
8397 * (yes, it is ugly, but it is quick, safe, and gets the job done
8398 */
8399static void tpacpi_driver_event(const unsigned int hkey_event)
8400{
8401	if (ibm_backlight_device) {
8402		switch (hkey_event) {
8403		case TP_HKEY_EV_BRGHT_UP:
8404		case TP_HKEY_EV_BRGHT_DOWN:
8405			tpacpi_brightness_notify_change();
8406		}
8407	}
8408	if (alsa_card) {
8409		switch (hkey_event) {
8410		case TP_HKEY_EV_VOL_UP:
8411		case TP_HKEY_EV_VOL_DOWN:
8412		case TP_HKEY_EV_VOL_MUTE:
8413			volume_alsa_notify_change();
8414		}
8415	}
8416}
8417
8418static void hotkey_driver_event(const unsigned int scancode)
8419{
8420	tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8421}
8422
8423/* sysfs name ---------------------------------------------------------- */
8424static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8425			   struct device_attribute *attr,
8426			   char *buf)
8427{
8428	return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8429}
8430
8431static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8432	__ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8433
8434/* --------------------------------------------------------------------- */
8435
8436/* /proc support */
8437static struct proc_dir_entry *proc_dir;
8438
8439/*
8440 * Module and infrastructure proble, init and exit handling
8441 */
8442
8443static int force_load;
8444
8445#ifdef CONFIG_THINKPAD_ACPI_DEBUG
8446static const char * __init str_supported(int is_supported)
8447{
8448	static char text_unsupported[] __initdata = "not supported";
8449
8450	return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8451}
8452#endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8453
8454static void ibm_exit(struct ibm_struct *ibm)
8455{
8456	dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8457
8458	list_del_init(&ibm->all_drivers);
8459
8460	if (ibm->flags.acpi_notify_installed) {
8461		dbg_printk(TPACPI_DBG_EXIT,
8462			"%s: acpi_remove_notify_handler\n", ibm->name);
8463		BUG_ON(!ibm->acpi);
8464		acpi_remove_notify_handler(*ibm->acpi->handle,
8465					   ibm->acpi->type,
8466					   dispatch_acpi_notify);
8467		ibm->flags.acpi_notify_installed = 0;
8468	}
8469
8470	if (ibm->flags.proc_created) {
8471		dbg_printk(TPACPI_DBG_EXIT,
8472			"%s: remove_proc_entry\n", ibm->name);
8473		remove_proc_entry(ibm->name, proc_dir);
8474		ibm->flags.proc_created = 0;
8475	}
8476
8477	if (ibm->flags.acpi_driver_registered) {
8478		dbg_printk(TPACPI_DBG_EXIT,
8479			"%s: acpi_bus_unregister_driver\n", ibm->name);
8480		BUG_ON(!ibm->acpi);
8481		acpi_bus_unregister_driver(ibm->acpi->driver);
8482		kfree(ibm->acpi->driver);
8483		ibm->acpi->driver = NULL;
8484		ibm->flags.acpi_driver_registered = 0;
8485	}
8486
8487	if (ibm->flags.init_called && ibm->exit) {
8488		ibm->exit();
8489		ibm->flags.init_called = 0;
8490	}
8491
8492	dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8493}
8494
8495static int __init ibm_init(struct ibm_init_struct *iibm)
8496{
8497	int ret;
8498	struct ibm_struct *ibm = iibm->data;
8499	struct proc_dir_entry *entry;
8500
8501	BUG_ON(ibm == NULL);
8502
8503	INIT_LIST_HEAD(&ibm->all_drivers);
8504
8505	if (ibm->flags.experimental && !experimental)
8506		return 0;
8507
8508	dbg_printk(TPACPI_DBG_INIT,
8509		"probing for %s\n", ibm->name);
8510
8511	if (iibm->init) {
8512		ret = iibm->init(iibm);
8513		if (ret > 0)
8514			return 0;	/* probe failed */
8515		if (ret)
8516			return ret;
8517
8518		ibm->flags.init_called = 1;
8519	}
8520
8521	if (ibm->acpi) {
8522		if (ibm->acpi->hid) {
8523			ret = register_tpacpi_subdriver(ibm);
8524			if (ret)
8525				goto err_out;
8526		}
8527
8528		if (ibm->acpi->notify) {
8529			ret = setup_acpi_notify(ibm);
8530			if (ret == -ENODEV) {
8531				pr_notice("disabling subdriver %s\n",
8532					  ibm->name);
8533				ret = 0;
8534				goto err_out;
8535			}
8536			if (ret < 0)
8537				goto err_out;
8538		}
8539	}
8540
8541	dbg_printk(TPACPI_DBG_INIT,
8542		"%s installed\n", ibm->name);
8543
8544	if (ibm->read) {
8545		mode_t mode = iibm->base_procfs_mode;
8546
8547		if (!mode)
8548			mode = S_IRUGO;
8549		if (ibm->write)
8550			mode |= S_IWUSR;
8551		entry = proc_create_data(ibm->name, mode, proc_dir,
8552					 &dispatch_proc_fops, ibm);
8553		if (!entry) {
8554			pr_err("unable to create proc entry %s\n", ibm->name);
8555			ret = -ENODEV;
8556			goto err_out;
8557		}
8558		ibm->flags.proc_created = 1;
8559	}
8560
8561	list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8562
8563	return 0;
8564
8565err_out:
8566	dbg_printk(TPACPI_DBG_INIT,
8567		"%s: at error exit path with result %d\n",
8568		ibm->name, ret);
8569
8570	ibm_exit(ibm);
8571	return (ret < 0)? ret : 0;
8572}
8573
8574/* Probing */
8575
8576static bool __pure __init tpacpi_is_fw_digit(const char c)
8577{
8578	return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8579}
8580
8581/* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8582static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8583						const char t)
8584{
8585	return s && strlen(s) >= 8 &&
8586		tpacpi_is_fw_digit(s[0]) &&
8587		tpacpi_is_fw_digit(s[1]) &&
8588		s[2] == t && s[3] == 'T' &&
 
8589		tpacpi_is_fw_digit(s[4]) &&
8590		tpacpi_is_fw_digit(s[5]);
8591}
8592
8593/* returns 0 - probe ok, or < 0 - probe error.
8594 * Probe ok doesn't mean thinkpad found.
8595 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8596static int __must_check __init get_thinkpad_model_data(
8597						struct thinkpad_id_data *tp)
8598{
8599	const struct dmi_device *dev = NULL;
8600	char ec_fw_string[18];
8601	char const *s;
8602
8603	if (!tp)
8604		return -EINVAL;
8605
8606	memset(tp, 0, sizeof(*tp));
8607
8608	if (dmi_name_in_vendors("IBM"))
8609		tp->vendor = PCI_VENDOR_ID_IBM;
8610	else if (dmi_name_in_vendors("LENOVO"))
8611		tp->vendor = PCI_VENDOR_ID_LENOVO;
8612	else
8613		return 0;
8614
8615	s = dmi_get_system_info(DMI_BIOS_VERSION);
8616	tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8617	if (s && !tp->bios_version_str)
8618		return -ENOMEM;
8619
8620	/* Really ancient ThinkPad 240X will fail this, which is fine */
8621	if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
 
8622		return 0;
8623
8624	tp->bios_model = tp->bios_version_str[0]
8625			 | (tp->bios_version_str[1] << 8);
8626	tp->bios_release = (tp->bios_version_str[4] << 8)
8627			 | tp->bios_version_str[5];
8628
8629	/*
8630	 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8631	 * X32 or newer, all Z series;  Some models must have an
8632	 * up-to-date BIOS or they will not be detected.
8633	 *
8634	 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8635	 */
8636	while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8637		if (sscanf(dev->name,
8638			   "IBM ThinkPad Embedded Controller -[%17c",
8639			   ec_fw_string) == 1) {
8640			ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8641			ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8642
8643			tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8644			if (!tp->ec_version_str)
8645				return -ENOMEM;
8646
8647			if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8648				tp->ec_model = ec_fw_string[0]
8649						| (ec_fw_string[1] << 8);
8650				tp->ec_release = (ec_fw_string[4] << 8)
8651						| ec_fw_string[5];
8652			} else {
8653				pr_notice("ThinkPad firmware release %s "
8654					  "doesn't match the known patterns\n",
8655					  ec_fw_string);
8656				pr_notice("please report this to %s\n",
8657					  TPACPI_MAIL);
8658			}
8659			break;
8660		}
8661	}
8662
8663	s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8664	if (s && !strnicmp(s, "ThinkPad", 8)) {
8665		tp->model_str = kstrdup(s, GFP_KERNEL);
8666		if (!tp->model_str)
8667			return -ENOMEM;
 
 
 
 
 
 
 
8668	}
8669
8670	s = dmi_get_system_info(DMI_PRODUCT_NAME);
8671	tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8672	if (s && !tp->nummodel_str)
8673		return -ENOMEM;
8674
8675	return 0;
8676}
8677
8678static int __init probe_for_thinkpad(void)
8679{
8680	int is_thinkpad;
8681
8682	if (acpi_disabled)
8683		return -ENODEV;
8684
8685	/* It would be dangerous to run the driver in this case */
8686	if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8687		return -ENODEV;
8688
8689	/*
8690	 * Non-ancient models have better DMI tagging, but very old models
8691	 * don't.  tpacpi_is_fw_known() is a cheat to help in that case.
8692	 */
8693	is_thinkpad = (thinkpad_id.model_str != NULL) ||
8694		      (thinkpad_id.ec_model != 0) ||
8695		      tpacpi_is_fw_known();
8696
8697	/* The EC handler is required */
8698	tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
8699	if (!ec_handle) {
8700		if (is_thinkpad)
8701			pr_err("Not yet supported ThinkPad detected!\n");
8702		return -ENODEV;
8703	}
8704
8705	if (!is_thinkpad && !force_load)
8706		return -ENODEV;
8707
8708	return 0;
8709}
8710
8711static void __init thinkpad_acpi_init_banner(void)
8712{
8713	pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
8714	pr_info("%s\n", TPACPI_URL);
8715
8716	pr_info("ThinkPad BIOS %s, EC %s\n",
8717		(thinkpad_id.bios_version_str) ?
8718			thinkpad_id.bios_version_str : "unknown",
8719		(thinkpad_id.ec_version_str) ?
8720			thinkpad_id.ec_version_str : "unknown");
8721
8722	BUG_ON(!thinkpad_id.vendor);
8723
8724	if (thinkpad_id.model_str)
8725		pr_info("%s %s, model %s\n",
8726			(thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
8727				"IBM" : ((thinkpad_id.vendor ==
8728						PCI_VENDOR_ID_LENOVO) ?
8729					"Lenovo" : "Unknown vendor"),
8730			thinkpad_id.model_str,
8731			(thinkpad_id.nummodel_str) ?
8732				thinkpad_id.nummodel_str : "unknown");
8733}
8734
8735/* Module init, exit, parameters */
8736
8737static struct ibm_init_struct ibms_init[] __initdata = {
8738	{
8739		.data = &thinkpad_acpi_driver_data,
8740	},
8741	{
8742		.init = hotkey_init,
8743		.data = &hotkey_driver_data,
8744	},
8745	{
8746		.init = bluetooth_init,
8747		.data = &bluetooth_driver_data,
8748	},
8749	{
8750		.init = wan_init,
8751		.data = &wan_driver_data,
8752	},
8753	{
8754		.init = uwb_init,
8755		.data = &uwb_driver_data,
8756	},
8757#ifdef CONFIG_THINKPAD_ACPI_VIDEO
8758	{
8759		.init = video_init,
8760		.base_procfs_mode = S_IRUSR,
8761		.data = &video_driver_data,
8762	},
8763#endif
8764	{
8765		.init = light_init,
8766		.data = &light_driver_data,
8767	},
8768	{
8769		.init = cmos_init,
8770		.data = &cmos_driver_data,
8771	},
8772	{
8773		.init = led_init,
8774		.data = &led_driver_data,
8775	},
8776	{
8777		.init = beep_init,
8778		.data = &beep_driver_data,
8779	},
8780	{
8781		.init = thermal_init,
8782		.data = &thermal_driver_data,
8783	},
8784	{
8785		.init = brightness_init,
8786		.data = &brightness_driver_data,
8787	},
8788	{
8789		.init = volume_init,
8790		.data = &volume_driver_data,
8791	},
8792	{
8793		.init = fan_init,
8794		.data = &fan_driver_data,
8795	},
 
 
 
 
8796};
8797
8798static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8799{
8800	unsigned int i;
8801	struct ibm_struct *ibm;
8802
8803	if (!kp || !kp->name || !val)
8804		return -EINVAL;
8805
8806	for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8807		ibm = ibms_init[i].data;
8808		WARN_ON(ibm == NULL);
8809
8810		if (!ibm || !ibm->name)
8811			continue;
8812
8813		if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8814			if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8815				return -ENOSPC;
8816			strcpy(ibms_init[i].param, val);
8817			strcat(ibms_init[i].param, ",");
8818			return 0;
8819		}
8820	}
8821
8822	return -EINVAL;
8823}
8824
8825module_param(experimental, int, 0444);
8826MODULE_PARM_DESC(experimental,
8827		 "Enables experimental features when non-zero");
8828
8829module_param_named(debug, dbg_level, uint, 0);
8830MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8831
8832module_param(force_load, bool, 0444);
8833MODULE_PARM_DESC(force_load,
8834		 "Attempts to load the driver even on a "
8835		 "mis-identified ThinkPad when true");
8836
8837module_param_named(fan_control, fan_control_allowed, bool, 0444);
8838MODULE_PARM_DESC(fan_control,
8839		 "Enables setting fan parameters features when true");
8840
8841module_param_named(brightness_mode, brightness_mode, uint, 0444);
8842MODULE_PARM_DESC(brightness_mode,
8843		 "Selects brightness control strategy: "
8844		 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8845
8846module_param(brightness_enable, uint, 0444);
8847MODULE_PARM_DESC(brightness_enable,
8848		 "Enables backlight control when 1, disables when 0");
8849
8850module_param(hotkey_report_mode, uint, 0444);
8851MODULE_PARM_DESC(hotkey_report_mode,
8852		 "used for backwards compatibility with userspace, "
8853		 "see documentation");
8854
8855#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8856module_param_named(volume_mode, volume_mode, uint, 0444);
8857MODULE_PARM_DESC(volume_mode,
8858		 "Selects volume control strategy: "
8859		 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8860
8861module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8862MODULE_PARM_DESC(volume_capabilities,
8863		 "Selects the mixer capabilites: "
8864		 "0=auto, 1=volume and mute, 2=mute only");
8865
8866module_param_named(volume_control, volume_control_allowed, bool, 0444);
8867MODULE_PARM_DESC(volume_control,
8868		 "Enables software override for the console audio "
8869		 "control when true");
8870
8871/* ALSA module API parameters */
8872module_param_named(index, alsa_index, int, 0444);
8873MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8874module_param_named(id, alsa_id, charp, 0444);
8875MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8876module_param_named(enable, alsa_enable, bool, 0444);
8877MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8878#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8879
8880#define TPACPI_PARAM(feature) \
8881	module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8882	MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8883			 "at module load, see documentation")
8884
8885TPACPI_PARAM(hotkey);
8886TPACPI_PARAM(bluetooth);
8887TPACPI_PARAM(video);
8888TPACPI_PARAM(light);
8889TPACPI_PARAM(cmos);
8890TPACPI_PARAM(led);
8891TPACPI_PARAM(beep);
8892TPACPI_PARAM(brightness);
8893TPACPI_PARAM(volume);
8894TPACPI_PARAM(fan);
8895
8896#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8897module_param(dbg_wlswemul, uint, 0444);
8898MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8899module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8900MODULE_PARM_DESC(wlsw_state,
8901		 "Initial state of the emulated WLSW switch");
8902
8903module_param(dbg_bluetoothemul, uint, 0444);
8904MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8905module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8906MODULE_PARM_DESC(bluetooth_state,
8907		 "Initial state of the emulated bluetooth switch");
8908
8909module_param(dbg_wwanemul, uint, 0444);
8910MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8911module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8912MODULE_PARM_DESC(wwan_state,
8913		 "Initial state of the emulated WWAN switch");
8914
8915module_param(dbg_uwbemul, uint, 0444);
8916MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8917module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8918MODULE_PARM_DESC(uwb_state,
8919		 "Initial state of the emulated UWB switch");
8920#endif
8921
8922static void thinkpad_acpi_module_exit(void)
8923{
8924	struct ibm_struct *ibm, *itmp;
8925
8926	tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8927
8928	list_for_each_entry_safe_reverse(ibm, itmp,
8929					 &tpacpi_all_drivers,
8930					 all_drivers) {
8931		ibm_exit(ibm);
8932	}
8933
8934	dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8935
8936	if (tpacpi_inputdev) {
8937		if (tp_features.input_device_registered)
8938			input_unregister_device(tpacpi_inputdev);
8939		else
8940			input_free_device(tpacpi_inputdev);
 
8941	}
8942
8943	if (tpacpi_hwmon)
8944		hwmon_device_unregister(tpacpi_hwmon);
8945
8946	if (tp_features.sensors_pdev_attrs_registered)
8947		device_remove_file(&tpacpi_sensors_pdev->dev,
8948				   &dev_attr_thinkpad_acpi_pdev_name);
8949	if (tpacpi_sensors_pdev)
8950		platform_device_unregister(tpacpi_sensors_pdev);
8951	if (tpacpi_pdev)
8952		platform_device_unregister(tpacpi_pdev);
8953
8954	if (tp_features.sensors_pdrv_attrs_registered)
8955		tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8956	if (tp_features.platform_drv_attrs_registered)
8957		tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8958
8959	if (tp_features.sensors_pdrv_registered)
8960		platform_driver_unregister(&tpacpi_hwmon_pdriver);
8961
8962	if (tp_features.platform_drv_registered)
8963		platform_driver_unregister(&tpacpi_pdriver);
8964
8965	if (proc_dir)
8966		remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
8967
8968	if (tpacpi_wq)
8969		destroy_workqueue(tpacpi_wq);
8970
8971	kfree(thinkpad_id.bios_version_str);
8972	kfree(thinkpad_id.ec_version_str);
8973	kfree(thinkpad_id.model_str);
 
8974}
8975
8976
8977static int __init thinkpad_acpi_module_init(void)
8978{
8979	int ret, i;
8980
8981	tpacpi_lifecycle = TPACPI_LIFE_INIT;
8982
8983	/* Parameter checking */
8984	if (hotkey_report_mode > 2)
8985		return -EINVAL;
8986
8987	/* Driver-level probe */
8988
8989	ret = get_thinkpad_model_data(&thinkpad_id);
8990	if (ret) {
8991		pr_err("unable to get DMI data: %d\n", ret);
8992		thinkpad_acpi_module_exit();
8993		return ret;
8994	}
8995	ret = probe_for_thinkpad();
8996	if (ret) {
8997		thinkpad_acpi_module_exit();
8998		return ret;
8999	}
9000
9001	/* Driver initialization */
9002
9003	thinkpad_acpi_init_banner();
9004	tpacpi_check_outdated_fw();
9005
9006	TPACPI_ACPIHANDLE_INIT(ecrd);
9007	TPACPI_ACPIHANDLE_INIT(ecwr);
9008
9009	tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9010	if (!tpacpi_wq) {
9011		thinkpad_acpi_module_exit();
9012		return -ENOMEM;
9013	}
9014
9015	proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9016	if (!proc_dir) {
9017		pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
9018		thinkpad_acpi_module_exit();
9019		return -ENODEV;
9020	}
9021
9022	ret = platform_driver_register(&tpacpi_pdriver);
9023	if (ret) {
9024		pr_err("unable to register main platform driver\n");
9025		thinkpad_acpi_module_exit();
9026		return ret;
9027	}
9028	tp_features.platform_drv_registered = 1;
9029
9030	ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9031	if (ret) {
9032		pr_err("unable to register hwmon platform driver\n");
9033		thinkpad_acpi_module_exit();
9034		return ret;
9035	}
9036	tp_features.sensors_pdrv_registered = 1;
9037
9038	ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9039	if (!ret) {
9040		tp_features.platform_drv_attrs_registered = 1;
9041		ret = tpacpi_create_driver_attributes(
9042					&tpacpi_hwmon_pdriver.driver);
9043	}
9044	if (ret) {
9045		pr_err("unable to create sysfs driver attributes\n");
9046		thinkpad_acpi_module_exit();
9047		return ret;
9048	}
9049	tp_features.sensors_pdrv_attrs_registered = 1;
9050
9051
9052	/* Device initialization */
9053	tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9054							NULL, 0);
9055	if (IS_ERR(tpacpi_pdev)) {
9056		ret = PTR_ERR(tpacpi_pdev);
9057		tpacpi_pdev = NULL;
9058		pr_err("unable to register platform device\n");
9059		thinkpad_acpi_module_exit();
9060		return ret;
9061	}
9062	tpacpi_sensors_pdev = platform_device_register_simple(
9063						TPACPI_HWMON_DRVR_NAME,
9064						-1, NULL, 0);
9065	if (IS_ERR(tpacpi_sensors_pdev)) {
9066		ret = PTR_ERR(tpacpi_sensors_pdev);
9067		tpacpi_sensors_pdev = NULL;
9068		pr_err("unable to register hwmon platform device\n");
9069		thinkpad_acpi_module_exit();
9070		return ret;
9071	}
9072	ret = device_create_file(&tpacpi_sensors_pdev->dev,
9073				 &dev_attr_thinkpad_acpi_pdev_name);
9074	if (ret) {
9075		pr_err("unable to create sysfs hwmon device attributes\n");
9076		thinkpad_acpi_module_exit();
9077		return ret;
9078	}
9079	tp_features.sensors_pdev_attrs_registered = 1;
9080	tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9081	if (IS_ERR(tpacpi_hwmon)) {
9082		ret = PTR_ERR(tpacpi_hwmon);
9083		tpacpi_hwmon = NULL;
9084		pr_err("unable to register hwmon device\n");
9085		thinkpad_acpi_module_exit();
9086		return ret;
9087	}
9088	mutex_init(&tpacpi_inputdev_send_mutex);
9089	tpacpi_inputdev = input_allocate_device();
9090	if (!tpacpi_inputdev) {
9091		pr_err("unable to allocate input device\n");
9092		thinkpad_acpi_module_exit();
9093		return -ENOMEM;
9094	} else {
9095		/* Prepare input device, but don't register */
9096		tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9097		tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9098		tpacpi_inputdev->id.bustype = BUS_HOST;
9099		tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9100		tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9101		tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9102		tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9103	}
9104
9105	/* Init subdriver dependencies */
9106	tpacpi_detect_brightness_capabilities();
9107
9108	/* Init subdrivers */
9109	for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9110		ret = ibm_init(&ibms_init[i]);
9111		if (ret >= 0 && *ibms_init[i].param)
9112			ret = ibms_init[i].data->write(ibms_init[i].param);
9113		if (ret < 0) {
9114			thinkpad_acpi_module_exit();
9115			return ret;
9116		}
9117	}
9118
9119	tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9120
9121	ret = input_register_device(tpacpi_inputdev);
9122	if (ret < 0) {
9123		pr_err("unable to register input device\n");
9124		thinkpad_acpi_module_exit();
9125		return ret;
9126	} else {
9127		tp_features.input_device_registered = 1;
9128	}
9129
9130	return 0;
9131}
9132
9133MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9134
9135/*
9136 * This will autoload the driver in almost every ThinkPad
9137 * in widespread use.
9138 *
9139 * Only _VERY_ old models, like the 240, 240x and 570 lack
9140 * the HKEY event interface.
9141 */
9142MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9143
9144/*
9145 * DMI matching for module autoloading
9146 *
9147 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9148 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9149 *
9150 * Only models listed in thinkwiki will be supported, so add yours
9151 * if it is not there yet.
9152 */
9153#define IBM_BIOS_MODULE_ALIAS(__type) \
9154	MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9155
9156/* Ancient thinkpad BIOSes have to be identified by
9157 * BIOS type or model number, and there are far less
9158 * BIOS types than model numbers... */
9159IBM_BIOS_MODULE_ALIAS("I[MU]");		/* 570, 570e */
9160
9161MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9162MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9163MODULE_DESCRIPTION(TPACPI_DESC);
9164MODULE_VERSION(TPACPI_VERSION);
9165MODULE_LICENSE("GPL");
9166
9167module_init(thinkpad_acpi_module_init);
9168module_exit(thinkpad_acpi_module_exit);
v3.15
   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 pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  25
  26#define TPACPI_VERSION "0.25"
  27#define TPACPI_SYSFS_VERSION 0x020700
  28
  29/*
  30 *  Changelog:
  31 *  2007-10-20		changelog trimmed down
  32 *
  33 *  2007-03-27  0.14	renamed to thinkpad_acpi and moved to
  34 *  			drivers/misc.
  35 *
  36 *  2006-11-22	0.13	new maintainer
  37 *  			changelog now lives in git commit history, and will
  38 *  			not be updated further in-file.
  39 *
  40 *  2005-03-17	0.11	support for 600e, 770x
  41 *			    thanks to Jamie Lentin <lentinj@dial.pipex.com>
  42 *
  43 *  2005-01-16	0.9	use MODULE_VERSION
  44 *			    thanks to Henrik Brix Andersen <brix@gentoo.org>
  45 *			fix parameter passing on module loading
  46 *			    thanks to Rusty Russell <rusty@rustcorp.com.au>
  47 *			    thanks to Jim Radford <radford@blackbean.org>
  48 *  2004-11-08	0.8	fix init error case, don't return from a macro
  49 *			    thanks to Chris Wright <chrisw@osdl.org>
  50 */
  51
  52#include <linux/kernel.h>
  53#include <linux/module.h>
  54#include <linux/init.h>
  55#include <linux/types.h>
  56#include <linux/string.h>
  57#include <linux/list.h>
  58#include <linux/mutex.h>
  59#include <linux/sched.h>
  60#include <linux/kthread.h>
  61#include <linux/freezer.h>
  62#include <linux/delay.h>
  63#include <linux/slab.h>
 
  64#include <linux/nvram.h>
  65#include <linux/proc_fs.h>
  66#include <linux/seq_file.h>
  67#include <linux/sysfs.h>
  68#include <linux/backlight.h>
  69#include <linux/fb.h>
  70#include <linux/platform_device.h>
  71#include <linux/hwmon.h>
  72#include <linux/hwmon-sysfs.h>
  73#include <linux/input.h>
  74#include <linux/leds.h>
  75#include <linux/rfkill.h>
 
 
  76#include <linux/dmi.h>
  77#include <linux/jiffies.h>
  78#include <linux/workqueue.h>
  79#include <linux/acpi.h>
  80#include <linux/pci_ids.h>
  81#include <linux/thinkpad_acpi.h>
  82#include <sound/core.h>
  83#include <sound/control.h>
  84#include <sound/initval.h>
  85#include <asm/uaccess.h>
 
 
 
 
  86
  87/* ThinkPad CMOS commands */
  88#define TP_CMOS_VOLUME_DOWN	0
  89#define TP_CMOS_VOLUME_UP	1
  90#define TP_CMOS_VOLUME_MUTE	2
  91#define TP_CMOS_BRIGHTNESS_UP	4
  92#define TP_CMOS_BRIGHTNESS_DOWN	5
  93#define TP_CMOS_THINKLIGHT_ON	12
  94#define TP_CMOS_THINKLIGHT_OFF	13
  95
  96/* NVRAM Addresses */
  97enum tp_nvram_addr {
  98	TP_NVRAM_ADDR_HK2		= 0x57,
  99	TP_NVRAM_ADDR_THINKLIGHT	= 0x58,
 100	TP_NVRAM_ADDR_VIDEO		= 0x59,
 101	TP_NVRAM_ADDR_BRIGHTNESS	= 0x5e,
 102	TP_NVRAM_ADDR_MIXER		= 0x60,
 103};
 104
 105/* NVRAM bit masks */
 106enum {
 107	TP_NVRAM_MASK_HKT_THINKPAD	= 0x08,
 108	TP_NVRAM_MASK_HKT_ZOOM		= 0x20,
 109	TP_NVRAM_MASK_HKT_DISPLAY	= 0x40,
 110	TP_NVRAM_MASK_HKT_HIBERNATE	= 0x80,
 111	TP_NVRAM_MASK_THINKLIGHT	= 0x10,
 112	TP_NVRAM_MASK_HKT_DISPEXPND	= 0x30,
 113	TP_NVRAM_MASK_HKT_BRIGHTNESS	= 0x20,
 114	TP_NVRAM_MASK_LEVEL_BRIGHTNESS	= 0x0f,
 115	TP_NVRAM_POS_LEVEL_BRIGHTNESS	= 0,
 116	TP_NVRAM_MASK_MUTE		= 0x40,
 117	TP_NVRAM_MASK_HKT_VOLUME	= 0x80,
 118	TP_NVRAM_MASK_LEVEL_VOLUME	= 0x0f,
 119	TP_NVRAM_POS_LEVEL_VOLUME	= 0,
 120};
 121
 122/* Misc NVRAM-related */
 123enum {
 124	TP_NVRAM_LEVEL_VOLUME_MAX = 14,
 125};
 126
 127/* ACPI HIDs */
 128#define TPACPI_ACPI_IBM_HKEY_HID	"IBM0068"
 129#define TPACPI_ACPI_LENOVO_HKEY_HID	"LEN0068"
 130#define TPACPI_ACPI_EC_HID		"PNP0C09"
 131
 132/* Input IDs */
 133#define TPACPI_HKEY_INPUT_PRODUCT	0x5054 /* "TP" */
 134#define TPACPI_HKEY_INPUT_VERSION	0x4101
 135
 136/* ACPI \WGSV commands */
 137enum {
 138	TP_ACPI_WGSV_GET_STATE		= 0x01, /* Get state information */
 139	TP_ACPI_WGSV_PWR_ON_ON_RESUME	= 0x02, /* Resume WWAN powered on */
 140	TP_ACPI_WGSV_PWR_OFF_ON_RESUME	= 0x03,	/* Resume WWAN powered off */
 141	TP_ACPI_WGSV_SAVE_STATE		= 0x04, /* Save state for S4/S5 */
 142};
 143
 144/* TP_ACPI_WGSV_GET_STATE bits */
 145enum {
 146	TP_ACPI_WGSV_STATE_WWANEXIST	= 0x0001, /* WWAN hw available */
 147	TP_ACPI_WGSV_STATE_WWANPWR	= 0x0002, /* WWAN radio enabled */
 148	TP_ACPI_WGSV_STATE_WWANPWRRES	= 0x0004, /* WWAN state at resume */
 149	TP_ACPI_WGSV_STATE_WWANBIOSOFF	= 0x0008, /* WWAN disabled in BIOS */
 150	TP_ACPI_WGSV_STATE_BLTHEXIST	= 0x0001, /* BLTH hw available */
 151	TP_ACPI_WGSV_STATE_BLTHPWR	= 0x0002, /* BLTH radio enabled */
 152	TP_ACPI_WGSV_STATE_BLTHPWRRES	= 0x0004, /* BLTH state at resume */
 153	TP_ACPI_WGSV_STATE_BLTHBIOSOFF	= 0x0008, /* BLTH disabled in BIOS */
 154	TP_ACPI_WGSV_STATE_UWBEXIST	= 0x0010, /* UWB hw available */
 155	TP_ACPI_WGSV_STATE_UWBPWR	= 0x0020, /* UWB radio enabled */
 156};
 157
 158/* HKEY events */
 159enum tpacpi_hkey_event_t {
 160	/* Hotkey-related */
 161	TP_HKEY_EV_HOTKEY_BASE		= 0x1001, /* first hotkey (FN+F1) */
 162	TP_HKEY_EV_BRGHT_UP		= 0x1010, /* Brightness up */
 163	TP_HKEY_EV_BRGHT_DOWN		= 0x1011, /* Brightness down */
 164	TP_HKEY_EV_VOL_UP		= 0x1015, /* Volume up or unmute */
 165	TP_HKEY_EV_VOL_DOWN		= 0x1016, /* Volume down or unmute */
 166	TP_HKEY_EV_VOL_MUTE		= 0x1017, /* Mixer output mute */
 167
 168	/* Reasons for waking up from S3/S4 */
 169	TP_HKEY_EV_WKUP_S3_UNDOCK	= 0x2304, /* undock requested, S3 */
 170	TP_HKEY_EV_WKUP_S4_UNDOCK	= 0x2404, /* undock requested, S4 */
 171	TP_HKEY_EV_WKUP_S3_BAYEJ	= 0x2305, /* bay ejection req, S3 */
 172	TP_HKEY_EV_WKUP_S4_BAYEJ	= 0x2405, /* bay ejection req, S4 */
 173	TP_HKEY_EV_WKUP_S3_BATLOW	= 0x2313, /* battery empty, S3 */
 174	TP_HKEY_EV_WKUP_S4_BATLOW	= 0x2413, /* battery empty, S4 */
 175
 176	/* Auto-sleep after eject request */
 177	TP_HKEY_EV_BAYEJ_ACK		= 0x3003, /* bay ejection complete */
 178	TP_HKEY_EV_UNDOCK_ACK		= 0x4003, /* undock complete */
 179
 180	/* Misc bay events */
 181	TP_HKEY_EV_OPTDRV_EJ		= 0x3006, /* opt. drive tray ejected */
 182	TP_HKEY_EV_HOTPLUG_DOCK		= 0x4010, /* docked into hotplug dock
 183						     or port replicator */
 184	TP_HKEY_EV_HOTPLUG_UNDOCK	= 0x4011, /* undocked from hotplug
 185						     dock or port replicator */
 186
 187	/* User-interface events */
 188	TP_HKEY_EV_LID_CLOSE		= 0x5001, /* laptop lid closed */
 189	TP_HKEY_EV_LID_OPEN		= 0x5002, /* laptop lid opened */
 190	TP_HKEY_EV_TABLET_TABLET	= 0x5009, /* tablet swivel up */
 191	TP_HKEY_EV_TABLET_NOTEBOOK	= 0x500a, /* tablet swivel down */
 192	TP_HKEY_EV_PEN_INSERTED		= 0x500b, /* tablet pen inserted */
 193	TP_HKEY_EV_PEN_REMOVED		= 0x500c, /* tablet pen removed */
 194	TP_HKEY_EV_BRGHT_CHANGED	= 0x5010, /* backlight control event */
 195
 196	/* Key-related user-interface events */
 197	TP_HKEY_EV_KEY_NUMLOCK		= 0x6000, /* NumLock key pressed */
 198	TP_HKEY_EV_KEY_FN		= 0x6005, /* Fn key pressed? E420 */
 199
 200	/* Thermal events */
 201	TP_HKEY_EV_ALARM_BAT_HOT	= 0x6011, /* battery too hot */
 202	TP_HKEY_EV_ALARM_BAT_XHOT	= 0x6012, /* battery critically hot */
 203	TP_HKEY_EV_ALARM_SENSOR_HOT	= 0x6021, /* sensor too hot */
 204	TP_HKEY_EV_ALARM_SENSOR_XHOT	= 0x6022, /* sensor critically hot */
 205	TP_HKEY_EV_THM_TABLE_CHANGED	= 0x6030, /* thermal table changed */
 206
 207	/* AC-related events */
 208	TP_HKEY_EV_AC_CHANGED		= 0x6040, /* AC status changed */
 
 209
 210	/* Misc */
 211	TP_HKEY_EV_RFKILL_CHANGED	= 0x7000, /* rfkill switch changed */
 212};
 213
 214/****************************************************************************
 215 * Main driver
 216 */
 217
 218#define TPACPI_NAME "thinkpad"
 219#define TPACPI_DESC "ThinkPad ACPI Extras"
 220#define TPACPI_FILE TPACPI_NAME "_acpi"
 221#define TPACPI_URL "http://ibm-acpi.sf.net/"
 222#define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
 223
 224#define TPACPI_PROC_DIR "ibm"
 225#define TPACPI_ACPI_EVENT_PREFIX "ibm"
 226#define TPACPI_DRVR_NAME TPACPI_FILE
 227#define TPACPI_DRVR_SHORTNAME "tpacpi"
 228#define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
 229
 230#define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
 231#define TPACPI_WORKQUEUE_NAME "ktpacpid"
 232
 233#define TPACPI_MAX_ACPI_ARGS 3
 234
 235/* Debugging printk groups */
 236#define TPACPI_DBG_ALL		0xffff
 237#define TPACPI_DBG_DISCLOSETASK	0x8000
 238#define TPACPI_DBG_INIT		0x0001
 239#define TPACPI_DBG_EXIT		0x0002
 240#define TPACPI_DBG_RFKILL	0x0004
 241#define TPACPI_DBG_HKEY		0x0008
 242#define TPACPI_DBG_FAN		0x0010
 243#define TPACPI_DBG_BRGHT	0x0020
 244#define TPACPI_DBG_MIXER	0x0040
 245
 246#define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
 247#define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
 248#define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
 249
 250
 251/****************************************************************************
 252 * Driver-wide structs and misc. variables
 253 */
 254
 255struct ibm_struct;
 256
 257struct tp_acpi_drv_struct {
 258	const struct acpi_device_id *hid;
 259	struct acpi_driver *driver;
 260
 261	void (*notify) (struct ibm_struct *, u32);
 262	acpi_handle *handle;
 263	u32 type;
 264	struct acpi_device *device;
 265};
 266
 267struct ibm_struct {
 268	char *name;
 269
 270	int (*read) (struct seq_file *);
 271	int (*write) (char *);
 272	void (*exit) (void);
 273	void (*resume) (void);
 274	void (*suspend) (void);
 275	void (*shutdown) (void);
 276
 277	struct list_head all_drivers;
 278
 279	struct tp_acpi_drv_struct *acpi;
 280
 281	struct {
 282		u8 acpi_driver_registered:1;
 283		u8 acpi_notify_installed:1;
 284		u8 proc_created:1;
 285		u8 init_called:1;
 286		u8 experimental:1;
 287	} flags;
 288};
 289
 290struct ibm_init_struct {
 291	char param[32];
 292
 293	int (*init) (struct ibm_init_struct *);
 294	umode_t base_procfs_mode;
 295	struct ibm_struct *data;
 296};
 297
 298static struct {
 299	u32 bluetooth:1;
 300	u32 hotkey:1;
 301	u32 hotkey_mask:1;
 302	u32 hotkey_wlsw:1;
 303	u32 hotkey_tablet:1;
 304	u32 light:1;
 305	u32 light_status:1;
 306	u32 bright_acpimode:1;
 307	u32 bright_unkfw:1;
 308	u32 wan:1;
 309	u32 uwb:1;
 310	u32 fan_ctrl_status_undef:1;
 311	u32 second_fan:1;
 312	u32 beep_needs_two_args:1;
 313	u32 mixer_no_level_control:1;
 314	u32 input_device_registered:1;
 315	u32 platform_drv_registered:1;
 316	u32 platform_drv_attrs_registered:1;
 317	u32 sensors_pdrv_registered:1;
 318	u32 sensors_pdrv_attrs_registered:1;
 319	u32 sensors_pdev_attrs_registered:1;
 320	u32 hotkey_poll_active:1;
 321} tp_features;
 322
 323static struct {
 324	u16 hotkey_mask_ff:1;
 325	u16 volume_ctrl_forbidden:1;
 326} tp_warned;
 327
 328struct thinkpad_id_data {
 329	unsigned int vendor;	/* ThinkPad vendor:
 330				 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
 331
 332	char *bios_version_str;	/* Something like 1ZET51WW (1.03z) */
 333	char *ec_version_str;	/* Something like 1ZHT51WW-1.04a */
 334
 335	u16 bios_model;		/* 1Y = 0x5931, 0 = unknown */
 336	u16 ec_model;
 337	u16 bios_release;	/* 1ZETK1WW = 0x314b, 0 = unknown */
 338	u16 ec_release;
 339
 340	char *model_str;	/* ThinkPad T43 */
 341	char *nummodel_str;	/* 9384A9C for a 9384-A9C model */
 342};
 343static struct thinkpad_id_data thinkpad_id;
 344
 345static enum {
 346	TPACPI_LIFE_INIT = 0,
 347	TPACPI_LIFE_RUNNING,
 348	TPACPI_LIFE_EXITING,
 349} tpacpi_lifecycle;
 350
 351static int experimental;
 352static u32 dbg_level;
 353
 354static struct workqueue_struct *tpacpi_wq;
 355
 356enum led_status_t {
 357	TPACPI_LED_OFF = 0,
 358	TPACPI_LED_ON,
 359	TPACPI_LED_BLINK,
 360};
 361
 362/* Special LED class that can defer work */
 363struct tpacpi_led_classdev {
 364	struct led_classdev led_classdev;
 365	struct work_struct work;
 366	enum led_status_t new_state;
 367	int led;
 368};
 369
 370/* brightness level capabilities */
 371static unsigned int bright_maxlvl;	/* 0 = unknown */
 372
 373#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
 374static int dbg_wlswemul;
 375static bool tpacpi_wlsw_emulstate;
 376static int dbg_bluetoothemul;
 377static bool tpacpi_bluetooth_emulstate;
 378static int dbg_wwanemul;
 379static bool tpacpi_wwan_emulstate;
 380static int dbg_uwbemul;
 381static bool tpacpi_uwb_emulstate;
 382#endif
 383
 384
 385/*************************************************************************
 386 *  Debugging helpers
 387 */
 388
 389#define dbg_printk(a_dbg_level, format, arg...)				\
 390do {									\
 391	if (dbg_level & (a_dbg_level))					\
 392		printk(KERN_DEBUG pr_fmt("%s: " format),		\
 393		       __func__, ##arg);				\
 394} while (0)
 395
 396#ifdef CONFIG_THINKPAD_ACPI_DEBUG
 397#define vdbg_printk dbg_printk
 398static const char *str_supported(int is_supported);
 399#else
 400static inline const char *str_supported(int is_supported) { return ""; }
 401#define vdbg_printk(a_dbg_level, format, arg...)	\
 402	no_printk(format, ##arg)
 403#endif
 404
 405static void tpacpi_log_usertask(const char * const what)
 406{
 407	printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
 408	       what, task_tgid_vnr(current));
 409}
 410
 411#define tpacpi_disclose_usertask(what, format, arg...)			\
 412do {									\
 413	if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) &&		\
 414		     (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) {	\
 415		printk(KERN_DEBUG pr_fmt("%s: PID %d: " format),	\
 416		       what, task_tgid_vnr(current), ## arg);		\
 417	}								\
 418} while (0)
 419
 420/*
 421 * Quirk handling helpers
 422 *
 423 * ThinkPad IDs and versions seen in the field so far
 424 * are two-characters from the set [0-9A-Z], i.e. base 36.
 425 *
 426 * We use values well outside that range as specials.
 427 */
 428
 429#define TPACPI_MATCH_ANY		0xffffU
 430#define TPACPI_MATCH_UNKNOWN		0U
 431
 432/* TPID('1', 'Y') == 0x5931 */
 433#define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
 434
 435#define TPACPI_Q_IBM(__id1, __id2, __quirk)	\
 436	{ .vendor = PCI_VENDOR_ID_IBM,		\
 437	  .bios = TPID(__id1, __id2),		\
 438	  .ec = TPACPI_MATCH_ANY,		\
 439	  .quirks = (__quirk) }
 440
 441#define TPACPI_Q_LNV(__id1, __id2, __quirk)	\
 442	{ .vendor = PCI_VENDOR_ID_LENOVO,	\
 443	  .bios = TPID(__id1, __id2),		\
 444	  .ec = TPACPI_MATCH_ANY,		\
 445	  .quirks = (__quirk) }
 446
 447#define TPACPI_QEC_LNV(__id1, __id2, __quirk)	\
 448	{ .vendor = PCI_VENDOR_ID_LENOVO,	\
 449	  .bios = TPACPI_MATCH_ANY,		\
 450	  .ec = TPID(__id1, __id2),		\
 451	  .quirks = (__quirk) }
 452
 453struct tpacpi_quirk {
 454	unsigned int vendor;
 455	u16 bios;
 456	u16 ec;
 457	unsigned long quirks;
 458};
 459
 460/**
 461 * tpacpi_check_quirks() - search BIOS/EC version on a list
 462 * @qlist:		array of &struct tpacpi_quirk
 463 * @qlist_size:		number of elements in @qlist
 464 *
 465 * Iterates over a quirks list until one is found that matches the
 466 * ThinkPad's vendor, BIOS and EC model.
 467 *
 468 * Returns 0 if nothing matches, otherwise returns the quirks field of
 469 * the matching &struct tpacpi_quirk entry.
 470 *
 471 * The match criteria is: vendor, ec and bios much match.
 472 */
 473static unsigned long __init tpacpi_check_quirks(
 474			const struct tpacpi_quirk *qlist,
 475			unsigned int qlist_size)
 476{
 477	while (qlist_size) {
 478		if ((qlist->vendor == thinkpad_id.vendor ||
 479				qlist->vendor == TPACPI_MATCH_ANY) &&
 480		    (qlist->bios == thinkpad_id.bios_model ||
 481				qlist->bios == TPACPI_MATCH_ANY) &&
 482		    (qlist->ec == thinkpad_id.ec_model ||
 483				qlist->ec == TPACPI_MATCH_ANY))
 484			return qlist->quirks;
 485
 486		qlist_size--;
 487		qlist++;
 488	}
 489	return 0;
 490}
 491
 492static inline bool __pure __init tpacpi_is_lenovo(void)
 493{
 494	return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
 495}
 496
 497static inline bool __pure __init tpacpi_is_ibm(void)
 498{
 499	return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
 500}
 501
 502/****************************************************************************
 503 ****************************************************************************
 504 *
 505 * ACPI Helpers and device model
 506 *
 507 ****************************************************************************
 508 ****************************************************************************/
 509
 510/*************************************************************************
 511 * ACPI basic handles
 512 */
 513
 514static acpi_handle root_handle;
 515static acpi_handle ec_handle;
 516
 517#define TPACPI_HANDLE(object, parent, paths...)			\
 518	static acpi_handle  object##_handle;			\
 519	static const acpi_handle * const object##_parent __initconst =	\
 520						&parent##_handle; \
 521	static char *object##_paths[] __initdata = { paths }
 522
 523TPACPI_HANDLE(ecrd, ec, "ECRD");	/* 570 */
 524TPACPI_HANDLE(ecwr, ec, "ECWR");	/* 570 */
 525
 526TPACPI_HANDLE(cmos, root, "\\UCMS",	/* R50, R50e, R50p, R51, */
 527					/* T4x, X31, X40 */
 528	   "\\CMOS",		/* A3x, G4x, R32, T23, T30, X22-24, X30 */
 529	   "\\CMS",		/* R40, R40e */
 530	   );			/* all others */
 531
 532TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY",	/* 600e/x, 770e, 770x */
 533	   "^HKEY",		/* R30, R31 */
 534	   "HKEY",		/* all others */
 535	   );			/* 570 */
 536
 537/*************************************************************************
 538 * ACPI helpers
 539 */
 540
 541static int acpi_evalf(acpi_handle handle,
 542		      int *res, char *method, char *fmt, ...)
 543{
 544	char *fmt0 = fmt;
 545	struct acpi_object_list params;
 546	union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
 547	struct acpi_buffer result, *resultp;
 548	union acpi_object out_obj;
 549	acpi_status status;
 550	va_list ap;
 551	char res_type;
 552	int success;
 553	int quiet;
 554
 555	if (!*fmt) {
 556		pr_err("acpi_evalf() called with empty format\n");
 557		return 0;
 558	}
 559
 560	if (*fmt == 'q') {
 561		quiet = 1;
 562		fmt++;
 563	} else
 564		quiet = 0;
 565
 566	res_type = *(fmt++);
 567
 568	params.count = 0;
 569	params.pointer = &in_objs[0];
 570
 571	va_start(ap, fmt);
 572	while (*fmt) {
 573		char c = *(fmt++);
 574		switch (c) {
 575		case 'd':	/* int */
 576			in_objs[params.count].integer.value = va_arg(ap, int);
 577			in_objs[params.count++].type = ACPI_TYPE_INTEGER;
 578			break;
 579			/* add more types as needed */
 580		default:
 581			pr_err("acpi_evalf() called "
 582			       "with invalid format character '%c'\n", c);
 583			va_end(ap);
 584			return 0;
 585		}
 586	}
 587	va_end(ap);
 588
 589	if (res_type != 'v') {
 590		result.length = sizeof(out_obj);
 591		result.pointer = &out_obj;
 592		resultp = &result;
 593	} else
 594		resultp = NULL;
 595
 596	status = acpi_evaluate_object(handle, method, &params, resultp);
 597
 598	switch (res_type) {
 599	case 'd':		/* int */
 600		success = (status == AE_OK &&
 601			   out_obj.type == ACPI_TYPE_INTEGER);
 602		if (success && res)
 603			*res = out_obj.integer.value;
 604		break;
 605	case 'v':		/* void */
 606		success = status == AE_OK;
 607		break;
 608		/* add more types as needed */
 609	default:
 610		pr_err("acpi_evalf() called "
 611		       "with invalid format character '%c'\n", res_type);
 612		return 0;
 613	}
 614
 615	if (!success && !quiet)
 616		pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
 617		       method, fmt0, acpi_format_exception(status));
 618
 619	return success;
 620}
 621
 622static int acpi_ec_read(int i, u8 *p)
 623{
 624	int v;
 625
 626	if (ecrd_handle) {
 627		if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
 628			return 0;
 629		*p = v;
 630	} else {
 631		if (ec_read(i, p) < 0)
 632			return 0;
 633	}
 634
 635	return 1;
 636}
 637
 638static int acpi_ec_write(int i, u8 v)
 639{
 640	if (ecwr_handle) {
 641		if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
 642			return 0;
 643	} else {
 644		if (ec_write(i, v) < 0)
 645			return 0;
 646	}
 647
 648	return 1;
 649}
 650
 651static int issue_thinkpad_cmos_command(int cmos_cmd)
 652{
 653	if (!cmos_handle)
 654		return -ENXIO;
 655
 656	if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
 657		return -EIO;
 658
 659	return 0;
 660}
 661
 662/*************************************************************************
 663 * ACPI device model
 664 */
 665
 666#define TPACPI_ACPIHANDLE_INIT(object) \
 667	drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
 668		object##_paths, ARRAY_SIZE(object##_paths))
 669
 670static void __init drv_acpi_handle_init(const char *name,
 671			   acpi_handle *handle, const acpi_handle parent,
 672			   char **paths, const int num_paths)
 673{
 674	int i;
 675	acpi_status status;
 676
 677	vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
 678		name);
 679
 680	for (i = 0; i < num_paths; i++) {
 681		status = acpi_get_handle(parent, paths[i], handle);
 682		if (ACPI_SUCCESS(status)) {
 683			dbg_printk(TPACPI_DBG_INIT,
 684				   "Found ACPI handle %s for %s\n",
 685				   paths[i], name);
 686			return;
 687		}
 688	}
 689
 690	vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
 691		    name);
 692	*handle = NULL;
 693}
 694
 695static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
 696			u32 level, void *context, void **return_value)
 697{
 698	struct acpi_device *dev;
 699	if (!strcmp(context, "video")) {
 700		if (acpi_bus_get_device(handle, &dev))
 701			return AE_OK;
 702		if (strcmp(ACPI_VIDEO_HID, acpi_device_hid(dev)))
 703			return AE_OK;
 704	}
 705
 706	*(acpi_handle *)return_value = handle;
 707
 708	return AE_CTRL_TERMINATE;
 709}
 710
 711static void __init tpacpi_acpi_handle_locate(const char *name,
 712		const char *hid,
 713		acpi_handle *handle)
 714{
 715	acpi_status status;
 716	acpi_handle device_found;
 717
 718	BUG_ON(!name || !handle);
 719	vdbg_printk(TPACPI_DBG_INIT,
 720			"trying to locate ACPI handle for %s, using HID %s\n",
 721			name, hid ? hid : "NULL");
 722
 723	memset(&device_found, 0, sizeof(device_found));
 724	status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
 725				  (void *)name, &device_found);
 726
 727	*handle = NULL;
 728
 729	if (ACPI_SUCCESS(status)) {
 730		*handle = device_found;
 731		dbg_printk(TPACPI_DBG_INIT,
 732			   "Found ACPI handle for %s\n", name);
 733	} else {
 734		vdbg_printk(TPACPI_DBG_INIT,
 735			    "Could not locate an ACPI handle for %s: %s\n",
 736			    name, acpi_format_exception(status));
 737	}
 738}
 739
 740static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
 741{
 742	struct ibm_struct *ibm = data;
 743
 744	if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
 745		return;
 746
 747	if (!ibm || !ibm->acpi || !ibm->acpi->notify)
 748		return;
 749
 750	ibm->acpi->notify(ibm, event);
 751}
 752
 753static int __init setup_acpi_notify(struct ibm_struct *ibm)
 754{
 755	acpi_status status;
 756	int rc;
 757
 758	BUG_ON(!ibm->acpi);
 759
 760	if (!*ibm->acpi->handle)
 761		return 0;
 762
 763	vdbg_printk(TPACPI_DBG_INIT,
 764		"setting up ACPI notify for %s\n", ibm->name);
 765
 766	rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
 767	if (rc < 0) {
 768		pr_err("acpi_bus_get_device(%s) failed: %d\n", ibm->name, rc);
 769		return -ENODEV;
 770	}
 771
 772	ibm->acpi->device->driver_data = ibm;
 773	sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
 774		TPACPI_ACPI_EVENT_PREFIX,
 775		ibm->name);
 776
 777	status = acpi_install_notify_handler(*ibm->acpi->handle,
 778			ibm->acpi->type, dispatch_acpi_notify, ibm);
 779	if (ACPI_FAILURE(status)) {
 780		if (status == AE_ALREADY_EXISTS) {
 781			pr_notice("another device driver is already "
 782				  "handling %s events\n", ibm->name);
 783		} else {
 784			pr_err("acpi_install_notify_handler(%s) failed: %s\n",
 785			       ibm->name, acpi_format_exception(status));
 786		}
 787		return -ENODEV;
 788	}
 789	ibm->flags.acpi_notify_installed = 1;
 790	return 0;
 791}
 792
 793static int __init tpacpi_device_add(struct acpi_device *device)
 794{
 795	return 0;
 796}
 797
 798static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
 799{
 800	int rc;
 801
 802	dbg_printk(TPACPI_DBG_INIT,
 803		"registering %s as an ACPI driver\n", ibm->name);
 804
 805	BUG_ON(!ibm->acpi);
 806
 807	ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
 808	if (!ibm->acpi->driver) {
 809		pr_err("failed to allocate memory for ibm->acpi->driver\n");
 810		return -ENOMEM;
 811	}
 812
 813	sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
 814	ibm->acpi->driver->ids = ibm->acpi->hid;
 815
 816	ibm->acpi->driver->ops.add = &tpacpi_device_add;
 817
 818	rc = acpi_bus_register_driver(ibm->acpi->driver);
 819	if (rc < 0) {
 820		pr_err("acpi_bus_register_driver(%s) failed: %d\n",
 821		       ibm->name, rc);
 822		kfree(ibm->acpi->driver);
 823		ibm->acpi->driver = NULL;
 824	} else if (!rc)
 825		ibm->flags.acpi_driver_registered = 1;
 826
 827	return rc;
 828}
 829
 830
 831/****************************************************************************
 832 ****************************************************************************
 833 *
 834 * Procfs Helpers
 835 *
 836 ****************************************************************************
 837 ****************************************************************************/
 838
 839static int dispatch_proc_show(struct seq_file *m, void *v)
 840{
 841	struct ibm_struct *ibm = m->private;
 842
 843	if (!ibm || !ibm->read)
 844		return -EINVAL;
 845	return ibm->read(m);
 846}
 847
 848static int dispatch_proc_open(struct inode *inode, struct file *file)
 849{
 850	return single_open(file, dispatch_proc_show, PDE_DATA(inode));
 851}
 852
 853static ssize_t dispatch_proc_write(struct file *file,
 854			const char __user *userbuf,
 855			size_t count, loff_t *pos)
 856{
 857	struct ibm_struct *ibm = PDE_DATA(file_inode(file));
 858	char *kernbuf;
 859	int ret;
 860
 861	if (!ibm || !ibm->write)
 862		return -EINVAL;
 863	if (count > PAGE_SIZE - 2)
 864		return -EINVAL;
 865
 866	kernbuf = kmalloc(count + 2, GFP_KERNEL);
 867	if (!kernbuf)
 868		return -ENOMEM;
 869
 870	if (copy_from_user(kernbuf, userbuf, count)) {
 871		kfree(kernbuf);
 872		return -EFAULT;
 873	}
 874
 875	kernbuf[count] = 0;
 876	strcat(kernbuf, ",");
 877	ret = ibm->write(kernbuf);
 878	if (ret == 0)
 879		ret = count;
 880
 881	kfree(kernbuf);
 882
 883	return ret;
 884}
 885
 886static const struct file_operations dispatch_proc_fops = {
 887	.owner		= THIS_MODULE,
 888	.open		= dispatch_proc_open,
 889	.read		= seq_read,
 890	.llseek		= seq_lseek,
 891	.release	= single_release,
 892	.write		= dispatch_proc_write,
 893};
 894
 895static char *next_cmd(char **cmds)
 896{
 897	char *start = *cmds;
 898	char *end;
 899
 900	while ((end = strchr(start, ',')) && end == start)
 901		start = end + 1;
 902
 903	if (!end)
 904		return NULL;
 905
 906	*end = 0;
 907	*cmds = end + 1;
 908	return start;
 909}
 910
 911
 912/****************************************************************************
 913 ****************************************************************************
 914 *
 915 * Device model: input, hwmon and platform
 916 *
 917 ****************************************************************************
 918 ****************************************************************************/
 919
 920static struct platform_device *tpacpi_pdev;
 921static struct platform_device *tpacpi_sensors_pdev;
 922static struct device *tpacpi_hwmon;
 923static struct input_dev *tpacpi_inputdev;
 924static struct mutex tpacpi_inputdev_send_mutex;
 925static LIST_HEAD(tpacpi_all_drivers);
 926
 927#ifdef CONFIG_PM_SLEEP
 928static int tpacpi_suspend_handler(struct device *dev)
 929{
 930	struct ibm_struct *ibm, *itmp;
 931
 932	list_for_each_entry_safe(ibm, itmp,
 933				 &tpacpi_all_drivers,
 934				 all_drivers) {
 935		if (ibm->suspend)
 936			(ibm->suspend)();
 937	}
 938
 939	return 0;
 940}
 941
 942static int tpacpi_resume_handler(struct device *dev)
 943{
 944	struct ibm_struct *ibm, *itmp;
 945
 946	list_for_each_entry_safe(ibm, itmp,
 947				 &tpacpi_all_drivers,
 948				 all_drivers) {
 949		if (ibm->resume)
 950			(ibm->resume)();
 951	}
 952
 953	return 0;
 954}
 955#endif
 956
 957static SIMPLE_DEV_PM_OPS(tpacpi_pm,
 958			 tpacpi_suspend_handler, tpacpi_resume_handler);
 959
 960static void tpacpi_shutdown_handler(struct platform_device *pdev)
 961{
 962	struct ibm_struct *ibm, *itmp;
 963
 964	list_for_each_entry_safe(ibm, itmp,
 965				 &tpacpi_all_drivers,
 966				 all_drivers) {
 967		if (ibm->shutdown)
 968			(ibm->shutdown)();
 969	}
 970}
 971
 972static struct platform_driver tpacpi_pdriver = {
 973	.driver = {
 974		.name = TPACPI_DRVR_NAME,
 975		.owner = THIS_MODULE,
 976		.pm = &tpacpi_pm,
 977	},
 
 
 978	.shutdown = tpacpi_shutdown_handler,
 979};
 980
 981static struct platform_driver tpacpi_hwmon_pdriver = {
 982	.driver = {
 983		.name = TPACPI_HWMON_DRVR_NAME,
 984		.owner = THIS_MODULE,
 985	},
 986};
 987
 988/*************************************************************************
 989 * sysfs support helpers
 990 */
 991
 992struct attribute_set {
 993	unsigned int members, max_members;
 994	struct attribute_group group;
 995};
 996
 997struct attribute_set_obj {
 998	struct attribute_set s;
 999	struct attribute *a;
1000} __attribute__((packed));
1001
1002static struct attribute_set *create_attr_set(unsigned int max_members,
1003						const char *name)
1004{
1005	struct attribute_set_obj *sobj;
1006
1007	if (max_members == 0)
1008		return NULL;
1009
1010	/* Allocates space for implicit NULL at the end too */
1011	sobj = kzalloc(sizeof(struct attribute_set_obj) +
1012		    max_members * sizeof(struct attribute *),
1013		    GFP_KERNEL);
1014	if (!sobj)
1015		return NULL;
1016	sobj->s.max_members = max_members;
1017	sobj->s.group.attrs = &sobj->a;
1018	sobj->s.group.name = name;
1019
1020	return &sobj->s;
1021}
1022
1023#define destroy_attr_set(_set) \
1024	kfree(_set);
1025
1026/* not multi-threaded safe, use it in a single thread per set */
1027static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1028{
1029	if (!s || !attr)
1030		return -EINVAL;
1031
1032	if (s->members >= s->max_members)
1033		return -ENOMEM;
1034
1035	s->group.attrs[s->members] = attr;
1036	s->members++;
1037
1038	return 0;
1039}
1040
1041static int add_many_to_attr_set(struct attribute_set *s,
1042			struct attribute **attr,
1043			unsigned int count)
1044{
1045	int i, res;
1046
1047	for (i = 0; i < count; i++) {
1048		res = add_to_attr_set(s, attr[i]);
1049		if (res)
1050			return res;
1051	}
1052
1053	return 0;
1054}
1055
1056static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1057{
1058	sysfs_remove_group(kobj, &s->group);
1059	destroy_attr_set(s);
1060}
1061
1062#define register_attr_set_with_sysfs(_attr_set, _kobj) \
1063	sysfs_create_group(_kobj, &_attr_set->group)
1064
1065static int parse_strtoul(const char *buf,
1066		unsigned long max, unsigned long *value)
1067{
1068	char *endp;
1069
1070	*value = simple_strtoul(skip_spaces(buf), &endp, 0);
1071	endp = skip_spaces(endp);
1072	if (*endp || *value > max)
1073		return -EINVAL;
1074
1075	return 0;
1076}
1077
1078static void tpacpi_disable_brightness_delay(void)
1079{
1080	if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1081		pr_notice("ACPI backlight control delay disabled\n");
1082}
1083
1084static void printk_deprecated_attribute(const char * const what,
1085					const char * const details)
1086{
1087	tpacpi_log_usertask("deprecated sysfs attribute");
1088	pr_warn("WARNING: sysfs attribute %s is deprecated and "
1089		"will be removed. %s\n",
1090		what, details);
1091}
1092
1093/*************************************************************************
1094 * rfkill and radio control support helpers
1095 */
1096
1097/*
1098 * ThinkPad-ACPI firmware handling model:
1099 *
1100 * WLSW (master wireless switch) is event-driven, and is common to all
1101 * firmware-controlled radios.  It cannot be controlled, just monitored,
1102 * as expected.  It overrides all radio state in firmware
1103 *
1104 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1105 * (TODO: verify how WLSW interacts with the returned radio state).
1106 *
1107 * The only time there are shadow radio state changes, is when
1108 * masked-off hotkeys are used.
1109 */
1110
1111/*
1112 * Internal driver API for radio state:
1113 *
1114 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1115 * bool: true means radio blocked (off)
1116 */
1117enum tpacpi_rfkill_state {
1118	TPACPI_RFK_RADIO_OFF = 0,
1119	TPACPI_RFK_RADIO_ON
1120};
1121
1122/* rfkill switches */
1123enum tpacpi_rfk_id {
1124	TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1125	TPACPI_RFK_WWAN_SW_ID,
1126	TPACPI_RFK_UWB_SW_ID,
1127	TPACPI_RFK_SW_MAX
1128};
1129
1130static const char *tpacpi_rfkill_names[] = {
1131	[TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1132	[TPACPI_RFK_WWAN_SW_ID] = "wwan",
1133	[TPACPI_RFK_UWB_SW_ID] = "uwb",
1134	[TPACPI_RFK_SW_MAX] = NULL
1135};
1136
1137/* ThinkPad-ACPI rfkill subdriver */
1138struct tpacpi_rfk {
1139	struct rfkill *rfkill;
1140	enum tpacpi_rfk_id id;
1141	const struct tpacpi_rfk_ops *ops;
1142};
1143
1144struct tpacpi_rfk_ops {
1145	/* firmware interface */
1146	int (*get_status)(void);
1147	int (*set_status)(const enum tpacpi_rfkill_state);
1148};
1149
1150static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1151
1152/* Query FW and update rfkill sw state for a given rfkill switch */
1153static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1154{
1155	int status;
1156
1157	if (!tp_rfk)
1158		return -ENODEV;
1159
1160	status = (tp_rfk->ops->get_status)();
1161	if (status < 0)
1162		return status;
1163
1164	rfkill_set_sw_state(tp_rfk->rfkill,
1165			    (status == TPACPI_RFK_RADIO_OFF));
1166
1167	return status;
1168}
1169
1170/* Query FW and update rfkill sw state for all rfkill switches */
1171static void tpacpi_rfk_update_swstate_all(void)
1172{
1173	unsigned int i;
1174
1175	for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1176		tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1177}
1178
1179/*
1180 * Sync the HW-blocking state of all rfkill switches,
1181 * do notice it causes the rfkill core to schedule uevents
1182 */
1183static void tpacpi_rfk_update_hwblock_state(bool blocked)
1184{
1185	unsigned int i;
1186	struct tpacpi_rfk *tp_rfk;
1187
1188	for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1189		tp_rfk = tpacpi_rfkill_switches[i];
1190		if (tp_rfk) {
1191			if (rfkill_set_hw_state(tp_rfk->rfkill,
1192						blocked)) {
1193				/* ignore -- we track sw block */
1194			}
1195		}
1196	}
1197}
1198
1199/* Call to get the WLSW state from the firmware */
1200static int hotkey_get_wlsw(void);
1201
1202/* Call to query WLSW state and update all rfkill switches */
1203static bool tpacpi_rfk_check_hwblock_state(void)
1204{
1205	int res = hotkey_get_wlsw();
1206	int hw_blocked;
1207
1208	/* When unknown or unsupported, we have to assume it is unblocked */
1209	if (res < 0)
1210		return false;
1211
1212	hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1213	tpacpi_rfk_update_hwblock_state(hw_blocked);
1214
1215	return hw_blocked;
1216}
1217
1218static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1219{
1220	struct tpacpi_rfk *tp_rfk = data;
1221	int res;
1222
1223	dbg_printk(TPACPI_DBG_RFKILL,
1224		   "request to change radio state to %s\n",
1225		   blocked ? "blocked" : "unblocked");
1226
1227	/* try to set radio state */
1228	res = (tp_rfk->ops->set_status)(blocked ?
1229				TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1230
1231	/* and update the rfkill core with whatever the FW really did */
1232	tpacpi_rfk_update_swstate(tp_rfk);
1233
1234	return (res < 0) ? res : 0;
1235}
1236
1237static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1238	.set_block = tpacpi_rfk_hook_set_block,
1239};
1240
1241static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1242			const struct tpacpi_rfk_ops *tp_rfkops,
1243			const enum rfkill_type rfktype,
1244			const char *name,
1245			const bool set_default)
1246{
1247	struct tpacpi_rfk *atp_rfk;
1248	int res;
1249	bool sw_state = false;
1250	bool hw_state;
1251	int sw_status;
1252
1253	BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1254
1255	atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1256	if (atp_rfk)
1257		atp_rfk->rfkill = rfkill_alloc(name,
1258						&tpacpi_pdev->dev,
1259						rfktype,
1260						&tpacpi_rfk_rfkill_ops,
1261						atp_rfk);
1262	if (!atp_rfk || !atp_rfk->rfkill) {
1263		pr_err("failed to allocate memory for rfkill class\n");
1264		kfree(atp_rfk);
1265		return -ENOMEM;
1266	}
1267
1268	atp_rfk->id = id;
1269	atp_rfk->ops = tp_rfkops;
1270
1271	sw_status = (tp_rfkops->get_status)();
1272	if (sw_status < 0) {
1273		pr_err("failed to read initial state for %s, error %d\n",
1274		       name, sw_status);
1275	} else {
1276		sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1277		if (set_default) {
1278			/* try to keep the initial state, since we ask the
1279			 * firmware to preserve it across S5 in NVRAM */
1280			rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1281		}
1282	}
1283	hw_state = tpacpi_rfk_check_hwblock_state();
1284	rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1285
1286	res = rfkill_register(atp_rfk->rfkill);
1287	if (res < 0) {
1288		pr_err("failed to register %s rfkill switch: %d\n", name, res);
1289		rfkill_destroy(atp_rfk->rfkill);
1290		kfree(atp_rfk);
1291		return res;
1292	}
1293
1294	tpacpi_rfkill_switches[id] = atp_rfk;
1295
1296	pr_info("rfkill switch %s: radio is %sblocked\n",
1297		name, (sw_state || hw_state) ? "" : "un");
1298	return 0;
1299}
1300
1301static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1302{
1303	struct tpacpi_rfk *tp_rfk;
1304
1305	BUG_ON(id >= TPACPI_RFK_SW_MAX);
1306
1307	tp_rfk = tpacpi_rfkill_switches[id];
1308	if (tp_rfk) {
1309		rfkill_unregister(tp_rfk->rfkill);
1310		rfkill_destroy(tp_rfk->rfkill);
1311		tpacpi_rfkill_switches[id] = NULL;
1312		kfree(tp_rfk);
1313	}
1314}
1315
1316static void printk_deprecated_rfkill_attribute(const char * const what)
1317{
1318	printk_deprecated_attribute(what,
1319			"Please switch to generic rfkill before year 2010");
1320}
1321
1322/* sysfs <radio> enable ------------------------------------------------ */
1323static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1324					    struct device_attribute *attr,
1325					    char *buf)
1326{
1327	int status;
1328
1329	printk_deprecated_rfkill_attribute(attr->attr.name);
1330
1331	/* This is in the ABI... */
1332	if (tpacpi_rfk_check_hwblock_state()) {
1333		status = TPACPI_RFK_RADIO_OFF;
1334	} else {
1335		status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1336		if (status < 0)
1337			return status;
1338	}
1339
1340	return snprintf(buf, PAGE_SIZE, "%d\n",
1341			(status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1342}
1343
1344static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1345			    struct device_attribute *attr,
1346			    const char *buf, size_t count)
1347{
1348	unsigned long t;
1349	int res;
1350
1351	printk_deprecated_rfkill_attribute(attr->attr.name);
1352
1353	if (parse_strtoul(buf, 1, &t))
1354		return -EINVAL;
1355
1356	tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1357
1358	/* This is in the ABI... */
1359	if (tpacpi_rfk_check_hwblock_state() && !!t)
1360		return -EPERM;
1361
1362	res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1363				TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1364	tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1365
1366	return (res < 0) ? res : count;
1367}
1368
1369/* procfs -------------------------------------------------------------- */
1370static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1371{
1372	if (id >= TPACPI_RFK_SW_MAX)
1373		seq_printf(m, "status:\t\tnot supported\n");
1374	else {
1375		int status;
1376
1377		/* This is in the ABI... */
1378		if (tpacpi_rfk_check_hwblock_state()) {
1379			status = TPACPI_RFK_RADIO_OFF;
1380		} else {
1381			status = tpacpi_rfk_update_swstate(
1382						tpacpi_rfkill_switches[id]);
1383			if (status < 0)
1384				return status;
1385		}
1386
1387		seq_printf(m, "status:\t\t%s\n",
1388				(status == TPACPI_RFK_RADIO_ON) ?
1389					"enabled" : "disabled");
1390		seq_printf(m, "commands:\tenable, disable\n");
1391	}
1392
1393	return 0;
1394}
1395
1396static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1397{
1398	char *cmd;
1399	int status = -1;
1400	int res = 0;
1401
1402	if (id >= TPACPI_RFK_SW_MAX)
1403		return -ENODEV;
1404
1405	while ((cmd = next_cmd(&buf))) {
1406		if (strlencmp(cmd, "enable") == 0)
1407			status = TPACPI_RFK_RADIO_ON;
1408		else if (strlencmp(cmd, "disable") == 0)
1409			status = TPACPI_RFK_RADIO_OFF;
1410		else
1411			return -EINVAL;
1412	}
1413
1414	if (status != -1) {
1415		tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1416				(status == TPACPI_RFK_RADIO_ON) ?
1417						"enable" : "disable",
1418				tpacpi_rfkill_names[id]);
1419		res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1420		tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1421	}
1422
1423	return res;
1424}
1425
1426/*************************************************************************
1427 * thinkpad-acpi driver attributes
1428 */
1429
1430/* interface_version --------------------------------------------------- */
1431static ssize_t tpacpi_driver_interface_version_show(
1432				struct device_driver *drv,
1433				char *buf)
1434{
1435	return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1436}
1437
1438static DRIVER_ATTR(interface_version, S_IRUGO,
1439		tpacpi_driver_interface_version_show, NULL);
1440
1441/* debug_level --------------------------------------------------------- */
1442static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1443						char *buf)
1444{
1445	return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1446}
1447
1448static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1449						const char *buf, size_t count)
1450{
1451	unsigned long t;
1452
1453	if (parse_strtoul(buf, 0xffff, &t))
1454		return -EINVAL;
1455
1456	dbg_level = t;
1457
1458	return count;
1459}
1460
1461static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1462		tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1463
1464/* version ------------------------------------------------------------- */
1465static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1466						char *buf)
1467{
1468	return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1469			TPACPI_DESC, TPACPI_VERSION);
1470}
1471
1472static DRIVER_ATTR(version, S_IRUGO,
1473		tpacpi_driver_version_show, NULL);
1474
1475/* --------------------------------------------------------------------- */
1476
1477#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1478
1479/* wlsw_emulstate ------------------------------------------------------ */
1480static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1481						char *buf)
1482{
1483	return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1484}
1485
1486static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1487						const char *buf, size_t count)
1488{
1489	unsigned long t;
1490
1491	if (parse_strtoul(buf, 1, &t))
1492		return -EINVAL;
1493
1494	if (tpacpi_wlsw_emulstate != !!t) {
1495		tpacpi_wlsw_emulstate = !!t;
1496		tpacpi_rfk_update_hwblock_state(!t);	/* negative logic */
1497	}
1498
1499	return count;
1500}
1501
1502static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1503		tpacpi_driver_wlsw_emulstate_show,
1504		tpacpi_driver_wlsw_emulstate_store);
1505
1506/* bluetooth_emulstate ------------------------------------------------- */
1507static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1508					struct device_driver *drv,
1509					char *buf)
1510{
1511	return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1512}
1513
1514static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1515					struct device_driver *drv,
1516					const char *buf, size_t count)
1517{
1518	unsigned long t;
1519
1520	if (parse_strtoul(buf, 1, &t))
1521		return -EINVAL;
1522
1523	tpacpi_bluetooth_emulstate = !!t;
1524
1525	return count;
1526}
1527
1528static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1529		tpacpi_driver_bluetooth_emulstate_show,
1530		tpacpi_driver_bluetooth_emulstate_store);
1531
1532/* wwan_emulstate ------------------------------------------------- */
1533static ssize_t tpacpi_driver_wwan_emulstate_show(
1534					struct device_driver *drv,
1535					char *buf)
1536{
1537	return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1538}
1539
1540static ssize_t tpacpi_driver_wwan_emulstate_store(
1541					struct device_driver *drv,
1542					const char *buf, size_t count)
1543{
1544	unsigned long t;
1545
1546	if (parse_strtoul(buf, 1, &t))
1547		return -EINVAL;
1548
1549	tpacpi_wwan_emulstate = !!t;
1550
1551	return count;
1552}
1553
1554static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1555		tpacpi_driver_wwan_emulstate_show,
1556		tpacpi_driver_wwan_emulstate_store);
1557
1558/* uwb_emulstate ------------------------------------------------- */
1559static ssize_t tpacpi_driver_uwb_emulstate_show(
1560					struct device_driver *drv,
1561					char *buf)
1562{
1563	return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1564}
1565
1566static ssize_t tpacpi_driver_uwb_emulstate_store(
1567					struct device_driver *drv,
1568					const char *buf, size_t count)
1569{
1570	unsigned long t;
1571
1572	if (parse_strtoul(buf, 1, &t))
1573		return -EINVAL;
1574
1575	tpacpi_uwb_emulstate = !!t;
1576
1577	return count;
1578}
1579
1580static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1581		tpacpi_driver_uwb_emulstate_show,
1582		tpacpi_driver_uwb_emulstate_store);
1583#endif
1584
1585/* --------------------------------------------------------------------- */
1586
1587static struct driver_attribute *tpacpi_driver_attributes[] = {
1588	&driver_attr_debug_level, &driver_attr_version,
1589	&driver_attr_interface_version,
1590};
1591
1592static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1593{
1594	int i, res;
1595
1596	i = 0;
1597	res = 0;
1598	while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1599		res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1600		i++;
1601	}
1602
1603#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1604	if (!res && dbg_wlswemul)
1605		res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1606	if (!res && dbg_bluetoothemul)
1607		res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1608	if (!res && dbg_wwanemul)
1609		res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1610	if (!res && dbg_uwbemul)
1611		res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1612#endif
1613
1614	return res;
1615}
1616
1617static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1618{
1619	int i;
1620
1621	for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1622		driver_remove_file(drv, tpacpi_driver_attributes[i]);
1623
1624#ifdef THINKPAD_ACPI_DEBUGFACILITIES
1625	driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1626	driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1627	driver_remove_file(drv, &driver_attr_wwan_emulstate);
1628	driver_remove_file(drv, &driver_attr_uwb_emulstate);
1629#endif
1630}
1631
1632/*************************************************************************
1633 * Firmware Data
1634 */
1635
1636/*
1637 * Table of recommended minimum BIOS versions
1638 *
1639 * Reasons for listing:
1640 *    1. Stable BIOS, listed because the unknown amount of
1641 *       bugs and bad ACPI behaviour on older versions
1642 *
1643 *    2. BIOS or EC fw with known bugs that trigger on Linux
1644 *
1645 *    3. BIOS with known reduced functionality in older versions
1646 *
1647 *  We recommend the latest BIOS and EC version.
1648 *  We only support the latest BIOS and EC fw version as a rule.
1649 *
1650 *  Sources: IBM ThinkPad Public Web Documents (update changelogs),
1651 *  Information from users in ThinkWiki
1652 *
1653 *  WARNING: we use this table also to detect that the machine is
1654 *  a ThinkPad in some cases, so don't remove entries lightly.
1655 */
1656
1657#define TPV_Q(__v, __id1, __id2, __bv1, __bv2)		\
1658	{ .vendor	= (__v),			\
1659	  .bios		= TPID(__id1, __id2),		\
1660	  .ec		= TPACPI_MATCH_ANY,		\
1661	  .quirks	= TPACPI_MATCH_ANY << 16	\
1662			  | (__bv1) << 8 | (__bv2) }
1663
1664#define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2,	\
1665		__eid, __ev1, __ev2)			\
1666	{ .vendor	= (__v),			\
1667	  .bios		= TPID(__bid1, __bid2),		\
1668	  .ec		= __eid,			\
1669	  .quirks	= (__ev1) << 24 | (__ev2) << 16 \
1670			  | (__bv1) << 8 | (__bv2) }
1671
1672#define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1673	TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1674
1675/* Outdated IBM BIOSes often lack the EC id string */
1676#define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1677	TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, 	\
1678		__bv1, __bv2, TPID(__id1, __id2),	\
1679		__ev1, __ev2),				\
1680	TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, 	\
1681		__bv1, __bv2, TPACPI_MATCH_UNKNOWN,	\
1682		__ev1, __ev2)
1683
1684/* Outdated IBM BIOSes often lack the EC id string */
1685#define TPV_QI2(__bid1, __bid2, __bv1, __bv2,		\
1686		__eid1, __eid2, __ev1, __ev2) 		\
1687	TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, 	\
1688		__bv1, __bv2, TPID(__eid1, __eid2),	\
1689		__ev1, __ev2),				\
1690	TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, 	\
1691		__bv1, __bv2, TPACPI_MATCH_UNKNOWN,	\
1692		__ev1, __ev2)
1693
1694#define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1695	TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1696
1697#define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1698	TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, 	\
1699		__bv1, __bv2, TPID(__id1, __id2),	\
1700		__ev1, __ev2)
1701
1702#define TPV_QL2(__bid1, __bid2, __bv1, __bv2,		\
1703		__eid1, __eid2, __ev1, __ev2) 		\
1704	TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, 	\
1705		__bv1, __bv2, TPID(__eid1, __eid2),	\
1706		__ev1, __ev2)
1707
1708static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1709	/*  Numeric models ------------------ */
1710	/*      FW MODEL   BIOS VERS	      */
1711	TPV_QI0('I', 'M',  '6', '5'),		 /* 570 */
1712	TPV_QI0('I', 'U',  '2', '6'),		 /* 570E */
1713	TPV_QI0('I', 'B',  '5', '4'),		 /* 600 */
1714	TPV_QI0('I', 'H',  '4', '7'),		 /* 600E */
1715	TPV_QI0('I', 'N',  '3', '6'),		 /* 600E */
1716	TPV_QI0('I', 'T',  '5', '5'),		 /* 600X */
1717	TPV_QI0('I', 'D',  '4', '8'),		 /* 770, 770E, 770ED */
1718	TPV_QI0('I', 'I',  '4', '2'),		 /* 770X */
1719	TPV_QI0('I', 'O',  '2', '3'),		 /* 770Z */
1720
1721	/* A-series ------------------------- */
1722	/*      FW MODEL   BIOS VERS  EC VERS */
1723	TPV_QI0('I', 'W',  '5', '9'),		 /* A20m */
1724	TPV_QI0('I', 'V',  '6', '9'),		 /* A20p */
1725	TPV_QI0('1', '0',  '2', '6'),		 /* A21e, A22e */
1726	TPV_QI0('K', 'U',  '3', '6'),		 /* A21e */
1727	TPV_QI0('K', 'X',  '3', '6'),		 /* A21m, A22m */
1728	TPV_QI0('K', 'Y',  '3', '8'),		 /* A21p, A22p */
1729	TPV_QI0('1', 'B',  '1', '7'),		 /* A22e */
1730	TPV_QI0('1', '3',  '2', '0'),		 /* A22m */
1731	TPV_QI0('1', 'E',  '7', '3'),		 /* A30/p (0) */
1732	TPV_QI1('1', 'G',  '4', '1',  '1', '7'), /* A31/p (0) */
1733	TPV_QI1('1', 'N',  '1', '6',  '0', '7'), /* A31/p (0) */
1734
1735	/* G-series ------------------------- */
1736	/*      FW MODEL   BIOS VERS	      */
1737	TPV_QI0('1', 'T',  'A', '6'),		 /* G40 */
1738	TPV_QI0('1', 'X',  '5', '7'),		 /* G41 */
1739
1740	/* R-series, T-series --------------- */
1741	/*      FW MODEL   BIOS VERS  EC VERS */
1742	TPV_QI0('1', 'C',  'F', '0'),		 /* R30 */
1743	TPV_QI0('1', 'F',  'F', '1'),		 /* R31 */
1744	TPV_QI0('1', 'M',  '9', '7'),		 /* R32 */
1745	TPV_QI0('1', 'O',  '6', '1'),		 /* R40 */
1746	TPV_QI0('1', 'P',  '6', '5'),		 /* R40 */
1747	TPV_QI0('1', 'S',  '7', '0'),		 /* R40e */
1748	TPV_QI1('1', 'R',  'D', 'R',  '7', '1'), /* R50/p, R51,
1749						    T40/p, T41/p, T42/p (1) */
1750	TPV_QI1('1', 'V',  '7', '1',  '2', '8'), /* R50e, R51 (1) */
1751	TPV_QI1('7', '8',  '7', '1',  '0', '6'), /* R51e (1) */
1752	TPV_QI1('7', '6',  '6', '9',  '1', '6'), /* R52 (1) */
1753	TPV_QI1('7', '0',  '6', '9',  '2', '8'), /* R52, T43 (1) */
1754
1755	TPV_QI0('I', 'Y',  '6', '1'),		 /* T20 */
1756	TPV_QI0('K', 'Z',  '3', '4'),		 /* T21 */
1757	TPV_QI0('1', '6',  '3', '2'),		 /* T22 */
1758	TPV_QI1('1', 'A',  '6', '4',  '2', '3'), /* T23 (0) */
1759	TPV_QI1('1', 'I',  '7', '1',  '2', '0'), /* T30 (0) */
1760	TPV_QI1('1', 'Y',  '6', '5',  '2', '9'), /* T43/p (1) */
1761
1762	TPV_QL1('7', '9',  'E', '3',  '5', '0'), /* T60/p */
1763	TPV_QL1('7', 'C',  'D', '2',  '2', '2'), /* R60, R60i */
1764	TPV_QL1('7', 'E',  'D', '0',  '1', '5'), /* R60e, R60i */
1765
1766	/*      BIOS FW    BIOS VERS  EC FW     EC VERS */
1767	TPV_QI2('1', 'W',  '9', '0',  '1', 'V', '2', '8'), /* R50e (1) */
1768	TPV_QL2('7', 'I',  '3', '4',  '7', '9', '5', '0'), /* T60/p wide */
1769
1770	/* X-series ------------------------- */
1771	/*      FW MODEL   BIOS VERS  EC VERS */
1772	TPV_QI0('I', 'Z',  '9', 'D'),		 /* X20, X21 */
1773	TPV_QI0('1', 'D',  '7', '0'),		 /* X22, X23, X24 */
1774	TPV_QI1('1', 'K',  '4', '8',  '1', '8'), /* X30 (0) */
1775	TPV_QI1('1', 'Q',  '9', '7',  '2', '3'), /* X31, X32 (0) */
1776	TPV_QI1('1', 'U',  'D', '3',  'B', '2'), /* X40 (0) */
1777	TPV_QI1('7', '4',  '6', '4',  '2', '7'), /* X41 (0) */
1778	TPV_QI1('7', '5',  '6', '0',  '2', '0'), /* X41t (0) */
1779
1780	TPV_QL1('7', 'B',  'D', '7',  '4', '0'), /* X60/s */
1781	TPV_QL1('7', 'J',  '3', '0',  '1', '3'), /* X60t */
1782
1783	/* (0) - older versions lack DMI EC fw string and functionality */
1784	/* (1) - older versions known to lack functionality */
1785};
1786
1787#undef TPV_QL1
1788#undef TPV_QL0
1789#undef TPV_QI2
1790#undef TPV_QI1
1791#undef TPV_QI0
1792#undef TPV_Q_X
1793#undef TPV_Q
1794
1795static void __init tpacpi_check_outdated_fw(void)
1796{
1797	unsigned long fwvers;
1798	u16 ec_version, bios_version;
1799
1800	fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1801				ARRAY_SIZE(tpacpi_bios_version_qtable));
1802
1803	if (!fwvers)
1804		return;
1805
1806	bios_version = fwvers & 0xffffU;
1807	ec_version = (fwvers >> 16) & 0xffffU;
1808
1809	/* note that unknown versions are set to 0x0000 and we use that */
1810	if ((bios_version > thinkpad_id.bios_release) ||
1811	    (ec_version > thinkpad_id.ec_release &&
1812				ec_version != TPACPI_MATCH_ANY)) {
1813		/*
1814		 * The changelogs would let us track down the exact
1815		 * reason, but it is just too much of a pain to track
1816		 * it.  We only list BIOSes that are either really
1817		 * broken, or really stable to begin with, so it is
1818		 * best if the user upgrades the firmware anyway.
1819		 */
1820		pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1821		pr_warn("WARNING: This firmware may be missing critical bug "
1822			"fixes and/or important features\n");
1823	}
1824}
1825
1826static bool __init tpacpi_is_fw_known(void)
1827{
1828	return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1829			ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1830}
1831
1832/****************************************************************************
1833 ****************************************************************************
1834 *
1835 * Subdrivers
1836 *
1837 ****************************************************************************
1838 ****************************************************************************/
1839
1840/*************************************************************************
1841 * thinkpad-acpi metadata subdriver
1842 */
1843
1844static int thinkpad_acpi_driver_read(struct seq_file *m)
1845{
1846	seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1847	seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1848	return 0;
1849}
1850
1851static struct ibm_struct thinkpad_acpi_driver_data = {
1852	.name = "driver",
1853	.read = thinkpad_acpi_driver_read,
1854};
1855
1856/*************************************************************************
1857 * Hotkey subdriver
1858 */
1859
1860/*
1861 * ThinkPad firmware event model
1862 *
1863 * The ThinkPad firmware has two main event interfaces: normal ACPI
1864 * notifications (which follow the ACPI standard), and a private event
1865 * interface.
1866 *
1867 * The private event interface also issues events for the hotkeys.  As
1868 * the driver gained features, the event handling code ended up being
1869 * built around the hotkey subdriver.  This will need to be refactored
1870 * to a more formal event API eventually.
1871 *
1872 * Some "hotkeys" are actually supposed to be used as event reports,
1873 * such as "brightness has changed", "volume has changed", depending on
1874 * the ThinkPad model and how the firmware is operating.
1875 *
1876 * Unlike other classes, hotkey-class events have mask/unmask control on
1877 * non-ancient firmware.  However, how it behaves changes a lot with the
1878 * firmware model and version.
1879 */
1880
1881enum {	/* hot key scan codes (derived from ACPI DSDT) */
1882	TP_ACPI_HOTKEYSCAN_FNF1		= 0,
1883	TP_ACPI_HOTKEYSCAN_FNF2,
1884	TP_ACPI_HOTKEYSCAN_FNF3,
1885	TP_ACPI_HOTKEYSCAN_FNF4,
1886	TP_ACPI_HOTKEYSCAN_FNF5,
1887	TP_ACPI_HOTKEYSCAN_FNF6,
1888	TP_ACPI_HOTKEYSCAN_FNF7,
1889	TP_ACPI_HOTKEYSCAN_FNF8,
1890	TP_ACPI_HOTKEYSCAN_FNF9,
1891	TP_ACPI_HOTKEYSCAN_FNF10,
1892	TP_ACPI_HOTKEYSCAN_FNF11,
1893	TP_ACPI_HOTKEYSCAN_FNF12,
1894	TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1895	TP_ACPI_HOTKEYSCAN_FNINSERT,
1896	TP_ACPI_HOTKEYSCAN_FNDELETE,
1897	TP_ACPI_HOTKEYSCAN_FNHOME,
1898	TP_ACPI_HOTKEYSCAN_FNEND,
1899	TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1900	TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1901	TP_ACPI_HOTKEYSCAN_FNSPACE,
1902	TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1903	TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1904	TP_ACPI_HOTKEYSCAN_MUTE,
1905	TP_ACPI_HOTKEYSCAN_THINKPAD,
1906	TP_ACPI_HOTKEYSCAN_UNK1,
1907	TP_ACPI_HOTKEYSCAN_UNK2,
1908	TP_ACPI_HOTKEYSCAN_UNK3,
1909	TP_ACPI_HOTKEYSCAN_UNK4,
1910	TP_ACPI_HOTKEYSCAN_UNK5,
1911	TP_ACPI_HOTKEYSCAN_UNK6,
1912	TP_ACPI_HOTKEYSCAN_UNK7,
1913	TP_ACPI_HOTKEYSCAN_UNK8,
1914
1915	/* Hotkey keymap size */
1916	TPACPI_HOTKEY_MAP_LEN
1917};
1918
1919enum {	/* Keys/events available through NVRAM polling */
1920	TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1921	TPACPI_HKEY_NVRAM_GOOD_MASK  = 0x00fb8000U,
1922};
1923
1924enum {	/* Positions of some of the keys in hotkey masks */
1925	TP_ACPI_HKEY_DISPSWTCH_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1926	TP_ACPI_HKEY_DISPXPAND_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1927	TP_ACPI_HKEY_HIBERNATE_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1928	TP_ACPI_HKEY_BRGHTUP_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1929	TP_ACPI_HKEY_BRGHTDWN_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1930	TP_ACPI_HKEY_THNKLGHT_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1931	TP_ACPI_HKEY_ZOOM_MASK		= 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1932	TP_ACPI_HKEY_VOLUP_MASK		= 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1933	TP_ACPI_HKEY_VOLDWN_MASK	= 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1934	TP_ACPI_HKEY_MUTE_MASK		= 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1935	TP_ACPI_HKEY_THINKPAD_MASK	= 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1936};
1937
1938enum {	/* NVRAM to ACPI HKEY group map */
1939	TP_NVRAM_HKEY_GROUP_HK2		= TP_ACPI_HKEY_THINKPAD_MASK |
1940					  TP_ACPI_HKEY_ZOOM_MASK |
1941					  TP_ACPI_HKEY_DISPSWTCH_MASK |
1942					  TP_ACPI_HKEY_HIBERNATE_MASK,
1943	TP_NVRAM_HKEY_GROUP_BRIGHTNESS	= TP_ACPI_HKEY_BRGHTUP_MASK |
1944					  TP_ACPI_HKEY_BRGHTDWN_MASK,
1945	TP_NVRAM_HKEY_GROUP_VOLUME	= TP_ACPI_HKEY_VOLUP_MASK |
1946					  TP_ACPI_HKEY_VOLDWN_MASK |
1947					  TP_ACPI_HKEY_MUTE_MASK,
1948};
1949
1950#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1951struct tp_nvram_state {
1952       u16 thinkpad_toggle:1;
1953       u16 zoom_toggle:1;
1954       u16 display_toggle:1;
1955       u16 thinklight_toggle:1;
1956       u16 hibernate_toggle:1;
1957       u16 displayexp_toggle:1;
1958       u16 display_state:1;
1959       u16 brightness_toggle:1;
1960       u16 volume_toggle:1;
1961       u16 mute:1;
1962
1963       u8 brightness_level;
1964       u8 volume_level;
1965};
1966
1967/* kthread for the hotkey poller */
1968static struct task_struct *tpacpi_hotkey_task;
1969
 
 
 
1970/*
1971 * Acquire mutex to write poller control variables as an
1972 * atomic block.
1973 *
1974 * Increment hotkey_config_change when changing them if you
1975 * want the kthread to forget old state.
1976 *
1977 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1978 */
1979static struct mutex hotkey_thread_data_mutex;
1980static unsigned int hotkey_config_change;
1981
1982/*
1983 * hotkey poller control variables
1984 *
1985 * Must be atomic or readers will also need to acquire mutex
1986 *
1987 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1988 * should be used only when the changes need to be taken as
1989 * a block, OR when one needs to force the kthread to forget
1990 * old state.
1991 */
1992static u32 hotkey_source_mask;		/* bit mask 0=ACPI,1=NVRAM */
1993static unsigned int hotkey_poll_freq = 10; /* Hz */
1994
1995#define HOTKEY_CONFIG_CRITICAL_START \
1996	do { \
1997		mutex_lock(&hotkey_thread_data_mutex); \
1998		hotkey_config_change++; \
1999	} while (0);
2000#define HOTKEY_CONFIG_CRITICAL_END \
2001	mutex_unlock(&hotkey_thread_data_mutex);
2002
2003#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2004
2005#define hotkey_source_mask 0U
2006#define HOTKEY_CONFIG_CRITICAL_START
2007#define HOTKEY_CONFIG_CRITICAL_END
2008
2009#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2010
2011static struct mutex hotkey_mutex;
2012
2013static enum {	/* Reasons for waking up */
2014	TP_ACPI_WAKEUP_NONE = 0,	/* None or unknown */
2015	TP_ACPI_WAKEUP_BAYEJ,		/* Bay ejection request */
2016	TP_ACPI_WAKEUP_UNDOCK,		/* Undock request */
2017} hotkey_wakeup_reason;
2018
2019static int hotkey_autosleep_ack;
2020
2021static u32 hotkey_orig_mask;		/* events the BIOS had enabled */
2022static u32 hotkey_all_mask;		/* all events supported in fw */
2023static u32 hotkey_reserved_mask;	/* events better left disabled */
2024static u32 hotkey_driver_mask;		/* events needed by the driver */
2025static u32 hotkey_user_mask;		/* events visible to userspace */
2026static u32 hotkey_acpi_mask;		/* events enabled in firmware */
2027
 
 
2028static u16 *hotkey_keycode_map;
2029
2030static struct attribute_set *hotkey_dev_attributes;
2031
2032static void tpacpi_driver_event(const unsigned int hkey_event);
2033static void hotkey_driver_event(const unsigned int scancode);
2034static void hotkey_poll_setup(const bool may_warn);
2035
2036/* HKEY.MHKG() return bits */
2037#define TP_HOTKEY_TABLET_MASK (1 << 3)
2038
2039static int hotkey_get_wlsw(void)
2040{
2041	int status;
2042
2043	if (!tp_features.hotkey_wlsw)
2044		return -ENODEV;
2045
2046#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2047	if (dbg_wlswemul)
2048		return (tpacpi_wlsw_emulstate) ?
2049				TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2050#endif
2051
2052	if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2053		return -EIO;
2054
2055	return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2056}
2057
2058static int hotkey_get_tablet_mode(int *status)
2059{
2060	int s;
2061
2062	if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2063		return -EIO;
2064
2065	*status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2066	return 0;
2067}
2068
2069/*
2070 * Reads current event mask from firmware, and updates
2071 * hotkey_acpi_mask accordingly.  Also resets any bits
2072 * from hotkey_user_mask that are unavailable to be
2073 * delivered (shadow requirement of the userspace ABI).
2074 *
2075 * Call with hotkey_mutex held
2076 */
2077static int hotkey_mask_get(void)
2078{
2079	if (tp_features.hotkey_mask) {
2080		u32 m = 0;
2081
2082		if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2083			return -EIO;
2084
2085		hotkey_acpi_mask = m;
2086	} else {
2087		/* no mask support doesn't mean no event support... */
2088		hotkey_acpi_mask = hotkey_all_mask;
2089	}
2090
2091	/* sync userspace-visible mask */
2092	hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2093
2094	return 0;
2095}
2096
2097void static hotkey_mask_warn_incomplete_mask(void)
2098{
2099	/* log only what the user can fix... */
2100	const u32 wantedmask = hotkey_driver_mask &
2101		~(hotkey_acpi_mask | hotkey_source_mask) &
2102		(hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2103
2104	if (wantedmask)
2105		pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2106}
2107
2108/*
2109 * Set the firmware mask when supported
2110 *
2111 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2112 *
2113 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2114 *
2115 * Call with hotkey_mutex held
2116 */
2117static int hotkey_mask_set(u32 mask)
2118{
2119	int i;
2120	int rc = 0;
2121
2122	const u32 fwmask = mask & ~hotkey_source_mask;
2123
2124	if (tp_features.hotkey_mask) {
2125		for (i = 0; i < 32; i++) {
2126			if (!acpi_evalf(hkey_handle,
2127					NULL, "MHKM", "vdd", i + 1,
2128					!!(mask & (1 << i)))) {
2129				rc = -EIO;
2130				break;
2131			}
2132		}
2133	}
2134
2135	/*
2136	 * We *must* make an inconditional call to hotkey_mask_get to
2137	 * refresh hotkey_acpi_mask and update hotkey_user_mask
2138	 *
2139	 * Take the opportunity to also log when we cannot _enable_
2140	 * a given event.
2141	 */
2142	if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2143		pr_notice("asked for hotkey mask 0x%08x, but "
2144			  "firmware forced it to 0x%08x\n",
2145			  fwmask, hotkey_acpi_mask);
2146	}
2147
2148	if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2149		hotkey_mask_warn_incomplete_mask();
2150
2151	return rc;
2152}
2153
2154/*
2155 * Sets hotkey_user_mask and tries to set the firmware mask
2156 *
2157 * Call with hotkey_mutex held
2158 */
2159static int hotkey_user_mask_set(const u32 mask)
2160{
2161	int rc;
2162
2163	/* Give people a chance to notice they are doing something that
2164	 * is bound to go boom on their users sooner or later */
2165	if (!tp_warned.hotkey_mask_ff &&
2166	    (mask == 0xffff || mask == 0xffffff ||
2167	     mask == 0xffffffff)) {
2168		tp_warned.hotkey_mask_ff = 1;
2169		pr_notice("setting the hotkey mask to 0x%08x is likely "
2170			  "not the best way to go about it\n", mask);
2171		pr_notice("please consider using the driver defaults, "
2172			  "and refer to up-to-date thinkpad-acpi "
2173			  "documentation\n");
2174	}
2175
2176	/* Try to enable what the user asked for, plus whatever we need.
2177	 * this syncs everything but won't enable bits in hotkey_user_mask */
2178	rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2179
2180	/* Enable the available bits in hotkey_user_mask */
2181	hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2182
2183	return rc;
2184}
2185
2186/*
2187 * Sets the driver hotkey mask.
2188 *
2189 * Can be called even if the hotkey subdriver is inactive
2190 */
2191static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2192{
2193	int rc;
2194
2195	/* Do the right thing if hotkey_init has not been called yet */
2196	if (!tp_features.hotkey) {
2197		hotkey_driver_mask = mask;
2198		return 0;
2199	}
2200
2201	mutex_lock(&hotkey_mutex);
2202
2203	HOTKEY_CONFIG_CRITICAL_START
2204	hotkey_driver_mask = mask;
2205#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2206	hotkey_source_mask |= (mask & ~hotkey_all_mask);
2207#endif
2208	HOTKEY_CONFIG_CRITICAL_END
2209
2210	rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2211							~hotkey_source_mask);
2212	hotkey_poll_setup(true);
2213
2214	mutex_unlock(&hotkey_mutex);
2215
2216	return rc;
2217}
2218
2219static int hotkey_status_get(int *status)
2220{
2221	if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2222		return -EIO;
2223
2224	return 0;
2225}
2226
2227static int hotkey_status_set(bool enable)
2228{
2229	if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2230		return -EIO;
2231
2232	return 0;
2233}
2234
2235static void tpacpi_input_send_tabletsw(void)
2236{
2237	int state;
2238
2239	if (tp_features.hotkey_tablet &&
2240	    !hotkey_get_tablet_mode(&state)) {
2241		mutex_lock(&tpacpi_inputdev_send_mutex);
2242
2243		input_report_switch(tpacpi_inputdev,
2244				    SW_TABLET_MODE, !!state);
2245		input_sync(tpacpi_inputdev);
2246
2247		mutex_unlock(&tpacpi_inputdev_send_mutex);
2248	}
2249}
2250
2251/* Do NOT call without validating scancode first */
2252static void tpacpi_input_send_key(const unsigned int scancode)
2253{
2254	const unsigned int keycode = hotkey_keycode_map[scancode];
2255
2256	if (keycode != KEY_RESERVED) {
2257		mutex_lock(&tpacpi_inputdev_send_mutex);
2258
2259		input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2260		input_report_key(tpacpi_inputdev, keycode, 1);
2261		input_sync(tpacpi_inputdev);
2262
2263		input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2264		input_report_key(tpacpi_inputdev, keycode, 0);
2265		input_sync(tpacpi_inputdev);
2266
2267		mutex_unlock(&tpacpi_inputdev_send_mutex);
2268	}
2269}
2270
2271/* Do NOT call without validating scancode first */
2272static void tpacpi_input_send_key_masked(const unsigned int scancode)
2273{
2274	hotkey_driver_event(scancode);
2275	if (hotkey_user_mask & (1 << scancode))
2276		tpacpi_input_send_key(scancode);
2277}
2278
2279#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2280static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2281
2282/* Do NOT call without validating scancode first */
2283static void tpacpi_hotkey_send_key(unsigned int scancode)
2284{
2285	tpacpi_input_send_key_masked(scancode);
 
 
 
 
2286}
2287
2288static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2289{
2290	u8 d;
2291
2292	if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2293		d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2294		n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2295		n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2296		n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2297		n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2298	}
2299	if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2300		d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2301		n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2302	}
2303	if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2304		d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2305		n->displayexp_toggle =
2306				!!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2307	}
2308	if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2309		d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2310		n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2311				>> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2312		n->brightness_toggle =
2313				!!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2314	}
2315	if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2316		d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2317		n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2318				>> TP_NVRAM_POS_LEVEL_VOLUME;
2319		n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2320		n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2321	}
2322}
2323
 
 
 
 
 
2324#define TPACPI_COMPARE_KEY(__scancode, __member) \
2325do { \
2326	if ((event_mask & (1 << __scancode)) && \
2327	    oldn->__member != newn->__member) \
2328		tpacpi_hotkey_send_key(__scancode); \
2329} while (0)
2330
2331#define TPACPI_MAY_SEND_KEY(__scancode) \
2332do { \
2333	if (event_mask & (1 << __scancode)) \
2334		tpacpi_hotkey_send_key(__scancode); \
2335} while (0)
 
 
 
 
 
2336
2337static void issue_volchange(const unsigned int oldvol,
2338			    const unsigned int newvol,
2339			    const u32 event_mask)
2340{
2341	unsigned int i = oldvol;
2342
2343	while (i > newvol) {
2344		TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2345		i--;
2346	}
2347	while (i < newvol) {
2348		TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2349		i++;
2350	}
2351}
2352
2353static void issue_brightnesschange(const unsigned int oldbrt,
2354				   const unsigned int newbrt,
2355				   const u32 event_mask)
2356{
2357	unsigned int i = oldbrt;
2358
2359	while (i > newbrt) {
2360		TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2361		i--;
 
 
 
 
2362	}
2363	while (i < newbrt) {
2364		TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2365		i++;
2366	}
2367}
2368
2369static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2370					   struct tp_nvram_state *newn,
2371					   const u32 event_mask)
2372{
2373
2374	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2375	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2376	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2377	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2378
2379	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2380
2381	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2382
2383	/*
2384	 * Handle volume
2385	 *
2386	 * This code is supposed to duplicate the IBM firmware behaviour:
2387	 * - Pressing MUTE issues mute hotkey message, even when already mute
2388	 * - Pressing Volume up/down issues volume up/down hotkey messages,
2389	 *   even when already at maximum or minimum volume
2390	 * - The act of unmuting issues volume up/down notification,
2391	 *   depending which key was used to unmute
2392	 *
2393	 * We are constrained to what the NVRAM can tell us, which is not much
2394	 * and certainly not enough if more than one volume hotkey was pressed
2395	 * since the last poll cycle.
2396	 *
2397	 * Just to make our life interesting, some newer Lenovo ThinkPads have
2398	 * bugs in the BIOS and may fail to update volume_toggle properly.
2399	 */
2400	if (newn->mute) {
2401		/* muted */
2402		if (!oldn->mute ||
2403		    oldn->volume_toggle != newn->volume_toggle ||
2404		    oldn->volume_level != newn->volume_level) {
2405			/* recently muted, or repeated mute keypress, or
2406			 * multiple presses ending in mute */
2407			issue_volchange(oldn->volume_level, newn->volume_level,
2408				event_mask);
2409			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2410		}
2411	} else {
2412		/* unmute */
2413		if (oldn->mute) {
2414			/* recently unmuted, issue 'unmute' keypress */
2415			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2416		}
2417		if (oldn->volume_level != newn->volume_level) {
2418			issue_volchange(oldn->volume_level, newn->volume_level,
2419				event_mask);
2420		} else if (oldn->volume_toggle != newn->volume_toggle) {
2421			/* repeated vol up/down keypress at end of scale ? */
2422			if (newn->volume_level == 0)
2423				TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2424			else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2425				TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2426		}
2427	}
2428
2429	/* handle brightness */
2430	if (oldn->brightness_level != newn->brightness_level) {
2431		issue_brightnesschange(oldn->brightness_level,
2432				       newn->brightness_level, event_mask);
2433	} else if (oldn->brightness_toggle != newn->brightness_toggle) {
2434		/* repeated key presses that didn't change state */
2435		if (newn->brightness_level == 0)
2436			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2437		else if (newn->brightness_level >= bright_maxlvl
2438				&& !tp_features.bright_unkfw)
2439			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2440	}
2441
2442#undef TPACPI_COMPARE_KEY
2443#undef TPACPI_MAY_SEND_KEY
2444}
2445
2446/*
2447 * Polling driver
2448 *
2449 * We track all events in hotkey_source_mask all the time, since
2450 * most of them are edge-based.  We only issue those requested by
2451 * hotkey_user_mask or hotkey_driver_mask, though.
2452 */
2453static int hotkey_kthread(void *data)
2454{
2455	struct tp_nvram_state s[2];
2456	u32 poll_mask, event_mask;
2457	unsigned int si, so;
2458	unsigned long t;
2459	unsigned int change_detector;
2460	unsigned int poll_freq;
2461	bool was_frozen;
 
2462
2463	if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2464		goto exit;
2465
2466	set_freezable();
2467
2468	so = 0;
2469	si = 1;
2470	t = 0;
2471
2472	/* Initial state for compares */
2473	mutex_lock(&hotkey_thread_data_mutex);
2474	change_detector = hotkey_config_change;
2475	poll_mask = hotkey_source_mask;
2476	event_mask = hotkey_source_mask &
2477			(hotkey_driver_mask | hotkey_user_mask);
2478	poll_freq = hotkey_poll_freq;
2479	mutex_unlock(&hotkey_thread_data_mutex);
2480	hotkey_read_nvram(&s[so], poll_mask);
2481
2482	while (!kthread_should_stop()) {
2483		if (t == 0) {
2484			if (likely(poll_freq))
2485				t = 1000/poll_freq;
2486			else
2487				t = 100;	/* should never happen... */
2488		}
2489		t = msleep_interruptible(t);
2490		if (unlikely(kthread_freezable_should_stop(&was_frozen)))
2491			break;
2492
2493		if (t > 0 && !was_frozen)
2494			continue;
2495
2496		mutex_lock(&hotkey_thread_data_mutex);
2497		if (was_frozen || hotkey_config_change != change_detector) {
2498			/* forget old state on thaw or config change */
2499			si = so;
2500			t = 0;
2501			change_detector = hotkey_config_change;
2502		}
2503		poll_mask = hotkey_source_mask;
2504		event_mask = hotkey_source_mask &
2505				(hotkey_driver_mask | hotkey_user_mask);
2506		poll_freq = hotkey_poll_freq;
2507		mutex_unlock(&hotkey_thread_data_mutex);
2508
2509		if (likely(poll_mask)) {
2510			hotkey_read_nvram(&s[si], poll_mask);
2511			if (likely(si != so)) {
2512				hotkey_compare_and_issue_event(&s[so], &s[si],
2513								event_mask);
2514			}
2515		}
2516
2517		so = si;
2518		si ^= 1;
2519	}
2520
2521exit:
 
2522	return 0;
2523}
2524
2525/* call with hotkey_mutex held */
2526static void hotkey_poll_stop_sync(void)
2527{
2528	if (tpacpi_hotkey_task) {
 
 
 
 
2529		kthread_stop(tpacpi_hotkey_task);
2530		tpacpi_hotkey_task = NULL;
 
 
 
2531	}
2532}
2533
2534/* call with hotkey_mutex held */
2535static void hotkey_poll_setup(const bool may_warn)
2536{
2537	const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2538	const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2539
2540	if (hotkey_poll_freq > 0 &&
2541	    (poll_driver_mask ||
2542	     (poll_user_mask && tpacpi_inputdev->users > 0))) {
2543		if (!tpacpi_hotkey_task) {
2544			tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2545					NULL, TPACPI_NVRAM_KTHREAD_NAME);
2546			if (IS_ERR(tpacpi_hotkey_task)) {
2547				tpacpi_hotkey_task = NULL;
2548				pr_err("could not create kernel thread "
2549				       "for hotkey polling\n");
2550			}
2551		}
2552	} else {
2553		hotkey_poll_stop_sync();
2554		if (may_warn && (poll_driver_mask || poll_user_mask) &&
2555		    hotkey_poll_freq == 0) {
2556			pr_notice("hot keys 0x%08x and/or events 0x%08x "
2557				  "require polling, which is currently "
2558				  "disabled\n",
2559				  poll_user_mask, poll_driver_mask);
2560		}
2561	}
2562}
2563
2564static void hotkey_poll_setup_safe(const bool may_warn)
2565{
2566	mutex_lock(&hotkey_mutex);
2567	hotkey_poll_setup(may_warn);
2568	mutex_unlock(&hotkey_mutex);
2569}
2570
2571/* call with hotkey_mutex held */
2572static void hotkey_poll_set_freq(unsigned int freq)
2573{
2574	if (!freq)
2575		hotkey_poll_stop_sync();
2576
2577	hotkey_poll_freq = freq;
2578}
2579
2580#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2581
2582static void hotkey_poll_setup(const bool __unused)
2583{
2584}
2585
2586static void hotkey_poll_setup_safe(const bool __unused)
2587{
2588}
2589
2590#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2591
2592static int hotkey_inputdev_open(struct input_dev *dev)
2593{
2594	switch (tpacpi_lifecycle) {
2595	case TPACPI_LIFE_INIT:
2596	case TPACPI_LIFE_RUNNING:
2597		hotkey_poll_setup_safe(false);
2598		return 0;
2599	case TPACPI_LIFE_EXITING:
2600		return -EBUSY;
2601	}
2602
2603	/* Should only happen if tpacpi_lifecycle is corrupt */
2604	BUG();
2605	return -EBUSY;
2606}
2607
2608static void hotkey_inputdev_close(struct input_dev *dev)
2609{
2610	/* disable hotkey polling when possible */
2611	if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2612	    !(hotkey_source_mask & hotkey_driver_mask))
2613		hotkey_poll_setup_safe(false);
2614}
2615
2616/* sysfs hotkey enable ------------------------------------------------- */
2617static ssize_t hotkey_enable_show(struct device *dev,
2618			   struct device_attribute *attr,
2619			   char *buf)
2620{
2621	int res, status;
2622
2623	printk_deprecated_attribute("hotkey_enable",
2624			"Hotkey reporting is always enabled");
2625
2626	res = hotkey_status_get(&status);
2627	if (res)
2628		return res;
2629
2630	return snprintf(buf, PAGE_SIZE, "%d\n", status);
2631}
2632
2633static ssize_t hotkey_enable_store(struct device *dev,
2634			    struct device_attribute *attr,
2635			    const char *buf, size_t count)
2636{
2637	unsigned long t;
2638
2639	printk_deprecated_attribute("hotkey_enable",
2640			"Hotkeys can be disabled through hotkey_mask");
2641
2642	if (parse_strtoul(buf, 1, &t))
2643		return -EINVAL;
2644
2645	if (t == 0)
2646		return -EPERM;
2647
2648	return count;
2649}
2650
2651static struct device_attribute dev_attr_hotkey_enable =
2652	__ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2653		hotkey_enable_show, hotkey_enable_store);
2654
2655/* sysfs hotkey mask --------------------------------------------------- */
2656static ssize_t hotkey_mask_show(struct device *dev,
2657			   struct device_attribute *attr,
2658			   char *buf)
2659{
2660	return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2661}
2662
2663static ssize_t hotkey_mask_store(struct device *dev,
2664			    struct device_attribute *attr,
2665			    const char *buf, size_t count)
2666{
2667	unsigned long t;
2668	int res;
2669
2670	if (parse_strtoul(buf, 0xffffffffUL, &t))
2671		return -EINVAL;
2672
2673	if (mutex_lock_killable(&hotkey_mutex))
2674		return -ERESTARTSYS;
2675
2676	res = hotkey_user_mask_set(t);
2677
2678#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2679	hotkey_poll_setup(true);
2680#endif
2681
2682	mutex_unlock(&hotkey_mutex);
2683
2684	tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2685
2686	return (res) ? res : count;
2687}
2688
2689static struct device_attribute dev_attr_hotkey_mask =
2690	__ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2691		hotkey_mask_show, hotkey_mask_store);
2692
2693/* sysfs hotkey bios_enabled ------------------------------------------- */
2694static ssize_t hotkey_bios_enabled_show(struct device *dev,
2695			   struct device_attribute *attr,
2696			   char *buf)
2697{
2698	return sprintf(buf, "0\n");
2699}
2700
2701static struct device_attribute dev_attr_hotkey_bios_enabled =
2702	__ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2703
2704/* sysfs hotkey bios_mask ---------------------------------------------- */
2705static ssize_t hotkey_bios_mask_show(struct device *dev,
2706			   struct device_attribute *attr,
2707			   char *buf)
2708{
2709	printk_deprecated_attribute("hotkey_bios_mask",
2710			"This attribute is useless.");
2711	return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2712}
2713
2714static struct device_attribute dev_attr_hotkey_bios_mask =
2715	__ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2716
2717/* sysfs hotkey all_mask ----------------------------------------------- */
2718static ssize_t hotkey_all_mask_show(struct device *dev,
2719			   struct device_attribute *attr,
2720			   char *buf)
2721{
2722	return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2723				hotkey_all_mask | hotkey_source_mask);
2724}
2725
2726static struct device_attribute dev_attr_hotkey_all_mask =
2727	__ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2728
2729/* sysfs hotkey recommended_mask --------------------------------------- */
2730static ssize_t hotkey_recommended_mask_show(struct device *dev,
2731					    struct device_attribute *attr,
2732					    char *buf)
2733{
2734	return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2735			(hotkey_all_mask | hotkey_source_mask)
2736			& ~hotkey_reserved_mask);
2737}
2738
2739static struct device_attribute dev_attr_hotkey_recommended_mask =
2740	__ATTR(hotkey_recommended_mask, S_IRUGO,
2741		hotkey_recommended_mask_show, NULL);
2742
2743#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2744
2745/* sysfs hotkey hotkey_source_mask ------------------------------------- */
2746static ssize_t hotkey_source_mask_show(struct device *dev,
2747			   struct device_attribute *attr,
2748			   char *buf)
2749{
2750	return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2751}
2752
2753static ssize_t hotkey_source_mask_store(struct device *dev,
2754			    struct device_attribute *attr,
2755			    const char *buf, size_t count)
2756{
2757	unsigned long t;
2758	u32 r_ev;
2759	int rc;
2760
2761	if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2762		((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2763		return -EINVAL;
2764
2765	if (mutex_lock_killable(&hotkey_mutex))
2766		return -ERESTARTSYS;
2767
2768	HOTKEY_CONFIG_CRITICAL_START
2769	hotkey_source_mask = t;
2770	HOTKEY_CONFIG_CRITICAL_END
2771
2772	rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2773			~hotkey_source_mask);
2774	hotkey_poll_setup(true);
2775
2776	/* check if events needed by the driver got disabled */
2777	r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2778		& ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2779
2780	mutex_unlock(&hotkey_mutex);
2781
2782	if (rc < 0)
2783		pr_err("hotkey_source_mask: "
2784		       "failed to update the firmware event mask!\n");
2785
2786	if (r_ev)
2787		pr_notice("hotkey_source_mask: "
2788			  "some important events were disabled: 0x%04x\n",
2789			  r_ev);
2790
2791	tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2792
2793	return (rc < 0) ? rc : count;
2794}
2795
2796static struct device_attribute dev_attr_hotkey_source_mask =
2797	__ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2798		hotkey_source_mask_show, hotkey_source_mask_store);
2799
2800/* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2801static ssize_t hotkey_poll_freq_show(struct device *dev,
2802			   struct device_attribute *attr,
2803			   char *buf)
2804{
2805	return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2806}
2807
2808static ssize_t hotkey_poll_freq_store(struct device *dev,
2809			    struct device_attribute *attr,
2810			    const char *buf, size_t count)
2811{
2812	unsigned long t;
2813
2814	if (parse_strtoul(buf, 25, &t))
2815		return -EINVAL;
2816
2817	if (mutex_lock_killable(&hotkey_mutex))
2818		return -ERESTARTSYS;
2819
2820	hotkey_poll_set_freq(t);
2821	hotkey_poll_setup(true);
2822
2823	mutex_unlock(&hotkey_mutex);
2824
2825	tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2826
2827	return count;
2828}
2829
2830static struct device_attribute dev_attr_hotkey_poll_freq =
2831	__ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2832		hotkey_poll_freq_show, hotkey_poll_freq_store);
2833
2834#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2835
2836/* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2837static ssize_t hotkey_radio_sw_show(struct device *dev,
2838			   struct device_attribute *attr,
2839			   char *buf)
2840{
2841	int res;
2842	res = hotkey_get_wlsw();
2843	if (res < 0)
2844		return res;
2845
2846	/* Opportunistic update */
2847	tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2848
2849	return snprintf(buf, PAGE_SIZE, "%d\n",
2850			(res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2851}
2852
2853static struct device_attribute dev_attr_hotkey_radio_sw =
2854	__ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2855
2856static void hotkey_radio_sw_notify_change(void)
2857{
2858	if (tp_features.hotkey_wlsw)
2859		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2860			     "hotkey_radio_sw");
2861}
2862
2863/* sysfs hotkey tablet mode (pollable) --------------------------------- */
2864static ssize_t hotkey_tablet_mode_show(struct device *dev,
2865			   struct device_attribute *attr,
2866			   char *buf)
2867{
2868	int res, s;
2869	res = hotkey_get_tablet_mode(&s);
2870	if (res < 0)
2871		return res;
2872
2873	return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2874}
2875
2876static struct device_attribute dev_attr_hotkey_tablet_mode =
2877	__ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2878
2879static void hotkey_tablet_mode_notify_change(void)
2880{
2881	if (tp_features.hotkey_tablet)
2882		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2883			     "hotkey_tablet_mode");
2884}
2885
 
 
 
 
 
 
 
 
 
 
 
 
2886/* sysfs wakeup reason (pollable) -------------------------------------- */
2887static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2888			   struct device_attribute *attr,
2889			   char *buf)
2890{
2891	return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2892}
2893
2894static struct device_attribute dev_attr_hotkey_wakeup_reason =
2895	__ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2896
2897static void hotkey_wakeup_reason_notify_change(void)
2898{
2899	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2900		     "wakeup_reason");
2901}
2902
2903/* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2904static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2905			   struct device_attribute *attr,
2906			   char *buf)
2907{
2908	return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2909}
2910
2911static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2912	__ATTR(wakeup_hotunplug_complete, S_IRUGO,
2913	       hotkey_wakeup_hotunplug_complete_show, NULL);
2914
2915static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2916{
2917	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2918		     "wakeup_hotunplug_complete");
2919}
2920
2921/* --------------------------------------------------------------------- */
2922
2923static struct attribute *hotkey_attributes[] __initdata = {
2924	&dev_attr_hotkey_enable.attr,
2925	&dev_attr_hotkey_bios_enabled.attr,
2926	&dev_attr_hotkey_bios_mask.attr,
 
2927	&dev_attr_hotkey_wakeup_reason.attr,
2928	&dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2929	&dev_attr_hotkey_mask.attr,
2930	&dev_attr_hotkey_all_mask.attr,
2931	&dev_attr_hotkey_recommended_mask.attr,
2932#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2933	&dev_attr_hotkey_source_mask.attr,
2934	&dev_attr_hotkey_poll_freq.attr,
2935#endif
2936};
2937
2938/*
2939 * Sync both the hw and sw blocking state of all switches
2940 */
2941static void tpacpi_send_radiosw_update(void)
2942{
2943	int wlsw;
2944
2945	/*
2946	 * We must sync all rfkill controllers *before* issuing any
2947	 * rfkill input events, or we will race the rfkill core input
2948	 * handler.
2949	 *
2950	 * tpacpi_inputdev_send_mutex works as a synchronization point
2951	 * for the above.
2952	 *
2953	 * We optimize to avoid numerous calls to hotkey_get_wlsw.
2954	 */
2955
2956	wlsw = hotkey_get_wlsw();
2957
2958	/* Sync hw blocking state first if it is hw-blocked */
2959	if (wlsw == TPACPI_RFK_RADIO_OFF)
2960		tpacpi_rfk_update_hwblock_state(true);
2961
2962	/* Sync sw blocking state */
2963	tpacpi_rfk_update_swstate_all();
2964
2965	/* Sync hw blocking state last if it is hw-unblocked */
2966	if (wlsw == TPACPI_RFK_RADIO_ON)
2967		tpacpi_rfk_update_hwblock_state(false);
2968
2969	/* Issue rfkill input event for WLSW switch */
2970	if (!(wlsw < 0)) {
2971		mutex_lock(&tpacpi_inputdev_send_mutex);
2972
2973		input_report_switch(tpacpi_inputdev,
2974				    SW_RFKILL_ALL, (wlsw > 0));
2975		input_sync(tpacpi_inputdev);
2976
2977		mutex_unlock(&tpacpi_inputdev_send_mutex);
2978	}
2979
2980	/*
2981	 * this can be unconditional, as we will poll state again
2982	 * if userspace uses the notify to read data
2983	 */
2984	hotkey_radio_sw_notify_change();
2985}
2986
2987static void hotkey_exit(void)
2988{
2989#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2990	mutex_lock(&hotkey_mutex);
2991	hotkey_poll_stop_sync();
2992	mutex_unlock(&hotkey_mutex);
2993#endif
2994
2995	if (hotkey_dev_attributes)
2996		delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
2997
 
 
2998	dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
2999		   "restoring original HKEY status and mask\n");
3000	/* yes, there is a bitwise or below, we want the
3001	 * functions to be called even if one of them fail */
3002	if (((tp_features.hotkey_mask &&
3003	      hotkey_mask_set(hotkey_orig_mask)) |
3004	     hotkey_status_set(false)) != 0)
3005		pr_err("failed to restore hot key mask "
3006		       "to BIOS defaults\n");
3007}
3008
3009static void __init hotkey_unmap(const unsigned int scancode)
3010{
3011	if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3012		clear_bit(hotkey_keycode_map[scancode],
3013			  tpacpi_inputdev->keybit);
3014		hotkey_keycode_map[scancode] = KEY_RESERVED;
3015	}
3016}
3017
3018/*
3019 * HKEY quirks:
3020 *   TPACPI_HK_Q_INIMASK:	Supports FN+F3,FN+F4,FN+F12
3021 */
3022
3023#define	TPACPI_HK_Q_INIMASK	0x0001
3024
3025static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3026	TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3027	TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3028	TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3029	TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3030	TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3031	TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3032	TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3033	TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3034	TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3035	TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3036	TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3037	TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3038	TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3039	TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3040	TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3041	TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3042	TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3043	TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3044	TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3045};
3046
3047typedef u16 tpacpi_keymap_entry_t;
3048typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3049
3050static int __init hotkey_init(struct ibm_init_struct *iibm)
3051{
3052	/* Requirements for changing the default keymaps:
3053	 *
3054	 * 1. Many of the keys are mapped to KEY_RESERVED for very
3055	 *    good reasons.  Do not change them unless you have deep
3056	 *    knowledge on the IBM and Lenovo ThinkPad firmware for
3057	 *    the various ThinkPad models.  The driver behaves
3058	 *    differently for KEY_RESERVED: such keys have their
3059	 *    hot key mask *unset* in mask_recommended, and also
3060	 *    in the initial hot key mask programmed into the
3061	 *    firmware at driver load time, which means the firm-
3062	 *    ware may react very differently if you change them to
3063	 *    something else;
3064	 *
3065	 * 2. You must be subscribed to the linux-thinkpad and
3066	 *    ibm-acpi-devel mailing lists, and you should read the
3067	 *    list archives since 2007 if you want to change the
3068	 *    keymaps.  This requirement exists so that you will
3069	 *    know the past history of problems with the thinkpad-
3070	 *    acpi driver keymaps, and also that you will be
3071	 *    listening to any bug reports;
3072	 *
3073	 * 3. Do not send thinkpad-acpi specific patches directly to
3074	 *    for merging, *ever*.  Send them to the linux-acpi
3075	 *    mailinglist for comments.  Merging is to be done only
3076	 *    through acpi-test and the ACPI maintainer.
3077	 *
3078	 * If the above is too much to ask, don't change the keymap.
3079	 * Ask the thinkpad-acpi maintainer to do it, instead.
3080	 */
3081
3082	enum keymap_index {
3083		TPACPI_KEYMAP_IBM_GENERIC = 0,
3084		TPACPI_KEYMAP_LENOVO_GENERIC,
3085	};
3086
3087	static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3088	/* Generic keymap for IBM ThinkPads */
3089	[TPACPI_KEYMAP_IBM_GENERIC] = {
3090		/* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3091		KEY_FN_F1,	KEY_BATTERY,	KEY_COFFEE,	KEY_SLEEP,
3092		KEY_WLAN,	KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3093		KEY_FN_F9,	KEY_FN_F10,	KEY_FN_F11,	KEY_SUSPEND,
3094
3095		/* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3096		KEY_UNKNOWN,	/* 0x0C: FN+BACKSPACE */
3097		KEY_UNKNOWN,	/* 0x0D: FN+INSERT */
3098		KEY_UNKNOWN,	/* 0x0E: FN+DELETE */
3099
3100		/* brightness: firmware always reacts to them */
3101		KEY_RESERVED,	/* 0x0F: FN+HOME (brightness up) */
3102		KEY_RESERVED,	/* 0x10: FN+END (brightness down) */
3103
3104		/* Thinklight: firmware always react to it */
3105		KEY_RESERVED,	/* 0x11: FN+PGUP (thinklight toggle) */
3106
3107		KEY_UNKNOWN,	/* 0x12: FN+PGDOWN */
3108		KEY_ZOOM,	/* 0x13: FN+SPACE (zoom) */
3109
3110		/* Volume: firmware always react to it and reprograms
3111		 * the built-in *extra* mixer.  Never map it to control
3112		 * another mixer by default. */
3113		KEY_RESERVED,	/* 0x14: VOLUME UP */
3114		KEY_RESERVED,	/* 0x15: VOLUME DOWN */
3115		KEY_RESERVED,	/* 0x16: MUTE */
3116
3117		KEY_VENDOR,	/* 0x17: Thinkpad/AccessIBM/Lenovo */
3118
3119		/* (assignments unknown, please report if found) */
3120		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3121		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3122		},
3123
3124	/* Generic keymap for Lenovo ThinkPads */
3125	[TPACPI_KEYMAP_LENOVO_GENERIC] = {
3126		/* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3127		KEY_FN_F1,	KEY_COFFEE,	KEY_BATTERY,	KEY_SLEEP,
3128		KEY_WLAN,	KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3129		KEY_FN_F9,	KEY_FN_F10,	KEY_FN_F11,	KEY_SUSPEND,
3130
3131		/* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3132		KEY_UNKNOWN,	/* 0x0C: FN+BACKSPACE */
3133		KEY_UNKNOWN,	/* 0x0D: FN+INSERT */
3134		KEY_UNKNOWN,	/* 0x0E: FN+DELETE */
3135
3136		/* These should be enabled --only-- when ACPI video
3137		 * is disabled (i.e. in "vendor" mode), and are handled
3138		 * in a special way by the init code */
3139		KEY_BRIGHTNESSUP,	/* 0x0F: FN+HOME (brightness up) */
3140		KEY_BRIGHTNESSDOWN,	/* 0x10: FN+END (brightness down) */
3141
3142		KEY_RESERVED,	/* 0x11: FN+PGUP (thinklight toggle) */
3143
3144		KEY_UNKNOWN,	/* 0x12: FN+PGDOWN */
3145		KEY_ZOOM,	/* 0x13: FN+SPACE (zoom) */
3146
3147		/* Volume: z60/z61, T60 (BIOS version?): firmware always
3148		 * react to it and reprograms the built-in *extra* mixer.
3149		 * Never map it to control another mixer by default.
3150		 *
3151		 * T60?, T61, R60?, R61: firmware and EC tries to send
3152		 * these over the regular keyboard, so these are no-ops,
3153		 * but there are still weird bugs re. MUTE, so do not
3154		 * change unless you get test reports from all Lenovo
3155		 * models.  May cause the BIOS to interfere with the
3156		 * HDA mixer.
3157		 */
3158		KEY_RESERVED,	/* 0x14: VOLUME UP */
3159		KEY_RESERVED,	/* 0x15: VOLUME DOWN */
3160		KEY_RESERVED,	/* 0x16: MUTE */
3161
3162		KEY_VENDOR,	/* 0x17: Thinkpad/AccessIBM/Lenovo */
3163
3164		/* (assignments unknown, please report if found) */
3165		KEY_UNKNOWN, KEY_UNKNOWN,
3166
3167		/*
3168		 * The mic mute button only sends 0x1a.  It does not
3169		 * automatically mute the mic or change the mute light.
3170		 */
3171		KEY_MICMUTE,	/* 0x1a: Mic mute (since ?400 or so) */
3172
3173		/* (assignments unknown, please report if found) */
3174		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3175		KEY_UNKNOWN,
3176		},
3177	};
3178
3179	static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3180		/* Generic maps (fallback) */
3181		{
3182		  .vendor = PCI_VENDOR_ID_IBM,
3183		  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3184		  .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3185		},
3186		{
3187		  .vendor = PCI_VENDOR_ID_LENOVO,
3188		  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3189		  .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3190		},
3191	};
3192
3193#define TPACPI_HOTKEY_MAP_SIZE		sizeof(tpacpi_keymap_t)
3194#define TPACPI_HOTKEY_MAP_TYPESIZE	sizeof(tpacpi_keymap_entry_t)
3195
3196	int res, i;
3197	int status;
3198	int hkeyv;
3199	bool radiosw_state  = false;
3200	bool tabletsw_state = false;
3201
3202	unsigned long quirks;
3203	unsigned long keymap_id;
3204
3205	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3206			"initializing hotkey subdriver\n");
3207
3208	BUG_ON(!tpacpi_inputdev);
3209	BUG_ON(tpacpi_inputdev->open != NULL ||
3210	       tpacpi_inputdev->close != NULL);
3211
3212	TPACPI_ACPIHANDLE_INIT(hkey);
3213	mutex_init(&hotkey_mutex);
3214
3215#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
 
3216	mutex_init(&hotkey_thread_data_mutex);
3217#endif
3218
3219	/* hotkey not supported on 570 */
3220	tp_features.hotkey = hkey_handle != NULL;
3221
3222	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3223		"hotkeys are %s\n",
3224		str_supported(tp_features.hotkey));
3225
3226	if (!tp_features.hotkey)
3227		return 1;
3228
3229	quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3230				     ARRAY_SIZE(tpacpi_hotkey_qtable));
3231
3232	tpacpi_disable_brightness_delay();
3233
3234	/* MUST have enough space for all attributes to be added to
3235	 * hotkey_dev_attributes */
3236	hotkey_dev_attributes = create_attr_set(
3237					ARRAY_SIZE(hotkey_attributes) + 2,
3238					NULL);
3239	if (!hotkey_dev_attributes)
3240		return -ENOMEM;
3241	res = add_many_to_attr_set(hotkey_dev_attributes,
3242			hotkey_attributes,
3243			ARRAY_SIZE(hotkey_attributes));
3244	if (res)
3245		goto err_exit;
3246
3247	/* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3248	   A30, R30, R31, T20-22, X20-21, X22-24.  Detected by checking
3249	   for HKEY interface version 0x100 */
3250	if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3251		if ((hkeyv >> 8) != 1) {
3252			pr_err("unknown version of the HKEY interface: 0x%x\n",
3253			       hkeyv);
3254			pr_err("please report this to %s\n", TPACPI_MAIL);
3255		} else {
3256			/*
3257			 * MHKV 0x100 in A31, R40, R40e,
3258			 * T4x, X31, and later
3259			 */
3260			vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3261				"firmware HKEY interface version: 0x%x\n",
3262				hkeyv);
3263
3264			/* Paranoia check AND init hotkey_all_mask */
3265			if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3266					"MHKA", "qd")) {
3267				pr_err("missing MHKA handler, "
3268				       "please report this to %s\n",
3269				       TPACPI_MAIL);
3270				/* Fallback: pre-init for FN+F3,F4,F12 */
3271				hotkey_all_mask = 0x080cU;
3272			} else {
3273				tp_features.hotkey_mask = 1;
3274			}
3275		}
3276	}
3277
3278	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3279		"hotkey masks are %s\n",
3280		str_supported(tp_features.hotkey_mask));
3281
3282	/* Init hotkey_all_mask if not initialized yet */
3283	if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3284	    (quirks & TPACPI_HK_Q_INIMASK))
3285		hotkey_all_mask = 0x080cU;  /* FN+F12, FN+F4, FN+F3 */
3286
3287	/* Init hotkey_acpi_mask and hotkey_orig_mask */
3288	if (tp_features.hotkey_mask) {
3289		/* hotkey_source_mask *must* be zero for
3290		 * the first hotkey_mask_get to return hotkey_orig_mask */
3291		res = hotkey_mask_get();
3292		if (res)
3293			goto err_exit;
3294
3295		hotkey_orig_mask = hotkey_acpi_mask;
3296	} else {
3297		hotkey_orig_mask = hotkey_all_mask;
3298		hotkey_acpi_mask = hotkey_all_mask;
3299	}
3300
3301#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3302	if (dbg_wlswemul) {
3303		tp_features.hotkey_wlsw = 1;
3304		radiosw_state = !!tpacpi_wlsw_emulstate;
3305		pr_info("radio switch emulation enabled\n");
3306	} else
3307#endif
3308	/* Not all thinkpads have a hardware radio switch */
3309	if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3310		tp_features.hotkey_wlsw = 1;
3311		radiosw_state = !!status;
3312		pr_info("radio switch found; radios are %s\n",
3313			enabled(status, 0));
3314	}
3315	if (tp_features.hotkey_wlsw)
3316		res = add_to_attr_set(hotkey_dev_attributes,
3317				&dev_attr_hotkey_radio_sw.attr);
3318
3319	/* For X41t, X60t, X61t Tablets... */
3320	if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3321		tp_features.hotkey_tablet = 1;
3322		tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3323		pr_info("possible tablet mode switch found; "
3324			"ThinkPad in %s mode\n",
3325			(tabletsw_state) ? "tablet" : "laptop");
3326		res = add_to_attr_set(hotkey_dev_attributes,
3327				&dev_attr_hotkey_tablet_mode.attr);
3328	}
3329
3330	if (!res)
3331		res = register_attr_set_with_sysfs(
3332				hotkey_dev_attributes,
3333				&tpacpi_pdev->dev.kobj);
3334	if (res)
3335		goto err_exit;
3336
3337	/* Set up key map */
3338	hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3339					GFP_KERNEL);
3340	if (!hotkey_keycode_map) {
3341		pr_err("failed to allocate memory for key map\n");
3342		res = -ENOMEM;
3343		goto err_exit;
3344	}
3345
3346	keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3347					ARRAY_SIZE(tpacpi_keymap_qtable));
3348	BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3349	dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3350		   "using keymap number %lu\n", keymap_id);
3351
3352	memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3353		TPACPI_HOTKEY_MAP_SIZE);
3354
3355	input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3356	tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3357	tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3358	tpacpi_inputdev->keycode = hotkey_keycode_map;
3359	for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3360		if (hotkey_keycode_map[i] != KEY_RESERVED) {
3361			input_set_capability(tpacpi_inputdev, EV_KEY,
3362						hotkey_keycode_map[i]);
3363		} else {
3364			if (i < sizeof(hotkey_reserved_mask)*8)
3365				hotkey_reserved_mask |= 1 << i;
3366		}
3367	}
3368
3369	if (tp_features.hotkey_wlsw) {
3370		input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3371		input_report_switch(tpacpi_inputdev,
3372				    SW_RFKILL_ALL, radiosw_state);
3373	}
3374	if (tp_features.hotkey_tablet) {
3375		input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3376		input_report_switch(tpacpi_inputdev,
3377				    SW_TABLET_MODE, tabletsw_state);
3378	}
3379
3380	/* Do not issue duplicate brightness change events to
3381	 * userspace. tpacpi_detect_brightness_capabilities() must have
3382	 * been called before this point  */
3383	if (acpi_video_backlight_support()) {
3384		pr_info("This ThinkPad has standard ACPI backlight "
3385			"brightness control, supported by the ACPI "
3386			"video driver\n");
3387		pr_notice("Disabling thinkpad-acpi brightness events "
3388			  "by default...\n");
3389
3390		/* Disable brightness up/down on Lenovo thinkpads when
3391		 * ACPI is handling them, otherwise it is plain impossible
3392		 * for userspace to do something even remotely sane */
3393		hotkey_reserved_mask |=
3394			(1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3395			| (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3396		hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3397		hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3398	}
3399
3400#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3401	hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3402				& ~hotkey_all_mask
3403				& ~hotkey_reserved_mask;
3404
3405	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3406		    "hotkey source mask 0x%08x, polling freq %u\n",
3407		    hotkey_source_mask, hotkey_poll_freq);
3408#endif
3409
3410	dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3411			"enabling firmware HKEY event interface...\n");
3412	res = hotkey_status_set(true);
3413	if (res) {
3414		hotkey_exit();
3415		return res;
3416	}
3417	res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3418			       | hotkey_driver_mask)
3419			      & ~hotkey_source_mask);
3420	if (res < 0 && res != -ENXIO) {
3421		hotkey_exit();
3422		return res;
3423	}
3424	hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3425				& ~hotkey_reserved_mask;
3426	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3427		"initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3428		hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3429
 
 
 
 
 
3430	tpacpi_inputdev->open = &hotkey_inputdev_open;
3431	tpacpi_inputdev->close = &hotkey_inputdev_close;
3432
3433	hotkey_poll_setup_safe(true);
3434
3435	return 0;
3436
3437err_exit:
3438	delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3439	hotkey_dev_attributes = NULL;
3440
3441	return (res < 0)? res : 1;
3442}
3443
3444/* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3445 * mode, Web conference mode, Function mode and Lay-flat mode.
3446 * We support Home mode and Function mode currently.
3447 *
3448 * Will consider support rest of modes in future.
3449 *
3450 */
3451enum ADAPTIVE_KEY_MODE {
3452	HOME_MODE,
3453	WEB_BROWSER_MODE,
3454	WEB_CONFERENCE_MODE,
3455	FUNCTION_MODE,
3456	LAYFLAT_MODE
3457};
3458
3459const int adaptive_keyboard_modes[] = {
3460	HOME_MODE,
3461/*	WEB_BROWSER_MODE = 2,
3462	WEB_CONFERENCE_MODE = 3, */
3463	FUNCTION_MODE
3464};
3465
3466#define DFR_CHANGE_ROW			0x101
3467#define DFR_SHOW_QUICKVIEW_ROW		0x102
3468
3469/* press Fn key a while second, it will switch to Function Mode. Then
3470 * release Fn key, previous mode be restored.
3471 */
3472static bool adaptive_keyboard_mode_is_saved;
3473static int adaptive_keyboard_prev_mode;
3474
3475static int adaptive_keyboard_get_next_mode(int mode)
3476{
3477	size_t i;
3478	size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3479
3480	for (i = 0; i <= max_mode; i++) {
3481		if (adaptive_keyboard_modes[i] == mode)
3482			break;
3483	}
3484
3485	if (i >= max_mode)
3486		i = 0;
3487	else
3488		i++;
3489
3490	return adaptive_keyboard_modes[i];
3491}
3492
3493static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3494{
3495	u32 current_mode = 0;
3496	int new_mode = 0;
3497
3498	switch (scancode) {
3499	case DFR_CHANGE_ROW:
3500		if (adaptive_keyboard_mode_is_saved) {
3501			new_mode = adaptive_keyboard_prev_mode;
3502			adaptive_keyboard_mode_is_saved = false;
3503		} else {
3504			if (!acpi_evalf(
3505					hkey_handle, &current_mode,
3506					"GTRW", "dd", 0)) {
3507				pr_err("Cannot read adaptive keyboard mode\n");
3508				return false;
3509			} else {
3510				new_mode = adaptive_keyboard_get_next_mode(
3511						current_mode);
3512			}
3513		}
3514
3515		if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3516			pr_err("Cannot set adaptive keyboard mode\n");
3517			return false;
3518		}
3519
3520		return true;
3521
3522	case DFR_SHOW_QUICKVIEW_ROW:
3523		if (!acpi_evalf(hkey_handle,
3524				&adaptive_keyboard_prev_mode,
3525				"GTRW", "dd", 0)) {
3526			pr_err("Cannot read adaptive keyboard mode\n");
3527			return false;
3528		} else {
3529			adaptive_keyboard_mode_is_saved = true;
3530
3531			if (!acpi_evalf(hkey_handle,
3532					NULL, "STRW", "vd", FUNCTION_MODE)) {
3533				pr_err("Cannot set adaptive keyboard mode\n");
3534				return false;
3535			}
3536		}
3537		return true;
3538
3539	default:
3540		return false;
3541	}
3542}
3543
3544static bool hotkey_notify_hotkey(const u32 hkey,
3545				 bool *send_acpi_ev,
3546				 bool *ignore_acpi_ev)
3547{
3548	/* 0x1000-0x1FFF: key presses */
3549	unsigned int scancode = hkey & 0xfff;
3550	*send_acpi_ev = true;
3551	*ignore_acpi_ev = false;
3552
3553	/* HKEY event 0x1001 is scancode 0x00 */
3554	if (scancode > 0 && scancode <= TPACPI_HOTKEY_MAP_LEN) {
3555		scancode--;
3556		if (!(hotkey_source_mask & (1 << scancode))) {
3557			tpacpi_input_send_key_masked(scancode);
3558			*send_acpi_ev = false;
3559		} else {
3560			*ignore_acpi_ev = true;
3561		}
3562		return true;
3563	} else {
3564		return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3565	}
3566	return false;
3567}
3568
3569static bool hotkey_notify_wakeup(const u32 hkey,
3570				 bool *send_acpi_ev,
3571				 bool *ignore_acpi_ev)
3572{
3573	/* 0x2000-0x2FFF: Wakeup reason */
3574	*send_acpi_ev = true;
3575	*ignore_acpi_ev = false;
3576
3577	switch (hkey) {
3578	case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3579	case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3580		hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3581		*ignore_acpi_ev = true;
3582		break;
3583
3584	case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3585	case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3586		hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3587		*ignore_acpi_ev = true;
3588		break;
3589
3590	case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3591	case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3592		pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3593		/* how to auto-heal: */
3594		/* 2313: woke up from S3, go to S4/S5 */
3595		/* 2413: woke up from S4, go to S5 */
3596		break;
3597
3598	default:
3599		return false;
3600	}
3601
3602	if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3603		pr_info("woke up due to a hot-unplug request...\n");
3604		hotkey_wakeup_reason_notify_change();
3605	}
3606	return true;
3607}
3608
3609static bool hotkey_notify_dockevent(const u32 hkey,
3610				 bool *send_acpi_ev,
3611				 bool *ignore_acpi_ev)
3612{
3613	/* 0x4000-0x4FFF: dock-related events */
3614	*send_acpi_ev = true;
3615	*ignore_acpi_ev = false;
3616
3617	switch (hkey) {
3618	case TP_HKEY_EV_UNDOCK_ACK:
3619		/* ACPI undock operation completed after wakeup */
3620		hotkey_autosleep_ack = 1;
3621		pr_info("undocked\n");
3622		hotkey_wakeup_hotunplug_complete_notify_change();
3623		return true;
3624
3625	case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3626		pr_info("docked into hotplug port replicator\n");
3627		return true;
3628	case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3629		pr_info("undocked from hotplug port replicator\n");
3630		return true;
3631
3632	default:
3633		return false;
3634	}
3635}
3636
3637static bool hotkey_notify_usrevent(const u32 hkey,
3638				 bool *send_acpi_ev,
3639				 bool *ignore_acpi_ev)
3640{
3641	/* 0x5000-0x5FFF: human interface helpers */
3642	*send_acpi_ev = true;
3643	*ignore_acpi_ev = false;
3644
3645	switch (hkey) {
3646	case TP_HKEY_EV_PEN_INSERTED:  /* X61t: tablet pen inserted into bay */
3647	case TP_HKEY_EV_PEN_REMOVED:   /* X61t: tablet pen removed from bay */
3648		return true;
3649
3650	case TP_HKEY_EV_TABLET_TABLET:   /* X41t-X61t: tablet mode */
3651	case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3652		tpacpi_input_send_tabletsw();
3653		hotkey_tablet_mode_notify_change();
3654		*send_acpi_ev = false;
3655		return true;
3656
3657	case TP_HKEY_EV_LID_CLOSE:	/* Lid closed */
3658	case TP_HKEY_EV_LID_OPEN:	/* Lid opened */
3659	case TP_HKEY_EV_BRGHT_CHANGED:	/* brightness changed */
3660		/* do not propagate these events */
3661		*ignore_acpi_ev = true;
3662		return true;
3663
3664	default:
3665		return false;
3666	}
3667}
3668
3669static void thermal_dump_all_sensors(void);
3670
3671static bool hotkey_notify_6xxx(const u32 hkey,
3672				 bool *send_acpi_ev,
3673				 bool *ignore_acpi_ev)
3674{
3675	bool known = true;
3676
3677	/* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
3678	*send_acpi_ev = true;
3679	*ignore_acpi_ev = false;
3680
3681	switch (hkey) {
3682	case TP_HKEY_EV_THM_TABLE_CHANGED:
3683		pr_info("EC reports that Thermal Table has changed\n");
3684		/* recommended action: do nothing, we don't have
3685		 * Lenovo ATM information */
3686		return true;
3687	case TP_HKEY_EV_ALARM_BAT_HOT:
3688		pr_crit("THERMAL ALARM: battery is too hot!\n");
3689		/* recommended action: warn user through gui */
3690		break;
3691	case TP_HKEY_EV_ALARM_BAT_XHOT:
3692		pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
3693		/* recommended action: immediate sleep/hibernate */
3694		break;
3695	case TP_HKEY_EV_ALARM_SENSOR_HOT:
3696		pr_crit("THERMAL ALARM: "
3697			"a sensor reports something is too hot!\n");
3698		/* recommended action: warn user through gui, that */
3699		/* some internal component is too hot */
3700		break;
3701	case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3702		pr_alert("THERMAL EMERGENCY: "
3703			 "a sensor reports something is extremely hot!\n");
3704		/* recommended action: immediate sleep/hibernate */
3705		break;
3706	case TP_HKEY_EV_AC_CHANGED:
3707		/* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
3708		 * AC status changed; can be triggered by plugging or
3709		 * unplugging AC adapter, docking or undocking. */
3710
3711		/* fallthrough */
3712
3713	case TP_HKEY_EV_KEY_NUMLOCK:
3714	case TP_HKEY_EV_KEY_FN:
3715		/* key press events, we just ignore them as long as the EC
3716		 * is still reporting them in the normal keyboard stream */
3717		*send_acpi_ev = false;
3718		*ignore_acpi_ev = true;
3719		return true;
3720
3721	default:
3722		pr_warn("unknown possible thermal alarm or keyboard event received\n");
3723		known = false;
3724	}
3725
3726	thermal_dump_all_sensors();
3727
3728	return known;
3729}
3730
3731static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3732{
3733	u32 hkey;
3734	bool send_acpi_ev;
3735	bool ignore_acpi_ev;
3736	bool known_ev;
3737
3738	if (event != 0x80) {
3739		pr_err("unknown HKEY notification event %d\n", event);
3740		/* forward it to userspace, maybe it knows how to handle it */
3741		acpi_bus_generate_netlink_event(
3742					ibm->acpi->device->pnp.device_class,
3743					dev_name(&ibm->acpi->device->dev),
3744					event, 0);
3745		return;
3746	}
3747
3748	while (1) {
3749		if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3750			pr_err("failed to retrieve HKEY event\n");
3751			return;
3752		}
3753
3754		if (hkey == 0) {
3755			/* queue empty */
3756			return;
3757		}
3758
3759		send_acpi_ev = true;
3760		ignore_acpi_ev = false;
3761
3762		switch (hkey >> 12) {
3763		case 1:
3764			/* 0x1000-0x1FFF: key presses */
3765			known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3766						 &ignore_acpi_ev);
3767			break;
3768		case 2:
3769			/* 0x2000-0x2FFF: Wakeup reason */
3770			known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3771						 &ignore_acpi_ev);
3772			break;
3773		case 3:
3774			/* 0x3000-0x3FFF: bay-related wakeups */
3775			switch (hkey) {
3776			case TP_HKEY_EV_BAYEJ_ACK:
3777				hotkey_autosleep_ack = 1;
3778				pr_info("bay ejected\n");
3779				hotkey_wakeup_hotunplug_complete_notify_change();
3780				known_ev = true;
3781				break;
3782			case TP_HKEY_EV_OPTDRV_EJ:
3783				/* FIXME: kick libata if SATA link offline */
3784				known_ev = true;
3785				break;
3786			default:
3787				known_ev = false;
3788			}
3789			break;
3790		case 4:
3791			/* 0x4000-0x4FFF: dock-related events */
3792			known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
3793						&ignore_acpi_ev);
3794			break;
3795		case 5:
3796			/* 0x5000-0x5FFF: human interface helpers */
3797			known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3798						 &ignore_acpi_ev);
3799			break;
3800		case 6:
3801			/* 0x6000-0x6FFF: thermal alarms/notices and
3802			 *                keyboard events */
3803			known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
3804						 &ignore_acpi_ev);
3805			break;
3806		case 7:
3807			/* 0x7000-0x7FFF: misc */
3808			if (tp_features.hotkey_wlsw &&
3809					hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3810				tpacpi_send_radiosw_update();
3811				send_acpi_ev = 0;
3812				known_ev = true;
3813				break;
3814			}
3815			/* fallthrough to default */
3816		default:
3817			known_ev = false;
3818		}
3819		if (!known_ev) {
3820			pr_notice("unhandled HKEY event 0x%04x\n", hkey);
3821			pr_notice("please report the conditions when this "
3822				  "event happened to %s\n", TPACPI_MAIL);
3823		}
3824
 
 
 
 
 
 
 
3825		/* netlink events */
3826		if (!ignore_acpi_ev && send_acpi_ev) {
3827			acpi_bus_generate_netlink_event(
3828					ibm->acpi->device->pnp.device_class,
3829					dev_name(&ibm->acpi->device->dev),
3830					event, hkey);
3831		}
3832	}
3833}
3834
3835static void hotkey_suspend(void)
3836{
3837	int hkeyv;
3838
3839	/* Do these on suspend, we get the events on early resume! */
3840	hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3841	hotkey_autosleep_ack = 0;
3842
3843	/* save previous mode of adaptive keyboard of X1 Carbon */
3844	if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3845		if ((hkeyv >> 8) == 2) {
3846			if (!acpi_evalf(hkey_handle,
3847						&adaptive_keyboard_prev_mode,
3848						"GTRW", "dd", 0)) {
3849				pr_err("Cannot read adaptive keyboard mode.\n");
3850			}
3851		}
3852	}
3853}
3854
3855static void hotkey_resume(void)
3856{
3857	int hkeyv;
3858
3859	tpacpi_disable_brightness_delay();
3860
3861	if (hotkey_status_set(true) < 0 ||
3862	    hotkey_mask_set(hotkey_acpi_mask) < 0)
3863		pr_err("error while attempting to reset the event "
3864		       "firmware interface\n");
3865
3866	tpacpi_send_radiosw_update();
3867	hotkey_tablet_mode_notify_change();
3868	hotkey_wakeup_reason_notify_change();
3869	hotkey_wakeup_hotunplug_complete_notify_change();
3870	hotkey_poll_setup_safe(false);
3871
3872	/* restore previous mode of adapive keyboard of X1 Carbon */
3873	if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3874		if ((hkeyv >> 8) == 2) {
3875			if (!acpi_evalf(hkey_handle,
3876						NULL,
3877						"STRW", "vd",
3878						adaptive_keyboard_prev_mode)) {
3879				pr_err("Cannot set adaptive keyboard mode.\n");
3880			}
3881		}
3882	}
3883}
3884
3885/* procfs -------------------------------------------------------------- */
3886static int hotkey_read(struct seq_file *m)
3887{
3888	int res, status;
3889
3890	if (!tp_features.hotkey) {
3891		seq_printf(m, "status:\t\tnot supported\n");
3892		return 0;
3893	}
3894
3895	if (mutex_lock_killable(&hotkey_mutex))
3896		return -ERESTARTSYS;
3897	res = hotkey_status_get(&status);
3898	if (!res)
3899		res = hotkey_mask_get();
3900	mutex_unlock(&hotkey_mutex);
3901	if (res)
3902		return res;
3903
3904	seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3905	if (hotkey_all_mask) {
3906		seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3907		seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3908	} else {
3909		seq_printf(m, "mask:\t\tnot supported\n");
3910		seq_printf(m, "commands:\tenable, disable, reset\n");
3911	}
3912
3913	return 0;
3914}
3915
3916static void hotkey_enabledisable_warn(bool enable)
3917{
3918	tpacpi_log_usertask("procfs hotkey enable/disable");
3919	if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3920		  pr_fmt("hotkey enable/disable functionality has been "
3921			 "removed from the driver.  "
3922			 "Hotkeys are always enabled.\n")))
3923		pr_err("Please remove the hotkey=enable module "
3924		       "parameter, it is deprecated.  "
3925		       "Hotkeys are always enabled.\n");
3926}
3927
3928static int hotkey_write(char *buf)
3929{
3930	int res;
3931	u32 mask;
3932	char *cmd;
3933
3934	if (!tp_features.hotkey)
3935		return -ENODEV;
3936
3937	if (mutex_lock_killable(&hotkey_mutex))
3938		return -ERESTARTSYS;
3939
3940	mask = hotkey_user_mask;
3941
3942	res = 0;
3943	while ((cmd = next_cmd(&buf))) {
3944		if (strlencmp(cmd, "enable") == 0) {
3945			hotkey_enabledisable_warn(1);
3946		} else if (strlencmp(cmd, "disable") == 0) {
3947			hotkey_enabledisable_warn(0);
3948			res = -EPERM;
3949		} else if (strlencmp(cmd, "reset") == 0) {
3950			mask = (hotkey_all_mask | hotkey_source_mask)
3951				& ~hotkey_reserved_mask;
3952		} else if (sscanf(cmd, "0x%x", &mask) == 1) {
3953			/* mask set */
3954		} else if (sscanf(cmd, "%x", &mask) == 1) {
3955			/* mask set */
3956		} else {
3957			res = -EINVAL;
3958			goto errexit;
3959		}
3960	}
3961
3962	if (!res) {
3963		tpacpi_disclose_usertask("procfs hotkey",
3964			"set mask to 0x%08x\n", mask);
3965		res = hotkey_user_mask_set(mask);
3966	}
3967
3968errexit:
3969	mutex_unlock(&hotkey_mutex);
3970	return res;
3971}
3972
3973static const struct acpi_device_id ibm_htk_device_ids[] = {
3974	{TPACPI_ACPI_IBM_HKEY_HID, 0},
3975	{TPACPI_ACPI_LENOVO_HKEY_HID, 0},
3976	{"", 0},
3977};
3978
3979static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3980	.hid = ibm_htk_device_ids,
3981	.notify = hotkey_notify,
3982	.handle = &hkey_handle,
3983	.type = ACPI_DEVICE_NOTIFY,
3984};
3985
3986static struct ibm_struct hotkey_driver_data = {
3987	.name = "hotkey",
3988	.read = hotkey_read,
3989	.write = hotkey_write,
3990	.exit = hotkey_exit,
3991	.resume = hotkey_resume,
3992	.suspend = hotkey_suspend,
3993	.acpi = &ibm_hotkey_acpidriver,
3994};
3995
3996/*************************************************************************
3997 * Bluetooth subdriver
3998 */
3999
4000enum {
4001	/* ACPI GBDC/SBDC bits */
4002	TP_ACPI_BLUETOOTH_HWPRESENT	= 0x01,	/* Bluetooth hw available */
4003	TP_ACPI_BLUETOOTH_RADIOSSW	= 0x02,	/* Bluetooth radio enabled */
4004	TP_ACPI_BLUETOOTH_RESUMECTRL	= 0x04,	/* Bluetooth state at resume:
4005						   0 = disable, 1 = enable */
4006};
4007
4008enum {
4009	/* ACPI \BLTH commands */
4010	TP_ACPI_BLTH_GET_ULTRAPORT_ID	= 0x00, /* Get Ultraport BT ID */
4011	TP_ACPI_BLTH_GET_PWR_ON_RESUME	= 0x01, /* Get power-on-resume state */
4012	TP_ACPI_BLTH_PWR_ON_ON_RESUME	= 0x02, /* Resume powered on */
4013	TP_ACPI_BLTH_PWR_OFF_ON_RESUME	= 0x03,	/* Resume powered off */
4014	TP_ACPI_BLTH_SAVE_STATE		= 0x05, /* Save state for S4/S5 */
4015};
4016
4017#define TPACPI_RFK_BLUETOOTH_SW_NAME	"tpacpi_bluetooth_sw"
4018
4019static int bluetooth_get_status(void)
4020{
4021	int status;
4022
4023#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4024	if (dbg_bluetoothemul)
4025		return (tpacpi_bluetooth_emulstate) ?
4026		       TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4027#endif
4028
4029	if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4030		return -EIO;
4031
4032	return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4033			TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4034}
4035
4036static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4037{
4038	int status;
4039
4040	vdbg_printk(TPACPI_DBG_RFKILL,
4041		"will attempt to %s bluetooth\n",
4042		(state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4043
4044#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4045	if (dbg_bluetoothemul) {
4046		tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4047		return 0;
4048	}
4049#endif
4050
4051	if (state == TPACPI_RFK_RADIO_ON)
4052		status = TP_ACPI_BLUETOOTH_RADIOSSW
4053			  | TP_ACPI_BLUETOOTH_RESUMECTRL;
4054	else
4055		status = 0;
4056
4057	if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4058		return -EIO;
4059
4060	return 0;
4061}
4062
4063/* sysfs bluetooth enable ---------------------------------------------- */
4064static ssize_t bluetooth_enable_show(struct device *dev,
4065			   struct device_attribute *attr,
4066			   char *buf)
4067{
4068	return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4069			attr, buf);
4070}
4071
4072static ssize_t bluetooth_enable_store(struct device *dev,
4073			    struct device_attribute *attr,
4074			    const char *buf, size_t count)
4075{
4076	return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4077				attr, buf, count);
4078}
4079
4080static struct device_attribute dev_attr_bluetooth_enable =
4081	__ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
4082		bluetooth_enable_show, bluetooth_enable_store);
4083
4084/* --------------------------------------------------------------------- */
4085
4086static struct attribute *bluetooth_attributes[] = {
4087	&dev_attr_bluetooth_enable.attr,
4088	NULL
4089};
4090
4091static const struct attribute_group bluetooth_attr_group = {
4092	.attrs = bluetooth_attributes,
4093};
4094
4095static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4096	.get_status = bluetooth_get_status,
4097	.set_status = bluetooth_set_status,
4098};
4099
4100static void bluetooth_shutdown(void)
4101{
4102	/* Order firmware to save current state to NVRAM */
4103	if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4104			TP_ACPI_BLTH_SAVE_STATE))
4105		pr_notice("failed to save bluetooth state to NVRAM\n");
4106	else
4107		vdbg_printk(TPACPI_DBG_RFKILL,
4108			"bluetooth state saved to NVRAM\n");
4109}
4110
4111static void bluetooth_exit(void)
4112{
4113	sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4114			&bluetooth_attr_group);
4115
4116	tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4117
4118	bluetooth_shutdown();
4119}
4120
4121static int __init bluetooth_init(struct ibm_init_struct *iibm)
4122{
4123	int res;
4124	int status = 0;
4125
4126	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4127			"initializing bluetooth subdriver\n");
4128
4129	TPACPI_ACPIHANDLE_INIT(hkey);
4130
4131	/* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4132	   G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4133	tp_features.bluetooth = hkey_handle &&
4134	    acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4135
4136	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4137		"bluetooth is %s, status 0x%02x\n",
4138		str_supported(tp_features.bluetooth),
4139		status);
4140
4141#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4142	if (dbg_bluetoothemul) {
4143		tp_features.bluetooth = 1;
4144		pr_info("bluetooth switch emulation enabled\n");
4145	} else
4146#endif
4147	if (tp_features.bluetooth &&
4148	    !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4149		/* no bluetooth hardware present in system */
4150		tp_features.bluetooth = 0;
4151		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4152			   "bluetooth hardware not installed\n");
4153	}
4154
4155	if (!tp_features.bluetooth)
4156		return 1;
4157
4158	res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4159				&bluetooth_tprfk_ops,
4160				RFKILL_TYPE_BLUETOOTH,
4161				TPACPI_RFK_BLUETOOTH_SW_NAME,
4162				true);
4163	if (res)
4164		return res;
4165
4166	res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4167				&bluetooth_attr_group);
4168	if (res) {
4169		tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4170		return res;
4171	}
4172
4173	return 0;
4174}
4175
4176/* procfs -------------------------------------------------------------- */
4177static int bluetooth_read(struct seq_file *m)
4178{
4179	return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4180}
4181
4182static int bluetooth_write(char *buf)
4183{
4184	return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4185}
4186
4187static struct ibm_struct bluetooth_driver_data = {
4188	.name = "bluetooth",
4189	.read = bluetooth_read,
4190	.write = bluetooth_write,
4191	.exit = bluetooth_exit,
4192	.shutdown = bluetooth_shutdown,
4193};
4194
4195/*************************************************************************
4196 * Wan subdriver
4197 */
4198
4199enum {
4200	/* ACPI GWAN/SWAN bits */
4201	TP_ACPI_WANCARD_HWPRESENT	= 0x01,	/* Wan hw available */
4202	TP_ACPI_WANCARD_RADIOSSW	= 0x02,	/* Wan radio enabled */
4203	TP_ACPI_WANCARD_RESUMECTRL	= 0x04,	/* Wan state at resume:
4204						   0 = disable, 1 = enable */
4205};
4206
4207#define TPACPI_RFK_WWAN_SW_NAME		"tpacpi_wwan_sw"
4208
4209static int wan_get_status(void)
4210{
4211	int status;
4212
4213#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4214	if (dbg_wwanemul)
4215		return (tpacpi_wwan_emulstate) ?
4216		       TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4217#endif
4218
4219	if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4220		return -EIO;
4221
4222	return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4223			TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4224}
4225
4226static int wan_set_status(enum tpacpi_rfkill_state state)
4227{
4228	int status;
4229
4230	vdbg_printk(TPACPI_DBG_RFKILL,
4231		"will attempt to %s wwan\n",
4232		(state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4233
4234#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4235	if (dbg_wwanemul) {
4236		tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4237		return 0;
4238	}
4239#endif
4240
4241	if (state == TPACPI_RFK_RADIO_ON)
4242		status = TP_ACPI_WANCARD_RADIOSSW
4243			 | TP_ACPI_WANCARD_RESUMECTRL;
4244	else
4245		status = 0;
4246
4247	if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4248		return -EIO;
4249
4250	return 0;
4251}
4252
4253/* sysfs wan enable ---------------------------------------------------- */
4254static ssize_t wan_enable_show(struct device *dev,
4255			   struct device_attribute *attr,
4256			   char *buf)
4257{
4258	return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4259			attr, buf);
4260}
4261
4262static ssize_t wan_enable_store(struct device *dev,
4263			    struct device_attribute *attr,
4264			    const char *buf, size_t count)
4265{
4266	return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4267			attr, buf, count);
4268}
4269
4270static struct device_attribute dev_attr_wan_enable =
4271	__ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4272		wan_enable_show, wan_enable_store);
4273
4274/* --------------------------------------------------------------------- */
4275
4276static struct attribute *wan_attributes[] = {
4277	&dev_attr_wan_enable.attr,
4278	NULL
4279};
4280
4281static const struct attribute_group wan_attr_group = {
4282	.attrs = wan_attributes,
4283};
4284
4285static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4286	.get_status = wan_get_status,
4287	.set_status = wan_set_status,
4288};
4289
4290static void wan_shutdown(void)
4291{
4292	/* Order firmware to save current state to NVRAM */
4293	if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4294			TP_ACPI_WGSV_SAVE_STATE))
4295		pr_notice("failed to save WWAN state to NVRAM\n");
4296	else
4297		vdbg_printk(TPACPI_DBG_RFKILL,
4298			"WWAN state saved to NVRAM\n");
4299}
4300
4301static void wan_exit(void)
4302{
4303	sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4304		&wan_attr_group);
4305
4306	tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4307
4308	wan_shutdown();
4309}
4310
4311static int __init wan_init(struct ibm_init_struct *iibm)
4312{
4313	int res;
4314	int status = 0;
4315
4316	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4317			"initializing wan subdriver\n");
4318
4319	TPACPI_ACPIHANDLE_INIT(hkey);
4320
4321	tp_features.wan = hkey_handle &&
4322	    acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4323
4324	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4325		"wan is %s, status 0x%02x\n",
4326		str_supported(tp_features.wan),
4327		status);
4328
4329#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4330	if (dbg_wwanemul) {
4331		tp_features.wan = 1;
4332		pr_info("wwan switch emulation enabled\n");
4333	} else
4334#endif
4335	if (tp_features.wan &&
4336	    !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4337		/* no wan hardware present in system */
4338		tp_features.wan = 0;
4339		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4340			   "wan hardware not installed\n");
4341	}
4342
4343	if (!tp_features.wan)
4344		return 1;
4345
4346	res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4347				&wan_tprfk_ops,
4348				RFKILL_TYPE_WWAN,
4349				TPACPI_RFK_WWAN_SW_NAME,
4350				true);
4351	if (res)
4352		return res;
4353
4354	res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4355				&wan_attr_group);
4356
4357	if (res) {
4358		tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4359		return res;
4360	}
4361
4362	return 0;
4363}
4364
4365/* procfs -------------------------------------------------------------- */
4366static int wan_read(struct seq_file *m)
4367{
4368	return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4369}
4370
4371static int wan_write(char *buf)
4372{
4373	return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4374}
4375
4376static struct ibm_struct wan_driver_data = {
4377	.name = "wan",
4378	.read = wan_read,
4379	.write = wan_write,
4380	.exit = wan_exit,
4381	.shutdown = wan_shutdown,
4382};
4383
4384/*************************************************************************
4385 * UWB subdriver
4386 */
4387
4388enum {
4389	/* ACPI GUWB/SUWB bits */
4390	TP_ACPI_UWB_HWPRESENT	= 0x01,	/* UWB hw available */
4391	TP_ACPI_UWB_RADIOSSW	= 0x02,	/* UWB radio enabled */
4392};
4393
4394#define TPACPI_RFK_UWB_SW_NAME	"tpacpi_uwb_sw"
4395
4396static int uwb_get_status(void)
4397{
4398	int status;
4399
4400#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4401	if (dbg_uwbemul)
4402		return (tpacpi_uwb_emulstate) ?
4403		       TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4404#endif
4405
4406	if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4407		return -EIO;
4408
4409	return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4410			TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4411}
4412
4413static int uwb_set_status(enum tpacpi_rfkill_state state)
4414{
4415	int status;
4416
4417	vdbg_printk(TPACPI_DBG_RFKILL,
4418		"will attempt to %s UWB\n",
4419		(state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4420
4421#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4422	if (dbg_uwbemul) {
4423		tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4424		return 0;
4425	}
4426#endif
4427
4428	if (state == TPACPI_RFK_RADIO_ON)
4429		status = TP_ACPI_UWB_RADIOSSW;
4430	else
4431		status = 0;
4432
4433	if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4434		return -EIO;
4435
4436	return 0;
4437}
4438
4439/* --------------------------------------------------------------------- */
4440
4441static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4442	.get_status = uwb_get_status,
4443	.set_status = uwb_set_status,
4444};
4445
4446static void uwb_exit(void)
4447{
4448	tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4449}
4450
4451static int __init uwb_init(struct ibm_init_struct *iibm)
4452{
4453	int res;
4454	int status = 0;
4455
4456	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4457			"initializing uwb subdriver\n");
4458
4459	TPACPI_ACPIHANDLE_INIT(hkey);
4460
4461	tp_features.uwb = hkey_handle &&
4462	    acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4463
4464	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4465		"uwb is %s, status 0x%02x\n",
4466		str_supported(tp_features.uwb),
4467		status);
4468
4469#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4470	if (dbg_uwbemul) {
4471		tp_features.uwb = 1;
4472		pr_info("uwb switch emulation enabled\n");
4473	} else
4474#endif
4475	if (tp_features.uwb &&
4476	    !(status & TP_ACPI_UWB_HWPRESENT)) {
4477		/* no uwb hardware present in system */
4478		tp_features.uwb = 0;
4479		dbg_printk(TPACPI_DBG_INIT,
4480			   "uwb hardware not installed\n");
4481	}
4482
4483	if (!tp_features.uwb)
4484		return 1;
4485
4486	res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4487				&uwb_tprfk_ops,
4488				RFKILL_TYPE_UWB,
4489				TPACPI_RFK_UWB_SW_NAME,
4490				false);
4491	return res;
4492}
4493
4494static struct ibm_struct uwb_driver_data = {
4495	.name = "uwb",
4496	.exit = uwb_exit,
4497	.flags.experimental = 1,
4498};
4499
4500/*************************************************************************
4501 * Video subdriver
4502 */
4503
4504#ifdef CONFIG_THINKPAD_ACPI_VIDEO
4505
4506enum video_access_mode {
4507	TPACPI_VIDEO_NONE = 0,
4508	TPACPI_VIDEO_570,	/* 570 */
4509	TPACPI_VIDEO_770,	/* 600e/x, 770e, 770x */
4510	TPACPI_VIDEO_NEW,	/* all others */
4511};
4512
4513enum {	/* video status flags, based on VIDEO_570 */
4514	TP_ACPI_VIDEO_S_LCD = 0x01,	/* LCD output enabled */
4515	TP_ACPI_VIDEO_S_CRT = 0x02,	/* CRT output enabled */
4516	TP_ACPI_VIDEO_S_DVI = 0x08,	/* DVI output enabled */
4517};
4518
4519enum {  /* TPACPI_VIDEO_570 constants */
4520	TP_ACPI_VIDEO_570_PHSCMD = 0x87,	/* unknown magic constant :( */
4521	TP_ACPI_VIDEO_570_PHSMASK = 0x03,	/* PHS bits that map to
4522						 * video_status_flags */
4523	TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,	/* unknown magic constant :( */
4524	TP_ACPI_VIDEO_570_PHS2SET = 0x80,	/* unknown magic constant :( */
4525};
4526
4527static enum video_access_mode video_supported;
4528static int video_orig_autosw;
4529
4530static int video_autosw_get(void);
4531static int video_autosw_set(int enable);
4532
4533TPACPI_HANDLE(vid, root,
4534	      "\\_SB.PCI.AGP.VGA",	/* 570 */
4535	      "\\_SB.PCI0.AGP0.VID0",	/* 600e/x, 770x */
4536	      "\\_SB.PCI0.VID0",	/* 770e */
4537	      "\\_SB.PCI0.VID",		/* A21e, G4x, R50e, X30, X40 */
4538	      "\\_SB.PCI0.AGP.VGA",	/* X100e and a few others */
4539	      "\\_SB.PCI0.AGP.VID",	/* all others */
4540	);				/* R30, R31 */
4541
4542TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID");	/* G41 */
4543
4544static int __init video_init(struct ibm_init_struct *iibm)
4545{
4546	int ivga;
4547
4548	vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4549
4550	TPACPI_ACPIHANDLE_INIT(vid);
4551	if (tpacpi_is_ibm())
4552		TPACPI_ACPIHANDLE_INIT(vid2);
4553
4554	if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4555		/* G41, assume IVGA doesn't change */
4556		vid_handle = vid2_handle;
4557
4558	if (!vid_handle)
4559		/* video switching not supported on R30, R31 */
4560		video_supported = TPACPI_VIDEO_NONE;
4561	else if (tpacpi_is_ibm() &&
4562		 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4563		/* 570 */
4564		video_supported = TPACPI_VIDEO_570;
4565	else if (tpacpi_is_ibm() &&
4566		 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4567		/* 600e/x, 770e, 770x */
4568		video_supported = TPACPI_VIDEO_770;
4569	else
4570		/* all others */
4571		video_supported = TPACPI_VIDEO_NEW;
4572
4573	vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4574		str_supported(video_supported != TPACPI_VIDEO_NONE),
4575		video_supported);
4576
4577	return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4578}
4579
4580static void video_exit(void)
4581{
4582	dbg_printk(TPACPI_DBG_EXIT,
4583		   "restoring original video autoswitch mode\n");
4584	if (video_autosw_set(video_orig_autosw))
4585		pr_err("error while trying to restore original "
4586			"video autoswitch mode\n");
4587}
4588
4589static int video_outputsw_get(void)
4590{
4591	int status = 0;
4592	int i;
4593
4594	switch (video_supported) {
4595	case TPACPI_VIDEO_570:
4596		if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4597				 TP_ACPI_VIDEO_570_PHSCMD))
4598			return -EIO;
4599		status = i & TP_ACPI_VIDEO_570_PHSMASK;
4600		break;
4601	case TPACPI_VIDEO_770:
4602		if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4603			return -EIO;
4604		if (i)
4605			status |= TP_ACPI_VIDEO_S_LCD;
4606		if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4607			return -EIO;
4608		if (i)
4609			status |= TP_ACPI_VIDEO_S_CRT;
4610		break;
4611	case TPACPI_VIDEO_NEW:
4612		if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4613		    !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4614			return -EIO;
4615		if (i)
4616			status |= TP_ACPI_VIDEO_S_CRT;
4617
4618		if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4619		    !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4620			return -EIO;
4621		if (i)
4622			status |= TP_ACPI_VIDEO_S_LCD;
4623		if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4624			return -EIO;
4625		if (i)
4626			status |= TP_ACPI_VIDEO_S_DVI;
4627		break;
4628	default:
4629		return -ENOSYS;
4630	}
4631
4632	return status;
4633}
4634
4635static int video_outputsw_set(int status)
4636{
4637	int autosw;
4638	int res = 0;
4639
4640	switch (video_supported) {
4641	case TPACPI_VIDEO_570:
4642		res = acpi_evalf(NULL, NULL,
4643				 "\\_SB.PHS2", "vdd",
4644				 TP_ACPI_VIDEO_570_PHS2CMD,
4645				 status | TP_ACPI_VIDEO_570_PHS2SET);
4646		break;
4647	case TPACPI_VIDEO_770:
4648		autosw = video_autosw_get();
4649		if (autosw < 0)
4650			return autosw;
4651
4652		res = video_autosw_set(1);
4653		if (res)
4654			return res;
4655		res = acpi_evalf(vid_handle, NULL,
4656				 "ASWT", "vdd", status * 0x100, 0);
4657		if (!autosw && video_autosw_set(autosw)) {
4658			pr_err("video auto-switch left enabled due to error\n");
4659			return -EIO;
4660		}
4661		break;
4662	case TPACPI_VIDEO_NEW:
4663		res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4664		      acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4665		break;
4666	default:
4667		return -ENOSYS;
4668	}
4669
4670	return (res)? 0 : -EIO;
4671}
4672
4673static int video_autosw_get(void)
4674{
4675	int autosw = 0;
4676
4677	switch (video_supported) {
4678	case TPACPI_VIDEO_570:
4679		if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4680			return -EIO;
4681		break;
4682	case TPACPI_VIDEO_770:
4683	case TPACPI_VIDEO_NEW:
4684		if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4685			return -EIO;
4686		break;
4687	default:
4688		return -ENOSYS;
4689	}
4690
4691	return autosw & 1;
4692}
4693
4694static int video_autosw_set(int enable)
4695{
4696	if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4697		return -EIO;
4698	return 0;
4699}
4700
4701static int video_outputsw_cycle(void)
4702{
4703	int autosw = video_autosw_get();
4704	int res;
4705
4706	if (autosw < 0)
4707		return autosw;
4708
4709	switch (video_supported) {
4710	case TPACPI_VIDEO_570:
4711		res = video_autosw_set(1);
4712		if (res)
4713			return res;
4714		res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4715		break;
4716	case TPACPI_VIDEO_770:
4717	case TPACPI_VIDEO_NEW:
4718		res = video_autosw_set(1);
4719		if (res)
4720			return res;
4721		res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4722		break;
4723	default:
4724		return -ENOSYS;
4725	}
4726	if (!autosw && video_autosw_set(autosw)) {
4727		pr_err("video auto-switch left enabled due to error\n");
4728		return -EIO;
4729	}
4730
4731	return (res)? 0 : -EIO;
4732}
4733
4734static int video_expand_toggle(void)
4735{
4736	switch (video_supported) {
4737	case TPACPI_VIDEO_570:
4738		return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4739			0 : -EIO;
4740	case TPACPI_VIDEO_770:
4741		return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4742			0 : -EIO;
4743	case TPACPI_VIDEO_NEW:
4744		return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4745			0 : -EIO;
4746	default:
4747		return -ENOSYS;
4748	}
4749	/* not reached */
4750}
4751
4752static int video_read(struct seq_file *m)
4753{
4754	int status, autosw;
4755
4756	if (video_supported == TPACPI_VIDEO_NONE) {
4757		seq_printf(m, "status:\t\tnot supported\n");
4758		return 0;
4759	}
4760
4761	/* Even reads can crash X.org, so... */
4762	if (!capable(CAP_SYS_ADMIN))
4763		return -EPERM;
4764
4765	status = video_outputsw_get();
4766	if (status < 0)
4767		return status;
4768
4769	autosw = video_autosw_get();
4770	if (autosw < 0)
4771		return autosw;
4772
4773	seq_printf(m, "status:\t\tsupported\n");
4774	seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4775	seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4776	if (video_supported == TPACPI_VIDEO_NEW)
4777		seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4778	seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4779	seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4780	seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4781	if (video_supported == TPACPI_VIDEO_NEW)
4782		seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4783	seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4784	seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4785
4786	return 0;
4787}
4788
4789static int video_write(char *buf)
4790{
4791	char *cmd;
4792	int enable, disable, status;
4793	int res;
4794
4795	if (video_supported == TPACPI_VIDEO_NONE)
4796		return -ENODEV;
4797
4798	/* Even reads can crash X.org, let alone writes... */
4799	if (!capable(CAP_SYS_ADMIN))
4800		return -EPERM;
4801
4802	enable = 0;
4803	disable = 0;
4804
4805	while ((cmd = next_cmd(&buf))) {
4806		if (strlencmp(cmd, "lcd_enable") == 0) {
4807			enable |= TP_ACPI_VIDEO_S_LCD;
4808		} else if (strlencmp(cmd, "lcd_disable") == 0) {
4809			disable |= TP_ACPI_VIDEO_S_LCD;
4810		} else if (strlencmp(cmd, "crt_enable") == 0) {
4811			enable |= TP_ACPI_VIDEO_S_CRT;
4812		} else if (strlencmp(cmd, "crt_disable") == 0) {
4813			disable |= TP_ACPI_VIDEO_S_CRT;
4814		} else if (video_supported == TPACPI_VIDEO_NEW &&
4815			   strlencmp(cmd, "dvi_enable") == 0) {
4816			enable |= TP_ACPI_VIDEO_S_DVI;
4817		} else if (video_supported == TPACPI_VIDEO_NEW &&
4818			   strlencmp(cmd, "dvi_disable") == 0) {
4819			disable |= TP_ACPI_VIDEO_S_DVI;
4820		} else if (strlencmp(cmd, "auto_enable") == 0) {
4821			res = video_autosw_set(1);
4822			if (res)
4823				return res;
4824		} else if (strlencmp(cmd, "auto_disable") == 0) {
4825			res = video_autosw_set(0);
4826			if (res)
4827				return res;
4828		} else if (strlencmp(cmd, "video_switch") == 0) {
4829			res = video_outputsw_cycle();
4830			if (res)
4831				return res;
4832		} else if (strlencmp(cmd, "expand_toggle") == 0) {
4833			res = video_expand_toggle();
4834			if (res)
4835				return res;
4836		} else
4837			return -EINVAL;
4838	}
4839
4840	if (enable || disable) {
4841		status = video_outputsw_get();
4842		if (status < 0)
4843			return status;
4844		res = video_outputsw_set((status & ~disable) | enable);
4845		if (res)
4846			return res;
4847	}
4848
4849	return 0;
4850}
4851
4852static struct ibm_struct video_driver_data = {
4853	.name = "video",
4854	.read = video_read,
4855	.write = video_write,
4856	.exit = video_exit,
4857};
4858
4859#endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4860
4861/*************************************************************************
4862 * Light (thinklight) subdriver
4863 */
4864
4865TPACPI_HANDLE(lght, root, "\\LGHT");	/* A21e, A2xm/p, T20-22, X20-21 */
4866TPACPI_HANDLE(ledb, ec, "LEDB");		/* G4x */
4867
4868static int light_get_status(void)
4869{
4870	int status = 0;
4871
4872	if (tp_features.light_status) {
4873		if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4874			return -EIO;
4875		return (!!status);
4876	}
4877
4878	return -ENXIO;
4879}
4880
4881static int light_set_status(int status)
4882{
4883	int rc;
4884
4885	if (tp_features.light) {
4886		if (cmos_handle) {
4887			rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4888					(status)?
4889						TP_CMOS_THINKLIGHT_ON :
4890						TP_CMOS_THINKLIGHT_OFF);
4891		} else {
4892			rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4893					(status)? 1 : 0);
4894		}
4895		return (rc)? 0 : -EIO;
4896	}
4897
4898	return -ENXIO;
4899}
4900
4901static void light_set_status_worker(struct work_struct *work)
4902{
4903	struct tpacpi_led_classdev *data =
4904			container_of(work, struct tpacpi_led_classdev, work);
4905
4906	if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4907		light_set_status((data->new_state != TPACPI_LED_OFF));
4908}
4909
4910static void light_sysfs_set(struct led_classdev *led_cdev,
4911			enum led_brightness brightness)
4912{
4913	struct tpacpi_led_classdev *data =
4914		container_of(led_cdev,
4915			     struct tpacpi_led_classdev,
4916			     led_classdev);
4917	data->new_state = (brightness != LED_OFF) ?
4918				TPACPI_LED_ON : TPACPI_LED_OFF;
4919	queue_work(tpacpi_wq, &data->work);
4920}
4921
4922static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4923{
4924	return (light_get_status() == 1)? LED_FULL : LED_OFF;
4925}
4926
4927static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4928	.led_classdev = {
4929		.name		= "tpacpi::thinklight",
4930		.brightness_set	= &light_sysfs_set,
4931		.brightness_get	= &light_sysfs_get,
4932	}
4933};
4934
4935static int __init light_init(struct ibm_init_struct *iibm)
4936{
4937	int rc;
4938
4939	vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4940
4941	if (tpacpi_is_ibm()) {
4942		TPACPI_ACPIHANDLE_INIT(ledb);
4943		TPACPI_ACPIHANDLE_INIT(lght);
4944	}
4945	TPACPI_ACPIHANDLE_INIT(cmos);
4946	INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4947
4948	/* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4949	tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4950
4951	if (tp_features.light)
4952		/* light status not supported on
4953		   570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4954		tp_features.light_status =
4955			acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4956
4957	vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4958		str_supported(tp_features.light),
4959		str_supported(tp_features.light_status));
4960
4961	if (!tp_features.light)
4962		return 1;
4963
4964	rc = led_classdev_register(&tpacpi_pdev->dev,
4965				   &tpacpi_led_thinklight.led_classdev);
4966
4967	if (rc < 0) {
4968		tp_features.light = 0;
4969		tp_features.light_status = 0;
4970	} else  {
4971		rc = 0;
4972	}
4973
4974	return rc;
4975}
4976
4977static void light_exit(void)
4978{
4979	led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4980	flush_workqueue(tpacpi_wq);
 
4981}
4982
4983static int light_read(struct seq_file *m)
4984{
4985	int status;
4986
4987	if (!tp_features.light) {
4988		seq_printf(m, "status:\t\tnot supported\n");
4989	} else if (!tp_features.light_status) {
4990		seq_printf(m, "status:\t\tunknown\n");
4991		seq_printf(m, "commands:\ton, off\n");
4992	} else {
4993		status = light_get_status();
4994		if (status < 0)
4995			return status;
4996		seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4997		seq_printf(m, "commands:\ton, off\n");
4998	}
4999
5000	return 0;
5001}
5002
5003static int light_write(char *buf)
5004{
5005	char *cmd;
5006	int newstatus = 0;
5007
5008	if (!tp_features.light)
5009		return -ENODEV;
5010
5011	while ((cmd = next_cmd(&buf))) {
5012		if (strlencmp(cmd, "on") == 0) {
5013			newstatus = 1;
5014		} else if (strlencmp(cmd, "off") == 0) {
5015			newstatus = 0;
5016		} else
5017			return -EINVAL;
5018	}
5019
5020	return light_set_status(newstatus);
5021}
5022
5023static struct ibm_struct light_driver_data = {
5024	.name = "light",
5025	.read = light_read,
5026	.write = light_write,
5027	.exit = light_exit,
5028};
5029
5030/*************************************************************************
5031 * CMOS subdriver
5032 */
5033
5034/* sysfs cmos_command -------------------------------------------------- */
5035static ssize_t cmos_command_store(struct device *dev,
5036			    struct device_attribute *attr,
5037			    const char *buf, size_t count)
5038{
5039	unsigned long cmos_cmd;
5040	int res;
5041
5042	if (parse_strtoul(buf, 21, &cmos_cmd))
5043		return -EINVAL;
5044
5045	res = issue_thinkpad_cmos_command(cmos_cmd);
5046	return (res)? res : count;
5047}
5048
5049static struct device_attribute dev_attr_cmos_command =
5050	__ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
5051
5052/* --------------------------------------------------------------------- */
5053
5054static int __init cmos_init(struct ibm_init_struct *iibm)
5055{
5056	int res;
5057
5058	vdbg_printk(TPACPI_DBG_INIT,
5059		"initializing cmos commands subdriver\n");
5060
5061	TPACPI_ACPIHANDLE_INIT(cmos);
5062
5063	vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5064		str_supported(cmos_handle != NULL));
5065
5066	res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5067	if (res)
5068		return res;
5069
5070	return (cmos_handle)? 0 : 1;
5071}
5072
5073static void cmos_exit(void)
5074{
5075	device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5076}
5077
5078static int cmos_read(struct seq_file *m)
5079{
5080	/* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5081	   R30, R31, T20-22, X20-21 */
5082	if (!cmos_handle)
5083		seq_printf(m, "status:\t\tnot supported\n");
5084	else {
5085		seq_printf(m, "status:\t\tsupported\n");
5086		seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5087	}
5088
5089	return 0;
5090}
5091
5092static int cmos_write(char *buf)
5093{
5094	char *cmd;
5095	int cmos_cmd, res;
5096
5097	while ((cmd = next_cmd(&buf))) {
5098		if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5099		    cmos_cmd >= 0 && cmos_cmd <= 21) {
5100			/* cmos_cmd set */
5101		} else
5102			return -EINVAL;
5103
5104		res = issue_thinkpad_cmos_command(cmos_cmd);
5105		if (res)
5106			return res;
5107	}
5108
5109	return 0;
5110}
5111
5112static struct ibm_struct cmos_driver_data = {
5113	.name = "cmos",
5114	.read = cmos_read,
5115	.write = cmos_write,
5116	.exit = cmos_exit,
5117};
5118
5119/*************************************************************************
5120 * LED subdriver
5121 */
5122
5123enum led_access_mode {
5124	TPACPI_LED_NONE = 0,
5125	TPACPI_LED_570,	/* 570 */
5126	TPACPI_LED_OLD,	/* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5127	TPACPI_LED_NEW,	/* all others */
5128};
5129
5130enum {	/* For TPACPI_LED_OLD */
5131	TPACPI_LED_EC_HLCL = 0x0c,	/* EC reg to get led to power on */
5132	TPACPI_LED_EC_HLBL = 0x0d,	/* EC reg to blink a lit led */
5133	TPACPI_LED_EC_HLMS = 0x0e,	/* EC reg to select led to command */
5134};
5135
5136static enum led_access_mode led_supported;
5137
5138static acpi_handle led_handle;
5139
5140#define TPACPI_LED_NUMLEDS 16
5141static struct tpacpi_led_classdev *tpacpi_leds;
5142static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5143static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5144	/* there's a limit of 19 chars + NULL before 2.6.26 */
5145	"tpacpi::power",
5146	"tpacpi:orange:batt",
5147	"tpacpi:green:batt",
5148	"tpacpi::dock_active",
5149	"tpacpi::bay_active",
5150	"tpacpi::dock_batt",
5151	"tpacpi::unknown_led",
5152	"tpacpi::standby",
5153	"tpacpi::dock_status1",
5154	"tpacpi::dock_status2",
5155	"tpacpi::unknown_led2",
5156	"tpacpi::unknown_led3",
5157	"tpacpi::thinkvantage",
5158};
5159#define TPACPI_SAFE_LEDS	0x1081U
5160
5161static inline bool tpacpi_is_led_restricted(const unsigned int led)
5162{
5163#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5164	return false;
5165#else
5166	return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5167#endif
5168}
5169
5170static int led_get_status(const unsigned int led)
5171{
5172	int status;
5173	enum led_status_t led_s;
5174
5175	switch (led_supported) {
5176	case TPACPI_LED_570:
5177		if (!acpi_evalf(ec_handle,
5178				&status, "GLED", "dd", 1 << led))
5179			return -EIO;
5180		led_s = (status == 0)?
5181				TPACPI_LED_OFF :
5182				((status == 1)?
5183					TPACPI_LED_ON :
5184					TPACPI_LED_BLINK);
5185		tpacpi_led_state_cache[led] = led_s;
5186		return led_s;
5187	default:
5188		return -ENXIO;
5189	}
5190
5191	/* not reached */
5192}
5193
5194static int led_set_status(const unsigned int led,
5195			  const enum led_status_t ledstatus)
5196{
5197	/* off, on, blink. Index is led_status_t */
5198	static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5199	static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5200
5201	int rc = 0;
5202
5203	switch (led_supported) {
5204	case TPACPI_LED_570:
5205		/* 570 */
5206		if (unlikely(led > 7))
5207			return -EINVAL;
5208		if (unlikely(tpacpi_is_led_restricted(led)))
5209			return -EPERM;
5210		if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5211				(1 << led), led_sled_arg1[ledstatus]))
5212			rc = -EIO;
5213		break;
5214	case TPACPI_LED_OLD:
5215		/* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5216		if (unlikely(led > 7))
5217			return -EINVAL;
5218		if (unlikely(tpacpi_is_led_restricted(led)))
5219			return -EPERM;
5220		rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5221		if (rc >= 0)
5222			rc = ec_write(TPACPI_LED_EC_HLBL,
5223				      (ledstatus == TPACPI_LED_BLINK) << led);
5224		if (rc >= 0)
5225			rc = ec_write(TPACPI_LED_EC_HLCL,
5226				      (ledstatus != TPACPI_LED_OFF) << led);
5227		break;
5228	case TPACPI_LED_NEW:
5229		/* all others */
5230		if (unlikely(led >= TPACPI_LED_NUMLEDS))
5231			return -EINVAL;
5232		if (unlikely(tpacpi_is_led_restricted(led)))
5233			return -EPERM;
5234		if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5235				led, led_led_arg1[ledstatus]))
5236			rc = -EIO;
5237		break;
5238	default:
5239		rc = -ENXIO;
5240	}
5241
5242	if (!rc)
5243		tpacpi_led_state_cache[led] = ledstatus;
5244
5245	return rc;
5246}
5247
5248static void led_set_status_worker(struct work_struct *work)
5249{
5250	struct tpacpi_led_classdev *data =
5251		container_of(work, struct tpacpi_led_classdev, work);
5252
5253	if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5254		led_set_status(data->led, data->new_state);
5255}
5256
5257static void led_sysfs_set(struct led_classdev *led_cdev,
5258			enum led_brightness brightness)
5259{
5260	struct tpacpi_led_classdev *data = container_of(led_cdev,
5261			     struct tpacpi_led_classdev, led_classdev);
5262
5263	if (brightness == LED_OFF)
5264		data->new_state = TPACPI_LED_OFF;
5265	else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5266		data->new_state = TPACPI_LED_ON;
5267	else
5268		data->new_state = TPACPI_LED_BLINK;
5269
5270	queue_work(tpacpi_wq, &data->work);
5271}
5272
5273static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5274			unsigned long *delay_on, unsigned long *delay_off)
5275{
5276	struct tpacpi_led_classdev *data = container_of(led_cdev,
5277			     struct tpacpi_led_classdev, led_classdev);
5278
5279	/* Can we choose the flash rate? */
5280	if (*delay_on == 0 && *delay_off == 0) {
5281		/* yes. set them to the hardware blink rate (1 Hz) */
5282		*delay_on = 500; /* ms */
5283		*delay_off = 500; /* ms */
5284	} else if ((*delay_on != 500) || (*delay_off != 500))
5285		return -EINVAL;
5286
5287	data->new_state = TPACPI_LED_BLINK;
5288	queue_work(tpacpi_wq, &data->work);
5289
5290	return 0;
5291}
5292
5293static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5294{
5295	int rc;
5296
5297	struct tpacpi_led_classdev *data = container_of(led_cdev,
5298			     struct tpacpi_led_classdev, led_classdev);
5299
5300	rc = led_get_status(data->led);
5301
5302	if (rc == TPACPI_LED_OFF || rc < 0)
5303		rc = LED_OFF;	/* no error handling in led class :( */
5304	else
5305		rc = LED_FULL;
5306
5307	return rc;
5308}
5309
5310static void led_exit(void)
5311{
5312	unsigned int i;
5313
5314	for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5315		if (tpacpi_leds[i].led_classdev.name)
5316			led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5317	}
5318
5319	flush_workqueue(tpacpi_wq);
5320	kfree(tpacpi_leds);
5321}
5322
5323static int __init tpacpi_init_led(unsigned int led)
5324{
5325	int rc;
5326
5327	tpacpi_leds[led].led = led;
5328
5329	/* LEDs with no name don't get registered */
5330	if (!tpacpi_led_names[led])
5331		return 0;
5332
5333	tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5334	tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5335	if (led_supported == TPACPI_LED_570)
5336		tpacpi_leds[led].led_classdev.brightness_get =
5337						&led_sysfs_get;
5338
5339	tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5340
5341	INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5342
5343	rc = led_classdev_register(&tpacpi_pdev->dev,
5344				&tpacpi_leds[led].led_classdev);
5345	if (rc < 0)
5346		tpacpi_leds[led].led_classdev.name = NULL;
5347
5348	return rc;
5349}
5350
5351static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5352	TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5353	TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5354	TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5355
5356	TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5357	TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5358	TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5359	TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5360	TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5361	TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5362	TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5363	TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5364
5365	TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5366	TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5367	TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5368	TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5369	TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5370
5371	TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5372	TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5373	TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5374	TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5375
5376	/* (1) - may have excess leds enabled on MSB */
5377
5378	/* Defaults (order matters, keep last, don't reorder!) */
5379	{ /* Lenovo */
5380	  .vendor = PCI_VENDOR_ID_LENOVO,
5381	  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5382	  .quirks = 0x1fffU,
5383	},
5384	{ /* IBM ThinkPads with no EC version string */
5385	  .vendor = PCI_VENDOR_ID_IBM,
5386	  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5387	  .quirks = 0x00ffU,
5388	},
5389	{ /* IBM ThinkPads with EC version string */
5390	  .vendor = PCI_VENDOR_ID_IBM,
5391	  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5392	  .quirks = 0x00bfU,
5393	},
5394};
5395
5396#undef TPACPI_LEDQ_IBM
5397#undef TPACPI_LEDQ_LNV
5398
5399static enum led_access_mode __init led_init_detect_mode(void)
5400{
5401	acpi_status status;
5402
5403	if (tpacpi_is_ibm()) {
5404		/* 570 */
5405		status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5406		if (ACPI_SUCCESS(status))
5407			return TPACPI_LED_570;
5408
5409		/* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5410		status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5411		if (ACPI_SUCCESS(status))
5412			return TPACPI_LED_OLD;
5413	}
5414
5415	/* most others */
5416	status = acpi_get_handle(ec_handle, "LED", &led_handle);
5417	if (ACPI_SUCCESS(status))
5418		return TPACPI_LED_NEW;
5419
5420	/* R30, R31, and unknown firmwares */
5421	led_handle = NULL;
5422	return TPACPI_LED_NONE;
5423}
5424
5425static int __init led_init(struct ibm_init_struct *iibm)
5426{
5427	unsigned int i;
5428	int rc;
5429	unsigned long useful_leds;
5430
5431	vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5432
5433	led_supported = led_init_detect_mode();
5434
5435	if (led_supported != TPACPI_LED_NONE) {
5436		useful_leds = tpacpi_check_quirks(led_useful_qtable,
5437				ARRAY_SIZE(led_useful_qtable));
5438
5439		if (!useful_leds) {
5440			led_handle = NULL;
5441			led_supported = TPACPI_LED_NONE;
5442		}
5443	}
5444
5445	vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5446		str_supported(led_supported), led_supported);
5447
5448	if (led_supported == TPACPI_LED_NONE)
5449		return 1;
5450
5451	tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5452			      GFP_KERNEL);
5453	if (!tpacpi_leds) {
5454		pr_err("Out of memory for LED data\n");
5455		return -ENOMEM;
5456	}
5457
 
 
 
5458	for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5459		tpacpi_leds[i].led = -1;
5460
5461		if (!tpacpi_is_led_restricted(i) &&
5462		    test_bit(i, &useful_leds)) {
5463			rc = tpacpi_init_led(i);
5464			if (rc < 0) {
5465				led_exit();
5466				return rc;
5467			}
5468		}
5469	}
5470
5471#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5472	pr_notice("warning: userspace override of important "
5473		  "firmware LEDs is enabled\n");
5474#endif
5475	return 0;
5476}
5477
5478#define str_led_status(s) \
5479	((s) == TPACPI_LED_OFF ? "off" : \
5480		((s) == TPACPI_LED_ON ? "on" : "blinking"))
5481
5482static int led_read(struct seq_file *m)
5483{
5484	if (!led_supported) {
5485		seq_printf(m, "status:\t\tnot supported\n");
5486		return 0;
5487	}
5488	seq_printf(m, "status:\t\tsupported\n");
5489
5490	if (led_supported == TPACPI_LED_570) {
5491		/* 570 */
5492		int i, status;
5493		for (i = 0; i < 8; i++) {
5494			status = led_get_status(i);
5495			if (status < 0)
5496				return -EIO;
5497			seq_printf(m, "%d:\t\t%s\n",
5498				       i, str_led_status(status));
5499		}
5500	}
5501
5502	seq_printf(m, "commands:\t"
5503		       "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5504
5505	return 0;
5506}
5507
5508static int led_write(char *buf)
5509{
5510	char *cmd;
5511	int led, rc;
5512	enum led_status_t s;
5513
5514	if (!led_supported)
5515		return -ENODEV;
5516
5517	while ((cmd = next_cmd(&buf))) {
5518		if (sscanf(cmd, "%d", &led) != 1)
5519			return -EINVAL;
5520
5521		if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1) ||
5522				tpacpi_leds[led].led < 0)
5523			return -ENODEV;
5524
5525		if (strstr(cmd, "off")) {
5526			s = TPACPI_LED_OFF;
5527		} else if (strstr(cmd, "on")) {
5528			s = TPACPI_LED_ON;
5529		} else if (strstr(cmd, "blink")) {
5530			s = TPACPI_LED_BLINK;
5531		} else {
5532			return -EINVAL;
5533		}
5534
5535		rc = led_set_status(led, s);
5536		if (rc < 0)
5537			return rc;
5538	}
5539
5540	return 0;
5541}
5542
5543static struct ibm_struct led_driver_data = {
5544	.name = "led",
5545	.read = led_read,
5546	.write = led_write,
5547	.exit = led_exit,
5548};
5549
5550/*************************************************************************
5551 * Beep subdriver
5552 */
5553
5554TPACPI_HANDLE(beep, ec, "BEEP");	/* all except R30, R31 */
5555
5556#define TPACPI_BEEP_Q1 0x0001
5557
5558static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5559	TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5560	TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5561};
5562
5563static int __init beep_init(struct ibm_init_struct *iibm)
5564{
5565	unsigned long quirks;
5566
5567	vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5568
5569	TPACPI_ACPIHANDLE_INIT(beep);
5570
5571	vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5572		str_supported(beep_handle != NULL));
5573
5574	quirks = tpacpi_check_quirks(beep_quirk_table,
5575				     ARRAY_SIZE(beep_quirk_table));
5576
5577	tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5578
5579	return (beep_handle)? 0 : 1;
5580}
5581
5582static int beep_read(struct seq_file *m)
5583{
5584	if (!beep_handle)
5585		seq_printf(m, "status:\t\tnot supported\n");
5586	else {
5587		seq_printf(m, "status:\t\tsupported\n");
5588		seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5589	}
5590
5591	return 0;
5592}
5593
5594static int beep_write(char *buf)
5595{
5596	char *cmd;
5597	int beep_cmd;
5598
5599	if (!beep_handle)
5600		return -ENODEV;
5601
5602	while ((cmd = next_cmd(&buf))) {
5603		if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5604		    beep_cmd >= 0 && beep_cmd <= 17) {
5605			/* beep_cmd set */
5606		} else
5607			return -EINVAL;
5608		if (tp_features.beep_needs_two_args) {
5609			if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5610					beep_cmd, 0))
5611				return -EIO;
5612		} else {
5613			if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5614					beep_cmd))
5615				return -EIO;
5616		}
5617	}
5618
5619	return 0;
5620}
5621
5622static struct ibm_struct beep_driver_data = {
5623	.name = "beep",
5624	.read = beep_read,
5625	.write = beep_write,
5626};
5627
5628/*************************************************************************
5629 * Thermal subdriver
5630 */
5631
5632enum thermal_access_mode {
5633	TPACPI_THERMAL_NONE = 0,	/* No thermal support */
5634	TPACPI_THERMAL_ACPI_TMP07,	/* Use ACPI TMP0-7 */
5635	TPACPI_THERMAL_ACPI_UPDT,	/* Use ACPI TMP0-7 with UPDT */
5636	TPACPI_THERMAL_TPEC_8,		/* Use ACPI EC regs, 8 sensors */
5637	TPACPI_THERMAL_TPEC_16,		/* Use ACPI EC regs, 16 sensors */
5638};
5639
5640enum { /* TPACPI_THERMAL_TPEC_* */
5641	TP_EC_THERMAL_TMP0 = 0x78,	/* ACPI EC regs TMP 0..7 */
5642	TP_EC_THERMAL_TMP8 = 0xC0,	/* ACPI EC regs TMP 8..15 */
5643	TP_EC_THERMAL_TMP_NA = -128,	/* ACPI EC sensor not available */
5644
5645	TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5646};
5647
5648
5649#define TPACPI_MAX_THERMAL_SENSORS 16	/* Max thermal sensors supported */
5650struct ibm_thermal_sensors_struct {
5651	s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5652};
5653
5654static enum thermal_access_mode thermal_read_mode;
5655
5656/* idx is zero-based */
5657static int thermal_get_sensor(int idx, s32 *value)
5658{
5659	int t;
5660	s8 tmp;
5661	char tmpi[5];
5662
5663	t = TP_EC_THERMAL_TMP0;
5664
5665	switch (thermal_read_mode) {
5666#if TPACPI_MAX_THERMAL_SENSORS >= 16
5667	case TPACPI_THERMAL_TPEC_16:
5668		if (idx >= 8 && idx <= 15) {
5669			t = TP_EC_THERMAL_TMP8;
5670			idx -= 8;
5671		}
5672		/* fallthrough */
5673#endif
5674	case TPACPI_THERMAL_TPEC_8:
5675		if (idx <= 7) {
5676			if (!acpi_ec_read(t + idx, &tmp))
5677				return -EIO;
5678			*value = tmp * 1000;
5679			return 0;
5680		}
5681		break;
5682
5683	case TPACPI_THERMAL_ACPI_UPDT:
5684		if (idx <= 7) {
5685			snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5686			if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5687				return -EIO;
5688			if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5689				return -EIO;
5690			*value = (t - 2732) * 100;
5691			return 0;
5692		}
5693		break;
5694
5695	case TPACPI_THERMAL_ACPI_TMP07:
5696		if (idx <= 7) {
5697			snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5698			if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5699				return -EIO;
5700			if (t > 127 || t < -127)
5701				t = TP_EC_THERMAL_TMP_NA;
5702			*value = t * 1000;
5703			return 0;
5704		}
5705		break;
5706
5707	case TPACPI_THERMAL_NONE:
5708	default:
5709		return -ENOSYS;
5710	}
5711
5712	return -EINVAL;
5713}
5714
5715static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5716{
5717	int res, i;
5718	int n;
5719
5720	n = 8;
5721	i = 0;
5722
5723	if (!s)
5724		return -EINVAL;
5725
5726	if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5727		n = 16;
5728
5729	for (i = 0 ; i < n; i++) {
5730		res = thermal_get_sensor(i, &s->temp[i]);
5731		if (res)
5732			return res;
5733	}
5734
5735	return n;
5736}
5737
5738static void thermal_dump_all_sensors(void)
5739{
5740	int n, i;
5741	struct ibm_thermal_sensors_struct t;
5742
5743	n = thermal_get_sensors(&t);
5744	if (n <= 0)
5745		return;
5746
5747	pr_notice("temperatures (Celsius):");
5748
5749	for (i = 0; i < n; i++) {
5750		if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5751			pr_cont(" %d", (int)(t.temp[i] / 1000));
5752		else
5753			pr_cont(" N/A");
5754	}
5755
5756	pr_cont("\n");
5757}
5758
5759/* sysfs temp##_input -------------------------------------------------- */
5760
5761static ssize_t thermal_temp_input_show(struct device *dev,
5762			   struct device_attribute *attr,
5763			   char *buf)
5764{
5765	struct sensor_device_attribute *sensor_attr =
5766					to_sensor_dev_attr(attr);
5767	int idx = sensor_attr->index;
5768	s32 value;
5769	int res;
5770
5771	res = thermal_get_sensor(idx, &value);
5772	if (res)
5773		return res;
5774	if (value == TPACPI_THERMAL_SENSOR_NA)
5775		return -ENXIO;
5776
5777	return snprintf(buf, PAGE_SIZE, "%d\n", value);
5778}
5779
5780#define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5781	 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5782		     thermal_temp_input_show, NULL, _idxB)
5783
5784static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5785	THERMAL_SENSOR_ATTR_TEMP(1, 0),
5786	THERMAL_SENSOR_ATTR_TEMP(2, 1),
5787	THERMAL_SENSOR_ATTR_TEMP(3, 2),
5788	THERMAL_SENSOR_ATTR_TEMP(4, 3),
5789	THERMAL_SENSOR_ATTR_TEMP(5, 4),
5790	THERMAL_SENSOR_ATTR_TEMP(6, 5),
5791	THERMAL_SENSOR_ATTR_TEMP(7, 6),
5792	THERMAL_SENSOR_ATTR_TEMP(8, 7),
5793	THERMAL_SENSOR_ATTR_TEMP(9, 8),
5794	THERMAL_SENSOR_ATTR_TEMP(10, 9),
5795	THERMAL_SENSOR_ATTR_TEMP(11, 10),
5796	THERMAL_SENSOR_ATTR_TEMP(12, 11),
5797	THERMAL_SENSOR_ATTR_TEMP(13, 12),
5798	THERMAL_SENSOR_ATTR_TEMP(14, 13),
5799	THERMAL_SENSOR_ATTR_TEMP(15, 14),
5800	THERMAL_SENSOR_ATTR_TEMP(16, 15),
5801};
5802
5803#define THERMAL_ATTRS(X) \
5804	&sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5805
5806static struct attribute *thermal_temp_input_attr[] = {
5807	THERMAL_ATTRS(8),
5808	THERMAL_ATTRS(9),
5809	THERMAL_ATTRS(10),
5810	THERMAL_ATTRS(11),
5811	THERMAL_ATTRS(12),
5812	THERMAL_ATTRS(13),
5813	THERMAL_ATTRS(14),
5814	THERMAL_ATTRS(15),
5815	THERMAL_ATTRS(0),
5816	THERMAL_ATTRS(1),
5817	THERMAL_ATTRS(2),
5818	THERMAL_ATTRS(3),
5819	THERMAL_ATTRS(4),
5820	THERMAL_ATTRS(5),
5821	THERMAL_ATTRS(6),
5822	THERMAL_ATTRS(7),
5823	NULL
5824};
5825
5826static const struct attribute_group thermal_temp_input16_group = {
5827	.attrs = thermal_temp_input_attr
5828};
5829
5830static const struct attribute_group thermal_temp_input8_group = {
5831	.attrs = &thermal_temp_input_attr[8]
5832};
5833
5834#undef THERMAL_SENSOR_ATTR_TEMP
5835#undef THERMAL_ATTRS
5836
5837/* --------------------------------------------------------------------- */
5838
5839static int __init thermal_init(struct ibm_init_struct *iibm)
5840{
5841	u8 t, ta1, ta2;
5842	int i;
5843	int acpi_tmp7;
5844	int res;
5845
5846	vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5847
5848	acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5849
5850	if (thinkpad_id.ec_model) {
5851		/*
5852		 * Direct EC access mode: sensors at registers
5853		 * 0x78-0x7F, 0xC0-0xC7.  Registers return 0x00 for
5854		 * non-implemented, thermal sensors return 0x80 when
5855		 * not available
5856		 */
5857
5858		ta1 = ta2 = 0;
5859		for (i = 0; i < 8; i++) {
5860			if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5861				ta1 |= t;
5862			} else {
5863				ta1 = 0;
5864				break;
5865			}
5866			if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5867				ta2 |= t;
5868			} else {
5869				ta1 = 0;
5870				break;
5871			}
5872		}
5873		if (ta1 == 0) {
5874			/* This is sheer paranoia, but we handle it anyway */
5875			if (acpi_tmp7) {
5876				pr_err("ThinkPad ACPI EC access misbehaving, "
5877				       "falling back to ACPI TMPx access "
5878				       "mode\n");
5879				thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5880			} else {
5881				pr_err("ThinkPad ACPI EC access misbehaving, "
5882				       "disabling thermal sensors access\n");
5883				thermal_read_mode = TPACPI_THERMAL_NONE;
5884			}
5885		} else {
5886			thermal_read_mode =
5887			    (ta2 != 0) ?
5888			    TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5889		}
5890	} else if (acpi_tmp7) {
5891		if (tpacpi_is_ibm() &&
5892		    acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5893			/* 600e/x, 770e, 770x */
5894			thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5895		} else {
5896			/* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5897			thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5898		}
5899	} else {
5900		/* temperatures not supported on 570, G4x, R30, R31, R32 */
5901		thermal_read_mode = TPACPI_THERMAL_NONE;
5902	}
5903
5904	vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5905		str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5906		thermal_read_mode);
5907
5908	switch (thermal_read_mode) {
5909	case TPACPI_THERMAL_TPEC_16:
5910		res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5911				&thermal_temp_input16_group);
5912		if (res)
5913			return res;
5914		break;
5915	case TPACPI_THERMAL_TPEC_8:
5916	case TPACPI_THERMAL_ACPI_TMP07:
5917	case TPACPI_THERMAL_ACPI_UPDT:
5918		res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5919				&thermal_temp_input8_group);
5920		if (res)
5921			return res;
5922		break;
5923	case TPACPI_THERMAL_NONE:
5924	default:
5925		return 1;
5926	}
5927
5928	return 0;
5929}
5930
5931static void thermal_exit(void)
5932{
5933	switch (thermal_read_mode) {
5934	case TPACPI_THERMAL_TPEC_16:
5935		sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5936				   &thermal_temp_input16_group);
5937		break;
5938	case TPACPI_THERMAL_TPEC_8:
5939	case TPACPI_THERMAL_ACPI_TMP07:
5940	case TPACPI_THERMAL_ACPI_UPDT:
5941		sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5942				   &thermal_temp_input8_group);
5943		break;
5944	case TPACPI_THERMAL_NONE:
5945	default:
5946		break;
5947	}
5948}
5949
5950static int thermal_read(struct seq_file *m)
5951{
5952	int n, i;
5953	struct ibm_thermal_sensors_struct t;
5954
5955	n = thermal_get_sensors(&t);
5956	if (unlikely(n < 0))
5957		return n;
5958
5959	seq_printf(m, "temperatures:\t");
5960
5961	if (n > 0) {
5962		for (i = 0; i < (n - 1); i++)
5963			seq_printf(m, "%d ", t.temp[i] / 1000);
5964		seq_printf(m, "%d\n", t.temp[i] / 1000);
5965	} else
5966		seq_printf(m, "not supported\n");
5967
5968	return 0;
5969}
5970
5971static struct ibm_struct thermal_driver_data = {
5972	.name = "thermal",
5973	.read = thermal_read,
5974	.exit = thermal_exit,
5975};
5976
5977/*************************************************************************
5978 * Backlight/brightness subdriver
5979 */
5980
5981#define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5982
5983/*
5984 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5985 * CMOS NVRAM byte 0x5E, bits 0-3.
5986 *
5987 * EC HBRV (0x31) has the following layout
5988 *   Bit 7: unknown function
5989 *   Bit 6: unknown function
5990 *   Bit 5: Z: honour scale changes, NZ: ignore scale changes
5991 *   Bit 4: must be set to zero to avoid problems
5992 *   Bit 3-0: backlight brightness level
5993 *
5994 * brightness_get_raw returns status data in the HBRV layout
5995 *
5996 * WARNING: The X61 has been verified to use HBRV for something else, so
5997 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5998 * testing on the very early *60 Lenovo models...
5999 */
6000
6001enum {
6002	TP_EC_BACKLIGHT = 0x31,
6003
6004	/* TP_EC_BACKLIGHT bitmasks */
6005	TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6006	TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6007	TP_EC_BACKLIGHT_MAPSW = 0x20,
6008};
6009
6010enum tpacpi_brightness_access_mode {
6011	TPACPI_BRGHT_MODE_AUTO = 0,	/* Not implemented yet */
6012	TPACPI_BRGHT_MODE_EC,		/* EC control */
6013	TPACPI_BRGHT_MODE_UCMS_STEP,	/* UCMS step-based control */
6014	TPACPI_BRGHT_MODE_ECNVRAM,	/* EC control w/ NVRAM store */
6015	TPACPI_BRGHT_MODE_MAX
6016};
6017
6018static struct backlight_device *ibm_backlight_device;
6019
6020static enum tpacpi_brightness_access_mode brightness_mode =
6021		TPACPI_BRGHT_MODE_MAX;
6022
6023static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6024
6025static struct mutex brightness_mutex;
6026
6027/* NVRAM brightness access,
6028 * call with brightness_mutex held! */
6029static unsigned int tpacpi_brightness_nvram_get(void)
6030{
6031	u8 lnvram;
6032
6033	lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6034		  & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6035		  >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6036	lnvram &= bright_maxlvl;
6037
6038	return lnvram;
6039}
6040
6041static void tpacpi_brightness_checkpoint_nvram(void)
6042{
6043	u8 lec = 0;
6044	u8 b_nvram;
6045
6046	if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6047		return;
6048
6049	vdbg_printk(TPACPI_DBG_BRGHT,
6050		"trying to checkpoint backlight level to NVRAM...\n");
6051
6052	if (mutex_lock_killable(&brightness_mutex) < 0)
6053		return;
6054
6055	if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6056		goto unlock;
6057	lec &= TP_EC_BACKLIGHT_LVLMSK;
6058	b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6059
6060	if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6061			     >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6062		/* NVRAM needs update */
6063		b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6064				TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6065		b_nvram |= lec;
6066		nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6067		dbg_printk(TPACPI_DBG_BRGHT,
6068			   "updated NVRAM backlight level to %u (0x%02x)\n",
6069			   (unsigned int) lec, (unsigned int) b_nvram);
6070	} else
6071		vdbg_printk(TPACPI_DBG_BRGHT,
6072			   "NVRAM backlight level already is %u (0x%02x)\n",
6073			   (unsigned int) lec, (unsigned int) b_nvram);
6074
6075unlock:
6076	mutex_unlock(&brightness_mutex);
6077}
6078
6079
6080/* call with brightness_mutex held! */
6081static int tpacpi_brightness_get_raw(int *status)
6082{
6083	u8 lec = 0;
6084
6085	switch (brightness_mode) {
6086	case TPACPI_BRGHT_MODE_UCMS_STEP:
6087		*status = tpacpi_brightness_nvram_get();
6088		return 0;
6089	case TPACPI_BRGHT_MODE_EC:
6090	case TPACPI_BRGHT_MODE_ECNVRAM:
6091		if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6092			return -EIO;
6093		*status = lec;
6094		return 0;
6095	default:
6096		return -ENXIO;
6097	}
6098}
6099
6100/* call with brightness_mutex held! */
6101/* do NOT call with illegal backlight level value */
6102static int tpacpi_brightness_set_ec(unsigned int value)
6103{
6104	u8 lec = 0;
6105
6106	if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6107		return -EIO;
6108
6109	if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6110				(lec & TP_EC_BACKLIGHT_CMDMSK) |
6111				(value & TP_EC_BACKLIGHT_LVLMSK))))
6112		return -EIO;
6113
6114	return 0;
6115}
6116
6117/* call with brightness_mutex held! */
6118static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6119{
6120	int cmos_cmd, inc;
6121	unsigned int current_value, i;
6122
6123	current_value = tpacpi_brightness_nvram_get();
6124
6125	if (value == current_value)
6126		return 0;
6127
6128	cmos_cmd = (value > current_value) ?
6129			TP_CMOS_BRIGHTNESS_UP :
6130			TP_CMOS_BRIGHTNESS_DOWN;
6131	inc = (value > current_value) ? 1 : -1;
6132
6133	for (i = current_value; i != value; i += inc)
6134		if (issue_thinkpad_cmos_command(cmos_cmd))
6135			return -EIO;
6136
6137	return 0;
6138}
6139
6140/* May return EINTR which can always be mapped to ERESTARTSYS */
6141static int brightness_set(unsigned int value)
6142{
6143	int res;
6144
6145	if (value > bright_maxlvl || value < 0)
6146		return -EINVAL;
6147
6148	vdbg_printk(TPACPI_DBG_BRGHT,
6149			"set backlight level to %d\n", value);
6150
6151	res = mutex_lock_killable(&brightness_mutex);
6152	if (res < 0)
6153		return res;
6154
6155	switch (brightness_mode) {
6156	case TPACPI_BRGHT_MODE_EC:
6157	case TPACPI_BRGHT_MODE_ECNVRAM:
6158		res = tpacpi_brightness_set_ec(value);
6159		break;
6160	case TPACPI_BRGHT_MODE_UCMS_STEP:
6161		res = tpacpi_brightness_set_ucmsstep(value);
6162		break;
6163	default:
6164		res = -ENXIO;
6165	}
6166
6167	mutex_unlock(&brightness_mutex);
6168	return res;
6169}
6170
6171/* sysfs backlight class ----------------------------------------------- */
6172
6173static int brightness_update_status(struct backlight_device *bd)
6174{
6175	unsigned int level =
6176		(bd->props.fb_blank == FB_BLANK_UNBLANK &&
6177		 bd->props.power == FB_BLANK_UNBLANK) ?
6178				bd->props.brightness : 0;
6179
6180	dbg_printk(TPACPI_DBG_BRGHT,
6181			"backlight: attempt to set level to %d\n",
6182			level);
6183
6184	/* it is the backlight class's job (caller) to handle
6185	 * EINTR and other errors properly */
6186	return brightness_set(level);
6187}
6188
6189static int brightness_get(struct backlight_device *bd)
6190{
6191	int status, res;
6192
6193	res = mutex_lock_killable(&brightness_mutex);
6194	if (res < 0)
6195		return 0;
6196
6197	res = tpacpi_brightness_get_raw(&status);
6198
6199	mutex_unlock(&brightness_mutex);
6200
6201	if (res < 0)
6202		return 0;
6203
6204	return status & TP_EC_BACKLIGHT_LVLMSK;
6205}
6206
6207static void tpacpi_brightness_notify_change(void)
6208{
6209	backlight_force_update(ibm_backlight_device,
6210			       BACKLIGHT_UPDATE_HOTKEY);
6211}
6212
6213static const struct backlight_ops ibm_backlight_data = {
6214	.get_brightness = brightness_get,
6215	.update_status  = brightness_update_status,
6216};
6217
6218/* --------------------------------------------------------------------- */
6219
6220/*
6221 * Call _BCL method of video device.  On some ThinkPads this will
6222 * switch the firmware to the ACPI brightness control mode.
6223 */
6224
6225static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6226{
6227	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6228	union acpi_object *obj;
6229	struct acpi_device *device, *child;
6230	int rc;
6231
6232	if (acpi_bus_get_device(handle, &device))
6233		return 0;
6234
6235	rc = 0;
6236	list_for_each_entry(child, &device->children, node) {
6237		acpi_status status = acpi_evaluate_object(child->handle, "_BCL",
6238							  NULL, &buffer);
6239		if (ACPI_FAILURE(status))
6240			continue;
6241
6242		obj = (union acpi_object *)buffer.pointer;
6243		if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6244			pr_err("Unknown _BCL data, please report this to %s\n",
6245				TPACPI_MAIL);
6246			rc = 0;
6247		} else {
6248			rc = obj->package.count;
6249		}
6250		break;
 
6251	}
6252
6253	kfree(buffer.pointer);
6254	return rc;
6255}
6256
6257
6258/*
6259 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6260 */
6261static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6262{
6263	acpi_handle video_device;
6264	int bcl_levels = 0;
6265
6266	tpacpi_acpi_handle_locate("video", NULL, &video_device);
6267	if (video_device)
6268		bcl_levels = tpacpi_query_bcl_levels(video_device);
6269
6270	tp_features.bright_acpimode = (bcl_levels > 0);
6271
6272	return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6273}
6274
6275/*
6276 * These are only useful for models that have only one possibility
6277 * of GPU.  If the BIOS model handles both ATI and Intel, don't use
6278 * these quirks.
6279 */
6280#define TPACPI_BRGHT_Q_NOEC	0x0001	/* Must NOT use EC HBRV */
6281#define TPACPI_BRGHT_Q_EC	0x0002  /* Should or must use EC HBRV */
6282#define TPACPI_BRGHT_Q_ASK	0x8000	/* Ask for user report */
6283
6284static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6285	/* Models with ATI GPUs known to require ECNVRAM mode */
6286	TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC),	/* T43/p ATI */
6287
6288	/* Models with ATI GPUs that can use ECNVRAM */
6289	TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC),	/* R50,51 T40-42 */
6290	TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6291	TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC),	/* R52 */
6292	TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6293
6294	/* Models with Intel Extreme Graphics 2 */
6295	TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC),	/* X40 */
6296	TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6297	TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6298
6299	/* Models with Intel GMA900 */
6300	TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC),	/* T43, R52 */
6301	TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC),	/* X41 */
6302	TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC),	/* X41 Tablet */
6303};
6304
6305/*
6306 * Returns < 0 for error, otherwise sets tp_features.bright_*
6307 * and bright_maxlvl.
6308 */
6309static void __init tpacpi_detect_brightness_capabilities(void)
6310{
6311	unsigned int b;
6312
6313	vdbg_printk(TPACPI_DBG_INIT,
6314		    "detecting firmware brightness interface capabilities\n");
6315
6316	/* we could run a quirks check here (same table used by
6317	 * brightness_init) if needed */
6318
6319	/*
6320	 * We always attempt to detect acpi support, so as to switch
6321	 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6322	 * going to publish a backlight interface
6323	 */
6324	b = tpacpi_check_std_acpi_brightness_support();
6325	switch (b) {
6326	case 16:
6327		bright_maxlvl = 15;
6328		pr_info("detected a 16-level brightness capable ThinkPad\n");
6329		break;
6330	case 8:
6331	case 0:
6332		bright_maxlvl = 7;
6333		pr_info("detected a 8-level brightness capable ThinkPad\n");
6334		break;
6335	default:
6336		pr_err("Unsupported brightness interface, "
6337		       "please contact %s\n", TPACPI_MAIL);
6338		tp_features.bright_unkfw = 1;
6339		bright_maxlvl = b - 1;
6340	}
6341}
6342
6343static int __init brightness_init(struct ibm_init_struct *iibm)
6344{
6345	struct backlight_properties props;
6346	int b;
6347	unsigned long quirks;
6348
6349	vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6350
6351	mutex_init(&brightness_mutex);
6352
6353	quirks = tpacpi_check_quirks(brightness_quirk_table,
6354				ARRAY_SIZE(brightness_quirk_table));
6355
6356	/* tpacpi_detect_brightness_capabilities() must have run already */
6357
6358	/* if it is unknown, we don't handle it: it wouldn't be safe */
6359	if (tp_features.bright_unkfw)
6360		return 1;
6361
6362	if (!brightness_enable) {
6363		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6364			   "brightness support disabled by "
6365			   "module parameter\n");
6366		return 1;
6367	}
6368
6369	if (acpi_video_backlight_support()) {
6370		if (brightness_enable > 1) {
6371			pr_info("Standard ACPI backlight interface "
6372				"available, not loading native one\n");
6373			return 1;
6374		} else if (brightness_enable == 1) {
6375			pr_warn("Cannot enable backlight brightness support, "
6376				"ACPI is already handling it.  Refer to the "
6377				"acpi_backlight kernel parameter.\n");
6378			return 1;
6379		}
6380	} else if (tp_features.bright_acpimode && brightness_enable > 1) {
6381		pr_notice("Standard ACPI backlight interface not "
6382			  "available, thinkpad_acpi native "
6383			  "brightness control enabled\n");
6384	}
6385
6386	/*
6387	 * Check for module parameter bogosity, note that we
6388	 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6389	 * able to detect "unspecified"
6390	 */
6391	if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6392		return -EINVAL;
6393
6394	/* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6395	if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6396	    brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6397		if (quirks & TPACPI_BRGHT_Q_EC)
6398			brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6399		else
6400			brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6401
6402		dbg_printk(TPACPI_DBG_BRGHT,
6403			   "driver auto-selected brightness_mode=%d\n",
6404			   brightness_mode);
6405	}
6406
6407	/* Safety */
6408	if (!tpacpi_is_ibm() &&
6409	    (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6410	     brightness_mode == TPACPI_BRGHT_MODE_EC))
6411		return -EINVAL;
6412
6413	if (tpacpi_brightness_get_raw(&b) < 0)
6414		return 1;
6415
6416	memset(&props, 0, sizeof(struct backlight_properties));
6417	props.type = BACKLIGHT_PLATFORM;
6418	props.max_brightness = bright_maxlvl;
6419	props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6420	ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6421							 NULL, NULL,
6422							 &ibm_backlight_data,
6423							 &props);
6424	if (IS_ERR(ibm_backlight_device)) {
6425		int rc = PTR_ERR(ibm_backlight_device);
6426		ibm_backlight_device = NULL;
6427		pr_err("Could not register backlight device\n");
6428		return rc;
6429	}
6430	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6431			"brightness is supported\n");
6432
6433	if (quirks & TPACPI_BRGHT_Q_ASK) {
6434		pr_notice("brightness: will use unverified default: "
6435			  "brightness_mode=%d\n", brightness_mode);
6436		pr_notice("brightness: please report to %s whether it works well "
6437			  "or not on your ThinkPad\n", TPACPI_MAIL);
6438	}
6439
6440	/* Added by mistake in early 2007.  Probably useless, but it could
6441	 * be working around some unknown firmware problem where the value
6442	 * read at startup doesn't match the real hardware state... so leave
6443	 * it in place just in case */
6444	backlight_update_status(ibm_backlight_device);
6445
6446	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6447			"brightness: registering brightness hotkeys "
6448			"as change notification\n");
6449	tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6450				| TP_ACPI_HKEY_BRGHTUP_MASK
6451				| TP_ACPI_HKEY_BRGHTDWN_MASK);
6452	return 0;
6453}
6454
6455static void brightness_suspend(void)
6456{
6457	tpacpi_brightness_checkpoint_nvram();
6458}
6459
6460static void brightness_shutdown(void)
6461{
6462	tpacpi_brightness_checkpoint_nvram();
6463}
6464
6465static void brightness_exit(void)
6466{
6467	if (ibm_backlight_device) {
6468		vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6469			    "calling backlight_device_unregister()\n");
6470		backlight_device_unregister(ibm_backlight_device);
6471	}
6472
6473	tpacpi_brightness_checkpoint_nvram();
6474}
6475
6476static int brightness_read(struct seq_file *m)
6477{
6478	int level;
6479
6480	level = brightness_get(NULL);
6481	if (level < 0) {
6482		seq_printf(m, "level:\t\tunreadable\n");
6483	} else {
6484		seq_printf(m, "level:\t\t%d\n", level);
6485		seq_printf(m, "commands:\tup, down\n");
6486		seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6487			       bright_maxlvl);
6488	}
6489
6490	return 0;
6491}
6492
6493static int brightness_write(char *buf)
6494{
6495	int level;
6496	int rc;
6497	char *cmd;
6498
6499	level = brightness_get(NULL);
6500	if (level < 0)
6501		return level;
6502
6503	while ((cmd = next_cmd(&buf))) {
6504		if (strlencmp(cmd, "up") == 0) {
6505			if (level < bright_maxlvl)
6506				level++;
6507		} else if (strlencmp(cmd, "down") == 0) {
6508			if (level > 0)
6509				level--;
6510		} else if (sscanf(cmd, "level %d", &level) == 1 &&
6511			   level >= 0 && level <= bright_maxlvl) {
6512			/* new level set */
6513		} else
6514			return -EINVAL;
6515	}
6516
6517	tpacpi_disclose_usertask("procfs brightness",
6518			"set level to %d\n", level);
6519
6520	/*
6521	 * Now we know what the final level should be, so we try to set it.
6522	 * Doing it this way makes the syscall restartable in case of EINTR
6523	 */
6524	rc = brightness_set(level);
6525	if (!rc && ibm_backlight_device)
6526		backlight_force_update(ibm_backlight_device,
6527					BACKLIGHT_UPDATE_SYSFS);
6528	return (rc == -EINTR)? -ERESTARTSYS : rc;
6529}
6530
6531static struct ibm_struct brightness_driver_data = {
6532	.name = "brightness",
6533	.read = brightness_read,
6534	.write = brightness_write,
6535	.exit = brightness_exit,
6536	.suspend = brightness_suspend,
6537	.shutdown = brightness_shutdown,
6538};
6539
6540/*************************************************************************
6541 * Volume subdriver
6542 */
6543
6544/*
6545 * IBM ThinkPads have a simple volume controller with MUTE gating.
6546 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6547 *
6548 * Since the *61 series (and probably also the later *60 series), Lenovo
6549 * ThinkPads only implement the MUTE gate.
6550 *
6551 * EC register 0x30
6552 *   Bit 6: MUTE (1 mutes sound)
6553 *   Bit 3-0: Volume
6554 *   Other bits should be zero as far as we know.
6555 *
6556 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6557 * bits 3-0 (volume).  Other bits in NVRAM may have other functions,
6558 * such as bit 7 which is used to detect repeated presses of MUTE,
6559 * and we leave them unchanged.
6560 */
6561
6562#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6563
6564#define TPACPI_ALSA_DRVNAME  "ThinkPad EC"
6565#define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6566#define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6567
6568#if SNDRV_CARDS <= 32
6569#define DEFAULT_ALSA_IDX		~((1 << (SNDRV_CARDS - 3)) - 1)
6570#else
6571#define DEFAULT_ALSA_IDX		~((1 << (32 - 3)) - 1)
6572#endif
6573static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
6574static char *alsa_id = "ThinkPadEC";
6575static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
6576
6577struct tpacpi_alsa_data {
6578	struct snd_card *card;
6579	struct snd_ctl_elem_id *ctl_mute_id;
6580	struct snd_ctl_elem_id *ctl_vol_id;
6581};
6582
6583static struct snd_card *alsa_card;
6584
6585enum {
6586	TP_EC_AUDIO = 0x30,
6587
6588	/* TP_EC_AUDIO bits */
6589	TP_EC_AUDIO_MUTESW = 6,
6590
6591	/* TP_EC_AUDIO bitmasks */
6592	TP_EC_AUDIO_LVL_MSK = 0x0F,
6593	TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6594
6595	/* Maximum volume */
6596	TP_EC_VOLUME_MAX = 14,
6597};
6598
6599enum tpacpi_volume_access_mode {
6600	TPACPI_VOL_MODE_AUTO = 0,	/* Not implemented yet */
6601	TPACPI_VOL_MODE_EC,		/* Pure EC control */
6602	TPACPI_VOL_MODE_UCMS_STEP,	/* UCMS step-based control: N/A */
6603	TPACPI_VOL_MODE_ECNVRAM,	/* EC control w/ NVRAM store */
6604	TPACPI_VOL_MODE_MAX
6605};
6606
6607enum tpacpi_volume_capabilities {
6608	TPACPI_VOL_CAP_AUTO = 0,	/* Use white/blacklist */
6609	TPACPI_VOL_CAP_VOLMUTE,		/* Output vol and mute */
6610	TPACPI_VOL_CAP_MUTEONLY,	/* Output mute only */
6611	TPACPI_VOL_CAP_MAX
6612};
6613
6614static enum tpacpi_volume_access_mode volume_mode =
6615	TPACPI_VOL_MODE_MAX;
6616
6617static enum tpacpi_volume_capabilities volume_capabilities;
6618static bool volume_control_allowed;
6619
6620/*
6621 * Used to syncronize writers to TP_EC_AUDIO and
6622 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6623 */
6624static struct mutex volume_mutex;
6625
6626static void tpacpi_volume_checkpoint_nvram(void)
6627{
6628	u8 lec = 0;
6629	u8 b_nvram;
6630	u8 ec_mask;
6631
6632	if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6633		return;
6634	if (!volume_control_allowed)
6635		return;
6636
6637	vdbg_printk(TPACPI_DBG_MIXER,
6638		"trying to checkpoint mixer state to NVRAM...\n");
6639
6640	if (tp_features.mixer_no_level_control)
6641		ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6642	else
6643		ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6644
6645	if (mutex_lock_killable(&volume_mutex) < 0)
6646		return;
6647
6648	if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6649		goto unlock;
6650	lec &= ec_mask;
6651	b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6652
6653	if (lec != (b_nvram & ec_mask)) {
6654		/* NVRAM needs update */
6655		b_nvram &= ~ec_mask;
6656		b_nvram |= lec;
6657		nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6658		dbg_printk(TPACPI_DBG_MIXER,
6659			   "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6660			   (unsigned int) lec, (unsigned int) b_nvram);
6661	} else {
6662		vdbg_printk(TPACPI_DBG_MIXER,
6663			   "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6664			   (unsigned int) lec, (unsigned int) b_nvram);
6665	}
6666
6667unlock:
6668	mutex_unlock(&volume_mutex);
6669}
6670
6671static int volume_get_status_ec(u8 *status)
6672{
6673	u8 s;
6674
6675	if (!acpi_ec_read(TP_EC_AUDIO, &s))
6676		return -EIO;
6677
6678	*status = s;
6679
6680	dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6681
6682	return 0;
6683}
6684
6685static int volume_get_status(u8 *status)
6686{
6687	return volume_get_status_ec(status);
6688}
6689
6690static int volume_set_status_ec(const u8 status)
6691{
6692	if (!acpi_ec_write(TP_EC_AUDIO, status))
6693		return -EIO;
6694
6695	dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6696
6697	return 0;
6698}
6699
6700static int volume_set_status(const u8 status)
6701{
6702	return volume_set_status_ec(status);
6703}
6704
6705/* returns < 0 on error, 0 on no change, 1 on change */
6706static int __volume_set_mute_ec(const bool mute)
6707{
6708	int rc;
6709	u8 s, n;
6710
6711	if (mutex_lock_killable(&volume_mutex) < 0)
6712		return -EINTR;
6713
6714	rc = volume_get_status_ec(&s);
6715	if (rc)
6716		goto unlock;
6717
6718	n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6719		     s & ~TP_EC_AUDIO_MUTESW_MSK;
6720
6721	if (n != s) {
6722		rc = volume_set_status_ec(n);
6723		if (!rc)
6724			rc = 1;
6725	}
6726
6727unlock:
6728	mutex_unlock(&volume_mutex);
6729	return rc;
6730}
6731
6732static int volume_alsa_set_mute(const bool mute)
6733{
6734	dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6735		   (mute) ? "" : "un");
6736	return __volume_set_mute_ec(mute);
6737}
6738
6739static int volume_set_mute(const bool mute)
6740{
6741	int rc;
6742
6743	dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6744		   (mute) ? "" : "un");
6745
6746	rc = __volume_set_mute_ec(mute);
6747	return (rc < 0) ? rc : 0;
6748}
6749
6750/* returns < 0 on error, 0 on no change, 1 on change */
6751static int __volume_set_volume_ec(const u8 vol)
6752{
6753	int rc;
6754	u8 s, n;
6755
6756	if (vol > TP_EC_VOLUME_MAX)
6757		return -EINVAL;
6758
6759	if (mutex_lock_killable(&volume_mutex) < 0)
6760		return -EINTR;
6761
6762	rc = volume_get_status_ec(&s);
6763	if (rc)
6764		goto unlock;
6765
6766	n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6767
6768	if (n != s) {
6769		rc = volume_set_status_ec(n);
6770		if (!rc)
6771			rc = 1;
6772	}
6773
6774unlock:
6775	mutex_unlock(&volume_mutex);
6776	return rc;
6777}
6778
6779static int volume_alsa_set_volume(const u8 vol)
6780{
6781	dbg_printk(TPACPI_DBG_MIXER,
6782		   "ALSA: trying to set volume level to %hu\n", vol);
6783	return __volume_set_volume_ec(vol);
6784}
6785
6786static void volume_alsa_notify_change(void)
6787{
6788	struct tpacpi_alsa_data *d;
6789
6790	if (alsa_card && alsa_card->private_data) {
6791		d = alsa_card->private_data;
6792		if (d->ctl_mute_id)
6793			snd_ctl_notify(alsa_card,
6794					SNDRV_CTL_EVENT_MASK_VALUE,
6795					d->ctl_mute_id);
6796		if (d->ctl_vol_id)
6797			snd_ctl_notify(alsa_card,
6798					SNDRV_CTL_EVENT_MASK_VALUE,
6799					d->ctl_vol_id);
6800	}
6801}
6802
6803static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6804				struct snd_ctl_elem_info *uinfo)
6805{
6806	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6807	uinfo->count = 1;
6808	uinfo->value.integer.min = 0;
6809	uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6810	return 0;
6811}
6812
6813static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6814				struct snd_ctl_elem_value *ucontrol)
6815{
6816	u8 s;
6817	int rc;
6818
6819	rc = volume_get_status(&s);
6820	if (rc < 0)
6821		return rc;
6822
6823	ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6824	return 0;
6825}
6826
6827static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6828				struct snd_ctl_elem_value *ucontrol)
6829{
6830	tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
6831				 ucontrol->value.integer.value[0]);
6832	return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6833}
6834
6835#define volume_alsa_mute_info snd_ctl_boolean_mono_info
6836
6837static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6838				struct snd_ctl_elem_value *ucontrol)
6839{
6840	u8 s;
6841	int rc;
6842
6843	rc = volume_get_status(&s);
6844	if (rc < 0)
6845		return rc;
6846
6847	ucontrol->value.integer.value[0] =
6848				(s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6849	return 0;
6850}
6851
6852static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6853				struct snd_ctl_elem_value *ucontrol)
6854{
6855	tpacpi_disclose_usertask("ALSA", "%smute\n",
6856				 ucontrol->value.integer.value[0] ?
6857					"un" : "");
6858	return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6859}
6860
6861static struct snd_kcontrol_new volume_alsa_control_vol = {
6862	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6863	.name = "Console Playback Volume",
6864	.index = 0,
6865	.access = SNDRV_CTL_ELEM_ACCESS_READ,
6866	.info = volume_alsa_vol_info,
6867	.get = volume_alsa_vol_get,
6868};
6869
6870static struct snd_kcontrol_new volume_alsa_control_mute = {
6871	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6872	.name = "Console Playback Switch",
6873	.index = 0,
6874	.access = SNDRV_CTL_ELEM_ACCESS_READ,
6875	.info = volume_alsa_mute_info,
6876	.get = volume_alsa_mute_get,
6877};
6878
6879static void volume_suspend(void)
6880{
6881	tpacpi_volume_checkpoint_nvram();
6882}
6883
6884static void volume_resume(void)
6885{
6886	volume_alsa_notify_change();
6887}
6888
6889static void volume_shutdown(void)
6890{
6891	tpacpi_volume_checkpoint_nvram();
6892}
6893
6894static void volume_exit(void)
6895{
6896	if (alsa_card) {
6897		snd_card_free(alsa_card);
6898		alsa_card = NULL;
6899	}
6900
6901	tpacpi_volume_checkpoint_nvram();
6902}
6903
6904static int __init volume_create_alsa_mixer(void)
6905{
6906	struct snd_card *card;
6907	struct tpacpi_alsa_data *data;
6908	struct snd_kcontrol *ctl_vol;
6909	struct snd_kcontrol *ctl_mute;
6910	int rc;
6911
6912	rc = snd_card_new(&tpacpi_pdev->dev,
6913			  alsa_index, alsa_id, THIS_MODULE,
6914			  sizeof(struct tpacpi_alsa_data), &card);
6915	if (rc < 0 || !card) {
6916		pr_err("Failed to create ALSA card structures: %d\n", rc);
6917		return 1;
6918	}
6919
6920	BUG_ON(!card->private_data);
6921	data = card->private_data;
6922	data->card = card;
6923
6924	strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6925		sizeof(card->driver));
6926	strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6927		sizeof(card->shortname));
6928	snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6929		 (thinkpad_id.ec_version_str) ?
6930			thinkpad_id.ec_version_str : "(unknown)");
6931	snprintf(card->longname, sizeof(card->longname),
6932		 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6933		 (thinkpad_id.ec_version_str) ?
6934			thinkpad_id.ec_version_str : "unknown");
6935
6936	if (volume_control_allowed) {
6937		volume_alsa_control_vol.put = volume_alsa_vol_put;
6938		volume_alsa_control_vol.access =
6939				SNDRV_CTL_ELEM_ACCESS_READWRITE;
6940
6941		volume_alsa_control_mute.put = volume_alsa_mute_put;
6942		volume_alsa_control_mute.access =
6943				SNDRV_CTL_ELEM_ACCESS_READWRITE;
6944	}
6945
6946	if (!tp_features.mixer_no_level_control) {
6947		ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6948		rc = snd_ctl_add(card, ctl_vol);
6949		if (rc < 0) {
6950			pr_err("Failed to create ALSA volume control: %d\n",
6951			       rc);
6952			goto err_exit;
6953		}
6954		data->ctl_vol_id = &ctl_vol->id;
6955	}
6956
6957	ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6958	rc = snd_ctl_add(card, ctl_mute);
6959	if (rc < 0) {
6960		pr_err("Failed to create ALSA mute control: %d\n", rc);
6961		goto err_exit;
6962	}
6963	data->ctl_mute_id = &ctl_mute->id;
6964
 
6965	rc = snd_card_register(card);
6966	if (rc < 0) {
6967		pr_err("Failed to register ALSA card: %d\n", rc);
6968		goto err_exit;
6969	}
6970
6971	alsa_card = card;
6972	return 0;
6973
6974err_exit:
6975	snd_card_free(card);
6976	return 1;
6977}
6978
6979#define TPACPI_VOL_Q_MUTEONLY	0x0001	/* Mute-only control available */
6980#define TPACPI_VOL_Q_LEVEL	0x0002  /* Volume control available */
6981
6982static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6983	/* Whitelist volume level on all IBM by default */
6984	{ .vendor = PCI_VENDOR_ID_IBM,
6985	  .bios   = TPACPI_MATCH_ANY,
6986	  .ec     = TPACPI_MATCH_ANY,
6987	  .quirks = TPACPI_VOL_Q_LEVEL },
6988
6989	/* Lenovo models with volume control (needs confirmation) */
6990	TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6991	TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6992	TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6993	TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6994	TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6995	TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6996	TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6997
6998	/* Whitelist mute-only on all Lenovo by default */
6999	{ .vendor = PCI_VENDOR_ID_LENOVO,
7000	  .bios   = TPACPI_MATCH_ANY,
7001	  .ec	  = TPACPI_MATCH_ANY,
7002	  .quirks = TPACPI_VOL_Q_MUTEONLY }
7003};
7004
7005static int __init volume_init(struct ibm_init_struct *iibm)
7006{
7007	unsigned long quirks;
7008	int rc;
7009
7010	vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7011
7012	mutex_init(&volume_mutex);
7013
7014	/*
7015	 * Check for module parameter bogosity, note that we
7016	 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7017	 * able to detect "unspecified"
7018	 */
7019	if (volume_mode > TPACPI_VOL_MODE_MAX)
7020		return -EINVAL;
7021
7022	if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7023		pr_err("UCMS step volume mode not implemented, "
7024		       "please contact %s\n", TPACPI_MAIL);
7025		return 1;
7026	}
7027
7028	if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7029		return -EINVAL;
7030
7031	/*
7032	 * The ALSA mixer is our primary interface.
7033	 * When disabled, don't install the subdriver at all
7034	 */
7035	if (!alsa_enable) {
7036		vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7037			    "ALSA mixer disabled by parameter, "
7038			    "not loading volume subdriver...\n");
7039		return 1;
7040	}
7041
7042	quirks = tpacpi_check_quirks(volume_quirk_table,
7043				     ARRAY_SIZE(volume_quirk_table));
7044
7045	switch (volume_capabilities) {
7046	case TPACPI_VOL_CAP_AUTO:
7047		if (quirks & TPACPI_VOL_Q_MUTEONLY)
7048			tp_features.mixer_no_level_control = 1;
7049		else if (quirks & TPACPI_VOL_Q_LEVEL)
7050			tp_features.mixer_no_level_control = 0;
7051		else
7052			return 1; /* no mixer */
7053		break;
7054	case TPACPI_VOL_CAP_VOLMUTE:
7055		tp_features.mixer_no_level_control = 0;
7056		break;
7057	case TPACPI_VOL_CAP_MUTEONLY:
7058		tp_features.mixer_no_level_control = 1;
7059		break;
7060	default:
7061		return 1;
7062	}
7063
7064	if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7065		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7066				"using user-supplied volume_capabilities=%d\n",
7067				volume_capabilities);
7068
7069	if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7070	    volume_mode == TPACPI_VOL_MODE_MAX) {
7071		volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7072
7073		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7074				"driver auto-selected volume_mode=%d\n",
7075				volume_mode);
7076	} else {
7077		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7078				"using user-supplied volume_mode=%d\n",
7079				volume_mode);
7080	}
7081
7082	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7083			"mute is supported, volume control is %s\n",
7084			str_supported(!tp_features.mixer_no_level_control));
7085
7086	rc = volume_create_alsa_mixer();
7087	if (rc) {
7088		pr_err("Could not create the ALSA mixer interface\n");
7089		return rc;
7090	}
7091
7092	pr_info("Console audio control enabled, mode: %s\n",
7093		(volume_control_allowed) ?
7094			"override (read/write)" :
7095			"monitor (read only)");
7096
7097	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7098		"registering volume hotkeys as change notification\n");
7099	tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7100			| TP_ACPI_HKEY_VOLUP_MASK
7101			| TP_ACPI_HKEY_VOLDWN_MASK
7102			| TP_ACPI_HKEY_MUTE_MASK);
7103
7104	return 0;
7105}
7106
7107static int volume_read(struct seq_file *m)
7108{
7109	u8 status;
7110
7111	if (volume_get_status(&status) < 0) {
7112		seq_printf(m, "level:\t\tunreadable\n");
7113	} else {
7114		if (tp_features.mixer_no_level_control)
7115			seq_printf(m, "level:\t\tunsupported\n");
7116		else
7117			seq_printf(m, "level:\t\t%d\n",
7118					status & TP_EC_AUDIO_LVL_MSK);
7119
7120		seq_printf(m, "mute:\t\t%s\n",
7121				onoff(status, TP_EC_AUDIO_MUTESW));
7122
7123		if (volume_control_allowed) {
7124			seq_printf(m, "commands:\tunmute, mute\n");
7125			if (!tp_features.mixer_no_level_control) {
7126				seq_printf(m,
7127					       "commands:\tup, down\n");
7128				seq_printf(m,
7129					       "commands:\tlevel <level>"
7130					       " (<level> is 0-%d)\n",
7131					       TP_EC_VOLUME_MAX);
7132			}
7133		}
7134	}
7135
7136	return 0;
7137}
7138
7139static int volume_write(char *buf)
7140{
7141	u8 s;
7142	u8 new_level, new_mute;
7143	int l;
7144	char *cmd;
7145	int rc;
7146
7147	/*
7148	 * We do allow volume control at driver startup, so that the
7149	 * user can set initial state through the volume=... parameter hack.
7150	 */
7151	if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7152		if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7153			tp_warned.volume_ctrl_forbidden = 1;
7154			pr_notice("Console audio control in monitor mode, "
7155				  "changes are not allowed\n");
7156			pr_notice("Use the volume_control=1 module parameter "
7157				  "to enable volume control\n");
7158		}
7159		return -EPERM;
7160	}
7161
7162	rc = volume_get_status(&s);
7163	if (rc < 0)
7164		return rc;
7165
7166	new_level = s & TP_EC_AUDIO_LVL_MSK;
7167	new_mute  = s & TP_EC_AUDIO_MUTESW_MSK;
7168
7169	while ((cmd = next_cmd(&buf))) {
7170		if (!tp_features.mixer_no_level_control) {
7171			if (strlencmp(cmd, "up") == 0) {
7172				if (new_mute)
7173					new_mute = 0;
7174				else if (new_level < TP_EC_VOLUME_MAX)
7175					new_level++;
7176				continue;
7177			} else if (strlencmp(cmd, "down") == 0) {
7178				if (new_mute)
7179					new_mute = 0;
7180				else if (new_level > 0)
7181					new_level--;
7182				continue;
7183			} else if (sscanf(cmd, "level %u", &l) == 1 &&
7184				   l >= 0 && l <= TP_EC_VOLUME_MAX) {
7185					new_level = l;
7186				continue;
7187			}
7188		}
7189		if (strlencmp(cmd, "mute") == 0)
7190			new_mute = TP_EC_AUDIO_MUTESW_MSK;
7191		else if (strlencmp(cmd, "unmute") == 0)
7192			new_mute = 0;
7193		else
7194			return -EINVAL;
7195	}
7196
7197	if (tp_features.mixer_no_level_control) {
7198		tpacpi_disclose_usertask("procfs volume", "%smute\n",
7199					new_mute ? "" : "un");
7200		rc = volume_set_mute(!!new_mute);
7201	} else {
7202		tpacpi_disclose_usertask("procfs volume",
7203					"%smute and set level to %d\n",
7204					new_mute ? "" : "un", new_level);
7205		rc = volume_set_status(new_mute | new_level);
7206	}
7207	volume_alsa_notify_change();
7208
7209	return (rc == -EINTR) ? -ERESTARTSYS : rc;
7210}
7211
7212static struct ibm_struct volume_driver_data = {
7213	.name = "volume",
7214	.read = volume_read,
7215	.write = volume_write,
7216	.exit = volume_exit,
7217	.suspend = volume_suspend,
7218	.resume = volume_resume,
7219	.shutdown = volume_shutdown,
7220};
7221
7222#else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7223
7224#define alsa_card NULL
7225
7226static void inline volume_alsa_notify_change(void)
7227{
7228}
7229
7230static int __init volume_init(struct ibm_init_struct *iibm)
7231{
7232	pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7233
7234	return 1;
7235}
7236
7237static struct ibm_struct volume_driver_data = {
7238	.name = "volume",
7239};
7240
7241#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7242
7243/*************************************************************************
7244 * Fan subdriver
7245 */
7246
7247/*
7248 * FAN ACCESS MODES
7249 *
7250 * TPACPI_FAN_RD_ACPI_GFAN:
7251 * 	ACPI GFAN method: returns fan level
7252 *
7253 * 	see TPACPI_FAN_WR_ACPI_SFAN
7254 * 	EC 0x2f (HFSP) not available if GFAN exists
7255 *
7256 * TPACPI_FAN_WR_ACPI_SFAN:
7257 * 	ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7258 *
7259 * 	EC 0x2f (HFSP) might be available *for reading*, but do not use
7260 * 	it for writing.
7261 *
7262 * TPACPI_FAN_WR_TPEC:
7263 * 	ThinkPad EC register 0x2f (HFSP): fan control loop mode
7264 * 	Supported on almost all ThinkPads
7265 *
7266 * 	Fan speed changes of any sort (including those caused by the
7267 * 	disengaged mode) are usually done slowly by the firmware as the
7268 * 	maximum amount of fan duty cycle change per second seems to be
7269 * 	limited.
7270 *
7271 * 	Reading is not available if GFAN exists.
7272 * 	Writing is not available if SFAN exists.
7273 *
7274 * 	Bits
7275 *	 7	automatic mode engaged;
7276 *  		(default operation mode of the ThinkPad)
7277 * 		fan level is ignored in this mode.
7278 *	 6	full speed mode (takes precedence over bit 7);
7279 *		not available on all thinkpads.  May disable
7280 *		the tachometer while the fan controller ramps up
7281 *		the speed (which can take up to a few *minutes*).
7282 *		Speeds up fan to 100% duty-cycle, which is far above
7283 *		the standard RPM levels.  It is not impossible that
7284 *		it could cause hardware damage.
7285 *	5-3	unused in some models.  Extra bits for fan level
7286 *		in others, but still useless as all values above
7287 *		7 map to the same speed as level 7 in these models.
7288 *	2-0	fan level (0..7 usually)
7289 *			0x00 = stop
7290 * 			0x07 = max (set when temperatures critical)
7291 * 		Some ThinkPads may have other levels, see
7292 * 		TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7293 *
7294 *	FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7295 *	boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7296 *	does so, its initial value is meaningless (0x07).
7297 *
7298 *	For firmware bugs, refer to:
7299 *	http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7300 *
7301 * 	----
7302 *
7303 *	ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7304 *	Main fan tachometer reading (in RPM)
7305 *
7306 *	This register is present on all ThinkPads with a new-style EC, and
7307 *	it is known not to be present on the A21m/e, and T22, as there is
7308 *	something else in offset 0x84 according to the ACPI DSDT.  Other
7309 *	ThinkPads from this same time period (and earlier) probably lack the
7310 *	tachometer as well.
7311 *
7312 *	Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7313 *	was never fixed by IBM to report the EC firmware version string
7314 *	probably support the tachometer (like the early X models), so
7315 *	detecting it is quite hard.  We need more data to know for sure.
7316 *
7317 *	FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7318 *	might result.
7319 *
7320 *	FIRMWARE BUG: may go stale while the EC is switching to full speed
7321 *	mode.
7322 *
7323 *	For firmware bugs, refer to:
7324 *	http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7325 *
7326 *	----
7327 *
7328 *	ThinkPad EC register 0x31 bit 0 (only on select models)
7329 *
7330 *	When bit 0 of EC register 0x31 is zero, the tachometer registers
7331 *	show the speed of the main fan.  When bit 0 of EC register 0x31
7332 *	is one, the tachometer registers show the speed of the auxiliary
7333 *	fan.
7334 *
7335 *	Fan control seems to affect both fans, regardless of the state
7336 *	of this bit.
7337 *
7338 *	So far, only the firmware for the X60/X61 non-tablet versions
7339 *	seem to support this (firmware TP-7M).
7340 *
7341 * TPACPI_FAN_WR_ACPI_FANS:
7342 *	ThinkPad X31, X40, X41.  Not available in the X60.
7343 *
7344 *	FANS ACPI handle: takes three arguments: low speed, medium speed,
7345 *	high speed.  ACPI DSDT seems to map these three speeds to levels
7346 *	as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7347 *	(this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7348 *
7349 * 	The speeds are stored on handles
7350 * 	(FANA:FAN9), (FANC:FANB), (FANE:FAND).
7351 *
7352 * 	There are three default speed sets, accessible as handles:
7353 * 	FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7354 *
7355 * 	ACPI DSDT switches which set is in use depending on various
7356 * 	factors.
7357 *
7358 * 	TPACPI_FAN_WR_TPEC is also available and should be used to
7359 * 	command the fan.  The X31/X40/X41 seems to have 8 fan levels,
7360 * 	but the ACPI tables just mention level 7.
7361 */
7362
7363enum {					/* Fan control constants */
7364	fan_status_offset = 0x2f,	/* EC register 0x2f */
7365	fan_rpm_offset = 0x84,		/* EC register 0x84: LSB, 0x85 MSB (RPM)
7366					 * 0x84 must be read before 0x85 */
7367	fan_select_offset = 0x31,	/* EC register 0x31 (Firmware 7M)
7368					   bit 0 selects which fan is active */
7369
7370	TP_EC_FAN_FULLSPEED = 0x40,	/* EC fan mode: full speed */
7371	TP_EC_FAN_AUTO	    = 0x80,	/* EC fan mode: auto fan control */
7372
7373	TPACPI_FAN_LAST_LEVEL = 0x100,	/* Use cached last-seen fan level */
7374};
7375
7376enum fan_status_access_mode {
7377	TPACPI_FAN_NONE = 0,		/* No fan status or control */
7378	TPACPI_FAN_RD_ACPI_GFAN,	/* Use ACPI GFAN */
7379	TPACPI_FAN_RD_TPEC,		/* Use ACPI EC regs 0x2f, 0x84-0x85 */
7380};
7381
7382enum fan_control_access_mode {
7383	TPACPI_FAN_WR_NONE = 0,		/* No fan control */
7384	TPACPI_FAN_WR_ACPI_SFAN,	/* Use ACPI SFAN */
7385	TPACPI_FAN_WR_TPEC,		/* Use ACPI EC reg 0x2f */
7386	TPACPI_FAN_WR_ACPI_FANS,	/* Use ACPI FANS and EC reg 0x2f */
7387};
7388
7389enum fan_control_commands {
7390	TPACPI_FAN_CMD_SPEED 	= 0x0001,	/* speed command */
7391	TPACPI_FAN_CMD_LEVEL 	= 0x0002,	/* level command  */
7392	TPACPI_FAN_CMD_ENABLE	= 0x0004,	/* enable/disable cmd,
7393						 * and also watchdog cmd */
7394};
7395
7396static bool fan_control_allowed;
7397
7398static enum fan_status_access_mode fan_status_access_mode;
7399static enum fan_control_access_mode fan_control_access_mode;
7400static enum fan_control_commands fan_control_commands;
7401
7402static u8 fan_control_initial_status;
7403static u8 fan_control_desired_level;
7404static u8 fan_control_resume_level;
7405static int fan_watchdog_maxinterval;
7406
7407static struct mutex fan_mutex;
7408
7409static void fan_watchdog_fire(struct work_struct *ignored);
7410static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7411
7412TPACPI_HANDLE(fans, ec, "FANS");	/* X31, X40, X41 */
7413TPACPI_HANDLE(gfan, ec, "GFAN",	/* 570 */
7414	   "\\FSPD",		/* 600e/x, 770e, 770x */
7415	   );			/* all others */
7416TPACPI_HANDLE(sfan, ec, "SFAN",	/* 570 */
7417	   "JFNS",		/* 770x-JL */
7418	   );			/* all others */
7419
7420/*
7421 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7422 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7423 * be in auto mode (0x80).
7424 *
7425 * This is corrected by any write to HFSP either by the driver, or
7426 * by the firmware.
7427 *
7428 * We assume 0x07 really means auto mode while this quirk is active,
7429 * as this is far more likely than the ThinkPad being in level 7,
7430 * which is only used by the firmware during thermal emergencies.
7431 *
7432 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7433 * TP-70 (T43, R52), which are known to be buggy.
7434 */
7435
7436static void fan_quirk1_setup(void)
7437{
7438	if (fan_control_initial_status == 0x07) {
7439		pr_notice("fan_init: initial fan status is unknown, "
7440			  "assuming it is in auto mode\n");
7441		tp_features.fan_ctrl_status_undef = 1;
7442	}
7443}
7444
7445static void fan_quirk1_handle(u8 *fan_status)
7446{
7447	if (unlikely(tp_features.fan_ctrl_status_undef)) {
7448		if (*fan_status != fan_control_initial_status) {
7449			/* something changed the HFSP regisnter since
7450			 * driver init time, so it is not undefined
7451			 * anymore */
7452			tp_features.fan_ctrl_status_undef = 0;
7453		} else {
7454			/* Return most likely status. In fact, it
7455			 * might be the only possible status */
7456			*fan_status = TP_EC_FAN_AUTO;
7457		}
7458	}
7459}
7460
7461/* Select main fan on X60/X61, NOOP on others */
7462static bool fan_select_fan1(void)
7463{
7464	if (tp_features.second_fan) {
7465		u8 val;
7466
7467		if (ec_read(fan_select_offset, &val) < 0)
7468			return false;
7469		val &= 0xFEU;
7470		if (ec_write(fan_select_offset, val) < 0)
7471			return false;
7472	}
7473	return true;
7474}
7475
7476/* Select secondary fan on X60/X61 */
7477static bool fan_select_fan2(void)
7478{
7479	u8 val;
7480
7481	if (!tp_features.second_fan)
7482		return false;
7483
7484	if (ec_read(fan_select_offset, &val) < 0)
7485		return false;
7486	val |= 0x01U;
7487	if (ec_write(fan_select_offset, val) < 0)
7488		return false;
7489
7490	return true;
7491}
7492
7493/*
7494 * Call with fan_mutex held
7495 */
7496static void fan_update_desired_level(u8 status)
7497{
7498	if ((status &
7499	     (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7500		if (status > 7)
7501			fan_control_desired_level = 7;
7502		else
7503			fan_control_desired_level = status;
7504	}
7505}
7506
7507static int fan_get_status(u8 *status)
7508{
7509	u8 s;
7510
7511	/* TODO:
7512	 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7513
7514	switch (fan_status_access_mode) {
7515	case TPACPI_FAN_RD_ACPI_GFAN: {
7516		/* 570, 600e/x, 770e, 770x */
7517		int res;
7518
7519		if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
7520			return -EIO;
7521
7522		if (likely(status))
7523			*status = res & 0x07;
7524
7525		break;
7526	}
7527	case TPACPI_FAN_RD_TPEC:
7528		/* all except 570, 600e/x, 770e, 770x */
7529		if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7530			return -EIO;
7531
7532		if (likely(status)) {
7533			*status = s;
7534			fan_quirk1_handle(status);
7535		}
7536
7537		break;
7538
7539	default:
7540		return -ENXIO;
7541	}
7542
7543	return 0;
7544}
7545
7546static int fan_get_status_safe(u8 *status)
7547{
7548	int rc;
7549	u8 s;
7550
7551	if (mutex_lock_killable(&fan_mutex))
7552		return -ERESTARTSYS;
7553	rc = fan_get_status(&s);
7554	if (!rc)
7555		fan_update_desired_level(s);
7556	mutex_unlock(&fan_mutex);
7557
7558	if (status)
7559		*status = s;
7560
7561	return rc;
7562}
7563
7564static int fan_get_speed(unsigned int *speed)
7565{
7566	u8 hi, lo;
7567
7568	switch (fan_status_access_mode) {
7569	case TPACPI_FAN_RD_TPEC:
7570		/* all except 570, 600e/x, 770e, 770x */
7571		if (unlikely(!fan_select_fan1()))
7572			return -EIO;
7573		if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7574			     !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7575			return -EIO;
7576
7577		if (likely(speed))
7578			*speed = (hi << 8) | lo;
7579
7580		break;
7581
7582	default:
7583		return -ENXIO;
7584	}
7585
7586	return 0;
7587}
7588
7589static int fan2_get_speed(unsigned int *speed)
7590{
7591	u8 hi, lo;
7592	bool rc;
7593
7594	switch (fan_status_access_mode) {
7595	case TPACPI_FAN_RD_TPEC:
7596		/* all except 570, 600e/x, 770e, 770x */
7597		if (unlikely(!fan_select_fan2()))
7598			return -EIO;
7599		rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7600			     !acpi_ec_read(fan_rpm_offset + 1, &hi);
7601		fan_select_fan1(); /* play it safe */
7602		if (rc)
7603			return -EIO;
7604
7605		if (likely(speed))
7606			*speed = (hi << 8) | lo;
7607
7608		break;
7609
7610	default:
7611		return -ENXIO;
7612	}
7613
7614	return 0;
7615}
7616
7617static int fan_set_level(int level)
7618{
7619	if (!fan_control_allowed)
7620		return -EPERM;
7621
7622	switch (fan_control_access_mode) {
7623	case TPACPI_FAN_WR_ACPI_SFAN:
7624		if (level >= 0 && level <= 7) {
7625			if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7626				return -EIO;
7627		} else
7628			return -EINVAL;
7629		break;
7630
7631	case TPACPI_FAN_WR_ACPI_FANS:
7632	case TPACPI_FAN_WR_TPEC:
7633		if (!(level & TP_EC_FAN_AUTO) &&
7634		    !(level & TP_EC_FAN_FULLSPEED) &&
7635		    ((level < 0) || (level > 7)))
7636			return -EINVAL;
7637
7638		/* safety net should the EC not support AUTO
7639		 * or FULLSPEED mode bits and just ignore them */
7640		if (level & TP_EC_FAN_FULLSPEED)
7641			level |= 7;	/* safety min speed 7 */
7642		else if (level & TP_EC_FAN_AUTO)
7643			level |= 4;	/* safety min speed 4 */
7644
7645		if (!acpi_ec_write(fan_status_offset, level))
7646			return -EIO;
7647		else
7648			tp_features.fan_ctrl_status_undef = 0;
7649		break;
7650
7651	default:
7652		return -ENXIO;
7653	}
7654
7655	vdbg_printk(TPACPI_DBG_FAN,
7656		"fan control: set fan control register to 0x%02x\n", level);
7657	return 0;
7658}
7659
7660static int fan_set_level_safe(int level)
7661{
7662	int rc;
7663
7664	if (!fan_control_allowed)
7665		return -EPERM;
7666
7667	if (mutex_lock_killable(&fan_mutex))
7668		return -ERESTARTSYS;
7669
7670	if (level == TPACPI_FAN_LAST_LEVEL)
7671		level = fan_control_desired_level;
7672
7673	rc = fan_set_level(level);
7674	if (!rc)
7675		fan_update_desired_level(level);
7676
7677	mutex_unlock(&fan_mutex);
7678	return rc;
7679}
7680
7681static int fan_set_enable(void)
7682{
7683	u8 s;
7684	int rc;
7685
7686	if (!fan_control_allowed)
7687		return -EPERM;
7688
7689	if (mutex_lock_killable(&fan_mutex))
7690		return -ERESTARTSYS;
7691
7692	switch (fan_control_access_mode) {
7693	case TPACPI_FAN_WR_ACPI_FANS:
7694	case TPACPI_FAN_WR_TPEC:
7695		rc = fan_get_status(&s);
7696		if (rc < 0)
7697			break;
7698
7699		/* Don't go out of emergency fan mode */
7700		if (s != 7) {
7701			s &= 0x07;
7702			s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7703		}
7704
7705		if (!acpi_ec_write(fan_status_offset, s))
7706			rc = -EIO;
7707		else {
7708			tp_features.fan_ctrl_status_undef = 0;
7709			rc = 0;
7710		}
7711		break;
7712
7713	case TPACPI_FAN_WR_ACPI_SFAN:
7714		rc = fan_get_status(&s);
7715		if (rc < 0)
7716			break;
7717
7718		s &= 0x07;
7719
7720		/* Set fan to at least level 4 */
7721		s |= 4;
7722
7723		if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7724			rc = -EIO;
7725		else
7726			rc = 0;
7727		break;
7728
7729	default:
7730		rc = -ENXIO;
7731	}
7732
7733	mutex_unlock(&fan_mutex);
7734
7735	if (!rc)
7736		vdbg_printk(TPACPI_DBG_FAN,
7737			"fan control: set fan control register to 0x%02x\n",
7738			s);
7739	return rc;
7740}
7741
7742static int fan_set_disable(void)
7743{
7744	int rc;
7745
7746	if (!fan_control_allowed)
7747		return -EPERM;
7748
7749	if (mutex_lock_killable(&fan_mutex))
7750		return -ERESTARTSYS;
7751
7752	rc = 0;
7753	switch (fan_control_access_mode) {
7754	case TPACPI_FAN_WR_ACPI_FANS:
7755	case TPACPI_FAN_WR_TPEC:
7756		if (!acpi_ec_write(fan_status_offset, 0x00))
7757			rc = -EIO;
7758		else {
7759			fan_control_desired_level = 0;
7760			tp_features.fan_ctrl_status_undef = 0;
7761		}
7762		break;
7763
7764	case TPACPI_FAN_WR_ACPI_SFAN:
7765		if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7766			rc = -EIO;
7767		else
7768			fan_control_desired_level = 0;
7769		break;
7770
7771	default:
7772		rc = -ENXIO;
7773	}
7774
7775	if (!rc)
7776		vdbg_printk(TPACPI_DBG_FAN,
7777			"fan control: set fan control register to 0\n");
7778
7779	mutex_unlock(&fan_mutex);
7780	return rc;
7781}
7782
7783static int fan_set_speed(int speed)
7784{
7785	int rc;
7786
7787	if (!fan_control_allowed)
7788		return -EPERM;
7789
7790	if (mutex_lock_killable(&fan_mutex))
7791		return -ERESTARTSYS;
7792
7793	rc = 0;
7794	switch (fan_control_access_mode) {
7795	case TPACPI_FAN_WR_ACPI_FANS:
7796		if (speed >= 0 && speed <= 65535) {
7797			if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7798					speed, speed, speed))
7799				rc = -EIO;
7800		} else
7801			rc = -EINVAL;
7802		break;
7803
7804	default:
7805		rc = -ENXIO;
7806	}
7807
7808	mutex_unlock(&fan_mutex);
7809	return rc;
7810}
7811
7812static void fan_watchdog_reset(void)
7813{
 
 
7814	if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7815		return;
7816
 
 
 
7817	if (fan_watchdog_maxinterval > 0 &&
7818	    tpacpi_lifecycle != TPACPI_LIFE_EXITING)
7819		mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
7820			msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
7821	else
7822		cancel_delayed_work(&fan_watchdog_task);
 
 
 
 
 
7823}
7824
7825static void fan_watchdog_fire(struct work_struct *ignored)
7826{
7827	int rc;
7828
7829	if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7830		return;
7831
7832	pr_notice("fan watchdog: enabling fan\n");
7833	rc = fan_set_enable();
7834	if (rc < 0) {
7835		pr_err("fan watchdog: error %d while enabling fan, "
7836		       "will try again later...\n", -rc);
7837		/* reschedule for later */
7838		fan_watchdog_reset();
7839	}
7840}
7841
7842/*
7843 * SYSFS fan layout: hwmon compatible (device)
7844 *
7845 * pwm*_enable:
7846 * 	0: "disengaged" mode
7847 * 	1: manual mode
7848 * 	2: native EC "auto" mode (recommended, hardware default)
7849 *
7850 * pwm*: set speed in manual mode, ignored otherwise.
7851 * 	0 is level 0; 255 is level 7. Intermediate points done with linear
7852 * 	interpolation.
7853 *
7854 * fan*_input: tachometer reading, RPM
7855 *
7856 *
7857 * SYSFS fan layout: extensions
7858 *
7859 * fan_watchdog (driver):
7860 * 	fan watchdog interval in seconds, 0 disables (default), max 120
7861 */
7862
7863/* sysfs fan pwm1_enable ----------------------------------------------- */
7864static ssize_t fan_pwm1_enable_show(struct device *dev,
7865				    struct device_attribute *attr,
7866				    char *buf)
7867{
7868	int res, mode;
7869	u8 status;
7870
7871	res = fan_get_status_safe(&status);
7872	if (res)
7873		return res;
7874
7875	if (status & TP_EC_FAN_FULLSPEED) {
7876		mode = 0;
7877	} else if (status & TP_EC_FAN_AUTO) {
7878		mode = 2;
7879	} else
7880		mode = 1;
7881
7882	return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7883}
7884
7885static ssize_t fan_pwm1_enable_store(struct device *dev,
7886				     struct device_attribute *attr,
7887				     const char *buf, size_t count)
7888{
7889	unsigned long t;
7890	int res, level;
7891
7892	if (parse_strtoul(buf, 2, &t))
7893		return -EINVAL;
7894
7895	tpacpi_disclose_usertask("hwmon pwm1_enable",
7896			"set fan mode to %lu\n", t);
7897
7898	switch (t) {
7899	case 0:
7900		level = TP_EC_FAN_FULLSPEED;
7901		break;
7902	case 1:
7903		level = TPACPI_FAN_LAST_LEVEL;
7904		break;
7905	case 2:
7906		level = TP_EC_FAN_AUTO;
7907		break;
7908	case 3:
7909		/* reserved for software-controlled auto mode */
7910		return -ENOSYS;
7911	default:
7912		return -EINVAL;
7913	}
7914
7915	res = fan_set_level_safe(level);
7916	if (res == -ENXIO)
7917		return -EINVAL;
7918	else if (res < 0)
7919		return res;
7920
7921	fan_watchdog_reset();
7922
7923	return count;
7924}
7925
7926static struct device_attribute dev_attr_fan_pwm1_enable =
7927	__ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7928		fan_pwm1_enable_show, fan_pwm1_enable_store);
7929
7930/* sysfs fan pwm1 ------------------------------------------------------ */
7931static ssize_t fan_pwm1_show(struct device *dev,
7932			     struct device_attribute *attr,
7933			     char *buf)
7934{
7935	int res;
7936	u8 status;
7937
7938	res = fan_get_status_safe(&status);
7939	if (res)
7940		return res;
7941
7942	if ((status &
7943	     (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7944		status = fan_control_desired_level;
7945
7946	if (status > 7)
7947		status = 7;
7948
7949	return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7950}
7951
7952static ssize_t fan_pwm1_store(struct device *dev,
7953			      struct device_attribute *attr,
7954			      const char *buf, size_t count)
7955{
7956	unsigned long s;
7957	int rc;
7958	u8 status, newlevel;
7959
7960	if (parse_strtoul(buf, 255, &s))
7961		return -EINVAL;
7962
7963	tpacpi_disclose_usertask("hwmon pwm1",
7964			"set fan speed to %lu\n", s);
7965
7966	/* scale down from 0-255 to 0-7 */
7967	newlevel = (s >> 5) & 0x07;
7968
7969	if (mutex_lock_killable(&fan_mutex))
7970		return -ERESTARTSYS;
7971
7972	rc = fan_get_status(&status);
7973	if (!rc && (status &
7974		    (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7975		rc = fan_set_level(newlevel);
7976		if (rc == -ENXIO)
7977			rc = -EINVAL;
7978		else if (!rc) {
7979			fan_update_desired_level(newlevel);
7980			fan_watchdog_reset();
7981		}
7982	}
7983
7984	mutex_unlock(&fan_mutex);
7985	return (rc)? rc : count;
7986}
7987
7988static struct device_attribute dev_attr_fan_pwm1 =
7989	__ATTR(pwm1, S_IWUSR | S_IRUGO,
7990		fan_pwm1_show, fan_pwm1_store);
7991
7992/* sysfs fan fan1_input ------------------------------------------------ */
7993static ssize_t fan_fan1_input_show(struct device *dev,
7994			   struct device_attribute *attr,
7995			   char *buf)
7996{
7997	int res;
7998	unsigned int speed;
7999
8000	res = fan_get_speed(&speed);
8001	if (res < 0)
8002		return res;
8003
8004	return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8005}
8006
8007static struct device_attribute dev_attr_fan_fan1_input =
8008	__ATTR(fan1_input, S_IRUGO,
8009		fan_fan1_input_show, NULL);
8010
8011/* sysfs fan fan2_input ------------------------------------------------ */
8012static ssize_t fan_fan2_input_show(struct device *dev,
8013			   struct device_attribute *attr,
8014			   char *buf)
8015{
8016	int res;
8017	unsigned int speed;
8018
8019	res = fan2_get_speed(&speed);
8020	if (res < 0)
8021		return res;
8022
8023	return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8024}
8025
8026static struct device_attribute dev_attr_fan_fan2_input =
8027	__ATTR(fan2_input, S_IRUGO,
8028		fan_fan2_input_show, NULL);
8029
8030/* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8031static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
8032				     char *buf)
8033{
8034	return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
8035}
8036
8037static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
8038				      const char *buf, size_t count)
8039{
8040	unsigned long t;
8041
8042	if (parse_strtoul(buf, 120, &t))
8043		return -EINVAL;
8044
8045	if (!fan_control_allowed)
8046		return -EPERM;
8047
8048	fan_watchdog_maxinterval = t;
8049	fan_watchdog_reset();
8050
8051	tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8052
8053	return count;
8054}
8055
8056static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
8057		fan_fan_watchdog_show, fan_fan_watchdog_store);
8058
8059/* --------------------------------------------------------------------- */
8060static struct attribute *fan_attributes[] = {
8061	&dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
8062	&dev_attr_fan_fan1_input.attr,
8063	NULL, /* for fan2_input */
8064	NULL
8065};
8066
8067static const struct attribute_group fan_attr_group = {
8068	.attrs = fan_attributes,
8069};
8070
8071#define	TPACPI_FAN_Q1	0x0001		/* Unitialized HFSP */
8072#define TPACPI_FAN_2FAN	0x0002		/* EC 0x31 bit 0 selects fan2 */
8073
8074#define TPACPI_FAN_QI(__id1, __id2, __quirks)	\
8075	{ .vendor = PCI_VENDOR_ID_IBM,		\
8076	  .bios = TPACPI_MATCH_ANY,		\
8077	  .ec = TPID(__id1, __id2),		\
8078	  .quirks = __quirks }
8079
8080#define TPACPI_FAN_QL(__id1, __id2, __quirks)	\
8081	{ .vendor = PCI_VENDOR_ID_LENOVO,	\
8082	  .bios = TPACPI_MATCH_ANY,		\
8083	  .ec = TPID(__id1, __id2),		\
8084	  .quirks = __quirks }
8085
8086static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8087	TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
8088	TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
8089	TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
8090	TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
8091	TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
8092};
8093
8094#undef TPACPI_FAN_QL
8095#undef TPACPI_FAN_QI
8096
8097static int __init fan_init(struct ibm_init_struct *iibm)
8098{
8099	int rc;
8100	unsigned long quirks;
8101
8102	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8103			"initializing fan subdriver\n");
8104
8105	mutex_init(&fan_mutex);
8106	fan_status_access_mode = TPACPI_FAN_NONE;
8107	fan_control_access_mode = TPACPI_FAN_WR_NONE;
8108	fan_control_commands = 0;
8109	fan_watchdog_maxinterval = 0;
8110	tp_features.fan_ctrl_status_undef = 0;
8111	tp_features.second_fan = 0;
8112	fan_control_desired_level = 7;
8113
8114	if (tpacpi_is_ibm()) {
8115		TPACPI_ACPIHANDLE_INIT(fans);
8116		TPACPI_ACPIHANDLE_INIT(gfan);
8117		TPACPI_ACPIHANDLE_INIT(sfan);
8118	}
8119
8120	quirks = tpacpi_check_quirks(fan_quirk_table,
8121				     ARRAY_SIZE(fan_quirk_table));
8122
8123	if (gfan_handle) {
8124		/* 570, 600e/x, 770e, 770x */
8125		fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8126	} else {
8127		/* all other ThinkPads: note that even old-style
8128		 * ThinkPad ECs supports the fan control register */
8129		if (likely(acpi_ec_read(fan_status_offset,
8130					&fan_control_initial_status))) {
8131			fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8132			if (quirks & TPACPI_FAN_Q1)
8133				fan_quirk1_setup();
8134			if (quirks & TPACPI_FAN_2FAN) {
8135				tp_features.second_fan = 1;
8136				dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8137					"secondary fan support enabled\n");
8138			}
8139		} else {
8140			pr_err("ThinkPad ACPI EC access misbehaving, "
8141			       "fan status and control unavailable\n");
8142			return 1;
8143		}
8144	}
8145
8146	if (sfan_handle) {
8147		/* 570, 770x-JL */
8148		fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8149		fan_control_commands |=
8150		    TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8151	} else {
8152		if (!gfan_handle) {
8153			/* gfan without sfan means no fan control */
8154			/* all other models implement TP EC 0x2f control */
8155
8156			if (fans_handle) {
8157				/* X31, X40, X41 */
8158				fan_control_access_mode =
8159				    TPACPI_FAN_WR_ACPI_FANS;
8160				fan_control_commands |=
8161				    TPACPI_FAN_CMD_SPEED |
8162				    TPACPI_FAN_CMD_LEVEL |
8163				    TPACPI_FAN_CMD_ENABLE;
8164			} else {
8165				fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8166				fan_control_commands |=
8167				    TPACPI_FAN_CMD_LEVEL |
8168				    TPACPI_FAN_CMD_ENABLE;
8169			}
8170		}
8171	}
8172
8173	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8174		"fan is %s, modes %d, %d\n",
8175		str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8176		  fan_control_access_mode != TPACPI_FAN_WR_NONE),
8177		fan_status_access_mode, fan_control_access_mode);
8178
8179	/* fan control master switch */
8180	if (!fan_control_allowed) {
8181		fan_control_access_mode = TPACPI_FAN_WR_NONE;
8182		fan_control_commands = 0;
8183		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8184			   "fan control features disabled by parameter\n");
8185	}
8186
8187	/* update fan_control_desired_level */
8188	if (fan_status_access_mode != TPACPI_FAN_NONE)
8189		fan_get_status_safe(NULL);
8190
8191	if (fan_status_access_mode != TPACPI_FAN_NONE ||
8192	    fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8193		if (tp_features.second_fan) {
8194			/* attach second fan tachometer */
8195			fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8196					&dev_attr_fan_fan2_input.attr;
8197		}
8198		rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8199					 &fan_attr_group);
8200		if (rc < 0)
8201			return rc;
8202
8203		rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8204					&driver_attr_fan_watchdog);
8205		if (rc < 0) {
8206			sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8207					&fan_attr_group);
8208			return rc;
8209		}
8210		return 0;
8211	} else
8212		return 1;
8213}
8214
8215static void fan_exit(void)
8216{
8217	vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8218		    "cancelling any pending fan watchdog tasks\n");
8219
8220	/* FIXME: can we really do this unconditionally? */
8221	sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8222	driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8223			   &driver_attr_fan_watchdog);
8224
8225	cancel_delayed_work(&fan_watchdog_task);
8226	flush_workqueue(tpacpi_wq);
8227}
8228
8229static void fan_suspend(void)
8230{
8231	int rc;
8232
8233	if (!fan_control_allowed)
8234		return;
8235
8236	/* Store fan status in cache */
8237	fan_control_resume_level = 0;
8238	rc = fan_get_status_safe(&fan_control_resume_level);
8239	if (rc < 0)
8240		pr_notice("failed to read fan level for later "
8241			  "restore during resume: %d\n", rc);
8242
8243	/* if it is undefined, don't attempt to restore it.
8244	 * KEEP THIS LAST */
8245	if (tp_features.fan_ctrl_status_undef)
8246		fan_control_resume_level = 0;
8247}
8248
8249static void fan_resume(void)
8250{
8251	u8 current_level = 7;
8252	bool do_set = false;
8253	int rc;
8254
8255	/* DSDT *always* updates status on resume */
8256	tp_features.fan_ctrl_status_undef = 0;
8257
8258	if (!fan_control_allowed ||
8259	    !fan_control_resume_level ||
8260	    (fan_get_status_safe(&current_level) < 0))
8261		return;
8262
8263	switch (fan_control_access_mode) {
8264	case TPACPI_FAN_WR_ACPI_SFAN:
8265		/* never decrease fan level */
8266		do_set = (fan_control_resume_level > current_level);
8267		break;
8268	case TPACPI_FAN_WR_ACPI_FANS:
8269	case TPACPI_FAN_WR_TPEC:
8270		/* never decrease fan level, scale is:
8271		 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8272		 *
8273		 * We expect the firmware to set either 7 or AUTO, but we
8274		 * handle FULLSPEED out of paranoia.
8275		 *
8276		 * So, we can safely only restore FULLSPEED or 7, anything
8277		 * else could slow the fan.  Restoring AUTO is useless, at
8278		 * best that's exactly what the DSDT already set (it is the
8279		 * slower it uses).
8280		 *
8281		 * Always keep in mind that the DSDT *will* have set the
8282		 * fans to what the vendor supposes is the best level.  We
8283		 * muck with it only to speed the fan up.
8284		 */
8285		if (fan_control_resume_level != 7 &&
8286		    !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8287			return;
8288		else
8289			do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8290				 (current_level != fan_control_resume_level);
8291		break;
8292	default:
8293		return;
8294	}
8295	if (do_set) {
8296		pr_notice("restoring fan level to 0x%02x\n",
8297			  fan_control_resume_level);
8298		rc = fan_set_level_safe(fan_control_resume_level);
8299		if (rc < 0)
8300			pr_notice("failed to restore fan level: %d\n", rc);
8301	}
8302}
8303
8304static int fan_read(struct seq_file *m)
8305{
8306	int rc;
8307	u8 status;
8308	unsigned int speed = 0;
8309
8310	switch (fan_status_access_mode) {
8311	case TPACPI_FAN_RD_ACPI_GFAN:
8312		/* 570, 600e/x, 770e, 770x */
8313		rc = fan_get_status_safe(&status);
8314		if (rc < 0)
8315			return rc;
8316
8317		seq_printf(m, "status:\t\t%s\n"
8318			       "level:\t\t%d\n",
8319			       (status != 0) ? "enabled" : "disabled", status);
8320		break;
8321
8322	case TPACPI_FAN_RD_TPEC:
8323		/* all except 570, 600e/x, 770e, 770x */
8324		rc = fan_get_status_safe(&status);
8325		if (rc < 0)
8326			return rc;
8327
8328		seq_printf(m, "status:\t\t%s\n",
8329			       (status != 0) ? "enabled" : "disabled");
8330
8331		rc = fan_get_speed(&speed);
8332		if (rc < 0)
8333			return rc;
8334
8335		seq_printf(m, "speed:\t\t%d\n", speed);
8336
8337		if (status & TP_EC_FAN_FULLSPEED)
8338			/* Disengaged mode takes precedence */
8339			seq_printf(m, "level:\t\tdisengaged\n");
8340		else if (status & TP_EC_FAN_AUTO)
8341			seq_printf(m, "level:\t\tauto\n");
8342		else
8343			seq_printf(m, "level:\t\t%d\n", status);
8344		break;
8345
8346	case TPACPI_FAN_NONE:
8347	default:
8348		seq_printf(m, "status:\t\tnot supported\n");
8349	}
8350
8351	if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8352		seq_printf(m, "commands:\tlevel <level>");
8353
8354		switch (fan_control_access_mode) {
8355		case TPACPI_FAN_WR_ACPI_SFAN:
8356			seq_printf(m, " (<level> is 0-7)\n");
8357			break;
8358
8359		default:
8360			seq_printf(m, " (<level> is 0-7, "
8361				       "auto, disengaged, full-speed)\n");
8362			break;
8363		}
8364	}
8365
8366	if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8367		seq_printf(m, "commands:\tenable, disable\n"
8368			       "commands:\twatchdog <timeout> (<timeout> "
8369			       "is 0 (off), 1-120 (seconds))\n");
8370
8371	if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8372		seq_printf(m, "commands:\tspeed <speed>"
8373			       " (<speed> is 0-65535)\n");
8374
8375	return 0;
8376}
8377
8378static int fan_write_cmd_level(const char *cmd, int *rc)
8379{
8380	int level;
8381
8382	if (strlencmp(cmd, "level auto") == 0)
8383		level = TP_EC_FAN_AUTO;
8384	else if ((strlencmp(cmd, "level disengaged") == 0) |
8385			(strlencmp(cmd, "level full-speed") == 0))
8386		level = TP_EC_FAN_FULLSPEED;
8387	else if (sscanf(cmd, "level %d", &level) != 1)
8388		return 0;
8389
8390	*rc = fan_set_level_safe(level);
8391	if (*rc == -ENXIO)
8392		pr_err("level command accepted for unsupported access mode %d\n",
8393		       fan_control_access_mode);
8394	else if (!*rc)
8395		tpacpi_disclose_usertask("procfs fan",
8396			"set level to %d\n", level);
8397
8398	return 1;
8399}
8400
8401static int fan_write_cmd_enable(const char *cmd, int *rc)
8402{
8403	if (strlencmp(cmd, "enable") != 0)
8404		return 0;
8405
8406	*rc = fan_set_enable();
8407	if (*rc == -ENXIO)
8408		pr_err("enable command accepted for unsupported access mode %d\n",
8409		       fan_control_access_mode);
8410	else if (!*rc)
8411		tpacpi_disclose_usertask("procfs fan", "enable\n");
8412
8413	return 1;
8414}
8415
8416static int fan_write_cmd_disable(const char *cmd, int *rc)
8417{
8418	if (strlencmp(cmd, "disable") != 0)
8419		return 0;
8420
8421	*rc = fan_set_disable();
8422	if (*rc == -ENXIO)
8423		pr_err("disable command accepted for unsupported access mode %d\n",
8424		       fan_control_access_mode);
8425	else if (!*rc)
8426		tpacpi_disclose_usertask("procfs fan", "disable\n");
8427
8428	return 1;
8429}
8430
8431static int fan_write_cmd_speed(const char *cmd, int *rc)
8432{
8433	int speed;
8434
8435	/* TODO:
8436	 * Support speed <low> <medium> <high> ? */
8437
8438	if (sscanf(cmd, "speed %d", &speed) != 1)
8439		return 0;
8440
8441	*rc = fan_set_speed(speed);
8442	if (*rc == -ENXIO)
8443		pr_err("speed command accepted for unsupported access mode %d\n",
8444		       fan_control_access_mode);
8445	else if (!*rc)
8446		tpacpi_disclose_usertask("procfs fan",
8447			"set speed to %d\n", speed);
8448
8449	return 1;
8450}
8451
8452static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8453{
8454	int interval;
8455
8456	if (sscanf(cmd, "watchdog %d", &interval) != 1)
8457		return 0;
8458
8459	if (interval < 0 || interval > 120)
8460		*rc = -EINVAL;
8461	else {
8462		fan_watchdog_maxinterval = interval;
8463		tpacpi_disclose_usertask("procfs fan",
8464			"set watchdog timer to %d\n",
8465			interval);
8466	}
8467
8468	return 1;
8469}
8470
8471static int fan_write(char *buf)
8472{
8473	char *cmd;
8474	int rc = 0;
8475
8476	while (!rc && (cmd = next_cmd(&buf))) {
8477		if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8478		      fan_write_cmd_level(cmd, &rc)) &&
8479		    !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8480		      (fan_write_cmd_enable(cmd, &rc) ||
8481		       fan_write_cmd_disable(cmd, &rc) ||
8482		       fan_write_cmd_watchdog(cmd, &rc))) &&
8483		    !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8484		      fan_write_cmd_speed(cmd, &rc))
8485		    )
8486			rc = -EINVAL;
8487		else if (!rc)
8488			fan_watchdog_reset();
8489	}
8490
8491	return rc;
8492}
8493
8494static struct ibm_struct fan_driver_data = {
8495	.name = "fan",
8496	.read = fan_read,
8497	.write = fan_write,
8498	.exit = fan_exit,
8499	.suspend = fan_suspend,
8500	.resume = fan_resume,
8501};
8502
8503/*************************************************************************
8504 * Mute LED subdriver
8505 */
8506
8507
8508struct tp_led_table {
8509	acpi_string name;
8510	int on_value;
8511	int off_value;
8512	int state;
8513};
8514
8515static struct tp_led_table led_tables[] = {
8516	[TPACPI_LED_MUTE] = {
8517		.name = "SSMS",
8518		.on_value = 1,
8519		.off_value = 0,
8520	},
8521	[TPACPI_LED_MICMUTE] = {
8522		.name = "MMTS",
8523		.on_value = 2,
8524		.off_value = 0,
8525	},
8526};
8527
8528static int mute_led_on_off(struct tp_led_table *t, bool state)
8529{
8530	acpi_handle temp;
8531	int output;
8532
8533	if (!ACPI_SUCCESS(acpi_get_handle(hkey_handle, t->name, &temp))) {
8534		pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
8535		return -EIO;
8536	}
8537
8538	if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
8539			state ? t->on_value : t->off_value))
8540		return -EIO;
8541
8542	t->state = state;
8543	return state;
8544}
8545
8546int tpacpi_led_set(int whichled, bool on)
8547{
8548	struct tp_led_table *t;
8549
8550	if (whichled < 0 || whichled >= TPACPI_LED_MAX)
8551		return -EINVAL;
8552
8553	t = &led_tables[whichled];
8554	if (t->state < 0 || t->state == on)
8555		return t->state;
8556	return mute_led_on_off(t, on);
8557}
8558EXPORT_SYMBOL_GPL(tpacpi_led_set);
8559
8560static int mute_led_init(struct ibm_init_struct *iibm)
8561{
8562	acpi_handle temp;
8563	int i;
8564
8565	for (i = 0; i < TPACPI_LED_MAX; i++) {
8566		struct tp_led_table *t = &led_tables[i];
8567		if (ACPI_SUCCESS(acpi_get_handle(hkey_handle, t->name, &temp)))
8568			mute_led_on_off(t, false);
8569		else
8570			t->state = -ENODEV;
8571	}
8572	return 0;
8573}
8574
8575static void mute_led_exit(void)
8576{
8577	int i;
8578
8579	for (i = 0; i < TPACPI_LED_MAX; i++)
8580		tpacpi_led_set(i, false);
8581}
8582
8583static void mute_led_resume(void)
8584{
8585	int i;
8586
8587	for (i = 0; i < TPACPI_LED_MAX; i++) {
8588		struct tp_led_table *t = &led_tables[i];
8589		if (t->state >= 0)
8590			mute_led_on_off(t, t->state);
8591	}
8592}
8593
8594static struct ibm_struct mute_led_driver_data = {
8595	.name = "mute_led",
8596	.exit = mute_led_exit,
8597	.resume = mute_led_resume,
8598};
8599
8600/****************************************************************************
8601 ****************************************************************************
8602 *
8603 * Infrastructure
8604 *
8605 ****************************************************************************
8606 ****************************************************************************/
8607
8608/*
8609 * HKEY event callout for other subdrivers go here
8610 * (yes, it is ugly, but it is quick, safe, and gets the job done
8611 */
8612static void tpacpi_driver_event(const unsigned int hkey_event)
8613{
8614	if (ibm_backlight_device) {
8615		switch (hkey_event) {
8616		case TP_HKEY_EV_BRGHT_UP:
8617		case TP_HKEY_EV_BRGHT_DOWN:
8618			tpacpi_brightness_notify_change();
8619		}
8620	}
8621	if (alsa_card) {
8622		switch (hkey_event) {
8623		case TP_HKEY_EV_VOL_UP:
8624		case TP_HKEY_EV_VOL_DOWN:
8625		case TP_HKEY_EV_VOL_MUTE:
8626			volume_alsa_notify_change();
8627		}
8628	}
8629}
8630
8631static void hotkey_driver_event(const unsigned int scancode)
8632{
8633	tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8634}
8635
8636/* sysfs name ---------------------------------------------------------- */
8637static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8638			   struct device_attribute *attr,
8639			   char *buf)
8640{
8641	return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8642}
8643
8644static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8645	__ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8646
8647/* --------------------------------------------------------------------- */
8648
8649/* /proc support */
8650static struct proc_dir_entry *proc_dir;
8651
8652/*
8653 * Module and infrastructure proble, init and exit handling
8654 */
8655
8656static bool force_load;
8657
8658#ifdef CONFIG_THINKPAD_ACPI_DEBUG
8659static const char * __init str_supported(int is_supported)
8660{
8661	static char text_unsupported[] __initdata = "not supported";
8662
8663	return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8664}
8665#endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8666
8667static void ibm_exit(struct ibm_struct *ibm)
8668{
8669	dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8670
8671	list_del_init(&ibm->all_drivers);
8672
8673	if (ibm->flags.acpi_notify_installed) {
8674		dbg_printk(TPACPI_DBG_EXIT,
8675			"%s: acpi_remove_notify_handler\n", ibm->name);
8676		BUG_ON(!ibm->acpi);
8677		acpi_remove_notify_handler(*ibm->acpi->handle,
8678					   ibm->acpi->type,
8679					   dispatch_acpi_notify);
8680		ibm->flags.acpi_notify_installed = 0;
8681	}
8682
8683	if (ibm->flags.proc_created) {
8684		dbg_printk(TPACPI_DBG_EXIT,
8685			"%s: remove_proc_entry\n", ibm->name);
8686		remove_proc_entry(ibm->name, proc_dir);
8687		ibm->flags.proc_created = 0;
8688	}
8689
8690	if (ibm->flags.acpi_driver_registered) {
8691		dbg_printk(TPACPI_DBG_EXIT,
8692			"%s: acpi_bus_unregister_driver\n", ibm->name);
8693		BUG_ON(!ibm->acpi);
8694		acpi_bus_unregister_driver(ibm->acpi->driver);
8695		kfree(ibm->acpi->driver);
8696		ibm->acpi->driver = NULL;
8697		ibm->flags.acpi_driver_registered = 0;
8698	}
8699
8700	if (ibm->flags.init_called && ibm->exit) {
8701		ibm->exit();
8702		ibm->flags.init_called = 0;
8703	}
8704
8705	dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8706}
8707
8708static int __init ibm_init(struct ibm_init_struct *iibm)
8709{
8710	int ret;
8711	struct ibm_struct *ibm = iibm->data;
8712	struct proc_dir_entry *entry;
8713
8714	BUG_ON(ibm == NULL);
8715
8716	INIT_LIST_HEAD(&ibm->all_drivers);
8717
8718	if (ibm->flags.experimental && !experimental)
8719		return 0;
8720
8721	dbg_printk(TPACPI_DBG_INIT,
8722		"probing for %s\n", ibm->name);
8723
8724	if (iibm->init) {
8725		ret = iibm->init(iibm);
8726		if (ret > 0)
8727			return 0;	/* probe failed */
8728		if (ret)
8729			return ret;
8730
8731		ibm->flags.init_called = 1;
8732	}
8733
8734	if (ibm->acpi) {
8735		if (ibm->acpi->hid) {
8736			ret = register_tpacpi_subdriver(ibm);
8737			if (ret)
8738				goto err_out;
8739		}
8740
8741		if (ibm->acpi->notify) {
8742			ret = setup_acpi_notify(ibm);
8743			if (ret == -ENODEV) {
8744				pr_notice("disabling subdriver %s\n",
8745					  ibm->name);
8746				ret = 0;
8747				goto err_out;
8748			}
8749			if (ret < 0)
8750				goto err_out;
8751		}
8752	}
8753
8754	dbg_printk(TPACPI_DBG_INIT,
8755		"%s installed\n", ibm->name);
8756
8757	if (ibm->read) {
8758		umode_t mode = iibm->base_procfs_mode;
8759
8760		if (!mode)
8761			mode = S_IRUGO;
8762		if (ibm->write)
8763			mode |= S_IWUSR;
8764		entry = proc_create_data(ibm->name, mode, proc_dir,
8765					 &dispatch_proc_fops, ibm);
8766		if (!entry) {
8767			pr_err("unable to create proc entry %s\n", ibm->name);
8768			ret = -ENODEV;
8769			goto err_out;
8770		}
8771		ibm->flags.proc_created = 1;
8772	}
8773
8774	list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8775
8776	return 0;
8777
8778err_out:
8779	dbg_printk(TPACPI_DBG_INIT,
8780		"%s: at error exit path with result %d\n",
8781		ibm->name, ret);
8782
8783	ibm_exit(ibm);
8784	return (ret < 0)? ret : 0;
8785}
8786
8787/* Probing */
8788
8789static bool __pure __init tpacpi_is_fw_digit(const char c)
8790{
8791	return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8792}
8793
8794/* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8795static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8796						const char t)
8797{
8798	return s && strlen(s) >= 8 &&
8799		tpacpi_is_fw_digit(s[0]) &&
8800		tpacpi_is_fw_digit(s[1]) &&
8801		s[2] == t &&
8802		(s[3] == 'T' || s[3] == 'N') &&
8803		tpacpi_is_fw_digit(s[4]) &&
8804		tpacpi_is_fw_digit(s[5]);
8805}
8806
8807/* returns 0 - probe ok, or < 0 - probe error.
8808 * Probe ok doesn't mean thinkpad found.
8809 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8810static int __must_check __init get_thinkpad_model_data(
8811						struct thinkpad_id_data *tp)
8812{
8813	const struct dmi_device *dev = NULL;
8814	char ec_fw_string[18];
8815	char const *s;
8816
8817	if (!tp)
8818		return -EINVAL;
8819
8820	memset(tp, 0, sizeof(*tp));
8821
8822	if (dmi_name_in_vendors("IBM"))
8823		tp->vendor = PCI_VENDOR_ID_IBM;
8824	else if (dmi_name_in_vendors("LENOVO"))
8825		tp->vendor = PCI_VENDOR_ID_LENOVO;
8826	else
8827		return 0;
8828
8829	s = dmi_get_system_info(DMI_BIOS_VERSION);
8830	tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8831	if (s && !tp->bios_version_str)
8832		return -ENOMEM;
8833
8834	/* Really ancient ThinkPad 240X will fail this, which is fine */
8835	if (!(tpacpi_is_valid_fw_id(tp->bios_version_str, 'E') ||
8836	      tpacpi_is_valid_fw_id(tp->bios_version_str, 'C')))
8837		return 0;
8838
8839	tp->bios_model = tp->bios_version_str[0]
8840			 | (tp->bios_version_str[1] << 8);
8841	tp->bios_release = (tp->bios_version_str[4] << 8)
8842			 | tp->bios_version_str[5];
8843
8844	/*
8845	 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8846	 * X32 or newer, all Z series;  Some models must have an
8847	 * up-to-date BIOS or they will not be detected.
8848	 *
8849	 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8850	 */
8851	while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8852		if (sscanf(dev->name,
8853			   "IBM ThinkPad Embedded Controller -[%17c",
8854			   ec_fw_string) == 1) {
8855			ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8856			ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8857
8858			tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8859			if (!tp->ec_version_str)
8860				return -ENOMEM;
8861
8862			if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8863				tp->ec_model = ec_fw_string[0]
8864						| (ec_fw_string[1] << 8);
8865				tp->ec_release = (ec_fw_string[4] << 8)
8866						| ec_fw_string[5];
8867			} else {
8868				pr_notice("ThinkPad firmware release %s "
8869					  "doesn't match the known patterns\n",
8870					  ec_fw_string);
8871				pr_notice("please report this to %s\n",
8872					  TPACPI_MAIL);
8873			}
8874			break;
8875		}
8876	}
8877
8878	s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8879	if (s && !(strnicmp(s, "ThinkPad", 8) && strnicmp(s, "Lenovo", 6))) {
8880		tp->model_str = kstrdup(s, GFP_KERNEL);
8881		if (!tp->model_str)
8882			return -ENOMEM;
8883	} else {
8884		s = dmi_get_system_info(DMI_BIOS_VENDOR);
8885		if (s && !(strnicmp(s, "Lenovo", 6))) {
8886			tp->model_str = kstrdup(s, GFP_KERNEL);
8887			if (!tp->model_str)
8888				return -ENOMEM;
8889		}
8890	}
8891
8892	s = dmi_get_system_info(DMI_PRODUCT_NAME);
8893	tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8894	if (s && !tp->nummodel_str)
8895		return -ENOMEM;
8896
8897	return 0;
8898}
8899
8900static int __init probe_for_thinkpad(void)
8901{
8902	int is_thinkpad;
8903
8904	if (acpi_disabled)
8905		return -ENODEV;
8906
8907	/* It would be dangerous to run the driver in this case */
8908	if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8909		return -ENODEV;
8910
8911	/*
8912	 * Non-ancient models have better DMI tagging, but very old models
8913	 * don't.  tpacpi_is_fw_known() is a cheat to help in that case.
8914	 */
8915	is_thinkpad = (thinkpad_id.model_str != NULL) ||
8916		      (thinkpad_id.ec_model != 0) ||
8917		      tpacpi_is_fw_known();
8918
8919	/* The EC handler is required */
8920	tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
8921	if (!ec_handle) {
8922		if (is_thinkpad)
8923			pr_err("Not yet supported ThinkPad detected!\n");
8924		return -ENODEV;
8925	}
8926
8927	if (!is_thinkpad && !force_load)
8928		return -ENODEV;
8929
8930	return 0;
8931}
8932
8933static void __init thinkpad_acpi_init_banner(void)
8934{
8935	pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
8936	pr_info("%s\n", TPACPI_URL);
8937
8938	pr_info("ThinkPad BIOS %s, EC %s\n",
8939		(thinkpad_id.bios_version_str) ?
8940			thinkpad_id.bios_version_str : "unknown",
8941		(thinkpad_id.ec_version_str) ?
8942			thinkpad_id.ec_version_str : "unknown");
8943
8944	BUG_ON(!thinkpad_id.vendor);
8945
8946	if (thinkpad_id.model_str)
8947		pr_info("%s %s, model %s\n",
8948			(thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
8949				"IBM" : ((thinkpad_id.vendor ==
8950						PCI_VENDOR_ID_LENOVO) ?
8951					"Lenovo" : "Unknown vendor"),
8952			thinkpad_id.model_str,
8953			(thinkpad_id.nummodel_str) ?
8954				thinkpad_id.nummodel_str : "unknown");
8955}
8956
8957/* Module init, exit, parameters */
8958
8959static struct ibm_init_struct ibms_init[] __initdata = {
8960	{
8961		.data = &thinkpad_acpi_driver_data,
8962	},
8963	{
8964		.init = hotkey_init,
8965		.data = &hotkey_driver_data,
8966	},
8967	{
8968		.init = bluetooth_init,
8969		.data = &bluetooth_driver_data,
8970	},
8971	{
8972		.init = wan_init,
8973		.data = &wan_driver_data,
8974	},
8975	{
8976		.init = uwb_init,
8977		.data = &uwb_driver_data,
8978	},
8979#ifdef CONFIG_THINKPAD_ACPI_VIDEO
8980	{
8981		.init = video_init,
8982		.base_procfs_mode = S_IRUSR,
8983		.data = &video_driver_data,
8984	},
8985#endif
8986	{
8987		.init = light_init,
8988		.data = &light_driver_data,
8989	},
8990	{
8991		.init = cmos_init,
8992		.data = &cmos_driver_data,
8993	},
8994	{
8995		.init = led_init,
8996		.data = &led_driver_data,
8997	},
8998	{
8999		.init = beep_init,
9000		.data = &beep_driver_data,
9001	},
9002	{
9003		.init = thermal_init,
9004		.data = &thermal_driver_data,
9005	},
9006	{
9007		.init = brightness_init,
9008		.data = &brightness_driver_data,
9009	},
9010	{
9011		.init = volume_init,
9012		.data = &volume_driver_data,
9013	},
9014	{
9015		.init = fan_init,
9016		.data = &fan_driver_data,
9017	},
9018	{
9019		.init = mute_led_init,
9020		.data = &mute_led_driver_data,
9021	},
9022};
9023
9024static int __init set_ibm_param(const char *val, struct kernel_param *kp)
9025{
9026	unsigned int i;
9027	struct ibm_struct *ibm;
9028
9029	if (!kp || !kp->name || !val)
9030		return -EINVAL;
9031
9032	for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9033		ibm = ibms_init[i].data;
9034		WARN_ON(ibm == NULL);
9035
9036		if (!ibm || !ibm->name)
9037			continue;
9038
9039		if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
9040			if (strlen(val) > sizeof(ibms_init[i].param) - 2)
9041				return -ENOSPC;
9042			strcpy(ibms_init[i].param, val);
9043			strcat(ibms_init[i].param, ",");
9044			return 0;
9045		}
9046	}
9047
9048	return -EINVAL;
9049}
9050
9051module_param(experimental, int, 0444);
9052MODULE_PARM_DESC(experimental,
9053		 "Enables experimental features when non-zero");
9054
9055module_param_named(debug, dbg_level, uint, 0);
9056MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
9057
9058module_param(force_load, bool, 0444);
9059MODULE_PARM_DESC(force_load,
9060		 "Attempts to load the driver even on a "
9061		 "mis-identified ThinkPad when true");
9062
9063module_param_named(fan_control, fan_control_allowed, bool, 0444);
9064MODULE_PARM_DESC(fan_control,
9065		 "Enables setting fan parameters features when true");
9066
9067module_param_named(brightness_mode, brightness_mode, uint, 0444);
9068MODULE_PARM_DESC(brightness_mode,
9069		 "Selects brightness control strategy: "
9070		 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
9071
9072module_param(brightness_enable, uint, 0444);
9073MODULE_PARM_DESC(brightness_enable,
9074		 "Enables backlight control when 1, disables when 0");
9075
 
 
 
 
 
9076#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
9077module_param_named(volume_mode, volume_mode, uint, 0444);
9078MODULE_PARM_DESC(volume_mode,
9079		 "Selects volume control strategy: "
9080		 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
9081
9082module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
9083MODULE_PARM_DESC(volume_capabilities,
9084		 "Selects the mixer capabilites: "
9085		 "0=auto, 1=volume and mute, 2=mute only");
9086
9087module_param_named(volume_control, volume_control_allowed, bool, 0444);
9088MODULE_PARM_DESC(volume_control,
9089		 "Enables software override for the console audio "
9090		 "control when true");
9091
9092/* ALSA module API parameters */
9093module_param_named(index, alsa_index, int, 0444);
9094MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
9095module_param_named(id, alsa_id, charp, 0444);
9096MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
9097module_param_named(enable, alsa_enable, bool, 0444);
9098MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
9099#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
9100
9101#define TPACPI_PARAM(feature) \
9102	module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
9103	MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
9104			 "at module load, see documentation")
9105
9106TPACPI_PARAM(hotkey);
9107TPACPI_PARAM(bluetooth);
9108TPACPI_PARAM(video);
9109TPACPI_PARAM(light);
9110TPACPI_PARAM(cmos);
9111TPACPI_PARAM(led);
9112TPACPI_PARAM(beep);
9113TPACPI_PARAM(brightness);
9114TPACPI_PARAM(volume);
9115TPACPI_PARAM(fan);
9116
9117#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
9118module_param(dbg_wlswemul, uint, 0444);
9119MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
9120module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
9121MODULE_PARM_DESC(wlsw_state,
9122		 "Initial state of the emulated WLSW switch");
9123
9124module_param(dbg_bluetoothemul, uint, 0444);
9125MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
9126module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
9127MODULE_PARM_DESC(bluetooth_state,
9128		 "Initial state of the emulated bluetooth switch");
9129
9130module_param(dbg_wwanemul, uint, 0444);
9131MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
9132module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
9133MODULE_PARM_DESC(wwan_state,
9134		 "Initial state of the emulated WWAN switch");
9135
9136module_param(dbg_uwbemul, uint, 0444);
9137MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
9138module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
9139MODULE_PARM_DESC(uwb_state,
9140		 "Initial state of the emulated UWB switch");
9141#endif
9142
9143static void thinkpad_acpi_module_exit(void)
9144{
9145	struct ibm_struct *ibm, *itmp;
9146
9147	tpacpi_lifecycle = TPACPI_LIFE_EXITING;
9148
9149	list_for_each_entry_safe_reverse(ibm, itmp,
9150					 &tpacpi_all_drivers,
9151					 all_drivers) {
9152		ibm_exit(ibm);
9153	}
9154
9155	dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
9156
9157	if (tpacpi_inputdev) {
9158		if (tp_features.input_device_registered)
9159			input_unregister_device(tpacpi_inputdev);
9160		else
9161			input_free_device(tpacpi_inputdev);
9162		kfree(hotkey_keycode_map);
9163	}
9164
9165	if (tpacpi_hwmon)
9166		hwmon_device_unregister(tpacpi_hwmon);
9167
9168	if (tp_features.sensors_pdev_attrs_registered)
9169		device_remove_file(&tpacpi_sensors_pdev->dev,
9170				   &dev_attr_thinkpad_acpi_pdev_name);
9171	if (tpacpi_sensors_pdev)
9172		platform_device_unregister(tpacpi_sensors_pdev);
9173	if (tpacpi_pdev)
9174		platform_device_unregister(tpacpi_pdev);
9175
9176	if (tp_features.sensors_pdrv_attrs_registered)
9177		tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
9178	if (tp_features.platform_drv_attrs_registered)
9179		tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
9180
9181	if (tp_features.sensors_pdrv_registered)
9182		platform_driver_unregister(&tpacpi_hwmon_pdriver);
9183
9184	if (tp_features.platform_drv_registered)
9185		platform_driver_unregister(&tpacpi_pdriver);
9186
9187	if (proc_dir)
9188		remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
9189
9190	if (tpacpi_wq)
9191		destroy_workqueue(tpacpi_wq);
9192
9193	kfree(thinkpad_id.bios_version_str);
9194	kfree(thinkpad_id.ec_version_str);
9195	kfree(thinkpad_id.model_str);
9196	kfree(thinkpad_id.nummodel_str);
9197}
9198
9199
9200static int __init thinkpad_acpi_module_init(void)
9201{
9202	int ret, i;
9203
9204	tpacpi_lifecycle = TPACPI_LIFE_INIT;
9205
 
 
 
 
9206	/* Driver-level probe */
9207
9208	ret = get_thinkpad_model_data(&thinkpad_id);
9209	if (ret) {
9210		pr_err("unable to get DMI data: %d\n", ret);
9211		thinkpad_acpi_module_exit();
9212		return ret;
9213	}
9214	ret = probe_for_thinkpad();
9215	if (ret) {
9216		thinkpad_acpi_module_exit();
9217		return ret;
9218	}
9219
9220	/* Driver initialization */
9221
9222	thinkpad_acpi_init_banner();
9223	tpacpi_check_outdated_fw();
9224
9225	TPACPI_ACPIHANDLE_INIT(ecrd);
9226	TPACPI_ACPIHANDLE_INIT(ecwr);
9227
9228	tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9229	if (!tpacpi_wq) {
9230		thinkpad_acpi_module_exit();
9231		return -ENOMEM;
9232	}
9233
9234	proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9235	if (!proc_dir) {
9236		pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
9237		thinkpad_acpi_module_exit();
9238		return -ENODEV;
9239	}
9240
9241	ret = platform_driver_register(&tpacpi_pdriver);
9242	if (ret) {
9243		pr_err("unable to register main platform driver\n");
9244		thinkpad_acpi_module_exit();
9245		return ret;
9246	}
9247	tp_features.platform_drv_registered = 1;
9248
9249	ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9250	if (ret) {
9251		pr_err("unable to register hwmon platform driver\n");
9252		thinkpad_acpi_module_exit();
9253		return ret;
9254	}
9255	tp_features.sensors_pdrv_registered = 1;
9256
9257	ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9258	if (!ret) {
9259		tp_features.platform_drv_attrs_registered = 1;
9260		ret = tpacpi_create_driver_attributes(
9261					&tpacpi_hwmon_pdriver.driver);
9262	}
9263	if (ret) {
9264		pr_err("unable to create sysfs driver attributes\n");
9265		thinkpad_acpi_module_exit();
9266		return ret;
9267	}
9268	tp_features.sensors_pdrv_attrs_registered = 1;
9269
9270
9271	/* Device initialization */
9272	tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9273							NULL, 0);
9274	if (IS_ERR(tpacpi_pdev)) {
9275		ret = PTR_ERR(tpacpi_pdev);
9276		tpacpi_pdev = NULL;
9277		pr_err("unable to register platform device\n");
9278		thinkpad_acpi_module_exit();
9279		return ret;
9280	}
9281	tpacpi_sensors_pdev = platform_device_register_simple(
9282						TPACPI_HWMON_DRVR_NAME,
9283						-1, NULL, 0);
9284	if (IS_ERR(tpacpi_sensors_pdev)) {
9285		ret = PTR_ERR(tpacpi_sensors_pdev);
9286		tpacpi_sensors_pdev = NULL;
9287		pr_err("unable to register hwmon platform device\n");
9288		thinkpad_acpi_module_exit();
9289		return ret;
9290	}
9291	ret = device_create_file(&tpacpi_sensors_pdev->dev,
9292				 &dev_attr_thinkpad_acpi_pdev_name);
9293	if (ret) {
9294		pr_err("unable to create sysfs hwmon device attributes\n");
9295		thinkpad_acpi_module_exit();
9296		return ret;
9297	}
9298	tp_features.sensors_pdev_attrs_registered = 1;
9299	tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9300	if (IS_ERR(tpacpi_hwmon)) {
9301		ret = PTR_ERR(tpacpi_hwmon);
9302		tpacpi_hwmon = NULL;
9303		pr_err("unable to register hwmon device\n");
9304		thinkpad_acpi_module_exit();
9305		return ret;
9306	}
9307	mutex_init(&tpacpi_inputdev_send_mutex);
9308	tpacpi_inputdev = input_allocate_device();
9309	if (!tpacpi_inputdev) {
 
9310		thinkpad_acpi_module_exit();
9311		return -ENOMEM;
9312	} else {
9313		/* Prepare input device, but don't register */
9314		tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9315		tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9316		tpacpi_inputdev->id.bustype = BUS_HOST;
9317		tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9318		tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9319		tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9320		tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9321	}
9322
9323	/* Init subdriver dependencies */
9324	tpacpi_detect_brightness_capabilities();
9325
9326	/* Init subdrivers */
9327	for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9328		ret = ibm_init(&ibms_init[i]);
9329		if (ret >= 0 && *ibms_init[i].param)
9330			ret = ibms_init[i].data->write(ibms_init[i].param);
9331		if (ret < 0) {
9332			thinkpad_acpi_module_exit();
9333			return ret;
9334		}
9335	}
9336
9337	tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9338
9339	ret = input_register_device(tpacpi_inputdev);
9340	if (ret < 0) {
9341		pr_err("unable to register input device\n");
9342		thinkpad_acpi_module_exit();
9343		return ret;
9344	} else {
9345		tp_features.input_device_registered = 1;
9346	}
9347
9348	return 0;
9349}
9350
9351MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9352
9353/*
9354 * This will autoload the driver in almost every ThinkPad
9355 * in widespread use.
9356 *
9357 * Only _VERY_ old models, like the 240, 240x and 570 lack
9358 * the HKEY event interface.
9359 */
9360MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9361
9362/*
9363 * DMI matching for module autoloading
9364 *
9365 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9366 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9367 *
9368 * Only models listed in thinkwiki will be supported, so add yours
9369 * if it is not there yet.
9370 */
9371#define IBM_BIOS_MODULE_ALIAS(__type) \
9372	MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9373
9374/* Ancient thinkpad BIOSes have to be identified by
9375 * BIOS type or model number, and there are far less
9376 * BIOS types than model numbers... */
9377IBM_BIOS_MODULE_ALIAS("I[MU]");		/* 570, 570e */
9378
9379MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9380MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9381MODULE_DESCRIPTION(TPACPI_DESC);
9382MODULE_VERSION(TPACPI_VERSION);
9383MODULE_LICENSE("GPL");
9384
9385module_init(thinkpad_acpi_module_init);
9386module_exit(thinkpad_acpi_module_exit);