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