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