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