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