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