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