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