1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 *  thinkpad_acpi.c - ThinkPad ACPI Extras
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
9#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10
11#define TPACPI_VERSION "0.26"
12#define TPACPI_SYSFS_VERSION 0x030000
13
14/*
15 *  Changelog:
16 *  2007-10-20		changelog trimmed down
17 *
18 *  2007-03-27  0.14	renamed to thinkpad_acpi and moved to
19 *  			drivers/misc.
20 *
21 *  2006-11-22	0.13	new maintainer
22 *  			changelog now lives in git commit history, and will
23 *  			not be updated further in-file.
24 *
25 *  2005-03-17	0.11	support for 600e, 770x
26 *			    thanks to Jamie Lentin <lentinj@dial.pipex.com>
27 *
28 *  2005-01-16	0.9	use MODULE_VERSION
29 *			    thanks to Henrik Brix Andersen <brix@gentoo.org>
30 *			fix parameter passing on module loading
31 *			    thanks to Rusty Russell <rusty@rustcorp.com.au>
32 *			    thanks to Jim Radford <radford@blackbean.org>
33 *  2004-11-08	0.8	fix init error case, don't return from a macro
34 *			    thanks to Chris Wright <chrisw@osdl.org>
35 */
36
37#include <linux/acpi.h>
38#include <linux/backlight.h>
39#include <linux/bitops.h>
40#include <linux/delay.h>
41#include <linux/dmi.h>
42#include <linux/fb.h>
43#include <linux/freezer.h>
44#include <linux/hwmon.h>
45#include <linux/hwmon-sysfs.h>
46#include <linux/init.h>
47#include <linux/input.h>
48#include <linux/jiffies.h>
49#include <linux/kernel.h>
50#include <linux/kthread.h>
51#include <linux/leds.h>
52#include <linux/list.h>
53#include <linux/lockdep.h>
54#include <linux/module.h>
55#include <linux/mutex.h>
56#include <linux/nvram.h>
57#include <linux/pci.h>
58#include <linux/platform_device.h>
59#include <linux/platform_profile.h>
60#include <linux/power_supply.h>
61#include <linux/proc_fs.h>
62#include <linux/rfkill.h>
63#include <linux/sched.h>
64#include <linux/sched/signal.h>
65#include <linux/seq_file.h>
66#include <linux/slab.h>
67#include <linux/string.h>
68#include <linux/string_helpers.h>
69#include <linux/sysfs.h>
70#include <linux/types.h>
71#include <linux/uaccess.h>
72#include <linux/workqueue.h>
73
74#include <acpi/battery.h>
75#include <acpi/video.h>
76
77#include <drm/drm_privacy_screen_driver.h>
78
79#include <sound/control.h>
80#include <sound/core.h>
81#include <sound/initval.h>
82
83#include "dual_accel_detect.h"
84
85/* ThinkPad CMOS commands */
86#define TP_CMOS_VOLUME_DOWN	0
87#define TP_CMOS_VOLUME_UP	1
88#define TP_CMOS_VOLUME_MUTE	2
89#define TP_CMOS_BRIGHTNESS_UP	4
90#define TP_CMOS_BRIGHTNESS_DOWN	5
91#define TP_CMOS_THINKLIGHT_ON	12
92#define TP_CMOS_THINKLIGHT_OFF	13
93
94/* NVRAM Addresses */
95enum tp_nvram_addr {
96	TP_NVRAM_ADDR_HK2		= 0x57,
97	TP_NVRAM_ADDR_THINKLIGHT	= 0x58,
98	TP_NVRAM_ADDR_VIDEO		= 0x59,
99	TP_NVRAM_ADDR_BRIGHTNESS	= 0x5e,
100	TP_NVRAM_ADDR_MIXER		= 0x60,
101};
102
103/* NVRAM bit masks */
104enum {
105	TP_NVRAM_MASK_HKT_THINKPAD	= 0x08,
106	TP_NVRAM_MASK_HKT_ZOOM		= 0x20,
107	TP_NVRAM_MASK_HKT_DISPLAY	= 0x40,
108	TP_NVRAM_MASK_HKT_HIBERNATE	= 0x80,
109	TP_NVRAM_MASK_THINKLIGHT	= 0x10,
110	TP_NVRAM_MASK_HKT_DISPEXPND	= 0x30,
111	TP_NVRAM_MASK_HKT_BRIGHTNESS	= 0x20,
112	TP_NVRAM_MASK_LEVEL_BRIGHTNESS	= 0x0f,
113	TP_NVRAM_POS_LEVEL_BRIGHTNESS	= 0,
114	TP_NVRAM_MASK_MUTE		= 0x40,
115	TP_NVRAM_MASK_HKT_VOLUME	= 0x80,
116	TP_NVRAM_MASK_LEVEL_VOLUME	= 0x0f,
117	TP_NVRAM_POS_LEVEL_VOLUME	= 0,
118};
119
120/* Misc NVRAM-related */
121enum {
122	TP_NVRAM_LEVEL_VOLUME_MAX = 14,
123};
124
125/* ACPI HIDs */
126#define TPACPI_ACPI_IBM_HKEY_HID	"IBM0068"
127#define TPACPI_ACPI_LENOVO_HKEY_HID	"LEN0068"
128#define TPACPI_ACPI_LENOVO_HKEY_V2_HID	"LEN0268"
129#define TPACPI_ACPI_EC_HID		"PNP0C09"
130
131/* Input IDs */
132#define TPACPI_HKEY_INPUT_PRODUCT	0x5054 /* "TP" */
133#define TPACPI_HKEY_INPUT_VERSION	0x4101
134
135/* ACPI \WGSV commands */
136enum {
137	TP_ACPI_WGSV_GET_STATE		= 0x01, /* Get state information */
138	TP_ACPI_WGSV_PWR_ON_ON_RESUME	= 0x02, /* Resume WWAN powered on */
139	TP_ACPI_WGSV_PWR_OFF_ON_RESUME	= 0x03,	/* Resume WWAN powered off */
140	TP_ACPI_WGSV_SAVE_STATE		= 0x04, /* Save state for S4/S5 */
141};
142
143/* TP_ACPI_WGSV_GET_STATE bits */
144enum {
145	TP_ACPI_WGSV_STATE_WWANEXIST	= 0x0001, /* WWAN hw available */
146	TP_ACPI_WGSV_STATE_WWANPWR	= 0x0002, /* WWAN radio enabled */
147	TP_ACPI_WGSV_STATE_WWANPWRRES	= 0x0004, /* WWAN state at resume */
148	TP_ACPI_WGSV_STATE_WWANBIOSOFF	= 0x0008, /* WWAN disabled in BIOS */
149	TP_ACPI_WGSV_STATE_BLTHEXIST	= 0x0001, /* BLTH hw available */
150	TP_ACPI_WGSV_STATE_BLTHPWR	= 0x0002, /* BLTH radio enabled */
151	TP_ACPI_WGSV_STATE_BLTHPWRRES	= 0x0004, /* BLTH state at resume */
152	TP_ACPI_WGSV_STATE_BLTHBIOSOFF	= 0x0008, /* BLTH disabled in BIOS */
153	TP_ACPI_WGSV_STATE_UWBEXIST	= 0x0010, /* UWB hw available */
154	TP_ACPI_WGSV_STATE_UWBPWR	= 0x0020, /* UWB radio enabled */
155};
156
157/* HKEY events */
158enum tpacpi_hkey_event_t {
159	/* Hotkey-related */
160	TP_HKEY_EV_HOTKEY_BASE		= 0x1001, /* first hotkey (FN+F1) */
161	TP_HKEY_EV_BRGHT_UP		= 0x1010, /* Brightness up */
162	TP_HKEY_EV_BRGHT_DOWN		= 0x1011, /* Brightness down */
163	TP_HKEY_EV_KBD_LIGHT		= 0x1012, /* Thinklight/kbd backlight */
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	TP_HKEY_EV_PRIVACYGUARD_TOGGLE	= 0x130f, /* Toggle priv.guard on/off */
168	TP_HKEY_EV_AMT_TOGGLE		= 0x131a, /* Toggle AMT on/off */
169
170	/* Reasons for waking up from S3/S4 */
171	TP_HKEY_EV_WKUP_S3_UNDOCK	= 0x2304, /* undock requested, S3 */
172	TP_HKEY_EV_WKUP_S4_UNDOCK	= 0x2404, /* undock requested, S4 */
173	TP_HKEY_EV_WKUP_S3_BAYEJ	= 0x2305, /* bay ejection req, S3 */
174	TP_HKEY_EV_WKUP_S4_BAYEJ	= 0x2405, /* bay ejection req, S4 */
175	TP_HKEY_EV_WKUP_S3_BATLOW	= 0x2313, /* battery empty, S3 */
176	TP_HKEY_EV_WKUP_S4_BATLOW	= 0x2413, /* battery empty, S4 */
177
178	/* Auto-sleep after eject request */
179	TP_HKEY_EV_BAYEJ_ACK		= 0x3003, /* bay ejection complete */
180	TP_HKEY_EV_UNDOCK_ACK		= 0x4003, /* undock complete */
181
182	/* Misc bay events */
183	TP_HKEY_EV_OPTDRV_EJ		= 0x3006, /* opt. drive tray ejected */
184	TP_HKEY_EV_HOTPLUG_DOCK		= 0x4010, /* docked into hotplug dock
185						     or port replicator */
186	TP_HKEY_EV_HOTPLUG_UNDOCK	= 0x4011, /* undocked from hotplug
187						     dock or port replicator */
188	/*
189	 * Thinkpad X1 Tablet series devices emit 0x4012 and 0x4013
190	 * when keyboard cover is attached, detached or folded onto the back
191	 */
192	TP_HKEY_EV_KBD_COVER_ATTACH	= 0x4012, /* keyboard cover attached */
193	TP_HKEY_EV_KBD_COVER_DETACH	= 0x4013, /* keyboard cover detached or folded back */
194
195	/* User-interface events */
196	TP_HKEY_EV_LID_CLOSE		= 0x5001, /* laptop lid closed */
197	TP_HKEY_EV_LID_OPEN		= 0x5002, /* laptop lid opened */
198	TP_HKEY_EV_TABLET_TABLET	= 0x5009, /* tablet swivel up */
199	TP_HKEY_EV_TABLET_NOTEBOOK	= 0x500a, /* tablet swivel down */
200	TP_HKEY_EV_TABLET_CHANGED	= 0x60c0, /* X1 Yoga (2016):
201						   * enter/leave tablet mode
202						   */
203	TP_HKEY_EV_PEN_INSERTED		= 0x500b, /* tablet pen inserted */
204	TP_HKEY_EV_PEN_REMOVED		= 0x500c, /* tablet pen removed */
205	TP_HKEY_EV_BRGHT_CHANGED	= 0x5010, /* backlight control event */
206
207	/* Key-related user-interface events */
208	TP_HKEY_EV_KEY_NUMLOCK		= 0x6000, /* NumLock key pressed */
209	TP_HKEY_EV_KEY_FN		= 0x6005, /* Fn key pressed? E420 */
210	TP_HKEY_EV_KEY_FN_ESC           = 0x6060, /* Fn+Esc key pressed X240 */
211
212	/* Thermal events */
213	TP_HKEY_EV_ALARM_BAT_HOT	= 0x6011, /* battery too hot */
214	TP_HKEY_EV_ALARM_BAT_XHOT	= 0x6012, /* battery critically hot */
215	TP_HKEY_EV_ALARM_SENSOR_HOT	= 0x6021, /* sensor too hot */
216	TP_HKEY_EV_ALARM_SENSOR_XHOT	= 0x6022, /* sensor critically hot */
217	TP_HKEY_EV_THM_TABLE_CHANGED	= 0x6030, /* windows; thermal table changed */
218	TP_HKEY_EV_THM_CSM_COMPLETED    = 0x6032, /* windows; thermal control set
219						   * command completed. Related to
220						   * AML DYTC */
221	TP_HKEY_EV_THM_TRANSFM_CHANGED  = 0x60F0, /* windows; thermal transformation
222						   * changed. Related to AML GMTS */
223
224	/* AC-related events */
225	TP_HKEY_EV_AC_CHANGED		= 0x6040, /* AC status changed */
226
227	/* Further user-interface events */
228	TP_HKEY_EV_PALM_DETECTED	= 0x60b0, /* palm hoveres keyboard */
229	TP_HKEY_EV_PALM_UNDETECTED	= 0x60b1, /* palm removed */
230
231	/* Misc */
232	TP_HKEY_EV_RFKILL_CHANGED	= 0x7000, /* rfkill switch changed */
233};
234
235/****************************************************************************
236 * Main driver
237 */
238
239#define TPACPI_NAME "thinkpad"
240#define TPACPI_DESC "ThinkPad ACPI Extras"
241#define TPACPI_FILE TPACPI_NAME "_acpi"
242#define TPACPI_URL "http://ibm-acpi.sf.net/"
243#define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
244
245#define TPACPI_PROC_DIR "ibm"
246#define TPACPI_ACPI_EVENT_PREFIX "ibm"
247#define TPACPI_DRVR_NAME TPACPI_FILE
248#define TPACPI_DRVR_SHORTNAME "tpacpi"
249#define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
250
251#define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
252#define TPACPI_WORKQUEUE_NAME "ktpacpid"
253
254#define TPACPI_MAX_ACPI_ARGS 3
255
256/* Debugging printk groups */
257#define TPACPI_DBG_ALL		0xffff
258#define TPACPI_DBG_DISCLOSETASK	0x8000
259#define TPACPI_DBG_INIT		0x0001
260#define TPACPI_DBG_EXIT		0x0002
261#define TPACPI_DBG_RFKILL	0x0004
262#define TPACPI_DBG_HKEY		0x0008
263#define TPACPI_DBG_FAN		0x0010
264#define TPACPI_DBG_BRGHT	0x0020
265#define TPACPI_DBG_MIXER	0x0040
266
267#define FAN_NOT_PRESENT		65535
268
269/****************************************************************************
270 * Driver-wide structs and misc. variables
271 */
272
273struct ibm_struct;
274
275struct tp_acpi_drv_struct {
276	const struct acpi_device_id *hid;
277	struct acpi_driver *driver;
278
279	void (*notify) (struct ibm_struct *, u32);
280	acpi_handle *handle;
281	u32 type;
282	struct acpi_device *device;
283};
284
285struct ibm_struct {
286	char *name;
287
288	int (*read) (struct seq_file *);
289	int (*write) (char *);
290	void (*exit) (void);
291	void (*resume) (void);
292	void (*suspend) (void);
293	void (*shutdown) (void);
294
295	struct list_head all_drivers;
296
297	struct tp_acpi_drv_struct *acpi;
298
299	struct {
300		u8 acpi_driver_registered:1;
301		u8 acpi_notify_installed:1;
302		u8 proc_created:1;
303		u8 init_called:1;
304		u8 experimental:1;
305	} flags;
306};
307
308struct ibm_init_struct {
309	char param[32];
310
311	int (*init) (struct ibm_init_struct *);
312	umode_t base_procfs_mode;
313	struct ibm_struct *data;
314};
315
316/* DMI Quirks */
317struct quirk_entry {
318	bool btusb_bug;
319};
320
321static struct quirk_entry quirk_btusb_bug = {
322	.btusb_bug = true,
323};
324
325static struct {
326	u32 bluetooth:1;
327	u32 hotkey:1;
328	u32 hotkey_mask:1;
329	u32 hotkey_wlsw:1;
330	enum {
331		TP_HOTKEY_TABLET_NONE = 0,
332		TP_HOTKEY_TABLET_USES_MHKG,
333		TP_HOTKEY_TABLET_USES_GMMS,
334	} hotkey_tablet;
335	u32 kbdlight:1;
336	u32 light:1;
337	u32 light_status:1;
338	u32 bright_acpimode:1;
339	u32 bright_unkfw:1;
340	u32 wan:1;
341	u32 uwb:1;
342	u32 fan_ctrl_status_undef:1;
343	u32 second_fan:1;
344	u32 second_fan_ctl:1;
345	u32 beep_needs_two_args:1;
346	u32 mixer_no_level_control:1;
347	u32 battery_force_primary:1;
348	u32 input_device_registered:1;
349	u32 platform_drv_registered:1;
350	u32 sensors_pdrv_registered:1;
351	u32 hotkey_poll_active:1;
352	u32 has_adaptive_kbd:1;
353	u32 kbd_lang:1;
354	struct quirk_entry *quirks;
355} tp_features;
356
357static struct {
358	u16 hotkey_mask_ff:1;
359	u16 volume_ctrl_forbidden:1;
360} tp_warned;
361
362struct thinkpad_id_data {
363	unsigned int vendor;	/* ThinkPad vendor:
364				 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
365
366	char *bios_version_str;	/* Something like 1ZET51WW (1.03z) */
367	char *ec_version_str;	/* Something like 1ZHT51WW-1.04a */
368
369	u32 bios_model;		/* 1Y = 0x3159, 0 = unknown */
370	u32 ec_model;
371	u16 bios_release;	/* 1ZETK1WW = 0x4b31, 0 = unknown */
372	u16 ec_release;
373
374	char *model_str;	/* ThinkPad T43 */
375	char *nummodel_str;	/* 9384A9C for a 9384-A9C model */
376};
377static struct thinkpad_id_data thinkpad_id;
378
379static enum {
380	TPACPI_LIFE_INIT = 0,
381	TPACPI_LIFE_RUNNING,
382	TPACPI_LIFE_EXITING,
383} tpacpi_lifecycle;
384
385static int experimental;
386static u32 dbg_level;
387
388static struct workqueue_struct *tpacpi_wq;
389
390enum led_status_t {
391	TPACPI_LED_OFF = 0,
392	TPACPI_LED_ON,
393	TPACPI_LED_BLINK,
394};
395
396/* tpacpi LED class */
397struct tpacpi_led_classdev {
398	struct led_classdev led_classdev;
399	int led;
400};
401
402/* brightness level capabilities */
403static unsigned int bright_maxlvl;	/* 0 = unknown */
404
405#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
406static int dbg_wlswemul;
407static bool tpacpi_wlsw_emulstate;
408static int dbg_bluetoothemul;
409static bool tpacpi_bluetooth_emulstate;
410static int dbg_wwanemul;
411static bool tpacpi_wwan_emulstate;
412static int dbg_uwbemul;
413static bool tpacpi_uwb_emulstate;
414#endif
415
416
417/*************************************************************************
418 *  Debugging helpers
419 */
420
421#define dbg_printk(a_dbg_level, format, arg...)				\
422do {									\
423	if (dbg_level & (a_dbg_level))					\
424		printk(KERN_DEBUG pr_fmt("%s: " format),		\
425		       __func__, ##arg);				\
426} while (0)
427
428#ifdef CONFIG_THINKPAD_ACPI_DEBUG
429#define vdbg_printk dbg_printk
430static const char *str_supported(int is_supported);
431#else
432static inline const char *str_supported(int is_supported) { return ""; }
433#define vdbg_printk(a_dbg_level, format, arg...)	\
434	do { if (0) no_printk(format, ##arg); } while (0)
435#endif
436
437static void tpacpi_log_usertask(const char * const what)
438{
439	printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
440	       what, task_tgid_vnr(current));
441}
442
443#define tpacpi_disclose_usertask(what, format, arg...)			\
444do {									\
445	if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) &&		\
446		     (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) {	\
447		printk(KERN_DEBUG pr_fmt("%s: PID %d: " format),	\
448		       what, task_tgid_vnr(current), ## arg);		\
449	}								\
450} while (0)
451
452/*
453 * Quirk handling helpers
454 *
455 * ThinkPad IDs and versions seen in the field so far are
456 * two or three characters from the set [0-9A-Z], i.e. base 36.
457 *
458 * We use values well outside that range as specials.
459 */
460
461#define TPACPI_MATCH_ANY		0xffffffffU
462#define TPACPI_MATCH_ANY_VERSION	0xffffU
463#define TPACPI_MATCH_UNKNOWN		0U
464
465/* TPID('1', 'Y') == 0x3159 */
466#define TPID(__c1, __c2)	(((__c1) << 8) | (__c2))
467#define TPID3(__c1, __c2, __c3)	(((__c1) << 16) | ((__c2) << 8) | (__c3))
468#define TPVER TPID
469
470#define TPACPI_Q_IBM(__id1, __id2, __quirk)	\
471	{ .vendor = PCI_VENDOR_ID_IBM,		\
472	  .bios = TPID(__id1, __id2),		\
473	  .ec = TPACPI_MATCH_ANY,		\
474	  .quirks = (__quirk) }
475
476#define TPACPI_Q_LNV(__id1, __id2, __quirk)	\
477	{ .vendor = PCI_VENDOR_ID_LENOVO,	\
478	  .bios = TPID(__id1, __id2),		\
479	  .ec = TPACPI_MATCH_ANY,		\
480	  .quirks = (__quirk) }
481
482#define TPACPI_Q_LNV3(__id1, __id2, __id3, __quirk) \
483	{ .vendor = PCI_VENDOR_ID_LENOVO,	\
484	  .bios = TPID3(__id1, __id2, __id3),	\
485	  .ec = TPACPI_MATCH_ANY,		\
486	  .quirks = (__quirk) }
487
488#define TPACPI_QEC_IBM(__id1, __id2, __quirk)	\
489	{ .vendor = PCI_VENDOR_ID_IBM,		\
490	  .bios = TPACPI_MATCH_ANY,		\
491	  .ec = TPID(__id1, __id2),		\
492	  .quirks = (__quirk) }
493
494#define TPACPI_QEC_LNV(__id1, __id2, __quirk)	\
495	{ .vendor = PCI_VENDOR_ID_LENOVO,	\
496	  .bios = TPACPI_MATCH_ANY,		\
497	  .ec = TPID(__id1, __id2),		\
498	  .quirks = (__quirk) }
499
500struct tpacpi_quirk {
501	unsigned int vendor;
502	u32 bios;
503	u32 ec;
504	unsigned long quirks;
505};
506
507/**
508 * tpacpi_check_quirks() - search BIOS/EC version on a list
509 * @qlist:		array of &struct tpacpi_quirk
510 * @qlist_size:		number of elements in @qlist
511 *
512 * Iterates over a quirks list until one is found that matches the
513 * ThinkPad's vendor, BIOS and EC model.
514 *
515 * Returns 0 if nothing matches, otherwise returns the quirks field of
516 * the matching &struct tpacpi_quirk entry.
517 *
518 * The match criteria is: vendor, ec and bios much match.
519 */
520static unsigned long __init tpacpi_check_quirks(
521			const struct tpacpi_quirk *qlist,
522			unsigned int qlist_size)
523{
524	while (qlist_size) {
525		if ((qlist->vendor == thinkpad_id.vendor ||
526				qlist->vendor == TPACPI_MATCH_ANY) &&
527		    (qlist->bios == thinkpad_id.bios_model ||
528				qlist->bios == TPACPI_MATCH_ANY) &&
529		    (qlist->ec == thinkpad_id.ec_model ||
530				qlist->ec == TPACPI_MATCH_ANY))
531			return qlist->quirks;
532
533		qlist_size--;
534		qlist++;
535	}
536	return 0;
537}
538
539static inline bool __pure __init tpacpi_is_lenovo(void)
540{
541	return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
542}
543
544static inline bool __pure __init tpacpi_is_ibm(void)
545{
546	return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
547}
548
549/****************************************************************************
550 ****************************************************************************
551 *
552 * ACPI Helpers and device model
553 *
554 ****************************************************************************
555 ****************************************************************************/
556
557/*************************************************************************
558 * ACPI basic handles
559 */
560
561static acpi_handle root_handle;
562static acpi_handle ec_handle;
563
564#define TPACPI_HANDLE(object, parent, paths...)			\
565	static acpi_handle  object##_handle;			\
566	static const acpi_handle * const object##_parent __initconst =	\
567						&parent##_handle; \
568	static char *object##_paths[] __initdata = { paths }
569
570TPACPI_HANDLE(ecrd, ec, "ECRD");	/* 570 */
571TPACPI_HANDLE(ecwr, ec, "ECWR");	/* 570 */
572
573TPACPI_HANDLE(cmos, root, "\\UCMS",	/* R50, R50e, R50p, R51, */
574					/* T4x, X31, X40 */
575	   "\\CMOS",		/* A3x, G4x, R32, T23, T30, X22-24, X30 */
576	   "\\CMS",		/* R40, R40e */
577	   );			/* all others */
578
579TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY",	/* 600e/x, 770e, 770x */
580	   "^HKEY",		/* R30, R31 */
581	   "HKEY",		/* all others */
582	   );			/* 570 */
583
584/*************************************************************************
585 * ACPI helpers
586 */
587
588static int acpi_evalf(acpi_handle handle,
589		      int *res, char *method, char *fmt, ...)
590{
591	char *fmt0 = fmt;
592	struct acpi_object_list params;
593	union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
594	struct acpi_buffer result, *resultp;
595	union acpi_object out_obj;
596	acpi_status status;
597	va_list ap;
598	char res_type;
599	int success;
600	int quiet;
601
602	if (!*fmt) {
603		pr_err("acpi_evalf() called with empty format\n");
604		return 0;
605	}
606
607	if (*fmt == 'q') {
608		quiet = 1;
609		fmt++;
610	} else
611		quiet = 0;
612
613	res_type = *(fmt++);
614
615	params.count = 0;
616	params.pointer = &in_objs[0];
617
618	va_start(ap, fmt);
619	while (*fmt) {
620		char c = *(fmt++);
621		switch (c) {
622		case 'd':	/* int */
623			in_objs[params.count].integer.value = va_arg(ap, int);
624			in_objs[params.count++].type = ACPI_TYPE_INTEGER;
625			break;
626			/* add more types as needed */
627		default:
628			pr_err("acpi_evalf() called with invalid format character '%c'\n",
629			       c);
630			va_end(ap);
631			return 0;
632		}
633	}
634	va_end(ap);
635
636	if (res_type != 'v') {
637		result.length = sizeof(out_obj);
638		result.pointer = &out_obj;
639		resultp = &result;
640	} else
641		resultp = NULL;
642
643	status = acpi_evaluate_object(handle, method, &params, resultp);
644
645	switch (res_type) {
646	case 'd':		/* int */
647		success = (status == AE_OK &&
648			   out_obj.type == ACPI_TYPE_INTEGER);
649		if (success && res)
650			*res = out_obj.integer.value;
651		break;
652	case 'v':		/* void */
653		success = status == AE_OK;
654		break;
655		/* add more types as needed */
656	default:
657		pr_err("acpi_evalf() called with invalid format character '%c'\n",
658		       res_type);
659		return 0;
660	}
661
662	if (!success && !quiet)
663		pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
664		       method, fmt0, acpi_format_exception(status));
665
666	return success;
667}
668
669static int acpi_ec_read(int i, u8 *p)
670{
671	int v;
672
673	if (ecrd_handle) {
674		if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
675			return 0;
676		*p = v;
677	} else {
678		if (ec_read(i, p) < 0)
679			return 0;
680	}
681
682	return 1;
683}
684
685static int acpi_ec_write(int i, u8 v)
686{
687	if (ecwr_handle) {
688		if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
689			return 0;
690	} else {
691		if (ec_write(i, v) < 0)
692			return 0;
693	}
694
695	return 1;
696}
697
698static int issue_thinkpad_cmos_command(int cmos_cmd)
699{
700	if (!cmos_handle)
701		return -ENXIO;
702
703	if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
704		return -EIO;
705
706	return 0;
707}
708
709/*************************************************************************
710 * ACPI device model
711 */
712
713#define TPACPI_ACPIHANDLE_INIT(object) \
714	drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
715		object##_paths, ARRAY_SIZE(object##_paths))
716
717static void __init drv_acpi_handle_init(const char *name,
718			   acpi_handle *handle, const acpi_handle parent,
719			   char **paths, const int num_paths)
720{
721	int i;
722	acpi_status status;
723
724	vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
725		name);
726
727	for (i = 0; i < num_paths; i++) {
728		status = acpi_get_handle(parent, paths[i], handle);
729		if (ACPI_SUCCESS(status)) {
730			dbg_printk(TPACPI_DBG_INIT,
731				   "Found ACPI handle %s for %s\n",
732				   paths[i], name);
733			return;
734		}
735	}
736
737	vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
738		    name);
739	*handle = NULL;
740}
741
742static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
743			u32 level, void *context, void **return_value)
744{
745	if (!strcmp(context, "video")) {
746		struct acpi_device *dev = acpi_fetch_acpi_dev(handle);
747
748		if (!dev || strcmp(ACPI_VIDEO_HID, acpi_device_hid(dev)))
749			return AE_OK;
750	}
751
752	*(acpi_handle *)return_value = handle;
753
754	return AE_CTRL_TERMINATE;
755}
756
757static void __init tpacpi_acpi_handle_locate(const char *name,
758		const char *hid,
759		acpi_handle *handle)
760{
761	acpi_status status;
762	acpi_handle device_found;
763
764	BUG_ON(!name || !handle);
765	vdbg_printk(TPACPI_DBG_INIT,
766			"trying to locate ACPI handle for %s, using HID %s\n",
767			name, hid ? hid : "NULL");
768
769	memset(&device_found, 0, sizeof(device_found));
770	status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
771				  (void *)name, &device_found);
772
773	*handle = NULL;
774
775	if (ACPI_SUCCESS(status)) {
776		*handle = device_found;
777		dbg_printk(TPACPI_DBG_INIT,
778			   "Found ACPI handle for %s\n", name);
779	} else {
780		vdbg_printk(TPACPI_DBG_INIT,
781			    "Could not locate an ACPI handle for %s: %s\n",
782			    name, acpi_format_exception(status));
783	}
784}
785
786static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
787{
788	struct ibm_struct *ibm = data;
789
790	if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
791		return;
792
793	if (!ibm || !ibm->acpi || !ibm->acpi->notify)
794		return;
795
796	ibm->acpi->notify(ibm, event);
797}
798
799static int __init setup_acpi_notify(struct ibm_struct *ibm)
800{
801	acpi_status status;
802
803	BUG_ON(!ibm->acpi);
804
805	if (!*ibm->acpi->handle)
806		return 0;
807
808	vdbg_printk(TPACPI_DBG_INIT,
809		"setting up ACPI notify for %s\n", ibm->name);
810
811	ibm->acpi->device = acpi_fetch_acpi_dev(*ibm->acpi->handle);
812	if (!ibm->acpi->device) {
813		pr_err("acpi_fetch_acpi_dev(%s) failed\n", ibm->name);
814		return -ENODEV;
815	}
816
817	ibm->acpi->device->driver_data = ibm;
818	sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
819		TPACPI_ACPI_EVENT_PREFIX,
820		ibm->name);
821
822	status = acpi_install_notify_handler(*ibm->acpi->handle,
823			ibm->acpi->type, dispatch_acpi_notify, ibm);
824	if (ACPI_FAILURE(status)) {
825		if (status == AE_ALREADY_EXISTS) {
826			pr_notice("another device driver is already handling %s events\n",
827				  ibm->name);
828		} else {
829			pr_err("acpi_install_notify_handler(%s) failed: %s\n",
830			       ibm->name, acpi_format_exception(status));
831		}
832		return -ENODEV;
833	}
834	ibm->flags.acpi_notify_installed = 1;
835	return 0;
836}
837
838static int __init tpacpi_device_add(struct acpi_device *device)
839{
840	return 0;
841}
842
843static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
844{
845	int rc;
846
847	dbg_printk(TPACPI_DBG_INIT,
848		"registering %s as an ACPI driver\n", ibm->name);
849
850	BUG_ON(!ibm->acpi);
851
852	ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
853	if (!ibm->acpi->driver) {
854		pr_err("failed to allocate memory for ibm->acpi->driver\n");
855		return -ENOMEM;
856	}
857
858	sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
859	ibm->acpi->driver->ids = ibm->acpi->hid;
860
861	ibm->acpi->driver->ops.add = &tpacpi_device_add;
862
863	rc = acpi_bus_register_driver(ibm->acpi->driver);
864	if (rc < 0) {
865		pr_err("acpi_bus_register_driver(%s) failed: %d\n",
866		       ibm->name, rc);
867		kfree(ibm->acpi->driver);
868		ibm->acpi->driver = NULL;
869	} else if (!rc)
870		ibm->flags.acpi_driver_registered = 1;
871
872	return rc;
873}
874
875
876/****************************************************************************
877 ****************************************************************************
878 *
879 * Procfs Helpers
880 *
881 ****************************************************************************
882 ****************************************************************************/
883
884static int dispatch_proc_show(struct seq_file *m, void *v)
885{
886	struct ibm_struct *ibm = m->private;
887
888	if (!ibm || !ibm->read)
889		return -EINVAL;
890	return ibm->read(m);
891}
892
893static int dispatch_proc_open(struct inode *inode, struct file *file)
894{
895	return single_open(file, dispatch_proc_show, pde_data(inode));
896}
897
898static ssize_t dispatch_proc_write(struct file *file,
899			const char __user *userbuf,
900			size_t count, loff_t *pos)
901{
902	struct ibm_struct *ibm = pde_data(file_inode(file));
903	char *kernbuf;
904	int ret;
905
906	if (!ibm || !ibm->write)
907		return -EINVAL;
908	if (count > PAGE_SIZE - 1)
909		return -EINVAL;
910
911	kernbuf = memdup_user_nul(userbuf, count);
912	if (IS_ERR(kernbuf))
913		return PTR_ERR(kernbuf);
914	ret = ibm->write(kernbuf);
915	if (ret == 0)
916		ret = count;
917
918	kfree(kernbuf);
919
920	return ret;
921}
922
923static const struct proc_ops dispatch_proc_ops = {
924	.proc_open	= dispatch_proc_open,
925	.proc_read	= seq_read,
926	.proc_lseek	= seq_lseek,
927	.proc_release	= single_release,
928	.proc_write	= dispatch_proc_write,
929};
930
931/****************************************************************************
932 ****************************************************************************
933 *
934 * Device model: input, hwmon and platform
935 *
936 ****************************************************************************
937 ****************************************************************************/
938
939static struct platform_device *tpacpi_pdev;
940static struct platform_device *tpacpi_sensors_pdev;
941static struct device *tpacpi_hwmon;
942static struct input_dev *tpacpi_inputdev;
943static struct mutex tpacpi_inputdev_send_mutex;
944static LIST_HEAD(tpacpi_all_drivers);
945
946#ifdef CONFIG_PM_SLEEP
947static int tpacpi_suspend_handler(struct device *dev)
948{
949	struct ibm_struct *ibm, *itmp;
950
951	list_for_each_entry_safe(ibm, itmp,
952				 &tpacpi_all_drivers,
953				 all_drivers) {
954		if (ibm->suspend)
955			(ibm->suspend)();
956	}
957
958	return 0;
959}
960
961static int tpacpi_resume_handler(struct device *dev)
962{
963	struct ibm_struct *ibm, *itmp;
964
965	list_for_each_entry_safe(ibm, itmp,
966				 &tpacpi_all_drivers,
967				 all_drivers) {
968		if (ibm->resume)
969			(ibm->resume)();
970	}
971
972	return 0;
973}
974#endif
975
976static SIMPLE_DEV_PM_OPS(tpacpi_pm,
977			 tpacpi_suspend_handler, tpacpi_resume_handler);
978
979static void tpacpi_shutdown_handler(struct platform_device *pdev)
980{
981	struct ibm_struct *ibm, *itmp;
982
983	list_for_each_entry_safe(ibm, itmp,
984				 &tpacpi_all_drivers,
985				 all_drivers) {
986		if (ibm->shutdown)
987			(ibm->shutdown)();
988	}
989}
990
991/*************************************************************************
992 * sysfs support helpers
993 */
994
995static int parse_strtoul(const char *buf,
996		unsigned long max, unsigned long *value)
997{
998	char *endp;
999
1000	*value = simple_strtoul(skip_spaces(buf), &endp, 0);
1001	endp = skip_spaces(endp);
1002	if (*endp || *value > max)
1003		return -EINVAL;
1004
1005	return 0;
1006}
1007
1008static void tpacpi_disable_brightness_delay(void)
1009{
1010	if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1011		pr_notice("ACPI backlight control delay disabled\n");
1012}
1013
1014static void printk_deprecated_attribute(const char * const what,
1015					const char * const details)
1016{
1017	tpacpi_log_usertask("deprecated sysfs attribute");
1018	pr_warn("WARNING: sysfs attribute %s is deprecated and will be removed. %s\n",
1019		what, details);
1020}
1021
1022/*************************************************************************
1023 * rfkill and radio control support helpers
1024 */
1025
1026/*
1027 * ThinkPad-ACPI firmware handling model:
1028 *
1029 * WLSW (master wireless switch) is event-driven, and is common to all
1030 * firmware-controlled radios.  It cannot be controlled, just monitored,
1031 * as expected.  It overrides all radio state in firmware
1032 *
1033 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1034 * (TODO: verify how WLSW interacts with the returned radio state).
1035 *
1036 * The only time there are shadow radio state changes, is when
1037 * masked-off hotkeys are used.
1038 */
1039
1040/*
1041 * Internal driver API for radio state:
1042 *
1043 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1044 * bool: true means radio blocked (off)
1045 */
1046enum tpacpi_rfkill_state {
1047	TPACPI_RFK_RADIO_OFF = 0,
1048	TPACPI_RFK_RADIO_ON
1049};
1050
1051/* rfkill switches */
1052enum tpacpi_rfk_id {
1053	TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1054	TPACPI_RFK_WWAN_SW_ID,
1055	TPACPI_RFK_UWB_SW_ID,
1056	TPACPI_RFK_SW_MAX
1057};
1058
1059static const char *tpacpi_rfkill_names[] = {
1060	[TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1061	[TPACPI_RFK_WWAN_SW_ID] = "wwan",
1062	[TPACPI_RFK_UWB_SW_ID] = "uwb",
1063	[TPACPI_RFK_SW_MAX] = NULL
1064};
1065
1066/* ThinkPad-ACPI rfkill subdriver */
1067struct tpacpi_rfk {
1068	struct rfkill *rfkill;
1069	enum tpacpi_rfk_id id;
1070	const struct tpacpi_rfk_ops *ops;
1071};
1072
1073struct tpacpi_rfk_ops {
1074	/* firmware interface */
1075	int (*get_status)(void);
1076	int (*set_status)(const enum tpacpi_rfkill_state);
1077};
1078
1079static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1080
1081/* Query FW and update rfkill sw state for a given rfkill switch */
1082static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1083{
1084	int status;
1085
1086	if (!tp_rfk)
1087		return -ENODEV;
1088
1089	status = (tp_rfk->ops->get_status)();
1090	if (status < 0)
1091		return status;
1092
1093	rfkill_set_sw_state(tp_rfk->rfkill,
1094			    (status == TPACPI_RFK_RADIO_OFF));
1095
1096	return status;
1097}
1098
1099/*
1100 * Sync the HW-blocking state of all rfkill switches,
1101 * do notice it causes the rfkill core to schedule uevents
1102 */
1103static void tpacpi_rfk_update_hwblock_state(bool blocked)
1104{
1105	unsigned int i;
1106	struct tpacpi_rfk *tp_rfk;
1107
1108	for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1109		tp_rfk = tpacpi_rfkill_switches[i];
1110		if (tp_rfk) {
1111			if (rfkill_set_hw_state(tp_rfk->rfkill,
1112						blocked)) {
1113				/* ignore -- we track sw block */
1114			}
1115		}
1116	}
1117}
1118
1119/* Call to get the WLSW state from the firmware */
1120static int hotkey_get_wlsw(void);
1121
1122/* Call to query WLSW state and update all rfkill switches */
1123static bool tpacpi_rfk_check_hwblock_state(void)
1124{
1125	int res = hotkey_get_wlsw();
1126	int hw_blocked;
1127
1128	/* When unknown or unsupported, we have to assume it is unblocked */
1129	if (res < 0)
1130		return false;
1131
1132	hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1133	tpacpi_rfk_update_hwblock_state(hw_blocked);
1134
1135	return hw_blocked;
1136}
1137
1138static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1139{
1140	struct tpacpi_rfk *tp_rfk = data;
1141	int res;
1142
1143	dbg_printk(TPACPI_DBG_RFKILL,
1144		   "request to change radio state to %s\n",
1145		   blocked ? "blocked" : "unblocked");
1146
1147	/* try to set radio state */
1148	res = (tp_rfk->ops->set_status)(blocked ?
1149				TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1150
1151	/* and update the rfkill core with whatever the FW really did */
1152	tpacpi_rfk_update_swstate(tp_rfk);
1153
1154	return (res < 0) ? res : 0;
1155}
1156
1157static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1158	.set_block = tpacpi_rfk_hook_set_block,
1159};
1160
1161static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1162			const struct tpacpi_rfk_ops *tp_rfkops,
1163			const enum rfkill_type rfktype,
1164			const char *name,
1165			const bool set_default)
1166{
1167	struct tpacpi_rfk *atp_rfk;
1168	int res;
1169	bool sw_state = false;
1170	bool hw_state;
1171	int sw_status;
1172
1173	BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1174
1175	atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1176	if (atp_rfk)
1177		atp_rfk->rfkill = rfkill_alloc(name,
1178						&tpacpi_pdev->dev,
1179						rfktype,
1180						&tpacpi_rfk_rfkill_ops,
1181						atp_rfk);
1182	if (!atp_rfk || !atp_rfk->rfkill) {
1183		pr_err("failed to allocate memory for rfkill class\n");
1184		kfree(atp_rfk);
1185		return -ENOMEM;
1186	}
1187
1188	atp_rfk->id = id;
1189	atp_rfk->ops = tp_rfkops;
1190
1191	sw_status = (tp_rfkops->get_status)();
1192	if (sw_status < 0) {
1193		pr_err("failed to read initial state for %s, error %d\n",
1194		       name, sw_status);
1195	} else {
1196		sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1197		if (set_default) {
1198			/* try to keep the initial state, since we ask the
1199			 * firmware to preserve it across S5 in NVRAM */
1200			rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1201		}
1202	}
1203	hw_state = tpacpi_rfk_check_hwblock_state();
1204	rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1205
1206	res = rfkill_register(atp_rfk->rfkill);
1207	if (res < 0) {
1208		pr_err("failed to register %s rfkill switch: %d\n", name, res);
1209		rfkill_destroy(atp_rfk->rfkill);
1210		kfree(atp_rfk);
1211		return res;
1212	}
1213
1214	tpacpi_rfkill_switches[id] = atp_rfk;
1215
1216	pr_info("rfkill switch %s: radio is %sblocked\n",
1217		name, (sw_state || hw_state) ? "" : "un");
1218	return 0;
1219}
1220
1221static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1222{
1223	struct tpacpi_rfk *tp_rfk;
1224
1225	BUG_ON(id >= TPACPI_RFK_SW_MAX);
1226
1227	tp_rfk = tpacpi_rfkill_switches[id];
1228	if (tp_rfk) {
1229		rfkill_unregister(tp_rfk->rfkill);
1230		rfkill_destroy(tp_rfk->rfkill);
1231		tpacpi_rfkill_switches[id] = NULL;
1232		kfree(tp_rfk);
1233	}
1234}
1235
1236static void printk_deprecated_rfkill_attribute(const char * const what)
1237{
1238	printk_deprecated_attribute(what,
1239			"Please switch to generic rfkill before year 2010");
1240}
1241
1242/* sysfs <radio> enable ------------------------------------------------ */
1243static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1244					    struct device_attribute *attr,
1245					    char *buf)
1246{
1247	int status;
1248
1249	printk_deprecated_rfkill_attribute(attr->attr.name);
1250
1251	/* This is in the ABI... */
1252	if (tpacpi_rfk_check_hwblock_state()) {
1253		status = TPACPI_RFK_RADIO_OFF;
1254	} else {
1255		status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1256		if (status < 0)
1257			return status;
1258	}
1259
1260	return sysfs_emit(buf, "%d\n",
1261			(status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1262}
1263
1264static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1265			    struct device_attribute *attr,
1266			    const char *buf, size_t count)
1267{
1268	unsigned long t;
1269	int res;
1270
1271	printk_deprecated_rfkill_attribute(attr->attr.name);
1272
1273	if (parse_strtoul(buf, 1, &t))
1274		return -EINVAL;
1275
1276	tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1277
1278	/* This is in the ABI... */
1279	if (tpacpi_rfk_check_hwblock_state() && !!t)
1280		return -EPERM;
1281
1282	res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1283				TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1284	tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1285
1286	return (res < 0) ? res : count;
1287}
1288
1289/* procfs -------------------------------------------------------------- */
1290static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1291{
1292	if (id >= TPACPI_RFK_SW_MAX)
1293		seq_printf(m, "status:\t\tnot supported\n");
1294	else {
1295		int status;
1296
1297		/* This is in the ABI... */
1298		if (tpacpi_rfk_check_hwblock_state()) {
1299			status = TPACPI_RFK_RADIO_OFF;
1300		} else {
1301			status = tpacpi_rfk_update_swstate(
1302						tpacpi_rfkill_switches[id]);
1303			if (status < 0)
1304				return status;
1305		}
1306
1307		seq_printf(m, "status:\t\t%s\n", str_enabled_disabled(status == TPACPI_RFK_RADIO_ON));
1308		seq_printf(m, "commands:\tenable, disable\n");
1309	}
1310
1311	return 0;
1312}
1313
1314static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1315{
1316	char *cmd;
1317	int status = -1;
1318	int res = 0;
1319
1320	if (id >= TPACPI_RFK_SW_MAX)
1321		return -ENODEV;
1322
1323	while ((cmd = strsep(&buf, ","))) {
1324		if (strstarts(cmd, "enable"))
1325			status = TPACPI_RFK_RADIO_ON;
1326		else if (strstarts(cmd, "disable"))
1327			status = TPACPI_RFK_RADIO_OFF;
1328		else
1329			return -EINVAL;
1330	}
1331
1332	if (status != -1) {
1333		tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1334				str_enable_disable(status == TPACPI_RFK_RADIO_ON),
1335				tpacpi_rfkill_names[id]);
1336		res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1337		tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1338	}
1339
1340	return res;
1341}
1342
1343/*************************************************************************
1344 * thinkpad-acpi driver attributes
1345 */
1346
1347/* interface_version --------------------------------------------------- */
1348static ssize_t interface_version_show(struct device_driver *drv, char *buf)
1349{
1350	return sysfs_emit(buf, "0x%08x\n", TPACPI_SYSFS_VERSION);
1351}
1352static DRIVER_ATTR_RO(interface_version);
1353
1354/* debug_level --------------------------------------------------------- */
1355static ssize_t debug_level_show(struct device_driver *drv, char *buf)
1356{
1357	return sysfs_emit(buf, "0x%04x\n", dbg_level);
1358}
1359
1360static ssize_t debug_level_store(struct device_driver *drv, const char *buf,
1361				 size_t count)
1362{
1363	unsigned long t;
1364
1365	if (parse_strtoul(buf, 0xffff, &t))
1366		return -EINVAL;
1367
1368	dbg_level = t;
1369
1370	return count;
1371}
1372static DRIVER_ATTR_RW(debug_level);
1373
1374/* version ------------------------------------------------------------- */
1375static ssize_t version_show(struct device_driver *drv, char *buf)
1376{
1377	return sysfs_emit(buf, "%s v%s\n",
1378			TPACPI_DESC, TPACPI_VERSION);
1379}
1380static DRIVER_ATTR_RO(version);
1381
1382/* --------------------------------------------------------------------- */
1383
1384#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1385
1386/* wlsw_emulstate ------------------------------------------------------ */
1387static ssize_t wlsw_emulstate_show(struct device_driver *drv, char *buf)
1388{
1389	return sysfs_emit(buf, "%d\n", !!tpacpi_wlsw_emulstate);
1390}
1391
1392static ssize_t wlsw_emulstate_store(struct device_driver *drv, const char *buf,
1393				    size_t count)
1394{
1395	unsigned long t;
1396
1397	if (parse_strtoul(buf, 1, &t))
1398		return -EINVAL;
1399
1400	if (tpacpi_wlsw_emulstate != !!t) {
1401		tpacpi_wlsw_emulstate = !!t;
1402		tpacpi_rfk_update_hwblock_state(!t);	/* negative logic */
1403	}
1404
1405	return count;
1406}
1407static DRIVER_ATTR_RW(wlsw_emulstate);
1408
1409/* bluetooth_emulstate ------------------------------------------------- */
1410static ssize_t bluetooth_emulstate_show(struct device_driver *drv, char *buf)
1411{
1412	return sysfs_emit(buf, "%d\n", !!tpacpi_bluetooth_emulstate);
1413}
1414
1415static ssize_t bluetooth_emulstate_store(struct device_driver *drv,
1416					 const char *buf, size_t count)
1417{
1418	unsigned long t;
1419
1420	if (parse_strtoul(buf, 1, &t))
1421		return -EINVAL;
1422
1423	tpacpi_bluetooth_emulstate = !!t;
1424
1425	return count;
1426}
1427static DRIVER_ATTR_RW(bluetooth_emulstate);
1428
1429/* wwan_emulstate ------------------------------------------------- */
1430static ssize_t wwan_emulstate_show(struct device_driver *drv, char *buf)
1431{
1432	return sysfs_emit(buf, "%d\n", !!tpacpi_wwan_emulstate);
1433}
1434
1435static ssize_t wwan_emulstate_store(struct device_driver *drv, const char *buf,
1436				    size_t count)
1437{
1438	unsigned long t;
1439
1440	if (parse_strtoul(buf, 1, &t))
1441		return -EINVAL;
1442
1443	tpacpi_wwan_emulstate = !!t;
1444
1445	return count;
1446}
1447static DRIVER_ATTR_RW(wwan_emulstate);
1448
1449/* uwb_emulstate ------------------------------------------------- */
1450static ssize_t uwb_emulstate_show(struct device_driver *drv, char *buf)
1451{
1452	return sysfs_emit(buf, "%d\n", !!tpacpi_uwb_emulstate);
1453}
1454
1455static ssize_t uwb_emulstate_store(struct device_driver *drv, const char *buf,
1456				   size_t count)
1457{
1458	unsigned long t;
1459
1460	if (parse_strtoul(buf, 1, &t))
1461		return -EINVAL;
1462
1463	tpacpi_uwb_emulstate = !!t;
1464
1465	return count;
1466}
1467static DRIVER_ATTR_RW(uwb_emulstate);
1468#endif
1469
1470/*************************************************************************
1471 * Firmware Data
1472 */
1473
1474/*
1475 * Table of recommended minimum BIOS versions
1476 *
1477 * Reasons for listing:
1478 *    1. Stable BIOS, listed because the unknown amount of
1479 *       bugs and bad ACPI behaviour on older versions
1480 *
1481 *    2. BIOS or EC fw with known bugs that trigger on Linux
1482 *
1483 *    3. BIOS with known reduced functionality in older versions
1484 *
1485 *  We recommend the latest BIOS and EC version.
1486 *  We only support the latest BIOS and EC fw version as a rule.
1487 *
1488 *  Sources: IBM ThinkPad Public Web Documents (update changelogs),
1489 *  Information from users in ThinkWiki
1490 *
1491 *  WARNING: we use this table also to detect that the machine is
1492 *  a ThinkPad in some cases, so don't remove entries lightly.
1493 */
1494
1495#define TPV_Q(__v, __id1, __id2, __bv1, __bv2)		\
1496	{ .vendor	= (__v),			\
1497	  .bios		= TPID(__id1, __id2),		\
1498	  .ec		= TPACPI_MATCH_ANY,		\
1499	  .quirks	= TPACPI_MATCH_ANY_VERSION << 16 \
1500			  | TPVER(__bv1, __bv2) }
1501
1502#define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2,	\
1503		__eid, __ev1, __ev2)			\
1504	{ .vendor	= (__v),			\
1505	  .bios		= TPID(__bid1, __bid2),		\
1506	  .ec		= __eid,			\
1507	  .quirks	= TPVER(__ev1, __ev2) << 16	\
1508			  | TPVER(__bv1, __bv2) }
1509
1510#define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1511	TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1512
1513/* Outdated IBM BIOSes often lack the EC id string */
1514#define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1515	TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, 	\
1516		__bv1, __bv2, TPID(__id1, __id2),	\
1517		__ev1, __ev2),				\
1518	TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, 	\
1519		__bv1, __bv2, TPACPI_MATCH_UNKNOWN,	\
1520		__ev1, __ev2)
1521
1522/* Outdated IBM BIOSes often lack the EC id string */
1523#define TPV_QI2(__bid1, __bid2, __bv1, __bv2,		\
1524		__eid1, __eid2, __ev1, __ev2) 		\
1525	TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, 	\
1526		__bv1, __bv2, TPID(__eid1, __eid2),	\
1527		__ev1, __ev2),				\
1528	TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, 	\
1529		__bv1, __bv2, TPACPI_MATCH_UNKNOWN,	\
1530		__ev1, __ev2)
1531
1532#define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1533	TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1534
1535#define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1536	TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, 	\
1537		__bv1, __bv2, TPID(__id1, __id2),	\
1538		__ev1, __ev2)
1539
1540#define TPV_QL2(__bid1, __bid2, __bv1, __bv2,		\
1541		__eid1, __eid2, __ev1, __ev2) 		\
1542	TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, 	\
1543		__bv1, __bv2, TPID(__eid1, __eid2),	\
1544		__ev1, __ev2)
1545
1546static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1547	/*  Numeric models ------------------ */
1548	/*      FW MODEL   BIOS VERS	      */
1549	TPV_QI0('I', 'M',  '6', '5'),		 /* 570 */
1550	TPV_QI0('I', 'U',  '2', '6'),		 /* 570E */
1551	TPV_QI0('I', 'B',  '5', '4'),		 /* 600 */
1552	TPV_QI0('I', 'H',  '4', '7'),		 /* 600E */
1553	TPV_QI0('I', 'N',  '3', '6'),		 /* 600E */
1554	TPV_QI0('I', 'T',  '5', '5'),		 /* 600X */
1555	TPV_QI0('I', 'D',  '4', '8'),		 /* 770, 770E, 770ED */
1556	TPV_QI0('I', 'I',  '4', '2'),		 /* 770X */
1557	TPV_QI0('I', 'O',  '2', '3'),		 /* 770Z */
1558
1559	/* A-series ------------------------- */
1560	/*      FW MODEL   BIOS VERS  EC VERS */
1561	TPV_QI0('I', 'W',  '5', '9'),		 /* A20m */
1562	TPV_QI0('I', 'V',  '6', '9'),		 /* A20p */
1563	TPV_QI0('1', '0',  '2', '6'),		 /* A21e, A22e */
1564	TPV_QI0('K', 'U',  '3', '6'),		 /* A21e */
1565	TPV_QI0('K', 'X',  '3', '6'),		 /* A21m, A22m */
1566	TPV_QI0('K', 'Y',  '3', '8'),		 /* A21p, A22p */
1567	TPV_QI0('1', 'B',  '1', '7'),		 /* A22e */
1568	TPV_QI0('1', '3',  '2', '0'),		 /* A22m */
1569	TPV_QI0('1', 'E',  '7', '3'),		 /* A30/p (0) */
1570	TPV_QI1('1', 'G',  '4', '1',  '1', '7'), /* A31/p (0) */
1571	TPV_QI1('1', 'N',  '1', '6',  '0', '7'), /* A31/p (0) */
1572
1573	/* G-series ------------------------- */
1574	/*      FW MODEL   BIOS VERS	      */
1575	TPV_QI0('1', 'T',  'A', '6'),		 /* G40 */
1576	TPV_QI0('1', 'X',  '5', '7'),		 /* G41 */
1577
1578	/* R-series, T-series --------------- */
1579	/*      FW MODEL   BIOS VERS  EC VERS */
1580	TPV_QI0('1', 'C',  'F', '0'),		 /* R30 */
1581	TPV_QI0('1', 'F',  'F', '1'),		 /* R31 */
1582	TPV_QI0('1', 'M',  '9', '7'),		 /* R32 */
1583	TPV_QI0('1', 'O',  '6', '1'),		 /* R40 */
1584	TPV_QI0('1', 'P',  '6', '5'),		 /* R40 */
1585	TPV_QI0('1', 'S',  '7', '0'),		 /* R40e */
1586	TPV_QI1('1', 'R',  'D', 'R',  '7', '1'), /* R50/p, R51,
1587						    T40/p, T41/p, T42/p (1) */
1588	TPV_QI1('1', 'V',  '7', '1',  '2', '8'), /* R50e, R51 (1) */
1589	TPV_QI1('7', '8',  '7', '1',  '0', '6'), /* R51e (1) */
1590	TPV_QI1('7', '6',  '6', '9',  '1', '6'), /* R52 (1) */
1591	TPV_QI1('7', '0',  '6', '9',  '2', '8'), /* R52, T43 (1) */
1592
1593	TPV_QI0('I', 'Y',  '6', '1'),		 /* T20 */
1594	TPV_QI0('K', 'Z',  '3', '4'),		 /* T21 */
1595	TPV_QI0('1', '6',  '3', '2'),		 /* T22 */
1596	TPV_QI1('1', 'A',  '6', '4',  '2', '3'), /* T23 (0) */
1597	TPV_QI1('1', 'I',  '7', '1',  '2', '0'), /* T30 (0) */
1598	TPV_QI1('1', 'Y',  '6', '5',  '2', '9'), /* T43/p (1) */
1599
1600	TPV_QL1('7', '9',  'E', '3',  '5', '0'), /* T60/p */
1601	TPV_QL1('7', 'C',  'D', '2',  '2', '2'), /* R60, R60i */
1602	TPV_QL1('7', 'E',  'D', '0',  '1', '5'), /* R60e, R60i */
1603
1604	/*      BIOS FW    BIOS VERS  EC FW     EC VERS */
1605	TPV_QI2('1', 'W',  '9', '0',  '1', 'V', '2', '8'), /* R50e (1) */
1606	TPV_QL2('7', 'I',  '3', '4',  '7', '9', '5', '0'), /* T60/p wide */
1607
1608	/* X-series ------------------------- */
1609	/*      FW MODEL   BIOS VERS  EC VERS */
1610	TPV_QI0('I', 'Z',  '9', 'D'),		 /* X20, X21 */
1611	TPV_QI0('1', 'D',  '7', '0'),		 /* X22, X23, X24 */
1612	TPV_QI1('1', 'K',  '4', '8',  '1', '8'), /* X30 (0) */
1613	TPV_QI1('1', 'Q',  '9', '7',  '2', '3'), /* X31, X32 (0) */
1614	TPV_QI1('1', 'U',  'D', '3',  'B', '2'), /* X40 (0) */
1615	TPV_QI1('7', '4',  '6', '4',  '2', '7'), /* X41 (0) */
1616	TPV_QI1('7', '5',  '6', '0',  '2', '0'), /* X41t (0) */
1617
1618	TPV_QL1('7', 'B',  'D', '7',  '4', '0'), /* X60/s */
1619	TPV_QL1('7', 'J',  '3', '0',  '1', '3'), /* X60t */
1620
1621	/* (0) - older versions lack DMI EC fw string and functionality */
1622	/* (1) - older versions known to lack functionality */
1623};
1624
1625#undef TPV_QL1
1626#undef TPV_QL0
1627#undef TPV_QI2
1628#undef TPV_QI1
1629#undef TPV_QI0
1630#undef TPV_Q_X
1631#undef TPV_Q
1632
1633static void __init tpacpi_check_outdated_fw(void)
1634{
1635	unsigned long fwvers;
1636	u16 ec_version, bios_version;
1637
1638	fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1639				ARRAY_SIZE(tpacpi_bios_version_qtable));
1640
1641	if (!fwvers)
1642		return;
1643
1644	bios_version = fwvers & 0xffffU;
1645	ec_version = (fwvers >> 16) & 0xffffU;
1646
1647	/* note that unknown versions are set to 0x0000 and we use that */
1648	if ((bios_version > thinkpad_id.bios_release) ||
1649	    (ec_version > thinkpad_id.ec_release &&
1650				ec_version != TPACPI_MATCH_ANY_VERSION)) {
1651		/*
1652		 * The changelogs would let us track down the exact
1653		 * reason, but it is just too much of a pain to track
1654		 * it.  We only list BIOSes that are either really
1655		 * broken, or really stable to begin with, so it is
1656		 * best if the user upgrades the firmware anyway.
1657		 */
1658		pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1659		pr_warn("WARNING: This firmware may be missing critical bug fixes and/or important features\n");
1660	}
1661}
1662
1663static bool __init tpacpi_is_fw_known(void)
1664{
1665	return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1666			ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1667}
1668
1669/****************************************************************************
1670 ****************************************************************************
1671 *
1672 * Subdrivers
1673 *
1674 ****************************************************************************
1675 ****************************************************************************/
1676
1677/*************************************************************************
1678 * thinkpad-acpi metadata subdriver
1679 */
1680
1681static int thinkpad_acpi_driver_read(struct seq_file *m)
1682{
1683	seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1684	seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1685	return 0;
1686}
1687
1688static struct ibm_struct thinkpad_acpi_driver_data = {
1689	.name = "driver",
1690	.read = thinkpad_acpi_driver_read,
1691};
1692
1693/*************************************************************************
1694 * Hotkey subdriver
1695 */
1696
1697/*
1698 * ThinkPad firmware event model
1699 *
1700 * The ThinkPad firmware has two main event interfaces: normal ACPI
1701 * notifications (which follow the ACPI standard), and a private event
1702 * interface.
1703 *
1704 * The private event interface also issues events for the hotkeys.  As
1705 * the driver gained features, the event handling code ended up being
1706 * built around the hotkey subdriver.  This will need to be refactored
1707 * to a more formal event API eventually.
1708 *
1709 * Some "hotkeys" are actually supposed to be used as event reports,
1710 * such as "brightness has changed", "volume has changed", depending on
1711 * the ThinkPad model and how the firmware is operating.
1712 *
1713 * Unlike other classes, hotkey-class events have mask/unmask control on
1714 * non-ancient firmware.  However, how it behaves changes a lot with the
1715 * firmware model and version.
1716 */
1717
1718enum {	/* hot key scan codes (derived from ACPI DSDT) */
1719	TP_ACPI_HOTKEYSCAN_FNF1		= 0,
1720	TP_ACPI_HOTKEYSCAN_FNF2,
1721	TP_ACPI_HOTKEYSCAN_FNF3,
1722	TP_ACPI_HOTKEYSCAN_FNF4,
1723	TP_ACPI_HOTKEYSCAN_FNF5,
1724	TP_ACPI_HOTKEYSCAN_FNF6,
1725	TP_ACPI_HOTKEYSCAN_FNF7,
1726	TP_ACPI_HOTKEYSCAN_FNF8,
1727	TP_ACPI_HOTKEYSCAN_FNF9,
1728	TP_ACPI_HOTKEYSCAN_FNF10,
1729	TP_ACPI_HOTKEYSCAN_FNF11,
1730	TP_ACPI_HOTKEYSCAN_FNF12,
1731	TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1732	TP_ACPI_HOTKEYSCAN_FNINSERT,
1733	TP_ACPI_HOTKEYSCAN_FNDELETE,
1734	TP_ACPI_HOTKEYSCAN_FNHOME,
1735	TP_ACPI_HOTKEYSCAN_FNEND,
1736	TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1737	TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1738	TP_ACPI_HOTKEYSCAN_FNSPACE,
1739	TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1740	TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1741	TP_ACPI_HOTKEYSCAN_MUTE,
1742	TP_ACPI_HOTKEYSCAN_THINKPAD,
1743	TP_ACPI_HOTKEYSCAN_UNK1,
1744	TP_ACPI_HOTKEYSCAN_UNK2,
1745	TP_ACPI_HOTKEYSCAN_UNK3,
1746	TP_ACPI_HOTKEYSCAN_UNK4,
1747	TP_ACPI_HOTKEYSCAN_UNK5,
1748	TP_ACPI_HOTKEYSCAN_UNK6,
1749	TP_ACPI_HOTKEYSCAN_UNK7,
1750	TP_ACPI_HOTKEYSCAN_UNK8,
1751
1752	/* Adaptive keyboard keycodes */
1753	TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1754	TP_ACPI_HOTKEYSCAN_MUTE2        = TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1755	TP_ACPI_HOTKEYSCAN_BRIGHTNESS_ZERO,
1756	TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL,
1757	TP_ACPI_HOTKEYSCAN_CLOUD,
1758	TP_ACPI_HOTKEYSCAN_UNK9,
1759	TP_ACPI_HOTKEYSCAN_VOICE,
1760	TP_ACPI_HOTKEYSCAN_UNK10,
1761	TP_ACPI_HOTKEYSCAN_GESTURES,
1762	TP_ACPI_HOTKEYSCAN_UNK11,
1763	TP_ACPI_HOTKEYSCAN_UNK12,
1764	TP_ACPI_HOTKEYSCAN_UNK13,
1765	TP_ACPI_HOTKEYSCAN_CONFIG,
1766	TP_ACPI_HOTKEYSCAN_NEW_TAB,
1767	TP_ACPI_HOTKEYSCAN_RELOAD,
1768	TP_ACPI_HOTKEYSCAN_BACK,
1769	TP_ACPI_HOTKEYSCAN_MIC_DOWN,
1770	TP_ACPI_HOTKEYSCAN_MIC_UP,
1771	TP_ACPI_HOTKEYSCAN_MIC_CANCELLATION,
1772	TP_ACPI_HOTKEYSCAN_CAMERA_MODE,
1773	TP_ACPI_HOTKEYSCAN_ROTATE_DISPLAY,
1774
1775	/* Lenovo extended keymap, starting at 0x1300 */
1776	TP_ACPI_HOTKEYSCAN_EXTENDED_START,
1777	/* first new observed key (star, favorites) is 0x1311 */
1778	TP_ACPI_HOTKEYSCAN_STAR = 69,
1779	TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL2,
1780	TP_ACPI_HOTKEYSCAN_CALCULATOR,
1781	TP_ACPI_HOTKEYSCAN_BLUETOOTH,
1782	TP_ACPI_HOTKEYSCAN_KEYBOARD,
1783	TP_ACPI_HOTKEYSCAN_FN_RIGHT_SHIFT, /* Used by "Lenovo Quick Clean" */
1784	TP_ACPI_HOTKEYSCAN_NOTIFICATION_CENTER,
1785	TP_ACPI_HOTKEYSCAN_PICKUP_PHONE,
1786	TP_ACPI_HOTKEYSCAN_HANGUP_PHONE,
1787
1788	/* Hotkey keymap size */
1789	TPACPI_HOTKEY_MAP_LEN
1790};
1791
1792enum {	/* Keys/events available through NVRAM polling */
1793	TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1794	TPACPI_HKEY_NVRAM_GOOD_MASK  = 0x00fb8000U,
1795};
1796
1797enum {	/* Positions of some of the keys in hotkey masks */
1798	TP_ACPI_HKEY_DISPSWTCH_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1799	TP_ACPI_HKEY_DISPXPAND_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1800	TP_ACPI_HKEY_HIBERNATE_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1801	TP_ACPI_HKEY_BRGHTUP_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1802	TP_ACPI_HKEY_BRGHTDWN_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1803	TP_ACPI_HKEY_KBD_LIGHT_MASK	= 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1804	TP_ACPI_HKEY_ZOOM_MASK		= 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1805	TP_ACPI_HKEY_VOLUP_MASK		= 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1806	TP_ACPI_HKEY_VOLDWN_MASK	= 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1807	TP_ACPI_HKEY_MUTE_MASK		= 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1808	TP_ACPI_HKEY_THINKPAD_MASK	= 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1809};
1810
1811enum {	/* NVRAM to ACPI HKEY group map */
1812	TP_NVRAM_HKEY_GROUP_HK2		= TP_ACPI_HKEY_THINKPAD_MASK |
1813					  TP_ACPI_HKEY_ZOOM_MASK |
1814					  TP_ACPI_HKEY_DISPSWTCH_MASK |
1815					  TP_ACPI_HKEY_HIBERNATE_MASK,
1816	TP_NVRAM_HKEY_GROUP_BRIGHTNESS	= TP_ACPI_HKEY_BRGHTUP_MASK |
1817					  TP_ACPI_HKEY_BRGHTDWN_MASK,
1818	TP_NVRAM_HKEY_GROUP_VOLUME	= TP_ACPI_HKEY_VOLUP_MASK |
1819					  TP_ACPI_HKEY_VOLDWN_MASK |
1820					  TP_ACPI_HKEY_MUTE_MASK,
1821};
1822
1823#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1824struct tp_nvram_state {
1825       u16 thinkpad_toggle:1;
1826       u16 zoom_toggle:1;
1827       u16 display_toggle:1;
1828       u16 thinklight_toggle:1;
1829       u16 hibernate_toggle:1;
1830       u16 displayexp_toggle:1;
1831       u16 display_state:1;
1832       u16 brightness_toggle:1;
1833       u16 volume_toggle:1;
1834       u16 mute:1;
1835
1836       u8 brightness_level;
1837       u8 volume_level;
1838};
1839
1840/* kthread for the hotkey poller */
1841static struct task_struct *tpacpi_hotkey_task;
1842
1843/*
1844 * Acquire mutex to write poller control variables as an
1845 * atomic block.
1846 *
1847 * Increment hotkey_config_change when changing them if you
1848 * want the kthread to forget old state.
1849 *
1850 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1851 */
1852static struct mutex hotkey_thread_data_mutex;
1853static unsigned int hotkey_config_change;
1854
1855/*
1856 * hotkey poller control variables
1857 *
1858 * Must be atomic or readers will also need to acquire mutex
1859 *
1860 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1861 * should be used only when the changes need to be taken as
1862 * a block, OR when one needs to force the kthread to forget
1863 * old state.
1864 */
1865static u32 hotkey_source_mask;		/* bit mask 0=ACPI,1=NVRAM */
1866static unsigned int hotkey_poll_freq = 10; /* Hz */
1867
1868#define HOTKEY_CONFIG_CRITICAL_START \
1869	do { \
1870		mutex_lock(&hotkey_thread_data_mutex); \
1871		hotkey_config_change++; \
1872	} while (0);
1873#define HOTKEY_CONFIG_CRITICAL_END \
1874	mutex_unlock(&hotkey_thread_data_mutex);
1875
1876#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
1877
1878#define hotkey_source_mask 0U
1879#define HOTKEY_CONFIG_CRITICAL_START
1880#define HOTKEY_CONFIG_CRITICAL_END
1881
1882#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
1883
1884static struct mutex hotkey_mutex;
1885
1886static enum {	/* Reasons for waking up */
1887	TP_ACPI_WAKEUP_NONE = 0,	/* None or unknown */
1888	TP_ACPI_WAKEUP_BAYEJ,		/* Bay ejection request */
1889	TP_ACPI_WAKEUP_UNDOCK,		/* Undock request */
1890} hotkey_wakeup_reason;
1891
1892static int hotkey_autosleep_ack;
1893
1894static u32 hotkey_orig_mask;		/* events the BIOS had enabled */
1895static u32 hotkey_all_mask;		/* all events supported in fw */
1896static u32 hotkey_adaptive_all_mask;	/* all adaptive events supported in fw */
1897static u32 hotkey_reserved_mask;	/* events better left disabled */
1898static u32 hotkey_driver_mask;		/* events needed by the driver */
1899static u32 hotkey_user_mask;		/* events visible to userspace */
1900static u32 hotkey_acpi_mask;		/* events enabled in firmware */
1901
1902static u16 *hotkey_keycode_map;
1903
1904static void tpacpi_driver_event(const unsigned int hkey_event);
1905static void hotkey_driver_event(const unsigned int scancode);
1906static void hotkey_poll_setup(const bool may_warn);
1907
1908/* HKEY.MHKG() return bits */
1909#define TP_HOTKEY_TABLET_MASK (1 << 3)
1910enum {
1911	TP_ACPI_MULTI_MODE_INVALID	= 0,
1912	TP_ACPI_MULTI_MODE_UNKNOWN	= 1 << 0,
1913	TP_ACPI_MULTI_MODE_LAPTOP	= 1 << 1,
1914	TP_ACPI_MULTI_MODE_TABLET	= 1 << 2,
1915	TP_ACPI_MULTI_MODE_FLAT		= 1 << 3,
1916	TP_ACPI_MULTI_MODE_STAND	= 1 << 4,
1917	TP_ACPI_MULTI_MODE_TENT		= 1 << 5,
1918	TP_ACPI_MULTI_MODE_STAND_TENT	= 1 << 6,
1919};
1920
1921enum {
1922	/* The following modes are considered tablet mode for the purpose of
1923	 * reporting the status to userspace. i.e. in all these modes it makes
1924	 * sense to disable the laptop input devices such as touchpad and
1925	 * keyboard.
1926	 */
1927	TP_ACPI_MULTI_MODE_TABLET_LIKE	= TP_ACPI_MULTI_MODE_TABLET |
1928					  TP_ACPI_MULTI_MODE_STAND |
1929					  TP_ACPI_MULTI_MODE_TENT |
1930					  TP_ACPI_MULTI_MODE_STAND_TENT,
1931};
1932
1933static int hotkey_get_wlsw(void)
1934{
1935	int status;
1936
1937	if (!tp_features.hotkey_wlsw)
1938		return -ENODEV;
1939
1940#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1941	if (dbg_wlswemul)
1942		return (tpacpi_wlsw_emulstate) ?
1943				TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
1944#endif
1945
1946	if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
1947		return -EIO;
1948
1949	return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
1950}
1951
1952static int hotkey_gmms_get_tablet_mode(int s, int *has_tablet_mode)
1953{
1954	int type = (s >> 16) & 0xffff;
1955	int value = s & 0xffff;
1956	int mode = TP_ACPI_MULTI_MODE_INVALID;
1957	int valid_modes = 0;
1958
1959	if (has_tablet_mode)
1960		*has_tablet_mode = 0;
1961
1962	switch (type) {
1963	case 1:
1964		valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1965			      TP_ACPI_MULTI_MODE_TABLET |
1966			      TP_ACPI_MULTI_MODE_STAND_TENT;
1967		break;
1968	case 2:
1969		valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1970			      TP_ACPI_MULTI_MODE_FLAT |
1971			      TP_ACPI_MULTI_MODE_TABLET |
1972			      TP_ACPI_MULTI_MODE_STAND |
1973			      TP_ACPI_MULTI_MODE_TENT;
1974		break;
1975	case 3:
1976		valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1977			      TP_ACPI_MULTI_MODE_FLAT;
1978		break;
1979	case 4:
1980	case 5:
1981		/* In mode 4, FLAT is not specified as a valid mode. However,
1982		 * it can be seen at least on the X1 Yoga 2nd Generation.
1983		 */
1984		valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1985			      TP_ACPI_MULTI_MODE_FLAT |
1986			      TP_ACPI_MULTI_MODE_TABLET |
1987			      TP_ACPI_MULTI_MODE_STAND |
1988			      TP_ACPI_MULTI_MODE_TENT;
1989		break;
1990	default:
1991		pr_err("Unknown multi mode status type %d with value 0x%04X, please report this to %s\n",
1992		       type, value, TPACPI_MAIL);
1993		return 0;
1994	}
1995
1996	if (has_tablet_mode && (valid_modes & TP_ACPI_MULTI_MODE_TABLET_LIKE))
1997		*has_tablet_mode = 1;
1998
1999	switch (value) {
2000	case 1:
2001		mode = TP_ACPI_MULTI_MODE_LAPTOP;
2002		break;
2003	case 2:
2004		mode = TP_ACPI_MULTI_MODE_FLAT;
2005		break;
2006	case 3:
2007		mode = TP_ACPI_MULTI_MODE_TABLET;
2008		break;
2009	case 4:
2010		if (type == 1)
2011			mode = TP_ACPI_MULTI_MODE_STAND_TENT;
2012		else
2013			mode = TP_ACPI_MULTI_MODE_STAND;
2014		break;
2015	case 5:
2016		mode = TP_ACPI_MULTI_MODE_TENT;
2017		break;
2018	default:
2019		if (type == 5 && value == 0xffff) {
2020			pr_warn("Multi mode status is undetected, assuming laptop\n");
2021			return 0;
2022		}
2023	}
2024
2025	if (!(mode & valid_modes)) {
2026		pr_err("Unknown/reserved multi mode value 0x%04X for type %d, please report this to %s\n",
2027		       value, type, TPACPI_MAIL);
2028		return 0;
2029	}
2030
2031	return !!(mode & TP_ACPI_MULTI_MODE_TABLET_LIKE);
2032}
2033
2034static int hotkey_get_tablet_mode(int *status)
2035{
2036	int s;
2037
2038	switch (tp_features.hotkey_tablet) {
2039	case TP_HOTKEY_TABLET_USES_MHKG:
2040		if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2041			return -EIO;
2042
2043		*status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2044		break;
2045	case TP_HOTKEY_TABLET_USES_GMMS:
2046		if (!acpi_evalf(hkey_handle, &s, "GMMS", "dd", 0))
2047			return -EIO;
2048
2049		*status = hotkey_gmms_get_tablet_mode(s, NULL);
2050		break;
2051	default:
2052		break;
2053	}
2054
2055	return 0;
2056}
2057
2058/*
2059 * Reads current event mask from firmware, and updates
2060 * hotkey_acpi_mask accordingly.  Also resets any bits
2061 * from hotkey_user_mask that are unavailable to be
2062 * delivered (shadow requirement of the userspace ABI).
2063 */
2064static int hotkey_mask_get(void)
2065{
2066	lockdep_assert_held(&hotkey_mutex);
2067
2068	if (tp_features.hotkey_mask) {
2069		u32 m = 0;
2070
2071		if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2072			return -EIO;
2073
2074		hotkey_acpi_mask = m;
2075	} else {
2076		/* no mask support doesn't mean no event support... */
2077		hotkey_acpi_mask = hotkey_all_mask;
2078	}
2079
2080	/* sync userspace-visible mask */
2081	hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2082
2083	return 0;
2084}
2085
2086static void hotkey_mask_warn_incomplete_mask(void)
2087{
2088	/* log only what the user can fix... */
2089	const u32 wantedmask = hotkey_driver_mask &
2090		~(hotkey_acpi_mask | hotkey_source_mask) &
2091		(hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2092
2093	if (wantedmask)
2094		pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2095}
2096
2097/*
2098 * Set the firmware mask when supported
2099 *
2100 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2101 *
2102 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2103 */
2104static int hotkey_mask_set(u32 mask)
2105{
2106	int i;
2107	int rc = 0;
2108
2109	const u32 fwmask = mask & ~hotkey_source_mask;
2110
2111	lockdep_assert_held(&hotkey_mutex);
2112
2113	if (tp_features.hotkey_mask) {
2114		for (i = 0; i < 32; i++) {
2115			if (!acpi_evalf(hkey_handle,
2116					NULL, "MHKM", "vdd", i + 1,
2117					!!(mask & (1 << i)))) {
2118				rc = -EIO;
2119				break;
2120			}
2121		}
2122	}
2123
2124	/*
2125	 * We *must* make an inconditional call to hotkey_mask_get to
2126	 * refresh hotkey_acpi_mask and update hotkey_user_mask
2127	 *
2128	 * Take the opportunity to also log when we cannot _enable_
2129	 * a given event.
2130	 */
2131	if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2132		pr_notice("asked for hotkey mask 0x%08x, but firmware forced it to 0x%08x\n",
2133			  fwmask, hotkey_acpi_mask);
2134	}
2135
2136	if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2137		hotkey_mask_warn_incomplete_mask();
2138
2139	return rc;
2140}
2141
2142/*
2143 * Sets hotkey_user_mask and tries to set the firmware mask
2144 */
2145static int hotkey_user_mask_set(const u32 mask)
2146{
2147	int rc;
2148
2149	lockdep_assert_held(&hotkey_mutex);
2150
2151	/* Give people a chance to notice they are doing something that
2152	 * is bound to go boom on their users sooner or later */
2153	if (!tp_warned.hotkey_mask_ff &&
2154	    (mask == 0xffff || mask == 0xffffff ||
2155	     mask == 0xffffffff)) {
2156		tp_warned.hotkey_mask_ff = 1;
2157		pr_notice("setting the hotkey mask to 0x%08x is likely not the best way to go about it\n",
2158			  mask);
2159		pr_notice("please consider using the driver defaults, and refer to up-to-date thinkpad-acpi documentation\n");
2160	}
2161
2162	/* Try to enable what the user asked for, plus whatever we need.
2163	 * this syncs everything but won't enable bits in hotkey_user_mask */
2164	rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2165
2166	/* Enable the available bits in hotkey_user_mask */
2167	hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2168
2169	return rc;
2170}
2171
2172/*
2173 * Sets the driver hotkey mask.
2174 *
2175 * Can be called even if the hotkey subdriver is inactive
2176 */
2177static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2178{
2179	int rc;
2180
2181	/* Do the right thing if hotkey_init has not been called yet */
2182	if (!tp_features.hotkey) {
2183		hotkey_driver_mask = mask;
2184		return 0;
2185	}
2186
2187	mutex_lock(&hotkey_mutex);
2188
2189	HOTKEY_CONFIG_CRITICAL_START
2190	hotkey_driver_mask = mask;
2191#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2192	hotkey_source_mask |= (mask & ~hotkey_all_mask);
2193#endif
2194	HOTKEY_CONFIG_CRITICAL_END
2195
2196	rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2197							~hotkey_source_mask);
2198	hotkey_poll_setup(true);
2199
2200	mutex_unlock(&hotkey_mutex);
2201
2202	return rc;
2203}
2204
2205static int hotkey_status_get(int *status)
2206{
2207	if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2208		return -EIO;
2209
2210	return 0;
2211}
2212
2213static int hotkey_status_set(bool enable)
2214{
2215	if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2216		return -EIO;
2217
2218	return 0;
2219}
2220
2221static void tpacpi_input_send_tabletsw(void)
2222{
2223	int state;
2224
2225	if (tp_features.hotkey_tablet &&
2226	    !hotkey_get_tablet_mode(&state)) {
2227		mutex_lock(&tpacpi_inputdev_send_mutex);
2228
2229		input_report_switch(tpacpi_inputdev,
2230				    SW_TABLET_MODE, !!state);
2231		input_sync(tpacpi_inputdev);
2232
2233		mutex_unlock(&tpacpi_inputdev_send_mutex);
2234	}
2235}
2236
2237/* Do NOT call without validating scancode first */
2238static void tpacpi_input_send_key(const unsigned int scancode)
2239{
2240	const unsigned int keycode = hotkey_keycode_map[scancode];
2241
2242	if (keycode != KEY_RESERVED) {
2243		mutex_lock(&tpacpi_inputdev_send_mutex);
2244
2245		input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2246		input_report_key(tpacpi_inputdev, keycode, 1);
2247		input_sync(tpacpi_inputdev);
2248
2249		input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2250		input_report_key(tpacpi_inputdev, keycode, 0);
2251		input_sync(tpacpi_inputdev);
2252
2253		mutex_unlock(&tpacpi_inputdev_send_mutex);
2254	}
2255}
2256
2257/* Do NOT call without validating scancode first */
2258static void tpacpi_input_send_key_masked(const unsigned int scancode)
2259{
2260	hotkey_driver_event(scancode);
2261	if (hotkey_user_mask & (1 << scancode))
2262		tpacpi_input_send_key(scancode);
2263}
2264
2265#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2266static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2267
2268/* Do NOT call without validating scancode first */
2269static void tpacpi_hotkey_send_key(unsigned int scancode)
2270{
2271	tpacpi_input_send_key_masked(scancode);
2272}
2273
2274static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2275{
2276	u8 d;
2277
2278	if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2279		d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2280		n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2281		n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2282		n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2283		n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2284	}
2285	if (m & TP_ACPI_HKEY_KBD_LIGHT_MASK) {
2286		d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2287		n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2288	}
2289	if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2290		d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2291		n->displayexp_toggle =
2292				!!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2293	}
2294	if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2295		d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2296		n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2297				>> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2298		n->brightness_toggle =
2299				!!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2300	}
2301	if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2302		d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2303		n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2304				>> TP_NVRAM_POS_LEVEL_VOLUME;
2305		n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2306		n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2307	}
2308}
2309
2310#define TPACPI_COMPARE_KEY(__scancode, __member) \
2311do { \
2312	if ((event_mask & (1 << __scancode)) && \
2313	    oldn->__member != newn->__member) \
2314		tpacpi_hotkey_send_key(__scancode); \
2315} while (0)
2316
2317#define TPACPI_MAY_SEND_KEY(__scancode) \
2318do { \
2319	if (event_mask & (1 << __scancode)) \
2320		tpacpi_hotkey_send_key(__scancode); \
2321} while (0)
2322
2323static void issue_volchange(const unsigned int oldvol,
2324			    const unsigned int newvol,
2325			    const u32 event_mask)
2326{
2327	unsigned int i = oldvol;
2328
2329	while (i > newvol) {
2330		TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2331		i--;
2332	}
2333	while (i < newvol) {
2334		TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2335		i++;
2336	}
2337}
2338
2339static void issue_brightnesschange(const unsigned int oldbrt,
2340				   const unsigned int newbrt,
2341				   const u32 event_mask)
2342{
2343	unsigned int i = oldbrt;
2344
2345	while (i > newbrt) {
2346		TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2347		i--;
2348	}
2349	while (i < newbrt) {
2350		TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2351		i++;
2352	}
2353}
2354
2355static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2356					   struct tp_nvram_state *newn,
2357					   const u32 event_mask)
2358{
2359
2360	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2361	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2362	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2363	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2364
2365	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2366
2367	TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2368
2369	/*
2370	 * Handle volume
2371	 *
2372	 * This code is supposed to duplicate the IBM firmware behaviour:
2373	 * - Pressing MUTE issues mute hotkey message, even when already mute
2374	 * - Pressing Volume up/down issues volume up/down hotkey messages,
2375	 *   even when already at maximum or minimum volume
2376	 * - The act of unmuting issues volume up/down notification,
2377	 *   depending which key was used to unmute
2378	 *
2379	 * We are constrained to what the NVRAM can tell us, which is not much
2380	 * and certainly not enough if more than one volume hotkey was pressed
2381	 * since the last poll cycle.
2382	 *
2383	 * Just to make our life interesting, some newer Lenovo ThinkPads have
2384	 * bugs in the BIOS and may fail to update volume_toggle properly.
2385	 */
2386	if (newn->mute) {
2387		/* muted */
2388		if (!oldn->mute ||
2389		    oldn->volume_toggle != newn->volume_toggle ||
2390		    oldn->volume_level != newn->volume_level) {
2391			/* recently muted, or repeated mute keypress, or
2392			 * multiple presses ending in mute */
2393			issue_volchange(oldn->volume_level, newn->volume_level,
2394				event_mask);
2395			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2396		}
2397	} else {
2398		/* unmute */
2399		if (oldn->mute) {
2400			/* recently unmuted, issue 'unmute' keypress */
2401			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2402		}
2403		if (oldn->volume_level != newn->volume_level) {
2404			issue_volchange(oldn->volume_level, newn->volume_level,
2405				event_mask);
2406		} else if (oldn->volume_toggle != newn->volume_toggle) {
2407			/* repeated vol up/down keypress at end of scale ? */
2408			if (newn->volume_level == 0)
2409				TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2410			else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2411				TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2412		}
2413	}
2414
2415	/* handle brightness */
2416	if (oldn->brightness_level != newn->brightness_level) {
2417		issue_brightnesschange(oldn->brightness_level,
2418				       newn->brightness_level, event_mask);
2419	} else if (oldn->brightness_toggle != newn->brightness_toggle) {
2420		/* repeated key presses that didn't change state */
2421		if (newn->brightness_level == 0)
2422			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2423		else if (newn->brightness_level >= bright_maxlvl
2424				&& !tp_features.bright_unkfw)
2425			TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2426	}
2427
2428#undef TPACPI_COMPARE_KEY
2429#undef TPACPI_MAY_SEND_KEY
2430}
2431
2432/*
2433 * Polling driver
2434 *
2435 * We track all events in hotkey_source_mask all the time, since
2436 * most of them are edge-based.  We only issue those requested by
2437 * hotkey_user_mask or hotkey_driver_mask, though.
2438 */
2439static int hotkey_kthread(void *data)
2440{
2441	struct tp_nvram_state s[2] = { 0 };
2442	u32 poll_mask, event_mask;
2443	unsigned int si, so;
2444	unsigned long t;
2445	unsigned int change_detector;
2446	unsigned int poll_freq;
2447	bool was_frozen;
2448
2449	if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2450		goto exit;
2451
2452	set_freezable();
2453
2454	so = 0;
2455	si = 1;
2456	t = 0;
2457
2458	/* Initial state for compares */
2459	mutex_lock(&hotkey_thread_data_mutex);
2460	change_detector = hotkey_config_change;
2461	poll_mask = hotkey_source_mask;
2462	event_mask = hotkey_source_mask &
2463			(hotkey_driver_mask | hotkey_user_mask);
2464	poll_freq = hotkey_poll_freq;
2465	mutex_unlock(&hotkey_thread_data_mutex);
2466	hotkey_read_nvram(&s[so], poll_mask);
2467
2468	while (!kthread_should_stop()) {
2469		if (t == 0) {
2470			if (likely(poll_freq))
2471				t = 1000/poll_freq;
2472			else
2473				t = 100;	/* should never happen... */
2474		}
2475		t = msleep_interruptible(t);
2476		if (unlikely(kthread_freezable_should_stop(&was_frozen)))
2477			break;
2478
2479		if (t > 0 && !was_frozen)
2480			continue;
2481
2482		mutex_lock(&hotkey_thread_data_mutex);
2483		if (was_frozen || hotkey_config_change != change_detector) {
2484			/* forget old state on thaw or config change */
2485			si = so;
2486			t = 0;
2487			change_detector = hotkey_config_change;
2488		}
2489		poll_mask = hotkey_source_mask;
2490		event_mask = hotkey_source_mask &
2491				(hotkey_driver_mask | hotkey_user_mask);
2492		poll_freq = hotkey_poll_freq;
2493		mutex_unlock(&hotkey_thread_data_mutex);
2494
2495		if (likely(poll_mask)) {
2496			hotkey_read_nvram(&s[si], poll_mask);
2497			if (likely(si != so)) {
2498				hotkey_compare_and_issue_event(&s[so], &s[si],
2499								event_mask);
2500			}
2501		}
2502
2503		so = si;
2504		si ^= 1;
2505	}
2506
2507exit:
2508	return 0;
2509}
2510
2511static void hotkey_poll_stop_sync(void)
2512{
2513	lockdep_assert_held(&hotkey_mutex);
2514
2515	if (tpacpi_hotkey_task) {
2516		kthread_stop(tpacpi_hotkey_task);
2517		tpacpi_hotkey_task = NULL;
2518	}
2519}
2520
2521static void hotkey_poll_setup(const bool may_warn)
2522{
2523	const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2524	const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2525
2526	lockdep_assert_held(&hotkey_mutex);
2527
2528	if (hotkey_poll_freq > 0 &&
2529	    (poll_driver_mask ||
2530	     (poll_user_mask && tpacpi_inputdev->users > 0))) {
2531		if (!tpacpi_hotkey_task) {
2532			tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2533					NULL, TPACPI_NVRAM_KTHREAD_NAME);
2534			if (IS_ERR(tpacpi_hotkey_task)) {
2535				tpacpi_hotkey_task = NULL;
2536				pr_err("could not create kernel thread for hotkey polling\n");
2537			}
2538		}
2539	} else {
2540		hotkey_poll_stop_sync();
2541		if (may_warn && (poll_driver_mask || poll_user_mask) &&
2542		    hotkey_poll_freq == 0) {
2543			pr_notice("hot keys 0x%08x and/or events 0x%08x require polling, which is currently disabled\n",
2544				  poll_user_mask, poll_driver_mask);
2545		}
2546	}
2547}
2548
2549static void hotkey_poll_setup_safe(const bool may_warn)
2550{
2551	mutex_lock(&hotkey_mutex);
2552	hotkey_poll_setup(may_warn);
2553	mutex_unlock(&hotkey_mutex);
2554}
2555
2556static void hotkey_poll_set_freq(unsigned int freq)
2557{
2558	lockdep_assert_held(&hotkey_mutex);
2559
2560	if (!freq)
2561		hotkey_poll_stop_sync();
2562
2563	hotkey_poll_freq = freq;
2564}
2565
2566#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2567
2568static void hotkey_poll_setup(const bool __unused)
2569{
2570}
2571
2572static void hotkey_poll_setup_safe(const bool __unused)
2573{
2574}
2575
2576#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2577
2578static int hotkey_inputdev_open(struct input_dev *dev)
2579{
2580	switch (tpacpi_lifecycle) {
2581	case TPACPI_LIFE_INIT:
2582	case TPACPI_LIFE_RUNNING:
2583		hotkey_poll_setup_safe(false);
2584		return 0;
2585	case TPACPI_LIFE_EXITING:
2586		return -EBUSY;
2587	}
2588
2589	/* Should only happen if tpacpi_lifecycle is corrupt */
2590	BUG();
2591	return -EBUSY;
2592}
2593
2594static void hotkey_inputdev_close(struct input_dev *dev)
2595{
2596	/* disable hotkey polling when possible */
2597	if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2598	    !(hotkey_source_mask & hotkey_driver_mask))
2599		hotkey_poll_setup_safe(false);
2600}
2601
2602/* sysfs hotkey enable ------------------------------------------------- */
2603static ssize_t hotkey_enable_show(struct device *dev,
2604			   struct device_attribute *attr,
2605			   char *buf)
2606{
2607	int res, status;
2608
2609	printk_deprecated_attribute("hotkey_enable",
2610			"Hotkey reporting is always enabled");
2611
2612	res = hotkey_status_get(&status);
2613	if (res)
2614		return res;
2615
2616	return sysfs_emit(buf, "%d\n", status);
2617}
2618
2619static ssize_t hotkey_enable_store(struct device *dev,
2620			    struct device_attribute *attr,
2621			    const char *buf, size_t count)
2622{
2623	unsigned long t;
2624
2625	printk_deprecated_attribute("hotkey_enable",
2626			"Hotkeys can be disabled through hotkey_mask");
2627
2628	if (parse_strtoul(buf, 1, &t))
2629		return -EINVAL;
2630
2631	if (t == 0)
2632		return -EPERM;
2633
2634	return count;
2635}
2636
2637static DEVICE_ATTR_RW(hotkey_enable);
2638
2639/* sysfs hotkey mask --------------------------------------------------- */
2640static ssize_t hotkey_mask_show(struct device *dev,
2641			   struct device_attribute *attr,
2642			   char *buf)
2643{
2644	return sysfs_emit(buf, "0x%08x\n", hotkey_user_mask);
2645}
2646
2647static ssize_t hotkey_mask_store(struct device *dev,
2648			    struct device_attribute *attr,
2649			    const char *buf, size_t count)
2650{
2651	unsigned long t;
2652	int res;
2653
2654	if (parse_strtoul(buf, 0xffffffffUL, &t))
2655		return -EINVAL;
2656
2657	if (mutex_lock_killable(&hotkey_mutex))
2658		return -ERESTARTSYS;
2659
2660	res = hotkey_user_mask_set(t);
2661
2662#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2663	hotkey_poll_setup(true);
2664#endif
2665
2666	mutex_unlock(&hotkey_mutex);
2667
2668	tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2669
2670	return (res) ? res : count;
2671}
2672
2673static DEVICE_ATTR_RW(hotkey_mask);
2674
2675/* sysfs hotkey bios_enabled ------------------------------------------- */
2676static ssize_t hotkey_bios_enabled_show(struct device *dev,
2677			   struct device_attribute *attr,
2678			   char *buf)
2679{
2680	return sprintf(buf, "0\n");
2681}
2682
2683static DEVICE_ATTR_RO(hotkey_bios_enabled);
2684
2685/* sysfs hotkey bios_mask ---------------------------------------------- */
2686static ssize_t hotkey_bios_mask_show(struct device *dev,
2687			   struct device_attribute *attr,
2688			   char *buf)
2689{
2690	printk_deprecated_attribute("hotkey_bios_mask",
2691			"This attribute is useless.");
2692	return sysfs_emit(buf, "0x%08x\n", hotkey_orig_mask);
2693}
2694
2695static DEVICE_ATTR_RO(hotkey_bios_mask);
2696
2697/* sysfs hotkey all_mask ----------------------------------------------- */
2698static ssize_t hotkey_all_mask_show(struct device *dev,
2699			   struct device_attribute *attr,
2700			   char *buf)
2701{
2702	return sysfs_emit(buf, "0x%08x\n",
2703				hotkey_all_mask | hotkey_source_mask);
2704}
2705
2706static DEVICE_ATTR_RO(hotkey_all_mask);
2707
2708/* sysfs hotkey all_mask ----------------------------------------------- */
2709static ssize_t hotkey_adaptive_all_mask_show(struct device *dev,
2710			   struct device_attribute *attr,
2711			   char *buf)
2712{
2713	return sysfs_emit(buf, "0x%08x\n",
2714			hotkey_adaptive_all_mask | hotkey_source_mask);
2715}
2716
2717static DEVICE_ATTR_RO(hotkey_adaptive_all_mask);
2718
2719/* sysfs hotkey recommended_mask --------------------------------------- */
2720static ssize_t hotkey_recommended_mask_show(struct device *dev,
2721					    struct device_attribute *attr,
2722					    char *buf)
2723{
2724	return sysfs_emit(buf, "0x%08x\n",
2725			(hotkey_all_mask | hotkey_source_mask)
2726			& ~hotkey_reserved_mask);
2727}
2728
2729static DEVICE_ATTR_RO(hotkey_recommended_mask);
2730
2731#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2732
2733/* sysfs hotkey hotkey_source_mask ------------------------------------- */
2734static ssize_t hotkey_source_mask_show(struct device *dev,
2735			   struct device_attribute *attr,
2736			   char *buf)
2737{
2738	return sysfs_emit(buf, "0x%08x\n", hotkey_source_mask);
2739}
2740
2741static ssize_t hotkey_source_mask_store(struct device *dev,
2742			    struct device_attribute *attr,
2743			    const char *buf, size_t count)
2744{
2745	unsigned long t;
2746	u32 r_ev;
2747	int rc;
2748
2749	if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2750		((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2751		return -EINVAL;
2752
2753	if (mutex_lock_killable(&hotkey_mutex))
2754		return -ERESTARTSYS;
2755
2756	HOTKEY_CONFIG_CRITICAL_START
2757	hotkey_source_mask = t;
2758	HOTKEY_CONFIG_CRITICAL_END
2759
2760	rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2761			~hotkey_source_mask);
2762	hotkey_poll_setup(true);
2763
2764	/* check if events needed by the driver got disabled */
2765	r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2766		& ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2767
2768	mutex_unlock(&hotkey_mutex);
2769
2770	if (rc < 0)
2771		pr_err("hotkey_source_mask: failed to update the firmware event mask!\n");
2772
2773	if (r_ev)
2774		pr_notice("hotkey_source_mask: some important events were disabled: 0x%04x\n",
2775			  r_ev);
2776
2777	tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2778
2779	return (rc < 0) ? rc : count;
2780}
2781
2782static DEVICE_ATTR_RW(hotkey_source_mask);
2783
2784/* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2785static ssize_t hotkey_poll_freq_show(struct device *dev,
2786			   struct device_attribute *attr,
2787			   char *buf)
2788{
2789	return sysfs_emit(buf, "%d\n", hotkey_poll_freq);
2790}
2791
2792static ssize_t hotkey_poll_freq_store(struct device *dev,
2793			    struct device_attribute *attr,
2794			    const char *buf, size_t count)
2795{
2796	unsigned long t;
2797
2798	if (parse_strtoul(buf, 25, &t))
2799		return -EINVAL;
2800
2801	if (mutex_lock_killable(&hotkey_mutex))
2802		return -ERESTARTSYS;
2803
2804	hotkey_poll_set_freq(t);
2805	hotkey_poll_setup(true);
2806
2807	mutex_unlock(&hotkey_mutex);
2808
2809	tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2810
2811	return count;
2812}
2813
2814static DEVICE_ATTR_RW(hotkey_poll_freq);
2815
2816#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2817
2818/* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2819static ssize_t hotkey_radio_sw_show(struct device *dev,
2820			   struct device_attribute *attr,
2821			   char *buf)
2822{
2823	int res;
2824	res = hotkey_get_wlsw();
2825	if (res < 0)
2826		return res;
2827
2828	/* Opportunistic update */
2829	tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2830
2831	return sysfs_emit(buf, "%d\n",
2832			(res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2833}
2834
2835static DEVICE_ATTR_RO(hotkey_radio_sw);
2836
2837static void hotkey_radio_sw_notify_change(void)
2838{
2839	if (tp_features.hotkey_wlsw)
2840		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2841			     "hotkey_radio_sw");
2842}
2843
2844/* sysfs hotkey tablet mode (pollable) --------------------------------- */
2845static ssize_t hotkey_tablet_mode_show(struct device *dev,
2846			   struct device_attribute *attr,
2847			   char *buf)
2848{
2849	int res, s;
2850	res = hotkey_get_tablet_mode(&s);
2851	if (res < 0)
2852		return res;
2853
2854	return sysfs_emit(buf, "%d\n", !!s);
2855}
2856
2857static DEVICE_ATTR_RO(hotkey_tablet_mode);
2858
2859static void hotkey_tablet_mode_notify_change(void)
2860{
2861	if (tp_features.hotkey_tablet)
2862		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2863			     "hotkey_tablet_mode");
2864}
2865
2866/* sysfs wakeup reason (pollable) -------------------------------------- */
2867static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2868			   struct device_attribute *attr,
2869			   char *buf)
2870{
2871	return sysfs_emit(buf, "%d\n", hotkey_wakeup_reason);
2872}
2873
2874static DEVICE_ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2875
2876static void hotkey_wakeup_reason_notify_change(void)
2877{
2878	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2879		     "wakeup_reason");
2880}
2881
2882/* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2883static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2884			   struct device_attribute *attr,
2885			   char *buf)
2886{
2887	return sysfs_emit(buf, "%d\n", hotkey_autosleep_ack);
2888}
2889
2890static DEVICE_ATTR(wakeup_hotunplug_complete, S_IRUGO,
2891		   hotkey_wakeup_hotunplug_complete_show, NULL);
2892
2893static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2894{
2895	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2896		     "wakeup_hotunplug_complete");
2897}
2898
2899/* sysfs adaptive kbd mode --------------------------------------------- */
2900
2901static int adaptive_keyboard_get_mode(void);
2902static int adaptive_keyboard_set_mode(int new_mode);
2903
2904enum ADAPTIVE_KEY_MODE {
2905	HOME_MODE,
2906	WEB_BROWSER_MODE,
2907	WEB_CONFERENCE_MODE,
2908	FUNCTION_MODE,
2909	LAYFLAT_MODE
2910};
2911
2912static ssize_t adaptive_kbd_mode_show(struct device *dev,
2913			   struct device_attribute *attr,
2914			   char *buf)
2915{
2916	int current_mode;
2917
2918	current_mode = adaptive_keyboard_get_mode();
2919	if (current_mode < 0)
2920		return current_mode;
2921
2922	return sysfs_emit(buf, "%d\n", current_mode);
2923}
2924
2925static ssize_t adaptive_kbd_mode_store(struct device *dev,
2926			    struct device_attribute *attr,
2927			    const char *buf, size_t count)
2928{
2929	unsigned long t;
2930	int res;
2931
2932	if (parse_strtoul(buf, LAYFLAT_MODE, &t))
2933		return -EINVAL;
2934
2935	res = adaptive_keyboard_set_mode(t);
2936	return (res < 0) ? res : count;
2937}
2938
2939static DEVICE_ATTR_RW(adaptive_kbd_mode);
2940
2941static struct attribute *adaptive_kbd_attributes[] = {
2942	&dev_attr_adaptive_kbd_mode.attr,
2943	NULL
2944};
2945
2946static umode_t hadaptive_kbd_attr_is_visible(struct kobject *kobj,
2947					     struct attribute *attr, int n)
2948{
2949	return tp_features.has_adaptive_kbd ? attr->mode : 0;
2950}
2951
2952static const struct attribute_group adaptive_kbd_attr_group = {
2953	.is_visible = hadaptive_kbd_attr_is_visible,
2954	.attrs = adaptive_kbd_attributes,
2955};
2956
2957/* --------------------------------------------------------------------- */
2958
2959static struct attribute *hotkey_attributes[] = {
2960	&dev_attr_hotkey_enable.attr,
2961	&dev_attr_hotkey_bios_enabled.attr,
2962	&dev_attr_hotkey_bios_mask.attr,
2963	&dev_attr_wakeup_reason.attr,
2964	&dev_attr_wakeup_hotunplug_complete.attr,
2965	&dev_attr_hotkey_mask.attr,
2966	&dev_attr_hotkey_all_mask.attr,
2967	&dev_attr_hotkey_adaptive_all_mask.attr,
2968	&dev_attr_hotkey_recommended_mask.attr,
2969	&dev_attr_hotkey_tablet_mode.attr,
2970	&dev_attr_hotkey_radio_sw.attr,
2971#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2972	&dev_attr_hotkey_source_mask.attr,
2973	&dev_attr_hotkey_poll_freq.attr,
2974#endif
2975	NULL
2976};
2977
2978static umode_t hotkey_attr_is_visible(struct kobject *kobj,
2979				      struct attribute *attr, int n)
2980{
2981	if (attr == &dev_attr_hotkey_tablet_mode.attr) {
2982		if (!tp_features.hotkey_tablet)
2983			return 0;
2984	} else if (attr == &dev_attr_hotkey_radio_sw.attr) {
2985		if (!tp_features.hotkey_wlsw)
2986			return 0;
2987	}
2988
2989	return attr->mode;
2990}
2991
2992static const struct attribute_group hotkey_attr_group = {
2993	.is_visible = hotkey_attr_is_visible,
2994	.attrs = hotkey_attributes,
2995};
2996
2997/*
2998 * Sync both the hw and sw blocking state of all switches
2999 */
3000static void tpacpi_send_radiosw_update(void)
3001{
3002	int wlsw;
3003
3004	/*
3005	 * We must sync all rfkill controllers *before* issuing any
3006	 * rfkill input events, or we will race the rfkill core input
3007	 * handler.
3008	 *
3009	 * tpacpi_inputdev_send_mutex works as a synchronization point
3010	 * for the above.
3011	 *
3012	 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3013	 */
3014
3015	wlsw = hotkey_get_wlsw();
3016
3017	/* Sync hw blocking state first if it is hw-blocked */
3018	if (wlsw == TPACPI_RFK_RADIO_OFF)
3019		tpacpi_rfk_update_hwblock_state(true);
3020
3021	/* Sync hw blocking state last if it is hw-unblocked */
3022	if (wlsw == TPACPI_RFK_RADIO_ON)
3023		tpacpi_rfk_update_hwblock_state(false);
3024
3025	/* Issue rfkill input event for WLSW switch */
3026	if (!(wlsw < 0)) {
3027		mutex_lock(&tpacpi_inputdev_send_mutex);
3028
3029		input_report_switch(tpacpi_inputdev,
3030				    SW_RFKILL_ALL, (wlsw > 0));
3031		input_sync(tpacpi_inputdev);
3032
3033		mutex_unlock(&tpacpi_inputdev_send_mutex);
3034	}
3035
3036	/*
3037	 * this can be unconditional, as we will poll state again
3038	 * if userspace uses the notify to read data
3039	 */
3040	hotkey_radio_sw_notify_change();
3041}
3042
3043static void hotkey_exit(void)
3044{
3045#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3046	mutex_lock(&hotkey_mutex);
3047	hotkey_poll_stop_sync();
3048	mutex_unlock(&hotkey_mutex);
3049#endif
3050	dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3051		   "restoring original HKEY status and mask\n");
3052	/* yes, there is a bitwise or below, we want the
3053	 * functions to be called even if one of them fail */
3054	if (((tp_features.hotkey_mask &&
3055	      hotkey_mask_set(hotkey_orig_mask)) |
3056	     hotkey_status_set(false)) != 0)
3057		pr_err("failed to restore hot key mask to BIOS defaults\n");
3058}
3059
3060static void __init hotkey_unmap(const unsigned int scancode)
3061{
3062	if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3063		clear_bit(hotkey_keycode_map[scancode],
3064			  tpacpi_inputdev->keybit);
3065		hotkey_keycode_map[scancode] = KEY_RESERVED;
3066	}
3067}
3068
3069/*
3070 * HKEY quirks:
3071 *   TPACPI_HK_Q_INIMASK:	Supports FN+F3,FN+F4,FN+F12
3072 */
3073
3074#define	TPACPI_HK_Q_INIMASK	0x0001
3075
3076static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3077	TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3078	TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3079	TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3080	TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3081	TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3082	TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3083	TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3084	TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3085	TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3086	TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3087	TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3088	TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3089	TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3090	TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3091	TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3092	TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3093	TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3094	TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3095	TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3096};
3097
3098typedef u16 tpacpi_keymap_entry_t;
3099typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3100
3101static int hotkey_init_tablet_mode(void)
3102{
3103	int in_tablet_mode = 0, res;
3104	char *type = NULL;
3105
3106	if (acpi_evalf(hkey_handle, &res, "GMMS", "qdd", 0)) {
3107		int has_tablet_mode;
3108
3109		in_tablet_mode = hotkey_gmms_get_tablet_mode(res,
3110							     &has_tablet_mode);
3111		/*
3112		 * The Yoga 11e series has 2 accelerometers described by a
3113		 * BOSC0200 ACPI node. This setup relies on a Windows service
3114		 * which calls special ACPI methods on this node to report
3115		 * the laptop/tent/tablet mode to the EC. The bmc150 iio driver
3116		 * does not support this, so skip the hotkey on these models.
3117		 */
3118		if (has_tablet_mode && !dual_accel_detect())
3119			tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_GMMS;
3120		type = "GMMS";
3121	} else if (acpi_evalf(hkey_handle, &res, "MHKG", "qd")) {
3122		/* For X41t, X60t, X61t Tablets... */
3123		tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_MHKG;
3124		in_tablet_mode = !!(res & TP_HOTKEY_TABLET_MASK);
3125		type = "MHKG";
3126	}
3127
3128	if (!tp_features.hotkey_tablet)
3129		return 0;
3130
3131	pr_info("Tablet mode switch found (type: %s), currently in %s mode\n",
3132		type, in_tablet_mode ? "tablet" : "laptop");
3133
3134	return in_tablet_mode;
3135}
3136
3137static int __init hotkey_init(struct ibm_init_struct *iibm)
3138{
3139	/* Requirements for changing the default keymaps:
3140	 *
3141	 * 1. Many of the keys are mapped to KEY_RESERVED for very
3142	 *    good reasons.  Do not change them unless you have deep
3143	 *    knowledge on the IBM and Lenovo ThinkPad firmware for
3144	 *    the various ThinkPad models.  The driver behaves
3145	 *    differently for KEY_RESERVED: such keys have their
3146	 *    hot key mask *unset* in mask_recommended, and also
3147	 *    in the initial hot key mask programmed into the
3148	 *    firmware at driver load time, which means the firm-
3149	 *    ware may react very differently if you change them to
3150	 *    something else;
3151	 *
3152	 * 2. You must be subscribed to the linux-thinkpad and
3153	 *    ibm-acpi-devel mailing lists, and you should read the
3154	 *    list archives since 2007 if you want to change the
3155	 *    keymaps.  This requirement exists so that you will
3156	 *    know the past history of problems with the thinkpad-
3157	 *    acpi driver keymaps, and also that you will be
3158	 *    listening to any bug reports;
3159	 *
3160	 * 3. Do not send thinkpad-acpi specific patches directly to
3161	 *    for merging, *ever*.  Send them to the linux-acpi
3162	 *    mailinglist for comments.  Merging is to be done only
3163	 *    through acpi-test and the ACPI maintainer.
3164	 *
3165	 * If the above is too much to ask, don't change the keymap.
3166	 * Ask the thinkpad-acpi maintainer to do it, instead.
3167	 */
3168
3169	enum keymap_index {
3170		TPACPI_KEYMAP_IBM_GENERIC = 0,
3171		TPACPI_KEYMAP_LENOVO_GENERIC,
3172	};
3173
3174	static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3175	/* Generic keymap for IBM ThinkPads */
3176	[TPACPI_KEYMAP_IBM_GENERIC] = {
3177		/* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3178		KEY_FN_F1,	KEY_BATTERY,	KEY_COFFEE,	KEY_SLEEP,
3179		KEY_WLAN,	KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3180		KEY_FN_F9,	KEY_FN_F10,	KEY_FN_F11,	KEY_SUSPEND,
3181
3182		/* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3183		KEY_UNKNOWN,	/* 0x0C: FN+BACKSPACE */
3184		KEY_UNKNOWN,	/* 0x0D: FN+INSERT */
3185		KEY_UNKNOWN,	/* 0x0E: FN+DELETE */
3186
3187		/* brightness: firmware always reacts to them */
3188		KEY_RESERVED,	/* 0x0F: FN+HOME (brightness up) */
3189		KEY_RESERVED,	/* 0x10: FN+END (brightness down) */
3190
3191		/* Thinklight: firmware always react to it */
3192		KEY_RESERVED,	/* 0x11: FN+PGUP (thinklight toggle) */
3193
3194		KEY_UNKNOWN,	/* 0x12: FN+PGDOWN */
3195		KEY_ZOOM,	/* 0x13: FN+SPACE (zoom) */
3196
3197		/* Volume: firmware always react to it and reprograms
3198		 * the built-in *extra* mixer.  Never map it to control
3199		 * another mixer by default. */
3200		KEY_RESERVED,	/* 0x14: VOLUME UP */
3201		KEY_RESERVED,	/* 0x15: VOLUME DOWN */
3202		KEY_RESERVED,	/* 0x16: MUTE */
3203
3204		KEY_VENDOR,	/* 0x17: Thinkpad/AccessIBM/Lenovo */
3205
3206		/* (assignments unknown, please report if found) */
3207		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3208		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3209
3210		/* No assignments, only used for Adaptive keyboards. */
3211		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3212		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3213		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3214		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3215		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3216
3217		/* No assignment, used for newer Lenovo models */
3218		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3219		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3220		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3221		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3222		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3223		KEY_UNKNOWN, KEY_UNKNOWN
3224
3225		},
3226
3227	/* Generic keymap for Lenovo ThinkPads */
3228	[TPACPI_KEYMAP_LENOVO_GENERIC] = {
3229		/* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3230		KEY_FN_F1,	KEY_COFFEE,	KEY_BATTERY,	KEY_SLEEP,
3231		KEY_WLAN,	KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3232		KEY_FN_F9,	KEY_FN_F10,	KEY_FN_F11,	KEY_SUSPEND,
3233
3234		/* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3235		KEY_UNKNOWN,	/* 0x0C: FN+BACKSPACE */
3236		KEY_UNKNOWN,	/* 0x0D: FN+INSERT */
3237		KEY_UNKNOWN,	/* 0x0E: FN+DELETE */
3238
3239		/* These should be enabled --only-- when ACPI video
3240		 * is disabled (i.e. in "vendor" mode), and are handled
3241		 * in a special way by the init code */
3242		KEY_BRIGHTNESSUP,	/* 0x0F: FN+HOME (brightness up) */
3243		KEY_BRIGHTNESSDOWN,	/* 0x10: FN+END (brightness down) */
3244
3245		KEY_RESERVED,	/* 0x11: FN+PGUP (thinklight toggle) */
3246
3247		KEY_UNKNOWN,	/* 0x12: FN+PGDOWN */
3248		KEY_ZOOM,	/* 0x13: FN+SPACE (zoom) */
3249
3250		/* Volume: z60/z61, T60 (BIOS version?): firmware always
3251		 * react to it and reprograms the built-in *extra* mixer.
3252		 * Never map it to control another mixer by default.
3253		 *
3254		 * T60?, T61, R60?, R61: firmware and EC tries to send
3255		 * these over the regular keyboard, so these are no-ops,
3256		 * but there are still weird bugs re. MUTE, so do not
3257		 * change unless you get test reports from all Lenovo
3258		 * models.  May cause the BIOS to interfere with the
3259		 * HDA mixer.
3260		 */
3261		KEY_RESERVED,	/* 0x14: VOLUME UP */
3262		KEY_RESERVED,	/* 0x15: VOLUME DOWN */
3263		KEY_RESERVED,	/* 0x16: MUTE */
3264
3265		KEY_VENDOR,	/* 0x17: Thinkpad/AccessIBM/Lenovo */
3266
3267		/* (assignments unknown, please report if found) */
3268		KEY_UNKNOWN, KEY_UNKNOWN,
3269
3270		/*
3271		 * The mic mute button only sends 0x1a.  It does not
3272		 * automatically mute the mic or change the mute light.
3273		 */
3274		KEY_MICMUTE,	/* 0x1a: Mic mute (since ?400 or so) */
3275
3276		/* (assignments unknown, please report if found) */
3277		KEY_UNKNOWN,
3278
3279		/* Extra keys in use since the X240 / T440 / T540 */
3280		KEY_CONFIG, KEY_SEARCH, KEY_SCALE, KEY_FILE,
3281
3282		/*
3283		 * These are the adaptive keyboard keycodes for Carbon X1 2014.
3284		 * The first item in this list is the Mute button which is
3285		 * emitted with 0x103 through
3286		 * adaptive_keyboard_hotkey_notify_hotkey() when the sound
3287		 * symbol is held.
3288		 * We'll need to offset those by 0x20.
3289		 */
3290		KEY_RESERVED,        /* Mute held, 0x103 */
3291		KEY_BRIGHTNESS_MIN,  /* Backlight off */
3292		KEY_RESERVED,        /* Clipping tool */
3293		KEY_RESERVED,        /* Cloud */
3294		KEY_RESERVED,
3295		KEY_VOICECOMMAND,    /* Voice */
3296		KEY_RESERVED,
3297		KEY_RESERVED,        /* Gestures */
3298		KEY_RESERVED,
3299		KEY_RESERVED,
3300		KEY_RESERVED,
3301		KEY_CONFIG,          /* Settings */
3302		KEY_RESERVED,        /* New tab */
3303		KEY_REFRESH,         /* Reload */
3304		KEY_BACK,            /* Back */
3305		KEY_RESERVED,        /* Microphone down */
3306		KEY_RESERVED,        /* Microphone up */
3307		KEY_RESERVED,        /* Microphone cancellation */
3308		KEY_RESERVED,        /* Camera mode */
3309		KEY_RESERVED,        /* Rotate display, 0x116 */
3310
3311		/*
3312		 * These are found in 2017 models (e.g. T470s, X270).
3313		 * The lowest known value is 0x311, which according to
3314		 * the manual should launch a user defined favorite
3315		 * application.
3316		 *
3317		 * The offset for these is TP_ACPI_HOTKEYSCAN_EXTENDED_START,
3318		 * corresponding to 0x34.
3319		 */
3320
3321		/* (assignments unknown, please report if found) */
3322		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3323		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3324		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3325		KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3326		KEY_UNKNOWN,
3327
3328		KEY_BOOKMARKS,			/* Favorite app, 0x311 */
3329		KEY_SELECTIVE_SCREENSHOT,	/* Clipping tool */
3330		KEY_CALC,			/* Calculator (above numpad, P52) */
3331		KEY_BLUETOOTH,			/* Bluetooth */
3332		KEY_KEYBOARD,			/* Keyboard, 0x315 */
3333		KEY_FN_RIGHT_SHIFT,		/* Fn + right Shift */
3334		KEY_NOTIFICATION_CENTER,	/* Notification Center */
3335		KEY_PICKUP_PHONE,		/* Answer incoming call */
3336		KEY_HANGUP_PHONE,		/* Decline incoming call */
3337		},
3338	};
3339
3340	static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3341		/* Generic maps (fallback) */
3342		{
3343		  .vendor = PCI_VENDOR_ID_IBM,
3344		  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3345		  .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3346		},
3347		{
3348		  .vendor = PCI_VENDOR_ID_LENOVO,
3349		  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3350		  .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3351		},
3352	};
3353
3354#define TPACPI_HOTKEY_MAP_SIZE		sizeof(tpacpi_keymap_t)
3355#define TPACPI_HOTKEY_MAP_TYPESIZE	sizeof(tpacpi_keymap_entry_t)
3356
3357	int res, i;
3358	int status;
3359	int hkeyv;
3360	bool radiosw_state  = false;
3361	bool tabletsw_state = false;
3362
3363	unsigned long quirks;
3364	unsigned long keymap_id;
3365
3366	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3367			"initializing hotkey subdriver\n");
3368
3369	BUG_ON(!tpacpi_inputdev);
3370	BUG_ON(tpacpi_inputdev->open != NULL ||
3371	       tpacpi_inputdev->close != NULL);
3372
3373	TPACPI_ACPIHANDLE_INIT(hkey);
3374	mutex_init(&hotkey_mutex);
3375
3376#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3377	mutex_init(&hotkey_thread_data_mutex);
3378#endif
3379
3380	/* hotkey not supported on 570 */
3381	tp_features.hotkey = hkey_handle != NULL;
3382
3383	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3384		"hotkeys are %s\n",
3385		str_supported(tp_features.hotkey));
3386
3387	if (!tp_features.hotkey)
3388		return -ENODEV;
3389
3390	quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3391				     ARRAY_SIZE(tpacpi_hotkey_qtable));
3392
3393	tpacpi_disable_brightness_delay();
3394
3395	/* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3396	   A30, R30, R31, T20-22, X20-21, X22-24.  Detected by checking
3397	   for HKEY interface version 0x100 */
3398	if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3399		vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3400			    "firmware HKEY interface version: 0x%x\n",
3401			    hkeyv);
3402
3403		switch (hkeyv >> 8) {
3404		case 1:
3405			/*
3406			 * MHKV 0x100 in A31, R40, R40e,
3407			 * T4x, X31, and later
3408			 */
3409
3410			/* Paranoia check AND init hotkey_all_mask */
3411			if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3412					"MHKA", "qd")) {
3413				pr_err("missing MHKA handler, please report this to %s\n",
3414				       TPACPI_MAIL);
3415				/* Fallback: pre-init for FN+F3,F4,F12 */
3416				hotkey_all_mask = 0x080cU;
3417			} else {
3418				tp_features.hotkey_mask = 1;
3419			}
3420			break;
3421
3422		case 2:
3423			/*
3424			 * MHKV 0x200 in X1, T460s, X260, T560, X1 Tablet (2016)
3425			 */
3426
3427			/* Paranoia check AND init hotkey_all_mask */
3428			if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3429					"MHKA", "dd", 1)) {
3430				pr_err("missing MHKA handler, please report this to %s\n",
3431				       TPACPI_MAIL);
3432				/* Fallback: pre-init for FN+F3,F4,F12 */
3433				hotkey_all_mask = 0x080cU;
3434			} else {
3435				tp_features.hotkey_mask = 1;
3436			}
3437
3438			/*
3439			 * Check if we have an adaptive keyboard, like on the
3440			 * Lenovo Carbon X1 2014 (2nd Gen).
3441			 */
3442			if (acpi_evalf(hkey_handle, &hotkey_adaptive_all_mask,
3443				       "MHKA", "dd", 2)) {
3444				if (hotkey_adaptive_all_mask != 0)
3445					tp_features.has_adaptive_kbd = true;
3446			} else {
3447				tp_features.has_adaptive_kbd = false;
3448				hotkey_adaptive_all_mask = 0x0U;
3449			}
3450			break;
3451
3452		default:
3453			pr_err("unknown version of the HKEY interface: 0x%x\n",
3454			       hkeyv);
3455			pr_err("please report this to %s\n", TPACPI_MAIL);
3456			break;
3457		}
3458	}
3459
3460	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3461		"hotkey masks are %s\n",
3462		str_supported(tp_features.hotkey_mask));
3463
3464	/* Init hotkey_all_mask if not initialized yet */
3465	if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3466	    (quirks & TPACPI_HK_Q_INIMASK))
3467		hotkey_all_mask = 0x080cU;  /* FN+F12, FN+F4, FN+F3 */
3468
3469	/* Init hotkey_acpi_mask and hotkey_orig_mask */
3470	if (tp_features.hotkey_mask) {
3471		/* hotkey_source_mask *must* be zero for
3472		 * the first hotkey_mask_get to return hotkey_orig_mask */
3473		mutex_lock(&hotkey_mutex);
3474		res = hotkey_mask_get();
3475		mutex_unlock(&hotkey_mutex);
3476		if (res)
3477			return res;
3478
3479		hotkey_orig_mask = hotkey_acpi_mask;
3480	} else {
3481		hotkey_orig_mask = hotkey_all_mask;
3482		hotkey_acpi_mask = hotkey_all_mask;
3483	}
3484
3485#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3486	if (dbg_wlswemul) {
3487		tp_features.hotkey_wlsw = 1;
3488		radiosw_state = !!tpacpi_wlsw_emulstate;
3489		pr_info("radio switch emulation enabled\n");
3490	} else
3491#endif
3492	/* Not all thinkpads have a hardware radio switch */
3493	if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3494		tp_features.hotkey_wlsw = 1;
3495		radiosw_state = !!status;
3496		pr_info("radio switch found; radios are %s\n", str_enabled_disabled(status & BIT(0)));
3497	}
3498
3499	tabletsw_state = hotkey_init_tablet_mode();
3500
3501	/* Set up key map */
3502	keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3503					ARRAY_SIZE(tpacpi_keymap_qtable));
3504	BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3505	dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3506		   "using keymap number %lu\n", keymap_id);
3507
3508	hotkey_keycode_map = kmemdup(&tpacpi_keymaps[keymap_id],
3509			TPACPI_HOTKEY_MAP_SIZE,	GFP_KERNEL);
3510	if (!hotkey_keycode_map) {
3511		pr_err("failed to allocate memory for key map\n");
3512		return -ENOMEM;
3513	}
3514
3515	input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3516	tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3517	tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3518	tpacpi_inputdev->keycode = hotkey_keycode_map;
3519	for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3520		if (hotkey_keycode_map[i] != KEY_RESERVED) {
3521			input_set_capability(tpacpi_inputdev, EV_KEY,
3522						hotkey_keycode_map[i]);
3523		} else {
3524			if (i < sizeof(hotkey_reserved_mask)*8)
3525				hotkey_reserved_mask |= 1 << i;
3526		}
3527	}
3528
3529	if (tp_features.hotkey_wlsw) {
3530		input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3531		input_report_switch(tpacpi_inputdev,
3532				    SW_RFKILL_ALL, radiosw_state);
3533	}
3534	if (tp_features.hotkey_tablet) {
3535		input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3536		input_report_switch(tpacpi_inputdev,
3537				    SW_TABLET_MODE, tabletsw_state);
3538	}
3539
3540	/* Do not issue duplicate brightness change events to
3541	 * userspace. tpacpi_detect_brightness_capabilities() must have
3542	 * been called before this point  */
3543	if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
3544		pr_info("This ThinkPad has standard ACPI backlight brightness control, supported by the ACPI video driver\n");
3545		pr_notice("Disabling thinkpad-acpi brightness events by default...\n");
3546
3547		/* Disable brightness up/down on Lenovo thinkpads when
3548		 * ACPI is handling them, otherwise it is plain impossible
3549		 * for userspace to do something even remotely sane */
3550		hotkey_reserved_mask |=
3551			(1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3552			| (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3553		hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3554		hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3555	}
3556
3557#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3558	hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3559				& ~hotkey_all_mask
3560				& ~hotkey_reserved_mask;
3561
3562	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3563		    "hotkey source mask 0x%08x, polling freq %u\n",
3564		    hotkey_source_mask, hotkey_poll_freq);
3565#endif
3566
3567	dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3568			"enabling firmware HKEY event interface...\n");
3569	res = hotkey_status_set(true);
3570	if (res) {
3571		hotkey_exit();
3572		return res;
3573	}
3574	mutex_lock(&hotkey_mutex);
3575	res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3576			       | hotkey_driver_mask)
3577			      & ~hotkey_source_mask);
3578	mutex_unlock(&hotkey_mutex);
3579	if (res < 0 && res != -ENXIO) {
3580		hotkey_exit();
3581		return res;
3582	}
3583	hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3584				& ~hotkey_reserved_mask;
3585	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3586		"initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3587		hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3588
3589	tpacpi_inputdev->open = &hotkey_inputdev_open;
3590	tpacpi_inputdev->close = &hotkey_inputdev_close;
3591
3592	hotkey_poll_setup_safe(true);
3593
3594	return 0;
3595}
3596
3597/* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3598 * mode, Web conference mode, Function mode and Lay-flat mode.
3599 * We support Home mode and Function mode currently.
3600 *
3601 * Will consider support rest of modes in future.
3602 *
3603 */
3604static const int adaptive_keyboard_modes[] = {
3605	HOME_MODE,
3606/*	WEB_BROWSER_MODE = 2,
3607	WEB_CONFERENCE_MODE = 3, */
3608	FUNCTION_MODE
3609};
3610
3611#define DFR_CHANGE_ROW			0x101
3612#define DFR_SHOW_QUICKVIEW_ROW		0x102
3613#define FIRST_ADAPTIVE_KEY		0x103
3614
3615/* press Fn key a while second, it will switch to Function Mode. Then
3616 * release Fn key, previous mode be restored.
3617 */
3618static bool adaptive_keyboard_mode_is_saved;
3619static int adaptive_keyboard_prev_mode;
3620
3621static int adaptive_keyboard_get_mode(void)
3622{
3623	int mode = 0;
3624
3625	if (!acpi_evalf(hkey_handle, &mode, "GTRW", "dd", 0)) {
3626		pr_err("Cannot read adaptive keyboard mode\n");
3627		return -EIO;
3628	}
3629
3630	return mode;
3631}
3632
3633static int adaptive_keyboard_set_mode(int new_mode)
3634{
3635	if (new_mode < 0 ||
3636		new_mode > LAYFLAT_MODE)
3637		return -EINVAL;
3638
3639	if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3640		pr_err("Cannot set adaptive keyboard mode\n");
3641		return -EIO;
3642	}
3643
3644	return 0;
3645}
3646
3647static int adaptive_keyboard_get_next_mode(int mode)
3648{
3649	size_t i;
3650	size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3651
3652	for (i = 0; i <= max_mode; i++) {
3653		if (adaptive_keyboard_modes[i] == mode)
3654			break;
3655	}
3656
3657	if (i >= max_mode)
3658		i = 0;
3659	else
3660		i++;
3661
3662	return adaptive_keyboard_modes[i];
3663}
3664
3665static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3666{
3667	int current_mode = 0;
3668	int new_mode = 0;
3669	int keycode;
3670
3671	switch (scancode) {
3672	case DFR_CHANGE_ROW:
3673		if (adaptive_keyboard_mode_is_saved) {
3674			new_mode = adaptive_keyboard_prev_mode;
3675			adaptive_keyboard_mode_is_saved = false;
3676		} else {
3677			current_mode = adaptive_keyboard_get_mode();
3678			if (current_mode < 0)
3679				return false;
3680			new_mode = adaptive_keyboard_get_next_mode(
3681					current_mode);
3682		}
3683
3684		if (adaptive_keyboard_set_mode(new_mode) < 0)
3685			return false;
3686
3687		return true;
3688
3689	case DFR_SHOW_QUICKVIEW_ROW:
3690		current_mode = adaptive_keyboard_get_mode();
3691		if (current_mode < 0)
3692			return false;
3693
3694		adaptive_keyboard_prev_mode = current_mode;
3695		adaptive_keyboard_mode_is_saved = true;
3696
3697		if (adaptive_keyboard_set_mode (FUNCTION_MODE) < 0)
3698			return false;
3699		return true;
3700
3701	default:
3702		if (scancode < FIRST_ADAPTIVE_KEY ||
3703		    scancode >= FIRST_ADAPTIVE_KEY +
3704		    TP_ACPI_HOTKEYSCAN_EXTENDED_START -
3705		    TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3706			pr_info("Unhandled adaptive keyboard key: 0x%x\n",
3707				scancode);
3708			return false;
3709		}
3710		keycode = hotkey_keycode_map[scancode - FIRST_ADAPTIVE_KEY +
3711					     TP_ACPI_HOTKEYSCAN_ADAPTIVE_START];
3712		if (keycode != KEY_RESERVED) {
3713			mutex_lock(&tpacpi_inputdev_send_mutex);
3714
3715			input_report_key(tpacpi_inputdev, keycode, 1);
3716			input_sync(tpacpi_inputdev);
3717
3718			input_report_key(tpacpi_inputdev, keycode, 0);
3719			input_sync(tpacpi_inputdev);
3720
3721			mutex_unlock(&tpacpi_inputdev_send_mutex);
3722		}
3723		return true;
3724	}
3725}
3726
3727static bool hotkey_notify_extended_hotkey(const u32 hkey)
3728{
3729	unsigned int scancode;
3730
3731	switch (hkey) {
3732	case TP_HKEY_EV_PRIVACYGUARD_TOGGLE:
3733	case TP_HKEY_EV_AMT_TOGGLE:
3734		tpacpi_driver_event(hkey);
3735		return true;
3736	}
3737
3738	/* Extended keycodes start at 0x300 and our offset into the map
3739	 * TP_ACPI_HOTKEYSCAN_EXTENDED_START. The calculated scancode
3740	 * will be positive, but might not be in the correct range.
3741	 */
3742	scancode = (hkey & 0xfff) - (0x300 - TP_ACPI_HOTKEYSCAN_EXTENDED_START);
3743	if (scancode >= TP_ACPI_HOTKEYSCAN_EXTENDED_START &&
3744	    scancode < TPACPI_HOTKEY_MAP_LEN) {
3745		tpacpi_input_send_key(scancode);
3746		return true;
3747	}
3748
3749	return false;
3750}
3751
3752static bool hotkey_notify_hotkey(const u32 hkey,
3753				 bool *send_acpi_ev,
3754				 bool *ignore_acpi_ev)
3755{
3756	/* 0x1000-0x1FFF: key presses */
3757	unsigned int scancode = hkey & 0xfff;
3758	*send_acpi_ev = true;
3759	*ignore_acpi_ev = false;
3760
3761	/*
3762	 * Original events are in the 0x10XX range, the adaptive keyboard
3763	 * found in 2014 X1 Carbon emits events are of 0x11XX. In 2017
3764	 * models, additional keys are emitted through 0x13XX.
3765	 */
3766	switch ((hkey >> 8) & 0xf) {
3767	case 0:
3768		if (scancode > 0 &&
3769		    scancode <= TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3770			/* HKEY event 0x1001 is scancode 0x00 */
3771			scancode--;
3772			if (!(hotkey_source_mask & (1 << scancode))) {
3773				tpacpi_input_send_key_masked(scancode);
3774				*send_acpi_ev = false;
3775			} else {
3776				*ignore_acpi_ev = true;
3777			}
3778			return true;
3779		}
3780		break;
3781
3782	case 1:
3783		return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3784
3785	case 3:
3786		return hotkey_notify_extended_hotkey(hkey);
3787	}
3788
3789	return false;
3790}
3791
3792static bool hotkey_notify_wakeup(const u32 hkey,
3793				 bool *send_acpi_ev,
3794				 bool *ignore_acpi_ev)
3795{
3796	/* 0x2000-0x2FFF: Wakeup reason */
3797	*send_acpi_ev = true;
3798	*ignore_acpi_ev = false;
3799
3800	switch (hkey) {
3801	case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3802	case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3803		hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3804		*ignore_acpi_ev = true;
3805		break;
3806
3807	case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3808	case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3809		hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3810		*ignore_acpi_ev = true;
3811		break;
3812
3813	case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3814	case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3815		pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3816		/* how to auto-heal: */
3817		/* 2313: woke up from S3, go to S4/S5 */
3818		/* 2413: woke up from S4, go to S5 */
3819		break;
3820
3821	default:
3822		return false;
3823	}
3824
3825	if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3826		pr_info("woke up due to a hot-unplug request...\n");
3827		hotkey_wakeup_reason_notify_change();
3828	}
3829	return true;
3830}
3831
3832static bool hotkey_notify_dockevent(const u32 hkey,
3833				 bool *send_acpi_ev,
3834				 bool *ignore_acpi_ev)
3835{
3836	/* 0x4000-0x4FFF: dock-related events */
3837	*send_acpi_ev = true;
3838	*ignore_acpi_ev = false;
3839
3840	switch (hkey) {
3841	case TP_HKEY_EV_UNDOCK_ACK:
3842		/* ACPI undock operation completed after wakeup */
3843		hotkey_autosleep_ack = 1;
3844		pr_info("undocked\n");
3845		hotkey_wakeup_hotunplug_complete_notify_change();
3846		return true;
3847
3848	case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3849		pr_info("docked into hotplug port replicator\n");
3850		return true;
3851	case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3852		pr_info("undocked from hotplug port replicator\n");
3853		return true;
3854
3855	/*
3856	 * Deliberately ignore attaching and detaching the keybord cover to avoid
3857	 * duplicates from intel-vbtn, which already emits SW_TABLET_MODE events
3858	 * to userspace.
3859	 *
3860	 * Please refer to the following thread for more information and a preliminary
3861	 * implementation using the GTOP ("Get Tablet OPtions") interface that could be
3862	 * extended to other attachment options of the ThinkPad X1 Tablet series, such as
3863	 * the Pico cartridge dock module:
3864	 * https://lore.kernel.org/platform-driver-x86/38cb8265-1e30-d547-9e12-b4ae290be737@a-kobel.de/
3865	 */
3866	case TP_HKEY_EV_KBD_COVER_ATTACH:
3867	case TP_HKEY_EV_KBD_COVER_DETACH:
3868		*send_acpi_ev = false;
3869		*ignore_acpi_ev = true;
3870		return true;
3871
3872	default:
3873		return false;
3874	}
3875}
3876
3877static bool hotkey_notify_usrevent(const u32 hkey,
3878				 bool *send_acpi_ev,
3879				 bool *ignore_acpi_ev)
3880{
3881	/* 0x5000-0x5FFF: human interface helpers */
3882	*send_acpi_ev = true;
3883	*ignore_acpi_ev = false;
3884
3885	switch (hkey) {
3886	case TP_HKEY_EV_PEN_INSERTED:  /* X61t: tablet pen inserted into bay */
3887	case TP_HKEY_EV_PEN_REMOVED:   /* X61t: tablet pen removed from bay */
3888		return true;
3889
3890	case TP_HKEY_EV_TABLET_TABLET:   /* X41t-X61t: tablet mode */
3891	case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3892		tpacpi_input_send_tabletsw();
3893		hotkey_tablet_mode_notify_change();
3894		*send_acpi_ev = false;
3895		return true;
3896
3897	case TP_HKEY_EV_LID_CLOSE:	/* Lid closed */
3898	case TP_HKEY_EV_LID_OPEN:	/* Lid opened */
3899	case TP_HKEY_EV_BRGHT_CHANGED:	/* brightness changed */
3900		/* do not propagate these events */
3901		*ignore_acpi_ev = true;
3902		return true;
3903
3904	default:
3905		return false;
3906	}
3907}
3908
3909static void thermal_dump_all_sensors(void);
3910static void palmsensor_refresh(void);
3911
3912static bool hotkey_notify_6xxx(const u32 hkey,
3913				 bool *send_acpi_ev,
3914				 bool *ignore_acpi_ev)
3915{
3916	/* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
3917	*send_acpi_ev = true;
3918	*ignore_acpi_ev = false;
3919
3920	switch (hkey) {
3921	case TP_HKEY_EV_THM_TABLE_CHANGED:
3922		pr_debug("EC reports: Thermal Table has changed\n");
3923		/* recommended action: do nothing, we don't have
3924		 * Lenovo ATM information */
3925		return true;
3926	case TP_HKEY_EV_THM_CSM_COMPLETED:
3927		pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
3928		/* Thermal event - pass on to event handler */
3929		tpacpi_driver_event(hkey);
3930		return true;
3931	case TP_HKEY_EV_THM_TRANSFM_CHANGED:
3932		pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
3933		/* recommended action: do nothing, we don't have
3934		 * Lenovo ATM information */
3935		return true;
3936	case TP_HKEY_EV_ALARM_BAT_HOT:
3937		pr_crit("THERMAL ALARM: battery is too hot!\n");
3938		/* recommended action: warn user through gui */
3939		break;
3940	case TP_HKEY_EV_ALARM_BAT_XHOT:
3941		pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
3942		/* recommended action: immediate sleep/hibernate */
3943		break;
3944	case TP_HKEY_EV_ALARM_SENSOR_HOT:
3945		pr_crit("THERMAL ALARM: a sensor reports something is too hot!\n");
3946		/* recommended action: warn user through gui, that */
3947		/* some internal component is too hot */
3948		break;
3949	case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3950		pr_alert("THERMAL EMERGENCY: a sensor reports something is extremely hot!\n");
3951		/* recommended action: immediate sleep/hibernate */
3952		break;
3953	case TP_HKEY_EV_AC_CHANGED:
3954		/* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
3955		 * AC status changed; can be triggered by plugging or
3956		 * unplugging AC adapter, docking or undocking. */
3957
3958		fallthrough;
3959
3960	case TP_HKEY_EV_KEY_NUMLOCK:
3961	case TP_HKEY_EV_KEY_FN:
3962		/* key press events, we just ignore them as long as the EC
3963		 * is still reporting them in the normal keyboard stream */
3964		*send_acpi_ev = false;
3965		*ignore_acpi_ev = true;
3966		return true;
3967
3968	case TP_HKEY_EV_KEY_FN_ESC:
3969		/* Get the media key status to force the status LED to update */
3970		acpi_evalf(hkey_handle, NULL, "GMKS", "v");
3971		*send_acpi_ev = false;
3972		*ignore_acpi_ev = true;
3973		return true;
3974
3975	case TP_HKEY_EV_TABLET_CHANGED:
3976		tpacpi_input_send_tabletsw();
3977		hotkey_tablet_mode_notify_change();
3978		*send_acpi_ev = false;
3979		return true;
3980
3981	case TP_HKEY_EV_PALM_DETECTED:
3982	case TP_HKEY_EV_PALM_UNDETECTED:
3983		/* palm detected  - pass on to event handler */
3984		palmsensor_refresh();
3985		return true;
3986
3987	default:
3988		/* report simply as unknown, no sensor dump */
3989		return false;
3990	}
3991
3992	thermal_dump_all_sensors();
3993	return true;
3994}
3995
3996static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3997{
3998	u32 hkey;
3999	bool send_acpi_ev;
4000	bool ignore_acpi_ev;
4001	bool known_ev;
4002
4003	if (event != 0x80) {
4004		pr_err("unknown HKEY notification event %d\n", event);
4005		/* forward it to userspace, maybe it knows how to handle it */
4006		acpi_bus_generate_netlink_event(
4007					ibm->acpi->device->pnp.device_class,
4008					dev_name(&ibm->acpi->device->dev),
4009					event, 0);
4010		return;
4011	}
4012
4013	while (1) {
4014		if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
4015			pr_err("failed to retrieve HKEY event\n");
4016			return;
4017		}
4018
4019		if (hkey == 0) {
4020			/* queue empty */
4021			return;
4022		}
4023
4024		send_acpi_ev = true;
4025		ignore_acpi_ev = false;
4026
4027		switch (hkey >> 12) {
4028		case 1:
4029			/* 0x1000-0x1FFF: key presses */
4030			known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
4031						 &ignore_acpi_ev);
4032			break;
4033		case 2:
4034			/* 0x2000-0x2FFF: Wakeup reason */
4035			known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
4036						 &ignore_acpi_ev);
4037			break;
4038		case 3:
4039			/* 0x3000-0x3FFF: bay-related wakeups */
4040			switch (hkey) {
4041			case TP_HKEY_EV_BAYEJ_ACK:
4042				hotkey_autosleep_ack = 1;
4043				pr_info("bay ejected\n");
4044				hotkey_wakeup_hotunplug_complete_notify_change();
4045				known_ev = true;
4046				break;
4047			case TP_HKEY_EV_OPTDRV_EJ:
4048				/* FIXME: kick libata if SATA link offline */
4049				known_ev = true;
4050				break;
4051			default:
4052				known_ev = false;
4053			}
4054			break;
4055		case 4:
4056			/* 0x4000-0x4FFF: dock-related events */
4057			known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
4058						&ignore_acpi_ev);
4059			break;
4060		case 5:
4061			/* 0x5000-0x5FFF: human interface helpers */
4062			known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
4063						 &ignore_acpi_ev);
4064			break;
4065		case 6:
4066			/* 0x6000-0x6FFF: thermal alarms/notices and
4067			 *                keyboard events */
4068			known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
4069						 &ignore_acpi_ev);
4070			break;
4071		case 7:
4072			/* 0x7000-0x7FFF: misc */
4073			if (tp_features.hotkey_wlsw &&
4074					hkey == TP_HKEY_EV_RFKILL_CHANGED) {
4075				tpacpi_send_radiosw_update();
4076				send_acpi_ev = 0;
4077				known_ev = true;
4078				break;
4079			}
4080			fallthrough;	/* to default */
4081		default:
4082			known_ev = false;
4083		}
4084		if (!known_ev) {
4085			pr_notice("unhandled HKEY event 0x%04x\n", hkey);
4086			pr_notice("please report the conditions when this event happened to %s\n",
4087				  TPACPI_MAIL);
4088		}
4089
4090		/* netlink events */
4091		if (!ignore_acpi_ev && send_acpi_ev) {
4092			acpi_bus_generate_netlink_event(
4093					ibm->acpi->device->pnp.device_class,
4094					dev_name(&ibm->acpi->device->dev),
4095					event, hkey);
4096		}
4097	}
4098}
4099
4100static void hotkey_suspend(void)
4101{
4102	/* Do these on suspend, we get the events on early resume! */
4103	hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
4104	hotkey_autosleep_ack = 0;
4105
4106	/* save previous mode of adaptive keyboard of X1 Carbon */
4107	if (tp_features.has_adaptive_kbd) {
4108		if (!acpi_evalf(hkey_handle, &adaptive_keyboard_prev_mode,
4109					"GTRW", "dd", 0)) {
4110			pr_err("Cannot read adaptive keyboard mode.\n");
4111		}
4112	}
4113}
4114
4115static void hotkey_resume(void)
4116{
4117	tpacpi_disable_brightness_delay();
4118
4119	mutex_lock(&hotkey_mutex);
4120	if (hotkey_status_set(true) < 0 ||
4121	    hotkey_mask_set(hotkey_acpi_mask) < 0)
4122		pr_err("error while attempting to reset the event firmware interface\n");
4123	mutex_unlock(&hotkey_mutex);
4124
4125	tpacpi_send_radiosw_update();
4126	tpacpi_input_send_tabletsw();
4127	hotkey_tablet_mode_notify_change();
4128	hotkey_wakeup_reason_notify_change();
4129	hotkey_wakeup_hotunplug_complete_notify_change();
4130	hotkey_poll_setup_safe(false);
4131
4132	/* restore previous mode of adapive keyboard of X1 Carbon */
4133	if (tp_features.has_adaptive_kbd) {
4134		if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd",
4135					adaptive_keyboard_prev_mode)) {
4136			pr_err("Cannot set adaptive keyboard mode.\n");
4137		}
4138	}
4139}
4140
4141/* procfs -------------------------------------------------------------- */
4142static int hotkey_read(struct seq_file *m)
4143{
4144	int res, status;
4145
4146	if (!tp_features.hotkey) {
4147		seq_printf(m, "status:\t\tnot supported\n");
4148		return 0;
4149	}
4150
4151	if (mutex_lock_killable(&hotkey_mutex))
4152		return -ERESTARTSYS;
4153	res = hotkey_status_get(&status);
4154	if (!res)
4155		res = hotkey_mask_get();
4156	mutex_unlock(&hotkey_mutex);
4157	if (res)
4158		return res;
4159
4160	seq_printf(m, "status:\t\t%s\n", str_enabled_disabled(status & BIT(0)));
4161	if (hotkey_all_mask) {
4162		seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
4163		seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
4164	} else {
4165		seq_printf(m, "mask:\t\tnot supported\n");
4166		seq_printf(m, "commands:\tenable, disable, reset\n");
4167	}
4168
4169	return 0;
4170}
4171
4172static void hotkey_enabledisable_warn(bool enable)
4173{
4174	tpacpi_log_usertask("procfs hotkey enable/disable");
4175	if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
4176		  pr_fmt("hotkey enable/disable functionality has been removed from the driver.  Hotkeys are always enabled.\n")))
4177		pr_err("Please remove the hotkey=enable module parameter, it is deprecated.  Hotkeys are always enabled.\n");
4178}
4179
4180static int hotkey_write(char *buf)
4181{
4182	int res;
4183	u32 mask;
4184	char *cmd;
4185
4186	if (!tp_features.hotkey)
4187		return -ENODEV;
4188
4189	if (mutex_lock_killable(&hotkey_mutex))
4190		return -ERESTARTSYS;
4191
4192	mask = hotkey_user_mask;
4193
4194	res = 0;
4195	while ((cmd = strsep(&buf, ","))) {
4196		if (strstarts(cmd, "enable")) {
4197			hotkey_enabledisable_warn(1);
4198		} else if (strstarts(cmd, "disable")) {
4199			hotkey_enabledisable_warn(0);
4200			res = -EPERM;
4201		} else if (strstarts(cmd, "reset")) {
4202			mask = (hotkey_all_mask | hotkey_source_mask)
4203				& ~hotkey_reserved_mask;
4204		} else if (sscanf(cmd, "0x%x", &mask) == 1) {
4205			/* mask set */
4206		} else if (sscanf(cmd, "%x", &mask) == 1) {
4207			/* mask set */
4208		} else {
4209			res = -EINVAL;
4210			goto errexit;
4211		}
4212	}
4213
4214	if (!res) {
4215		tpacpi_disclose_usertask("procfs hotkey",
4216			"set mask to 0x%08x\n", mask);
4217		res = hotkey_user_mask_set(mask);
4218	}
4219
4220errexit:
4221	mutex_unlock(&hotkey_mutex);
4222	return res;
4223}
4224
4225static const struct acpi_device_id ibm_htk_device_ids[] = {
4226	{TPACPI_ACPI_IBM_HKEY_HID, 0},
4227	{TPACPI_ACPI_LENOVO_HKEY_HID, 0},
4228	{TPACPI_ACPI_LENOVO_HKEY_V2_HID, 0},
4229	{"", 0},
4230};
4231
4232static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
4233	.hid = ibm_htk_device_ids,
4234	.notify = hotkey_notify,
4235	.handle = &hkey_handle,
4236	.type = ACPI_DEVICE_NOTIFY,
4237};
4238
4239static struct ibm_struct hotkey_driver_data = {
4240	.name = "hotkey",
4241	.read = hotkey_read,
4242	.write = hotkey_write,
4243	.exit = hotkey_exit,
4244	.resume = hotkey_resume,
4245	.suspend = hotkey_suspend,
4246	.acpi = &ibm_hotkey_acpidriver,
4247};
4248
4249/*************************************************************************
4250 * Bluetooth subdriver
4251 */
4252
4253enum {
4254	/* ACPI GBDC/SBDC bits */
4255	TP_ACPI_BLUETOOTH_HWPRESENT	= 0x01,	/* Bluetooth hw available */
4256	TP_ACPI_BLUETOOTH_RADIOSSW	= 0x02,	/* Bluetooth radio enabled */
4257	TP_ACPI_BLUETOOTH_RESUMECTRL	= 0x04,	/* Bluetooth state at resume:
4258						   0 = disable, 1 = enable */
4259};
4260
4261enum {
4262	/* ACPI \BLTH commands */
4263	TP_ACPI_BLTH_GET_ULTRAPORT_ID	= 0x00, /* Get Ultraport BT ID */
4264	TP_ACPI_BLTH_GET_PWR_ON_RESUME	= 0x01, /* Get power-on-resume state */
4265	TP_ACPI_BLTH_PWR_ON_ON_RESUME	= 0x02, /* Resume powered on */
4266	TP_ACPI_BLTH_PWR_OFF_ON_RESUME	= 0x03,	/* Resume powered off */
4267	TP_ACPI_BLTH_SAVE_STATE		= 0x05, /* Save state for S4/S5 */
4268};
4269
4270#define TPACPI_RFK_BLUETOOTH_SW_NAME	"tpacpi_bluetooth_sw"
4271
4272static int bluetooth_get_status(void)
4273{
4274	int status;
4275
4276#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4277	if (dbg_bluetoothemul)
4278		return (tpacpi_bluetooth_emulstate) ?
4279		       TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4280#endif
4281
4282	if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4283		return -EIO;
4284
4285	return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4286			TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4287}
4288
4289static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4290{
4291	int status;
4292
4293	vdbg_printk(TPACPI_DBG_RFKILL, "will attempt to %s bluetooth\n",
4294		    str_enable_disable(state == TPACPI_RFK_RADIO_ON));
4295
4296#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4297	if (dbg_bluetoothemul) {
4298		tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4299		return 0;
4300	}
4301#endif
4302
4303	if (state == TPACPI_RFK_RADIO_ON)
4304		status = TP_ACPI_BLUETOOTH_RADIOSSW
4305			  | TP_ACPI_BLUETOOTH_RESUMECTRL;
4306	else
4307		status = 0;
4308
4309	if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4310		return -EIO;
4311
4312	return 0;
4313}
4314
4315/* sysfs bluetooth enable ---------------------------------------------- */
4316static ssize_t bluetooth_enable_show(struct device *dev,
4317			   struct device_attribute *attr,
4318			   char *buf)
4319{
4320	return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4321			attr, buf);
4322}
4323
4324static ssize_t bluetooth_enable_store(struct device *dev,
4325			    struct device_attribute *attr,
4326			    const char *buf, size_t count)
4327{
4328	return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4329				attr, buf, count);
4330}
4331
4332static DEVICE_ATTR_RW(bluetooth_enable);
4333
4334/* --------------------------------------------------------------------- */
4335
4336static struct attribute *bluetooth_attributes[] = {
4337	&dev_attr_bluetooth_enable.attr,
4338	NULL
4339};
4340
4341static umode_t bluetooth_attr_is_visible(struct kobject *kobj,
4342					 struct attribute *attr, int n)
4343{
4344	return tp_features.bluetooth ? attr->mode : 0;
4345}
4346
4347static const struct attribute_group bluetooth_attr_group = {
4348	.is_visible = bluetooth_attr_is_visible,
4349	.attrs = bluetooth_attributes,
4350};
4351
4352static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4353	.get_status = bluetooth_get_status,
4354	.set_status = bluetooth_set_status,
4355};
4356
4357static void bluetooth_shutdown(void)
4358{
4359	/* Order firmware to save current state to NVRAM */
4360	if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4361			TP_ACPI_BLTH_SAVE_STATE))
4362		pr_notice("failed to save bluetooth state to NVRAM\n");
4363	else
4364		vdbg_printk(TPACPI_DBG_RFKILL,
4365			"bluetooth state saved to NVRAM\n");
4366}
4367
4368static void bluetooth_exit(void)
4369{
4370	tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4371	bluetooth_shutdown();
4372}
4373
4374static const struct dmi_system_id fwbug_list[] __initconst = {
4375	{
4376		.ident = "ThinkPad E485",
4377		.driver_data = &quirk_btusb_bug,
4378		.matches = {
4379			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4380			DMI_MATCH(DMI_BOARD_NAME, "20KU"),
4381		},
4382	},
4383	{
4384		.ident = "ThinkPad E585",
4385		.driver_data = &quirk_btusb_bug,
4386		.matches = {
4387			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4388			DMI_MATCH(DMI_BOARD_NAME, "20KV"),
4389		},
4390	},
4391	{
4392		.ident = "ThinkPad A285 - 20MW",
4393		.driver_data = &quirk_btusb_bug,
4394		.matches = {
4395			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4396			DMI_MATCH(DMI_BOARD_NAME, "20MW"),
4397		},
4398	},
4399	{
4400		.ident = "ThinkPad A285 - 20MX",
4401		.driver_data = &quirk_btusb_bug,
4402		.matches = {
4403			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4404			DMI_MATCH(DMI_BOARD_NAME, "20MX"),
4405		},
4406	},
4407	{
4408		.ident = "ThinkPad A485 - 20MU",
4409		.driver_data = &quirk_btusb_bug,
4410		.matches = {
4411			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4412			DMI_MATCH(DMI_BOARD_NAME, "20MU"),
4413		},
4414	},
4415	{
4416		.ident = "ThinkPad A485 - 20MV",
4417		.driver_data = &quirk_btusb_bug,
4418		.matches = {
4419			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4420			DMI_MATCH(DMI_BOARD_NAME, "20MV"),
4421		},
4422	},
4423	{}
4424};
4425
4426static const struct pci_device_id fwbug_cards_ids[] __initconst = {
4427	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24F3) },
4428	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24FD) },
4429	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x2526) },
4430	{}
4431};
4432
4433
4434static int __init have_bt_fwbug(void)
4435{
4436	/*
4437	 * Some AMD based ThinkPads have a firmware bug that calling
4438	 * "GBDC" will cause bluetooth on Intel wireless cards blocked
4439	 */
4440	if (tp_features.quirks && tp_features.quirks->btusb_bug &&
4441	    pci_dev_present(fwbug_cards_ids)) {
4442		vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4443			FW_BUG "disable bluetooth subdriver for Intel cards\n");
4444		return 1;
4445	} else
4446		return 0;
4447}
4448
4449static int __init bluetooth_init(struct ibm_init_struct *iibm)
4450{
4451	int res;
4452	int status = 0;
4453
4454	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4455			"initializing bluetooth subdriver\n");
4456
4457	TPACPI_ACPIHANDLE_INIT(hkey);
4458
4459	/* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4460	   G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4461	tp_features.bluetooth = !have_bt_fwbug() && hkey_handle &&
4462	    acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4463
4464	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4465		"bluetooth is %s, status 0x%02x\n",
4466		str_supported(tp_features.bluetooth),
4467		status);
4468
4469#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4470	if (dbg_bluetoothemul) {
4471		tp_features.bluetooth = 1;
4472		pr_info("bluetooth switch emulation enabled\n");
4473	} else
4474#endif
4475	if (tp_features.bluetooth &&
4476	    !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4477		/* no bluetooth hardware present in system */
4478		tp_features.bluetooth = 0;
4479		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4480			   "bluetooth hardware not installed\n");
4481	}
4482
4483	if (!tp_features.bluetooth)
4484		return -ENODEV;
4485
4486	res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4487				&bluetooth_tprfk_ops,
4488				RFKILL_TYPE_BLUETOOTH,
4489				TPACPI_RFK_BLUETOOTH_SW_NAME,
4490				true);
4491	return res;
4492}
4493
4494/* procfs -------------------------------------------------------------- */
4495static int bluetooth_read(struct seq_file *m)
4496{
4497	return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4498}
4499
4500static int bluetooth_write(char *buf)
4501{
4502	return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4503}
4504
4505static struct ibm_struct bluetooth_driver_data = {
4506	.name = "bluetooth",
4507	.read = bluetooth_read,
4508	.write = bluetooth_write,
4509	.exit = bluetooth_exit,
4510	.shutdown = bluetooth_shutdown,
4511};
4512
4513/*************************************************************************
4514 * Wan subdriver
4515 */
4516
4517enum {
4518	/* ACPI GWAN/SWAN bits */
4519	TP_ACPI_WANCARD_HWPRESENT	= 0x01,	/* Wan hw available */
4520	TP_ACPI_WANCARD_RADIOSSW	= 0x02,	/* Wan radio enabled */
4521	TP_ACPI_WANCARD_RESUMECTRL	= 0x04,	/* Wan state at resume:
4522						   0 = disable, 1 = enable */
4523};
4524
4525#define TPACPI_RFK_WWAN_SW_NAME		"tpacpi_wwan_sw"
4526
4527static int wan_get_status(void)
4528{
4529	int status;
4530
4531#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4532	if (dbg_wwanemul)
4533		return (tpacpi_wwan_emulstate) ?
4534		       TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4535#endif
4536
4537	if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4538		return -EIO;
4539
4540	return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4541			TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4542}
4543
4544static int wan_set_status(enum tpacpi_rfkill_state state)
4545{
4546	int status;
4547
4548	vdbg_printk(TPACPI_DBG_RFKILL, "will attempt to %s wwan\n",
4549		    str_enable_disable(state == TPACPI_RFK_RADIO_ON));
4550
4551#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4552	if (dbg_wwanemul) {
4553		tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4554		return 0;
4555	}
4556#endif
4557
4558	if (state == TPACPI_RFK_RADIO_ON)
4559		status = TP_ACPI_WANCARD_RADIOSSW
4560			 | TP_ACPI_WANCARD_RESUMECTRL;
4561	else
4562		status = 0;
4563
4564	if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4565		return -EIO;
4566
4567	return 0;
4568}
4569
4570/* sysfs wan enable ---------------------------------------------------- */
4571static ssize_t wan_enable_show(struct device *dev,
4572			   struct device_attribute *attr,
4573			   char *buf)
4574{
4575	return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4576			attr, buf);
4577}
4578
4579static ssize_t wan_enable_store(struct device *dev,
4580			    struct device_attribute *attr,
4581			    const char *buf, size_t count)
4582{
4583	return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4584			attr, buf, count);
4585}
4586
4587static DEVICE_ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4588		   wan_enable_show, wan_enable_store);
4589
4590/* --------------------------------------------------------------------- */
4591
4592static struct attribute *wan_attributes[] = {
4593	&dev_attr_wwan_enable.attr,
4594	NULL
4595};
4596
4597static umode_t wan_attr_is_visible(struct kobject *kobj, struct attribute *attr,
4598				   int n)
4599{
4600	return tp_features.wan ? attr->mode : 0;
4601}
4602
4603static const struct attribute_group wan_attr_group = {
4604	.is_visible = wan_attr_is_visible,
4605	.attrs = wan_attributes,
4606};
4607
4608static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4609	.get_status = wan_get_status,
4610	.set_status = wan_set_status,
4611};
4612
4613static void wan_shutdown(void)
4614{
4615	/* Order firmware to save current state to NVRAM */
4616	if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4617			TP_ACPI_WGSV_SAVE_STATE))
4618		pr_notice("failed to save WWAN state to NVRAM\n");
4619	else
4620		vdbg_printk(TPACPI_DBG_RFKILL,
4621			"WWAN state saved to NVRAM\n");
4622}
4623
4624static void wan_exit(void)
4625{
4626	tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4627	wan_shutdown();
4628}
4629
4630static int __init wan_init(struct ibm_init_struct *iibm)
4631{
4632	int res;
4633	int status = 0;
4634
4635	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4636			"initializing wan subdriver\n");
4637
4638	TPACPI_ACPIHANDLE_INIT(hkey);
4639
4640	tp_features.wan = hkey_handle &&
4641	    acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4642
4643	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4644		"wan is %s, status 0x%02x\n",
4645		str_supported(tp_features.wan),
4646		status);
4647
4648#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4649	if (dbg_wwanemul) {
4650		tp_features.wan = 1;
4651		pr_info("wwan switch emulation enabled\n");
4652	} else
4653#endif
4654	if (tp_features.wan &&
4655	    !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4656		/* no wan hardware present in system */
4657		tp_features.wan = 0;
4658		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4659			   "wan hardware not installed\n");
4660	}
4661
4662	if (!tp_features.wan)
4663		return -ENODEV;
4664
4665	res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4666				&wan_tprfk_ops,
4667				RFKILL_TYPE_WWAN,
4668				TPACPI_RFK_WWAN_SW_NAME,
4669				true);
4670	return res;
4671}
4672
4673/* procfs -------------------------------------------------------------- */
4674static int wan_read(struct seq_file *m)
4675{
4676	return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4677}
4678
4679static int wan_write(char *buf)
4680{
4681	return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4682}
4683
4684static struct ibm_struct wan_driver_data = {
4685	.name = "wan",
4686	.read = wan_read,
4687	.write = wan_write,
4688	.exit = wan_exit,
4689	.shutdown = wan_shutdown,
4690};
4691
4692/*************************************************************************
4693 * UWB subdriver
4694 */
4695
4696enum {
4697	/* ACPI GUWB/SUWB bits */
4698	TP_ACPI_UWB_HWPRESENT	= 0x01,	/* UWB hw available */
4699	TP_ACPI_UWB_RADIOSSW	= 0x02,	/* UWB radio enabled */
4700};
4701
4702#define TPACPI_RFK_UWB_SW_NAME	"tpacpi_uwb_sw"
4703
4704static int uwb_get_status(void)
4705{
4706	int status;
4707
4708#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4709	if (dbg_uwbemul)
4710		return (tpacpi_uwb_emulstate) ?
4711		       TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4712#endif
4713
4714	if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4715		return -EIO;
4716
4717	return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4718			TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4719}
4720
4721static int uwb_set_status(enum tpacpi_rfkill_state state)
4722{
4723	int status;
4724
4725	vdbg_printk(TPACPI_DBG_RFKILL, "will attempt to %s UWB\n",
4726		    str_enable_disable(state == TPACPI_RFK_RADIO_ON));
4727
4728#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4729	if (dbg_uwbemul) {
4730		tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4731		return 0;
4732	}
4733#endif
4734
4735	if (state == TPACPI_RFK_RADIO_ON)
4736		status = TP_ACPI_UWB_RADIOSSW;
4737	else
4738		status = 0;
4739
4740	if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4741		return -EIO;
4742
4743	return 0;
4744}
4745
4746/* --------------------------------------------------------------------- */
4747
4748static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4749	.get_status = uwb_get_status,
4750	.set_status = uwb_set_status,
4751};
4752
4753static void uwb_exit(void)
4754{
4755	tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4756}
4757
4758static int __init uwb_init(struct ibm_init_struct *iibm)
4759{
4760	int res;
4761	int status = 0;
4762
4763	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4764			"initializing uwb subdriver\n");
4765
4766	TPACPI_ACPIHANDLE_INIT(hkey);
4767
4768	tp_features.uwb = hkey_handle &&
4769	    acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4770
4771	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4772		"uwb is %s, status 0x%02x\n",
4773		str_supported(tp_features.uwb),
4774		status);
4775
4776#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4777	if (dbg_uwbemul) {
4778		tp_features.uwb = 1;
4779		pr_info("uwb switch emulation enabled\n");
4780	} else
4781#endif
4782	if (tp_features.uwb &&
4783	    !(status & TP_ACPI_UWB_HWPRESENT)) {
4784		/* no uwb hardware present in system */
4785		tp_features.uwb = 0;
4786		dbg_printk(TPACPI_DBG_INIT,
4787			   "uwb hardware not installed\n");
4788	}
4789
4790	if (!tp_features.uwb)
4791		return -ENODEV;
4792
4793	res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4794				&uwb_tprfk_ops,
4795				RFKILL_TYPE_UWB,
4796				TPACPI_RFK_UWB_SW_NAME,
4797				false);
4798	return res;
4799}
4800
4801static struct ibm_struct uwb_driver_data = {
4802	.name = "uwb",
4803	.exit = uwb_exit,
4804	.flags.experimental = 1,
4805};
4806
4807/*************************************************************************
4808 * Video subdriver
4809 */
4810
4811#ifdef CONFIG_THINKPAD_ACPI_VIDEO
4812
4813enum video_access_mode {
4814	TPACPI_VIDEO_NONE = 0,
4815	TPACPI_VIDEO_570,	/* 570 */
4816	TPACPI_VIDEO_770,	/* 600e/x, 770e, 770x */
4817	TPACPI_VIDEO_NEW,	/* all others */
4818};
4819
4820enum {	/* video status flags, based on VIDEO_570 */
4821	TP_ACPI_VIDEO_S_LCD = 0x01,	/* LCD output enabled */
4822	TP_ACPI_VIDEO_S_CRT = 0x02,	/* CRT output enabled */
4823	TP_ACPI_VIDEO_S_DVI = 0x08,	/* DVI output enabled */
4824};
4825
4826enum {  /* TPACPI_VIDEO_570 constants */
4827	TP_ACPI_VIDEO_570_PHSCMD = 0x87,	/* unknown magic constant :( */
4828	TP_ACPI_VIDEO_570_PHSMASK = 0x03,	/* PHS bits that map to
4829						 * video_status_flags */
4830	TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,	/* unknown magic constant :( */
4831	TP_ACPI_VIDEO_570_PHS2SET = 0x80,	/* unknown magic constant :( */
4832};
4833
4834static enum video_access_mode video_supported;
4835static int video_orig_autosw;
4836
4837static int video_autosw_get(void);
4838static int video_autosw_set(int enable);
4839
4840TPACPI_HANDLE(vid, root,
4841	      "\\_SB.PCI.AGP.VGA",	/* 570 */
4842	      "\\_SB.PCI0.AGP0.VID0",	/* 600e/x, 770x */
4843	      "\\_SB.PCI0.VID0",	/* 770e */
4844	      "\\_SB.PCI0.VID",		/* A21e, G4x, R50e, X30, X40 */
4845	      "\\_SB.PCI0.AGP.VGA",	/* X100e and a few others */
4846	      "\\_SB.PCI0.AGP.VID",	/* all others */
4847	);				/* R30, R31 */
4848
4849TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID");	/* G41 */
4850
4851static int __init video_init(struct ibm_init_struct *iibm)
4852{
4853	int ivga;
4854
4855	vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4856
4857	TPACPI_ACPIHANDLE_INIT(vid);
4858	if (tpacpi_is_ibm())
4859		TPACPI_ACPIHANDLE_INIT(vid2);
4860
4861	if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4862		/* G41, assume IVGA doesn't change */
4863		vid_handle = vid2_handle;
4864
4865	if (!vid_handle)
4866		/* video switching not supported on R30, R31 */
4867		video_supported = TPACPI_VIDEO_NONE;
4868	else if (tpacpi_is_ibm() &&
4869		 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4870		/* 570 */
4871		video_supported = TPACPI_VIDEO_570;
4872	else if (tpacpi_is_ibm() &&
4873		 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4874		/* 600e/x, 770e, 770x */
4875		video_supported = TPACPI_VIDEO_770;
4876	else
4877		/* all others */
4878		video_supported = TPACPI_VIDEO_NEW;
4879
4880	vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4881		str_supported(video_supported != TPACPI_VIDEO_NONE),
4882		video_supported);
4883
4884	return (video_supported != TPACPI_VIDEO_NONE) ? 0 : -ENODEV;
4885}
4886
4887static void video_exit(void)
4888{
4889	dbg_printk(TPACPI_DBG_EXIT,
4890		   "restoring original video autoswitch mode\n");
4891	if (video_autosw_set(video_orig_autosw))
4892		pr_err("error while trying to restore original video autoswitch mode\n");
4893}
4894
4895static int video_outputsw_get(void)
4896{
4897	int status = 0;
4898	int i;
4899
4900	switch (video_supported) {
4901	case TPACPI_VIDEO_570:
4902		if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4903				 TP_ACPI_VIDEO_570_PHSCMD))
4904			return -EIO;
4905		status = i & TP_ACPI_VIDEO_570_PHSMASK;
4906		break;
4907	case TPACPI_VIDEO_770:
4908		if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4909			return -EIO;
4910		if (i)
4911			status |= TP_ACPI_VIDEO_S_LCD;
4912		if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4913			return -EIO;
4914		if (i)
4915			status |= TP_ACPI_VIDEO_S_CRT;
4916		break;
4917	case TPACPI_VIDEO_NEW:
4918		if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4919		    !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4920			return -EIO;
4921		if (i)
4922			status |= TP_ACPI_VIDEO_S_CRT;
4923
4924		if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4925		    !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4926			return -EIO;
4927		if (i)
4928			status |= TP_ACPI_VIDEO_S_LCD;
4929		if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4930			return -EIO;
4931		if (i)
4932			status |= TP_ACPI_VIDEO_S_DVI;
4933		break;
4934	default:
4935		return -ENOSYS;
4936	}
4937
4938	return status;
4939}
4940
4941static int video_outputsw_set(int status)
4942{
4943	int autosw;
4944	int res = 0;
4945
4946	switch (video_supported) {
4947	case TPACPI_VIDEO_570:
4948		res = acpi_evalf(NULL, NULL,
4949				 "\\_SB.PHS2", "vdd",
4950				 TP_ACPI_VIDEO_570_PHS2CMD,
4951				 status | TP_ACPI_VIDEO_570_PHS2SET);
4952		break;
4953	case TPACPI_VIDEO_770:
4954		autosw = video_autosw_get();
4955		if (autosw < 0)
4956			return autosw;
4957
4958		res = video_autosw_set(1);
4959		if (res)
4960			return res;
4961		res = acpi_evalf(vid_handle, NULL,
4962				 "ASWT", "vdd", status * 0x100, 0);
4963		if (!autosw && video_autosw_set(autosw)) {
4964			pr_err("video auto-switch left enabled due to error\n");
4965			return -EIO;
4966		}
4967		break;
4968	case TPACPI_VIDEO_NEW:
4969		res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4970		      acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4971		break;
4972	default:
4973		return -ENOSYS;
4974	}
4975
4976	return (res) ? 0 : -EIO;
4977}
4978
4979static int video_autosw_get(void)
4980{
4981	int autosw = 0;
4982
4983	switch (video_supported) {
4984	case TPACPI_VIDEO_570:
4985		if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4986			return -EIO;
4987		break;
4988	case TPACPI_VIDEO_770:
4989	case TPACPI_VIDEO_NEW:
4990		if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4991			return -EIO;
4992		break;
4993	default:
4994		return -ENOSYS;
4995	}
4996
4997	return autosw & 1;
4998}
4999
5000static int video_autosw_set(int enable)
5001{
5002	if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable) ? 1 : 0))
5003		return -EIO;
5004	return 0;
5005}
5006
5007static int video_outputsw_cycle(void)
5008{
5009	int autosw = video_autosw_get();
5010	int res;
5011
5012	if (autosw < 0)
5013		return autosw;
5014
5015	switch (video_supported) {
5016	case TPACPI_VIDEO_570:
5017		res = video_autosw_set(1);
5018		if (res)
5019			return res;
5020		res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
5021		break;
5022	case TPACPI_VIDEO_770:
5023	case TPACPI_VIDEO_NEW:
5024		res = video_autosw_set(1);
5025		if (res)
5026			return res;
5027		res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
5028		break;
5029	default:
5030		return -ENOSYS;
5031	}
5032	if (!autosw && video_autosw_set(autosw)) {
5033		pr_err("video auto-switch left enabled due to error\n");
5034		return -EIO;
5035	}
5036
5037	return (res) ? 0 : -EIO;
5038}
5039
5040static int video_expand_toggle(void)
5041{
5042	switch (video_supported) {
5043	case TPACPI_VIDEO_570:
5044		return acpi_evalf(ec_handle, NULL, "_Q17", "v") ?
5045			0 : -EIO;
5046	case TPACPI_VIDEO_770:
5047		return acpi_evalf(vid_handle, NULL, "VEXP", "v") ?
5048			0 : -EIO;
5049	case TPACPI_VIDEO_NEW:
5050		return acpi_evalf(NULL, NULL, "\\VEXP", "v") ?
5051			0 : -EIO;
5052	default:
5053		return -ENOSYS;
5054	}
5055	/* not reached */
5056}
5057
5058static int video_read(struct seq_file *m)
5059{
5060	int status, autosw;
5061
5062	if (video_supported == TPACPI_VIDEO_NONE) {
5063		seq_printf(m, "status:\t\tnot supported\n");
5064		return 0;
5065	}
5066
5067	/* Even reads can crash X.org, so... */
5068	if (!capable(CAP_SYS_ADMIN))
5069		return -EPERM;
5070
5071	status = video_outputsw_get();
5072	if (status < 0)
5073		return status;
5074
5075	autosw = video_autosw_get();
5076	if (autosw < 0)
5077		return autosw;
5078
5079	seq_printf(m, "status:\t\tsupported\n");
5080	seq_printf(m, "lcd:\t\t%s\n", str_enabled_disabled(status & BIT(0)));
5081	seq_printf(m, "crt:\t\t%s\n", str_enabled_disabled(status & BIT(1)));
5082	if (video_supported == TPACPI_VIDEO_NEW)
5083		seq_printf(m, "dvi:\t\t%s\n", str_enabled_disabled(status & BIT(3)));
5084	seq_printf(m, "auto:\t\t%s\n", str_enabled_disabled(autosw & BIT(0)));
5085	seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
5086	seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
5087	if (video_supported == TPACPI_VIDEO_NEW)
5088		seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
5089	seq_printf(m, "commands:\tauto_enable, auto_disable\n");
5090	seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
5091
5092	return 0;
5093}
5094
5095static int video_write(char *buf)
5096{
5097	char *cmd;
5098	int enable, disable, status;
5099	int res;
5100
5101	if (video_supported == TPACPI_VIDEO_NONE)
5102		return -ENODEV;
5103
5104	/* Even reads can crash X.org, let alone writes... */
5105	if (!capable(CAP_SYS_ADMIN))
5106		return -EPERM;
5107
5108	enable = 0;
5109	disable = 0;
5110
5111	while ((cmd = strsep(&buf, ","))) {
5112		if (strstarts(cmd, "lcd_enable")) {
5113			enable |= TP_ACPI_VIDEO_S_LCD;
5114		} else if (strstarts(cmd, "lcd_disable")) {
5115			disable |= TP_ACPI_VIDEO_S_LCD;
5116		} else if (strstarts(cmd, "crt_enable")) {
5117			enable |= TP_ACPI_VIDEO_S_CRT;
5118		} else if (strstarts(cmd, "crt_disable")) {
5119			disable |= TP_ACPI_VIDEO_S_CRT;
5120		} else if (video_supported == TPACPI_VIDEO_NEW &&
5121			   strstarts(cmd, "dvi_enable")) {
5122			enable |= TP_ACPI_VIDEO_S_DVI;
5123		} else if (video_supported == TPACPI_VIDEO_NEW &&
5124			   strstarts(cmd, "dvi_disable")) {
5125			disable |= TP_ACPI_VIDEO_S_DVI;
5126		} else if (strstarts(cmd, "auto_enable")) {
5127			res = video_autosw_set(1);
5128			if (res)
5129				return res;
5130		} else if (strstarts(cmd, "auto_disable")) {
5131			res = video_autosw_set(0);
5132			if (res)
5133				return res;
5134		} else if (strstarts(cmd, "video_switch")) {
5135			res = video_outputsw_cycle();
5136			if (res)
5137				return res;
5138		} else if (strstarts(cmd, "expand_toggle")) {
5139			res = video_expand_toggle();
5140			if (res)
5141				return res;
5142		} else
5143			return -EINVAL;
5144	}
5145
5146	if (enable || disable) {
5147		status = video_outputsw_get();
5148		if (status < 0)
5149			return status;
5150		res = video_outputsw_set((status & ~disable) | enable);
5151		if (res)
5152			return res;
5153	}
5154
5155	return 0;
5156}
5157
5158static struct ibm_struct video_driver_data = {
5159	.name = "video",
5160	.read = video_read,
5161	.write = video_write,
5162	.exit = video_exit,
5163};
5164
5165#endif /* CONFIG_THINKPAD_ACPI_VIDEO */
5166
5167/*************************************************************************
5168 * Keyboard backlight subdriver
5169 */
5170
5171static enum led_brightness kbdlight_brightness;
5172static DEFINE_MUTEX(kbdlight_mutex);
5173
5174static int kbdlight_set_level(int level)
5175{
5176	int ret = 0;
5177
5178	if (!hkey_handle)
5179		return -ENXIO;
5180
5181	mutex_lock(&kbdlight_mutex);
5182
5183	if (!acpi_evalf(hkey_handle, NULL, "MLCS", "dd", level))
5184		ret = -EIO;
5185	else
5186		kbdlight_brightness = level;
5187
5188	mutex_unlock(&kbdlight_mutex);
5189
5190	return ret;
5191}
5192
5193static int kbdlight_get_level(void)
5194{
5195	int status = 0;
5196
5197	if (!hkey_handle)
5198		return -ENXIO;
5199
5200	if (!acpi_evalf(hkey_handle, &status, "MLCG", "dd", 0))
5201		return -EIO;
5202
5203	if (status < 0)
5204		return status;
5205
5206	return status & 0x3;
5207}
5208
5209static bool kbdlight_is_supported(void)
5210{
5211	int status = 0;
5212
5213	if (!hkey_handle)
5214		return false;
5215
5216	if (!acpi_has_method(hkey_handle, "MLCG")) {
5217		vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG is unavailable\n");
5218		return false;
5219	}
5220
5221	if (!acpi_evalf(hkey_handle, &status, "MLCG", "qdd", 0)) {
5222		vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG failed\n");
5223		return false;
5224	}
5225
5226	if (status < 0) {
5227		vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG err: %d\n", status);
5228		return false;
5229	}
5230
5231	vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG returned 0x%x\n", status);
5232	/*
5233	 * Guessed test for keyboard backlight:
5234	 *
5235	 * Machines with backlight keyboard return:
5236	 *   b010100000010000000XX - ThinkPad X1 Carbon 3rd
5237	 *   b110100010010000000XX - ThinkPad x230
5238	 *   b010100000010000000XX - ThinkPad x240
5239	 *   b010100000010000000XX - ThinkPad W541
5240	 * (XX is current backlight level)
5241	 *
5242	 * Machines without backlight keyboard return:
5243	 *   b10100001000000000000 - ThinkPad x230
5244	 *   b10110001000000000000 - ThinkPad E430
5245	 *   b00000000000000000000 - ThinkPad E450
5246	 *
5247	 * Candidate BITs for detection test (XOR):
5248	 *   b01000000001000000000
5249	 *              ^
5250	 */
5251	return status & BIT(9);
5252}
5253
5254static int kbdlight_sysfs_set(struct led_classdev *led_cdev,
5255			enum led_brightness brightness)
5256{
5257	return kbdlight_set_level(brightness);
5258}
5259
5260static enum led_brightness kbdlight_sysfs_get(struct led_classdev *led_cdev)
5261{
5262	int level;
5263
5264	level = kbdlight_get_level();
5265	if (level < 0)
5266		return 0;
5267
5268	return level;
5269}
5270
5271static struct tpacpi_led_classdev tpacpi_led_kbdlight = {
5272	.led_classdev = {
5273		.name		= "tpacpi::kbd_backlight",
5274		.max_brightness	= 2,
5275		.flags		= LED_BRIGHT_HW_CHANGED,
5276		.brightness_set_blocking = &kbdlight_sysfs_set,
5277		.brightness_get	= &kbdlight_sysfs_get,
5278	}
5279};
5280
5281static int __init kbdlight_init(struct ibm_init_struct *iibm)
5282{
5283	int rc;
5284
5285	vdbg_printk(TPACPI_DBG_INIT, "initializing kbdlight subdriver\n");
5286
5287	TPACPI_ACPIHANDLE_INIT(hkey);
5288
5289	if (!kbdlight_is_supported()) {
5290		tp_features.kbdlight = 0;
5291		vdbg_printk(TPACPI_DBG_INIT, "kbdlight is unsupported\n");
5292		return -ENODEV;
5293	}
5294
5295	kbdlight_brightness = kbdlight_sysfs_get(NULL);
5296	tp_features.kbdlight = 1;
5297
5298	rc = led_classdev_register(&tpacpi_pdev->dev,
5299				   &tpacpi_led_kbdlight.led_classdev);
5300	if (rc < 0) {
5301		tp_features.kbdlight = 0;
5302		return rc;
5303	}
5304
5305	tpacpi_hotkey_driver_mask_set(hotkey_driver_mask |
5306				      TP_ACPI_HKEY_KBD_LIGHT_MASK);
5307	return 0;
5308}
5309
5310static void kbdlight_exit(void)
5311{
5312	led_classdev_unregister(&tpacpi_led_kbdlight.led_classdev);
5313}
5314
5315static int kbdlight_set_level_and_update(int level)
5316{
5317	int ret;
5318	struct led_classdev *led_cdev;
5319
5320	ret = kbdlight_set_level(level);
5321	led_cdev = &tpacpi_led_kbdlight.led_classdev;
5322
5323	if (ret == 0 && !(led_cdev->flags & LED_SUSPENDED))
5324		led_cdev->brightness = level;
5325
5326	return ret;
5327}
5328
5329static int kbdlight_read(struct seq_file *m)
5330{
5331	int level;
5332
5333	if (!tp_features.kbdlight) {
5334		seq_printf(m, "status:\t\tnot supported\n");
5335	} else {
5336		level = kbdlight_get_level();
5337		if (level < 0)
5338			seq_printf(m, "status:\t\terror %d\n", level);
5339		else
5340			seq_printf(m, "status:\t\t%d\n", level);
5341		seq_printf(m, "commands:\t0, 1, 2\n");
5342	}
5343
5344	return 0;
5345}
5346
5347static int kbdlight_write(char *buf)
5348{
5349	char *cmd;
5350	int res, level = -EINVAL;
5351
5352	if (!tp_features.kbdlight)
5353		return -ENODEV;
5354
5355	while ((cmd = strsep(&buf, ","))) {
5356		res = kstrtoint(cmd, 10, &level);
5357		if (res < 0)
5358			return res;
5359	}
5360
5361	if (level >= 3 || level < 0)
5362		return -EINVAL;
5363
5364	return kbdlight_set_level_and_update(level);
5365}
5366
5367static void kbdlight_suspend(void)
5368{
5369	struct led_classdev *led_cdev;
5370
5371	if (!tp_features.kbdlight)
5372		return;
5373
5374	led_cdev = &tpacpi_led_kbdlight.led_classdev;
5375	led_update_brightness(led_cdev);
5376	led_classdev_suspend(led_cdev);
5377}
5378
5379static void kbdlight_resume(void)
5380{
5381	if (!tp_features.kbdlight)
5382		return;
5383
5384	led_classdev_resume(&tpacpi_led_kbdlight.led_classdev);
5385}
5386
5387static struct ibm_struct kbdlight_driver_data = {
5388	.name = "kbdlight",
5389	.read = kbdlight_read,
5390	.write = kbdlight_write,
5391	.suspend = kbdlight_suspend,
5392	.resume = kbdlight_resume,
5393	.exit = kbdlight_exit,
5394};
5395
5396/*************************************************************************
5397 * Light (thinklight) subdriver
5398 */
5399
5400TPACPI_HANDLE(lght, root, "\\LGHT");	/* A21e, A2xm/p, T20-22, X20-21 */
5401TPACPI_HANDLE(ledb, ec, "LEDB");		/* G4x */
5402
5403static int light_get_status(void)
5404{
5405	int status = 0;
5406
5407	if (tp_features.light_status) {
5408		if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
5409			return -EIO;
5410		return (!!status);
5411	}
5412
5413	return -ENXIO;
5414}
5415
5416static int light_set_status(int status)
5417{
5418	int rc;
5419
5420	if (tp_features.light) {
5421		if (cmos_handle) {
5422			rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
5423					(status) ?
5424						TP_CMOS_THINKLIGHT_ON :
5425						TP_CMOS_THINKLIGHT_OFF);
5426		} else {
5427			rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
5428					(status) ? 1 : 0);
5429		}
5430		return (rc) ? 0 : -EIO;
5431	}
5432
5433	return -ENXIO;
5434}
5435
5436static int light_sysfs_set(struct led_classdev *led_cdev,
5437			enum led_brightness brightness)
5438{
5439	return light_set_status((brightness != LED_OFF) ?
5440				TPACPI_LED_ON : TPACPI_LED_OFF);
5441}
5442
5443static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
5444{
5445	return (light_get_status() == 1) ? LED_ON : LED_OFF;
5446}
5447
5448static struct tpacpi_led_classdev tpacpi_led_thinklight = {
5449	.led_classdev = {
5450		.name		= "tpacpi::thinklight",
5451		.max_brightness	= 1,
5452		.brightness_set_blocking = &light_sysfs_set,
5453		.brightness_get	= &light_sysfs_get,
5454	}
5455};
5456
5457static int __init light_init(struct ibm_init_struct *iibm)
5458{
5459	int rc;
5460
5461	vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
5462
5463	if (tpacpi_is_ibm()) {
5464		TPACPI_ACPIHANDLE_INIT(ledb);
5465		TPACPI_ACPIHANDLE_INIT(lght);
5466	}
5467	TPACPI_ACPIHANDLE_INIT(cmos);
5468
5469	/* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
5470	tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
5471
5472	if (tp_features.light)
5473		/* light status not supported on
5474		   570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
5475		tp_features.light_status =
5476			acpi_evalf(ec_handle, NULL, "KBLT", "qv");
5477
5478	vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
5479		str_supported(tp_features.light),
5480		str_supported(tp_features.light_status));
5481
5482	if (!tp_features.light)
5483		return -ENODEV;
5484
5485	rc = led_classdev_register(&tpacpi_pdev->dev,
5486				   &tpacpi_led_thinklight.led_classdev);
5487
5488	if (rc < 0) {
5489		tp_features.light = 0;
5490		tp_features.light_status = 0;
5491	} else  {
5492		rc = 0;
5493	}
5494
5495	return rc;
5496}
5497
5498static void light_exit(void)
5499{
5500	led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
5501}
5502
5503static int light_read(struct seq_file *m)
5504{
5505	int status;
5506
5507	if (!tp_features.light) {
5508		seq_printf(m, "status:\t\tnot supported\n");
5509	} else if (!tp_features.light_status) {
5510		seq_printf(m, "status:\t\tunknown\n");
5511		seq_printf(m, "commands:\ton, off\n");
5512	} else {
5513		status = light_get_status();
5514		if (status < 0)
5515			return status;
5516		seq_printf(m, "status:\t\t%s\n", str_on_off(status & BIT(0)));
5517		seq_printf(m, "commands:\ton, off\n");
5518	}
5519
5520	return 0;
5521}
5522
5523static int light_write(char *buf)
5524{
5525	char *cmd;
5526	int newstatus = 0;
5527
5528	if (!tp_features.light)
5529		return -ENODEV;
5530
5531	while ((cmd = strsep(&buf, ","))) {
5532		if (strstarts(cmd, "on")) {
5533			newstatus = 1;
5534		} else if (strstarts(cmd, "off")) {
5535			newstatus = 0;
5536		} else
5537			return -EINVAL;
5538	}
5539
5540	return light_set_status(newstatus);
5541}
5542
5543static struct ibm_struct light_driver_data = {
5544	.name = "light",
5545	.read = light_read,
5546	.write = light_write,
5547	.exit = light_exit,
5548};
5549
5550/*************************************************************************
5551 * CMOS subdriver
5552 */
5553
5554/* sysfs cmos_command -------------------------------------------------- */
5555static ssize_t cmos_command_store(struct device *dev,
5556			    struct device_attribute *attr,
5557			    const char *buf, size_t count)
5558{
5559	unsigned long cmos_cmd;
5560	int res;
5561
5562	if (parse_strtoul(buf, 21, &cmos_cmd))
5563		return -EINVAL;
5564
5565	res = issue_thinkpad_cmos_command(cmos_cmd);
5566	return (res) ? res : count;
5567}
5568
5569static DEVICE_ATTR_WO(cmos_command);
5570
5571static struct attribute *cmos_attributes[] = {
5572	&dev_attr_cmos_command.attr,
5573	NULL
5574};
5575
5576static umode_t cmos_attr_is_visible(struct kobject *kobj,
5577				    struct attribute *attr, int n)
5578{
5579	return cmos_handle ? attr->mode : 0;
5580}
5581
5582static const struct attribute_group cmos_attr_group = {
5583	.is_visible = cmos_attr_is_visible,
5584	.attrs = cmos_attributes,
5585};
5586
5587/* --------------------------------------------------------------------- */
5588
5589static int __init cmos_init(struct ibm_init_struct *iibm)
5590{
5591	vdbg_printk(TPACPI_DBG_INIT,
5592		    "initializing cmos commands subdriver\n");
5593
5594	TPACPI_ACPIHANDLE_INIT(cmos);
5595
5596	vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5597		    str_supported(cmos_handle != NULL));
5598
5599	return cmos_handle ? 0 : -ENODEV;
5600}
5601
5602static int cmos_read(struct seq_file *m)
5603{
5604	/* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5605	   R30, R31, T20-22, X20-21 */
5606	if (!cmos_handle)
5607		seq_printf(m, "status:\t\tnot supported\n");
5608	else {
5609		seq_printf(m, "status:\t\tsupported\n");
5610		seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5611	}
5612
5613	return 0;
5614}
5615
5616static int cmos_write(char *buf)
5617{
5618	char *cmd;
5619	int cmos_cmd, res;
5620
5621	while ((cmd = strsep(&buf, ","))) {
5622		if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5623		    cmos_cmd >= 0 && cmos_cmd <= 21) {
5624			/* cmos_cmd set */
5625		} else
5626			return -EINVAL;
5627
5628		res = issue_thinkpad_cmos_command(cmos_cmd);
5629		if (res)
5630			return res;
5631	}
5632
5633	return 0;
5634}
5635
5636static struct ibm_struct cmos_driver_data = {
5637	.name = "cmos",
5638	.read = cmos_read,
5639	.write = cmos_write,
5640};
5641
5642/*************************************************************************
5643 * LED subdriver
5644 */
5645
5646enum led_access_mode {
5647	TPACPI_LED_NONE = 0,
5648	TPACPI_LED_570,	/* 570 */
5649	TPACPI_LED_OLD,	/* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5650	TPACPI_LED_NEW,	/* all others */
5651};
5652
5653enum {	/* For TPACPI_LED_OLD */
5654	TPACPI_LED_EC_HLCL = 0x0c,	/* EC reg to get led to power on */
5655	TPACPI_LED_EC_HLBL = 0x0d,	/* EC reg to blink a lit led */
5656	TPACPI_LED_EC_HLMS = 0x0e,	/* EC reg to select led to command */
5657};
5658
5659static enum led_access_mode led_supported;
5660
5661static acpi_handle led_handle;
5662
5663#define TPACPI_LED_NUMLEDS 16
5664static struct tpacpi_led_classdev *tpacpi_leds;
5665static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5666static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5667	/* there's a limit of 19 chars + NULL before 2.6.26 */
5668	"tpacpi::power",
5669	"tpacpi:orange:batt",
5670	"tpacpi:green:batt",
5671	"tpacpi::dock_active",
5672	"tpacpi::bay_active",
5673	"tpacpi::dock_batt",
5674	"tpacpi::unknown_led",
5675	"tpacpi::standby",
5676	"tpacpi::dock_status1",
5677	"tpacpi::dock_status2",
5678	"tpacpi::lid_logo_dot",
5679	"tpacpi::unknown_led3",
5680	"tpacpi::thinkvantage",
5681};
5682#define TPACPI_SAFE_LEDS	0x1481U
5683
5684static inline bool tpacpi_is_led_restricted(const unsigned int led)
5685{
5686#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5687	return false;
5688#else
5689	return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5690#endif
5691}
5692
5693static int led_get_status(const unsigned int led)
5694{
5695	int status;
5696	enum led_status_t led_s;
5697
5698	switch (led_supported) {
5699	case TPACPI_LED_570:
5700		if (!acpi_evalf(ec_handle,
5701				&status, "GLED", "dd", 1 << led))
5702			return -EIO;
5703		led_s = (status == 0) ?
5704				TPACPI_LED_OFF :
5705				((status == 1) ?
5706					TPACPI_LED_ON :
5707					TPACPI_LED_BLINK);
5708		tpacpi_led_state_cache[led] = led_s;
5709		return led_s;
5710	default:
5711		return -ENXIO;
5712	}
5713
5714	/* not reached */
5715}
5716
5717static int led_set_status(const unsigned int led,
5718			  const enum led_status_t ledstatus)
5719{
5720	/* off, on, blink. Index is led_status_t */
5721	static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5722	static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5723
5724	int rc = 0;
5725
5726	switch (led_supported) {
5727	case TPACPI_LED_570:
5728		/* 570 */
5729		if (unlikely(led > 7))
5730			return -EINVAL;
5731		if (unlikely(tpacpi_is_led_restricted(led)))
5732			return -EPERM;
5733		if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5734				(1 << led), led_sled_arg1[ledstatus]))
5735			return -EIO;
5736		break;
5737	case TPACPI_LED_OLD:
5738		/* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5739		if (unlikely(led > 7))
5740			return -EINVAL;
5741		if (unlikely(tpacpi_is_led_restricted(led)))
5742			return -EPERM;
5743		rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5744		if (rc >= 0)
5745			rc = ec_write(TPACPI_LED_EC_HLBL,
5746				      (ledstatus == TPACPI_LED_BLINK) << led);
5747		if (rc >= 0)
5748			rc = ec_write(TPACPI_LED_EC_HLCL,
5749				      (ledstatus != TPACPI_LED_OFF) << led);
5750		break;
5751	case TPACPI_LED_NEW:
5752		/* all others */
5753		if (unlikely(led >= TPACPI_LED_NUMLEDS))
5754			return -EINVAL;
5755		if (unlikely(tpacpi_is_led_restricted(led)))
5756			return -EPERM;
5757		if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5758				led, led_led_arg1[ledstatus]))
5759			return -EIO;
5760		break;
5761	default:
5762		return -ENXIO;
5763	}
5764
5765	if (!rc)
5766		tpacpi_led_state_cache[led] = ledstatus;
5767
5768	return rc;
5769}
5770
5771static int led_sysfs_set(struct led_classdev *led_cdev,
5772			enum led_brightness brightness)
5773{
5774	struct tpacpi_led_classdev *data = container_of(led_cdev,
5775			     struct tpacpi_led_classdev, led_classdev);
5776	enum led_status_t new_state;
5777
5778	if (brightness == LED_OFF)
5779		new_state = TPACPI_LED_OFF;
5780	else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5781		new_state = TPACPI_LED_ON;
5782	else
5783		new_state = TPACPI_LED_BLINK;
5784
5785	return led_set_status(data->led, new_state);
5786}
5787
5788static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5789			unsigned long *delay_on, unsigned long *delay_off)
5790{
5791	struct tpacpi_led_classdev *data = container_of(led_cdev,
5792			     struct tpacpi_led_classdev, led_classdev);
5793
5794	/* Can we choose the flash rate? */
5795	if (*delay_on == 0 && *delay_off == 0) {
5796		/* yes. set them to the hardware blink rate (1 Hz) */
5797		*delay_on = 500; /* ms */
5798		*delay_off = 500; /* ms */
5799	} else if ((*delay_on != 500) || (*delay_off != 500))
5800		return -EINVAL;
5801
5802	return led_set_status(data->led, TPACPI_LED_BLINK);
5803}
5804
5805static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5806{
5807	int rc;
5808
5809	struct tpacpi_led_classdev *data = container_of(led_cdev,
5810			     struct tpacpi_led_classdev, led_classdev);
5811
5812	rc = led_get_status(data->led);
5813
5814	if (rc == TPACPI_LED_OFF || rc < 0)
5815		rc = LED_OFF;	/* no error handling in led class :( */
5816	else
5817		rc = LED_FULL;
5818
5819	return rc;
5820}
5821
5822static void led_exit(void)
5823{
5824	unsigned int i;
5825
5826	for (i = 0; i < TPACPI_LED_NUMLEDS; i++)
5827		led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5828
5829	kfree(tpacpi_leds);
5830}
5831
5832static int __init tpacpi_init_led(unsigned int led)
5833{
5834	/* LEDs with no name don't get registered */
5835	if (!tpacpi_led_names[led])
5836		return 0;
5837
5838	tpacpi_leds[led].led_classdev.brightness_set_blocking = &led_sysfs_set;
5839	tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5840	if (led_supported == TPACPI_LED_570)
5841		tpacpi_leds[led].led_classdev.brightness_get = &led_sysfs_get;
5842
5843	tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5844	tpacpi_leds[led].led_classdev.flags = LED_RETAIN_AT_SHUTDOWN;
5845	tpacpi_leds[led].led = led;
5846
5847	return led_classdev_register(&tpacpi_pdev->dev, &tpacpi_leds[led].led_classdev);
5848}
5849
5850static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5851	TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5852	TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5853	TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5854
5855	TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5856	TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5857	TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5858	TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5859	TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5860	TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5861	TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5862	TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5863
5864	TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5865	TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5866	TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5867	TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5868	TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5869
5870	TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5871	TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5872	TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5873	TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5874
5875	/* (1) - may have excess leds enabled on MSB */
5876
5877	/* Defaults (order matters, keep last, don't reorder!) */
5878	{ /* Lenovo */
5879	  .vendor = PCI_VENDOR_ID_LENOVO,
5880	  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5881	  .quirks = 0x1fffU,
5882	},
5883	{ /* IBM ThinkPads with no EC version string */
5884	  .vendor = PCI_VENDOR_ID_IBM,
5885	  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5886	  .quirks = 0x00ffU,
5887	},
5888	{ /* IBM ThinkPads with EC version string */
5889	  .vendor = PCI_VENDOR_ID_IBM,
5890	  .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5891	  .quirks = 0x00bfU,
5892	},
5893};
5894
5895static enum led_access_mode __init led_init_detect_mode(void)
5896{
5897	acpi_status status;
5898
5899	if (tpacpi_is_ibm()) {
5900		/* 570 */
5901		status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5902		if (ACPI_SUCCESS(status))
5903			return TPACPI_LED_570;
5904
5905		/* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5906		status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5907		if (ACPI_SUCCESS(status))
5908			return TPACPI_LED_OLD;
5909	}
5910
5911	/* most others */
5912	status = acpi_get_handle(ec_handle, "LED", &led_handle);
5913	if (ACPI_SUCCESS(status))
5914		return TPACPI_LED_NEW;
5915
5916	/* R30, R31, and unknown firmwares */
5917	led_handle = NULL;
5918	return TPACPI_LED_NONE;
5919}
5920
5921static int __init led_init(struct ibm_init_struct *iibm)
5922{
5923	unsigned int i;
5924	int rc;
5925	unsigned long useful_leds;
5926
5927	vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5928
5929	led_supported = led_init_detect_mode();
5930
5931	if (led_supported != TPACPI_LED_NONE) {
5932		useful_leds = tpacpi_check_quirks(led_useful_qtable,
5933				ARRAY_SIZE(led_useful_qtable));
5934
5935		if (!useful_leds) {
5936			led_handle = NULL;
5937			led_supported = TPACPI_LED_NONE;
5938		}
5939	}
5940
5941	vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5942		str_supported(led_supported), led_supported);
5943
5944	if (led_supported == TPACPI_LED_NONE)
5945		return -ENODEV;
5946
5947	tpacpi_leds = kcalloc(TPACPI_LED_NUMLEDS, sizeof(*tpacpi_leds),
5948			      GFP_KERNEL);
5949	if (!tpacpi_leds) {
5950		pr_err("Out of memory for LED data\n");
5951		return -ENOMEM;
5952	}
5953
5954	for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5955		tpacpi_leds[i].led = -1;
5956
5957		if (!tpacpi_is_led_restricted(i) && test_bit(i, &useful_leds)) {
5958			rc = tpacpi_init_led(i);
5959			if (rc < 0) {
5960				led_exit();
5961				return rc;
5962			}
5963		}
5964	}
5965
5966#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5967	pr_notice("warning: userspace override of important firmware LEDs is enabled\n");
5968#endif
5969	return 0;
5970}
5971
5972#define str_led_status(s)	((s) >= TPACPI_LED_BLINK ? "blinking" : str_on_off(s))
5973
5974static int led_read(struct seq_file *m)
5975{
5976	if (!led_supported) {
5977		seq_printf(m, "status:\t\tnot supported\n");
5978		return 0;
5979	}
5980	seq_printf(m, "status:\t\tsupported\n");
5981
5982	if (led_supported == TPACPI_LED_570) {
5983		/* 570 */
5984		int i, status;
5985		for (i = 0; i < 8; i++) {
5986			status = led_get_status(i);
5987			if (status < 0)
5988				return -EIO;
5989			seq_printf(m, "%d:\t\t%s\n", i, str_led_status(status));
5990		}
5991	}
5992
5993	seq_printf(m, "commands:\t<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5994
5995	return 0;
5996}
5997
5998static int led_write(char *buf)
5999{
6000	char *cmd;
6001	int led, rc;
6002	enum led_status_t s;
6003
6004	if (!led_supported)
6005		return -ENODEV;
6006
6007	while ((cmd = strsep(&buf, ","))) {
6008		if (sscanf(cmd, "%d", &led) != 1)
6009			return -EINVAL;
6010
6011		if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1))
6012			return -ENODEV;
6013
6014		if (tpacpi_leds[led].led < 0)
6015			return -ENODEV;
6016
6017		if (strstr(cmd, "off")) {
6018			s = TPACPI_LED_OFF;
6019		} else if (strstr(cmd, "on")) {
6020			s = TPACPI_LED_ON;
6021		} else if (strstr(cmd, "blink")) {
6022			s = TPACPI_LED_BLINK;
6023		} else {
6024			return -EINVAL;
6025		}
6026
6027		rc = led_set_status(led, s);
6028		if (rc < 0)
6029			return rc;
6030	}
6031
6032	return 0;
6033}
6034
6035static struct ibm_struct led_driver_data = {
6036	.name = "led",
6037	.read = led_read,
6038	.write = led_write,
6039	.exit = led_exit,
6040};
6041
6042/*************************************************************************
6043 * Beep subdriver
6044 */
6045
6046TPACPI_HANDLE(beep, ec, "BEEP");	/* all except R30, R31 */
6047
6048#define TPACPI_BEEP_Q1 0x0001
6049
6050static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
6051	TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
6052	TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
6053};
6054
6055static int __init beep_init(struct ibm_init_struct *iibm)
6056{
6057	unsigned long quirks;
6058
6059	vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
6060
6061	TPACPI_ACPIHANDLE_INIT(beep);
6062
6063	vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
6064		str_supported(beep_handle != NULL));
6065
6066	quirks = tpacpi_check_quirks(beep_quirk_table,
6067				     ARRAY_SIZE(beep_quirk_table));
6068
6069	tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
6070
6071	return (beep_handle) ? 0 : -ENODEV;
6072}
6073
6074static int beep_read(struct seq_file *m)
6075{
6076	if (!beep_handle)
6077		seq_printf(m, "status:\t\tnot supported\n");
6078	else {
6079		seq_printf(m, "status:\t\tsupported\n");
6080		seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
6081	}
6082
6083	return 0;
6084}
6085
6086static int beep_write(char *buf)
6087{
6088	char *cmd;
6089	int beep_cmd;
6090
6091	if (!beep_handle)
6092		return -ENODEV;
6093
6094	while ((cmd = strsep(&buf, ","))) {
6095		if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
6096		    beep_cmd >= 0 && beep_cmd <= 17) {
6097			/* beep_cmd set */
6098		} else
6099			return -EINVAL;
6100		if (tp_features.beep_needs_two_args) {
6101			if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
6102					beep_cmd, 0))
6103				return -EIO;
6104		} else {
6105			if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
6106					beep_cmd))
6107				return -EIO;
6108		}
6109	}
6110
6111	return 0;
6112}
6113
6114static struct ibm_struct beep_driver_data = {
6115	.name = "beep",
6116	.read = beep_read,
6117	.write = beep_write,
6118};
6119
6120/*************************************************************************
6121 * Thermal subdriver
6122 */
6123
6124enum thermal_access_mode {
6125	TPACPI_THERMAL_NONE = 0,	/* No thermal support */
6126	TPACPI_THERMAL_ACPI_TMP07,	/* Use ACPI TMP0-7 */
6127	TPACPI_THERMAL_ACPI_UPDT,	/* Use ACPI TMP0-7 with UPDT */
6128	TPACPI_THERMAL_TPEC_8,		/* Use ACPI EC regs, 8 sensors */
6129	TPACPI_THERMAL_TPEC_16,		/* Use ACPI EC regs, 16 sensors */
6130};
6131
6132enum { /* TPACPI_THERMAL_TPEC_* */
6133	TP_EC_THERMAL_TMP0 = 0x78,	/* ACPI EC regs TMP 0..7 */
6134	TP_EC_THERMAL_TMP8 = 0xC0,	/* ACPI EC regs TMP 8..15 */
6135	TP_EC_FUNCREV      = 0xEF,      /* ACPI EC Functional revision */
6136	TP_EC_THERMAL_TMP_NA = -128,	/* ACPI EC sensor not available */
6137
6138	TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
6139};
6140
6141
6142#define TPACPI_MAX_THERMAL_SENSORS 16	/* Max thermal sensors supported */
6143struct ibm_thermal_sensors_struct {
6144	s32 temp[TPACPI_MAX_THERMAL_SENSORS];
6145};
6146
6147static enum thermal_access_mode thermal_read_mode;
6148static bool thermal_use_labels;
6149
6150/* idx is zero-based */
6151static int thermal_get_sensor(int idx, s32 *value)
6152{
6153	int t;
6154	s8 tmp;
6155	char tmpi[5];
6156
6157	t = TP_EC_THERMAL_TMP0;
6158
6159	switch (thermal_read_mode) {
6160#if TPACPI_MAX_THERMAL_SENSORS >= 16
6161	case TPACPI_THERMAL_TPEC_16:
6162		if (idx >= 8 && idx <= 15) {
6163			t = TP_EC_THERMAL_TMP8;
6164			idx -= 8;
6165		}
6166#endif
6167		fallthrough;
6168	case TPACPI_THERMAL_TPEC_8:
6169		if (idx <= 7) {
6170			if (!acpi_ec_read(t + idx, &tmp))
6171				return -EIO;
6172			*value = tmp * 1000;
6173			return 0;
6174		}
6175		break;
6176
6177	case TPACPI_THERMAL_ACPI_UPDT:
6178		if (idx <= 7) {
6179			snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6180			if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
6181				return -EIO;
6182			if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6183				return -EIO;
6184			*value = (t - 2732) * 100;
6185			return 0;
6186		}
6187		break;
6188
6189	case TPACPI_THERMAL_ACPI_TMP07:
6190		if (idx <= 7) {
6191			snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6192			if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6193				return -EIO;
6194			if (t > 127 || t < -127)
6195				t = TP_EC_THERMAL_TMP_NA;
6196			*value = t * 1000;
6197			return 0;
6198		}
6199		break;
6200
6201	case TPACPI_THERMAL_NONE:
6202	default:
6203		return -ENOSYS;
6204	}
6205
6206	return -EINVAL;
6207}
6208
6209static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
6210{
6211	int res, i;
6212	int n;
6213
6214	n = 8;
6215	i = 0;
6216
6217	if (!s)
6218		return -EINVAL;
6219
6220	if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
6221		n = 16;
6222
6223	for (i = 0 ; i < n; i++) {
6224		res = thermal_get_sensor(i, &s->temp[i]);
6225		if (res)
6226			return res;
6227	}
6228
6229	return n;
6230}
6231
6232static void thermal_dump_all_sensors(void)
6233{
6234	int n, i;
6235	struct ibm_thermal_sensors_struct t;
6236
6237	n = thermal_get_sensors(&t);
6238	if (n <= 0)
6239		return;
6240
6241	pr_notice("temperatures (Celsius):");
6242
6243	for (i = 0; i < n; i++) {
6244		if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
6245			pr_cont(" %d", (int)(t.temp[i] / 1000));
6246		else
6247			pr_cont(" N/A");
6248	}
6249
6250	pr_cont("\n");
6251}
6252
6253/* sysfs temp##_input -------------------------------------------------- */
6254
6255static ssize_t thermal_temp_input_show(struct device *dev,
6256			   struct device_attribute *attr,
6257			   char *buf)
6258{
6259	struct sensor_device_attribute *sensor_attr =
6260					to_sensor_dev_attr(attr);
6261	int idx = sensor_attr->index;
6262	s32 value;
6263	int res;
6264
6265	res = thermal_get_sensor(idx, &value);
6266	if (res)
6267		return res;
6268	if (value == TPACPI_THERMAL_SENSOR_NA)
6269		return -ENXIO;
6270
6271	return sysfs_emit(buf, "%d\n", value);
6272}
6273
6274#define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
6275	 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
6276		     thermal_temp_input_show, NULL, _idxB)
6277
6278static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
6279	THERMAL_SENSOR_ATTR_TEMP(1, 0),
6280	THERMAL_SENSOR_ATTR_TEMP(2, 1),
6281	THERMAL_SENSOR_ATTR_TEMP(3, 2),
6282	THERMAL_SENSOR_ATTR_TEMP(4, 3),
6283	THERMAL_SENSOR_ATTR_TEMP(5, 4),
6284	THERMAL_SENSOR_ATTR_TEMP(6, 5),
6285	THERMAL_SENSOR_ATTR_TEMP(7, 6),
6286	THERMAL_SENSOR_ATTR_TEMP(8, 7),
6287	THERMAL_SENSOR_ATTR_TEMP(9, 8),
6288	THERMAL_SENSOR_ATTR_TEMP(10, 9),
6289	THERMAL_SENSOR_ATTR_TEMP(11, 10),
6290	THERMAL_SENSOR_ATTR_TEMP(12, 11),
6291	THERMAL_SENSOR_ATTR_TEMP(13, 12),
6292	THERMAL_SENSOR_ATTR_TEMP(14, 13),
6293	THERMAL_SENSOR_ATTR_TEMP(15, 14),
6294	THERMAL_SENSOR_ATTR_TEMP(16, 15),
6295};
6296
6297#define THERMAL_ATTRS(X) \
6298	&sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
6299
6300static struct attribute *thermal_temp_input_attr[] = {
6301	THERMAL_ATTRS(0),
6302	THERMAL_ATTRS(1),
6303	THERMAL_ATTRS(2),
6304	THERMAL_ATTRS(3),
6305	THERMAL_ATTRS(4),
6306	THERMAL_ATTRS(5),
6307	THERMAL_ATTRS(6),
6308	THERMAL_ATTRS(7),
6309	THERMAL_ATTRS(8),
6310	THERMAL_ATTRS(9),
6311	THERMAL_ATTRS(10),
6312	THERMAL_ATTRS(11),
6313	THERMAL_ATTRS(12),
6314	THERMAL_ATTRS(13),
6315	THERMAL_ATTRS(14),
6316	THERMAL_ATTRS(15),
6317	NULL
6318};
6319
6320static umode_t thermal_attr_is_visible(struct kobject *kobj,
6321				       struct attribute *attr, int n)
6322{
6323	if (thermal_read_mode == TPACPI_THERMAL_NONE)
6324		return 0;
6325
6326	if (attr == THERMAL_ATTRS(8) || attr == THERMAL_ATTRS(9) ||
6327	    attr == THERMAL_ATTRS(10) || attr == THERMAL_ATTRS(11) ||
6328	    attr == THERMAL_ATTRS(12) || attr == THERMAL_ATTRS(13) ||
6329	    attr == THERMAL_ATTRS(14) || attr == THERMAL_ATTRS(15)) {
6330		if (thermal_read_mode != TPACPI_THERMAL_TPEC_16)
6331			return 0;
6332	}
6333
6334	return attr->mode;
6335}
6336
6337static const struct attribute_group thermal_attr_group = {
6338	.is_visible = thermal_attr_is_visible,
6339	.attrs = thermal_temp_input_attr,
6340};
6341
6342#undef THERMAL_SENSOR_ATTR_TEMP
6343#undef THERMAL_ATTRS
6344
6345static ssize_t temp1_label_show(struct device *dev, struct device_attribute *attr, char *buf)
6346{
6347	return sysfs_emit(buf, "CPU\n");
6348}
6349static DEVICE_ATTR_RO(temp1_label);
6350
6351static ssize_t temp2_label_show(struct device *dev, struct device_attribute *attr, char *buf)
6352{
6353	return sysfs_emit(buf, "GPU\n");
6354}
6355static DEVICE_ATTR_RO(temp2_label);
6356
6357static struct attribute *temp_label_attributes[] = {
6358	&dev_attr_temp1_label.attr,
6359	&dev_attr_temp2_label.attr,
6360	NULL
6361};
6362
6363static umode_t temp_label_attr_is_visible(struct kobject *kobj,
6364					  struct attribute *attr, int n)
6365{
6366	return thermal_use_labels ? attr->mode : 0;
6367}
6368
6369static const struct attribute_group temp_label_attr_group = {
6370	.is_visible = temp_label_attr_is_visible,
6371	.attrs = temp_label_attributes,
6372};
6373
6374/* --------------------------------------------------------------------- */
6375
6376static int __init thermal_init(struct ibm_init_struct *iibm)
6377{
6378	u8 t, ta1, ta2, ver = 0;
6379	int i;
6380	int acpi_tmp7;
6381
6382	vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
6383
6384	acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
6385
6386	if (thinkpad_id.ec_model) {
6387		/*
6388		 * Direct EC access mode: sensors at registers
6389		 * 0x78-0x7F, 0xC0-0xC7.  Registers return 0x00 for
6390		 * non-implemented, thermal sensors return 0x80 when
6391		 * not available
6392		 * The above rule is unfortunately flawed. This has been seen with
6393		 * 0xC2 (power supply ID) causing thermal control problems.
6394		 * The EC version can be determined by offset 0xEF and at least for
6395		 * version 3 the Lenovo firmware team confirmed that registers 0xC0-0xC7
6396		 * are not thermal registers.
6397		 */
6398		if (!acpi_ec_read(TP_EC_FUNCREV, &ver))
6399			pr_warn("Thinkpad ACPI EC unable to access EC version\n");
6400
6401		ta1 = ta2 = 0;
6402		for (i = 0; i < 8; i++) {
6403			if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
6404				ta1 |= t;
6405			} else {
6406				ta1 = 0;
6407				break;
6408			}
6409			if (ver < 3) {
6410				if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
6411					ta2 |= t;
6412				} else {
6413					ta1 = 0;
6414					break;
6415				}
6416			}
6417		}
6418		if (ta1 == 0) {
6419			/* This is sheer paranoia, but we handle it anyway */
6420			if (acpi_tmp7) {
6421				pr_err("ThinkPad ACPI EC access misbehaving, falling back to ACPI TMPx access mode\n");
6422				thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6423			} else {
6424				pr_err("ThinkPad ACPI EC access misbehaving, disabling thermal sensors access\n");
6425				thermal_read_mode = TPACPI_THERMAL_NONE;
6426			}
6427		} else {
6428			if (ver >= 3) {
6429				thermal_read_mode = TPACPI_THERMAL_TPEC_8;
6430				thermal_use_labels = true;
6431			} else {
6432				thermal_read_mode =
6433					(ta2 != 0) ?
6434					TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
6435			}
6436		}
6437	} else if (acpi_tmp7) {
6438		if (tpacpi_is_ibm() &&
6439		    acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
6440			/* 600e/x, 770e, 770x */
6441			thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
6442		} else {
6443			/* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
6444			thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6445		}
6446	} else {
6447		/* temperatures not supported on 570, G4x, R30, R31, R32 */
6448		thermal_read_mode = TPACPI_THERMAL_NONE;
6449	}
6450
6451	vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
6452		str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
6453		thermal_read_mode);
6454
6455	return thermal_read_mode != TPACPI_THERMAL_NONE ? 0 : -ENODEV;
6456}
6457
6458static int thermal_read(struct seq_file *m)
6459{
6460	int n, i;
6461	struct ibm_thermal_sensors_struct t;
6462
6463	n = thermal_get_sensors(&t);
6464	if (unlikely(n < 0))
6465		return n;
6466
6467	seq_printf(m, "temperatures:\t");
6468
6469	if (n > 0) {
6470		for (i = 0; i < (n - 1); i++)
6471			seq_printf(m, "%d ", t.temp[i] / 1000);
6472		seq_printf(m, "%d\n", t.temp[i] / 1000);
6473	} else
6474		seq_printf(m, "not supported\n");
6475
6476	return 0;
6477}
6478
6479static struct ibm_struct thermal_driver_data = {
6480	.name = "thermal",
6481	.read = thermal_read,
6482};
6483
6484/*************************************************************************
6485 * Backlight/brightness subdriver
6486 */
6487
6488#define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
6489
6490/*
6491 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
6492 * CMOS NVRAM byte 0x5E, bits 0-3.
6493 *
6494 * EC HBRV (0x31) has the following layout
6495 *   Bit 7: unknown function
6496 *   Bit 6: unknown function
6497 *   Bit 5: Z: honour scale changes, NZ: ignore scale changes
6498 *   Bit 4: must be set to zero to avoid problems
6499 *   Bit 3-0: backlight brightness level
6500 *
6501 * brightness_get_raw returns status data in the HBRV layout
6502 *
6503 * WARNING: The X61 has been verified to use HBRV for something else, so
6504 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
6505 * testing on the very early *60 Lenovo models...
6506 */
6507
6508enum {
6509	TP_EC_BACKLIGHT = 0x31,
6510
6511	/* TP_EC_BACKLIGHT bitmasks */
6512	TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6513	TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6514	TP_EC_BACKLIGHT_MAPSW = 0x20,
6515};
6516
6517enum tpacpi_brightness_access_mode {
6518	TPACPI_BRGHT_MODE_AUTO = 0,	/* Not implemented yet */
6519	TPACPI_BRGHT_MODE_EC,		/* EC control */
6520	TPACPI_BRGHT_MODE_UCMS_STEP,	/* UCMS step-based control */
6521	TPACPI_BRGHT_MODE_ECNVRAM,	/* EC control w/ NVRAM store */
6522	TPACPI_BRGHT_MODE_MAX
6523};
6524
6525static struct backlight_device *ibm_backlight_device;
6526
6527static enum tpacpi_brightness_access_mode brightness_mode =
6528		TPACPI_BRGHT_MODE_MAX;
6529
6530static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6531
6532static struct mutex brightness_mutex;
6533
6534/* NVRAM brightness access */
6535static unsigned int tpacpi_brightness_nvram_get(void)
6536{
6537	u8 lnvram;
6538
6539	lockdep_assert_held(&brightness_mutex);
6540
6541	lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6542		  & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6543		  >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6544	lnvram &= bright_maxlvl;
6545
6546	return lnvram;
6547}
6548
6549static void tpacpi_brightness_checkpoint_nvram(void)
6550{
6551	u8 lec = 0;
6552	u8 b_nvram;
6553
6554	if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6555		return;
6556
6557	vdbg_printk(TPACPI_DBG_BRGHT,
6558		"trying to checkpoint backlight level to NVRAM...\n");
6559
6560	if (mutex_lock_killable(&brightness_mutex) < 0)
6561		return;
6562
6563	if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6564		goto unlock;
6565	lec &= TP_EC_BACKLIGHT_LVLMSK;
6566	b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6567
6568	if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6569			     >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6570		/* NVRAM needs update */
6571		b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6572				TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6573		b_nvram |= lec;
6574		nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6575		dbg_printk(TPACPI_DBG_BRGHT,
6576			   "updated NVRAM backlight level to %u (0x%02x)\n",
6577			   (unsigned int) lec, (unsigned int) b_nvram);
6578	} else
6579		vdbg_printk(TPACPI_DBG_BRGHT,
6580			   "NVRAM backlight level already is %u (0x%02x)\n",
6581			   (unsigned int) lec, (unsigned int) b_nvram);
6582
6583unlock:
6584	mutex_unlock(&brightness_mutex);
6585}
6586
6587
6588static int tpacpi_brightness_get_raw(int *status)
6589{
6590	u8 lec = 0;
6591
6592	lockdep_assert_held(&brightness_mutex);
6593
6594	switch (brightness_mode) {
6595	case TPACPI_BRGHT_MODE_UCMS_STEP:
6596		*status = tpacpi_brightness_nvram_get();
6597		return 0;
6598	case TPACPI_BRGHT_MODE_EC:
6599	case TPACPI_BRGHT_MODE_ECNVRAM:
6600		if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6601			return -EIO;
6602		*status = lec;
6603		return 0;
6604	default:
6605		return -ENXIO;
6606	}
6607}
6608
6609/* do NOT call with illegal backlight level value */
6610static int tpacpi_brightness_set_ec(unsigned int value)
6611{
6612	u8 lec = 0;
6613
6614	lockdep_assert_held(&brightness_mutex);
6615
6616	if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6617		return -EIO;
6618
6619	if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6620				(lec & TP_EC_BACKLIGHT_CMDMSK) |
6621				(value & TP_EC_BACKLIGHT_LVLMSK))))
6622		return -EIO;
6623
6624	return 0;
6625}
6626
6627static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6628{
6629	int cmos_cmd, inc;
6630	unsigned int current_value, i;
6631
6632	lockdep_assert_held(&brightness_mutex);
6633
6634	current_value = tpacpi_brightness_nvram_get();
6635
6636	if (value == current_value)
6637		return 0;
6638
6639	cmos_cmd = (value > current_value) ?
6640			TP_CMOS_BRIGHTNESS_UP :
6641			TP_CMOS_BRIGHTNESS_DOWN;
6642	inc = (value > current_value) ? 1 : -1;
6643
6644	for (i = current_value; i != value; i += inc)
6645		if (issue_thinkpad_cmos_command(cmos_cmd))
6646			return -EIO;
6647
6648	return 0;
6649}
6650
6651/* May return EINTR which can always be mapped to ERESTARTSYS */
6652static int brightness_set(unsigned int value)
6653{
6654	int res;
6655
6656	if (value > bright_maxlvl)
6657		return -EINVAL;
6658
6659	vdbg_printk(TPACPI_DBG_BRGHT,
6660			"set backlight level to %d\n", value);
6661
6662	res = mutex_lock_killable(&brightness_mutex);
6663	if (res < 0)
6664		return res;
6665
6666	switch (brightness_mode) {
6667	case TPACPI_BRGHT_MODE_EC:
6668	case TPACPI_BRGHT_MODE_ECNVRAM:
6669		res = tpacpi_brightness_set_ec(value);
6670		break;
6671	case TPACPI_BRGHT_MODE_UCMS_STEP:
6672		res = tpacpi_brightness_set_ucmsstep(value);
6673		break;
6674	default:
6675		res = -ENXIO;
6676	}
6677
6678	mutex_unlock(&brightness_mutex);
6679	return res;
6680}
6681
6682/* sysfs backlight class ----------------------------------------------- */
6683
6684static int brightness_update_status(struct backlight_device *bd)
6685{
6686	int level = backlight_get_brightness(bd);
6687
6688	dbg_printk(TPACPI_DBG_BRGHT,
6689			"backlight: attempt to set level to %d\n",
6690			level);
6691
6692	/* it is the backlight class's job (caller) to handle
6693	 * EINTR and other errors properly */
6694	return brightness_set(level);
6695}
6696
6697static int brightness_get(struct backlight_device *bd)
6698{
6699	int status, res;
6700
6701	res = mutex_lock_killable(&brightness_mutex);
6702	if (res < 0)
6703		return 0;
6704
6705	res = tpacpi_brightness_get_raw(&status);
6706
6707	mutex_unlock(&brightness_mutex);
6708
6709	if (res < 0)
6710		return 0;
6711
6712	return status & TP_EC_BACKLIGHT_LVLMSK;
6713}
6714
6715static void tpacpi_brightness_notify_change(void)
6716{
6717	backlight_force_update(ibm_backlight_device,
6718			       BACKLIGHT_UPDATE_HOTKEY);
6719}
6720
6721static const struct backlight_ops ibm_backlight_data = {
6722	.get_brightness = brightness_get,
6723	.update_status  = brightness_update_status,
6724};
6725
6726/* --------------------------------------------------------------------- */
6727
6728static int __init tpacpi_evaluate_bcl(struct acpi_device *adev, void *not_used)
6729{
6730	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6731	union acpi_object *obj;
6732	acpi_status status;
6733	int rc;
6734
6735	status = acpi_evaluate_object(adev->handle, "_BCL", NULL, &buffer);
6736	if (ACPI_FAILURE(status))
6737		return 0;
6738
6739	obj = buffer.pointer;
6740	if (!obj || obj->type != ACPI_TYPE_PACKAGE) {
6741		acpi_handle_info(adev->handle,
6742				 "Unknown _BCL data, please report this to %s\n",
6743				 TPACPI_MAIL);
6744		rc = 0;
6745	} else {
6746		rc = obj->package.count;
6747	}
6748	kfree(obj);
6749
6750	return rc;
6751}
6752
6753/*
6754 * Call _BCL method of video device.  On some ThinkPads this will
6755 * switch the firmware to the ACPI brightness control mode.
6756 */
6757
6758static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6759{
6760	struct acpi_device *device;
6761
6762	device = acpi_fetch_acpi_dev(handle);
6763	if (!device)
6764		return 0;
6765
6766	return acpi_dev_for_each_child(device, tpacpi_evaluate_bcl, NULL);
6767}
6768
6769
6770/*
6771 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6772 */
6773static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6774{
6775	acpi_handle video_device;
6776	int bcl_levels = 0;
6777
6778	tpacpi_acpi_handle_locate("video", NULL, &video_device);
6779	if (video_device)
6780		bcl_levels = tpacpi_query_bcl_levels(video_device);
6781
6782	tp_features.bright_acpimode = (bcl_levels > 0);
6783
6784	return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6785}
6786
6787/*
6788 * These are only useful for models that have only one possibility
6789 * of GPU.  If the BIOS model handles both ATI and Intel, don't use
6790 * these quirks.
6791 */
6792#define TPACPI_BRGHT_Q_NOEC	0x0001	/* Must NOT use EC HBRV */
6793#define TPACPI_BRGHT_Q_EC	0x0002  /* Should or must use EC HBRV */
6794#define TPACPI_BRGHT_Q_ASK	0x8000	/* Ask for user report */
6795
6796static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6797	/* Models with ATI GPUs known to require ECNVRAM mode */
6798	TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC),	/* T43/p ATI */
6799
6800	/* Models with ATI GPUs that can use ECNVRAM */
6801	TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC),	/* R50,51 T40-42 */
6802	TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6803	TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC),	/* R52 */
6804	TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6805
6806	/* Models with Intel Extreme Graphics 2 */
6807	TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC),	/* X40 */
6808	TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6809	TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6810
6811	/* Models with Intel GMA900 */
6812	TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC),	/* T43, R52 */
6813	TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC),	/* X41 */
6814	TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC),	/* X41 Tablet */
6815};
6816
6817/*
6818 * Returns < 0 for error, otherwise sets tp_features.bright_*
6819 * and bright_maxlvl.
6820 */
6821static void __init tpacpi_detect_brightness_capabilities(void)
6822{
6823	unsigned int b;
6824
6825	vdbg_printk(TPACPI_DBG_INIT,
6826		    "detecting firmware brightness interface capabilities\n");
6827
6828	/* we could run a quirks check here (same table used by
6829	 * brightness_init) if needed */
6830
6831	/*
6832	 * We always attempt to detect acpi support, so as to switch
6833	 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6834	 * going to publish a backlight interface
6835	 */
6836	b = tpacpi_check_std_acpi_brightness_support();
6837	switch (b) {
6838	case 16:
6839		bright_maxlvl = 15;
6840		break;
6841	case 8:
6842	case 0:
6843		bright_maxlvl = 7;
6844		break;
6845	default:
6846		tp_features.bright_unkfw = 1;
6847		bright_maxlvl = b - 1;
6848	}
6849	pr_debug("detected %u brightness levels\n", bright_maxlvl + 1);
6850}
6851
6852static int __init brightness_init(struct ibm_init_struct *iibm)
6853{
6854	struct backlight_properties props;
6855	int b;
6856	unsigned long quirks;
6857
6858	vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6859
6860	mutex_init(&brightness_mutex);
6861
6862	quirks = tpacpi_check_quirks(brightness_quirk_table,
6863				ARRAY_SIZE(brightness_quirk_table));
6864
6865	/* tpacpi_detect_brightness_capabilities() must have run already */
6866
6867	/* if it is unknown, we don't handle it: it wouldn't be safe */
6868	if (tp_features.bright_unkfw)
6869		return -ENODEV;
6870
6871	if (!brightness_enable) {
6872		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6873			   "brightness support disabled by module parameter\n");
6874		return -ENODEV;
6875	}
6876
6877	if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
6878		if (brightness_enable > 1) {
6879			pr_info("Standard ACPI backlight interface available, not loading native one\n");
6880			return -ENODEV;
6881		} else if (brightness_enable == 1) {
6882			pr_warn("Cannot enable backlight brightness support, ACPI is already handling it.  Refer to the acpi_backlight kernel parameter.\n");
6883			return -ENODEV;
6884		}
6885	} else if (!tp_features.bright_acpimode) {
6886		pr_notice("ACPI backlight interface not available\n");
6887		return -ENODEV;
6888	}
6889
6890	pr_notice("ACPI native brightness control enabled\n");
6891
6892	/*
6893	 * Check for module parameter bogosity, note that we
6894	 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6895	 * able to detect "unspecified"
6896	 */
6897	if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6898		return -EINVAL;
6899
6900	/* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6901	if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6902	    brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6903		if (quirks & TPACPI_BRGHT_Q_EC)
6904			brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6905		else
6906			brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6907
6908		dbg_printk(TPACPI_DBG_BRGHT,
6909			   "driver auto-selected brightness_mode=%d\n",
6910			   brightness_mode);
6911	}
6912
6913	/* Safety */
6914	if (!tpacpi_is_ibm() &&
6915	    (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6916	     brightness_mode == TPACPI_BRGHT_MODE_EC))
6917		return -EINVAL;
6918
6919	if (tpacpi_brightness_get_raw(&b) < 0)
6920		return -ENODEV;
6921
6922	memset(&props, 0, sizeof(struct backlight_properties));
6923	props.type = BACKLIGHT_PLATFORM;
6924	props.max_brightness = bright_maxlvl;
6925	props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6926	ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6927							 NULL, NULL,
6928							 &ibm_backlight_data,
6929							 &props);
6930	if (IS_ERR(ibm_backlight_device)) {
6931		int rc = PTR_ERR(ibm_backlight_device);
6932		ibm_backlight_device = NULL;
6933		pr_err("Could not register backlight device\n");
6934		return rc;
6935	}
6936	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6937			"brightness is supported\n");
6938
6939	if (quirks & TPACPI_BRGHT_Q_ASK) {
6940		pr_notice("brightness: will use unverified default: brightness_mode=%d\n",
6941			  brightness_mode);
6942		pr_notice("brightness: please report to %s whether it works well or not on your ThinkPad\n",
6943			  TPACPI_MAIL);
6944	}
6945
6946	/* Added by mistake in early 2007.  Probably useless, but it could
6947	 * be working around some unknown firmware problem where the value
6948	 * read at startup doesn't match the real hardware state... so leave
6949	 * it in place just in case */
6950	backlight_update_status(ibm_backlight_device);
6951
6952	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6953		    "brightness: registering brightness hotkeys as change notification\n");
6954	tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6955				| TP_ACPI_HKEY_BRGHTUP_MASK
6956				| TP_ACPI_HKEY_BRGHTDWN_MASK);
6957	return 0;
6958}
6959
6960static void brightness_suspend(void)
6961{
6962	tpacpi_brightness_checkpoint_nvram();
6963}
6964
6965static void brightness_shutdown(void)
6966{
6967	tpacpi_brightness_checkpoint_nvram();
6968}
6969
6970static void brightness_exit(void)
6971{
6972	if (ibm_backlight_device) {
6973		vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6974			    "calling backlight_device_unregister()\n");
6975		backlight_device_unregister(ibm_backlight_device);
6976	}
6977
6978	tpacpi_brightness_checkpoint_nvram();
6979}
6980
6981static int brightness_read(struct seq_file *m)
6982{
6983	int level;
6984
6985	level = brightness_get(NULL);
6986	if (level < 0) {
6987		seq_printf(m, "level:\t\tunreadable\n");
6988	} else {
6989		seq_printf(m, "level:\t\t%d\n", level);
6990		seq_printf(m, "commands:\tup, down\n");
6991		seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6992			       bright_maxlvl);
6993	}
6994
6995	return 0;
6996}
6997
6998static int brightness_write(char *buf)
6999{
7000	int level;
7001	int rc;
7002	char *cmd;
7003
7004	level = brightness_get(NULL);
7005	if (level < 0)
7006		return level;
7007
7008	while ((cmd = strsep(&buf, ","))) {
7009		if (strstarts(cmd, "up")) {
7010			if (level < bright_maxlvl)
7011				level++;
7012		} else if (strstarts(cmd, "down")) {
7013			if (level > 0)
7014				level--;
7015		} else if (sscanf(cmd, "level %d", &level) == 1 &&
7016			   level >= 0 && level <= bright_maxlvl) {
7017			/* new level set */
7018		} else
7019			return -EINVAL;
7020	}
7021
7022	tpacpi_disclose_usertask("procfs brightness",
7023			"set level to %d\n", level);
7024
7025	/*
7026	 * Now we know what the final level should be, so we try to set it.
7027	 * Doing it this way makes the syscall restartable in case of EINTR
7028	 */
7029	rc = brightness_set(level);
7030	if (!rc && ibm_backlight_device)
7031		backlight_force_update(ibm_backlight_device,
7032					BACKLIGHT_UPDATE_SYSFS);
7033	return (rc == -EINTR) ? -ERESTARTSYS : rc;
7034}
7035
7036static struct ibm_struct brightness_driver_data = {
7037	.name = "brightness",
7038	.read = brightness_read,
7039	.write = brightness_write,
7040	.exit = brightness_exit,
7041	.suspend = brightness_suspend,
7042	.shutdown = brightness_shutdown,
7043};
7044
7045/*************************************************************************
7046 * Volume subdriver
7047 */
7048
7049/*
7050 * IBM ThinkPads have a simple volume controller with MUTE gating.
7051 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
7052 *
7053 * Since the *61 series (and probably also the later *60 series), Lenovo
7054 * ThinkPads only implement the MUTE gate.
7055 *
7056 * EC register 0x30
7057 *   Bit 6: MUTE (1 mutes sound)
7058 *   Bit 3-0: Volume
7059 *   Other bits should be zero as far as we know.
7060 *
7061 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
7062 * bits 3-0 (volume).  Other bits in NVRAM may have other functions,
7063 * such as bit 7 which is used to detect repeated presses of MUTE,
7064 * and we leave them unchanged.
7065 *
7066 * On newer Lenovo ThinkPads, the EC can automatically change the volume
7067 * in response to user input.  Unfortunately, this rarely works well.
7068 * The laptop changes the state of its internal MUTE gate and, on some
7069 * models, sends KEY_MUTE, causing any user code that responds to the
7070 * mute button to get confused.  The hardware MUTE gate is also
7071 * unnecessary, since user code can handle the mute button without
7072 * kernel or EC help.
7073 *
7074 * To avoid confusing userspace, we simply disable all EC-based mute
7075 * and volume controls when possible.
7076 */
7077
7078#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
7079
7080#define TPACPI_ALSA_DRVNAME  "ThinkPad EC"
7081#define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
7082#define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
7083
7084#if SNDRV_CARDS <= 32
7085#define DEFAULT_ALSA_IDX		~((1 << (SNDRV_CARDS - 3)) - 1)
7086#else
7087#define DEFAULT_ALSA_IDX		~((1 << (32 - 3)) - 1)
7088#endif
7089static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
7090static char *alsa_id = "ThinkPadEC";
7091static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
7092
7093struct tpacpi_alsa_data {
7094	struct snd_card *card;
7095	struct snd_ctl_elem_id *ctl_mute_id;
7096	struct snd_ctl_elem_id *ctl_vol_id;
7097};
7098
7099static struct snd_card *alsa_card;
7100
7101enum {
7102	TP_EC_AUDIO = 0x30,
7103
7104	/* TP_EC_AUDIO bits */
7105	TP_EC_AUDIO_MUTESW = 6,
7106
7107	/* TP_EC_AUDIO bitmasks */
7108	TP_EC_AUDIO_LVL_MSK = 0x0F,
7109	TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
7110
7111	/* Maximum volume */
7112	TP_EC_VOLUME_MAX = 14,
7113};
7114
7115enum tpacpi_volume_access_mode {
7116	TPACPI_VOL_MODE_AUTO = 0,	/* Not implemented yet */
7117	TPACPI_VOL_MODE_EC,		/* Pure EC control */
7118	TPACPI_VOL_MODE_UCMS_STEP,	/* UCMS step-based control: N/A */
7119	TPACPI_VOL_MODE_ECNVRAM,	/* EC control w/ NVRAM store */
7120	TPACPI_VOL_MODE_MAX
7121};
7122
7123enum tpacpi_volume_capabilities {
7124	TPACPI_VOL_CAP_AUTO = 0,	/* Use white/blacklist */
7125	TPACPI_VOL_CAP_VOLMUTE,		/* Output vol and mute */
7126	TPACPI_VOL_CAP_MUTEONLY,	/* Output mute only */
7127	TPACPI_VOL_CAP_MAX
7128};
7129
7130enum tpacpi_mute_btn_mode {
7131	TP_EC_MUTE_BTN_LATCH  = 0,	/* Mute mutes; up/down unmutes */
7132	/* We don't know what mode 1 is. */
7133	TP_EC_MUTE_BTN_NONE   = 2,	/* Mute and up/down are just keys */
7134	TP_EC_MUTE_BTN_TOGGLE = 3,	/* Mute toggles; up/down unmutes */
7135};
7136
7137static enum tpacpi_volume_access_mode volume_mode =
7138	TPACPI_VOL_MODE_MAX;
7139
7140static enum tpacpi_volume_capabilities volume_capabilities;
7141static bool volume_control_allowed;
7142static bool software_mute_requested = true;
7143static bool software_mute_active;
7144static int software_mute_orig_mode;
7145
7146/*
7147 * Used to syncronize writers to TP_EC_AUDIO and
7148 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
7149 */
7150static struct mutex volume_mutex;
7151
7152static void tpacpi_volume_checkpoint_nvram(void)
7153{
7154	u8 lec = 0;
7155	u8 b_nvram;
7156	u8 ec_mask;
7157
7158	if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
7159		return;
7160	if (!volume_control_allowed)
7161		return;
7162	if (software_mute_active)
7163		return;
7164
7165	vdbg_printk(TPACPI_DBG_MIXER,
7166		"trying to checkpoint mixer state to NVRAM...\n");
7167
7168	if (tp_features.mixer_no_level_control)
7169		ec_mask = TP_EC_AUDIO_MUTESW_MSK;
7170	else
7171		ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
7172
7173	if (mutex_lock_killable(&volume_mutex) < 0)
7174		return;
7175
7176	if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
7177		goto unlock;
7178	lec &= ec_mask;
7179	b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
7180
7181	if (lec != (b_nvram & ec_mask)) {
7182		/* NVRAM needs update */
7183		b_nvram &= ~ec_mask;
7184		b_nvram |= lec;
7185		nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
7186		dbg_printk(TPACPI_DBG_MIXER,
7187			   "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
7188			   (unsigned int) lec, (unsigned int) b_nvram);
7189	} else {
7190		vdbg_printk(TPACPI_DBG_MIXER,
7191			   "NVRAM mixer status already is 0x%02x (0x%02x)\n",
7192			   (unsigned int) lec, (unsigned int) b_nvram);
7193	}
7194
7195unlock:
7196	mutex_unlock(&volume_mutex);
7197}
7198
7199static int volume_get_status_ec(u8 *status)
7200{
7201	u8 s;
7202
7203	if (!acpi_ec_read(TP_EC_AUDIO, &s))
7204		return -EIO;
7205
7206	*status = s;
7207
7208	dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
7209
7210	return 0;
7211}
7212
7213static int volume_get_status(u8 *status)
7214{
7215	return volume_get_status_ec(status);
7216}
7217
7218static int volume_set_status_ec(const u8 status)
7219{
7220	if (!acpi_ec_write(TP_EC_AUDIO, status))
7221		return -EIO;
7222
7223	dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
7224
7225	/*
7226	 * On X200s, and possibly on others, it can take a while for
7227	 * reads to become correct.
7228	 */
7229	msleep(1);
7230
7231	return 0;
7232}
7233
7234static int volume_set_status(const u8 status)
7235{
7236	return volume_set_status_ec(status);
7237}
7238
7239/* returns < 0 on error, 0 on no change, 1 on change */
7240static int __volume_set_mute_ec(const bool mute)
7241{
7242	int rc;
7243	u8 s, n;
7244
7245	if (mutex_lock_killable(&volume_mutex) < 0)
7246		return -EINTR;
7247
7248	rc = volume_get_status_ec(&s);
7249	if (rc)
7250		goto unlock;
7251
7252	n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
7253		     s & ~TP_EC_AUDIO_MUTESW_MSK;
7254
7255	if (n != s) {
7256		rc = volume_set_status_ec(n);
7257		if (!rc)
7258			rc = 1;
7259	}
7260
7261unlock:
7262	mutex_unlock(&volume_mutex);
7263	return rc;
7264}
7265
7266static int volume_alsa_set_mute(const bool mute)
7267{
7268	dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
7269		   (mute) ? "" : "un");
7270	return __volume_set_mute_ec(mute);
7271}
7272
7273static int volume_set_mute(const bool mute)
7274{
7275	int rc;
7276
7277	dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
7278		   (mute) ? "" : "un");
7279
7280	rc = __volume_set_mute_ec(mute);
7281	return (rc < 0) ? rc : 0;
7282}
7283
7284/* returns < 0 on error, 0 on no change, 1 on change */
7285static int __volume_set_volume_ec(const u8 vol)
7286{
7287	int rc;
7288	u8 s, n;
7289
7290	if (vol > TP_EC_VOLUME_MAX)
7291		return -EINVAL;
7292
7293	if (mutex_lock_killable(&volume_mutex) < 0)
7294		return -EINTR;
7295
7296	rc = volume_get_status_ec(&s);
7297	if (rc)
7298		goto unlock;
7299
7300	n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
7301
7302	if (n != s) {
7303		rc = volume_set_status_ec(n);
7304		if (!rc)
7305			rc = 1;
7306	}
7307
7308unlock:
7309	mutex_unlock(&volume_mutex);
7310	return rc;
7311}
7312
7313static int volume_set_software_mute(bool startup)
7314{
7315	int result;
7316
7317	if (!tpacpi_is_lenovo())
7318		return -ENODEV;
7319
7320	if (startup) {
7321		if (!acpi_evalf(ec_handle, &software_mute_orig_mode,
7322				"HAUM", "qd"))
7323			return -EIO;
7324
7325		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7326			    "Initial HAUM setting was %d\n",
7327			    software_mute_orig_mode);
7328	}
7329
7330	if (!acpi_evalf(ec_handle, &result, "SAUM", "qdd",
7331			(int)TP_EC_MUTE_BTN_NONE))
7332		return -EIO;
7333
7334	if (result != TP_EC_MUTE_BTN_NONE)
7335		pr_warn("Unexpected SAUM result %d\n",
7336			result);
7337
7338	/*
7339	 * In software mute mode, the standard codec controls take
7340	 * precendence, so we unmute the ThinkPad HW switch at
7341	 * startup.  Just on case there are SAUM-capable ThinkPads
7342	 * with level controls, set max HW volume as well.
7343	 */
7344	if (tp_features.mixer_no_level_control)
7345		result = volume_set_mute(false);
7346	else
7347		result = volume_set_status(TP_EC_VOLUME_MAX);
7348
7349	if (result != 0)
7350		pr_warn("Failed to unmute the HW mute switch\n");
7351
7352	return 0;
7353}
7354
7355static void volume_exit_software_mute(void)
7356{
7357	int r;
7358
7359	if (!acpi_evalf(ec_handle, &r, "SAUM", "qdd", software_mute_orig_mode)
7360	    || r != software_mute_orig_mode)
7361		pr_warn("Failed to restore mute mode\n");
7362}
7363
7364static int volume_alsa_set_volume(const u8 vol)
7365{
7366	dbg_printk(TPACPI_DBG_MIXER,
7367		   "ALSA: trying to set volume level to %hu\n", vol);
7368	return __volume_set_volume_ec(vol);
7369}
7370
7371static void volume_alsa_notify_change(void)
7372{
7373	struct tpacpi_alsa_data *d;
7374
7375	if (alsa_card && alsa_card->private_data) {
7376		d = alsa_card->private_data;
7377		if (d->ctl_mute_id)
7378			snd_ctl_notify(alsa_card,
7379					SNDRV_CTL_EVENT_MASK_VALUE,
7380					d->ctl_mute_id);
7381		if (d->ctl_vol_id)
7382			snd_ctl_notify(alsa_card,
7383					SNDRV_CTL_EVENT_MASK_VALUE,
7384					d->ctl_vol_id);
7385	}
7386}
7387
7388static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
7389				struct snd_ctl_elem_info *uinfo)
7390{
7391	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
7392	uinfo->count = 1;
7393	uinfo->value.integer.min = 0;
7394	uinfo->value.integer.max = TP_EC_VOLUME_MAX;
7395	return 0;
7396}
7397
7398static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
7399				struct snd_ctl_elem_value *ucontrol)
7400{
7401	u8 s;
7402	int rc;
7403
7404	rc = volume_get_status(&s);
7405	if (rc < 0)
7406		return rc;
7407
7408	ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
7409	return 0;
7410}
7411
7412static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
7413				struct snd_ctl_elem_value *ucontrol)
7414{
7415	tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
7416				 ucontrol->value.integer.value[0]);
7417	return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
7418}
7419
7420#define volume_alsa_mute_info snd_ctl_boolean_mono_info
7421
7422static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
7423				struct snd_ctl_elem_value *ucontrol)
7424{
7425	u8 s;
7426	int rc;
7427
7428	rc = volume_get_status(&s);
7429	if (rc < 0)
7430		return rc;
7431
7432	ucontrol->value.integer.value[0] =
7433				(s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
7434	return 0;
7435}
7436
7437static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
7438				struct snd_ctl_elem_value *ucontrol)
7439{
7440	tpacpi_disclose_usertask("ALSA", "%smute\n",
7441				 ucontrol->value.integer.value[0] ?
7442					"un" : "");
7443	return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
7444}
7445
7446static struct snd_kcontrol_new volume_alsa_control_vol __initdata = {
7447	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7448	.name = "Console Playback Volume",
7449	.index = 0,
7450	.access = SNDRV_CTL_ELEM_ACCESS_READ,
7451	.info = volume_alsa_vol_info,
7452	.get = volume_alsa_vol_get,
7453};
7454
7455static struct snd_kcontrol_new volume_alsa_control_mute __initdata = {
7456	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7457	.name = "Console Playback Switch",
7458	.index = 0,
7459	.access = SNDRV_CTL_ELEM_ACCESS_READ,
7460	.info = volume_alsa_mute_info,
7461	.get = volume_alsa_mute_get,
7462};
7463
7464static void volume_suspend(void)
7465{
7466	tpacpi_volume_checkpoint_nvram();
7467}
7468
7469static void volume_resume(void)
7470{
7471	if (software_mute_active) {
7472		if (volume_set_software_mute(false) < 0)
7473			pr_warn("Failed to restore software mute\n");
7474	} else {
7475		volume_alsa_notify_change();
7476	}
7477}
7478
7479static void volume_shutdown(void)
7480{
7481	tpacpi_volume_checkpoint_nvram();
7482}
7483
7484static void volume_exit(void)
7485{
7486	if (alsa_card) {
7487		snd_card_free(alsa_card);
7488		alsa_card = NULL;
7489	}
7490
7491	tpacpi_volume_checkpoint_nvram();
7492
7493	if (software_mute_active)
7494		volume_exit_software_mute();
7495}
7496
7497static int __init volume_create_alsa_mixer(void)
7498{
7499	struct snd_card *card;
7500	struct tpacpi_alsa_data *data;
7501	struct snd_kcontrol *ctl_vol;
7502	struct snd_kcontrol *ctl_mute;
7503	int rc;
7504
7505	rc = snd_card_new(&tpacpi_pdev->dev,
7506			  alsa_index, alsa_id, THIS_MODULE,
7507			  sizeof(struct tpacpi_alsa_data), &card);
7508	if (rc < 0 || !card) {
7509		pr_err("Failed to create ALSA card structures: %d\n", rc);
7510		return -ENODEV;
7511	}
7512
7513	BUG_ON(!card->private_data);
7514	data = card->private_data;
7515	data->card = card;
7516
7517	strscpy(card->driver, TPACPI_ALSA_DRVNAME,
7518		sizeof(card->driver));
7519	strscpy(card->shortname, TPACPI_ALSA_SHRTNAME,
7520		sizeof(card->shortname));
7521	snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
7522		 (thinkpad_id.ec_version_str) ?
7523			thinkpad_id.ec_version_str : "(unknown)");
7524	snprintf(card->longname, sizeof(card->longname),
7525		 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
7526		 (thinkpad_id.ec_version_str) ?
7527			thinkpad_id.ec_version_str : "unknown");
7528
7529	if (volume_control_allowed) {
7530		volume_alsa_control_vol.put = volume_alsa_vol_put;
7531		volume_alsa_control_vol.access =
7532				SNDRV_CTL_ELEM_ACCESS_READWRITE;
7533
7534		volume_alsa_control_mute.put = volume_alsa_mute_put;
7535		volume_alsa_control_mute.access =
7536				SNDRV_CTL_ELEM_ACCESS_READWRITE;
7537	}
7538
7539	if (!tp_features.mixer_no_level_control) {
7540		ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
7541		rc = snd_ctl_add(card, ctl_vol);
7542		if (rc < 0) {
7543			pr_err("Failed to create ALSA volume control: %d\n",
7544			       rc);
7545			goto err_exit;
7546		}
7547		data->ctl_vol_id = &ctl_vol->id;
7548	}
7549
7550	ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
7551	rc = snd_ctl_add(card, ctl_mute);
7552	if (rc < 0) {
7553		pr_err("Failed to create ALSA mute control: %d\n", rc);
7554		goto err_exit;
7555	}
7556	data->ctl_mute_id = &ctl_mute->id;
7557
7558	rc = snd_card_register(card);
7559	if (rc < 0) {
7560		pr_err("Failed to register ALSA card: %d\n", rc);
7561		goto err_exit;
7562	}
7563
7564	alsa_card = card;
7565	return 0;
7566
7567err_exit:
7568	snd_card_free(card);
7569	return -ENODEV;
7570}
7571
7572#define TPACPI_VOL_Q_MUTEONLY	0x0001	/* Mute-only control available */
7573#define TPACPI_VOL_Q_LEVEL	0x0002  /* Volume control available */
7574
7575static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
7576	/* Whitelist volume level on all IBM by default */
7577	{ .vendor = PCI_VENDOR_ID_IBM,
7578	  .bios   = TPACPI_MATCH_ANY,
7579	  .ec     = TPACPI_MATCH_ANY,
7580	  .quirks = TPACPI_VOL_Q_LEVEL },
7581
7582	/* Lenovo models with volume control (needs confirmation) */
7583	TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
7584	TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
7585	TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
7586	TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
7587	TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
7588	TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
7589	TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
7590
7591	/* Whitelist mute-only on all Lenovo by default */
7592	{ .vendor = PCI_VENDOR_ID_LENOVO,
7593	  .bios   = TPACPI_MATCH_ANY,
7594	  .ec	  = TPACPI_MATCH_ANY,
7595	  .quirks = TPACPI_VOL_Q_MUTEONLY }
7596};
7597
7598static int __init volume_init(struct ibm_init_struct *iibm)
7599{
7600	unsigned long quirks;
7601	int rc;
7602
7603	vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7604
7605	mutex_init(&volume_mutex);
7606
7607	/*
7608	 * Check for module parameter bogosity, note that we
7609	 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7610	 * able to detect "unspecified"
7611	 */
7612	if (volume_mode > TPACPI_VOL_MODE_MAX)
7613		return -EINVAL;
7614
7615	if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7616		pr_err("UCMS step volume mode not implemented, please contact %s\n",
7617		       TPACPI_MAIL);
7618		return -ENODEV;
7619	}
7620
7621	if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7622		return -EINVAL;
7623
7624	/*
7625	 * The ALSA mixer is our primary interface.
7626	 * When disabled, don't install the subdriver at all
7627	 */
7628	if (!alsa_enable) {
7629		vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7630			    "ALSA mixer disabled by parameter, not loading volume subdriver...\n");
7631		return -ENODEV;
7632	}
7633
7634	quirks = tpacpi_check_quirks(volume_quirk_table,
7635				     ARRAY_SIZE(volume_quirk_table));
7636
7637	switch (volume_capabilities) {
7638	case TPACPI_VOL_CAP_AUTO:
7639		if (quirks & TPACPI_VOL_Q_MUTEONLY)
7640			tp_features.mixer_no_level_control = 1;
7641		else if (quirks & TPACPI_VOL_Q_LEVEL)
7642			tp_features.mixer_no_level_control = 0;
7643		else
7644			return -ENODEV; /* no mixer */
7645		break;
7646	case TPACPI_VOL_CAP_VOLMUTE:
7647		tp_features.mixer_no_level_control = 0;
7648		break;
7649	case TPACPI_VOL_CAP_MUTEONLY:
7650		tp_features.mixer_no_level_control = 1;
7651		break;
7652	default:
7653		return -ENODEV;
7654	}
7655
7656	if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7657		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7658				"using user-supplied volume_capabilities=%d\n",
7659				volume_capabilities);
7660
7661	if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7662	    volume_mode == TPACPI_VOL_MODE_MAX) {
7663		volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7664
7665		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7666				"driver auto-selected volume_mode=%d\n",
7667				volume_mode);
7668	} else {
7669		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7670				"using user-supplied volume_mode=%d\n",
7671				volume_mode);
7672	}
7673
7674	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7675			"mute is supported, volume control is %s\n",
7676			str_supported(!tp_features.mixer_no_level_control));
7677
7678	if (software_mute_requested && volume_set_software_mute(true) == 0) {
7679		software_mute_active = true;
7680	} else {
7681		rc = volume_create_alsa_mixer();
7682		if (rc) {
7683			pr_err("Could not create the ALSA mixer interface\n");
7684			return rc;
7685		}
7686
7687		pr_info("Console audio control enabled, mode: %s\n",
7688			(volume_control_allowed) ?
7689				"override (read/write)" :
7690				"monitor (read only)");
7691	}
7692
7693	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7694		"registering volume hotkeys as change notification\n");
7695	tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7696			| TP_ACPI_HKEY_VOLUP_MASK
7697			| TP_ACPI_HKEY_VOLDWN_MASK
7698			| TP_ACPI_HKEY_MUTE_MASK);
7699
7700	return 0;
7701}
7702
7703static int volume_read(struct seq_file *m)
7704{
7705	u8 status;
7706
7707	if (volume_get_status(&status) < 0) {
7708		seq_printf(m, "level:\t\tunreadable\n");
7709	} else {
7710		if (tp_features.mixer_no_level_control)
7711			seq_printf(m, "level:\t\tunsupported\n");
7712		else
7713			seq_printf(m, "level:\t\t%d\n",
7714					status & TP_EC_AUDIO_LVL_MSK);
7715
7716		seq_printf(m, "mute:\t\t%s\n", str_on_off(status & BIT(TP_EC_AUDIO_MUTESW)));
7717
7718		if (volume_control_allowed) {
7719			seq_printf(m, "commands:\tunmute, mute\n");
7720			if (!tp_features.mixer_no_level_control) {
7721				seq_printf(m, "commands:\tup, down\n");
7722				seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7723					      TP_EC_VOLUME_MAX);
7724			}
7725		}
7726	}
7727
7728	return 0;
7729}
7730
7731static int volume_write(char *buf)
7732{
7733	u8 s;
7734	u8 new_level, new_mute;
7735	int l;
7736	char *cmd;
7737	int rc;
7738
7739	/*
7740	 * We do allow volume control at driver startup, so that the
7741	 * user can set initial state through the volume=... parameter hack.
7742	 */
7743	if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7744		if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7745			tp_warned.volume_ctrl_forbidden = 1;
7746			pr_notice("Console audio control in monitor mode, changes are not allowed\n");
7747			pr_notice("Use the volume_control=1 module parameter to enable volume control\n");
7748		}
7749		return -EPERM;
7750	}
7751
7752	rc = volume_get_status(&s);
7753	if (rc < 0)
7754		return rc;
7755
7756	new_level = s & TP_EC_AUDIO_LVL_MSK;
7757	new_mute  = s & TP_EC_AUDIO_MUTESW_MSK;
7758
7759	while ((cmd = strsep(&buf, ","))) {
7760		if (!tp_features.mixer_no_level_control) {
7761			if (strstarts(cmd, "up")) {
7762				if (new_mute)
7763					new_mute = 0;
7764				else if (new_level < TP_EC_VOLUME_MAX)
7765					new_level++;
7766				continue;
7767			} else if (strstarts(cmd, "down")) {
7768				if (new_mute)
7769					new_mute = 0;
7770				else if (new_level > 0)
7771					new_level--;
7772				continue;
7773			} else if (sscanf(cmd, "level %u", &l) == 1 &&
7774				   l >= 0 && l <= TP_EC_VOLUME_MAX) {
7775				new_level = l;
7776				continue;
7777			}
7778		}
7779		if (strstarts(cmd, "mute"))
7780			new_mute = TP_EC_AUDIO_MUTESW_MSK;
7781		else if (strstarts(cmd, "unmute"))
7782			new_mute = 0;
7783		else
7784			return -EINVAL;
7785	}
7786
7787	if (tp_features.mixer_no_level_control) {
7788		tpacpi_disclose_usertask("procfs volume", "%smute\n",
7789					new_mute ? "" : "un");
7790		rc = volume_set_mute(!!new_mute);
7791	} else {
7792		tpacpi_disclose_usertask("procfs volume",
7793					"%smute and set level to %d\n",
7794					new_mute ? "" : "un", new_level);
7795		rc = volume_set_status(new_mute | new_level);
7796	}
7797	volume_alsa_notify_change();
7798
7799	return (rc == -EINTR) ? -ERESTARTSYS : rc;
7800}
7801
7802static struct ibm_struct volume_driver_data = {
7803	.name = "volume",
7804	.read = volume_read,
7805	.write = volume_write,
7806	.exit = volume_exit,
7807	.suspend = volume_suspend,
7808	.resume = volume_resume,
7809	.shutdown = volume_shutdown,
7810};
7811
7812#else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7813
7814#define alsa_card NULL
7815
7816static inline void volume_alsa_notify_change(void)
7817{
7818}
7819
7820static int __init volume_init(struct ibm_init_struct *iibm)
7821{
7822	pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7823
7824	return -ENODEV;
7825}
7826
7827static struct ibm_struct volume_driver_data = {
7828	.name = "volume",
7829};
7830
7831#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7832
7833/*************************************************************************
7834 * Fan subdriver
7835 */
7836
7837/*
7838 * FAN ACCESS MODES
7839 *
7840 * TPACPI_FAN_RD_ACPI_GFAN:
7841 * 	ACPI GFAN method: returns fan level
7842 *
7843 * 	see TPACPI_FAN_WR_ACPI_SFAN
7844 * 	EC 0x2f (HFSP) not available if GFAN exists
7845 *
7846 * TPACPI_FAN_WR_ACPI_SFAN:
7847 * 	ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7848 *
7849 * 	EC 0x2f (HFSP) might be available *for reading*, but do not use
7850 * 	it for writing.
7851 *
7852 * TPACPI_FAN_WR_TPEC:
7853 * 	ThinkPad EC register 0x2f (HFSP): fan control loop mode
7854 * 	Supported on almost all ThinkPads
7855 *
7856 * 	Fan speed changes of any sort (including those caused by the
7857 * 	disengaged mode) are usually done slowly by the firmware as the
7858 * 	maximum amount of fan duty cycle change per second seems to be
7859 * 	limited.
7860 *
7861 * 	Reading is not available if GFAN exists.
7862 * 	Writing is not available if SFAN exists.
7863 *
7864 * 	Bits
7865 *	 7	automatic mode engaged;
7866 *  		(default operation mode of the ThinkPad)
7867 * 		fan level is ignored in this mode.
7868 *	 6	full speed mode (takes precedence over bit 7);
7869 *		not available on all thinkpads.  May disable
7870 *		the tachometer while the fan controller ramps up
7871 *		the speed (which can take up to a few *minutes*).
7872 *		Speeds up fan to 100% duty-cycle, which is far above
7873 *		the standard RPM levels.  It is not impossible that
7874 *		it could cause hardware damage.
7875 *	5-3	unused in some models.  Extra bits for fan level
7876 *		in others, but still useless as all values above
7877 *		7 map to the same speed as level 7 in these models.
7878 *	2-0	fan level (0..7 usually)
7879 *			0x00 = stop
7880 * 			0x07 = max (set when temperatures critical)
7881 * 		Some ThinkPads may have other levels, see
7882 * 		TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7883 *
7884 *	FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7885 *	boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7886 *	does so, its initial value is meaningless (0x07).
7887 *
7888 *	For firmware bugs, refer to:
7889 *	https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7890 *
7891 * 	----
7892 *
7893 *	ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7894 *	Main fan tachometer reading (in RPM)
7895 *
7896 *	This register is present on all ThinkPads with a new-style EC, and
7897 *	it is known not to be present on the A21m/e, and T22, as there is
7898 *	something else in offset 0x84 according to the ACPI DSDT.  Other
7899 *	ThinkPads from this same time period (and earlier) probably lack the
7900 *	tachometer as well.
7901 *
7902 *	Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7903 *	was never fixed by IBM to report the EC firmware version string
7904 *	probably support the tachometer (like the early X models), so
7905 *	detecting it is quite hard.  We need more data to know for sure.
7906 *
7907 *	FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7908 *	might result.
7909 *
7910 *	FIRMWARE BUG: may go stale while the EC is switching to full speed
7911 *	mode.
7912 *
7913 *	For firmware bugs, refer to:
7914 *	https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7915 *
7916 *	----
7917 *
7918 *	ThinkPad EC register 0x31 bit 0 (only on select models)
7919 *
7920 *	When bit 0 of EC register 0x31 is zero, the tachometer registers
7921 *	show the speed of the main fan.  When bit 0 of EC register 0x31
7922 *	is one, the tachometer registers show the speed of the auxiliary
7923 *	fan.
7924 *
7925 *	Fan control seems to affect both fans, regardless of the state
7926 *	of this bit.
7927 *
7928 *	So far, only the firmware for the X60/X61 non-tablet versions
7929 *	seem to support this (firmware TP-7M).
7930 *
7931 * TPACPI_FAN_WR_ACPI_FANS:
7932 *	ThinkPad X31, X40, X41.  Not available in the X60.
7933 *
7934 *	FANS ACPI handle: takes three arguments: low speed, medium speed,
7935 *	high speed.  ACPI DSDT seems to map these three speeds to levels
7936 *	as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7937 *	(this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7938 *
7939 * 	The speeds are stored on handles
7940 * 	(FANA:FAN9), (FANC:FANB), (FANE:FAND).
7941 *
7942 * 	There are three default speed sets, accessible as handles:
7943 * 	FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7944 *
7945 * 	ACPI DSDT switches which set is in use depending on various
7946 * 	factors.
7947 *
7948 * 	TPACPI_FAN_WR_TPEC is also available and should be used to
7949 * 	command the fan.  The X31/X40/X41 seems to have 8 fan levels,
7950 * 	but the ACPI tables just mention level 7.
7951 *
7952 * TPACPI_FAN_RD_TPEC_NS:
7953 *	This mode is used for a few ThinkPads (L13 Yoga Gen2, X13 Yoga Gen2 etc.)
7954 *	that are using non-standard EC locations for reporting fan speeds.
7955 *	Currently these platforms only provide fan rpm reporting.
7956 *
7957 */
7958
7959#define FAN_RPM_CAL_CONST 491520	/* FAN RPM calculation offset for some non-standard ECFW */
7960
7961#define FAN_NS_CTRL_STATUS	BIT(2)		/* Bit which determines control is enabled or not */
7962#define FAN_NS_CTRL		BIT(4)		/* Bit which determines control is by host or EC */
7963
7964enum {					/* Fan control constants */
7965	fan_status_offset = 0x2f,	/* EC register 0x2f */
7966	fan_rpm_offset = 0x84,		/* EC register 0x84: LSB, 0x85 MSB (RPM)
7967					 * 0x84 must be read before 0x85 */
7968	fan_select_offset = 0x31,	/* EC register 0x31 (Firmware 7M)
7969					   bit 0 selects which fan is active */
7970
7971	fan_status_offset_ns = 0x93,	/* Special status/control offset for non-standard EC Fan1 */
7972	fan2_status_offset_ns = 0x96,	/* Special status/control offset for non-standard EC Fan2 */
7973	fan_rpm_status_ns = 0x95,	/* Special offset for Fan1 RPM status for non-standard EC */
7974	fan2_rpm_status_ns = 0x98,	/* Special offset for Fan2 RPM status for non-standard EC */
7975
7976	TP_EC_FAN_FULLSPEED = 0x40,	/* EC fan mode: full speed */
7977	TP_EC_FAN_AUTO	    = 0x80,	/* EC fan mode: auto fan control */
7978
7979	TPACPI_FAN_LAST_LEVEL = 0x100,	/* Use cached last-seen fan level */
7980};
7981
7982enum fan_status_access_mode {
7983	TPACPI_FAN_NONE = 0,		/* No fan status or control */
7984	TPACPI_FAN_RD_ACPI_GFAN,	/* Use ACPI GFAN */
7985	TPACPI_FAN_RD_TPEC,		/* Use ACPI EC regs 0x2f, 0x84-0x85 */
7986	TPACPI_FAN_RD_TPEC_NS,		/* Use non-standard ACPI EC regs (eg: L13 Yoga gen2 etc.) */
7987};
7988
7989enum fan_control_access_mode {
7990	TPACPI_FAN_WR_NONE = 0,		/* No fan control */
7991	TPACPI_FAN_WR_ACPI_SFAN,	/* Use ACPI SFAN */
7992	TPACPI_FAN_WR_TPEC,		/* Use ACPI EC reg 0x2f */
7993	TPACPI_FAN_WR_ACPI_FANS,	/* Use ACPI FANS and EC reg 0x2f */
7994};
7995
7996enum fan_control_commands {
7997	TPACPI_FAN_CMD_SPEED 	= 0x0001,	/* speed command */
7998	TPACPI_FAN_CMD_LEVEL 	= 0x0002,	/* level command  */
7999	TPACPI_FAN_CMD_ENABLE	= 0x0004,	/* enable/disable cmd,
8000						 * and also watchdog cmd */
8001};
8002
8003static bool fan_control_allowed;
8004
8005static enum fan_status_access_mode fan_status_access_mode;
8006static enum fan_control_access_mode fan_control_access_mode;
8007static enum fan_control_commands fan_control_commands;
8008
8009static u8 fan_control_initial_status;
8010static u8 fan_control_desired_level;
8011static u8 fan_control_resume_level;
8012static int fan_watchdog_maxinterval;
8013
8014static bool fan_with_ns_addr;
8015
8016static struct mutex fan_mutex;
8017
8018static void fan_watchdog_fire(struct work_struct *ignored);
8019static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
8020
8021TPACPI_HANDLE(fans, ec, "FANS");	/* X31, X40, X41 */
8022TPACPI_HANDLE(gfan, ec, "GFAN",	/* 570 */
8023	   "\\FSPD",		/* 600e/x, 770e, 770x */
8024	   );			/* all others */
8025TPACPI_HANDLE(sfan, ec, "SFAN",	/* 570 */
8026	   "JFNS",		/* 770x-JL */
8027	   );			/* all others */
8028
8029/*
8030 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
8031 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
8032 * be in auto mode (0x80).
8033 *
8034 * This is corrected by any write to HFSP either by the driver, or
8035 * by the firmware.
8036 *
8037 * We assume 0x07 really means auto mode while this quirk is active,
8038 * as this is far more likely than the ThinkPad being in level 7,
8039 * which is only used by the firmware during thermal emergencies.
8040 *
8041 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
8042 * TP-70 (T43, R52), which are known to be buggy.
8043 */
8044
8045static void fan_quirk1_setup(void)
8046{
8047	if (fan_control_initial_status == 0x07) {
8048		pr_notice("fan_init: initial fan status is unknown, assuming it is in auto mode\n");
8049		tp_features.fan_ctrl_status_undef = 1;
8050	}
8051}
8052
8053static void fan_quirk1_handle(u8 *fan_status)
8054{
8055	if (unlikely(tp_features.fan_ctrl_status_undef)) {
8056		if (*fan_status != fan_control_initial_status) {
8057			/* something changed the HFSP regisnter since
8058			 * driver init time, so it is not undefined
8059			 * anymore */
8060			tp_features.fan_ctrl_status_undef = 0;
8061		} else {
8062			/* Return most likely status. In fact, it
8063			 * might be the only possible status */
8064			*fan_status = TP_EC_FAN_AUTO;
8065		}
8066	}
8067}
8068
8069/* Select main fan on X60/X61, NOOP on others */
8070static bool fan_select_fan1(void)
8071{
8072	if (tp_features.second_fan) {
8073		u8 val;
8074
8075		if (ec_read(fan_select_offset, &val) < 0)
8076			return false;
8077		val &= 0xFEU;
8078		if (ec_write(fan_select_offset, val) < 0)
8079			return false;
8080	}
8081	return true;
8082}
8083
8084/* Select secondary fan on X60/X61 */
8085static bool fan_select_fan2(void)
8086{
8087	u8 val;
8088
8089	if (!tp_features.second_fan)
8090		return false;
8091
8092	if (ec_read(fan_select_offset, &val) < 0)
8093		return false;
8094	val |= 0x01U;
8095	if (ec_write(fan_select_offset, val) < 0)
8096		return false;
8097
8098	return true;
8099}
8100
8101static void fan_update_desired_level(u8 status)
8102{
8103	lockdep_assert_held(&fan_mutex);
8104
8105	if ((status &
8106	     (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8107		if (status > 7)
8108			fan_control_desired_level = 7;
8109		else
8110			fan_control_desired_level = status;
8111	}
8112}
8113
8114static int fan_get_status(u8 *status)
8115{
8116	u8 s;
8117
8118	/* TODO:
8119	 * Add TPACPI_FAN_RD_ACPI_FANS ? */
8120
8121	switch (fan_status_access_mode) {
8122	case TPACPI_FAN_RD_ACPI_GFAN: {
8123		/* 570, 600e/x, 770e, 770x */
8124		int res;
8125
8126		if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
8127			return -EIO;
8128
8129		if (likely(status))
8130			*status = res & 0x07;
8131
8132		break;
8133	}
8134	case TPACPI_FAN_RD_TPEC:
8135		/* all except 570, 600e/x, 770e, 770x */
8136		if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
8137			return -EIO;
8138
8139		if (likely(status)) {
8140			*status = s;
8141			fan_quirk1_handle(status);
8142		}
8143
8144		break;
8145	case TPACPI_FAN_RD_TPEC_NS:
8146		/* Default mode is AUTO which means controlled by EC */
8147		if (!acpi_ec_read(fan_status_offset_ns, &s))
8148			return -EIO;
8149
8150		if (status)
8151			*status = s;
8152
8153		break;
8154
8155	default:
8156		return -ENXIO;
8157	}
8158
8159	return 0;
8160}
8161
8162static int fan_get_status_safe(u8 *status)
8163{
8164	int rc;
8165	u8 s;
8166
8167	if (mutex_lock_killable(&fan_mutex))
8168		return -ERESTARTSYS;
8169	rc = fan_get_status(&s);
8170	/* NS EC doesn't have register with level settings */
8171	if (!rc && !fan_with_ns_addr)
8172		fan_update_desired_level(s);
8173	mutex_unlock(&fan_mutex);
8174
8175	if (rc)
8176		return rc;
8177	if (status)
8178		*status = s;
8179
8180	return 0;
8181}
8182
8183static int fan_get_speed(unsigned int *speed)
8184{
8185	u8 hi, lo;
8186
8187	switch (fan_status_access_mode) {
8188	case TPACPI_FAN_RD_TPEC:
8189		/* all except 570, 600e/x, 770e, 770x */
8190		if (unlikely(!fan_select_fan1()))
8191			return -EIO;
8192		if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
8193			     !acpi_ec_read(fan_rpm_offset + 1, &hi)))
8194			return -EIO;
8195
8196		if (likely(speed))
8197			*speed = (hi << 8) | lo;
8198		break;
8199	case TPACPI_FAN_RD_TPEC_NS:
8200		if (!acpi_ec_read(fan_rpm_status_ns, &lo))
8201			return -EIO;
8202
8203		if (speed)
8204			*speed = lo ? FAN_RPM_CAL_CONST / lo : 0;
8205		break;
8206
8207	default:
8208		return -ENXIO;
8209	}
8210
8211	return 0;
8212}
8213
8214static int fan2_get_speed(unsigned int *speed)
8215{
8216	u8 hi, lo, status;
8217	bool rc;
8218
8219	switch (fan_status_access_mode) {
8220	case TPACPI_FAN_RD_TPEC:
8221		/* all except 570, 600e/x, 770e, 770x */
8222		if (unlikely(!fan_select_fan2()))
8223			return -EIO;
8224		rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
8225			     !acpi_ec_read(fan_rpm_offset + 1, &hi);
8226		fan_select_fan1(); /* play it safe */
8227		if (rc)
8228			return -EIO;
8229
8230		if (likely(speed))
8231			*speed = (hi << 8) | lo;
8232		break;
8233
8234	case TPACPI_FAN_RD_TPEC_NS:
8235		rc = !acpi_ec_read(fan2_status_offset_ns, &status);
8236		if (rc)
8237			return -EIO;
8238		if (!(status & FAN_NS_CTRL_STATUS)) {
8239			pr_info("secondary fan control not supported\n");
8240			return -EIO;
8241		}
8242		rc = !acpi_ec_read(fan2_rpm_status_ns, &lo);
8243		if (rc)
8244			return -EIO;
8245		if (speed)
8246			*speed = lo ? FAN_RPM_CAL_CONST / lo : 0;
8247		break;
8248
8249	default:
8250		return -ENXIO;
8251	}
8252
8253	return 0;
8254}
8255
8256static int fan_set_level(int level)
8257{
8258	if (!fan_control_allowed)
8259		return -EPERM;
8260
8261	switch (fan_control_access_mode) {
8262	case TPACPI_FAN_WR_ACPI_SFAN:
8263		if ((level < 0) || (level > 7))
8264			return -EINVAL;
8265
8266		if (tp_features.second_fan_ctl) {
8267			if (!fan_select_fan2() ||
8268			    !acpi_evalf(sfan_handle, NULL, NULL, "vd", level)) {
8269				pr_warn("Couldn't set 2nd fan level, disabling support\n");
8270				tp_features.second_fan_ctl = 0;
8271			}
8272			fan_select_fan1();
8273		}
8274		if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
8275			return -EIO;
8276		break;
8277
8278	case TPACPI_FAN_WR_ACPI_FANS:
8279	case TPACPI_FAN_WR_TPEC:
8280		if (!(level & TP_EC_FAN_AUTO) &&
8281		    !(level & TP_EC_FAN_FULLSPEED) &&
8282		    ((level < 0) || (level > 7)))
8283			return -EINVAL;
8284
8285		/* safety net should the EC not support AUTO
8286		 * or FULLSPEED mode bits and just ignore them */
8287		if (level & TP_EC_FAN_FULLSPEED)
8288			level |= 7;	/* safety min speed 7 */
8289		else if (level & TP_EC_FAN_AUTO)
8290			level |= 4;	/* safety min speed 4 */
8291
8292		if (tp_features.second_fan_ctl) {
8293			if (!fan_select_fan2() ||
8294			    !acpi_ec_write(fan_status_offset, level)) {
8295				pr_warn("Couldn't set 2nd fan level, disabling support\n");
8296				tp_features.second_fan_ctl = 0;
8297			}
8298			fan_select_fan1();
8299
8300		}
8301		if (!acpi_ec_write(fan_status_offset, level))
8302			return -EIO;
8303		else
8304			tp_features.fan_ctrl_status_undef = 0;
8305		break;
8306
8307	default:
8308		return -ENXIO;
8309	}
8310
8311	vdbg_printk(TPACPI_DBG_FAN,
8312		"fan control: set fan control register to 0x%02x\n", level);
8313	return 0;
8314}
8315
8316static int fan_set_level_safe(int level)
8317{
8318	int rc;
8319
8320	if (!fan_control_allowed)
8321		return -EPERM;
8322
8323	if (mutex_lock_killable(&fan_mutex))
8324		return -ERESTARTSYS;
8325
8326	if (level == TPACPI_FAN_LAST_LEVEL)
8327		level = fan_control_desired_level;
8328
8329	rc = fan_set_level(level);
8330	if (!rc)
8331		fan_update_desired_level(level);
8332
8333	mutex_unlock(&fan_mutex);
8334	return rc;
8335}
8336
8337static int fan_set_enable(void)
8338{
8339	u8 s;
8340	int rc;
8341
8342	if (!fan_control_allowed)
8343		return -EPERM;
8344
8345	if (mutex_lock_killable(&fan_mutex))
8346		return -ERESTARTSYS;
8347
8348	switch (fan_control_access_mode) {
8349	case TPACPI_FAN_WR_ACPI_FANS:
8350	case TPACPI_FAN_WR_TPEC:
8351		rc = fan_get_status(&s);
8352		if (rc)
8353			break;
8354
8355		/* Don't go out of emergency fan mode */
8356		if (s != 7) {
8357			s &= 0x07;
8358			s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
8359		}
8360
8361		if (!acpi_ec_write(fan_status_offset, s))
8362			rc = -EIO;
8363		else {
8364			tp_features.fan_ctrl_status_undef = 0;
8365			rc = 0;
8366		}
8367		break;
8368
8369	case TPACPI_FAN_WR_ACPI_SFAN:
8370		rc = fan_get_status(&s);
8371		if (rc)
8372			break;
8373
8374		s &= 0x07;
8375
8376		/* Set fan to at least level 4 */
8377		s |= 4;
8378
8379		if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
8380			rc = -EIO;
8381		else
8382			rc = 0;
8383		break;
8384
8385	default:
8386		rc = -ENXIO;
8387	}
8388
8389	mutex_unlock(&fan_mutex);
8390
8391	if (!rc)
8392		vdbg_printk(TPACPI_DBG_FAN,
8393			"fan control: set fan control register to 0x%02x\n",
8394			s);
8395	return rc;
8396}
8397
8398static int fan_set_disable(void)
8399{
8400	int rc;
8401
8402	if (!fan_control_allowed)
8403		return -EPERM;
8404
8405	if (mutex_lock_killable(&fan_mutex))
8406		return -ERESTARTSYS;
8407
8408	rc = 0;
8409	switch (fan_control_access_mode) {
8410	case TPACPI_FAN_WR_ACPI_FANS:
8411	case TPACPI_FAN_WR_TPEC:
8412		if (!acpi_ec_write(fan_status_offset, 0x00))
8413			rc = -EIO;
8414		else {
8415			fan_control_desired_level = 0;
8416			tp_features.fan_ctrl_status_undef = 0;
8417		}
8418		break;
8419
8420	case TPACPI_FAN_WR_ACPI_SFAN:
8421		if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
8422			rc = -EIO;
8423		else
8424			fan_control_desired_level = 0;
8425		break;
8426
8427	default:
8428		rc = -ENXIO;
8429	}
8430
8431	if (!rc)
8432		vdbg_printk(TPACPI_DBG_FAN,
8433			"fan control: set fan control register to 0\n");
8434
8435	mutex_unlock(&fan_mutex);
8436	return rc;
8437}
8438
8439static int fan_set_speed(int speed)
8440{
8441	int rc;
8442
8443	if (!fan_control_allowed)
8444		return -EPERM;
8445
8446	if (mutex_lock_killable(&fan_mutex))
8447		return -ERESTARTSYS;
8448
8449	rc = 0;
8450	switch (fan_control_access_mode) {
8451	case TPACPI_FAN_WR_ACPI_FANS:
8452		if (speed >= 0 && speed <= 65535) {
8453			if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
8454					speed, speed, speed))
8455				rc = -EIO;
8456		} else
8457			rc = -EINVAL;
8458		break;
8459
8460	default:
8461		rc = -ENXIO;
8462	}
8463
8464	mutex_unlock(&fan_mutex);
8465	return rc;
8466}
8467
8468static void fan_watchdog_reset(void)
8469{
8470	if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
8471		return;
8472
8473	if (fan_watchdog_maxinterval > 0 &&
8474	    tpacpi_lifecycle != TPACPI_LIFE_EXITING)
8475		mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
8476			msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
8477	else
8478		cancel_delayed_work(&fan_watchdog_task);
8479}
8480
8481static void fan_watchdog_fire(struct work_struct *ignored)
8482{
8483	int rc;
8484
8485	if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
8486		return;
8487
8488	pr_notice("fan watchdog: enabling fan\n");
8489	rc = fan_set_enable();
8490	if (rc < 0) {
8491		pr_err("fan watchdog: error %d while enabling fan, will try again later...\n",
8492		       rc);
8493		/* reschedule for later */
8494		fan_watchdog_reset();
8495	}
8496}
8497
8498/*
8499 * SYSFS fan layout: hwmon compatible (device)
8500 *
8501 * pwm*_enable:
8502 * 	0: "disengaged" mode
8503 * 	1: manual mode
8504 * 	2: native EC "auto" mode (recommended, hardware default)
8505 *
8506 * pwm*: set speed in manual mode, ignored otherwise.
8507 * 	0 is level 0; 255 is level 7. Intermediate points done with linear
8508 * 	interpolation.
8509 *
8510 * fan*_input: tachometer reading, RPM
8511 *
8512 *
8513 * SYSFS fan layout: extensions
8514 *
8515 * fan_watchdog (driver):
8516 * 	fan watchdog interval in seconds, 0 disables (default), max 120
8517 */
8518
8519/* sysfs fan pwm1_enable ----------------------------------------------- */
8520static ssize_t fan_pwm1_enable_show(struct device *dev,
8521				    struct device_attribute *attr,
8522				    char *buf)
8523{
8524	int res, mode;
8525	u8 status;
8526
8527	res = fan_get_status_safe(&status);
8528	if (res)
8529		return res;
8530
8531	if (status & TP_EC_FAN_FULLSPEED) {
8532		mode = 0;
8533	} else if (status & TP_EC_FAN_AUTO) {
8534		mode = 2;
8535	} else
8536		mode = 1;
8537
8538	return sysfs_emit(buf, "%d\n", mode);
8539}
8540
8541static ssize_t fan_pwm1_enable_store(struct device *dev,
8542				     struct device_attribute *attr,
8543				     const char *buf, size_t count)
8544{
8545	unsigned long t;
8546	int res, level;
8547
8548	if (parse_strtoul(buf, 2, &t))
8549		return -EINVAL;
8550
8551	tpacpi_disclose_usertask("hwmon pwm1_enable",
8552			"set fan mode to %lu\n", t);
8553
8554	switch (t) {
8555	case 0:
8556		level = TP_EC_FAN_FULLSPEED;
8557		break;
8558	case 1:
8559		level = TPACPI_FAN_LAST_LEVEL;
8560		break;
8561	case 2:
8562		level = TP_EC_FAN_AUTO;
8563		break;
8564	case 3:
8565		/* reserved for software-controlled auto mode */
8566		return -ENOSYS;
8567	default:
8568		return -EINVAL;
8569	}
8570
8571	res = fan_set_level_safe(level);
8572	if (res == -ENXIO)
8573		return -EINVAL;
8574	else if (res < 0)
8575		return res;
8576
8577	fan_watchdog_reset();
8578
8579	return count;
8580}
8581
8582static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
8583		   fan_pwm1_enable_show, fan_pwm1_enable_store);
8584
8585/* sysfs fan pwm1 ------------------------------------------------------ */
8586static ssize_t fan_pwm1_show(struct device *dev,
8587			     struct device_attribute *attr,
8588			     char *buf)
8589{
8590	int res;
8591	u8 status;
8592
8593	res = fan_get_status_safe(&status);
8594	if (res)
8595		return res;
8596
8597	if ((status &
8598	     (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
8599		status = fan_control_desired_level;
8600
8601	if (status > 7)
8602		status = 7;
8603
8604	return sysfs_emit(buf, "%u\n", (status * 255) / 7);
8605}
8606
8607static ssize_t fan_pwm1_store(struct device *dev,
8608			      struct device_attribute *attr,
8609			      const char *buf, size_t count)
8610{
8611	unsigned long s;
8612	int rc;
8613	u8 status, newlevel;
8614
8615	if (parse_strtoul(buf, 255, &s))
8616		return -EINVAL;
8617
8618	tpacpi_disclose_usertask("hwmon pwm1",
8619			"set fan speed to %lu\n", s);
8620
8621	/* scale down from 0-255 to 0-7 */
8622	newlevel = (s >> 5) & 0x07;
8623
8624	if (mutex_lock_killable(&fan_mutex))
8625		return -ERESTARTSYS;
8626
8627	rc = fan_get_status(&status);
8628	if (!rc && (status &
8629		    (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8630		rc = fan_set_level(newlevel);
8631		if (rc == -ENXIO)
8632			rc = -EINVAL;
8633		else if (!rc) {
8634			fan_update_desired_level(newlevel);
8635			fan_watchdog_reset();
8636		}
8637	}
8638
8639	mutex_unlock(&fan_mutex);
8640	return (rc) ? rc : count;
8641}
8642
8643static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, fan_pwm1_show, fan_pwm1_store);
8644
8645/* sysfs fan fan1_input ------------------------------------------------ */
8646static ssize_t fan_fan1_input_show(struct device *dev,
8647			   struct device_attribute *attr,
8648			   char *buf)
8649{
8650	int res;
8651	unsigned int speed;
8652
8653	res = fan_get_speed(&speed);
8654	if (res < 0)
8655		return res;
8656
8657	return sysfs_emit(buf, "%u\n", speed);
8658}
8659
8660static DEVICE_ATTR(fan1_input, S_IRUGO, fan_fan1_input_show, NULL);
8661
8662/* sysfs fan fan2_input ------------------------------------------------ */
8663static ssize_t fan_fan2_input_show(struct device *dev,
8664			   struct device_attribute *attr,
8665			   char *buf)
8666{
8667	int res;
8668	unsigned int speed;
8669
8670	res = fan2_get_speed(&speed);
8671	if (res < 0)
8672		return res;
8673
8674	return sysfs_emit(buf, "%u\n", speed);
8675}
8676
8677static DEVICE_ATTR(fan2_input, S_IRUGO, fan_fan2_input_show, NULL);
8678
8679/* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8680static ssize_t fan_watchdog_show(struct device_driver *drv, char *buf)
8681{
8682	return sysfs_emit(buf, "%u\n", fan_watchdog_maxinterval);
8683}
8684
8685static ssize_t fan_watchdog_store(struct device_driver *drv, const char *buf,
8686				  size_t count)
8687{
8688	unsigned long t;
8689
8690	if (parse_strtoul(buf, 120, &t))
8691		return -EINVAL;
8692
8693	if (!fan_control_allowed)
8694		return -EPERM;
8695
8696	fan_watchdog_maxinterval = t;
8697	fan_watchdog_reset();
8698
8699	tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8700
8701	return count;
8702}
8703static DRIVER_ATTR_RW(fan_watchdog);
8704
8705/* --------------------------------------------------------------------- */
8706
8707static struct attribute *fan_attributes[] = {
8708	&dev_attr_pwm1_enable.attr,
8709	&dev_attr_pwm1.attr,
8710	&dev_attr_fan1_input.attr,
8711	&dev_attr_fan2_input.attr,
8712	NULL
8713};
8714
8715static umode_t fan_attr_is_visible(struct kobject *kobj, struct attribute *attr,
8716				   int n)
8717{
8718	if (fan_status_access_mode == TPACPI_FAN_NONE &&
8719	    fan_control_access_mode == TPACPI_FAN_WR_NONE)
8720		return 0;
8721
8722	if (attr == &dev_attr_fan2_input.attr) {
8723		if (!tp_features.second_fan)
8724			return 0;
8725	}
8726
8727	return attr->mode;
8728}
8729
8730static const struct attribute_group fan_attr_group = {
8731	.is_visible = fan_attr_is_visible,
8732	.attrs = fan_attributes,
8733};
8734
8735static struct attribute *fan_driver_attributes[] = {
8736	&driver_attr_fan_watchdog.attr,
8737	NULL
8738};
8739
8740static const struct attribute_group fan_driver_attr_group = {
8741	.is_visible = fan_attr_is_visible,
8742	.attrs = fan_driver_attributes,
8743};
8744
8745#define TPACPI_FAN_Q1		0x0001		/* Uninitialized HFSP */
8746#define TPACPI_FAN_2FAN		0x0002		/* EC 0x31 bit 0 selects fan2 */
8747#define TPACPI_FAN_2CTL		0x0004		/* selects fan2 control */
8748#define TPACPI_FAN_NOFAN	0x0008		/* no fan available */
8749#define TPACPI_FAN_NS		0x0010		/* For EC with non-Standard register addresses */
8750
8751static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8752	TPACPI_QEC_IBM('1', 'Y', TPACPI_FAN_Q1),
8753	TPACPI_QEC_IBM('7', '8', TPACPI_FAN_Q1),
8754	TPACPI_QEC_IBM('7', '6', TPACPI_FAN_Q1),
8755	TPACPI_QEC_IBM('7', '0', TPACPI_FAN_Q1),
8756	TPACPI_QEC_LNV('7', 'M', TPACPI_FAN_2FAN),
8757	TPACPI_Q_LNV('N', '1', TPACPI_FAN_2FAN),
8758	TPACPI_Q_LNV3('N', '1', 'D', TPACPI_FAN_2CTL),	/* P70 */
8759	TPACPI_Q_LNV3('N', '1', 'E', TPACPI_FAN_2CTL),	/* P50 */
8760	TPACPI_Q_LNV3('N', '1', 'T', TPACPI_FAN_2CTL),	/* P71 */
8761	TPACPI_Q_LNV3('N', '1', 'U', TPACPI_FAN_2CTL),	/* P51 */
8762	TPACPI_Q_LNV3('N', '2', 'C', TPACPI_FAN_2CTL),	/* P52 / P72 */
8763	TPACPI_Q_LNV3('N', '2', 'N', TPACPI_FAN_2CTL),	/* P53 / P73 */
8764	TPACPI_Q_LNV3('N', '2', 'E', TPACPI_FAN_2CTL),	/* P1 / X1 Extreme (1st gen) */
8765	TPACPI_Q_LNV3('N', '2', 'O', TPACPI_FAN_2CTL),	/* P1 / X1 Extreme (2nd gen) */
8766	TPACPI_Q_LNV3('N', '3', '0', TPACPI_FAN_2CTL),	/* P15 (1st gen) / P15v (1st gen) */
8767	TPACPI_Q_LNV3('N', '3', '7', TPACPI_FAN_2CTL),  /* T15g (2nd gen) */
8768	TPACPI_Q_LNV3('R', '1', 'F', TPACPI_FAN_NS),	/* L13 Yoga Gen 2 */
8769	TPACPI_Q_LNV3('N', '2', 'U', TPACPI_FAN_NS),	/* X13 Yoga Gen 2*/
8770	TPACPI_Q_LNV3('N', '1', 'O', TPACPI_FAN_NOFAN),	/* X1 Tablet (2nd gen) */
8771};
8772
8773static int __init fan_init(struct ibm_init_struct *iibm)
8774{
8775	unsigned long quirks;
8776
8777	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8778			"initializing fan subdriver\n");
8779
8780	mutex_init(&fan_mutex);
8781	fan_status_access_mode = TPACPI_FAN_NONE;
8782	fan_control_access_mode = TPACPI_FAN_WR_NONE;
8783	fan_control_commands = 0;
8784	fan_watchdog_maxinterval = 0;
8785	tp_features.fan_ctrl_status_undef = 0;
8786	tp_features.second_fan = 0;
8787	tp_features.second_fan_ctl = 0;
8788	fan_control_desired_level = 7;
8789
8790	if (tpacpi_is_ibm()) {
8791		TPACPI_ACPIHANDLE_INIT(fans);
8792		TPACPI_ACPIHANDLE_INIT(gfan);
8793		TPACPI_ACPIHANDLE_INIT(sfan);
8794	}
8795
8796	quirks = tpacpi_check_quirks(fan_quirk_table,
8797				     ARRAY_SIZE(fan_quirk_table));
8798
8799	if (quirks & TPACPI_FAN_NOFAN) {
8800		pr_info("No integrated ThinkPad fan available\n");
8801		return -ENODEV;
8802	}
8803
8804	if (quirks & TPACPI_FAN_NS) {
8805		pr_info("ECFW with non-standard fan reg control found\n");
8806		fan_with_ns_addr = 1;
8807		/* Fan ctrl support from host is undefined for now */
8808		tp_features.fan_ctrl_status_undef = 1;
8809	}
8810
8811	if (gfan_handle) {
8812		/* 570, 600e/x, 770e, 770x */
8813		fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8814	} else {
8815		/* all other ThinkPads: note that even old-style
8816		 * ThinkPad ECs supports the fan control register */
8817		if (fan_with_ns_addr ||
8818		    likely(acpi_ec_read(fan_status_offset, &fan_control_initial_status))) {
8819			int res;
8820			unsigned int speed;
8821
8822			fan_status_access_mode = fan_with_ns_addr ?
8823				TPACPI_FAN_RD_TPEC_NS : TPACPI_FAN_RD_TPEC;
8824
8825			if (quirks & TPACPI_FAN_Q1)
8826				fan_quirk1_setup();
8827			/* Try and probe the 2nd fan */
8828			tp_features.second_fan = 1; /* needed for get_speed to work */
8829			res = fan2_get_speed(&speed);
8830			if (res >= 0 && speed != FAN_NOT_PRESENT) {
8831				/* It responded - so let's assume it's there */
8832				tp_features.second_fan = 1;
8833				/* fan control not currently available for ns ECFW */
8834				tp_features.second_fan_ctl = !fan_with_ns_addr;
8835				pr_info("secondary fan control detected & enabled\n");
8836			} else {
8837				/* Fan not auto-detected */
8838				tp_features.second_fan = 0;
8839				if (quirks & TPACPI_FAN_2FAN) {
8840					tp_features.second_fan = 1;
8841					pr_info("secondary fan support enabled\n");
8842				}
8843				if (quirks & TPACPI_FAN_2CTL) {
8844					tp_features.second_fan = 1;
8845					tp_features.second_fan_ctl = 1;
8846					pr_info("secondary fan control enabled\n");
8847				}
8848			}
8849		} else {
8850			pr_err("ThinkPad ACPI EC access misbehaving, fan status and control unavailable\n");
8851			return -ENODEV;
8852		}
8853	}
8854
8855	if (sfan_handle) {
8856		/* 570, 770x-JL */
8857		fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8858		fan_control_commands |=
8859		    TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8860	} else {
8861		if (!gfan_handle) {
8862			/* gfan without sfan means no fan control */
8863			/* all other models implement TP EC 0x2f control */
8864
8865			if (fans_handle) {
8866				/* X31, X40, X41 */
8867				fan_control_access_mode =
8868				    TPACPI_FAN_WR_ACPI_FANS;
8869				fan_control_commands |=
8870				    TPACPI_FAN_CMD_SPEED |
8871				    TPACPI_FAN_CMD_LEVEL |
8872				    TPACPI_FAN_CMD_ENABLE;
8873			} else {
8874				fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8875				fan_control_commands |=
8876				    TPACPI_FAN_CMD_LEVEL |
8877				    TPACPI_FAN_CMD_ENABLE;
8878			}
8879		}
8880	}
8881
8882	vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8883		"fan is %s, modes %d, %d\n",
8884		str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8885		  fan_control_access_mode != TPACPI_FAN_WR_NONE),
8886		fan_status_access_mode, fan_control_access_mode);
8887
8888	/* fan control master switch */
8889	if (!fan_control_allowed) {
8890		fan_control_access_mode = TPACPI_FAN_WR_NONE;
8891		fan_control_commands = 0;
8892		dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8893			   "fan control features disabled by parameter\n");
8894	}
8895
8896	/* update fan_control_desired_level */
8897	if (fan_status_access_mode != TPACPI_FAN_NONE)
8898		fan_get_status_safe(NULL);
8899
8900	if (fan_status_access_mode == TPACPI_FAN_NONE &&
8901	    fan_control_access_mode == TPACPI_FAN_WR_NONE)
8902		return -ENODEV;
8903
8904	return 0;
8905}
8906
8907static void fan_exit(void)
8908{
8909	vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8910		    "cancelling any pending fan watchdog tasks\n");
8911
8912	cancel_delayed_work(&fan_watchdog_task);
8913	flush_workqueue(tpacpi_wq);
8914}
8915
8916static void fan_suspend(void)
8917{
8918	int rc;
8919
8920	if (!fan_control_allowed)
8921		return;
8922
8923	/* Store fan status in cache */
8924	fan_control_resume_level = 0;
8925	rc = fan_get_status_safe(&fan_control_resume_level);
8926	if (rc)
8927		pr_notice("failed to read fan level for later restore during resume: %d\n",
8928			  rc);
8929
8930	/* if it is undefined, don't attempt to restore it.
8931	 * KEEP THIS LAST */
8932	if (tp_features.fan_ctrl_status_undef)
8933		fan_control_resume_level = 0;
8934}
8935
8936static void fan_resume(void)
8937{
8938	u8 current_level = 7;
8939	bool do_set = false;
8940	int rc;
8941
8942	/* DSDT *always* updates status on resume */
8943	tp_features.fan_ctrl_status_undef = 0;
8944
8945	if (!fan_control_allowed ||
8946	    !fan_control_resume_level ||
8947	    fan_get_status_safe(&current_level))
8948		return;
8949
8950	switch (fan_control_access_mode) {
8951	case TPACPI_FAN_WR_ACPI_SFAN:
8952		/* never decrease fan level */
8953		do_set = (fan_control_resume_level > current_level);
8954		break;
8955	case TPACPI_FAN_WR_ACPI_FANS:
8956	case TPACPI_FAN_WR_TPEC:
8957		/* never decrease fan level, scale is:
8958		 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8959		 *
8960		 * We expect the firmware to set either 7 or AUTO, but we
8961		 * handle FULLSPEED out of paranoia.
8962		 *
8963		 * So, we can safely only restore FULLSPEED or 7, anything
8964		 * else could slow the fan.  Restoring AUTO is useless, at
8965		 * best that's exactly what the DSDT already set (it is the
8966		 * slower it uses).
8967		 *
8968		 * Always keep in mind that the DSDT *will* have set the
8969		 * fans to what the vendor supposes is the best level.  We
8970		 * muck with it only to speed the fan up.
8971		 */
8972		if (fan_control_resume_level != 7 &&
8973		    !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8974			return;
8975		else
8976			do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8977				 (current_level != fan_control_resume_level);
8978		break;
8979	default:
8980		return;
8981	}
8982	if (do_set) {
8983		pr_notice("restoring fan level to 0x%02x\n",
8984			  fan_control_resume_level);
8985		rc = fan_set_level_safe(fan_control_resume_level);
8986		if (rc < 0)
8987			pr_notice("failed to restore fan level: %d\n", rc);
8988	}
8989}
8990
8991static int fan_read(struct seq_file *m)
8992{
8993	int rc;
8994	u8 status;
8995	unsigned int speed = 0;
8996
8997	switch (fan_status_access_mode) {
8998	case TPACPI_FAN_RD_ACPI_GFAN:
8999		/* 570, 600e/x, 770e, 770x */
9000		rc = fan_get_status_safe(&status);
9001		if (rc)
9002			return rc;
9003
9004		seq_printf(m, "status:\t\t%s\n"
9005			       "level:\t\t%d\n",
9006			       str_enabled_disabled(status), status);
9007		break;
9008
9009	case TPACPI_FAN_RD_TPEC_NS:
9010	case TPACPI_FAN_RD_TPEC:
9011		/* all except 570, 600e/x, 770e, 770x */
9012		rc = fan_get_status_safe(&status);
9013		if (rc)
9014			return rc;
9015
9016		seq_printf(m, "status:\t\t%s\n", str_enabled_disabled(status));
9017
9018		rc = fan_get_speed(&speed);
9019		if (rc < 0)
9020			return rc;
9021
9022		seq_printf(m, "speed:\t\t%d\n", speed);
9023
9024		if (fan_status_access_mode == TPACPI_FAN_RD_TPEC_NS) {
9025			/*
9026			 * No full speed bit in NS EC
9027			 * EC Auto mode is set by default.
9028			 * No other levels settings available
9029			 */
9030			seq_printf(m, "level:\t\t%s\n", status & FAN_NS_CTRL ? "unknown" : "auto");
9031		} else {
9032			if (status & TP_EC_FAN_FULLSPEED)
9033				/* Disengaged mode takes precedence */
9034				seq_printf(m, "level:\t\tdisengaged\n");
9035			else if (status & TP_EC_FAN_AUTO)
9036				seq_printf(m, "level:\t\tauto\n");
9037			else
9038				seq_printf(m, "level:\t\t%d\n", status);
9039		}
9040		break;
9041
9042	case TPACPI_FAN_NONE:
9043	default:
9044		seq_printf(m, "status:\t\tnot supported\n");
9045	}
9046
9047	if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
9048		seq_printf(m, "commands:\tlevel <level>");
9049
9050		switch (fan_control_access_mode) {
9051		case TPACPI_FAN_WR_ACPI_SFAN:
9052			seq_printf(m, " (<level> is 0-7)\n");
9053			break;
9054
9055		default:
9056			seq_printf(m, " (<level> is 0-7, auto, disengaged, full-speed)\n");
9057			break;
9058		}
9059	}
9060
9061	if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
9062		seq_printf(m, "commands:\tenable, disable\n"
9063			       "commands:\twatchdog <timeout> (<timeout> is 0 (off), 1-120 (seconds))\n");
9064
9065	if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
9066		seq_printf(m, "commands:\tspeed <speed> (<speed> is 0-65535)\n");
9067
9068	return 0;
9069}
9070
9071static int fan_write_cmd_level(const char *cmd, int *rc)
9072{
9073	int level;
9074
9075	if (strstarts(cmd, "level auto"))
9076		level = TP_EC_FAN_AUTO;
9077	else if (strstarts(cmd, "level disengaged") || strstarts(cmd, "level full-speed"))
9078		level = TP_EC_FAN_FULLSPEED;
9079	else if (sscanf(cmd, "level %d", &level) != 1)
9080		return 0;
9081
9082	*rc = fan_set_level_safe(level);
9083	if (*rc == -ENXIO)
9084		pr_err("level command accepted for unsupported access mode %d\n",
9085		       fan_control_access_mode);
9086	else if (!*rc)
9087		tpacpi_disclose_usertask("procfs fan",
9088			"set level to %d\n", level);
9089
9090	return 1;
9091}
9092
9093static int fan_write_cmd_enable(const char *cmd, int *rc)
9094{
9095	if (!strstarts(cmd, "enable"))
9096		return 0;
9097
9098	*rc = fan_set_enable();
9099	if (*rc == -ENXIO)
9100		pr_err("enable command accepted for unsupported access mode %d\n",
9101		       fan_control_access_mode);
9102	else if (!*rc)
9103		tpacpi_disclose_usertask("procfs fan", "enable\n");
9104
9105	return 1;
9106}
9107
9108static int fan_write_cmd_disable(const char *cmd, int *rc)
9109{
9110	if (!strstarts(cmd, "disable"))
9111		return 0;
9112
9113	*rc = fan_set_disable();
9114	if (*rc == -ENXIO)
9115		pr_err("disable command accepted for unsupported access mode %d\n",
9116		       fan_control_access_mode);
9117	else if (!*rc)
9118		tpacpi_disclose_usertask("procfs fan", "disable\n");
9119
9120	return 1;
9121}
9122
9123static int fan_write_cmd_speed(const char *cmd, int *rc)
9124{
9125	int speed;
9126
9127	/* TODO:
9128	 * Support speed <low> <medium> <high> ? */
9129
9130	if (sscanf(cmd, "speed %d", &speed) != 1)
9131		return 0;
9132
9133	*rc = fan_set_speed(speed);
9134	if (*rc == -ENXIO)
9135		pr_err("speed command accepted for unsupported access mode %d\n",
9136		       fan_control_access_mode);
9137	else if (!*rc)
9138		tpacpi_disclose_usertask("procfs fan",
9139			"set speed to %d\n", speed);
9140
9141	return 1;
9142}
9143
9144static int fan_write_cmd_watchdog(const char *cmd, int *rc)
9145{
9146	int interval;
9147
9148	if (sscanf(cmd, "watchdog %d", &interval) != 1)
9149		return 0;
9150
9151	if (interval < 0 || interval > 120)
9152		*rc = -EINVAL;
9153	else {
9154		fan_watchdog_maxinterval = interval;
9155		tpacpi_disclose_usertask("procfs fan",
9156			"set watchdog timer to %d\n",
9157			interval);
9158	}
9159
9160	return 1;
9161}
9162
9163static int fan_write(char *buf)
9164{
9165	char *cmd;
9166	int rc = 0;
9167
9168	while (!rc && (cmd = strsep(&buf, ","))) {
9169		if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
9170		      fan_write_cmd_level(cmd, &rc)) &&
9171		    !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
9172		      (fan_write_cmd_enable(cmd, &rc) ||
9173		       fan_write_cmd_disable(cmd, &rc) ||
9174		       fan_write_cmd_watchdog(cmd, &rc))) &&
9175		    !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
9176		      fan_write_cmd_speed(cmd, &rc))
9177		    )
9178			rc = -EINVAL;
9179		else if (!rc)
9180			fan_watchdog_reset();
9181	}
9182
9183	return rc;
9184}
9185
9186static struct ibm_struct fan_driver_data = {
9187	.name = "fan",
9188	.read = fan_read,
9189	.write = fan_write,
9190	.exit = fan_exit,
9191	.suspend = fan_suspend,
9192	.resume = fan_resume,
9193};
9194
9195/*************************************************************************
9196 * Mute LED subdriver
9197 */
9198
9199#define TPACPI_LED_MAX		2
9200
9201struct tp_led_table {
9202	acpi_string name;
9203	int on_value;
9204	int off_value;
9205	int state;
9206};
9207
9208static struct tp_led_table led_tables[TPACPI_LED_MAX] = {
9209	[LED_AUDIO_MUTE] = {
9210		.name = "SSMS",
9211		.on_value = 1,
9212		.off_value = 0,
9213	},
9214	[LED_AUDIO_MICMUTE] = {
9215		.name = "MMTS",
9216		.on_value = 2,
9217		.off_value = 0,
9218	},
9219};
9220
9221static int mute_led_on_off(struct tp_led_table *t, bool state)
9222{
9223	acpi_handle temp;
9224	int output;
9225
9226	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9227		pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
9228		return -EIO;
9229	}
9230
9231	if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
9232			state ? t->on_value : t->off_value))
9233		return -EIO;
9234
9235	t->state = state;
9236	return state;
9237}
9238
9239static int tpacpi_led_set(int whichled, bool on)
9240{
9241	struct tp_led_table *t;
9242
9243	t = &led_tables[whichled];
9244	if (t->state < 0 || t->state == on)
9245		return t->state;
9246	return mute_led_on_off(t, on);
9247}
9248
9249static int tpacpi_led_mute_set(struct led_classdev *led_cdev,
9250			       enum led_brightness brightness)
9251{
9252	return tpacpi_led_set(LED_AUDIO_MUTE, brightness != LED_OFF);
9253}
9254
9255static int tpacpi_led_micmute_set(struct led_classdev *led_cdev,
9256				  enum led_brightness brightness)
9257{
9258	return tpacpi_led_set(LED_AUDIO_MICMUTE, brightness != LED_OFF);
9259}
9260
9261static struct led_classdev mute_led_cdev[TPACPI_LED_MAX] = {
9262	[LED_AUDIO_MUTE] = {
9263		.name		= "platform::mute",
9264		.max_brightness = 1,
9265		.brightness_set_blocking = tpacpi_led_mute_set,
9266		.default_trigger = "audio-mute",
9267	},
9268	[LED_AUDIO_MICMUTE] = {
9269		.name		= "platform::micmute",
9270		.max_brightness = 1,
9271		.brightness_set_blocking = tpacpi_led_micmute_set,
9272		.default_trigger = "audio-micmute",
9273	},
9274};
9275
9276static int mute_led_init(struct ibm_init_struct *iibm)
9277{
9278	acpi_handle temp;
9279	int i, err;
9280
9281	for (i = 0; i < TPACPI_LED_MAX; i++) {
9282		struct tp_led_table *t = &led_tables[i];
9283		if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9284			t->state = -ENODEV;
9285			continue;
9286		}
9287
9288		mute_led_cdev[i].brightness = ledtrig_audio_get(i);
9289		err = led_classdev_register(&tpacpi_pdev->dev, &mute_led_cdev[i]);
9290		if (err < 0) {
9291			while (i--)
9292				led_classdev_unregister(&mute_led_cdev[i]);
9293			return err;
9294		}
9295	}
9296	return 0;
9297}
9298
9299static void mute_led_exit(void)
9300{
9301	int i;
9302
9303	for (i = 0; i < TPACPI_LED_MAX; i++) {
9304		led_classdev_unregister(&mute_led_cdev[i]);
9305		tpacpi_led_set(i, false);
9306	}
9307}
9308
9309static void mute_led_resume(void)
9310{
9311	int i;
9312
9313	for (i = 0; i < TPACPI_LED_MAX; i++) {
9314		struct tp_led_table *t = &led_tables[i];
9315		if (t->state >= 0)
9316			mute_led_on_off(t, t->state);
9317	}
9318}
9319
9320static struct ibm_struct mute_led_driver_data = {
9321	.name = "mute_led",
9322	.exit = mute_led_exit,
9323	.resume = mute_led_resume,
9324};
9325
9326/*
9327 * Battery Wear Control Driver
9328 * Contact: Ognjen Galic <smclt30p@gmail.com>
9329 */
9330
9331/* Metadata */
9332
9333#define GET_START	"BCTG"
9334#define SET_START	"BCCS"
9335#define GET_STOP	"BCSG"
9336#define SET_STOP	"BCSS"
9337#define GET_DISCHARGE	"BDSG"
9338#define SET_DISCHARGE	"BDSS"
9339#define GET_INHIBIT	"BICG"
9340#define SET_INHIBIT	"BICS"
9341
9342enum {
9343	BAT_ANY = 0,
9344	BAT_PRIMARY = 1,
9345	BAT_SECONDARY = 2
9346};
9347
9348enum {
9349	/* Error condition bit */
9350	METHOD_ERR = BIT(31),
9351};
9352
9353enum {
9354	/* This is used in the get/set helpers */
9355	THRESHOLD_START,
9356	THRESHOLD_STOP,
9357	FORCE_DISCHARGE,
9358	INHIBIT_CHARGE,
9359};
9360
9361struct tpacpi_battery_data {
9362	int charge_start;
9363	int start_support;
9364	int charge_stop;
9365	int stop_support;
9366	unsigned int charge_behaviours;
9367};
9368
9369struct tpacpi_battery_driver_data {
9370	struct tpacpi_battery_data batteries[3];
9371	int individual_addressing;
9372};
9373
9374static struct tpacpi_battery_driver_data battery_info;
9375
9376/* ACPI helpers/functions/probes */
9377
9378/**
9379 * This evaluates a ACPI method call specific to the battery
9380 * ACPI extension. The specifics are that an error is marked
9381 * in the 32rd bit of the response, so we just check that here.
9382 */
9383static acpi_status tpacpi_battery_acpi_eval(char *method, int *ret, int param)
9384{
9385	int response;
9386
9387	if (!acpi_evalf(hkey_handle, &response, method, "dd", param)) {
9388		acpi_handle_err(hkey_handle, "%s: evaluate failed", method);
9389		return AE_ERROR;
9390	}
9391	if (response & METHOD_ERR) {
9392		acpi_handle_err(hkey_handle,
9393				"%s evaluated but flagged as error", method);
9394		return AE_ERROR;
9395	}
9396	*ret = response;
9397	return AE_OK;
9398}
9399
9400static int tpacpi_battery_get(int what, int battery, int *ret)
9401{
9402	switch (what) {
9403	case THRESHOLD_START:
9404		if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, ret, battery))
9405			return -ENODEV;
9406
9407		/* The value is in the low 8 bits of the response */
9408		*ret = *ret & 0xFF;
9409		return 0;
9410	case THRESHOLD_STOP:
9411		if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, ret, battery))
9412			return -ENODEV;
9413		/* Value is in lower 8 bits */
9414		*ret = *ret & 0xFF;
9415		/*
9416		 * On the stop value, if we return 0 that
9417		 * does not make any sense. 0 means Default, which
9418		 * means that charging stops at 100%, so we return
9419		 * that.
9420		 */
9421		if (*ret == 0)
9422			*ret = 100;
9423		return 0;
9424	case FORCE_DISCHARGE:
9425		if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_DISCHARGE, ret, battery))
9426			return -ENODEV;
9427		/* The force discharge status is in bit 0 */
9428		*ret = *ret & 0x01;
9429		return 0;
9430	case INHIBIT_CHARGE:
9431		if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_INHIBIT, ret, battery))
9432			return -ENODEV;
9433		/* The inhibit charge status is in bit 0 */
9434		*ret = *ret & 0x01;
9435		return 0;
9436	default:
9437		pr_crit("wrong parameter: %d", what);
9438		return -EINVAL;
9439	}
9440}
9441
9442static int tpacpi_battery_set(int what, int battery, int value)
9443{
9444	int param, ret;
9445	/* The first 8 bits are the value of the threshold */
9446	param = value;
9447	/* The battery ID is in bits 8-9, 2 bits */
9448	param |= battery << 8;
9449
9450	switch (what) {
9451	case THRESHOLD_START:
9452		if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_START, &ret, param)) {
9453			pr_err("failed to set charge threshold on battery %d",
9454					battery);
9455			return -ENODEV;
9456		}
9457		return 0;
9458	case THRESHOLD_STOP:
9459		if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_STOP, &ret, param)) {
9460			pr_err("failed to set stop threshold: %d", battery);
9461			return -ENODEV;
9462		}
9463		return 0;
9464	case FORCE_DISCHARGE:
9465		/* Force discharge is in bit 0,
9466		 * break on AC attach is in bit 1 (won't work on some ThinkPads),
9467		 * battery ID is in bits 8-9, 2 bits.
9468		 */
9469		if (ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_DISCHARGE, &ret, param))) {
9470			pr_err("failed to set force discharge on %d", battery);
9471			return -ENODEV;
9472		}
9473		return 0;
9474	case INHIBIT_CHARGE:
9475		/* When setting inhibit charge, we set a default value of
9476		 * always breaking on AC detach and the effective time is set to
9477		 * be permanent.
9478		 * The battery ID is in bits 4-5, 2 bits,
9479		 * the effective time is in bits 8-23, 2 bytes.
9480		 * A time of FFFF indicates forever.
9481		 */
9482		param = value;
9483		param |= battery << 4;
9484		param |= 0xFFFF << 8;
9485		if (ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_INHIBIT, &ret, param))) {
9486			pr_err("failed to set inhibit charge on %d", battery);
9487			return -ENODEV;
9488		}
9489		return 0;
9490	default:
9491		pr_crit("wrong parameter: %d", what);
9492		return -EINVAL;
9493	}
9494}
9495
9496static int tpacpi_battery_set_validate(int what, int battery, int value)
9497{
9498	int ret, v;
9499
9500	ret = tpacpi_battery_set(what, battery, value);
9501	if (ret < 0)
9502		return ret;
9503
9504	ret = tpacpi_battery_get(what, battery, &v);
9505	if (ret < 0)
9506		return ret;
9507
9508	if (v == value)
9509		return 0;
9510
9511	msleep(500);
9512
9513	ret = tpacpi_battery_get(what, battery, &v);
9514	if (ret < 0)
9515		return ret;
9516
9517	if (v == value)
9518		return 0;
9519
9520	return -EIO;
9521}
9522
9523static int tpacpi_battery_probe(int battery)
9524{
9525	int ret = 0;
9526
9527	memset(&battery_info.batteries[battery], 0,
9528		sizeof(battery_info.batteries[battery]));
9529
9530	/*
9531	 * 1) Get the current start threshold
9532	 * 2) Check for support
9533	 * 3) Get the current stop threshold
9534	 * 4) Check for support
9535	 * 5) Get the current force discharge status
9536	 * 6) Check for support
9537	 * 7) Get the current inhibit charge status
9538	 * 8) Check for support
9539	 */
9540	if (acpi_has_method(hkey_handle, GET_START)) {
9541		if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, &ret, battery)) {
9542			pr_err("Error probing battery %d\n", battery);
9543			return -ENODEV;
9544		}
9545		/* Individual addressing is in bit 9 */
9546		if (ret & BIT(9))
9547			battery_info.individual_addressing = true;
9548		/* Support is marked in bit 8 */
9549		if (ret & BIT(8))
9550			battery_info.batteries[battery].start_support = 1;
9551		else
9552			return -ENODEV;
9553		if (tpacpi_battery_get(THRESHOLD_START, battery,
9554			&battery_info.batteries[battery].charge_start)) {
9555			pr_err("Error probing battery %d\n", battery);
9556			return -ENODEV;
9557		}
9558	}
9559	if (acpi_has_method(hkey_handle, GET_STOP)) {
9560		if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, &ret, battery)) {
9561			pr_err("Error probing battery stop; %d\n", battery);
9562			return -ENODEV;
9563		}
9564		/* Support is marked in bit 8 */
9565		if (ret & BIT(8))
9566			battery_info.batteries[battery].stop_support = 1;
9567		else
9568			return -ENODEV;
9569		if (tpacpi_battery_get(THRESHOLD_STOP, battery,
9570			&battery_info.batteries[battery].charge_stop)) {
9571			pr_err("Error probing battery stop: %d\n", battery);
9572			return -ENODEV;
9573		}
9574	}
9575	if (acpi_has_method(hkey_handle, GET_DISCHARGE)) {
9576		if (ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_DISCHARGE, &ret, battery))) {
9577			pr_err("Error probing battery discharge; %d\n", battery);
9578			return -ENODEV;
9579		}
9580		/* Support is marked in bit 8 */
9581		if (ret & BIT(8))
9582			battery_info.batteries[battery].charge_behaviours |=
9583				BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE);
9584	}
9585	if (acpi_has_method(hkey_handle, GET_INHIBIT)) {
9586		if (ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_INHIBIT, &ret, battery))) {
9587			pr_err("Error probing battery inhibit charge; %d\n", battery);
9588			return -ENODEV;
9589		}
9590		/* Support is marked in bit 5 */
9591		if (ret & BIT(5))
9592			battery_info.batteries[battery].charge_behaviours |=
9593				BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE);
9594	}
9595
9596	battery_info.batteries[battery].charge_behaviours |=
9597		BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_AUTO);
9598
9599	pr_info("battery %d registered (start %d, stop %d, behaviours: 0x%x)\n",
9600		battery,
9601		battery_info.batteries[battery].charge_start,
9602		battery_info.batteries[battery].charge_stop,
9603		battery_info.batteries[battery].charge_behaviours);
9604
9605	return 0;
9606}
9607
9608/* General helper functions */
9609
9610static int tpacpi_battery_get_id(const char *battery_name)
9611{
9612
9613	if (strcmp(battery_name, "BAT0") == 0 ||
9614	    tp_features.battery_force_primary)
9615		return BAT_PRIMARY;
9616	if (strcmp(battery_name, "BAT1") == 0)
9617		return BAT_SECONDARY;
9618	/*
9619	 * If for some reason the battery is not BAT0 nor is it
9620	 * BAT1, we will assume it's the default, first battery,
9621	 * AKA primary.
9622	 */
9623	pr_warn("unknown battery %s, assuming primary", battery_name);
9624	return BAT_PRIMARY;
9625}
9626
9627/* sysfs interface */
9628
9629static ssize_t tpacpi_battery_store(int what,
9630				    struct device *dev,
9631				    const char *buf, size_t count)
9632{
9633	struct power_supply *supply = to_power_supply(dev);
9634	unsigned long value;
9635	int battery, rval;
9636	/*
9637	 * Some systems have support for more than
9638	 * one battery. If that is the case,
9639	 * tpacpi_battery_probe marked that addressing
9640	 * them individually is supported, so we do that
9641	 * based on the device struct.
9642	 *
9643	 * On systems that are not supported, we assume
9644	 * the primary as most of the ACPI calls fail
9645	 * with "Any Battery" as the parameter.
9646	 */
9647	if (battery_info.individual_addressing)
9648		/* BAT_PRIMARY or BAT_SECONDARY */
9649		battery = tpacpi_battery_get_id(supply->desc->name);
9650	else
9651		battery = BAT_PRIMARY;
9652
9653	rval = kstrtoul(buf, 10, &value);
9654	if (rval)
9655		return rval;
9656
9657	switch (what) {
9658	case THRESHOLD_START:
9659		if (!battery_info.batteries[battery].start_support)
9660			return -ENODEV;
9661		/* valid values are [0, 99] */
9662		if (value > 99)
9663			return -EINVAL;
9664		if (value > battery_info.batteries[battery].charge_stop)
9665			return -EINVAL;
9666		if (tpacpi_battery_set(THRESHOLD_START, battery, value))
9667			return -ENODEV;
9668		battery_info.batteries[battery].charge_start = value;
9669		return count;
9670
9671	case THRESHOLD_STOP:
9672		if (!battery_info.batteries[battery].stop_support)
9673			return -ENODEV;
9674		/* valid values are [1, 100] */
9675		if (value < 1 || value > 100)
9676			return -EINVAL;
9677		if (value < battery_info.batteries[battery].charge_start)
9678			return -EINVAL;
9679		battery_info.batteries[battery].charge_stop = value;
9680		/*
9681		 * When 100 is passed to stop, we need to flip
9682		 * it to 0 as that the EC understands that as
9683		 * "Default", which will charge to 100%
9684		 */
9685		if (value == 100)
9686			value = 0;
9687		if (tpacpi_battery_set(THRESHOLD_STOP, battery, value))
9688			return -EINVAL;
9689		return count;
9690	default:
9691		pr_crit("Wrong parameter: %d", what);
9692		return -EINVAL;
9693	}
9694	return count;
9695}
9696
9697static ssize_t tpacpi_battery_show(int what,
9698				   struct device *dev,
9699				   char *buf)
9700{
9701	struct power_supply *supply = to_power_supply(dev);
9702	int ret, battery;
9703	/*
9704	 * Some systems have support for more than
9705	 * one battery. If that is the case,
9706	 * tpacpi_battery_probe marked that addressing
9707	 * them individually is supported, so we;
9708	 * based on the device struct.
9709	 *
9710	 * On systems that are not supported, we assume
9711	 * the primary as most of the ACPI calls fail
9712	 * with "Any Battery" as the parameter.
9713	 */
9714	if (battery_info.individual_addressing)
9715		/* BAT_PRIMARY or BAT_SECONDARY */
9716		battery = tpacpi_battery_get_id(supply->desc->name);
9717	else
9718		battery = BAT_PRIMARY;
9719	if (tpacpi_battery_get(what, battery, &ret))
9720		return -ENODEV;
9721	return sprintf(buf, "%d\n", ret);
9722}
9723
9724static ssize_t charge_control_start_threshold_show(struct device *device,
9725				struct device_attribute *attr,
9726				char *buf)
9727{
9728	return tpacpi_battery_show(THRESHOLD_START, device, buf);
9729}
9730
9731static ssize_t charge_control_end_threshold_show(struct device *device,
9732				struct device_attribute *attr,
9733				char *buf)
9734{
9735	return tpacpi_battery_show(THRESHOLD_STOP, device, buf);
9736}
9737
9738static ssize_t charge_behaviour_show(struct device *dev,
9739				     struct device_attribute *attr,
9740				     char *buf)
9741{
9742	enum power_supply_charge_behaviour active = POWER_SUPPLY_CHARGE_BEHAVIOUR_AUTO;
9743	struct power_supply *supply = to_power_supply(dev);
9744	unsigned int available;
9745	int ret, battery;
9746
9747	battery = tpacpi_battery_get_id(supply->desc->name);
9748	available = battery_info.batteries[battery].charge_behaviours;
9749
9750	if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE)) {
9751		if (tpacpi_battery_get(FORCE_DISCHARGE, battery, &ret))
9752			return -ENODEV;
9753		if (ret) {
9754			active = POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE;
9755			goto out;
9756		}
9757	}
9758
9759	if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE)) {
9760		if (tpacpi_battery_get(INHIBIT_CHARGE, battery, &ret))
9761			return -ENODEV;
9762		if (ret) {
9763			active = POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE;
9764			goto out;
9765		}
9766	}
9767
9768out:
9769	return power_supply_charge_behaviour_show(dev, available, active, buf);
9770}
9771
9772static ssize_t charge_control_start_threshold_store(struct device *dev,
9773				struct device_attribute *attr,
9774				const char *buf, size_t count)
9775{
9776	return tpacpi_battery_store(THRESHOLD_START, dev, buf, count);
9777}
9778
9779static ssize_t charge_control_end_threshold_store(struct device *dev,
9780				struct device_attribute *attr,
9781				const char *buf, size_t count)
9782{
9783	return tpacpi_battery_store(THRESHOLD_STOP, dev, buf, count);
9784}
9785
9786static ssize_t charge_behaviour_store(struct device *dev,
9787				      struct device_attribute *attr,
9788				      const char *buf, size_t count)
9789{
9790	struct power_supply *supply = to_power_supply(dev);
9791	int selected, battery, ret = 0;
9792	unsigned int available;
9793
9794	battery = tpacpi_battery_get_id(supply->desc->name);
9795	available = battery_info.batteries[battery].charge_behaviours;
9796	selected = power_supply_charge_behaviour_parse(available, buf);
9797
9798	if (selected < 0)
9799		return selected;
9800
9801	switch (selected) {
9802	case POWER_SUPPLY_CHARGE_BEHAVIOUR_AUTO:
9803		if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE))
9804			ret = tpacpi_battery_set_validate(FORCE_DISCHARGE, battery, 0);
9805		if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE))
9806			ret = min(ret, tpacpi_battery_set_validate(INHIBIT_CHARGE, battery, 0));
9807		if (ret < 0)
9808			return ret;
9809		break;
9810	case POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE:
9811		if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE))
9812			ret = tpacpi_battery_set_validate(INHIBIT_CHARGE, battery, 0);
9813		ret = min(ret, tpacpi_battery_set_validate(FORCE_DISCHARGE, battery, 1));
9814		if (ret < 0)
9815			return ret;
9816		break;
9817	case POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE:
9818		if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE))
9819			ret = tpacpi_battery_set_validate(FORCE_DISCHARGE, battery, 0);
9820		ret = min(ret, tpacpi_battery_set_validate(INHIBIT_CHARGE, battery, 1));
9821		if (ret < 0)
9822			return ret;
9823		break;
9824	default:
9825		dev_err(dev, "Unexpected charge behaviour: %d\n", selected);
9826		return -EINVAL;
9827	}
9828
9829	return count;
9830}
9831
9832static DEVICE_ATTR_RW(charge_control_start_threshold);
9833static DEVICE_ATTR_RW(charge_control_end_threshold);
9834static DEVICE_ATTR_RW(charge_behaviour);
9835static struct device_attribute dev_attr_charge_start_threshold = __ATTR(
9836	charge_start_threshold,
9837	0644,
9838	charge_control_start_threshold_show,
9839	charge_control_start_threshold_store
9840);
9841static struct device_attribute dev_attr_charge_stop_threshold = __ATTR(
9842	charge_stop_threshold,
9843	0644,
9844	charge_control_end_threshold_show,
9845	charge_control_end_threshold_store
9846);
9847
9848static struct attribute *tpacpi_battery_attrs[] = {
9849	&dev_attr_charge_control_start_threshold.attr,
9850	&dev_attr_charge_control_end_threshold.attr,
9851	&dev_attr_charge_start_threshold.attr,
9852	&dev_attr_charge_stop_threshold.attr,
9853	&dev_attr_charge_behaviour.attr,
9854	NULL,
9855};
9856
9857ATTRIBUTE_GROUPS(tpacpi_battery);
9858
9859/* ACPI battery hooking */
9860
9861static int tpacpi_battery_add(struct power_supply *battery, struct acpi_battery_hook *hook)
9862{
9863	int batteryid = tpacpi_battery_get_id(battery->desc->name);
9864
9865	if (tpacpi_battery_probe(batteryid))
9866		return -ENODEV;
9867	if (device_add_groups(&battery->dev, tpacpi_battery_groups))
9868		return -ENODEV;
9869	return 0;
9870}
9871
9872static int tpacpi_battery_remove(struct power_supply *battery, struct acpi_battery_hook *hook)
9873{
9874	device_remove_groups(&battery->dev, tpacpi_battery_groups);
9875	return 0;
9876}
9877
9878static struct acpi_battery_hook battery_hook = {
9879	.add_battery = tpacpi_battery_add,
9880	.remove_battery = tpacpi_battery_remove,
9881	.name = "ThinkPad Battery Extension",
9882};
9883
9884/* Subdriver init/exit */
9885
9886static const struct tpacpi_quirk battery_quirk_table[] __initconst = {
9887	/*
9888	 * Individual addressing is broken on models that expose the
9889	 * primary battery as BAT1.
9890	 */
9891	TPACPI_Q_LNV('8', 'F', true),       /* Thinkpad X120e */
9892	TPACPI_Q_LNV('J', '7', true),       /* B5400 */
9893	TPACPI_Q_LNV('J', 'I', true),       /* Thinkpad 11e */
9894	TPACPI_Q_LNV3('R', '0', 'B', true), /* Thinkpad 11e gen 3 */
9895	TPACPI_Q_LNV3('R', '0', 'C', true), /* Thinkpad 13 */
9896	TPACPI_Q_LNV3('R', '0', 'J', true), /* Thinkpad 13 gen 2 */
9897	TPACPI_Q_LNV3('R', '0', 'K', true), /* Thinkpad 11e gen 4 celeron BIOS */
9898};
9899
9900static int __init tpacpi_battery_init(struct ibm_init_struct *ibm)
9901{
9902	memset(&battery_info, 0, sizeof(battery_info));
9903
9904	tp_features.battery_force_primary = tpacpi_check_quirks(
9905					battery_quirk_table,
9906					ARRAY_SIZE(battery_quirk_table));
9907
9908	battery_hook_register(&battery_hook);
9909	return 0;
9910}
9911
9912static void tpacpi_battery_exit(void)
9913{
9914	battery_hook_unregister(&battery_hook);
9915}
9916
9917static struct ibm_struct battery_driver_data = {
9918	.name = "battery",
9919	.exit = tpacpi_battery_exit,
9920};
9921
9922/*************************************************************************
9923 * LCD Shadow subdriver, for the Lenovo PrivacyGuard feature
9924 */
9925
9926static struct drm_privacy_screen *lcdshadow_dev;
9927static acpi_handle lcdshadow_get_handle;
9928static acpi_handle lcdshadow_set_handle;
9929
9930static int lcdshadow_set_sw_state(struct drm_privacy_screen *priv,
9931				  enum drm_privacy_screen_status state)
9932{
9933	int output;
9934
9935	if (WARN_ON(!mutex_is_locked(&priv->lock)))
9936		return -EIO;
9937
9938	if (!acpi_evalf(lcdshadow_set_handle, &output, NULL, "dd", (int)state))
9939		return -EIO;
9940
9941	priv->hw_state = priv->sw_state = state;
9942	return 0;
9943}
9944
9945static void lcdshadow_get_hw_state(struct drm_privacy_screen *priv)
9946{
9947	int output;
9948
9949	if (!acpi_evalf(lcdshadow_get_handle, &output, NULL, "dd", 0))
9950		return;
9951
9952	priv->hw_state = priv->sw_state = output & 0x1;
9953}
9954
9955static const struct drm_privacy_screen_ops lcdshadow_ops = {
9956	.set_sw_state = lcdshadow_set_sw_state,
9957	.get_hw_state = lcdshadow_get_hw_state,
9958};
9959
9960static int tpacpi_lcdshadow_init(struct ibm_init_struct *iibm)
9961{
9962	acpi_status status1, status2;
9963	int output;
9964
9965	status1 = acpi_get_handle(hkey_handle, "GSSS", &lcdshadow_get_handle);
9966	status2 = acpi_get_handle(hkey_handle, "SSSS", &lcdshadow_set_handle);
9967	if (ACPI_FAILURE(status1) || ACPI_FAILURE(status2))
9968		return 0;
9969
9970	if (!acpi_evalf(lcdshadow_get_handle, &output, NULL, "dd", 0))
9971		return -EIO;
9972
9973	if (!(output & 0x10000))
9974		return 0;
9975
9976	lcdshadow_dev = drm_privacy_screen_register(&tpacpi_pdev->dev,
9977						    &lcdshadow_ops, NULL);
9978	if (IS_ERR(lcdshadow_dev))
9979		return PTR_ERR(lcdshadow_dev);
9980
9981	return 0;
9982}
9983
9984static void lcdshadow_exit(void)
9985{
9986	drm_privacy_screen_unregister(lcdshadow_dev);
9987}
9988
9989static void lcdshadow_resume(void)
9990{
9991	if (!lcdshadow_dev)
9992		return;
9993
9994	mutex_lock(&lcdshadow_dev->lock);
9995	lcdshadow_set_sw_state(lcdshadow_dev, lcdshadow_dev->sw_state);
9996	mutex_unlock(&lcdshadow_dev->lock);
9997}
9998
9999static int lcdshadow_read(struct seq_file *m)
10000{
10001	if (!lcdshadow_dev) {
10002		seq_puts(m, "status:\t\tnot supported\n");
10003	} else {
10004		seq_printf(m, "status:\t\t%d\n", lcdshadow_dev->hw_state);
10005		seq_puts(m, "commands:\t0, 1\n");
10006	}
10007
10008	return 0;
10009}
10010
10011static int lcdshadow_write(char *buf)
10012{
10013	char *cmd;
10014	int res, state = -EINVAL;
10015
10016	if (!lcdshadow_dev)
10017		return -ENODEV;
10018
10019	while ((cmd = strsep(&buf, ","))) {
10020		res = kstrtoint(cmd, 10, &state);
10021		if (res < 0)
10022			return res;
10023	}
10024
10025	if (state >= 2 || state < 0)
10026		return -EINVAL;
10027
10028	mutex_lock(&lcdshadow_dev->lock);
10029	res = lcdshadow_set_sw_state(lcdshadow_dev, state);
10030	mutex_unlock(&lcdshadow_dev->lock);
10031
10032	drm_privacy_screen_call_notifier_chain(lcdshadow_dev);
10033
10034	return res;
10035}
10036
10037static struct ibm_struct lcdshadow_driver_data = {
10038	.name = "lcdshadow",
10039	.exit = lcdshadow_exit,
10040	.resume = lcdshadow_resume,
10041	.read = lcdshadow_read,
10042	.write = lcdshadow_write,
10043};
10044
10045/*************************************************************************
10046 * Thinkpad sensor interfaces
10047 */
10048
10049#define DYTC_CMD_QUERY        0 /* To get DYTC status - enable/revision */
10050#define DYTC_QUERY_ENABLE_BIT 8  /* Bit        8 - 0 = disabled, 1 = enabled */
10051#define DYTC_QUERY_SUBREV_BIT 16 /* Bits 16 - 27 - sub revision */
10052#define DYTC_QUERY_REV_BIT    28 /* Bits 28 - 31 - revision */
10053
10054#define DYTC_CMD_GET          2 /* To get current IC function and mode */
10055#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
10056
10057#define PALMSENSOR_PRESENT_BIT 0 /* Determine if psensor present */
10058#define PALMSENSOR_ON_BIT      1 /* psensor status */
10059
10060static bool has_palmsensor;
10061static bool has_lapsensor;
10062static bool palm_state;
10063static bool lap_state;
10064static int dytc_version;
10065
10066static int dytc_command(int command, int *output)
10067{
10068	acpi_handle dytc_handle;
10069
10070	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
10071		/* Platform doesn't support DYTC */
10072		return -ENODEV;
10073	}
10074	if (!acpi_evalf(dytc_handle, output, NULL, "dd", command))
10075		return -EIO;
10076	return 0;
10077}
10078
10079static int lapsensor_get(bool *present, bool *state)
10080{
10081	int output, err;
10082
10083	*present = false;
10084	err = dytc_command(DYTC_CMD_GET, &output);
10085	if (err)
10086		return err;
10087
10088	*present = true; /*If we get his far, we have lapmode support*/
10089	*state = output & BIT(DYTC_GET_LAPMODE_BIT) ? true : false;
10090	return 0;
10091}
10092
10093static int palmsensor_get(bool *present, bool *state)
10094{
10095	acpi_handle psensor_handle;
10096	int output;
10097
10098	*present = false;
10099	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GPSS", &psensor_handle)))
10100		return -ENODEV;
10101	if (!acpi_evalf(psensor_handle, &output, NULL, "d"))
10102		return -EIO;
10103
10104	*present = output & BIT(PALMSENSOR_PRESENT_BIT) ? true : false;
10105	*state = output & BIT(PALMSENSOR_ON_BIT) ? true : false;
10106	return 0;
10107}
10108
10109static void lapsensor_refresh(void)
10110{
10111	bool state;
10112	int err;
10113
10114	if (has_lapsensor) {
10115		err = lapsensor_get(&has_lapsensor, &state);
10116		if (err)
10117			return;
10118		if (lap_state != state) {
10119			lap_state = state;
10120			sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
10121		}
10122	}
10123}
10124
10125static void palmsensor_refresh(void)
10126{
10127	bool state;
10128	int err;
10129
10130	if (has_palmsensor) {
10131		err = palmsensor_get(&has_palmsensor, &state);
10132		if (err)
10133			return;
10134		if (palm_state != state) {
10135			palm_state = state;
10136			sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "palmsensor");
10137		}
10138	}
10139}
10140
10141static ssize_t dytc_lapmode_show(struct device *dev,
10142					struct device_attribute *attr,
10143					char *buf)
10144{
10145	if (has_lapsensor)
10146		return sysfs_emit(buf, "%d\n", lap_state);
10147	return sysfs_emit(buf, "\n");
10148}
10149static DEVICE_ATTR_RO(dytc_lapmode);
10150
10151static ssize_t palmsensor_show(struct device *dev,
10152					struct device_attribute *attr,
10153					char *buf)
10154{
10155	if (has_palmsensor)
10156		return sysfs_emit(buf, "%d\n", palm_state);
10157	return sysfs_emit(buf, "\n");
10158}
10159static DEVICE_ATTR_RO(palmsensor);
10160
10161static struct attribute *proxsensor_attributes[] = {
10162	&dev_attr_dytc_lapmode.attr,
10163	&dev_attr_palmsensor.attr,
10164	NULL
10165};
10166
10167static umode_t proxsensor_attr_is_visible(struct kobject *kobj,
10168					  struct attribute *attr, int n)
10169{
10170	if (attr == &dev_attr_dytc_lapmode.attr) {
10171		/*
10172		 * Platforms before DYTC version 5 claim to have a lap sensor,
10173		 * but it doesn't work, so we ignore them.
10174		 */
10175		if (!has_lapsensor || dytc_version < 5)
10176			return 0;
10177	} else if (attr == &dev_attr_palmsensor.attr) {
10178		if (!has_palmsensor)
10179			return 0;
10180	}
10181
10182	return attr->mode;
10183}
10184
10185static const struct attribute_group proxsensor_attr_group = {
10186	.is_visible = proxsensor_attr_is_visible,
10187	.attrs = proxsensor_attributes,
10188};
10189
10190static int tpacpi_proxsensor_init(struct ibm_init_struct *iibm)
10191{
10192	int palm_err, lap_err;
10193
10194	palm_err = palmsensor_get(&has_palmsensor, &palm_state);
10195	lap_err = lapsensor_get(&has_lapsensor, &lap_state);
10196	/* If support isn't available for both devices return -ENODEV */
10197	if ((palm_err == -ENODEV) && (lap_err == -ENODEV))
10198		return -ENODEV;
10199	/* Otherwise, if there was an error return it */
10200	if (palm_err && (palm_err != -ENODEV))
10201		return palm_err;
10202	if (lap_err && (lap_err != -ENODEV))
10203		return lap_err;
10204
10205	return 0;
10206}
10207
10208static struct ibm_struct proxsensor_driver_data = {
10209	.name = "proximity-sensor",
10210};
10211
10212/*************************************************************************
10213 * DYTC Platform Profile interface
10214 */
10215
10216#define DYTC_CMD_SET          1 /* To enable/disable IC function mode */
10217#define DYTC_CMD_MMC_GET      8 /* To get current MMC function and mode */
10218#define DYTC_CMD_RESET    0x1ff /* To reset back to default */
10219
10220#define DYTC_CMD_FUNC_CAP     3 /* To get DYTC capabilities */
10221#define DYTC_FC_MMC           27 /* MMC Mode supported */
10222#define DYTC_FC_PSC           29 /* PSC Mode supported */
10223#define DYTC_FC_AMT           31 /* AMT mode supported */
10224
10225#define DYTC_GET_FUNCTION_BIT 8  /* Bits  8-11 - function setting */
10226#define DYTC_GET_MODE_BIT     12 /* Bits 12-15 - mode setting */
10227
10228#define DYTC_SET_FUNCTION_BIT 12 /* Bits 12-15 - function setting */
10229#define DYTC_SET_MODE_BIT     16 /* Bits 16-19 - mode setting */
10230#define DYTC_SET_VALID_BIT    20 /* Bit     20 - 1 = on, 0 = off */
10231
10232#define DYTC_FUNCTION_STD     0  /* Function = 0, standard mode */
10233#define DYTC_FUNCTION_CQL     1  /* Function = 1, lap mode */
10234#define DYTC_FUNCTION_MMC     11 /* Function = 11, MMC mode */
10235#define DYTC_FUNCTION_PSC     13 /* Function = 13, PSC mode */
10236#define DYTC_FUNCTION_AMT     15 /* Function = 15, AMT mode */
10237
10238#define DYTC_MODE_AMT_ENABLE   0x1 /* Enable AMT (in balanced mode) */
10239#define DYTC_MODE_AMT_DISABLE  0xF /* Disable AMT (in other modes) */
10240
10241#define DYTC_MODE_MMC_PERFORM  2  /* High power mode aka performance */
10242#define DYTC_MODE_MMC_LOWPOWER 3  /* Low power mode */
10243#define DYTC_MODE_MMC_BALANCE  0xF  /* Default mode aka balanced */
10244#define DYTC_MODE_MMC_DEFAULT  0  /* Default mode from MMC_GET, aka balanced */
10245
10246#define DYTC_MODE_PSC_LOWPOWER 3  /* Low power mode */
10247#define DYTC_MODE_PSC_BALANCE  5  /* Default mode aka balanced */
10248#define DYTC_MODE_PSC_PERFORM  7  /* High power mode aka performance */
10249
10250#define DYTC_ERR_MASK       0xF  /* Bits 0-3 in cmd result are the error result */
10251#define DYTC_ERR_SUCCESS      1  /* CMD completed successful */
10252
10253#define DYTC_SET_COMMAND(function, mode, on) \
10254	(DYTC_CMD_SET | (function) << DYTC_SET_FUNCTION_BIT | \
10255	 (mode) << DYTC_SET_MODE_BIT | \
10256	 (on) << DYTC_SET_VALID_BIT)
10257
10258#define DYTC_DISABLE_CQL DYTC_SET_COMMAND(DYTC_FUNCTION_CQL, DYTC_MODE_MMC_BALANCE, 0)
10259#define DYTC_ENABLE_CQL DYTC_SET_COMMAND(DYTC_FUNCTION_CQL, DYTC_MODE_MMC_BALANCE, 1)
10260static int dytc_control_amt(bool enable);
10261static bool dytc_amt_active;
10262
10263static enum platform_profile_option dytc_current_profile;
10264static atomic_t dytc_ignore_event = ATOMIC_INIT(0);
10265static DEFINE_MUTEX(dytc_mutex);
10266static int dytc_capabilities;
10267static bool dytc_mmc_get_available;
10268static int profile_force;
10269
10270static int convert_dytc_to_profile(int funcmode, int dytcmode,
10271		enum platform_profile_option *profile)
10272{
10273	switch (funcmode) {
10274	case DYTC_FUNCTION_MMC:
10275		switch (dytcmode) {
10276		case DYTC_MODE_MMC_LOWPOWER:
10277			*profile = PLATFORM_PROFILE_LOW_POWER;
10278			break;
10279		case DYTC_MODE_MMC_DEFAULT:
10280		case DYTC_MODE_MMC_BALANCE:
10281			*profile =  PLATFORM_PROFILE_BALANCED;
10282			break;
10283		case DYTC_MODE_MMC_PERFORM:
10284			*profile =  PLATFORM_PROFILE_PERFORMANCE;
10285			break;
10286		default: /* Unknown mode */
10287			return -EINVAL;
10288		}
10289		return 0;
10290	case DYTC_FUNCTION_PSC:
10291		switch (dytcmode) {
10292		case DYTC_MODE_PSC_LOWPOWER:
10293			*profile = PLATFORM_PROFILE_LOW_POWER;
10294			break;
10295		case DYTC_MODE_PSC_BALANCE:
10296			*profile =  PLATFORM_PROFILE_BALANCED;
10297			break;
10298		case DYTC_MODE_PSC_PERFORM:
10299			*profile =  PLATFORM_PROFILE_PERFORMANCE;
10300			break;
10301		default: /* Unknown mode */
10302			return -EINVAL;
10303		}
10304		return 0;
10305	case DYTC_FUNCTION_AMT:
10306		/* For now return balanced. It's the closest we have to 'auto' */
10307		*profile =  PLATFORM_PROFILE_BALANCED;
10308		return 0;
10309	default:
10310		/* Unknown function */
10311		pr_debug("unknown function 0x%x\n", funcmode);
10312		return -EOPNOTSUPP;
10313	}
10314	return 0;
10315}
10316
10317static int convert_profile_to_dytc(enum platform_profile_option profile, int *perfmode)
10318{
10319	switch (profile) {
10320	case PLATFORM_PROFILE_LOW_POWER:
10321		if (dytc_capabilities & BIT(DYTC_FC_MMC))
10322			*perfmode = DYTC_MODE_MMC_LOWPOWER;
10323		else if (dytc_capabilities & BIT(DYTC_FC_PSC))
10324			*perfmode = DYTC_MODE_PSC_LOWPOWER;
10325		break;
10326	case PLATFORM_PROFILE_BALANCED:
10327		if (dytc_capabilities & BIT(DYTC_FC_MMC))
10328			*perfmode = DYTC_MODE_MMC_BALANCE;
10329		else if (dytc_capabilities & BIT(DYTC_FC_PSC))
10330			*perfmode = DYTC_MODE_PSC_BALANCE;
10331		break;
10332	case PLATFORM_PROFILE_PERFORMANCE:
10333		if (dytc_capabilities & BIT(DYTC_FC_MMC))
10334			*perfmode = DYTC_MODE_MMC_PERFORM;
10335		else if (dytc_capabilities & BIT(DYTC_FC_PSC))
10336			*perfmode = DYTC_MODE_PSC_PERFORM;
10337		break;
10338	default: /* Unknown profile */
10339		return -EOPNOTSUPP;
10340	}
10341	return 0;
10342}
10343
10344/*
10345 * dytc_profile_get: Function to register with platform_profile
10346 * handler. Returns current platform profile.
10347 */
10348static int dytc_profile_get(struct platform_profile_handler *pprof,
10349			    enum platform_profile_option *profile)
10350{
10351	*profile = dytc_current_profile;
10352	return 0;
10353}
10354
10355static int dytc_control_amt(bool enable)
10356{
10357	int dummy;
10358	int err;
10359	int cmd;
10360
10361	if (!(dytc_capabilities & BIT(DYTC_FC_AMT))) {
10362		pr_warn("Attempting to toggle AMT on a system that doesn't advertise support\n");
10363		return -ENODEV;
10364	}
10365
10366	if (enable)
10367		cmd = DYTC_SET_COMMAND(DYTC_FUNCTION_AMT, DYTC_MODE_AMT_ENABLE, enable);
10368	else
10369		cmd = DYTC_SET_COMMAND(DYTC_FUNCTION_AMT, DYTC_MODE_AMT_DISABLE, enable);
10370
10371	pr_debug("%sabling AMT (cmd 0x%x)", enable ? "en":"dis", cmd);
10372	err = dytc_command(cmd, &dummy);
10373	if (err)
10374		return err;
10375	dytc_amt_active = enable;
10376	return 0;
10377}
10378
10379/*
10380 * Helper function - check if we are in CQL mode and if we are
10381 *  -  disable CQL,
10382 *  - run the command
10383 *  - enable CQL
10384 *  If not in CQL mode, just run the command
10385 */
10386static int dytc_cql_command(int command, int *output)
10387{
10388	int err, cmd_err, dummy;
10389	int cur_funcmode;
10390
10391	/* Determine if we are in CQL mode. This alters the commands we do */
10392	err = dytc_command(DYTC_CMD_GET, output);
10393	if (err)
10394		return err;
10395
10396	cur_funcmode = (*output >> DYTC_GET_FUNCTION_BIT) & 0xF;
10397	/* Check if we're OK to return immediately */
10398	if ((command == DYTC_CMD_GET) && (cur_funcmode != DYTC_FUNCTION_CQL))
10399		return 0;
10400
10401	if (cur_funcmode == DYTC_FUNCTION_CQL) {
10402		atomic_inc(&dytc_ignore_event);
10403		err = dytc_command(DYTC_DISABLE_CQL, &dummy);
10404		if (err)
10405			return err;
10406	}
10407
10408	cmd_err = dytc_command(command,	output);
10409	/* Check return condition after we've restored CQL state */
10410
10411	if (cur_funcmode == DYTC_FUNCTION_CQL) {
10412		err = dytc_command(DYTC_ENABLE_CQL, &dummy);
10413		if (err)
10414			return err;
10415	}
10416	return cmd_err;
10417}
10418
10419/*
10420 * dytc_profile_set: Function to register with platform_profile
10421 * handler. Sets current platform profile.
10422 */
10423static int dytc_profile_set(struct platform_profile_handler *pprof,
10424			    enum platform_profile_option profile)
10425{
10426	int perfmode;
10427	int output;
10428	int err;
10429
10430	err = mutex_lock_interruptible(&dytc_mutex);
10431	if (err)
10432		return err;
10433
10434	err = convert_profile_to_dytc(profile, &perfmode);
10435	if (err)
10436		goto unlock;
10437
10438	if (dytc_capabilities & BIT(DYTC_FC_MMC)) {
10439		if (profile == PLATFORM_PROFILE_BALANCED) {
10440			/*
10441			 * To get back to balanced mode we need to issue a reset command.
10442			 * Note we still need to disable CQL mode before hand and re-enable
10443			 * it afterwards, otherwise dytc_lapmode gets reset to 0 and stays
10444			 * stuck at 0 for aprox. 30 minutes.
10445			 */
10446			err = dytc_cql_command(DYTC_CMD_RESET, &output);
10447			if (err)
10448				goto unlock;
10449		} else {
10450			/* Determine if we are in CQL mode. This alters the commands we do */
10451			err = dytc_cql_command(DYTC_SET_COMMAND(DYTC_FUNCTION_MMC, perfmode, 1),
10452						&output);
10453			if (err)
10454				goto unlock;
10455		}
10456	} else if (dytc_capabilities & BIT(DYTC_FC_PSC)) {
10457		err = dytc_command(DYTC_SET_COMMAND(DYTC_FUNCTION_PSC, perfmode, 1), &output);
10458		if (err)
10459			goto unlock;
10460
10461		/* system supports AMT, activate it when on balanced */
10462		if (dytc_capabilities & BIT(DYTC_FC_AMT))
10463			dytc_control_amt(profile == PLATFORM_PROFILE_BALANCED);
10464	}
10465	/* Success - update current profile */
10466	dytc_current_profile = profile;
10467unlock:
10468	mutex_unlock(&dytc_mutex);
10469	return err;
10470}
10471
10472static void dytc_profile_refresh(void)
10473{
10474	enum platform_profile_option profile;
10475	int output = 0, err = 0;
10476	int perfmode, funcmode = 0;
10477
10478	mutex_lock(&dytc_mutex);
10479	if (dytc_capabilities & BIT(DYTC_FC_MMC)) {
10480		if (dytc_mmc_get_available)
10481			err = dytc_command(DYTC_CMD_MMC_GET, &output);
10482		else
10483			err = dytc_cql_command(DYTC_CMD_GET, &output);
10484		funcmode = DYTC_FUNCTION_MMC;
10485	} else if (dytc_capabilities & BIT(DYTC_FC_PSC)) {
10486		err = dytc_command(DYTC_CMD_GET, &output);
10487		/* Check if we are PSC mode, or have AMT enabled */
10488		funcmode = (output >> DYTC_GET_FUNCTION_BIT) & 0xF;
10489	} else { /* Unknown profile mode */
10490		err = -ENODEV;
10491	}
10492	mutex_unlock(&dytc_mutex);
10493	if (err)
10494		return;
10495
10496	perfmode = (output >> DYTC_GET_MODE_BIT) & 0xF;
10497	err = convert_dytc_to_profile(funcmode, perfmode, &profile);
10498	if (!err && profile != dytc_current_profile) {
10499		dytc_current_profile = profile;
10500		platform_profile_notify();
10501	}
10502}
10503
10504static struct platform_profile_handler dytc_profile = {
10505	.profile_get = dytc_profile_get,
10506	.profile_set = dytc_profile_set,
10507};
10508
10509static int tpacpi_dytc_profile_init(struct ibm_init_struct *iibm)
10510{
10511	int err, output;
10512
10513	/* Setup supported modes */
10514	set_bit(PLATFORM_PROFILE_LOW_POWER, dytc_profile.choices);
10515	set_bit(PLATFORM_PROFILE_BALANCED, dytc_profile.choices);
10516	set_bit(PLATFORM_PROFILE_PERFORMANCE, dytc_profile.choices);
10517
10518	err = dytc_command(DYTC_CMD_QUERY, &output);
10519	if (err)
10520		return err;
10521
10522	if (output & BIT(DYTC_QUERY_ENABLE_BIT))
10523		dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
10524
10525	/* Check DYTC is enabled and supports mode setting */
10526	if (dytc_version < 5)
10527		return -ENODEV;
10528
10529	/* Check what capabilities are supported */
10530	err = dytc_command(DYTC_CMD_FUNC_CAP, &dytc_capabilities);
10531	if (err)
10532		return err;
10533
10534	/* Check if user wants to override the profile selection */
10535	if (profile_force) {
10536		switch (profile_force) {
10537		case -1:
10538			dytc_capabilities = 0;
10539			break;
10540		case 1:
10541			dytc_capabilities = BIT(DYTC_FC_MMC);
10542			break;
10543		case 2:
10544			dytc_capabilities = BIT(DYTC_FC_PSC);
10545			break;
10546		}
10547		pr_debug("Profile selection forced: 0x%x\n", dytc_capabilities);
10548	}
10549	if (dytc_capabilities & BIT(DYTC_FC_MMC)) { /* MMC MODE */
10550		pr_debug("MMC is supported\n");
10551		/*
10552		 * Check if MMC_GET functionality available
10553		 * Version > 6 and return success from MMC_GET command
10554		 */
10555		dytc_mmc_get_available = false;
10556		if (dytc_version >= 6) {
10557			err = dytc_command(DYTC_CMD_MMC_GET, &output);
10558			if (!err && ((output & DYTC_ERR_MASK) == DYTC_ERR_SUCCESS))
10559				dytc_mmc_get_available = true;
10560		}
10561	} else if (dytc_capabilities & BIT(DYTC_FC_PSC)) { /* PSC MODE */
10562		pr_debug("PSC is supported\n");
10563	} else {
10564		dbg_printk(TPACPI_DBG_INIT, "No DYTC support available\n");
10565		return -ENODEV;
10566	}
10567
10568	dbg_printk(TPACPI_DBG_INIT,
10569			"DYTC version %d: thermal mode available\n", dytc_version);
10570
10571	/* Create platform_profile structure and register */
10572	err = platform_profile_register(&dytc_profile);
10573	/*
10574	 * If for some reason platform_profiles aren't enabled
10575	 * don't quit terminally.
10576	 */
10577	if (err)
10578		return -ENODEV;
10579
10580	/* Ensure initial values are correct */
10581	dytc_profile_refresh();
10582
10583	/* Workaround for https://bugzilla.kernel.org/show_bug.cgi?id=216347 */
10584	if (dytc_capabilities & BIT(DYTC_FC_PSC))
10585		dytc_profile_set(NULL, PLATFORM_PROFILE_BALANCED);
10586
10587	return 0;
10588}
10589
10590static void dytc_profile_exit(void)
10591{
10592	platform_profile_remove();
10593}
10594
10595static struct ibm_struct  dytc_profile_driver_data = {
10596	.name = "dytc-profile",
10597	.exit = dytc_profile_exit,
10598};
10599
10600/*************************************************************************
10601 * Keyboard language interface
10602 */
10603
10604struct keyboard_lang_data {
10605	const char *lang_str;
10606	int lang_code;
10607};
10608
10609static const struct keyboard_lang_data keyboard_lang_data[] = {
10610	{"be", 0x080c},
10611	{"cz", 0x0405},
10612	{"da", 0x0406},
10613	{"de", 0x0c07},
10614	{"en", 0x0000},
10615	{"es", 0x2c0a},
10616	{"et", 0x0425},
10617	{"fr", 0x040c},
10618	{"fr-ch", 0x100c},
10619	{"hu", 0x040e},
10620	{"it", 0x0410},
10621	{"jp", 0x0411},
10622	{"nl", 0x0413},
10623	{"nn", 0x0414},
10624	{"pl", 0x0415},
10625	{"pt", 0x0816},
10626	{"sl", 0x041b},
10627	{"sv", 0x081d},
10628	{"tr", 0x041f},
10629};
10630
10631static int set_keyboard_lang_command(int command)
10632{
10633	acpi_handle sskl_handle;
10634	int output;
10635
10636	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "SSKL", &sskl_handle))) {
10637		/* Platform doesn't support SSKL */
10638		return -ENODEV;
10639	}
10640
10641	if (!acpi_evalf(sskl_handle, &output, NULL, "dd", command))
10642		return -EIO;
10643
10644	return 0;
10645}
10646
10647static int get_keyboard_lang(int *output)
10648{
10649	acpi_handle gskl_handle;
10650	int kbd_lang;
10651
10652	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GSKL", &gskl_handle))) {
10653		/* Platform doesn't support GSKL */
10654		return -ENODEV;
10655	}
10656
10657	if (!acpi_evalf(gskl_handle, &kbd_lang, NULL, "dd", 0x02000000))
10658		return -EIO;
10659
10660	/*
10661	 * METHOD_ERR gets returned on devices where there are no special (e.g. '=',
10662	 * '(' and ')') keys which use layout dependent key-press emulation.
10663	 */
10664	if (kbd_lang & METHOD_ERR)
10665		return -ENODEV;
10666
10667	*output = kbd_lang;
10668
10669	return 0;
10670}
10671
10672/* sysfs keyboard language entry */
10673static ssize_t keyboard_lang_show(struct device *dev,
10674				struct device_attribute *attr,
10675				char *buf)
10676{
10677	int output, err, i, len = 0;
10678
10679	err = get_keyboard_lang(&output);
10680	if (err)
10681		return err;
10682
10683	for (i = 0; i < ARRAY_SIZE(keyboard_lang_data); i++) {
10684		if (i)
10685			len += sysfs_emit_at(buf, len, "%s", " ");
10686
10687		if (output == keyboard_lang_data[i].lang_code) {
10688			len += sysfs_emit_at(buf, len, "[%s]", keyboard_lang_data[i].lang_str);
10689		} else {
10690			len += sysfs_emit_at(buf, len, "%s", keyboard_lang_data[i].lang_str);
10691		}
10692	}
10693	len += sysfs_emit_at(buf, len, "\n");
10694
10695	return len;
10696}
10697
10698static ssize_t keyboard_lang_store(struct device *dev,
10699				struct device_attribute *attr,
10700				const char *buf, size_t count)
10701{
10702	int err, i;
10703	bool lang_found = false;
10704	int lang_code = 0;
10705
10706	for (i = 0; i < ARRAY_SIZE(keyboard_lang_data); i++) {
10707		if (sysfs_streq(buf, keyboard_lang_data[i].lang_str)) {
10708			lang_code = keyboard_lang_data[i].lang_code;
10709			lang_found = true;
10710			break;
10711		}
10712	}
10713
10714	if (lang_found) {
10715		lang_code = lang_code | 1 << 24;
10716
10717		/* Set language code */
10718		err = set_keyboard_lang_command(lang_code);
10719		if (err)
10720			return err;
10721	} else {
10722		dev_err(&tpacpi_pdev->dev, "Unknown Keyboard language. Ignoring\n");
10723		return -EINVAL;
10724	}
10725
10726	tpacpi_disclose_usertask(attr->attr.name,
10727			"keyboard language is set to  %s\n", buf);
10728
10729	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "keyboard_lang");
10730
10731	return count;
10732}
10733static DEVICE_ATTR_RW(keyboard_lang);
10734
10735static struct attribute *kbdlang_attributes[] = {
10736	&dev_attr_keyboard_lang.attr,
10737	NULL
10738};
10739
10740static umode_t kbdlang_attr_is_visible(struct kobject *kobj,
10741				       struct attribute *attr, int n)
10742{
10743	return tp_features.kbd_lang ? attr->mode : 0;
10744}
10745
10746static const struct attribute_group kbdlang_attr_group = {
10747	.is_visible = kbdlang_attr_is_visible,
10748	.attrs = kbdlang_attributes,
10749};
10750
10751static int tpacpi_kbdlang_init(struct ibm_init_struct *iibm)
10752{
10753	int err, output;
10754
10755	err = get_keyboard_lang(&output);
10756	tp_features.kbd_lang = !err;
10757	return err;
10758}
10759
10760static struct ibm_struct kbdlang_driver_data = {
10761	.name = "kbdlang",
10762};
10763
10764/*************************************************************************
10765 * DPRC(Dynamic Power Reduction Control) subdriver, for the Lenovo WWAN
10766 * and WLAN feature.
10767 */
10768#define DPRC_GET_WWAN_ANTENNA_TYPE      0x40000
10769#define DPRC_WWAN_ANTENNA_TYPE_A_BIT    BIT(4)
10770#define DPRC_WWAN_ANTENNA_TYPE_B_BIT    BIT(8)
10771static bool has_antennatype;
10772static int wwan_antennatype;
10773
10774static int dprc_command(int command, int *output)
10775{
10776	acpi_handle dprc_handle;
10777
10778	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DPRC", &dprc_handle))) {
10779		/* Platform doesn't support DPRC */
10780		return -ENODEV;
10781	}
10782
10783	if (!acpi_evalf(dprc_handle, output, NULL, "dd", command))
10784		return -EIO;
10785
10786	/*
10787	 * METHOD_ERR gets returned on devices where few commands are not supported
10788	 * for example command to get WWAN Antenna type command is not supported on
10789	 * some devices.
10790	 */
10791	if (*output & METHOD_ERR)
10792		return -ENODEV;
10793
10794	return 0;
10795}
10796
10797static int get_wwan_antenna(int *wwan_antennatype)
10798{
10799	int output, err;
10800
10801	/* Get current Antenna type */
10802	err = dprc_command(DPRC_GET_WWAN_ANTENNA_TYPE, &output);
10803	if (err)
10804		return err;
10805
10806	if (output & DPRC_WWAN_ANTENNA_TYPE_A_BIT)
10807		*wwan_antennatype = 1;
10808	else if (output & DPRC_WWAN_ANTENNA_TYPE_B_BIT)
10809		*wwan_antennatype = 2;
10810	else
10811		return -ENODEV;
10812
10813	return 0;
10814}
10815
10816/* sysfs wwan antenna type entry */
10817static ssize_t wwan_antenna_type_show(struct device *dev,
10818					struct device_attribute *attr,
10819					char *buf)
10820{
10821	switch (wwan_antennatype) {
10822	case 1:
10823		return sysfs_emit(buf, "type a\n");
10824	case 2:
10825		return sysfs_emit(buf, "type b\n");
10826	default:
10827		return -ENODATA;
10828	}
10829}
10830static DEVICE_ATTR_RO(wwan_antenna_type);
10831
10832static struct attribute *dprc_attributes[] = {
10833	&dev_attr_wwan_antenna_type.attr,
10834	NULL
10835};
10836
10837static umode_t dprc_attr_is_visible(struct kobject *kobj,
10838				    struct attribute *attr, int n)
10839{
10840	return has_antennatype ? attr->mode : 0;
10841}
10842
10843static const struct attribute_group dprc_attr_group = {
10844	.is_visible = dprc_attr_is_visible,
10845	.attrs = dprc_attributes,
10846};
10847
10848static int tpacpi_dprc_init(struct ibm_init_struct *iibm)
10849{
10850	int err;
10851
10852	err = get_wwan_antenna(&wwan_antennatype);
10853	if (err)
10854		return err;
10855
10856	has_antennatype = true;
10857	return 0;
10858}
10859
10860static struct ibm_struct dprc_driver_data = {
10861	.name = "dprc",
10862};
10863
10864/* --------------------------------------------------------------------- */
10865
10866static struct attribute *tpacpi_driver_attributes[] = {
10867	&driver_attr_debug_level.attr,
10868	&driver_attr_version.attr,
10869	&driver_attr_interface_version.attr,
10870#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10871	&driver_attr_wlsw_emulstate.attr,
10872	&driver_attr_bluetooth_emulstate.attr,
10873	&driver_attr_wwan_emulstate.attr,
10874	&driver_attr_uwb_emulstate.attr,
10875#endif
10876	NULL
10877};
10878
10879#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10880static umode_t tpacpi_attr_is_visible(struct kobject *kobj,
10881				      struct attribute *attr, int n)
10882{
10883	if (attr == &driver_attr_wlsw_emulstate.attr) {
10884		if (!dbg_wlswemul)
10885			return 0;
10886	} else if (attr == &driver_attr_bluetooth_emulstate.attr) {
10887		if (!dbg_bluetoothemul)
10888			return 0;
10889	} else if (attr == &driver_attr_wwan_emulstate.attr) {
10890		if (!dbg_wwanemul)
10891			return 0;
10892	} else if (attr == &driver_attr_uwb_emulstate.attr) {
10893		if (!dbg_uwbemul)
10894			return 0;
10895	}
10896
10897	return attr->mode;
10898}
10899#endif
10900
10901static const struct attribute_group tpacpi_driver_attr_group = {
10902#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10903	.is_visible = tpacpi_attr_is_visible,
10904#endif
10905	.attrs = tpacpi_driver_attributes,
10906};
10907
10908static const struct attribute_group *tpacpi_driver_groups[] = {
10909	&tpacpi_driver_attr_group,
10910	NULL,
10911};
10912
10913static const struct attribute_group *tpacpi_groups[] = {
10914	&adaptive_kbd_attr_group,
10915	&hotkey_attr_group,
10916	&bluetooth_attr_group,
10917	&wan_attr_group,
10918	&cmos_attr_group,
10919	&proxsensor_attr_group,
10920	&kbdlang_attr_group,
10921	&dprc_attr_group,
10922	NULL,
10923};
10924
10925static const struct attribute_group *tpacpi_hwmon_groups[] = {
10926	&thermal_attr_group,
10927	&temp_label_attr_group,
10928	&fan_attr_group,
10929	NULL,
10930};
10931
10932static const struct attribute_group *tpacpi_hwmon_driver_groups[] = {
10933	&fan_driver_attr_group,
10934	NULL,
10935};
10936
10937/****************************************************************************
10938 ****************************************************************************
10939 *
10940 * Platform drivers
10941 *
10942 ****************************************************************************
10943 ****************************************************************************/
10944
10945static struct platform_driver tpacpi_pdriver = {
10946	.driver = {
10947		.name = TPACPI_DRVR_NAME,
10948		.pm = &tpacpi_pm,
10949		.groups = tpacpi_driver_groups,
10950		.dev_groups = tpacpi_groups,
10951	},
10952	.shutdown = tpacpi_shutdown_handler,
10953};
10954
10955static struct platform_driver tpacpi_hwmon_pdriver = {
10956	.driver = {
10957		.name = TPACPI_HWMON_DRVR_NAME,
10958		.groups = tpacpi_hwmon_driver_groups,
10959	},
10960};
10961
10962/****************************************************************************
10963 ****************************************************************************
10964 *
10965 * Infrastructure
10966 *
10967 ****************************************************************************
10968 ****************************************************************************/
10969
10970/*
10971 * HKEY event callout for other subdrivers go here
10972 * (yes, it is ugly, but it is quick, safe, and gets the job done
10973 */
10974static void tpacpi_driver_event(const unsigned int hkey_event)
10975{
10976	if (ibm_backlight_device) {
10977		switch (hkey_event) {
10978		case TP_HKEY_EV_BRGHT_UP:
10979		case TP_HKEY_EV_BRGHT_DOWN:
10980			tpacpi_brightness_notify_change();
10981		}
10982	}
10983	if (alsa_card) {
10984		switch (hkey_event) {
10985		case TP_HKEY_EV_VOL_UP:
10986		case TP_HKEY_EV_VOL_DOWN:
10987		case TP_HKEY_EV_VOL_MUTE:
10988			volume_alsa_notify_change();
10989		}
10990	}
10991	if (tp_features.kbdlight && hkey_event == TP_HKEY_EV_KBD_LIGHT) {
10992		enum led_brightness brightness;
10993
10994		mutex_lock(&kbdlight_mutex);
10995
10996		/*
10997		 * Check the brightness actually changed, setting the brightness
10998		 * through kbdlight_set_level() also triggers this event.
10999		 */
11000		brightness = kbdlight_sysfs_get(NULL);
11001		if (kbdlight_brightness != brightness) {
11002			kbdlight_brightness = brightness;
11003			led_classdev_notify_brightness_hw_changed(
11004				&tpacpi_led_kbdlight.led_classdev, brightness);
11005		}
11006
11007		mutex_unlock(&kbdlight_mutex);
11008	}
11009
11010	if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED) {
11011		lapsensor_refresh();
11012		/* If we are already accessing DYTC then skip dytc update */
11013		if (!atomic_add_unless(&dytc_ignore_event, -1, 0))
11014			dytc_profile_refresh();
11015	}
11016
11017	if (lcdshadow_dev && hkey_event == TP_HKEY_EV_PRIVACYGUARD_TOGGLE) {
11018		enum drm_privacy_screen_status old_hw_state;
11019		bool changed;
11020
11021		mutex_lock(&lcdshadow_dev->lock);
11022		old_hw_state = lcdshadow_dev->hw_state;
11023		lcdshadow_get_hw_state(lcdshadow_dev);
11024		changed = lcdshadow_dev->hw_state != old_hw_state;
11025		mutex_unlock(&lcdshadow_dev->lock);
11026
11027		if (changed)
11028			drm_privacy_screen_call_notifier_chain(lcdshadow_dev);
11029	}
11030	if (hkey_event == TP_HKEY_EV_AMT_TOGGLE) {
11031		/* If we're enabling AMT we need to force balanced mode */
11032		if (!dytc_amt_active)
11033			/* This will also set AMT mode enabled */
11034			dytc_profile_set(NULL, PLATFORM_PROFILE_BALANCED);
11035		else
11036			dytc_control_amt(!dytc_amt_active);
11037	}
11038
11039}
11040
11041static void hotkey_driver_event(const unsigned int scancode)
11042{
11043	tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
11044}
11045
11046/* --------------------------------------------------------------------- */
11047
11048/* /proc support */
11049static struct proc_dir_entry *proc_dir;
11050
11051/*
11052 * Module and infrastructure proble, init and exit handling
11053 */
11054
11055static bool force_load;
11056
11057#ifdef CONFIG_THINKPAD_ACPI_DEBUG
11058static const char * __init str_supported(int is_supported)
11059{
11060	static char text_unsupported[] __initdata = "not supported";
11061
11062	return (is_supported) ? &text_unsupported[4] : &text_unsupported[0];
11063}
11064#endif /* CONFIG_THINKPAD_ACPI_DEBUG */
11065
11066static void ibm_exit(struct ibm_struct *ibm)
11067{
11068	dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
11069
11070	list_del_init(&ibm->all_drivers);
11071
11072	if (ibm->flags.acpi_notify_installed) {
11073		dbg_printk(TPACPI_DBG_EXIT,
11074			"%s: acpi_remove_notify_handler\n", ibm->name);
11075		BUG_ON(!ibm->acpi);
11076		acpi_remove_notify_handler(*ibm->acpi->handle,
11077					   ibm->acpi->type,
11078					   dispatch_acpi_notify);
11079		ibm->flags.acpi_notify_installed = 0;
11080	}
11081
11082	if (ibm->flags.proc_created) {
11083		dbg_printk(TPACPI_DBG_EXIT,
11084			"%s: remove_proc_entry\n", ibm->name);
11085		remove_proc_entry(ibm->name, proc_dir);
11086		ibm->flags.proc_created = 0;
11087	}
11088
11089	if (ibm->flags.acpi_driver_registered) {
11090		dbg_printk(TPACPI_DBG_EXIT,
11091			"%s: acpi_bus_unregister_driver\n", ibm->name);
11092		BUG_ON(!ibm->acpi);
11093		acpi_bus_unregister_driver(ibm->acpi->driver);
11094		kfree(ibm->acpi->driver);
11095		ibm->acpi->driver = NULL;
11096		ibm->flags.acpi_driver_registered = 0;
11097	}
11098
11099	if (ibm->flags.init_called && ibm->exit) {
11100		ibm->exit();
11101		ibm->flags.init_called = 0;
11102	}
11103
11104	dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
11105}
11106
11107static int __init ibm_init(struct ibm_init_struct *iibm)
11108{
11109	int ret;
11110	struct ibm_struct *ibm = iibm->data;
11111	struct proc_dir_entry *entry;
11112
11113	BUG_ON(ibm == NULL);
11114
11115	INIT_LIST_HEAD(&ibm->all_drivers);
11116
11117	if (ibm->flags.experimental && !experimental)
11118		return 0;
11119
11120	dbg_printk(TPACPI_DBG_INIT,
11121		"probing for %s\n", ibm->name);
11122
11123	if (iibm->init) {
11124		ret = iibm->init(iibm);
11125		if (ret > 0 || ret == -ENODEV)
11126			return 0; /* subdriver functionality not available */
11127		if (ret)
11128			return ret;
11129
11130		ibm->flags.init_called = 1;
11131	}
11132
11133	if (ibm->acpi) {
11134		if (ibm->acpi->hid) {
11135			ret = register_tpacpi_subdriver(ibm);
11136			if (ret)
11137				goto err_out;
11138		}
11139
11140		if (ibm->acpi->notify) {
11141			ret = setup_acpi_notify(ibm);
11142			if (ret == -ENODEV) {
11143				pr_notice("disabling subdriver %s\n",
11144					  ibm->name);
11145				ret = 0;
11146				goto err_out;
11147			}
11148			if (ret < 0)
11149				goto err_out;
11150		}
11151	}
11152
11153	dbg_printk(TPACPI_DBG_INIT,
11154		"%s installed\n", ibm->name);
11155
11156	if (ibm->read) {
11157		umode_t mode = iibm->base_procfs_mode;
11158
11159		if (!mode)
11160			mode = S_IRUGO;
11161		if (ibm->write)
11162			mode |= S_IWUSR;
11163		entry = proc_create_data(ibm->name, mode, proc_dir,
11164					 &dispatch_proc_ops, ibm);
11165		if (!entry) {
11166			pr_err("unable to create proc entry %s\n", ibm->name);
11167			ret = -ENODEV;
11168			goto err_out;
11169		}
11170		ibm->flags.proc_created = 1;
11171	}
11172
11173	list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
11174
11175	return 0;
11176
11177err_out:
11178	dbg_printk(TPACPI_DBG_INIT,
11179		"%s: at error exit path with result %d\n",
11180		ibm->name, ret);
11181
11182	ibm_exit(ibm);
11183	return (ret < 0) ? ret : 0;
11184}
11185
11186/* Probing */
11187
11188static char __init tpacpi_parse_fw_id(const char * const s,
11189				      u32 *model, u16 *release)
11190{
11191	int i;
11192
11193	if (!s || strlen(s) < 8)
11194		goto invalid;
11195
11196	for (i = 0; i < 8; i++)
11197		if (!((s[i] >= '0' && s[i] <= '9') ||
11198		      (s[i] >= 'A' && s[i] <= 'Z')))
11199			goto invalid;
11200
11201	/*
11202	 * Most models: xxyTkkWW (#.##c)
11203	 * Ancient 570/600 and -SL lacks (#.##c)
11204	 */
11205	if (s[3] == 'T' || s[3] == 'N') {
11206		*model = TPID(s[0], s[1]);
11207		*release = TPVER(s[4], s[5]);
11208		return s[2];
11209
11210	/* New models: xxxyTkkW (#.##c); T550 and some others */
11211	} else if (s[4] == 'T' || s[4] == 'N') {
11212		*model = TPID3(s[0], s[1], s[2]);
11213		*release = TPVER(s[5], s[6]);
11214		return s[3];
11215	}
11216
11217invalid:
11218	return '\0';
11219}
11220
11221static void find_new_ec_fwstr(const struct dmi_header *dm, void *private)
11222{
11223	char *ec_fw_string = (char *) private;
11224	const char *dmi_data = (const char *)dm;
11225	/*
11226	 * ThinkPad Embedded Controller Program Table on newer models
11227	 *
11228	 * Offset |  Name                | Width  | Description
11229	 * ----------------------------------------------------
11230	 *  0x00  | Type                 | BYTE   | 0x8C
11231	 *  0x01  | Length               | BYTE   |
11232	 *  0x02  | Handle               | WORD   | Varies
11233	 *  0x04  | Signature            | BYTEx6 | ASCII for "LENOVO"
11234	 *  0x0A  | OEM struct offset    | BYTE   | 0x0B
11235	 *  0x0B  | OEM struct number    | BYTE   | 0x07, for this structure
11236	 *  0x0C  | OEM struct revision  | BYTE   | 0x01, for this format
11237	 *  0x0D  | ECP version ID       | STR ID |
11238	 *  0x0E  | ECP release date     | STR ID |
11239	 */
11240
11241	/* Return if data structure not match */
11242	if (dm->type != 140 || dm->length < 0x0F ||
11243	memcmp(dmi_data + 4, "LENOVO", 6) != 0 ||
11244	dmi_data[0x0A] != 0x0B || dmi_data[0x0B] != 0x07 ||
11245	dmi_data[0x0C] != 0x01)
11246		return;
11247
11248	/* fwstr is the first 8byte string  */
11249	strncpy(ec_fw_string, dmi_data + 0x0F, 8);
11250}
11251
11252/* returns 0 - probe ok, or < 0 - probe error.
11253 * Probe ok doesn't mean thinkpad found.
11254 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
11255static int __must_check __init get_thinkpad_model_data(
11256						struct thinkpad_id_data *tp)
11257{
11258	const struct dmi_device *dev = NULL;
11259	char ec_fw_string[18] = {0};
11260	char const *s;
11261	char t;
11262
11263	if (!tp)
11264		return -EINVAL;
11265
11266	memset(tp, 0, sizeof(*tp));
11267
11268	if (dmi_name_in_vendors("IBM"))
11269		tp->vendor = PCI_VENDOR_ID_IBM;
11270	else if (dmi_name_in_vendors("LENOVO"))
11271		tp->vendor = PCI_VENDOR_ID_LENOVO;
11272	else
11273		return 0;
11274
11275	s = dmi_get_system_info(DMI_BIOS_VERSION);
11276	tp->bios_version_str = kstrdup(s, GFP_KERNEL);
11277	if (s && !tp->bios_version_str)
11278		return -ENOMEM;
11279
11280	/* Really ancient ThinkPad 240X will fail this, which is fine */
11281	t = tpacpi_parse_fw_id(tp->bios_version_str,
11282			       &tp->bios_model, &tp->bios_release);
11283	if (t != 'E' && t != 'C')
11284		return 0;
11285
11286	/*
11287	 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
11288	 * X32 or newer, all Z series;  Some models must have an
11289	 * up-to-date BIOS or they will not be detected.
11290	 *
11291	 * See https://thinkwiki.org/wiki/List_of_DMI_IDs
11292	 */
11293	while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
11294		if (sscanf(dev->name,
11295			   "IBM ThinkPad Embedded Controller -[%17c",
11296			   ec_fw_string) == 1) {
11297			ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
11298			ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
11299			break;
11300		}
11301	}
11302
11303	/* Newer ThinkPads have different EC program info table */
11304	if (!ec_fw_string[0])
11305		dmi_walk(find_new_ec_fwstr, &ec_fw_string);
11306
11307	if (ec_fw_string[0]) {
11308		tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
11309		if (!tp->ec_version_str)
11310			return -ENOMEM;
11311
11312		t = tpacpi_parse_fw_id(ec_fw_string,
11313			 &tp->ec_model, &tp->ec_release);
11314		if (t != 'H') {
11315			pr_notice("ThinkPad firmware release %s doesn't match the known patterns\n",
11316				  ec_fw_string);
11317			pr_notice("please report this to %s\n", TPACPI_MAIL);
11318		}
11319	}
11320
11321	s = dmi_get_system_info(DMI_PRODUCT_VERSION);
11322	if (s && !(strncasecmp(s, "ThinkPad", 8) && strncasecmp(s, "Lenovo", 6))) {
11323		tp->model_str = kstrdup(s, GFP_KERNEL);
11324		if (!tp->model_str)
11325			return -ENOMEM;
11326	} else {
11327		s = dmi_get_system_info(DMI_BIOS_VENDOR);
11328		if (s && !(strncasecmp(s, "Lenovo", 6))) {
11329			tp->model_str = kstrdup(s, GFP_KERNEL);
11330			if (!tp->model_str)
11331				return -ENOMEM;
11332		}
11333	}
11334
11335	s = dmi_get_system_info(DMI_PRODUCT_NAME);
11336	tp->nummodel_str = kstrdup(s, GFP_KERNEL);
11337	if (s && !tp->nummodel_str)
11338		return -ENOMEM;
11339
11340	return 0;
11341}
11342
11343static int __init probe_for_thinkpad(void)
11344{
11345	int is_thinkpad;
11346
11347	if (acpi_disabled)
11348		return -ENODEV;
11349
11350	/* It would be dangerous to run the driver in this case */
11351	if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
11352		return -ENODEV;
11353
11354	/*
11355	 * Non-ancient models have better DMI tagging, but very old models
11356	 * don't.  tpacpi_is_fw_known() is a cheat to help in that case.
11357	 */
11358	is_thinkpad = (thinkpad_id.model_str != NULL) ||
11359		      (thinkpad_id.ec_model != 0) ||
11360		      tpacpi_is_fw_known();
11361
11362	/* The EC handler is required */
11363	tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
11364	if (!ec_handle) {
11365		if (is_thinkpad)
11366			pr_err("Not yet supported ThinkPad detected!\n");
11367		return -ENODEV;
11368	}
11369
11370	if (!is_thinkpad && !force_load)
11371		return -ENODEV;
11372
11373	return 0;
11374}
11375
11376static void __init thinkpad_acpi_init_banner(void)
11377{
11378	pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
11379	pr_info("%s\n", TPACPI_URL);
11380
11381	pr_info("ThinkPad BIOS %s, EC %s\n",
11382		(thinkpad_id.bios_version_str) ?
11383			thinkpad_id.bios_version_str : "unknown",
11384		(thinkpad_id.ec_version_str) ?
11385			thinkpad_id.ec_version_str : "unknown");
11386
11387	BUG_ON(!thinkpad_id.vendor);
11388
11389	if (thinkpad_id.model_str)
11390		pr_info("%s %s, model %s\n",
11391			(thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
11392				"IBM" : ((thinkpad_id.vendor ==
11393						PCI_VENDOR_ID_LENOVO) ?
11394					"Lenovo" : "Unknown vendor"),
11395			thinkpad_id.model_str,
11396			(thinkpad_id.nummodel_str) ?
11397				thinkpad_id.nummodel_str : "unknown");
11398}
11399
11400/* Module init, exit, parameters */
11401
11402static struct ibm_init_struct ibms_init[] __initdata = {
11403	{
11404		.data = &thinkpad_acpi_driver_data,
11405	},
11406	{
11407		.init = hotkey_init,
11408		.data = &hotkey_driver_data,
11409	},
11410	{
11411		.init = bluetooth_init,
11412		.data = &bluetooth_driver_data,
11413	},
11414	{
11415		.init = wan_init,
11416		.data = &wan_driver_data,
11417	},
11418	{
11419		.init = uwb_init,
11420		.data = &uwb_driver_data,
11421	},
11422#ifdef CONFIG_THINKPAD_ACPI_VIDEO
11423	{
11424		.init = video_init,
11425		.base_procfs_mode = S_IRUSR,
11426		.data = &video_driver_data,
11427	},
11428#endif
11429	{
11430		.init = kbdlight_init,
11431		.data = &kbdlight_driver_data,
11432	},
11433	{
11434		.init = light_init,
11435		.data = &light_driver_data,
11436	},
11437	{
11438		.init = cmos_init,
11439		.data = &cmos_driver_data,
11440	},
11441	{
11442		.init = led_init,
11443		.data = &led_driver_data,
11444	},
11445	{
11446		.init = beep_init,
11447		.data = &beep_driver_data,
11448	},
11449	{
11450		.init = thermal_init,
11451		.data = &thermal_driver_data,
11452	},
11453	{
11454		.init = brightness_init,
11455		.data = &brightness_driver_data,
11456	},
11457	{
11458		.init = volume_init,
11459		.data = &volume_driver_data,
11460	},
11461	{
11462		.init = fan_init,
11463		.data = &fan_driver_data,
11464	},
11465	{
11466		.init = mute_led_init,
11467		.data = &mute_led_driver_data,
11468	},
11469	{
11470		.init = tpacpi_battery_init,
11471		.data = &battery_driver_data,
11472	},
11473	{
11474		.init = tpacpi_lcdshadow_init,
11475		.data = &lcdshadow_driver_data,
11476	},
11477	{
11478		.init = tpacpi_proxsensor_init,
11479		.data = &proxsensor_driver_data,
11480	},
11481	{
11482		.init = tpacpi_dytc_profile_init,
11483		.data = &dytc_profile_driver_data,
11484	},
11485	{
11486		.init = tpacpi_kbdlang_init,
11487		.data = &kbdlang_driver_data,
11488	},
11489	{
11490		.init = tpacpi_dprc_init,
11491		.data = &dprc_driver_data,
11492	},
11493};
11494
11495static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
11496{
11497	unsigned int i;
11498	struct ibm_struct *ibm;
11499
11500	if (!kp || !kp->name || !val)
11501		return -EINVAL;
11502
11503	for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
11504		ibm = ibms_init[i].data;
11505		if (!ibm || !ibm->name)
11506			continue;
11507
11508		if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
11509			if (strlen(val) > sizeof(ibms_init[i].param) - 1)
11510				return -ENOSPC;
11511			strcpy(ibms_init[i].param, val);
11512			return 0;
11513		}
11514	}
11515
11516	return -EINVAL;
11517}
11518
11519module_param(experimental, int, 0444);
11520MODULE_PARM_DESC(experimental,
11521		 "Enables experimental features when non-zero");
11522
11523module_param_named(debug, dbg_level, uint, 0);
11524MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
11525
11526module_param(force_load, bool, 0444);
11527MODULE_PARM_DESC(force_load,
11528		 "Attempts to load the driver even on a mis-identified ThinkPad when true");
11529
11530module_param_named(fan_control, fan_control_allowed, bool, 0444);
11531MODULE_PARM_DESC(fan_control,
11532		 "Enables setting fan parameters features when true");
11533
11534module_param_named(brightness_mode, brightness_mode, uint, 0444);
11535MODULE_PARM_DESC(brightness_mode,
11536		 "Selects brightness control strategy: 0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
11537
11538module_param(brightness_enable, uint, 0444);
11539MODULE_PARM_DESC(brightness_enable,
11540		 "Enables backlight control when 1, disables when 0");
11541
11542#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
11543module_param_named(volume_mode, volume_mode, uint, 0444);
11544MODULE_PARM_DESC(volume_mode,
11545		 "Selects volume control strategy: 0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
11546
11547module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
11548MODULE_PARM_DESC(volume_capabilities,
11549		 "Selects the mixer capabilities: 0=auto, 1=volume and mute, 2=mute only");
11550
11551module_param_named(volume_control, volume_control_allowed, bool, 0444);
11552MODULE_PARM_DESC(volume_control,
11553		 "Enables software override for the console audio control when true");
11554
11555module_param_named(software_mute, software_mute_requested, bool, 0444);
11556MODULE_PARM_DESC(software_mute,
11557		 "Request full software mute control");
11558
11559/* ALSA module API parameters */
11560module_param_named(index, alsa_index, int, 0444);
11561MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
11562module_param_named(id, alsa_id, charp, 0444);
11563MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
11564module_param_named(enable, alsa_enable, bool, 0444);
11565MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
11566#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
11567
11568/* The module parameter can't be read back, that's why 0 is used here */
11569#define TPACPI_PARAM(feature) \
11570	module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
11571	MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command at module load, see documentation")
11572
11573TPACPI_PARAM(hotkey);
11574TPACPI_PARAM(bluetooth);
11575TPACPI_PARAM(video);
11576TPACPI_PARAM(light);
11577TPACPI_PARAM(cmos);
11578TPACPI_PARAM(led);
11579TPACPI_PARAM(beep);
11580TPACPI_PARAM(brightness);
11581TPACPI_PARAM(volume);
11582TPACPI_PARAM(fan);
11583
11584#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
11585module_param(dbg_wlswemul, uint, 0444);
11586MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
11587module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
11588MODULE_PARM_DESC(wlsw_state,
11589		 "Initial state of the emulated WLSW switch");
11590
11591module_param(dbg_bluetoothemul, uint, 0444);
11592MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
11593module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
11594MODULE_PARM_DESC(bluetooth_state,
11595		 "Initial state of the emulated bluetooth switch");
11596
11597module_param(dbg_wwanemul, uint, 0444);
11598MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
11599module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
11600MODULE_PARM_DESC(wwan_state,
11601		 "Initial state of the emulated WWAN switch");
11602
11603module_param(dbg_uwbemul, uint, 0444);
11604MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
11605module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
11606MODULE_PARM_DESC(uwb_state,
11607		 "Initial state of the emulated UWB switch");
11608#endif
11609
11610module_param(profile_force, int, 0444);
11611MODULE_PARM_DESC(profile_force, "Force profile mode. -1=off, 1=MMC, 2=PSC");
11612
11613static void thinkpad_acpi_module_exit(void)
11614{
11615	struct ibm_struct *ibm, *itmp;
11616
11617	tpacpi_lifecycle = TPACPI_LIFE_EXITING;
11618
11619	if (tpacpi_hwmon)
11620		hwmon_device_unregister(tpacpi_hwmon);
11621	if (tp_features.sensors_pdrv_registered)
11622		platform_driver_unregister(&tpacpi_hwmon_pdriver);
11623	if (tp_features.platform_drv_registered)
11624		platform_driver_unregister(&tpacpi_pdriver);
11625
11626	list_for_each_entry_safe_reverse(ibm, itmp,
11627					 &tpacpi_all_drivers,
11628					 all_drivers) {
11629		ibm_exit(ibm);
11630	}
11631
11632	dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
11633
11634	if (tpacpi_inputdev) {
11635		if (tp_features.input_device_registered)
11636			input_unregister_device(tpacpi_inputdev);
11637		else
11638			input_free_device(tpacpi_inputdev);
11639		kfree(hotkey_keycode_map);
11640	}
11641
11642	if (tpacpi_sensors_pdev)
11643		platform_device_unregister(tpacpi_sensors_pdev);
11644	if (tpacpi_pdev)
11645		platform_device_unregister(tpacpi_pdev);
11646	if (proc_dir)
11647		remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
11648	if (tpacpi_wq)
11649		destroy_workqueue(tpacpi_wq);
11650
11651	kfree(thinkpad_id.bios_version_str);
11652	kfree(thinkpad_id.ec_version_str);
11653	kfree(thinkpad_id.model_str);
11654	kfree(thinkpad_id.nummodel_str);
11655}
11656
11657
11658static int __init thinkpad_acpi_module_init(void)
11659{
11660	const struct dmi_system_id *dmi_id;
11661	int ret, i;
11662	acpi_object_type obj_type;
11663
11664	tpacpi_lifecycle = TPACPI_LIFE_INIT;
11665
11666	/* Driver-level probe */
11667
11668	ret = get_thinkpad_model_data(&thinkpad_id);
11669	if (ret) {
11670		pr_err("unable to get DMI data: %d\n", ret);
11671		thinkpad_acpi_module_exit();
11672		return ret;
11673	}
11674	ret = probe_for_thinkpad();
11675	if (ret) {
11676		thinkpad_acpi_module_exit();
11677		return ret;
11678	}
11679
11680	/* Driver initialization */
11681
11682	thinkpad_acpi_init_banner();
11683	tpacpi_check_outdated_fw();
11684
11685	TPACPI_ACPIHANDLE_INIT(ecrd);
11686	TPACPI_ACPIHANDLE_INIT(ecwr);
11687
11688	/*
11689	 * Quirk: in some models (e.g. X380 Yoga), an object named ECRD
11690	 * exists, but it is a register, not a method.
11691	 */
11692	if (ecrd_handle) {
11693		acpi_get_type(ecrd_handle, &obj_type);
11694		if (obj_type != ACPI_TYPE_METHOD)
11695			ecrd_handle = NULL;
11696	}
11697	if (ecwr_handle) {
11698		acpi_get_type(ecwr_handle, &obj_type);
11699		if (obj_type != ACPI_TYPE_METHOD)
11700			ecwr_handle = NULL;
11701	}
11702
11703	tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
11704	if (!tpacpi_wq) {
11705		thinkpad_acpi_module_exit();
11706		return -ENOMEM;
11707	}
11708
11709	proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
11710	if (!proc_dir) {
11711		pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
11712		thinkpad_acpi_module_exit();
11713		return -ENODEV;
11714	}
11715
11716	dmi_id = dmi_first_match(fwbug_list);
11717	if (dmi_id)
11718		tp_features.quirks = dmi_id->driver_data;
11719
11720	/* Device initialization */
11721	tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, PLATFORM_DEVID_NONE,
11722							NULL, 0);
11723	if (IS_ERR(tpacpi_pdev)) {
11724		ret = PTR_ERR(tpacpi_pdev);
11725		tpacpi_pdev = NULL;
11726		pr_err("unable to register platform device\n");
11727		thinkpad_acpi_module_exit();
11728		return ret;
11729	}
11730	tpacpi_sensors_pdev = platform_device_register_simple(
11731						TPACPI_HWMON_DRVR_NAME,
11732						PLATFORM_DEVID_NONE, NULL, 0);
11733	if (IS_ERR(tpacpi_sensors_pdev)) {
11734		ret = PTR_ERR(tpacpi_sensors_pdev);
11735		tpacpi_sensors_pdev = NULL;
11736		pr_err("unable to register hwmon platform device\n");
11737		thinkpad_acpi_module_exit();
11738		return ret;
11739	}
11740
11741	mutex_init(&tpacpi_inputdev_send_mutex);
11742	tpacpi_inputdev = input_allocate_device();
11743	if (!tpacpi_inputdev) {
11744		thinkpad_acpi_module_exit();
11745		return -ENOMEM;
11746	} else {
11747		/* Prepare input device, but don't register */
11748		tpacpi_inputdev->name = "ThinkPad Extra Buttons";
11749		tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
11750		tpacpi_inputdev->id.bustype = BUS_HOST;
11751		tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
11752		tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
11753		tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
11754		tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
11755	}
11756
11757	/* Init subdriver dependencies */
11758	tpacpi_detect_brightness_capabilities();
11759
11760	/* Init subdrivers */
11761	for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
11762		ret = ibm_init(&ibms_init[i]);
11763		if (ret >= 0 && *ibms_init[i].param)
11764			ret = ibms_init[i].data->write(ibms_init[i].param);
11765		if (ret < 0) {
11766			thinkpad_acpi_module_exit();
11767			return ret;
11768		}
11769	}
11770
11771	tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
11772
11773	ret = platform_driver_register(&tpacpi_pdriver);
11774	if (ret) {
11775		pr_err("unable to register main platform driver\n");
11776		thinkpad_acpi_module_exit();
11777		return ret;
11778	}
11779	tp_features.platform_drv_registered = 1;
11780
11781	ret = platform_driver_register(&tpacpi_hwmon_pdriver);
11782	if (ret) {
11783		pr_err("unable to register hwmon platform driver\n");
11784		thinkpad_acpi_module_exit();
11785		return ret;
11786	}
11787	tp_features.sensors_pdrv_registered = 1;
11788
11789	tpacpi_hwmon = hwmon_device_register_with_groups(
11790		&tpacpi_sensors_pdev->dev, TPACPI_NAME, NULL, tpacpi_hwmon_groups);
11791	if (IS_ERR(tpacpi_hwmon)) {
11792		ret = PTR_ERR(tpacpi_hwmon);
11793		tpacpi_hwmon = NULL;
11794		pr_err("unable to register hwmon device\n");
11795		thinkpad_acpi_module_exit();
11796		return ret;
11797	}
11798
11799	ret = input_register_device(tpacpi_inputdev);
11800	if (ret < 0) {
11801		pr_err("unable to register input device\n");
11802		thinkpad_acpi_module_exit();
11803		return ret;
11804	} else {
11805		tp_features.input_device_registered = 1;
11806	}
11807
11808	return 0;
11809}
11810
11811MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
11812
11813/*
11814 * This will autoload the driver in almost every ThinkPad
11815 * in widespread use.
11816 *
11817 * Only _VERY_ old models, like the 240, 240x and 570 lack
11818 * the HKEY event interface.
11819 */
11820MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
11821
11822/*
11823 * DMI matching for module autoloading
11824 *
11825 * See https://thinkwiki.org/wiki/List_of_DMI_IDs
11826 * See https://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
11827 *
11828 * Only models listed in thinkwiki will be supported, so add yours
11829 * if it is not there yet.
11830 */
11831#define IBM_BIOS_MODULE_ALIAS(__type) \
11832	MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
11833
11834/* Ancient thinkpad BIOSes have to be identified by
11835 * BIOS type or model number, and there are far less
11836 * BIOS types than model numbers... */
11837IBM_BIOS_MODULE_ALIAS("I[MU]");		/* 570, 570e */
11838
11839MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
11840MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
11841MODULE_DESCRIPTION(TPACPI_DESC);
11842MODULE_VERSION(TPACPI_VERSION);
11843MODULE_LICENSE("GPL");
11844
11845module_init(thinkpad_acpi_module_init);
11846module_exit(thinkpad_acpi_module_exit);
11847