?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
thinkpad-acpi fails to load with newer Thinkpad X201s BIOS
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / platform / x86 / thinkpad_acpi.c
blob31ee86e337fde54f1b6aaaadbab9a30060ee791b
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 #include <linux/slab.h>
62
63 #include <linux/nvram.h>
64 #include <linux/proc_fs.h>
65 #include <linux/seq_file.h>
66 #include <linux/sysfs.h>
67 #include <linux/backlight.h>
68 #include <linux/fb.h>
69 #include <linux/platform_device.h>
70 #include <linux/hwmon.h>
71 #include <linux/hwmon-sysfs.h>
72 #include <linux/input.h>
73 #include <linux/leds.h>
74 #include <linux/rfkill.h>
75 #include <asm/uaccess.h>
76
77 #include <linux/dmi.h>
78 #include <linux/jiffies.h>
79 #include <linux/workqueue.h>
80
81 #include <sound/core.h>
82 #include <sound/control.h>
83 #include <sound/initval.h>
84
85 #include <acpi/acpi_drivers.h>
86
87 #include <linux/pci_ids.h>
88
89
90 /* ThinkPad CMOS commands */
91 #define TP_CMOS_VOLUME_DOWN 0
92 #define TP_CMOS_VOLUME_UP 1
93 #define TP_CMOS_VOLUME_MUTE 2
94 #define TP_CMOS_BRIGHTNESS_UP 4
95 #define TP_CMOS_BRIGHTNESS_DOWN 5
96 #define TP_CMOS_THINKLIGHT_ON 12
97 #define TP_CMOS_THINKLIGHT_OFF 13
98
99 /* NVRAM Addresses */
100 enum tp_nvram_addr {
101 TP_NVRAM_ADDR_HK2 = 0x57,
102 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
103 TP_NVRAM_ADDR_VIDEO = 0x59,
104 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
105 TP_NVRAM_ADDR_MIXER = 0x60,
106 };
107
108 /* NVRAM bit masks */
109 enum {
110 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
111 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
112 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
113 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
114 TP_NVRAM_MASK_THINKLIGHT = 0x10,
115 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
116 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
117 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
118 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
119 TP_NVRAM_MASK_MUTE = 0x40,
120 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
121 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
122 TP_NVRAM_POS_LEVEL_VOLUME = 0,
123 };
124
125 /* Misc NVRAM-related */
126 enum {
127 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
128 };
129
130 /* ACPI HIDs */
131 #define TPACPI_ACPI_HKEY_HID "IBM0068"
132 #define TPACPI_ACPI_EC_HID "PNP0C09"
133
134 /* Input IDs */
135 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
136 #define TPACPI_HKEY_INPUT_VERSION 0x4101
137
138 /* ACPI \WGSV commands */
139 enum {
140 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
141 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
142 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
143 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
144 };
145
146 /* TP_ACPI_WGSV_GET_STATE bits */
147 enum {
148 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
149 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
150 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
151 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
152 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
153 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
154 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
155 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
156 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
157 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
158 };
159
160 /* HKEY events */
161 enum tpacpi_hkey_event_t {
162 /* Hotkey-related */
163 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
164 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
165 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
166 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
167 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
168 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
169
170 /* Reasons for waking up from S3/S4 */
171 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
172 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
173 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
174 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
175 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
176 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
177
178 /* Auto-sleep after eject request */
179 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
180 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
181
182 /* Misc bay events */
183 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
184
185 /* User-interface events */
186 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
187 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
188 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
189 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
190 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
191 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
192 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
193
194 /* Thermal events */
195 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
196 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
197 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
198 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
199 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* thermal table changed */
200
201 /* Misc */
202 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
203 };
204
205 /****************************************************************************
206 * Main driver
207 */
208
209 #define TPACPI_NAME "thinkpad"
210 #define TPACPI_DESC "ThinkPad ACPI Extras"
211 #define TPACPI_FILE TPACPI_NAME "_acpi"
212 #define TPACPI_URL "http://ibm-acpi.sf.net/"
213 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
214
215 #define TPACPI_PROC_DIR "ibm"
216 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
217 #define TPACPI_DRVR_NAME TPACPI_FILE
218 #define TPACPI_DRVR_SHORTNAME "tpacpi"
219 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
220
221 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
222 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
223
224 #define TPACPI_MAX_ACPI_ARGS 3
225
226 /* printk headers */
227 #define TPACPI_LOG TPACPI_FILE ": "
228 #define TPACPI_EMERG KERN_EMERG TPACPI_LOG
229 #define TPACPI_ALERT KERN_ALERT TPACPI_LOG
230 #define TPACPI_CRIT KERN_CRIT TPACPI_LOG
231 #define TPACPI_ERR KERN_ERR TPACPI_LOG
232 #define TPACPI_WARN KERN_WARNING TPACPI_LOG
233 #define TPACPI_NOTICE KERN_NOTICE TPACPI_LOG
234 #define TPACPI_INFO KERN_INFO TPACPI_LOG
235 #define TPACPI_DEBUG KERN_DEBUG TPACPI_LOG
236
237 /* Debugging printk groups */
238 #define TPACPI_DBG_ALL 0xffff
239 #define TPACPI_DBG_DISCLOSETASK 0x8000
240 #define TPACPI_DBG_INIT 0x0001
241 #define TPACPI_DBG_EXIT 0x0002
242 #define TPACPI_DBG_RFKILL 0x0004
243 #define TPACPI_DBG_HKEY 0x0008
244 #define TPACPI_DBG_FAN 0x0010
245 #define TPACPI_DBG_BRGHT 0x0020
246 #define TPACPI_DBG_MIXER 0x0040
247
248 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
249 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
250 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
251
252
253 /****************************************************************************
254 * Driver-wide structs and misc. variables
255 */
256
257 struct ibm_struct;
258
259 struct tp_acpi_drv_struct {
260 const struct acpi_device_id *hid;
261 struct acpi_driver *driver;
262
263 void (*notify) (struct ibm_struct *, u32);
264 acpi_handle *handle;
265 u32 type;
266 struct acpi_device *device;
267 };
268
269 struct ibm_struct {
270 char *name;
271
272 int (*read) (struct seq_file *);
273 int (*write) (char *);
274 void (*exit) (void);
275 void (*resume) (void);
276 void (*suspend) (pm_message_t state);
277 void (*shutdown) (void);
278
279 struct list_head all_drivers;
280
281 struct tp_acpi_drv_struct *acpi;
282
283 struct {
284 u8 acpi_driver_registered:1;
285 u8 acpi_notify_installed:1;
286 u8 proc_created:1;
287 u8 init_called:1;
288 u8 experimental:1;
289 } flags;
290 };
291
292 struct ibm_init_struct {
293 char param[32];
294
295 int (*init) (struct ibm_init_struct *);
296 mode_t base_procfs_mode;
297 struct ibm_struct *data;
298 };
299
300 static struct {
301 u32 bluetooth:1;
302 u32 hotkey:1;
303 u32 hotkey_mask:1;
304 u32 hotkey_wlsw:1;
305 u32 hotkey_tablet:1;
306 u32 light:1;
307 u32 light_status:1;
308 u32 bright_acpimode:1;
309 u32 bright_unkfw:1;
310 u32 wan:1;
311 u32 uwb:1;
312 u32 fan_ctrl_status_undef:1;
313 u32 second_fan:1;
314 u32 beep_needs_two_args:1;
315 u32 mixer_no_level_control:1;
316 u32 input_device_registered:1;
317 u32 platform_drv_registered:1;
318 u32 platform_drv_attrs_registered:1;
319 u32 sensors_pdrv_registered:1;
320 u32 sensors_pdrv_attrs_registered:1;
321 u32 sensors_pdev_attrs_registered:1;
322 u32 hotkey_poll_active:1;
323 } tp_features;
324
325 static struct {
326 u16 hotkey_mask_ff:1;
327 u16 volume_ctrl_forbidden:1;
328 } tp_warned;
329
330 struct thinkpad_id_data {
331 unsigned int vendor; /* ThinkPad vendor:
332 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
333
334 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
335 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
336
337 u16 bios_model; /* 1Y = 0x5931, 0 = unknown */
338 u16 ec_model;
339 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
340 u16 ec_release;
341
342 char *model_str; /* ThinkPad T43 */
343 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
344 };
345 static struct thinkpad_id_data thinkpad_id;
346
347 static enum {
348 TPACPI_LIFE_INIT = 0,
349 TPACPI_LIFE_RUNNING,
350 TPACPI_LIFE_EXITING,
351 } tpacpi_lifecycle;
352
353 static int experimental;
354 static u32 dbg_level;
355
356 static struct workqueue_struct *tpacpi_wq;
357
358 enum led_status_t {
359 TPACPI_LED_OFF = 0,
360 TPACPI_LED_ON,
361 TPACPI_LED_BLINK,
362 };
363
364 /* Special LED class that can defer work */
365 struct tpacpi_led_classdev {
366 struct led_classdev led_classdev;
367 struct work_struct work;
368 enum led_status_t new_state;
369 unsigned int led;
370 };
371
372 /* brightness level capabilities */
373 static unsigned int bright_maxlvl; /* 0 = unknown */
374
375 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
376 static int dbg_wlswemul;
377 static int tpacpi_wlsw_emulstate;
378 static int dbg_bluetoothemul;
379 static int tpacpi_bluetooth_emulstate;
380 static int dbg_wwanemul;
381 static int tpacpi_wwan_emulstate;
382 static int dbg_uwbemul;
383 static int tpacpi_uwb_emulstate;
384 #endif
385
386
387 /*************************************************************************
388 * Debugging helpers
389 */
390
391 #define dbg_printk(a_dbg_level, format, arg...) \
392 do { if (dbg_level & (a_dbg_level)) \
393 printk(TPACPI_DEBUG "%s: " format, __func__ , ## arg); \
394 } while (0)
395
396 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
397 #define vdbg_printk dbg_printk
398 static const char *str_supported(int is_supported);
399 #else
400 #define vdbg_printk(a_dbg_level, format, arg...) \
401 do { } while (0)
402 #endif
403
404 static void tpacpi_log_usertask(const char * const what)
405 {
406 printk(TPACPI_DEBUG "%s: access by process with PID %d\n",
407 what, task_tgid_vnr(current));
408 }
409
410 #define tpacpi_disclose_usertask(what, format, arg...) \
411 do { \
412 if (unlikely( \
413 (dbg_level & TPACPI_DBG_DISCLOSETASK) && \
414 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
415 printk(TPACPI_DEBUG "%s: PID %d: " format, \
416 what, task_tgid_vnr(current), ## arg); \
417 } \
418 } while (0)
419
420 /*
421 * Quirk handling helpers
422 *
423 * ThinkPad IDs and versions seen in the field so far
424 * are two-characters from the set [0-9A-Z], i.e. base 36.
425 *
426 * We use values well outside that range as specials.
427 */
428
429 #define TPACPI_MATCH_ANY 0xffffU
430 #define TPACPI_MATCH_UNKNOWN 0U
431
432 /* TPID('1', 'Y') == 0x5931 */
433 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
434
435 #define TPACPI_Q_IBM(__id1, __id2, __quirk) \
436 { .vendor = PCI_VENDOR_ID_IBM, \
437 .bios = TPID(__id1, __id2), \
438 .ec = TPACPI_MATCH_ANY, \
439 .quirks = (__quirk) }
440
441 #define TPACPI_Q_LNV(__id1, __id2, __quirk) \
442 { .vendor = PCI_VENDOR_ID_LENOVO, \
443 .bios = TPID(__id1, __id2), \
444 .ec = TPACPI_MATCH_ANY, \
445 .quirks = (__quirk) }
446
447 #define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
448 { .vendor = PCI_VENDOR_ID_LENOVO, \
449 .bios = TPACPI_MATCH_ANY, \
450 .ec = TPID(__id1, __id2), \
451 .quirks = (__quirk) }
452
453 struct tpacpi_quirk {
454 unsigned int vendor;
455 u16 bios;
456 u16 ec;
457 unsigned long quirks;
458 };
459
460 /**
461 * tpacpi_check_quirks() - search BIOS/EC version on a list
462 * @qlist: array of &struct tpacpi_quirk
463 * @qlist_size: number of elements in @qlist
464 *
465 * Iterates over a quirks list until one is found that matches the
466 * ThinkPad's vendor, BIOS and EC model.
467 *
468 * Returns 0 if nothing matches, otherwise returns the quirks field of
469 * the matching &struct tpacpi_quirk entry.
470 *
471 * The match criteria is: vendor, ec and bios much match.
472 */
473 static unsigned long __init tpacpi_check_quirks(
474 const struct tpacpi_quirk *qlist,
475 unsigned int qlist_size)
476 {
477 while (qlist_size) {
478 if ((qlist->vendor == thinkpad_id.vendor ||
479 qlist->vendor == TPACPI_MATCH_ANY) &&
480 (qlist->bios == thinkpad_id.bios_model ||
481 qlist->bios == TPACPI_MATCH_ANY) &&
482 (qlist->ec == thinkpad_id.ec_model ||
483 qlist->ec == TPACPI_MATCH_ANY))
484 return qlist->quirks;
485
486 qlist_size--;
487 qlist++;
488 }
489 return 0;
490 }
491
492 static inline bool __pure __init tpacpi_is_lenovo(void)
493 {
494 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
495 }
496
497 static inline bool __pure __init tpacpi_is_ibm(void)
498 {
499 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
500 }
501
502 /****************************************************************************
503 ****************************************************************************
504 *
505 * ACPI Helpers and device model
506 *
507 ****************************************************************************
508 ****************************************************************************/
509
510 /*************************************************************************
511 * ACPI basic handles
512 */
513
514 static acpi_handle root_handle;
515 static acpi_handle ec_handle;
516
517 #define TPACPI_HANDLE(object, parent, paths...) \
518 static acpi_handle object##_handle; \
519 static const acpi_handle *object##_parent __initdata = \
520 &parent##_handle; \
521 static char *object##_paths[] __initdata = { paths }
522
523 TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
524 TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
525
526 TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
527 /* T4x, X31, X40 */
528 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
529 "\\CMS", /* R40, R40e */
530 ); /* all others */
531
532 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
533 "^HKEY", /* R30, R31 */
534 "HKEY", /* all others */
535 ); /* 570 */
536
537 TPACPI_HANDLE(vid, root, "\\_SB.PCI.AGP.VGA", /* 570 */
538 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
539 "\\_SB.PCI0.VID0", /* 770e */
540 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
541 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
542 "\\_SB.PCI0.AGP.VID", /* all others */
543 ); /* R30, R31 */
544
545
546 /*************************************************************************
547 * ACPI helpers
548 */
549
550 static int acpi_evalf(acpi_handle handle,
551 void *res, char *method, char *fmt, ...)
552 {
553 char *fmt0 = fmt;
554 struct acpi_object_list params;
555 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
556 struct acpi_buffer result, *resultp;
557 union acpi_object out_obj;
558 acpi_status status;
559 va_list ap;
560 char res_type;
561 int success;
562 int quiet;
563
564 if (!*fmt) {
565 printk(TPACPI_ERR "acpi_evalf() called with empty format\n");
566 return 0;
567 }
568
569 if (*fmt == 'q') {
570 quiet = 1;
571 fmt++;
572 } else
573 quiet = 0;
574
575 res_type = *(fmt++);
576
577 params.count = 0;
578 params.pointer = &in_objs[0];
579
580 va_start(ap, fmt);
581 while (*fmt) {
582 char c = *(fmt++);
583 switch (c) {
584 case 'd': /* int */
585 in_objs[params.count].integer.value = va_arg(ap, int);
586 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
587 break;
588 /* add more types as needed */
589 default:
590 printk(TPACPI_ERR "acpi_evalf() called "
591 "with invalid format character '%c'\n", c);
592 va_end(ap);
593 return 0;
594 }
595 }
596 va_end(ap);
597
598 if (res_type != 'v') {
599 result.length = sizeof(out_obj);
600 result.pointer = &out_obj;
601 resultp = &result;
602 } else
603 resultp = NULL;
604
605 status = acpi_evaluate_object(handle, method, &params, resultp);
606
607 switch (res_type) {
608 case 'd': /* int */
609 success = (status == AE_OK &&
610 out_obj.type == ACPI_TYPE_INTEGER);
611 if (success && res)
612 *(int *)res = out_obj.integer.value;
613 break;
614 case 'v': /* void */
615 success = status == AE_OK;
616 break;
617 /* add more types as needed */
618 default:
619 printk(TPACPI_ERR "acpi_evalf() called "
620 "with invalid format character '%c'\n", res_type);
621 return 0;
622 }
623
624 if (!success && !quiet)
625 printk(TPACPI_ERR "acpi_evalf(%s, %s, ...) failed: %s\n",
626 method, fmt0, acpi_format_exception(status));
627
628 return success;
629 }
630
631 static int acpi_ec_read(int i, u8 *p)
632 {
633 int v;
634
635 if (ecrd_handle) {
636 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
637 return 0;
638 *p = v;
639 } else {
640 if (ec_read(i, p) < 0)
641 return 0;
642 }
643
644 return 1;
645 }
646
647 static int acpi_ec_write(int i, u8 v)
648 {
649 if (ecwr_handle) {
650 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
651 return 0;
652 } else {
653 if (ec_write(i, v) < 0)
654 return 0;
655 }
656
657 return 1;
658 }
659
660 static int issue_thinkpad_cmos_command(int cmos_cmd)
661 {
662 if (!cmos_handle)
663 return -ENXIO;
664
665 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
666 return -EIO;
667
668 return 0;
669 }
670
671 /*************************************************************************
672 * ACPI device model
673 */
674
675 #define TPACPI_ACPIHANDLE_INIT(object) \
676 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
677 object##_paths, ARRAY_SIZE(object##_paths))
678
679 static void __init drv_acpi_handle_init(const char *name,
680 acpi_handle *handle, const acpi_handle parent,
681 char **paths, const int num_paths)
682 {
683 int i;
684 acpi_status status;
685
686 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
687 name);
688
689 for (i = 0; i < num_paths; i++) {
690 status = acpi_get_handle(parent, paths[i], handle);
691 if (ACPI_SUCCESS(status)) {
692 dbg_printk(TPACPI_DBG_INIT,
693 "Found ACPI handle %s for %s\n",
694 paths[i], name);
695 return;
696 }
697 }
698
699 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
700 name);
701 *handle = NULL;
702 }
703
704 static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
705 u32 level, void *context, void **return_value)
706 {
707 *(acpi_handle *)return_value = handle;
708
709 return AE_CTRL_TERMINATE;
710 }
711
712 static void __init tpacpi_acpi_handle_locate(const char *name,
713 const char *hid,
714 acpi_handle *handle)
715 {
716 acpi_status status;
717 acpi_handle device_found;
718
719 BUG_ON(!name || !hid || !handle);
720 vdbg_printk(TPACPI_DBG_INIT,
721 "trying to locate ACPI handle for %s, using HID %s\n",
722 name, hid);
723
724 memset(&device_found, 0, sizeof(device_found));
725 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
726 (void *)name, &device_found);
727
728 *handle = NULL;
729
730 if (ACPI_SUCCESS(status)) {
731 *handle = device_found;
732 dbg_printk(TPACPI_DBG_INIT,
733 "Found ACPI handle for %s\n", name);
734 } else {
735 vdbg_printk(TPACPI_DBG_INIT,
736 "Could not locate an ACPI handle for %s: %s\n",
737 name, acpi_format_exception(status));
738 }
739 }
740
741 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
742 {
743 struct ibm_struct *ibm = data;
744
745 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
746 return;
747
748 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
749 return;
750
751 ibm->acpi->notify(ibm, event);
752 }
753
754 static int __init setup_acpi_notify(struct ibm_struct *ibm)
755 {
756 acpi_status status;
757 int rc;
758
759 BUG_ON(!ibm->acpi);
760
761 if (!*ibm->acpi->handle)
762 return 0;
763
764 vdbg_printk(TPACPI_DBG_INIT,
765 "setting up ACPI notify for %s\n", ibm->name);
766
767 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
768 if (rc < 0) {
769 printk(TPACPI_ERR "acpi_bus_get_device(%s) failed: %d\n",
770 ibm->name, rc);
771 return -ENODEV;
772 }
773
774 ibm->acpi->device->driver_data = ibm;
775 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
776 TPACPI_ACPI_EVENT_PREFIX,
777 ibm->name);
778
779 status = acpi_install_notify_handler(*ibm->acpi->handle,
780 ibm->acpi->type, dispatch_acpi_notify, ibm);
781 if (ACPI_FAILURE(status)) {
782 if (status == AE_ALREADY_EXISTS) {
783 printk(TPACPI_NOTICE
784 "another device driver is already "
785 "handling %s events\n", ibm->name);
786 } else {
787 printk(TPACPI_ERR
788 "acpi_install_notify_handler(%s) failed: %s\n",
789 ibm->name, acpi_format_exception(status));
790 }
791 return -ENODEV;
792 }
793 ibm->flags.acpi_notify_installed = 1;
794 return 0;
795 }
796
797 static int __init tpacpi_device_add(struct acpi_device *device)
798 {
799 return 0;
800 }
801
802 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
803 {
804 int rc;
805
806 dbg_printk(TPACPI_DBG_INIT,
807 "registering %s as an ACPI driver\n", ibm->name);
808
809 BUG_ON(!ibm->acpi);
810
811 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
812 if (!ibm->acpi->driver) {
813 printk(TPACPI_ERR
814 "failed to allocate memory for ibm->acpi->driver\n");
815 return -ENOMEM;
816 }
817
818 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
819 ibm->acpi->driver->ids = ibm->acpi->hid;
820
821 ibm->acpi->driver->ops.add = &tpacpi_device_add;
822
823 rc = acpi_bus_register_driver(ibm->acpi->driver);
824 if (rc < 0) {
825 printk(TPACPI_ERR "acpi_bus_register_driver(%s) failed: %d\n",
826 ibm->name, rc);
827 kfree(ibm->acpi->driver);
828 ibm->acpi->driver = NULL;
829 } else if (!rc)
830 ibm->flags.acpi_driver_registered = 1;
831
832 return rc;
833 }
834
835
836 /****************************************************************************
837 ****************************************************************************
838 *
839 * Procfs Helpers
840 *
841 ****************************************************************************
842 ****************************************************************************/
843
844 static int dispatch_proc_show(struct seq_file *m, void *v)
845 {
846 struct ibm_struct *ibm = m->private;
847
848 if (!ibm || !ibm->read)
849 return -EINVAL;
850 return ibm->read(m);
851 }
852
853 static int dispatch_proc_open(struct inode *inode, struct file *file)
854 {
855 return single_open(file, dispatch_proc_show, PDE(inode)->data);
856 }
857
858 static ssize_t dispatch_proc_write(struct file *file,
859 const char __user *userbuf,
860 size_t count, loff_t *pos)
861 {
862 struct ibm_struct *ibm = PDE(file->f_path.dentry->d_inode)->data;
863 char *kernbuf;
864 int ret;
865
866 if (!ibm || !ibm->write)
867 return -EINVAL;
868 if (count > PAGE_SIZE - 2)
869 return -EINVAL;
870
871 kernbuf = kmalloc(count + 2, GFP_KERNEL);
872 if (!kernbuf)
873 return -ENOMEM;
874
875 if (copy_from_user(kernbuf, userbuf, count)) {
876 kfree(kernbuf);
877 return -EFAULT;
878 }
879
880 kernbuf[count] = 0;
881 strcat(kernbuf, ",");
882 ret = ibm->write(kernbuf);
883 if (ret == 0)
884 ret = count;
885
886 kfree(kernbuf);
887
888 return ret;
889 }
890
891 static const struct file_operations dispatch_proc_fops = {
892 .owner = THIS_MODULE,
893 .open = dispatch_proc_open,
894 .read = seq_read,
895 .llseek = seq_lseek,
896 .release = single_release,
897 .write = dispatch_proc_write,
898 };
899
900 static char *next_cmd(char **cmds)
901 {
902 char *start = *cmds;
903 char *end;
904
905 while ((end = strchr(start, ',')) && end == start)
906 start = end + 1;
907
908 if (!end)
909 return NULL;
910
911 *end = 0;
912 *cmds = end + 1;
913 return start;
914 }
915
916
917 /****************************************************************************
918 ****************************************************************************
919 *
920 * Device model: input, hwmon and platform
921 *
922 ****************************************************************************
923 ****************************************************************************/
924
925 static struct platform_device *tpacpi_pdev;
926 static struct platform_device *tpacpi_sensors_pdev;
927 static struct device *tpacpi_hwmon;
928 static struct input_dev *tpacpi_inputdev;
929 static struct mutex tpacpi_inputdev_send_mutex;
930 static LIST_HEAD(tpacpi_all_drivers);
931
932 static int tpacpi_suspend_handler(struct platform_device *pdev,
933 pm_message_t state)
934 {
935 struct ibm_struct *ibm, *itmp;
936
937 list_for_each_entry_safe(ibm, itmp,
938 &tpacpi_all_drivers,
939 all_drivers) {
940 if (ibm->suspend)
941 (ibm->suspend)(state);
942 }
943
944 return 0;
945 }
946
947 static int tpacpi_resume_handler(struct platform_device *pdev)
948 {
949 struct ibm_struct *ibm, *itmp;
950
951 list_for_each_entry_safe(ibm, itmp,
952 &tpacpi_all_drivers,
953 all_drivers) {
954 if (ibm->resume)
955 (ibm->resume)();
956 }
957
958 return 0;
959 }
960
961 static void tpacpi_shutdown_handler(struct platform_device *pdev)
962 {
963 struct ibm_struct *ibm, *itmp;
964
965 list_for_each_entry_safe(ibm, itmp,
966 &tpacpi_all_drivers,
967 all_drivers) {
968 if (ibm->shutdown)
969 (ibm->shutdown)();
970 }
971 }
972
973 static struct platform_driver tpacpi_pdriver = {
974 .driver = {
975 .name = TPACPI_DRVR_NAME,
976 .owner = THIS_MODULE,
977 },
978 .suspend = tpacpi_suspend_handler,
979 .resume = tpacpi_resume_handler,
980 .shutdown = tpacpi_shutdown_handler,
981 };
982
983 static struct platform_driver tpacpi_hwmon_pdriver = {
984 .driver = {
985 .name = TPACPI_HWMON_DRVR_NAME,
986 .owner = THIS_MODULE,
987 },
988 };
989
990 /*************************************************************************
991 * sysfs support helpers
992 */
993
994 struct attribute_set {
995 unsigned int members, max_members;
996 struct attribute_group group;
997 };
998
999 struct attribute_set_obj {
1000 struct attribute_set s;
1001 struct attribute *a;
1002 } __attribute__((packed));
1003
1004 static struct attribute_set *create_attr_set(unsigned int max_members,
1005 const char *name)
1006 {
1007 struct attribute_set_obj *sobj;
1008
1009 if (max_members == 0)
1010 return NULL;
1011
1012 /* Allocates space for implicit NULL at the end too */
1013 sobj = kzalloc(sizeof(struct attribute_set_obj) +
1014 max_members * sizeof(struct attribute *),
1015 GFP_KERNEL);
1016 if (!sobj)
1017 return NULL;
1018 sobj->s.max_members = max_members;
1019 sobj->s.group.attrs = &sobj->a;
1020 sobj->s.group.name = name;
1021
1022 return &sobj->s;
1023 }
1024
1025 #define destroy_attr_set(_set) \
1026 kfree(_set);
1027
1028 /* not multi-threaded safe, use it in a single thread per set */
1029 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1030 {
1031 if (!s || !attr)
1032 return -EINVAL;
1033
1034 if (s->members >= s->max_members)
1035 return -ENOMEM;
1036
1037 s->group.attrs[s->members] = attr;
1038 s->members++;
1039
1040 return 0;
1041 }
1042
1043 static int add_many_to_attr_set(struct attribute_set *s,
1044 struct attribute **attr,
1045 unsigned int count)
1046 {
1047 int i, res;
1048
1049 for (i = 0; i < count; i++) {
1050 res = add_to_attr_set(s, attr[i]);
1051 if (res)
1052 return res;
1053 }
1054
1055 return 0;
1056 }
1057
1058 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1059 {
1060 sysfs_remove_group(kobj, &s->group);
1061 destroy_attr_set(s);
1062 }
1063
1064 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1065 sysfs_create_group(_kobj, &_attr_set->group)
1066
1067 static int parse_strtoul(const char *buf,
1068 unsigned long max, unsigned long *value)
1069 {
1070 char *endp;
1071
1072 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1073 endp = skip_spaces(endp);
1074 if (*endp || *value > max)
1075 return -EINVAL;
1076
1077 return 0;
1078 }
1079
1080 static void tpacpi_disable_brightness_delay(void)
1081 {
1082 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1083 printk(TPACPI_NOTICE
1084 "ACPI backlight control delay disabled\n");
1085 }
1086
1087 static void printk_deprecated_attribute(const char * const what,
1088 const char * const details)
1089 {
1090 tpacpi_log_usertask("deprecated sysfs attribute");
1091 printk(TPACPI_WARN "WARNING: sysfs attribute %s is deprecated and "
1092 "will be removed. %s\n",
1093 what, details);
1094 }
1095
1096 /*************************************************************************
1097 * rfkill and radio control support helpers
1098 */
1099
1100 /*
1101 * ThinkPad-ACPI firmware handling model:
1102 *
1103 * WLSW (master wireless switch) is event-driven, and is common to all
1104 * firmware-controlled radios. It cannot be controlled, just monitored,
1105 * as expected. It overrides all radio state in firmware
1106 *
1107 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1108 * (TODO: verify how WLSW interacts with the returned radio state).
1109 *
1110 * The only time there are shadow radio state changes, is when
1111 * masked-off hotkeys are used.
1112 */
1113
1114 /*
1115 * Internal driver API for radio state:
1116 *
1117 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1118 * bool: true means radio blocked (off)
1119 */
1120 enum tpacpi_rfkill_state {
1121 TPACPI_RFK_RADIO_OFF = 0,
1122 TPACPI_RFK_RADIO_ON
1123 };
1124
1125 /* rfkill switches */
1126 enum tpacpi_rfk_id {
1127 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1128 TPACPI_RFK_WWAN_SW_ID,
1129 TPACPI_RFK_UWB_SW_ID,
1130 TPACPI_RFK_SW_MAX
1131 };
1132
1133 static const char *tpacpi_rfkill_names[] = {
1134 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1135 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1136 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1137 [TPACPI_RFK_SW_MAX] = NULL
1138 };
1139
1140 /* ThinkPad-ACPI rfkill subdriver */
1141 struct tpacpi_rfk {
1142 struct rfkill *rfkill;
1143 enum tpacpi_rfk_id id;
1144 const struct tpacpi_rfk_ops *ops;
1145 };
1146
1147 struct tpacpi_rfk_ops {
1148 /* firmware interface */
1149 int (*get_status)(void);
1150 int (*set_status)(const enum tpacpi_rfkill_state);
1151 };
1152
1153 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1154
1155 /* Query FW and update rfkill sw state for a given rfkill switch */
1156 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1157 {
1158 int status;
1159
1160 if (!tp_rfk)
1161 return -ENODEV;
1162
1163 status = (tp_rfk->ops->get_status)();
1164 if (status < 0)
1165 return status;
1166
1167 rfkill_set_sw_state(tp_rfk->rfkill,
1168 (status == TPACPI_RFK_RADIO_OFF));
1169
1170 return status;
1171 }
1172
1173 /* Query FW and update rfkill sw state for all rfkill switches */
1174 static void tpacpi_rfk_update_swstate_all(void)
1175 {
1176 unsigned int i;
1177
1178 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1179 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1180 }
1181
1182 /*
1183 * Sync the HW-blocking state of all rfkill switches,
1184 * do notice it causes the rfkill core to schedule uevents
1185 */
1186 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1187 {
1188 unsigned int i;
1189 struct tpacpi_rfk *tp_rfk;
1190
1191 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1192 tp_rfk = tpacpi_rfkill_switches[i];
1193 if (tp_rfk) {
1194 if (rfkill_set_hw_state(tp_rfk->rfkill,
1195 blocked)) {
1196 /* ignore -- we track sw block */
1197 }
1198 }
1199 }
1200 }
1201
1202 /* Call to get the WLSW state from the firmware */
1203 static int hotkey_get_wlsw(void);
1204
1205 /* Call to query WLSW state and update all rfkill switches */
1206 static bool tpacpi_rfk_check_hwblock_state(void)
1207 {
1208 int res = hotkey_get_wlsw();
1209 int hw_blocked;
1210
1211 /* When unknown or unsupported, we have to assume it is unblocked */
1212 if (res < 0)
1213 return false;
1214
1215 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1216 tpacpi_rfk_update_hwblock_state(hw_blocked);
1217
1218 return hw_blocked;
1219 }
1220
1221 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1222 {
1223 struct tpacpi_rfk *tp_rfk = data;
1224 int res;
1225
1226 dbg_printk(TPACPI_DBG_RFKILL,
1227 "request to change radio state to %s\n",
1228 blocked ? "blocked" : "unblocked");
1229
1230 /* try to set radio state */
1231 res = (tp_rfk->ops->set_status)(blocked ?
1232 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1233
1234 /* and update the rfkill core with whatever the FW really did */
1235 tpacpi_rfk_update_swstate(tp_rfk);
1236
1237 return (res < 0) ? res : 0;
1238 }
1239
1240 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1241 .set_block = tpacpi_rfk_hook_set_block,
1242 };
1243
1244 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1245 const struct tpacpi_rfk_ops *tp_rfkops,
1246 const enum rfkill_type rfktype,
1247 const char *name,
1248 const bool set_default)
1249 {
1250 struct tpacpi_rfk *atp_rfk;
1251 int res;
1252 bool sw_state = false;
1253 bool hw_state;
1254 int sw_status;
1255
1256 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1257
1258 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1259 if (atp_rfk)
1260 atp_rfk->rfkill = rfkill_alloc(name,
1261 &tpacpi_pdev->dev,
1262 rfktype,
1263 &tpacpi_rfk_rfkill_ops,
1264 atp_rfk);
1265 if (!atp_rfk || !atp_rfk->rfkill) {
1266 printk(TPACPI_ERR
1267 "failed to allocate memory for rfkill class\n");
1268 kfree(atp_rfk);
1269 return -ENOMEM;
1270 }
1271
1272 atp_rfk->id = id;
1273 atp_rfk->ops = tp_rfkops;
1274
1275 sw_status = (tp_rfkops->get_status)();
1276 if (sw_status < 0) {
1277 printk(TPACPI_ERR
1278 "failed to read initial state for %s, error %d\n",
1279 name, sw_status);
1280 } else {
1281 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1282 if (set_default) {
1283 /* try to keep the initial state, since we ask the
1284 * firmware to preserve it across S5 in NVRAM */
1285 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1286 }
1287 }
1288 hw_state = tpacpi_rfk_check_hwblock_state();
1289 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1290
1291 res = rfkill_register(atp_rfk->rfkill);
1292 if (res < 0) {
1293 printk(TPACPI_ERR
1294 "failed to register %s rfkill switch: %d\n",
1295 name, res);
1296 rfkill_destroy(atp_rfk->rfkill);
1297 kfree(atp_rfk);
1298 return res;
1299 }
1300
1301 tpacpi_rfkill_switches[id] = atp_rfk;
1302
1303 printk(TPACPI_INFO "rfkill switch %s: radio is %sblocked\n",
1304 name, (sw_state || hw_state) ? "" : "un");
1305 return 0;
1306 }
1307
1308 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1309 {
1310 struct tpacpi_rfk *tp_rfk;
1311
1312 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1313
1314 tp_rfk = tpacpi_rfkill_switches[id];
1315 if (tp_rfk) {
1316 rfkill_unregister(tp_rfk->rfkill);
1317 rfkill_destroy(tp_rfk->rfkill);
1318 tpacpi_rfkill_switches[id] = NULL;
1319 kfree(tp_rfk);
1320 }
1321 }
1322
1323 static void printk_deprecated_rfkill_attribute(const char * const what)
1324 {
1325 printk_deprecated_attribute(what,
1326 "Please switch to generic rfkill before year 2010");
1327 }
1328
1329 /* sysfs <radio> enable ------------------------------------------------ */
1330 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1331 struct device_attribute *attr,
1332 char *buf)
1333 {
1334 int status;
1335
1336 printk_deprecated_rfkill_attribute(attr->attr.name);
1337
1338 /* This is in the ABI... */
1339 if (tpacpi_rfk_check_hwblock_state()) {
1340 status = TPACPI_RFK_RADIO_OFF;
1341 } else {
1342 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1343 if (status < 0)
1344 return status;
1345 }
1346
1347 return snprintf(buf, PAGE_SIZE, "%d\n",
1348 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1349 }
1350
1351 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1352 struct device_attribute *attr,
1353 const char *buf, size_t count)
1354 {
1355 unsigned long t;
1356 int res;
1357
1358 printk_deprecated_rfkill_attribute(attr->attr.name);
1359
1360 if (parse_strtoul(buf, 1, &t))
1361 return -EINVAL;
1362
1363 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1364
1365 /* This is in the ABI... */
1366 if (tpacpi_rfk_check_hwblock_state() && !!t)
1367 return -EPERM;
1368
1369 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1370 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1371 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1372
1373 return (res < 0) ? res : count;
1374 }
1375
1376 /* procfs -------------------------------------------------------------- */
1377 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1378 {
1379 if (id >= TPACPI_RFK_SW_MAX)
1380 seq_printf(m, "status:\t\tnot supported\n");
1381 else {
1382 int status;
1383
1384 /* This is in the ABI... */
1385 if (tpacpi_rfk_check_hwblock_state()) {
1386 status = TPACPI_RFK_RADIO_OFF;
1387 } else {
1388 status = tpacpi_rfk_update_swstate(
1389 tpacpi_rfkill_switches[id]);
1390 if (status < 0)
1391 return status;
1392 }
1393
1394 seq_printf(m, "status:\t\t%s\n",
1395 (status == TPACPI_RFK_RADIO_ON) ?
1396 "enabled" : "disabled");
1397 seq_printf(m, "commands:\tenable, disable\n");
1398 }
1399
1400 return 0;
1401 }
1402
1403 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1404 {
1405 char *cmd;
1406 int status = -1;
1407 int res = 0;
1408
1409 if (id >= TPACPI_RFK_SW_MAX)
1410 return -ENODEV;
1411
1412 while ((cmd = next_cmd(&buf))) {
1413 if (strlencmp(cmd, "enable") == 0)
1414 status = TPACPI_RFK_RADIO_ON;
1415 else if (strlencmp(cmd, "disable") == 0)
1416 status = TPACPI_RFK_RADIO_OFF;
1417 else
1418 return -EINVAL;
1419 }
1420
1421 if (status != -1) {
1422 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1423 (status == TPACPI_RFK_RADIO_ON) ?
1424 "enable" : "disable",
1425 tpacpi_rfkill_names[id]);
1426 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1427 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1428 }
1429
1430 return res;
1431 }
1432
1433 /*************************************************************************
1434 * thinkpad-acpi driver attributes
1435 */
1436
1437 /* interface_version --------------------------------------------------- */
1438 static ssize_t tpacpi_driver_interface_version_show(
1439 struct device_driver *drv,
1440 char *buf)
1441 {
1442 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1443 }
1444
1445 static DRIVER_ATTR(interface_version, S_IRUGO,
1446 tpacpi_driver_interface_version_show, NULL);
1447
1448 /* debug_level --------------------------------------------------------- */
1449 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1450 char *buf)
1451 {
1452 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1453 }
1454
1455 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1456 const char *buf, size_t count)
1457 {
1458 unsigned long t;
1459
1460 if (parse_strtoul(buf, 0xffff, &t))
1461 return -EINVAL;
1462
1463 dbg_level = t;
1464
1465 return count;
1466 }
1467
1468 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1469 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1470
1471 /* version ------------------------------------------------------------- */
1472 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1473 char *buf)
1474 {
1475 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1476 TPACPI_DESC, TPACPI_VERSION);
1477 }
1478
1479 static DRIVER_ATTR(version, S_IRUGO,
1480 tpacpi_driver_version_show, NULL);
1481
1482 /* --------------------------------------------------------------------- */
1483
1484 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1485
1486 /* wlsw_emulstate ------------------------------------------------------ */
1487 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1488 char *buf)
1489 {
1490 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1491 }
1492
1493 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1494 const char *buf, size_t count)
1495 {
1496 unsigned long t;
1497
1498 if (parse_strtoul(buf, 1, &t))
1499 return -EINVAL;
1500
1501 if (tpacpi_wlsw_emulstate != !!t) {
1502 tpacpi_wlsw_emulstate = !!t;
1503 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1504 }
1505
1506 return count;
1507 }
1508
1509 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1510 tpacpi_driver_wlsw_emulstate_show,
1511 tpacpi_driver_wlsw_emulstate_store);
1512
1513 /* bluetooth_emulstate ------------------------------------------------- */
1514 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1515 struct device_driver *drv,
1516 char *buf)
1517 {
1518 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1519 }
1520
1521 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1522 struct device_driver *drv,
1523 const char *buf, size_t count)
1524 {
1525 unsigned long t;
1526
1527 if (parse_strtoul(buf, 1, &t))
1528 return -EINVAL;
1529
1530 tpacpi_bluetooth_emulstate = !!t;
1531
1532 return count;
1533 }
1534
1535 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1536 tpacpi_driver_bluetooth_emulstate_show,
1537 tpacpi_driver_bluetooth_emulstate_store);
1538
1539 /* wwan_emulstate ------------------------------------------------- */
1540 static ssize_t tpacpi_driver_wwan_emulstate_show(
1541 struct device_driver *drv,
1542 char *buf)
1543 {
1544 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1545 }
1546
1547 static ssize_t tpacpi_driver_wwan_emulstate_store(
1548 struct device_driver *drv,
1549 const char *buf, size_t count)
1550 {
1551 unsigned long t;
1552
1553 if (parse_strtoul(buf, 1, &t))
1554 return -EINVAL;
1555
1556 tpacpi_wwan_emulstate = !!t;
1557
1558 return count;
1559 }
1560
1561 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1562 tpacpi_driver_wwan_emulstate_show,
1563 tpacpi_driver_wwan_emulstate_store);
1564
1565 /* uwb_emulstate ------------------------------------------------- */
1566 static ssize_t tpacpi_driver_uwb_emulstate_show(
1567 struct device_driver *drv,
1568 char *buf)
1569 {
1570 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1571 }
1572
1573 static ssize_t tpacpi_driver_uwb_emulstate_store(
1574 struct device_driver *drv,
1575 const char *buf, size_t count)
1576 {
1577 unsigned long t;
1578
1579 if (parse_strtoul(buf, 1, &t))
1580 return -EINVAL;
1581
1582 tpacpi_uwb_emulstate = !!t;
1583
1584 return count;
1585 }
1586
1587 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1588 tpacpi_driver_uwb_emulstate_show,
1589 tpacpi_driver_uwb_emulstate_store);
1590 #endif
1591
1592 /* --------------------------------------------------------------------- */
1593
1594 static struct driver_attribute *tpacpi_driver_attributes[] = {
1595 &driver_attr_debug_level, &driver_attr_version,
1596 &driver_attr_interface_version,
1597 };
1598
1599 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1600 {
1601 int i, res;
1602
1603 i = 0;
1604 res = 0;
1605 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1606 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1607 i++;
1608 }
1609
1610 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1611 if (!res && dbg_wlswemul)
1612 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1613 if (!res && dbg_bluetoothemul)
1614 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1615 if (!res && dbg_wwanemul)
1616 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1617 if (!res && dbg_uwbemul)
1618 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1619 #endif
1620
1621 return res;
1622 }
1623
1624 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1625 {
1626 int i;
1627
1628 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1629 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1630
1631 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1632 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1633 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1634 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1635 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1636 #endif
1637 }
1638
1639 /*************************************************************************
1640 * Firmware Data
1641 */
1642
1643 /*
1644 * Table of recommended minimum BIOS versions
1645 *
1646 * Reasons for listing:
1647 * 1. Stable BIOS, listed because the unknown amount of
1648 * bugs and bad ACPI behaviour on older versions
1649 *
1650 * 2. BIOS or EC fw with known bugs that trigger on Linux
1651 *
1652 * 3. BIOS with known reduced functionality in older versions
1653 *
1654 * We recommend the latest BIOS and EC version.
1655 * We only support the latest BIOS and EC fw version as a rule.
1656 *
1657 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1658 * Information from users in ThinkWiki
1659 *
1660 * WARNING: we use this table also to detect that the machine is
1661 * a ThinkPad in some cases, so don't remove entries lightly.
1662 */
1663
1664 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1665 { .vendor = (__v), \
1666 .bios = TPID(__id1, __id2), \
1667 .ec = TPACPI_MATCH_ANY, \
1668 .quirks = TPACPI_MATCH_ANY << 16 \
1669 | (__bv1) << 8 | (__bv2) }
1670
1671 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1672 __eid, __ev1, __ev2) \
1673 { .vendor = (__v), \
1674 .bios = TPID(__bid1, __bid2), \
1675 .ec = __eid, \
1676 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1677 | (__bv1) << 8 | (__bv2) }
1678
1679 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1680 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1681
1682 /* Outdated IBM BIOSes often lack the EC id string */
1683 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1684 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1685 __bv1, __bv2, TPID(__id1, __id2), \
1686 __ev1, __ev2), \
1687 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1688 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1689 __ev1, __ev2)
1690
1691 /* Outdated IBM BIOSes often lack the EC id string */
1692 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1693 __eid1, __eid2, __ev1, __ev2) \
1694 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1695 __bv1, __bv2, TPID(__eid1, __eid2), \
1696 __ev1, __ev2), \
1697 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1698 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1699 __ev1, __ev2)
1700
1701 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1702 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1703
1704 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1705 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1706 __bv1, __bv2, TPID(__id1, __id2), \
1707 __ev1, __ev2)
1708
1709 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1710 __eid1, __eid2, __ev1, __ev2) \
1711 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1712 __bv1, __bv2, TPID(__eid1, __eid2), \
1713 __ev1, __ev2)
1714
1715 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1716 /* Numeric models ------------------ */
1717 /* FW MODEL BIOS VERS */
1718 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1719 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1720 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1721 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1722 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1723 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1724 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1725 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1726 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1727
1728 /* A-series ------------------------- */
1729 /* FW MODEL BIOS VERS EC VERS */
1730 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1731 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1732 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1733 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1734 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1735 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1736 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1737 TPV_QI0('1', '3', '2', '0'), /* A22m */
1738 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1739 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1740 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1741
1742 /* G-series ------------------------- */
1743 /* FW MODEL BIOS VERS */
1744 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1745 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1746
1747 /* R-series, T-series --------------- */
1748 /* FW MODEL BIOS VERS EC VERS */
1749 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1750 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1751 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1752 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1753 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1754 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1755 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1756 T40/p, T41/p, T42/p (1) */
1757 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1758 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1759 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1760 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1761
1762 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1763 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1764 TPV_QI0('1', '6', '3', '2'), /* T22 */
1765 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1766 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1767 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1768
1769 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1770 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1771 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1772
1773 /* BIOS FW BIOS VERS EC FW EC VERS */
1774 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1775 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1776
1777 /* X-series ------------------------- */
1778 /* FW MODEL BIOS VERS EC VERS */
1779 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1780 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1781 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1782 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1783 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1784 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1785 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1786
1787 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1788 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1789
1790 /* (0) - older versions lack DMI EC fw string and functionality */
1791 /* (1) - older versions known to lack functionality */
1792 };
1793
1794 #undef TPV_QL1
1795 #undef TPV_QL0
1796 #undef TPV_QI2
1797 #undef TPV_QI1
1798 #undef TPV_QI0
1799 #undef TPV_Q_X
1800 #undef TPV_Q
1801
1802 static void __init tpacpi_check_outdated_fw(void)
1803 {
1804 unsigned long fwvers;
1805 u16 ec_version, bios_version;
1806
1807 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1808 ARRAY_SIZE(tpacpi_bios_version_qtable));
1809
1810 if (!fwvers)
1811 return;
1812
1813 bios_version = fwvers & 0xffffU;
1814 ec_version = (fwvers >> 16) & 0xffffU;
1815
1816 /* note that unknown versions are set to 0x0000 and we use that */
1817 if ((bios_version > thinkpad_id.bios_release) ||
1818 (ec_version > thinkpad_id.ec_release &&
1819 ec_version != TPACPI_MATCH_ANY)) {
1820 /*
1821 * The changelogs would let us track down the exact
1822 * reason, but it is just too much of a pain to track
1823 * it. We only list BIOSes that are either really
1824 * broken, or really stable to begin with, so it is
1825 * best if the user upgrades the firmware anyway.
1826 */
1827 printk(TPACPI_WARN
1828 "WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1829 printk(TPACPI_WARN
1830 "WARNING: This firmware may be missing critical bug "
1831 "fixes and/or important features\n");
1832 }
1833 }
1834
1835 static bool __init tpacpi_is_fw_known(void)
1836 {
1837 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1838 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1839 }
1840
1841 /****************************************************************************
1842 ****************************************************************************
1843 *
1844 * Subdrivers
1845 *
1846 ****************************************************************************
1847 ****************************************************************************/
1848
1849 /*************************************************************************
1850 * thinkpad-acpi metadata subdriver
1851 */
1852
1853 static int thinkpad_acpi_driver_read(struct seq_file *m)
1854 {
1855 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1856 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1857 return 0;
1858 }
1859
1860 static struct ibm_struct thinkpad_acpi_driver_data = {
1861 .name = "driver",
1862 .read = thinkpad_acpi_driver_read,
1863 };
1864
1865 /*************************************************************************
1866 * Hotkey subdriver
1867 */
1868
1869 /*
1870 * ThinkPad firmware event model
1871 *
1872 * The ThinkPad firmware has two main event interfaces: normal ACPI
1873 * notifications (which follow the ACPI standard), and a private event
1874 * interface.
1875 *
1876 * The private event interface also issues events for the hotkeys. As
1877 * the driver gained features, the event handling code ended up being
1878 * built around the hotkey subdriver. This will need to be refactored
1879 * to a more formal event API eventually.
1880 *
1881 * Some "hotkeys" are actually supposed to be used as event reports,
1882 * such as "brightness has changed", "volume has changed", depending on
1883 * the ThinkPad model and how the firmware is operating.
1884 *
1885 * Unlike other classes, hotkey-class events have mask/unmask control on
1886 * non-ancient firmware. However, how it behaves changes a lot with the
1887 * firmware model and version.
1888 */
1889
1890 enum { /* hot key scan codes (derived from ACPI DSDT) */
1891 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1892 TP_ACPI_HOTKEYSCAN_FNF2,
1893 TP_ACPI_HOTKEYSCAN_FNF3,
1894 TP_ACPI_HOTKEYSCAN_FNF4,
1895 TP_ACPI_HOTKEYSCAN_FNF5,
1896 TP_ACPI_HOTKEYSCAN_FNF6,
1897 TP_ACPI_HOTKEYSCAN_FNF7,
1898 TP_ACPI_HOTKEYSCAN_FNF8,
1899 TP_ACPI_HOTKEYSCAN_FNF9,
1900 TP_ACPI_HOTKEYSCAN_FNF10,
1901 TP_ACPI_HOTKEYSCAN_FNF11,
1902 TP_ACPI_HOTKEYSCAN_FNF12,
1903 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1904 TP_ACPI_HOTKEYSCAN_FNINSERT,
1905 TP_ACPI_HOTKEYSCAN_FNDELETE,
1906 TP_ACPI_HOTKEYSCAN_FNHOME,
1907 TP_ACPI_HOTKEYSCAN_FNEND,
1908 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1909 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1910 TP_ACPI_HOTKEYSCAN_FNSPACE,
1911 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1912 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1913 TP_ACPI_HOTKEYSCAN_MUTE,
1914 TP_ACPI_HOTKEYSCAN_THINKPAD,
1915 TP_ACPI_HOTKEYSCAN_UNK1,
1916 TP_ACPI_HOTKEYSCAN_UNK2,
1917 TP_ACPI_HOTKEYSCAN_UNK3,
1918 TP_ACPI_HOTKEYSCAN_UNK4,
1919 TP_ACPI_HOTKEYSCAN_UNK5,
1920 TP_ACPI_HOTKEYSCAN_UNK6,
1921 TP_ACPI_HOTKEYSCAN_UNK7,
1922 TP_ACPI_HOTKEYSCAN_UNK8,
1923
1924 /* Hotkey keymap size */
1925 TPACPI_HOTKEY_MAP_LEN
1926 };
1927
1928 enum { /* Keys/events available through NVRAM polling */
1929 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1930 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1931 };
1932
1933 enum { /* Positions of some of the keys in hotkey masks */
1934 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1935 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1936 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1937 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1938 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1939 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1940 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1941 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1942 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1943 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1944 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1945 };
1946
1947 enum { /* NVRAM to ACPI HKEY group map */
1948 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1949 TP_ACPI_HKEY_ZOOM_MASK |
1950 TP_ACPI_HKEY_DISPSWTCH_MASK |
1951 TP_ACPI_HKEY_HIBERNATE_MASK,
1952 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1953 TP_ACPI_HKEY_BRGHTDWN_MASK,
1954 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1955 TP_ACPI_HKEY_VOLDWN_MASK |
1956 TP_ACPI_HKEY_MUTE_MASK,
1957 };
1958
1959 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1960 struct tp_nvram_state {
1961 u16 thinkpad_toggle:1;
1962 u16 zoom_toggle:1;
1963 u16 display_toggle:1;
1964 u16 thinklight_toggle:1;
1965 u16 hibernate_toggle:1;
1966 u16 displayexp_toggle:1;
1967 u16 display_state:1;
1968 u16 brightness_toggle:1;
1969 u16 volume_toggle:1;
1970 u16 mute:1;
1971
1972 u8 brightness_level;
1973 u8 volume_level;
1974 };
1975
1976 /* kthread for the hotkey poller */
1977 static struct task_struct *tpacpi_hotkey_task;
1978
1979 /* Acquired while the poller kthread is running, use to sync start/stop */
1980 static struct mutex hotkey_thread_mutex;
1981
1982 /*
1983 * Acquire mutex to write poller control variables as an
1984 * atomic block.
1985 *
1986 * Increment hotkey_config_change when changing them if you
1987 * want the kthread to forget old state.
1988 *
1989 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1990 */
1991 static struct mutex hotkey_thread_data_mutex;
1992 static unsigned int hotkey_config_change;
1993
1994 /*
1995 * hotkey poller control variables
1996 *
1997 * Must be atomic or readers will also need to acquire mutex
1998 *
1999 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2000 * should be used only when the changes need to be taken as
2001 * a block, OR when one needs to force the kthread to forget
2002 * old state.
2003 */
2004 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2005 static unsigned int hotkey_poll_freq = 10; /* Hz */
2006
2007 #define HOTKEY_CONFIG_CRITICAL_START \
2008 do { \
2009 mutex_lock(&hotkey_thread_data_mutex); \
2010 hotkey_config_change++; \
2011 } while (0);
2012 #define HOTKEY_CONFIG_CRITICAL_END \
2013 mutex_unlock(&hotkey_thread_data_mutex);
2014
2015 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2016
2017 #define hotkey_source_mask 0U
2018 #define HOTKEY_CONFIG_CRITICAL_START
2019 #define HOTKEY_CONFIG_CRITICAL_END
2020
2021 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2022
2023 static struct mutex hotkey_mutex;
2024
2025 static enum { /* Reasons for waking up */
2026 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2027 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2028 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2029 } hotkey_wakeup_reason;
2030
2031 static int hotkey_autosleep_ack;
2032
2033 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2034 static u32 hotkey_all_mask; /* all events supported in fw */
2035 static u32 hotkey_reserved_mask; /* events better left disabled */
2036 static u32 hotkey_driver_mask; /* events needed by the driver */
2037 static u32 hotkey_user_mask; /* events visible to userspace */
2038 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2039
2040 static unsigned int hotkey_report_mode;
2041
2042 static u16 *hotkey_keycode_map;
2043
2044 static struct attribute_set *hotkey_dev_attributes;
2045
2046 static void tpacpi_driver_event(const unsigned int hkey_event);
2047 static void hotkey_driver_event(const unsigned int scancode);
2048 static void hotkey_poll_setup(const bool may_warn);
2049
2050 /* HKEY.MHKG() return bits */
2051 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2052
2053 static int hotkey_get_wlsw(void)
2054 {
2055 int status;
2056
2057 if (!tp_features.hotkey_wlsw)
2058 return -ENODEV;
2059
2060 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2061 if (dbg_wlswemul)
2062 return (tpacpi_wlsw_emulstate) ?
2063 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2064 #endif
2065
2066 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2067 return -EIO;
2068
2069 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2070 }
2071
2072 static int hotkey_get_tablet_mode(int *status)
2073 {
2074 int s;
2075
2076 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2077 return -EIO;
2078
2079 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2080 return 0;
2081 }
2082
2083 /*
2084 * Reads current event mask from firmware, and updates
2085 * hotkey_acpi_mask accordingly. Also resets any bits
2086 * from hotkey_user_mask that are unavailable to be
2087 * delivered (shadow requirement of the userspace ABI).
2088 *
2089 * Call with hotkey_mutex held
2090 */
2091 static int hotkey_mask_get(void)
2092 {
2093 if (tp_features.hotkey_mask) {
2094 u32 m = 0;
2095
2096 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2097 return -EIO;
2098
2099 hotkey_acpi_mask = m;
2100 } else {
2101 /* no mask support doesn't mean no event support... */
2102 hotkey_acpi_mask = hotkey_all_mask;
2103 }
2104
2105 /* sync userspace-visible mask */
2106 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2107
2108 return 0;
2109 }
2110
2111 void static hotkey_mask_warn_incomplete_mask(void)
2112 {
2113 /* log only what the user can fix... */
2114 const u32 wantedmask = hotkey_driver_mask &
2115 ~(hotkey_acpi_mask | hotkey_source_mask) &
2116 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2117
2118 if (wantedmask)
2119 printk(TPACPI_NOTICE
2120 "required events 0x%08x not enabled!\n",
2121 wantedmask);
2122 }
2123
2124 /*
2125 * Set the firmware mask when supported
2126 *
2127 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2128 *
2129 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2130 *
2131 * Call with hotkey_mutex held
2132 */
2133 static int hotkey_mask_set(u32 mask)
2134 {
2135 int i;
2136 int rc = 0;
2137
2138 const u32 fwmask = mask & ~hotkey_source_mask;
2139
2140 if (tp_features.hotkey_mask) {
2141 for (i = 0; i < 32; i++) {
2142 if (!acpi_evalf(hkey_handle,
2143 NULL, "MHKM", "vdd", i + 1,
2144 !!(mask & (1 << i)))) {
2145 rc = -EIO;
2146 break;
2147 }
2148 }
2149 }
2150
2151 /*
2152 * We *must* make an inconditional call to hotkey_mask_get to
2153 * refresh hotkey_acpi_mask and update hotkey_user_mask
2154 *
2155 * Take the opportunity to also log when we cannot _enable_
2156 * a given event.
2157 */
2158 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2159 printk(TPACPI_NOTICE
2160 "asked for hotkey mask 0x%08x, but "
2161 "firmware forced it to 0x%08x\n",
2162 fwmask, hotkey_acpi_mask);
2163 }
2164
2165 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2166 hotkey_mask_warn_incomplete_mask();
2167
2168 return rc;
2169 }
2170
2171 /*
2172 * Sets hotkey_user_mask and tries to set the firmware mask
2173 *
2174 * Call with hotkey_mutex held
2175 */
2176 static int hotkey_user_mask_set(const u32 mask)
2177 {
2178 int rc;
2179
2180 /* Give people a chance to notice they are doing something that
2181 * is bound to go boom on their users sooner or later */
2182 if (!tp_warned.hotkey_mask_ff &&
2183 (mask == 0xffff || mask == 0xffffff ||
2184 mask == 0xffffffff)) {
2185 tp_warned.hotkey_mask_ff = 1;
2186 printk(TPACPI_NOTICE
2187 "setting the hotkey mask to 0x%08x is likely "
2188 "not the best way to go about it\n", mask);
2189 printk(TPACPI_NOTICE
2190 "please consider using the driver defaults, "
2191 "and refer to up-to-date thinkpad-acpi "
2192 "documentation\n");
2193 }
2194
2195 /* Try to enable what the user asked for, plus whatever we need.
2196 * this syncs everything but won't enable bits in hotkey_user_mask */
2197 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2198
2199 /* Enable the available bits in hotkey_user_mask */
2200 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2201
2202 return rc;
2203 }
2204
2205 /*
2206 * Sets the driver hotkey mask.
2207 *
2208 * Can be called even if the hotkey subdriver is inactive
2209 */
2210 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2211 {
2212 int rc;
2213
2214 /* Do the right thing if hotkey_init has not been called yet */
2215 if (!tp_features.hotkey) {
2216 hotkey_driver_mask = mask;
2217 return 0;
2218 }
2219
2220 mutex_lock(&hotkey_mutex);
2221
2222 HOTKEY_CONFIG_CRITICAL_START
2223 hotkey_driver_mask = mask;
2224 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2225 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2226 #endif
2227 HOTKEY_CONFIG_CRITICAL_END
2228
2229 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2230 ~hotkey_source_mask);
2231 hotkey_poll_setup(true);
2232
2233 mutex_unlock(&hotkey_mutex);
2234
2235 return rc;
2236 }
2237
2238 static int hotkey_status_get(int *status)
2239 {
2240 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2241 return -EIO;
2242
2243 return 0;
2244 }
2245
2246 static int hotkey_status_set(bool enable)
2247 {
2248 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2249 return -EIO;
2250
2251 return 0;
2252 }
2253
2254 static void tpacpi_input_send_tabletsw(void)
2255 {
2256 int state;
2257
2258 if (tp_features.hotkey_tablet &&
2259 !hotkey_get_tablet_mode(&state)) {
2260 mutex_lock(&tpacpi_inputdev_send_mutex);
2261
2262 input_report_switch(tpacpi_inputdev,
2263 SW_TABLET_MODE, !!state);
2264 input_sync(tpacpi_inputdev);
2265
2266 mutex_unlock(&tpacpi_inputdev_send_mutex);
2267 }
2268 }
2269
2270 /* Do NOT call without validating scancode first */
2271 static void tpacpi_input_send_key(const unsigned int scancode)
2272 {
2273 const unsigned int keycode = hotkey_keycode_map[scancode];
2274
2275 if (keycode != KEY_RESERVED) {
2276 mutex_lock(&tpacpi_inputdev_send_mutex);
2277
2278 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2279 input_report_key(tpacpi_inputdev, keycode, 1);
2280 input_sync(tpacpi_inputdev);
2281
2282 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2283 input_report_key(tpacpi_inputdev, keycode, 0);
2284 input_sync(tpacpi_inputdev);
2285
2286 mutex_unlock(&tpacpi_inputdev_send_mutex);
2287 }
2288 }
2289
2290 /* Do NOT call without validating scancode first */
2291 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2292 {
2293 hotkey_driver_event(scancode);
2294 if (hotkey_user_mask & (1 << scancode))
2295 tpacpi_input_send_key(scancode);
2296 }
2297
2298 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2299 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2300
2301 /* Do NOT call without validating scancode first */
2302 static void tpacpi_hotkey_send_key(unsigned int scancode)
2303 {
2304 tpacpi_input_send_key_masked(scancode);
2305 if (hotkey_report_mode < 2) {
2306 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2307 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2308 }
2309 }
2310
2311 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2312 {
2313 u8 d;
2314
2315 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2316 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2317 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2318 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2319 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2320 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2321 }
2322 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2323 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2324 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2325 }
2326 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2327 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2328 n->displayexp_toggle =
2329 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2330 }
2331 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2332 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2333 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2334 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2335 n->brightness_toggle =
2336 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2337 }
2338 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2339 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2340 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2341 >> TP_NVRAM_POS_LEVEL_VOLUME;
2342 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2343 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2344 }
2345 }
2346
2347 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2348 struct tp_nvram_state *newn,
2349 const u32 event_mask)
2350 {
2351
2352 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2353 do { \
2354 if ((event_mask & (1 << __scancode)) && \
2355 oldn->__member != newn->__member) \
2356 tpacpi_hotkey_send_key(__scancode); \
2357 } while (0)
2358
2359 #define TPACPI_MAY_SEND_KEY(__scancode) \
2360 do { \
2361 if (event_mask & (1 << __scancode)) \
2362 tpacpi_hotkey_send_key(__scancode); \
2363 } while (0)
2364
2365 void issue_volchange(const unsigned int oldvol,
2366 const unsigned int newvol)
2367 {
2368 unsigned int i = oldvol;
2369
2370 while (i > newvol) {
2371 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2372 i--;
2373 }
2374 while (i < newvol) {
2375 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2376 i++;
2377 }
2378 }
2379
2380 void issue_brightnesschange(const unsigned int oldbrt,
2381 const unsigned int newbrt)
2382 {
2383 unsigned int i = oldbrt;
2384
2385 while (i > newbrt) {
2386 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2387 i--;
2388 }
2389 while (i < newbrt) {
2390 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2391 i++;
2392 }
2393 }
2394
2395 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2396 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2397 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2398 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2399
2400 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2401
2402 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2403
2404 /*
2405 * Handle volume
2406 *
2407 * This code is supposed to duplicate the IBM firmware behaviour:
2408 * - Pressing MUTE issues mute hotkey message, even when already mute
2409 * - Pressing Volume up/down issues volume up/down hotkey messages,
2410 * even when already at maximum or minimum volume
2411 * - The act of unmuting issues volume up/down notification,
2412 * depending which key was used to unmute
2413 *
2414 * We are constrained to what the NVRAM can tell us, which is not much
2415 * and certainly not enough if more than one volume hotkey was pressed
2416 * since the last poll cycle.
2417 *
2418 * Just to make our life interesting, some newer Lenovo ThinkPads have
2419 * bugs in the BIOS and may fail to update volume_toggle properly.
2420 */
2421 if (newn->mute) {
2422 /* muted */
2423 if (!oldn->mute ||
2424 oldn->volume_toggle != newn->volume_toggle ||
2425 oldn->volume_level != newn->volume_level) {
2426 /* recently muted, or repeated mute keypress, or
2427 * multiple presses ending in mute */
2428 issue_volchange(oldn->volume_level, newn->volume_level);
2429 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2430 }
2431 } else {
2432 /* unmute */
2433 if (oldn->mute) {
2434 /* recently unmuted, issue 'unmute' keypress */
2435 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2436 }
2437 if (oldn->volume_level != newn->volume_level) {
2438 issue_volchange(oldn->volume_level, newn->volume_level);
2439 } else if (oldn->volume_toggle != newn->volume_toggle) {
2440 /* repeated vol up/down keypress at end of scale ? */
2441 if (newn->volume_level == 0)
2442 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2443 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2444 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2445 }
2446 }
2447
2448 /* handle brightness */
2449 if (oldn->brightness_level != newn->brightness_level) {
2450 issue_brightnesschange(oldn->brightness_level,
2451 newn->brightness_level);
2452 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2453 /* repeated key presses that didn't change state */
2454 if (newn->brightness_level == 0)
2455 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2456 else if (newn->brightness_level >= bright_maxlvl
2457 && !tp_features.bright_unkfw)
2458 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2459 }
2460
2461 #undef TPACPI_COMPARE_KEY
2462 #undef TPACPI_MAY_SEND_KEY
2463 }
2464
2465 /*
2466 * Polling driver
2467 *
2468 * We track all events in hotkey_source_mask all the time, since
2469 * most of them are edge-based. We only issue those requested by
2470 * hotkey_user_mask or hotkey_driver_mask, though.
2471 */
2472 static int hotkey_kthread(void *data)
2473 {
2474 struct tp_nvram_state s[2];
2475 u32 poll_mask, event_mask;
2476 unsigned int si, so;
2477 unsigned long t;
2478 unsigned int change_detector, must_reset;
2479 unsigned int poll_freq;
2480
2481 mutex_lock(&hotkey_thread_mutex);
2482
2483 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2484 goto exit;
2485
2486 set_freezable();
2487
2488 so = 0;
2489 si = 1;
2490 t = 0;
2491
2492 /* Initial state for compares */
2493 mutex_lock(&hotkey_thread_data_mutex);
2494 change_detector = hotkey_config_change;
2495 poll_mask = hotkey_source_mask;
2496 event_mask = hotkey_source_mask &
2497 (hotkey_driver_mask | hotkey_user_mask);
2498 poll_freq = hotkey_poll_freq;
2499 mutex_unlock(&hotkey_thread_data_mutex);
2500 hotkey_read_nvram(&s[so], poll_mask);
2501
2502 while (!kthread_should_stop()) {
2503 if (t == 0) {
2504 if (likely(poll_freq))
2505 t = 1000/poll_freq;
2506 else
2507 t = 100; /* should never happen... */
2508 }
2509 t = msleep_interruptible(t);
2510 if (unlikely(kthread_should_stop()))
2511 break;
2512 must_reset = try_to_freeze();
2513 if (t > 0 && !must_reset)
2514 continue;
2515
2516 mutex_lock(&hotkey_thread_data_mutex);
2517 if (must_reset || hotkey_config_change != change_detector) {
2518 /* forget old state on thaw or config change */
2519 si = so;
2520 t = 0;
2521 change_detector = hotkey_config_change;
2522 }
2523 poll_mask = hotkey_source_mask;
2524 event_mask = hotkey_source_mask &
2525 (hotkey_driver_mask | hotkey_user_mask);
2526 poll_freq = hotkey_poll_freq;
2527 mutex_unlock(&hotkey_thread_data_mutex);
2528
2529 if (likely(poll_mask)) {
2530 hotkey_read_nvram(&s[si], poll_mask);
2531 if (likely(si != so)) {
2532 hotkey_compare_and_issue_event(&s[so], &s[si],
2533 event_mask);
2534 }
2535 }
2536
2537 so = si;
2538 si ^= 1;
2539 }
2540
2541 exit:
2542 mutex_unlock(&hotkey_thread_mutex);
2543 return 0;
2544 }
2545
2546 /* call with hotkey_mutex held */
2547 static void hotkey_poll_stop_sync(void)
2548 {
2549 if (tpacpi_hotkey_task) {
2550 if (frozen(tpacpi_hotkey_task) ||
2551 freezing(tpacpi_hotkey_task))
2552 thaw_process(tpacpi_hotkey_task);
2553
2554 kthread_stop(tpacpi_hotkey_task);
2555 tpacpi_hotkey_task = NULL;
2556 mutex_lock(&hotkey_thread_mutex);
2557 /* at this point, the thread did exit */
2558 mutex_unlock(&hotkey_thread_mutex);
2559 }
2560 }
2561
2562 /* call with hotkey_mutex held */
2563 static void hotkey_poll_setup(const bool may_warn)
2564 {
2565 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2566 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2567
2568 if (hotkey_poll_freq > 0 &&
2569 (poll_driver_mask ||
2570 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2571 if (!tpacpi_hotkey_task) {
2572 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2573 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2574 if (IS_ERR(tpacpi_hotkey_task)) {
2575 tpacpi_hotkey_task = NULL;
2576 printk(TPACPI_ERR
2577 "could not create kernel thread "
2578 "for hotkey polling\n");
2579 }
2580 }
2581 } else {
2582 hotkey_poll_stop_sync();
2583 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2584 hotkey_poll_freq == 0) {
2585 printk(TPACPI_NOTICE
2586 "hot keys 0x%08x and/or events 0x%08x "
2587 "require polling, which is currently "
2588 "disabled\n",
2589 poll_user_mask, poll_driver_mask);
2590 }
2591 }
2592 }
2593
2594 static void hotkey_poll_setup_safe(const bool may_warn)
2595 {
2596 mutex_lock(&hotkey_mutex);
2597 hotkey_poll_setup(may_warn);
2598 mutex_unlock(&hotkey_mutex);
2599 }
2600
2601 /* call with hotkey_mutex held */
2602 static void hotkey_poll_set_freq(unsigned int freq)
2603 {
2604 if (!freq)
2605 hotkey_poll_stop_sync();
2606
2607 hotkey_poll_freq = freq;
2608 }
2609
2610 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2611
2612 static void hotkey_poll_setup(const bool __unused)
2613 {
2614 }
2615
2616 static void hotkey_poll_setup_safe(const bool __unused)
2617 {
2618 }
2619
2620 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2621
2622 static int hotkey_inputdev_open(struct input_dev *dev)
2623 {
2624 switch (tpacpi_lifecycle) {
2625 case TPACPI_LIFE_INIT:
2626 case TPACPI_LIFE_RUNNING:
2627 hotkey_poll_setup_safe(false);
2628 return 0;
2629 case TPACPI_LIFE_EXITING:
2630 return -EBUSY;
2631 }
2632
2633 /* Should only happen if tpacpi_lifecycle is corrupt */
2634 BUG();
2635 return -EBUSY;
2636 }
2637
2638 static void hotkey_inputdev_close(struct input_dev *dev)
2639 {
2640 /* disable hotkey polling when possible */
2641 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2642 !(hotkey_source_mask & hotkey_driver_mask))
2643 hotkey_poll_setup_safe(false);
2644 }
2645
2646 /* sysfs hotkey enable ------------------------------------------------- */
2647 static ssize_t hotkey_enable_show(struct device *dev,
2648 struct device_attribute *attr,
2649 char *buf)
2650 {
2651 int res, status;
2652
2653 printk_deprecated_attribute("hotkey_enable",
2654 "Hotkey reporting is always enabled");
2655
2656 res = hotkey_status_get(&status);
2657 if (res)
2658 return res;
2659
2660 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2661 }
2662
2663 static ssize_t hotkey_enable_store(struct device *dev,
2664 struct device_attribute *attr,
2665 const char *buf, size_t count)
2666 {
2667 unsigned long t;
2668
2669 printk_deprecated_attribute("hotkey_enable",
2670 "Hotkeys can be disabled through hotkey_mask");
2671
2672 if (parse_strtoul(buf, 1, &t))
2673 return -EINVAL;
2674
2675 if (t == 0)
2676 return -EPERM;
2677
2678 return count;
2679 }
2680
2681 static struct device_attribute dev_attr_hotkey_enable =
2682 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2683 hotkey_enable_show, hotkey_enable_store);
2684
2685 /* sysfs hotkey mask --------------------------------------------------- */
2686 static ssize_t hotkey_mask_show(struct device *dev,
2687 struct device_attribute *attr,
2688 char *buf)
2689 {
2690 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2691 }
2692
2693 static ssize_t hotkey_mask_store(struct device *dev,
2694 struct device_attribute *attr,
2695 const char *buf, size_t count)
2696 {
2697 unsigned long t;
2698 int res;
2699
2700 if (parse_strtoul(buf, 0xffffffffUL, &t))
2701 return -EINVAL;
2702
2703 if (mutex_lock_killable(&hotkey_mutex))
2704 return -ERESTARTSYS;
2705
2706 res = hotkey_user_mask_set(t);
2707
2708 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2709 hotkey_poll_setup(true);
2710 #endif
2711
2712 mutex_unlock(&hotkey_mutex);
2713
2714 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2715
2716 return (res) ? res : count;
2717 }
2718
2719 static struct device_attribute dev_attr_hotkey_mask =
2720 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2721 hotkey_mask_show, hotkey_mask_store);
2722
2723 /* sysfs hotkey bios_enabled ------------------------------------------- */
2724 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2725 struct device_attribute *attr,
2726 char *buf)
2727 {
2728 return sprintf(buf, "0\n");
2729 }
2730
2731 static struct device_attribute dev_attr_hotkey_bios_enabled =
2732 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2733
2734 /* sysfs hotkey bios_mask ---------------------------------------------- */
2735 static ssize_t hotkey_bios_mask_show(struct device *dev,
2736 struct device_attribute *attr,
2737 char *buf)
2738 {
2739 printk_deprecated_attribute("hotkey_bios_mask",
2740 "This attribute is useless.");
2741 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2742 }
2743
2744 static struct device_attribute dev_attr_hotkey_bios_mask =
2745 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2746
2747 /* sysfs hotkey all_mask ----------------------------------------------- */
2748 static ssize_t hotkey_all_mask_show(struct device *dev,
2749 struct device_attribute *attr,
2750 char *buf)
2751 {
2752 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2753 hotkey_all_mask | hotkey_source_mask);
2754 }
2755
2756 static struct device_attribute dev_attr_hotkey_all_mask =
2757 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2758
2759 /* sysfs hotkey recommended_mask --------------------------------------- */
2760 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2761 struct device_attribute *attr,
2762 char *buf)
2763 {
2764 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2765 (hotkey_all_mask | hotkey_source_mask)
2766 & ~hotkey_reserved_mask);
2767 }
2768
2769 static struct device_attribute dev_attr_hotkey_recommended_mask =
2770 __ATTR(hotkey_recommended_mask, S_IRUGO,
2771 hotkey_recommended_mask_show, NULL);
2772
2773 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2774
2775 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2776 static ssize_t hotkey_source_mask_show(struct device *dev,
2777 struct device_attribute *attr,
2778 char *buf)
2779 {
2780 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2781 }
2782
2783 static ssize_t hotkey_source_mask_store(struct device *dev,
2784 struct device_attribute *attr,
2785 const char *buf, size_t count)
2786 {
2787 unsigned long t;
2788 u32 r_ev;
2789 int rc;
2790
2791 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2792 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2793 return -EINVAL;
2794
2795 if (mutex_lock_killable(&hotkey_mutex))
2796 return -ERESTARTSYS;
2797
2798 HOTKEY_CONFIG_CRITICAL_START
2799 hotkey_source_mask = t;
2800 HOTKEY_CONFIG_CRITICAL_END
2801
2802 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2803 ~hotkey_source_mask);
2804 hotkey_poll_setup(true);
2805
2806 /* check if events needed by the driver got disabled */
2807 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2808 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2809
2810 mutex_unlock(&hotkey_mutex);
2811
2812 if (rc < 0)
2813 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2814 "firmware event mask!\n");
2815
2816 if (r_ev)
2817 printk(TPACPI_NOTICE "hotkey_source_mask: "
2818 "some important events were disabled: "
2819 "0x%04x\n", r_ev);
2820
2821 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2822
2823 return (rc < 0) ? rc : count;
2824 }
2825
2826 static struct device_attribute dev_attr_hotkey_source_mask =
2827 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2828 hotkey_source_mask_show, hotkey_source_mask_store);
2829
2830 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2831 static ssize_t hotkey_poll_freq_show(struct device *dev,
2832 struct device_attribute *attr,
2833 char *buf)
2834 {
2835 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2836 }
2837
2838 static ssize_t hotkey_poll_freq_store(struct device *dev,
2839 struct device_attribute *attr,
2840 const char *buf, size_t count)
2841 {
2842 unsigned long t;
2843
2844 if (parse_strtoul(buf, 25, &t))
2845 return -EINVAL;
2846
2847 if (mutex_lock_killable(&hotkey_mutex))
2848 return -ERESTARTSYS;
2849
2850 hotkey_poll_set_freq(t);
2851 hotkey_poll_setup(true);
2852
2853 mutex_unlock(&hotkey_mutex);
2854
2855 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2856
2857 return count;
2858 }
2859
2860 static struct device_attribute dev_attr_hotkey_poll_freq =
2861 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2862 hotkey_poll_freq_show, hotkey_poll_freq_store);
2863
2864 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2865
2866 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2867 static ssize_t hotkey_radio_sw_show(struct device *dev,
2868 struct device_attribute *attr,
2869 char *buf)
2870 {
2871 int res;
2872 res = hotkey_get_wlsw();
2873 if (res < 0)
2874 return res;
2875
2876 /* Opportunistic update */
2877 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2878
2879 return snprintf(buf, PAGE_SIZE, "%d\n",
2880 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2881 }
2882
2883 static struct device_attribute dev_attr_hotkey_radio_sw =
2884 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2885
2886 static void hotkey_radio_sw_notify_change(void)
2887 {
2888 if (tp_features.hotkey_wlsw)
2889 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2890 "hotkey_radio_sw");
2891 }
2892
2893 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2894 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2895 struct device_attribute *attr,
2896 char *buf)
2897 {
2898 int res, s;
2899 res = hotkey_get_tablet_mode(&s);
2900 if (res < 0)
2901 return res;
2902
2903 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2904 }
2905
2906 static struct device_attribute dev_attr_hotkey_tablet_mode =
2907 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2908
2909 static void hotkey_tablet_mode_notify_change(void)
2910 {
2911 if (tp_features.hotkey_tablet)
2912 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2913 "hotkey_tablet_mode");
2914 }
2915
2916 /* sysfs hotkey report_mode -------------------------------------------- */
2917 static ssize_t hotkey_report_mode_show(struct device *dev,
2918 struct device_attribute *attr,
2919 char *buf)
2920 {
2921 return snprintf(buf, PAGE_SIZE, "%d\n",
2922 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2923 }
2924
2925 static struct device_attribute dev_attr_hotkey_report_mode =
2926 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2927
2928 /* sysfs wakeup reason (pollable) -------------------------------------- */
2929 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2930 struct device_attribute *attr,
2931 char *buf)
2932 {
2933 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2934 }
2935
2936 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2937 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2938
2939 static void hotkey_wakeup_reason_notify_change(void)
2940 {
2941 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2942 "wakeup_reason");
2943 }
2944
2945 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2946 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2947 struct device_attribute *attr,
2948 char *buf)
2949 {
2950 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2951 }
2952
2953 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2954 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2955 hotkey_wakeup_hotunplug_complete_show, NULL);
2956
2957 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2958 {
2959 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2960 "wakeup_hotunplug_complete");
2961 }
2962
2963 /* --------------------------------------------------------------------- */
2964
2965 static struct attribute *hotkey_attributes[] __initdata = {
2966 &dev_attr_hotkey_enable.attr,
2967 &dev_attr_hotkey_bios_enabled.attr,
2968 &dev_attr_hotkey_bios_mask.attr,
2969 &dev_attr_hotkey_report_mode.attr,
2970 &dev_attr_hotkey_wakeup_reason.attr,
2971 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2972 &dev_attr_hotkey_mask.attr,
2973 &dev_attr_hotkey_all_mask.attr,
2974 &dev_attr_hotkey_recommended_mask.attr,
2975 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2976 &dev_attr_hotkey_source_mask.attr,
2977 &dev_attr_hotkey_poll_freq.attr,
2978 #endif
2979 };
2980
2981 /*
2982 * Sync both the hw and sw blocking state of all switches
2983 */
2984 static void tpacpi_send_radiosw_update(void)
2985 {
2986 int wlsw;
2987
2988 /*
2989 * We must sync all rfkill controllers *before* issuing any
2990 * rfkill input events, or we will race the rfkill core input
2991 * handler.
2992 *
2993 * tpacpi_inputdev_send_mutex works as a synchronization point
2994 * for the above.
2995 *
2996 * We optimize to avoid numerous calls to hotkey_get_wlsw.
2997 */
2998
2999 wlsw = hotkey_get_wlsw();
3000
3001 /* Sync hw blocking state first if it is hw-blocked */
3002 if (wlsw == TPACPI_RFK_RADIO_OFF)
3003 tpacpi_rfk_update_hwblock_state(true);
3004
3005 /* Sync sw blocking state */
3006 tpacpi_rfk_update_swstate_all();
3007
3008 /* Sync hw blocking state last if it is hw-unblocked */
3009 if (wlsw == TPACPI_RFK_RADIO_ON)
3010 tpacpi_rfk_update_hwblock_state(false);
3011
3012 /* Issue rfkill input event for WLSW switch */
3013 if (!(wlsw < 0)) {
3014 mutex_lock(&tpacpi_inputdev_send_mutex);
3015
3016 input_report_switch(tpacpi_inputdev,
3017 SW_RFKILL_ALL, (wlsw > 0));
3018 input_sync(tpacpi_inputdev);
3019
3020 mutex_unlock(&tpacpi_inputdev_send_mutex);
3021 }
3022
3023 /*
3024 * this can be unconditional, as we will poll state again
3025 * if userspace uses the notify to read data
3026 */
3027 hotkey_radio_sw_notify_change();
3028 }
3029
3030 static void hotkey_exit(void)
3031 {
3032 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3033 mutex_lock(&hotkey_mutex);
3034 hotkey_poll_stop_sync();
3035 mutex_unlock(&hotkey_mutex);
3036 #endif
3037
3038 if (hotkey_dev_attributes)
3039 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3040
3041 kfree(hotkey_keycode_map);
3042
3043 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3044 "restoring original HKEY status and mask\n");
3045 /* yes, there is a bitwise or below, we want the
3046 * functions to be called even if one of them fail */
3047 if (((tp_features.hotkey_mask &&
3048 hotkey_mask_set(hotkey_orig_mask)) |
3049 hotkey_status_set(false)) != 0)
3050 printk(TPACPI_ERR
3051 "failed to restore hot key mask "
3052 "to BIOS defaults\n");
3053 }
3054
3055 static void __init hotkey_unmap(const unsigned int scancode)
3056 {
3057 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3058 clear_bit(hotkey_keycode_map[scancode],
3059 tpacpi_inputdev->keybit);
3060 hotkey_keycode_map[scancode] = KEY_RESERVED;
3061 }
3062 }
3063
3064 /*
3065 * HKEY quirks:
3066 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3067 */
3068
3069 #define TPACPI_HK_Q_INIMASK 0x0001
3070
3071 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3072 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3073 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3074 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3075 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3076 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3077 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3078 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3079 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3080 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3081 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3082 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3083 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3084 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3085 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3086 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3087 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3088 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3089 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3090 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3091 };
3092
3093 typedef u16 tpacpi_keymap_entry_t;
3094 typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3095
3096 static int __init hotkey_init(struct ibm_init_struct *iibm)
3097 {
3098 /* Requirements for changing the default keymaps:
3099 *
3100 * 1. Many of the keys are mapped to KEY_RESERVED for very
3101 * good reasons. Do not change them unless you have deep
3102 * knowledge on the IBM and Lenovo ThinkPad firmware for
3103 * the various ThinkPad models. The driver behaves
3104 * differently for KEY_RESERVED: such keys have their
3105 * hot key mask *unset* in mask_recommended, and also
3106 * in the initial hot key mask programmed into the
3107 * firmware at driver load time, which means the firm-
3108 * ware may react very differently if you change them to
3109 * something else;
3110 *
3111 * 2. You must be subscribed to the linux-thinkpad and
3112 * ibm-acpi-devel mailing lists, and you should read the
3113 * list archives since 2007 if you want to change the
3114 * keymaps. This requirement exists so that you will
3115 * know the past history of problems with the thinkpad-
3116 * acpi driver keymaps, and also that you will be
3117 * listening to any bug reports;
3118 *
3119 * 3. Do not send thinkpad-acpi specific patches directly to
3120 * for merging, *ever*. Send them to the linux-acpi
3121 * mailinglist for comments. Merging is to be done only
3122 * through acpi-test and the ACPI maintainer.
3123 *
3124 * If the above is too much to ask, don't change the keymap.
3125 * Ask the thinkpad-acpi maintainer to do it, instead.
3126 */
3127
3128 enum keymap_index {
3129 TPACPI_KEYMAP_IBM_GENERIC = 0,
3130 TPACPI_KEYMAP_LENOVO_GENERIC,
3131 };
3132
3133 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3134 /* Generic keymap for IBM ThinkPads */
3135 [TPACPI_KEYMAP_IBM_GENERIC] = {
3136 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3137 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3138 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3139 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3140
3141 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3142 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3143 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3144 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3145
3146 /* brightness: firmware always reacts to them */
3147 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3148 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3149
3150 /* Thinklight: firmware always react to it */
3151 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3152
3153 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3154 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3155
3156 /* Volume: firmware always react to it and reprograms
3157 * the built-in *extra* mixer. Never map it to control
3158 * another mixer by default. */
3159 KEY_RESERVED, /* 0x14: VOLUME UP */
3160 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3161 KEY_RESERVED, /* 0x16: MUTE */
3162
3163 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3164
3165 /* (assignments unknown, please report if found) */
3166 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3167 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3168 },
3169
3170 /* Generic keymap for Lenovo ThinkPads */
3171 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3172 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3173 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3174 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3175 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3176
3177 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3178 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3179 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3180 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3181
3182 /* These should be enabled --only-- when ACPI video
3183 * is disabled (i.e. in "vendor" mode), and are handled
3184 * in a special way by the init code */
3185 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3186 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3187
3188 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3189
3190 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3191 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3192
3193 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3194 * react to it and reprograms the built-in *extra* mixer.
3195 * Never map it to control another mixer by default.
3196 *
3197 * T60?, T61, R60?, R61: firmware and EC tries to send
3198 * these over the regular keyboard, so these are no-ops,
3199 * but there are still weird bugs re. MUTE, so do not
3200 * change unless you get test reports from all Lenovo
3201 * models. May cause the BIOS to interfere with the
3202 * HDA mixer.
3203 */
3204 KEY_RESERVED, /* 0x14: VOLUME UP */
3205 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3206 KEY_RESERVED, /* 0x16: MUTE */
3207
3208 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3209
3210 /* (assignments unknown, please report if found) */
3211 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3212 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3213 },
3214 };
3215
3216 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3217 /* Generic maps (fallback) */
3218 {
3219 .vendor = PCI_VENDOR_ID_IBM,
3220 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3221 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3222 },
3223 {
3224 .vendor = PCI_VENDOR_ID_LENOVO,
3225 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3226 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3227 },
3228 };
3229
3230 #define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3231 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3232
3233 int res, i;
3234 int status;
3235 int hkeyv;
3236 bool radiosw_state = false;
3237 bool tabletsw_state = false;
3238
3239 unsigned long quirks;
3240 unsigned long keymap_id;
3241
3242 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3243 "initializing hotkey subdriver\n");
3244
3245 BUG_ON(!tpacpi_inputdev);
3246 BUG_ON(tpacpi_inputdev->open != NULL ||
3247 tpacpi_inputdev->close != NULL);
3248
3249 TPACPI_ACPIHANDLE_INIT(hkey);
3250 mutex_init(&hotkey_mutex);
3251
3252 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3253 mutex_init(&hotkey_thread_mutex);
3254 mutex_init(&hotkey_thread_data_mutex);
3255 #endif
3256
3257 /* hotkey not supported on 570 */
3258 tp_features.hotkey = hkey_handle != NULL;
3259
3260 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3261 "hotkeys are %s\n",
3262 str_supported(tp_features.hotkey));
3263
3264 if (!tp_features.hotkey)
3265 return 1;
3266
3267 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3268 ARRAY_SIZE(tpacpi_hotkey_qtable));
3269
3270 tpacpi_disable_brightness_delay();
3271
3272 /* MUST have enough space for all attributes to be added to
3273 * hotkey_dev_attributes */
3274 hotkey_dev_attributes = create_attr_set(
3275 ARRAY_SIZE(hotkey_attributes) + 2,
3276 NULL);
3277 if (!hotkey_dev_attributes)
3278 return -ENOMEM;
3279 res = add_many_to_attr_set(hotkey_dev_attributes,
3280 hotkey_attributes,
3281 ARRAY_SIZE(hotkey_attributes));
3282 if (res)
3283 goto err_exit;
3284
3285 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3286 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3287 for HKEY interface version 0x100 */
3288 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3289 if ((hkeyv >> 8) != 1) {
3290 printk(TPACPI_ERR "unknown version of the "
3291 "HKEY interface: 0x%x\n", hkeyv);
3292 printk(TPACPI_ERR "please report this to %s\n",
3293 TPACPI_MAIL);
3294 } else {
3295 /*
3296 * MHKV 0x100 in A31, R40, R40e,
3297 * T4x, X31, and later
3298 */
3299 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3300 "firmware HKEY interface version: 0x%x\n",
3301 hkeyv);
3302
3303 /* Paranoia check AND init hotkey_all_mask */
3304 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3305 "MHKA", "qd")) {
3306 printk(TPACPI_ERR
3307 "missing MHKA handler, "
3308 "please report this to %s\n",
3309 TPACPI_MAIL);
3310 /* Fallback: pre-init for FN+F3,F4,F12 */
3311 hotkey_all_mask = 0x080cU;
3312 } else {
3313 tp_features.hotkey_mask = 1;
3314 }
3315 }
3316 }
3317
3318 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3319 "hotkey masks are %s\n",
3320 str_supported(tp_features.hotkey_mask));
3321
3322 /* Init hotkey_all_mask if not initialized yet */
3323 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3324 (quirks & TPACPI_HK_Q_INIMASK))
3325 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3326
3327 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3328 if (tp_features.hotkey_mask) {
3329 /* hotkey_source_mask *must* be zero for
3330 * the first hotkey_mask_get to return hotkey_orig_mask */
3331 res = hotkey_mask_get();
3332 if (res)
3333 goto err_exit;
3334
3335 hotkey_orig_mask = hotkey_acpi_mask;
3336 } else {
3337 hotkey_orig_mask = hotkey_all_mask;
3338 hotkey_acpi_mask = hotkey_all_mask;
3339 }
3340
3341 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3342 if (dbg_wlswemul) {
3343 tp_features.hotkey_wlsw = 1;
3344 radiosw_state = !!tpacpi_wlsw_emulstate;
3345 printk(TPACPI_INFO
3346 "radio switch emulation enabled\n");
3347 } else
3348 #endif
3349 /* Not all thinkpads have a hardware radio switch */
3350 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3351 tp_features.hotkey_wlsw = 1;
3352 radiosw_state = !!status;
3353 printk(TPACPI_INFO
3354 "radio switch found; radios are %s\n",
3355 enabled(status, 0));
3356 }
3357 if (tp_features.hotkey_wlsw)
3358 res = add_to_attr_set(hotkey_dev_attributes,
3359 &dev_attr_hotkey_radio_sw.attr);
3360
3361 /* For X41t, X60t, X61t Tablets... */
3362 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3363 tp_features.hotkey_tablet = 1;
3364 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3365 printk(TPACPI_INFO
3366 "possible tablet mode switch found; "
3367 "ThinkPad in %s mode\n",
3368 (tabletsw_state) ? "tablet" : "laptop");
3369 res = add_to_attr_set(hotkey_dev_attributes,
3370 &dev_attr_hotkey_tablet_mode.attr);
3371 }
3372
3373 if (!res)
3374 res = register_attr_set_with_sysfs(
3375 hotkey_dev_attributes,
3376 &tpacpi_pdev->dev.kobj);
3377 if (res)
3378 goto err_exit;
3379
3380 /* Set up key map */
3381 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3382 GFP_KERNEL);
3383 if (!hotkey_keycode_map) {
3384 printk(TPACPI_ERR
3385 "failed to allocate memory for key map\n");
3386 res = -ENOMEM;
3387 goto err_exit;
3388 }
3389
3390 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3391 ARRAY_SIZE(tpacpi_keymap_qtable));
3392 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3393 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3394 "using keymap number %lu\n", keymap_id);
3395
3396 memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3397 TPACPI_HOTKEY_MAP_SIZE);
3398
3399 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3400 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3401 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3402 tpacpi_inputdev->keycode = hotkey_keycode_map;
3403 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3404 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3405 input_set_capability(tpacpi_inputdev, EV_KEY,
3406 hotkey_keycode_map[i]);
3407 } else {
3408 if (i < sizeof(hotkey_reserved_mask)*8)
3409 hotkey_reserved_mask |= 1 << i;
3410 }
3411 }
3412
3413 if (tp_features.hotkey_wlsw) {
3414 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3415 input_report_switch(tpacpi_inputdev,
3416 SW_RFKILL_ALL, radiosw_state);
3417 }
3418 if (tp_features.hotkey_tablet) {
3419 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3420 input_report_switch(tpacpi_inputdev,
3421 SW_TABLET_MODE, tabletsw_state);
3422 }
3423
3424 /* Do not issue duplicate brightness change events to
3425 * userspace. tpacpi_detect_brightness_capabilities() must have
3426 * been called before this point */
3427 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3428 printk(TPACPI_INFO
3429 "This ThinkPad has standard ACPI backlight "
3430 "brightness control, supported by the ACPI "
3431 "video driver\n");
3432 printk(TPACPI_NOTICE
3433 "Disabling thinkpad-acpi brightness events "
3434 "by default...\n");
3435
3436 /* Disable brightness up/down on Lenovo thinkpads when
3437 * ACPI is handling them, otherwise it is plain impossible
3438 * for userspace to do something even remotely sane */
3439 hotkey_reserved_mask |=
3440 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3441 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3442 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3443 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3444 }
3445
3446 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3447 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3448 & ~hotkey_all_mask
3449 & ~hotkey_reserved_mask;
3450
3451 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3452 "hotkey source mask 0x%08x, polling freq %u\n",
3453 hotkey_source_mask, hotkey_poll_freq);
3454 #endif
3455
3456 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3457 "enabling firmware HKEY event interface...\n");
3458 res = hotkey_status_set(true);
3459 if (res) {
3460 hotkey_exit();
3461 return res;
3462 }
3463 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3464 | hotkey_driver_mask)
3465 & ~hotkey_source_mask);
3466 if (res < 0 && res != -ENXIO) {
3467 hotkey_exit();
3468 return res;
3469 }
3470 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3471 & ~hotkey_reserved_mask;
3472 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3473 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3474 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3475
3476 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3477 "legacy ibm/hotkey event reporting over procfs %s\n",
3478 (hotkey_report_mode < 2) ?
3479 "enabled" : "disabled");
3480
3481 tpacpi_inputdev->open = &hotkey_inputdev_open;
3482 tpacpi_inputdev->close = &hotkey_inputdev_close;
3483
3484 hotkey_poll_setup_safe(true);
3485
3486 return 0;
3487
3488 err_exit:
3489 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3490 hotkey_dev_attributes = NULL;
3491
3492 return (res < 0)? res : 1;
3493 }
3494
3495 static bool hotkey_notify_hotkey(const u32 hkey,
3496 bool *send_acpi_ev,
3497 bool *ignore_acpi_ev)
3498 {
3499 /* 0x1000-0x1FFF: key presses */
3500 unsigned int scancode = hkey & 0xfff;
3501 *send_acpi_ev = true;
3502 *ignore_acpi_ev = false;
3503
3504 /* HKEY event 0x1001 is scancode 0x00 */
3505 if (scancode > 0 && scancode <= TPACPI_HOTKEY_MAP_LEN) {
3506 scancode--;
3507 if (!(hotkey_source_mask & (1 << scancode))) {
3508 tpacpi_input_send_key_masked(scancode);
3509 *send_acpi_ev = false;
3510 } else {
3511 *ignore_acpi_ev = true;
3512 }
3513 return true;
3514 }
3515 return false;
3516 }
3517
3518 static bool hotkey_notify_wakeup(const u32 hkey,
3519 bool *send_acpi_ev,
3520 bool *ignore_acpi_ev)
3521 {
3522 /* 0x2000-0x2FFF: Wakeup reason */
3523 *send_acpi_ev = true;
3524 *ignore_acpi_ev = false;
3525
3526 switch (hkey) {
3527 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3528 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3529 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3530 *ignore_acpi_ev = true;
3531 break;
3532
3533 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3534 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3535 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3536 *ignore_acpi_ev = true;
3537 break;
3538
3539 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3540 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3541 printk(TPACPI_ALERT
3542 "EMERGENCY WAKEUP: battery almost empty\n");
3543 /* how to auto-heal: */
3544 /* 2313: woke up from S3, go to S4/S5 */
3545 /* 2413: woke up from S4, go to S5 */
3546 break;
3547
3548 default:
3549 return false;
3550 }
3551
3552 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3553 printk(TPACPI_INFO
3554 "woke up due to a hot-unplug "
3555 "request...\n");
3556 hotkey_wakeup_reason_notify_change();
3557 }
3558 return true;
3559 }
3560
3561 static bool hotkey_notify_usrevent(const u32 hkey,
3562 bool *send_acpi_ev,
3563 bool *ignore_acpi_ev)
3564 {
3565 /* 0x5000-0x5FFF: human interface helpers */
3566 *send_acpi_ev = true;
3567 *ignore_acpi_ev = false;
3568
3569 switch (hkey) {
3570 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3571 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3572 return true;
3573
3574 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3575 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3576 tpacpi_input_send_tabletsw();
3577 hotkey_tablet_mode_notify_change();
3578 *send_acpi_ev = false;
3579 return true;
3580
3581 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3582 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3583 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3584 /* do not propagate these events */
3585 *ignore_acpi_ev = true;
3586 return true;
3587
3588 default:
3589 return false;
3590 }
3591 }
3592
3593 static void thermal_dump_all_sensors(void);
3594
3595 static bool hotkey_notify_thermal(const u32 hkey,
3596 bool *send_acpi_ev,
3597 bool *ignore_acpi_ev)
3598 {
3599 bool known = true;
3600
3601 /* 0x6000-0x6FFF: thermal alarms */
3602 *send_acpi_ev = true;
3603 *ignore_acpi_ev = false;
3604
3605 switch (hkey) {
3606 case TP_HKEY_EV_THM_TABLE_CHANGED:
3607 printk(TPACPI_INFO
3608 "EC reports that Thermal Table has changed\n");
3609 /* recommended action: do nothing, we don't have
3610 * Lenovo ATM information */
3611 return true;
3612 case TP_HKEY_EV_ALARM_BAT_HOT:
3613 printk(TPACPI_CRIT
3614 "THERMAL ALARM: battery is too hot!\n");
3615 /* recommended action: warn user through gui */
3616 break;
3617 case TP_HKEY_EV_ALARM_BAT_XHOT:
3618 printk(TPACPI_ALERT
3619 "THERMAL EMERGENCY: battery is extremely hot!\n");
3620 /* recommended action: immediate sleep/hibernate */
3621 break;
3622 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3623 printk(TPACPI_CRIT
3624 "THERMAL ALARM: "
3625 "a sensor reports something is too hot!\n");
3626 /* recommended action: warn user through gui, that */
3627 /* some internal component is too hot */
3628 break;
3629 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3630 printk(TPACPI_ALERT
3631 "THERMAL EMERGENCY: "
3632 "a sensor reports something is extremely hot!\n");
3633 /* recommended action: immediate sleep/hibernate */
3634 break;
3635 default:
3636 printk(TPACPI_ALERT
3637 "THERMAL ALERT: unknown thermal alarm received\n");
3638 known = false;
3639 }
3640
3641 thermal_dump_all_sensors();
3642
3643 return known;
3644 }
3645
3646 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3647 {
3648 u32 hkey;
3649 bool send_acpi_ev;
3650 bool ignore_acpi_ev;
3651 bool known_ev;
3652
3653 if (event != 0x80) {
3654 printk(TPACPI_ERR
3655 "unknown HKEY notification event %d\n", event);
3656 /* forward it to userspace, maybe it knows how to handle it */
3657 acpi_bus_generate_netlink_event(
3658 ibm->acpi->device->pnp.device_class,
3659 dev_name(&ibm->acpi->device->dev),
3660 event, 0);
3661 return;
3662 }
3663
3664 while (1) {
3665 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3666 printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3667 return;
3668 }
3669
3670 if (hkey == 0) {
3671 /* queue empty */
3672 return;
3673 }
3674
3675 send_acpi_ev = true;
3676 ignore_acpi_ev = false;
3677
3678 switch (hkey >> 12) {
3679 case 1:
3680 /* 0x1000-0x1FFF: key presses */
3681 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3682 &ignore_acpi_ev);
3683 break;
3684 case 2:
3685 /* 0x2000-0x2FFF: Wakeup reason */
3686 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3687 &ignore_acpi_ev);
3688 break;
3689 case 3:
3690 /* 0x3000-0x3FFF: bay-related wakeups */
3691 switch (hkey) {
3692 case TP_HKEY_EV_BAYEJ_ACK:
3693 hotkey_autosleep_ack = 1;
3694 printk(TPACPI_INFO
3695 "bay ejected\n");
3696 hotkey_wakeup_hotunplug_complete_notify_change();
3697 known_ev = true;
3698 break;
3699 case TP_HKEY_EV_OPTDRV_EJ:
3700 /* FIXME: kick libata if SATA link offline */
3701 known_ev = true;
3702 break;
3703 default:
3704 known_ev = false;
3705 }
3706 break;
3707 case 4:
3708 /* 0x4000-0x4FFF: dock-related wakeups */
3709 if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3710 hotkey_autosleep_ack = 1;
3711 printk(TPACPI_INFO
3712 "undocked\n");
3713 hotkey_wakeup_hotunplug_complete_notify_change();
3714 known_ev = true;
3715 } else {
3716 known_ev = false;
3717 }
3718 break;
3719 case 5:
3720 /* 0x5000-0x5FFF: human interface helpers */
3721 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3722 &ignore_acpi_ev);
3723 break;
3724 case 6:
3725 /* 0x6000-0x6FFF: thermal alarms */
3726 known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3727 &ignore_acpi_ev);
3728 break;
3729 case 7:
3730 /* 0x7000-0x7FFF: misc */
3731 if (tp_features.hotkey_wlsw &&
3732 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3733 tpacpi_send_radiosw_update();
3734 send_acpi_ev = 0;
3735 known_ev = true;
3736 break;
3737 }
3738 /* fallthrough to default */
3739 default:
3740 known_ev = false;
3741 }
3742 if (!known_ev) {
3743 printk(TPACPI_NOTICE
3744 "unhandled HKEY event 0x%04x\n", hkey);
3745 printk(TPACPI_NOTICE
3746 "please report the conditions when this "
3747 "event happened to %s\n", TPACPI_MAIL);
3748 }
3749
3750 /* Legacy events */
3751 if (!ignore_acpi_ev &&
3752 (send_acpi_ev || hotkey_report_mode < 2)) {
3753 acpi_bus_generate_proc_event(ibm->acpi->device,
3754 event, hkey);
3755 }
3756
3757 /* netlink events */
3758 if (!ignore_acpi_ev && send_acpi_ev) {
3759 acpi_bus_generate_netlink_event(
3760 ibm->acpi->device->pnp.device_class,
3761 dev_name(&ibm->acpi->device->dev),
3762 event, hkey);
3763 }
3764 }
3765 }
3766
3767 static void hotkey_suspend(pm_message_t state)
3768 {
3769 /* Do these on suspend, we get the events on early resume! */
3770 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3771 hotkey_autosleep_ack = 0;
3772 }
3773
3774 static void hotkey_resume(void)
3775 {
3776 tpacpi_disable_brightness_delay();
3777
3778 if (hotkey_status_set(true) < 0 ||
3779 hotkey_mask_set(hotkey_acpi_mask) < 0)
3780 printk(TPACPI_ERR
3781 "error while attempting to reset the event "
3782 "firmware interface\n");
3783
3784 tpacpi_send_radiosw_update();
3785 hotkey_tablet_mode_notify_change();
3786 hotkey_wakeup_reason_notify_change();
3787 hotkey_wakeup_hotunplug_complete_notify_change();
3788 hotkey_poll_setup_safe(false);
3789 }
3790
3791 /* procfs -------------------------------------------------------------- */
3792 static int hotkey_read(struct seq_file *m)
3793 {
3794 int res, status;
3795
3796 if (!tp_features.hotkey) {
3797 seq_printf(m, "status:\t\tnot supported\n");
3798 return 0;
3799 }
3800
3801 if (mutex_lock_killable(&hotkey_mutex))
3802 return -ERESTARTSYS;
3803 res = hotkey_status_get(&status);
3804 if (!res)
3805 res = hotkey_mask_get();
3806 mutex_unlock(&hotkey_mutex);
3807 if (res)
3808 return res;
3809
3810 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3811 if (hotkey_all_mask) {
3812 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3813 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3814 } else {
3815 seq_printf(m, "mask:\t\tnot supported\n");
3816 seq_printf(m, "commands:\tenable, disable, reset\n");
3817 }
3818
3819 return 0;
3820 }
3821
3822 static void hotkey_enabledisable_warn(bool enable)
3823 {
3824 tpacpi_log_usertask("procfs hotkey enable/disable");
3825 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3826 TPACPI_WARN
3827 "hotkey enable/disable functionality has been "
3828 "removed from the driver. Hotkeys are always "
3829 "enabled\n"))
3830 printk(TPACPI_ERR
3831 "Please remove the hotkey=enable module "
3832 "parameter, it is deprecated. Hotkeys are always "
3833 "enabled\n");
3834 }
3835
3836 static int hotkey_write(char *buf)
3837 {
3838 int res;
3839 u32 mask;
3840 char *cmd;
3841
3842 if (!tp_features.hotkey)
3843 return -ENODEV;
3844
3845 if (mutex_lock_killable(&hotkey_mutex))
3846 return -ERESTARTSYS;
3847
3848 mask = hotkey_user_mask;
3849
3850 res = 0;
3851 while ((cmd = next_cmd(&buf))) {
3852 if (strlencmp(cmd, "enable") == 0) {
3853 hotkey_enabledisable_warn(1);
3854 } else if (strlencmp(cmd, "disable") == 0) {
3855 hotkey_enabledisable_warn(0);
3856 res = -EPERM;
3857 } else if (strlencmp(cmd, "reset") == 0) {
3858 mask = (hotkey_all_mask | hotkey_source_mask)
3859 & ~hotkey_reserved_mask;
3860 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3861 /* mask set */
3862 } else if (sscanf(cmd, "%x", &mask) == 1) {
3863 /* mask set */
3864 } else {
3865 res = -EINVAL;
3866 goto errexit;
3867 }
3868 }
3869
3870 if (!res) {
3871 tpacpi_disclose_usertask("procfs hotkey",
3872 "set mask to 0x%08x\n", mask);
3873 res = hotkey_user_mask_set(mask);
3874 }
3875
3876 errexit:
3877 mutex_unlock(&hotkey_mutex);
3878 return res;
3879 }
3880
3881 static const struct acpi_device_id ibm_htk_device_ids[] = {
3882 {TPACPI_ACPI_HKEY_HID, 0},
3883 {"", 0},
3884 };
3885
3886 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3887 .hid = ibm_htk_device_ids,
3888 .notify = hotkey_notify,
3889 .handle = &hkey_handle,
3890 .type = ACPI_DEVICE_NOTIFY,
3891 };
3892
3893 static struct ibm_struct hotkey_driver_data = {
3894 .name = "hotkey",
3895 .read = hotkey_read,
3896 .write = hotkey_write,
3897 .exit = hotkey_exit,
3898 .resume = hotkey_resume,
3899 .suspend = hotkey_suspend,
3900 .acpi = &ibm_hotkey_acpidriver,
3901 };
3902
3903 /*************************************************************************
3904 * Bluetooth subdriver
3905 */
3906
3907 enum {
3908 /* ACPI GBDC/SBDC bits */
3909 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3910 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3911 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3912 0 = disable, 1 = enable */
3913 };
3914
3915 enum {
3916 /* ACPI \BLTH commands */
3917 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3918 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3919 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3920 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3921 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3922 };
3923
3924 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3925
3926 static int bluetooth_get_status(void)
3927 {
3928 int status;
3929
3930 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3931 if (dbg_bluetoothemul)
3932 return (tpacpi_bluetooth_emulstate) ?
3933 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3934 #endif
3935
3936 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3937 return -EIO;
3938
3939 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3940 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3941 }
3942
3943 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3944 {
3945 int status;
3946
3947 vdbg_printk(TPACPI_DBG_RFKILL,
3948 "will attempt to %s bluetooth\n",
3949 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3950
3951 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3952 if (dbg_bluetoothemul) {
3953 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3954 return 0;
3955 }
3956 #endif
3957
3958 if (state == TPACPI_RFK_RADIO_ON)
3959 status = TP_ACPI_BLUETOOTH_RADIOSSW
3960 | TP_ACPI_BLUETOOTH_RESUMECTRL;
3961 else
3962 status = 0;
3963
3964 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3965 return -EIO;
3966
3967 return 0;
3968 }
3969
3970 /* sysfs bluetooth enable ---------------------------------------------- */
3971 static ssize_t bluetooth_enable_show(struct device *dev,
3972 struct device_attribute *attr,
3973 char *buf)
3974 {
3975 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3976 attr, buf);
3977 }
3978
3979 static ssize_t bluetooth_enable_store(struct device *dev,
3980 struct device_attribute *attr,
3981 const char *buf, size_t count)
3982 {
3983 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3984 attr, buf, count);
3985 }
3986
3987 static struct device_attribute dev_attr_bluetooth_enable =
3988 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3989 bluetooth_enable_show, bluetooth_enable_store);
3990
3991 /* --------------------------------------------------------------------- */
3992
3993 static struct attribute *bluetooth_attributes[] = {
3994 &dev_attr_bluetooth_enable.attr,
3995 NULL
3996 };
3997
3998 static const struct attribute_group bluetooth_attr_group = {
3999 .attrs = bluetooth_attributes,
4000 };
4001
4002 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4003 .get_status = bluetooth_get_status,
4004 .set_status = bluetooth_set_status,
4005 };
4006
4007 static void bluetooth_shutdown(void)
4008 {
4009 /* Order firmware to save current state to NVRAM */
4010 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4011 TP_ACPI_BLTH_SAVE_STATE))
4012 printk(TPACPI_NOTICE
4013 "failed to save bluetooth state to NVRAM\n");
4014 else
4015 vdbg_printk(TPACPI_DBG_RFKILL,
4016 "bluestooth state saved to NVRAM\n");
4017 }
4018
4019 static void bluetooth_exit(void)
4020 {
4021 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4022 &bluetooth_attr_group);
4023
4024 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4025
4026 bluetooth_shutdown();
4027 }
4028
4029 static int __init bluetooth_init(struct ibm_init_struct *iibm)
4030 {
4031 int res;
4032 int status = 0;
4033
4034 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4035 "initializing bluetooth subdriver\n");
4036
4037 TPACPI_ACPIHANDLE_INIT(hkey);
4038
4039 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4040 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4041 tp_features.bluetooth = hkey_handle &&
4042 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4043
4044 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4045 "bluetooth is %s, status 0x%02x\n",
4046 str_supported(tp_features.bluetooth),
4047 status);
4048
4049 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4050 if (dbg_bluetoothemul) {
4051 tp_features.bluetooth = 1;
4052 printk(TPACPI_INFO
4053 "bluetooth switch emulation enabled\n");
4054 } else
4055 #endif
4056 if (tp_features.bluetooth &&
4057 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4058 /* no bluetooth hardware present in system */
4059 tp_features.bluetooth = 0;
4060 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4061 "bluetooth hardware not installed\n");
4062 }
4063
4064 if (!tp_features.bluetooth)
4065 return 1;
4066
4067 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4068 &bluetooth_tprfk_ops,
4069 RFKILL_TYPE_BLUETOOTH,
4070 TPACPI_RFK_BLUETOOTH_SW_NAME,
4071 true);
4072 if (res)
4073 return res;
4074
4075 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4076 &bluetooth_attr_group);
4077 if (res) {
4078 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4079 return res;
4080 }
4081
4082 return 0;
4083 }
4084
4085 /* procfs -------------------------------------------------------------- */
4086 static int bluetooth_read(struct seq_file *m)
4087 {
4088 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4089 }
4090
4091 static int bluetooth_write(char *buf)
4092 {
4093 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4094 }
4095
4096 static struct ibm_struct bluetooth_driver_data = {
4097 .name = "bluetooth",
4098 .read = bluetooth_read,
4099 .write = bluetooth_write,
4100 .exit = bluetooth_exit,
4101 .shutdown = bluetooth_shutdown,
4102 };
4103
4104 /*************************************************************************
4105 * Wan subdriver
4106 */
4107
4108 enum {
4109 /* ACPI GWAN/SWAN bits */
4110 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4111 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4112 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4113 0 = disable, 1 = enable */
4114 };
4115
4116 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4117
4118 static int wan_get_status(void)
4119 {
4120 int status;
4121
4122 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4123 if (dbg_wwanemul)
4124 return (tpacpi_wwan_emulstate) ?
4125 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4126 #endif
4127
4128 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4129 return -EIO;
4130
4131 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4132 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4133 }
4134
4135 static int wan_set_status(enum tpacpi_rfkill_state state)
4136 {
4137 int status;
4138
4139 vdbg_printk(TPACPI_DBG_RFKILL,
4140 "will attempt to %s wwan\n",
4141 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4142
4143 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4144 if (dbg_wwanemul) {
4145 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4146 return 0;
4147 }
4148 #endif
4149
4150 if (state == TPACPI_RFK_RADIO_ON)
4151 status = TP_ACPI_WANCARD_RADIOSSW
4152 | TP_ACPI_WANCARD_RESUMECTRL;
4153 else
4154 status = 0;
4155
4156 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4157 return -EIO;
4158
4159 return 0;
4160 }
4161
4162 /* sysfs wan enable ---------------------------------------------------- */
4163 static ssize_t wan_enable_show(struct device *dev,
4164 struct device_attribute *attr,
4165 char *buf)
4166 {
4167 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4168 attr, buf);
4169 }
4170
4171 static ssize_t wan_enable_store(struct device *dev,
4172 struct device_attribute *attr,
4173 const char *buf, size_t count)
4174 {
4175 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4176 attr, buf, count);
4177 }
4178
4179 static struct device_attribute dev_attr_wan_enable =
4180 __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4181 wan_enable_show, wan_enable_store);
4182
4183 /* --------------------------------------------------------------------- */
4184
4185 static struct attribute *wan_attributes[] = {
4186 &dev_attr_wan_enable.attr,
4187 NULL
4188 };
4189
4190 static const struct attribute_group wan_attr_group = {
4191 .attrs = wan_attributes,
4192 };
4193
4194 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4195 .get_status = wan_get_status,
4196 .set_status = wan_set_status,
4197 };
4198
4199 static void wan_shutdown(void)
4200 {
4201 /* Order firmware to save current state to NVRAM */
4202 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4203 TP_ACPI_WGSV_SAVE_STATE))
4204 printk(TPACPI_NOTICE
4205 "failed to save WWAN state to NVRAM\n");
4206 else
4207 vdbg_printk(TPACPI_DBG_RFKILL,
4208 "WWAN state saved to NVRAM\n");
4209 }
4210
4211 static void wan_exit(void)
4212 {
4213 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4214 &wan_attr_group);
4215
4216 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4217
4218 wan_shutdown();
4219 }
4220
4221 static int __init wan_init(struct ibm_init_struct *iibm)
4222 {
4223 int res;
4224 int status = 0;
4225
4226 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4227 "initializing wan subdriver\n");
4228
4229 TPACPI_ACPIHANDLE_INIT(hkey);
4230
4231 tp_features.wan = hkey_handle &&
4232 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4233
4234 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4235 "wan is %s, status 0x%02x\n",
4236 str_supported(tp_features.wan),
4237 status);
4238
4239 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4240 if (dbg_wwanemul) {
4241 tp_features.wan = 1;
4242 printk(TPACPI_INFO
4243 "wwan switch emulation enabled\n");
4244 } else
4245 #endif
4246 if (tp_features.wan &&
4247 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4248 /* no wan hardware present in system */
4249 tp_features.wan = 0;
4250 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4251 "wan hardware not installed\n");
4252 }
4253
4254 if (!tp_features.wan)
4255 return 1;
4256
4257 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4258 &wan_tprfk_ops,
4259 RFKILL_TYPE_WWAN,
4260 TPACPI_RFK_WWAN_SW_NAME,
4261 true);
4262 if (res)
4263 return res;
4264
4265 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4266 &wan_attr_group);
4267
4268 if (res) {
4269 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4270 return res;
4271 }
4272
4273 return 0;
4274 }
4275
4276 /* procfs -------------------------------------------------------------- */
4277 static int wan_read(struct seq_file *m)
4278 {
4279 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4280 }
4281
4282 static int wan_write(char *buf)
4283 {
4284 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4285 }
4286
4287 static struct ibm_struct wan_driver_data = {
4288 .name = "wan",
4289 .read = wan_read,
4290 .write = wan_write,
4291 .exit = wan_exit,
4292 .shutdown = wan_shutdown,
4293 };
4294
4295 /*************************************************************************
4296 * UWB subdriver
4297 */
4298
4299 enum {
4300 /* ACPI GUWB/SUWB bits */
4301 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4302 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4303 };
4304
4305 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4306
4307 static int uwb_get_status(void)
4308 {
4309 int status;
4310
4311 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4312 if (dbg_uwbemul)
4313 return (tpacpi_uwb_emulstate) ?
4314 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4315 #endif
4316
4317 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4318 return -EIO;
4319
4320 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4321 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4322 }
4323
4324 static int uwb_set_status(enum tpacpi_rfkill_state state)
4325 {
4326 int status;
4327
4328 vdbg_printk(TPACPI_DBG_RFKILL,
4329 "will attempt to %s UWB\n",
4330 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4331
4332 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4333 if (dbg_uwbemul) {
4334 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4335 return 0;
4336 }
4337 #endif
4338
4339 if (state == TPACPI_RFK_RADIO_ON)
4340 status = TP_ACPI_UWB_RADIOSSW;
4341 else
4342 status = 0;
4343
4344 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4345 return -EIO;
4346
4347 return 0;
4348 }
4349
4350 /* --------------------------------------------------------------------- */
4351
4352 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4353 .get_status = uwb_get_status,
4354 .set_status = uwb_set_status,
4355 };
4356
4357 static void uwb_exit(void)
4358 {
4359 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4360 }
4361
4362 static int __init uwb_init(struct ibm_init_struct *iibm)
4363 {
4364 int res;
4365 int status = 0;
4366
4367 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4368 "initializing uwb subdriver\n");
4369
4370 TPACPI_ACPIHANDLE_INIT(hkey);
4371
4372 tp_features.uwb = hkey_handle &&
4373 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4374
4375 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4376 "uwb is %s, status 0x%02x\n",
4377 str_supported(tp_features.uwb),
4378 status);
4379
4380 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4381 if (dbg_uwbemul) {
4382 tp_features.uwb = 1;
4383 printk(TPACPI_INFO
4384 "uwb switch emulation enabled\n");
4385 } else
4386 #endif
4387 if (tp_features.uwb &&
4388 !(status & TP_ACPI_UWB_HWPRESENT)) {
4389 /* no uwb hardware present in system */
4390 tp_features.uwb = 0;
4391 dbg_printk(TPACPI_DBG_INIT,
4392 "uwb hardware not installed\n");
4393 }
4394
4395 if (!tp_features.uwb)
4396 return 1;
4397
4398 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4399 &uwb_tprfk_ops,
4400 RFKILL_TYPE_UWB,
4401 TPACPI_RFK_UWB_SW_NAME,
4402 false);
4403 return res;
4404 }
4405
4406 static struct ibm_struct uwb_driver_data = {
4407 .name = "uwb",
4408 .exit = uwb_exit,
4409 .flags.experimental = 1,
4410 };
4411
4412 /*************************************************************************
4413 * Video subdriver
4414 */
4415
4416 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4417
4418 enum video_access_mode {
4419 TPACPI_VIDEO_NONE = 0,
4420 TPACPI_VIDEO_570, /* 570 */
4421 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4422 TPACPI_VIDEO_NEW, /* all others */
4423 };
4424
4425 enum { /* video status flags, based on VIDEO_570 */
4426 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4427 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4428 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4429 };
4430
4431 enum { /* TPACPI_VIDEO_570 constants */
4432 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4433 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4434 * video_status_flags */
4435 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4436 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4437 };
4438
4439 static enum video_access_mode video_supported;
4440 static int video_orig_autosw;
4441
4442 static int video_autosw_get(void);
4443 static int video_autosw_set(int enable);
4444
4445 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4446
4447 static int __init video_init(struct ibm_init_struct *iibm)
4448 {
4449 int ivga;
4450
4451 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4452
4453 TPACPI_ACPIHANDLE_INIT(vid);
4454 if (tpacpi_is_ibm())
4455 TPACPI_ACPIHANDLE_INIT(vid2);
4456
4457 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4458 /* G41, assume IVGA doesn't change */
4459 vid_handle = vid2_handle;
4460
4461 if (!vid_handle)
4462 /* video switching not supported on R30, R31 */
4463 video_supported = TPACPI_VIDEO_NONE;
4464 else if (tpacpi_is_ibm() &&
4465 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4466 /* 570 */
4467 video_supported = TPACPI_VIDEO_570;
4468 else if (tpacpi_is_ibm() &&
4469 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4470 /* 600e/x, 770e, 770x */
4471 video_supported = TPACPI_VIDEO_770;
4472 else
4473 /* all others */
4474 video_supported = TPACPI_VIDEO_NEW;
4475
4476 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4477 str_supported(video_supported != TPACPI_VIDEO_NONE),
4478 video_supported);
4479
4480 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4481 }
4482
4483 static void video_exit(void)
4484 {
4485 dbg_printk(TPACPI_DBG_EXIT,
4486 "restoring original video autoswitch mode\n");
4487 if (video_autosw_set(video_orig_autosw))
4488 printk(TPACPI_ERR "error while trying to restore original "
4489 "video autoswitch mode\n");
4490 }
4491
4492 static int video_outputsw_get(void)
4493 {
4494 int status = 0;
4495 int i;
4496
4497 switch (video_supported) {
4498 case TPACPI_VIDEO_570:
4499 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4500 TP_ACPI_VIDEO_570_PHSCMD))
4501 return -EIO;
4502 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4503 break;
4504 case TPACPI_VIDEO_770:
4505 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4506 return -EIO;
4507 if (i)
4508 status |= TP_ACPI_VIDEO_S_LCD;
4509 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4510 return -EIO;
4511 if (i)
4512 status |= TP_ACPI_VIDEO_S_CRT;
4513 break;
4514 case TPACPI_VIDEO_NEW:
4515 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4516 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4517 return -EIO;
4518 if (i)
4519 status |= TP_ACPI_VIDEO_S_CRT;
4520
4521 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4522 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4523 return -EIO;
4524 if (i)
4525 status |= TP_ACPI_VIDEO_S_LCD;
4526 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4527 return -EIO;
4528 if (i)
4529 status |= TP_ACPI_VIDEO_S_DVI;
4530 break;
4531 default:
4532 return -ENOSYS;
4533 }
4534
4535 return status;
4536 }
4537
4538 static int video_outputsw_set(int status)
4539 {
4540 int autosw;
4541 int res = 0;
4542
4543 switch (video_supported) {
4544 case TPACPI_VIDEO_570:
4545 res = acpi_evalf(NULL, NULL,
4546 "\\_SB.PHS2", "vdd",
4547 TP_ACPI_VIDEO_570_PHS2CMD,
4548 status | TP_ACPI_VIDEO_570_PHS2SET);
4549 break;
4550 case TPACPI_VIDEO_770:
4551 autosw = video_autosw_get();
4552 if (autosw < 0)
4553 return autosw;
4554
4555 res = video_autosw_set(1);
4556 if (res)
4557 return res;
4558 res = acpi_evalf(vid_handle, NULL,
4559 "ASWT", "vdd", status * 0x100, 0);
4560 if (!autosw && video_autosw_set(autosw)) {
4561 printk(TPACPI_ERR
4562 "video auto-switch left enabled due to error\n");
4563 return -EIO;
4564 }
4565 break;
4566 case TPACPI_VIDEO_NEW:
4567 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4568 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4569 break;
4570 default:
4571 return -ENOSYS;
4572 }
4573
4574 return (res)? 0 : -EIO;
4575 }
4576
4577 static int video_autosw_get(void)
4578 {
4579 int autosw = 0;
4580
4581 switch (video_supported) {
4582 case TPACPI_VIDEO_570:
4583 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4584 return -EIO;
4585 break;
4586 case TPACPI_VIDEO_770:
4587 case TPACPI_VIDEO_NEW:
4588 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4589 return -EIO;
4590 break;
4591 default:
4592 return -ENOSYS;
4593 }
4594
4595 return autosw & 1;
4596 }
4597
4598 static int video_autosw_set(int enable)
4599 {
4600 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4601 return -EIO;
4602 return 0;
4603 }
4604
4605 static int video_outputsw_cycle(void)
4606 {
4607 int autosw = video_autosw_get();
4608 int res;
4609
4610 if (autosw < 0)
4611 return autosw;
4612
4613 switch (video_supported) {
4614 case TPACPI_VIDEO_570:
4615 res = video_autosw_set(1);
4616 if (res)
4617 return res;
4618 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4619 break;
4620 case TPACPI_VIDEO_770:
4621 case TPACPI_VIDEO_NEW:
4622 res = video_autosw_set(1);
4623 if (res)
4624 return res;
4625 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4626 break;
4627 default:
4628 return -ENOSYS;
4629 }
4630 if (!autosw && video_autosw_set(autosw)) {
4631 printk(TPACPI_ERR
4632 "video auto-switch left enabled due to error\n");
4633 return -EIO;
4634 }
4635
4636 return (res)? 0 : -EIO;
4637 }
4638
4639 static int video_expand_toggle(void)
4640 {
4641 switch (video_supported) {
4642 case TPACPI_VIDEO_570:
4643 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4644 0 : -EIO;
4645 case TPACPI_VIDEO_770:
4646 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4647 0 : -EIO;
4648 case TPACPI_VIDEO_NEW:
4649 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4650 0 : -EIO;
4651 default:
4652 return -ENOSYS;
4653 }
4654 /* not reached */
4655 }
4656
4657 static int video_read(struct seq_file *m)
4658 {
4659 int status, autosw;
4660
4661 if (video_supported == TPACPI_VIDEO_NONE) {
4662 seq_printf(m, "status:\t\tnot supported\n");
4663 return 0;
4664 }
4665
4666 /* Even reads can crash X.org, so... */
4667 if (!capable(CAP_SYS_ADMIN))
4668 return -EPERM;
4669
4670 status = video_outputsw_get();
4671 if (status < 0)
4672 return status;
4673
4674 autosw = video_autosw_get();
4675 if (autosw < 0)
4676 return autosw;
4677
4678 seq_printf(m, "status:\t\tsupported\n");
4679 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4680 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4681 if (video_supported == TPACPI_VIDEO_NEW)
4682 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4683 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4684 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4685 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4686 if (video_supported == TPACPI_VIDEO_NEW)
4687 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4688 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4689 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4690
4691 return 0;
4692 }
4693
4694 static int video_write(char *buf)
4695 {
4696 char *cmd;
4697 int enable, disable, status;
4698 int res;
4699
4700 if (video_supported == TPACPI_VIDEO_NONE)
4701 return -ENODEV;
4702
4703 /* Even reads can crash X.org, let alone writes... */
4704 if (!capable(CAP_SYS_ADMIN))
4705 return -EPERM;
4706
4707 enable = 0;
4708 disable = 0;
4709
4710 while ((cmd = next_cmd(&buf))) {
4711 if (strlencmp(cmd, "lcd_enable") == 0) {
4712 enable |= TP_ACPI_VIDEO_S_LCD;
4713 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4714 disable |= TP_ACPI_VIDEO_S_LCD;
4715 } else if (strlencmp(cmd, "crt_enable") == 0) {
4716 enable |= TP_ACPI_VIDEO_S_CRT;
4717 } else if (strlencmp(cmd, "crt_disable") == 0) {
4718 disable |= TP_ACPI_VIDEO_S_CRT;
4719 } else if (video_supported == TPACPI_VIDEO_NEW &&
4720 strlencmp(cmd, "dvi_enable") == 0) {
4721 enable |= TP_ACPI_VIDEO_S_DVI;
4722 } else if (video_supported == TPACPI_VIDEO_NEW &&
4723 strlencmp(cmd, "dvi_disable") == 0) {
4724 disable |= TP_ACPI_VIDEO_S_DVI;
4725 } else if (strlencmp(cmd, "auto_enable") == 0) {
4726 res = video_autosw_set(1);
4727 if (res)
4728 return res;
4729 } else if (strlencmp(cmd, "auto_disable") == 0) {
4730 res = video_autosw_set(0);
4731 if (res)
4732 return res;
4733 } else if (strlencmp(cmd, "video_switch") == 0) {
4734 res = video_outputsw_cycle();
4735 if (res)
4736 return res;
4737 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4738 res = video_expand_toggle();
4739 if (res)
4740 return res;
4741 } else
4742 return -EINVAL;
4743 }
4744
4745 if (enable || disable) {
4746 status = video_outputsw_get();
4747 if (status < 0)
4748 return status;
4749 res = video_outputsw_set((status & ~disable) | enable);
4750 if (res)
4751 return res;
4752 }
4753
4754 return 0;
4755 }
4756
4757 static struct ibm_struct video_driver_data = {
4758 .name = "video",
4759 .read = video_read,
4760 .write = video_write,
4761 .exit = video_exit,
4762 };
4763
4764 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4765
4766 /*************************************************************************
4767 * Light (thinklight) subdriver
4768 */
4769
4770 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4771 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4772
4773 static int light_get_status(void)
4774 {
4775 int status = 0;
4776
4777 if (tp_features.light_status) {
4778 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4779 return -EIO;
4780 return (!!status);
4781 }
4782
4783 return -ENXIO;
4784 }
4785
4786 static int light_set_status(int status)
4787 {
4788 int rc;
4789
4790 if (tp_features.light) {
4791 if (cmos_handle) {
4792 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4793 (status)?
4794 TP_CMOS_THINKLIGHT_ON :
4795 TP_CMOS_THINKLIGHT_OFF);
4796 } else {
4797 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4798 (status)? 1 : 0);
4799 }
4800 return (rc)? 0 : -EIO;
4801 }
4802
4803 return -ENXIO;
4804 }
4805
4806 static void light_set_status_worker(struct work_struct *work)
4807 {
4808 struct tpacpi_led_classdev *data =
4809 container_of(work, struct tpacpi_led_classdev, work);
4810
4811 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4812 light_set_status((data->new_state != TPACPI_LED_OFF));
4813 }
4814
4815 static void light_sysfs_set(struct led_classdev *led_cdev,
4816 enum led_brightness brightness)
4817 {
4818 struct tpacpi_led_classdev *data =
4819 container_of(led_cdev,
4820 struct tpacpi_led_classdev,
4821 led_classdev);
4822 data->new_state = (brightness != LED_OFF) ?
4823 TPACPI_LED_ON : TPACPI_LED_OFF;
4824 queue_work(tpacpi_wq, &data->work);
4825 }
4826
4827 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4828 {
4829 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4830 }
4831
4832 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4833 .led_classdev = {
4834 .name = "tpacpi::thinklight",
4835 .brightness_set = &light_sysfs_set,
4836 .brightness_get = &light_sysfs_get,
4837 }
4838 };
4839
4840 static int __init light_init(struct ibm_init_struct *iibm)
4841 {
4842 int rc;
4843
4844 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4845
4846 if (tpacpi_is_ibm()) {
4847 TPACPI_ACPIHANDLE_INIT(ledb);
4848 TPACPI_ACPIHANDLE_INIT(lght);
4849 }
4850 TPACPI_ACPIHANDLE_INIT(cmos);
4851 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4852
4853 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4854 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4855
4856 if (tp_features.light)
4857 /* light status not supported on
4858 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4859 tp_features.light_status =
4860 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4861
4862 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4863 str_supported(tp_features.light),
4864 str_supported(tp_features.light_status));
4865
4866 if (!tp_features.light)
4867 return 1;
4868
4869 rc = led_classdev_register(&tpacpi_pdev->dev,
4870 &tpacpi_led_thinklight.led_classdev);
4871
4872 if (rc < 0) {
4873 tp_features.light = 0;
4874 tp_features.light_status = 0;
4875 } else {
4876 rc = 0;
4877 }
4878
4879 return rc;
4880 }
4881
4882 static void light_exit(void)
4883 {
4884 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4885 if (work_pending(&tpacpi_led_thinklight.work))
4886 flush_workqueue(tpacpi_wq);
4887 }
4888
4889 static int light_read(struct seq_file *m)
4890 {
4891 int status;
4892
4893 if (!tp_features.light) {
4894 seq_printf(m, "status:\t\tnot supported\n");
4895 } else if (!tp_features.light_status) {
4896 seq_printf(m, "status:\t\tunknown\n");
4897 seq_printf(m, "commands:\ton, off\n");
4898 } else {
4899 status = light_get_status();
4900 if (status < 0)
4901 return status;
4902 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4903 seq_printf(m, "commands:\ton, off\n");
4904 }
4905
4906 return 0;
4907 }
4908
4909 static int light_write(char *buf)
4910 {
4911 char *cmd;
4912 int newstatus = 0;
4913
4914 if (!tp_features.light)
4915 return -ENODEV;
4916
4917 while ((cmd = next_cmd(&buf))) {
4918 if (strlencmp(cmd, "on") == 0) {
4919 newstatus = 1;
4920 } else if (strlencmp(cmd, "off") == 0) {
4921 newstatus = 0;
4922 } else
4923 return -EINVAL;
4924 }
4925
4926 return light_set_status(newstatus);
4927 }
4928
4929 static struct ibm_struct light_driver_data = {
4930 .name = "light",
4931 .read = light_read,
4932 .write = light_write,
4933 .exit = light_exit,
4934 };
4935
4936 /*************************************************************************
4937 * CMOS subdriver
4938 */
4939
4940 /* sysfs cmos_command -------------------------------------------------- */
4941 static ssize_t cmos_command_store(struct device *dev,
4942 struct device_attribute *attr,
4943 const char *buf, size_t count)
4944 {
4945 unsigned long cmos_cmd;
4946 int res;
4947
4948 if (parse_strtoul(buf, 21, &cmos_cmd))
4949 return -EINVAL;
4950
4951 res = issue_thinkpad_cmos_command(cmos_cmd);
4952 return (res)? res : count;
4953 }
4954
4955 static struct device_attribute dev_attr_cmos_command =
4956 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4957
4958 /* --------------------------------------------------------------------- */
4959
4960 static int __init cmos_init(struct ibm_init_struct *iibm)
4961 {
4962 int res;
4963
4964 vdbg_printk(TPACPI_DBG_INIT,
4965 "initializing cmos commands subdriver\n");
4966
4967 TPACPI_ACPIHANDLE_INIT(cmos);
4968
4969 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4970 str_supported(cmos_handle != NULL));
4971
4972 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4973 if (res)
4974 return res;
4975
4976 return (cmos_handle)? 0 : 1;
4977 }
4978
4979 static void cmos_exit(void)
4980 {
4981 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4982 }
4983
4984 static int cmos_read(struct seq_file *m)
4985 {
4986 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4987 R30, R31, T20-22, X20-21 */
4988 if (!cmos_handle)
4989 seq_printf(m, "status:\t\tnot supported\n");
4990 else {
4991 seq_printf(m, "status:\t\tsupported\n");
4992 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
4993 }
4994
4995 return 0;
4996 }
4997
4998 static int cmos_write(char *buf)
4999 {
5000 char *cmd;
5001 int cmos_cmd, res;
5002
5003 while ((cmd = next_cmd(&buf))) {
5004 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5005 cmos_cmd >= 0 && cmos_cmd <= 21) {
5006 /* cmos_cmd set */
5007 } else
5008 return -EINVAL;
5009
5010 res = issue_thinkpad_cmos_command(cmos_cmd);
5011 if (res)
5012 return res;
5013 }
5014
5015 return 0;
5016 }
5017
5018 static struct ibm_struct cmos_driver_data = {
5019 .name = "cmos",
5020 .read = cmos_read,
5021 .write = cmos_write,
5022 .exit = cmos_exit,
5023 };
5024
5025 /*************************************************************************
5026 * LED subdriver
5027 */
5028
5029 enum led_access_mode {
5030 TPACPI_LED_NONE = 0,
5031 TPACPI_LED_570, /* 570 */
5032 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5033 TPACPI_LED_NEW, /* all others */
5034 };
5035
5036 enum { /* For TPACPI_LED_OLD */
5037 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5038 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5039 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5040 };
5041
5042 static enum led_access_mode led_supported;
5043
5044 static acpi_handle led_handle;
5045
5046 #define TPACPI_LED_NUMLEDS 16
5047 static struct tpacpi_led_classdev *tpacpi_leds;
5048 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5049 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5050 /* there's a limit of 19 chars + NULL before 2.6.26 */
5051 "tpacpi::power",
5052 "tpacpi:orange:batt",
5053 "tpacpi:green:batt",
5054 "tpacpi::dock_active",
5055 "tpacpi::bay_active",
5056 "tpacpi::dock_batt",
5057 "tpacpi::unknown_led",
5058 "tpacpi::standby",
5059 "tpacpi::dock_status1",
5060 "tpacpi::dock_status2",
5061 "tpacpi::unknown_led2",
5062 "tpacpi::unknown_led3",
5063 "tpacpi::thinkvantage",
5064 };
5065 #define TPACPI_SAFE_LEDS 0x1081U
5066
5067 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5068 {
5069 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5070 return false;
5071 #else
5072 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5073 #endif
5074 }
5075
5076 static int led_get_status(const unsigned int led)
5077 {
5078 int status;
5079 enum led_status_t led_s;
5080
5081 switch (led_supported) {
5082 case TPACPI_LED_570:
5083 if (!acpi_evalf(ec_handle,
5084 &status, "GLED", "dd", 1 << led))
5085 return -EIO;
5086 led_s = (status == 0)?
5087 TPACPI_LED_OFF :
5088 ((status == 1)?
5089 TPACPI_LED_ON :
5090 TPACPI_LED_BLINK);
5091 tpacpi_led_state_cache[led] = led_s;
5092 return led_s;
5093 default:
5094 return -ENXIO;
5095 }
5096
5097 /* not reached */
5098 }
5099
5100 static int led_set_status(const unsigned int led,
5101 const enum led_status_t ledstatus)
5102 {
5103 /* off, on, blink. Index is led_status_t */
5104 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5105 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5106
5107 int rc = 0;
5108
5109 switch (led_supported) {
5110 case TPACPI_LED_570:
5111 /* 570 */
5112 if (unlikely(led > 7))
5113 return -EINVAL;
5114 if (unlikely(tpacpi_is_led_restricted(led)))
5115 return -EPERM;
5116 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5117 (1 << led), led_sled_arg1[ledstatus]))
5118 rc = -EIO;
5119 break;
5120 case TPACPI_LED_OLD:
5121 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5122 if (unlikely(led > 7))
5123 return -EINVAL;
5124 if (unlikely(tpacpi_is_led_restricted(led)))
5125 return -EPERM;
5126 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5127 if (rc >= 0)
5128 rc = ec_write(TPACPI_LED_EC_HLBL,
5129 (ledstatus == TPACPI_LED_BLINK) << led);
5130 if (rc >= 0)
5131 rc = ec_write(TPACPI_LED_EC_HLCL,
5132 (ledstatus != TPACPI_LED_OFF) << led);
5133 break;
5134 case TPACPI_LED_NEW:
5135 /* all others */
5136 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5137 return -EINVAL;
5138 if (unlikely(tpacpi_is_led_restricted(led)))
5139 return -EPERM;
5140 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5141 led, led_led_arg1[ledstatus]))
5142 rc = -EIO;
5143 break;
5144 default:
5145 rc = -ENXIO;
5146 }
5147
5148 if (!rc)
5149 tpacpi_led_state_cache[led] = ledstatus;
5150
5151 return rc;
5152 }
5153
5154 static void led_set_status_worker(struct work_struct *work)
5155 {
5156 struct tpacpi_led_classdev *data =
5157 container_of(work, struct tpacpi_led_classdev, work);
5158
5159 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5160 led_set_status(data->led, data->new_state);
5161 }
5162
5163 static void led_sysfs_set(struct led_classdev *led_cdev,
5164 enum led_brightness brightness)
5165 {
5166 struct tpacpi_led_classdev *data = container_of(led_cdev,
5167 struct tpacpi_led_classdev, led_classdev);
5168
5169 if (brightness == LED_OFF)
5170 data->new_state = TPACPI_LED_OFF;
5171 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5172 data->new_state = TPACPI_LED_ON;
5173 else
5174 data->new_state = TPACPI_LED_BLINK;
5175
5176 queue_work(tpacpi_wq, &data->work);
5177 }
5178
5179 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5180 unsigned long *delay_on, unsigned long *delay_off)
5181 {
5182 struct tpacpi_led_classdev *data = container_of(led_cdev,
5183 struct tpacpi_led_classdev, led_classdev);
5184
5185 /* Can we choose the flash rate? */
5186 if (*delay_on == 0 && *delay_off == 0) {
5187 /* yes. set them to the hardware blink rate (1 Hz) */
5188 *delay_on = 500; /* ms */
5189 *delay_off = 500; /* ms */
5190 } else if ((*delay_on != 500) || (*delay_off != 500))
5191 return -EINVAL;
5192
5193 data->new_state = TPACPI_LED_BLINK;
5194 queue_work(tpacpi_wq, &data->work);
5195
5196 return 0;
5197 }
5198
5199 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5200 {
5201 int rc;
5202
5203 struct tpacpi_led_classdev *data = container_of(led_cdev,
5204 struct tpacpi_led_classdev, led_classdev);
5205
5206 rc = led_get_status(data->led);
5207
5208 if (rc == TPACPI_LED_OFF || rc < 0)
5209 rc = LED_OFF; /* no error handling in led class :( */
5210 else
5211 rc = LED_FULL;
5212
5213 return rc;
5214 }
5215
5216 static void led_exit(void)
5217 {
5218 unsigned int i;
5219
5220 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5221 if (tpacpi_leds[i].led_classdev.name)
5222 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5223 }
5224
5225 kfree(tpacpi_leds);
5226 }
5227
5228 static int __init tpacpi_init_led(unsigned int led)
5229 {
5230 int rc;
5231
5232 tpacpi_leds[led].led = led;
5233
5234 /* LEDs with no name don't get registered */
5235 if (!tpacpi_led_names[led])
5236 return 0;
5237
5238 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5239 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5240 if (led_supported == TPACPI_LED_570)
5241 tpacpi_leds[led].led_classdev.brightness_get =
5242 &led_sysfs_get;
5243
5244 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5245
5246 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5247
5248 rc = led_classdev_register(&tpacpi_pdev->dev,
5249 &tpacpi_leds[led].led_classdev);
5250 if (rc < 0)
5251 tpacpi_leds[led].led_classdev.name = NULL;
5252
5253 return rc;
5254 }
5255
5256 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5257 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5258 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5259 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5260
5261 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5262 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5263 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5264 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5265 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5266 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5267 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5268 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5269
5270 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5271 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5272 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5273 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5274 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5275
5276 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5277 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5278 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5279 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5280
5281 /* (1) - may have excess leds enabled on MSB */
5282
5283 /* Defaults (order matters, keep last, don't reorder!) */
5284 { /* Lenovo */
5285 .vendor = PCI_VENDOR_ID_LENOVO,
5286 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5287 .quirks = 0x1fffU,
5288 },
5289 { /* IBM ThinkPads with no EC version string */
5290 .vendor = PCI_VENDOR_ID_IBM,
5291 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5292 .quirks = 0x00ffU,
5293 },
5294 { /* IBM ThinkPads with EC version string */
5295 .vendor = PCI_VENDOR_ID_IBM,
5296 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5297 .quirks = 0x00bfU,
5298 },
5299 };
5300
5301 #undef TPACPI_LEDQ_IBM
5302 #undef TPACPI_LEDQ_LNV
5303
5304 static enum led_access_mode __init led_init_detect_mode(void)
5305 {
5306 acpi_status status;
5307
5308 if (tpacpi_is_ibm()) {
5309 /* 570 */
5310 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5311 if (ACPI_SUCCESS(status))
5312 return TPACPI_LED_570;
5313
5314 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5315 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5316 if (ACPI_SUCCESS(status))
5317 return TPACPI_LED_OLD;
5318 }
5319
5320 /* most others */
5321 status = acpi_get_handle(ec_handle, "LED", &led_handle);
5322 if (ACPI_SUCCESS(status))
5323 return TPACPI_LED_NEW;
5324
5325 /* R30, R31, and unknown firmwares */
5326 led_handle = NULL;
5327 return TPACPI_LED_NONE;
5328 }
5329
5330 static int __init led_init(struct ibm_init_struct *iibm)
5331 {
5332 unsigned int i;
5333 int rc;
5334 unsigned long useful_leds;
5335
5336 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5337
5338 led_supported = led_init_detect_mode();
5339
5340 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5341 str_supported(led_supported), led_supported);
5342
5343 if (led_supported == TPACPI_LED_NONE)
5344 return 1;
5345
5346 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5347 GFP_KERNEL);
5348 if (!tpacpi_leds) {
5349 printk(TPACPI_ERR "Out of memory for LED data\n");
5350 return -ENOMEM;
5351 }
5352
5353 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5354 ARRAY_SIZE(led_useful_qtable));
5355
5356 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5357 if (!tpacpi_is_led_restricted(i) &&
5358 test_bit(i, &useful_leds)) {
5359 rc = tpacpi_init_led(i);
5360 if (rc < 0) {
5361 led_exit();
5362 return rc;
5363 }
5364 }
5365 }
5366
5367 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5368 printk(TPACPI_NOTICE
5369 "warning: userspace override of important "
5370 "firmware LEDs is enabled\n");
5371 #endif
5372 return 0;
5373 }
5374
5375 #define str_led_status(s) \
5376 ((s) == TPACPI_LED_OFF ? "off" : \
5377 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5378
5379 static int led_read(struct seq_file *m)
5380 {
5381 if (!led_supported) {
5382 seq_printf(m, "status:\t\tnot supported\n");
5383 return 0;
5384 }
5385 seq_printf(m, "status:\t\tsupported\n");
5386
5387 if (led_supported == TPACPI_LED_570) {
5388 /* 570 */
5389 int i, status;
5390 for (i = 0; i < 8; i++) {
5391 status = led_get_status(i);
5392 if (status < 0)
5393 return -EIO;
5394 seq_printf(m, "%d:\t\t%s\n",
5395 i, str_led_status(status));
5396 }
5397 }
5398
5399 seq_printf(m, "commands:\t"
5400 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5401
5402 return 0;
5403 }
5404
5405 static int led_write(char *buf)
5406 {
5407 char *cmd;
5408 int led, rc;
5409 enum led_status_t s;
5410
5411 if (!led_supported)
5412 return -ENODEV;
5413
5414 while ((cmd = next_cmd(&buf))) {
5415 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5416 return -EINVAL;
5417
5418 if (strstr(cmd, "off")) {
5419 s = TPACPI_LED_OFF;
5420 } else if (strstr(cmd, "on")) {
5421 s = TPACPI_LED_ON;
5422 } else if (strstr(cmd, "blink")) {
5423 s = TPACPI_LED_BLINK;
5424 } else {
5425 return -EINVAL;
5426 }
5427
5428 rc = led_set_status(led, s);
5429 if (rc < 0)
5430 return rc;
5431 }
5432
5433 return 0;
5434 }
5435
5436 static struct ibm_struct led_driver_data = {
5437 .name = "led",
5438 .read = led_read,
5439 .write = led_write,
5440 .exit = led_exit,
5441 };
5442
5443 /*************************************************************************
5444 * Beep subdriver
5445 */
5446
5447 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5448
5449 #define TPACPI_BEEP_Q1 0x0001
5450
5451 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5452 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5453 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5454 };
5455
5456 static int __init beep_init(struct ibm_init_struct *iibm)
5457 {
5458 unsigned long quirks;
5459
5460 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5461
5462 TPACPI_ACPIHANDLE_INIT(beep);
5463
5464 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5465 str_supported(beep_handle != NULL));
5466
5467 quirks = tpacpi_check_quirks(beep_quirk_table,
5468 ARRAY_SIZE(beep_quirk_table));
5469
5470 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5471
5472 return (beep_handle)? 0 : 1;
5473 }
5474
5475 static int beep_read(struct seq_file *m)
5476 {
5477 if (!beep_handle)
5478 seq_printf(m, "status:\t\tnot supported\n");
5479 else {
5480 seq_printf(m, "status:\t\tsupported\n");
5481 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5482 }
5483
5484 return 0;
5485 }
5486
5487 static int beep_write(char *buf)
5488 {
5489 char *cmd;
5490 int beep_cmd;
5491
5492 if (!beep_handle)
5493 return -ENODEV;
5494
5495 while ((cmd = next_cmd(&buf))) {
5496 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5497 beep_cmd >= 0 && beep_cmd <= 17) {
5498 /* beep_cmd set */
5499 } else
5500 return -EINVAL;
5501 if (tp_features.beep_needs_two_args) {
5502 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5503 beep_cmd, 0))
5504 return -EIO;
5505 } else {
5506 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5507 beep_cmd))
5508 return -EIO;
5509 }
5510 }
5511
5512 return 0;
5513 }
5514
5515 static struct ibm_struct beep_driver_data = {
5516 .name = "beep",
5517 .read = beep_read,
5518 .write = beep_write,
5519 };
5520
5521 /*************************************************************************
5522 * Thermal subdriver
5523 */
5524
5525 enum thermal_access_mode {
5526 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5527 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5528 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5529 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5530 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5531 };
5532
5533 enum { /* TPACPI_THERMAL_TPEC_* */
5534 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5535 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5536 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5537
5538 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5539 };
5540
5541
5542 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5543 struct ibm_thermal_sensors_struct {
5544 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5545 };
5546
5547 static enum thermal_access_mode thermal_read_mode;
5548
5549 /* idx is zero-based */
5550 static int thermal_get_sensor(int idx, s32 *value)
5551 {
5552 int t;
5553 s8 tmp;
5554 char tmpi[5];
5555
5556 t = TP_EC_THERMAL_TMP0;
5557
5558 switch (thermal_read_mode) {
5559 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5560 case TPACPI_THERMAL_TPEC_16:
5561 if (idx >= 8 && idx <= 15) {
5562 t = TP_EC_THERMAL_TMP8;
5563 idx -= 8;
5564 }
5565 /* fallthrough */
5566 #endif
5567 case TPACPI_THERMAL_TPEC_8:
5568 if (idx <= 7) {
5569 if (!acpi_ec_read(t + idx, &tmp))
5570 return -EIO;
5571 *value = tmp * 1000;
5572 return 0;
5573 }
5574 break;
5575
5576 case TPACPI_THERMAL_ACPI_UPDT:
5577 if (idx <= 7) {
5578 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5579 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5580 return -EIO;
5581 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5582 return -EIO;
5583 *value = (t - 2732) * 100;
5584 return 0;
5585 }
5586 break;
5587
5588 case TPACPI_THERMAL_ACPI_TMP07:
5589 if (idx <= 7) {
5590 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5591 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5592 return -EIO;
5593 if (t > 127 || t < -127)
5594 t = TP_EC_THERMAL_TMP_NA;
5595 *value = t * 1000;
5596 return 0;
5597 }
5598 break;
5599
5600 case TPACPI_THERMAL_NONE:
5601 default:
5602 return -ENOSYS;
5603 }
5604
5605 return -EINVAL;
5606 }
5607
5608 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5609 {
5610 int res, i;
5611 int n;
5612
5613 n = 8;
5614 i = 0;
5615
5616 if (!s)
5617 return -EINVAL;
5618
5619 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5620 n = 16;
5621
5622 for (i = 0 ; i < n; i++) {
5623 res = thermal_get_sensor(i, &s->temp[i]);
5624 if (res)
5625 return res;
5626 }
5627
5628 return n;
5629 }
5630
5631 static void thermal_dump_all_sensors(void)
5632 {
5633 int n, i;
5634 struct ibm_thermal_sensors_struct t;
5635
5636 n = thermal_get_sensors(&t);
5637 if (n <= 0)
5638 return;
5639
5640 printk(TPACPI_NOTICE
5641 "temperatures (Celsius):");
5642
5643 for (i = 0; i < n; i++) {
5644 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5645 printk(KERN_CONT " %d", (int)(t.temp[i] / 1000));
5646 else
5647 printk(KERN_CONT " N/A");
5648 }
5649
5650 printk(KERN_CONT "\n");
5651 }
5652
5653 /* sysfs temp##_input -------------------------------------------------- */
5654
5655 static ssize_t thermal_temp_input_show(struct device *dev,
5656 struct device_attribute *attr,
5657 char *buf)
5658 {
5659 struct sensor_device_attribute *sensor_attr =
5660 to_sensor_dev_attr(attr);
5661 int idx = sensor_attr->index;
5662 s32 value;
5663 int res;
5664
5665 res = thermal_get_sensor(idx, &value);
5666 if (res)
5667 return res;
5668 if (value == TPACPI_THERMAL_SENSOR_NA)
5669 return -ENXIO;
5670
5671 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5672 }
5673
5674 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5675 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5676 thermal_temp_input_show, NULL, _idxB)
5677
5678 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5679 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5680 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5681 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5682 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5683 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5684 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5685 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5686 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5687 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5688 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5689 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5690 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5691 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5692 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5693 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5694 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5695 };
5696
5697 #define THERMAL_ATTRS(X) \
5698 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5699
5700 static struct attribute *thermal_temp_input_attr[] = {
5701 THERMAL_ATTRS(8),
5702 THERMAL_ATTRS(9),
5703 THERMAL_ATTRS(10),
5704 THERMAL_ATTRS(11),
5705 THERMAL_ATTRS(12),
5706 THERMAL_ATTRS(13),
5707 THERMAL_ATTRS(14),
5708 THERMAL_ATTRS(15),
5709 THERMAL_ATTRS(0),
5710 THERMAL_ATTRS(1),
5711 THERMAL_ATTRS(2),
5712 THERMAL_ATTRS(3),
5713 THERMAL_ATTRS(4),
5714 THERMAL_ATTRS(5),
5715 THERMAL_ATTRS(6),
5716 THERMAL_ATTRS(7),
5717 NULL
5718 };
5719
5720 static const struct attribute_group thermal_temp_input16_group = {
5721 .attrs = thermal_temp_input_attr
5722 };
5723
5724 static const struct attribute_group thermal_temp_input8_group = {
5725 .attrs = &thermal_temp_input_attr[8]
5726 };
5727
5728 #undef THERMAL_SENSOR_ATTR_TEMP
5729 #undef THERMAL_ATTRS
5730
5731 /* --------------------------------------------------------------------- */
5732
5733 static int __init thermal_init(struct ibm_init_struct *iibm)
5734 {
5735 u8 t, ta1, ta2;
5736 int i;
5737 int acpi_tmp7;
5738 int res;
5739
5740 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5741
5742 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5743
5744 if (thinkpad_id.ec_model) {
5745 /*
5746 * Direct EC access mode: sensors at registers
5747 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5748 * non-implemented, thermal sensors return 0x80 when
5749 * not available
5750 */
5751
5752 ta1 = ta2 = 0;
5753 for (i = 0; i < 8; i++) {
5754 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5755 ta1 |= t;
5756 } else {
5757 ta1 = 0;
5758 break;
5759 }
5760 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5761 ta2 |= t;
5762 } else {
5763 ta1 = 0;
5764 break;
5765 }
5766 }
5767 if (ta1 == 0) {
5768 /* This is sheer paranoia, but we handle it anyway */
5769 if (acpi_tmp7) {
5770 printk(TPACPI_ERR
5771 "ThinkPad ACPI EC access misbehaving, "
5772 "falling back to ACPI TMPx access "
5773 "mode\n");
5774 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5775 } else {
5776 printk(TPACPI_ERR
5777 "ThinkPad ACPI EC access misbehaving, "
5778 "disabling thermal sensors access\n");
5779 thermal_read_mode = TPACPI_THERMAL_NONE;
5780 }
5781 } else {
5782 thermal_read_mode =
5783 (ta2 != 0) ?
5784 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5785 }
5786 } else if (acpi_tmp7) {
5787 if (tpacpi_is_ibm() &&
5788 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5789 /* 600e/x, 770e, 770x */
5790 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5791 } else {
5792 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5793 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5794 }
5795 } else {
5796 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5797 thermal_read_mode = TPACPI_THERMAL_NONE;
5798 }
5799
5800 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5801 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5802 thermal_read_mode);
5803
5804 switch (thermal_read_mode) {
5805 case TPACPI_THERMAL_TPEC_16:
5806 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5807 &thermal_temp_input16_group);
5808 if (res)
5809 return res;
5810 break;
5811 case TPACPI_THERMAL_TPEC_8:
5812 case TPACPI_THERMAL_ACPI_TMP07:
5813 case TPACPI_THERMAL_ACPI_UPDT:
5814 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5815 &thermal_temp_input8_group);
5816 if (res)
5817 return res;
5818 break;
5819 case TPACPI_THERMAL_NONE:
5820 default:
5821 return 1;
5822 }
5823
5824 return 0;
5825 }
5826
5827 static void thermal_exit(void)
5828 {
5829 switch (thermal_read_mode) {
5830 case TPACPI_THERMAL_TPEC_16:
5831 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5832 &thermal_temp_input16_group);
5833 break;
5834 case TPACPI_THERMAL_TPEC_8:
5835 case TPACPI_THERMAL_ACPI_TMP07:
5836 case TPACPI_THERMAL_ACPI_UPDT:
5837 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5838 &thermal_temp_input8_group);
5839 break;
5840 case TPACPI_THERMAL_NONE:
5841 default:
5842 break;
5843 }
5844 }
5845
5846 static int thermal_read(struct seq_file *m)
5847 {
5848 int n, i;
5849 struct ibm_thermal_sensors_struct t;
5850
5851 n = thermal_get_sensors(&t);
5852 if (unlikely(n < 0))
5853 return n;
5854
5855 seq_printf(m, "temperatures:\t");
5856
5857 if (n > 0) {
5858 for (i = 0; i < (n - 1); i++)
5859 seq_printf(m, "%d ", t.temp[i] / 1000);
5860 seq_printf(m, "%d\n", t.temp[i] / 1000);
5861 } else
5862 seq_printf(m, "not supported\n");
5863
5864 return 0;
5865 }
5866
5867 static struct ibm_struct thermal_driver_data = {
5868 .name = "thermal",
5869 .read = thermal_read,
5870 .exit = thermal_exit,
5871 };
5872
5873 /*************************************************************************
5874 * EC Dump subdriver
5875 */
5876
5877 static u8 ecdump_regs[256];
5878
5879 static int ecdump_read(struct seq_file *m)
5880 {
5881 int i, j;
5882 u8 v;
5883
5884 seq_printf(m, "EC "
5885 " +00 +01 +02 +03 +04 +05 +06 +07"
5886 " +08 +09 +0a +0b +0c +0d +0e +0f\n");
5887 for (i = 0; i < 256; i += 16) {
5888 seq_printf(m, "EC 0x%02x:", i);
5889 for (j = 0; j < 16; j++) {
5890 if (!acpi_ec_read(i + j, &v))
5891 break;
5892 if (v != ecdump_regs[i + j])
5893 seq_printf(m, " *%02x", v);
5894 else
5895 seq_printf(m, " %02x", v);
5896 ecdump_regs[i + j] = v;
5897 }
5898 seq_putc(m, '\n');
5899 if (j != 16)
5900 break;
5901 }
5902
5903 /* These are way too dangerous to advertise openly... */
5904 #if 0
5905 seq_printf(m, "commands:\t0x<offset> 0x<value>"
5906 " (<offset> is 00-ff, <value> is 00-ff)\n");
5907 seq_printf(m, "commands:\t0x<offset> <value> "
5908 " (<offset> is 00-ff, <value> is 0-255)\n");
5909 #endif
5910 return 0;
5911 }
5912
5913 static int ecdump_write(char *buf)
5914 {
5915 char *cmd;
5916 int i, v;
5917
5918 while ((cmd = next_cmd(&buf))) {
5919 if (sscanf(cmd, "0x%x 0x%x", &i, &v) == 2) {
5920 /* i and v set */
5921 } else if (sscanf(cmd, "0x%x %u", &i, &v) == 2) {
5922 /* i and v set */
5923 } else
5924 return -EINVAL;
5925 if (i >= 0 && i < 256 && v >= 0 && v < 256) {
5926 if (!acpi_ec_write(i, v))
5927 return -EIO;
5928 } else
5929 return -EINVAL;
5930 }
5931
5932 return 0;
5933 }
5934
5935 static struct ibm_struct ecdump_driver_data = {
5936 .name = "ecdump",
5937 .read = ecdump_read,
5938 .write = ecdump_write,
5939 .flags.experimental = 1,
5940 };
5941
5942 /*************************************************************************
5943 * Backlight/brightness subdriver
5944 */
5945
5946 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5947
5948 /*
5949 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5950 * CMOS NVRAM byte 0x5E, bits 0-3.
5951 *
5952 * EC HBRV (0x31) has the following layout
5953 * Bit 7: unknown function
5954 * Bit 6: unknown function
5955 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5956 * Bit 4: must be set to zero to avoid problems
5957 * Bit 3-0: backlight brightness level
5958 *
5959 * brightness_get_raw returns status data in the HBRV layout
5960 *
5961 * WARNING: The X61 has been verified to use HBRV for something else, so
5962 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5963 * testing on the very early *60 Lenovo models...
5964 */
5965
5966 enum {
5967 TP_EC_BACKLIGHT = 0x31,
5968
5969 /* TP_EC_BACKLIGHT bitmasks */
5970 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5971 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5972 TP_EC_BACKLIGHT_MAPSW = 0x20,
5973 };
5974
5975 enum tpacpi_brightness_access_mode {
5976 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5977 TPACPI_BRGHT_MODE_EC, /* EC control */
5978 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5979 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5980 TPACPI_BRGHT_MODE_MAX
5981 };
5982
5983 static struct backlight_device *ibm_backlight_device;
5984
5985 static enum tpacpi_brightness_access_mode brightness_mode =
5986 TPACPI_BRGHT_MODE_MAX;
5987
5988 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5989
5990 static struct mutex brightness_mutex;
5991
5992 /* NVRAM brightness access,
5993 * call with brightness_mutex held! */
5994 static unsigned int tpacpi_brightness_nvram_get(void)
5995 {
5996 u8 lnvram;
5997
5998 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5999 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6000 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6001 lnvram &= bright_maxlvl;
6002
6003 return lnvram;
6004 }
6005
6006 static void tpacpi_brightness_checkpoint_nvram(void)
6007 {
6008 u8 lec = 0;
6009 u8 b_nvram;
6010
6011 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6012 return;
6013
6014 vdbg_printk(TPACPI_DBG_BRGHT,
6015 "trying to checkpoint backlight level to NVRAM...\n");
6016
6017 if (mutex_lock_killable(&brightness_mutex) < 0)
6018 return;
6019
6020 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6021 goto unlock;
6022 lec &= TP_EC_BACKLIGHT_LVLMSK;
6023 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6024
6025 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6026 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6027 /* NVRAM needs update */
6028 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6029 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6030 b_nvram |= lec;
6031 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6032 dbg_printk(TPACPI_DBG_BRGHT,
6033 "updated NVRAM backlight level to %u (0x%02x)\n",
6034 (unsigned int) lec, (unsigned int) b_nvram);
6035 } else
6036 vdbg_printk(TPACPI_DBG_BRGHT,
6037 "NVRAM backlight level already is %u (0x%02x)\n",
6038 (unsigned int) lec, (unsigned int) b_nvram);
6039
6040 unlock:
6041 mutex_unlock(&brightness_mutex);
6042 }
6043
6044
6045 /* call with brightness_mutex held! */
6046 static int tpacpi_brightness_get_raw(int *status)
6047 {
6048 u8 lec = 0;
6049
6050 switch (brightness_mode) {
6051 case TPACPI_BRGHT_MODE_UCMS_STEP:
6052 *status = tpacpi_brightness_nvram_get();
6053 return 0;
6054 case TPACPI_BRGHT_MODE_EC:
6055 case TPACPI_BRGHT_MODE_ECNVRAM:
6056 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6057 return -EIO;
6058 *status = lec;
6059 return 0;
6060 default:
6061 return -ENXIO;
6062 }
6063 }
6064
6065 /* call with brightness_mutex held! */
6066 /* do NOT call with illegal backlight level value */
6067 static int tpacpi_brightness_set_ec(unsigned int value)
6068 {
6069 u8 lec = 0;
6070
6071 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6072 return -EIO;
6073
6074 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6075 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6076 (value & TP_EC_BACKLIGHT_LVLMSK))))
6077 return -EIO;
6078
6079 return 0;
6080 }
6081
6082 /* call with brightness_mutex held! */
6083 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6084 {
6085 int cmos_cmd, inc;
6086 unsigned int current_value, i;
6087
6088 current_value = tpacpi_brightness_nvram_get();
6089
6090 if (value == current_value)
6091 return 0;
6092
6093 cmos_cmd = (value > current_value) ?
6094 TP_CMOS_BRIGHTNESS_UP :
6095 TP_CMOS_BRIGHTNESS_DOWN;
6096 inc = (value > current_value) ? 1 : -1;
6097
6098 for (i = current_value; i != value; i += inc)
6099 if (issue_thinkpad_cmos_command(cmos_cmd))
6100 return -EIO;
6101
6102 return 0;
6103 }
6104
6105 /* May return EINTR which can always be mapped to ERESTARTSYS */
6106 static int brightness_set(unsigned int value)
6107 {
6108 int res;
6109
6110 if (value > bright_maxlvl || value < 0)
6111 return -EINVAL;
6112
6113 vdbg_printk(TPACPI_DBG_BRGHT,
6114 "set backlight level to %d\n", value);
6115
6116 res = mutex_lock_killable(&brightness_mutex);
6117 if (res < 0)
6118 return res;
6119
6120 switch (brightness_mode) {
6121 case TPACPI_BRGHT_MODE_EC:
6122 case TPACPI_BRGHT_MODE_ECNVRAM:
6123 res = tpacpi_brightness_set_ec(value);
6124 break;
6125 case TPACPI_BRGHT_MODE_UCMS_STEP:
6126 res = tpacpi_brightness_set_ucmsstep(value);
6127 break;
6128 default:
6129 res = -ENXIO;
6130 }
6131
6132 mutex_unlock(&brightness_mutex);
6133 return res;
6134 }
6135
6136 /* sysfs backlight class ----------------------------------------------- */
6137
6138 static int brightness_update_status(struct backlight_device *bd)
6139 {
6140 unsigned int level =
6141 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6142 bd->props.power == FB_BLANK_UNBLANK) ?
6143 bd->props.brightness : 0;
6144
6145 dbg_printk(TPACPI_DBG_BRGHT,
6146 "backlight: attempt to set level to %d\n",
6147 level);
6148
6149 /* it is the backlight class's job (caller) to handle
6150 * EINTR and other errors properly */
6151 return brightness_set(level);
6152 }
6153
6154 static int brightness_get(struct backlight_device *bd)
6155 {
6156 int status, res;
6157
6158 res = mutex_lock_killable(&brightness_mutex);
6159 if (res < 0)
6160 return 0;
6161
6162 res = tpacpi_brightness_get_raw(&status);
6163
6164 mutex_unlock(&brightness_mutex);
6165
6166 if (res < 0)
6167 return 0;
6168
6169 return status & TP_EC_BACKLIGHT_LVLMSK;
6170 }
6171
6172 static void tpacpi_brightness_notify_change(void)
6173 {
6174 backlight_force_update(ibm_backlight_device,
6175 BACKLIGHT_UPDATE_HOTKEY);
6176 }
6177
6178 static const struct backlight_ops ibm_backlight_data = {
6179 .get_brightness = brightness_get,
6180 .update_status = brightness_update_status,
6181 };
6182
6183 /* --------------------------------------------------------------------- */
6184
6185 /*
6186 * Call _BCL method of video device. On some ThinkPads this will
6187 * switch the firmware to the ACPI brightness control mode.
6188 */
6189
6190 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6191 {
6192 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6193 union acpi_object *obj;
6194 int rc;
6195
6196 if (ACPI_SUCCESS(acpi_evaluate_object(handle, "_BCL", NULL, &buffer))) {
6197 obj = (union acpi_object *)buffer.pointer;
6198 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6199 printk(TPACPI_ERR "Unknown _BCL data, "
6200 "please report this to %s\n", TPACPI_MAIL);
6201 rc = 0;
6202 } else {
6203 rc = obj->package.count;
6204 }
6205 } else {
6206 return 0;
6207 }
6208
6209 kfree(buffer.pointer);
6210 return rc;
6211 }
6212
6213
6214 /*
6215 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6216 */
6217 static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6218 {
6219 acpi_handle video_device;
6220 int bcl_levels = 0;
6221
6222 tpacpi_acpi_handle_locate("video", ACPI_VIDEO_HID, &video_device);
6223 if (video_device)
6224 bcl_levels = tpacpi_query_bcl_levels(video_device);
6225
6226 tp_features.bright_acpimode = (bcl_levels > 0);
6227
6228 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6229 }
6230
6231 /*
6232 * These are only useful for models that have only one possibility
6233 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6234 * these quirks.
6235 */
6236 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6237 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6238 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6239
6240 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6241 /* Models with ATI GPUs known to require ECNVRAM mode */
6242 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6243
6244 /* Models with ATI GPUs that can use ECNVRAM */
6245 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6246 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6247 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6248 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6249
6250 /* Models with Intel Extreme Graphics 2 */
6251 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6252 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6253 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6254
6255 /* Models with Intel GMA900 */
6256 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6257 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6258 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6259 };
6260
6261 /*
6262 * Returns < 0 for error, otherwise sets tp_features.bright_*
6263 * and bright_maxlvl.
6264 */
6265 static void __init tpacpi_detect_brightness_capabilities(void)
6266 {
6267 unsigned int b;
6268
6269 vdbg_printk(TPACPI_DBG_INIT,
6270 "detecting firmware brightness interface capabilities\n");
6271
6272 /* we could run a quirks check here (same table used by
6273 * brightness_init) if needed */
6274
6275 /*
6276 * We always attempt to detect acpi support, so as to switch
6277 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6278 * going to publish a backlight interface
6279 */
6280 b = tpacpi_check_std_acpi_brightness_support();
6281 switch (b) {
6282 case 16:
6283 bright_maxlvl = 15;
6284 printk(TPACPI_INFO
6285 "detected a 16-level brightness capable ThinkPad\n");
6286 break;
6287 case 8:
6288 case 0:
6289 bright_maxlvl = 7;
6290 printk(TPACPI_INFO
6291 "detected a 8-level brightness capable ThinkPad\n");
6292 break;
6293 default:
6294 printk(TPACPI_ERR
6295 "Unsupported brightness interface, "
6296 "please contact %s\n", TPACPI_MAIL);
6297 tp_features.bright_unkfw = 1;
6298 bright_maxlvl = b - 1;
6299 }
6300 }
6301
6302 static int __init brightness_init(struct ibm_init_struct *iibm)
6303 {
6304 struct backlight_properties props;
6305 int b;
6306 unsigned long quirks;
6307
6308 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6309
6310 mutex_init(&brightness_mutex);
6311
6312 quirks = tpacpi_check_quirks(brightness_quirk_table,
6313 ARRAY_SIZE(brightness_quirk_table));
6314
6315 /* tpacpi_detect_brightness_capabilities() must have run already */
6316
6317 /* if it is unknown, we don't handle it: it wouldn't be safe */
6318 if (tp_features.bright_unkfw)
6319 return 1;
6320
6321 if (!brightness_enable) {
6322 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6323 "brightness support disabled by "
6324 "module parameter\n");
6325 return 1;
6326 }
6327
6328 if (acpi_video_backlight_support()) {
6329 if (brightness_enable > 1) {
6330 printk(TPACPI_INFO
6331 "Standard ACPI backlight interface "
6332 "available, not loading native one.\n");
6333 return 1;
6334 } else if (brightness_enable == 1) {
6335 printk(TPACPI_WARN
6336 "Cannot enable backlight brightness support, "
6337 "ACPI is already handling it. Refer to the "
6338 "acpi_backlight kernel parameter\n");
6339 return 1;
6340 }
6341 } else if (tp_features.bright_acpimode && brightness_enable > 1) {
6342 printk(TPACPI_NOTICE
6343 "Standard ACPI backlight interface not "
6344 "available, thinkpad_acpi native "
6345 "brightness control enabled\n");
6346 }
6347
6348 /*
6349 * Check for module parameter bogosity, note that we
6350 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6351 * able to detect "unspecified"
6352 */
6353 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6354 return -EINVAL;
6355
6356 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6357 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6358 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6359 if (quirks & TPACPI_BRGHT_Q_EC)
6360 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6361 else
6362 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6363
6364 dbg_printk(TPACPI_DBG_BRGHT,
6365 "driver auto-selected brightness_mode=%d\n",
6366 brightness_mode);
6367 }
6368
6369 /* Safety */
6370 if (!tpacpi_is_ibm() &&
6371 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6372 brightness_mode == TPACPI_BRGHT_MODE_EC))
6373 return -EINVAL;
6374
6375 if (tpacpi_brightness_get_raw(&b) < 0)
6376 return 1;
6377
6378 memset(&props, 0, sizeof(struct backlight_properties));
6379 props.max_brightness = bright_maxlvl;
6380 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6381 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6382 NULL, NULL,
6383 &ibm_backlight_data,
6384 &props);
6385 if (IS_ERR(ibm_backlight_device)) {
6386 int rc = PTR_ERR(ibm_backlight_device);
6387 ibm_backlight_device = NULL;
6388 printk(TPACPI_ERR "Could not register backlight device\n");
6389 return rc;
6390 }
6391 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6392 "brightness is supported\n");
6393
6394 if (quirks & TPACPI_BRGHT_Q_ASK) {
6395 printk(TPACPI_NOTICE
6396 "brightness: will use unverified default: "
6397 "brightness_mode=%d\n", brightness_mode);
6398 printk(TPACPI_NOTICE
6399 "brightness: please report to %s whether it works well "
6400 "or not on your ThinkPad\n", TPACPI_MAIL);
6401 }
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 initialize 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 }
8567
8568 if (ibm->flags.proc_created) {
8569 dbg_printk(TPACPI_DBG_EXIT,
8570 "%s: remove_proc_entry\n", ibm->name);
8571 remove_proc_entry(ibm->name, proc_dir);
8572 ibm->flags.proc_created = 0;
8573 }
8574
8575 if (ibm->flags.acpi_driver_registered) {
8576 dbg_printk(TPACPI_DBG_EXIT,
8577 "%s: acpi_bus_unregister_driver\n", ibm->name);
8578 BUG_ON(!ibm->acpi);
8579 acpi_bus_unregister_driver(ibm->acpi->driver);
8580 kfree(ibm->acpi->driver);
8581 ibm->acpi->driver = NULL;
8582 ibm->flags.acpi_driver_registered = 0;
8583 }
8584
8585 if (ibm->flags.init_called && ibm->exit) {
8586 ibm->exit();
8587 ibm->flags.init_called = 0;
8588 }
8589
8590 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8591 }
8592
8593 static int __init ibm_init(struct ibm_init_struct *iibm)
8594 {
8595 int ret;
8596 struct ibm_struct *ibm = iibm->data;
8597 struct proc_dir_entry *entry;
8598
8599 BUG_ON(ibm == NULL);
8600
8601 INIT_LIST_HEAD(&ibm->all_drivers);
8602
8603 if (ibm->flags.experimental && !experimental)
8604 return 0;
8605
8606 dbg_printk(TPACPI_DBG_INIT,
8607 "probing for %s\n", ibm->name);
8608
8609 if (iibm->init) {
8610 ret = iibm->init(iibm);
8611 if (ret > 0)
8612 return 0; /* probe failed */
8613 if (ret)
8614 return ret;
8615
8616 ibm->flags.init_called = 1;
8617 }
8618
8619 if (ibm->acpi) {
8620 if (ibm->acpi->hid) {
8621 ret = register_tpacpi_subdriver(ibm);
8622 if (ret)
8623 goto err_out;
8624 }
8625
8626 if (ibm->acpi->notify) {
8627 ret = setup_acpi_notify(ibm);
8628 if (ret == -ENODEV) {
8629 printk(TPACPI_NOTICE "disabling subdriver %s\n",
8630 ibm->name);
8631 ret = 0;
8632 goto err_out;
8633 }
8634 if (ret < 0)
8635 goto err_out;
8636 }
8637 }
8638
8639 dbg_printk(TPACPI_DBG_INIT,
8640 "%s installed\n", ibm->name);
8641
8642 if (ibm->read) {
8643 mode_t mode = iibm->base_procfs_mode;
8644
8645 if (!mode)
8646 mode = S_IRUGO;
8647 if (ibm->write)
8648 mode |= S_IWUSR;
8649 entry = proc_create_data(ibm->name, mode, proc_dir,
8650 &dispatch_proc_fops, ibm);
8651 if (!entry) {
8652 printk(TPACPI_ERR "unable to create proc entry %s\n",
8653 ibm->name);
8654 ret = -ENODEV;
8655 goto err_out;
8656 }
8657 ibm->flags.proc_created = 1;
8658 }
8659
8660 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8661
8662 return 0;
8663
8664 err_out:
8665 dbg_printk(TPACPI_DBG_INIT,
8666 "%s: at error exit path with result %d\n",
8667 ibm->name, ret);
8668
8669 ibm_exit(ibm);
8670 return (ret < 0)? ret : 0;
8671 }
8672
8673 /* Probing */
8674
8675 static bool __pure __init tpacpi_is_fw_digit(const char c)
8676 {
8677 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8678 }
8679
8680 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8681 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8682 const char t)
8683 {
8684 return s && strlen(s) >= 8 &&
8685 tpacpi_is_fw_digit(s[0]) &&
8686 tpacpi_is_fw_digit(s[1]) &&
8687 s[2] == t && s[3] == 'T' &&
8688 tpacpi_is_fw_digit(s[4]) &&
8689 tpacpi_is_fw_digit(s[5]);
8690 }
8691
8692 /* returns 0 - probe ok, or < 0 - probe error.
8693 * Probe ok doesn't mean thinkpad found.
8694 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8695 static int __must_check __init get_thinkpad_model_data(
8696 struct thinkpad_id_data *tp)
8697 {
8698 const struct dmi_device *dev = NULL;
8699 char ec_fw_string[18];
8700 char const *s;
8701
8702 if (!tp)
8703 return -EINVAL;
8704
8705 memset(tp, 0, sizeof(*tp));
8706
8707 if (dmi_name_in_vendors("IBM"))
8708 tp->vendor = PCI_VENDOR_ID_IBM;
8709 else if (dmi_name_in_vendors("LENOVO"))
8710 tp->vendor = PCI_VENDOR_ID_LENOVO;
8711 else
8712 return 0;
8713
8714 s = dmi_get_system_info(DMI_BIOS_VERSION);
8715 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8716 if (s && !tp->bios_version_str)
8717 return -ENOMEM;
8718
8719 /* Really ancient ThinkPad 240X will fail this, which is fine */
8720 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
8721 return 0;
8722
8723 tp->bios_model = tp->bios_version_str[0]
8724 | (tp->bios_version_str[1] << 8);
8725 tp->bios_release = (tp->bios_version_str[4] << 8)
8726 | tp->bios_version_str[5];
8727
8728 /*
8729 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8730 * X32 or newer, all Z series; Some models must have an
8731 * up-to-date BIOS or they will not be detected.
8732 *
8733 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8734 */
8735 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8736 if (sscanf(dev->name,
8737 "IBM ThinkPad Embedded Controller -[%17c",
8738 ec_fw_string) == 1) {
8739 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8740 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8741
8742 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8743 if (!tp->ec_version_str)
8744 return -ENOMEM;
8745
8746 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8747 tp->ec_model = ec_fw_string[0]
8748 | (ec_fw_string[1] << 8);
8749 tp->ec_release = (ec_fw_string[4] << 8)
8750 | ec_fw_string[5];
8751 } else {
8752 printk(TPACPI_NOTICE
8753 "ThinkPad firmware release %s "
8754 "doesn't match the known patterns\n",
8755 ec_fw_string);
8756 printk(TPACPI_NOTICE
8757 "please report this to %s\n",
8758 TPACPI_MAIL);
8759 }
8760 break;
8761 }
8762 }
8763
8764 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8765 if (s && !strnicmp(s, "ThinkPad", 8)) {
8766 tp->model_str = kstrdup(s, GFP_KERNEL);
8767 if (!tp->model_str)
8768 return -ENOMEM;
8769 }
8770
8771 s = dmi_get_system_info(DMI_PRODUCT_NAME);
8772 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8773 if (s && !tp->nummodel_str)
8774 return -ENOMEM;
8775
8776 return 0;
8777 }
8778
8779 static int __init probe_for_thinkpad(void)
8780 {
8781 int is_thinkpad;
8782
8783 if (acpi_disabled)
8784 return -ENODEV;
8785
8786 /* It would be dangerous to run the driver in this case */
8787 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8788 return -ENODEV;
8789
8790 /*
8791 * Non-ancient models have better DMI tagging, but very old models
8792 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
8793 */
8794 is_thinkpad = (thinkpad_id.model_str != NULL) ||
8795 (thinkpad_id.ec_model != 0) ||
8796 tpacpi_is_fw_known();
8797
8798 /* The EC handler is required */
8799 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
8800 if (!ec_handle) {
8801 if (is_thinkpad)
8802 printk(TPACPI_ERR
8803 "Not yet supported ThinkPad detected!\n");
8804 return -ENODEV;
8805 }
8806
8807 if (!is_thinkpad && !force_load)
8808 return -ENODEV;
8809
8810 return 0;
8811 }
8812
8813 static void __init thinkpad_acpi_init_banner(void)
8814 {
8815 printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
8816 printk(TPACPI_INFO "%s\n", TPACPI_URL);
8817
8818 printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
8819 (thinkpad_id.bios_version_str) ?
8820 thinkpad_id.bios_version_str : "unknown",
8821 (thinkpad_id.ec_version_str) ?
8822 thinkpad_id.ec_version_str : "unknown");
8823
8824 BUG_ON(!thinkpad_id.vendor);
8825
8826 if (thinkpad_id.model_str)
8827 printk(TPACPI_INFO "%s %s, model %s\n",
8828 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
8829 "IBM" : ((thinkpad_id.vendor ==
8830 PCI_VENDOR_ID_LENOVO) ?
8831 "Lenovo" : "Unknown vendor"),
8832 thinkpad_id.model_str,
8833 (thinkpad_id.nummodel_str) ?
8834 thinkpad_id.nummodel_str : "unknown");
8835 }
8836
8837 /* Module init, exit, parameters */
8838
8839 static struct ibm_init_struct ibms_init[] __initdata = {
8840 {
8841 .data = &thinkpad_acpi_driver_data,
8842 },
8843 {
8844 .init = hotkey_init,
8845 .data = &hotkey_driver_data,
8846 },
8847 {
8848 .init = bluetooth_init,
8849 .data = &bluetooth_driver_data,
8850 },
8851 {
8852 .init = wan_init,
8853 .data = &wan_driver_data,
8854 },
8855 {
8856 .init = uwb_init,
8857 .data = &uwb_driver_data,
8858 },
8859 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8860 {
8861 .init = video_init,
8862 .base_procfs_mode = S_IRUSR,
8863 .data = &video_driver_data,
8864 },
8865 #endif
8866 {
8867 .init = light_init,
8868 .data = &light_driver_data,
8869 },
8870 {
8871 .init = cmos_init,
8872 .data = &cmos_driver_data,
8873 },
8874 {
8875 .init = led_init,
8876 .data = &led_driver_data,
8877 },
8878 {
8879 .init = beep_init,
8880 .data = &beep_driver_data,
8881 },
8882 {
8883 .init = thermal_init,
8884 .data = &thermal_driver_data,
8885 },
8886 {
8887 .data = &ecdump_driver_data,
8888 },
8889 {
8890 .init = brightness_init,
8891 .data = &brightness_driver_data,
8892 },
8893 {
8894 .init = volume_init,
8895 .data = &volume_driver_data,
8896 },
8897 {
8898 .init = fan_init,
8899 .data = &fan_driver_data,
8900 },
8901 };
8902
8903 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8904 {
8905 unsigned int i;
8906 struct ibm_struct *ibm;
8907
8908 if (!kp || !kp->name || !val)
8909 return -EINVAL;
8910
8911 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8912 ibm = ibms_init[i].data;
8913 WARN_ON(ibm == NULL);
8914
8915 if (!ibm || !ibm->name)
8916 continue;
8917
8918 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8919 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8920 return -ENOSPC;
8921 strcpy(ibms_init[i].param, val);
8922 strcat(ibms_init[i].param, ",");
8923 return 0;
8924 }
8925 }
8926
8927 return -EINVAL;
8928 }
8929
8930 module_param(experimental, int, 0444);
8931 MODULE_PARM_DESC(experimental,
8932 "Enables experimental features when non-zero");
8933
8934 module_param_named(debug, dbg_level, uint, 0);
8935 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8936
8937 module_param(force_load, bool, 0444);
8938 MODULE_PARM_DESC(force_load,
8939 "Attempts to load the driver even on a "
8940 "mis-identified ThinkPad when true");
8941
8942 module_param_named(fan_control, fan_control_allowed, bool, 0444);
8943 MODULE_PARM_DESC(fan_control,
8944 "Enables setting fan parameters features when true");
8945
8946 module_param_named(brightness_mode, brightness_mode, uint, 0444);
8947 MODULE_PARM_DESC(brightness_mode,
8948 "Selects brightness control strategy: "
8949 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8950
8951 module_param(brightness_enable, uint, 0444);
8952 MODULE_PARM_DESC(brightness_enable,
8953 "Enables backlight control when 1, disables when 0");
8954
8955 module_param(hotkey_report_mode, uint, 0444);
8956 MODULE_PARM_DESC(hotkey_report_mode,
8957 "used for backwards compatibility with userspace, "
8958 "see documentation");
8959
8960 #ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8961 module_param_named(volume_mode, volume_mode, uint, 0444);
8962 MODULE_PARM_DESC(volume_mode,
8963 "Selects volume control strategy: "
8964 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8965
8966 module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8967 MODULE_PARM_DESC(volume_capabilities,
8968 "Selects the mixer capabilites: "
8969 "0=auto, 1=volume and mute, 2=mute only");
8970
8971 module_param_named(volume_control, volume_control_allowed, bool, 0444);
8972 MODULE_PARM_DESC(volume_control,
8973 "Enables software override for the console audio "
8974 "control when true");
8975
8976 /* ALSA module API parameters */
8977 module_param_named(index, alsa_index, int, 0444);
8978 MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8979 module_param_named(id, alsa_id, charp, 0444);
8980 MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8981 module_param_named(enable, alsa_enable, bool, 0444);
8982 MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8983 #endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8984
8985 #define TPACPI_PARAM(feature) \
8986 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8987 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8988 "at module load, see documentation")
8989
8990 TPACPI_PARAM(hotkey);
8991 TPACPI_PARAM(bluetooth);
8992 TPACPI_PARAM(video);
8993 TPACPI_PARAM(light);
8994 TPACPI_PARAM(cmos);
8995 TPACPI_PARAM(led);
8996 TPACPI_PARAM(beep);
8997 TPACPI_PARAM(ecdump);
8998 TPACPI_PARAM(brightness);
8999 TPACPI_PARAM(volume);
9000 TPACPI_PARAM(fan);
9001
9002 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
9003 module_param(dbg_wlswemul, uint, 0444);
9004 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
9005 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
9006 MODULE_PARM_DESC(wlsw_state,
9007 "Initial state of the emulated WLSW switch");
9008
9009 module_param(dbg_bluetoothemul, uint, 0444);
9010 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
9011 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
9012 MODULE_PARM_DESC(bluetooth_state,
9013 "Initial state of the emulated bluetooth switch");
9014
9015 module_param(dbg_wwanemul, uint, 0444);
9016 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
9017 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
9018 MODULE_PARM_DESC(wwan_state,
9019 "Initial state of the emulated WWAN switch");
9020
9021 module_param(dbg_uwbemul, uint, 0444);
9022 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
9023 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
9024 MODULE_PARM_DESC(uwb_state,
9025 "Initial state of the emulated UWB switch");
9026 #endif
9027
9028 static void thinkpad_acpi_module_exit(void)
9029 {
9030 struct ibm_struct *ibm, *itmp;
9031
9032 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
9033
9034 list_for_each_entry_safe_reverse(ibm, itmp,
9035 &tpacpi_all_drivers,
9036 all_drivers) {
9037 ibm_exit(ibm);
9038 }
9039
9040 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
9041
9042 if (tpacpi_inputdev) {
9043 if (tp_features.input_device_registered)
9044 input_unregister_device(tpacpi_inputdev);
9045 else
9046 input_free_device(tpacpi_inputdev);
9047 }
9048
9049 if (tpacpi_hwmon)
9050 hwmon_device_unregister(tpacpi_hwmon);
9051
9052 if (tp_features.sensors_pdev_attrs_registered)
9053 device_remove_file(&tpacpi_sensors_pdev->dev,
9054 &dev_attr_thinkpad_acpi_pdev_name);
9055 if (tpacpi_sensors_pdev)
9056 platform_device_unregister(tpacpi_sensors_pdev);
9057 if (tpacpi_pdev)
9058 platform_device_unregister(tpacpi_pdev);
9059
9060 if (tp_features.sensors_pdrv_attrs_registered)
9061 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
9062 if (tp_features.platform_drv_attrs_registered)
9063 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
9064
9065 if (tp_features.sensors_pdrv_registered)
9066 platform_driver_unregister(&tpacpi_hwmon_pdriver);
9067
9068 if (tp_features.platform_drv_registered)
9069 platform_driver_unregister(&tpacpi_pdriver);
9070
9071 if (proc_dir)
9072 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
9073
9074 if (tpacpi_wq)
9075 destroy_workqueue(tpacpi_wq);
9076
9077 kfree(thinkpad_id.bios_version_str);
9078 kfree(thinkpad_id.ec_version_str);
9079 kfree(thinkpad_id.model_str);
9080 }
9081
9082
9083 static int __init thinkpad_acpi_module_init(void)
9084 {
9085 int ret, i;
9086
9087 tpacpi_lifecycle = TPACPI_LIFE_INIT;
9088
9089 /* Parameter checking */
9090 if (hotkey_report_mode > 2)
9091 return -EINVAL;
9092
9093 /* Driver-level probe */
9094
9095 ret = get_thinkpad_model_data(&thinkpad_id);
9096 if (ret) {
9097 printk(TPACPI_ERR
9098 "unable to get DMI data: %d\n", ret);
9099 thinkpad_acpi_module_exit();
9100 return ret;
9101 }
9102 ret = probe_for_thinkpad();
9103 if (ret) {
9104 thinkpad_acpi_module_exit();
9105 return ret;
9106 }
9107
9108 /* Driver initialization */
9109
9110 thinkpad_acpi_init_banner();
9111 tpacpi_check_outdated_fw();
9112
9113 TPACPI_ACPIHANDLE_INIT(ecrd);
9114 TPACPI_ACPIHANDLE_INIT(ecwr);
9115
9116 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9117 if (!tpacpi_wq) {
9118 thinkpad_acpi_module_exit();
9119 return -ENOMEM;
9120 }
9121
9122 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9123 if (!proc_dir) {
9124 printk(TPACPI_ERR
9125 "unable to create proc dir " TPACPI_PROC_DIR);
9126 thinkpad_acpi_module_exit();
9127 return -ENODEV;
9128 }
9129
9130 ret = platform_driver_register(&tpacpi_pdriver);
9131 if (ret) {
9132 printk(TPACPI_ERR
9133 "unable to register main platform driver\n");
9134 thinkpad_acpi_module_exit();
9135 return ret;
9136 }
9137 tp_features.platform_drv_registered = 1;
9138
9139 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9140 if (ret) {
9141 printk(TPACPI_ERR
9142 "unable to register hwmon platform driver\n");
9143 thinkpad_acpi_module_exit();
9144 return ret;
9145 }
9146 tp_features.sensors_pdrv_registered = 1;
9147
9148 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9149 if (!ret) {
9150 tp_features.platform_drv_attrs_registered = 1;
9151 ret = tpacpi_create_driver_attributes(
9152 &tpacpi_hwmon_pdriver.driver);
9153 }
9154 if (ret) {
9155 printk(TPACPI_ERR
9156 "unable to create sysfs driver attributes\n");
9157 thinkpad_acpi_module_exit();
9158 return ret;
9159 }
9160 tp_features.sensors_pdrv_attrs_registered = 1;
9161
9162
9163 /* Device initialization */
9164 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9165 NULL, 0);
9166 if (IS_ERR(tpacpi_pdev)) {
9167 ret = PTR_ERR(tpacpi_pdev);
9168 tpacpi_pdev = NULL;
9169 printk(TPACPI_ERR "unable to register platform device\n");
9170 thinkpad_acpi_module_exit();
9171 return ret;
9172 }
9173 tpacpi_sensors_pdev = platform_device_register_simple(
9174 TPACPI_HWMON_DRVR_NAME,
9175 -1, NULL, 0);
9176 if (IS_ERR(tpacpi_sensors_pdev)) {
9177 ret = PTR_ERR(tpacpi_sensors_pdev);
9178 tpacpi_sensors_pdev = NULL;
9179 printk(TPACPI_ERR
9180 "unable to register hwmon platform device\n");
9181 thinkpad_acpi_module_exit();
9182 return ret;
9183 }
9184 ret = device_create_file(&tpacpi_sensors_pdev->dev,
9185 &dev_attr_thinkpad_acpi_pdev_name);
9186 if (ret) {
9187 printk(TPACPI_ERR
9188 "unable to create sysfs hwmon device attributes\n");
9189 thinkpad_acpi_module_exit();
9190 return ret;
9191 }
9192 tp_features.sensors_pdev_attrs_registered = 1;
9193 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9194 if (IS_ERR(tpacpi_hwmon)) {
9195 ret = PTR_ERR(tpacpi_hwmon);
9196 tpacpi_hwmon = NULL;
9197 printk(TPACPI_ERR "unable to register hwmon device\n");
9198 thinkpad_acpi_module_exit();
9199 return ret;
9200 }
9201 mutex_init(&tpacpi_inputdev_send_mutex);
9202 tpacpi_inputdev = input_allocate_device();
9203 if (!tpacpi_inputdev) {
9204 printk(TPACPI_ERR "unable to allocate input device\n");
9205 thinkpad_acpi_module_exit();
9206 return -ENOMEM;
9207 } else {
9208 /* Prepare input device, but don't register */
9209 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9210 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9211 tpacpi_inputdev->id.bustype = BUS_HOST;
9212 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9213 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9214 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9215 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9216 }
9217
9218 /* Init subdriver dependencies */
9219 tpacpi_detect_brightness_capabilities();
9220
9221 /* Init subdrivers */
9222 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9223 ret = ibm_init(&ibms_init[i]);
9224 if (ret >= 0 && *ibms_init[i].param)
9225 ret = ibms_init[i].data->write(ibms_init[i].param);
9226 if (ret < 0) {
9227 thinkpad_acpi_module_exit();
9228 return ret;
9229 }
9230 }
9231
9232 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9233
9234 ret = input_register_device(tpacpi_inputdev);
9235 if (ret < 0) {
9236 printk(TPACPI_ERR "unable to register input device\n");
9237 thinkpad_acpi_module_exit();
9238 return ret;
9239 } else {
9240 tp_features.input_device_registered = 1;
9241 }
9242
9243 return 0;
9244 }
9245
9246 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9247
9248 /*
9249 * This will autoload the driver in almost every ThinkPad
9250 * in widespread use.
9251 *
9252 * Only _VERY_ old models, like the 240, 240x and 570 lack
9253 * the HKEY event interface.
9254 */
9255 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9256
9257 /*
9258 * DMI matching for module autoloading
9259 *
9260 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9261 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9262 *
9263 * Only models listed in thinkwiki will be supported, so add yours
9264 * if it is not there yet.
9265 */
9266 #define IBM_BIOS_MODULE_ALIAS(__type) \
9267 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9268
9269 /* Ancient thinkpad BIOSes have to be identified by
9270 * BIOS type or model number, and there are far less
9271 * BIOS types than model numbers... */
9272 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
9273
9274 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9275 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9276 MODULE_DESCRIPTION(TPACPI_DESC);
9277 MODULE_VERSION(TPACPI_VERSION);
9278 MODULE_LICENSE("GPL");
9279
9280 module_init(thinkpad_acpi_module_init);
9281 module_exit(thinkpad_acpi_module_exit);
Linux 2.6 ibm-acpi/thinkpad-acpi driver git tree