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