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