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