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