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