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